]> git.sur5r.net Git - freertos/blobdiff - Demo/CORTEX_A2F200_IAR_and_Keil/MicroSemi_Code/drivers/mss_ethernet_mac/mss_ethernet_mac.h
Update MAC drivers so they use a uIP specific zero copy mechanism.
[freertos] / Demo / CORTEX_A2F200_IAR_and_Keil / MicroSemi_Code / drivers / mss_ethernet_mac / mss_ethernet_mac.h
index 0757105a5c6af17d383b9099fd86bae9cfd8b197..65ac8ee3ccc543308b9a542d6b29fafefe6cca28 100644 (file)
@@ -16,7 +16,7 @@
 \r
 #ifdef __cplusplus\r
 extern "C" {\r
-#endif \r
+#endif\r
 \r
 /******************************** DEFINES *************************************/\r
 \r
@@ -160,7 +160,7 @@ extern "C" {
 #define MSS_PHY_ADDRESS_AUTO_DETECT            255u\r
 \r
 /***************************************************************************//**\r
- * Listener function type defines the function prototype that might be followed \r
+ * Listener function type defines the function prototype that might be followed\r
  * by MAC_isr which is triggered with each receive and transmit related interrupts.\r
  * Listener functions should follow the following prototype:\r
  *             void MAC_Listener( uint32_t events );\r
@@ -168,7 +168,7 @@ extern "C" {
  * or events. Events input to the system are:\r
  *      #define MSS_MAC_EVENT_PACKET_SEND              1\r
  *      #define MSS_MAC_EVENT_PACKET_RECEIVED  2\r
- * Listener function should be defined by the application using this driver if \r
+ * Listener function should be defined by the application using this driver if\r
  * needed. This function may be assigned to the driver using MAC_set_callback\r
  * routine and may be un assigned again by using the same routine with a NULL pointer\r
  * as the event listener function. It is recommended to use this property for interrupt\r
@@ -177,7 +177,7 @@ extern "C" {
 typedef void (*MSS_MAC_callback_t)(uint32_t events);\r
 \r
 /***************************************************************************//**\r
- * Statistics counter identifiers are used with MAC_get_statistics routine to \r
+ * Statistics counter identifiers are used with MAC_get_statistics routine to\r
  * receive the count of the requested errors/interrupts occurrences.\r
  *\r
  * MSS_MAC_RX_INTERRUPTS\r
@@ -270,7 +270,7 @@ typedef enum {
        MSS_MAC_TX_EXCESSIVE_COLLISION,\r
        MSS_MAC_TX_COLLISION_COUNT,\r
        MSS_MAC_TX_UNDERFLOW_ERROR\r
-} mss_mac_statistics_id_t; \r
+} mss_mac_statistics_id_t;\r
 \r
 /******************************* FUNCTIONS ************************************/\r
 \r
@@ -317,7 +317,7 @@ MSS_MAC_configure
 \r
 /***************************************************************************//**\r
  * Returns the configuration of the Ethernet Controller.\r
- * After the MAC_init function has been called, this API function can be used to \r
+ * After the MAC_init function has been called, this API function can be used to\r
  * get the configuration of the Ethernet Controller.\r
  *\r
  * @return              The logical OR of the following values:\r
@@ -366,7 +366,7 @@ MSS_MAC_tx_packet
  * Returns available packet's size.\r
  *\r
  * @return              Size of packet, bigger than 0, if a packet is available,\r
- *                      if not, returns 0. \r
+ *                      if not, returns 0.\r
  * @see   MAC_rx_packet()\r
  */\r
 int32_t\r
@@ -416,26 +416,26 @@ MSS_MAC_rx_packet
   used by the user application or copied to another buffer, the\r
   MSS_MAC_prepare_rx_descriptor() function must be called to free up the receive\r
   memory buffer used by the MSS Ethernet MAC\r
\r
+\r
   @param pacData\r
    The pacData parameter is a pointer to a memory buffer pointer. The uint8_t\r
    pointer pointed to by the pacData parameter will contain the address of the\r
    memory buffer containing the received packet after this function returns. The\r
    value of pacData is only valid if the return value is larger than zero,\r
    indicating that a packet was received.\r
-   \r
+\r
   @param time_out\r
     The time_out parameter is the timeout value for the transmission in milliseconds.\r
     The time_out parameter value can be one of the following values:\r
         \95 Unsigned integer greater than 0 and less than 0x01000000\r
-        \95 MSS_MAC_BLOCKING \96 there will be no timeout. \r
+        \95 MSS_MAC_BLOCKING \96 there will be no timeout.\r
         \95 MSS_MAC_NONBLOCKING \96 the function will return immediately if no packets\r
-          have been received. \r
+          have been received.\r
 \r
   @return\r
        The function returns the size of the packet if the packet fits in pacData.\r
     Returns zero if there is no received packet.\r
-                        \r
+\r
   @see   MAC_rx_pckt_size()\r
   @see   MAC_tx_packet()\r
  */\r
@@ -537,10 +537,10 @@ MSS_MAC_set_callback
 /***************************************************************************//**\r
  * Returns description of latest error happened.\r
  *\r
- * @return              A string describing the error. This string must not be \r
+ * @return              A string describing the error. This string must not be\r
  *                                             modified by the application.\r
  */\r
-const int8_t* \r
+const int8_t*\r
 MSS_MAC_last_error\r
 (\r
     void\r
@@ -549,7 +549,7 @@ MSS_MAC_last_error
 \r
 /***************************************************************************//**\r
  * Returns statistics counter of stat_id identifier.\r
- * \r
+ *\r
  * @param stat_id              Identifier of statistics counter.\r
  * @return                             Statistics counter of stat_id identifier.\r
  *                                             On error returns 0.\r
@@ -560,23 +560,11 @@ MSS_MAC_get_statistics
        mss_mac_statistics_id_t stat_id\r
 );\r
 \r
-/*\r
- * Ensure uip_buf is pointing to a valid and free buffer before any transmissions\r
- * initiated by the uIP stack occur.
- */\r
-unsigned char *MSS_MAC_GetTxDescriptor( void );\r
-\r
-/*\r
- * A buffer is no longer required by the application.  Hand it back to the\r
- * control of the MAC hardware.
- */\r
-void MSS_MAC_ReleaseBuffer( unsigned char *pucBuffer );\r
-\r
 /*\r
  * The double Tx has completed.  Hand back the Tx buffer to the control of\r
- * the MAC hardware.
+ * the MAC hardware.\r
  */\r
-void MSS_MAC_TxBufferCompleted( void );\r
+void MSS_MAC_CheckTxBufferStatus( void );\r
 #ifdef __cplusplus\r
 }\r
 #endif\r