source: mainline/uspace/drv/ohci/hc.c@ 561112f

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

OHCI interrupt support
  • 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/** @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#include <usb/usbdevice.h>
43
44#include "hc.h"
45#include "hcd_endpoint.h"
46
47#define OHCI_USED_INTERRUPTS \
48 (I_SO | I_WDH | I_UE | I_RHSC)
49static int interrupt_emulator(hc_t *instance);
50static void hc_gain_control(hc_t *instance);
51static void hc_init_hw(hc_t *instance);
52static int hc_init_transfer_lists(hc_t *instance);
53static int hc_init_memory(hc_t *instance);
54/*----------------------------------------------------------------------------*/
55int hc_register_hub(hc_t *instance, ddf_fun_t *hub_fun)
56{
57 assert(instance);
58 assert(hub_fun);
59
60 int ret;
61
62 usb_address_t hub_address =
63 device_keeper_get_free_address(&instance->manager, USB_SPEED_FULL);
64 if (hub_address <= 0) {
65 usb_log_error("Failed to get OHCI root hub address.\n");
66 return hub_address;
67 }
68 instance->rh.address = hub_address;
69 usb_device_keeper_bind(
70 &instance->manager, hub_address, hub_fun->handle);
71
72 ret = hc_add_endpoint(instance, hub_address, 0, USB_SPEED_FULL,
73 USB_TRANSFER_CONTROL, USB_DIRECTION_BOTH, 64, 0, 0);
74 if (ret != EOK) {
75 usb_log_error("Failed to add OHCI rh endpoint 0.\n");
76 usb_device_keeper_release(&instance->manager, hub_address);
77 return ret;
78 }
79
80 char *match_str = NULL;
81 /* DDF needs heap allocated string */
82 ret = asprintf(&match_str, "usb&class=hub");
83 if (ret < 0) {
84 usb_log_error(
85 "Failed(%d) to create root hub match-id string.\n", ret);
86 usb_device_keeper_release(&instance->manager, hub_address);
87 return ret;
88 }
89
90 ret = ddf_fun_add_match_id(hub_fun, match_str, 100);
91 if (ret != EOK) {
92 usb_log_error("Failed add root hub match-id.\n");
93 }
94 return ret;
95}
96/*----------------------------------------------------------------------------*/
97int hc_init(hc_t *instance, ddf_fun_t *fun, ddf_dev_t *dev,
98 uintptr_t regs, size_t reg_size, bool interrupts)
99{
100 assert(instance);
101 int ret = EOK;
102#define CHECK_RET_RETURN(ret, message...) \
103if (ret != EOK) { \
104 usb_log_error(message); \
105 return ret; \
106} else (void)0
107
108 ret = pio_enable((void*)regs, reg_size, (void**)&instance->registers);
109 CHECK_RET_RETURN(ret,
110 "Failed(%d) to gain access to device registers: %s.\n",
111 ret, str_error(ret));
112
113 usb_device_keeper_init(&instance->manager);
114 ret = usb_endpoint_manager_init(&instance->ep_manager,
115 BANDWIDTH_AVAILABLE_USB11);
116 CHECK_RET_RETURN(ret, "Failed to initialize endpoint manager: %s.\n",
117 str_error(ret));
118
119 hc_gain_control(instance);
120 ret = hc_init_memory(instance);
121 CHECK_RET_RETURN(ret, "Failed to create OHCI memory structures: %s.\n",
122 str_error(ret));
123 hc_init_hw(instance);
124 fibril_mutex_initialize(&instance->guard);
125
126 rh_init(&instance->rh, instance->registers);
127
128 if (!interrupts) {
129 instance->interrupt_emulator =
130 fibril_create((int(*)(void*))interrupt_emulator, instance);
131 fibril_add_ready(instance->interrupt_emulator);
132 }
133
134 list_initialize(&instance->pending_batches);
135#undef CHECK_RET_RETURN
136 return EOK;
137}
138/*----------------------------------------------------------------------------*/
139int hc_add_endpoint(
140 hc_t *instance, usb_address_t address, usb_endpoint_t endpoint,
141 usb_speed_t speed, usb_transfer_type_t type, usb_direction_t direction,
142 size_t mps, size_t size, unsigned interval)
143{
144 endpoint_t *ep = malloc(sizeof(endpoint_t));
145 if (ep == NULL)
146 return ENOMEM;
147 int ret =
148 endpoint_init(ep, address, endpoint, direction, type, speed, mps);
149 if (ret != EOK) {
150 free(ep);
151 return ret;
152 }
153
154 hcd_endpoint_t *hcd_ep = hcd_endpoint_assign(ep);
155 if (hcd_ep == NULL) {
156 endpoint_destroy(ep);
157 return ENOMEM;
158 }
159
160 ret = usb_endpoint_manager_register_ep(&instance->ep_manager, ep, size);
161 if (ret != EOK) {
162 hcd_endpoint_clear(ep);
163 endpoint_destroy(ep);
164 return ret;
165 }
166
167 /* Enqueue hcd_ep */
168 switch (ep->transfer_type) {
169 case USB_TRANSFER_CONTROL:
170 instance->registers->control &= ~C_CLE;
171 endpoint_list_add_ep(
172 &instance->lists[ep->transfer_type], hcd_ep);
173 instance->registers->control_current = 0;
174 instance->registers->control |= C_CLE;
175 break;
176 case USB_TRANSFER_BULK:
177 instance->registers->control &= ~C_BLE;
178 endpoint_list_add_ep(
179 &instance->lists[ep->transfer_type], hcd_ep);
180 instance->registers->control |= C_BLE;
181 break;
182 case USB_TRANSFER_ISOCHRONOUS:
183 case USB_TRANSFER_INTERRUPT:
184 instance->registers->control &= (~C_PLE & ~C_IE);
185 endpoint_list_add_ep(
186 &instance->lists[ep->transfer_type], hcd_ep);
187 instance->registers->control |= C_PLE | C_IE;
188 break;
189 default:
190 break;
191 }
192
193 return EOK;
194}
195/*----------------------------------------------------------------------------*/
196int hc_remove_endpoint(hc_t *instance, usb_address_t address,
197 usb_endpoint_t endpoint, usb_direction_t direction)
198{
199 assert(instance);
200 fibril_mutex_lock(&instance->guard);
201 endpoint_t *ep = usb_endpoint_manager_get_ep(&instance->ep_manager,
202 address, endpoint, direction, NULL);
203 if (ep == NULL) {
204 usb_log_error("Endpoint unregister failed: No such EP.\n");
205 fibril_mutex_unlock(&instance->guard);
206 return ENOENT;
207 }
208
209 hcd_endpoint_t *hcd_ep = hcd_endpoint_get(ep);
210 if (hcd_ep) {
211 /* Dequeue hcd_ep */
212 switch (ep->transfer_type) {
213 case USB_TRANSFER_CONTROL:
214 instance->registers->control &= ~C_CLE;
215 endpoint_list_remove_ep(
216 &instance->lists[ep->transfer_type], hcd_ep);
217 instance->registers->control_current = 0;
218 instance->registers->control |= C_CLE;
219 break;
220 case USB_TRANSFER_BULK:
221 instance->registers->control &= ~C_BLE;
222 endpoint_list_remove_ep(
223 &instance->lists[ep->transfer_type], hcd_ep);
224 instance->registers->control |= C_BLE;
225 break;
226 case USB_TRANSFER_ISOCHRONOUS:
227 case USB_TRANSFER_INTERRUPT:
228 instance->registers->control &= (~C_PLE & ~C_IE);
229 endpoint_list_remove_ep(
230 &instance->lists[ep->transfer_type], hcd_ep);
231 instance->registers->control |= C_PLE | C_IE;
232 break;
233 default:
234 break;
235 }
236 hcd_endpoint_clear(ep);
237 } else {
238 usb_log_warning("Endpoint without hcd equivalent structure.\n");
239 }
240 int ret = usb_endpoint_manager_unregister_ep(&instance->ep_manager,
241 address, endpoint, direction);
242 fibril_mutex_unlock(&instance->guard);
243 return ret;
244}
245/*----------------------------------------------------------------------------*/
246endpoint_t * hc_get_endpoint(hc_t *instance, usb_address_t address,
247 usb_endpoint_t endpoint, usb_direction_t direction, size_t *bw)
248{
249 assert(instance);
250 fibril_mutex_lock(&instance->guard);
251 endpoint_t *ep = usb_endpoint_manager_get_ep(&instance->ep_manager,
252 address, endpoint, direction, bw);
253 fibril_mutex_unlock(&instance->guard);
254 return ep;
255}
256/*----------------------------------------------------------------------------*/
257int hc_schedule(hc_t *instance, usb_transfer_batch_t *batch)
258{
259 assert(instance);
260 assert(batch);
261 assert(batch->ep);
262
263 /* check for root hub communication */
264 if (batch->ep->address == instance->rh.address) {
265 return rh_request(&instance->rh, batch);
266 }
267
268 fibril_mutex_lock(&instance->guard);
269 list_append(&batch->link, &instance->pending_batches);
270 batch_commit(batch);
271 switch (batch->ep->transfer_type) {
272 case USB_TRANSFER_CONTROL:
273 instance->registers->command_status |= CS_CLF;
274 break;
275 case USB_TRANSFER_BULK:
276 instance->registers->command_status |= CS_BLF;
277 break;
278 default:
279 break;
280 }
281
282 fibril_mutex_unlock(&instance->guard);
283 return EOK;
284}
285/*----------------------------------------------------------------------------*/
286void hc_interrupt(hc_t *instance, uint32_t status)
287{
288 assert(instance);
289 usb_log_debug("OHCI interrupt: %x.\n", status);
290 if ((status & ~I_SF) == 0) /* ignore sof status */
291 return;
292 if (status & I_RHSC)
293 rh_interrupt(&instance->rh);
294
295
296 if (status & I_WDH) {
297 fibril_mutex_lock(&instance->guard);
298 usb_log_debug2("HCCA: %p-%#" PRIx32 " (%p).\n", instance->hcca,
299 instance->registers->hcca,
300 (void *) addr_to_phys(instance->hcca));
301 usb_log_debug2("Periodic current: %#" PRIx32 ".\n",
302 instance->registers->periodic_current);
303
304 link_t *current = instance->pending_batches.next;
305 while (current != &instance->pending_batches) {
306 link_t *next = current->next;
307 usb_transfer_batch_t *batch =
308 usb_transfer_batch_from_link(current);
309
310 if (batch_is_complete(batch)) {
311 list_remove(current);
312 usb_transfer_batch_finish(batch);
313 }
314 current = next;
315 }
316 fibril_mutex_unlock(&instance->guard);
317 }
318}
319/*----------------------------------------------------------------------------*/
320int interrupt_emulator(hc_t *instance)
321{
322 assert(instance);
323 usb_log_info("Started interrupt emulator.\n");
324 while (1) {
325 const uint32_t status = instance->registers->interrupt_status;
326 instance->registers->interrupt_status = status;
327 hc_interrupt(instance, status);
328 async_usleep(50000);
329 }
330 return EOK;
331}
332/*----------------------------------------------------------------------------*/
333void hc_gain_control(hc_t *instance)
334{
335 assert(instance);
336 /* Turn off legacy emulation */
337 volatile uint32_t *ohci_emulation_reg =
338 (uint32_t*)((char*)instance->registers + 0x100);
339 usb_log_debug("OHCI legacy register %p: %x.\n",
340 ohci_emulation_reg, *ohci_emulation_reg);
341 *ohci_emulation_reg = 0;
342
343 /* Interrupt routing enabled => smm driver is active */
344 if (instance->registers->control & C_IR) {
345 usb_log_debug("SMM driver: request ownership change.\n");
346 instance->registers->command_status |= CS_OCR;
347 while (instance->registers->control & C_IR) {
348 async_usleep(1000);
349 }
350 usb_log_info("SMM driver: Ownership taken.\n");
351 return;
352 }
353
354 const unsigned hc_status =
355 (instance->registers->control >> C_HCFS_SHIFT) & C_HCFS_MASK;
356 /* Interrupt routing disabled && status != USB_RESET => BIOS active */
357 if (hc_status != C_HCFS_RESET) {
358 usb_log_debug("BIOS driver found.\n");
359 if (hc_status == C_HCFS_OPERATIONAL) {
360 usb_log_info("BIOS driver: HC operational.\n");
361 return;
362 }
363 /* HC is suspended assert resume for 20ms */
364 instance->registers->control &= (C_HCFS_RESUME << C_HCFS_SHIFT);
365 async_usleep(20000);
366 usb_log_info("BIOS driver: HC resumed.\n");
367 return;
368 }
369
370 /* HC is in reset (hw startup) => no other driver
371 * maintain reset for at least the time specified in USB spec (50 ms)*/
372 usb_log_info("HC found in reset.\n");
373 async_usleep(50000);
374}
375/*----------------------------------------------------------------------------*/
376void hc_init_hw(hc_t *instance)
377{
378 /* OHCI guide page 42 */
379 assert(instance);
380 usb_log_debug2("Started hc initialization routine.\n");
381
382 /* Save contents of fm_interval register */
383 const uint32_t fm_interval = instance->registers->fm_interval;
384 usb_log_debug2("Old value of HcFmInterval: %x.\n", fm_interval);
385
386 /* Reset hc */
387 usb_log_debug2("HC reset.\n");
388 size_t time = 0;
389 instance->registers->command_status = CS_HCR;
390 while (instance->registers->command_status & CS_HCR) {
391 async_usleep(10);
392 time += 10;
393 }
394 usb_log_debug2("HC reset complete in %zu us.\n", time);
395
396 /* Restore fm_interval */
397 instance->registers->fm_interval = fm_interval;
398 assert((instance->registers->command_status & CS_HCR) == 0);
399
400 /* hc is now in suspend state */
401 usb_log_debug2("HC should be in suspend state(%x).\n",
402 instance->registers->control);
403
404 /* Use HCCA */
405 instance->registers->hcca = addr_to_phys(instance->hcca);
406
407 /* Use queues */
408 instance->registers->bulk_head =
409 instance->lists[USB_TRANSFER_BULK].list_head_pa;
410 usb_log_debug2("Bulk HEAD set to: %p (%#" PRIx32 ").\n",
411 instance->lists[USB_TRANSFER_BULK].list_head,
412 instance->lists[USB_TRANSFER_BULK].list_head_pa);
413
414 instance->registers->control_head =
415 instance->lists[USB_TRANSFER_CONTROL].list_head_pa;
416 usb_log_debug2("Control HEAD set to: %p (%#" PRIx32 ").\n",
417 instance->lists[USB_TRANSFER_CONTROL].list_head,
418 instance->lists[USB_TRANSFER_CONTROL].list_head_pa);
419
420 /* Enable queues */
421 instance->registers->control |= (C_PLE | C_IE | C_CLE | C_BLE);
422 usb_log_debug2("All queues enabled(%x).\n",
423 instance->registers->control);
424
425 /* Enable interrupts */
426 instance->registers->interrupt_enable = OHCI_USED_INTERRUPTS;
427 usb_log_debug2("Enabled interrupts: %x.\n",
428 instance->registers->interrupt_enable);
429 instance->registers->interrupt_enable = I_MI;
430 /* Disable interrupts */
431// instance->registers->interrupt_disable = I_SF | I_OC;
432// usb_log_debug2("Disabling interrupts: %x.\n",
433// instance->registers->interrupt_disable);
434// instance->registers->interrupt_disable = I_MI;
435
436 /* Set periodic start to 90% */
437 uint32_t frame_length = ((fm_interval >> FMI_FI_SHIFT) & FMI_FI_MASK);
438 instance->registers->periodic_start = (frame_length / 10) * 9;
439 usb_log_debug2("All periodic start set to: %x(%u - 90%% of %d).\n",
440 instance->registers->periodic_start,
441 instance->registers->periodic_start, frame_length);
442
443 instance->registers->control &= (C_HCFS_OPERATIONAL << C_HCFS_SHIFT);
444 usb_log_info("OHCI HC up and running(%x).\n",
445 instance->registers->control);
446}
447/*----------------------------------------------------------------------------*/
448int hc_init_transfer_lists(hc_t *instance)
449{
450 assert(instance);
451
452#define SETUP_ENDPOINT_LIST(type) \
453do { \
454 const char *name = usb_str_transfer_type(type); \
455 int ret = endpoint_list_init(&instance->lists[type], name); \
456 if (ret != EOK) { \
457 usb_log_error("Failed(%d) to setup %s endpoint list.\n", \
458 ret, name); \
459 endpoint_list_fini(&instance->lists[USB_TRANSFER_ISOCHRONOUS]); \
460 endpoint_list_fini(&instance->lists[USB_TRANSFER_INTERRUPT]); \
461 endpoint_list_fini(&instance->lists[USB_TRANSFER_CONTROL]); \
462 endpoint_list_fini(&instance->lists[USB_TRANSFER_BULK]); \
463 } \
464} while (0)
465
466 SETUP_ENDPOINT_LIST(USB_TRANSFER_ISOCHRONOUS);
467 SETUP_ENDPOINT_LIST(USB_TRANSFER_INTERRUPT);
468 SETUP_ENDPOINT_LIST(USB_TRANSFER_CONTROL);
469 SETUP_ENDPOINT_LIST(USB_TRANSFER_BULK);
470#undef SETUP_ENDPOINT_LIST
471 endpoint_list_set_next(&instance->lists[USB_TRANSFER_INTERRUPT],
472 &instance->lists[USB_TRANSFER_ISOCHRONOUS]);
473
474 return EOK;
475}
476/*----------------------------------------------------------------------------*/
477int hc_init_memory(hc_t *instance)
478{
479 assert(instance);
480 /* Init queues */
481 hc_init_transfer_lists(instance);
482
483 /*Init HCCA */
484 instance->hcca = malloc32(sizeof(hcca_t));
485 if (instance->hcca == NULL)
486 return ENOMEM;
487 bzero(instance->hcca, sizeof(hcca_t));
488 usb_log_debug2("OHCI HCCA initialized at %p.\n", instance->hcca);
489
490 unsigned i = 0;
491 for (; i < 32; ++i) {
492 instance->hcca->int_ep[i] =
493 instance->lists[USB_TRANSFER_INTERRUPT].list_head_pa;
494 }
495 usb_log_debug2("Interrupt HEADs set to: %p (%#" PRIx32 ").\n",
496 instance->lists[USB_TRANSFER_INTERRUPT].list_head,
497 instance->lists[USB_TRANSFER_INTERRUPT].list_head_pa);
498
499 /* Init interrupt code */
500 instance->interrupt_code.cmds = instance->interrupt_commands;
501 {
502 /* Read status register */
503 instance->interrupt_commands[0].cmd = CMD_MEM_READ_32;
504 instance->interrupt_commands[0].dstarg = 1;
505 instance->interrupt_commands[0].addr = (void*)
506 addr_to_phys((void*)&instance->registers->interrupt_status);
507
508 /* Test whether we are the interrupt cause */
509 instance->interrupt_commands[1].cmd = CMD_BTEST;
510 instance->interrupt_commands[1].value =
511 OHCI_USED_INTERRUPTS;
512 instance->interrupt_commands[1].srcarg = 1;
513 instance->interrupt_commands[1].dstarg = 2;
514
515 /* Predicate cleaning and accepting */
516 instance->interrupt_commands[2].cmd = CMD_PREDICATE;
517 instance->interrupt_commands[2].value = 2;
518 instance->interrupt_commands[2].srcarg = 2;
519
520 /* Write clean status register */
521 instance->interrupt_commands[3].cmd = CMD_PIO_WRITE_A_32;
522 instance->interrupt_commands[3].srcarg = 1;
523 instance->interrupt_commands[3].addr = (void*)
524 addr_to_phys((void*)&instance->registers->interrupt_status);
525
526 /* Accept interrupt */
527 instance->interrupt_commands[4].cmd = CMD_ACCEPT;
528
529 instance->interrupt_code.cmdcount = OHCI_NEEDED_IRQ_COMMANDS;
530 }
531
532 return EOK;
533}
534/**
535 * @}
536 */
Note: See TracBrowser for help on using the repository browser.