Simplemac Library Api Naming Conventions; Simplemac Library Apis Classes - ST SimpleMAC STM32W108 Series User Manual

UM0893
3.3

SimpleMAC library API naming conventions

The following naming conventions are used:
General prefix
●
All SimpleMAC APIs are prefixed with "ST_" followed by the general API family (e.g.
Radio, AES).
Callback suffix
●
The functions which are implemented in the application and called from the
SimpleMAC library are suffixed with "Callback".
ISR callback suffix
●
The functions which are implemented in the application and called from the
SimpleMAC library in interrupt context are suffixed with "IsrCallback".
ISR suffix
●
The functions which are implemented in the SimpleMAC library and must be called by
the application in response to hardware events are suffixed with "Isr".
3.4

SimpleMAC Library APIs classes

The following API classes are supported:
●
Radio power state control APIs which control the overall radio initialization and power
state.
● Radio channel APIs which control channel selection and calibration.
●
Radio transmit APIs which control the transmission of packets.
● Radio receive APIs which control the reception of packets.
●
Radio cryptography APIs which provide an interface to the hardware AES coprocessor.
● Radio MAC timer APIs to interface with the MAC timer.
●
Radio miscellaneous APIs which perform MAC diagnostic and configuration.
For a detailed description of the SimpleMAC library APIs, refer to the STM32W108
SimpleMAC Library APIs documentation.
STM32W108 SimpleMAC library overview
Doc ID 16995 Rev 10 15/54