diff options
Diffstat (limited to 'os/hal/src/mac.c')
| -rw-r--r-- | os/hal/src/mac.c | 17 |
1 files changed, 16 insertions, 1 deletions
diff --git a/os/hal/src/mac.c b/os/hal/src/mac.c index a079556fe..62340dc31 100644 --- a/os/hal/src/mac.c +++ b/os/hal/src/mac.c @@ -52,6 +52,8 @@ /**
* @brief MAC Driver initialization.
+ *
+ * @init
*/
void macInit(void) {
@@ -62,6 +64,8 @@ void macInit(void) { * @brief Initialize the standard part of a @p MACDriver structure.
*
* @param[in] macp pointer to the @p MACDriver object
+ *
+ * @init
*/
void macObjectInit(MACDriver *macp) {
@@ -74,7 +78,7 @@ void macObjectInit(MACDriver *macp) { /**
* @brief MAC address setup.
- * @note This function must be invoked only with the driver in the stopped
+ * @pre This function must be invoked with the driver in the stopped
* state. If invoked on an active interface then it is ignored.
*
* @param[in] macp pointer to the @p MACDriver object
@@ -82,6 +86,7 @@ void macObjectInit(MACDriver *macp) { * address. If this parameter is set to @p NULL then MAC
* a system default is used.
*
+ * @api
*/
void macSetAddress(MACDriver *macp, const uint8_t *p) {
@@ -104,6 +109,8 @@ void macSetAddress(MACDriver *macp, const uint8_t *p) { * @return The operation status.
* @retval RDY_OK the descriptor was obtained.
* @retval RDY_TIMEOUT the operation timed out, descriptor not initialized.
+ *
+ * @api
*/
msg_t macWaitTransmitDescriptor(MACDriver *macp,
MACTransmitDescriptor *tdp,
@@ -128,6 +135,8 @@ msg_t macWaitTransmitDescriptor(MACDriver *macp, * enqueued data as a single frame.
*
* @param[in] tdp the pointer to the @p MACTransmitDescriptor structure
+ *
+ * @api
*/
void macReleaseTransmitDescriptor(MACTransmitDescriptor *tdp) {
@@ -150,6 +159,8 @@ void macReleaseTransmitDescriptor(MACTransmitDescriptor *tdp) { * @return The operation status.
* @retval RDY_OK the descriptor was obtained.
* @retval RDY_TIMEOUT the operation timed out, descriptor not initialized.
+ *
+ * @api
*/
msg_t macWaitReceiveDescriptor(MACDriver *macp,
MACReceiveDescriptor *rdp,
@@ -175,6 +186,8 @@ msg_t macWaitReceiveDescriptor(MACDriver *macp, * frames.
*
* @param[in] rdp the pointer to the @p MACReceiveDescriptor structure
+ *
+ * @api
*/
void macReleaseReceiveDescriptor(MACReceiveDescriptor *rdp) {
@@ -188,6 +201,8 @@ void macReleaseReceiveDescriptor(MACReceiveDescriptor *rdp) { * @return The link status.
* @retval TRUE if the link is active.
* @retval FALSE if the link is down.
+ *
+ * @api
*/
bool_t macPollLinkStatus(MACDriver *macp) {
|