diff options
Diffstat (limited to 'os/hal/templates')
| -rw-r--r-- | os/hal/templates/adc_lld.c | 10 | ||||
| -rw-r--r-- | os/hal/templates/can_lld.c | 18 | ||||
| -rw-r--r-- | os/hal/templates/hal_lld.c | 2 | ||||
| -rw-r--r-- | os/hal/templates/i2c_lld.c | 16 | ||||
| -rw-r--r-- | os/hal/templates/mac_lld.c | 18 | ||||
| -rw-r--r-- | os/hal/templates/meta/driver.c | 8 | ||||
| -rw-r--r-- | os/hal/templates/meta/driver_lld.c | 6 | ||||
| -rw-r--r-- | os/hal/templates/pal_lld.h | 34 | ||||
| -rw-r--r-- | os/hal/templates/pwm_lld.c | 14 | ||||
| -rw-r--r-- | os/hal/templates/serial_lld.c | 6 | ||||
| -rw-r--r-- | os/hal/templates/spi_lld.c | 18 | ||||
| -rw-r--r-- | os/hal/templates/uart_lld.c | 14 |
12 files changed, 163 insertions, 1 deletions
diff --git a/os/hal/templates/adc_lld.c b/os/hal/templates/adc_lld.c index ffe67bc0f..38a1915eb 100644 --- a/os/hal/templates/adc_lld.c +++ b/os/hal/templates/adc_lld.c @@ -52,6 +52,8 @@ /**
* @brief Low level ADC driver initialization.
+ *
+ * @notapi
*/
void adc_lld_init(void) {
@@ -61,6 +63,8 @@ void adc_lld_init(void) { * @brief Configures and activates the ADC peripheral.
*
* @param[in] adcp pointer to the @p ADCDriver object
+ *
+ * @notapi
*/
void adc_lld_start(ADCDriver *adcp) {
@@ -74,6 +78,8 @@ void adc_lld_start(ADCDriver *adcp) { * @brief Deactivates the ADC peripheral.
*
* @param[in] adcp pointer to the @p ADCDriver object
+ *
+ * @notapi
*/
void adc_lld_stop(ADCDriver *adcp) {
@@ -83,6 +89,8 @@ void adc_lld_stop(ADCDriver *adcp) { * @brief Starts an ADC conversion.
*
* @param[in] adcp pointer to the @p ADCDriver object
+ *
+ * @notapi
*/
void adc_lld_start_conversion(ADCDriver *adcp) {
@@ -92,6 +100,8 @@ void adc_lld_start_conversion(ADCDriver *adcp) { * @brief Stops an ongoing conversion.
*
* @param[in] adcp pointer to the @p ADCDriver object
+ *
+ * @notapi
*/
void adc_lld_stop_conversion(ADCDriver *adcp) {
diff --git a/os/hal/templates/can_lld.c b/os/hal/templates/can_lld.c index 65190276d..dca401bd4 100644 --- a/os/hal/templates/can_lld.c +++ b/os/hal/templates/can_lld.c @@ -52,6 +52,8 @@ /**
* @brief Low level CAN driver initialization.
+ *
+ * @notapi
*/
void can_lld_init(void) {
@@ -61,6 +63,8 @@ void can_lld_init(void) { * @brief Configures and activates the CAN peripheral.
*
* @param[in] canp pointer to the @p CANDriver object
+ *
+ * @notapi
*/
void can_lld_start(CANDriver *canp) {
@@ -70,6 +74,8 @@ void can_lld_start(CANDriver *canp) { * @brief Deactivates the CAN peripheral.
*
* @param[in] canp pointer to the @p CANDriver object
+ *
+ * @notapi
*/
void can_lld_stop(CANDriver *canp) {
@@ -87,6 +93,8 @@ void can_lld_stop(CANDriver *canp) { * @return The queue space availability.
* @retval FALSE no space in the transmit queue.
* @retval TRUE transmit slot available.
+ *
+ * @notapi
*/
bool_t can_lld_can_transmit(CANDriver *canp) {
@@ -98,6 +106,8 @@ bool_t can_lld_can_transmit(CANDriver *canp) { *
* @param[in] canp pointer to the @p CANDriver object
* @param[in] ctfp pointer to the CAN frame to be transmitted
+ *
+ * @notapi
*/
void can_lld_transmit(CANDriver *canp, const CANTxFrame *ctfp) {
@@ -110,6 +120,8 @@ void can_lld_transmit(CANDriver *canp, const CANTxFrame *ctfp) { * @return The queue space availability.
* @retval FALSE no space in the transmit queue.
* @retval TRUE transmit slot available.
+ *
+ * @notapi
*/
bool_t can_lld_can_receive(CANDriver *canp) {
@@ -121,6 +133,8 @@ bool_t can_lld_can_receive(CANDriver *canp) { *
* @param[in] canp pointer to the @p CANDriver object
* @param[out] crfp pointer to the buffer where the CAN frame is copied
+ *
+ * @notapi
*/
void can_lld_receive(CANDriver *canp, CANRxFrame *crfp) {
@@ -131,6 +145,8 @@ void can_lld_receive(CANDriver *canp, CANRxFrame *crfp) { * @brief Enters the sleep mode.
*
* @param[in] canp pointer to the @p CANDriver object
+ *
+ * @notapi
*/
void can_lld_sleep(CANDriver *canp) {
@@ -140,6 +156,8 @@ void can_lld_sleep(CANDriver *canp) { * @brief Enforces leaving the sleep mode.
*
* @param[in] canp pointer to the @p CANDriver object
+ *
+ * @notapi
*/
void can_lld_wakeup(CANDriver *canp) {
diff --git a/os/hal/templates/hal_lld.c b/os/hal/templates/hal_lld.c index 8674d4f38..3531f16c0 100644 --- a/os/hal/templates/hal_lld.c +++ b/os/hal/templates/hal_lld.c @@ -50,6 +50,8 @@ /**
* @brief Low level HAL driver initialization.
+ *
+ * @notapi
*/
void hal_lld_init(void) {
diff --git a/os/hal/templates/i2c_lld.c b/os/hal/templates/i2c_lld.c index e41cc3b29..479c9a3cc 100644 --- a/os/hal/templates/i2c_lld.c +++ b/os/hal/templates/i2c_lld.c @@ -52,6 +52,8 @@ /**
* @brief Low level I2C driver initialization.
+ *
+ * @notapi
*/
void i2c_lld_init(void) {
@@ -61,6 +63,8 @@ void i2c_lld_init(void) { * @brief Configures and activates the I2C peripheral.
*
* @param[in] i2cp pointer to the @p I2CDriver object
+ *
+ * @notapi
*/
void i2c_lld_start(I2CDriver *i2cp) {
@@ -74,6 +78,8 @@ void i2c_lld_start(I2CDriver *i2cp) { * @brief Deactivates the I2C peripheral.
*
* @param[in] i2cp pointer to the @p I2CDriver object
+ *
+ * @notapi
*/
void i2c_lld_stop(I2CDriver *i2cp) {
@@ -86,6 +92,8 @@ void i2c_lld_stop(I2CDriver *i2cp) { *
* @param[in] i2cp pointer to the @p I2CDriver object
* @param[in] header transaction header
+ *
+ * @notapi
*/
void i2c_lld_master_start(I2CDriver *i2cp, uint16_t header) {
@@ -95,6 +103,8 @@ void i2c_lld_master_start(I2CDriver *i2cp, uint16_t header) { * @brief Terminates a master bus transaction.
*
* @param[in] i2cp pointer to the @p I2CDriver object
+ *
+ * @notapi
*/
void i2c_lld_master_stop(I2CDriver *i2cp) {
@@ -105,6 +115,8 @@ void i2c_lld_master_stop(I2CDriver *i2cp) { * @details Restart bits are required by some types of I2C transactions.
*
* @param[in] i2cp pointer to the @p I2CDriver object
+ *
+ * @notapi
*/
void i2c_lld_master_restart(I2CDriver *i2cp) {
@@ -116,6 +128,8 @@ void i2c_lld_master_restart(I2CDriver *i2cp) { * @param[in] i2cp pointer to the @p I2CDriver object
* @param[in] n number of bytes to be transmitted
* @param[in] txbuf transmit data buffer pointer
+ *
+ * @notapi
*/
void i2c_lld_master_transmit(I2CDriver *i2cp, size_t n,
const uint8_t *txbuf) {
@@ -128,6 +142,8 @@ void i2c_lld_master_transmit(I2CDriver *i2cp, size_t n, * @param[in] i2cp pointer to the @p I2CDriver object
* @param[in] n number of bytes to be transmitted
* @param[in] rxbuf receive data buffer pointer
+ *
+ * @notapi
*/
void i2c_lld_master_receive(I2CDriver *i2cp, size_t n, uint8_t *rxbuf) {
diff --git a/os/hal/templates/mac_lld.c b/os/hal/templates/mac_lld.c index bfe21d65a..864cb76c0 100644 --- a/os/hal/templates/mac_lld.c +++ b/os/hal/templates/mac_lld.c @@ -52,6 +52,8 @@ /**
* @brief Low level MAC initialization.
+ *
+ * @notapi
*/
void mac_lld_init(void) {
@@ -64,6 +66,8 @@ void mac_lld_init(void) { * @param[in] p pointer to a six bytes buffer containing the MAC
* address. If this parameter is set to @p NULL then
* a system default MAC is used.
+ *
+ * @notapi
*/
void mac_lld_set_address(MACDriver *macp, const uint8_t *p) {
@@ -79,6 +83,8 @@ void mac_lld_set_address(MACDriver *macp, const uint8_t *p) { * @return The operation status.
* @retval RDY_OK a descriptor was obtained.
* @retval RDY_TIMEOUT descriptor not available.
+ *
+ * @notapi
*/
msg_t max_lld_get_transmit_descriptor(MACDriver *macp,
MACTransmitDescriptor *tdp) {
@@ -97,6 +103,8 @@ msg_t max_lld_get_transmit_descriptor(MACDriver *macp, * stream, this value can be less than the amount
* specified in the parameter @p size if the maximum
* frame size is reached.
+ *
+ * @notapi
*/
size_t mac_lld_write_transmit_descriptor(MACTransmitDescriptor *tdp,
uint8_t *buf,
@@ -110,6 +118,8 @@ size_t mac_lld_write_transmit_descriptor(MACTransmitDescriptor *tdp, * enqueued data as a single frame.
*
* @param[in] tdp pointer to a @p MACTransmitDescriptor structure
+ *
+ * @notapi
*/
void mac_lld_release_transmit_descriptor(MACTransmitDescriptor *tdp) {
@@ -123,6 +133,8 @@ void mac_lld_release_transmit_descriptor(MACTransmitDescriptor *tdp) { * @return The operation status.
* @retval RDY_OK a descriptor was obtained.
* @retval RDY_TIMEOUT descriptor not available.
+ *
+ * @notapi
*/
msg_t max_lld_get_receive_descriptor(MACDriver *macp,
MACReceiveDescriptor *rdp) {
@@ -139,6 +151,8 @@ msg_t max_lld_get_receive_descriptor(MACDriver *macp, * @return The number of bytes read from the descriptor's stream,
* this value can be less than the amount specified in
* the parameter @p size if there are no more bytes to read.
+ *
+ * @notapi
*/
size_t mac_lld_read_receive_descriptor(MACReceiveDescriptor *rdp,
uint8_t *buf,
@@ -153,6 +167,8 @@ size_t mac_lld_read_receive_descriptor(MACReceiveDescriptor *rdp, * frames.
*
* @param[in] rdp pointer to a @p MACReceiveDescriptor structure
+ *
+ * @notapi
*/
void mac_lld_release_receive_descriptor(MACReceiveDescriptor *rdp) {
@@ -165,6 +181,8 @@ void mac_lld_release_receive_descriptor(MACReceiveDescriptor *rdp) { * @return The link status.
* @retval TRUE if the link is active.
* @retval FALSE if the link is down.
+ *
+ * @notapi
*/
bool_t mac_lld_poll_link_status(MACDriver *macp) {
diff --git a/os/hal/templates/meta/driver.c b/os/hal/templates/meta/driver.c index d688f3626..d006d0fda 100644 --- a/os/hal/templates/meta/driver.c +++ b/os/hal/templates/meta/driver.c @@ -48,6 +48,8 @@ /**
* @brief XXX Driver initialization.
+ *
+ * @init
*/
void xxxInit(void) {
@@ -58,6 +60,8 @@ void xxxInit(void) { * @brief Initializes the standard part of a @p XXXDriver structure.
*
* @param[in] xxxp pointer to the @p XXXDriver object
+ *
+ * @init
*/
void xxxObjectInit(XXXDriver *xxxp) {
@@ -70,6 +74,8 @@ void xxxObjectInit(XXXDriver *xxxp) { *
* @param[in] xxxp pointer to the @p XXXDriver object
* @param[in] config pointer to the @p XXXConfig object
+ *
+ * @api
*/
void xxxStart(XXXDriver *xxxp, const XXXConfig *config) {
@@ -89,6 +95,8 @@ void xxxStart(XXXDriver *xxxp, const XXXConfig *config) { * @brief Deactivates the XXX peripheral.
*
* @param[in] xxxp pointer to the @p XXXDriver object
+ *
+ * @api
*/
void xxxStop(XXXDriver *xxxp) {
diff --git a/os/hal/templates/meta/driver_lld.c b/os/hal/templates/meta/driver_lld.c index 5d6253339..b1129f2d2 100644 --- a/os/hal/templates/meta/driver_lld.c +++ b/os/hal/templates/meta/driver_lld.c @@ -52,6 +52,8 @@ /**
* @brief Low level XXX driver initialization.
+ *
+ * @notapi
*/
void xxx_lld_init(void) {
@@ -61,6 +63,8 @@ void xxx_lld_init(void) { * @brief Configures and activates the XXX peripheral.
*
* @param[in] xxxp pointer to the @p XXXDriver object
+ *
+ * @notapi
*/
void xxx_lld_start(XXXDriver *xxxp) {
@@ -74,6 +78,8 @@ void xxx_lld_start(XXXDriver *xxxp) { * @brief Deactivates the XXX peripheral.
*
* @param[in] xxxp pointer to the @p XXXDriver object
+ *
+ * @notapi
*/
void xxx_lld_stop(XXXDriver *xxxp) {
diff --git a/os/hal/templates/pal_lld.h b/os/hal/templates/pal_lld.h index dddc58e77..7025bdbc6 100644 --- a/os/hal/templates/pal_lld.h +++ b/os/hal/templates/pal_lld.h @@ -95,6 +95,8 @@ typedef uint32_t ioportid_t; * @brief Low level PAL subsystem initialization.
*
* @param[in] config architecture-dependent ports configuration
+ *
+ * @notapi
*/
#define pal_lld_init(config)
@@ -105,6 +107,8 @@ typedef uint32_t ioportid_t; *
* @param[in] port port identifier
* @return The port bits.
+ *
+ * @notapi
*/
#define pal_lld_readport(port)
@@ -117,6 +121,8 @@ typedef uint32_t ioportid_t; *
* @param[in] port port identifier
* @return The latched logical states.
+ *
+ * @notapi
*/
#define pal_lld_readlatch(port)
@@ -127,6 +133,8 @@ typedef uint32_t ioportid_t; *
* @param[in] port port identifier
* @param[in] bits bits to be written on the specified port
+ *
+ * @notapi
*/
#define pal_lld_writeport(port, bits)
@@ -140,6 +148,8 @@ typedef uint32_t ioportid_t; *
* @param[in] port port identifier
* @param[in] bits bits to be ORed on the specified port
+ *
+ * @notapi
*/
#define pal_lld_setport(port, bits)
@@ -153,6 +163,8 @@ typedef uint32_t ioportid_t; *
* @param[in] port port identifier
* @param[in] bits bits to be cleared on the specified port
+ *
+ * @notapi
*/
#define pal_lld_clearport(port, bits)
@@ -166,6 +178,8 @@ typedef uint32_t ioportid_t; *
* @param[in] port port identifier
* @param[in] bits bits to be XORed on the specified port
+ *
+ * @notapi
*/
#define pal_lld_toggleport(port, bits)
@@ -181,6 +195,8 @@ typedef uint32_t ioportid_t; * @param[in] mask group mask
* @param[in] offset group bit offset within the port
* @return The group logical states.
+ *
+ * @notapi
*/
#define pal_lld_readgroup(port, mask, offset)
@@ -197,6 +213,8 @@ typedef uint32_t ioportid_t; * @param[in] offset group bit offset within the port
* @param[in] bits bits to be written. Values exceeding the group width
* are masked.
+ *
+ * @notapi
*/
#define pal_lld_writegroup(port, mask, offset, bits)
@@ -211,6 +229,8 @@ typedef uint32_t ioportid_t; * @param[in] port port identifier
* @param[in] mask group mask
* @param[in] mode group mode
+ *
+ * @notapi
*/
#define pal_lld_setgroupmode(port, mask, mode)
@@ -227,6 +247,8 @@ typedef uint32_t ioportid_t; * @return The logical state.
* @retval PAL_LOW low logical state.
* @retval PAL_HIGH high logical state.
+ *
+ * @notapi
*/
#define pal_lld_readpad(port, pad)
@@ -240,8 +262,10 @@ typedef uint32_t ioportid_t; *
* @param[in] port port identifier
* @param[in] pad pad number within the port
- * @param[out] bit logical value, the value must be @p PAL_LOW or
+ * @param[in] bit logical value, the value must be @p PAL_LOW or
* @p PAL_HIGH
+ *
+ * @notapi
*/
#define pal_lld_writepad(port, pad, bit)
@@ -255,6 +279,8 @@ typedef uint32_t ioportid_t; *
* @param[in] port port identifier
* @param[in] pad pad number within the port
+ *
+ * @notapi
*/
#define pal_lld_setpad(port, pad)
@@ -268,6 +294,8 @@ typedef uint32_t ioportid_t; *
* @param[in] port port identifier
* @param[in] pad pad number within the port
+ *
+ * @notapi
*/
#define pal_lld_clearpad(port, pad)
@@ -281,6 +309,8 @@ typedef uint32_t ioportid_t; *
* @param[in] port port identifier
* @param[in] pad pad number within the port
+ *
+ * @notapi
*/
#define pal_lld_togglepad(port, pad)
@@ -297,6 +327,8 @@ typedef uint32_t ioportid_t; * @param[in] port port identifier
* @param[in] pad pad number within the port
* @param[in] mode pad mode
+ *
+ * @notapi
*/
#define pal_lld_setpadmode(port, pad, mode)
diff --git a/os/hal/templates/pwm_lld.c b/os/hal/templates/pwm_lld.c index c37db97ea..d71427cb2 100644 --- a/os/hal/templates/pwm_lld.c +++ b/os/hal/templates/pwm_lld.c @@ -50,6 +50,8 @@ /**
* @brief Low level PWM driver initialization.
+ *
+ * @notapi
*/
void pwm_lld_init(void) {
@@ -59,6 +61,8 @@ void pwm_lld_init(void) { * @brief Configures and activates the PWM peripheral.
*
* @param[in] pwmp pointer to the @p PWMDriver object
+ *
+ * @notapi
*/
void pwm_lld_start(PWMDriver *pwmp) {
@@ -72,6 +76,8 @@ void pwm_lld_start(PWMDriver *pwmp) { * @brief Deactivates the PWM peripheral.
*
* @param[in] pwmp pointer to the @p PWMDriver object
+ *
+ * @notapi
*/
void pwm_lld_stop(PWMDriver *pwmp) {
@@ -85,6 +91,8 @@ void pwm_lld_stop(PWMDriver *pwmp) { * @return The PWM channel status.
* @retval FALSE the channel is not enabled.
* @retval TRUE the channel is enabled.
+ *
+ * @notapi
*/
bool_t pwm_lld_is_enabled(PWMDriver *pwmp, pwmchannel_t channel) {
@@ -99,6 +107,8 @@ bool_t pwm_lld_is_enabled(PWMDriver *pwmp, pwmchannel_t channel) { * @param[in] channel PWM channel identifier
* @param[in] edge output edge mode
* @param[in] callback callback function
+ *
+ * @notapi
*/
void pwm_lld_set_callback(PWMDriver *pwmp, pwmchannel_t channel,
pwmedge_t edge, pwmcallback_t callback) {
@@ -111,6 +121,8 @@ void pwm_lld_set_callback(PWMDriver *pwmp, pwmchannel_t channel, * @param[in] pwmp pointer to the @p PWMDriver object
* @param[in] channel PWM channel identifier
* @param[in] width PWM pulse width as clock pulses number
+ *
+ * @notapi
*/
void pwm_lld_enable_channel(PWMDriver *pwmp,
pwmchannel_t channel,
@@ -125,6 +137,8 @@ void pwm_lld_enable_channel(PWMDriver *pwmp, *
* @param[in] pwmp pointer to the @p PWMDriver object
* @param[in] channel PWM channel identifier
+ *
+ * @notapi
*/
void pwm_lld_disable_channel(PWMDriver *pwmp, pwmchannel_t channel) {
diff --git a/os/hal/templates/serial_lld.c b/os/hal/templates/serial_lld.c index 01d50de68..39b1f6bc4 100644 --- a/os/hal/templates/serial_lld.c +++ b/os/hal/templates/serial_lld.c @@ -58,6 +58,8 @@ static const SerialConfig default_config = { /**
* @brief Low level serial driver initialization.
+ *
+ * @notapi
*/
void sd_lld_init(void) {
@@ -70,6 +72,8 @@ void sd_lld_init(void) { * @param[in] config the architecture-dependent serial driver configuration.
* If this parameter is set to @p NULL then a default
* configuration is used.
+ *
+ * @notapi
*/
void sd_lld_start(SerialDriver *sdp, const SerialConfig *config) {
@@ -84,6 +88,8 @@ void sd_lld_start(SerialDriver *sdp, const SerialConfig *config) { * interrupt vector.
*
* @param[in] sdp pointer to a @p SerialDriver object
+ *
+ * @notapi
*/
void sd_lld_stop(SerialDriver *sdp) {
diff --git a/os/hal/templates/spi_lld.c b/os/hal/templates/spi_lld.c index 769e13b51..19af51488 100644 --- a/os/hal/templates/spi_lld.c +++ b/os/hal/templates/spi_lld.c @@ -52,6 +52,8 @@ /**
* @brief Low level SPI driver initialization.
+ *
+ * @notapi
*/
void spi_lld_init(void) {
@@ -61,6 +63,8 @@ void spi_lld_init(void) { * @brief Configures and activates the SPI peripheral.
*
* @param[in] spip pointer to the @p SPIDriver object
+ *
+ * @notapi
*/
void spi_lld_start(SPIDriver *spip) {
@@ -74,6 +78,8 @@ void spi_lld_start(SPIDriver *spip) { * @brief Deactivates the SPI peripheral.
*
* @param[in] spip pointer to the @p SPIDriver object
+ *
+ * @notapi
*/
void spi_lld_stop(SPIDriver *spip) {
@@ -83,6 +89,8 @@ void spi_lld_stop(SPIDriver *spip) { * @brief Asserts the slave select signal and prepares for transfers.
*
* @param[in] spip pointer to the @p SPIDriver object
+ *
+ * @notapi
*/
void spi_lld_select(SPIDriver *spip) {
@@ -93,6 +101,8 @@ void spi_lld_select(SPIDriver *spip) { * @details The previously selected peripheral is unselected.
*
* @param[in] spip pointer to the @p SPIDriver object
+ *
+ * @notapi
*/
void spi_lld_unselect(SPIDriver *spip) {
@@ -106,6 +116,8 @@ void spi_lld_unselect(SPIDriver *spip) { *
* @param[in] spip pointer to the @p SPIDriver object
* @param[in] n number of words to be ignored
+ *
+ * @notapi
*/
void spi_lld_ignore(SPIDriver *spip, size_t n) {
@@ -121,6 +133,8 @@ void spi_lld_ignore(SPIDriver *spip, size_t n) { * @param[in] n number of words to be exchanged
* @param[in] txbuf the pointer to the transmit buffer
* @param[out] rxbuf the pointer to the receive buffer
+ *
+ * @notapi
*/
void spi_lld_exchange(SPIDriver *spip, size_t n,
const void *txbuf, void *rxbuf) {
@@ -135,6 +149,8 @@ void spi_lld_exchange(SPIDriver *spip, size_t n, * @param[in] spip pointer to the @p SPIDriver object
* @param[in] n number of words to send
* @param[in] txbuf the pointer to the transmit buffer
+ *
+ * @notapi
*/
void spi_lld_send(SPIDriver *spip, size_t n, const void *txbuf) {
@@ -148,6 +164,8 @@ void spi_lld_send(SPIDriver *spip, size_t n, const void *txbuf) { * @param[in] spip pointer to the @p SPIDriver object
* @param[in] n number of words to receive
* @param[out] rxbuf the pointer to the receive buffer
+ *
+ * @notapi
*/
void spi_lld_receive(SPIDriver *spip, size_t n, void *rxbuf) {
diff --git a/os/hal/templates/uart_lld.c b/os/hal/templates/uart_lld.c index b48620a71..3180ee8e7 100644 --- a/os/hal/templates/uart_lld.c +++ b/os/hal/templates/uart_lld.c @@ -52,6 +52,8 @@ /**
* @brief Low level UART driver initialization.
+ *
+ * @notapi
*/
void uart_lld_init(void) {
@@ -61,6 +63,8 @@ void uart_lld_init(void) { * @brief Configures and activates the UART peripheral.
*
* @param[in] uartp pointer to the @p UARTDriver object
+ *
+ * @notapi
*/
void uart_lld_start(UARTDriver *uartp) {
@@ -74,6 +78,8 @@ void uart_lld_start(UARTDriver *uartp) { * @brief Deactivates the UART peripheral.
*
* @param[in] uartp pointer to the @p UARTDriver object
+ *
+ * @notapi
*/
void uart_lld_stop(UARTDriver *uartp) {
@@ -87,6 +93,8 @@ void uart_lld_stop(UARTDriver *uartp) { * @param[in] uartp pointer to the @p UARTDriver object
* @param[in] n number of data frames to send
* @param[in] txbuf the pointer to the transmit buffer
+ *
+ * @notapi
*/
void uart_lld_start_send(UARTDriver *uartp, size_t n, const void *txbuf) {
@@ -100,6 +108,8 @@ void uart_lld_start_send(UARTDriver *uartp, size_t n, const void *txbuf) { *
* @return The number of data frames not transmitted by the
* stopped transmit operation.
+ *
+ * @notapi
*/
size_t uart_lld_stop_send(UARTDriver *uartp) {
@@ -113,6 +123,8 @@ size_t uart_lld_stop_send(UARTDriver *uartp) { * @param[in] uartp pointer to the @p UARTDriver object
* @param[in] n number of data frames to send
* @param[in] rxbuf the pointer to the receive buffer
+ *
+ * @notapi
*/
void uart_lld_start_receive(UARTDriver *uartp, size_t n, void *rxbuf) {
@@ -126,6 +138,8 @@ void uart_lld_start_receive(UARTDriver *uartp, size_t n, void *rxbuf) { *
* @return The number of data frames not received by the
* stopped receive operation.
+ *
+ * @notapi
*/
size_t uart_lld_stop_receive(UARTDriver *uartp) {
|