]> git.sur5r.net Git - freertos/blob - Demo/RX600_RX62N-MDK_IAR/webserver/EMAC.c
Temporarily revert the AVR32 port back to the V6.0.5 files. Work will continue on...
[freertos] / Demo / RX600_RX62N-MDK_IAR / webserver / EMAC.c
1 /*\r
2     FreeRTOS V6.0.5 - Copyright (C) 2010 Real Time Engineers Ltd.\r
3 \r
4     ***************************************************************************\r
5     *                                                                         *\r
6     * If you are:                                                             *\r
7     *                                                                         *\r
8     *    + New to FreeRTOS,                                                   *\r
9     *    + Wanting to learn FreeRTOS or multitasking in general quickly       *\r
10     *    + Looking for basic training,                                        *\r
11     *    + Wanting to improve your FreeRTOS skills and productivity           *\r
12     *                                                                         *\r
13     * then take a look at the FreeRTOS eBook                                  *\r
14     *                                                                         *\r
15     *        "Using the FreeRTOS Real Time Kernel - a Practical Guide"        *\r
16     *                  http://www.FreeRTOS.org/Documentation                  *\r
17     *                                                                         *\r
18     * A pdf reference manual is also available.  Both are usually delivered   *\r
19     * to your inbox within 20 minutes to two hours when purchased between 8am *\r
20     * and 8pm GMT (although please allow up to 24 hours in case of            *\r
21     * exceptional circumstances).  Thank you for your support!                *\r
22     *                                                                         *\r
23     ***************************************************************************\r
24 \r
25     This file is part of the FreeRTOS distribution.\r
26 \r
27     FreeRTOS is free software; you can redistribute it and/or modify it under\r
28     the terms of the GNU General Public License (version 2) as published by the\r
29     Free Software Foundation AND MODIFIED BY the FreeRTOS exception.\r
30     ***NOTE*** The exception to the GPL is included to allow you to distribute\r
31     a combined work that includes FreeRTOS without being obliged to provide the\r
32     source code for proprietary components outside of the FreeRTOS kernel.\r
33     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT\r
34     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\r
35     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for\r
36     more details. You should have received a copy of the GNU General Public\r
37     License and the FreeRTOS license exception along with FreeRTOS; if not it\r
38     can be viewed here: http://www.freertos.org/a00114.html and also obtained\r
39     by writing to Richard Barry, contact details for whom are available on the\r
40     FreeRTOS WEB site.\r
41 \r
42     1 tab == 4 spaces!\r
43 \r
44     http://www.FreeRTOS.org - Documentation, latest information, license and\r
45     contact details.\r
46 \r
47     http://www.SafeRTOS.com - A version that is certified for use in safety\r
48     critical systems.\r
49 \r
50     http://www.OpenRTOS.com - Commercial support, development, porting,\r
51     licensing and training services.\r
52 */\r
53 \r
54 /* Hardware specific includes. */\r
55 #include <iorx62n.h>\r
56 #include "typedefine.h"\r
57 #include "r_ether.h"\r
58 #include "phy.h"\r
59 \r
60 /* FreeRTOS includes. */\r
61 #include "FreeRTOS.h"\r
62 #include "task.h"\r
63 #include "semphr.h"\r
64 \r
65 /* uIP includes. */\r
66 #include "net/uip.h"\r
67 \r
68 /* The time to wait between attempts to obtain a free buffer. */\r
69 #define emacBUFFER_WAIT_DELAY_ms                ( 3 / portTICK_RATE_MS )\r
70 \r
71 /* The number of times emacBUFFER_WAIT_DELAY_ms should be waited before giving\r
72 up on attempting to obtain a free buffer all together. */\r
73 #define emacBUFFER_WAIT_ATTEMPTS        ( 30 )\r
74 \r
75 /* The number of Rx descriptors. */\r
76 #define emacNUM_RX_DESCRIPTORS  8\r
77 \r
78 /* The number of Tx descriptors.  When using uIP there is not point in having\r
79 more than two. */\r
80 #define emacNUM_TX_BUFFERS      2\r
81 \r
82 /* The total number of EMAC buffers to allocate. */\r
83 #define emacNUM_BUFFERS         ( emacNUM_RX_DESCRIPTORS + emacNUM_TX_BUFFERS )\r
84 \r
85 /* The time to wait for the Tx descriptor to become free. */\r
86 #define emacTX_WAIT_DELAY_ms ( 10 / portTICK_RATE_MS )\r
87 \r
88 /* The total number of times to wait emacTX_WAIT_DELAY_ms for the Tx descriptor to\r
89 become free. */\r
90 #define emacTX_WAIT_ATTEMPTS ( 50 )\r
91 \r
92 /* Only Rx end and Tx end interrupts are used by this driver. */\r
93 #define emacTX_END_INTERRUPT    ( 1UL << 21UL )\r
94 #define emacRX_END_INTERRUPT    ( 1UL << 18UL )\r
95 \r
96 /*-----------------------------------------------------------*/\r
97 \r
98 /* The buffers and descriptors themselves.  */\r
99 #pragma data_alignment=32\r
100 volatile ethfifo xRxDescriptors[ emacNUM_RX_DESCRIPTORS ];\r
101 \r
102 #pragma data_alignment=32\r
103 volatile ethfifo xTxDescriptors[ emacNUM_TX_BUFFERS ];\r
104 \r
105 #pragma data_alignment=32\r
106 char xEthernetBuffers[ emacNUM_BUFFERS ][ UIP_BUFSIZE ];\r
107 \r
108 \r
109 /* Used to indicate which buffers are free and which are in use.  If an index\r
110 contains 0 then the corresponding buffer in xEthernetBuffers is free, otherwise\r
111 the buffer is in use or about to be used. */\r
112 static unsigned char ucBufferInUse[ emacNUM_BUFFERS ];\r
113 \r
114 /*-----------------------------------------------------------*/\r
115 \r
116 /*\r
117  * Initialise both the Rx and Tx descriptors.\r
118  */\r
119 static void prvInitialiseDescriptors( void );\r
120 \r
121 /*\r
122  * Return a pointer to a free buffer within xEthernetBuffers.\r
123  */\r
124 static unsigned char *prvGetNextBuffer( void );\r
125 \r
126 /*\r
127  * Return a buffer to the list of free buffers.\r
128  */\r
129 static void prvReturnBuffer( unsigned char *pucBuffer );\r
130 \r
131 /*\r
132  * Examine the status of the next Rx FIFO to see if it contains new data.\r
133  */\r
134 static unsigned long prvCheckRxFifoStatus( void );\r
135 \r
136 /*\r
137  * Setup the microcontroller for communication with the PHY.\r
138  */\r
139 static void prvResetMAC( void );\r
140 \r
141 /*\r
142  * Configure the Ethernet interface peripherals.\r
143  */\r
144 static void prvConfigureEtherCAndEDMAC( void );\r
145 \r
146 /*\r
147  * Something has gone wrong with the descriptor usage.  Reset all the buffers\r
148  * and descriptors.\r
149  */\r
150 static void prvResetEverything( void );\r
151 \r
152 /*-----------------------------------------------------------*/\r
153 \r
154 /* Points to the Rx descriptor currently in use. */\r
155 static volatile ethfifo *pxCurrentDesc = NULL;\r
156 \r
157 /* The buffer used by the uIP stack to both receive and send.  This points to\r
158 one of the Ethernet buffers when its actually in use. */\r
159 unsigned char *uip_buf = NULL;\r
160 \r
161 /*-----------------------------------------------------------*/\r
162 \r
163 void vInitEmac( void )\r
164 {\r
165         /* Software reset. */\r
166         prvResetMAC();\r
167         \r
168         /* Set the Rx and Tx descriptors into their initial state. */\r
169         prvInitialiseDescriptors();\r
170 \r
171         /* Set the MAC address into the ETHERC */\r
172         ETHERC.MAHR =   ( ( unsigned long ) configMAC_ADDR0 << 24UL ) |\r
173                                         ( ( unsigned long ) configMAC_ADDR1 << 16UL ) |\r
174                                         ( ( unsigned long ) configMAC_ADDR2 << 8UL ) |\r
175                                         ( unsigned long ) configMAC_ADDR3;\r
176                                         \r
177         ETHERC.MALR.BIT.MA = ( ( unsigned long ) configMAC_ADDR4 << 8UL ) |\r
178                                                  ( unsigned long ) configMAC_ADDR5;\r
179 \r
180         /* Perform rest of interface hardware configuration. */\r
181         prvConfigureEtherCAndEDMAC();\r
182         \r
183         /* Nothing received yet, so uip_buf points nowhere. */\r
184         uip_buf = NULL;\r
185 \r
186         /* Initialize the PHY */\r
187         phy_init();\r
188 }\r
189 /*-----------------------------------------------------------*/\r
190 \r
191 void vEMACWrite( void )\r
192 {\r
193 long x;\r
194 \r
195         /* Wait until the second transmission of the last packet has completed. */\r
196         for( x = 0; x < emacTX_WAIT_ATTEMPTS; x++ )\r
197         {\r
198                 if( ( xTxDescriptors[ 1 ].status & ACT ) != 0 )\r
199                 {\r
200                         /* Descriptor is still active. */\r
201                         vTaskDelay( emacTX_WAIT_DELAY_ms );\r
202                 }\r
203                 else\r
204                 {\r
205                         break;\r
206                 }\r
207         }\r
208         \r
209         /* Is the descriptor free after waiting for it? */\r
210         if( ( xTxDescriptors[ 1 ].status & ACT ) != 0 )\r
211         {\r
212                 /* Something has gone wrong. */\r
213                 prvResetEverything();\r
214         }\r
215         \r
216         /* Setup both descriptors to transmit the frame. */\r
217         xTxDescriptors[ 0 ].buf_p = ( char * ) uip_buf;\r
218         xTxDescriptors[ 0 ].bufsize = uip_len;  \r
219         xTxDescriptors[ 1 ].buf_p = ( char * ) uip_buf;\r
220         xTxDescriptors[ 1 ].bufsize = uip_len;\r
221 \r
222         /* uip_buf is being sent by the Tx descriptor.  Allocate a new buffer\r
223         for use by the stack. */\r
224         uip_buf = prvGetNextBuffer();\r
225 \r
226         /* Clear previous settings and go. */\r
227         xTxDescriptors[0].status &= ~( FP1 | FP0 );\r
228         xTxDescriptors[0].status |= ( FP1 | FP0 | ACT );\r
229         xTxDescriptors[1].status &= ~( FP1 | FP0 );\r
230         xTxDescriptors[1].status |= ( FP1 | FP0 | ACT );\r
231 \r
232         EDMAC.EDTRR.LONG = 0x00000001;\r
233 }\r
234 /*-----------------------------------------------------------*/\r
235 \r
236 unsigned long ulEMACRead( void )\r
237 {\r
238 unsigned long ulBytesReceived;\r
239 \r
240         ulBytesReceived = prvCheckRxFifoStatus();\r
241 \r
242         if( ulBytesReceived > 0 )\r
243         {\r
244                 pxCurrentDesc->status &= ~( FP1 | FP0 );\r
245                 pxCurrentDesc->status |= ACT;                   \r
246 \r
247                 if( EDMAC.EDRRR.LONG == 0x00000000L )\r
248                 {\r
249                         /* Restart Ethernet if it has stopped */\r
250                         EDMAC.EDRRR.LONG = 0x00000001L;\r
251                 }\r
252 \r
253                 /* Mark the pxDescriptor buffer as free as uip_buf is going to be set to\r
254                 the buffer that contains the received data. */\r
255                 prvReturnBuffer( uip_buf );\r
256                 \r
257                 uip_buf = ( void * ) pxCurrentDesc->buf_p;\r
258 \r
259                 /* Move onto the next buffer in the ring. */\r
260                 pxCurrentDesc = pxCurrentDesc->next;\r
261         }\r
262 \r
263         return ulBytesReceived;\r
264 }\r
265 /*-----------------------------------------------------------*/\r
266 \r
267 long lEMACWaitForLink( void )\r
268 {\r
269 long lReturn;\r
270 \r
271         /* Set the link status. */\r
272         switch( phy_set_autonegotiate() )\r
273         {\r
274                 /* Half duplex link */\r
275                 case PHY_LINK_100H:\r
276                                                                 ETHERC.ECMR.BIT.DM = 0;\r
277                                                                 ETHERC.ECMR.BIT.RTM = 1;\r
278                                                                 lReturn = pdPASS;\r
279                                                                 break;\r
280 \r
281                 case PHY_LINK_10H:\r
282                                                                 ETHERC.ECMR.BIT.DM = 0;\r
283                                                                 ETHERC.ECMR.BIT.RTM = 0;\r
284                                                                 lReturn = pdPASS;\r
285                                                                 break;\r
286 \r
287 \r
288                 /* Full duplex link */\r
289                 case PHY_LINK_100F:\r
290                                                                 ETHERC.ECMR.BIT.DM = 1;\r
291                                                                 ETHERC.ECMR.BIT.RTM = 1;\r
292                                                                 lReturn = pdPASS;\r
293                                                                 break;\r
294                 \r
295                 case PHY_LINK_10F:\r
296                                                                 ETHERC.ECMR.BIT.DM = 1;\r
297                                                                 ETHERC.ECMR.BIT.RTM = 0;\r
298                                                                 lReturn = pdPASS;\r
299                                                                 break;\r
300 \r
301                 default:\r
302                                                                 lReturn = pdFAIL;\r
303                                                                 break;\r
304         }\r
305 \r
306         if( lReturn == pdPASS )\r
307         {\r
308                 /* Enable receive and transmit. */\r
309                 ETHERC.ECMR.BIT.RE = 1;\r
310                 ETHERC.ECMR.BIT.TE = 1;\r
311 \r
312                 /* Enable EDMAC receive */\r
313                 EDMAC.EDRRR.LONG = 0x1;\r
314         }\r
315         \r
316         return lReturn;\r
317 }\r
318 /*-----------------------------------------------------------*/\r
319 \r
320 static void prvInitialiseDescriptors( void )\r
321 {\r
322 volatile ethfifo *pxDescriptor;\r
323 long x;\r
324 \r
325         for( x = 0; x < emacNUM_BUFFERS; x++ )\r
326         {\r
327                 /* Ensure none of the buffers are shown as in use at the start. */\r
328                 ucBufferInUse[ x ] = pdFALSE;\r
329         }\r
330 \r
331         /* Initialise the Rx descriptors. */\r
332         for( x = 0; x < emacNUM_RX_DESCRIPTORS; x++ )\r
333         {\r
334                 pxDescriptor = &( xRxDescriptors[ x ] );\r
335                 pxDescriptor->buf_p = &( xEthernetBuffers[ x ][ 0 ] );\r
336 \r
337                 pxDescriptor->bufsize = UIP_BUFSIZE;\r
338                 pxDescriptor->size = 0;\r
339                 pxDescriptor->status = ACT;\r
340                 pxDescriptor->next = ( ethfifo * ) &xRxDescriptors[ x + 1 ];    \r
341                 \r
342                 /* Mark this buffer as in use. */\r
343                 ucBufferInUse[ x ] = pdTRUE;\r
344         }\r
345 \r
346         /* The last descriptor points back to the start. */\r
347         pxDescriptor->status |= DL;\r
348         pxDescriptor->next = ( ethfifo * ) &xRxDescriptors[ 0 ];\r
349         \r
350         /* Initialise the Tx descriptors. */\r
351         for( x = 0; x < emacNUM_TX_BUFFERS; x++ )\r
352         {\r
353                 pxDescriptor = &( xTxDescriptors[ x ] );\r
354                 \r
355                 /* A buffer is not allocated to the Tx descriptor until a send is\r
356                 actually required. */\r
357                 pxDescriptor->buf_p = NULL;\r
358 \r
359                 pxDescriptor->bufsize = UIP_BUFSIZE;\r
360                 pxDescriptor->size = 0;\r
361                 pxDescriptor->status = 0;\r
362                 pxDescriptor->next = ( ethfifo * ) &xTxDescriptors[ x + 1 ];    \r
363         }\r
364 \r
365         /* The last descriptor points back to the start. */\r
366         pxDescriptor->status |= DL;\r
367         pxDescriptor->next = ( ethfifo * ) &( xTxDescriptors[ 0 ] );\r
368         \r
369         /* Use the first Rx descriptor to start with. */\r
370         pxCurrentDesc = &( xRxDescriptors[ 0 ] );\r
371 }\r
372 /*-----------------------------------------------------------*/\r
373 \r
374 static unsigned char *prvGetNextBuffer( void )\r
375 {\r
376 long x;\r
377 unsigned char *pucReturn = NULL;\r
378 unsigned long ulAttempts = 0;\r
379 \r
380         while( pucReturn == NULL )\r
381         {\r
382                 /* Look through the buffers to find one that is not in use by\r
383                 anything else. */\r
384                 for( x = 0; x < emacNUM_BUFFERS; x++ )\r
385                 {\r
386                         if( ucBufferInUse[ x ] == pdFALSE )\r
387                         {\r
388                                 ucBufferInUse[ x ] = pdTRUE;\r
389                                 pucReturn = ( unsigned char * ) &( xEthernetBuffers[ x ][ 0 ] );\r
390                                 break;\r
391                         }\r
392                 }\r
393 \r
394                 /* Was a buffer found? */\r
395                 if( pucReturn == NULL )\r
396                 {\r
397                         ulAttempts++;\r
398 \r
399                         if( ulAttempts >= emacBUFFER_WAIT_ATTEMPTS )\r
400                         {\r
401                                 break;\r
402                         }\r
403 \r
404                         /* Wait then look again. */\r
405                         vTaskDelay( emacBUFFER_WAIT_DELAY_ms );\r
406                 }\r
407         }\r
408 \r
409         return pucReturn;\r
410 }\r
411 /*-----------------------------------------------------------*/\r
412 \r
413 static void prvReturnBuffer( unsigned char *pucBuffer )\r
414 {\r
415 unsigned long ul;\r
416 \r
417         /* Return a buffer to the pool of free buffers. */\r
418         for( ul = 0; ul < emacNUM_BUFFERS; ul++ )\r
419         {\r
420                 if( &( xEthernetBuffers[ ul ][ 0 ] ) == ( void * ) pucBuffer )\r
421                 {\r
422                         ucBufferInUse[ ul ] = pdFALSE;\r
423                         break;\r
424                 }\r
425         }\r
426 }\r
427 /*-----------------------------------------------------------*/\r
428 \r
429 static void prvResetEverything( void )\r
430 {\r
431         /* Temporary code just to see if this gets called.  This function has not\r
432         been implemented. */\r
433         portDISABLE_INTERRUPTS();\r
434         for( ;; );\r
435 }\r
436 /*-----------------------------------------------------------*/\r
437 \r
438 static unsigned long prvCheckRxFifoStatus( void )\r
439 {\r
440 unsigned long ulReturn = 0;\r
441 \r
442         if( ( pxCurrentDesc->status & ACT ) != 0 )\r
443         {\r
444                 /* Current descriptor is still active. */\r
445         }\r
446         else if( ( pxCurrentDesc->status & FE ) != 0 )\r
447         {\r
448                 /* Frame error.  Clear the error. */\r
449                 pxCurrentDesc->status &= ~( FP1 | FP0 | FE );\r
450                 pxCurrentDesc->status &= ~( RMAF | RRF | RTLF | RTSF | PRE | CERF );\r
451                 pxCurrentDesc->status |= ACT;\r
452                 pxCurrentDesc = pxCurrentDesc->next;\r
453 \r
454                 if( EDMAC.EDRRR.LONG == 0x00000000UL )\r
455                 {\r
456                         /* Restart Ethernet if it has stopped. */\r
457                         EDMAC.EDRRR.LONG = 0x00000001UL;\r
458                 }       \r
459         }\r
460         else\r
461         {\r
462                 /* The descriptor contains a frame.  Because of the size of the buffers\r
463                 the frame should always be complete. */\r
464                 if( ( pxCurrentDesc->status & FP0 ) == FP0 )\r
465                 {\r
466                         ulReturn = pxCurrentDesc->size;\r
467                 }\r
468                 else\r
469                 {\r
470                         /* Do not expect to get here. */\r
471                         prvResetEverything();\r
472                 }\r
473         }\r
474         \r
475         return ulReturn;\r
476 }\r
477 /*-----------------------------------------------------------*/\r
478 \r
479 static void prvResetMAC( void )\r
480 {\r
481         /* Ensure the EtherC and EDMAC are enabled. */\r
482         SYSTEM.MSTPCRB.BIT.MSTPB15 = 0;\r
483         vTaskDelay( 100 / portTICK_RATE_MS );\r
484         \r
485         EDMAC.EDMR.BIT.SWR = 1; \r
486         \r
487         /* Crude wait for reset to complete. */\r
488         vTaskDelay( 500 / portTICK_RATE_MS );   \r
489 }\r
490 /*-----------------------------------------------------------*/\r
491 \r
492 static void prvConfigureEtherCAndEDMAC( void )\r
493 {\r
494         /* Initialisation code taken from Renesas example project. */\r
495         \r
496         /* TODO:    Check   bit 5   */\r
497         ETHERC.ECSR.LONG = 0x00000037;                          /* Clear all ETHERC statuS BFR, PSRTO, LCHNG, MPD, ICD */\r
498 \r
499         /* Set the EDMAC interrupt priority. */\r
500         _IPR( _ETHER_EINT ) = configKERNEL_INTERRUPT_PRIORITY;\r
501 \r
502         /* TODO:    Check   bit 5   */\r
503         /* Enable interrupts of interest only. */\r
504         EDMAC.EESIPR.LONG = emacTX_END_INTERRUPT | emacRX_END_INTERRUPT;\r
505         ETHERC.RFLR.LONG = 1518;                                        /* Ether payload is 1500+ CRC */\r
506         ETHERC.IPGR.LONG = 0x00000014;                          /* Intergap is 96-bit time */\r
507 \r
508         /* EDMAC */\r
509         EDMAC.EESR.LONG = 0x47FF0F9F;                           /* Clear all ETHERC and EDMAC status bits */\r
510         #if __LITTLE_ENDIAN__ == 1\r
511                 EDMAC.EDMR.BIT.DE = 1;\r
512         #endif\r
513         EDMAC.RDLAR = ( void * ) pxCurrentDesc; /* Initialaize Rx Descriptor List Address */\r
514         EDMAC.TDLAR = ( void * ) &( xTxDescriptors[ 0 ] );/* Initialaize Tx Descriptor List Address */\r
515         EDMAC.TRSCER.LONG = 0x00000000;                         /* Copy-back status is RFE & TFE only   */\r
516         EDMAC.TFTR.LONG = 0x00000000;                           /* Threshold of Tx_FIFO */\r
517         EDMAC.FDR.LONG = 0x00000000;                            /* Transmit fifo & receive fifo is 256 bytes */\r
518         EDMAC.RMCR.LONG = 0x00000003;                           /* Receive function is normal mode(continued) */\r
519         \r
520         /* Enable the interrupt... */\r
521         _IEN( _ETHER_EINT ) = 1;        \r
522 }\r
523 /*-----------------------------------------------------------*/\r
524 \r
525 #pragma vector = VECT_ETHER_EINT\r
526 __interrupt void vEMAC_ISR_Handler( void )\r
527 {\r
528 unsigned long ul = EDMAC.EESR.LONG;\r
529 long lHigherPriorityTaskWoken = pdFALSE;\r
530 extern xSemaphoreHandle xEMACSemaphore;\r
531 static long ulTxEndInts = 0;\r
532 \r
533         __enable_interrupt();\r
534 \r
535         /* Has a Tx end occurred? */\r
536         if( ul & emacTX_END_INTERRUPT )\r
537         {\r
538                 ++ulTxEndInts;\r
539                 if( ulTxEndInts >= 2 )\r
540                 {\r
541                         /* Only return the buffer to the pool once both Txes have completed. */\r
542                         prvReturnBuffer( ( void * ) xTxDescriptors[ 0 ].buf_p );\r
543                         ulTxEndInts = 0;\r
544                 }\r
545                 EDMAC.EESR.LONG = emacTX_END_INTERRUPT;\r
546         }\r
547 \r
548         /* Has an Rx end occurred? */\r
549         if( ul & emacRX_END_INTERRUPT )\r
550         {\r
551                 /* Make sure the Ethernet task is not blocked waiting for a packet. */\r
552                 xSemaphoreGiveFromISR( xEMACSemaphore, &lHigherPriorityTaskWoken );\r
553                 portYIELD_FROM_ISR( lHigherPriorityTaskWoken );\r
554                 EDMAC.EESR.LONG = emacRX_END_INTERRUPT;\r
555         }\r
556 }\r
557 \r