source: mainline/uspace/drv/bus/usb/ohci/hc.c@ feabe163

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since feabe163 was a1732929, checked in by Ondřej Hlavatý <aearsis@…>, 8 years ago

usb: unified logging

Use logger instead of printf. Logger adds newlines automatically.
  • Property mode set to 100644
File size: 17.1 KB
Line 
1/*
2 * Copyright (c) 2011 Jan Vesely
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * - Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * - Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * - The name of the author may not be used to endorse or promote products
15 * derived from this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29/** @addtogroup drvusbohcihc
30 * @{
31 */
32/** @file
33 * @brief OHCI Host controller driver routines
34 */
35
36#include <assert.h>
37#include <async.h>
38#include <errno.h>
39#include <macros.h>
40#include <mem.h>
41#include <stdlib.h>
42#include <str_error.h>
43#include <stddef.h>
44#include <stdint.h>
45
46#include <usb/debug.h>
47#include <usb/usb.h>
48
49#include "ohci_bus.h"
50#include "ohci_batch.h"
51
52#include "hc.h"
53
54#define OHCI_USED_INTERRUPTS \
55 (I_SO | I_WDH | I_UE | I_RHSC)
56
57static const irq_pio_range_t ohci_pio_ranges[] = {
58 {
59 .base = 0,
60 .size = sizeof(ohci_regs_t)
61 }
62};
63
64static const irq_cmd_t ohci_irq_commands[] = {
65 {
66 .cmd = CMD_PIO_READ_32,
67 .dstarg = 1,
68 .addr = NULL
69 },
70 {
71 .cmd = CMD_AND,
72 .srcarg = 1,
73 .dstarg = 2,
74 .value = 0
75 },
76 {
77 .cmd = CMD_PREDICATE,
78 .srcarg = 2,
79 .value = 2
80 },
81 {
82 .cmd = CMD_PIO_WRITE_A_32,
83 .srcarg = 1,
84 .addr = NULL
85 },
86 {
87 .cmd = CMD_ACCEPT
88 }
89};
90
91static int hc_init_transfer_lists(hc_t *instance);
92static int hc_init_memory(hc_t *instance);
93
94/** Generate IRQ code.
95 * @param[out] ranges PIO ranges buffer.
96 * @param[in] ranges_size Size of the ranges buffer (bytes).
97 * @param[out] cmds Commands buffer.
98 * @param[in] cmds_size Size of the commands buffer (bytes).
99 * @param[in] hw_res Device's resources.
100 *
101 * @return Error code.
102 */
103int hc_gen_irq_code(irq_code_t *code, hc_device_t *hcd, const hw_res_list_parsed_t *hw_res)
104{
105 assert(code);
106 assert(hw_res);
107
108 if (hw_res->irqs.count != 1 || hw_res->mem_ranges.count != 1)
109 return EINVAL;
110
111 const addr_range_t regs = hw_res->mem_ranges.ranges[0];
112
113 if (RNGSZ(regs) < sizeof(ohci_regs_t))
114 return EOVERFLOW;
115
116 code->ranges = malloc(sizeof(ohci_pio_ranges));
117 if (code->ranges == NULL)
118 return ENOMEM;
119
120 code->cmds = malloc(sizeof(ohci_irq_commands));
121 if (code->cmds == NULL) {
122 free(code->ranges);
123 return ENOMEM;
124 }
125
126 code->rangecount = ARRAY_SIZE(ohci_pio_ranges);
127 code->cmdcount = ARRAY_SIZE(ohci_irq_commands);
128
129 memcpy(code->ranges, ohci_pio_ranges, sizeof(ohci_pio_ranges));
130 code->ranges[0].base = RNGABS(regs);
131
132 memcpy(code->cmds, ohci_irq_commands, sizeof(ohci_irq_commands));
133 ohci_regs_t *registers = (ohci_regs_t *) RNGABSPTR(regs);
134 code->cmds[0].addr = (void *) &registers->interrupt_status;
135 code->cmds[3].addr = (void *) &registers->interrupt_status;
136 OHCI_WR(code->cmds[1].value, OHCI_USED_INTERRUPTS);
137
138 usb_log_debug("Memory mapped regs at %p (size %zu), IRQ %d.",
139 RNGABSPTR(regs), RNGSZ(regs), hw_res->irqs.irqs[0]);
140
141 return hw_res->irqs.irqs[0];
142}
143
144/** Initialize OHCI hc driver structure
145 *
146 * @param[in] instance Memory place for the structure.
147 * @param[in] regs Device's resources
148 * @param[in] interrupts True if w interrupts should be used
149 * @return Error code
150 */
151int hc_add(hc_device_t *hcd, const hw_res_list_parsed_t *hw_res)
152{
153 hc_t *instance = hcd_to_hc(hcd);
154 assert(hw_res);
155 if (hw_res->mem_ranges.count != 1 ||
156 hw_res->mem_ranges.ranges[0].size < sizeof(ohci_regs_t))
157 return EINVAL;
158
159 int ret = pio_enable_range(&hw_res->mem_ranges.ranges[0],
160 (void **) &instance->registers);
161 if (ret != EOK) {
162 usb_log_error("Failed to gain access to registers: %s.",
163 str_error(ret));
164 return ret;
165 }
166 usb_log_debug("Device registers at %" PRIx64 " (%zuB) accessible.",
167 hw_res->mem_ranges.ranges[0].address.absolute,
168 hw_res->mem_ranges.ranges[0].size);
169
170 list_initialize(&instance->pending_batches);
171 fibril_mutex_initialize(&instance->guard);
172
173 ret = hc_init_memory(instance);
174 if (ret != EOK) {
175 usb_log_error("Failed to create OHCI memory structures: %s.",
176 str_error(ret));
177 // TODO: We should disable pio access here
178 return ret;
179 }
180
181 return EOK;
182}
183
184/** Safely dispose host controller internal structures
185 *
186 * @param[in] instance Host controller structure to use.
187 */
188int hc_gone(hc_device_t *instance)
189{
190 assert(instance);
191 /* TODO: implement*/
192 return ENOTSUP;
193}
194
195void hc_enqueue_endpoint(hc_t *instance, const endpoint_t *ep)
196{
197 assert(instance);
198 assert(ep);
199
200 endpoint_list_t *list = &instance->lists[ep->transfer_type];
201 ohci_endpoint_t *ohci_ep = ohci_endpoint_get(ep);
202 assert(list);
203 assert(ohci_ep);
204
205 /* Enqueue ep */
206 switch (ep->transfer_type) {
207 case USB_TRANSFER_CONTROL:
208 OHCI_CLR(instance->registers->control, C_CLE);
209 endpoint_list_add_ep(list, ohci_ep);
210 OHCI_WR(instance->registers->control_current, 0);
211 OHCI_SET(instance->registers->control, C_CLE);
212 break;
213 case USB_TRANSFER_BULK:
214 OHCI_CLR(instance->registers->control, C_BLE);
215 endpoint_list_add_ep(list, ohci_ep);
216 OHCI_WR(instance->registers->bulk_current, 0);
217 OHCI_SET(instance->registers->control, C_BLE);
218 break;
219 case USB_TRANSFER_ISOCHRONOUS:
220 case USB_TRANSFER_INTERRUPT:
221 OHCI_CLR(instance->registers->control, C_PLE | C_IE);
222 endpoint_list_add_ep(list, ohci_ep);
223 OHCI_SET(instance->registers->control, C_PLE | C_IE);
224 break;
225 }
226}
227
228void hc_dequeue_endpoint(hc_t *instance, const endpoint_t *ep)
229{
230 assert(instance);
231 assert(ep);
232
233 /* Dequeue ep */
234 endpoint_list_t *list = &instance->lists[ep->transfer_type];
235 ohci_endpoint_t *ohci_ep = ohci_endpoint_get(ep);
236
237 assert(list);
238 assert(ohci_ep);
239 switch (ep->transfer_type) {
240 case USB_TRANSFER_CONTROL:
241 OHCI_CLR(instance->registers->control, C_CLE);
242 endpoint_list_remove_ep(list, ohci_ep);
243 OHCI_WR(instance->registers->control_current, 0);
244 OHCI_SET(instance->registers->control, C_CLE);
245 break;
246 case USB_TRANSFER_BULK:
247 OHCI_CLR(instance->registers->control, C_BLE);
248 endpoint_list_remove_ep(list, ohci_ep);
249 OHCI_WR(instance->registers->bulk_current, 0);
250 OHCI_SET(instance->registers->control, C_BLE);
251 break;
252 case USB_TRANSFER_ISOCHRONOUS:
253 case USB_TRANSFER_INTERRUPT:
254 OHCI_CLR(instance->registers->control, C_PLE | C_IE);
255 endpoint_list_remove_ep(list, ohci_ep);
256 OHCI_SET(instance->registers->control, C_PLE | C_IE);
257 break;
258 default:
259 break;
260 }
261}
262
263int ohci_hc_status(bus_t *bus_base, uint32_t *status)
264{
265 assert(bus_base);
266 assert(status);
267
268 ohci_bus_t *bus = (ohci_bus_t *) bus_base;
269 hc_t *hc = bus->hc;
270 assert(hc);
271
272 if (hc->registers){
273 *status = OHCI_RD(hc->registers->interrupt_status);
274 OHCI_WR(hc->registers->interrupt_status, *status);
275 }
276 return EOK;
277}
278
279/** Add USB transfer to the schedule.
280 *
281 * @param[in] hcd HCD driver structure.
282 * @param[in] batch Batch representing the transfer.
283 * @return Error code.
284 */
285int ohci_hc_schedule(usb_transfer_batch_t *batch)
286{
287 assert(batch);
288
289 ohci_bus_t *bus = (ohci_bus_t *) endpoint_get_bus(batch->ep);
290 hc_t *hc = bus->hc;
291 assert(hc);
292
293 /* Check for root hub communication */
294 if (batch->target.address == ohci_rh_get_address(&hc->rh)) {
295 usb_log_debug("OHCI root hub request.");
296 return ohci_rh_schedule(&hc->rh, batch);
297 }
298 ohci_transfer_batch_t *ohci_batch = ohci_transfer_batch_get(batch);
299 if (!ohci_batch)
300 return ENOMEM;
301
302 const int err = ohci_transfer_batch_prepare(ohci_batch);
303 if (err)
304 return err;
305
306 fibril_mutex_lock(&hc->guard);
307 list_append(&ohci_batch->link, &hc->pending_batches);
308 ohci_transfer_batch_commit(ohci_batch);
309
310 /* Control and bulk schedules need a kick to start working */
311 switch (batch->ep->transfer_type)
312 {
313 case USB_TRANSFER_CONTROL:
314 OHCI_SET(hc->registers->command_status, CS_CLF);
315 break;
316 case USB_TRANSFER_BULK:
317 OHCI_SET(hc->registers->command_status, CS_BLF);
318 break;
319 default:
320 break;
321 }
322 fibril_mutex_unlock(&hc->guard);
323 return EOK;
324}
325
326/** Interrupt handling routine
327 *
328 * @param[in] hcd HCD driver structure.
329 * @param[in] status Value of the status register at the time of interrupt.
330 */
331void ohci_hc_interrupt(bus_t *bus_base, uint32_t status)
332{
333 assert(bus_base);
334
335 ohci_bus_t *bus = (ohci_bus_t *) bus_base;
336 hc_t *hc = bus->hc;
337 assert(hc);
338
339 status = OHCI_RD(status);
340 assert(hc);
341 if ((status & ~I_SF) == 0) /* ignore sof status */
342 return;
343 usb_log_debug2("OHCI(%p) interrupt: %x.", hc, status);
344 if (status & I_RHSC)
345 ohci_rh_interrupt(&hc->rh);
346
347 if (status & I_WDH) {
348 fibril_mutex_lock(&hc->guard);
349 usb_log_debug2("HCCA: %p-%#" PRIx32 " (%p).", hc->hcca,
350 OHCI_RD(hc->registers->hcca),
351 (void *) addr_to_phys(hc->hcca));
352 usb_log_debug2("Periodic current: %#" PRIx32 ".",
353 OHCI_RD(hc->registers->periodic_current));
354
355 link_t *current = list_first(&hc->pending_batches);
356 while (current && current != &hc->pending_batches.head) {
357 link_t *next = current->next;
358 ohci_transfer_batch_t *batch =
359 ohci_transfer_batch_from_link(current);
360
361 if (ohci_transfer_batch_check_completed(batch)) {
362 list_remove(current);
363 usb_transfer_batch_finish(&batch->base);
364 }
365
366 current = next;
367 }
368 fibril_mutex_unlock(&hc->guard);
369 }
370
371 if (status & I_UE) {
372 usb_log_fatal("Error like no other!");
373 hc_start(&hc->base);
374 }
375
376}
377
378/** Turn off any (BIOS)driver that might be in control of the device.
379 *
380 * This function implements routines described in chapter 5.1.1.3 of the OHCI
381 * specification (page 40, pdf page 54).
382 *
383 * @param[in] instance OHCI hc driver structure.
384 */
385int hc_gain_control(hc_device_t *hcd)
386{
387 hc_t *instance = hcd_to_hc(hcd);
388
389 usb_log_debug("Requesting OHCI control.");
390 if (OHCI_RD(instance->registers->revision) & R_LEGACY_FLAG) {
391 /* Turn off legacy emulation, it should be enough to zero
392 * the lowest bit, but it caused problems. Thus clear all
393 * except GateA20 (causes restart on some hw).
394 * See page 145 of the specs for details.
395 */
396 volatile uint32_t *ohci_emulation_reg =
397 (uint32_t*)((char*)instance->registers + LEGACY_REGS_OFFSET);
398 usb_log_debug("OHCI legacy register %p: %x.",
399 ohci_emulation_reg, OHCI_RD(*ohci_emulation_reg));
400 /* Zero everything but A20State */
401 // TODO: should we ack interrupts before doing this?
402 OHCI_CLR(*ohci_emulation_reg, ~0x100);
403 usb_log_debug(
404 "OHCI legacy register (should be 0 or 0x100) %p: %x.",
405 ohci_emulation_reg, OHCI_RD(*ohci_emulation_reg));
406 }
407
408 /* Interrupt routing enabled => smm driver is active */
409 if (OHCI_RD(instance->registers->control) & C_IR) {
410 usb_log_debug("SMM driver: request ownership change.");
411 // TODO: should we ack interrupts before doing this?
412 OHCI_SET(instance->registers->command_status, CS_OCR);
413 /* Hope that SMM actually knows its stuff or we can hang here */
414 while (OHCI_RD(instance->registers->control) & C_IR) {
415 async_usleep(1000);
416 }
417 usb_log_info("SMM driver: Ownership taken.");
418 C_HCFS_SET(instance->registers->control, C_HCFS_RESET);
419 async_usleep(50000);
420 return EOK;
421 }
422
423 const unsigned hc_status = C_HCFS_GET(instance->registers->control);
424 /* Interrupt routing disabled && status != USB_RESET => BIOS active */
425 if (hc_status != C_HCFS_RESET) {
426 usb_log_debug("BIOS driver found.");
427 if (hc_status == C_HCFS_OPERATIONAL) {
428 usb_log_info("BIOS driver: HC operational.");
429 return EOK;
430 }
431 /* HC is suspended assert resume for 20ms */
432 C_HCFS_SET(instance->registers->control, C_HCFS_RESUME);
433 async_usleep(20000);
434 usb_log_info("BIOS driver: HC resumed.");
435 return EOK;
436 }
437
438 /* HC is in reset (hw startup) => no other driver
439 * maintain reset for at least the time specified in USB spec (50 ms)*/
440 usb_log_debug("Host controller found in reset state.");
441 async_usleep(50000);
442 return EOK;
443}
444
445/** OHCI hw initialization routine.
446 *
447 * @param[in] instance OHCI hc driver structure.
448 */
449int hc_start(hc_device_t *hcd)
450{
451 hc_t *instance = hcd_to_hc(hcd);
452 ohci_rh_init(&instance->rh, instance->registers, "ohci rh");
453
454 /* OHCI guide page 42 */
455 assert(instance);
456 usb_log_debug2("Started hc initialization routine.");
457
458 /* Save contents of fm_interval register */
459 const uint32_t fm_interval = OHCI_RD(instance->registers->fm_interval);
460 usb_log_debug2("Old value of HcFmInterval: %x.", fm_interval);
461
462 /* Reset hc */
463 usb_log_debug2("HC reset.");
464 size_t time = 0;
465 OHCI_WR(instance->registers->command_status, CS_HCR);
466 while (OHCI_RD(instance->registers->command_status) & CS_HCR) {
467 async_usleep(10);
468 time += 10;
469 }
470 usb_log_debug2("HC reset complete in %zu us.", time);
471
472 /* Restore fm_interval */
473 OHCI_WR(instance->registers->fm_interval, fm_interval);
474 assert((OHCI_RD(instance->registers->command_status) & CS_HCR) == 0);
475
476 /* hc is now in suspend state */
477 usb_log_debug2("HC should be in suspend state(%x).",
478 OHCI_RD(instance->registers->control));
479
480 /* Use HCCA */
481 OHCI_WR(instance->registers->hcca, addr_to_phys(instance->hcca));
482
483 /* Use queues */
484 OHCI_WR(instance->registers->bulk_head,
485 instance->lists[USB_TRANSFER_BULK].list_head_pa);
486 usb_log_debug2("Bulk HEAD set to: %p (%#" PRIx32 ").",
487 instance->lists[USB_TRANSFER_BULK].list_head,
488 instance->lists[USB_TRANSFER_BULK].list_head_pa);
489
490 OHCI_WR(instance->registers->control_head,
491 instance->lists[USB_TRANSFER_CONTROL].list_head_pa);
492 usb_log_debug2("Control HEAD set to: %p (%#" PRIx32 ").",
493 instance->lists[USB_TRANSFER_CONTROL].list_head,
494 instance->lists[USB_TRANSFER_CONTROL].list_head_pa);
495
496 /* Enable queues */
497 OHCI_SET(instance->registers->control, (C_PLE | C_IE | C_CLE | C_BLE));
498 usb_log_debug("Queues enabled(%x).",
499 OHCI_RD(instance->registers->control));
500
501 /* Enable interrupts */
502 if (instance->base.irq_cap >= 0) {
503 OHCI_WR(instance->registers->interrupt_enable,
504 OHCI_USED_INTERRUPTS);
505 usb_log_debug("Enabled interrupts: %x.",
506 OHCI_RD(instance->registers->interrupt_enable));
507 OHCI_WR(instance->registers->interrupt_enable, I_MI);
508 }
509
510 /* Set periodic start to 90% */
511 const uint32_t frame_length =
512 (fm_interval >> FMI_FI_SHIFT) & FMI_FI_MASK;
513 OHCI_WR(instance->registers->periodic_start,
514 ((frame_length / 10) * 9) & PS_MASK << PS_SHIFT);
515 usb_log_debug2("All periodic start set to: %x(%u - 90%% of %d).",
516 OHCI_RD(instance->registers->periodic_start),
517 OHCI_RD(instance->registers->periodic_start), frame_length);
518 C_HCFS_SET(instance->registers->control, C_HCFS_OPERATIONAL);
519 usb_log_debug("OHCI HC up and running (ctl_reg=0x%x).",
520 OHCI_RD(instance->registers->control));
521
522 return EOK;
523}
524
525/** Initialize schedule queues
526 *
527 * @param[in] instance OHCI hc driver structure
528 * @return Error code
529 */
530int hc_init_transfer_lists(hc_t *instance)
531{
532 assert(instance);
533#define SETUP_ENDPOINT_LIST(type) \
534do { \
535 const char *name = usb_str_transfer_type(type); \
536 const int ret = endpoint_list_init(&instance->lists[type], name); \
537 if (ret != EOK) { \
538 usb_log_error("Failed to setup %s endpoint list: %s.", \
539 name, str_error(ret)); \
540 endpoint_list_fini(&instance->lists[USB_TRANSFER_ISOCHRONOUS]);\
541 endpoint_list_fini(&instance->lists[USB_TRANSFER_INTERRUPT]); \
542 endpoint_list_fini(&instance->lists[USB_TRANSFER_CONTROL]); \
543 endpoint_list_fini(&instance->lists[USB_TRANSFER_BULK]); \
544 return ret; \
545 } \
546} while (0)
547
548 SETUP_ENDPOINT_LIST(USB_TRANSFER_ISOCHRONOUS);
549 SETUP_ENDPOINT_LIST(USB_TRANSFER_INTERRUPT);
550 SETUP_ENDPOINT_LIST(USB_TRANSFER_CONTROL);
551 SETUP_ENDPOINT_LIST(USB_TRANSFER_BULK);
552#undef SETUP_ENDPOINT_LIST
553 endpoint_list_set_next(&instance->lists[USB_TRANSFER_INTERRUPT],
554 &instance->lists[USB_TRANSFER_ISOCHRONOUS]);
555
556 return EOK;
557}
558
559/** Initialize memory structures used by the OHCI hcd.
560 *
561 * @param[in] instance OHCI hc driver structure.
562 * @return Error code.
563 */
564int hc_init_memory(hc_t *instance)
565{
566 assert(instance);
567
568 memset(&instance->rh, 0, sizeof(instance->rh));
569 /* Init queues */
570 int ret = hc_init_transfer_lists(instance);
571 if (ret != EOK) {
572 return ret;
573 }
574
575 /*Init HCCA */
576 instance->hcca = hcca_get();
577 if (instance->hcca == NULL)
578 return ENOMEM;
579 usb_log_debug2("OHCI HCCA initialized at %p.", instance->hcca);
580
581 for (unsigned i = 0; i < HCCA_INT_EP_COUNT; ++i) {
582 hcca_set_int_ep(instance->hcca, i,
583 instance->lists[USB_TRANSFER_INTERRUPT].list_head_pa);
584 }
585 usb_log_debug2("Interrupt HEADs set to: %p (%#" PRIx32 ").",
586 instance->lists[USB_TRANSFER_INTERRUPT].list_head,
587 instance->lists[USB_TRANSFER_INTERRUPT].list_head_pa);
588
589 if ((ret = ohci_bus_init(&instance->bus, instance))) {
590 usb_log_error("HC(%p): Failed to setup bus : %s",
591 instance, str_error(ret));
592 return ret;
593 }
594
595 hc_device_setup(&instance->base, (bus_t *) &instance->bus);
596
597 return EOK;
598}
599
600/**
601 * @}
602 */
Note: See TracBrowser for help on using the repository browser.