cellular_common_portable.h File Reference

#include <stdint.h>
#include "cellular_common.h"

Go to the source code of this file.

Functions
CellularError_t	Cellular_ModuleInit (const CellularContext_t *pContext, void **ppModuleContext)
	Cellular module init function.
CellularError_t	Cellular_ModuleCleanUp (const CellularContext_t *pContext)
	Cellular module cleanup function.
CellularError_t	Cellular_ModuleEnableUE (CellularContext_t *pContext)
	Cellular module user equipment setup function.
CellularError_t	Cellular_ModuleEnableUrc (CellularContext_t *pContext)
	Cellular module URC enable function.

Function Documentation

Cellular_ModuleInit()

CellularError_t Cellular_ModuleInit	(	const CellularContext_t *	pContext,
		void **	ppModuleContext
	)

Cellular module init function.

This function is called in Cellular_CommonInit to setup cellular module context.

Parameters

[in,out]	pContext	FreeRTOS Cellular Library context created in Cellular_Init.
[in]	ppModuleContext	Cellular module context can be obtained with _Cellular_GetModuleContext.

Returns

CELLULAR_SUCCESS if the operation is successful, otherwise an error code indicating the cause of the error.

Cellular_ModuleCleanUp()

CellularError_t Cellular_ModuleCleanUp

(

const CellularContext_t *

pContext

)

Cellular module cleanup function.

This function cleans up the module context.

Parameters

[in,out]

pContext

FreeRTOS Cellular Library context created in Cellular_Init.

Returns

CELLULAR_SUCCESS if the operation is successful, otherwise an error code indicating the cause of the error.

Cellular_ModuleEnableUE()

CellularError_t Cellular_ModuleEnableUE

(

CellularContext_t *

pContext

)

Cellular module user equipment setup function.

This function setups the user equipment of the cellular module.

Parameters

[in,out]

pContext

FreeRTOS Cellular Library context created in Cellular_Init.

Returns

CELLULAR_SUCCESS if the operation is successful, otherwise an error code indicating the cause of the error.

Cellular_ModuleEnableUrc()

CellularError_t Cellular_ModuleEnableUrc

(

CellularContext_t *

pContext

)

Cellular module URC enable function.

This function enable the unsolicited result code of the cellular module.

Parameters

[in,out]

pContext

FreeRTOS Cellular Library context created in Cellular_Init.

Returns

CELLULAR_SUCCESS if the operation is successful, otherwise an error code indicating the cause of the error.