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

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since fd07e526 was 8b54fe6, checked in by Jan Vesely <jano.vesely@…>, 14 years ago

usb: Rename device_keeper ⇒ sub-device_manager to match the rest of the library
  • Property mode set to 100644
File size: 18.8 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/** @addtogroup drvusbohcihc
29 * @{
30 */
31/** @file
32 * @brief OHCI Host controller driver routines
33 */
34#include <errno.h>
35#include <str_error.h>
36#include <adt/list.h>
37#include <libarch/ddi.h>
38
39#include <usb/debug.h>
40#include <usb/usb.h>
41#include <usb/ddfiface.h>
42
43#include "hc.h"
44#include "ohci_endpoint.h"
45
46#define OHCI_USED_INTERRUPTS \
47 (I_SO | I_WDH | I_UE | I_RHSC)
48
49static const irq_cmd_t ohci_irq_commands[] =
50{
51 { .cmd = CMD_MEM_READ_32, .dstarg = 1, .addr = NULL /*filled later*/ },
52 { .cmd = CMD_BTEST, .srcarg = 1, .dstarg = 2, .value = OHCI_USED_INTERRUPTS },
53 { .cmd = CMD_PREDICATE, .srcarg = 2, .value = 2 },
54 { .cmd = CMD_MEM_WRITE_A_32, .srcarg = 1, .addr = NULL /*filled later*/ },
55 { .cmd = CMD_ACCEPT },
56};
57
58static void hc_gain_control(hc_t *instance);
59static void hc_start(hc_t *instance);
60static int hc_init_transfer_lists(hc_t *instance);
61static int hc_init_memory(hc_t *instance);
62static int interrupt_emulator(hc_t *instance);
63static int hc_schedule(hcd_t *hcd, usb_transfer_batch_t *batch);
64/*----------------------------------------------------------------------------*/
65/** Get number of commands used in IRQ code.
66 * @return Number of commands.
67 */
68size_t hc_irq_cmd_count(void)
69{
70 return sizeof(ohci_irq_commands) / sizeof(irq_cmd_t);
71}
72/*----------------------------------------------------------------------------*/
73/** Generate IRQ code commands.
74 * @param[out] cmds Place to store the commands.
75 * @param[in] cmd_size Size of the place (bytes).
76 * @param[in] regs Physical address of device's registers.
77 * @param[in] reg_size Size of the register area (bytes).
78 *
79 * @return Error code.
80 */
81int hc_get_irq_commands(
82 irq_cmd_t cmds[], size_t cmd_size, uintptr_t regs, size_t reg_size)
83{
84 if (cmd_size < sizeof(ohci_irq_commands)
85 || reg_size < sizeof(ohci_regs_t))
86 return EOVERFLOW;
87
88 /* Create register mapping to use in IRQ handler.
89 * This mapping should be present in kernel only.
90 * Remove it from here when kernel knows how to create mappings
91 * and accepts physical addresses in IRQ code.
92 * TODO: remove */
93 ohci_regs_t *registers;
94 const int ret = pio_enable((void*)regs, reg_size, (void**)&registers);
95 if (ret != EOK)
96 return ret;
97
98 /* Some bogus access to force create mapping. DO NOT remove,
99 * unless whole virtual addresses in irq is replaced
100 * NOTE: Compiler won't remove this as ohci_regs_t members
101 * are declared volatile.
102 *
103 * Introducing CMD_MEM set of IRQ code commands broke
104 * assumption that IRQ code does not cause page faults.
105 * If this happens during idling (THREAD == NULL)
106 * it causes kernel panic.
107 */
108 registers->revision;
109
110 memcpy(cmds, ohci_irq_commands, sizeof(ohci_irq_commands));
111
112 void *address = (void*)&registers->interrupt_status;
113 cmds[0].addr = address;
114 cmds[3].addr = address;
115 return EOK;
116}
117/*----------------------------------------------------------------------------*/
118/** Announce OHCI root hub to the DDF
119 *
120 * @param[in] instance OHCI driver intance
121 * @param[in] hub_fun DDF fuction representing OHCI root hub
122 * @return Error code
123 */
124int hc_register_hub(hc_t *instance, ddf_fun_t *hub_fun)
125{
126 assert(instance);
127 assert(hub_fun);
128
129 const usb_address_t hub_address =
130 usb_device_manager_get_free_address(
131 &instance->generic.dev_manager, USB_SPEED_FULL);
132 if (hub_address <= 0) {
133 usb_log_error("Failed to get OHCI root hub address: %s\n",
134 str_error(hub_address));
135 return hub_address;
136 }
137 instance->rh.address = hub_address;
138 usb_device_manager_bind(
139 &instance->generic.dev_manager, hub_address, hub_fun->handle);
140
141#define CHECK_RET_UNREG_RETURN(ret, message...) \
142if (ret != EOK) { \
143 usb_log_error(message); \
144 usb_endpoint_manager_unregister_ep( \
145 &instance->generic.ep_manager, hub_address, 0, USB_DIRECTION_BOTH);\
146 usb_device_manager_release( \
147 &instance->generic.dev_manager, hub_address); \
148 return ret; \
149} else (void)0
150 int ret = usb_endpoint_manager_add_ep(
151 &instance->generic.ep_manager, hub_address, 0, USB_DIRECTION_BOTH,
152 USB_TRANSFER_CONTROL, USB_SPEED_FULL, 64, 0);
153 CHECK_RET_UNREG_RETURN(ret,
154 "Failed to register root hub control endpoint: %s.\n",
155 str_error(ret));
156
157 ret = ddf_fun_add_match_id(hub_fun, "usb&class=hub", 100);
158 CHECK_RET_UNREG_RETURN(ret,
159 "Failed to add root hub match-id: %s.\n", str_error(ret));
160
161 ret = ddf_fun_bind(hub_fun);
162 CHECK_RET_UNREG_RETURN(ret,
163 "Failed to bind root hub function: %s.\n", str_error(ret));
164
165 return EOK;
166#undef CHECK_RET_RELEASE
167}
168/*----------------------------------------------------------------------------*/
169/** Initialize OHCI hc driver structure
170 *
171 * @param[in] instance Memory place for the structure.
172 * @param[in] regs Address of the memory mapped I/O registers.
173 * @param[in] reg_size Size of the memory mapped area.
174 * @param[in] interrupts True if w interrupts should be used
175 * @return Error code
176 */
177int hc_init(hc_t *instance, uintptr_t regs, size_t reg_size, bool interrupts)
178{
179 assert(instance);
180
181#define CHECK_RET_RETURN(ret, message...) \
182if (ret != EOK) { \
183 usb_log_error(message); \
184 return ret; \
185} else (void)0
186
187 int ret =
188 pio_enable((void*)regs, reg_size, (void**)&instance->registers);
189 CHECK_RET_RETURN(ret,
190 "Failed to gain access to device registers: %s.\n", str_error(ret));
191
192 list_initialize(&instance->pending_batches);
193
194 ret = hcd_init(&instance->generic, BANDWIDTH_AVAILABLE_USB11,
195 bandwidth_count_usb11);
196 CHECK_RET_RETURN(ret, "Failed to initialize generic driver: %s.\n",
197 str_error(ret));
198 instance->generic.private_data = instance;
199 instance->generic.schedule = hc_schedule;
200 instance->generic.ep_add_hook = ohci_endpoint_init;
201
202 ret = hc_init_memory(instance);
203 CHECK_RET_RETURN(ret, "Failed to create OHCI memory structures: %s.\n",
204 str_error(ret));
205#undef CHECK_RET_RETURN
206
207 fibril_mutex_initialize(&instance->guard);
208
209 hc_gain_control(instance);
210
211 if (!interrupts) {
212 instance->interrupt_emulator =
213 fibril_create((int(*)(void*))interrupt_emulator, instance);
214 fibril_add_ready(instance->interrupt_emulator);
215 }
216
217 rh_init(&instance->rh, instance->registers);
218 hc_start(instance);
219
220 return EOK;
221}
222/*----------------------------------------------------------------------------*/
223void hc_enqueue_endpoint(hc_t *instance, endpoint_t *ep)
224{
225 endpoint_list_t *list = &instance->lists[ep->transfer_type];
226 ohci_endpoint_t *ohci_ep = ohci_endpoint_get(ep);
227 /* Enqueue ep */
228 switch (ep->transfer_type) {
229 case USB_TRANSFER_CONTROL:
230 instance->registers->control &= ~C_CLE;
231 endpoint_list_add_ep(list, ohci_ep);
232 instance->registers->control_current = 0;
233 instance->registers->control |= C_CLE;
234 break;
235 case USB_TRANSFER_BULK:
236 instance->registers->control &= ~C_BLE;
237 endpoint_list_add_ep(list, ohci_ep);
238 instance->registers->control |= C_BLE;
239 break;
240 case USB_TRANSFER_ISOCHRONOUS:
241 case USB_TRANSFER_INTERRUPT:
242 instance->registers->control &= (~C_PLE & ~C_IE);
243 endpoint_list_add_ep(list, ohci_ep);
244 instance->registers->control |= C_PLE | C_IE;
245 break;
246 }
247}
248/*----------------------------------------------------------------------------*/
249void hc_dequeue_endpoint(hc_t *instance, endpoint_t *ep)
250{
251 /* Dequeue ep */
252 endpoint_list_t *list = &instance->lists[ep->transfer_type];
253 ohci_endpoint_t *ohci_ep = ohci_endpoint_get(ep);
254 switch (ep->transfer_type) {
255 case USB_TRANSFER_CONTROL:
256 instance->registers->control &= ~C_CLE;
257 endpoint_list_remove_ep(list, ohci_ep);
258 instance->registers->control_current = 0;
259 instance->registers->control |= C_CLE;
260 break;
261 case USB_TRANSFER_BULK:
262 instance->registers->control &= ~C_BLE;
263 endpoint_list_remove_ep(list, ohci_ep);
264 instance->registers->control |= C_BLE;
265 break;
266 case USB_TRANSFER_ISOCHRONOUS:
267 case USB_TRANSFER_INTERRUPT:
268 instance->registers->control &= (~C_PLE & ~C_IE);
269 endpoint_list_remove_ep(list, ohci_ep);
270 instance->registers->control |= C_PLE | C_IE;
271 break;
272 default:
273 break;
274 }
275}
276/*----------------------------------------------------------------------------*/
277/** Add USB transfer to the schedule.
278 *
279 * @param[in] instance OHCI hc driver structure.
280 * @param[in] batch Batch representing the transfer.
281 * @return Error code.
282 */
283int hc_schedule(hcd_t *hcd, usb_transfer_batch_t *batch)
284{
285 assert(hcd);
286 hc_t *instance = hcd->private_data;
287 assert(instance);
288
289 /* Check for root hub communication */
290 if (batch->ep->address == instance->rh.address) {
291 rh_request(&instance->rh, batch);
292 return EOK;
293 }
294 ohci_transfer_batch_t *ohci_batch = ohci_transfer_batch_get(batch);
295 if (!ohci_batch)
296 return ENOMEM;
297
298 fibril_mutex_lock(&instance->guard);
299 list_append(&ohci_batch->link, &instance->pending_batches);
300 ohci_transfer_batch_commit(ohci_batch);
301
302 /* Control and bulk schedules need a kick to start working */
303 switch (batch->ep->transfer_type)
304 {
305 case USB_TRANSFER_CONTROL:
306 instance->registers->command_status |= CS_CLF;
307 break;
308 case USB_TRANSFER_BULK:
309 instance->registers->command_status |= CS_BLF;
310 break;
311 default:
312 break;
313 }
314 fibril_mutex_unlock(&instance->guard);
315 return EOK;
316}
317/*----------------------------------------------------------------------------*/
318/** Interrupt handling routine
319 *
320 * @param[in] instance OHCI hc driver structure.
321 * @param[in] status Value of the status register at the time of interrupt.
322 */
323void hc_interrupt(hc_t *instance, uint32_t status)
324{
325 assert(instance);
326 if ((status & ~I_SF) == 0) /* ignore sof status */
327 return;
328 usb_log_debug2("OHCI(%p) interrupt: %x.\n", instance, status);
329 if (status & I_RHSC)
330 rh_interrupt(&instance->rh);
331
332 if (status & I_WDH) {
333 fibril_mutex_lock(&instance->guard);
334 usb_log_debug2("HCCA: %p-%#" PRIx32 " (%p).\n", instance->hcca,
335 instance->registers->hcca,
336 (void *) addr_to_phys(instance->hcca));
337 usb_log_debug2("Periodic current: %#" PRIx32 ".\n",
338 instance->registers->periodic_current);
339
340 link_t *current = list_first(&instance->pending_batches);
341 while (current && current != &instance->pending_batches.head) {
342 link_t *next = current->next;
343 ohci_transfer_batch_t *batch =
344 ohci_transfer_batch_from_link(current);
345
346 if (ohci_transfer_batch_is_complete(batch)) {
347 list_remove(current);
348 ohci_transfer_batch_finish_dispose(batch);
349 }
350
351 current = next;
352 }
353 fibril_mutex_unlock(&instance->guard);
354 }
355
356 if (status & I_UE) {
357 usb_log_fatal("Error like no other!\n");
358 hc_start(instance);
359 }
360
361}
362/*----------------------------------------------------------------------------*/
363/** Check status register regularly
364 *
365 * @param[in] instance OHCI hc driver structure.
366 * @return Error code
367 */
368int interrupt_emulator(hc_t *instance)
369{
370 assert(instance);
371 usb_log_info("Started interrupt emulator.\n");
372 while (1) {
373 const uint32_t status = instance->registers->interrupt_status;
374 instance->registers->interrupt_status = status;
375 hc_interrupt(instance, status);
376 async_usleep(10000);
377 }
378 return EOK;
379}
380/*----------------------------------------------------------------------------*/
381/** Turn off any (BIOS)driver that might be in control of the device.
382 *
383 * This function implements routines described in chapter 5.1.1.3 of the OHCI
384 * specification (page 40, pdf page 54).
385 *
386 * @param[in] instance OHCI hc driver structure.
387 */
388void hc_gain_control(hc_t *instance)
389{
390 assert(instance);
391
392 usb_log_debug("Requesting OHCI control.\n");
393 if (instance->registers->revision & R_LEGACY_FLAG) {
394 /* Turn off legacy emulation, it should be enough to zero
395 * the lowest bit, but it caused problems. Thus clear all
396 * except GateA20 (causes restart on some hw).
397 * See page 145 of the specs for details.
398 */
399 volatile uint32_t *ohci_emulation_reg =
400 (uint32_t*)((char*)instance->registers + LEGACY_REGS_OFFSET);
401 usb_log_debug("OHCI legacy register %p: %x.\n",
402 ohci_emulation_reg, *ohci_emulation_reg);
403 /* Zero everything but A20State */
404 *ohci_emulation_reg &= 0x100;
405 usb_log_debug(
406 "OHCI legacy register (should be 0 or 0x100) %p: %x.\n",
407 ohci_emulation_reg, *ohci_emulation_reg);
408 }
409
410 /* Interrupt routing enabled => smm driver is active */
411 if (instance->registers->control & C_IR) {
412 usb_log_debug("SMM driver: request ownership change.\n");
413 instance->registers->command_status |= CS_OCR;
414 /* Hope that SMM actually knows its stuff or we can hang here */
415 while (instance->registers->control & C_IR) {
416 async_usleep(1000);
417 }
418 usb_log_info("SMM driver: Ownership taken.\n");
419 C_HCFS_SET(instance->registers->control, C_HCFS_RESET);
420 async_usleep(50000);
421 return;
422 }
423
424 const unsigned hc_status = C_HCFS_GET(instance->registers->control);
425 /* Interrupt routing disabled && status != USB_RESET => BIOS active */
426 if (hc_status != C_HCFS_RESET) {
427 usb_log_debug("BIOS driver found.\n");
428 if (hc_status == C_HCFS_OPERATIONAL) {
429 usb_log_info("BIOS driver: HC operational.\n");
430 return;
431 }
432 /* HC is suspended assert resume for 20ms, */
433 C_HCFS_SET(instance->registers->control, C_HCFS_RESUME);
434 async_usleep(20000);
435 usb_log_info("BIOS driver: HC resumed.\n");
436 return;
437 }
438
439 /* HC is in reset (hw startup) => no other driver
440 * maintain reset for at least the time specified in USB spec (50 ms)*/
441 usb_log_debug("Host controller found in reset state.\n");
442 async_usleep(50000);
443}
444/*----------------------------------------------------------------------------*/
445/** OHCI hw initialization routine.
446 *
447 * @param[in] instance OHCI hc driver structure.
448 */
449void hc_start(hc_t *instance)
450{
451 /* OHCI guide page 42 */
452 assert(instance);
453 usb_log_debug2("Started hc initialization routine.\n");
454
455 /* Save contents of fm_interval register */
456 const uint32_t fm_interval = instance->registers->fm_interval;
457 usb_log_debug2("Old value of HcFmInterval: %x.\n", fm_interval);
458
459 /* Reset hc */
460 usb_log_debug2("HC reset.\n");
461 size_t time = 0;
462 instance->registers->command_status = CS_HCR;
463 while (instance->registers->command_status & CS_HCR) {
464 async_usleep(10);
465 time += 10;
466 }
467 usb_log_debug2("HC reset complete in %zu us.\n", time);
468
469 /* Restore fm_interval */
470 instance->registers->fm_interval = fm_interval;
471 assert((instance->registers->command_status & CS_HCR) == 0);
472
473 /* hc is now in suspend state */
474 usb_log_debug2("HC should be in suspend state(%x).\n",
475 instance->registers->control);
476
477 /* Use HCCA */
478 instance->registers->hcca = addr_to_phys(instance->hcca);
479
480 /* Use queues */
481 instance->registers->bulk_head =
482 instance->lists[USB_TRANSFER_BULK].list_head_pa;
483 usb_log_debug2("Bulk HEAD set to: %p (%#" PRIx32 ").\n",
484 instance->lists[USB_TRANSFER_BULK].list_head,
485 instance->lists[USB_TRANSFER_BULK].list_head_pa);
486
487 instance->registers->control_head =
488 instance->lists[USB_TRANSFER_CONTROL].list_head_pa;
489 usb_log_debug2("Control HEAD set to: %p (%#" PRIx32 ").\n",
490 instance->lists[USB_TRANSFER_CONTROL].list_head,
491 instance->lists[USB_TRANSFER_CONTROL].list_head_pa);
492
493 /* Enable queues */
494 instance->registers->control |= (C_PLE | C_IE | C_CLE | C_BLE);
495 usb_log_debug2("All queues enabled(%x).\n",
496 instance->registers->control);
497
498 /* Enable interrupts */
499 instance->registers->interrupt_enable = OHCI_USED_INTERRUPTS;
500 usb_log_debug2("Enabled interrupts: %x.\n",
501 instance->registers->interrupt_enable);
502 instance->registers->interrupt_enable = I_MI;
503
504 /* Set periodic start to 90% */
505 uint32_t frame_length = ((fm_interval >> FMI_FI_SHIFT) & FMI_FI_MASK);
506 instance->registers->periodic_start = (frame_length / 10) * 9;
507 usb_log_debug2("All periodic start set to: %x(%u - 90%% of %d).\n",
508 instance->registers->periodic_start,
509 instance->registers->periodic_start, frame_length);
510
511 C_HCFS_SET(instance->registers->control, C_HCFS_OPERATIONAL);
512 usb_log_debug("OHCI HC up and running (ctl_reg=0x%x).\n",
513 instance->registers->control);
514}
515/*----------------------------------------------------------------------------*/
516/** Initialize schedule queues
517 *
518 * @param[in] instance OHCI hc driver structure
519 * @return Error code
520 */
521int hc_init_transfer_lists(hc_t *instance)
522{
523 assert(instance);
524#define SETUP_ENDPOINT_LIST(type) \
525do { \
526 const char *name = usb_str_transfer_type(type); \
527 int ret = endpoint_list_init(&instance->lists[type], name); \
528 if (ret != EOK) { \
529 usb_log_error("Failed to setup %s endpoint list: %s.\n", \
530 name, str_error(ret)); \
531 endpoint_list_fini(&instance->lists[USB_TRANSFER_ISOCHRONOUS]);\
532 endpoint_list_fini(&instance->lists[USB_TRANSFER_INTERRUPT]); \
533 endpoint_list_fini(&instance->lists[USB_TRANSFER_CONTROL]); \
534 endpoint_list_fini(&instance->lists[USB_TRANSFER_BULK]); \
535 return ret; \
536 } \
537} while (0)
538
539 SETUP_ENDPOINT_LIST(USB_TRANSFER_ISOCHRONOUS);
540 SETUP_ENDPOINT_LIST(USB_TRANSFER_INTERRUPT);
541 SETUP_ENDPOINT_LIST(USB_TRANSFER_CONTROL);
542 SETUP_ENDPOINT_LIST(USB_TRANSFER_BULK);
543#undef SETUP_ENDPOINT_LIST
544 endpoint_list_set_next(&instance->lists[USB_TRANSFER_INTERRUPT],
545 &instance->lists[USB_TRANSFER_ISOCHRONOUS]);
546
547 return EOK;
548}
549/*----------------------------------------------------------------------------*/
550/** Initialize memory structures used by the OHCI hcd.
551 *
552 * @param[in] instance OHCI hc driver structure.
553 * @return Error code.
554 */
555int hc_init_memory(hc_t *instance)
556{
557 assert(instance);
558
559 bzero(&instance->rh, sizeof(instance->rh));
560 /* Init queues */
561 const int ret = hc_init_transfer_lists(instance);
562 if (ret != EOK) {
563 return ret;
564 }
565
566 /*Init HCCA */
567 instance->hcca = malloc32(sizeof(hcca_t));
568 if (instance->hcca == NULL)
569 return ENOMEM;
570 bzero(instance->hcca, sizeof(hcca_t));
571 usb_log_debug2("OHCI HCCA initialized at %p.\n", instance->hcca);
572
573 unsigned i = 0;
574 for (; i < 32; ++i) {
575 instance->hcca->int_ep[i] =
576 instance->lists[USB_TRANSFER_INTERRUPT].list_head_pa;
577 }
578 usb_log_debug2("Interrupt HEADs set to: %p (%#" PRIx32 ").\n",
579 instance->lists[USB_TRANSFER_INTERRUPT].list_head,
580 instance->lists[USB_TRANSFER_INTERRUPT].list_head_pa);
581
582 return EOK;
583}
584
585/**
586 * @}
587 */
Note: See TracBrowser for help on using the repository browser.