1/* SPDX-License-Identifier: GPL-2.0 */
2/**
3 * xhci-dbgcap.h - xHCI debug capability support
4 *
5 * Copyright (C) 2017 Intel Corporation
6 *
7 * Author: Lu Baolu <baolu.lu@linux.intel.com>
8 */
9#ifndef __LINUX_XHCI_DBGCAP_H
10#define __LINUX_XHCI_DBGCAP_H
11
12#include <linux/tty.h>
13#include <linux/kfifo.h>
14
15struct dbc_regs {
16 __le32 capability;
17 __le32 doorbell;
18 __le32 ersts; /* Event Ring Segment Table Size*/
19 __le32 __reserved_0; /* 0c~0f reserved bits */
20 __le64 erstba; /* Event Ring Segment Table Base Address */
21 __le64 erdp; /* Event Ring Dequeue Pointer */
22 __le32 control;
23 __le32 status;
24 __le32 portsc; /* Port status and control */
25 __le32 __reserved_1; /* 2b~28 reserved bits */
26 __le64 dccp; /* Debug Capability Context Pointer */
27 __le32 devinfo1; /* Device Descriptor Info Register 1 */
28 __le32 devinfo2; /* Device Descriptor Info Register 2 */
29};
30
31struct dbc_info_context {
32 __le64 string0;
33 __le64 manufacturer;
34 __le64 product;
35 __le64 serial;
36 __le32 length;
37 __le32 __reserved_0[7];
38};
39
40#define DBC_CTRL_DBC_RUN BIT(0)
41#define DBC_CTRL_PORT_ENABLE BIT(1)
42#define DBC_CTRL_HALT_OUT_TR BIT(2)
43#define DBC_CTRL_HALT_IN_TR BIT(3)
44#define DBC_CTRL_DBC_RUN_CHANGE BIT(4)
45#define DBC_CTRL_DBC_ENABLE BIT(31)
46#define DBC_CTRL_MAXBURST(p) (((p) >> 16) & 0xff)
47#define DBC_DOOR_BELL_TARGET(p) (((p) & 0xff) << 8)
48
49#define DBC_MAX_PACKET 1024
50#define DBC_MAX_STRING_LENGTH 64
51#define DBC_STRING_MANUFACTURER "Linux Foundation"
52#define DBC_STRING_PRODUCT "Linux USB Debug Target"
53#define DBC_STRING_SERIAL "0001"
54#define DBC_CONTEXT_SIZE 64
55
56/*
57 * Port status:
58 */
59#define DBC_PORTSC_CONN_STATUS BIT(0)
60#define DBC_PORTSC_PORT_ENABLED BIT(1)
61#define DBC_PORTSC_CONN_CHANGE BIT(17)
62#define DBC_PORTSC_RESET_CHANGE BIT(21)
63#define DBC_PORTSC_LINK_CHANGE BIT(22)
64#define DBC_PORTSC_CONFIG_CHANGE BIT(23)
65
66struct dbc_str_descs {
67 char string0[DBC_MAX_STRING_LENGTH];
68 char manufacturer[DBC_MAX_STRING_LENGTH];
69 char product[DBC_MAX_STRING_LENGTH];
70 char serial[DBC_MAX_STRING_LENGTH];
71};
72
73#define DBC_PROTOCOL 1 /* GNU Remote Debug Command */
74#define DBC_VENDOR_ID 0x1d6b /* Linux Foundation 0x1d6b */
75#define DBC_PRODUCT_ID 0x0010 /* device 0010 */
76#define DBC_DEVICE_REV 0x0010 /* 0.10 */
77
78enum dbc_state {
79 DS_DISABLED = 0,
80 DS_INITIALIZED,
81 DS_ENABLED,
82 DS_CONNECTED,
83 DS_CONFIGURED,
84 DS_MAX
85};
86
87struct dbc_ep {
88 struct xhci_dbc *dbc;
89 struct list_head list_pending;
90 struct xhci_ring *ring;
91 unsigned int direction:1;
92 unsigned int halted:1;
93};
94
95#define DBC_QUEUE_SIZE 16
96#define DBC_WRITE_BUF_SIZE 8192
97#define DBC_POLL_INTERVAL_DEFAULT 64 /* milliseconds */
98#define DBC_POLL_INTERVAL_MAX 5000 /* milliseconds */
99#define DBC_XFER_INACTIVITY_TIMEOUT 10 /* milliseconds */
100/*
101 * Private structure for DbC hardware state:
102 */
103struct dbc_port {
104 struct tty_port port;
105 spinlock_t port_lock; /* port access */
106 int minor;
107
108 struct list_head read_pool;
109 struct list_head read_queue;
110 unsigned int n_read;
111 struct tasklet_struct push;
112
113 struct list_head write_pool;
114 unsigned int tx_boundary;
115
116 bool registered;
117 bool tx_running;
118};
119
120struct dbc_driver {
121 int (*configure)(struct xhci_dbc *dbc);
122 void (*disconnect)(struct xhci_dbc *dbc);
123};
124
125struct xhci_dbc {
126 spinlock_t lock; /* device access */
127 struct device *dev;
128 struct xhci_hcd *xhci;
129 struct dbc_regs __iomem *regs;
130 struct xhci_ring *ring_evt;
131 struct xhci_ring *ring_in;
132 struct xhci_ring *ring_out;
133 struct xhci_erst erst;
134 struct xhci_container_ctx *ctx;
135
136 struct dbc_str_descs *string;
137 dma_addr_t string_dma;
138 size_t string_size;
139 u16 idVendor;
140 u16 idProduct;
141 u16 bcdDevice;
142 u8 bInterfaceProtocol;
143
144 enum dbc_state state;
145 struct delayed_work event_work;
146 unsigned int poll_interval; /* ms */
147 unsigned long xfer_timestamp;
148 unsigned resume_required:1;
149 struct dbc_ep eps[2];
150
151 const struct dbc_driver *driver;
152 void *priv;
153};
154
155struct dbc_request {
156 void *buf;
157 unsigned int length;
158 dma_addr_t dma;
159 void (*complete)(struct xhci_dbc *dbc,
160 struct dbc_request *req);
161 struct list_head list_pool;
162 int status;
163 unsigned int actual;
164
165 struct xhci_dbc *dbc;
166 struct list_head list_pending;
167 dma_addr_t trb_dma;
168 union xhci_trb *trb;
169 unsigned direction:1;
170};
171
172#define dbc_bulkout_ctx(d) \
173 ((struct xhci_ep_ctx *)((d)->ctx->bytes + DBC_CONTEXT_SIZE))
174#define dbc_bulkin_ctx(d) \
175 ((struct xhci_ep_ctx *)((d)->ctx->bytes + DBC_CONTEXT_SIZE * 2))
176#define dbc_bulkout_enq(d) \
177 xhci_trb_virt_to_dma((d)->ring_out->enq_seg, (d)->ring_out->enqueue)
178#define dbc_bulkin_enq(d) \
179 xhci_trb_virt_to_dma((d)->ring_in->enq_seg, (d)->ring_in->enqueue)
180#define dbc_epctx_info2(t, p, b) \
181 cpu_to_le32(EP_TYPE(t) | MAX_PACKET(p) | MAX_BURST(b))
182#define dbc_ep_dma_direction(d) \
183 ((d)->direction ? DMA_FROM_DEVICE : DMA_TO_DEVICE)
184
185#define BULK_OUT 0
186#define BULK_IN 1
187#define EPID_OUT 2
188#define EPID_IN 3
189
190enum evtreturn {
191 EVT_ERR = -1,
192 EVT_DONE,
193 EVT_XFER_DONE,
194 EVT_GSER,
195 EVT_DISC,
196};
197
198static inline struct dbc_ep *get_in_ep(struct xhci_dbc *dbc)
199{
200 return &dbc->eps[BULK_IN];
201}
202
203static inline struct dbc_ep *get_out_ep(struct xhci_dbc *dbc)
204{
205 return &dbc->eps[BULK_OUT];
206}
207
208#ifdef CONFIG_USB_XHCI_DBGCAP
209int xhci_create_dbc_dev(struct xhci_hcd *xhci);
210void xhci_remove_dbc_dev(struct xhci_hcd *xhci);
211int xhci_dbc_init(void);
212void xhci_dbc_exit(void);
213int dbc_tty_init(void);
214void dbc_tty_exit(void);
215int xhci_dbc_tty_probe(struct device *dev, void __iomem *res, struct xhci_hcd *xhci);
216void xhci_dbc_tty_remove(struct xhci_dbc *dbc);
217struct xhci_dbc *xhci_alloc_dbc(struct device *dev, void __iomem *res,
218 const struct dbc_driver *driver);
219void xhci_dbc_remove(struct xhci_dbc *dbc);
220struct dbc_request *dbc_alloc_request(struct xhci_dbc *dbc,
221 unsigned int direction,
222 gfp_t flags);
223void dbc_free_request(struct dbc_request *req);
224int dbc_ep_queue(struct dbc_request *req);
225#ifdef CONFIG_PM
226int xhci_dbc_suspend(struct xhci_hcd *xhci);
227int xhci_dbc_resume(struct xhci_hcd *xhci);
228#endif /* CONFIG_PM */
229#else
230static inline int xhci_create_dbc_dev(struct xhci_hcd *xhci)
231{
232 return 0;
233}
234
235static inline void xhci_remove_dbc_dev(struct xhci_hcd *xhci)
236{
237}
238static inline int xhci_dbc_init(void)
239{
240 return 0;
241}
242static inline void xhci_dbc_exit(void)
243{
244}
245static inline int xhci_dbc_suspend(struct xhci_hcd *xhci)
246{
247 return 0;
248}
249
250static inline int xhci_dbc_resume(struct xhci_hcd *xhci)
251{
252 return 0;
253}
254#endif /* CONFIG_USB_XHCI_DBGCAP */
255#endif /* __LINUX_XHCI_DBGCAP_H */
256

source code of linux/drivers/usb/host/xhci-dbgcap.h