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};
118
119struct dbc_driver {
120 int (*configure)(struct xhci_dbc *dbc);
121 void (*disconnect)(struct xhci_dbc *dbc);
122};
123
124struct xhci_dbc {
125 spinlock_t lock; /* device access */
126 struct device *dev;
127 struct xhci_hcd *xhci;
128 struct dbc_regs __iomem *regs;
129 struct xhci_ring *ring_evt;
130 struct xhci_ring *ring_in;
131 struct xhci_ring *ring_out;
132 struct xhci_erst erst;
133 struct xhci_container_ctx *ctx;
134
135 struct dbc_str_descs *string;
136 dma_addr_t string_dma;
137 size_t string_size;
138 u16 idVendor;
139 u16 idProduct;
140 u16 bcdDevice;
141 u8 bInterfaceProtocol;
142
143 enum dbc_state state;
144 struct delayed_work event_work;
145 unsigned int poll_interval; /* ms */
146 unsigned long xfer_timestamp;
147 unsigned resume_required:1;
148 struct dbc_ep eps[2];
149
150 const struct dbc_driver *driver;
151 void *priv;
152};
153
154struct dbc_request {
155 void *buf;
156 unsigned int length;
157 dma_addr_t dma;
158 void (*complete)(struct xhci_dbc *dbc,
159 struct dbc_request *req);
160 struct list_head list_pool;
161 int status;
162 unsigned int actual;
163
164 struct xhci_dbc *dbc;
165 struct list_head list_pending;
166 dma_addr_t trb_dma;
167 union xhci_trb *trb;
168 unsigned direction:1;
169};
170
171#define dbc_bulkout_ctx(d) \
172 ((struct xhci_ep_ctx *)((d)->ctx->bytes + DBC_CONTEXT_SIZE))
173#define dbc_bulkin_ctx(d) \
174 ((struct xhci_ep_ctx *)((d)->ctx->bytes + DBC_CONTEXT_SIZE * 2))
175#define dbc_bulkout_enq(d) \
176 xhci_trb_virt_to_dma((d)->ring_out->enq_seg, (d)->ring_out->enqueue)
177#define dbc_bulkin_enq(d) \
178 xhci_trb_virt_to_dma((d)->ring_in->enq_seg, (d)->ring_in->enqueue)
179#define dbc_epctx_info2(t, p, b) \
180 cpu_to_le32(EP_TYPE(t) | MAX_PACKET(p) | MAX_BURST(b))
181#define dbc_ep_dma_direction(d) \
182 ((d)->direction ? DMA_FROM_DEVICE : DMA_TO_DEVICE)
183
184#define BULK_OUT 0
185#define BULK_IN 1
186#define EPID_OUT 2
187#define EPID_IN 3
188
189enum evtreturn {
190 EVT_ERR = -1,
191 EVT_DONE,
192 EVT_XFER_DONE,
193 EVT_GSER,
194 EVT_DISC,
195};
196
197static inline struct dbc_ep *get_in_ep(struct xhci_dbc *dbc)
198{
199 return &dbc->eps[BULK_IN];
200}
201
202static inline struct dbc_ep *get_out_ep(struct xhci_dbc *dbc)
203{
204 return &dbc->eps[BULK_OUT];
205}
206
207#ifdef CONFIG_USB_XHCI_DBGCAP
208int xhci_create_dbc_dev(struct xhci_hcd *xhci);
209void xhci_remove_dbc_dev(struct xhci_hcd *xhci);
210int xhci_dbc_init(void);
211void xhci_dbc_exit(void);
212int dbc_tty_init(void);
213void dbc_tty_exit(void);
214int xhci_dbc_tty_probe(struct device *dev, void __iomem *res, struct xhci_hcd *xhci);
215void xhci_dbc_tty_remove(struct xhci_dbc *dbc);
216struct xhci_dbc *xhci_alloc_dbc(struct device *dev, void __iomem *res,
217 const struct dbc_driver *driver);
218void xhci_dbc_remove(struct xhci_dbc *dbc);
219struct dbc_request *dbc_alloc_request(struct xhci_dbc *dbc,
220 unsigned int direction,
221 gfp_t flags);
222void dbc_free_request(struct dbc_request *req);
223int dbc_ep_queue(struct dbc_request *req);
224#ifdef CONFIG_PM
225int xhci_dbc_suspend(struct xhci_hcd *xhci);
226int xhci_dbc_resume(struct xhci_hcd *xhci);
227#endif /* CONFIG_PM */
228#else
229static inline int xhci_create_dbc_dev(struct xhci_hcd *xhci)
230{
231 return 0;
232}
233
234static inline void xhci_remove_dbc_dev(struct xhci_hcd *xhci)
235{
236}
237static inline int xhci_dbc_init(void)
238{
239 return 0;
240}
241static inline void xhci_dbc_exit(void)
242{
243}
244static inline int xhci_dbc_suspend(struct xhci_hcd *xhci)
245{
246 return 0;
247}
248
249static inline int xhci_dbc_resume(struct xhci_hcd *xhci)
250{
251 return 0;
252}
253#endif /* CONFIG_USB_XHCI_DBGCAP */
254#endif /* __LINUX_XHCI_DBGCAP_H */
255