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

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