Collaboration diagram for NSC Interface Functions:

Functions
ptxStatus_t	ptxNSC_Init (ptxNSC_t nscCtx, ptxNSC_InitParam_t initParam)
	Initialization function for NSC component.

ptxStatus_t	ptxNSC_DeInit (ptxNSC_t *nscCtx)
	Shutdown function for NSC component.

ptxStatus_t	ptxNSC_Pause (ptxNSC_t *nscCtx, ptxNSC_Pause_Options pauseMode)
	Suspend or resume thread for the interface device.

ptxStatus_t	ptxNSC_HALSetFlowCtrlState (ptxNSC_t *nscCtx, uint8_t enableTRx)
	Enable/disable flow control mode for the interface device.

ptxStatus_t	ptxNSC_HALSetSpeed (ptxNSC_t *nscCtx, uint32_t bdSpeed)
	Set speed for interface with the chip.

ptxStatus_t	ptxNSC_SetState (ptxNSC_t *nscCtx, ptxNSC_States_t state)
	Set NSC State.

ptxNSC_States_t	ptxNSC_GetState (ptxNSC_t *nscCtx)
	Get NSC State.

ptxStatus_t	ptxNSC_GetMiscRFConfig (ptxNSC_t nscCtx, uint8_t configBuffer, size_t *configBufferLen)
	NSC Get last loaded Misc. RF-Configuration.

ptxStatus_t	ptxNSC_GetIORQNtf (ptxNSC_t nscCtx, struct ptxIoRq ioCpl)
	NSC Get IO RQ Notification.

Detailed Description

Function Documentation

◆ ptxNSC_DeInit()

ptxStatus_t ptxNSC_DeInit ( ptxNSC_t * nscCtx )

Shutdown function for NSC component.

Parameters

[in] nscCtx Pointer to the component structure.

Returns: Status, indicating whether the operation was successful. See ptxStatus_t.

◆ ptxNSC_GetIORQNtf()

ptxStatus_t ptxNSC_GetIORQNtf	(	ptxNSC_t *	nscCtx,
		struct ptxIoRq *	ioCpl )

NSC Get IO RQ Notification.

This function is used for building IO RQ Object when there is a NTF received. It is just used to do a push of the default completion function at NSC for notifications.

Parameters

[in]	nscCtx	Pointer to the component structure.
[in]	ioCpl	Pointer to the I/O Completion structure.

Returns: Status, indicating whether the operation was successful. See ptxStatus_t.

◆ ptxNSC_GetMiscRFConfig()

ptxStatus_t ptxNSC_GetMiscRFConfig	(	ptxNSC_t *	nscCtx,
		uint8_t *	configBuffer,
		size_t *	configBufferLen )

NSC Get last loaded Misc. RF-Configuration.

This function is used to retrieve a copy of the last loaded miscellaneous RF-Configuration settings.

Parameters

[in]	nscCtx	Pointer to the component structure.
[in]	configBuffer	Pointer to buffer where Misc. settings should be stored.
[in,out]	configBufferLen	Size of configBuffer (in), Length of stored Misc. settings (out).

Returns: Status, indicating whether the operation was successful. See ptxStatus_t.

◆ ptxNSC_GetState()

ptxNSC_States_t ptxNSC_GetState ( ptxNSC_t * nscCtx )

Get NSC State.

Parameters

[in] nscCtx Pointer to an allocated and initialized structure.

Returns: NSC State.

◆ ptxNSC_HALSetFlowCtrlState()

ptxStatus_t ptxNSC_HALSetFlowCtrlState	(	ptxNSC_t *	nscCtx,
		uint8_t	enableTRx )

Enable/disable flow control mode for the interface device.

Control the interface. Set flow control to active or inactive.

Parameters

[in]	nscCtx	Pointer to an allocated and initialized structure.
[in]	enableTRx	With 0 the mode is set to inactive; set to 1 in order to enable the mode.

Returns: Status, indicating whether the operation was successful. See ptxStatus_t.

◆ ptxNSC_HALSetSpeed()

ptxStatus_t ptxNSC_HALSetSpeed	(	ptxNSC_t *	nscCtx,
		uint32_t	bdSpeed )

Set speed for interface with the chip.

Control the interface. Set flow control to active or inactive.

Parameters

[in]	nscCtx	Pointer to an allocated and initialized structure.
[in]	bdSpeed	Speed to be set on the interface.

Returns: Status, indicating whether the operation was successful. See ptxStatus_t.

◆ ptxNSC_Init()

ptxStatus_t ptxNSC_Init	(	ptxNSC_t *	nscCtx,
		ptxNSC_InitParam_t *	initParam )

Initialization function for NSC component.

Parameters

[in]	nscCtx	Pointer to the component structure.
[in]	initParam	Pointer to the component initialization structure.

Returns: Status, indicating whether the operation was successful. See ptxStatus_t.

◆ ptxNSC_Pause()

ptxStatus_t ptxNSC_Pause	(	ptxNSC_t *	nscCtx,
		ptxNSC_Pause_Options	pauseMode )

Suspend or resume thread for the interface device.

Control the thread. For testing purpose it may be required to suspend it.

Parameters

[in]	nscCtx	Pointer to an allocated and initialized component structure.
[in]	pauseMode	Pause operation /ref ptxNSC_Pause_Options.

Returns: Status, indicating whether the operation was successful. See ptxStatus_t.

◆ ptxNSC_SetState()

ptxStatus_t ptxNSC_SetState	(	ptxNSC_t *	nscCtx,
		ptxNSC_States_t	state )

Set NSC State.

Parameters

[in]	nscCtx	Pointer to an allocated and initialized structure.
[in]	state	State to be updated.

Returns: Status, indicating whether the operation was successful. See ptxStatus_t.