alf_wb_parm_add

NAME

alf_wb_parm_add - Adds the given parameter to the parameter and context buffer of the work block in the order that this function is called.

SYNOPSIS

int alf_wb_parm_add(alf_wb_handle_t wb_handle, void *pdata, unsigned int size_of_data, ALF_DATA_TYPE_T data_type, unsigned int address_alignment)

Parameters  
wb_handle [IN] The work block handle.
pdata [IN] A pointer to the data to be copied.
size_of_data [IN] The size of the data in units of the data type.
data_type [IN] The type of data. This value is required if data endianess conversion is necessary when moving the data.
address_alignment [IN] Power of 2 byte alignment of 2 address_alignment. The valid range is from 0 to 16. A zero indicates a byte-aligned address. An 8 indicates alignment on 256 byte boundaries.

DESCRIPTION

This function adds the given parameter to the parameter and context buffer of the work block in the order that this function is called. The starting address is from offset zero. The added data is copied to the internal parameter and context buffer immediately. The relative address of the data can be aligned as specified. For a specific work block, additional calls to this API return an error after the work block is put into the work queue by calling the alf_wb_enqueue function.

RETURN VALUE

0 Success.
less than 0 Errors occurred:
  • ALF_ERR_INVAL: Invalid input argument.
  • ALF_ERR_PERM: Operation not allowed in current context.
  • ALF_ERR_BADF: Invalid task handle or work block handle.
  • ALF_ERR_NOBUFS: Some internal resource is occupied.
  • ALF_ERR_GENERIC: Generic internal errors.
Related concepts
Data structures
Related reference
alf_wb_create
alf_wb_enqueue
alf_wb_dtl_begin
alf_wb_dtl_entry_add
alf_wb_dtl_end