xref: /OK3568_Linux_fs/kernel/drivers/usb/chipidea/udc.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0 */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * udc.h - ChipIdea UDC structures
4*4882a593Smuzhiyun  *
5*4882a593Smuzhiyun  * Copyright (C) 2008 Chipidea - MIPS Technologies, Inc. All rights reserved.
6*4882a593Smuzhiyun  *
7*4882a593Smuzhiyun  * Author: David Lopo
8*4882a593Smuzhiyun  */
9*4882a593Smuzhiyun 
10*4882a593Smuzhiyun #ifndef __DRIVERS_USB_CHIPIDEA_UDC_H
11*4882a593Smuzhiyun #define __DRIVERS_USB_CHIPIDEA_UDC_H
12*4882a593Smuzhiyun 
13*4882a593Smuzhiyun #include <linux/list.h>
14*4882a593Smuzhiyun 
15*4882a593Smuzhiyun #define CTRL_PAYLOAD_MAX   64
16*4882a593Smuzhiyun #define RX        0  /* similar to USB_DIR_OUT but can be used as an index */
17*4882a593Smuzhiyun #define TX        1  /* similar to USB_DIR_IN  but can be used as an index */
18*4882a593Smuzhiyun 
19*4882a593Smuzhiyun /* DMA layout of transfer descriptors */
20*4882a593Smuzhiyun struct ci_hw_td {
21*4882a593Smuzhiyun 	/* 0 */
22*4882a593Smuzhiyun 	__le32 next;
23*4882a593Smuzhiyun #define TD_TERMINATE          BIT(0)
24*4882a593Smuzhiyun #define TD_ADDR_MASK          (0xFFFFFFEUL << 5)
25*4882a593Smuzhiyun 	/* 1 */
26*4882a593Smuzhiyun 	__le32 token;
27*4882a593Smuzhiyun #define TD_STATUS             (0x00FFUL <<  0)
28*4882a593Smuzhiyun #define TD_STATUS_TR_ERR      BIT(3)
29*4882a593Smuzhiyun #define TD_STATUS_DT_ERR      BIT(5)
30*4882a593Smuzhiyun #define TD_STATUS_HALTED      BIT(6)
31*4882a593Smuzhiyun #define TD_STATUS_ACTIVE      BIT(7)
32*4882a593Smuzhiyun #define TD_MULTO              (0x0003UL << 10)
33*4882a593Smuzhiyun #define TD_IOC                BIT(15)
34*4882a593Smuzhiyun #define TD_TOTAL_BYTES        (0x7FFFUL << 16)
35*4882a593Smuzhiyun 	/* 2 */
36*4882a593Smuzhiyun 	__le32 page[5];
37*4882a593Smuzhiyun #define TD_CURR_OFFSET        (0x0FFFUL <<  0)
38*4882a593Smuzhiyun #define TD_FRAME_NUM          (0x07FFUL <<  0)
39*4882a593Smuzhiyun #define TD_RESERVED_MASK      (0x0FFFUL <<  0)
40*4882a593Smuzhiyun } __attribute__ ((packed, aligned(4)));
41*4882a593Smuzhiyun 
42*4882a593Smuzhiyun /* DMA layout of queue heads */
43*4882a593Smuzhiyun struct ci_hw_qh {
44*4882a593Smuzhiyun 	/* 0 */
45*4882a593Smuzhiyun 	__le32 cap;
46*4882a593Smuzhiyun #define QH_IOS                BIT(15)
47*4882a593Smuzhiyun #define QH_MAX_PKT            (0x07FFUL << 16)
48*4882a593Smuzhiyun #define QH_ZLT                BIT(29)
49*4882a593Smuzhiyun #define QH_MULT               (0x0003UL << 30)
50*4882a593Smuzhiyun #define QH_ISO_MULT(x)		((x >> 11) & 0x03)
51*4882a593Smuzhiyun 	/* 1 */
52*4882a593Smuzhiyun 	__le32 curr;
53*4882a593Smuzhiyun 	/* 2 - 8 */
54*4882a593Smuzhiyun 	struct ci_hw_td		td;
55*4882a593Smuzhiyun 	/* 9 */
56*4882a593Smuzhiyun 	__le32 RESERVED;
57*4882a593Smuzhiyun 	struct usb_ctrlrequest   setup;
58*4882a593Smuzhiyun } __attribute__ ((packed, aligned(4)));
59*4882a593Smuzhiyun 
60*4882a593Smuzhiyun struct td_node {
61*4882a593Smuzhiyun 	struct list_head	td;
62*4882a593Smuzhiyun 	dma_addr_t		dma;
63*4882a593Smuzhiyun 	struct ci_hw_td		*ptr;
64*4882a593Smuzhiyun 	int			td_remaining_size;
65*4882a593Smuzhiyun };
66*4882a593Smuzhiyun 
67*4882a593Smuzhiyun /**
68*4882a593Smuzhiyun  * struct ci_hw_req - usb request representation
69*4882a593Smuzhiyun  * @req: request structure for gadget drivers
70*4882a593Smuzhiyun  * @queue: link to QH list
71*4882a593Smuzhiyun  * @tds: link to TD list
72*4882a593Smuzhiyun  */
73*4882a593Smuzhiyun struct ci_hw_req {
74*4882a593Smuzhiyun 	struct usb_request	req;
75*4882a593Smuzhiyun 	struct list_head	queue;
76*4882a593Smuzhiyun 	struct list_head	tds;
77*4882a593Smuzhiyun };
78*4882a593Smuzhiyun 
79*4882a593Smuzhiyun #ifdef CONFIG_USB_CHIPIDEA_UDC
80*4882a593Smuzhiyun 
81*4882a593Smuzhiyun int ci_hdrc_gadget_init(struct ci_hdrc *ci);
82*4882a593Smuzhiyun void ci_hdrc_gadget_destroy(struct ci_hdrc *ci);
83*4882a593Smuzhiyun 
84*4882a593Smuzhiyun #else
85*4882a593Smuzhiyun 
ci_hdrc_gadget_init(struct ci_hdrc * ci)86*4882a593Smuzhiyun static inline int ci_hdrc_gadget_init(struct ci_hdrc *ci)
87*4882a593Smuzhiyun {
88*4882a593Smuzhiyun 	return -ENXIO;
89*4882a593Smuzhiyun }
90*4882a593Smuzhiyun 
ci_hdrc_gadget_destroy(struct ci_hdrc * ci)91*4882a593Smuzhiyun static inline void ci_hdrc_gadget_destroy(struct ci_hdrc *ci)
92*4882a593Smuzhiyun {
93*4882a593Smuzhiyun 
94*4882a593Smuzhiyun }
95*4882a593Smuzhiyun 
96*4882a593Smuzhiyun #endif
97*4882a593Smuzhiyun 
98*4882a593Smuzhiyun #endif /* __DRIVERS_USB_CHIPIDEA_UDC_H */
99