ModusToolbox USBFXStack
Macros

General Description

Macros

#define CY_HBDMA_H
 Indicates the use of High-bandwidth DMA.
 
#define CY_HBDMA_DRV_VERSION_MAJOR   (1)
 Driver major version.
 
#define CY_HBDMA_DRV_VERSION_MINOR   (0)
 Driver minor version.
 
#define CY_HBDMA_ID   CY_PDL_DRV_ID(0x80U)
 HBDMA driver identifier.
 
#define CY_HBW_SRAM_BASE_ADDR   (0x1C000000UL)
 Base address of HBW SRAM.
 
#define CY_HBW_SRAM_LAST_ADDR   (0x1C100000UL)
 Upper limit of the HBW SRAM.
 
#define CY_HBDMA_DESC_SIZE   (0x10U)
 Size of each High Bandwidth DMA descriptor.
 
#define CY_HBDMA_MAX_DSCR_CNT   (4096U)
 Maximum number of descriptors supported.
 
#define CY_HBDMA_GET_DESC_ADDR(dscr_no)   ((CY_HBW_SRAM_BASE_ADDR) + ((dscr_no) * CY_HBDMA_DESC_SIZE))
 Get address of nth DMA descriptor.
 
#define CY_HBDMA_IS_SOCKET_VALID(id)
 Check whether socket id passed is valid. More...
 
#define CY_HBDMA_IS_USB_IN_SOCK(id)   (((id) >= CY_HBDMA_USBIN_SOCKET_00) && ((id) <= CY_HBDMA_USBIN_SOCKET_15))
 Check whether the socket is a valid USB ingress socket.
 
#define CY_HBDMA_IS_USB_EG_SOCK(id)   (((id) >= CY_HBDMA_USBEG_SOCKET_00) && ((id) <= CY_HBDMA_USBEG_SOCKET_15))
 Check whether the socket is a valid USB egress socket.
 
#define CY_HBDMA_IS_USBHS_IN_EP(id)   (((id) >= CY_HBDMA_USBHS_IN_EP_00) && ((id) <= CY_HBDMA_USBHS_IN_EP_15))
 Check whether the selection corresponds to a valid USB-HS IN endpoint.
 
#define CY_HBDMA_IS_USBHS_OUT_EP(id)   (((id) >= CY_HBDMA_USBHS_OUT_EP_00) && ((id) <= CY_HBDMA_USBHS_OUT_EP_15))
 Check whether the selection corresponds to a valid USB-HS OUT endpoint.
 
#define CY_HBDMA_SOCK_STATUS_WR_MASK   (0x2FE007FFUL)
 Mask for write-able fields of socket status.
 
#define CY_HBDMA_SOCK_PER_ADAPTER   (16u)
 Maximum number of sockets supported per DMA adapter.
 
#define CY_HBDMA_SOCK_STATE_STALL   (1u)
 Socket stall status value.
 
#define CY_HBDMA_SOCK_STATE_ACTIVE   (2u)
 Socket active status value.
 
#define CY_HBDMA_MGR_H
 Indicates the use of HB-DMA Manager.
 
#define CY_HBDMA_MGR_ID   CY_PDL_DRV_ID(0x81U)
 HBDMA Manager Middleware identifier.
 
#define CY_HBDMA_MAX_ADAP_CNT   (6U)
 Maximum number of adapters supported by the HBWSS DMA manager.
 
#define CY_HBDMA_DW_ADAP_CNT   (2U)
 Number of DataWire instances being used in the DMA driver.
 
#define CY_HBDMA_DW_DSCR_PER_CHN   (3U)
 Number of DataWire descriptors required per channel.
 
#define CY_HBDMA_INTR_QUEUE_ENTRIES   (128U)
 Number of entries supported in the HBDma Interrupt Message Queue.
 
#define CY_HBDMA_INTRQ_FULL_THRESHOLD   (CY_HBDMA_INTR_QUEUE_ENTRIES - 16U)
 Queue almost full threshold after which DMA interrupts are blocked.
 
#define CY_HBDMA_INTRQ_FREE_THRESHOLD   (CY_HBDMA_INTR_QUEUE_ENTRIES - 64U)
 Queue free threshold after which DMA interrupts are re-enabled.
 
#define CY_HBDMA_MAX_BUFFER_SIZE(en_64k)   ((en_64k != 0) ? 0x10000U : 0xFFF0U)
 Maximum DMA buffer size supported.
 
