FreeRTOS: FreeRTOS Cellular Library v1.4.0
FreeRTOS Cellular Library
 
Loading...
Searching...
No Matches
cellular_common_portable.h
Go to the documentation of this file.
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
32#ifndef __CELLULAR_COMMON_PORTABLE_H__
33#define __CELLULAR_COMMON_PORTABLE_H__
34
35/* *INDENT-OFF* */
36#ifdef __cplusplus
37 extern "C" {
38#endif
39/* *INDENT-ON* */
40
41#include <stdint.h>
42#include "cellular_common.h"
43
44/*-----------------------------------------------------------*/
45
57CellularError_t Cellular_ModuleInit( const CellularContext_t * pContext,
58 void ** ppModuleContext );
59
70CellularError_t Cellular_ModuleCleanUp( const CellularContext_t * pContext );
71
82CellularError_t Cellular_ModuleEnableUE( CellularContext_t * pContext );
83
94CellularError_t Cellular_ModuleEnableUrc( CellularContext_t * pContext );
95
96/* *INDENT-OFF* */
97#ifdef __cplusplus
98 }
99#endif
100/* *INDENT-ON* */
101
102#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:88