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