git.sur5r.net Git - freertos/blob - FreeRTOS-Labs/Demo/FreeRTOS_IoT_Libraries/shadow/shadow_device_operations/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/shadow/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  * Shadow demo is not actually started until the network is already, which is\r
  54  * indicated by vApplicationIPNetworkEventHook() executing - hence\r
  55  * vStartShadowDeviceOperationsDemo() is called from inside\r
  56  * vApplicationIPNetworkEventHook().\r
  57  */\r
  58 extern void vStartShadowDeviceOperationsDemo( void );\r
  59 \r
  60 /*\r
  61  * Just seeds the simple pseudo random number generator.\r
  62  *\r
  63  * !!! NOTE !!!\r
  64  * This is not a secure method of generating random numbers and production\r
  65  * devices should use a true random number generator (TRNG).\r
  66  */\r
  67 static void prvSRand( UBaseType_t ulSeed );\r
  68 \r
  69 /*\r
  70  * Miscellaneous initialization including preparing the logging and seeding the\r
  71  * random number generator.\r
  72  */\r
  73 static void prvMiscInitialisation( void );\r
  74 \r
  75 /* The default IP and MAC address used by the demo.  The address configuration\r
  76 defined here will be used if ipconfigUSE_DHCP is 0, or if ipconfigUSE_DHCP is\r
  77 1 but a DHCP server could not be contacted.  See the online documentation for\r
  78 more information. */\r
  79 static const uint8_t ucIPAddress[ 4 ] = { configIP_ADDR0, configIP_ADDR1, configIP_ADDR2, configIP_ADDR3 };\r
  80 static const uint8_t ucNetMask[ 4 ] = { configNET_MASK0, configNET_MASK1, configNET_MASK2, configNET_MASK3 };\r
  81 static const uint8_t ucGatewayAddress[ 4 ] = { configGATEWAY_ADDR0, configGATEWAY_ADDR1, configGATEWAY_ADDR2, configGATEWAY_ADDR3 };\r
  82 static const uint8_t ucDNSServerAddress[ 4 ] = { configDNS_SERVER_ADDR0, configDNS_SERVER_ADDR1, configDNS_SERVER_ADDR2, configDNS_SERVER_ADDR3 };\r
  83 \r
  84 /* Set the following constant to pdTRUE to log using the method indicated by the\r
  85 name of the constant, or pdFALSE to not log using the method indicated by the\r
  86 name of the constant.  Options include to standard out (xLogToStdout), to a disk\r
  87 file (xLogToFile), and to a UDP port (xLogToUDP).  If xLogToUDP is set to pdTRUE\r
  88 then UDP messages are sent to the IP address configured as the echo server\r
  89 address (see the configECHO_SERVER_ADDR0 definitions in FreeRTOSConfig.h) and\r
  90 the port number set by configPRINT_PORT in FreeRTOSConfig.h. */\r
  91 const BaseType_t xLogToStdout = pdTRUE, xLogToFile = pdFALSE, xLogToUDP = pdFALSE;\r
  92 \r
  93 /* Default MAC address configuration.  The demo creates a virtual network\r
  94 connection that uses this MAC address by accessing the raw Ethernet data\r
  95 to and from a real network connection on the host PC.  See the\r
  96 configNETWORK_INTERFACE_TO_USE definition for information on how to configure\r
  97 the real network connection to use. */\r
  98 const uint8_t ucMACAddress[ 6 ] = { configMAC_ADDR0, configMAC_ADDR1, configMAC_ADDR2, configMAC_ADDR3, configMAC_ADDR4, configMAC_ADDR5 };\r
  99 \r
 100 /* Use by the pseudo random number generator. */\r
 101 static UBaseType_t ulNextRand;\r
 102 /*-----------------------------------------------------------*/\r
 103 \r
 104 int main( void )\r
 105 {\r
 106         /***\r
 107          * See https://www.FreeRTOS.org/shadow/index.html for configuration and usage instructions.\r
 108          ***/\r
 109 \r
 110         /* Miscellaneous initialization including preparing the logging and seeding\r
 111         the random number generator. */\r
 112         prvMiscInitialisation();\r
 113 \r
 114         /* Initialize the network interface.\r
 115 \r
 116         ***NOTE*** Tasks that use the network are created in the network event hook\r
 117         when the network is connected and ready for use (see the implementation of\r
 118         vApplicationIPNetworkEventHook() below).  The address values passed in here\r
 119         are used if ipconfigUSE_DHCP is set to 0, or if ipconfigUSE_DHCP is set to 1\r
 120         but a DHCP server cannot be contacted. */\r
 121         FreeRTOS_IPInit( ucIPAddress, ucNetMask, ucGatewayAddress, ucDNSServerAddress, ucMACAddress );\r
 122 \r
 123         /* Start the RTOS scheduler. */\r
 124         vTaskStartScheduler();\r
 125 \r
 126         /* If all is well, the scheduler will now be running, and the following\r
 127         line will never be reached.  If the following line does execute, then\r
 128         there was insufficient FreeRTOS heap memory available for the idle and/or\r
 129         timer tasks to be created.  See the memory management section on the\r
 130         FreeRTOS web site for more details (this is standard text that is not\r
 131         really applicable to the Win32 simulator port). */\r
 132         for( ;; )\r
 133         {\r
 134                 __debugbreak();\r
 135         }\r
 136 }\r
 137 /*-----------------------------------------------------------*/\r
 138 \r
 139 /* Called by FreeRTOS+TCP when the network connects or disconnects.  Disconnect\r
 140 events are only received if implemented in the MAC driver. */\r
 141 void vApplicationIPNetworkEventHook( eIPCallbackEvent_t eNetworkEvent )\r
 142 {\r
 143 uint32_t ulIPAddress, ulNetMask, ulGatewayAddress, ulDNSServerAddress;\r
 144 char cBuffer[ 16 ];\r
 145 static BaseType_t xTasksAlreadyCreated = pdFALSE;\r
 146 \r
 147         /* If the network has just come up...*/\r
 148         if( eNetworkEvent == eNetworkUp )\r
 149         {\r
 150                 /* Create the tasks that use the IP stack if they have not already been\r
 151                 created. */\r
 152                 if( xTasksAlreadyCreated == pdFALSE )\r
 153                 {\r
 154                         /* Demos that use the network are created after the network is\r
 155                         up. */\r
 156                         configPRINTF( ( "---------STARTING DEMO---------\r\n" ) );\r
 157                         vStartShadowDeviceOperationsDemo();\r
 158                         xTasksAlreadyCreated = pdTRUE;\r
 159                 }\r
 160 \r
 161                 /* Print out the network configuration, which may have come from a DHCP\r
 162                 server. */\r
 163                 FreeRTOS_GetAddressConfiguration( &ulIPAddress, &ulNetMask, &ulGatewayAddress, &ulDNSServerAddress );\r
 164                 FreeRTOS_inet_ntoa( ulIPAddress, cBuffer );\r
 165                 FreeRTOS_printf( ( "\r\n\r\nIP Address: %s\r\n", cBuffer ) );/*_RB_ Should use IoT libraries logging. */\r
 166 \r
 167                 FreeRTOS_inet_ntoa( ulNetMask, cBuffer );\r
 168                 FreeRTOS_printf( ( "Subnet Mask: %s\r\n", cBuffer ) );\r
 169 \r
 170                 FreeRTOS_inet_ntoa( ulGatewayAddress, cBuffer );\r
 171                 FreeRTOS_printf( ( "Gateway Address: %s\r\n", cBuffer ) );\r
 172 \r
 173                 FreeRTOS_inet_ntoa( ulDNSServerAddress, cBuffer );\r
 174                 FreeRTOS_printf( ( "DNS Server Address: %s\r\n\r\n\r\n", cBuffer ) );\r
 175         }\r
 176 }\r
 177 /*-----------------------------------------------------------*/\r
 178 \r
 179 void vAssertCalled( const char *pcFile, uint32_t ulLine )\r
 180 {\r
 181         volatile uint32_t ulBlockVariable = 0UL;\r
 182         volatile char *pcFileName = ( volatile char *  ) pcFile;\r
 183         volatile uint32_t ulLineNumber = ulLine;\r
 184 \r
 185         ( void ) pcFileName;\r
 186         ( void ) ulLineNumber;\r
 187 \r
 188         printf( "vAssertCalled( %s, %u\n", pcFile, ulLine );\r
 189 \r
 190         /* Setting ulBlockVariable to a non-zero value in the debugger will allow\r
 191         this function to be exited. */\r
 192         taskDISABLE_INTERRUPTS();\r
 193         {\r
 194                 while( ulBlockVariable == 0UL )\r
 195                 {\r
 196                         __debugbreak();\r
 197                 }\r
 198         }\r
 199         taskENABLE_INTERRUPTS();\r
 200 }\r
 201 /*-----------------------------------------------------------*/\r
 202 \r
 203 UBaseType_t uxRand( void )\r
 204 {\r
 205 const uint32_t ulMultiplier = 0x015a4e35UL, ulIncrement = 1UL;\r
 206 \r
 207         /*\r
 208          * Utility function to generate a pseudo random number.\r
 209          *\r
 210          * !!!NOTE!!!\r
 211          * This is not a secure method of generating a random number.  Production\r
 212          * devices should use a True Random Number Generator (TRNG).\r
 213          */\r
 214         ulNextRand = ( ulMultiplier * ulNextRand ) + ulIncrement;\r
 215         return( ( int ) ( ulNextRand >> 16UL ) & 0x7fffUL );\r
 216 }\r
 217 /*-----------------------------------------------------------*/\r
 218 \r
 219 static void prvSRand( UBaseType_t ulSeed )\r
 220 {\r
 221         /* Utility function to seed the pseudo random number generator. */\r
 222         ulNextRand = ulSeed;\r
 223 }\r
 224 /*-----------------------------------------------------------*/\r
 225 \r
 226 static void prvMiscInitialisation( void )\r
 227 {\r
 228 time_t xTimeNow;\r
 229 uint32_t ulLoggingIPAddress;\r
 230 \r
 231         ulLoggingIPAddress = FreeRTOS_inet_addr_quick( configECHO_SERVER_ADDR0, configECHO_SERVER_ADDR1, configECHO_SERVER_ADDR2, configECHO_SERVER_ADDR3 );\r
 232         vLoggingInit( xLogToStdout, xLogToFile, xLogToUDP, ulLoggingIPAddress, configPRINT_PORT );\r
 233 \r
 234         /*\r
 235         * Seed random number generator.\r
 236         *\r
 237         * !!!NOTE!!!\r
 238         * This is not a secure method of generating a random number.  Production\r
 239         * devices should use a True Random Number Generator (TRNG).\r
 240         */\r
 241         time( &xTimeNow );\r
 242         FreeRTOS_debug_printf( ( "Seed for randomizer: %lu\n", xTimeNow ) );\r
 243         prvSRand( ( uint32_t ) xTimeNow );\r
 244         FreeRTOS_debug_printf( ( "Random numbers: %08X %08X %08X %08X\n", ipconfigRAND32(), ipconfigRAND32(), ipconfigRAND32(), ipconfigRAND32() ) );\r
 245 }\r
 246 /*-----------------------------------------------------------*/\r
 247 \r
 248 #if( ipconfigUSE_LLMNR != 0 ) || ( ipconfigUSE_NBNS != 0 ) || ( ipconfigDHCP_REGISTER_HOSTNAME == 1 )\r
 249 \r
 250         const char *pcApplicationHostnameHook( void )\r
 251         {\r
 252                 /* Assign the name "FreeRTOS" to this network node.  This function will\r
 253                 be called during the DHCP: the machine will be registered with an IP\r
 254                 address plus this name. */\r
 255                 return mainHOST_NAME;\r
 256         }\r
 257 \r
 258 #endif\r
 259 /*-----------------------------------------------------------*/\r
 260 \r
 261 #if( ipconfigUSE_LLMNR != 0 ) || ( ipconfigUSE_NBNS != 0 )\r
 262 \r
 263         BaseType_t xApplicationDNSQueryHook( const char *pcName )\r
 264         {\r
 265         BaseType_t xReturn;\r
 266 \r
 267                 /* Determine if a name lookup is for this node.  Two names are given\r
 268                 to this node: that returned by pcApplicationHostnameHook() and that set\r
 269                 by mainDEVICE_NICK_NAME. */\r
 270                 if( _stricmp( pcName, pcApplicationHostnameHook() ) == 0 )\r
 271                 {\r
 272                         xReturn = pdPASS;\r
 273                 }\r
 274                 else if( _stricmp( pcName, mainDEVICE_NICK_NAME ) == 0 )\r
 275                 {\r
 276                         xReturn = pdPASS;\r
 277                 }\r
 278                 else\r
 279                 {\r
 280                         xReturn = pdFAIL;\r
 281                 }\r
 282 \r
 283                 return xReturn;\r
 284         }\r
 285 \r
 286 #endif\r
 287 /*-----------------------------------------------------------*/\r
 288 \r
 289 /*\r
 290  * Callback that provides the inputs necessary to generate a randomized TCP\r
 291  * Initial Sequence Number per RFC 6528.  THIS IS ONLY A DUMMY IMPLEMENTATION\r
 292  * THAT RETURNS A PSEUDO RANDOM NUMBER SO IS NOT INTENDED FOR USE IN PRODUCTION\r
 293  * SYSTEMS.\r
 294  */\r
 295 extern uint32_t ulApplicationGetNextSequenceNumber( uint32_t ulSourceAddress,\r
 296                                                                                                         uint16_t usSourcePort,\r
 297                                                                                                         uint32_t ulDestinationAddress,\r
 298                                                                                                         uint16_t usDestinationPort )\r
 299 {\r
 300         ( void ) ulSourceAddress;\r
 301         ( void ) usSourcePort;\r
 302         ( void ) ulDestinationAddress;\r
 303         ( void ) usDestinationPort;\r
 304 \r
 305         return uxRand();\r
 306 }\r
 307 /*-----------------------------------------------------------*/\r
 308 \r
 309 /*\r
 310  * Supply a random number to FreeRTOS+TCP stack.\r
 311  * THIS IS ONLY A DUMMY IMPLEMENTATION THAT RETURNS A PSEUDO RANDOM NUMBER\r
 312  * SO IS NOT INTENDED FOR USE IN PRODUCTION SYSTEMS.\r
 313  */\r
 314 BaseType_t xApplicationGetRandomNumber(uint32_t* pulNumber)\r
 315 {\r
 316         *(pulNumber) = uxRand();\r
 317         return pdTRUE;\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