dwc_otg_cfi.h File Reference

This file contains the CFI related OTG PCD specific common constants, interfaces (functions and macros) and data structures. More...

#include "dwc_otg_pcd.h"
#include "dwc_cfi_common.h"

Go to the source code of this file.

Data Structures
struct	_ddma_sg_buffer_setup
	Descriptor DMA SG Buffer setup structure (SG buffer). More...
struct	_ddma_concat_buffer_setup_hdr
	Descriptor DMA Concatenation Buffer setup structure. More...
struct	_ddma_concat_buffer_setup
	Descriptor DMA Concatenation Buffer setup structure. More...
struct	_ddma_align_buffer_setup
	Descriptor DMA Alignment Buffer setup structure. More...
struct	_tx_fifo_size_setup
	Transmit FIFO Size setup structure. More...
struct	_rx_fifo_size_setup
	Transmit FIFO Size setup structure. More...
struct	cfi_usb_ctrlrequest
	struct cfi_usb_ctrlrequest - the CFI implementation of the struct usb_ctrlrequest This structure encapsulates the standard usb_ctrlrequest and adds a pointer to the data returned in the data stage of a 3-stage Control Write requests. More...
struct	cfi_ep
	The CFI wrapper of the enabled and activated dwc_otg_pcd_ep structures. More...
struct	cfi_dma_buff
struct	cfi_ops
	This is the interface for the CFI operations. More...
struct	cfiobject
Defines
#define	__DWC_OTG_CFI_H__
#define	FT_ID_DMA_MODE   0x0001
	This is a request for all Core Features.
#define	FT_ID_DMA_BUFFER_SETUP   0x0002
#define	FT_ID_DMA_BUFF_ALIGN   0x0003
#define	FT_ID_DMA_CONCAT_SETUP   0x0004
#define	FT_ID_DMA_CIRCULAR   0x0005
#define	FT_ID_THRESHOLD_SETUP   0x0006
#define	FT_ID_DFIFO_DEPTH   0x0007
#define	FT_ID_TX_FIFO_DEPTH   0x0008
#define	FT_ID_RX_FIFO_DEPTH   0x0009
#define	CFI_INFO_DEF
#define	CFI_INFO(fmt...)   DWC_PRINTF("CFI: " fmt);
#define	min(x, y)
#define	max(x, y)
#define	BS_SG_VAL_DESC_LEN   6
#define	BS_CONCAT_VAL_HDR_LEN   4
#define	BS_ALIGN_VAL_HDR_LEN   2
#define	CFI_IN_BUF_LEN   1024
#define	CFI_OUT_BUF_LEN   1024
#define	DUMP_MSG
Typedefs
typedef _ddma_sg_buffer_setup	ddma_sg_buffer_setup_t
typedef _ddma_concat_buffer_setup_hdr	ddma_concat_buffer_setup_hdr_t
typedef _ddma_concat_buffer_setup	ddma_concat_buffer_setup_t
typedef _ddma_align_buffer_setup	ddma_align_buffer_setup_t
typedef _tx_fifo_size_setup	tx_fifo_size_setup_t
typedef _rx_fifo_size_setup	rx_fifo_size_setup_t
typedef cfi_ep	cfi_ep_t
typedef cfi_dma_buff	cfi_dma_buff_t
typedef cfi_ops	cfi_ops_t
	This is the interface for the CFI operations.
typedef cfiobject	cfiobject_t
Functions
static void	dump_msg (const u8 *buf, unsigned int length)
static struct cfi_ep *	get_cfi_ep_by_addr (struct cfiobject *cfi, uint8_t addr)
	This function returns a pointer to cfi_ep_t object with the addr address.
static struct cfi_ep *	get_cfi_ep_by_pcd_ep (struct cfiobject *cfi, struct dwc_otg_pcd_ep *ep)
	This function returns a pointer to cfi_ep_t object that matches the dwc_otg_pcd_ep object.
int	cfi_setup (struct dwc_otg_pcd *pcd, struct cfi_usb_ctrlrequest *ctrl)
Variables
_ddma_sg_buffer_setup	packed
	Descriptor DMA SG Buffer setup structure (SG buffer).
_ddma_concat_buffer_setup_hdr	packed
	Descriptor DMA Concatenation Buffer setup structure.
_ddma_concat_buffer_setup	packed
	Descriptor DMA Concatenation Buffer setup structure.
_ddma_align_buffer_setup	packed
	Descriptor DMA Alignment Buffer setup structure.
_tx_fifo_size_setup	packed
	Transmit FIFO Size setup structure.
_rx_fifo_size_setup	packed
	Transmit FIFO Size setup structure.
cfi_usb_ctrlrequest	UPACKED
	struct cfi_usb_ctrlrequest - the CFI implementation of the struct usb_ctrlrequest This structure encapsulates the standard usb_ctrlrequest and adds a pointer to the data returned in the data stage of a 3-stage Control Write requests.

---

Detailed Description

This file contains the CFI related OTG PCD specific common constants, interfaces (functions and macros) and data structures.

Definition in file dwc_otg_cfi.h.

---

Define Documentation

#define min	(	x,
		y		)

Value:

({ \
        x < y ? x : y; })

Definition at line 67 of file dwc_otg_cfi.h.

#define max	(	x,
		y		)

Value:

({ \
        x > y ? x : y; })

Definition at line 70 of file dwc_otg_cfi.h.

---

Typedef Documentation

typedef struct cfi_ops cfi_ops_t

This is the interface for the CFI operations.

Parameters:

	ep_enable	Called when any endpoint is enabled and activated.
	release	Called when the CFI object is released and it needs to correctly deallocate the dynamic memory
	ctrl_write_complete	Called when the data stage of the request is complete

---

Variable Documentation

struct _ddma_sg_buffer_setup packed

Descriptor DMA SG Buffer setup structure (SG buffer).

This structure is also used for setting up a buffer for Circular DDMA.

---