begriffs open source - freertos/blob - Demo/lwIP_Demo_Rowley_ARM7/EMAC/SAM7_EMAC.h

   1 /*\r
   2         FreeRTOS.org V5.2.0 - Copyright (C) 2003-2009 Richard Barry.\r
   3 \r
   4         This file is part of the FreeRTOS.org distribution.\r
   5 \r
   6         FreeRTOS.org is free software; you can redistribute it and/or modify it \r
   7         under the terms of the GNU General Public License (version 2) as published\r
   8         by the Free Software Foundation and modified by the FreeRTOS exception.\r
   9 \r
  10         FreeRTOS.org is distributed in the hope that it will be useful, but WITHOUT\r
  11         ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or \r
  12         FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for \r
  13         more details.\r
  14 \r
  15         You should have received a copy of the GNU General Public License along \r
  16         with FreeRTOS.org; if not, write to the Free Software Foundation, Inc., 59 \r
  17         Temple Place, Suite 330, Boston, MA  02111-1307  USA.\r
  18 \r
  19         A special exception to the GPL is included to allow you to distribute a \r
  20         combined work that includes FreeRTOS.org without being obliged to provide\r
  21         the source code for any proprietary components.  See the licensing section\r
  22         of http://www.FreeRTOS.org for full details.\r
  23 \r
  24 \r
  25         ***************************************************************************\r
  26         *                                                                         *\r
  27         * Get the FreeRTOS eBook!  See http://www.FreeRTOS.org/Documentation      *\r
  28         *                                                                         *\r
  29         * This is a concise, step by step, 'hands on' guide that describes both   *\r
  30         * general multitasking concepts and FreeRTOS specifics. It presents and   *\r
  31         * explains numerous examples that are written using the FreeRTOS API.     *\r
  32         * Full source code for all the examples is provided in an accompanying    *\r
  33         * .zip file.                                                              *\r
  34         *                                                                         *\r
  35         ***************************************************************************\r
  36 \r
  37         1 tab == 4 spaces!\r
  38 \r
  39         Please ensure to read the configuration and relevant port sections of the\r
  40         online documentation.\r
  41 \r
  42         http://www.FreeRTOS.org - Documentation, latest information, license and\r
  43         contact details.\r
  44 \r
  45         http://www.SafeRTOS.com - A version that is certified for use in safety\r
  46         critical systems.\r
  47 \r
  48         http://www.OpenRTOS.com - Commercial support, development, porting,\r
  49         licensing and training services.\r
  50 */\r
  51 \r
  52 /*\r
  53 Changes from V3.2.4\r
  54 \r
  55         + Modified the default MAC address as the one used previously was not liked\r
  56           by some routers.\r
  57 \r
  58 */\r
  59 \r
  60 #ifndef SAM_7_EMAC_H\r
  61 #define SAM_7_EMAC_H\r
  62 \r
  63 /* MAC address definition.  The MAC address must be unique on the network. */\r
  64 #define emacETHADDR0 0\r
  65 #define emacETHADDR1 0xbd\r
  66 #define emacETHADDR2 0x33\r
  67 #define emacETHADDR3 0x06\r
  68 #define emacETHADDR4 0x68\r
  69 #define emacETHADDR5 0x22\r
  70 \r
  71 /* The IP address being used. */\r
  72 #define emacIPADDR0 172\r
  73 #define emacIPADDR1 25\r
  74 #define emacIPADDR2 218\r
  75 #define emacIPADDR3 205\r
  76 \r
  77 /* The gateway address being used. */\r
  78 #define emacGATEWAY_ADDR0 172\r
  79 #define emacGATEWAY_ADDR1 25\r
  80 #define emacGATEWAY_ADDR2 218\r
  81 #define emacGATEWAY_ADDR3 3\r
  82 \r
  83 /* The network mask being used. */\r
  84 #define emacNET_MASK0 255\r
  85 #define emacNET_MASK1 255\r
  86 #define emacNET_MASK2 0\r
  87 #define emacNET_MASK3 0\r
  88 \r
  89 /*\r
  90  * Initialise the EMAC driver.  If successful a semaphore is returned that\r
  91  * is used by the EMAC ISR to indicate that Rx packets have been received.\r
  92  * If the initialisation fails then NULL is returned.\r
  93  */\r
  94 xSemaphoreHandle xEMACInit( void );\r
  95 \r
  96 /*\r
  97  * Send ulLength bytes from pcFrom.  This copies the buffer to one of the\r
  98  * EMAC Tx buffers, then indicates to the EMAC that the buffer is ready.\r
  99  * If lEndOfFrame is true then the data being copied is the end of the frame\r
 100  * and the frame can be transmitted. \r
 101  */\r
 102 portLONG lEMACSend( portCHAR *pcFrom, unsigned portLONG ulLength, portLONG lEndOfFrame );\r
 103 \r
 104 /*\r
 105  * Frames can be read from the EMAC in multiple sections.\r
 106  * Read ulSectionLength bytes from the EMAC receive buffers to pcTo.  \r
 107  * ulTotalFrameLength is the size of the entire frame.  Generally vEMACRead\r
 108  * will be repetedly called until the sum of all the ulSectionLenths totals\r
 109  * the value of ulTotalFrameLength.\r
 110  */\r
 111 void vEMACRead( portCHAR *pcTo, unsigned portLONG ulSectionLength, unsigned portLONG ulTotalFrameLength );\r
 112 \r
 113 /*\r
 114  * The EMAC driver and interrupt service routines are defined in different \r
 115  * files as the driver is compiled to THUMB, and the ISR to ARM.  This function\r
 116  * simply passes the semaphore used to communicate between the two.\r
 117  */\r
 118 void vPassEMACSemaphore( xSemaphoreHandle xCreatedSemaphore );\r
 119 \r
 120 /* \r
 121  * Called by the Tx interrupt, this function traverses the buffers used to\r
 122  * hold the frame that has just completed transmission and marks each as\r
 123  * free again.\r
 124  */\r
 125 void vClearEMACTxBuffer( void );\r
 126 \r
 127 /*\r
 128  * Suspend on a semaphore waiting either for the semaphore to be obtained \r
 129  * or a timeout.  The semaphore is used by the EMAC ISR to indicate that\r
 130  * data has been received and is ready for processing.\r
 131  */\r
 132 void vEMACWaitForInput( void );\r
 133 \r
 134 /*\r
 135  * Return the length of the next frame in the receive buffers.\r
 136  */\r
 137 unsigned portLONG ulEMACInputLength( void );\r
 138 \r
 139 #endif\r