periodic update 10/01/2021 14:58 PDT

Author: robhath

doc_source/portingguide/afr-porting-ss.md

@@ -18,7 +18,7 @@ To port the Secure Sockets library, you need the following:
   For information about porting the Wi\-Fi library, see [Porting the Wi\-Fi library](afr-porting-wifi.md)\.
 + If your board has cellular connectivity, you must provide a Secure Sockets library that uses the cellular modem as transport\. You can implement the Secure Sockets library in two ways:
   + Implement the Secure Sockets API by using the AT commands of your modem directly\.
-  + Use the Cellular library provided by FreeRTOS, which hides the AT commands and provides a socket\-like API\. For more information, see [Porting the Cellular library](freertos-porting-cellular.md)\.
+  + Use the Cellular Interface library provided by FreeRTOS, which hides the AT commands and provides a socket\-like API\. For more information, see [Porting the Cellular Interface library](freertos-porting-cellular.md)\.
 + A port of a TCP/IP stack\.
 
   For information about porting a TCP/IP stack, see [Porting a TCP/IP stack](afr-porting-tcp.md)\.

doc_source/portingguide/afr-porting.md

@@ -40,9 +40,9 @@ Currently AWS IoT Device Tester does not support qualification of Over the Air u
 **Note**  
 Currently, a port of the FreeRTOS common I/O library is not required for qualification\.
 
-1. [Porting the Cellular library](freertos-porting-cellular.md)
+1. [Porting the Cellular Interface library](freertos-porting-cellular.md)
 **Note**  
