git.sur5r.net Git - freertos/blob - FreeRTOS-Labs/Demo/FreeRTOS_IoT_Libraries/https/common/main.c

   1 /*\r
   2  * FreeRTOS Kernel V10.3.0\r
   3  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.\r
   4  *\r
   5  * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
   6  * this software and associated documentation files (the "Software"), to deal in\r
   7  * the Software without restriction, including without limitation the rights to\r
   8  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
   9  * the Software, and to permit persons to whom the Software is furnished to do so,\r
  10  * subject to the following conditions:\r
  11  *\r
  12  * The above copyright notice and this permission notice shall be included in all\r
  13  * copies or substantial portions of the Software.\r
  14  *\r
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
  17  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
  18  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
  19  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
  20  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
  21  *\r
  22  * http://www.FreeRTOS.org\r
  23  * http://aws.amazon.com/freertos\r
  24  *\r
  25  * 1 tab == 4 spaces!\r
  26  */\r
  27 \r
  28  /***\r
  29   * See https://www.FreeRTOS.org/https/index.html for configuration and usage instructions.\r
  30   ***/\r
  31 \r
  32 /* Standard includes. */\r
  33 #include <stdio.h>\r
  34 #include <time.h>\r
  35 \r
  36 /* Visual studio intrinsics used so the __debugbreak() function is available\r
  37 should an assert get hit. */\r
  38 #include <intrin.h>\r
  39 \r
  40 /* FreeRTOS includes. */\r
  41 #include <FreeRTOS.h>\r
  42 #include "task.h"\r
  43 \r
  44 /* TCP/IP stack includes. */\r
  45 #include "FreeRTOS_IP.h"\r
  46 #include "FreeRTOS_Sockets.h"\r
  47 \r
  48 /* Demo app includes. */\r
  49 #include "demo_logging.h"\r
  50 \r
  51 /*\r
  52  * Prototypes for the demos that can be started from this project.  Note the\r
  53  * HTTPS demo is not actually started until the network is already, which is\r
  54  * indicated by vApplicationIPNetworkEventHook() executing - hence\r
  55  * prvStartSimpleHTTPSDemo() is called from inside vApplicationIPNetworkEventHook().\r
  56  */\r
  57 extern void vStartSimpleHTTPSDemo( void );\r
  58 \r
  59 /*\r
  60  * Just seeds the simple pseudo random number generator.\r
  61  *\r
  62  * !!! NOTE !!!\r
  63  * This is not a secure method of generating random numbers and production\r
  64  * devices should use a true random number generator (TRNG).\r
  65  */\r
  66 static void prvSRand( UBaseType_t ulSeed );\r
  67 \r
  68 /*\r
  69  * Miscellaneous initialization including preparing the logging and seeding the\r
  70  * random number generator.\r
  71  */\r
  72 static void prvMiscInitialisation( void );\r
  73 \r
  74 /* The default IP and MAC address used by the demo.  The address configuration\r
  75 defined here will be used if ipconfigUSE_DHCP is 0, or if ipconfigUSE_DHCP is\r
  76 1 but a DHCP server could not be contacted.  See the online documentation for\r
  77 more information. */\r
  78 static const uint8_t ucIPAddress[ 4 ] = { configIP_ADDR0, configIP_ADDR1, configIP_ADDR2, configIP_ADDR3 };\r
  79 static const uint8_t ucNetMask[ 4 ] = { configNET_MASK0, configNET_MASK1, configNET_MASK2, configNET_MASK3 };\r
  80 static const uint8_t ucGatewayAddress[ 4 ] = { configGATEWAY_ADDR0, configGATEWAY_ADDR1, configGATEWAY_ADDR2, configGATEWAY_ADDR3 };\r
  81 static const uint8_t ucDNSServerAddress[ 4 ] = { configDNS_SERVER_ADDR0, configDNS_SERVER_ADDR1, configDNS_SERVER_ADDR2, configDNS_SERVER_ADDR3 };\r
  82 \r
  83 /* Set the following constant to pdTRUE to log using the method indicated by the\r
  84 name of the constant, or pdFALSE to not log using the method indicated by the\r
  85 name of the constant.  Options include to standard out (xLogToStdout), to a disk\r
  86 file (xLogToFile), and to a UDP port (xLogToUDP).  If xLogToUDP is set to pdTRUE\r
  87 then UDP messages are sent to the IP address configured as the echo server\r
  88 address (see the configECHO_SERVER_ADDR0 definitions in FreeRTOSConfig.h) and\r
  89 the port number set by configPRINT_PORT in FreeRTOSConfig.h. */\r
  90 const BaseType_t xLogToStdout = pdTRUE, xLogToFile = pdFALSE, xLogToUDP = pdFALSE;\r
  91 \r
  92 /* Default MAC address configuration.  The demo creates a virtual network\r
  93 connection that uses this MAC address by accessing the raw Ethernet data\r
  94 to and from a real network connection on the host PC.  See the\r
  95 configNETWORK_INTERFACE_TO_USE definition for information on how to configure\r
  96 the real network connection to use. */\r
  97 const uint8_t ucMACAddress[ 6 ] = { configMAC_ADDR0, configMAC_ADDR1, configMAC_ADDR2, configMAC_ADDR3, configMAC_ADDR4, configMAC_ADDR5 };\r
  98 \r
  99 /* Use by the pseudo random number generator. */\r
 100 static UBaseType_t ulNextRand;\r
 101 /*-----------------------------------------------------------*/\r
 102 \r
 103 int main( void )\r
 104 {\r
 105         /***\r
 106          * See https://www.FreeRTOS.org/https/index.html for configuration and usage instructions.\r
 107          ***/\r
 108 \r
 109         /* Miscellaneous initialization including preparing the logging and seeding\r
 110         the random number generator. */\r
 111         prvMiscInitialisation();\r
 112 \r
 113         /* Initialize the network interface.\r
 114 \r
 115         ***NOTE*** Tasks that use the network are created in the network event hook\r
 116         when the network is connected and ready for use (see the implementation of\r
 117         vApplicationIPNetworkEventHook() below).  The address values passed in here\r
 118         are used if ipconfigUSE_DHCP is set to 0, or if ipconfigUSE_DHCP is set to 1\r
 119         but a DHCP server cannot be contacted. */\r
 120         FreeRTOS_IPInit( ucIPAddress, ucNetMask, ucGatewayAddress, ucDNSServerAddress, ucMACAddress );\r
 121 \r
 122         /* Start the RTOS scheduler. */\r
 123         vTaskStartScheduler();\r
 124 \r
 125         /* If all is well, the scheduler will now be running, and the following\r
 126         line will never be reached.  If the following line does execute, then\r
 127         there was insufficient FreeRTOS heap memory available for the idle and/or\r
 128         timer tasks to be created.  See the memory management section on the\r
 129         FreeRTOS web site for more details (this is standard text that is not\r
 130         really applicable to the Win32 simulator port). */\r
 131         for( ;; )\r
 132         {\r
 133                 __debugbreak();\r
 134         }\r
 135 }\r
 136 /*-----------------------------------------------------------*/\r
 137 \r
 138 /* Called by FreeRTOS+TCP when the network connects or disconnects.  Disconnect\r
 139 events are only received if implemented in the MAC driver. */\r
 140 void vApplicationIPNetworkEventHook( eIPCallbackEvent_t eNetworkEvent )\r
 141 {\r
 142 uint32_t ulIPAddress, ulNetMask, ulGatewayAddress, ulDNSServerAddress;\r
 143 char cBuffer[ 16 ];\r
 144 static BaseType_t xTasksAlreadyCreated = pdFALSE;\r
 145 \r
 146         /* If the network has just come up...*/\r
 147         if( eNetworkEvent == eNetworkUp )\r
 148         {\r
 149                 /* Create the tasks that use the IP stack if they have not already been\r
 150                 created. */\r
 151                 if( xTasksAlreadyCreated == pdFALSE )\r
 152                 {\r
 153                         /* Demos that use the network are created after the network is\r
 154                         up. */\r
 155                         configPRINTF( ( "---------STARTING DEMO---------\r\n" ) );\r
 156                         vStartSimpleHTTPSDemo();\r
 157                         xTasksAlreadyCreated = pdTRUE;\r
 158                 }\r
 159 \r
 160                 /* Print out the network configuration, which may have come from a DHCP\r
 161                 server. */\r
 162                 FreeRTOS_GetAddressConfiguration( &ulIPAddress, &ulNetMask, &ulGatewayAddress, &ulDNSServerAddress );\r
 163                 FreeRTOS_inet_ntoa( ulIPAddress, cBuffer );\r
 164                 FreeRTOS_printf( ( "\r\n\r\nIP Address: %s\r\n", cBuffer ) );/*_RB_ Should use IoT libraries logging. */\r
 165 \r
 166                 FreeRTOS_inet_ntoa( ulNetMask, cBuffer );\r
 167                 FreeRTOS_printf( ( "Subnet Mask: %s\r\n", cBuffer ) );\r
 168 \r
 169                 FreeRTOS_inet_ntoa( ulGatewayAddress, cBuffer );\r
 170                 FreeRTOS_printf( ( "Gateway Address: %s\r\n", cBuffer ) );\r
 171 \r
 172                 FreeRTOS_inet_ntoa( ulDNSServerAddress, cBuffer );\r
 173                 FreeRTOS_printf( ( "DNS Server Address: %s\r\n\r\n\r\n", cBuffer ) );\r
 174         }\r
 175 }\r
 176 /*-----------------------------------------------------------*/\r
 177 \r
 178 void vAssertCalled( const char *pcFile, uint32_t ulLine )\r
 179 {\r
 180         volatile uint32_t ulBlockVariable = 0UL;\r
 181         volatile char *pcFileName = ( volatile char *  ) pcFile;\r
 182         volatile uint32_t ulLineNumber = ulLine;\r
 183 \r
 184         ( void ) pcFileName;\r
 185         ( void ) ulLineNumber;\r
 186 \r
 187         printf( "vAssertCalled( %s, %u\n", pcFile, ulLine );\r
 188 \r
 189         /* Setting ulBlockVariable to a non-zero value in the debugger will allow\r
 190         this function to be exited. */\r
 191         taskDISABLE_INTERRUPTS();\r
 192         {\r
 193                 while( ulBlockVariable == 0UL )\r
 194                 {\r
 195                         __debugbreak();\r
 196                 }\r
 197         }\r
 198         taskENABLE_INTERRUPTS();\r
 199 }\r
 200 /*-----------------------------------------------------------*/\r
 201 \r
 202 UBaseType_t uxRand( void )\r
 203 {\r
 204 const uint32_t ulMultiplier = 0x015a4e35UL, ulIncrement = 1UL;\r
 205 \r
 206         /*\r
 207          * Utility function to generate a pseudo random number.\r
 208          *\r
 209          * !!!NOTE!!!\r
 210          * This is not a secure method of generating a random number.  Production\r
 211          * devices should use a True Random Number Generator (TRNG).\r
 212          */\r
 213         ulNextRand = ( ulMultiplier * ulNextRand ) + ulIncrement;\r
 214         return( ( int ) ( ulNextRand >> 16UL ) & 0x7fffUL );\r
 215 }\r
 216 /*-----------------------------------------------------------*/\r
 217 \r
 218 static void prvSRand( UBaseType_t ulSeed )\r
 219 {\r
 220         /* Utility function to seed the pseudo random number generator. */\r
 221         ulNextRand = ulSeed;\r
 222 }\r
 223 /*-----------------------------------------------------------*/\r
 224 \r
 225 static void prvMiscInitialisation( void )\r
 226 {\r
 227 time_t xTimeNow;\r
 228 uint32_t ulLoggingIPAddress;\r
 229 \r
 230         ulLoggingIPAddress = FreeRTOS_inet_addr_quick( configECHO_SERVER_ADDR0, configECHO_SERVER_ADDR1, configECHO_SERVER_ADDR2, configECHO_SERVER_ADDR3 );\r
 231         vLoggingInit( xLogToStdout, xLogToFile, xLogToUDP, ulLoggingIPAddress, configPRINT_PORT );\r
 232 \r
 233         /*\r
 234         * Seed random number generator.\r
 235         *\r
 236         * !!!NOTE!!!\r
 237         * This is not a secure method of generating a random number.  Production\r
 238         * devices should use a True Random Number Generator (TRNG).\r
 239         */\r
 240         time( &xTimeNow );\r
 241         FreeRTOS_debug_printf( ( "Seed for randomizer: %lu\n", xTimeNow ) );\r
 242         prvSRand( ( uint32_t ) xTimeNow );\r
 243         FreeRTOS_debug_printf( ( "Random numbers: %08X %08X %08X %08X\n", ipconfigRAND32(), ipconfigRAND32(), ipconfigRAND32(), ipconfigRAND32() ) );\r
 244 }\r
 245 /*-----------------------------------------------------------*/\r
 246 \r
 247 #if( ipconfigUSE_LLMNR != 0 ) || ( ipconfigUSE_NBNS != 0 ) || ( ipconfigDHCP_REGISTER_HOSTNAME == 1 )\r
 248 \r
 249         const char *pcApplicationHostnameHook( void )\r
 250         {\r
 251                 /* Assign the name "FreeRTOS" to this network node.  This function will\r
 252                 be called during the DHCP: the machine will be registered with an IP\r
 253                 address plus this name. */\r
 254                 return mainHOST_NAME;\r
 255         }\r
 256 \r
 257 #endif\r
 258 /*-----------------------------------------------------------*/\r
 259 \r
 260 #if( ipconfigUSE_LLMNR != 0 ) || ( ipconfigUSE_NBNS != 0 )\r
 261 \r
 262         BaseType_t xApplicationDNSQueryHook( const char *pcName )\r
 263         {\r
 264         BaseType_t xReturn;\r
 265 \r
 266                 /* Determine if a name lookup is for this node.  Two names are given\r
 267                 to this node: that returned by pcApplicationHostnameHook() and that set\r
 268                 by mainDEVICE_NICK_NAME. */\r
 269                 if( _stricmp( pcName, pcApplicationHostnameHook() ) == 0 )\r
 270                 {\r
 271                         xReturn = pdPASS;\r
 272                 }\r
 273                 else if( _stricmp( pcName, mainDEVICE_NICK_NAME ) == 0 )\r
 274                 {\r
 275                         xReturn = pdPASS;\r
 276                 }\r
 277                 else\r
 278                 {\r
 279                         xReturn = pdFAIL;\r
 280                 }\r
 281 \r
 282                 return xReturn;\r
 283         }\r
 284 \r
 285 #endif\r
 286 /*-----------------------------------------------------------*/\r
 287 \r
 288 /*\r
 289  * Callback that provides the inputs necessary to generate a randomized TCP\r
 290  * Initial Sequence Number per RFC 6528.  THIS IS ONLY A DUMMY IMPLEMENTATION\r
 291  * THAT RETURNS A PSEUDO RANDOM NUMBER SO IS NOT INTENDED FOR USE IN PRODUCTION\r
 292  * SYSTEMS.\r
 293  */\r
 294 extern uint32_t ulApplicationGetNextSequenceNumber( uint32_t ulSourceAddress,\r
 295                                                                                                         uint16_t usSourcePort,\r
 296                                                                                                         uint32_t ulDestinationAddress,\r
 297                                                                                                         uint16_t usDestinationPort )\r
 298 {\r
 299         ( void ) ulSourceAddress;\r
 300         ( void ) usSourcePort;\r
 301         ( void ) ulDestinationAddress;\r
 302         ( void ) usDestinationPort;\r
 303 \r
 304         return uxRand();\r
 305 }\r
 306 /*-----------------------------------------------------------*/\r
 307 \r
 308 /*\r
 309  * Supply a random number to FreeRTOS+TCP stack.\r
 310  * THIS IS ONLY A DUMMY IMPLEMENTATION THAT RETURNS A PSEUDO RANDOM NUMBER\r
 311  * SO IS NOT INTENDED FOR USE IN PRODUCTION SYSTEMS.\r
 312  */\r
 313 BaseType_t xApplicationGetRandomNumber(uint32_t* pulNumber)\r
 314 {\r
 315         *(pulNumber) = uxRand();\r
 316         return pdTRUE;\r
 317 }\r
 318 \r
 319 /*-----------------------------------------------------------*/\r
 320 \r
 321 /* configUSE_STATIC_ALLOCATION is set to 1, so the application must provide an\r
 322 implementation of vApplicationGetIdleTaskMemory() to provide the memory that is\r
 323 used by the Idle task. */\r
 324 void vApplicationGetIdleTaskMemory( StaticTask_t** ppxIdleTaskTCBBuffer, StackType_t** ppxIdleTaskStackBuffer, uint32_t* pulIdleTaskStackSize )\r
 325 {\r
 326         /* If the buffers to be provided to the Idle task are declared inside this\r
 327         function then they must be declared static - otherwise they will be allocated on\r
 328         the stack and so not exists after this function exits. */\r
 329         static StaticTask_t xIdleTaskTCB;\r
 330         static StackType_t uxIdleTaskStack[configMINIMAL_STACK_SIZE];\r
 331 \r
 332         /* Pass out a pointer to the StaticTask_t structure in which the Idle task's\r
 333         state will be stored. */\r
 334         *ppxIdleTaskTCBBuffer = &xIdleTaskTCB;\r
 335 \r
 336         /* Pass out the array that will be used as the Idle task's stack. */\r
 337         *ppxIdleTaskStackBuffer = uxIdleTaskStack;\r
 338 \r
 339         /* Pass out the size of the array pointed to by *ppxIdleTaskStackBuffer.\r
 340         Note that, as the array is necessarily of type StackType_t,\r
 341         configMINIMAL_STACK_SIZE is specified in words, not bytes. */\r
 342         *pulIdleTaskStackSize = configMINIMAL_STACK_SIZE;\r
 343 }\r
 344 /*-----------------------------------------------------------*/\r
 345 \r
 346 /* configUSE_STATIC_ALLOCATION and configUSE_TIMERS are both set to 1, so the\r
 347 application must provide an implementation of vApplicationGetTimerTaskMemory()\r
 348 to provide the memory that is used by the Timer service task. */\r
 349 void vApplicationGetTimerTaskMemory( StaticTask_t** ppxTimerTaskTCBBuffer, StackType_t** ppxTimerTaskStackBuffer, uint32_t* pulTimerTaskStackSize )\r
 350 {\r
 351         /* If the buffers to be provided to the Timer task are declared inside this\r
 352         function then they must be declared static - otherwise they will be allocated on\r
 353         the stack and so not exists after this function exits. */\r
 354         static StaticTask_t xTimerTaskTCB;\r
 355         static StackType_t uxTimerTaskStack[configTIMER_TASK_STACK_DEPTH];\r
 356 \r
 357         /* Pass out a pointer to the StaticTask_t structure in which the Timer\r
 358         task's state will be stored. */\r
 359         *ppxTimerTaskTCBBuffer = &xTimerTaskTCB;\r
 360 \r
 361         /* Pass out the array that will be used as the Timer task's stack. */\r
 362         *ppxTimerTaskStackBuffer = uxTimerTaskStack;\r
 363 \r
 364         /* Pass out the size of the array pointed to by *ppxTimerTaskStackBuffer.\r
 365         Note that, as the array is necessarily of type StackType_t,\r
 366         configMINIMAL_STACK_SIZE is specified in words, not bytes. */\r
 367         *pulTimerTaskStackSize = configTIMER_TASK_STACK_DEPTH;\r
 368 }\r
 369 /*-----------------------------------------------------------*/\r