FreeRTOS: FreeRTOS Cellular Library v1.4.0
FreeRTOS Cellular Library
 
Loading...
Searching...
No Matches
cellular_pkthandler_internal.h
1/*
2 * FreeRTOS-Cellular-Interface v1.4.0
3 * Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
4 *
5 * SPDX-License-Identifier: MIT
6 *
7 * Permission is hereby granted, free of charge, to any person obtaining a copy of
8 * this software and associated documentation files (the "Software"), to deal in
9 * the Software without restriction, including without limitation the rights to
10 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
11 * the Software, and to permit persons to whom the Software is furnished to do so,
12 * subject to the following conditions:
13 *
14 * The above copyright notice and this permission notice shall be included in all
15 * copies or substantial portions of the Software.
16 *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
19 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
20 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
21 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
22 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23 *
24 * https://www.FreeRTOS.org
25 * https://github.com/FreeRTOS
26 */
27
28#ifndef __CELLULAR_PKTHANDLER_INTERNAL_H__
29#define __CELLULAR_PKTHANDLER_INTERNAL_H__
30
31/* *INDENT-OFF* */
32#ifdef __cplusplus
33 extern "C" {
34#endif
35/* *INDENT-ON* */
36
37#ifndef CELLULAR_DO_NOT_USE_CUSTOM_CONFIG
38 /* Include custom config file before other headers. */
39 #include "cellular_config.h"
40#endif
42#include "cellular_types.h"
43#include "cellular_common.h"
44#include "cellular_pktio_internal.h"
45
46/*-----------------------------------------------------------*/
47
48/* AT Command timeout for general AT commands. */
49#define PACKET_REQ_TIMEOUT_MS CELLULAR_COMMON_AT_COMMAND_TIMEOUT_MS
50
51/*-----------------------------------------------------------*/
52
60bool _Cellular_CreatePktRequestMutex( CellularContext_t * pContext );
61
69void _Cellular_DestroyPktRequestMutex( CellularContext_t * pContext );
70
78bool _Cellular_CreatePktResponseMutex( CellularContext_t * pContext );
79
87void _Cellular_DestroyPktResponseMutex( CellularContext_t * pContext );
88
99CellularPktStatus_t _Cellular_PktHandlerInit( CellularContext_t * pContext );
100
108void _Cellular_PktHandlerCleanup( CellularContext_t * pContext );
109
122CellularPktStatus_t _Cellular_HandlePacket( CellularContext_t * pContext,
123 _atRespType_t atRespType,
124 const void * pBuf );
125
136CellularPktStatus_t _Cellular_AtParseInit( const CellularContext_t * pContext );
137
138
149CellularPktStatus_t _Cellular_PktHandler_AtcmdRequestWithCallback( CellularContext_t * pContext,
150 CellularAtReq_t atReq,
151 uint32_t timeoutMS );
152
153/* *INDENT-OFF* */
154#ifdef __cplusplus
155 }
156#endif
157/* *INDENT-ON* */
158
159#endif /* __CELLULAR_PKTHANDLER_INTERNAL_H__ */
This represents the default values for the configuration macros for the Cellular library.
CellularPktStatus_t
packet Status Names.
Definition: cellular_types.h:338
The AT command request structure.
Definition: cellular_common.h:62