FreeRTOS: FreeRTOS Cellular Library v1.4.0
FreeRTOS Cellular Library
 
Loading...
Searching...
No Matches
cellular_pktio_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
29#ifndef __CELLULAR_PKTIO_INTERNAL_H__
30#define __CELLULAR_PKTIO_INTERNAL_H__
31
32/* *INDENT-OFF* */
33#ifdef __cplusplus
34 extern "C" {
35#endif
36/* *INDENT-ON* */
37
38#ifndef CELLULAR_DO_NOT_USE_CUSTOM_CONFIG
39 /* Include custom config file before other headers. */
40 #include "cellular_config.h"
41#endif
43#include "cellular_types.h"
44
45/*-----------------------------------------------------------*/
46
50typedef enum _atRespType
51{
52 AT_SOLICITED = 0,
53 AT_UNSOLICITED,
54 AT_UNDEFINED
55} _atRespType_t;
56
67typedef CellularPktStatus_t ( * _pPktioHandlePacketCallback_t ) ( CellularContext_t * pContext,
68 _atRespType_t atRespType,
69 const void * pBuffer );
70
76typedef void ( * _pPktioShutdownCallback_t ) ( CellularContext_t * pContext );
77
78/*-----------------------------------------------------------*/
79
92CellularPktStatus_t _Cellular_PktioInit( CellularContext_t * pContext,
93 _pPktioHandlePacketCallback_t handlePacketCb );
94
103void _Cellular_PktioShutdown( CellularContext_t * pContext );
104
118CellularPktStatus_t _Cellular_PktioSendAtCmd( CellularContext_t * pContext,
119 const char * pAtCmd,
121 const char * pAtRspPrefix );
122
134uint32_t _Cellular_PktioSendData( CellularContext_t * pContext,
135 const uint8_t * pData,
136 uint32_t dataLen );
137
138/* *INDENT-OFF* */
139#ifdef __cplusplus
140 }
141#endif
142/* *INDENT-ON* */
143
144#endif /* __CELLULAR_PKTIO_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
CellularATCommandType_t
Represents AT Command type.
Definition: cellular_types.h:360