git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@3290 35acf78f-673a-0410-8e92-d51de3d6d3f4

2 files changed, 89 insertions, 37 deletions

diff --git a/os/hal/templates/mac_lld.c b/os/hal/templates/mac_lld.c
index 62b8765d0..ecd7f82bd 100644
--- a/os/hal/templates/mac_lld.c
+++ b/os/hal/templates/mac_lld.c
@@ -39,6 +39,11 @@
 /* Driver exported variables.                                                */

 /*===========================================================================*/

 

+/**

+ * @brief   Ethernet driver 1.

+ */

+MACDriver ETH1;

+

 /*===========================================================================*/

 /* Driver local variables.                                                   */

 /*===========================================================================*/

@@ -65,16 +70,24 @@ void mac_lld_init(void) {
 }

 

 /**

- * @brief   Low level MAC address setup.

+ * @brief   Configures and activates the MAC peripheral.

  *

  * @param[in] macp      pointer to the @p MACDriver object

- * @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) {

+void mac_lld_start(MACDriver *macp) {

+

+}

+

+/**

+ * @brief   Deactivates the MAC peripheral.

+ *

+ * @param[in] macp      pointer to the @p MACDriver object

+ *

+ * @notapi

+ */

+void mac_lld_stop(MACDriver *macp) {

 

 }

 

