GNU Linux-libre 6.1.24-gnu
[releases.git] / drivers / usb / early / xhci-dbc.c
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * xhci-dbc.c - xHCI debug capability early driver
4  *
5  * Copyright (C) 2016 Intel Corporation
6  *
7  * Author: Lu Baolu <baolu.lu@linux.intel.com>
8  */
9
10 #define pr_fmt(fmt)     KBUILD_MODNAME ":%s: " fmt, __func__
11
12 #include <linux/console.h>
13 #include <linux/pci_regs.h>
14 #include <linux/pci_ids.h>
15 #include <linux/memblock.h>
16 #include <linux/io.h>
17 #include <asm/pci-direct.h>
18 #include <asm/fixmap.h>
19 #include <linux/bcd.h>
20 #include <linux/export.h>
21 #include <linux/module.h>
22 #include <linux/delay.h>
23 #include <linux/kthread.h>
24 #include <linux/usb/xhci-dbgp.h>
25
26 #include "../host/xhci.h"
27 #include "xhci-dbc.h"
28
29 static struct xdbc_state xdbc;
30 static bool early_console_keep;
31
32 #ifdef XDBC_TRACE
33 #define xdbc_trace      trace_printk
34 #else
35 static inline void xdbc_trace(const char *fmt, ...) { }
36 #endif /* XDBC_TRACE */
37
38 static void __iomem * __init xdbc_map_pci_mmio(u32 bus, u32 dev, u32 func)
39 {
40         u64 val64, sz64, mask64;
41         void __iomem *base;
42         u32 val, sz;
43         u8 byte;
44
45         val = read_pci_config(bus, dev, func, PCI_BASE_ADDRESS_0);
46         write_pci_config(bus, dev, func, PCI_BASE_ADDRESS_0, ~0);
47         sz = read_pci_config(bus, dev, func, PCI_BASE_ADDRESS_0);
48         write_pci_config(bus, dev, func, PCI_BASE_ADDRESS_0, val);
49
50         if (val == 0xffffffff || sz == 0xffffffff) {
51                 pr_notice("invalid mmio bar\n");
52                 return NULL;
53         }
54
55         val64   = val & PCI_BASE_ADDRESS_MEM_MASK;
56         sz64    = sz & PCI_BASE_ADDRESS_MEM_MASK;
57         mask64  = PCI_BASE_ADDRESS_MEM_MASK;
58
59         if ((val & PCI_BASE_ADDRESS_MEM_TYPE_MASK) == PCI_BASE_ADDRESS_MEM_TYPE_64) {
60                 val = read_pci_config(bus, dev, func, PCI_BASE_ADDRESS_0 + 4);
61                 write_pci_config(bus, dev, func, PCI_BASE_ADDRESS_0 + 4, ~0);
62                 sz = read_pci_config(bus, dev, func, PCI_BASE_ADDRESS_0 + 4);
63                 write_pci_config(bus, dev, func, PCI_BASE_ADDRESS_0 + 4, val);
64
65                 val64   |= (u64)val << 32;
66                 sz64    |= (u64)sz << 32;
67                 mask64  |= ~0ULL << 32;
68         }
69
70         sz64 &= mask64;
71
72         if (!sz64) {
73                 pr_notice("invalid mmio address\n");
74                 return NULL;
75         }
76
77         sz64 = 1ULL << __ffs64(sz64);
78
79         /* Check if the mem space is enabled: */
80         byte = read_pci_config_byte(bus, dev, func, PCI_COMMAND);
81         if (!(byte & PCI_COMMAND_MEMORY)) {
82                 byte |= PCI_COMMAND_MEMORY;
83                 write_pci_config_byte(bus, dev, func, PCI_COMMAND, byte);
84         }
85
86         xdbc.xhci_start = val64;
87         xdbc.xhci_length = sz64;
88         base = early_ioremap(val64, sz64);
89
90         return base;
91 }
92
93 static void * __init xdbc_get_page(dma_addr_t *dma_addr)
94 {
95         void *virt;
96
97         virt = memblock_alloc(PAGE_SIZE, PAGE_SIZE);
98         if (!virt)
99                 return NULL;
100
101         if (dma_addr)
102                 *dma_addr = (dma_addr_t)__pa(virt);
103
104         return virt;
105 }
106
107 static u32 __init xdbc_find_dbgp(int xdbc_num, u32 *b, u32 *d, u32 *f)
108 {
109         u32 bus, dev, func, class;
110
111         for (bus = 0; bus < XDBC_PCI_MAX_BUSES; bus++) {
112                 for (dev = 0; dev < XDBC_PCI_MAX_DEVICES; dev++) {
113                         for (func = 0; func < XDBC_PCI_MAX_FUNCTION; func++) {
114
115                                 class = read_pci_config(bus, dev, func, PCI_CLASS_REVISION);
116                                 if ((class >> 8) != PCI_CLASS_SERIAL_USB_XHCI)
117                                         continue;
118
119                                 if (xdbc_num-- != 0)
120                                         continue;
121
122                                 *b = bus;
123                                 *d = dev;
124                                 *f = func;
125
126                                 return 0;
127                         }
128                 }
129         }
130
131         return -1;
132 }
133
134 static int handshake(void __iomem *ptr, u32 mask, u32 done, int wait, int delay)
135 {
136         u32 result;
137
138         /* Can not use readl_poll_timeout_atomic() for early boot things */
139         do {
140                 result = readl(ptr);
141                 result &= mask;
142                 if (result == done)
143                         return 0;
144                 udelay(delay);
145                 wait -= delay;
146         } while (wait > 0);
147
148         return -ETIMEDOUT;
149 }
150
151 static void __init xdbc_bios_handoff(void)
152 {
153         int offset, timeout;
154         u32 val;
155
156         offset = xhci_find_next_ext_cap(xdbc.xhci_base, 0, XHCI_EXT_CAPS_LEGACY);
157         val = readl(xdbc.xhci_base + offset);
158
159         if (val & XHCI_HC_BIOS_OWNED) {
160                 writel(val | XHCI_HC_OS_OWNED, xdbc.xhci_base + offset);
161                 timeout = handshake(xdbc.xhci_base + offset, XHCI_HC_BIOS_OWNED, 0, 5000, 10);
162
163                 if (timeout) {
164                         pr_notice("failed to hand over xHCI control from BIOS\n");
165                         writel(val & ~XHCI_HC_BIOS_OWNED, xdbc.xhci_base + offset);
166                 }
167         }
168
169         /* Disable BIOS SMIs and clear all SMI events: */
170         val = readl(xdbc.xhci_base + offset + XHCI_LEGACY_CONTROL_OFFSET);
171         val &= XHCI_LEGACY_DISABLE_SMI;
172         val |= XHCI_LEGACY_SMI_EVENTS;
173         writel(val, xdbc.xhci_base + offset + XHCI_LEGACY_CONTROL_OFFSET);
174 }
175
176 static int __init
177 xdbc_alloc_ring(struct xdbc_segment *seg, struct xdbc_ring *ring)
178 {
179         seg->trbs = xdbc_get_page(&seg->dma);
180         if (!seg->trbs)
181                 return -ENOMEM;
182
183         ring->segment = seg;
184
185         return 0;
186 }
187
188 static void __init xdbc_free_ring(struct xdbc_ring *ring)
189 {
190         struct xdbc_segment *seg = ring->segment;
191
192         if (!seg)
193                 return;
194
195         memblock_phys_free(seg->dma, PAGE_SIZE);
196         ring->segment = NULL;
197 }
198
199 static void xdbc_reset_ring(struct xdbc_ring *ring)
200 {
201         struct xdbc_segment *seg = ring->segment;
202         struct xdbc_trb *link_trb;
203
204         memset(seg->trbs, 0, PAGE_SIZE);
205
206         ring->enqueue = seg->trbs;
207         ring->dequeue = seg->trbs;
208         ring->cycle_state = 1;
209
210         if (ring != &xdbc.evt_ring) {
211                 link_trb = &seg->trbs[XDBC_TRBS_PER_SEGMENT - 1];
212                 link_trb->field[0] = cpu_to_le32(lower_32_bits(seg->dma));
213                 link_trb->field[1] = cpu_to_le32(upper_32_bits(seg->dma));
214                 link_trb->field[3] = cpu_to_le32(TRB_TYPE(TRB_LINK)) | cpu_to_le32(LINK_TOGGLE);
215         }
216 }
217
218 static inline void xdbc_put_utf16(u16 *s, const char *c, size_t size)
219 {
220         int i;
221
222         for (i = 0; i < size; i++)
223                 s[i] = cpu_to_le16(c[i]);
224 }
225
226 static void xdbc_mem_init(void)
227 {
228         struct xdbc_ep_context *ep_in, *ep_out;
229         struct usb_string_descriptor *s_desc;
230         struct xdbc_erst_entry *entry;
231         struct xdbc_strings *strings;
232         struct xdbc_context *ctx;
233         unsigned int max_burst;
234         u32 string_length;
235         int index = 0;
236         u32 dev_info;
237
238         xdbc_reset_ring(&xdbc.evt_ring);
239         xdbc_reset_ring(&xdbc.in_ring);
240         xdbc_reset_ring(&xdbc.out_ring);
241         memset(xdbc.table_base, 0, PAGE_SIZE);
242         memset(xdbc.out_buf, 0, PAGE_SIZE);
243
244         /* Initialize event ring segment table: */
245         xdbc.erst_size  = 16;
246         xdbc.erst_base  = xdbc.table_base + index * XDBC_TABLE_ENTRY_SIZE;
247         xdbc.erst_dma   = xdbc.table_dma + index * XDBC_TABLE_ENTRY_SIZE;
248
249         index += XDBC_ERST_ENTRY_NUM;
250         entry = (struct xdbc_erst_entry *)xdbc.erst_base;
251
252         entry->seg_addr         = cpu_to_le64(xdbc.evt_seg.dma);
253         entry->seg_size         = cpu_to_le32(XDBC_TRBS_PER_SEGMENT);
254         entry->__reserved_0     = 0;
255
256         /* Initialize ERST registers: */
257         writel(1, &xdbc.xdbc_reg->ersts);
258         xdbc_write64(xdbc.erst_dma, &xdbc.xdbc_reg->erstba);
259         xdbc_write64(xdbc.evt_seg.dma, &xdbc.xdbc_reg->erdp);
260
261         /* Debug capability contexts: */
262         xdbc.dbcc_size  = 64 * 3;
263         xdbc.dbcc_base  = xdbc.table_base + index * XDBC_TABLE_ENTRY_SIZE;
264         xdbc.dbcc_dma   = xdbc.table_dma + index * XDBC_TABLE_ENTRY_SIZE;
265
266         index += XDBC_DBCC_ENTRY_NUM;
267
268         /* Popluate the strings: */
269         xdbc.string_size = sizeof(struct xdbc_strings);
270         xdbc.string_base = xdbc.table_base + index * XDBC_TABLE_ENTRY_SIZE;
271         xdbc.string_dma  = xdbc.table_dma + index * XDBC_TABLE_ENTRY_SIZE;
272         strings          = (struct xdbc_strings *)xdbc.string_base;
273
274         index += XDBC_STRING_ENTRY_NUM;
275
276         /* Serial string: */
277         s_desc                  = (struct usb_string_descriptor *)strings->serial;
278         s_desc->bLength         = (strlen(XDBC_STRING_SERIAL) + 1) * 2;
279         s_desc->bDescriptorType = USB_DT_STRING;
280
281         xdbc_put_utf16(s_desc->wData, XDBC_STRING_SERIAL, strlen(XDBC_STRING_SERIAL));
282         string_length = s_desc->bLength;
283         string_length <<= 8;
284
285         /* Product string: */
286         s_desc                  = (struct usb_string_descriptor *)strings->product;
287         s_desc->bLength         = (strlen(XDBC_STRING_PRODUCT) + 1) * 2;
288         s_desc->bDescriptorType = USB_DT_STRING;
289
290         xdbc_put_utf16(s_desc->wData, XDBC_STRING_PRODUCT, strlen(XDBC_STRING_PRODUCT));
291         string_length += s_desc->bLength;
292         string_length <<= 8;
293
294         /* Manufacture string: */
295         s_desc                  = (struct usb_string_descriptor *)strings->manufacturer;
296         s_desc->bLength         = (strlen(XDBC_STRING_MANUFACTURER) + 1) * 2;
297         s_desc->bDescriptorType = USB_DT_STRING;
298
299         xdbc_put_utf16(s_desc->wData, XDBC_STRING_MANUFACTURER, strlen(XDBC_STRING_MANUFACTURER));
300         string_length += s_desc->bLength;
301         string_length <<= 8;
302
303         /* String0: */
304         strings->string0[0]     = 4;
305         strings->string0[1]     = USB_DT_STRING;
306         strings->string0[2]     = 0x09;
307         strings->string0[3]     = 0x04;
308
309         string_length += 4;
310
311         /* Populate info Context: */
312         ctx = (struct xdbc_context *)xdbc.dbcc_base;
313
314         ctx->info.string0       = cpu_to_le64(xdbc.string_dma);
315         ctx->info.manufacturer  = cpu_to_le64(xdbc.string_dma + XDBC_MAX_STRING_LENGTH);
316         ctx->info.product       = cpu_to_le64(xdbc.string_dma + XDBC_MAX_STRING_LENGTH * 2);
317         ctx->info.serial        = cpu_to_le64(xdbc.string_dma + XDBC_MAX_STRING_LENGTH * 3);
318         ctx->info.length        = cpu_to_le32(string_length);
319
320         /* Populate bulk out endpoint context: */
321         max_burst = DEBUG_MAX_BURST(readl(&xdbc.xdbc_reg->control));
322         ep_out = (struct xdbc_ep_context *)&ctx->out;
323
324         ep_out->ep_info1        = 0;
325         ep_out->ep_info2        = cpu_to_le32(EP_TYPE(BULK_OUT_EP) | MAX_PACKET(1024) | MAX_BURST(max_burst));
326         ep_out->deq             = cpu_to_le64(xdbc.out_seg.dma | xdbc.out_ring.cycle_state);
327
328         /* Populate bulk in endpoint context: */
329         ep_in = (struct xdbc_ep_context *)&ctx->in;
330
331         ep_in->ep_info1         = 0;
332         ep_in->ep_info2         = cpu_to_le32(EP_TYPE(BULK_IN_EP) | MAX_PACKET(1024) | MAX_BURST(max_burst));
333         ep_in->deq              = cpu_to_le64(xdbc.in_seg.dma | xdbc.in_ring.cycle_state);
334
335         /* Set DbC context and info registers: */
336         xdbc_write64(xdbc.dbcc_dma, &xdbc.xdbc_reg->dccp);
337
338         dev_info = cpu_to_le32((XDBC_VENDOR_ID << 16) | XDBC_PROTOCOL);
339         writel(dev_info, &xdbc.xdbc_reg->devinfo1);
340
341         dev_info = cpu_to_le32((XDBC_DEVICE_REV << 16) | XDBC_PRODUCT_ID);
342         writel(dev_info, &xdbc.xdbc_reg->devinfo2);
343
344         xdbc.in_buf = xdbc.out_buf + XDBC_MAX_PACKET;
345         xdbc.in_dma = xdbc.out_dma + XDBC_MAX_PACKET;
346 }
347
348 static void xdbc_do_reset_debug_port(u32 id, u32 count)
349 {
350         void __iomem *ops_reg;
351         void __iomem *portsc;
352         u32 val, cap_length;
353         int i;
354
355         cap_length = readl(xdbc.xhci_base) & 0xff;
356         ops_reg = xdbc.xhci_base + cap_length;
357
358         id--;
359         for (i = id; i < (id + count); i++) {
360                 portsc = ops_reg + 0x400 + i * 0x10;
361                 val = readl(portsc);
362                 if (!(val & PORT_CONNECT))
363                         writel(val | PORT_RESET, portsc);
364         }
365 }
366
367 static void xdbc_reset_debug_port(void)
368 {
369         u32 val, port_offset, port_count;
370         int offset = 0;
371
372         do {
373                 offset = xhci_find_next_ext_cap(xdbc.xhci_base, offset, XHCI_EXT_CAPS_PROTOCOL);
374                 if (!offset)
375                         break;
376
377                 val = readl(xdbc.xhci_base + offset);
378                 if (XHCI_EXT_PORT_MAJOR(val) != 0x3)
379                         continue;
380
381                 val = readl(xdbc.xhci_base + offset + 8);
382                 port_offset = XHCI_EXT_PORT_OFF(val);
383                 port_count = XHCI_EXT_PORT_COUNT(val);
384
385                 xdbc_do_reset_debug_port(port_offset, port_count);
386         } while (1);
387 }
388
389 static void
390 xdbc_queue_trb(struct xdbc_ring *ring, u32 field1, u32 field2, u32 field3, u32 field4)
391 {
392         struct xdbc_trb *trb, *link_trb;
393
394         trb = ring->enqueue;
395         trb->field[0] = cpu_to_le32(field1);
396         trb->field[1] = cpu_to_le32(field2);
397         trb->field[2] = cpu_to_le32(field3);
398         trb->field[3] = cpu_to_le32(field4);
399
400         ++(ring->enqueue);
401         if (ring->enqueue >= &ring->segment->trbs[TRBS_PER_SEGMENT - 1]) {
402                 link_trb = ring->enqueue;
403                 if (ring->cycle_state)
404                         link_trb->field[3] |= cpu_to_le32(TRB_CYCLE);
405                 else
406                         link_trb->field[3] &= cpu_to_le32(~TRB_CYCLE);
407
408                 ring->enqueue = ring->segment->trbs;
409                 ring->cycle_state ^= 1;
410         }
411 }
412
413 static void xdbc_ring_doorbell(int target)
414 {
415         writel(DOOR_BELL_TARGET(target), &xdbc.xdbc_reg->doorbell);
416 }
417
418 static int xdbc_start(void)
419 {
420         u32 ctrl, status;
421         int ret;
422
423         ctrl = readl(&xdbc.xdbc_reg->control);
424         writel(ctrl | CTRL_DBC_ENABLE | CTRL_PORT_ENABLE, &xdbc.xdbc_reg->control);
425         ret = handshake(&xdbc.xdbc_reg->control, CTRL_DBC_ENABLE, CTRL_DBC_ENABLE, 100000, 100);
426         if (ret) {
427                 xdbc_trace("failed to initialize hardware\n");
428                 return ret;
429         }
430
431         /* Reset port to avoid bus hang: */
432         if (xdbc.vendor == PCI_VENDOR_ID_INTEL)
433                 xdbc_reset_debug_port();
434
435         /* Wait for port connection: */
436         ret = handshake(&xdbc.xdbc_reg->portsc, PORTSC_CONN_STATUS, PORTSC_CONN_STATUS, 5000000, 100);
437         if (ret) {
438                 xdbc_trace("waiting for connection timed out\n");
439                 return ret;
440         }
441
442         /* Wait for debug device to be configured: */
443         ret = handshake(&xdbc.xdbc_reg->control, CTRL_DBC_RUN, CTRL_DBC_RUN, 5000000, 100);
444         if (ret) {
445                 xdbc_trace("waiting for device configuration timed out\n");
446                 return ret;
447         }
448
449         /* Check port number: */
450         status = readl(&xdbc.xdbc_reg->status);
451         if (!DCST_DEBUG_PORT(status)) {
452                 xdbc_trace("invalid root hub port number\n");
453                 return -ENODEV;
454         }
455
456         xdbc.port_number = DCST_DEBUG_PORT(status);
457
458         xdbc_trace("DbC is running now, control 0x%08x port ID %d\n",
459                    readl(&xdbc.xdbc_reg->control), xdbc.port_number);
460
461         return 0;
462 }
463
464 static int xdbc_bulk_transfer(void *data, int size, bool read)
465 {
466         struct xdbc_ring *ring;
467         struct xdbc_trb *trb;
468         u32 length, control;
469         u32 cycle;
470         u64 addr;
471
472         if (size > XDBC_MAX_PACKET) {
473                 xdbc_trace("bad parameter, size %d\n", size);
474                 return -EINVAL;
475         }
476
477         if (!(xdbc.flags & XDBC_FLAGS_INITIALIZED) ||
478             !(xdbc.flags & XDBC_FLAGS_CONFIGURED) ||
479             (!read && (xdbc.flags & XDBC_FLAGS_OUT_STALL)) ||
480             (read && (xdbc.flags & XDBC_FLAGS_IN_STALL))) {
481
482                 xdbc_trace("connection not ready, flags %08x\n", xdbc.flags);
483                 return -EIO;
484         }
485
486         ring = (read ? &xdbc.in_ring : &xdbc.out_ring);
487         trb = ring->enqueue;
488         cycle = ring->cycle_state;
489         length = TRB_LEN(size);
490         control = TRB_TYPE(TRB_NORMAL) | TRB_IOC;
491
492         if (cycle)
493                 control &= cpu_to_le32(~TRB_CYCLE);
494         else
495                 control |= cpu_to_le32(TRB_CYCLE);
496
497         if (read) {
498                 memset(xdbc.in_buf, 0, XDBC_MAX_PACKET);
499                 addr = xdbc.in_dma;
500                 xdbc.flags |= XDBC_FLAGS_IN_PROCESS;
501         } else {
502                 memset(xdbc.out_buf, 0, XDBC_MAX_PACKET);
503                 memcpy(xdbc.out_buf, data, size);
504                 addr = xdbc.out_dma;
505                 xdbc.flags |= XDBC_FLAGS_OUT_PROCESS;
506         }
507
508         xdbc_queue_trb(ring, lower_32_bits(addr), upper_32_bits(addr), length, control);
509
510         /*
511          * Add a barrier between writes of trb fields and flipping
512          * the cycle bit:
513          */
514         wmb();
515         if (cycle)
516                 trb->field[3] |= cpu_to_le32(cycle);
517         else
518                 trb->field[3] &= cpu_to_le32(~TRB_CYCLE);
519
520         xdbc_ring_doorbell(read ? IN_EP_DOORBELL : OUT_EP_DOORBELL);
521
522         return size;
523 }
524
525 static int xdbc_handle_external_reset(void)
526 {
527         int ret = 0;
528
529         xdbc.flags = 0;
530         writel(0, &xdbc.xdbc_reg->control);
531         ret = handshake(&xdbc.xdbc_reg->control, CTRL_DBC_ENABLE, 0, 100000, 10);
532         if (ret)
533                 goto reset_out;
534
535         xdbc_mem_init();
536
537         ret = xdbc_start();
538         if (ret < 0)
539                 goto reset_out;
540
541         xdbc_trace("dbc recovered\n");
542
543         xdbc.flags |= XDBC_FLAGS_INITIALIZED | XDBC_FLAGS_CONFIGURED;
544
545         xdbc_bulk_transfer(NULL, XDBC_MAX_PACKET, true);
546
547         return 0;
548
549 reset_out:
550         xdbc_trace("failed to recover from external reset\n");
551         return ret;
552 }
553
554 static int __init xdbc_early_setup(void)
555 {
556         int ret;
557
558         writel(0, &xdbc.xdbc_reg->control);
559         ret = handshake(&xdbc.xdbc_reg->control, CTRL_DBC_ENABLE, 0, 100000, 100);
560         if (ret)
561                 return ret;
562
563         /* Allocate the table page: */
564         xdbc.table_base = xdbc_get_page(&xdbc.table_dma);
565         if (!xdbc.table_base)
566                 return -ENOMEM;
567
568         /* Get and store the transfer buffer: */
569         xdbc.out_buf = xdbc_get_page(&xdbc.out_dma);
570         if (!xdbc.out_buf)
571                 return -ENOMEM;
572
573         /* Allocate the event ring: */
574         ret = xdbc_alloc_ring(&xdbc.evt_seg, &xdbc.evt_ring);
575         if (ret < 0)
576                 return ret;
577
578         /* Allocate IN/OUT endpoint transfer rings: */
579         ret = xdbc_alloc_ring(&xdbc.in_seg, &xdbc.in_ring);
580         if (ret < 0)
581                 return ret;
582
583         ret = xdbc_alloc_ring(&xdbc.out_seg, &xdbc.out_ring);
584         if (ret < 0)
585                 return ret;
586
587         xdbc_mem_init();
588
589         ret = xdbc_start();
590         if (ret < 0) {
591                 writel(0, &xdbc.xdbc_reg->control);
592                 return ret;
593         }
594
595         xdbc.flags |= XDBC_FLAGS_INITIALIZED | XDBC_FLAGS_CONFIGURED;
596
597         xdbc_bulk_transfer(NULL, XDBC_MAX_PACKET, true);
598
599         return 0;
600 }
601
602 int __init early_xdbc_parse_parameter(char *s, int keep_early)
603 {
604         unsigned long dbgp_num = 0;
605         u32 bus, dev, func, offset;
606         char *e;
607         int ret;
608
609         if (!early_pci_allowed())
610                 return -EPERM;
611
612         early_console_keep = keep_early;
613
614         if (xdbc.xdbc_reg)
615                 return 0;
616
617         if (*s) {
618                dbgp_num = simple_strtoul(s, &e, 10);
619                if (s == e)
620                        dbgp_num = 0;
621         }
622
623         pr_notice("dbgp_num: %lu\n", dbgp_num);
624
625         /* Locate the host controller: */
626         ret = xdbc_find_dbgp(dbgp_num, &bus, &dev, &func);
627         if (ret) {
628                 pr_notice("failed to locate xhci host\n");
629                 return -ENODEV;
630         }
631
632         xdbc.vendor     = read_pci_config_16(bus, dev, func, PCI_VENDOR_ID);
633         xdbc.device     = read_pci_config_16(bus, dev, func, PCI_DEVICE_ID);
634         xdbc.bus        = bus;
635         xdbc.dev        = dev;
636         xdbc.func       = func;
637
638         /* Map the IO memory: */
639         xdbc.xhci_base = xdbc_map_pci_mmio(bus, dev, func);
640         if (!xdbc.xhci_base)
641                 return -EINVAL;
642
643         /* Locate DbC registers: */
644         offset = xhci_find_next_ext_cap(xdbc.xhci_base, 0, XHCI_EXT_CAPS_DEBUG);
645         if (!offset) {
646                 pr_notice("xhci host doesn't support debug capability\n");
647                 early_iounmap(xdbc.xhci_base, xdbc.xhci_length);
648                 xdbc.xhci_base = NULL;
649                 xdbc.xhci_length = 0;
650
651                 return -ENODEV;
652         }
653         xdbc.xdbc_reg = (struct xdbc_regs __iomem *)(xdbc.xhci_base + offset);
654
655         return 0;
656 }
657
658 int __init early_xdbc_setup_hardware(void)
659 {
660         int ret;
661
662         if (!xdbc.xdbc_reg)
663                 return -ENODEV;
664
665         xdbc_bios_handoff();
666
667         raw_spin_lock_init(&xdbc.lock);
668
669         ret = xdbc_early_setup();
670         if (ret) {
671                 pr_notice("failed to setup the connection to host\n");
672
673                 xdbc_free_ring(&xdbc.evt_ring);
674                 xdbc_free_ring(&xdbc.out_ring);
675                 xdbc_free_ring(&xdbc.in_ring);
676
677                 if (xdbc.table_dma)
678                         memblock_phys_free(xdbc.table_dma, PAGE_SIZE);
679
680                 if (xdbc.out_dma)
681                         memblock_phys_free(xdbc.out_dma, PAGE_SIZE);
682
683                 xdbc.table_base = NULL;
684                 xdbc.out_buf = NULL;
685         }
686
687         return ret;
688 }
689
690 static void xdbc_handle_port_status(struct xdbc_trb *evt_trb)
691 {
692         u32 port_reg;
693
694         port_reg = readl(&xdbc.xdbc_reg->portsc);
695         if (port_reg & PORTSC_CONN_CHANGE) {
696                 xdbc_trace("connect status change event\n");
697
698                 /* Check whether cable unplugged: */
699                 if (!(port_reg & PORTSC_CONN_STATUS)) {
700                         xdbc.flags = 0;
701                         xdbc_trace("cable unplugged\n");
702                 }
703         }
704
705         if (port_reg & PORTSC_RESET_CHANGE)
706                 xdbc_trace("port reset change event\n");
707
708         if (port_reg & PORTSC_LINK_CHANGE)
709                 xdbc_trace("port link status change event\n");
710
711         if (port_reg & PORTSC_CONFIG_CHANGE)
712                 xdbc_trace("config error change\n");
713
714         /* Write back the value to clear RW1C bits: */
715         writel(port_reg, &xdbc.xdbc_reg->portsc);
716 }
717
718 static void xdbc_handle_tx_event(struct xdbc_trb *evt_trb)
719 {
720         u32 comp_code;
721         int ep_id;
722
723         comp_code       = GET_COMP_CODE(le32_to_cpu(evt_trb->field[2]));
724         ep_id           = TRB_TO_EP_ID(le32_to_cpu(evt_trb->field[3]));
725
726         switch (comp_code) {
727         case COMP_SUCCESS:
728         case COMP_SHORT_PACKET:
729                 break;
730         case COMP_TRB_ERROR:
731         case COMP_BABBLE_DETECTED_ERROR:
732         case COMP_USB_TRANSACTION_ERROR:
733         case COMP_STALL_ERROR:
734         default:
735                 if (ep_id == XDBC_EPID_OUT || ep_id == XDBC_EPID_OUT_INTEL)
736                         xdbc.flags |= XDBC_FLAGS_OUT_STALL;
737                 if (ep_id == XDBC_EPID_IN || ep_id == XDBC_EPID_IN_INTEL)
738                         xdbc.flags |= XDBC_FLAGS_IN_STALL;
739
740                 xdbc_trace("endpoint %d stalled\n", ep_id);
741                 break;
742         }
743
744         if (ep_id == XDBC_EPID_IN || ep_id == XDBC_EPID_IN_INTEL) {
745                 xdbc.flags &= ~XDBC_FLAGS_IN_PROCESS;
746                 xdbc_bulk_transfer(NULL, XDBC_MAX_PACKET, true);
747         } else if (ep_id == XDBC_EPID_OUT || ep_id == XDBC_EPID_OUT_INTEL) {
748                 xdbc.flags &= ~XDBC_FLAGS_OUT_PROCESS;
749         } else {
750                 xdbc_trace("invalid endpoint id %d\n", ep_id);
751         }
752 }
753
754 static void xdbc_handle_events(void)
755 {
756         struct xdbc_trb *evt_trb;
757         bool update_erdp = false;
758         u32 reg;
759         u8 cmd;
760
761         cmd = read_pci_config_byte(xdbc.bus, xdbc.dev, xdbc.func, PCI_COMMAND);
762         if (!(cmd & PCI_COMMAND_MASTER)) {
763                 cmd |= PCI_COMMAND_MASTER | PCI_COMMAND_MEMORY;
764                 write_pci_config_byte(xdbc.bus, xdbc.dev, xdbc.func, PCI_COMMAND, cmd);
765         }
766
767         if (!(xdbc.flags & XDBC_FLAGS_INITIALIZED))
768                 return;
769
770         /* Handle external reset events: */
771         reg = readl(&xdbc.xdbc_reg->control);
772         if (!(reg & CTRL_DBC_ENABLE)) {
773                 if (xdbc_handle_external_reset()) {
774                         xdbc_trace("failed to recover connection\n");
775                         return;
776                 }
777         }
778
779         /* Handle configure-exit event: */
780         reg = readl(&xdbc.xdbc_reg->control);
781         if (reg & CTRL_DBC_RUN_CHANGE) {
782                 writel(reg, &xdbc.xdbc_reg->control);
783                 if (reg & CTRL_DBC_RUN)
784                         xdbc.flags |= XDBC_FLAGS_CONFIGURED;
785                 else
786                         xdbc.flags &= ~XDBC_FLAGS_CONFIGURED;
787         }
788
789         /* Handle endpoint stall event: */
790         reg = readl(&xdbc.xdbc_reg->control);
791         if (reg & CTRL_HALT_IN_TR) {
792                 xdbc.flags |= XDBC_FLAGS_IN_STALL;
793         } else {
794                 xdbc.flags &= ~XDBC_FLAGS_IN_STALL;
795                 if (!(xdbc.flags & XDBC_FLAGS_IN_PROCESS))
796                         xdbc_bulk_transfer(NULL, XDBC_MAX_PACKET, true);
797         }
798
799         if (reg & CTRL_HALT_OUT_TR)
800                 xdbc.flags |= XDBC_FLAGS_OUT_STALL;
801         else
802                 xdbc.flags &= ~XDBC_FLAGS_OUT_STALL;
803
804         /* Handle the events in the event ring: */
805         evt_trb = xdbc.evt_ring.dequeue;
806         while ((le32_to_cpu(evt_trb->field[3]) & TRB_CYCLE) == xdbc.evt_ring.cycle_state) {
807                 /*
808                  * Add a barrier between reading the cycle flag and any
809                  * reads of the event's flags/data below:
810                  */
811                 rmb();
812
813                 switch ((le32_to_cpu(evt_trb->field[3]) & TRB_TYPE_BITMASK)) {
814                 case TRB_TYPE(TRB_PORT_STATUS):
815                         xdbc_handle_port_status(evt_trb);
816                         break;
817                 case TRB_TYPE(TRB_TRANSFER):
818                         xdbc_handle_tx_event(evt_trb);
819                         break;
820                 default:
821                         break;
822                 }
823
824                 ++(xdbc.evt_ring.dequeue);
825                 if (xdbc.evt_ring.dequeue == &xdbc.evt_seg.trbs[TRBS_PER_SEGMENT]) {
826                         xdbc.evt_ring.dequeue = xdbc.evt_seg.trbs;
827                         xdbc.evt_ring.cycle_state ^= 1;
828                 }
829
830                 evt_trb = xdbc.evt_ring.dequeue;
831                 update_erdp = true;
832         }
833
834         /* Update event ring dequeue pointer: */
835         if (update_erdp)
836                 xdbc_write64(__pa(xdbc.evt_ring.dequeue), &xdbc.xdbc_reg->erdp);
837 }
838
839 static int xdbc_bulk_write(const char *bytes, int size)
840 {
841         int ret, timeout = 0;
842         unsigned long flags;
843
844 retry:
845         if (in_nmi()) {
846                 if (!raw_spin_trylock_irqsave(&xdbc.lock, flags))
847                         return -EAGAIN;
848         } else {
849                 raw_spin_lock_irqsave(&xdbc.lock, flags);
850         }
851
852         xdbc_handle_events();
853
854         /* Check completion of the previous request: */
855         if ((xdbc.flags & XDBC_FLAGS_OUT_PROCESS) && (timeout < 2000000)) {
856                 raw_spin_unlock_irqrestore(&xdbc.lock, flags);
857                 udelay(100);
858                 timeout += 100;
859                 goto retry;
860         }
861
862         if (xdbc.flags & XDBC_FLAGS_OUT_PROCESS) {
863                 raw_spin_unlock_irqrestore(&xdbc.lock, flags);
864                 xdbc_trace("previous transfer not completed yet\n");
865
866                 return -ETIMEDOUT;
867         }
868
869         ret = xdbc_bulk_transfer((void *)bytes, size, false);
870         raw_spin_unlock_irqrestore(&xdbc.lock, flags);
871
872         return ret;
873 }
874
875 static void early_xdbc_write(struct console *con, const char *str, u32 n)
876 {
877         /* static variables are zeroed, so buf is always NULL terminated */
878         static char buf[XDBC_MAX_PACKET + 1];
879         int chunk, ret;
880         int use_cr = 0;
881
882         if (!xdbc.xdbc_reg)
883                 return;
884         memset(buf, 0, XDBC_MAX_PACKET);
885         while (n > 0) {
886                 for (chunk = 0; chunk < XDBC_MAX_PACKET && n > 0; str++, chunk++, n--) {
887
888                         if (!use_cr && *str == '\n') {
889                                 use_cr = 1;
890                                 buf[chunk] = '\r';
891                                 str--;
892                                 n++;
893                                 continue;
894                         }
895
896                         if (use_cr)
897                                 use_cr = 0;
898                         buf[chunk] = *str;
899                 }
900
901                 if (chunk > 0) {
902                         ret = xdbc_bulk_write(buf, chunk);
903                         if (ret < 0)
904                                 xdbc_trace("missed message {%s}\n", buf);
905                 }
906         }
907 }
908
909 static struct console early_xdbc_console = {
910         .name           = "earlyxdbc",
911         .write          = early_xdbc_write,
912         .flags          = CON_PRINTBUFFER,
913         .index          = -1,
914 };
915
916 void __init early_xdbc_register_console(void)
917 {
918         if (early_console)
919                 return;
920
921         early_console = &early_xdbc_console;
922         if (early_console_keep)
923                 early_console->flags &= ~CON_BOOT;
924         else
925                 early_console->flags |= CON_BOOT;
926         register_console(early_console);
927 }
928
929 static void xdbc_unregister_console(void)
930 {
931         if (early_xdbc_console.flags & CON_ENABLED)
932                 unregister_console(&early_xdbc_console);
933 }
934
935 static int xdbc_scrub_function(void *ptr)
936 {
937         unsigned long flags;
938
939         while (true) {
940                 raw_spin_lock_irqsave(&xdbc.lock, flags);
941                 xdbc_handle_events();
942
943                 if (!(xdbc.flags & XDBC_FLAGS_INITIALIZED)) {
944                         raw_spin_unlock_irqrestore(&xdbc.lock, flags);
945                         break;
946                 }
947
948                 raw_spin_unlock_irqrestore(&xdbc.lock, flags);
949                 schedule_timeout_interruptible(1);
950         }
951
952         xdbc_unregister_console();
953         writel(0, &xdbc.xdbc_reg->control);
954         xdbc_trace("dbc scrub function exits\n");
955
956         return 0;
957 }
958
959 static int __init xdbc_init(void)
960 {
961         unsigned long flags;
962         void __iomem *base;
963         int ret = 0;
964         u32 offset;
965
966         if (!(xdbc.flags & XDBC_FLAGS_INITIALIZED))
967                 return 0;
968
969         /*
970          * It's time to shut down the DbC, so that the debug
971          * port can be reused by the host controller:
972          */
973         if (early_xdbc_console.index == -1 ||
974             (early_xdbc_console.flags & CON_BOOT)) {
975                 xdbc_trace("hardware not used anymore\n");
976                 goto free_and_quit;
977         }
978
979         base = ioremap(xdbc.xhci_start, xdbc.xhci_length);
980         if (!base) {
981                 xdbc_trace("failed to remap the io address\n");
982                 ret = -ENOMEM;
983                 goto free_and_quit;
984         }
985
986         raw_spin_lock_irqsave(&xdbc.lock, flags);
987         early_iounmap(xdbc.xhci_base, xdbc.xhci_length);
988         xdbc.xhci_base = base;
989         offset = xhci_find_next_ext_cap(xdbc.xhci_base, 0, XHCI_EXT_CAPS_DEBUG);
990         xdbc.xdbc_reg = (struct xdbc_regs __iomem *)(xdbc.xhci_base + offset);
991         raw_spin_unlock_irqrestore(&xdbc.lock, flags);
992
993         kthread_run(xdbc_scrub_function, NULL, "%s", "xdbc");
994
995         return 0;
996
997 free_and_quit:
998         xdbc_free_ring(&xdbc.evt_ring);
999         xdbc_free_ring(&xdbc.out_ring);
1000         xdbc_free_ring(&xdbc.in_ring);
1001         memblock_phys_free(xdbc.table_dma, PAGE_SIZE);
1002         memblock_phys_free(xdbc.out_dma, PAGE_SIZE);
1003         writel(0, &xdbc.xdbc_reg->control);
1004         early_iounmap(xdbc.xhci_base, xdbc.xhci_length);
1005
1006         return ret;
1007 }
1008 subsys_initcall(xdbc_init);