source: mainline/uspace/drv/ohci/hc.c@ 7013b14

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

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