periodic update 12/09/2021 15:26 PDT

Author: robhath

doc_source/portingguide/afr-porting-ota.md

@@ -246,7 +246,7 @@ if(AFR_ENABLE_TESTS)
 endif()
 ```
 
-You can find an example `CMakeLists.txt` file for the Windows Simulator platform on  [ GitHub](https://github.com/aws/amazon-freertos/blob/main/vendors/pc/boards/windows/CMakeLists.txt)\.
+You can find an example `CMakeLists.txt` file for the Windows Simulator platform on [ GitHub](https://github.com/aws/amazon-freertos/blob/main/vendors/pc/boards/windows/CMakeLists.txt)\.
 
 ### OTA PAL tests<a name="testing-update-pal"></a>
 

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/include/mbedtls/entropy_poll.h#L90-L91) 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/include/mbedtls/entropy\_poll\.h](https://github.com/ARMmbed/mbedtls/blob/master/include/mbedtls/entropy_poll.h#L94-L102) and [ mbedtls/include/mbedtls/config\.h](https://github.com/ARMmbed/mbedtls/blob/master/include/mbedtls/config.h#L3482-L3511) 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/freertos-porting-cellular.md

@@ -1,6 +1,6 @@
 # Porting the Cellular Interface library<a name="freertos-porting-cellular"></a>
 
-FreeRTOS supports the AT commands of a TCP offloaded cellular abstraction Layer\. For more information, see [FreeRTOS Cellular Interface Library](https://freertos.org/cellular/index.html) and the [Porting Guide](https://freertos.org/cellular-porting-guide.html) for more information\.
+FreeRTOS supports the AT commands of a TCP offloaded cellular abstraction Layer\. For more information, see the [Cellular Interface Library](https://freertos.org/cellular/index.html) and [Porting the Cellular Interface Library](https://freertos.org/cellular-porting-guide.html) on freertos\.org\.
 
 ## Prerequisites<a name="freertos-porting-cellular-prereqs"></a>
 

doc_source/portingguide/freertos-porting-commonio.md

@@ -170,7 +170,7 @@ struct IotI2CDescriptor
 
 **Hardware Setup**
 
-If you're using an onboard sensor as a slave device, you can skip this step\.
+If you're using an onboard sensor as a secondary device, you can skip this step\.
 
 If you use an external device, you need to wire the SDA \(data\) lines and SCL \(clock\) lines of the two devices\.
 
@@ -216,11 +216,11 @@ Not used\. Define it as an array of null to compile\.
    
    #define I2C_TEST_SET                                         1
    
-   /* Slave address. */
+   /* Secondary address. */
    const uint8_t i2cTestSlaveAddr[ I2C_TEST_SET ] = { 0xD4 };
    /* Register address. */
    const uint8_t i2cTestDeviceRegister[ I2C_TEST_SET ] = { 0x73 };
-   /* A value that is written to slave device during test. */
+   /* A value that is written to secondary device during test. */
    const uint8_t i2cTestWriteVal[ I2C_TEST_SET ] = { 0b01101010 };
    /* I2C instance ID. */
    const uint8_t i2cTestInstanceIdx[ I2C_TEST_SET ] = { 1 };

doc_source/portingguide/porting-download.md

@@ -3,7 +3,7 @@
 Before you begin porting FreeRTOS to your platform, you need to download FreeRTOS or clone the FreeRTOS repository from [GitHub](https://github.com/aws/amazon-freertos)\. See the [README\.md](https://github.com/aws/amazon-freertos/blob/main/README.md) file for instructions\.
 
 **Note**  
-We recommend that you clone the repository\. Cloning makes it easier for you to pick up updates to the master branch as they are pushed to the repository\.
+We recommend that you clone the repository\. Cloning makes it easier for you to pick up updates to the main branch as they are pushed to the repository\.
 
 After you download or clone FreeRTOS, you can start porting FreeRTOS code to your platform\. For instructions, see [Setting Up Your FreeRTOS Source Code for Porting](porting-set-up-project.md), and then see [Porting the FreeRTOS Libraries](afr-porting.md)\.
 

doc_source/portingguide/porting-guide.md

@@ -43,7 +43,7 @@ The device that you port to FreeRTOS must be a microcontroller board that meets
 
 ### Porting older versions of FreeRTOS<a name="porting-older"></a>
 
-If you are porting an older version of FreeRTOS, go to the [FreeRTOS AWS Reference Integrations repository](https://github.com/aws/amazon-freertos), and checkout the version of FreeRTOS that you are porting by its version tag\. The qualification and testing documentation will be in PDF format, in the [https://github.com/aws/amazon-freertos/tree/master/tests](https://github.com/aws/amazon-freertos/tree/master/tests) folder\. See the table below for the qualification and testing documentation history\.
+If you are porting an older version of FreeRTOS, go to the [FreeRTOS AWS Reference Integrations repository](https://github.com/aws/amazon-freertos), and checkout the version of FreeRTOS that you are porting by its version tag\. The qualification and testing documentation will be in PDF format, in the [https://github.com/aws/amazon-freertos/tree/main/tests](https://github.com/aws/amazon-freertos/tree/main/tests) folder\. See the table below for the qualification and testing documentation history\.
 
 
 **Revision history of FreeRTOS porting and qualification documentation**  

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

@@ -46,7 +46,7 @@ The exact name of the PAL is technically open ended, but to be compatible with t
 
   Version 3: `OtaPalStatus_t otaPal_Abort( OtaFileContext_t * const *pFileContext* );`
 
-  Notes: Abort an OTA transfer\.
+  Notes: Stop an OTA transfer\.
 + Version 1: `OTA_Err_t prvPAL_SetPlatformImageState( OTA_ImageState_t *eState* );`
 
   Version 3: `OtaPalStatus_t otaPal_SetPlatformImageState( OtaFileContext_t * const pFileContext, OtaImageState_t eState );`

doc_source/qualificationguide/afr-qualification.md

@@ -70,7 +70,7 @@ A: Host all the files and folders necessary to make the port work as an out of t
 The coreMQTT Agent demo must be supported\. Other demos are at your discretion\. Also, the `tools` folder isn't required\. However, we recommend that you host this folder to assist customers with testing\.
 
 Q: *My device uses only cellular connectivity\. Can I still qualify?*  
-A: The FreeRTOS Cellular Interface library supports the AT commands of a TCP offloaded Cellular abstraction Layer\. These are available from [GitHub](https://github.com/FreeRTOS/FreeRTOS-Cellular-Interface)\. There are qualified devices that use the FreeRTOS Cellular Interface library, such as the STM32L4\+ Discovery IoT Node with STEVAL\-STMODLTE that uses a Quectel BG96 cellular modem\. For more information, see [Porting the Cellular Interface library](https://docs.aws.amazon.com/freertos/latest/portingguide/freertos-porting-cellular.html) in the *FreeRTOS Porting Guide*\.
+A: The Cellular Interface library supports the AT commands of a TCP offloaded Cellular abstraction Layer\. These are available from [GitHub](https://github.com/FreeRTOS/FreeRTOS-Cellular-Interface)\. There are qualified devices that use the Cellular Interface library, such as the STM32L4\+ Discovery IoT Node with STEVAL\-STMODLTE that uses a Quectel BG96 cellular modem\. For more information, see [Porting the Cellular Interface library](https://docs.aws.amazon.com/freertos/latest/portingguide/freertos-porting-cellular.html) in the *FreeRTOS Porting Guide*\.
 
 If you have questions about qualification that are not answered on this page or in the rest of the *FreeRTOS Qualification Guide*, contact your AWS representative or [the FreeRTOS engineering team](https://freertos.org/RTOS-contact-and-support.html)\.
 

doc_source/userguide/cellular-interface.md

@@ -2,16 +2,16 @@
 
 ## Introduction<a name="freertos-cellular-interface-introduction"></a>
 
-The FreeRTOS Cellular Interface library exposes the capabilities of a few popular cellular modems through a uniform API\. Currently, this project contains libraries for these three cellular modems\. 
+The Cellular Interface library exposes the capabilities of a few popular cellular modems through a uniform API\. Currently, this project contains libraries for these three cellular modems\. 
 + [Quectel BG96](https://www.quectel.com/product/lte-bg96-cat-m1-nb1-egprs/)
 + [ Sierra Wireless HL7802 ](https://www.sierrawireless.com/products-and-solutions/embedded-solutions/products/hl7802/)
 + [U\-Blox Sara\-R4](https://www.u-blox.com/en/product/sara-r4-series)
 
 The current version of the Cellular Interface library encapsulates the TCP stack offered by those cellular modems\. They all implement the same uniform [ Cellular Interface library API](https://www.freertos.org/Documentation/api-ref/cellular/index.html)\. That API hides the complexity of AT commands, and exposes a socket\-like interface to C programmers\.
 
-Even though applications can choose to use the Cellular Interface API directly, it is not designed for this purpose\. In a typical FreeRTOS system, applications use higher level libraries, such as the [coreMQTT](https://www.freertos.org/mqtt/index.html) library and the [coreHTTP](https://www.freertos.org/http/index.html) library, to communicate with other end points\. These higher level libraries use an abstract interface, the [Transport Interface](https://www.freertos.org/network-interface.html), to send and receive data\. A Transport Interface can be implemented on top of the Cellular Interface library; the  [FreeRTOS Cellular demo](https://www.freertos.org/cellular-demo.html) uses such an implementation\.
+Even though applications can choose to use the Cellular Interface API directly, it is not designed for this purpose\. In a typical FreeRTOS system, applications use higher level libraries, such as the [coreMQTT](https://www.freertos.org/mqtt/index.html) library and the [coreHTTP](https://www.freertos.org/http/index.html) library, to communicate with other end points\. These higher level libraries use an abstract interface, the [Transport Interface](https://www.freertos.org/network-interface.html), to send and receive data\. A Transport Interface can be implemented on top of the Cellular Interface library; the  [Cellular Interface Demo](https://www.freertos.org/cellular-demo.html) uses such an implementation\.
 
-Most cellular modems implement more or less of the AT commands defined by the [ 3GPP TS v27\.007](https://portal.3gpp.org/desktopmodules/Specifications/SpecificationDetails.aspx?specificationId=1515) standard\. This project provides an [implementation](https://github.com/FreeRTOS/FreeRTOS-Cellular-Interface/tree/main/source) of such standard AT commands in a [ reusable common component](https://freertos.org/Documentation/api-ref/cellular/cellular_porting_module_guide.html)\. The three Cellular Interface libraries in this project all take advantage of that common code\. The library for each modem only implements the vendor\-specific AT commands, then exposes the complete Cellular Interface API\.
+Most cellular modems implement more or less of the AT commands defined by the [ 3GPP TS v27\.007](https://portal.3gpp.org/desktopmodules/Specifications/SpecificationDetails.aspx?specificationId=1515) standard\. This project provides an [implementation](https://github.com/FreeRTOS/FreeRTOS-Cellular-Interface/tree/main/source) of such standard AT commands in a [ reusable common component](https://freertos.org/Documentation/api-ref/cellular/cellular_porting_module_guide.html)\. The three Cellular Interface libraries in this project all take advantage of that common code\. The library for each modem only implements the vendor\-specific AT commands, then exposes the complete Cellular Interface library API\.
 
 The common component that implements the 3GPP TS v27\.007 standard has been written in compliance with the following code quality criteria: 
 + GNU Complexity scores are not over 8
@@ -70,14 +70,14 @@ At the root of this repository you will see these folders:
 
 ### Configure and build the Library<a name="freertos-cellular-interface-configure"></a>
 
-The FreeRTOS Cellular Interface library should be built as part of an application\. In order to do this, you must provide certain configurations\. The [ Lab\-Project\-FreeRTOS\-Cellular\-Demo](https://github.com/FreeRTOS/Lab-Project-FreeRTOS-Cellular-Demo) project provides an [ example](https://github.com/FreeRTOS/Lab-Project-FreeRTOS-Cellular-Demo/blob/main/source/cellular/bg96/cellular_config.h) of how to configure the build\. More information can be found in the [Cellular API References](https://www.freertos.org/Documentation/api-ref/cellular/cellular_config.html)\. 
+The Cellular Interface library should be built as part of an application\. In order to do this, you must provide certain configurations\. The [ FreeRTOS\_Cellular\_Interface\_Windows\_Simulator](https://github.com/FreeRTOS/FreeRTOS/tree/main/FreeRTOS-Plus/Demo/FreeRTOS_Cellular_Interface_Windows_Simulator) project provides an [ example](https://github.com/FreeRTOS/FreeRTOS/blob/main/FreeRTOS-Plus/Demo/FreeRTOS_Cellular_Interface_Windows_Simulator/MQTT_Mutual_Auth_Demo_with_BG96/cellular_config.h) of how to configure the build\. More information can be found in the [Cellular API References](https://www.freertos.org/Documentation/api-ref/cellular/cellular_config.html)\. 
 
-Please refer to the [README file of the Lab\-Project\-FreeRTOS\-Cellular\-Demo](https://github.com/FreeRTOS/Lab-Project-FreeRTOS-Cellular-Demo) project for more information\.
+Please refer to the [Cellular Interface](https://www.freertos.org/cellular/index.html) page for more information\.
 
-## Integrate the FreeRTOS Cellular Interface library with MCU platforms<a name="freertos-cellular-interface-integrate"></a>
+## Integrate the Cellular Interface library with MCU platforms<a name="freertos-cellular-interface-integrate"></a>
 
-The FreeRTOS Cellular Interface library runs on MCUs using an abstracted interface, the [ Comm Interface](https://github.com/FreeRTOS/FreeRTOS-Cellular-Interface/blob/main/source/interface/cellular_comm_interface.h), to communicate with cellular modems\. A Comm Interface must be implemented on the MCU platform as well\. The most common implementations of the Comm Interface communicate over UART hardware, but can be implemented over other physical interfaces, such as SPI, as well\. The documentation for the Comm Interface can be found in the [ Cellular API References](https://www.freertos.org/Documentation/api-ref/cellular/cellular_porting.html#cellular_porting_comm_if)\. The following example implementations of the Comm Interface are available:
-+ [ FreeRTOS Windows simulator comm interface](https://github.com/FreeRTOS/Lab-Project-FreeRTOS-Cellular-Demo/blob/main/source/cellular/comm_if_windows.c)
+The Cellular Interface library runs on MCUs using an abstracted interface, the [ Comm Interface](https://github.com/FreeRTOS/FreeRTOS-Cellular-Interface/blob/main/source/interface/cellular_comm_interface.h), to communicate with cellular modems\. A Comm Interface must be implemented on the MCU platform as well\. The most common implementations of the Comm Interface communicate over UART hardware, but can be implemented over other physical interfaces, such as SPI, as well\. The documentation for the Comm Interface can be found in the [ Cellular Library API References](https://www.freertos.org/Documentation/api-ref/cellular/cellular_porting.html#cellular_porting_comm_if)\. The following example implementations of the Comm Interface are available:
++ [ FreeRTOS Windows simulator comm interface](https://github.com/FreeRTOS/FreeRTOS/blob/main/FreeRTOS-Plus/Demo/FreeRTOS_Cellular_Interface_Windows_Simulator/Common/comm_if_windows.c)
 + [  FreeRTOS Common IO UART comm interface](https://github.com/aws/amazon-freertos/blob/main/libraries/abstractions/common_io/include/iot_uart.h)
 + [ STM32 L475 discovery board comm interface](https://github.com/aws/amazon-freertos/blob/feature/cellular/vendors/st/boards/stm32l475_discovery/ports/comm_if/comm_if_uart.c)
 + [ Sierra Sensor Hub board comm interface](https://github.com/aws/amazon-freertos/blob/feature/cellular/vendors/sierra/boards/sensorhub/ports/comm_if/comm_if_sierra.c)

doc_source/userguide/core-http-s3-upload-demo.md

@@ -30,7 +30,7 @@ This demo uses a pre\-signed URL to connect to the Amazon S3 HTTP server and aut
       1. Grant permission to your AWS account to access FreeRTOS and AWS IoT by adding this policy:
          + AmazonS3FullAccess
 
-1. Create a bucket in Amazon S3 by following the steps in [How do I create an S3 bucket?](https://docs.aws.amazon.com/AmazonS3/latest/user-guide/create-bucket.html) in the *Amazon Simple Storage Service Console User Guide*\.
+1. Create a bucket in Amazon S3 by following the steps in [How do I create an S3 bucket?](https://docs.aws.amazon.com/AmazonS3/latest/user-guide/create-bucket.html) in the *Amazon Simple Storage Service User Guide*\.
 
 1. Upload a file to Amazon S3 by following the steps in [How do I upload files and folders to an S3 bucket?](https://docs.aws.amazon.com/AmazonS3/latest/user-guide/upload-objects.html)\.