Buffer initialization functionality. More...
Macros | |
#define | MCUXCLBUFFER_INIT(name, info, ptr, size) |
Initialize an input/output buffer (mcuxCl_Buffer_t). | |
#define | MCUXCLBUFFER_INIT_RO(name, info, ptr, size) |
Initialize an input buffer (mcuxCl_InputBuffer_t) with plain CPU handling. | |
#define | MCUXCLBUFFER_INIT_RW(name, info, ptr, size) |
Initialize an input/output buffer (mcuxCl_Buffer_t) with plain CPU handling. | |
#define | MCUXCLBUFFER_INIT_DMA_RO(name, info, ptr, size) |
Initialize an input buffer (mcuxCl_InputBuffer_t) with DMA handling. | |
#define | MCUXCLBUFFER_INIT_DMA_RW(name, info, ptr, size) |
Initialize an input/output buffer (mcuxCl_Buffer_t) with DMA handling. | |
#define | MCUXCLBUFFER_INIT_DMA(name, info, ptr, size) |
Initialize an input/output buffer (mcuxCl_Buffer_t) with DMA handling. | |
#define | MCUXCLBUFFER_INIT_CUSTOM(name, handler, info, spec, ptr, size) |
Initialize an input/output buffer with custom handler. | |
#define | MCUXCLBUFFER_INIT_PLAIN_RO_IMPL(_name, _info, _ptr, _size) |
Initialize an input buffer with plain CPU handling. | |
#define | MCUXCLBUFFER_INIT_PLAIN_RW_IMPL(_name, _info, _ptr, _size) |
Initialize an input/output buffer with plain CPU handling. | |
#define | MCUXCLBUFFER_INIT_DMA_RO_IMPL(_name, _info, _ptr, _size) |
DMA handling is not supported. | |
#define | MCUXCLBUFFER_INIT_DMA_RW_IMPL(_name, _info, _ptr, _size) |
DMA handling is not supported. | |
#define | MCUXCLBUFFER_INIT_CUSTOM_IMPL(_name, _handler, _info, _spec, _ptr, _size) |
Usage of custom handler is not supported. | |
Buffer initialization functionality.
Two sets of default buffer initializations are provided, each with read-only (RO, for mcuxCl_InputBuffer_t) and read-write (RW, for mcuxCl_Buffer_t) variants:
Additionally a custom initializer is provided as well as some aliases that can be used as shorthand notation.
#define MCUXCLBUFFER_INIT | ( | name, | |
info, | |||
ptr, | |||
size | |||
) |
Initialize an input/output buffer (mcuxCl_Buffer_t).
This macro is an alias for MCUXCLBUFFER_INIT_RW
.
name | the name to be used for the buffer variable |
info | pointer to a data structure that holds relevant information for the handler |
ptr | pointer to the memory location of the buffer |
size | size of the buffer - RFU |
#define MCUXCLBUFFER_INIT_RO | ( | name, | |
info, | |||
ptr, | |||
size | |||
) |
Initialize an input buffer (mcuxCl_InputBuffer_t) with plain CPU handling.
This macro can be used to initialize an input buffer that will be handled using plain CPU operations.
name | the name to be used for the buffer variable |
info | pointer to a data structure that holds relevant information for the handler |
ptr | pointer to the memory location of the buffer |
size | size of the buffer - RFU |
#define MCUXCLBUFFER_INIT_RW | ( | name, | |
info, | |||
ptr, | |||
size | |||
) |
Initialize an input/output buffer (mcuxCl_Buffer_t) with plain CPU handling.
This macro can be used to initialize an input/output buffer that will be handled using plain CPU operations.
name | the name to be used for the buffer variable |
info | pointer to a data structure that holds relevant information for the handler |
ptr | pointer to the memory location of the buffer |
size | size of the buffer - RFU |
#define MCUXCLBUFFER_INIT_DMA_RO | ( | name, | |
info, | |||
ptr, | |||
size | |||
) |
Initialize an input buffer (mcuxCl_InputBuffer_t) with DMA handling.
This macro can be used to initialize an input buffer that will be handled using DMA operations.
name | the name to be used for the buffer variable |
info | pointer to a data structure that holds relevant information for the handler |
ptr | pointer to the memory location of the buffer |
size | size of the buffer - RFU |
#define MCUXCLBUFFER_INIT_DMA_RW | ( | name, | |
info, | |||
ptr, | |||
size | |||
) |
Initialize an input/output buffer (mcuxCl_Buffer_t) with DMA handling.
This macro can be used to initialize an input/output buffer that will be handled using DMA operations.
name | the name to be used for the buffer variable |
info | pointer to a data structure that holds relevant information for the handler |
ptr | pointer to the memory location of the buffer |
size | size of the buffer - RFU |
#define MCUXCLBUFFER_INIT_DMA | ( | name, | |
info, | |||
ptr, | |||
size | |||
) |
Initialize an input/output buffer (mcuxCl_Buffer_t) with DMA handling.
This macro is an alias for MCUXCLBUFFER_INIT_RW
.
name | the name to be used for the buffer variable |
info | pointer to a data structure that holds relevant information for the handler |
ptr | pointer to the memory location of the buffer |
size | size of the buffer - RFU |
#define MCUXCLBUFFER_INIT_CUSTOM | ( | name, | |
handler, | |||
info, | |||
spec, | |||
ptr, | |||
size | |||
) |
Initialize an input/output buffer with custom handler.
This macro can be used to initialize an input/output buffer with a custom handler.
name | the name to be used for the buffer variable |
handler | the callback function that will handle the buffer operations |
info | pointer to a data structure that holds relevant information for the handler |
spec | specification of the buffer properties |
ptr | pointer to the memory location of the buffer |
size | size of the buffer - RFU |
#define MCUXCLBUFFER_INIT_PLAIN_RO_IMPL | ( | _name, | |
_info, | |||
_ptr, | |||
_size | |||
) |
Initialize an input buffer with plain CPU handling.
This macro can be used to initialize an input buffer that will be handled using plain CPU operations.
_name | the name to be used for the buffer variable |
_info | unused for the current implementation |
_ptr | pointer to the memory location of the buffer |
_size | unused for the current implementation |
#define MCUXCLBUFFER_INIT_PLAIN_RW_IMPL | ( | _name, | |
_info, | |||
_ptr, | |||
_size | |||
) |
Initialize an input/output buffer with plain CPU handling.
This macro can be used to initialize an input/output buffer that will be handled using plain CPU operations.
_name | the name to be used for the buffer variable |
_info | unused for the current implementation |
_ptr | pointer to the memory location of the buffer |
_size | unused for the current implementation |
#define MCUXCLBUFFER_INIT_DMA_RO_IMPL | ( | _name, | |
_info, | |||
_ptr, | |||
_size | |||
) |
DMA handling is not supported.
Initialize an input buffer with plain CPU handling.
This buffer implementation does not support DMA handling, so CPU handling is used as a fallback. This macro is an alias for MCUXCLBUFFER_INIT_PLAIN_RO_IMPL
.
_name | the name to be used for the buffer variable |
_info | unused for the current implementation |
_ptr | pointer to the memory location of the buffer |
_size | unused for the current implementation |
#define MCUXCLBUFFER_INIT_DMA_RW_IMPL | ( | _name, | |
_info, | |||
_ptr, | |||
_size | |||
) |
DMA handling is not supported.
Initialize an input/output buffer with plain CPU handling.
This buffer implementation does not support DMA handling, so CPU handling is used as a fallback. This macro is an alias for MCUXCLBUFFER_INIT_PLAIN_RW_IMPL
.
_name | the name to be used for the buffer variable |
_info | unused for the current implementation |
_ptr | pointer to the memory location of the buffer |
_size | unused for the current implementation |
#define MCUXCLBUFFER_INIT_CUSTOM_IMPL | ( | _name, | |
_handler, | |||
_info, | |||
_spec, | |||
_ptr, | |||
_size | |||
) |
Usage of custom handler is not supported.
Initialize an input/output buffer with plain CPU handling.
This macro is an alias for MCUXCLBUFFER_INIT_PLAIN_RW_IMPL
.
_name | the name to be used for the buffer variable |
_handler | unused for the current implementation |
_info | unused for the current implementation |
_spec | unused for the current implementation |
_ptr | pointer to the memory location of the buffer |
_size | unused for the current implementation |