]> git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/WizNET_DEMO_GCC_ARM7/TCP.c
Add FreeRTOS-Plus directory.
[freertos] / FreeRTOS / Demo / WizNET_DEMO_GCC_ARM7 / TCP.c
1 /*\r
2     FreeRTOS V7.1.1 - Copyright (C) 2012 Real Time Engineers Ltd.\r
3         \r
4 \r
5     ***************************************************************************\r
6      *                                                                       *\r
7      *    FreeRTOS tutorial books are available in pdf and paperback.        *\r
8      *    Complete, revised, and edited pdf reference manuals are also       *\r
9      *    available.                                                         *\r
10      *                                                                       *\r
11      *    Purchasing FreeRTOS documentation will not only help you, by       *\r
12      *    ensuring you get running as quickly as possible and with an        *\r
13      *    in-depth knowledge of how to use FreeRTOS, it will also help       *\r
14      *    the FreeRTOS project to continue with its mission of providing     *\r
15      *    professional grade, cross platform, de facto standard solutions    *\r
16      *    for microcontrollers - completely free of charge!                  *\r
17      *                                                                       *\r
18      *    >>> See http://www.FreeRTOS.org/Documentation for details. <<<     *\r
19      *                                                                       *\r
20      *    Thank you for using FreeRTOS, and thank you for your support!      *\r
21      *                                                                       *\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 modification to the GPL is included to allow you to\r
31     distribute a combined work that includes FreeRTOS without being obliged to\r
32     provide the source code for proprietary components outside of the FreeRTOS\r
33     kernel.  FreeRTOS is distributed in the hope that it will be useful, but\r
34     WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY\r
35     or 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     ***************************************************************************\r
45      *                                                                       *\r
46      *    Having a problem?  Start by reading the FAQ "My application does   *\r
47      *    not run, what could be wrong?                                      *\r
48      *                                                                       *\r
49      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
50      *                                                                       *\r
51     ***************************************************************************\r
52 \r
53     \r
54     http://www.FreeRTOS.org - Documentation, training, latest information, \r
55     license and contact details.\r
56     \r
57     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
58     including FreeRTOS+Trace - an indispensable productivity tool.\r
59 \r
60     Real Time Engineers ltd license FreeRTOS to High Integrity Systems, who sell \r
61     the code with commercial support, indemnification, and middleware, under \r
62     the OpenRTOS brand: http://www.OpenRTOS.com.  High Integrity Systems also\r
63     provide a safety engineered and independently SIL3 certified version under \r
64     the SafeRTOS brand: http://www.SafeRTOS.com.\r
65 */\r
66 \r
67 /*\r
68         Changes from V3.2.3\r
69         \r
70         + Modified char* types to compile without warning when using GCC V4.0.1.\r
71         + Corrected the address to which the MAC address is written.  Thanks to\r
72           Bill Knight for this correction.\r
73 \r
74         Changes from V3.2.4\r
75 \r
76         + Changed the default MAC address to something more realistic.\r
77 \r
78 */\r
79 \r
80 /* Standard includes. */\r
81 #include <stdlib.h>\r
82 #include <string.h>\r
83 \r
84 /* Scheduler include files. */\r
85 #include "FreeRTOS.h"\r
86 #include "task.h"\r
87 #include "semphr.h"\r
88 #include "tcp.h"\r
89 #include "serial.h"\r
90 \r
91 /* Application includes. */\r
92 #include "i2c.h"\r
93 #include "html_pages.h"\r
94 \r
95 /*-----------------------------------------------------------*/\r
96 \r
97 /* Hardwired i2c address of the WIZNet device. */\r
98 #define tcpDEVICE_ADDRESS                               ( ( unsigned char ) 0x00 )\r
99 \r
100 /* Constants used to configure the Tx and Rx buffer sizes within the WIZnet\r
101 device. */\r
102 #define tcp8K_RX                                                ( ( unsigned char ) 0x03 )\r
103 #define tcp8K_TX                                                ( ( unsigned char ) 0x03 )\r
104 \r
105 /* Constants used to generate the WIZnet internal buffer addresses. */\r
106 #define tcpSINGLE_SOCKET_ADDR_MASK              ( ( unsigned long ) 0x1fff )\r
107 #define tcpSINGLE_SOCKET_ADDR_OFFSET    ( ( unsigned long ) 0x4000 )\r
108 \r
109 /* Bit definitions of the commands that can be sent to the command register. */\r
110 #define tcpRESET_CMD                                    ( ( unsigned char ) 0x80 )\r
111 #define tcpSYS_INIT_CMD                                 ( ( unsigned char ) 0x01 )\r
112 #define tcpSOCK_STREAM                                  ( ( unsigned char ) 0x01 )\r
113 #define tcpSOCK_INIT                                    ( ( unsigned char ) 0x02 )\r
114 #define tcpLISTEN_CMD                                   ( ( unsigned char ) 0x08 )\r
115 #define tcpRECEIVE_CMD                                  ( ( unsigned char ) 0x40 )\r
116 #define tcpDISCONNECT_CMD                               ( ( unsigned char ) 0x10 )\r
117 #define tcpSEND_CMD                                             ( ( unsigned char ) 0x20 )\r
118 \r
119 /* Constants required to handle the interrupts. */\r
120 #define tcpCLEAR_EINT0                                  ( 1 )\r
121 #define i2cCLEAR_ALL_INTERRUPTS                 ( ( unsigned char ) 0xff )\r
122 #define i2cCHANNEL_0_ISR_ENABLE                 ( ( unsigned char ) 0x01 )\r
123 #define i2cCHANNEL_0_ISR_DISABLE                ( ( unsigned char ) 0x00 )\r
124 #define tcpWAKE_ON_EINT0                                ( 1 )\r
125 #define tcpENABLE_EINT0_FUNCTION                ( ( unsigned long ) 0x01 )\r
126 #define tcpEINT0_VIC_CHANNEL_BIT                ( ( unsigned long ) 0x4000 )\r
127 #define tcpEINT0_VIC_CHANNEL                    ( ( unsigned long ) 14 )\r
128 #define tcpEINT0_VIC_ENABLE                             ( ( unsigned long ) 0x0020 )\r
129 \r
130 /* Various delays used in the driver. */\r
131 #define tcpRESET_DELAY                                  ( ( portTickType ) 16 / portTICK_RATE_MS )\r
132 #define tcpINIT_DELAY                                   ( ( portTickType ) 500 / portTICK_RATE_MS  )\r
133 #define tcpLONG_DELAY                                   ( ( portTickType ) 500 / portTICK_RATE_MS  )\r
134 #define tcpSHORT_DELAY                                  ( ( portTickType ) 5 / portTICK_RATE_MS )\r
135 #define tcpCONNECTION_WAIT_DELAY                ( ( portTickType ) 100 / portTICK_RATE_MS )\r
136 #define tcpNO_DELAY                                             ( ( portTickType ) 0 )\r
137 \r
138 /* Length of the data to read for various register reads. */\r
139 #define tcpSTATUS_READ_LEN                              ( ( unsigned long ) 1 )\r
140 #define tcpSHADOW_READ_LEN                              ( ( unsigned long ) 1 )\r
141         \r
142 /* Register addresses within the WIZnet device. */\r
143 #define tcpCOMMAND_REG                                  ( ( unsigned short ) 0x0000 )\r
144 #define tcpGATEWAY_ADDR_REG                             ( ( unsigned short ) 0x0080 )\r
145 #define tcpSUBNET_MASK_REG                              ( ( unsigned short ) 0x0084 )\r
146 #define tcpSOURCE_HA_REG                                ( ( unsigned short ) 0x0088 )\r
147 #define tpcSOURCE_IP_REG                                ( ( unsigned short ) 0x008E )\r
148 #define tpcSOCKET_OPT_REG                               ( ( unsigned short ) 0x00A1 )\r
149 #define tcpSOURCE_PORT_REG                              ( ( unsigned short ) 0x00AE )\r
150 #define tcpTX_WRITE_POINTER_REG                 ( ( unsigned short ) 0x0040 )\r
151 #define tcpTX_READ_POINTER_REG                  ( ( unsigned short ) 0x0044 )\r
152 #define tcpTX_ACK_POINTER_REG                   ( ( unsigned short ) 0x0018 )\r
153 #define tcpTX_MEM_SIZE_REG                              ( ( unsigned short ) 0x0096 )\r
154 #define tcpRX_MEM_SIZE_REG                              ( ( unsigned short ) 0x0095 )\r
155 #define tcpINTERRUPT_STATUS_REG                 ( ( unsigned short ) 0x0004 )\r
156 #define tcpTX_WRITE_SHADOW_REG                  ( ( unsigned short ) 0x01F0 )\r
157 #define tcpTX_ACK_SHADOW_REG                    ( ( unsigned short ) 0x01E2 )\r
158 #define tcpISR_MASK_REG                                 ( ( unsigned short ) 0x0009 )\r
159 #define tcpINTERRUPT_REG                                ( ( unsigned short ) 0x0008 )\r
160 #define tcpSOCKET_STATE_REG                             ( ( unsigned short ) 0x00a0 )\r
161 \r
162 /* Constants required for hardware setup. */\r
163 #define tcpRESET_ACTIVE_LOW                     ( ( unsigned long ) 0x20 )\r
164 #define tcpRESET_ACTIVE_HIGH                    ( ( unsigned long ) 0x10 )\r
165 \r
166 /* Constants defining the source of the WIZnet ISR. */\r
167 #define tcpISR_SYS_INIT                                 ( ( unsigned char ) 0x01 )\r
168 #define tcpISR_SOCKET_INIT                              ( ( unsigned char ) 0x02 )\r
169 #define tcpISR_ESTABLISHED                              ( ( unsigned char ) 0x04 )\r
170 #define tcpISR_CLOSED                                   ( ( unsigned char ) 0x08 )\r
171 #define tcpISR_TIMEOUT                                  ( ( unsigned char ) 0x10 )\r
172 #define tcpISR_TX_COMPLETE                              ( ( unsigned char ) 0x20 )\r
173 #define tcpISR_RX_COMPLETE                              ( ( unsigned char ) 0x40 )\r
174 \r
175 /* Constants defining the socket status bits. */\r
176 #define tcpSTATUS_ESTABLISHED                   ( ( unsigned char ) 0x06 )\r
177 #define tcpSTATUS_LISTEN                                ( ( unsigned char ) 0x02 )\r
178 \r
179 /* Misc constants. */\r
180 #define tcpNO_STATUS_BITS                               ( ( unsigned char ) 0x00 )\r
181 #define i2cNO_ADDR_REQUIRED                             ( ( unsigned short ) 0x0000 )\r
182 #define i2cNO_DATA_REQUIRED                             ( 0x0000 )\r
183 #define tcpISR_QUEUE_LENGTH                             ( ( unsigned portBASE_TYPE ) 10 )\r
184 #define tcpISR_QUEUE_ITEM_SIZE                  ( ( unsigned portBASE_TYPE ) 0 )\r
185 #define tcpBUFFER_LEN                                   ( 4 * 1024 )\r
186 #define tcpMAX_REGISTER_LEN                             ( 4 )\r
187 #define tcpMAX_ATTEMPTS_TO_CHECK_BUFFER ( 6 )\r
188 #define tcpMAX_NON_LISTEN_STAUS_READS   ( 5 )\r
189 \r
190 /* Message definitions.  The IP address, MAC address, gateway address, etc.\r
191 is set here! */\r
192 const unsigned char const ucDataGAR[]                           = { 172, 25, 218, 3 };  /* Gateway address. */\r
193 const unsigned char const ucDataMSR[]                           = { 255, 255, 255, 0 }; /* Subnet mask.         */\r
194 const unsigned char const ucDataSIPR[]                          = { 172, 25, 218, 201 };/* IP address.          */\r
195 const unsigned char const ucDataSHAR[]                          = { 00, 23, 30, 41, 15, 26 }; /* MAC address - DO NOT USE THIS ON A PUBLIC NETWORK! */\r
196 \r
197 /* Other fixed messages. */\r
198 const unsigned char const ucDataReset[]                         = { tcpRESET_CMD }; \r
199 const unsigned char const ucDataInit[]                          = { tcpSYS_INIT_CMD }; \r
200 const unsigned char const ucDataProtocol[]                      = { tcpSOCK_STREAM };\r
201 const unsigned char const ucDataPort[]                          = { 0xBA, 0xCC };\r
202 const unsigned char const ucDataSockInit[]                      = { tcpSOCK_INIT };\r
203 const unsigned char const ucDataTxWritePointer[]        = { 0x11, 0x22, 0x00, 0x00 };\r
204 const unsigned char const ucDataTxAckPointer[]          = { 0x11, 0x22, 0x00, 0x00 };\r
205 const unsigned char const ucDataTxReadPointer[]         = { 0x11, 0x22, 0x00, 0x00 };\r
206 const unsigned char const ucDataListen[]                        = { tcpLISTEN_CMD };\r
207 const unsigned char const ucDataReceiveCmd[]            = { tcpRECEIVE_CMD };\r
208 const unsigned char const ucDataSetTxBufSize[]          = { tcp8K_TX };\r
209 const unsigned char const ucDataSetRxBufSize[]          = { tcp8K_RX };\r
210 const unsigned char const ucDataSend[]                          = { tcpSEND_CMD };\r
211 const unsigned char const ucDataDisconnect[]            = { tcpDISCONNECT_CMD };\r
212 const unsigned char const ucDataEnableISR[]                     = { i2cCHANNEL_0_ISR_ENABLE };\r
213 const unsigned char const ucDataDisableISR[]            = { i2cCHANNEL_0_ISR_DISABLE };\r
214 const unsigned char const ucDataClearInterrupt[]        = { i2cCLEAR_ALL_INTERRUPTS };\r
215 \r
216 static xSemaphoreHandle xMessageComplete = NULL;\r
217 xQueueHandle xTCPISRQueue = NULL;\r
218 \r
219 /* Dynamically generate and send an html page. */\r
220 static void prvSendSamplePage( void );\r
221 \r
222 /* Read a register from the WIZnet device via the i2c interface. */\r
223 static void prvReadRegister( unsigned char *pucDestination, unsigned short usAddress, unsigned long ulLength );\r
224 \r
225 /* Send the entire Tx buffer (the Tx buffer within the WIZnet device). */\r
226 static void prvFlushBuffer( unsigned long ulTxAddress );\r
227 \r
228 /* Write a string to the WIZnet Tx buffer. */\r
229 static void prvWriteString( const char * const pucTxBuffer, long lTxLen, unsigned long *pulTxAddress );\r
230 \r
231 /* Convert a number to a string. */\r
232 void ultoa( unsigned long ulVal, char *pcBuffer, long lIgnore );\r
233 \r
234 /*-----------------------------------------------------------*/\r
235 \r
236 void ultoa( unsigned long ulVal, char *pcBuffer, long lIgnore )\r
237 {\r
238 unsigned long lNibble;\r
239 long lIndex;\r
240 \r
241         /* Simple routine to convert an unsigned long value into a string in hex \r
242         format. */\r
243 \r
244         /* For each nibble in the number we are converting. */\r
245         for( lIndex = 0; lIndex < ( sizeof( ulVal ) * 2 ); lIndex++ )\r
246         {\r
247                 /* Take the top four bits of the number. */\r
248                 lNibble = ( ulVal >> 28 );\r
249 \r
250                 /* We are converting it to a hex string, so is the number in the range\r
251                 0-10 or A-F? */\r
252                 if( lNibble < 10 )\r
253                 {\r
254                         pcBuffer[ lIndex ] = '0' + lNibble;\r
255                 }\r
256                 else\r
257                 {\r
258                         lNibble -= 10;\r
259                         pcBuffer[ lIndex ] = 'A' + lNibble;\r
260                 }\r
261 \r
262                 /* Shift off the top nibble so we use the next nibble next time around. */\r
263                 ulVal <<= 4;\r
264         }       \r
265 \r
266         /* Mark the end of the string with a null terminator. */\r
267         pcBuffer[ lIndex ] = 0x00;\r
268 }\r
269 /*-----------------------------------------------------------*/\r
270 \r
271 static void prvReadRegister( unsigned char *pucDestination, unsigned short usAddress, unsigned long ulLength )\r
272 {\r
273 unsigned char ucRxBuffer[ tcpMAX_REGISTER_LEN ];\r
274 \r
275         /* Read a register value from the WIZnet device. */\r
276 \r
277         /* First write out the address of the register we want to read. */\r
278         i2cMessage( ucRxBuffer, i2cNO_DATA_REQUIRED, tcpDEVICE_ADDRESS, usAddress, i2cWRITE, NULL, portMAX_DELAY );\r
279         \r
280         /* Then read back from that address. */\r
281         i2cMessage( ( unsigned char * ) pucDestination, ulLength, tcpDEVICE_ADDRESS, i2cNO_ADDR_REQUIRED, i2cREAD, xMessageComplete, portMAX_DELAY );\r
282 \r
283         /* I2C messages are queued so use the semaphore to wait for the read to \r
284         complete - otherwise we will leave this function before the I2C \r
285         transactions have completed. */\r
286         xSemaphoreTake( xMessageComplete, tcpLONG_DELAY );\r
287 }\r
288 /*-----------------------------------------------------------*/\r
289 \r
290 void vTCPHardReset( void )\r
291 {\r
292         /* Physical reset of the WIZnet device by using the GPIO lines to hold the \r
293         WIZnet reset lines active for a few milliseconds. */\r
294 \r
295         /* Make sure the interrupt from the WIZnet is disabled. */\r
296         VICIntEnClear |= tcpEINT0_VIC_CHANNEL_BIT;\r
297 \r
298         /* If xMessageComplete is NULL then this is the first time that this \r
299         function has been called and the queue and semaphore used in this file\r
300         have not yet been created. */\r
301         if( xMessageComplete == NULL )\r
302         {\r
303                 /* Create and obtain the semaphore used when we want to wait for an i2c\r
304                 message to be completed. */\r
305                 vSemaphoreCreateBinary( xMessageComplete );\r
306                 xSemaphoreTake( xMessageComplete, tcpNO_DELAY );\r
307 \r
308                 /* Create the queue used to communicate between the WIZnet and TCP tasks. */\r
309                 xTCPISRQueue = xQueueCreate( tcpISR_QUEUE_LENGTH, tcpISR_QUEUE_ITEM_SIZE );\r
310         }\r
311 \r
312         /* Use the GPIO to reset the network hardware. */\r
313         GPIO_IOCLR = tcpRESET_ACTIVE_LOW;\r
314         GPIO_IOSET = tcpRESET_ACTIVE_HIGH;\r
315 \r
316         /* Delay with the network hardware in reset for a short while. */\r
317         vTaskDelay( tcpRESET_DELAY );\r
318 \r
319         GPIO_IOCLR = tcpRESET_ACTIVE_HIGH;\r
320         GPIO_IOSET = tcpRESET_ACTIVE_LOW;\r
321 \r
322         vTaskDelay( tcpINIT_DELAY );\r
323 \r
324         /* Setup the EINT0 to interrupt on required events from the WIZnet device.\r
325         First enable the EINT0 function of the pin. */\r
326         PCB_PINSEL1 |= tcpENABLE_EINT0_FUNCTION;\r
327         \r
328         /* We want the TCP comms to wake us from power save. */\r
329         SCB_EXTWAKE = tcpWAKE_ON_EINT0;\r
330 \r
331         /* Install the ISR into the VIC - but don't enable it yet! */\r
332         portENTER_CRITICAL();\r
333         {\r
334                 extern void ( vEINT0_ISR_Wrapper )( void );\r
335 \r
336                 VICIntSelect &= ~( tcpEINT0_VIC_CHANNEL_BIT );\r
337                 VICVectAddr3 = ( long ) vEINT0_ISR_Wrapper;\r
338 \r
339                 VICVectCntl3 = tcpEINT0_VIC_CHANNEL | tcpEINT0_VIC_ENABLE;\r
340         }\r
341         portEXIT_CRITICAL();\r
342 \r
343         /* Enable interrupts in the WIZnet itself. */\r
344         i2cMessage( ucDataEnableISR, sizeof( ucDataEnableISR ), tcpDEVICE_ADDRESS, tcpISR_MASK_REG, i2cWRITE, NULL, portMAX_DELAY );\r
345 \r
346         vTaskDelay( tcpLONG_DELAY );\r
347 }\r
348 /*-----------------------------------------------------------*/\r
349 \r
350 long lTCPSoftReset( void )\r
351 {\r
352 unsigned char ucStatus;\r
353 extern volatile long lTransactionCompleted;\r
354 \r
355         /* Send a message to the WIZnet device to tell it set all it's registers\r
356         back to their default states.  Then setup the WIZnet device as required. */\r
357 \r
358         /* Reset the internal WIZnet registers. */\r
359         i2cMessage( ucDataReset,        sizeof( ucDataReset ),  tcpDEVICE_ADDRESS, tcpCOMMAND_REG, i2cWRITE, NULL, portMAX_DELAY );\r
360 \r
361         /* Now we can configure the protocol.   Here the MAC address, gateway \r
362         address, subnet mask and IP address are configured. */\r
363         i2cMessage( ucDataSHAR,         sizeof( ucDataSHAR ),   tcpDEVICE_ADDRESS, tcpSOURCE_HA_REG, i2cWRITE, NULL, portMAX_DELAY );\r
364         i2cMessage( ucDataGAR,          sizeof( ucDataGAR ),    tcpDEVICE_ADDRESS, tcpGATEWAY_ADDR_REG, i2cWRITE, NULL, portMAX_DELAY );\r
365         i2cMessage( ucDataMSR,          sizeof( ucDataMSR ),    tcpDEVICE_ADDRESS, tcpSUBNET_MASK_REG,  i2cWRITE, NULL, portMAX_DELAY );\r
366         i2cMessage( ucDataSIPR,         sizeof( ucDataSIPR ),   tcpDEVICE_ADDRESS, tpcSOURCE_IP_REG,    i2cWRITE, NULL, portMAX_DELAY );\r
367         \r
368         /* Next the memory buffers are configured to give all the WIZnet internal\r
369         memory over to a single socket.  This gives the socket the maximum internal\r
370         Tx and Rx buffer space. */\r
371         i2cMessage( ucDataSetTxBufSize, sizeof( ucDataSetTxBufSize ), tcpDEVICE_ADDRESS, tcpTX_MEM_SIZE_REG, i2cWRITE, NULL, portMAX_DELAY );\r
372         i2cMessage( ucDataSetRxBufSize, sizeof( ucDataSetRxBufSize ), tcpDEVICE_ADDRESS, tcpRX_MEM_SIZE_REG, i2cWRITE, NULL, portMAX_DELAY );\r
373 \r
374         /* Send the sys init command so the above parameters take effect. */\r
375         i2cMessage( ucDataInit,         sizeof( ucDataInit ),   tcpDEVICE_ADDRESS, tcpCOMMAND_REG, i2cWRITE, NULL, portMAX_DELAY );\r
376 \r
377         /* Seems to like a little wait here. */\r
378         vTaskDelay( tcpINIT_DELAY );\r
379 \r
380         /* Read back the status to ensure the system initialised ok. */\r
381         prvReadRegister( &ucStatus, tcpINTERRUPT_STATUS_REG, tcpSTATUS_READ_LEN );\r
382 \r
383         /* We should find that the sys init was successful. */\r
384         if( ucStatus != tcpISR_SYS_INIT )\r
385         {\r
386                 return ( long ) pdFAIL;\r
387         }\r
388 \r
389         /* No i2c errors yet. */\r
390         portENTER_CRITICAL();\r
391                 lTransactionCompleted = pdTRUE;\r
392         portEXIT_CRITICAL();\r
393 \r
394         return ( long ) pdPASS;\r
395 }\r
396 /*-----------------------------------------------------------*/\r
397 \r
398 long lTCPCreateSocket( void )\r
399 {\r
400 unsigned char ucStatus;\r
401 \r
402         /* Create and configure a socket. */\r
403 \r
404         /* Setup and init the socket.  Here the port number is set and the socket\r
405         is initialised. */\r
406         i2cMessage( ucDataProtocol, sizeof( ucDataProtocol),tcpDEVICE_ADDRESS, tpcSOCKET_OPT_REG, i2cWRITE, NULL, portMAX_DELAY );\r
407         i2cMessage( ucDataPort,         sizeof( ucDataPort),    tcpDEVICE_ADDRESS, tcpSOURCE_PORT_REG, i2cWRITE, NULL, portMAX_DELAY );\r
408         i2cMessage( ucDataSockInit, sizeof( ucDataSockInit),tcpDEVICE_ADDRESS, tcpCOMMAND_REG, i2cWRITE, xMessageComplete, portMAX_DELAY );\r
409 \r
410         /* Wait for the Init command to be sent. */\r
411         if( !xSemaphoreTake( xMessageComplete, tcpLONG_DELAY ) )\r
412         {\r
413                 /* For some reason the message was not transmitted within our block\r
414                 period. */\r
415                 return ( long ) pdFAIL;\r
416         }\r
417 \r
418         /* Allow the socket to initialise. */\r
419         vTaskDelay( tcpINIT_DELAY );\r
420 \r
421         /* Read back the status to ensure the socket initialised ok. */\r
422         prvReadRegister( &ucStatus, tcpINTERRUPT_STATUS_REG, tcpSTATUS_READ_LEN );\r
423         \r
424         /* We should find that the socket init was successful. */\r
425         if( ucStatus != tcpISR_SOCKET_INIT )\r
426         {\r
427                 return ( long ) pdFAIL;\r
428         }\r
429 \r
430 \r
431         /* Setup the Tx pointer registers to indicate that the Tx buffer is empty. */\r
432         i2cMessage( ucDataTxReadPointer, sizeof( ucDataTxReadPointer ), tcpDEVICE_ADDRESS, tcpTX_READ_POINTER_REG, i2cWRITE, NULL, portMAX_DELAY );\r
433         vTaskDelay( tcpSHORT_DELAY );\r
434         i2cMessage( ucDataTxWritePointer, sizeof( ucDataTxWritePointer ), tcpDEVICE_ADDRESS, tcpTX_WRITE_POINTER_REG, i2cWRITE, NULL, portMAX_DELAY );\r
435         vTaskDelay( tcpSHORT_DELAY );\r
436         i2cMessage( ucDataTxAckPointer,   sizeof( ucDataTxAckPointer ),   tcpDEVICE_ADDRESS, tcpTX_ACK_POINTER_REG, i2cWRITE, NULL, portMAX_DELAY );\r
437         vTaskDelay( tcpSHORT_DELAY );\r
438 \r
439         return ( long ) pdPASS;\r
440 }\r
441 /*-----------------------------------------------------------*/\r
442 \r
443 void vTCPListen( void )\r
444 {\r
445 unsigned char ucISR;\r
446 \r
447         /* Start a passive listen on the socket. */\r
448 \r
449         /* Enable interrupts in the WizNet device after ensuring none are \r
450         currently pending. */\r
451         while( SCB_EXTINT & tcpCLEAR_EINT0 )\r
452         {\r
453                 /* The WIZnet device is still asserting and interrupt so tell it to \r
454                 clear. */\r
455                 i2cMessage( ucDataClearInterrupt, sizeof( ucDataClearInterrupt ), tcpDEVICE_ADDRESS, tcpINTERRUPT_REG, i2cWRITE, xMessageComplete, portMAX_DELAY );\r
456                 xSemaphoreTake( xMessageComplete, tcpLONG_DELAY );\r
457 \r
458                 vTaskDelay( 1 );\r
459                 SCB_EXTINT = tcpCLEAR_EINT0;\r
460         }\r
461 \r
462         while( xQueueReceive( xTCPISRQueue, &ucISR, tcpNO_DELAY ) )\r
463         {\r
464                 /* Just clearing the queue used by the ISR routine to tell this task\r
465                 that the WIZnet device needs attention. */\r
466         }\r
467 \r
468         /* Now all the pending interrupts have been cleared we can enable the \r
469         processor interrupts. */\r
470         VICIntEnable |= tcpEINT0_VIC_CHANNEL_BIT;\r
471 \r
472         /* Then start listening for incoming connections. */\r
473         i2cMessage( ucDataListen, sizeof( ucDataListen ), tcpDEVICE_ADDRESS, tcpCOMMAND_REG, i2cWRITE, NULL, portMAX_DELAY );\r
474 }\r
475 /*-----------------------------------------------------------*/\r
476 \r
477 long lProcessConnection( void )\r
478 {\r
479 unsigned char ucISR, ucState, ucLastState = 2, ucShadow;\r
480 extern volatile long lTransactionCompleted;\r
481 long lSameStateCount = 0, lDataSent = pdFALSE;\r
482 unsigned long ulWritePointer, ulAckPointer;\r
483 \r
484         /* No I2C errors can yet have occurred. */\r
485         portENTER_CRITICAL();\r
486                 lTransactionCompleted = pdTRUE;\r
487         portEXIT_CRITICAL();\r
488 \r
489         /* Keep looping - processing interrupts, until we have completed a \r
490         transaction.   This uses the WIZnet in it's simplest form.  The socket\r
491         accepts a connection - we process the connection - then close the socket.\r
492         We then go back to reinitialise everything and start again. */\r
493         while( lTransactionCompleted == pdTRUE )\r
494         {\r
495                 /* Wait for a message on the queue from the WIZnet ISR.  When the \r
496                 WIZnet device asserts an interrupt the ISR simply posts a message\r
497                 onto this queue to wake this task. */\r
498                 if( xQueueReceive( xTCPISRQueue, &ucISR, tcpCONNECTION_WAIT_DELAY ) )\r
499                 {\r
500                         /* The ISR posted a message on this queue to tell us that the\r
501                         WIZnet device asserted an interrupt.  The ISR cannot process\r
502                         an I2C message so cannot tell us what caused the interrupt so\r
503                         we have to query the device here.  This task is the highest\r
504                         priority in the system so will run immediately following the ISR. */\r
505                         prvReadRegister( &ucISR, tcpINTERRUPT_STATUS_REG, tcpSTATUS_READ_LEN );\r
506 \r
507                         /* Once we have read what caused the ISR we can clear the interrupt\r
508                         in the WIZnet. */\r
509                         i2cMessage( ucDataClearInterrupt, sizeof( ucDataClearInterrupt ), tcpDEVICE_ADDRESS, tcpINTERRUPT_REG, i2cWRITE, NULL, portMAX_DELAY );\r
510 \r
511                         /* Now we can clear the processor interrupt and re-enable ready for\r
512                         the next. */\r
513                         SCB_EXTINT = tcpCLEAR_EINT0;\r
514                         VICIntEnable |= tcpEINT0_VIC_CHANNEL_BIT;\r
515         \r
516                         /* Process the interrupt ... */\r
517 \r
518                         if( ucISR & tcpISR_ESTABLISHED )\r
519                         {\r
520                                 /* A connection has been established - respond by sending\r
521                                 a receive command. */\r
522                                 i2cMessage( ucDataReceiveCmd, sizeof( ucDataReceiveCmd ), tcpDEVICE_ADDRESS, tcpCOMMAND_REG, i2cWRITE, NULL, portMAX_DELAY );\r
523                         }\r
524                 \r
525                         if( ucISR & tcpISR_RX_COMPLETE )\r
526                         {\r
527                                 /* We message has been received.  This will be an HTTP get \r
528                                 command.  We only have one page to send so just send it without\r
529                                 regard to what the actual requested page was. */\r
530                                 prvSendSamplePage();\r
531                         }\r
532                 \r
533                         if( ucISR & tcpISR_TX_COMPLETE )\r
534                         {\r
535                                 /* We have a TX complete interrupt - which oddly does not \r
536                                 indicate that the message being sent is complete so we cannot\r
537                                 yet close the socket.  Instead we read the position of the Tx\r
538                                 pointer within the WIZnet device so we know how much data it\r
539                                 has to send.  Later we will read the ack pointer and compare \r
540                                 this to the Tx pointer to ascertain whether the transmission \r
541                                 has completed. */\r
542 \r
543                                 /* First read the shadow register. */\r
544                                 prvReadRegister( &ucShadow, tcpTX_WRITE_SHADOW_REG, tcpSHADOW_READ_LEN );\r
545                         \r
546                                 /* Now a short delay is required. */\r
547                                 vTaskDelay( tcpSHORT_DELAY );\r
548 \r
549                                 /* Then we can read the real register. */\r
550                                 prvReadRegister( ( unsigned char * ) &ulWritePointer, tcpTX_WRITE_POINTER_REG, sizeof( ulWritePointer ) );\r
551 \r
552                                 /* We cannot do anything more here but need to remember that \r
553                                 this interrupt has occurred. */\r
554                                 lDataSent = pdTRUE;\r
555                         }\r
556                 \r
557                         if( ucISR & tcpISR_CLOSED )\r
558                         {\r
559                                 /* The socket has been closed so we can leave this function. */\r
560                                 lTransactionCompleted = pdFALSE;\r
561                         }\r
562                 }\r
563                 else\r
564                 {\r
565                         /* We have not received an interrupt from the WIZnet device for a \r
566                         while.  Read the socket status and check that everything is as\r
567                         expected. */\r
568                         prvReadRegister( &ucState, tcpSOCKET_STATE_REG, tcpSTATUS_READ_LEN );\r
569                         \r
570                         if( ( ucState == tcpSTATUS_ESTABLISHED ) && ( lDataSent > 0 ) ) \r
571                         {\r
572                                 /* The socket is established and we have already received a Tx\r
573                                 end interrupt.  We must therefore be waiting for the Tx buffer\r
574                                 inside the WIZnet device to be empty before we can close the\r
575                                 socket. \r
576 \r
577                                 Read the Ack pointer register to see if it has caught up with\r
578                                 the Tx pointer register.  First we have to read the shadow \r
579                                 register. */\r
580                                 prvReadRegister( &ucShadow, tcpTX_ACK_SHADOW_REG, tcpSHADOW_READ_LEN );\r
581                                 vTaskDelay( tcpSHORT_DELAY );\r
582                                 prvReadRegister( ( unsigned char * ) &ulAckPointer, tcpTX_ACK_POINTER_REG, sizeof( ulWritePointer ) );\r
583 \r
584                                 if( ulAckPointer == ulWritePointer )\r
585                                 {\r
586                                         /* The Ack and write pointer are now equal and we can \r
587                                         safely close the socket. */\r
588                                         i2cMessage( ucDataDisconnect, sizeof( ucDataDisconnect ), tcpDEVICE_ADDRESS, tcpCOMMAND_REG, i2cWRITE, NULL, portMAX_DELAY );\r
589                                 }\r
590                                 else\r
591                                 {\r
592                                         /* Keep a count of how many times we encounter the Tx\r
593                                         buffer still containing data. */\r
594                                         lDataSent++;\r
595                                         if( lDataSent > tcpMAX_ATTEMPTS_TO_CHECK_BUFFER )\r
596                                         {\r
597                                                 /* Assume we cannot complete sending the data and \r
598                                                 therefore cannot safely close the socket.  Start over. */\r
599                                                 vTCPHardReset();\r
600                                                 lTransactionCompleted = pdFALSE;\r
601                                         }\r
602                                 }\r
603                         }\r
604                         else if( ucState != tcpSTATUS_LISTEN )\r
605                         {\r
606                                 /* If we have not yet received a Tx end interrupt we would only \r
607                                 ever expect to find the socket still listening for any \r
608                                 sustained period. */\r
609                                 if( ucState == ucLastState )\r
610                                 {\r
611                                         lSameStateCount++;\r
612                                         if( lSameStateCount > tcpMAX_NON_LISTEN_STAUS_READS )\r
613                                         {                                               \r
614                                                 /* We are persistently in an unexpected state.  Assume\r
615                                                 we cannot safely close the socket and start over. */\r
616                                                 vTCPHardReset();\r
617                                                 lTransactionCompleted = pdFALSE;\r
618                                         }\r
619                                 }\r
620                         }\r
621                         else\r
622                         {\r
623                                 /* We are in the listen state so are happy that everything\r
624                                 is as expected. */\r
625                                 lSameStateCount = 0;\r
626                         }\r
627 \r
628                         /* Remember what state we are in this time around so we can check\r
629                         for a persistence on an unexpected state. */\r
630                         ucLastState = ucState;\r
631                 }\r
632         }\r
633 \r
634         /* We are going to reinitialise the WIZnet device so do not want our \r
635         interrupts from the WIZnet to be processed. */\r
636         VICIntEnClear |= tcpEINT0_VIC_CHANNEL_BIT;\r
637         return lTransactionCompleted;\r
638 }\r
639 /*-----------------------------------------------------------*/\r
640 \r
641 static void prvWriteString( const char * const pucTxBuffer, long lTxLen, unsigned long *pulTxAddress )\r
642 {\r
643 unsigned long ulSendAddress;\r
644 \r
645         /* Send a string to the Tx buffer internal to the WIZnet device. */\r
646 \r
647         /* Calculate the address to which we are going to write in the buffer. */\r
648         ulSendAddress = ( *pulTxAddress & tcpSINGLE_SOCKET_ADDR_MASK ) + tcpSINGLE_SOCKET_ADDR_OFFSET;\r
649 \r
650         /* Send the buffer to the calculated address.  Use the semaphore so we\r
651         can wait until the entire message has been transferred. */\r
652         i2cMessage( ( unsigned char * ) pucTxBuffer, lTxLen, tcpDEVICE_ADDRESS, ( unsigned short ) ulSendAddress, i2cWRITE, xMessageComplete, portMAX_DELAY );\r
653 \r
654         /* Wait until the semaphore indicates that the message has been transferred. */\r
655         if( !xSemaphoreTake( xMessageComplete, tcpLONG_DELAY ) )\r
656         {\r
657                 return;\r
658         }\r
659 \r
660         /* Return the new address of the end of the buffer (within the WIZnet \r
661         device). */\r
662         *pulTxAddress += ( unsigned long ) lTxLen;\r
663 }\r
664 /*-----------------------------------------------------------*/\r
665 \r
666 static void prvFlushBuffer( unsigned long ulTxAddress )\r
667 {\r
668 unsigned char ucTxBuffer[ tcpMAX_REGISTER_LEN ];\r
669 \r
670         /* We have written some data to the Tx buffer internal to the WIZnet\r
671         device.  Now we update the Tx pointer inside the WIZnet then send a\r
672         Send command - which causes     the data up to the new Tx pointer to be \r
673         transmitted. */\r
674 \r
675         /* Make sure endieness is correct for transmission. */\r
676         ulTxAddress = htonl( ulTxAddress );\r
677 \r
678         /* Place the new Tx pointer in the string to be transmitted. */\r
679         ucTxBuffer[ 0 ] = ( unsigned char ) ( ulTxAddress & 0xff );\r
680         ulTxAddress >>= 8;\r
681         ucTxBuffer[ 1 ] = ( unsigned char ) ( ulTxAddress & 0xff );\r
682         ulTxAddress >>= 8;\r
683         ucTxBuffer[ 2 ] = ( unsigned char ) ( ulTxAddress & 0xff );\r
684         ulTxAddress >>= 8;\r
685         ucTxBuffer[ 3 ] = ( unsigned char ) ( ulTxAddress & 0xff );\r
686         ulTxAddress >>= 8;\r
687 \r
688         /* And send it to the WIZnet device. */\r
689         i2cMessage( ucTxBuffer, sizeof( ulTxAddress ), tcpDEVICE_ADDRESS, tcpTX_WRITE_POINTER_REG, i2cWRITE, xMessageComplete, portMAX_DELAY );\r
690 \r
691         if( !xSemaphoreTake( xMessageComplete, tcpLONG_DELAY ) )\r
692         {\r
693                 return;\r
694         }\r
695 \r
696         vTaskDelay( tcpSHORT_DELAY );\r
697 \r
698         /* Transmit! */\r
699         i2cMessage( ucDataSend, sizeof( ucDataSend ), tcpDEVICE_ADDRESS, tcpCOMMAND_REG, i2cWRITE, xMessageComplete, portMAX_DELAY );\r
700 \r
701         if( !xSemaphoreTake( xMessageComplete, tcpLONG_DELAY ) )\r
702         {\r
703                 return;\r
704         }\r
705 }\r
706 /*-----------------------------------------------------------*/\r
707 \r
708 static void prvSendSamplePage( void )\r
709 {\r
710 extern long lErrorInTask;\r
711 unsigned long ulTxAddress;\r
712 unsigned char ucShadow;\r
713 long lIndex;\r
714 static unsigned long ulRefreshCount = 0x00;\r
715 static char cPageBuffer[ tcpBUFFER_LEN ];\r
716 \r
717 \r
718         /* This function just generates a sample page of HTML which gets\r
719         sent each time a client attaches to the socket.  The page is created\r
720         from two fixed strings (cSamplePageFirstPart and cSamplePageSecondPart)\r
721         with a bit of dynamically generated data in the middle. */\r
722 \r
723         /* We need to know the address to which the html string should be sent\r
724         in the WIZnet Tx buffer.  First read the shadow register. */\r
725         prvReadRegister( &ucShadow, tcpTX_WRITE_SHADOW_REG, tcpSHADOW_READ_LEN );\r
726 \r
727         /* Now a short delay is required. */\r
728         vTaskDelay( tcpSHORT_DELAY );\r
729 \r
730         /* Now we can read the real pointer value. */\r
731         prvReadRegister( ( unsigned char * ) &ulTxAddress, tcpTX_WRITE_POINTER_REG, sizeof( ulTxAddress ) );\r
732 \r
733         /* Make sure endieness is correct. */\r
734         ulTxAddress = htonl( ulTxAddress );\r
735 \r
736         /* Send the start of the page. */\r
737         prvWriteString( cSamplePageFirstPart, strlen( cSamplePageFirstPart ), &ulTxAddress );\r
738 \r
739         /* Generate a bit of dynamic data and place it in the buffer ready to be\r
740         transmitted. */\r
741         strcpy( cPageBuffer, "<BR>Number of ticks since boot = 0x" );\r
742         lIndex = strlen( cPageBuffer );\r
743         ultoa( xTaskGetTickCount(), &( cPageBuffer[ lIndex ] ), 0 );\r
744         strcat( cPageBuffer, "<br>Number of tasks executing = ");\r
745         lIndex = strlen( cPageBuffer );\r
746         ultoa( ( unsigned long ) uxTaskGetNumberOfTasks(), &( cPageBuffer[ lIndex ] ), 0 );\r
747         strcat( cPageBuffer, "<br>IO port 0 state (used by flash tasks) = 0x" );\r
748         lIndex = strlen( cPageBuffer );\r
749         ultoa( ( unsigned long ) GPIO0_IOPIN, &( cPageBuffer[ lIndex ] ), 0 );\r
750         strcat( cPageBuffer, "<br>Refresh = 0x" );\r
751         lIndex = strlen( cPageBuffer );\r
752         ultoa( ( unsigned long ) ulRefreshCount, &( cPageBuffer[ lIndex ] ), 0 );\r
753         \r
754         if( lErrorInTask )\r
755         {\r
756                 strcat( cPageBuffer, "<p>An error has occurred in at least one task." );\r
757         }\r
758         else\r
759         {\r
760                 strcat( cPageBuffer, "<p>All tasks executing without error." );         \r
761         }\r
762 \r
763         ulRefreshCount++;\r
764 \r
765         /* Send the dynamically generated string. */\r
766         prvWriteString( cPageBuffer, strlen( cPageBuffer ), &ulTxAddress );\r
767 \r
768         /* Finish the page. */\r
769         prvWriteString( cSamplePageSecondPart, strlen( cSamplePageSecondPart ), &ulTxAddress );\r
770 \r
771         /* Tell the WIZnet to send the data we have just written to its Tx buffer. */\r
772         prvFlushBuffer( ulTxAddress );\r
773 }\r
774 \r