Stable API change: SMP (Simple Management Protocol) transport API within MCUmgr drops zephyr_ prefix in functions and type definitions


Ermel, Dominik
 

Hello,

 

The SMP transport API, used by MCUmgr to process requests, drops zephyr_ prefix from interface functions and type definitions; this means that

all zephyr_smp_* functions/types are now smp_* types.

 

The API is not officially stable, or even listed here https://docs.zephyrproject.org/latest/develop/api/overview.html#api-overview, but it has been in Zephyr for a long time and

could  have been used by some out-of-treen transports, that will now get broken.

The change can be reviewed here:

https://github.com/zephyrproject-rtos/zephyr/pull/49528

 

Dominik ERMEL | Senior Software Engineer
Kraków, Poland
nordicsemi.com | devzone.nordicsemi.com

Nordic_logo_signature

 


Ermel, Dominik
 

Hello,

I have posted missing RFC for the change here https://github.com/zephyrproject-rtos/zephyr/issues/49962 and extended it to cover removal of the zst parameter from zephyr_smp_transport_out_fn.
PRs, which  implement the RFC,  are here: https://github.com/zephyrproject-rtos/zephyr/pull/49528 and here https://github.com/zephyrproject-rtos/zephyr/pull/49527.

Best regards,
Dominik Ermel

 

From: devel@... <devel@...> On Behalf Of Ermel, Dominik via lists.zephyrproject.org
Sent: Wednesday, August 31, 2022 2:30 PM
To: Devel@...
Subject: [Zephyr-devel] Stable API change: SMP (Simple Management Protocol) transport API within MCUmgr drops zephyr_ prefix in functions and type definitions

 

dominik.ermel=nordicsemi.no@... appears similar to someone who previously sent you email, but may not be that person. Learn why this could be a risk

Hello,

 

The SMP transport API, used by MCUmgr to process requests, drops zephyr_ prefix from interface functions and type definitions; this means that

all zephyr_smp_* functions/types are now smp_* types.

 

The API is not officially stable, or even listed here https://docs.zephyrproject.org/latest/develop/api/overview.html#api-overview, but it has been in Zephyr for a long time and

could  have been used by some out-of-treen transports, that will now get broken.

The change can be reviewed here:

https://github.com/zephyrproject-rtos/zephyr/pull/49528

 

Dominik ERMEL | Senior Software Engineer
Kraków, Poland
nordicsemi.com | devzone.nordicsemi.com

Nordic_logo_signature