source: mainline/uspace/drv/ohci/hc.c@ d017cea

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

Remove EP information stored in usb_transfer_batch_t

rename usb_transfer_batch_t.transport_buffer ⇒ data_buffer
  • Property mode set to 100644
File size: 13.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
46static int interrupt_emulator(hc_t *instance);
47static void hc_gain_control(hc_t *instance);
48static void hc_init_hw(hc_t *instance);
49static int hc_init_transfer_lists(hc_t *instance);
50static int hc_init_memory(hc_t *instance);
51/*----------------------------------------------------------------------------*/
52int hc_register_hub(hc_t *instance, ddf_fun_t *hub_fun)
53{
54 assert(instance);
55 assert(hub_fun);
56
57 usb_address_t hub_address =
58 device_keeper_get_free_address(&instance->manager, USB_SPEED_FULL);
59 instance->rh.address = hub_address;
60 usb_device_keeper_bind(
61 &instance->manager, hub_address, hub_fun->handle);
62
63 endpoint_t *ep = malloc(sizeof(endpoint_t));
64 assert(ep);
65 int ret = endpoint_init(ep, hub_address, 0, USB_DIRECTION_BOTH,
66 USB_TRANSFER_CONTROL, USB_SPEED_FULL, 64);
67 assert(ret == EOK);
68 ret = usb_endpoint_manager_register_ep(&instance->ep_manager, ep, 0);
69 assert(ret == EOK);
70
71 char *match_str = NULL;
72 ret = asprintf(&match_str, "usb&class=hub");
73// ret = (match_str == NULL) ? ret : EOK;
74 if (ret < 0) {
75 usb_log_error(
76 "Failed(%d) to create root hub match-id string.\n", ret);
77 return ret;
78 }
79
80 ret = ddf_fun_add_match_id(hub_fun, match_str, 100);
81 if (ret != EOK) {
82 usb_log_error("Failed add create root hub match-id.\n");
83 }
84 return ret;
85}
86/*----------------------------------------------------------------------------*/
87int hc_init(hc_t *instance, ddf_fun_t *fun, ddf_dev_t *dev,
88 uintptr_t regs, size_t reg_size, bool interrupts)
89{
90 assert(instance);
91 int ret = EOK;
92#define CHECK_RET_RETURN(ret, message...) \
93if (ret != EOK) { \
94 usb_log_error(message); \
95 return ret; \
96} else (void)0
97
98 ret = pio_enable((void*)regs, reg_size, (void**)&instance->registers);
99 CHECK_RET_RETURN(ret,
100 "Failed(%d) to gain access to device registers: %s.\n",
101 ret, str_error(ret));
102
103 instance->ddf_instance = fun;
104 usb_device_keeper_init(&instance->manager);
105 ret = usb_endpoint_manager_init(&instance->ep_manager,
106 BANDWIDTH_AVAILABLE_USB11);
107 CHECK_RET_RETURN(ret, "Failed to initialize endpoint manager: %s.\n",
108 ret, str_error(ret));
109
110 hc_gain_control(instance);
111 ret = hc_init_memory(instance);
112 CHECK_RET_RETURN(ret, "Failed to create OHCI memory structures:%s.\n",
113 ret, str_error(ret));
114 hc_init_hw(instance);
115 fibril_mutex_initialize(&instance->guard);
116
117 rh_init(&instance->rh, dev, instance->registers);
118
119 if (!interrupts) {
120 instance->interrupt_emulator =
121 fibril_create((int(*)(void*))interrupt_emulator, instance);
122 fibril_add_ready(instance->interrupt_emulator);
123 }
124
125 return EOK;
126}
127/*----------------------------------------------------------------------------*/
128int hc_schedule(hc_t *instance, usb_transfer_batch_t *batch)
129{
130 assert(instance);
131 assert(batch);
132 assert(batch->ep);
133
134 /* check for root hub communication */
135 if (batch->ep->address == instance->rh.address) {
136 return rh_request(&instance->rh, batch);
137 }
138
139 fibril_mutex_lock(&instance->guard);
140 switch (batch->ep->transfer_type) {
141 case USB_TRANSFER_CONTROL:
142 instance->registers->control &= ~C_CLE;
143 transfer_list_add_batch(
144 instance->transfers[batch->ep->transfer_type], batch);
145 instance->registers->command_status |= CS_CLF;
146 usb_log_debug2("Set CS control transfer filled: %x.\n",
147 instance->registers->command_status);
148 instance->registers->control_current = 0;
149 instance->registers->control |= C_CLE;
150 break;
151 case USB_TRANSFER_BULK:
152 instance->registers->control &= ~C_BLE;
153 transfer_list_add_batch(
154 instance->transfers[batch->ep->transfer_type], batch);
155 instance->registers->command_status |= CS_BLF;
156 usb_log_debug2("Set bulk transfer filled: %x.\n",
157 instance->registers->command_status);
158 instance->registers->control |= C_BLE;
159 break;
160 case USB_TRANSFER_INTERRUPT:
161 case USB_TRANSFER_ISOCHRONOUS:
162 instance->registers->control &= (~C_PLE & ~C_IE);
163 transfer_list_add_batch(
164 instance->transfers[batch->ep->transfer_type], batch);
165 instance->registers->control |= C_PLE | C_IE;
166 usb_log_debug2("Added periodic transfer: %x.\n",
167 instance->registers->periodic_current);
168 break;
169 default:
170 break;
171 }
172 fibril_mutex_unlock(&instance->guard);
173 return EOK;
174}
175/*----------------------------------------------------------------------------*/
176void hc_interrupt(hc_t *instance, uint32_t status)
177{
178 assert(instance);
179 if ((status & ~IS_SF) == 0) /* ignore sof status */
180 return;
181 if (status & IS_RHSC)
182 rh_interrupt(&instance->rh);
183
184 usb_log_debug("OHCI interrupt: %x.\n", status);
185
186 if (status & IS_WDH) {
187 fibril_mutex_lock(&instance->guard);
188 usb_log_debug2("HCCA: %p-%p(%p).\n", instance->hcca,
189 instance->registers->hcca, addr_to_phys(instance->hcca));
190 usb_log_debug2("Periodic current: %p.\n",
191 instance->registers->periodic_current);
192 LIST_INITIALIZE(done);
193 transfer_list_remove_finished(
194 &instance->transfers_interrupt, &done);
195 transfer_list_remove_finished(
196 &instance->transfers_isochronous, &done);
197 transfer_list_remove_finished(
198 &instance->transfers_control, &done);
199 transfer_list_remove_finished(
200 &instance->transfers_bulk, &done);
201
202 while (!list_empty(&done)) {
203 link_t *item = done.next;
204 list_remove(item);
205 usb_transfer_batch_t *batch =
206 list_get_instance(item, usb_transfer_batch_t, link);
207 usb_transfer_batch_finish(batch);
208 }
209 fibril_mutex_unlock(&instance->guard);
210 }
211}
212/*----------------------------------------------------------------------------*/
213int interrupt_emulator(hc_t *instance)
214{
215 assert(instance);
216 usb_log_info("Started interrupt emulator.\n");
217 while (1) {
218 const uint32_t status = instance->registers->interrupt_status;
219 instance->registers->interrupt_status = status;
220 hc_interrupt(instance, status);
221 async_usleep(50000);
222 }
223 return EOK;
224}
225/*----------------------------------------------------------------------------*/
226void hc_gain_control(hc_t *instance)
227{
228 assert(instance);
229 /* Turn off legacy emulation */
230 volatile uint32_t *ohci_emulation_reg =
231 (uint32_t*)((char*)instance->registers + 0x100);
232 usb_log_debug("OHCI legacy register %p: %x.\n",
233 ohci_emulation_reg, *ohci_emulation_reg);
234 *ohci_emulation_reg = 0;
235
236 /* Interrupt routing enabled => smm driver is active */
237 if (instance->registers->control & C_IR) {
238 usb_log_debug("SMM driver: request ownership change.\n");
239 instance->registers->command_status |= CS_OCR;
240 while (instance->registers->control & C_IR) {
241 async_usleep(1000);
242 }
243 usb_log_info("SMM driver: Ownership taken.\n");
244 return;
245 }
246
247 const unsigned hc_status =
248 (instance->registers->control >> C_HCFS_SHIFT) & C_HCFS_MASK;
249 /* Interrupt routing disabled && status != USB_RESET => BIOS active */
250 if (hc_status != C_HCFS_RESET) {
251 usb_log_debug("BIOS driver found.\n");
252 if (hc_status == C_HCFS_OPERATIONAL) {
253 usb_log_info("BIOS driver: HC operational.\n");
254 return;
255 }
256 /* HC is suspended assert resume for 20ms */
257 instance->registers->control &= (C_HCFS_RESUME << C_HCFS_SHIFT);
258 async_usleep(20000);
259 usb_log_info("BIOS driver: HC resumed.\n");
260 return;
261 }
262
263 /* HC is in reset (hw startup) => no other driver
264 * maintain reset for at least the time specified in USB spec (50 ms)*/
265 usb_log_info("HC found in reset.\n");
266 async_usleep(50000);
267}
268/*----------------------------------------------------------------------------*/
269void hc_init_hw(hc_t *instance)
270{
271 /* OHCI guide page 42 */
272 assert(instance);
273 usb_log_debug2("Started hc initialization routine.\n");
274
275 /* Save contents of fm_interval register */
276 const uint32_t fm_interval = instance->registers->fm_interval;
277 usb_log_debug2("Old value of HcFmInterval: %x.\n", fm_interval);
278
279 /* Reset hc */
280 usb_log_debug2("HC reset.\n");
281 size_t time = 0;
282 instance->registers->command_status = CS_HCR;
283 while (instance->registers->command_status & CS_HCR) {
284 async_usleep(10);
285 time += 10;
286 }
287 usb_log_debug2("HC reset complete in %zu us.\n", time);
288
289 /* Restore fm_interval */
290 instance->registers->fm_interval = fm_interval;
291 assert((instance->registers->command_status & CS_HCR) == 0);
292
293 /* hc is now in suspend state */
294 usb_log_debug2("HC should be in suspend state(%x).\n",
295 instance->registers->control);
296
297 /* Use HCCA */
298 instance->registers->hcca = addr_to_phys(instance->hcca);
299
300 /* Use queues */
301 instance->registers->bulk_head = instance->transfers_bulk.list_head_pa;
302 usb_log_debug2("Bulk HEAD set to: %p(%p).\n",
303 instance->transfers_bulk.list_head,
304 instance->transfers_bulk.list_head_pa);
305
306 instance->registers->control_head =
307 instance->transfers_control.list_head_pa;
308 usb_log_debug2("Control HEAD set to: %p(%p).\n",
309 instance->transfers_control.list_head,
310 instance->transfers_control.list_head_pa);
311
312 /* Enable queues */
313 instance->registers->control |= (C_PLE | C_IE | C_CLE | C_BLE);
314 usb_log_debug2("All queues enabled(%x).\n",
315 instance->registers->control);
316
317 /* Disable interrupts */
318 instance->registers->interrupt_disable = I_SF | I_OC;
319 usb_log_debug2("Disabling interrupts: %x.\n",
320 instance->registers->interrupt_disable);
321 instance->registers->interrupt_disable = I_MI;
322 usb_log_debug2("Enabled interrupts: %x.\n",
323 instance->registers->interrupt_enable);
324
325 /* Set periodic start to 90% */
326 uint32_t frame_length = ((fm_interval >> FMI_FI_SHIFT) & FMI_FI_MASK);
327 instance->registers->periodic_start = (frame_length / 10) * 9;
328 usb_log_debug2("All periodic start set to: %x(%u - 90%% of %d).\n",
329 instance->registers->periodic_start,
330 instance->registers->periodic_start, frame_length);
331
332 instance->registers->control &= (C_HCFS_OPERATIONAL << C_HCFS_SHIFT);
333 usb_log_info("OHCI HC up and running(%x).\n",
334 instance->registers->control);
335}
336/*----------------------------------------------------------------------------*/
337int hc_init_transfer_lists(hc_t *instance)
338{
339 assert(instance);
340
341#define SETUP_TRANSFER_LIST(type, name) \
342do { \
343 int ret = transfer_list_init(&instance->type, name); \
344 if (ret != EOK) { \
345 usb_log_error("Failed(%d) to setup %s transfer list.\n", \
346 ret, name); \
347 transfer_list_fini(&instance->transfers_isochronous); \
348 transfer_list_fini(&instance->transfers_interrupt); \
349 transfer_list_fini(&instance->transfers_control); \
350 transfer_list_fini(&instance->transfers_bulk); \
351 } \
352} while (0)
353
354 SETUP_TRANSFER_LIST(transfers_isochronous, "ISOCHRONOUS");
355 SETUP_TRANSFER_LIST(transfers_interrupt, "INTERRUPT");
356 SETUP_TRANSFER_LIST(transfers_control, "CONTROL");
357 SETUP_TRANSFER_LIST(transfers_bulk, "BULK");
358#undef SETUP_TRANSFER_LIST
359 transfer_list_set_next(&instance->transfers_interrupt,
360 &instance->transfers_isochronous);
361
362 /* Assign pointers to be used during scheduling */
363 instance->transfers[USB_TRANSFER_INTERRUPT] =
364 &instance->transfers_interrupt;
365 instance->transfers[USB_TRANSFER_ISOCHRONOUS] =
366 &instance->transfers_interrupt;
367 instance->transfers[USB_TRANSFER_CONTROL] =
368 &instance->transfers_control;
369 instance->transfers[USB_TRANSFER_BULK] =
370 &instance->transfers_bulk;
371
372 return EOK;
373}
374/*----------------------------------------------------------------------------*/
375int hc_init_memory(hc_t *instance)
376{
377 assert(instance);
378 /* Init queues */
379 hc_init_transfer_lists(instance);
380
381 /*Init HCCA */
382 instance->hcca = malloc32(sizeof(hcca_t));
383 if (instance->hcca == NULL)
384 return ENOMEM;
385 bzero(instance->hcca, sizeof(hcca_t));
386 usb_log_debug2("OHCI HCCA initialized at %p.\n", instance->hcca);
387
388 unsigned i = 0;
389 for (; i < 32; ++i) {
390 instance->hcca->int_ep[i] =
391 instance->transfers_interrupt.list_head_pa;
392 }
393 usb_log_debug2("Interrupt HEADs set to: %p(%p).\n",
394 instance->transfers_interrupt.list_head,
395 instance->transfers_interrupt.list_head_pa);
396
397 return EOK;
398}
399/**
400 * @}
401 */
Note: See TracBrowser for help on using the repository browser.