mirror of
https://github.com/FreeRTOS/FreeRTOS-Kernel.git
synced 2025-08-11 13:54:16 -04:00
Add first draft of mqtt example
Note that it is still work in progress and not working as of now.
This commit is contained in:
parent
238a23e4d5
commit
a7ef9c3b61
13 changed files with 2990 additions and 627 deletions
|
@ -0,0 +1,447 @@
|
|||
/*
|
||||
* FreeRTOS Kernel V10.2.1
|
||||
* Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||
* this software and associated documentation files (the "Software"), to deal in
|
||||
* the Software without restriction, including without limitation the rights to
|
||||
* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
||||
* the Software, and to permit persons to whom the Software is furnished to do so,
|
||||
* subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in all
|
||||
* copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
||||
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
||||
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
||||
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
||||
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
*
|
||||
* http://www.FreeRTOS.org
|
||||
* http://aws.amazon.com/freertos
|
||||
*
|
||||
* 1 tab == 4 spaces!
|
||||
*/
|
||||
|
||||
/* Standard inclues. */
|
||||
#include <string.h>
|
||||
|
||||
/* Kernel includes. */
|
||||
#include "FreeRTOS.h"
|
||||
#include "task.h"
|
||||
|
||||
/* MQTT include. */
|
||||
#include "iot_mqtt.h"
|
||||
|
||||
/* Platform FreeRTOS network include. */
|
||||
#include "platform/iot_network_freertos.h"
|
||||
|
||||
/**
|
||||
* @brief The keep-alive interval used for this example.
|
||||
*
|
||||
* An MQTT ping request will be sent periodically at this interval.
|
||||
*/
|
||||
#define mqttexampleKEEP_ALIVE_SECONDS ( 60 )
|
||||
|
||||
/**
|
||||
* @brief The timeout for MQTT operations in this example.
|
||||
*/
|
||||
#define mqttexampleMQTT_TIMEOUT_MS ( 5000 )
|
||||
|
||||
/**
|
||||
* @brief The MQTT client identifier used in this example.
|
||||
*/
|
||||
#define mqttexampleCLIENT_IDENTIFIER "mqttexampleclient"
|
||||
|
||||
/**
|
||||
* @brief Details of the MQTT broker to connect to.
|
||||
*
|
||||
* @note This example does not use TLS and therefore won't work with AWS IoT.
|
||||
*/
|
||||
#define mqttexampleMQTT_BROKER_ENDPOINT "10.60.214.105"
|
||||
#define mqttexampleMQTT_BROKER_PORT 1883
|
||||
|
||||
/**
|
||||
* @brief The topic to subscribe and publish to in the example.
|
||||
*/
|
||||
#define mqttexampleTOPIC "example/topic"
|
||||
|
||||
/**
|
||||
* @brief The MQTT message published in this example.
|
||||
*/
|
||||
#define mqttexampleMESSAGE "Hello World!"
|
||||
|
||||
/**
|
||||
* @brief Paramters to control the retry behaviour in case a QoS1 publish
|
||||
* message gets lost.
|
||||
*
|
||||
* Retry every minutes up to a maximum of 5 retries.
|
||||
*/
|
||||
#define mqttexamplePUBLISH_RETRY_MS ( 1000 )
|
||||
#define mqttexamplePUBLISH_RETRY_LIMIT ( 5 )
|
||||
|
||||
/**
|
||||
* @brief The bit which is set in the demo task's notification value from the
|
||||
* disconnect callback to inform the demo task about the MQTT disconnect.
|
||||
*/
|
||||
#define mqttexampleDISCONNECTED_BIT ( 1UL << 0UL )
|
||||
|
||||
/**
|
||||
* @brief The bit which is set in the demo task's notification value from the
|
||||
* publish callback to inform the demo task about the message received from the
|
||||
* MQTT broker.
|
||||
*/
|
||||
#define mqttexampleMESSAGE_RECEIVED_BIT ( 1UL << 1UL )
|
||||
/*-----------------------------------------------------------*/
|
||||
|
||||
/**
|
||||
* @brief The MQTT connection handle used in this example.
|
||||
*/
|
||||
static IotMqttConnection_t xMQTTConnection = IOT_MQTT_CONNECTION_INITIALIZER;
|
||||
/*-----------------------------------------------------------*/
|
||||
|
||||
/**
|
||||
* @brief The task used to demonstrate the MQTT API.
|
||||
*
|
||||
* @param[in] pvParameters Parmaters as passed at the time of task creation. Not
|
||||
* used in this example.
|
||||
*/
|
||||
static void prvMQTTDemoTask( void *pvParameters );
|
||||
|
||||
/**
|
||||
* @brief The callback invoked by the MQTT library when the MQTT connection gets
|
||||
* disconnected.
|
||||
*
|
||||
* @param[in] pvCallbackContext Callback context as provided at the time of
|
||||
* connect.
|
||||
* @param[in] pxCallbackParams Contains the reason why the MQTT connection was
|
||||
* disconnected.
|
||||
*/
|
||||
static void prvExample_DisconnectCallback( void * pvCallbackContext,
|
||||
IotMqttCallbackParam_t * pxCallbackParams );
|
||||
|
||||
/**
|
||||
* @brief The callback invoked by the MQTT library when a message is received on
|
||||
* a subscribed topic from the MQTT broker.
|
||||
*
|
||||
* @param[in] pvCallbackContext Callback context as provided at the time of
|
||||
* subscribe.
|
||||
* @param[in] pxCallbackParams Contain the details about the received message -
|
||||
* topic on which the message was received, the received message.
|
||||
*/
|
||||
static void prvExample_PublishCallback( void * pvCallbackContext,
|
||||
IotMqttCallbackParam_t * pxCallbackParams );
|
||||
|
||||
/**
|
||||
* @brief Connects to the MQTT broker as specified in mqttexampleMQTT_BROKER_ENDPOINT
|
||||
* and mqttexampleMQTT_BROKER_PORT.
|
||||
*
|
||||
* @note This example does not use TLS and therefore will not work with MQTT.
|
||||
*/
|
||||
static void prvMQTTConnect( void );
|
||||
|
||||
/**
|
||||
* @brief Subscribes to the topic as specified in mqttexampleTOPIC.
|
||||
*/
|
||||
static void prvMQTTSubscribe( void );
|
||||
|
||||
/**
|
||||
* @brief Publishes a messages mqttexampleMESSAGE on mqttexampleTOPIC topic.
|
||||
*/
|
||||
static void prvMQTTPublish( void );
|
||||
|
||||
/**
|
||||
* @brief Unsubscribes from the mqttexampleTOPIC topic.
|
||||
*/
|
||||
static void prvMQTTUnsubscribe( void );
|
||||
|
||||
/**
|
||||
* @brief Disconnects from the MQTT broker gracefully by sending an MQTT
|
||||
* DISCONNECT message.
|
||||
*/
|
||||
static void prvMQTTDisconnect( void );
|
||||
/*-----------------------------------------------------------*/
|
||||
|
||||
static void prvExample_DisconnectCallback( void * pvCallbackContext,
|
||||
IotMqttCallbackParam_t * pxCallbackParams )
|
||||
{
|
||||
TaskHandle_t xDemoTaskHandle = ( TaskHandle_t ) pvCallbackContext;
|
||||
|
||||
/* Ensure that we initiated the disconnect. */
|
||||
configASSERT( pxCallbackParams->u.disconnectReason == IOT_MQTT_DISCONNECT_CALLED );
|
||||
|
||||
/* Inform the demo task about the disconnect. */
|
||||
xTaskNotify( xDemoTaskHandle,
|
||||
mqttexampleDISCONNECTED_BIT,
|
||||
eSetBits /* Set the mqttexampleDISCONNECTED_BIT in the demo task's notification value. */
|
||||
);
|
||||
}
|
||||
/*-----------------------------------------------------------*/
|
||||
|
||||
static void prvExample_PublishCallback( void * pvCallbackContext,
|
||||
IotMqttCallbackParam_t * pxCallbackParams )
|
||||
{
|
||||
TaskHandle_t xDemoTaskHandle = ( TaskHandle_t ) pvCallbackContext;
|
||||
|
||||
/* Ensure that the message is received on the expected topic. */
|
||||
configASSERT( pxCallbackParams->u.message.info.topicNameLength == strlen( mqttexampleTOPIC ) );
|
||||
configASSERT( strncmp( pxCallbackParams->u.message.info.pTopicName,
|
||||
mqttexampleTOPIC,
|
||||
strlen( mqttexampleTOPIC ) ) == 0 );
|
||||
|
||||
/* Ensure that the expected message is received. */
|
||||
configASSERT( pxCallbackParams->u.message.info.payloadLength == strlen( mqttexampleMESSAGE ) );
|
||||
configASSERT( strncmp( pxCallbackParams->u.message.info.pPayload,
|
||||
mqttexampleMESSAGE,
|
||||
strlen( mqttexampleMESSAGE ) ) == 0 );
|
||||
|
||||
/* Ensure that the message QoS is as expected. */
|
||||
configASSERT( pxCallbackParams->u.message.info.qos == IOT_MQTT_QOS_1 );
|
||||
|
||||
/* Inform the demo task about the message received from the MQTT broker. */
|
||||
xTaskNotify( xDemoTaskHandle,
|
||||
mqttexampleMESSAGE_RECEIVED_BIT,
|
||||
eSetBits /* Set the mqttexampleMESSAGE_RECEIVED_BIT in the demo task's notification value. */
|
||||
);
|
||||
}
|
||||
/*-----------------------------------------------------------*/
|
||||
|
||||
void vStartSimpleMQTTDemo( void )
|
||||
{
|
||||
/* This example uses a single application task, which in turn is used to
|
||||
* connect, subscribe, publish, unsubscribe and disconnect from the MQTT
|
||||
* broker. */
|
||||
xTaskCreate( prvMQTTDemoTask, /* Function that implements the task. */
|
||||
"MQTTDemo", /* Text name for the task - only used for debugging. */
|
||||
configMINIMAL_STACK_SIZE, /* Size of stack (in words, not bytes) to allocate for the task. */
|
||||
NULL, /* Task parameter - not used in this case. */
|
||||
tskIDLE_PRIORITY, /* Task priority, must be between 0 and configMAX_PRIORITIES - 1. */
|
||||
NULL ); /* Used to pass out a handle to the created task - not used in this case. */
|
||||
}
|
||||
/*-----------------------------------------------------------*/
|
||||
|
||||
static void prvMQTTDemoTask( void *pvParameters )
|
||||
{
|
||||
IotMqttError_t xResult;
|
||||
uint32_t ulNotificationValue = 0;
|
||||
const TickType_t xNoDelay = ( TickType_t ) 0;
|
||||
|
||||
/* Remove compiler warnings about unused parameters. */
|
||||
( void ) pvParameters;
|
||||
|
||||
/* MQTT library must be initialized before it can be used. This is just one
|
||||
* time initialization. */
|
||||
xResult = IotMqtt_Init();
|
||||
configASSERT( xResult == IOT_MQTT_SUCCESS );
|
||||
|
||||
for( ; ; )
|
||||
{
|
||||
/* Don't expect any notifications to be pending yet. */
|
||||
configASSERT( ulTaskNotifyTake( pdTRUE, xNoDelay ) == 0 );
|
||||
|
||||
/* Establish a connection to the MQTT broker. This example connects to
|
||||
* the MQTT broker as specified in mqttexampleMQTT_BROKER_ENDPOINT and
|
||||
* mqttexampleMQTT_BROKER_PORT at the top of this file. Please change
|
||||
* it to the MQTT broker you want to connect to. Note that this example
|
||||
* does not use TLS and therefore will not work with AWS IoT. */
|
||||
prvMQTTConnect();
|
||||
|
||||
/* Subscribe to the topic as specified in mqttexampleTOPIC at the top
|
||||
* of this file. */
|
||||
prvMQTTSubscribe();
|
||||
|
||||
/* Publish a message on the mqttexampleTOPIC topic as specified at the
|
||||
* top of this file. */
|
||||
prvMQTTPublish();
|
||||
|
||||
/* Since we are subscribed on the same topic, we will get the same
|
||||
* message back from the MQTT broker. Wait for the message to be
|
||||
* received which is informed to us by the publish callback
|
||||
* (prvExample_PublishCallback) by setting the mqttexampleMESSAGE_RECEIVED_BIT
|
||||
* in this task's notification value. */
|
||||
xTaskNotifyWait( 0UL, /* Don't clear any bits on entry. */
|
||||
0UL, /* Don't clear any bits on exit. */
|
||||
&( ulNotificationValue ), /* Obtain the notification value. */
|
||||
pdMS_TO_TICKS( mqttexampleMQTT_TIMEOUT_MS ) );
|
||||
configASSERT( ( ulNotificationValue & mqttexampleMESSAGE_RECEIVED_BIT ) == mqttexampleMESSAGE_RECEIVED_BIT );
|
||||
|
||||
/* Unsubscribe from the topic mqttexampleTOPIC. */
|
||||
prvMQTTUnsubscribe();
|
||||
|
||||
/* Gracefully disconnect from the MQTT broker by sending an MQTT
|
||||
* DISCONNECT message. */
|
||||
prvMQTTDisconnect();
|
||||
|
||||
/* Wait for the disconnect operation to complete which is informed to us
|
||||
* by the disconnect callback (prvExample_DisconnectCallback)by setting
|
||||
* the mqttexampleDISCONNECTED_BIT in this task's notification value.
|
||||
* Note that all bits are cleared in the task's notification value to
|
||||
* ensure that it is ready for the next run. */
|
||||
xTaskNotifyWait( 0UL, /* Don't clear any bits on entry. */
|
||||
portMAX_DELAY, /* Clear all bits on exit - portMAX_DELAY is used as it is a portable way of having all bits set. */
|
||||
&( ulNotificationValue ), /* Obtain the notification value. */
|
||||
pdMS_TO_TICKS( mqttexampleMQTT_TIMEOUT_MS ) );
|
||||
configASSERT( ( ulNotificationValue & mqttexampleDISCONNECTED_BIT ) == mqttexampleDISCONNECTED_BIT );
|
||||
}
|
||||
}
|
||||
/*-----------------------------------------------------------*/
|
||||
|
||||
static void prvMQTTConnect( void )
|
||||
{
|
||||
IotMqttError_t xResult;
|
||||
IotNetworkServerInfo_t xMQTTBrokerInfo;
|
||||
IotMqttNetworkInfo_t xNetworkInfo = IOT_MQTT_NETWORK_INFO_INITIALIZER;
|
||||
IotMqttConnectInfo_t xConnectInfo = IOT_MQTT_CONNECT_INFO_INITIALIZER;
|
||||
|
||||
/******************* Broker information setup. **********************/
|
||||
xMQTTBrokerInfo.pHostName = mqttexampleMQTT_BROKER_ENDPOINT;
|
||||
xMQTTBrokerInfo.port = mqttexampleMQTT_BROKER_PORT;
|
||||
|
||||
/******************* Network information setup. **********************/
|
||||
/* No connection to the MQTT broker has been established yet and we want to
|
||||
* establish a new connection. */
|
||||
xNetworkInfo.createNetworkConnection = true;
|
||||
xNetworkInfo.u.setup.pNetworkServerInfo = &( xMQTTBrokerInfo );
|
||||
|
||||
/* This example does not use TLS and therefore pNetworkCredentialInfo must
|
||||
* be set to NULL. */
|
||||
xNetworkInfo.u.setup.pNetworkCredentialInfo = NULL;
|
||||
|
||||
/* Use FreeRTOS+TCP network. */
|
||||
xNetworkInfo.pNetworkInterface = IOT_NETWORK_INTERFACE_AFR;
|
||||
|
||||
/* Setup the callback which is called when the MQTT connection is disconnected. */
|
||||
xNetworkInfo.disconnectCallback.pCallbackContext = ( void * ) xTaskGetCurrentTaskHandle();
|
||||
xNetworkInfo.disconnectCallback.function = prvExample_DisconnectCallback;
|
||||
|
||||
/****************** MQTT Connection information setup. ********************/
|
||||
/* This example does not use TLS and therefore won't work with AWS IoT. */
|
||||
xConnectInfo.awsIotMqttMode = false;
|
||||
|
||||
/* Start with a clean session i.e. direct the MQTT broker to discard any
|
||||
* previous session data. Also, establishing a connection with clean session
|
||||
* will ensure that the broker does not store any data when this client
|
||||
* gets disconnected. */
|
||||
xConnectInfo.cleanSession = true;
|
||||
|
||||
/* Since we are starting with a clean session, there are no previous
|
||||
* subscriptions to be restored. */
|
||||
xConnectInfo.pPreviousSubscriptions = NULL;
|
||||
xConnectInfo.previousSubscriptionCount = 0;
|
||||
|
||||
/* We do not want to publish Last Will and Testament (LWT) message if the
|
||||
* client gets disconnected. */
|
||||
xConnectInfo.pWillInfo = NULL;
|
||||
|
||||
/* Send an MQTT PING request every minute. */
|
||||
xConnectInfo.keepAliveSeconds = mqttexampleKEEP_ALIVE_SECONDS;
|
||||
|
||||
/* The client identifier is used to uniquely identify this MQTT client to
|
||||
* the MQTT broker. */
|
||||
xConnectInfo.pClientIdentifier = mqttexampleCLIENT_IDENTIFIER;
|
||||
xConnectInfo.clientIdentifierLength = ( uint16_t ) strlen( mqttexampleCLIENT_IDENTIFIER );
|
||||
|
||||
/* This example does not use any authentication and therefore username and
|
||||
* password fields are not used. */
|
||||
xConnectInfo.pUserName = NULL;
|
||||
xConnectInfo.userNameLength = 0;
|
||||
xConnectInfo.pPassword = NULL;
|
||||
xConnectInfo.passwordLength = 0;
|
||||
|
||||
/* Establish the connection to the MQTT broker - It is a blocking call and
|
||||
will return only when connection is complete. */
|
||||
xResult = IotMqtt_Connect( &( xNetworkInfo ),
|
||||
&( xConnectInfo ),
|
||||
mqttexampleMQTT_TIMEOUT_MS,
|
||||
&( xMQTTConnection ) );
|
||||
configASSERT( xResult == IOT_MQTT_SUCCESS );
|
||||
}
|
||||
/*-----------------------------------------------------------*/
|
||||
|
||||
static void prvMQTTSubscribe( void )
|
||||
{
|
||||
IotMqttError_t xResult;
|
||||
IotMqttSubscription_t xMQTTSubscription;
|
||||
|
||||
/* Subscribe to the mqttexampleTOPIC topic filter. */
|
||||
xMQTTSubscription.qos = IOT_MQTT_QOS_1;
|
||||
xMQTTSubscription.pTopicFilter = mqttexampleTOPIC;
|
||||
xMQTTSubscription.topicFilterLength = ( uint16_t ) strlen( mqttexampleTOPIC );
|
||||
xMQTTSubscription.callback.pCallbackContext = ( void * ) xTaskGetCurrentTaskHandle();
|
||||
xMQTTSubscription.callback.function = prvExample_PublishCallback;
|
||||
|
||||
/* Use the synchronous API to subscribe - It is a blocking call and only
|
||||
* returns when the subscribe operation is complete. */
|
||||
xResult = IotMqtt_TimedSubscribe( xMQTTConnection,
|
||||
&( xMQTTSubscription ),
|
||||
1, /* We are subscribing to one topic filter. */
|
||||
0, /* flags - currently ignored. */
|
||||
mqttexampleMQTT_TIMEOUT_MS );
|
||||
configASSERT( xResult == IOT_MQTT_SUCCESS );
|
||||
}
|
||||
/*-----------------------------------------------------------*/
|
||||
|
||||
static void prvMQTTPublish( void )
|
||||
{
|
||||
IotMqttError_t xResult;
|
||||
IotMqttPublishInfo_t xMQTTPublishInfo;
|
||||
|
||||
/* Publish a message with QoS1 on the mqttexampleTOPIC topic. Since we are
|
||||
* subscribed to the same topic, the MQTT broker will send the same message
|
||||
* back to us. It is verified in the publish callback. */
|
||||
xMQTTPublishInfo.qos = IOT_MQTT_QOS_1;
|
||||
xMQTTPublishInfo.retain = false;
|
||||
xMQTTPublishInfo.pTopicName = mqttexampleTOPIC;
|
||||
xMQTTPublishInfo.topicNameLength = ( uint16_t ) strlen( mqttexampleTOPIC );
|
||||
xMQTTPublishInfo.pPayload = mqttexampleMESSAGE;
|
||||
xMQTTPublishInfo.payloadLength = strlen( mqttexampleMESSAGE );
|
||||
xMQTTPublishInfo.retryMs = mqttexamplePUBLISH_RETRY_MS;
|
||||
xMQTTPublishInfo.retryLimit = mqttexamplePUBLISH_RETRY_LIMIT;
|
||||
|
||||
/* Use the synchronous API to publish - It is a blocking call and only
|
||||
* returns when the publish operation is complete. */
|
||||
xResult = IotMqtt_TimedPublish( xMQTTConnection,
|
||||
&( xMQTTPublishInfo ),
|
||||
0, /* flags - currently ignored. */
|
||||
mqttexampleMQTT_TIMEOUT_MS );
|
||||
configASSERT( xResult == IOT_MQTT_SUCCESS );
|
||||
}
|
||||
/*-----------------------------------------------------------*/
|
||||
|
||||
static void prvMQTTUnsubscribe( void )
|
||||
{
|
||||
IotMqttError_t xResult;
|
||||
IotMqttSubscription_t xMQTTSubscription;
|
||||
|
||||
/* Unsubscribe from the mqttexampleTOPIC topic filter. */
|
||||
xMQTTSubscription.pTopicFilter = mqttexampleTOPIC;
|
||||
xMQTTSubscription.topicFilterLength = ( uint16_t ) strlen( mqttexampleTOPIC );
|
||||
/* The following members of the IotMqttSubscription_t are ignored by the
|
||||
* unsubscribe operation. Just initialize them to avoid "use of uninitialized
|
||||
* variable" warnings. */
|
||||
xMQTTSubscription.qos = IOT_MQTT_QOS_1;
|
||||
xMQTTSubscription.callback.pCallbackContext = NULL;
|
||||
xMQTTSubscription.callback.function = NULL;
|
||||
|
||||
/* Use the synchronous API to unsubscribe - It is a blocking call and only
|
||||
* returns when the unsubscribe operation is complete. */
|
||||
xResult = IotMqtt_TimedUnsubscribe( xMQTTConnection,
|
||||
&( xMQTTSubscription ),
|
||||
1, /* We are unsubscribing from one topic filter. */
|
||||
0, /* flags - currently ignored. */
|
||||
mqttexampleMQTT_TIMEOUT_MS );
|
||||
configASSERT( xResult == IOT_MQTT_SUCCESS );
|
||||
}
|
||||
/*-----------------------------------------------------------*/
|
||||
|
||||
static void prvMQTTDisconnect( void )
|
||||
{
|
||||
/* Send a MQTT DISCONNECT packet to the MQTT broker to do a graceful
|
||||
* disconnect. */
|
||||
IotMqtt_Disconnect( xMQTTConnection,
|
||||
0 /* flags - 0 means a graceful disconnect by sending MQTT DISCONNECT. */
|
||||
);
|
||||
}
|
||||
/*-----------------------------------------------------------*/
|
|
@ -1,599 +0,0 @@
|
|||
/*
|
||||
* FreeRTOS Kernel V10.2.1
|
||||
* Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||
* this software and associated documentation files (the "Software"), to deal in
|
||||
* the Software without restriction, including without limitation the rights to
|
||||
* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
||||
* the Software, and to permit persons to whom the Software is furnished to do so,
|
||||
* subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in all
|
||||
* copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
||||
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
||||
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
||||
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
||||
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
*
|
||||
* http://www.FreeRTOS.org
|
||||
* http://aws.amazon.com/freertos
|
||||
*
|
||||
* 1 tab == 4 spaces!
|
||||
*/
|
||||
|
||||
//_RB_ Add link to docs here.
|
||||
|
||||
/* Kernel includes. */
|
||||
#include "FreeRTOS.h"
|
||||
#include "task.h"
|
||||
|
||||
/* Standard includes. */
|
||||
#include <stdio.h>
|
||||
|
||||
/* IoT SDK includes. */
|
||||
#include "iot_taskpool.h"
|
||||
|
||||
/* The priority at which that tasks in the task pool (the worker tasks) get
|
||||
created. */
|
||||
#define tpTASK_POOL_WORKER_PRIORITY 1
|
||||
|
||||
/* The number of jobs created in the example functions that create more than
|
||||
one job. */
|
||||
#define tpJOBS_TO_CREATE 5
|
||||
|
||||
/*
|
||||
* Prototypes for the functions that demonstrate the task pool API.
|
||||
* See the implementation of the prvTaskPoolDemoTask() function within this file
|
||||
* for a description of the individual functions. A configASSERT() is hit if
|
||||
* any of the demos encounter any unexpected behaviour.
|
||||
*/
|
||||
static void prvExample_BasicSingleJob( void );
|
||||
static void prvExample_DeferredJobAndCancellingJobs( void );
|
||||
static void prvExample_BasicRecyclableJob( void );
|
||||
static void prvExample_ReuseRecyclableJobFromLowPriorityTask( void );
|
||||
static void prvExample_ReuseRecyclableJobFromHighPriorityTask( void );
|
||||
|
||||
/*
|
||||
* Prototypes of the callback functions used in the examples. The callback
|
||||
* simply sends a signal (in the form of a direct task notification) to the
|
||||
* prvTaskPoolDemoTask() task to let the task know that the callback execute.
|
||||
* The handle of the prvTaskPoolDemoTask() task is not accessed directly, but
|
||||
* instead passed into the task pool job as the job's context.
|
||||
*/
|
||||
static void prvSimpleTaskNotifyCallback( IotTaskPool_t pTaskPool, IotTaskPoolJob_t pJob, void *pUserContext );
|
||||
|
||||
/*
|
||||
* The task used to demonstrate the task pool API. This task just loops through
|
||||
* each demo in turn.
|
||||
*/
|
||||
static void prvTaskPoolDemoTask( void *pvParameters );
|
||||
|
||||
/*-----------------------------------------------------------*/
|
||||
|
||||
/* Parameters used to create the system task pool - see TBD for more information
|
||||
as the task pool used in this example is a slimmed down version of the full
|
||||
library - the slimmed down version being intended specifically for FreeRTOS
|
||||
kernel use cases. */
|
||||
static const IotTaskPoolInfo_t xTaskPoolParameters = {
|
||||
/* Minimum number of threads in a task pool.
|
||||
Note the slimmed down version of the task
|
||||
pool used by this library does not autoscale
|
||||
the number of tasks in the pool so in this
|
||||
case this sets the number of tasks in the
|
||||
pool. */
|
||||
2,
|
||||
/* Maximum number of threads in a task pool.
|
||||
Note the slimmed down version of the task
|
||||
pool used by this library does not autoscale
|
||||
the number of tasks in the pool so in this
|
||||
case this parameter is just ignored. */
|
||||
2,
|
||||
/* Stack size for every task pool thread - in
|
||||
bytes, hence multiplying by the number of bytes
|
||||
in a word as configMINIMAL_STACK_SIZE is
|
||||
specified in words. */
|
||||
configMINIMAL_STACK_SIZE * sizeof( portSTACK_TYPE ),
|
||||
/* Priority for every task pool thread. */
|
||||
tpTASK_POOL_WORKER_PRIORITY,
|
||||
};
|
||||
|
||||
/*-----------------------------------------------------------*/
|
||||
|
||||
void vStartSimpleTaskPoolDemo( void )
|
||||
{
|
||||
/* This example uses a single application task, which in turn is used to
|
||||
create and send jobs to task pool tasks. */
|
||||
xTaskCreate( prvTaskPoolDemoTask, /* Function that implements the task. */
|
||||
"PoolDemo", /* Text name for the task - only used for debugging. */
|
||||
configMINIMAL_STACK_SIZE, /* Size of stack (in words, not bytes) to allocate for the task. */
|
||||
NULL, /* Task parameter - not used in this case. */
|
||||
tskIDLE_PRIORITY, /* Task priority, must be between 0 and configMAX_PRIORITIES - 1. */
|
||||
NULL ); /* Used to pass out a handle to the created tsak - not used in this case. */
|
||||
}
|
||||
/*-----------------------------------------------------------*/
|
||||
|
||||
static void prvTaskPoolDemoTask( void *pvParameters )
|
||||
{
|
||||
IotTaskPoolError_t xResult;
|
||||
uint32_t ulLoops = 0;
|
||||
|
||||
/* Remove compiler warnings about unused parameters. */
|
||||
( void ) pvParameters;
|
||||
|
||||
/* The task pool must be created before it can be used. The system task
|
||||
pool is the task pool managed by the task pool library itself - the storage
|
||||
used by the task pool is provided by the library. */
|
||||
xResult = IotTaskPool_CreateSystemTaskPool( &xTaskPoolParameters );
|
||||
configASSERT( xResult == IOT_TASKPOOL_SUCCESS );
|
||||
|
||||
/* Attempting to create the task pool again should then appear to succeed
|
||||
(in case it is initialised by more than one library), but have no effect. */
|
||||
xResult = IotTaskPool_CreateSystemTaskPool( &xTaskPoolParameters );
|
||||
configASSERT( xResult == IOT_TASKPOOL_SUCCESS );
|
||||
|
||||
for( ;; )
|
||||
{
|
||||
/* Demonstrate the most basic use case where a non persistent job is
|
||||
created and scheduled to run immediately. The task pool worker tasks
|
||||
(in which the job callback function executes) have a priority above the
|
||||
priority of this task so the job's callback executes as soon as it is
|
||||
scheduled. */
|
||||
prvExample_BasicSingleJob();
|
||||
|
||||
/* Demonstrate a job being scheduled to run at some time in the
|
||||
future, and how a job scheduled to run in the future can be cancelled if
|
||||
it has not yet started executing. */
|
||||
prvExample_DeferredJobAndCancellingJobs();
|
||||
|
||||
/* Demonstrate the most basic use of a recyclable job. This is similar
|
||||
to prvExample_BasicSingleJob() but using a recyclable job. Creating a
|
||||
recyclable job will re-use a previously created and now spare job from
|
||||
the task pool's job cache if one is available, or otherwise dynamically
|
||||
create a new job if a spare job is not available in the cache but space
|
||||
remains in the cache. */
|
||||
prvExample_BasicRecyclableJob();
|
||||
|
||||
/* Demonstrate multiple recyclable jobs being created, used, and then
|
||||
re-used. In this the task pool worker tasks (in which the job callback
|
||||
functions execute) have a priority above the priority of this task so
|
||||
the job's callback functions execute as soon as they are scheduled. */
|
||||
prvExample_ReuseRecyclableJobFromLowPriorityTask();
|
||||
|
||||
/* Again demonstrate multiple recyclable jobs being used, but this time
|
||||
the priority of the task pool worker tasks (in which the job callback
|
||||
functions execute) are lower than the priority of this task so the job's
|
||||
callback functions don't execute until this task enteres the blocked
|
||||
state. */
|
||||
prvExample_ReuseRecyclableJobFromHighPriorityTask();
|
||||
|
||||
ulLoops++;
|
||||
if( ( ulLoops % 10UL ) == 0 )
|
||||
{
|
||||
printf( "prvTaskPoolDemoTask() performed %u iterations without hitting an assert.\r\n", ulLoops );
|
||||
fflush( stdout );
|
||||
}
|
||||
}
|
||||
}
|
||||
/*-----------------------------------------------------------*/
|
||||
|
||||
static void prvSimpleTaskNotifyCallback( IotTaskPool_t pTaskPool, IotTaskPoolJob_t pJob, void *pUserContext )
|
||||
{
|
||||
/* The jobs context is the handle of the task to which a notification should
|
||||
be sent. */
|
||||
TaskHandle_t xTaskToNotify = ( TaskHandle_t ) pUserContext;
|
||||
|
||||
/* Remove warnings about unused parameters. */
|
||||
( void ) pTaskPool;
|
||||
( void ) pJob;
|
||||
|
||||
/* Notify the task that created this job. */
|
||||
xTaskNotifyGive( xTaskToNotify );
|
||||
}
|
||||
/*-----------------------------------------------------------*/
|
||||
|
||||
static void prvExample_BasicSingleJob( void )
|
||||
{
|
||||
IotTaskPoolJobStorage_t xJobStorage;
|
||||
IotTaskPoolJob_t xJob;
|
||||
IotTaskPoolError_t xResult;
|
||||
uint32_t ulReturn;
|
||||
const uint32_t ulNoFlags = 0UL;
|
||||
const TickType_t xNoDelay = ( TickType_t ) 0;
|
||||
size_t xFreeHeapBeforeCreatingJob = xPortGetFreeHeapSize();
|
||||
IotTaskPoolJobStatus_t xJobStatus;
|
||||
|
||||
/* Don't expect any notifications to be pending yet. */
|
||||
configASSERT( ulTaskNotifyTake( pdTRUE, 0 ) == 0 );
|
||||
|
||||
/* Create and schedule a job using the handle of this task as the job's
|
||||
context and the function that sends a notification to the task handle as
|
||||
the jobs callback function. This is not a recyclable job so the storage
|
||||
required to hold information about the job is provided by this task - in
|
||||
this case the storage is on the stack of this task so no memory is allocated
|
||||
dynamically but the stack frame must remain in scope for the lifetime of
|
||||
the job. */
|
||||
xResult = IotTaskPool_CreateJob( prvSimpleTaskNotifyCallback, /* Callback function. */
|
||||
( void * ) xTaskGetCurrentTaskHandle(), /* Job context. */
|
||||
&xJobStorage,
|
||||
&xJob );
|
||||
configASSERT( xResult == IOT_TASKPOOL_SUCCESS );
|
||||
|
||||
/* The job has been created but not scheduled so is now ready. */
|
||||
IotTaskPool_GetStatus( NULL, xJob, &xJobStatus );
|
||||
configASSERT( xJobStatus == IOT_TASKPOOL_STATUS_READY );
|
||||
|
||||
/* This is not a persistent (recyclable) job and its storage is on the
|
||||
stack of this function, so the amount of heap space available should not
|
||||
have chanced since entering this function. */
|
||||
configASSERT( xFreeHeapBeforeCreatingJob == xPortGetFreeHeapSize() );
|
||||
|
||||
/* In the full task pool implementation the first parameter is used to
|
||||
pass the handle of the task pool to schedule. The lean task pool
|
||||
implementation used in this demo only supports a single task pool, which
|
||||
is created internally within the library, so the first parameter is NULL. */
|
||||
xResult = IotTaskPool_Schedule( NULL, xJob, ulNoFlags );
|
||||
configASSERT( xResult == IOT_TASKPOOL_SUCCESS );
|
||||
|
||||
/* Look for the notification coming from the job's callback function. The
|
||||
priority of the task pool worker task that executes the callback is higher
|
||||
than the priority of this task so a block time is not needed - the task pool
|
||||
worker task pre-empts this task and sends the notification (from the job's
|
||||
callback) as soon as the job is scheduled. */
|
||||
ulReturn = ulTaskNotifyTake( pdTRUE, xNoDelay );
|
||||
configASSERT( ulReturn );
|
||||
|
||||
/* The job's callback has executed so the job has now completed. */
|
||||
IotTaskPool_GetStatus( NULL, xJob, &xJobStatus );
|
||||
configASSERT( xJobStatus == IOT_TASKPOOL_STATUS_COMPLETED );
|
||||
}
|
||||
/*-----------------------------------------------------------*/
|
||||
|
||||
static void prvExample_DeferredJobAndCancellingJobs( void )
|
||||
{
|
||||
IotTaskPoolJobStorage_t xJobStorage;
|
||||
IotTaskPoolJob_t xJob;
|
||||
IotTaskPoolError_t xResult;
|
||||
uint32_t ulReturn;
|
||||
const uint32_t ulShortDelay_ms = 100UL;
|
||||
const TickType_t xNoDelay = ( TickType_t ) 0, xAllowableMargin = ( TickType_t ) 5; /* Large margin for Windows port, which is not real time. */
|
||||
TickType_t xTimeBefore, xElapsedTime, xShortDelay_ticks;
|
||||
size_t xFreeHeapBeforeCreatingJob = xPortGetFreeHeapSize();
|
||||
IotTaskPoolJobStatus_t xJobStatus;
|
||||
|
||||
/* Don't expect any notifications to be pending yet. */
|
||||
configASSERT( ulTaskNotifyTake( pdTRUE, 0 ) == 0 );
|
||||
|
||||
/* Create a job using the handle of this task as the job's context and the
|
||||
function that sends a notification to the task handle as the jobs callback
|
||||
function. The job is created using storage allocated on the stack of this
|
||||
function - so no memory is allocated. */
|
||||
xResult = IotTaskPool_CreateJob( prvSimpleTaskNotifyCallback, /* Callback function. */
|
||||
( void * ) xTaskGetCurrentTaskHandle(), /* Job context. */
|
||||
&xJobStorage,
|
||||
&xJob );
|
||||
configASSERT( xResult == IOT_TASKPOOL_SUCCESS );
|
||||
|
||||
/* The job has been created but not scheduled so is now ready. */
|
||||
IotTaskPool_GetStatus( NULL, xJob, &xJobStatus );
|
||||
configASSERT( xJobStatus == IOT_TASKPOOL_STATUS_READY );
|
||||
|
||||
/* This is not a persistent (recyclable) job and its storage is on the
|
||||
stack of this function, so the amount of heap space available should not
|
||||
have chanced since entering this function. */
|
||||
configASSERT( xFreeHeapBeforeCreatingJob == xPortGetFreeHeapSize() );
|
||||
|
||||
/* Schedule the job to run its callback in xShortDelay_ms milliseconds time.
|
||||
In the full task pool implementation the first parameter is used to pass the
|
||||
handle of the task pool to schedule. The lean task pool implementation used
|
||||
in this demo only supports a single task pool, which is created internally
|
||||
within the library, so the first parameter is NULL. */
|
||||
xResult = IotTaskPool_ScheduleDeferred( NULL, xJob, ulShortDelay_ms );
|
||||
configASSERT( xResult == IOT_TASKPOOL_SUCCESS );
|
||||
|
||||
/* The scheduled job should not have executed yet, so don't expect any
|
||||
notifications and expect the job's status to be 'deferred'. */
|
||||
ulReturn = ulTaskNotifyTake( pdTRUE, xNoDelay );
|
||||
configASSERT( ulReturn == 0 );
|
||||
IotTaskPool_GetStatus( NULL, xJob, &xJobStatus );
|
||||
configASSERT( xJobStatus == IOT_TASKPOOL_STATUS_DEFERRED );
|
||||
|
||||
/* As the job has not yet been executed it can be stopped. */
|
||||
xResult = IotTaskPool_TryCancel( NULL, xJob, &xJobStatus );
|
||||
configASSERT( xResult == IOT_TASKPOOL_SUCCESS );
|
||||
IotTaskPool_GetStatus( NULL, xJob, &xJobStatus );
|
||||
configASSERT( xJobStatus == IOT_TASKPOOL_STATUS_CANCELED );
|
||||
|
||||
/* Schedule the job again, and this time wait until its callback is
|
||||
executed (the callback function sends a notification to this task) to see
|
||||
that it executes at the right time. */
|
||||
xTimeBefore = xTaskGetTickCount();
|
||||
xResult = IotTaskPool_ScheduleDeferred( NULL, xJob, ulShortDelay_ms );
|
||||
configASSERT( xResult == IOT_TASKPOOL_SUCCESS );
|
||||
|
||||
/* Wait twice the deferred execution time to ensure the callback is executed
|
||||
before the call below times out. */
|
||||
ulReturn = ulTaskNotifyTake( pdTRUE, pdMS_TO_TICKS( ulShortDelay_ms * 2UL ) );
|
||||
xElapsedTime = xTaskGetTickCount() - xTimeBefore;
|
||||
|
||||
/* A single notification should not have been received... */
|
||||
configASSERT( ulReturn == 1 );
|
||||
|
||||
/* ...and the time since scheduling the job should be greater than or
|
||||
equal to the deferred execution time - which is converted to ticks for
|
||||
comparison. */
|
||||
xShortDelay_ticks = pdMS_TO_TICKS( ulShortDelay_ms );
|
||||
configASSERT( ( xElapsedTime >= xShortDelay_ticks ) && ( xElapsedTime < ( xShortDelay_ticks + xAllowableMargin ) ) );
|
||||
}
|
||||
/*-----------------------------------------------------------*/
|
||||
|
||||
static void prvExample_BasicRecyclableJob( void )
|
||||
{
|
||||
IotTaskPoolJob_t xJob;
|
||||
IotTaskPoolError_t xResult;
|
||||
uint32_t ulReturn;
|
||||
const uint32_t ulNoFlags = 0UL;
|
||||
const TickType_t xNoDelay = ( TickType_t ) 0;
|
||||
size_t xFreeHeapBeforeCreatingJob = xPortGetFreeHeapSize();
|
||||
|
||||
/* Don't expect any notifications to be pending yet. */
|
||||
configASSERT( ulTaskNotifyTake( pdTRUE, 0 ) == 0 );
|
||||
|
||||
/* Create and schedule a job using the handle of this task as the job's
|
||||
context and the function that sends a notification to the task handle as
|
||||
the jobs callback function. The job is created as a recyclable job and in
|
||||
this case the memory used to hold the job status is allocated inside the
|
||||
create function. As the job is persistent it can be used multiple times,
|
||||
as demonstrated in other examples within this demo. In the full task pool
|
||||
implementation the first parameter is used to pass the handle of the task
|
||||
pool this recyclable job is to be associated with. In the lean
|
||||
implementation of the task pool used by this demo there is only one task
|
||||
pool (the system task pool created within the task pool library) so the
|
||||
first parameter is NULL. */
|
||||
xResult = IotTaskPool_CreateRecyclableJob( NULL,
|
||||
prvSimpleTaskNotifyCallback,
|
||||
(void * ) xTaskGetCurrentTaskHandle(),
|
||||
&xJob );
|
||||
configASSERT( xResult == IOT_TASKPOOL_SUCCESS );
|
||||
|
||||
/* This recyclable job is persistent, and in this case created dynamically,
|
||||
so expect there to be less heap space then when entering the function. */
|
||||
configASSERT( xPortGetFreeHeapSize() < xFreeHeapBeforeCreatingJob );
|
||||
|
||||
/* In the full task pool implementation the first parameter is used to
|
||||
pass the handle of the task pool to schedule. The lean task pool
|
||||
implementation used in this demo only supports a single task pool, which
|
||||
is created internally within the library, so the first parameter is NULL. */
|
||||
xResult = IotTaskPool_Schedule( NULL, xJob, ulNoFlags );
|
||||
configASSERT( xResult == IOT_TASKPOOL_SUCCESS );
|
||||
|
||||
/* Look for the notification coming from the job's callback function. The
|
||||
priority of the task pool worker task that executes the callback is higher
|
||||
than the priority of this task so a block time is not needed - the task pool
|
||||
worker task pre-empts this task and sends the notification (from the job's
|
||||
callback) as soon as the job is scheduled. */
|
||||
ulReturn = ulTaskNotifyTake( pdTRUE, xNoDelay );
|
||||
configASSERT( ulReturn );
|
||||
|
||||
/* Clean up recyclable job. In the full implementation of the task pool
|
||||
the first parameter is used to pass a handle to the task pool the job is
|
||||
associated with. In the lean implementation of the task pool used by this
|
||||
demo there is only one task pool (the system task pool created in the
|
||||
task pool library itself) so the first parameter is NULL. */
|
||||
IotTaskPool_DestroyRecyclableJob( NULL, xJob );
|
||||
|
||||
/* Once the job has been deleted the memory used to hold the job is
|
||||
returned, so the available heap should be exactly as when entering this
|
||||
function. */
|
||||
configASSERT( xPortGetFreeHeapSize() == xFreeHeapBeforeCreatingJob );
|
||||
}
|
||||
/*-----------------------------------------------------------*/
|
||||
|
||||
static void prvExample_ReuseRecyclableJobFromLowPriorityTask( void )
|
||||
{
|
||||
IotTaskPoolError_t xResult;
|
||||
uint32_t x, xIndex, ulNotificationValue;
|
||||
const uint32_t ulNoFlags = 0UL;
|
||||
IotTaskPoolJob_t xJobs[ tpJOBS_TO_CREATE ];
|
||||
size_t xFreeHeapBeforeCreatingJob = xPortGetFreeHeapSize();
|
||||
IotTaskPoolJobStatus_t xJobStatus;
|
||||
|
||||
/* Don't expect any notifications to be pending yet. */
|
||||
configASSERT( ulTaskNotifyTake( pdTRUE, 0 ) == 0 );
|
||||
|
||||
/* Create tpJOBS_TO_CREATE jobs using the handle of this task as the job's
|
||||
context and the function that sends a notification to the task handle as
|
||||
the jobs callback function. The jobs are created as a recyclable job and
|
||||
in this case the memory to store the job information is allocated within
|
||||
the create function as at this time there are no recyclable jobs in the
|
||||
task pool jobs cache. As the jobs are persistent they can be used multiple
|
||||
times. In the full task pool implementation the first parameter is used to
|
||||
pass the handle of the task pool this recyclable job is to be associated
|
||||
with. In the lean implementation of the task pool used by this demo there
|
||||
is only one task pool (the system task pool created within the task pool
|
||||
library) so the first parameter is NULL. */
|
||||
for( x = 0; x < tpJOBS_TO_CREATE; x++ )
|
||||
{
|
||||
xResult = IotTaskPool_CreateRecyclableJob( NULL,
|
||||
prvSimpleTaskNotifyCallback,
|
||||
(void * ) xTaskGetCurrentTaskHandle(),
|
||||
&( xJobs[ x ] ) );
|
||||
configASSERT( xResult == IOT_TASKPOOL_SUCCESS );
|
||||
|
||||
/* The job has been created but not scheduled so is now ready. */
|
||||
IotTaskPool_GetStatus( NULL, xJobs[ x ], &xJobStatus );
|
||||
configASSERT( xJobStatus == IOT_TASKPOOL_STATUS_READY );
|
||||
}
|
||||
|
||||
/* Demonstrate that the jobs can be recycled by performing twice the number
|
||||
of iterations of scheduling jobs than there actually are created jobs. This
|
||||
works because the task pool task priorities are above the priority of this
|
||||
task, so the tasks that run the jobs pre-empt this task as soon as a job is
|
||||
ready. */
|
||||
for( x = 0; x < ( tpJOBS_TO_CREATE * 2UL ); x++ )
|
||||
{
|
||||
/* Make sure array index does not go out of bounds. */
|
||||
xIndex = x % tpJOBS_TO_CREATE;
|
||||
|
||||
xResult = IotTaskPool_Schedule( NULL, xJobs[ xIndex ], ulNoFlags );
|
||||
configASSERT( xResult == IOT_TASKPOOL_SUCCESS );
|
||||
|
||||
/* The priority of the task pool task(s) is higher than the priority
|
||||
of this task, so the job's callback function should have already
|
||||
executed, sending a notification to this task, and incrementing this
|
||||
task's notification value. */
|
||||
xTaskNotifyWait( 0UL, /* Don't clear any bits on entry. */
|
||||
0UL, /* Don't clear any bits on exit. */
|
||||
&ulNotificationValue, /* Obtain the notification value. */
|
||||
0UL ); /* No block time, return immediately. */
|
||||
configASSERT( ulNotificationValue == ( x + 1 ) );
|
||||
|
||||
/* The job's callback has executed so the job is now completed. */
|
||||
IotTaskPool_GetStatus( NULL, xJobs[ xIndex ], &xJobStatus );
|
||||
configASSERT( xJobStatus == IOT_TASKPOOL_STATUS_COMPLETED );
|
||||
|
||||
/* To leave the list of jobs empty we can stop re-creating jobs half
|
||||
way through iterations of this loop. */
|
||||
if( x < tpJOBS_TO_CREATE )
|
||||
{
|
||||
/* Recycle the job so it can be used again. In the full task pool
|
||||
implementation the first parameter is used to pass the handle of the
|
||||
task pool this job will be associated with. In this lean task pool
|
||||
implementation only the system task pool exists (the task pool created
|
||||
internally to the task pool library) so the first parameter is just
|
||||
passed as NULL. *//*_RB_ Why not recycle it automatically? */
|
||||
IotTaskPool_RecycleJob( NULL, xJobs[ xIndex ] );
|
||||
xResult = IotTaskPool_CreateRecyclableJob( NULL,
|
||||
prvSimpleTaskNotifyCallback,
|
||||
(void * ) xTaskGetCurrentTaskHandle(),
|
||||
&( xJobs[ xIndex ] ) );
|
||||
configASSERT( xResult == IOT_TASKPOOL_SUCCESS );
|
||||
}
|
||||
}
|
||||
|
||||
/* Clear all the notification value bits again. */
|
||||
xTaskNotifyWait( portMAX_DELAY, /* Clear all bits on entry - portMAX_DELAY is used as it is a portable way of having all bits set. */
|
||||
0UL, /* Don't clear any bits on exit. */
|
||||
NULL, /* Don't need the notification value this time. */
|
||||
0UL ); /* No block time, return immediately. */
|
||||
configASSERT( ulTaskNotifyTake( pdTRUE, 0 ) == 0 );
|
||||
|
||||
/* Clean up all the recyclable job. In the full implementation of the task
|
||||
pool the first parameter is used to pass a handle to the task pool the job
|
||||
is associated with. In the lean implementation of the task pool used by
|
||||
this demo there is only one task pool (the system task pool created in the
|
||||
task pool library itself) so the first parameter is NULL. */
|
||||
for( x = 0; x < tpJOBS_TO_CREATE; x++ )
|
||||
{
|
||||
xResult = IotTaskPool_DestroyRecyclableJob( NULL, xJobs[ x ] );
|
||||
configASSERT( xResult == IOT_TASKPOOL_SUCCESS );
|
||||
}
|
||||
|
||||
/* Once the job has been deleted the memory used to hold the job is
|
||||
returned, so the available heap should be exactly as when entering this
|
||||
function. */
|
||||
configASSERT( xPortGetFreeHeapSize() == xFreeHeapBeforeCreatingJob );
|
||||
}
|
||||
/*-----------------------------------------------------------*/
|
||||
|
||||
static void prvExample_ReuseRecyclableJobFromHighPriorityTask( void )
|
||||
{
|
||||
IotTaskPoolError_t xResult;
|
||||
uint32_t x, ulNotificationValue;
|
||||
const uint32_t ulNoFlags = 0UL;
|
||||
IotTaskPoolJob_t xJobs[ tpJOBS_TO_CREATE ];
|
||||
IotTaskPoolJobStorage_t xJobStorage[ tpJOBS_TO_CREATE ];
|
||||
size_t xFreeHeapBeforeCreatingJob = xPortGetFreeHeapSize();
|
||||
TickType_t xShortDelay = pdMS_TO_TICKS( 150 );
|
||||
IotTaskPoolJobStatus_t xJobStatus;
|
||||
|
||||
/* Don't expect any notifications to be pending yet. */
|
||||
configASSERT( ulTaskNotifyTake( pdTRUE, 0 ) == 0 );
|
||||
|
||||
/* prvExample_ReuseRecyclableJobFromLowPriorityTask() executes in a task
|
||||
that has a lower [task] priority than the task pool's worker tasks.
|
||||
Therefore a talk pool worker preempts the task that calls
|
||||
prvExample_ReuseRecyclableJobFromHighPriorityTask() as soon as the job is
|
||||
scheduled. prvExample_ReuseRecyclableJobFromHighPriorityTask() reverses the
|
||||
priorities - prvExample_ReuseRecyclableJobFromHighPriorityTask() raises its
|
||||
priority to above the task pool's worker tasks, so the worker tasks do not
|
||||
execute until the calling task enters the blocked state. First raise the
|
||||
priority - passing NULL means raise the priority of the calling task. */
|
||||
vTaskPrioritySet( NULL, tpTASK_POOL_WORKER_PRIORITY + 1 );
|
||||
|
||||
/* Create tpJOBS_TO_CREATE jobs using the handle of this task as the job's
|
||||
context and the function that sends a notification to the task handle as
|
||||
the jobs callback function. */
|
||||
for( x = 0; x < tpJOBS_TO_CREATE; x++ )
|
||||
{
|
||||
xResult = IotTaskPool_CreateJob( prvSimpleTaskNotifyCallback, /* Callback function. */
|
||||
( void * ) xTaskGetCurrentTaskHandle(), /* Job context. */
|
||||
&( xJobStorage[ x ] ),
|
||||
&( xJobs[ x ] ) );
|
||||
configASSERT( xResult == IOT_TASKPOOL_SUCCESS );
|
||||
|
||||
/* This is not a persistent (recyclable) job and its storage is on the
|
||||
stack of this function, so the amount of heap space available should not
|
||||
have chanced since entering this function. */
|
||||
configASSERT( xFreeHeapBeforeCreatingJob == xPortGetFreeHeapSize() );
|
||||
}
|
||||
|
||||
for( x = 0; x < tpJOBS_TO_CREATE; x++ )
|
||||
{
|
||||
/* Schedule the next job. */
|
||||
xResult = IotTaskPool_Schedule( NULL, xJobs[ x ], ulNoFlags );
|
||||
configASSERT( xResult == IOT_TASKPOOL_SUCCESS );
|
||||
|
||||
/* Although scheduled, the job's callback has not executed, so the job
|
||||
reports itself as scheduled. */
|
||||
IotTaskPool_GetStatus( NULL, xJobs[ x ], &xJobStatus );
|
||||
configASSERT( xJobStatus == IOT_TASKPOOL_STATUS_SCHEDULED );
|
||||
|
||||
/* The priority of the task pool task(s) is lower than the priority
|
||||
of this task, so the job's callback function should not have executed
|
||||
yes, so don't expect the notification value for this task to have
|
||||
changed. */
|
||||
xTaskNotifyWait( 0UL, /* Don't clear any bits on entry. */
|
||||
0UL, /* Don't clear any bits on exit. */
|
||||
&ulNotificationValue, /* Obtain the notification value. */
|
||||
0UL ); /* No block time, return immediately. */
|
||||
configASSERT( ulNotificationValue == 0 );
|
||||
}
|
||||
|
||||
/* At this point there are tpJOBS_TO_CREATE scheduled, but none have executed
|
||||
their callbacks because the priority of this task is higher than the
|
||||
priority of the task pool worker threads. When this task blocks to wait for
|
||||
a notification a worker thread will be able to executes - but as soon as its
|
||||
callback function sends a notification to this task this task will
|
||||
preempt it (because it has a higher priority) so this task only expects to
|
||||
receive one notification at a time. */
|
||||
for( x = 0; x < tpJOBS_TO_CREATE; x++ )
|
||||
{
|
||||
xTaskNotifyWait( 0UL, /* Don't clear any bits on entry. */
|
||||
0UL, /* Don't clear any bits on exit. */
|
||||
&ulNotificationValue, /* Obtain the notification value. */
|
||||
xShortDelay ); /* Short delay to allow a task pool worker to execute. */
|
||||
configASSERT( ulNotificationValue == ( x + 1 ) );
|
||||
}
|
||||
|
||||
/* All the scheduled jobs have now executed, so waiting for another
|
||||
notification should timeout without the notification value changing. */
|
||||
xTaskNotifyWait( 0UL, /* Don't clear any bits on entry. */
|
||||
0UL, /* Don't clear any bits on exit. */
|
||||
&ulNotificationValue, /* Obtain the notification value. */
|
||||
xShortDelay ); /* Short delay to allow a task pool worker to execute. */
|
||||
configASSERT( ulNotificationValue == x );
|
||||
|
||||
/* Reset the priority of this task and clear the notifications ready for the
|
||||
next example. */
|
||||
vTaskPrioritySet( NULL, tskIDLE_PRIORITY );
|
||||
xTaskNotifyWait( portMAX_DELAY, /* Clear all bits on entry - portMAX_DELAY is used as it is a portable way of having all bits set. */
|
||||
0UL, /* Don't clear any bits on exit. */
|
||||
NULL, /* Don't need the notification value this time. */
|
||||
0UL ); /* No block time, return immediately. */
|
||||
}
|
||||
/*-----------------------------------------------------------*/
|
||||
|
|
@ -58,7 +58,7 @@
|
|||
</Midl>
|
||||
<ClCompile>
|
||||
<Optimization>Disabled</Optimization>
|
||||
<AdditionalIncludeDirectories>..\..\..\Source\FreeRTOS-Plus-IoT-SDK\c_sdk\standard\mqtt\include;..\..\..\Source\FreeRTOS-Plus-TCP\include;..\..\..\Source\FreeRTOS-Plus-TCP\portable\BufferManagement;..\..\..\Source\FreeRTOS-Plus-TCP\portable\Compiler\MSVC;.\DemoTasks\include;.\WinPCap;..\..\..\..\FreeRTOS\Source\include;..\..\..\..\FreeRTOS\Source\portable\MSVC-MingW;..\..\..\Source\FreeRTOS-Plus-IoT-SDK\c_sdk\standard\common\include;..\..\..\Source\FreeRTOS-Plus-IoT-SDK\abstractions\platform\include;..\..\..\Source\FreeRTOS-Plus-IoT-SDK\abstractions\platform\freertos\include;.;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
|
||||
<AdditionalIncludeDirectories>..\..\..\Source\FreeRTOS-Plus-IoT-SDK\c_sdk\standard\mqtt\include;..\..\..\Source\FreeRTOS-Plus-TCP\include;..\..\..\Source\FreeRTOS-Plus-TCP\portable\BufferManagement;..\..\..\Source\FreeRTOS-Plus-TCP\portable\Compiler\MSVC;.\DemoTasks\include;.\WinPCap;..\..\..\..\FreeRTOS\Source\include;..\..\..\..\FreeRTOS\Source\portable\MSVC-MingW;..\..\..\Source\FreeRTOS-Plus-IoT-SDK\c_sdk\standard\common\include\private;..\..\..\Source\FreeRTOS-Plus-IoT-SDK\c_sdk\standard\common\include;..\..\..\Source\FreeRTOS-Plus-IoT-SDK\abstractions\platform\include;..\..\..\Source\FreeRTOS-Plus-IoT-SDK\abstractions\platform\freertos\include;..\..\..\Source\FreeRTOS-Plus-IoT-SDK\abstractions\secure_sockets\include;.;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
|
||||
<PreprocessorDefinitions>WIN32;_DEBUG;_CONSOLE;_WIN32_WINNT=0x0500;WINVER=0x400;_CRT_SECURE_NO_WARNINGS;%(PreprocessorDefinitions)</PreprocessorDefinitions>
|
||||
<MinimalRebuild>true</MinimalRebuild>
|
||||
<BasicRuntimeChecks>EnableFastChecks</BasicRuntimeChecks>
|
||||
|
@ -138,11 +138,6 @@
|
|||
</Bscmake>
|
||||
</ItemDefinitionGroup>
|
||||
<ItemGroup>
|
||||
<ClCompile Include="..\..\..\..\..\..\..\..\..\T\reviews\amazon-freertos-master\libraries\abstractions\platform\freertos\iot_clock_freertos.c" />
|
||||
<ClCompile Include="..\..\..\..\..\..\..\..\..\T\reviews\amazon-freertos-master\libraries\abstractions\platform\freertos\iot_threads_freertos.c" />
|
||||
<ClCompile Include="..\..\..\..\..\..\..\..\..\T\reviews\amazon-freertos-master\libraries\c_sdk\standard\mqtt\src\iot_mqtt_network.c" />
|
||||
<ClCompile Include="..\..\..\..\..\..\..\..\..\T\reviews\amazon-freertos-master\libraries\c_sdk\standard\mqtt\src\iot_mqtt_subscription.c" />
|
||||
<ClCompile Include="..\..\..\..\..\..\..\..\..\T\reviews\amazon-freertos-master\libraries\c_sdk\standard\mqtt\src\iot_mqtt_validate.c" />
|
||||
<ClCompile Include="..\..\..\..\FreeRTOS\Source\event_groups.c" />
|
||||
<ClCompile Include="..\..\..\..\FreeRTOS\Source\list.c" />
|
||||
<ClCompile Include="..\..\..\..\FreeRTOS\Source\portable\MemMang\heap_4.c" />
|
||||
|
@ -150,11 +145,18 @@
|
|||
<ClCompile Include="..\..\..\..\FreeRTOS\Source\queue.c" />
|
||||
<ClCompile Include="..\..\..\..\FreeRTOS\Source\tasks.c" />
|
||||
<ClCompile Include="..\..\..\..\FreeRTOS\Source\timers.c" />
|
||||
<ClCompile Include="..\..\..\Source\FreeRTOS-Plus-IoT-SDK\abstractions\platform\freertos\iot_clock_freertos.c" />
|
||||
<ClCompile Include="..\..\..\Source\FreeRTOS-Plus-IoT-SDK\abstractions\platform\freertos\iot_network_freertos.c" />
|
||||
<ClCompile Include="..\..\..\Source\FreeRTOS-Plus-IoT-SDK\abstractions\platform\freertos\iot_threads_freertos.c" />
|
||||
<ClCompile Include="..\..\..\Source\FreeRTOS-Plus-IoT-SDK\abstractions\secure_sockets\freertos_plus_tcp\iot_secure_sockets.c" />
|
||||
<ClCompile Include="..\..\..\Source\FreeRTOS-Plus-IoT-SDK\c_sdk\standard\common\logging\iot_logging.c" />
|
||||
<ClCompile Include="..\..\..\Source\FreeRTOS-Plus-IoT-SDK\c_sdk\standard\common\taskpool\iot_taskpool.c" />
|
||||
<ClCompile Include="..\..\..\Source\FreeRTOS-Plus-IoT-SDK\c_sdk\standard\mqtt\src\iot_mqtt_api.c" />
|
||||
<ClCompile Include="..\..\..\Source\FreeRTOS-Plus-IoT-SDK\c_sdk\standard\mqtt\src\iot_mqtt_network.c" />
|
||||
<ClCompile Include="..\..\..\Source\FreeRTOS-Plus-IoT-SDK\c_sdk\standard\mqtt\src\iot_mqtt_operation.c" />
|
||||
<ClCompile Include="..\..\..\Source\FreeRTOS-Plus-IoT-SDK\c_sdk\standard\mqtt\src\iot_mqtt_serialize.c" />
|
||||
<ClCompile Include="..\..\..\Source\FreeRTOS-Plus-IoT-SDK\c_sdk\standard\mqtt\src\iot_mqtt_subscription.c" />
|
||||
<ClCompile Include="..\..\..\Source\FreeRTOS-Plus-IoT-SDK\c_sdk\standard\mqtt\src\iot_mqtt_validate.c" />
|
||||
<ClCompile Include="..\..\..\Source\FreeRTOS-Plus-TCP\FreeRTOS_ARP.c" />
|
||||
<ClCompile Include="..\..\..\Source\FreeRTOS-Plus-TCP\FreeRTOS_DHCP.c" />
|
||||
<ClCompile Include="..\..\..\Source\FreeRTOS-Plus-TCP\FreeRTOS_DNS.c" />
|
||||
|
@ -166,7 +168,7 @@
|
|||
<ClCompile Include="..\..\..\Source\FreeRTOS-Plus-TCP\FreeRTOS_UDP_IP.c" />
|
||||
<ClCompile Include="..\..\..\Source\FreeRTOS-Plus-TCP\portable\BufferManagement\BufferAllocation_2.c" />
|
||||
<ClCompile Include="..\..\..\Source\FreeRTOS-Plus-TCP\portable\NetworkInterface\WinPCap\NetworkInterface.c" />
|
||||
<ClCompile Include="DemoTasks\SimpleTaskPoolExamples.c" />
|
||||
<ClCompile Include="DemoTasks\SimpleMQTTExamples.c" />
|
||||
<ClCompile Include="DemoTasks\SimpleUDPClientAndServer.c" />
|
||||
<ClCompile Include="demo_logging.c" />
|
||||
<ClCompile Include="main.c">
|
||||
|
@ -185,10 +187,18 @@
|
|||
<ClInclude Include="..\..\..\..\FreeRTOS\Source\include\task.h" />
|
||||
<ClInclude Include="..\..\..\..\FreeRTOS\Source\include\timers.h" />
|
||||
<ClInclude Include="..\..\..\..\FreeRTOS\Source\portable\MSVC-MingW\portmacro.h" />
|
||||
<ClInclude Include="..\..\..\Source\FreeRTOS-Plus-IoT-SDK\abstractions\platform\freertos\include\platform\iot_platform_types_afr.h" />
|
||||
<ClInclude Include="..\..\..\Source\FreeRTOS-Plus-IoT-SDK\abstractions\platform\freertos\include\platform\iot_platform_types_freertos.h" />
|
||||
<ClInclude Include="..\..\..\Source\FreeRTOS-Plus-IoT-SDK\abstractions\platform\include\platform\iot_clock.h" />
|
||||
<ClInclude Include="..\..\..\Source\FreeRTOS-Plus-IoT-SDK\abstractions\platform\include\platform\iot_metrics.h" />
|
||||
<ClInclude Include="..\..\..\Source\FreeRTOS-Plus-IoT-SDK\abstractions\platform\include\platform\iot_network.h" />
|
||||
<ClInclude Include="..\..\..\Source\FreeRTOS-Plus-IoT-SDK\abstractions\platform\include\platform\iot_threads.h" />
|
||||
<ClInclude Include="..\..\..\Source\FreeRTOS-Plus-IoT-SDK\abstractions\platform\include\types\iot_platform_types.h" />
|
||||
<ClInclude Include="..\..\..\Source\FreeRTOS-Plus-IoT-SDK\abstractions\secure_sockets\include\iot_secure_sockets.h" />
|
||||
<ClInclude Include="..\..\..\Source\FreeRTOS-Plus-IoT-SDK\abstractions\secure_sockets\include\iot_secure_sockets_config_defaults.h" />
|
||||
<ClInclude Include="..\..\..\Source\FreeRTOS-Plus-IoT-SDK\abstractions\secure_sockets\include\iot_secure_sockets_wrapper_metrics.h" />
|
||||
<ClInclude Include="..\..\..\Source\FreeRTOS-Plus-IoT-SDK\c_sdk\standard\common\include\iot_taskpool.h" />
|
||||
<ClInclude Include="..\..\..\Source\FreeRTOS-Plus-IoT-SDK\c_sdk\standard\common\include\private\iot_error.h" />
|
||||
<ClInclude Include="..\..\..\Source\FreeRTOS-Plus-IoT-SDK\c_sdk\standard\common\include\private\iot_lib_init.h" />
|
||||
<ClInclude Include="..\..\..\Source\FreeRTOS-Plus-IoT-SDK\c_sdk\standard\common\include\private\iot_logging.h" />
|
||||
<ClInclude Include="..\..\..\Source\FreeRTOS-Plus-IoT-SDK\c_sdk\standard\common\include\private\iot_static_memory.h" />
|
||||
<ClInclude Include="..\..\..\Source\FreeRTOS-Plus-IoT-SDK\c_sdk\standard\common\include\private\iot_taskpool_internal.h" />
|
||||
|
|
|
@ -78,9 +78,6 @@
|
|||
<Filter Include="FreeRTOS+\FreeRTOS IoT Libraries\abstractions\platform\freertos\include\platform">
|
||||
<UniqueIdentifier>{bdcbc1ec-99b8-4c72-9075-49035c115488}</UniqueIdentifier>
|
||||
</Filter>
|
||||
<Filter Include="FreeRTOS+\FreeRTOS IoT Libraries\abstractions\platform\freertos\include\platform\types">
|
||||
<UniqueIdentifier>{35ce7745-52a2-4220-be31-50dfaa35c0ab}</UniqueIdentifier>
|
||||
</Filter>
|
||||
<Filter Include="FreeRTOS+\FreeRTOS IoT Libraries\standard\mqtt">
|
||||
<UniqueIdentifier>{2d17d5e6-ed70-4e42-9693-f7a63baf4948}</UniqueIdentifier>
|
||||
</Filter>
|
||||
|
@ -96,6 +93,15 @@
|
|||
<Filter Include="FreeRTOS+\FreeRTOS IoT Libraries\standard\common\logging">
|
||||
<UniqueIdentifier>{1943ad1a-a367-4ef5-ab65-1313801e6327}</UniqueIdentifier>
|
||||
</Filter>
|
||||
<Filter Include="FreeRTOS+\FreeRTOS IoT Libraries\abstractions\secure_sockets">
|
||||
<UniqueIdentifier>{9a82e058-c6c5-4da5-817e-a28c5137749b}</UniqueIdentifier>
|
||||
</Filter>
|
||||
<Filter Include="FreeRTOS+\FreeRTOS IoT Libraries\abstractions\secure_sockets\include">
|
||||
<UniqueIdentifier>{cf6813fa-76cf-4e4d-86f7-18f1ae92ad44}</UniqueIdentifier>
|
||||
</Filter>
|
||||
<Filter Include="FreeRTOS+\FreeRTOS IoT Libraries\abstractions\secure_sockets\freertos_plus_tcp">
|
||||
<UniqueIdentifier>{79ebfd9f-45cb-4a3b-8c73-73f9d9fe7984}</UniqueIdentifier>
|
||||
</Filter>
|
||||
</ItemGroup>
|
||||
<ItemGroup>
|
||||
<ClCompile Include="..\..\..\..\FreeRTOS\Source\portable\MSVC-MingW\port.c">
|
||||
|
@ -160,9 +166,6 @@
|
|||
<ClCompile Include="..\..\..\Source\FreeRTOS-Plus-IoT-SDK\c_sdk\standard\common\taskpool\iot_taskpool.c">
|
||||
<Filter>FreeRTOS+\FreeRTOS IoT Libraries\standard\common\task_pool</Filter>
|
||||
</ClCompile>
|
||||
<ClCompile Include="DemoTasks\SimpleTaskPoolExamples.c">
|
||||
<Filter>DemoTasks</Filter>
|
||||
</ClCompile>
|
||||
<ClCompile Include="..\..\..\Source\FreeRTOS-Plus-IoT-SDK\c_sdk\standard\mqtt\src\iot_mqtt_api.c">
|
||||
<Filter>FreeRTOS+\FreeRTOS IoT Libraries\standard\mqtt\src</Filter>
|
||||
</ClCompile>
|
||||
|
@ -172,22 +175,31 @@
|
|||
<ClCompile Include="..\..\..\Source\FreeRTOS-Plus-IoT-SDK\c_sdk\standard\mqtt\src\iot_mqtt_serialize.c">
|
||||
<Filter>FreeRTOS+\FreeRTOS IoT Libraries\standard\mqtt\src</Filter>
|
||||
</ClCompile>
|
||||
<ClCompile Include="..\..\..\..\..\..\..\..\..\T\reviews\amazon-freertos-master\libraries\c_sdk\standard\mqtt\src\iot_mqtt_network.c">
|
||||
<Filter>FreeRTOS+\FreeRTOS IoT Libraries\standard\mqtt\src</Filter>
|
||||
</ClCompile>
|
||||
<ClCompile Include="..\..\..\..\..\..\..\..\..\T\reviews\amazon-freertos-master\libraries\c_sdk\standard\mqtt\src\iot_mqtt_subscription.c">
|
||||
<Filter>FreeRTOS+\FreeRTOS IoT Libraries\standard\mqtt\src</Filter>
|
||||
</ClCompile>
|
||||
<ClCompile Include="..\..\..\..\..\..\..\..\..\T\reviews\amazon-freertos-master\libraries\c_sdk\standard\mqtt\src\iot_mqtt_validate.c">
|
||||
<Filter>FreeRTOS+\FreeRTOS IoT Libraries\standard\mqtt\src</Filter>
|
||||
</ClCompile>
|
||||
<ClCompile Include="..\..\..\Source\FreeRTOS-Plus-IoT-SDK\c_sdk\standard\common\logging\iot_logging.c">
|
||||
<Filter>FreeRTOS+\FreeRTOS IoT Libraries\standard\common\logging</Filter>
|
||||
</ClCompile>
|
||||
<ClCompile Include="..\..\..\..\..\..\..\..\..\T\reviews\amazon-freertos-master\libraries\abstractions\platform\freertos\iot_threads_freertos.c">
|
||||
<ClCompile Include="..\..\..\Source\FreeRTOS-Plus-IoT-SDK\c_sdk\standard\mqtt\src\iot_mqtt_network.c">
|
||||
<Filter>FreeRTOS+\FreeRTOS IoT Libraries\standard\mqtt\src</Filter>
|
||||
</ClCompile>
|
||||
<ClCompile Include="..\..\..\Source\FreeRTOS-Plus-IoT-SDK\c_sdk\standard\mqtt\src\iot_mqtt_subscription.c">
|
||||
<Filter>FreeRTOS+\FreeRTOS IoT Libraries\standard\mqtt\src</Filter>
|
||||
</ClCompile>
|
||||
<ClCompile Include="..\..\..\Source\FreeRTOS-Plus-IoT-SDK\c_sdk\standard\mqtt\src\iot_mqtt_validate.c">
|
||||
<Filter>FreeRTOS+\FreeRTOS IoT Libraries\standard\mqtt\src</Filter>
|
||||
</ClCompile>
|
||||
<ClCompile Include="..\..\..\Source\FreeRTOS-Plus-IoT-SDK\abstractions\platform\freertos\iot_clock_freertos.c">
|
||||
<Filter>FreeRTOS+\FreeRTOS IoT Libraries\abstractions\platform\freertos</Filter>
|
||||
</ClCompile>
|
||||
<ClCompile Include="..\..\..\..\..\..\..\..\..\T\reviews\amazon-freertos-master\libraries\abstractions\platform\freertos\iot_clock_freertos.c">
|
||||
<ClCompile Include="..\..\..\Source\FreeRTOS-Plus-IoT-SDK\abstractions\platform\freertos\iot_threads_freertos.c">
|
||||
<Filter>FreeRTOS+\FreeRTOS IoT Libraries\abstractions\platform\freertos</Filter>
|
||||
</ClCompile>
|
||||
<ClCompile Include="..\..\..\Source\FreeRTOS-Plus-IoT-SDK\abstractions\secure_sockets\freertos_plus_tcp\iot_secure_sockets.c">
|
||||
<Filter>FreeRTOS+\FreeRTOS IoT Libraries\abstractions\secure_sockets\freertos_plus_tcp</Filter>
|
||||
</ClCompile>
|
||||
<ClCompile Include="DemoTasks\SimpleMQTTExamples.c">
|
||||
<Filter>DemoTasks</Filter>
|
||||
</ClCompile>
|
||||
<ClCompile Include="..\..\..\Source\FreeRTOS-Plus-IoT-SDK\abstractions\platform\freertos\iot_network_freertos.c">
|
||||
<Filter>FreeRTOS+\FreeRTOS IoT Libraries\abstractions\platform\freertos</Filter>
|
||||
</ClCompile>
|
||||
</ItemGroup>
|
||||
|
@ -283,9 +295,6 @@
|
|||
</ClInclude>
|
||||
<ClInclude Include="iot_config.h" />
|
||||
<ClInclude Include="iot_config_common.h" />
|
||||
<ClInclude Include="..\..\..\Source\FreeRTOS-Plus-IoT-SDK\abstractions\platform\freertos\include\platform\iot_platform_types_afr.h">
|
||||
<Filter>FreeRTOS+\FreeRTOS IoT Libraries\abstractions\platform\freertos\include\platform</Filter>
|
||||
</ClInclude>
|
||||
<ClInclude Include="..\..\..\Source\FreeRTOS-Plus-IoT-SDK\abstractions\platform\include\types\iot_platform_types.h">
|
||||
<Filter>FreeRTOS+\FreeRTOS IoT Libraries\abstractions\platform\include\types</Filter>
|
||||
</ClInclude>
|
||||
|
@ -307,5 +316,32 @@
|
|||
<ClInclude Include="..\..\..\Source\FreeRTOS-Plus-IoT-SDK\c_sdk\standard\mqtt\include\types\iot_mqtt_types.h">
|
||||
<Filter>FreeRTOS+\FreeRTOS IoT Libraries\standard\mqtt\include\types</Filter>
|
||||
</ClInclude>
|
||||
<ClInclude Include="..\..\..\Source\FreeRTOS-Plus-IoT-SDK\abstractions\platform\freertos\include\platform\iot_platform_types_freertos.h">
|
||||
<Filter>FreeRTOS+\FreeRTOS IoT Libraries\abstractions\platform\freertos\include\platform</Filter>
|
||||
</ClInclude>
|
||||
<ClInclude Include="..\..\..\Source\FreeRTOS-Plus-IoT-SDK\abstractions\platform\include\platform\iot_clock.h">
|
||||
<Filter>FreeRTOS+\FreeRTOS IoT Libraries\abstractions\platform\include\platform</Filter>
|
||||
</ClInclude>
|
||||
<ClInclude Include="..\..\..\Source\FreeRTOS-Plus-IoT-SDK\abstractions\platform\include\platform\iot_metrics.h">
|
||||
<Filter>FreeRTOS+\FreeRTOS IoT Libraries\abstractions\platform\include\platform</Filter>
|
||||
</ClInclude>
|
||||
<ClInclude Include="..\..\..\Source\FreeRTOS-Plus-IoT-SDK\abstractions\platform\include\platform\iot_network.h">
|
||||
<Filter>FreeRTOS+\FreeRTOS IoT Libraries\abstractions\platform\include\platform</Filter>
|
||||
</ClInclude>
|
||||
<ClInclude Include="..\..\..\Source\FreeRTOS-Plus-IoT-SDK\abstractions\platform\include\platform\iot_threads.h">
|
||||
<Filter>FreeRTOS+\FreeRTOS IoT Libraries\abstractions\platform\include\platform</Filter>
|
||||
</ClInclude>
|
||||
<ClInclude Include="..\..\..\Source\FreeRTOS-Plus-IoT-SDK\abstractions\secure_sockets\include\iot_secure_sockets.h">
|
||||
<Filter>FreeRTOS+\FreeRTOS IoT Libraries\abstractions\secure_sockets\include</Filter>
|
||||
</ClInclude>
|
||||
<ClInclude Include="..\..\..\Source\FreeRTOS-Plus-IoT-SDK\abstractions\secure_sockets\include\iot_secure_sockets_config_defaults.h">
|
||||
<Filter>FreeRTOS+\FreeRTOS IoT Libraries\abstractions\secure_sockets\include</Filter>
|
||||
</ClInclude>
|
||||
<ClInclude Include="..\..\..\Source\FreeRTOS-Plus-IoT-SDK\abstractions\secure_sockets\include\iot_secure_sockets_wrapper_metrics.h">
|
||||
<Filter>FreeRTOS+\FreeRTOS IoT Libraries\abstractions\secure_sockets\include</Filter>
|
||||
</ClInclude>
|
||||
<ClInclude Include="..\..\..\Source\FreeRTOS-Plus-IoT-SDK\c_sdk\standard\common\include\private\iot_lib_init.h">
|
||||
<Filter>FreeRTOS+\FreeRTOS IoT Libraries\standard\common\include\private</Filter>
|
||||
</ClInclude>
|
||||
</ItemGroup>
|
||||
</Project>
|
547
FreeRTOS-Plus/Demo/FreeRTOS_IoT_Libraries/mqtt/atomic.h
Normal file
547
FreeRTOS-Plus/Demo/FreeRTOS_IoT_Libraries/mqtt/atomic.h
Normal file
|
@ -0,0 +1,547 @@
|
|||
/*
|
||||
* FreeRTOS Kernel V10.2.0
|
||||
* Copyright (C) 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||
* this software and associated documentation files (the "Software"), to deal in
|
||||
* the Software without restriction, including without limitation the rights to
|
||||
* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
||||
* the Software, and to permit persons to whom the Software is furnished to do so,
|
||||
* subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in all
|
||||
* copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
||||
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
||||
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
||||
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
||||
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
*
|
||||
* http://www.FreeRTOS.org
|
||||
* http://aws.amazon.com/freertos
|
||||
*
|
||||
* 1 tab == 4 spaces!
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file atomic.h
|
||||
* @brief FreeRTOS atomic operation support.
|
||||
*
|
||||
* Two implementations of atomic are given in this header file:
|
||||
* 1. Disabling interrupt globally.
|
||||
* 2. ISA native atomic support.
|
||||
* The former is available to all ports (compiler-architecture combination),
|
||||
* while the latter is only available to ports compiling with GCC (version at
|
||||
* least 4.7.0), which also have ISA atomic support.
|
||||
*
|
||||
* User can select which implementation to use by:
|
||||
* setting/clearing configUSE_ATOMIC_INSTRUCTION in FreeRTOSConfig.h.
|
||||
* Define AND set configUSE_ATOMIC_INSTRUCTION to 1 for ISA native atomic support.
|
||||
* Undefine OR clear configUSE_ATOMIC_INSTRUCTION for disabling global interrupt
|
||||
* implementation.
|
||||
*
|
||||
* @see GCC Built-in Functions for Memory Model Aware Atomic Operations
|
||||
* https://gcc.gnu.org/onlinedocs/gcc/_005f_005fatomic-Builtins.html
|
||||
*/
|
||||
|
||||
#ifndef ATOMIC_H
|
||||
#define ATOMIC_H
|
||||
|
||||
#ifndef INC_FREERTOS_H
|
||||
#error "include FreeRTOS.h must appear in source files before include atomic.h"
|
||||
#endif
|
||||
|
||||
/* Standard includes. */
|
||||
#include <stdint.h>
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
#if defined ( configUSE_GCC_BUILTIN_ATOMICS ) && ( configUSE_GCC_BUILTIN_ATOMICS == 1 )
|
||||
|
||||
/* Needed for __atomic_compare_exchange() weak=false. */
|
||||
#include <stdbool.h>
|
||||
|
||||
/* This branch is for GCC compiler and GCC compiler only. */
|
||||
#ifndef portFORCE_INLINE
|
||||
#define portFORCE_INLINE inline __attribute__((always_inline))
|
||||
#endif
|
||||
|
||||
#else
|
||||
|
||||
/* Port specific definitions -- entering/exiting critical section.
|
||||
* Refer template -- ./lib/FreeRTOS/portable/Compiler/Arch/portmacro.h
|
||||
*
|
||||
* Every call to ATOMIC_EXIT_CRITICAL() must be closely paired with
|
||||
* ATOMIC_ENTER_CRITICAL().
|
||||
*/
|
||||
#if defined( portSET_INTERRUPT_MASK_FROM_ISR )
|
||||
|
||||
/* Nested interrupt scheme is supported in this port. */
|
||||
#define ATOMIC_ENTER_CRITICAL() \
|
||||
UBaseType_t uxCriticalSectionType = portSET_INTERRUPT_MASK_FROM_ISR()
|
||||
|
||||
#define ATOMIC_EXIT_CRITICAL() \
|
||||
portCLEAR_INTERRUPT_MASK_FROM_ISR( uxCriticalSectionType )
|
||||
|
||||
#else
|
||||
|
||||
/* Nested interrupt scheme is NOT supported in this port. */
|
||||
#define ATOMIC_ENTER_CRITICAL() portENTER_CRITICAL()
|
||||
#define ATOMIC_EXIT_CRITICAL() portEXIT_CRITICAL()
|
||||
|
||||
#endif /* portSET_INTERRUPT_MASK_FROM_ISR() */
|
||||
|
||||
/* Port specific definition -- "always inline".
|
||||
* Inline is compiler specific, and may not always get inlined depending on your optimization level.
|
||||
* Also, inline is considerred as performance optimization for atomic.
|
||||
* Thus, if portFORCE_INLINE is not provided by portmacro.h, instead of resulting error,
|
||||
* simply define it.
|
||||
*/
|
||||
#ifndef portFORCE_INLINE
|
||||
#define portFORCE_INLINE
|
||||
#endif
|
||||
|
||||
#endif /* configUSE_GCC_BUILTIN_ATOMICS */
|
||||
|
||||
#define ATOMIC_COMPARE_AND_SWAP_SUCCESS 0x1U /**< Compare and swap succeeded, swapped. */
|
||||
#define ATOMIC_COMPARE_AND_SWAP_FAILURE 0x0U /**< Compare and swap failed, did not swap. */
|
||||
|
||||
/*----------------------------- Swap && CAS ------------------------------*/
|
||||
|
||||
/**
|
||||
* Atomic compare-and-swap
|
||||
*
|
||||
* @brief Performs an atomic compare-and-swap operation on the specified values.
|
||||
*
|
||||
* @param[in, out] pDestination Pointer to memory location from where value is
|
||||
* to be loaded and checked.
|
||||
* @param[in] ulExchange If condition meets, write this value to memory.
|
||||
* @param[in] ulComparand Swap condition.
|
||||
*
|
||||
* @return Unsigned integer of value 1 or 0. 1 for swapped, 0 for not swapped.
|
||||
*
|
||||
* @note This function only swaps *pDestination with ulExchange, if previous
|
||||
* *pDestination value equals ulComparand.
|
||||
*/
|
||||
static portFORCE_INLINE uint32_t Atomic_CompareAndSwap_u32(
|
||||
uint32_t volatile * pDestination,
|
||||
uint32_t ulExchange,
|
||||
uint32_t ulComparand )
|
||||
{
|
||||
|
||||
uint32_t ulReturnValue = ATOMIC_COMPARE_AND_SWAP_FAILURE;
|
||||
|
||||
#if defined ( configUSE_GCC_BUILTIN_ATOMICS ) && ( configUSE_GCC_BUILTIN_ATOMICS == 1 )
|
||||
|
||||
if ( __atomic_compare_exchange( pDestination,
|
||||
&ulComparand,
|
||||
&ulExchange,
|
||||
false,
|
||||
__ATOMIC_SEQ_CST,
|
||||
__ATOMIC_SEQ_CST ) )
|
||||
{
|
||||
ulReturnValue = ATOMIC_COMPARE_AND_SWAP_SUCCESS;
|
||||
}
|
||||
|
||||
#else
|
||||
|
||||
ATOMIC_ENTER_CRITICAL();
|
||||
|
||||
if ( *pDestination == ulComparand )
|
||||
{
|
||||
*pDestination = ulExchange;
|
||||
ulReturnValue = ATOMIC_COMPARE_AND_SWAP_SUCCESS;
|
||||
}
|
||||
|
||||
ATOMIC_EXIT_CRITICAL();
|
||||
|
||||
#endif
|
||||
|
||||
return ulReturnValue;
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* Atomic swap (pointers)
|
||||
*
|
||||
* @brief Atomically sets the address pointed to by *ppDestination to the value
|
||||
* of *pExchange.
|
||||
*
|
||||
* @param[in, out] ppDestination Pointer to memory location from where a pointer
|
||||
* value is to be loaded and written back to.
|
||||
* @param[in] pExchange Pointer value to be written to *ppDestination.
|
||||
*
|
||||
* @return The initial value of *ppDestination.
|
||||
*/
|
||||
static portFORCE_INLINE void * Atomic_SwapPointers_p32(
|
||||
void * volatile * ppDestination,
|
||||
void * pExchange )
|
||||
{
|
||||
void * pReturnValue;
|
||||
|
||||
#if defined ( configUSE_GCC_BUILTIN_ATOMICS ) && ( configUSE_GCC_BUILTIN_ATOMICS == 1 )
|
||||
|
||||
__atomic_exchange( ppDestination, &pExchange, &pReturnValue, __ATOMIC_SEQ_CST );
|
||||
|
||||
#else
|
||||
|
||||
ATOMIC_ENTER_CRITICAL();
|
||||
|
||||
pReturnValue = *ppDestination;
|
||||
|
||||
*ppDestination = pExchange;
|
||||
|
||||
ATOMIC_EXIT_CRITICAL();
|
||||
|
||||
#endif
|
||||
|
||||
return pReturnValue;
|
||||
}
|
||||
|
||||
/**
|
||||
* Atomic compare-and-swap (pointers)
|
||||
*
|
||||
* @brief Performs an atomic compare-and-swap operation on the specified pointer
|
||||
* values.
|
||||
*
|
||||
* @param[in, out] ppDestination Pointer to memory location from where a pointer
|
||||
* value is to be loaded and checked.
|
||||
* @param[in] pExchange If condition meets, write this value to memory.
|
||||
* @param[in] pComparand Swap condition.
|
||||
*
|
||||
* @return Unsigned integer of value 1 or 0. 1 for swapped, 0 for not swapped.
|
||||
*
|
||||
* @note This function only swaps *ppDestination with pExchange, if previous
|
||||
* *ppDestination value equals pComparand.
|
||||
*/
|
||||
static portFORCE_INLINE uint32_t Atomic_CompareAndSwapPointers_p32(
|
||||
void * volatile * ppDestination,
|
||||
void * pExchange, void * pComparand )
|
||||
{
|
||||
uint32_t ulReturnValue = ATOMIC_COMPARE_AND_SWAP_FAILURE;
|
||||
|
||||
#if defined ( configUSE_GCC_BUILTIN_ATOMICS ) && ( configUSE_GCC_BUILTIN_ATOMICS == 1 )
|
||||
if ( __atomic_compare_exchange( ppDestination,
|
||||
&pComparand,
|
||||
&pExchange,
|
||||
false,
|
||||
__ATOMIC_SEQ_CST,
|
||||
__ATOMIC_SEQ_CST ) )
|
||||
{
|
||||
ulReturnValue = ATOMIC_COMPARE_AND_SWAP_SUCCESS;
|
||||
}
|
||||
|
||||
#else
|
||||
|
||||
ATOMIC_ENTER_CRITICAL();
|
||||
|
||||
if ( *ppDestination == pComparand )
|
||||
{
|
||||
*ppDestination = pExchange;
|
||||
ulReturnValue = ATOMIC_COMPARE_AND_SWAP_SUCCESS;
|
||||
}
|
||||
|
||||
ATOMIC_EXIT_CRITICAL();
|
||||
|
||||
#endif
|
||||
|
||||
return ulReturnValue;
|
||||
}
|
||||
|
||||
|
||||
/*----------------------------- Arithmetic ------------------------------*/
|
||||
|
||||
/**
|
||||
* Atomic add
|
||||
*
|
||||
* @brief Atomically adds count to the value of the specified pointer points to.
|
||||
*
|
||||
* @param[in,out] pAddend Pointer to memory location from where value is to be
|
||||
* loaded and written back to.
|
||||
* @param[in] ulCount Value to be added to *pAddend.
|
||||
*
|
||||
* @return previous *pAddend value.
|
||||
*/
|
||||
static portFORCE_INLINE uint32_t Atomic_Add_u32(
|
||||
uint32_t volatile * pAddend,
|
||||
uint32_t ulCount )
|
||||
{
|
||||
#if defined ( configUSE_GCC_BUILTIN_ATOMICS ) && ( configUSE_GCC_BUILTIN_ATOMICS == 1 )
|
||||
|
||||
return __atomic_fetch_add(pAddend, ulCount, __ATOMIC_SEQ_CST);
|
||||
|
||||
#else
|
||||
|
||||
uint32_t ulCurrent;
|
||||
|
||||
ATOMIC_ENTER_CRITICAL();
|
||||
|
||||
ulCurrent = *pAddend;
|
||||
|
||||
*pAddend += ulCount;
|
||||
|
||||
ATOMIC_EXIT_CRITICAL();
|
||||
|
||||
return ulCurrent;
|
||||
|
||||
#endif
|
||||
}
|
||||
|
||||
/**
|
||||
* Atomic subtract
|
||||
*
|
||||
* @brief Atomically subtracts count from the value of the specified pointer
|
||||
* pointers to.
|
||||
*
|
||||
* @param[in,out] pAddend Pointer to memory location from where value is to be
|
||||
* loaded and written back to.
|
||||
* @param[in] ulCount Value to be subtract from *pAddend.
|
||||
*
|
||||
* @return previous *pAddend value.
|
||||
*/
|
||||
static portFORCE_INLINE uint32_t Atomic_Subtract_u32(
|
||||
uint32_t volatile * pAddend,
|
||||
uint32_t ulCount )
|
||||
{
|
||||
#if defined ( configUSE_GCC_BUILTIN_ATOMICS ) && ( configUSE_GCC_BUILTIN_ATOMICS == 1 )
|
||||
|
||||
return __atomic_fetch_sub(pAddend, ulCount, __ATOMIC_SEQ_CST);
|
||||
|
||||
#else
|
||||
|
||||
uint32_t ulCurrent;
|
||||
|
||||
ATOMIC_ENTER_CRITICAL();
|
||||
|
||||
ulCurrent = *pAddend;
|
||||
|
||||
*pAddend -= ulCount;
|
||||
|
||||
ATOMIC_EXIT_CRITICAL();
|
||||
|
||||
return ulCurrent;
|
||||
|
||||
#endif
|
||||
}
|
||||
|
||||
/**
|
||||
* Atomic increment
|
||||
*
|
||||
* @brief Atomically increments the value of the specified pointer points to.
|
||||
*
|
||||
* @param[in,out] pAddend Pointer to memory location from where value is to be
|
||||
* loaded and written back to.
|
||||
*
|
||||
* @return *pAddend value before increment.
|
||||
*/
|
||||
static portFORCE_INLINE uint32_t Atomic_Increment_u32( uint32_t volatile * pAddend )
|
||||
{
|
||||
#if defined ( configUSE_GCC_BUILTIN_ATOMICS ) && ( configUSE_GCC_BUILTIN_ATOMICS == 1 )
|
||||
|
||||
return __atomic_fetch_add(pAddend, 1, __ATOMIC_SEQ_CST);
|
||||
|
||||
#else
|
||||
|
||||
uint32_t ulCurrent;
|
||||
|
||||
ATOMIC_ENTER_CRITICAL();
|
||||
|
||||
ulCurrent = *pAddend;
|
||||
|
||||
*pAddend += 1;
|
||||
|
||||
ATOMIC_EXIT_CRITICAL();
|
||||
|
||||
return ulCurrent;
|
||||
|
||||
#endif
|
||||
}
|
||||
|
||||
/**
|
||||
* Atomic decrement
|
||||
*
|
||||
* @brief Atomically decrements the value of the specified pointer points to
|
||||
*
|
||||
* @param[in,out] pAddend Pointer to memory location from where value is to be
|
||||
* loaded and written back to.
|
||||
*
|
||||
* @return *pAddend value before decrement.
|
||||
*/
|
||||
static portFORCE_INLINE uint32_t Atomic_Decrement_u32( uint32_t volatile * pAddend )
|
||||
{
|
||||
#if defined ( configUSE_GCC_BUILTIN_ATOMICS ) && ( configUSE_GCC_BUILTIN_ATOMICS == 1 )
|
||||
|
||||
return __atomic_fetch_sub(pAddend, 1, __ATOMIC_SEQ_CST);
|
||||
|
||||
#else
|
||||
|
||||
uint32_t ulCurrent;
|
||||
|
||||
ATOMIC_ENTER_CRITICAL();
|
||||
|
||||
ulCurrent = *pAddend;
|
||||
|
||||
*pAddend -= 1;
|
||||
|
||||
ATOMIC_EXIT_CRITICAL();
|
||||
|
||||
return ulCurrent;
|
||||
|
||||
#endif
|
||||
}
|
||||
|
||||
/*----------------------------- Bitwise Logical ------------------------------*/
|
||||
|
||||
/**
|
||||
* Atomic OR
|
||||
*
|
||||
* @brief Performs an atomic OR operation on the specified values.
|
||||
*
|
||||
* @param [in, out] pDestination Pointer to memory location from where value is
|
||||
* to be loaded and written back to.
|
||||
* @param [in] ulValue Value to be ORed with *pDestination.
|
||||
*
|
||||
* @return The original value of *pDestination.
|
||||
*/
|
||||
static portFORCE_INLINE uint32_t Atomic_OR_u32(
|
||||
uint32_t volatile * pDestination,
|
||||
uint32_t ulValue )
|
||||
{
|
||||
#if defined ( configUSE_GCC_BUILTIN_ATOMICS ) && ( configUSE_GCC_BUILTIN_ATOMICS == 1 )
|
||||
|
||||
return __atomic_fetch_or(pDestination, ulValue, __ATOMIC_SEQ_CST);
|
||||
|
||||
#else
|
||||
|
||||
uint32_t ulCurrent;
|
||||
|
||||
ATOMIC_ENTER_CRITICAL();
|
||||
|
||||
ulCurrent = *pDestination;
|
||||
|
||||
*pDestination |= ulValue;
|
||||
|
||||
ATOMIC_EXIT_CRITICAL();
|
||||
|
||||
return ulCurrent;
|
||||
|
||||
#endif
|
||||
}
|
||||
|
||||
/**
|
||||
* Atomic AND
|
||||
*
|
||||
* @brief Performs an atomic AND operation on the specified values.
|
||||
*
|
||||
* @param [in, out] pDestination Pointer to memory location from where value is
|
||||
* to be loaded and written back to.
|
||||
* @param [in] ulValue Value to be ANDed with *pDestination.
|
||||
*
|
||||
* @return The original value of *pDestination.
|
||||
*/
|
||||
static portFORCE_INLINE uint32_t Atomic_AND_u32(
|
||||
uint32_t volatile * pDestination,
|
||||
uint32_t ulValue )
|
||||
{
|
||||
#if defined ( configUSE_GCC_BUILTIN_ATOMICS ) && ( configUSE_GCC_BUILTIN_ATOMICS == 1 )
|
||||
|
||||
return __atomic_fetch_and(pDestination, ulValue, __ATOMIC_SEQ_CST);
|
||||
|
||||
#else
|
||||
|
||||
uint32_t ulCurrent;
|
||||
|
||||
ATOMIC_ENTER_CRITICAL();
|
||||
|
||||
ulCurrent = *pDestination;
|
||||
|
||||
*pDestination &= ulValue;
|
||||
|
||||
ATOMIC_EXIT_CRITICAL();
|
||||
|
||||
return ulCurrent;
|
||||
|
||||
#endif
|
||||
}
|
||||
|
||||
/**
|
||||
* Atomic NAND
|
||||
*
|
||||
* @brief Performs an atomic NAND operation on the specified values.
|
||||
*
|
||||
* @param [in, out] pDestination Pointer to memory location from where value is
|
||||
* to be loaded and written back to.
|
||||
* @param [in] ulValue Value to be NANDed with *pDestination.
|
||||
*
|
||||
* @return The original value of *pDestination.
|
||||
*/
|
||||
static portFORCE_INLINE uint32_t Atomic_NAND_u32(
|
||||
uint32_t volatile * pDestination,
|
||||
uint32_t ulValue )
|
||||
{
|
||||
#if defined ( configUSE_GCC_BUILTIN_ATOMICS ) && ( configUSE_GCC_BUILTIN_ATOMICS == 1 )
|
||||
|
||||
return __atomic_fetch_nand(pDestination, ulValue, __ATOMIC_SEQ_CST);
|
||||
|
||||
#else
|
||||
|
||||
uint32_t ulCurrent;
|
||||
|
||||
ATOMIC_ENTER_CRITICAL();
|
||||
|
||||
ulCurrent = *pDestination;
|
||||
|
||||
*pDestination = ~(ulCurrent & ulValue);
|
||||
|
||||
ATOMIC_EXIT_CRITICAL();
|
||||
|
||||
return ulCurrent;
|
||||
|
||||
#endif
|
||||
}
|
||||
|
||||
/**
|
||||
* Atomic XOR
|
||||
*
|
||||
* @brief Performs an atomic XOR operation on the specified values.
|
||||
*
|
||||
* @param [in, out] pDestination Pointer to memory location from where value is
|
||||
* to be loaded and written back to.
|
||||
* @param [in] ulValue Value to be XORed with *pDestination.
|
||||
*
|
||||
* @return The original value of *pDestination.
|
||||
*/
|
||||
static portFORCE_INLINE uint32_t Atomic_XOR_u32(
|
||||
uint32_t volatile * pDestination,
|
||||
uint32_t ulValue )
|
||||
{
|
||||
#if defined ( configUSE_GCC_BUILTIN_ATOMICS ) && ( configUSE_GCC_BUILTIN_ATOMICS == 1 )
|
||||
|
||||
return __atomic_fetch_xor(pDestination, ulValue, __ATOMIC_SEQ_CST);
|
||||
|
||||
#else
|
||||
|
||||
uint32_t ulCurrent;
|
||||
|
||||
ATOMIC_ENTER_CRITICAL();
|
||||
|
||||
ulCurrent = *pDestination;
|
||||
|
||||
*pDestination ^= ulValue;
|
||||
|
||||
ATOMIC_EXIT_CRITICAL();
|
||||
|
||||
return ulCurrent;
|
||||
|
||||
#endif
|
||||
}
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
#endif /* ATOMIC_H */
|
|
@ -0,0 +1,56 @@
|
|||
/*
|
||||
* Amazon FreeRTOS V1.4.7
|
||||
* Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||
* this software and associated documentation files (the "Software"), to deal in
|
||||
* the Software without restriction, including without limitation the rights to
|
||||
* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
||||
* the Software, and to permit persons to whom the Software is furnished to do so,
|
||||
* subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in all
|
||||
* copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
||||
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
||||
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
||||
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
||||
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
*
|
||||
* http://aws.amazon.com/freertos
|
||||
* http://www.FreeRTOS.org
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file aws_secure_sockets_config.h
|
||||
* @brief Secure sockets configuration options.
|
||||
*/
|
||||
|
||||
#ifndef _AWS_SECURE_SOCKETS_CONFIG_H_
|
||||
#define _AWS_SECURE_SOCKETS_CONFIG_H_
|
||||
|
||||
/**
|
||||
* @brief Byte order of the target MCU.
|
||||
*
|
||||
* Valid values are pdLITTLE_ENDIAN and pdBIG_ENDIAN.
|
||||
*/
|
||||
#define socketsconfigBYTE_ORDER pdLITTLE_ENDIAN
|
||||
|
||||
/**
|
||||
* @brief Default socket send timeout.
|
||||
*/
|
||||
#define socketsconfigDEFAULT_SEND_TIMEOUT ( 10000 )
|
||||
|
||||
/**
|
||||
* @brief Default socket receive timeout.
|
||||
*/
|
||||
#define socketsconfigDEFAULT_RECV_TIMEOUT ( 10000 )
|
||||
|
||||
/**
|
||||
* @brief Enable metrics of secure socket.
|
||||
*/
|
||||
#define AWS_IOT_SECURE_SOCKETS_METRICS_ENABLED ( 0 )
|
||||
|
||||
#endif /* _AWS_SECURE_SOCKETS_CONFIG_H_ */
|
Loading…
Add table
Add a link
Reference in a new issue