git.sur5r.net Git - freertos/blob - Demo/WizNET_DEMO_GCC_ARM7/TCP.c

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