periodic update 05/02/2022 14:51 PDT

Author: robhath

doc_source/portingguide/afr-porting-ota.md

@@ -8,7 +8,7 @@ With FreeRTOS over\-the\-air \(OTA\) updates, you can do the following:
 + Debug a failed deployment\.
 + Digitally sign firmware using Code Signing for AWS IoT\.
 
-For more information, see [FreeRTOS Over\-the\-Air Updates](https://docs.aws.amazon.com/freertos/latest/userguide/freertos-ota-dev.html) in the *FreeRTOS User Guide* along with the [ AWS IoT Over\-the\-air Update Documentation](https://freertos.org/Documentation/api-ref/ota-for-aws-iot-embedded-sdk/docs/doxygen/output/html/index.html)\.
+For more information, see [FreeRTOS Over\-the\-Air Updates](https://docs.aws.amazon.com/freertos/latest/userguide/freertos-ota-dev.html) in the *FreeRTOS User Guide* along with the [AWS IoT Over\-the\-air Update Documentation](https://freertos.org/Documentation/api-ref/ota-for-aws-iot-embedded-sdk/docs/doxygen/output/html/index.html)\.
 
 You can use the OTA update library to integrate OTA functionality into your FreeRTOS applications\. For more information, see [FreeRTOS OTA update Library](https://docs.aws.amazon.com/freertos/latest/userguide/ota-update-library.html) in the *FreeRTOS User Guide*\.
 

doc_source/portingguide/afr-porting-pkcs.md

@@ -48,7 +48,7 @@ To port the corePKCS11 library, you need the following:
 1. Add support for a cryptographically random entropy source to your port:
    + If your ports use the mbedTLS library for underlying cryptographic and TLS support, and your device has a true random number generator \(TRNG\):
 
-     1. Implement the [  mbedtls\_hardware\_poll\(\)](https://github.com/ARMmbed/mbedtls/blob/master/library/entropy_poll.h#L49-L60) function to seed the deterministic random bit generator \(DRBG\) that mbedTLS uses to produce a cryptographically random bit stream\. The `mbedtls_hardware_poll()` function is located in `freertos/vendors/vendor/boards/board/ports/pkcs11/core_pkcs11_pal.c`\. 
+     1. Implement the [ mbedtls\_hardware\_poll\(\)](https://github.com/ARMmbed/mbedtls/blob/master/library/entropy_poll.h#L49-L60) function to seed the deterministic random bit generator \(DRBG\) that mbedTLS uses to produce a cryptographically random bit stream\. The `mbedtls_hardware_poll()` function is located in `freertos/vendors/vendor/boards/board/ports/pkcs11/core_pkcs11_pal.c`\. 
    + If your ports use the mbedTLS library for underlying cryptographic and TLS support, but your device does not have a TRNG:
 
      1. Make a copy of `freertos/libraries/3rdparty/mbedtls/include/mbedtls/config.h`, and in that copy, uncomment `MBEDTLS_ENTROPY_NV_SEED`, and comment out `MBEDTLS_ENTROPY_HARDWARE_ALT`\.
@@ -57,7 +57,7 @@ To port the corePKCS11 library, you need the following:
 
      1. Implement the functions `mbedtls_nv_seed_poll()`, `nv_seed_read_func()`, and `nv_seed_write_func()`\.
 
-        For information about implementing these functions, see the comments in the [  mbedtls/library/mbedtls/entropy\_poll\.h](https://github.com/ARMmbed/mbedtls/blob/master/library/entropy_poll.h#L62-L70) and [ mbedtls/include/mbedtls/platform\.h](https://github.com/ARMmbed/mbedtls/blob/master/include/mbedtls/platform.h#L315-L355) mbedTLS header files\.
+        For information about implementing these functions, see the comments in the [ mbedtls/library/mbedtls/entropy\_poll\.h](https://github.com/ARMmbed/mbedtls/blob/master/library/entropy_poll.h#L62-L70) and [ mbedtls/include/mbedtls/platform\.h](https://github.com/ARMmbed/mbedtls/blob/master/include/mbedtls/platform.h#L315-L355) mbedTLS header files\.
 **Important**  
 A seed file with an NIST\-approved entropy source must be supplied to the device at manufacturing time\.
 **Note**  

doc_source/portingguide/afr-porting-wifi.md

@@ -50,7 +50,7 @@ In the following steps, make sure that you add the source files to your IDE proj
 
 1. Add the source file `freertos/vendors/vendor/boards/board/ports/wifi/iot_wifi.c` to your `aws_tests` IDE project\.
 
-1. Add the source file `aws_test_wifi.c` to the `aws_tests` IDE project\.
+1. Add the source files `iot_test_wifi.c` and `iot_test_wifi.h` to the `aws_tests` IDE project\.
 
 ### Configuring the `CMakeLists.txt` file<a name="testing-cmake-wifi"></a>
 
@@ -84,7 +84,7 @@ After you set up the library in the IDE project, you need to configure some othe
 1. Open `freertos/tests/include/aws_clientcredential.h`, and set the macros in the following table for the first AP\.    
 [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/freertos/latest/portingguide/afr-porting-wifi.html)
 
-1. Open `freertos/libraries/abstractions/wifi/test/aws_test_wifi.h`, and set the macros in the following table for the second AP\.    
+1. Open `freertos/libraries/abstractions/wifi/test/iot_test_wifi.h`, and set the macros in the following table for the second AP\.    
 [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/freertos/latest/portingguide/afr-porting-wifi.html)
 
 1. To enable the Wi\-Fi tests, open `freertos/vendors/vendor/boards/board/aws_tests/config_files/aws_test_runner_config.h`, and set the `testrunnerFULL_WIFI_ENABLED` to `1`\. 

doc_source/portingguide/ota-updates-ble.md

@@ -465,4 +465,4 @@ W (146348) BT_SMP: FOR LE SC LTK IS USED INSTEAD OF STK
 
 ## References<a name="ota-updates-ble-reference"></a>
 
-1. [ AWS Blog on OTA updates over Bluetooth Low Energy](https://aws.amazon.com/blogs/iot/perform-ota-firmware-updates-on-espressif-esp32-devices-using-amazon-freertos-bluetooth-low-energy-mqtt-proxy/)\.
+1. [AWS Blog on OTA updates over Bluetooth Low Energy](https://aws.amazon.com/blogs/iot/perform-ota-firmware-updates-on-espressif-esp32-devices-using-amazon-freertos-bluetooth-low-energy-mqtt-proxy/)\.

doc_source/portingguide/porting-ca-config.md

@@ -2,7 +2,7 @@
 
 Save the following text to a file named `ca.config` in your current working directory\.
 
-This file is a modified version of the [ `openssl.cnf`](https://github.com/openssl/openssl/blob/master/apps/openssl.cnf) OpenSSL example configuration file\.
+This file is a modified version of the [https://github.com/openssl/openssl/blob/master/apps/openssl.cnf](https://github.com/openssl/openssl/blob/master/apps/openssl.cnf) OpenSSL example configuration file\.
 
 ```
 #

doc_source/portingguide/porting-create-project.md

@@ -23,7 +23,7 @@ Eclipse generates an additional `includes` folder\. This folder is not a part of
 
 1. Import all of the header files in the `freertos/vendors/vendor/boards/board/aws_tests/config_files` directory into the `aws_tests/config_files` virtual folder in your IDE\.
 **Note**  
-If you are not porting a specific library, you do not need to import the files for that library into your project\. For example, if you are not porting the OTA library, you can leave out the `aws_ota_agent_config.h` and `aws_test_ota_config.h` files\. If you are not porting the Wi\-Fi library, you can leave out the `aws_test_wifi_config.h` and `aws_wifi_config.h` files\.
+If you are not porting a specific library, you do not need to import the files for that library into your project\. For example, if you are not porting the OTA library, you can leave out the `aws_ota_agent_config.h` and `aws_test_ota_config.h` files\. If you are not porting the Wi\-Fi library, you can leave out the `iot_test_wifi.h` and `iot_test_wifi.c` files\.
 
 1. Import the required libraries in `freertos/libraries` and its subdirectories into the `aws_tests` IDE project, including any required third\-party libraries\. For information on the required libraries please follow the [FreeRTOS porting flowchart](https://docs.aws.amazon.com/freertos/latest/portingguide/porting-chart.html)\. Information about which FreeRTOS libraries depend on third\-party libraries that need to be included in addition to the test project is provided in the specific library's porting section\. 
 

doc_source/portingguide/porting-migration-ota-pal.md

@@ -4,7 +4,7 @@ The Over\-the\-air Updates Library introduced some changes in the folder structu
 
 ## Changes to OTA PAL<a name="porting-migration-ota-pal-changes"></a>
 + The OTA PAL port directory name has been updated from `ota` to `ota_pal_for_aws`\. This folder must contain 2 files: `ota_pal.c` and `ota_pal.h`\. The PAL header file `libraries/freertos_plus/aws/ota/src/aws_iot_ota_pal.h` has been deleted from the OTA library and must be defined inside the port\.
-+ The return codes \(`OTA_Err_t`\) are translated into an enum `OTAMainStatus_t`\. Refer to [  ota\_platform\_interface\.h](https://github.com/aws/ota-for-aws-iot-embedded-sdk/blob/v3.0.0/source/include/ota_platform_interface.h#L68-L90) for translated return codes\. [  Helper macros](https://github.com/aws/ota-for-aws-iot-embedded-sdk/blob/666241d0f643b07d5146a3715b649d80f8135e0b/source/include/ota_platform_interface.h#L105-L111) are also provided to combine `OtaPalMainStatus` and `OtaPalSubStatus` codes and extract `OtaMainStatus` from `OtaPalStatus` and similar\.
++ The return codes \(`OTA_Err_t`\) are translated into an enum `OTAMainStatus_t`\. Refer to [ ota\_platform\_interface\.h](https://github.com/aws/ota-for-aws-iot-embedded-sdk/blob/v3.0.0/source/include/ota_platform_interface.h#L68-L90) for translated return codes\. [ Helper macros](https://github.com/aws/ota-for-aws-iot-embedded-sdk/blob/666241d0f643b07d5146a3715b649d80f8135e0b/source/include/ota_platform_interface.h#L105-L111) are also provided to combine `OtaPalMainStatus` and `OtaPalSubStatus` codes and extract `OtaMainStatus` from `OtaPalStatus` and similar\.
 + Logging in the PAL 
   + Removed the `DEFINE_OTA_METHOD_NAME` macro\.
   + Earlier: `OTA_LOG_L1( "[%s] Receive file created.\r\n", OTA_METHOD_NAME );`\.
@@ -98,7 +98,7 @@ The exact name of the PAL is technically open ended, but to be compatible with t
 
 ### Configuration changes<a name="porting-migration-ota-pal-config-changes"></a>
 
-The file `aws_ota_agent_config.h` was renamed to [ `ota_config.h`](https://github.com/aws/amazon-freertos/blob/main/vendors/pc/boards/windows/aws_demos/config_files/ota_config.h) which changes the include guards from `_AWS_OTA_AGENT_CONFIG_H_` to `OTA_CONFIG_H_`\.
+The file `aws_ota_agent_config.h` was renamed to [https://github.com/aws/amazon-freertos/blob/main/vendors/pc/boards/windows/aws_demos/config_files/ota_config.h](https://github.com/aws/amazon-freertos/blob/main/vendors/pc/boards/windows/aws_demos/config_files/ota_config.h) which changes the include guards from `_AWS_OTA_AGENT_CONFIG_H_` to `OTA_CONFIG_H_`\.
 + The file `aws_ota_codesigner_certificate.h` has been deleted\.
 + Included the new logging stack to print debug messages:
 
@@ -135,7 +135,7 @@ The file `aws_ota_agent_config.h` was renamed to [ `ota_config.h`](https://githu
   #define otaconfigFILE_BLOCK_SIZE ( 1UL << otaconfigLOG2_FILE_BLOCK_SIZE )
   ```
 
-**New File:** [ `ota_demo_config.h`](https://github.com/aws/amazon-freertos/blob/main/vendors/pc/boards/windows/aws_demos/config_files/ota_demo_config.h) contains the configs that are required by the OTA demo such as the code signing certificate and application version\.
+**New File:** [https://github.com/aws/amazon-freertos/blob/main/vendors/pc/boards/windows/aws_demos/config_files/ota_demo_config.h](https://github.com/aws/amazon-freertos/blob/main/vendors/pc/boards/windows/aws_demos/config_files/ota_demo_config.h) contains the configs that are required by the OTA demo such as the code signing certificate and application version\.
 + `signingcredentialSIGNING_CERTIFICATE_PEM` which was defined in `demos/include/aws_ota_codesigner_certificate.h` has been moved to `ota_demo_config.h` as `otapalconfigCODE_SIGNING_CERTIFICATE` and can can be accessed from the PAL files as: 
 
   ```
@@ -184,5 +184,5 @@ Use this checklist to make sure you follow the steps required for migration:
   + Update the printing macros to use the logging stack\.
   + Update the `signingcredentialSIGNING_CERTIFICATE_PEM` to be `otapalconfigCODE_SIGNING_CERTIFICATE`\.
   + Update `otaPal_CheckFileSignature` and `otaPal_ReadAndAssumeCertificate` function comments\.
-+ Update the [ `CMakeLists.txt`](https://github.com/aws/amazon-freertos/pull/3208/commits/432e13fcb8dfbfeb6de25110a3d2ea14ccaf1b9a) file\.
++ Update the [https://github.com/aws/amazon-freertos/pull/3208/commits/432e13fcb8dfbfeb6de25110a3d2ea14ccaf1b9a](https://github.com/aws/amazon-freertos/pull/3208/commits/432e13fcb8dfbfeb6de25110a3d2ea14ccaf1b9a) file\.
 + Update the IDE projects\.

doc_source/portingguide/porting-migration-ota.md

@@ -194,7 +194,7 @@ The OTA PAL interface is a set of APIs that must be implemented for the device t
     otaInterfaces.pal.createFile = otaPal_CreateFileForRx;
 ```  
 **Changes in return \-**  
-The return is changed from OTA agent state to OTA error code\. Please refer to [ AWS IoT Over\-the\-air Update v3\.0\.0 : OtaErr\_t](https://freertos.org/Documentation/api-ref/ota-for-aws-iot-embedded-sdk/docs/doxygen/output/html/group__ota__enum__types.html#ga7ab3c74dc057383c56c6cb9aa6bf0b2d)\.
+The return is changed from OTA agent state to OTA error code\. Please refer to [AWS IoT Over\-the\-air Update v3\.0\.0 : OtaErr\_t](https://freertos.org/Documentation/api-ref/ota-for-aws-iot-embedded-sdk/docs/doxygen/output/html/group__ota__enum__types.html#ga7ab3c74dc057383c56c6cb9aa6bf0b2d)\.
 
 ### OTA\_Shutdown<a name="porting-migration-ota-shutdown"></a>
 
@@ -222,7 +222,7 @@ Flag to indicate if unsubscribe operations should be performed from the job topi
 
 **Changes in return \-**  
 OtaState\_t \-   
-The enum for OTA Agent state and its members are renamed\. Please refer to [ AWS IoT Over\-the\-air Update v3\.0\.0](https://freertos.org/Documentation/api-ref/ota-for-aws-iot-embedded-sdk/docs/doxygen/output/html/group__ota__enum__types.html#ga1cb476a5e0ee81fa486f605e64419dcc)\.
+The enum for OTA Agent state and its members are renamed\. Please refer to [AWS IoT Over\-the\-air Update v3\.0\.0](https://freertos.org/Documentation/api-ref/ota-for-aws-iot-embedded-sdk/docs/doxygen/output/html/group__ota__enum__types.html#ga1cb476a5e0ee81fa486f605e64419dcc)\.
 
 ### OTA\_GetState<a name="porting-migration-ota-get-state"></a>
 
@@ -242,7 +242,7 @@ OtaState_t OTA_GetState( void );
 
 **Changes in return \-**  
 OtaState\_t \-   
-The enum for OTA Agent state and its members are renamed\. Please refer to [ AWS IoT Over\-the\-air Update v3\.0\.0](https://freertos.org/Documentation/api-ref/ota-for-aws-iot-embedded-sdk/docs/doxygen/output/html/group__ota__enum__types.html#ga1cb476a5e0ee81fa486f605e64419dcc)\.
+The enum for OTA Agent state and its members are renamed\. Please refer to [AWS IoT Over\-the\-air Update v3\.0\.0](https://freertos.org/Documentation/api-ref/ota-for-aws-iot-embedded-sdk/docs/doxygen/output/html/group__ota__enum__types.html#ga1cb476a5e0ee81fa486f605e64419dcc)\.
 
 ### OTA\_GetStatistics<a name="porting-migration-ota-get-stats"></a>
 
@@ -296,7 +296,7 @@ OTA_Err_t OTA_ActivateNewImage( void );
 ```
 OtaErr_t OTA_ActivateNewImage( void );
 ```
-The return OTA error code enum is changed and new error codes are added\. Please refer to [ AWS IoT Over\-the\-air Update v3\.0\.0 : OtaErr\_t](https://freertos.org/Documentation/api-ref/ota-for-aws-iot-embedded-sdk/docs/doxygen/output/html/group__ota__enum__types.html#ga7ab3c74dc057383c56c6cb9aa6bf0b2d)\.
+The return OTA error code enum is changed and new error codes are added\. Please refer to [AWS IoT Over\-the\-air Update v3\.0\.0 : OtaErr\_t](https://freertos.org/Documentation/api-ref/ota-for-aws-iot-embedded-sdk/docs/doxygen/output/html/group__ota__enum__types.html#ga7ab3c74dc057383c56c6cb9aa6bf0b2d)\.
 
 **Example usage \- **  
 
@@ -321,8 +321,8 @@ OTA_Err_t OTA_SetImageState( OTA_ImageState_t eState );
 ```
 OtaErr_t OTA_SetImageState( OtaImageState_t state ); 
 ```
-The input parameter is renamed to OtaImageState\_t\. Please refer to [ AWS IoT Over\-the\-air Update v3\.0\.0](https://freertos.org/Documentation/api-ref/ota-for-aws-iot-embedded-sdk/docs/doxygen/output/html/group__ota__enum__types.html#gad4909faa8b9c8672e7f7bef1bc6b5b84)\.  
-The return OTA error code enum is changed and new error codes are added\. Please refer to [ AWS IoT Over\-the\-air Update v3\.0\.0 / OtaErr\_t](https://freertos.org/Documentation/api-ref/ota-for-aws-iot-embedded-sdk/docs/doxygen/output/html/group__ota__enum__types.html#ga7ab3c74dc057383c56c6cb9aa6bf0b2d)\.
+The input parameter is renamed to OtaImageState\_t\. Please refer to [AWS IoT Over\-the\-air Update v3\.0\.0](https://freertos.org/Documentation/api-ref/ota-for-aws-iot-embedded-sdk/docs/doxygen/output/html/group__ota__enum__types.html#gad4909faa8b9c8672e7f7bef1bc6b5b84)\.  
+The return OTA error code enum is changed and new error codes are added\. Please refer to [AWS IoT Over\-the\-air Update v3\.0\.0 / OtaErr\_t](https://freertos.org/Documentation/api-ref/ota-for-aws-iot-embedded-sdk/docs/doxygen/output/html/group__ota__enum__types.html#ga7ab3c74dc057383c56c6cb9aa6bf0b2d)\.
 
 **Example usage \- **  
 
@@ -347,7 +347,7 @@ OTA_ImageState_t OTA_GetImageState( void );
 ```
 OtaImageState_t OTA_GetImageState( void ); 
 ```
-The return enum is renamed to OtaImageState\_t\. Please refer to [ AWS IoT Over\-the\-air Update v3\.0\.0 : OtaImageState\_t ](https://freertos.org/Documentation/api-ref/ota-for-aws-iot-embedded-sdk/docs/doxygen/output/html/group__ota__enum__types.html#gad4909faa8b9c8672e7f7bef1bc6b5b84)\.
+The return enum is renamed to OtaImageState\_t\. Please refer to [AWS IoT Over\-the\-air Update v3\.0\.0 : OtaImageState\_t ](https://freertos.org/Documentation/api-ref/ota-for-aws-iot-embedded-sdk/docs/doxygen/output/html/group__ota__enum__types.html#gad4909faa8b9c8672e7f7bef1bc6b5b84)\.
 
 **Example usage \- **  
 
@@ -371,7 +371,7 @@ OTA_Err_t OTA_Suspend( void );
 ```
 OtaErr_t OTA_Suspend( void ); 
 ```
-The return OTA error code enum is changed and new error codes are added\. Please refer to [ AWS IoT Over\-the\-air Update v3\.0\.0 : OtaErr\_t](https://freertos.org/Documentation/api-ref/ota-for-aws-iot-embedded-sdk/docs/doxygen/output/html/group__ota__enum__types.html#ga7ab3c74dc057383c56c6cb9aa6bf0b2d)\. 
+The return OTA error code enum is changed and new error codes are added\. Please refer to [AWS IoT Over\-the\-air Update v3\.0\.0 : OtaErr\_t](https://freertos.org/Documentation/api-ref/ota-for-aws-iot-embedded-sdk/docs/doxygen/output/html/group__ota__enum__types.html#ga7ab3c74dc057383c56c6cb9aa6bf0b2d)\. 
 
 **Example usage \- **  
 
@@ -396,7 +396,7 @@ OTA_Err_t OTA_Resume( void * pxConnection );
 ```
 OtaErr_t OTA_Resume( void ); 
 ```
-The return OTA error code enum is changed and new error codes are added\. Please refer to [ AWS IoT Over\-the\-air Update v3\.0\.0 : OtaErr\_t](https://freertos.org/Documentation/api-ref/ota-for-aws-iot-embedded-sdk/docs/doxygen/output/html/group__ota__enum__types.html#ga7ab3c74dc057383c56c6cb9aa6bf0b2d)\.
+The return OTA error code enum is changed and new error codes are added\. Please refer to [AWS IoT Over\-the\-air Update v3\.0\.0 : OtaErr\_t](https://freertos.org/Documentation/api-ref/ota-for-aws-iot-embedded-sdk/docs/doxygen/output/html/group__ota__enum__types.html#ga7ab3c74dc057383c56c6cb9aa6bf0b2d)\.
 
 **Example usage \- **  
 
@@ -421,7 +421,7 @@ OTA_Err_t OTA_CheckForUpdate( void );
 ```
 OtaErr_t OTA_CheckForUpdate( void ) 
 ```
-The return OTA error code enum is changed and new error codes are added\. Please refer to [ AWS IoT Over\-the\-air Update v3\.0\.0 : OtaErr\_t](https://freertos.org/Documentation/api-ref/ota-for-aws-iot-embedded-sdk/docs/doxygen/output/html/group__ota__enum__types.html#ga7ab3c74dc057383c56c6cb9aa6bf0b2d)\.
+The return OTA error code enum is changed and new error codes are added\. Please refer to [AWS IoT Over\-the\-air Update v3\.0\.0 : OtaErr\_t](https://freertos.org/Documentation/api-ref/ota-for-aws-iot-embedded-sdk/docs/doxygen/output/html/group__ota__enum__types.html#ga7ab3c74dc057383c56c6cb9aa6bf0b2d)\.
 
 ### OTA\_EventProcessingTask<a name="porting-migration-ota-event"></a>