@@ -86,7 +99,7 @@ void mac_lld_set_address(MACDriver *macp, const uint8_t *p) {
  * @param[in] macp      pointer to the @p MACDriver object

  * @param[out] tdp      pointer to a @p MACTransmitDescriptor structure

  * @return              The operation status.

- * @retval RDY_OK       a descriptor was obtained.

+ * @retval RDY_OK       the descriptor has been obtained.

  * @retval RDY_TIMEOUT  descriptor not available.

  *

  * @notapi

@@ -101,7 +114,7 @@ msg_t max_lld_get_transmit_descriptor(MACDriver *macp,
  * @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

+ * @param[in] buf       pointer to the buffer cointaining the data to be

  *                      written

  * @param[in] size      number of bytes to be written

  * @return              The number of bytes written into the descriptor's

@@ -122,7 +135,7 @@ size_t mac_lld_write_transmit_descriptor(MACTransmitDescriptor *tdp,
  * @brief   Releases a transmit descriptor and starts the transmission of the

  *          enqueued data as a single frame.

  *

- * @param[in] tdp       pointer to a @p MACTransmitDescriptor structure

+ * @param[in] tdp       the pointer to the @p MACTransmitDescriptor structure

  *

  * @notapi

  */

@@ -133,10 +146,10 @@ void mac_lld_release_transmit_descriptor(MACTransmitDescriptor *tdp) {
 /**

  * @brief   Returns a receive descriptor.

  *

- * @param[in] macp      pointer to a @p MACDriver object

+ * @param[in] macp      pointer to the @p MACDriver object

  * @param[out] rdp      pointer to a @p MACReceiveDescriptor structure

  * @return              The operation status.

- * @retval RDY_OK       a descriptor was obtained.

+ * @retval RDY_OK       the descriptor has been obtained.

  * @retval RDY_TIMEOUT  descriptor not available.

  *

  * @notapi

@@ -144,18 +157,19 @@ void mac_lld_release_transmit_descriptor(MACTransmitDescriptor *tdp) {
 msg_t max_lld_get_receive_descriptor(MACDriver *macp,

                                      MACReceiveDescriptor *rdp) {

 

-  return RDY_OK;

+  return RDY_TIMEOUT;

 }

 

 /**

  * @brief   Reads from a receive descriptor's stream.

  *

- * @param[in] rdp   pointer to a @p MACReceiveDescriptor structure

- * @param[in] buf   pointer to a 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.

  *

  * @notapi

  */

@@ -171,7 +185,7 @@ size_t mac_lld_read_receive_descriptor(MACReceiveDescriptor *rdp,
  * @details The descriptor and its buffer are made available for more incoming

  *          frames.

  *

- * @param[in] rdp       pointer to a @p MACReceiveDescriptor structure

+ * @param[in] rdp       the pointer to the @p MACReceiveDescriptor structure

  *

  * @notapi

  */

@@ -182,7 +196,7 @@ void mac_lld_release_receive_descriptor(MACReceiveDescriptor *rdp) {
 /**

  * @brief   Updates and returns the link status.

  *

- * @param[in] macp      pointer to a @p MACDriver object

+ * @param[in] macp      pointer to the @p MACDriver object

  * @return              The link status.

  * @retval TRUE         if the link is active.

  * @retval FALSE        if the link is down.

@@ -191,7 +205,6 @@ void mac_lld_release_receive_descriptor(MACReceiveDescriptor *rdp) {
  */

 bool_t mac_lld_poll_link_status(MACDriver *macp) {

 

-  return FALSE;

 }

 

 #endif /* HAL_USE_MAC */

diff --git a/os/hal/templates/mac_lld.h b/os/hal/templates/mac_lld.h
index e103128a9..765ac247e 100644
--- a/os/hal/templates/mac_lld.h
+++ b/os/hal/templates/mac_lld.h
@@ -48,38 +48,72 @@
 /*===========================================================================*/

 

 /**

- * @brief   Structure representing a MAC driver.

- * @note    Implementations may extend this structure to contain more,

- *          architecture dependent, fields.

+ * @brief   Driver configuration structure.

  */

 typedef struct {

-  Semaphore             tdsem;              /**< Transmit semaphore.        */

-  Semaphore             rdsem;              /**< Receive semaphore.         */

-#if CH_USE_EVENTS

-  EventSource           rdevent;            /**< Receive event source.      */

+  /**

+   * @brief MAC address.

+   */

+  uint8_t               *mac_address;

+  /* End of the mandatory fields.*/

+} MACConfig;

+

+/**

+ * @brief   Structure representing a MAC driver.

+ */

+struct MACDriver {

+  /**

+   * @brief Driver state.

+   */

+  macstate_t            state;

+  /**

+   * @brief Current configuration data.

+   */

+  const MACConfig       *config;

+  /**

+   * @brief Transmit semaphore.

+   */

+  Semaphore             tdsem;

+  /**

+   * @brief Receive semaphore.

+   */

+  Semaphore             rdsem;

+#if MAC_USE_EVENTS || defined(__DOXYGEN__)

+  /**

+   * @brief Receive event.

+   */

+  EventSource           rdevent;

 #endif

   /* End of the mandatory fields.*/

-} MACDriver;

+};

 

 /**

  * @brief   Structure representing a transmit descriptor.

- * @note    Implementations may extend this structure to contain more,

- *          architecture dependent, fields.

  */

 typedef struct {

-  size_t                offset;             /**< Current write offset.      */

-  size_t                size;               /**< Available space size.      */

+  /**

+   * @brief Current write offset.

+   */

+  size_t                offset;

+  /**

+   * @brief Available space size.

+   */

+  size_t                size;

   /* End of the mandatory fields.*/

 } MACTransmitDescriptor;

 

 /**

  * @brief   Structure representing a receive descriptor.

- * @note    Implementations may extend this structure to contain more,

- *          architecture dependent, fields.

  */

 typedef struct {

-  size_t                offset;             /**< Current read offset.       */

-  size_t                size;               /**< Available data size.       */

+  /**

+   * @brief Current read offset.

+   */

+  size_t                offset;

+  /**

+   * @brief Available data size.

+   */

+  size_t                size;

   /* End of the mandatory fields.*/

 } MACReceiveDescriptor;

 

@@ -91,11 +125,16 @@ typedef struct {
 /* External declarations.                                                    */

 /*===========================================================================*/

 

+#if !defined(__DOXYGEN__)

+extern MACDriver ETH1;

+#endif

+

 #ifdef __cplusplus

 extern "C" {

 #endif

   void mac_lld_init(void);

-  void mac_lld_set_address(MACDriver *macp, const uint8_t *p);

+  void mac_lld_start(MACDriver *macp);

+  void mac_lld_stop(MACDriver *macp);

   msg_t max_lld_get_transmit_descriptor(MACDriver *macp,

                                         MACTransmitDescriptor *tdp);

   size_t mac_lld_write_transmit_descriptor(MACTransmitDescriptor *tdp,