CBUFF Driver External Functions

Introduction

The section has a list of all the exported API which the applications need to invoke in order to use the driver.

Functions
void	CBUFF_init (void)
	Description This function initializes the CBUFF module. This function must be called before any other functions are called. More...
CBUFF_Handle	CBUFF_open (CBUFF_InitCfg *ptrInitCfg, int32_t *errCode)
	Description The function Configures CBUFF peripheral with user provided configuration. More...
CBUFF_SessionHandle	CBUFF_createSession (CBUFF_Handle cbuffHandle, CBUFF_SessionCfg *ptrSessionCfg, int32_t *errCode)
	Description The function creates a session with the specified configuration. More...
int32_t	CBUFF_close (CBUFF_SessionHandle sessionHandle, int32_t *errCode)
	Description The function deletes the specific session. More...
int32_t	CBUFF_deinit (CBUFF_Handle cBuffHandle, int32_t *errCode)
	Description The function is used to deinitialize and shutdown the CBUFF driver. More...
int32_t	CBUFF_control (CBUFF_Handle cBuffHandle, CBUFF_Command cmd, void *arg, uint32_t argLen, int32_t *errCode)
	Description The function is used to get/set information from the CBUFF Driver. More...
int32_t	CBUFF_activateSession (CBUFF_SessionHandle sessionHandle, int32_t *errCode)
	Description The function activates the specific CBUFF session. More...
int32_t	CBUFF_deactivateSession (CBUFF_SessionHandle sessionHandle, int32_t *errCode)
	Description The function deactivates the specific CBUFF session. More...

Function Documentation

CBUFF_init()

void CBUFF_init

(

void

)

Description
This function initializes the CBUFF module. This function must be called before any other functions are called.

CBUFF_open()

CBUFF_Handle CBUFF_open	(	CBUFF_InitCfg *	ptrInitCfg,
		int32_t *	errCode
	)

Description
The function Configures CBUFF peripheral with user provided configuration.

Parameters

[in]	ptrInitCfg	A pointer to CBUFF_InitCfg structure for initialization
[out]	errCode	Pointer to an error code populated by the driver.

Returns

Success - Handle to the CBUFF Driver Error - NULL

CBUFF_createSession()

CBUFF_SessionHandle CBUFF_createSession	(	CBUFF_Handle	cbuffHandle,
		CBUFF_SessionCfg *	ptrSessionCfg,
		int32_t *	errCode
	)

Description
The function creates a session with the specified configuration.

Parameters

[in]	cbuffHandle	Handle to the CBUFF driver.
[in]	ptrSessionCfg	Pointer to the session configuration.
[out]	errCode	Pointer to an error code populated by the driver.

Returns

Success - Handle to the session Error - NULL

CBUFF_close()

int32_t CBUFF_close	(	CBUFF_SessionHandle	sessionHandle,
		int32_t *	errCode
	)

Description
The function deletes the specific session.

Parameters

[in]	sessionHandle	Handle to the CBUFF session.
[out]	errCode	Pointer to an error code populated by the driver.

Returns

Success - CBUFF_STATUS_SUCCESS Error - CBUFF_ERROR_CODES

CBUFF_deinit()

int32_t CBUFF_deinit	(	CBUFF_Handle	cBuffHandle,
		int32_t *	errCode
	)

Description
The function is used to deinitialize and shutdown the CBUFF driver.

Parameters

[in]	cBuffHandle	Handle to the CBUFF instance obtained through call to CBUFF_open.
[out]	errCode	Pointer to an error code populated by the driver.

Returns

Success - CBUFF_STATUS_SUCCESS Error - CBUFF_ERROR_CODES

CBUFF_control()

int32_t CBUFF_control	(	CBUFF_Handle	cBuffHandle,
		CBUFF_Command	cmd,
		void *	arg,
		uint32_t	argLen,
		int32_t *	errCode
	)

Description
The function is used to get/set information from the CBUFF Driver.

Parameters

[in]	cBuffHandle	Handle to the CBUFF instance obtained through call to CBUFF_open.
[in]	cmd	CBUFF command
[in]	arg	Command specified pointer to the argument
[in]	argLen	Length of the argument
[out]	errCode	Pointer to an error code populated by the driver.

Returns

Success - CBUFF_STATUS_SUCCESS Error - CBUFF_ERROR_CODES

CBUFF_activateSession()

int32_t CBUFF_activateSession	(	CBUFF_SessionHandle	sessionHandle,
		int32_t *	errCode
	)

Description
The function activates the specific CBUFF session.

Parameters

[in]	sessionHandle	Handle to the session to be activated CBUFF_createSession.
[out]	errCode	Pointer to an error code populated by the driver.

Returns

Success - CBUFF_STATUS_SUCCESS Error - CBUFF_ERROR_CODES

CBUFF_deactivateSession()

int32_t CBUFF_deactivateSession	(	CBUFF_SessionHandle	sessionHandle,
		int32_t *	errCode
	)

Description
The function deactivates the specific CBUFF session.

Parameters

[in]	sessionHandle	Handle to the session to be deactivated CBUFF_createSession.
[out]	errCode	Pointer to an error code populated by the driver.

Returns

Success - CBUFF_STATUS_SUCCESS Error - CBUFF_ERROR_CODES