git.sur5r.net Git - freertos/blob - FreeRTOS-Plus/Source/FreeRTOS-Plus-UDP/portable/NetworkInterface/LPC18xx/Using_LPCOpen_Library/lpc18xx_43xx_EMAC_LPCOpen.h

   1 /*\r
   2  * FreeRTOS+UDP V1.0.4\r
   3  * Copyright (C) 2017 Amazon.com, Inc. or its affiliates.  All Rights Reserved.\r
   4  *\r
   5  * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
   6  * this software and associated documentation files (the "Software"), to deal in\r
   7  * the Software without restriction, including without limitation the rights to\r
   8  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
   9  * the Software, and to permit persons to whom the Software is furnished to do so,\r
  10  * subject to the following conditions:\r
  11  *\r
  12  * The above copyright notice and this permission notice shall be included in all\r
  13  * copies or substantial portions of the Software. If you wish to use our Amazon\r
  14  * FreeRTOS name, please do so in a fair use way that does not cause confusion.\r
  15  *\r
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
  18  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
  19  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
  20  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
  21  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
  22  *\r
  23  * http://www.FreeRTOS.org\r
  24  * http://aws.amazon.com/freertos\r
  25  *\r
  26  * 1 tab == 4 spaces!\r
  27  */\r
  28 \r
  29 #ifndef LPC18xx_43xx_EMAC_H\r
  30 #define LPC18xx_43xx_EMAC_H\r
  31 \r
  32 /*\r
  33  * Initialise the MAC and PHY.\r
  34  */\r
  35 BaseType_t xEMACInit( uint8_t ucMACAddress[ 6 ] );\r
  36 \r
  37 /*\r
  38  * Return pdTRUE if there is a FreeRTOS Tx descriptor.  Return pdFALSE if all\r
  39  * Tx descriptors are already in use.\r
  40  */\r
  41 BaseType_t xEMACIsTxDescriptorAvailable( void );\r
  42 \r
  43 /*\r
  44  * Assign a buffer to a Tx descriptor so it is ready to be transmitted, but\r
  45  * don't start the transmission yet.\r
  46  */\r
  47 void vEMACAssignBufferToDescriptor( uint8_t * pucBuffer );\r
  48 \r
  49 /*\r
  50  * Start transmitting the buffer pointed to by the next Tx descriptor.  The\r
  51  * buffer must have first been allocated to the Tx descriptor using a call to\r
  52  * vEMACAssignBufferToDescriptor().\r
  53  */\r
  54 void vEMACStartNextTransmission( uint32_t ulLength );\r
  55 \r
  56 /*\r
  57  * The data pointed to by the Rx descriptor has been consumed, and the Rx\r
  58  * descriptor can be returned to the control of the DMS.\r
  59  */\r
  60 void vEMACReturnRxDescriptor( void );\r
  61 \r
  62 /*\r
  63  * Returns pdTRUE if the next Rx descriptor contains received data.  Returns\r
  64  * pdFLASE fi the next Rx descriptor is still under the control of the DMA.\r
  65  */\r
  66 BaseType_t xEMACRxDataAvailable( void );\r
  67 void vEMACSwapEmptyBufferForRxedData( xNetworkBufferDescriptor_t *pxNetworkBuffer );\r
  68 \r
  69 #endif /* LPC18xx_43xx_EMAC_H */\r
  70 \r