Skip to content

Commit f3d148d

Browse files
committed
periodic update 07/27/2021 11:28 PDT
1 parent b8ffc33 commit f3d148d

File tree

123 files changed

+3685
-2667
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

123 files changed

+3685
-2667
lines changed

doc_source/portingguide/afr-porting-kernel.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ FreeRTOS uses the FreeRTOS kernel for multitasking and inter\-task communication
66

77
**Note**
88
Porting the FreeRTOS kernel to a new architecture is out of the scope of this documentation\. If you are interested in porting the FreeRTOS kernel to a new architecture, [contact the FreeRTOS engineering team](https://freertos.org/RTOS-contact-and-support.html)\.
9-
For the FreeRTOS Qualification program, only existing ports are supported\. Modifications to these ports are not accepted within the Qualification program\. Only the official ports that can be downloaded from [Github](https://github.com/aws/amazon-freertos) or [Sourceforge](https://sourceforge.net/projects/freertos/) are accepted\.
9+
For the FreeRTOS Qualification program, only existing ports are supported\. Modifications to these ports are not accepted within the Qualification program\. Only the official ports that can be downloaded from [Github](https://github.com/aws/amazon-freertos) are accepted\.
1010

1111
## Prerequisites<a name="porting-prereqs-kernel"></a>
1212

doc_source/portingguide/afr-porting-mqtt.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@ After you set up the library in the IDE project, you need to configure other fil
4444

4545
To officially qualify a device for FreeRTOS, you need to validate the device's ported source code with AWS IoT Device Tester\. Follow the instructions in [ 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 to set up Device Tester for port validation\. To test a specific library's port, the correct test group must be enabled in the `device.json` file in the Device Tester `configs` folder\.
4646

47-
After you set up the coreMQTT library for your device, you can start porting the OTA agent library\. See [Porting the OTA library](afr-porting-ota.md) for instructions\.
47+
After you set up the coreMQTT library for your device, you can start porting the OTA agent library\. See [Porting the AWS IoT over\-the\-air update library](afr-porting-ota.md) for instructions\.
4848

4949
If your device doesn't support OTA functionality, you can start porting the Bluetooth Low Energy library\. See [Porting the Bluetooth Low Energy library](afr-porting-ble.md) for instructions\.
5050

51-
If your device doesn't support OTA and Bluetooth Low Energy functionality, then you are finished porting and can start the FreeRTOS qualification process\. See the [FreeRTOS Qualification Guide](https://docs.aws.amazon.com/freertos/latest/qualificationguide/) for more information\.
51+
If your device doesn't support OTA and Bluetooth Low Energy functionality, then you are finished porting and can start the FreeRTOS qualification process\. See the [ FreeRTOS Qualification Guide](https://docs.aws.amazon.com/freertos/latest/qualificationguide/) for more information\.

doc_source/portingguide/afr-porting-ota.md

+105-62
Large diffs are not rendered by default.

doc_source/portingguide/afr-porting.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ If your device does not support Wi\-Fi, you can use an ethernet connection to co
2424

2525
1. [Configuring the coreHTTP library for testing](afr-porting-corehttp.md)
2626

27-
1. [Porting the OTA library](afr-porting-ota.md)
27+
1. [Porting the AWS IoT over\-the\-air update library](afr-porting-ota.md)
2828
**Note**
2929
Currently, a port of the FreeRTOS OTA update library is not required for qualification\.
3030

doc_source/portingguide/index.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,11 @@ Amazon's trademarks and trade dress may not be used in
4242
+ [ca.config](porting-ca-config.md)
4343
+ [Configuring the coreMQTT library for testing](afr-porting-mqtt.md)
4444
+ [Configuring the coreHTTP library for testing](afr-porting-corehttp.md)
45-
+ [Porting the OTA library](afr-porting-ota.md)
45+
+ [Porting the AWS IoT over-the-air update library](afr-porting-ota.md)
4646
+ [Porting the Bluetooth Low Energy library](afr-porting-ble.md)
4747
+ [Perform Over the Air Updates using Bluetooth Low Energy](ota-updates-ble.md)
4848
+ [Porting the common I/O libraries](freertos-porting-commonio.md)
4949
+ [Porting the Cellular library](freertos-porting-cellular.md)
50-
+ [Migrating from Version 1.4.x to Version 201906.00 (and newer)](porting-migration.md)
50+
+ [Migrating from Version 1.4.x to Version 201906.00 (and newer)](porting-migration.md)
51+
+ [Migrating from version 1 to version 3 for OTA applications](porting-migration-ota.md)
52+
+ [Migrating from version 1 to version 3 for OTA Pal port](porting-migration-ota-pal.md)

doc_source/portingguide/ota-updates-ble.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ You can use the FreeRTOS Bluetooth Low Energy \(BLE\) and Over the Air Updates \
77
## Prerequisites<a name="ota-updates-ble-prereqs"></a>
88

99
1. Port the Over The Air Updates agent to each microcontroller device:
10-
+ Follow the steps in [Porting](afr-porting-ota.md#porting-steps-ota) and [IoT device bootloader](afr-porting-ota.md#afr-bootloader)\.
10+
+ Follow the steps in [Platform porting](afr-porting-ota.md#porting-steps-ota) and [IoT device bootloader](afr-porting-ota.md#afr-bootloader)\.
1111
+ After porting, follow the steps in [Testing](afr-porting-ota.md#porting-testing-ota) to verify that the OTA PAL tests pass\.
1212

1313
1. Port the Bluetooth Low Energy library to each microcontroller:
@@ -273,8 +273,8 @@ Certificates don't have to be added when you use Amazon Cognito credentials\.
273273
1. Open `vendors/vendor/boards/board/aws_demos/common/config_files/aws_iot_network_config.h`\.
274274
+ Change `configSUPPORTED_NETWORKS` and `configENABLED_NETWORKS` to only include `AWSIOT_NETWORK_TYPE_BLE`\.
275275

276-
1. Open `demos/include/aws_ota_codesigner_certificate.h`:
277-
+ Change `signingcredentialSIGNING_CERTIFICATE_PEM` to refer to the certificate to be used to sign the firmware binary file\.
276+
1. Open `ota_demo_config.h`:
277+
+ Change `otapalconfigCODE_SIGNING_CERTIFICATE` to refer to the certificate to be used to sign the firmware binary file\.
278278

279279
The application should start up and print the demo version:
280280

doc_source/portingguide/porting-download.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Downloading FreeRTOS for Porting<a name="porting-download"></a>
22

3-
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/master/README.md) file for instructions\.
3+
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\.
44

55
**Note**
66
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\.

doc_source/portingguide/porting-guide.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The FreeRTOS kernel and components are released individually and use semantic ve
1515
+ M represents the month\.
1616
+ N represents the release order within the designated month \(00 being the first release\)\.
1717

18-
For example, a second release in June 2021 would be 202106\.01\.
18+
For example, a second release in July 2021 would be 202107\.01\.
1919

2020
Previously, FreeRTOS releases used semantic versioning for major releases\. Although it has moved to date\-based versioning \(FreeRTOS 1\.4\.8 updated to FreeRTOS AWS Reference Integrations 201906\.00\), the FreeRTOS kernel and each individual FreeRTOS library still retain semantic versioning\. In semantic versioning, the version number itself \(X\.Y\.Z\) indicates whether the release is a major, minor, or point release\. You can use the semantic version of a library to assess the scope and impact of a new release on your application\.
2121

@@ -39,7 +39,7 @@ The device that you port to FreeRTOS must be a microcontroller board that meets
3939
+ 25MHz processing speed
4040
+ 64KB RAM
4141
+ 128KB program memory per executable image stored on the MCU
42-
+ \(If [Porting the OTA library](afr-porting-ota.md)\) Two executable images stored on the MCU
42+
+ \(If [Porting the AWS IoT over\-the\-air update library](afr-porting-ota.md)\) Two executable images stored on the MCU
4343

4444
### Porting older versions of FreeRTOS<a name="porting-older"></a>
4545

@@ -50,6 +50,7 @@ If you are porting an older version of FreeRTOS, go to the [FreeRTOS AWS Referen
5050

5151
| Date | Documentation version for the Porting and Qualification guides | Change history | FreeRTOS version |
5252
| --- | --- | --- | --- |
53+
| July, 2021 | [ 202107\.00](https://github.com/aws/amazon-freertos/blob/202107.00/doc/freertos_port_qual/FreeRTOS_Porting_Guide.pdf) \(Porting Guide\) [ 202107\.00](https://github.com/aws/amazon-freertos/blob/202107.00/doc/freertos_port_qual/FreeRTOS_Qualification_Guide.pdf) \(Qualification Guide\) | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/freertos/latest/portingguide/porting-guide.html) | [202107\.00](https://github.com/aws/amazon-freertos/tree/202107.00) |
5354
| December, 2020 | [ 202012\.00](https://github.com/aws/amazon-freertos/blob/202012.00/doc/freertos_port_qual/FreeRTOS_Porting_Guide.pdf) \(Porting Guide\) [ 202012\.00](https://github.com/aws/amazon-freertos/blob/202012.00/doc/freertos_port_qual/FreeRTOS_Qualification_Guide.pdf) \(Qualification Guide\) | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/freertos/latest/portingguide/porting-guide.html) | [202012\.00](https://github.com/aws/amazon-freertos/tree/202012.00) |
5455
| November, 2020 | [ 202011\.00](https://github.com/aws/amazon-freertos/blob/202011.00/doc/freertos_port_qual/FreeRTOS_Porting_Guide.pdf) \(Porting Guide\) [ 202011\.00](https://github.com/aws/amazon-freertos/blob/202011.00/doc/freertos_port_qual/FreeRTOS_Qualification_Guide.pdf) \(Qualification Guide\) | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/freertos/latest/portingguide/porting-guide.html) | [202011\.00](https://github.com/aws/amazon-freertos/tree/202011.00) |
5556
| July, 2020 | [ 202007\.00](https://github.com/aws/amazon-freertos/blob/202007.00/doc/freertos_port_qual/FreeRTOS_Porting_Guide.pdf) \(Porting Guide\) [ 202007\.00](https://github.com/aws/amazon-freertos/blob/202007.00/doc/freertos_port_qual/FreeRTOS_Qualification_Guide.pdf) \(Qualification Guide\) | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/freertos/latest/portingguide/porting-guide.html) | [202007\.00](https://github.com/aws/amazon-freertos/tree/202007.00) |

0 commit comments

Comments
 (0)