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

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