AWS IoT Over-the-air Update v3.0.0
Client library for AWS IoT OTA
ota_os_interface.h
Go to the documentation of this file.
1/*
2 * AWS IoT Over-the-air Update v3.0.0
3 * Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
4 *
5 * Permission is hereby granted, free of charge, to any person obtaining a copy of
6 * this software and associated documentation files (the "Software"), to deal in
7 * the Software without restriction, including without limitation the rights to
8 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
9 * the Software, and to permit persons to whom the Software is furnished to do so,
10 * subject to the following conditions:
11 *
12 * The above copyright notice and this permission notice shall be included in all
13 * copies or substantial portions of the Software.
14 *
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
17 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
18 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
19 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
20 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
21 */
22
29#ifndef OTA_OS_INTERFACE_H
30#define OTA_OS_INTERFACE_H
31
32
71struct OtaEventContext;
72
76typedef struct OtaEventContext OtaEventContext_t;
77
81typedef enum
82{
83 OtaRequestTimer = 0,
84 OtaSelfTestTimer,
85 OtaNumOfTimers
87
92typedef enum OtaOsStatus
93{
105
116typedef OtaOsStatus_t ( * OtaInitEvent_t ) ( OtaEventContext_t * pEventCtx );
117
133 const void * pEventMsg,
134 unsigned int timeout );
135
151 void * pEventMsg,
152 uint32_t timeout );
153
166
177typedef void ( * OtaTimerCallback_t )( OtaTimerId_t otaTimerId );
178
195typedef OtaOsStatus_t ( * OtaStartTimer_t ) ( OtaTimerId_t otaTimerId,
196 const char * const pTimerName,
197 const uint32_t timeout,
198 OtaTimerCallback_t callback );
199
210typedef OtaOsStatus_t ( * OtaStopTimer_t ) ( OtaTimerId_t otaTimerId );
211
222typedef OtaOsStatus_t ( * OtaDeleteTimer_t ) ( OtaTimerId_t otaTimerId );
223
235typedef void * ( * OtaMalloc_t ) ( size_t size );
236
249typedef void ( * OtaFree_t ) ( void * ptr );
250
255typedef struct OtaEventInterface
256{
263
268typedef struct OtaTimerInterface
269{
274
279typedef struct OtaMallocInterface
280{
281 /* MISRA rule 21.3 prohibits the use of malloc and free from stdlib.h, however, we're only
282 * defining the interface here. On FreeRTOS this is implemented with pvPortMalloc and vPortFree,
283 * and on Linux it's implemented with standard C malloc and free. This is a false positive. */
284 /* coverity[misra_c_2012_rule_21_3_violation] */
286 /* coverity[misra_c_2012_rule_21_3_violation] */
289
294typedef struct OtaOSInterface
295{
300
301#endif /* ifndef OTA_OS_INTERFACE_H */
OtaOsStatus_t
The OTA OS interface return status.
Definition: ota_os_interface.h:93
@ OtaOsEventQueueSendFailed
Posting event message to the event queue failed.
Definition: ota_os_interface.h:96
@ OtaOsTimerDeleteFailed
Failed to delete the timer.
Definition: ota_os_interface.h:103
@ OtaOsTimerCreateFailed
Failed to create the timer.
Definition: ota_os_interface.h:99
@ OtaOsEventQueueReceiveFailed
Failed to receive from the event queue.
Definition: ota_os_interface.h:97
@ OtaOsTimerStopFailed
Failed to stop the timer.
Definition: ota_os_interface.h:102
@ OtaOsEventQueueCreateFailed
Failed to create the event queue.
Definition: ota_os_interface.h:95
@ OtaOsTimerRestartFailed
Failed to restart the timer.
Definition: ota_os_interface.h:101
@ OtaOsSuccess
OTA OS interface success.
Definition: ota_os_interface.h:94
@ OtaOsTimerStartFailed
Failed to create the timer.
Definition: ota_os_interface.h:100
@ OtaOsEventQueueDeleteFailed
Failed to delete the event queue.
Definition: ota_os_interface.h:98
void(* OtaFree_t)(void *ptr)
Free memory.
Definition: ota_os_interface.h:249
OtaOsStatus_t(* OtaDeleteTimer_t)(OtaTimerId_t otaTimerId)
Delete a timer.
Definition: ota_os_interface.h:222
OtaOsStatus_t(* OtaStartTimer_t)(OtaTimerId_t otaTimerId, const char *const pTimerName, const uint32_t timeout, OtaTimerCallback_t callback)
Start timer.
Definition: ota_os_interface.h:195
struct OtaEventContext OtaEventContext_t
Type definition for Event Context.
Definition: ota_os_interface.h:76
void(* OtaTimerCallback_t)(OtaTimerId_t otaTimerId)
Timer callback.
Definition: ota_os_interface.h:177
void *(* OtaMalloc_t)(size_t size)
Allocate memory.
Definition: ota_os_interface.h:235
OtaOsStatus_t(* OtaDeinitEvent_t)(OtaEventContext_t *pEventCtx)
Deinitialize the OTA Events mechanism.
Definition: ota_os_interface.h:165
OtaOsStatus_t(* OtaSendEvent_t)(OtaEventContext_t *pEventCtx, const void *pEventMsg, unsigned int timeout)
Sends an OTA event.
Definition: ota_os_interface.h:132
OtaOsStatus_t(* OtaInitEvent_t)(OtaEventContext_t *pEventCtx)
Initialize the OTA events.
Definition: ota_os_interface.h:116
OtaOsStatus_t(* OtaReceiveEvent_t)(OtaEventContext_t *pEventCtx, void *pEventMsg, uint32_t timeout)
Receive an OTA event.
Definition: ota_os_interface.h:150
OtaOsStatus_t(* OtaStopTimer_t)(OtaTimerId_t otaTimerId)
Stop timer.
Definition: ota_os_interface.h:210
OtaTimerId_t
Enumeration for tracking multiple timers.
Definition: ota_os_interface.h:82
Definition: ota_os_interface.h:256
OtaSendEvent_t send
Send data.
Definition: ota_os_interface.h:258
OtaDeinitEvent_t deinit
Deinitialize event.
Definition: ota_os_interface.h:260
OtaEventContext_t * pEventContext
Event context to store event information.
Definition: ota_os_interface.h:261
OtaInitEvent_t init
Initialization event.
Definition: ota_os_interface.h:257
OtaReceiveEvent_t recv
Receive data.
Definition: ota_os_interface.h:259
OTA memory allocation interface.
Definition: ota_os_interface.h:280
OtaFree_t free
OTA memory deallocate interface.
Definition: ota_os_interface.h:287
OtaMalloc_t malloc
OTA memory allocate interface.
Definition: ota_os_interface.h:285
OTA OS Interface.
Definition: ota_os_interface.h:295
OtaMallocInterface_t mem
OTA memory interface.
Definition: ota_os_interface.h:298
OtaEventInterface_t event
OTA Event interface.
Definition: ota_os_interface.h:296
OtaTimerInterface_t timer
OTA Timer interface.
Definition: ota_os_interface.h:297
OTA Retry Timer Interface.
Definition: ota_os_interface.h:269
OtaStartTimer_t start
Timer start state.
Definition: ota_os_interface.h:270
OtaStopTimer_t stop
Timer stop state.
Definition: ota_os_interface.h:271