Functions | |
cy_en_axidmac_status_t | Cy_AXIDMAC_Descriptor_Init (cy_stc_axidmac_descriptor_t *descriptor, cy_stc_axidmac_descriptor_config_t const *config) |
Initializes the descriptor structure in SRAM from a pre-initialized configuration structure. More... | |
void | Cy_AXIDMAC_Descriptor_DeInit (cy_stc_axidmac_descriptor_t *descriptor) |
Clears the content of the specified descriptor. More... | |
void | Cy_AXIDMAC_Descriptor_SetNextDescriptor (cy_stc_axidmac_descriptor_t *descriptor, cy_stc_axidmac_descriptor_t const *nextDescriptor) |
Sets a Next Descriptor parameter for the specified descriptor. More... | |
void | Cy_AXIDMAC_Descriptor_SetDescriptorType (cy_stc_axidmac_descriptor_t *descriptor, cy_en_axidmac_descriptor_type_t descriptorType) |
Sets the descriptor's type for the specified descriptor. More... | |
__STATIC_INLINE void | Cy_AXIDMAC_Descriptor_SetSrcAddress (cy_stc_axidmac_descriptor_t *descriptor, void const *srcAddress) |
Sets the source address parameter for the specified descriptor. More... | |
__STATIC_INLINE void | Cy_AXIDMAC_Descriptor_SetDstAddress (cy_stc_axidmac_descriptor_t *descriptor, void const *dstAddress) |
Sets the destination address parameter for the specified descriptor. More... | |
__STATIC_INLINE void | Cy_AXIDMAC_Descriptor_SetMloopDataCount (cy_stc_axidmac_descriptor_t *descriptor, uint32_t mCount) |
Sets the number of data elements for the M loop of the specified descriptor. More... | |
void | Cy_AXIDMAC_Descriptor_SetXloopDataCount (cy_stc_axidmac_descriptor_t *descriptor, uint32_t xCount) |
Sets the number of data elements to transfer in the X loop for the specified descriptor (for 2D and 3D memory copy descriptors). More... | |
__STATIC_INLINE void | Cy_AXIDMAC_Descriptor_SetYloopDataCount (cy_stc_axidmac_descriptor_t *descriptor, uint32_t yCount) |
Sets the number of data elements for the Y loop of the specified descriptor (for 3D descriptors only). More... | |
__STATIC_INLINE void | Cy_AXIDMAC_Descriptor_SetXloopSrcIncrement (cy_stc_axidmac_descriptor_t *descriptor, int16_t srcXincrement) |
Sets the source increment parameter for the X loop of the specified descriptor (for 2D or 3D descriptors only). More... | |
__STATIC_INLINE void | Cy_AXIDMAC_Descriptor_SetXloopDstIncrement (cy_stc_axidmac_descriptor_t *descriptor, int16_t dstXincrement) |
Sets the destination increment parameter for the X loop for the specified descriptor (for 2D or 3D descriptors only). More... | |
__STATIC_INLINE void | Cy_AXIDMAC_Descriptor_SetYloopSrcIncrement (cy_stc_axidmac_descriptor_t *descriptor, int16_t srcYincrement) |
Sets the source increment parameter for the Y loop for the specified descriptor (for 3D descriptors only). More... | |
__STATIC_INLINE void | Cy_AXIDMAC_Descriptor_SetYloopDstIncrement (cy_stc_axidmac_descriptor_t *descriptor, int16_t dstYincrement) |
Sets the destination increment parameter for the Y loop of the specified descriptor (for 3D descriptors only). More... | |
__STATIC_INLINE void | Cy_AXIDMAC_Descriptor_SetInterruptType (cy_stc_axidmac_descriptor_t *descriptor, cy_en_axidmac_trigger_type_t interruptType) |
Sets the interrupt type parameter for the specified descriptor. More... | |
__STATIC_INLINE void | Cy_AXIDMAC_Descriptor_SetTriggerInType (cy_stc_axidmac_descriptor_t *descriptor, cy_en_axidmac_trigger_type_t triggerInType) |
Sets the Trigger In Type parameter for the specified descriptor. More... | |
__STATIC_INLINE void | Cy_AXIDMAC_Descriptor_SetTriggerOutType (cy_stc_axidmac_descriptor_t *descriptor, cy_en_axidmac_trigger_type_t triggerOutType) |
Sets the Trigger Out Type parameter for the specified descriptor. More... | |
__STATIC_INLINE void | Cy_AXIDMAC_Descriptor_SetRetrigger (cy_stc_axidmac_descriptor_t *descriptor, cy_en_axidmac_retrigger_t retrigger) |
Sets the retrigger value which specifies whether the controller should wait for the input trigger to be deactivated. More... | |
__STATIC_INLINE void | Cy_AXIDMAC_Descriptor_SetChannelState (cy_stc_axidmac_descriptor_t *descriptor, cy_en_axidmac_channel_state_t channelState) |
Sets the channel state on completion of the specified descriptor. More... | |
cy_stc_axidmac_descriptor_t * | Cy_AXIDMAC_Descriptor_GetNextDescriptor (cy_stc_axidmac_descriptor_t const *descriptor) |
Returns a next descriptor address of the specified descriptor. More... | |
__STATIC_INLINE cy_en_axidmac_descriptor_type_t | Cy_AXIDMAC_Descriptor_GetDescriptorType (cy_stc_axidmac_descriptor_t const *descriptor) |
Returns the descriptor's type of the specified descriptor. More... | |
__STATIC_INLINE void * | Cy_AXIDMAC_Descriptor_GetSrcAddress (cy_stc_axidmac_descriptor_t const *descriptor) |
Returns the source address of the specified descriptor. More... | |
__STATIC_INLINE void * | Cy_AXIDMAC_Descriptor_GetDstAddress (cy_stc_axidmac_descriptor_t const *descriptor) |
Returns the destination address of the specified descriptor. More... | |
__STATIC_INLINE uint32_t | Cy_AXIDMAC_Descriptor_GetMloopDataCount (cy_stc_axidmac_descriptor_t const *descriptor) |
Returns the number of M loops to execute in the specified descriptor. More... | |
uint32_t | Cy_AXIDMAC_Descriptor_GetXloopDataCount (cy_stc_axidmac_descriptor_t const *descriptor) |
Returns the number of data elements for the X loop of the specified descriptor (for 2D and 3D memory copy descriptors). More... | |
__STATIC_INLINE uint32_t | Cy_AXIDMAC_Descriptor_GetYloopDataCount (cy_stc_axidmac_descriptor_t const *descriptor) |
Returns the number of X loops to execute in the Y loop of the specified descriptor (for 3D descriptors only). More... | |
__STATIC_INLINE int16_t | Cy_AXIDMAC_Descriptor_GetXloopSrcIncrement (cy_stc_axidmac_descriptor_t const *descriptor) |
Returns the source increment parameter for the X loop of the specified descriptor (for 2D or 3D descriptors only). More... | |
__STATIC_INLINE int16_t | Cy_AXIDMAC_Descriptor_GetXloopDstIncrement (cy_stc_axidmac_descriptor_t const *descriptor) |
Returns the destination increment parameter for the X loop of the specified descriptor (for 2D or 3D descriptors only). More... | |
__STATIC_INLINE int16_t | Cy_AXIDMAC_Descriptor_GetYloopSrcIncrement (cy_stc_axidmac_descriptor_t const *descriptor) |
Returns the source increment parameter for the Y loop of the specified descriptor (for 2D descriptors only). More... | |
__STATIC_INLINE int16_t | Cy_AXIDMAC_Descriptor_GetYloopDstIncrement (cy_stc_axidmac_descriptor_t const *descriptor) |
Returns the destination increment parameter for the Y loop of the specified descriptor (for 3D descriptors only). More... | |
__STATIC_INLINE cy_en_axidmac_trigger_type_t | Cy_AXIDMAC_Descriptor_GetInterruptType (cy_stc_axidmac_descriptor_t const *descriptor) |
Returns the Interrupt-Type of the specified descriptor. More... | |
__STATIC_INLINE cy_en_axidmac_trigger_type_t | Cy_AXIDMAC_Descriptor_GetTriggerInType (cy_stc_axidmac_descriptor_t const *descriptor) |
Returns the Trigger In Type of the specified descriptor. More... | |
__STATIC_INLINE cy_en_axidmac_trigger_type_t | Cy_AXIDMAC_Descriptor_GetTriggerOutType (cy_stc_axidmac_descriptor_t const *descriptor) |
Returns the Trigger Out Type of the specified descriptor. More... | |
__STATIC_INLINE cy_en_axidmac_retrigger_t | Cy_AXIDMAC_Descriptor_GetRetrigger (cy_stc_axidmac_descriptor_t const *descriptor) |
Returns a value which specifies whether the controller should wait for the input trigger to be deactivated. More... | |
__STATIC_INLINE cy_en_axidmac_channel_state_t | Cy_AXIDMAC_Descriptor_GetChannelState (cy_stc_axidmac_descriptor_t const *descriptor) |
Returns the channel state on completion of the specified descriptor. More... | |
cy_en_axidmac_status_t Cy_AXIDMAC_Descriptor_Init | ( | cy_stc_axidmac_descriptor_t * | descriptor, |
const cy_stc_axidmac_descriptor_config_t * | config | ||
) |
Initializes the descriptor structure in SRAM from a pre-initialized configuration structure.
This function initializes only the descriptor and not the channel.
descriptor | The descriptor structure instance. |
config | This is a configuration structure that has all initialization information for the descriptor. |
void Cy_AXIDMAC_Descriptor_DeInit | ( | cy_stc_axidmac_descriptor_t * | descriptor | ) |
Clears the content of the specified descriptor.
descriptor | The descriptor structure instance. |
void Cy_AXIDMAC_Descriptor_SetNextDescriptor | ( | cy_stc_axidmac_descriptor_t * | descriptor, |
cy_stc_axidmac_descriptor_t const * | nextDescriptor | ||
) |
Sets a Next Descriptor parameter for the specified descriptor.
Based on the descriptor type, the offset of the address for the next descriptor register may vary: For the 1D memory copy descriptor type, this register is at offset 0x10. For the 2D memory copy descriptor type, this register is at offset 0x18. For the 3D memory copy descriptor type, this register is at offset 0x20.
descriptor | The descriptor structure instance. |
nextDescriptor | The pointer to the next descriptor. |
void Cy_AXIDMAC_Descriptor_SetDescriptorType | ( | cy_stc_axidmac_descriptor_t * | descriptor, |
cy_en_axidmac_descriptor_type_t | descriptorType | ||
) |
Sets the descriptor's type for the specified descriptor.
Moves the next descriptor pointer and M data count values into the proper offset in accordance to the actual descriptor type.
During the descriptor's type change, carefully set up the settings starting from dstAddress and all the rest below in the cy_stc_axidmac_descriptor_config_t structure. This is because the content of the descriptor registers might be lost/overridden by other descriptor settings due to the different registers structure for different descriptor types.
descriptor | The descriptor structure instance. |
descriptorType | The descriptor type cy_en_axidmac_descriptor_type_t. |
During the descriptor's type change, carefully set up the settings starting from dstAddress and all the rest below in the cy_stc_axidmac_descriptor_config_t structure. This is because the content of the descriptor registers might be lost/overridden by other descriptor settings due to the different registers structure for different descriptor types.
__STATIC_INLINE void Cy_AXIDMAC_Descriptor_SetSrcAddress | ( | cy_stc_axidmac_descriptor_t * | descriptor, |
void const * | srcAddress | ||
) |
Sets the source address parameter for the specified descriptor.
descriptor | The descriptor structure instance. |
srcAddress | The source address value for the descriptor. |
__STATIC_INLINE void Cy_AXIDMAC_Descriptor_SetDstAddress | ( | cy_stc_axidmac_descriptor_t * | descriptor, |
void const * | dstAddress | ||
) |
Sets the destination address parameter for the specified descriptor.
descriptor | The descriptor structure instance. |
dstAddress | The destination address value for the descriptor. |
__STATIC_INLINE void Cy_AXIDMAC_Descriptor_SetMloopDataCount | ( | cy_stc_axidmac_descriptor_t * | descriptor, |
uint32_t | mCount | ||
) |
Sets the number of data elements for the M loop of the specified descriptor.
descriptor | The descriptor structure instance. |
mCount | The number of M loops to execute. The valid range is 1 ... 65536. |
void Cy_AXIDMAC_Descriptor_SetXloopDataCount | ( | cy_stc_axidmac_descriptor_t * | descriptor, |
uint32_t | xCount | ||
) |
Sets the number of data elements to transfer in the X loop for the specified descriptor (for 2D and 3D memory copy descriptors).
descriptor | The descriptor structure instance. |
xCount | The number of data elements to transfer in the X loop. For all the rest of the descriptors (except 1D memory copy), the valid range is 1...65536. |
__STATIC_INLINE void Cy_AXIDMAC_Descriptor_SetYloopDataCount | ( | cy_stc_axidmac_descriptor_t * | descriptor, |
uint32_t | yCount | ||
) |
Sets the number of data elements for the Y loop of the specified descriptor (for 3D descriptors only).
descriptor | The descriptor structure instance. |
yCount | The number of X loops to execute in the Y loop. The valid range is 1 ... 65536. |
__STATIC_INLINE void Cy_AXIDMAC_Descriptor_SetXloopSrcIncrement | ( | cy_stc_axidmac_descriptor_t * | descriptor, |
int16_t | srcXincrement | ||
) |
Sets the source increment parameter for the X loop of the specified descriptor (for 2D or 3D descriptors only).
descriptor | The descriptor structure instance. |
srcXincrement | The value of the source increment. The valid range is -32768 ... 32767. Top most bit is a sign bit i.e., 0x8000 indicates -32768. |
__STATIC_INLINE void Cy_AXIDMAC_Descriptor_SetXloopDstIncrement | ( | cy_stc_axidmac_descriptor_t * | descriptor, |
int16_t | dstXincrement | ||
) |
Sets the destination increment parameter for the X loop for the specified descriptor (for 2D or 3D descriptors only).
descriptor | The descriptor structure instance. |
dstXincrement | The value of the destination increment. The valid range is -32768 ... 32767. Top most bit is a sign bit i.e., 0x8000 indicates -32768. |
__STATIC_INLINE void Cy_AXIDMAC_Descriptor_SetYloopSrcIncrement | ( | cy_stc_axidmac_descriptor_t * | descriptor, |
int16_t | srcYincrement | ||
) |
Sets the source increment parameter for the Y loop for the specified descriptor (for 3D descriptors only).
descriptor | The descriptor structure instance. |
srcYincrement | The value of the source increment. The valid range is -32768 ... 32767. Top most bit is a sign bit i.e., 0x8000 indicates -32768. |
__STATIC_INLINE void Cy_AXIDMAC_Descriptor_SetYloopDstIncrement | ( | cy_stc_axidmac_descriptor_t * | descriptor, |
int16_t | dstYincrement | ||
) |
Sets the destination increment parameter for the Y loop of the specified descriptor (for 3D descriptors only).
descriptor | The descriptor structure instance. |
dstYincrement | The value of the destination increment. The valid range is -32768 ... 32767. Top most bit is a sign bit i.e., 0x8000 indicates -32768. |
__STATIC_INLINE void Cy_AXIDMAC_Descriptor_SetInterruptType | ( | cy_stc_axidmac_descriptor_t * | descriptor, |
cy_en_axidmac_trigger_type_t | interruptType | ||
) |
Sets the interrupt type parameter for the specified descriptor.
descriptor | The descriptor structure instance. |
interruptType | The interrupt type set for the descriptor. cy_en_axidmac_trigger_type_t |
__STATIC_INLINE void Cy_AXIDMAC_Descriptor_SetTriggerInType | ( | cy_stc_axidmac_descriptor_t * | descriptor, |
cy_en_axidmac_trigger_type_t | triggerInType | ||
) |
Sets the Trigger In Type parameter for the specified descriptor.
descriptor | The descriptor structure instance. |
triggerInType | The Trigger In Type parameter cy_en_axidmac_trigger_type_t |
__STATIC_INLINE void Cy_AXIDMAC_Descriptor_SetTriggerOutType | ( | cy_stc_axidmac_descriptor_t * | descriptor, |
cy_en_axidmac_trigger_type_t | triggerOutType | ||
) |
Sets the Trigger Out Type parameter for the specified descriptor.
descriptor | The descriptor structure instance. |
triggerOutType | The Trigger Out Type set for the descriptor. cy_en_axidmac_trigger_type_t |
__STATIC_INLINE void Cy_AXIDMAC_Descriptor_SetRetrigger | ( | cy_stc_axidmac_descriptor_t * | descriptor, |
cy_en_axidmac_retrigger_t | retrigger | ||
) |
Sets the retrigger value which specifies whether the controller should wait for the input trigger to be deactivated.
descriptor | The descriptor structure instance. |
retrigger | The cy_en_axidmac_retrigger_t parameter specifies whether the controller should wait for the input trigger to be deactivated. |
__STATIC_INLINE void Cy_AXIDMAC_Descriptor_SetChannelState | ( | cy_stc_axidmac_descriptor_t * | descriptor, |
cy_en_axidmac_channel_state_t | channelState | ||
) |
Sets the channel state on completion of the specified descriptor.
descriptor | The descriptor structure instance. |
channelState | The channel state cy_en_axidmac_channel_state_t. |
cy_stc_axidmac_descriptor_t* Cy_AXIDMAC_Descriptor_GetNextDescriptor | ( | cy_stc_axidmac_descriptor_t const * | descriptor | ) |
Returns a next descriptor address of the specified descriptor.
Based on the descriptor type, the offset of the address for the next descriptor register may vary: For the 1D memory copy descriptor type, this register is at offset 0x10. For the 2D memory copy descriptor type, this register is at offset 0x18. For the 3D memory copy descriptor type, this register is at offset 0x20.
descriptor | The descriptor structure instance. |
__STATIC_INLINE cy_en_axidmac_descriptor_type_t Cy_AXIDMAC_Descriptor_GetDescriptorType | ( | cy_stc_axidmac_descriptor_t const * | descriptor | ) |
Returns the descriptor's type of the specified descriptor.
descriptor | The descriptor structure instance. |
__STATIC_INLINE void * Cy_AXIDMAC_Descriptor_GetSrcAddress | ( | cy_stc_axidmac_descriptor_t const * | descriptor | ) |
Returns the source address of the specified descriptor.
descriptor | The descriptor structure instance. |
__STATIC_INLINE void * Cy_AXIDMAC_Descriptor_GetDstAddress | ( | cy_stc_axidmac_descriptor_t const * | descriptor | ) |
Returns the destination address of the specified descriptor.
descriptor | The descriptor structure instance. |
__STATIC_INLINE uint32_t Cy_AXIDMAC_Descriptor_GetMloopDataCount | ( | cy_stc_axidmac_descriptor_t const * | descriptor | ) |
Returns the number of M loops to execute in the specified descriptor.
descriptor | The descriptor structure instance. |
uint32_t Cy_AXIDMAC_Descriptor_GetXloopDataCount | ( | cy_stc_axidmac_descriptor_t const * | descriptor | ) |
Returns the number of data elements for the X loop of the specified descriptor (for 2D and 3D memory copy descriptors).
descriptor | The descriptor structure instance. |
__STATIC_INLINE uint32_t Cy_AXIDMAC_Descriptor_GetYloopDataCount | ( | cy_stc_axidmac_descriptor_t const * | descriptor | ) |
Returns the number of X loops to execute in the Y loop of the specified descriptor (for 3D descriptors only).
descriptor | The descriptor structure instance. |
__STATIC_INLINE int16_t Cy_AXIDMAC_Descriptor_GetXloopSrcIncrement | ( | cy_stc_axidmac_descriptor_t const * | descriptor | ) |
Returns the source increment parameter for the X loop of the specified descriptor (for 2D or 3D descriptors only).
descriptor | The descriptor structure instance. |
__STATIC_INLINE int16_t Cy_AXIDMAC_Descriptor_GetXloopDstIncrement | ( | cy_stc_axidmac_descriptor_t const * | descriptor | ) |
Returns the destination increment parameter for the X loop of the specified descriptor (for 2D or 3D descriptors only).
descriptor | The descriptor structure instance. |
__STATIC_INLINE int16_t Cy_AXIDMAC_Descriptor_GetYloopSrcIncrement | ( | cy_stc_axidmac_descriptor_t const * | descriptor | ) |
Returns the source increment parameter for the Y loop of the specified descriptor (for 2D descriptors only).
descriptor | The descriptor structure instance. |
__STATIC_INLINE int16_t Cy_AXIDMAC_Descriptor_GetYloopDstIncrement | ( | cy_stc_axidmac_descriptor_t const * | descriptor | ) |
Returns the destination increment parameter for the Y loop of the specified descriptor (for 3D descriptors only).
descriptor | The descriptor structure instance. |
__STATIC_INLINE cy_en_axidmac_trigger_type_t Cy_AXIDMAC_Descriptor_GetInterruptType | ( | cy_stc_axidmac_descriptor_t const * | descriptor | ) |
Returns the Interrupt-Type of the specified descriptor.
descriptor | The descriptor structure instance. |
__STATIC_INLINE cy_en_axidmac_trigger_type_t Cy_AXIDMAC_Descriptor_GetTriggerInType | ( | cy_stc_axidmac_descriptor_t const * | descriptor | ) |
Returns the Trigger In Type of the specified descriptor.
descriptor | The descriptor structure instance. |
__STATIC_INLINE cy_en_axidmac_trigger_type_t Cy_AXIDMAC_Descriptor_GetTriggerOutType | ( | cy_stc_axidmac_descriptor_t const * | descriptor | ) |
Returns the Trigger Out Type of the specified descriptor.
descriptor | The descriptor structure instance. |
__STATIC_INLINE cy_en_axidmac_retrigger_t Cy_AXIDMAC_Descriptor_GetRetrigger | ( | cy_stc_axidmac_descriptor_t const * | descriptor | ) |
Returns a value which specifies whether the controller should wait for the input trigger to be deactivated.
descriptor | The descriptor structure instance. |
__STATIC_INLINE cy_en_axidmac_channel_state_t Cy_AXIDMAC_Descriptor_GetChannelState | ( | cy_stc_axidmac_descriptor_t const * | descriptor | ) |
Returns the channel state on completion of the specified descriptor.
descriptor | The descriptor structure instance. |