#define CY_HBDMA_TASK_STACK_DEPTH   (512)
 Size of stack reserved for HBDma manager task in 32-bit words.
 
#define CY_HBDMA_TASK_PRIORITY   (10)
 Priority of HBDma manager task.
 
#define Cy_HBDMA_GetDWDesc(dmaXferDscr)   &(dmaXferDscr.dwDscr)
 Retrieve the DataWire DMA descriptor from the DMA wrapper data structure.
 
#define CY_HBDMA_VERSION_H
 Indicates the use of HBDMA Version.
 
#define HBDMA_VERSION_MAJOR   (1u)
 HBDma manager middleware major version.
 
#define HBDMA_VERSION_MINOR   (3u)
 HBDma manager middleware minor version.
 
#define HBDMA_VERSION_PATCH   (2u)
 HBDma manager middleware patch version.
 
#define HBDMA_VERSION_BUILD   (36u)
 HBDma manager middleware build number.
 
#define HBDMA_VERSION_NUM
 HBDma manager middleware version number. More...
 

Macro Definition Documentation

◆ CY_HBDMA_IS_SOCKET_VALID

#define CY_HBDMA_IS_SOCKET_VALID (   id)
Value:
( ((id) <= CY_HBDMA_LVDS_SOCKET_31) || \
(((id) >= CY_HBDMA_USBIN_SOCKET_00) && ((id) <= CY_HBDMA_USBIN_SOCKET_15)) || \
(((id) >= CY_HBDMA_USBEG_SOCKET_00) && ((id) <= CY_HBDMA_USBEG_SOCKET_15)) || \
(((id) >= CY_HBDMA_USBHS_OUT_EP_00) && ((id) <= CY_HBDMA_USBHS_OUT_EP_15)) || \
(((id) >= CY_HBDMA_USBHS_IN_EP_00) && ((id) <= CY_HBDMA_USBHS_IN_EP_15)) || \
((id) == CY_HBDMA_VIRT_SOCKET_WR) || \
)
@ CY_HBDMA_LVDS_SOCKET_31
LVDS socket #31.
Definition: cy_hbdma.h:277
@ CY_HBDMA_USBEG_SOCKET_00
USB egress socket #00.
Definition: cy_hbdma.h:279
@ CY_HBDMA_USBIN_SOCKET_15
USB ingress socket #15.
Definition: cy_hbdma.h:311
@ CY_HBDMA_USBHS_OUT_EP_15
USBHS endpoint memory for OUT EP #15.
Definition: cy_hbdma.h:328
@ CY_HBDMA_VIRT_SOCKET_RD
Virtual (CPU) access socket for data read.
Definition: cy_hbdma.h:347
@ CY_HBDMA_USBHS_IN_EP_00
USBHS endpoint memory for IN EP #00.
Definition: cy_hbdma.h:330
@ CY_HBDMA_USBIN_SOCKET_00
USB ingress socket #00.
Definition: cy_hbdma.h:296
@ CY_HBDMA_USBEG_SOCKET_15
USB egress socket #15.
Definition: cy_hbdma.h:294
@ CY_HBDMA_USBHS_OUT_EP_00
USBHS endpoint memory for OUT EP #00.
Definition: cy_hbdma.h:313
@ CY_HBDMA_VIRT_SOCKET_WR
Virtual (CPU) access socket for data write.
Definition: cy_hbdma.h:348
@ CY_HBDMA_USBHS_IN_EP_15
USBHS endpoint memory for IN EP #15.
Definition: cy_hbdma.h:345

Check whether socket id passed is valid.

◆ HBDMA_VERSION_NUM

#define HBDMA_VERSION_NUM
Value:
((HBDMA_VERSION_MAJOR << 28u) | (HBDMA_VERSION_MINOR << 24u) | \
#define HBDMA_VERSION_MAJOR
HBDma manager middleware major version.
Definition: cy_hbdma_version.h:44
#define HBDMA_VERSION_MINOR
HBDma manager middleware minor version.
Definition: cy_hbdma_version.h:47
#define HBDMA_VERSION_PATCH
HBDma manager middleware patch version.
Definition: cy_hbdma_version.h:50
#define HBDMA_VERSION_BUILD
HBDma manager middleware build number.
Definition: cy_hbdma_version.h:53

HBDma manager middleware version number.