Skip to content

Commit 8de9548

Browse files
committed
periodic update 10/19/20 13:15 PDT
1 parent 316f6e2 commit 8de9548

13 files changed

+505
-34
lines changed

doc_source/portingguide/afr-porting-ble.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -167,8 +167,10 @@ The `CMakeLists.txt` template list file under `freertos/vendors/vendor/boards/bo
167167

168168
1. Check the test results in the UART console\.
169169

170-
## Validation<a name="w3aac11c39c13"></a>
170+
## Validation<a name="ble-validation"></a>
171171

172172
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\.
173173

174-
After you have ported the Bluetooth Low Energy library, you can start the FreeRTOS qualification process\. For more information, see the [FreeRTOS Qualification Guide](https://docs.aws.amazon.com/freertos/latest/qualificationguide/)\.
174+
After you have ported the Bluetooth Low Energy library, you can start the FreeRTOS qualification process\. For more information, see the [FreeRTOS Qualification Guide](https://docs.aws.amazon.com/freertos/latest/qualificationguide/)\.
175+
176+
If the device supports Over the Air Updates, then you should also validate Over the Air Updates over Bluetooth Low Energy using a companion device\. For more details, see the next topic, [Perform Over the Air Updates using Bluetooth Low Energy](ota-updates-ble.md)\.

doc_source/portingguide/afr-porting-pkcs.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,13 +43,13 @@ To port the PKCS \#11 library, you need the following:
4343
+ A code\-verification public key \(or a certificate that contains the code\-verification public key\) for secure bootloader and over\-the\-air \(OTA\) updates\.
4444
+ A Just\-In\-Time provisioning certificate\.
4545

46-
`freertos/vendors/vendor/boards/board/ports/pkcs11/iot_pkcs11_pal.c` contains empty definitions for the PAL functions\. You must provide ports for, at minimum, the functions listed in this table:
46+
`freertos/vendors/vendor/boards/board/ports/pkcs11/core_pkcs11_pal.c` contains empty definitions for the PAL functions\. You must provide ports for, at minimum, the functions listed in this table:
4747
[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/freertos/latest/portingguide/afr-porting-pkcs.html)
4848

4949
1. Add support for a cryptographically random entropy source to your port:
5050
+ If your ports use the mbedTLS library for underlying cryptographic and TLS support, and your device has a true random number generator \(TRNG\):
5151

52-
1. Implement the [ `mbedtls_hardware_poll()`](https://github.com/ARMmbed/mbedtls/blob/master/include/mbedtls/entropy_poll.h#L92) 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/iot_pkcs11_pal.c`\.
52+
1. Implement the [ `mbedtls_hardware_poll()`](https://github.com/ARMmbed/mbedtls/blob/master/include/mbedtls/entropy_poll.h#L92) 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`\.
5353
+ If your ports use the mbedTLS library for underlying cryptographic and TLS support, but your device does not have a TRNG:
5454

5555
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`\.
@@ -81,7 +81,7 @@ In the following steps, make sure that you add the source files to your IDE proj
8181

8282
**To set up the PKCS \#11 library in the IDE project**
8383

84-
1. Add the source file `freertos/vendors/vendor/boards/board/ports/pkcs11/iot_pkcs11_pal.c` to the `aws_tests` IDE project\.
84+
1. Add the source file `freertos/vendors/vendor/boards/board/ports/pkcs11/core_pkcs11_pal.c` to the `aws_tests` IDE project\.
8585

8686
1. Add all of the files in the `freertos/libraries/abstractions/pkcs11` directory and its subdirectories to the `aws_tests` IDE project\.
8787

@@ -109,7 +109,7 @@ afr_mcu_port(pkcs11_implementation DEPENDS AFR::pkcs11_mbedtls)
109109
target_sources(
110110
AFR::pkcs11_implementation::mcu_port
111111
INTERFACE
112-
"${afr_ports_dir}/pkcs11/iot_pkcs11_pal.c"
112+
"${afr_ports_dir}/pkcs11/core_pkcs11_pal.c"
113113
)
114114
```
115115

doc_source/portingguide/afr-porting.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,10 @@ Currently, a port of the FreeRTOS OTA update library is not required for qualifi
3434
**Note**
3535
Currently, a port of the FreeRTOS Bluetooth Low Energy library is not required for qualification\.
3636

37+
1. [Perform Over the Air Updates using Bluetooth Low Energy](ota-updates-ble.md)
38+
**Note**
39+
Currently AWS IoT Device Tester does not support qualification of Over the Air updates using Bluetooth Low Energy library\. A partner interested in this qualification should contact AWS through the APN \(AWS Partner Network\) team\.
40+
3741
1. [Porting the common I/O libraries](freertos-porting-commonio.md)
3842
**Note**
3943
Currently, a port of the FreeRTOS common I/O library is not required for qualification\.

doc_source/portingguide/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,5 +44,6 @@ Amazon's trademarks and trade dress may not be used in
4444
+ [Configuring the HTTPS client library for testing](afr-porting-https.md)
4545
+ [Porting the OTA library](afr-porting-ota.md)
4646
+ [Porting the Bluetooth Low Energy library](afr-porting-ble.md)
47+
+ [Perform Over the Air Updates using Bluetooth Low Energy](ota-updates-ble.md)
4748
+ [Porting the common I/O libraries](freertos-porting-commonio.md)
4849
+ [Migrating from Version 1.4.x to Version 201906.00 (and newer)](porting-migration.md)

0 commit comments

Comments
 (0)