-Currently, a port of the FreeRTOS Cellular library is not required for qualification\.
+Currently, a port of the FreeRTOS Cellular Interface library is not required for qualification\.
 
 After you port FreeRTOS to your board, you can officially validate the ports for FreeRTOS qualification with AWS IoT Device Tester for FreeRTOS\. For more information about AWS IoT Device Tester for FreeRTOS, see [Using AWS IoT Device Tester for FreeRTOS](https://docs.aws.amazon.com/freertos/latest/userguide/device-tester-for-freertos-ug.html) in the FreeRTOS User Guide\. 
 

doc_source/portingguide/freertos-porting-cellular.md

@@ -1,13 +1,10 @@
-# Porting the Cellular library<a name="freertos-porting-cellular"></a>
+# Porting the Cellular Interface library<a name="freertos-porting-cellular"></a>
 
-FreeRTOS Labs now supports AT commands, TCP offloaded cellular abstraction Layer\. For more information, see [FreeRTOS Labs \- Cellular Libraries](https://freertos.org/cellular/index.html) and the [Porting Guide](https://freertos.org/cellular-porting-guide.html) for more information\.
-
-**Note**  
-The Cellular Library is in FreeRTOS Labs\. The libraries in the FreeRTOS Labs download are fully functional, but undergoing improvements to their implementation, documentation, and coding style\.
+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\.
 
 ## Prerequisites<a name="freertos-porting-cellular-prereqs"></a>
 
-There is no direct dependency for the Cellular Library, however, in the FreeRTOS network stack, Ethernet, Wi\-Fi and cellular cannot co\-exist, so developers must choose one of them to integrate with the [Secure Sockets library](https://docs.aws.amazon.com/freertos/latest/userguide/secure-sockets.html)\.
+There is no direct dependency for the Cellular Interface library, however, in the FreeRTOS network stack, Ethernet, Wi\-Fi and cellular cannot co\-exist, so developers must choose one of them to integrate with the [Secure Sockets library](https://docs.aws.amazon.com/freertos/latest/userguide/secure-sockets.html)\.
 
 **Note**  
 If the cellular module is able to support TLS offload, or does not support AT commands, developers can implement their own cellular abstraction to integrate with the [Secure Sockets library](https://docs.aws.amazon.com/freertos/latest/userguide/secure-sockets.html)\.

doc_source/portingguide/index.md

@@ -46,7 +46,7 @@ Amazon's trademarks and trade dress may not be used in
    + [Porting the Bluetooth Low Energy library](afr-porting-ble.md)
    + [Perform Over the Air Updates using Bluetooth Low Energy](ota-updates-ble.md)
    + [Porting the common I/O libraries](freertos-porting-commonio.md)
-   + [Porting the Cellular library](freertos-porting-cellular.md)
+   + [Porting the Cellular Interface library](freertos-porting-cellular.md)
 + [Migrating from Version 1.4.x to Version 201906.00 (and newer)](porting-migration.md)
 + [Migrating from version 1 to version 3 for OTA applications](porting-migration-ota.md)
 + [Migrating from version 1 to version 3 for OTA Pal port](porting-migration-ota-pal.md)

doc_source/portingguide/ota-updates-ble.md

@@ -91,7 +91,7 @@ Before you create the AWS IoT Policy, you need to know your AWS region and AWS a
 
 1. In the upper\-right corner, choose your account and under **My Account** make a note of your 12\-digit account ID\.
 
-1. In the left navigation pane, choose **Settings**\. Under **Custom endpoint**, make a note of the endpoint value\. The endpoint should be something like "*xxxxxxxxxxxxxx*\.iot\.*us\-west\-2*\.amazonaws\.com"\. In this example, the AWS region is "us\-west\-2"\.
+1. In the left navigation pane, choose **Settings**\. Under **Device data endpoint**, make a note of the endpoint value\. The endpoint should be something like "*xxxxxxxxxxxxxx*\.iot\.*us\-west\-2*\.amazonaws\.com"\. In this example, the AWS region is "us\-west\-2"\.
 
 1. In the left navigation pane, choose **Secure**, choose **Policies**, and then choose **Create**\.
 

doc_source/portingguide/testing-connect-iot.md

@@ -70,7 +70,7 @@ After you obtain your certificates and keys from the AWS IoT console, you need t
 
 1. In the navigation pane, choose **Settings**\.
 
-   Your AWS IoT endpoint is displayed in **Endpoint**\. It should look like `123456789012-ats.iot.us-east-1.amazonaws.com`\. Make a note of this endpoint\.
+   Your AWS IoT endpoint is displayed in **Device data endpoint**\. It should look like `123456789012-ats.iot.us-east-1.amazonaws.com`\. Make a note of this endpoint\.
 
 1. In the navigation pane, choose **Manage**, and then choose **Things**\.
 

doc_source/qualificationguide/afr-qualification.md

@@ -69,6 +69,9 @@ Q: *We will be hosting our FreeRTOS port in our own repo as per the qualificatio
 A: Host all the files and folders necessary to make the port work as an out of the box experience for a customer who downloads it from the repository\. You should include your entire `freertos_kernel`, `libraries`, and `tools` folders, along with a `docs` folder for your documents, a `projects` folder for your IDE projects, and a `vendors` folder for your vendor\-specifc files\. Also include your entire demo folder\.   
 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*\.
+
 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)\.
 
 ### Documentation history<a name="afr-doc-history"></a>

doc_source/userguide/c-sdk.md

@@ -10,6 +10,7 @@ For Fleet Provisioning, use the `v4_beta_deprecated` version of the AWS IoT Devi
 The AWS IoT Device SDK for Embedded C is generally targeted at resource constrained devices that require an optimized C language runtime\. You can use the SDK on any operating system and host it on any processor type \(for example, MCUs and MPUs\)\. However, if your devices have sufficient memory and processing resources, we recommend that you use one of the higher order [AWS IoT Device SDKs](https://docs.aws.amazon.com/iot/latest/developerguide/iot-sdks.html#iot-device-sdks)\.
 
 For more information, see the following:
++ [AWS IoT Device SDK for Embedded C](https://docs.aws.amazon.com/embedded-csdk/latest/lib-ref/)
 + [AWS IoT Device SDK for Embedded C on GitHub](https://github.com/aws/aws-iot-device-sdk-embedded-C)
 + [AWS IoT Device SDK for Embedded C Readme](https://github.com/aws/aws-iot-device-sdk-embedded-C#aws-iot-device-sdk-for-embedded-c)
 + [ AWS IoT Device SDK for Embedded C Samples](https://docs.aws.amazon.com/embedded-csdk/202012.00/lib-ref/docs/doxygen/output/html/demos_main.html)

doc_source/userguide/cellular-interface.md

@@ -0,0 +1,83 @@
+# Cellular Interface library<a name="cellular-interface"></a>
+
+## 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\. 
++ [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\.
+
+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\.
+
+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
++ MISRA C:2012 coding standard\. Any deviations from the standard are documented in source code comments marked by "coverity"\.
+
+## Dependencies and requirements<a name="freertos-cellular-interface-dependencies"></a>
+
+There is no direct dependency for the Cellular Interface library\. However, Ethernet, Wi\-Fi and cellular cannot co\-exist in the FreeRTOS network stack\. Developers must choose one of the network interface to integrate with the [Secure Sockets library](https://docs.aws.amazon.com/freertos/latest/userguide/secure-sockets.html)\. 
+
+## Porting<a name="freertos-cellular-interface-porting"></a>
+
+For information about porting the Cellular Interface library to your platform, see [ Porting the Cellular Interface library](https://docs.aws.amazon.com/freertos/latest/portingguide/freertos-porting-cellular.html) in the *FreeRTOS Porting Guide*\. 
+
+## Memory use<a name="freertos-cellular-interface-memory-use"></a>
+
+
+****  
+
+| Code Size of cellular interface library \(example generated with GCC for ARM Cortex\-M\) | File | With \-O1 Optimization | With \-Os Optimization | 
+| --- | --- | --- | --- | 
+| cellular\_3gpp\_api\.c | 6\.3K | 5\.7K | 
+| cellular\_3gpp\_urc\_handler\.c | 0\.9K | 0\.8K | 
+| cellular\_at\_core\.c | 1\.4K | 1\.2K | 
+| cellular\_common\_api\.c | 0\.5K | 0\.5K | 
+| cellular\_common\.c | 1\.6K | 1\.4K | 
+| cellular\_pkthandler\.c | 1\.4K | 1\.2K | 
+| cellular\_pktio\.c | 1\.8K | 1\.6K | 
+| Total estimates | 13\.9K | 12\.4K | 
+
+## Getting started<a name="freertos-cellular-interface-getting-started"></a>
+
+### Download the source code<a name="freertos-cellular-interface-download-source"></a>
+
+The source code can be downloaded as part of the FreeRTOS libraries or by itself\.
+
+To clone the library from Github using HTTPS: 
+
+```
+git clone https://github.com/FreeRTOS/FreeRTOS-Cellular-Interface.git 
+```
+
+Using SSH:
+
+```
+git clone git@github.com:FreeRTOS/FreeRTOS-Cellular-Interface.git 
+```
+
+### Folder structure<a name="freertos-cellular-interface-folder-structure"></a>
+
+At the root of this repository you will see these folders: 
++ `source` : reusable common code that implements the standard AT commands defined by 3GPP TS v27\.007
++ `modules` : vendor\-specific code that implements non\-3GPP AT commands for each cellular modem
++ `doc` : documentation
++ `test` : unit test and cbmc
++ `tools` : tools for Coverity static analysis and CMock
+
+### 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)\. 
+
+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\.
+
+## Integrate the FreeRTOS 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)
++ [  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/dev-guide-freertos-libraries.md

@@ -22,10 +22,11 @@ The following porting libraries are included in configurations of FreeRTOS that
 | FreeRTOS\+POSIX | [FreeRTOS\+POSIX API Reference](https://freertos.org/Documentation/api-ref/POSIX/index.html) |  You can use the FreeRTOS\+POSIX library to port POSIX\-compliant applications to the FreeRTOS ecosystem\. For more information, see [FreeRTOS\+POSIX](https://freertos.org/FreeRTOS-Plus/FreeRTOS_Plus_POSIX/index.html)\.  | 
 | Secure Sockets | [ Secure Sockets API Reference](https://docs.aws.amazon.com/freertos/latest/lib-ref/html2/secure_sockets/index.html) | For more information, see [Secure Sockets library](secure-sockets.md)\. | 
 | FreeRTOS\+TCP | [ FreeRTOS\+TCP API Reference](https://freertos.org/FreeRTOS-Plus/FreeRTOS_Plus_TCP/FreeRTOS_TCP_API_Functions.html) |  FreeRTOS\+TCP is a scalable, open source and thread safe TCP/IP stack for FreeRTOS\. For more information, see [FreeRTOS\+TCP](https://freertos.org/FreeRTOS-Plus/FreeRTOS_Plus_TCP/index.html)\.   | 
-| Wi\-Fi | [Wi\-Fi API Reference](https://docs.aws.amazon.com/freertos/latest/lib-ref/html2/wifi/index.html) |  The FreeRTOS Wi\-Fi library enables you to interface with your microcontroller's lower\-level wireless stack\. For more information, see [Wi\-Fi library](freertos-wifi.md)\. | 
-| corePKCS11 |  |  The corePKCS11 library is a reference implementation of the Public Key Cryptography Standard \#11, to support provisioning and TLS client authentication\. For more information, see [corePKCS11 library](security-pkcs.md)\.  | 
+| Wi\-Fi | [Wi\-Fi API Reference](https://docs.aws.amazon.com/freertos/latest/lib-ref/html2/wifi/index.html) |  The FreeRTOS Wi\-Fi library enables you to interface with your microcontroller's lower\-level wireless stack\. For more information, see the [Wi\-Fi library](freertos-wifi.md)\.  | 
+| corePKCS11 |  |  The corePKCS11 library is a reference implementation of the Public Key Cryptography Standard \#11, to support provisioning and TLS client authentication\. For more information, see the [corePKCS11 library](security-pkcs.md)\.  | 
 | TLS |  |  For more information, see [Transport Layer Security](security-tls.md)\.  | 
 | Common I/O | Common I/O API Reference |  For more information, see [Common I/O](common-io.md)\.  | 
+| Cellular Interface | Cellular Interface API Reference |  The FreeRTOS Cellular Interface library exposes the capabilities of a few popular cellular modems through a uniform API\. For more information, see the [Cellular Interface library](cellular-interface.md)\.  | 
 
 ## FreeRTOS application libraries<a name="dev-guide-freertos-application-libraries"></a>