Stack I/O Requests

Stack I/O Request Functionality. More...

Collaboration diagram for Stack I/O Requests:

Topics
	I/O Request Data Structure
	The structure for I/O Requests stores the execution trace down the asynchronous stack. On the way up (return path) the structure is used to go back through the call chain.
	I/O Request Handler Functions
	Functions handling I/O requests.

Data Structures
struct	ptxIoRq
	I/O Request structure. More...

Typedefs
typedef ptxStatus_t(*	pptxIoRq_Init_t) (ptxIoRq_t *ioCpl)
	Function pointer declaration according to ptxIoRq_Init.
typedef ptxStatus_t(*	pptxIoRq_Push_t) (ptxIoRq_t *ioCpl, pptxIoRqCompletion_t ioCompletionFn, uint8_t *ioData, uint8_t dataLength, void *ioCompletionComp)
	Function pointer declaration according to ptxIoRq_Push.
typedef ptxStatus_t(*	pptxIoRq_Pop_t) (ptxIoRq_t *ioCpl, pptxIoRqCompletion_t *ioCompletionFn, void **ioData, uint8_t *ioDataLength, void **ioCompletionComp)
	Function pointer declaration according to ptxIoRq_Pop.

Functions
struct ptxIoRq *	ptxIoRq_GetItem (struct ptxOsal *osalCtx)
	Allocate or get from a pool an I/O Request Item.
void	ptxIoRq_ReturnItem (struct ptxOsal *osalCtx, struct ptxIoRq *ioRqItem)
	De-allocate or return to a pool an I/O Request Item.
ptxStatus_t	ptxIoRq_SetItemState (struct ptxIoRq *ioRqItem, uint8_t ioState)
	Set state of an I/O Request Item.

Definitions
#define	PTX_IORQ_EMPTY   0
#define	PTX_IORQ_NUM_STACK_LOCATIONS   8
#define	PTX_IORQ_DATA_POP   ((size_t)-1)
#define	PTX_IORQ_STATE_DISPOSED   (uint8_t)0
#define	PTX_IORQ_STATE_LOCKED   (uint8_t)1
#define	PTX_IORQ_STATE_LOCKED_RELEASE_BUFFER   (uint8_t)2
#define	PTX_IORQ_STATE_INVALID   (uint8_t)0xFF

Detailed Description

Stack I/O Request Functionality.

Macro Definition Documentation

PTX_IORQ_DATA_POP

#define PTX_IORQ_DATA_POP   ((size_t)-1)

Indicate in length parameter to pop data.

PTX_IORQ_EMPTY

#define PTX_IORQ_EMPTY   0

FIFO is empty

PTX_IORQ_NUM_STACK_LOCATIONS

#define PTX_IORQ_NUM_STACK_LOCATIONS   8

Maximum number of stack locations.

PTX_IORQ_STATE_DISPOSED

#define PTX_IORQ_STATE_DISPOSED   (uint8_t)0

default Value, IoRq item gets destroyed (and its linked buffer is released) after single IO execution

PTX_IORQ_STATE_INVALID

#define PTX_IORQ_STATE_INVALID   (uint8_t)0xFF

indicates an invalid value for the IoRq item

PTX_IORQ_STATE_LOCKED

#define PTX_IORQ_STATE_LOCKED   (uint8_t)1

prevent IoRq item from being destroyed (buffer is kept as well)

PTX_IORQ_STATE_LOCKED_RELEASE_BUFFER

#define PTX_IORQ_STATE_LOCKED_RELEASE_BUFFER   (uint8_t)2

prevent IoRq item from being destroyed but buffer is released.

Function Documentation

ptxIoRq_GetItem()

struct ptxIoRq * ptxIoRq_GetItem

(

struct ptxOsal *

osalCtx

)

Allocate or get from a pool an I/O Request Item.

I/O Request Structure Handling Functions

Parameters

[in]

osalCtx

Pointer to an initialized OSAL component structure.

Returns

Pointer to the allocated item or NULL if not successful.

ptxIoRq_ReturnItem()

void ptxIoRq_ReturnItem	(	struct ptxOsal *	osalCtx,
		struct ptxIoRq *	ioRqItem )

De-allocate or return to a pool an I/O Request Item.

Parameters

[in]	osalCtx	Pointer to an initialized OSAL component structure.
[in]	ioRqItem	Pointer to a previously allocated I/O Request Item.

ptxIoRq_SetItemState()

ptxStatus_t ptxIoRq_SetItemState	(	struct ptxIoRq *	ioRqItem,
		uint8_t	ioState )

Set state of an I/O Request Item.

Parameters

[in]	ioRqItem	Pointer to a previously allocated I/O Request Item.
[in]	ioState	State to be set within previously allocated I/O Request Item.

Returns

Status of the operation. See definition of ptxStatus_t.