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