1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
|
/*
* FreeRTOS V202107.00
* Copyright (C) 2020 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.
*
* https://www.FreeRTOS.org
* https://github.com/FreeRTOS
*
*/
/**
* @file freertos_command_pool.c
* @brief Implements functions to obtain and release commands.
*/
/* Standard includes. */
#include <string.h>
#include <stdio.h>
/* Kernel includes. */
#include "FreeRTOS.h"
#include "semphr.h"
/* Header include. */
#include "freertos_command_pool.h"
#include "freertos_agent_message.h"
/*-----------------------------------------------------------*/
#define QUEUE_NOT_INITIALIZED ( 0U )
#define QUEUE_INITIALIZED ( 1U )
/**
* @brief The pool of command structures used to hold information on commands (such
* as PUBLISH or SUBSCRIBE) between the command being created by an API call and
* completion of the command by the execution of the command's callback.
*/
static MQTTAgentCommand_t commandStructurePool[ MQTT_COMMAND_CONTEXTS_POOL_SIZE ];
/**
* @brief The message context used to guard the pool of MQTTAgentCommand_t structures.
* For FreeRTOS, this is implemented with a queue. Structures may be
* obtained by receiving a pointer from the queue, and returned by
* sending the pointer back into it.
*/
static MQTTAgentMessageContext_t commandStructMessageCtx;
/**
* @brief Initialization status of the queue.
*/
static volatile uint8_t initStatus = QUEUE_NOT_INITIALIZED;
/*-----------------------------------------------------------*/
void Agent_InitializePool( void )
{
size_t i;
MQTTAgentCommand_t * pCommand;
static uint8_t staticQueueStorageArea[ MQTT_COMMAND_CONTEXTS_POOL_SIZE * sizeof( MQTTAgentCommand_t * ) ];
static StaticQueue_t staticQueueStructure;
bool commandAdded = false;
if( initStatus == QUEUE_NOT_INITIALIZED )
{
memset( ( void * ) commandStructurePool, 0x00, sizeof( commandStructurePool ) );
commandStructMessageCtx.queue = xQueueCreateStatic( MQTT_COMMAND_CONTEXTS_POOL_SIZE,
sizeof( MQTTAgentCommand_t * ),
staticQueueStorageArea,
&staticQueueStructure );
configASSERT( commandStructMessageCtx.queue );
/* Populate the queue. */
for( i = 0; i < MQTT_COMMAND_CONTEXTS_POOL_SIZE; i++ )
{
/* Store the address as a variable. */
pCommand = &commandStructurePool[ i ];
/* Send the pointer to the queue. */
commandAdded = Agent_MessageSend( &commandStructMessageCtx, &pCommand, 0U );
configASSERT( commandAdded );
}
initStatus = QUEUE_INITIALIZED;
}
}
/*-----------------------------------------------------------*/
MQTTAgentCommand_t * Agent_GetCommand( uint32_t blockTimeMs )
{
MQTTAgentCommand_t * structToUse = NULL;
bool structRetrieved = false;
/* Check queue has been created. */
configASSERT( initStatus == QUEUE_INITIALIZED );
/* Retrieve a struct from the queue. */
structRetrieved = Agent_MessageReceive( &commandStructMessageCtx, &( structToUse ), blockTimeMs );
if( !structRetrieved )
{
LogError( ( "No command structure available." ) );
}
return structToUse;
}
/*-----------------------------------------------------------*/
bool Agent_ReleaseCommand( MQTTAgentCommand_t * pCommandToRelease )
{
bool structReturned = false;
configASSERT( initStatus == QUEUE_INITIALIZED );
/* See if the structure being returned is actually from the pool. */
if( ( pCommandToRelease >= commandStructurePool ) &&
( pCommandToRelease < ( commandStructurePool + MQTT_COMMAND_CONTEXTS_POOL_SIZE ) ) )
{
structReturned = Agent_MessageSend( &commandStructMessageCtx, &pCommandToRelease, 0U );
/* The send should not fail as the queue was created to hold every command
* in the pool. */
configASSERT( structReturned );
LogDebug( ( "Returned Command Context %d to pool",
( int ) ( pCommandToRelease - commandStructurePool ) ) );
}
return structReturned;
}
|
