diff options
| author | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2010-02-06 16:17:30 +0000 |
|---|---|---|
| committer | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2010-02-06 16:17:30 +0000 |
| commit | e3c7dc319ff582f9eb4a593950ac7bedb1d38b77 (patch) | |
| tree | 7646d3700bef00d4ee01bafa24523ff9b6f2f4b5 /os/hal/include/mac.h | |
| parent | f362c3ceb4227d96532f24d7d20f215e2c488ec6 (diff) | |
| download | ChibiOS-e3c7dc319ff582f9eb4a593950ac7bedb1d38b77.tar.gz ChibiOS-e3c7dc319ff582f9eb4a593950ac7bedb1d38b77.tar.bz2 ChibiOS-e3c7dc319ff582f9eb4a593950ac7bedb1d38b77.zip | |
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@1571 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'os/hal/include/mac.h')
| -rw-r--r-- | os/hal/include/mac.h | 39 |
1 files changed, 20 insertions, 19 deletions
diff --git a/os/hal/include/mac.h b/os/hal/include/mac.h index 85da4fc57..29381bab3 100644 --- a/os/hal/include/mac.h +++ b/os/hal/include/mac.h @@ -18,8 +18,8 @@ */
/**
- * @file mac.h
- * @brief MAC Driver macros and structures.
+ * @file mac.h
+ * @brief MAC Driver macros and structures.
* @addtogroup MAC
* @{
*/
@@ -56,37 +56,38 @@ /*===========================================================================*/
/**
- * @brief Returns the received frames event source.
+ * @brief Returns the received frames event source.
* - * @param[in] macp pointer to the @p MACDriver object
- * @return The pointer to the @p EventSource structure.
+ * @param[in] macp pointer to the @p MACDriver object
+ * @return The pointer to the @p EventSource structure.
*/
#if CH_USE_EVENTS || defined(__DOXYGEN__)
#define macGetReceiveEventSource(macp) (&(macp)->md_rdevent)
#endif
/**
- * @brief Writes to a transmit descriptor's stream.
+ * @brief Writes to a transmit descriptor's stream.
* - * @param[in] tdp pointer to a @p MACTransmitDescriptor structure
- * @param[in] buf pointer to the buffer containing the data to be written
- * @param[in] size number of bytes to be written
- * @return The number of bytes written into the descriptor's stream, this
- * value can be less than the amount specified in the parameter
- * @p size if the maximum frame size is reached.
+ * @param[in] tdp pointer to a @p MACTransmitDescriptor structure
+ * @param[in] buf pointer to the buffer containing the data to be written
+ * @param[in] size number of bytes to be written
+ * @return The number of bytes written into the descriptor's
+ * stream, this value can be less than the amount
+ * specified in the parameter @p size if the maximum frame
+ * size is reached.
*/
#define macWriteTransmitDescriptor(tdp, buf, size) \
mac_lld_write_transmit_descriptor(tdp, buf, size)
/**
- * @brief Reads from a receive descriptor's stream.
+ * @brief Reads from a receive descriptor's stream.
*
- * @param[in] rdp pointer to a @p MACReceiveDescriptor structure
- * @param[in] buf pointer to the buffer that will receive the read data
- * @param[in] size number of bytes to be read
- * @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.
+ * @param[in] rdp pointer to a @p MACReceiveDescriptor structure
+ * @param[in] buf pointer to the buffer that will receive the read data
+ * @param[in] size number of bytes to be read
+ * @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.
*/
#define macReadReceiveDescriptor(rdp, buf, size) \
mac_lld_read_receive_descriptor(rdp, buf, size)
|