espressif/FreeRTOS
1
0
Fork 0
mirror of https://github.com/FreeRTOS/FreeRTOS.git synced 2025-06-19 06:39:21 +08:00
Code Issues Packages Projects Releases Wiki Activity

Multiple tidy up and corrections preparing for release (#390)

Browse Source 
* Update to the WolfSSL FIPS ready demo:  Add a debug break point into the configASSERT() implementation along with a comment telling users how to update the integrity check hash if they hit the breakpoint.

* Updates in the root directory:  Remove "New - Stream and Message Buffers.url" as the feature is no longer new, and edit the readme.md file as the repo now contains 'core' libraries in addition to 'FreeRTOS+' libraries.

* FreeRTOS-Plus/Source/Utilities:  Add readme files and links to documentation.

* Application-Protocols:  Add readme and URL links.

* Remove Index.html from the end of a URL in the readme.txt file.

* Demo-IP-Protocols:  Add readme.txt files and code comments saying the protocols are not intended for production use.

* coreMQTT:  Remove links to deprecated documentation, add readme and correct links to documentation.

* General:  Correct URLs in source files and .url files.

* Update readme.txt
This commit is contained in:
RichardBarry
2020-11-09 14:50:33 -08:00
committed by GitHub
parent df082944e0
commit 5d3b3cb1c7
25 changed files with 119 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
FreeRTOS-Plus/Demo/AWS/Device_Shadow_Windows_Simulator/Common/main.c
View File

@ -26,7 +26,7 @@
*/
/***
* See https://www.FreeRTOS.org/mqtt_lts/index.html for configuration and usage instructions.
* See https://www.FreeRTOS.org/coremqtt for configuration and usage instructions.
***/
/* Standard includes. */
@ -107,7 +107,7 @@ static UBaseType_t ulNextRand;
int main( void )
{
/***
* See https://www.FreeRTOS.org/mqtt_lts/index.html for configuration and usage instructions.
* See https://www.FreeRTOS.org/coremqtt for configuration and usage instructions.
***/
/* Miscellaneous initialization including preparing the logging and seeding

2
FreeRTOS-Plus/Demo/AWS/Device_Shadow_Windows_Simulator/Device_Shadow_Demo/READ_ME_INSTRUCTIONS.url
View File

@ -2,4 +2,4 @@
Prop3=19,11
[InternetShortcut]
IDList=
URL=https://www.freertos.org/mqtt_lts/
URL=https://www.freertos.org/shadow/index.html

5
FreeRTOS-Plus/Demo/Common/Demo_IP_Protocols/FTP/FreeRTOS_FTP_server.c
View File

@ -1,4 +1,9 @@
/*
*!
*! The protocols implemented in this file are intended to be demo quality only,
*! and not for production devices.
*!
*
* FreeRTOS+TCP V2.0.3
* Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*

2
FreeRTOS-Plus/Demo/Common/Demo_IP_Protocols/FTP/readme.txt Normal file
View File

@ -0,0 +1,2 @@
The protocols implemented in this directory are intended to be demo quality
examples only. They are not intended for inclusion in production devices.

5
FreeRTOS-Plus/Demo/Common/Demo_IP_Protocols/HTTP/FreeRTOS_HTTP_commands.c
View File

@ -1,4 +1,9 @@
/*
*!
*! The protocols implemented in this file are intended to be demo quality only,
*! and not for production devices.
*!
*
* FreeRTOS+TCP V2.0.3
* Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*

5
FreeRTOS-Plus/Demo/Common/Demo_IP_Protocols/HTTP/FreeRTOS_HTTP_server.c
View File

@ -1,4 +1,9 @@
/*
*!
*! The protocols implemented in this file are intended to be demo quality only,
*! and not for production devices.
*!
*
* FreeRTOS+TCP V2.0.3
* Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*

2
FreeRTOS-Plus/Demo/Common/Demo_IP_Protocols/HTTP/readme.txt Normal file
View File

@ -0,0 +1,2 @@
The protocols implemented in this directory are intended to be demo quality
examples only. They are not intended for inclusion in production devices.

5
FreeRTOS-Plus/Demo/Common/Demo_IP_Protocols/NTP/NTPDemo.c
View File

@ -1,4 +1,9 @@
/*
*!
*! The protocols implemented in this file are intended to be demo quality only,
*! and not for production devices.
*!
*
* FreeRTOS+TCP V2.0.3
* Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*

2
FreeRTOS-Plus/Demo/Common/Demo_IP_Protocols/NTP/readme.txt Normal file
View File

@ -0,0 +1,2 @@
The protocols implemented in this directory are intended to be demo quality
examples only. They are not intended for inclusion in production devices.

3
FreeRTOS-Plus/Demo/Common/Demo_IP_Protocols/readme.txt Normal file
View File

@ -0,0 +1,3 @@
The protocols implemented in the files and folders in this directory and its
subdirectories are intended to be demo quality examples only. They are not
intended for inclusion in production devices.

13
FreeRTOS-Plus/Demo/FreeRTOS_Plus_WolfSSL_FIPS_Ready_Windows_Simulator/main.c
View File

@ -54,6 +54,11 @@ extern void vSecureTCPServerTask( void *pvParameters );
/*-----------------------------------------------------------*/
/*
*! It is necessary to update the build hash before running this project for the
*! time. Ensure to read README_wolfSSL_FIPS_ready.md in the directory that contains
*! this Visual Studio project for instructions.
*/
int main( void )
{
const uint32_t ulLongTime_ms = 250UL;
@ -96,6 +101,14 @@ const unsigned long ulLongSleep = 1000UL;
taskDISABLE_INTERRUPTS();
for( ;; )
{
/* Cause debugger break point if being debugged.
If you see reach here and the console shows "In core integrity check error"
then you have not updated the expected build hash since building this
project. See README_wolfSSL_FIPS_ready.md in the directory that contains
this Visual Studio project for instructions. */
__debugbreak();
Sleep( ulLongSleep );
}
}

4
FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/Common/main.c
View File

@ -26,7 +26,7 @@
*/
/***
* See https://www.FreeRTOS.org/mqtt_lts/index.html for configuration and usage instructions.
* See https://www.FreeRTOS.org/coremqtt for configuration and usage instructions.
***/
/* Standard includes. */
@ -107,7 +107,7 @@ static UBaseType_t ulNextRand;
int main( void )
{
/***
* See https://www.FreeRTOS.org/mqtt_lts/index.html for configuration and usage instructions.
* See https://www.FreeRTOS.org/coremqtt for configuration and usage instructions.
***/
/* Miscellaneous initialization including preparing the logging and seeding

11
FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Multitask/readme.txt Normal file
View File

@ -0,0 +1,11 @@
The multi threaded example creates an MQTT agent (or daemon task). It is thread
safe because only the agent task is allowed to access the coreMQTT API - hence
the API is only accessed from one FreeRTOS task. Other tasks and interrupts
needing to interact with the MQTT agent do so through a thread safe queue.
We are generalising this technique for future coreMQTT releases, which will have
a re-usable agent component.
! Plain text examples are for ease of evaluation only - product devices should
! always use authenticated and encrypted communication. Never send private or
! sensitive data on an unencrypted connection.

5
FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Plain_Text/READ_ME_INSTRUCTIONS.url
View File

@ -1,5 +0,0 @@
[{000214A0-0000-0000-C000-000000000046}]
Prop3=19,11
[InternetShortcut]
IDList=
URL=https://www.freertos.org/mqtt_lts/

5
FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Serializer/READ_ME_INSTRUCTIONS.url
View File

@ -1,5 +0,0 @@
[{000214A0-0000-0000-C000-000000000046}]
Prop3=19,11
[InternetShortcut]
IDList=
URL=https://www.freertos.org/mqtt_lts/

15
FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/readme.txt Normal file
View File

@ -0,0 +1,15 @@
The subdirectories of this directory contain multiple examples that demonstrate
coreMQTT using in both single and multi-threaded scenarios, as well as with
both plain text and authenticated and encrypted network interfaces.
The multi threaded example creates an MQTT agent (or daemon task). It is thread
safe because only the agent task is allowed to access the coreMQTT API - hence
the API is only accessed from one FreeRTOS task. Other tasks and interrupts
needing to interact with the MQTT agent do so through a thread safe queue.
We are generalising this technique for future coreMQTT releases, which will have
a re-usable agent component.
! Plain text examples are for ease of evaluation only - product devices should
! always use authenticated and encrypted communication. Never send private or
! sensitive data on an unencrypted connection.

2
FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Multitask/READ_ME_INSTRUCTIONS.url → FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/readme_coreMQTT.url
View File

@ -2,4 +2,4 @@
Prop3=19,11
[InternetShortcut]
IDList=
URL=https://www.freertos.org/mqtt_lts/
URL=https://www.freertos.org/coremqtt/index.html

2
FreeRTOS-Plus/Demo/corePKCS11_MQTT_Mutual_Auth_Windows_Simulator/main.c
View File

@ -97,7 +97,7 @@ static UBaseType_t ulNextRand;
int main( void )
{
/***
* See https://www.FreeRTOS.org/mqtt_lts/index.html for configuration and usage instructions.
* See https://www.FreeRTOS.org/coremqtt for configuration and usage instructions.
***/
/* Miscellaneous initialization including preparing the logging and seeding

2
FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Basic_TLS/READ_ME_INSTRUCTIONS.url → FreeRTOS-Plus/Source/Application-Protocols/ReadMe_coreMQTT.url
View File

@ -2,4 +2,4 @@
Prop3=19,11
[InternetShortcut]
IDList=
URL=https://www.freertos.org/mqtt_lts/
URL=https://www.freertos.org/coremqtt

2
FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Mutual_Auth/READ_ME_INSTRUCTIONS.url → FreeRTOS-Plus/Source/Application-Protocols/ReadMe_network_transport.url
View File

@ -2,4 +2,4 @@
Prop3=19,11
[InternetShortcut]
IDList=
URL=https://www.freertos.org/mqtt_lts/
URL=https://www.freertos.org/transportinterface.html

15
FreeRTOS-Plus/Source/Application-Protocols/readme.txt Normal file
View File

@ -0,0 +1,15 @@
The 'core' branded application protocols are 'standalone' in that they do not
have any dependencies outside of the C library. They use a simple transport
interface definition to ensure they are not dependent on the underlying TCP/IP
stack. This directory collects together the application protocols that all use
the same transport interface definition (only coreMQTT at the time of writing,
soon to also include coreHTTP).
Directories:
+ coreMQTT contains the implementation of the coreMQTT library. See:
https://www.FreeRTOS.org/coremqtt
+ network_transport contains the transport interface definition. See the
comment above and https://www.freertos.org/transportinterface.html

2
FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Keep_Alive/READ_ME_INSTRUCTIONS.url → FreeRTOS-Plus/Source/Utilities/logging/ReadMe_Logging.url
View File

@ -2,4 +2,4 @@
Prop3=19,11
[InternetShortcut]
IDList=
URL=https://www.freertos.org/mqtt_lts/
URL=https://www.freertos.org/logging.html

14
FreeRTOS-Plus/Source/Utilities/readme.txt Normal file
View File

@ -0,0 +1,14 @@
Directories:
+ Utilities/exponential_backoff contains a utility that calculates an
exponential back off time, with some jitter. It is used to ensure fleets of
IoT devices that become disconnected don't all try and reconnect at the same
time.
+ Utilities/logging contains header files for use with the core libraries logging
macros. See https://www.FreeRTOS.org/logging.html.
+ Utililties/mbedtls_freertos contains a few FreeRTOS specifics required by
mbedTLS.