FreeRTOS: FreeRTOS Cellular Library v1.2.0
FreeRTOS Cellular Library
cellular_common_portable.h
Go to the documentation of this file.
1/*
2 * FreeRTOS-Cellular-Interface v1.2.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 * https://www.FreeRTOS.org
23 * https://github.com/FreeRTOS
24 */
25
30#ifndef __CELLULAR_COMMON_PORTABLE_H__
31#define __CELLULAR_COMMON_PORTABLE_H__
32
33/* *INDENT-OFF* */
34#ifdef __cplusplus
35 extern "C" {
36#endif
37/* *INDENT-ON* */
38
39#include <stdint.h>
40#include "cellular_common.h"
41
42/*-----------------------------------------------------------*/
43
56 void ** ppModuleContext );
57
69
81
93
94/* *INDENT-OFF* */
95#ifdef __cplusplus
96 }
97#endif
98/* *INDENT-ON* */
99
100#endif /* End of __CELLULAR_COMMON_PORTABLE_H__. */
CellularError_t Cellular_ModuleInit(const CellularContext_t *pContext, void **ppModuleContext)
Cellular module init function.
CellularError_t Cellular_ModuleEnableUE(CellularContext_t *pContext)
Cellular module user equipment setup function.
CellularError_t Cellular_ModuleCleanUp(const CellularContext_t *pContext)
Cellular module cleanup function.
CellularError_t Cellular_ModuleEnableUrc(CellularContext_t *pContext)
Cellular module URC enable function.
CellularError_t
Status code returns from APIs.
Definition: cellular_types.h:86
struct CellularContext CellularContext_t
Opaque Cellular context structure type.
Definition: cellular_types.h:65