source: mainline/uspace/drv/ohci/hc.c@ 0ede0c3

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

More debug (still does not work)
  • Property mode set to 100644
File size: 12.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
116 rh_init(&instance->rh, dev, instance->registers);
117
118 if (!interrupts) {
119 instance->interrupt_emulator =
120 fibril_create((int(*)(void*))interrupt_emulator, instance);
121 fibril_add_ready(instance->interrupt_emulator);
122 }
123
124 return EOK;
125}
126/*----------------------------------------------------------------------------*/
127int hc_schedule(hc_t *instance, usb_transfer_batch_t *batch)
128{
129 assert(instance);
130 assert(batch);
131
132 /* check for root hub communication */
133 if (batch->target.address == instance->rh.address) {
134 return rh_request(&instance->rh, batch);
135 }
136
137 transfer_list_add_batch(
138 instance->transfers[batch->transfer_type], batch);
139
140 switch (batch->transfer_type) {
141 case USB_TRANSFER_CONTROL:
142 instance->registers->control &= ~C_CLE;
143 instance->registers->command_status |= CS_CLF;
144 usb_log_debug2("Set control transfer filled: %x.\n",
145 instance->registers->command_status);
146 instance->registers->control |= C_CLE;
147 break;
148 case USB_TRANSFER_BULK:
149 instance->registers->command_status |= CS_BLF;
150 usb_log_debug2("Set bulk transfer filled: %x.\n",
151 instance->registers->command_status);
152 break;
153 default:
154 break;
155 }
156 return EOK;
157}
158/*----------------------------------------------------------------------------*/
159void hc_interrupt(hc_t *instance, uint32_t status)
160{
161 assert(instance);
162 if ((status & ~IS_SF) == 0) /* ignore sof status */
163 return;
164 if (status & IS_RHSC)
165 rh_interrupt(&instance->rh);
166
167 usb_log_info("OHCI interrupt: %x.\n", status);
168
169
170 LIST_INITIALIZE(done);
171 transfer_list_remove_finished(&instance->transfers_interrupt, &done);
172 transfer_list_remove_finished(&instance->transfers_isochronous, &done);
173 transfer_list_remove_finished(&instance->transfers_control, &done);
174 transfer_list_remove_finished(&instance->transfers_bulk, &done);
175
176 while (!list_empty(&done)) {
177 link_t *item = done.next;
178 list_remove(item);
179 usb_transfer_batch_t *batch =
180 list_get_instance(item, usb_transfer_batch_t, link);
181 usb_transfer_batch_finish(batch);
182 }
183}
184/*----------------------------------------------------------------------------*/
185int interrupt_emulator(hc_t *instance)
186{
187 assert(instance);
188 usb_log_info("Started interrupt emulator.\n");
189 while (1) {
190 const uint32_t status = instance->registers->interrupt_status;
191 instance->registers->interrupt_status = status;
192 hc_interrupt(instance, status);
193 async_usleep(1000);
194 }
195 return EOK;
196}
197/*----------------------------------------------------------------------------*/
198void hc_gain_control(hc_t *instance)
199{
200 assert(instance);
201 /* Turn off legacy emulation */
202 volatile uint32_t *ohci_emulation_reg =
203 (uint32_t*)((char*)instance->registers + 0x100);
204 usb_log_debug("OHCI legacy register %p: %x.\n",
205 ohci_emulation_reg, *ohci_emulation_reg);
206 *ohci_emulation_reg = 0;
207
208 /* Interrupt routing enabled => smm driver is active */
209 if (instance->registers->control & C_IR) {
210 usb_log_debug("SMM driver: request ownership change.\n");
211 instance->registers->command_status |= CS_OCR;
212 while (instance->registers->control & C_IR) {
213 async_usleep(1000);
214 }
215 usb_log_info("SMM driver: Ownership taken.\n");
216 return;
217 }
218
219 const unsigned hc_status =
220 (instance->registers->control >> C_HCFS_SHIFT) & C_HCFS_MASK;
221 /* Interrupt routing disabled && status != USB_RESET => BIOS active */
222 if (hc_status != C_HCFS_RESET) {
223 usb_log_debug("BIOS driver found.\n");
224 if (hc_status == C_HCFS_OPERATIONAL) {
225 usb_log_info("BIOS driver: HC operational.\n");
226 return;
227 }
228 /* HC is suspended assert resume for 20ms */
229 instance->registers->control &= (C_HCFS_RESUME << C_HCFS_SHIFT);
230 async_usleep(20000);
231 usb_log_info("BIOS driver: HC resumed.\n");
232 return;
233 }
234
235 /* HC is in reset (hw startup) => no other driver
236 * maintain reset for at least the time specified in USB spec (50 ms)*/
237 usb_log_info("HC found in reset.\n");
238 async_usleep(50000);
239}
240/*----------------------------------------------------------------------------*/
241void hc_init_hw(hc_t *instance)
242{
243 /* OHCI guide page 42 */
244 assert(instance);
245 usb_log_debug2("Started hc initialization routine.\n");
246
247 /* Save contents of fm_interval register */
248 const uint32_t fm_interval = instance->registers->fm_interval;
249 usb_log_debug2("Old value of HcFmInterval: %x.\n", fm_interval);
250
251 /* Reset hc */
252 usb_log_debug2("HC reset.\n");
253 size_t time = 0;
254 instance->registers->command_status = CS_HCR;
255 while (instance->registers->command_status & CS_HCR) {
256 async_usleep(10);
257 time += 10;
258 }
259 usb_log_debug2("HC reset complete in %zu us.\n", time);
260
261 /* Restore fm_interval */
262 instance->registers->fm_interval = fm_interval;
263 assert((instance->registers->command_status & CS_HCR) == 0);
264
265 /* hc is now in suspend state */
266 usb_log_debug2("HC should be in suspend state(%x).\n",
267 instance->registers->control);
268
269 /* Enable queues */
270 instance->registers->control |= (C_PLE | C_IE | C_CLE | C_BLE);
271 usb_log_debug2("All queues enabled(%x).\n",
272 instance->registers->control);
273
274 /* Disable interrupts */
275 instance->registers->interrupt_disable = I_SF | I_OC;
276 usb_log_debug2("Disabling interrupts: %x.\n",
277 instance->registers->interrupt_disable);
278 instance->registers->interrupt_disable = I_MI;
279 usb_log_debug2("Enabled interrupts: %x.\n",
280 instance->registers->interrupt_enable);
281
282 /* Set periodic start to 90% */
283 uint32_t frame_length = ((fm_interval >> FMI_FI_SHIFT) & FMI_FI_MASK);
284 instance->registers->periodic_start = (frame_length / 10) * 9;
285 usb_log_debug2("All periodic start set to: %x(%u - 90%% of %d).\n",
286 instance->registers->periodic_start,
287 instance->registers->periodic_start, frame_length);
288
289 instance->registers->control &= (C_HCFS_OPERATIONAL << C_HCFS_SHIFT);
290 usb_log_info("OHCI HC up and running(%x).\n",
291 instance->registers->control);
292}
293/*----------------------------------------------------------------------------*/
294int hc_init_transfer_lists(hc_t *instance)
295{
296 assert(instance);
297
298#define SETUP_TRANSFER_LIST(type, name) \
299do { \
300 int ret = transfer_list_init(&instance->type, name); \
301 if (ret != EOK) { \
302 usb_log_error("Failed(%d) to setup %s transfer list.\n", \
303 ret, name); \
304 transfer_list_fini(&instance->transfers_isochronous); \
305 transfer_list_fini(&instance->transfers_interrupt); \
306 transfer_list_fini(&instance->transfers_control); \
307 transfer_list_fini(&instance->transfers_bulk); \
308 } \
309} while (0)
310
311 SETUP_TRANSFER_LIST(transfers_isochronous, "ISOCHRONOUS");
312 SETUP_TRANSFER_LIST(transfers_interrupt, "INTERRUPT");
313 SETUP_TRANSFER_LIST(transfers_control, "CONTROL");
314 SETUP_TRANSFER_LIST(transfers_bulk, "BULK");
315
316 transfer_list_set_next(&instance->transfers_interrupt,
317 &instance->transfers_isochronous);
318
319 /* Assign pointers to be used during scheduling */
320 instance->transfers[USB_TRANSFER_INTERRUPT] =
321 &instance->transfers_interrupt;
322 instance->transfers[USB_TRANSFER_ISOCHRONOUS] =
323 &instance->transfers_interrupt;
324 instance->transfers[USB_TRANSFER_CONTROL] =
325 &instance->transfers_control;
326 instance->transfers[USB_TRANSFER_BULK] =
327 &instance->transfers_bulk;
328
329 return EOK;
330#undef CHECK_RET_CLEAR_RETURN
331}
332/*----------------------------------------------------------------------------*/
333int hc_init_memory(hc_t *instance)
334{
335 assert(instance);
336 /* Init queues */
337 hc_init_transfer_lists(instance);
338
339 /*Init HCCA */
340 instance->hcca = malloc32(sizeof(hcca_t));
341 if (instance->hcca == NULL)
342 return ENOMEM;
343 bzero(instance->hcca, sizeof(hcca_t));
344 instance->registers->hcca = addr_to_phys(instance->hcca);
345 usb_log_debug2("OHCI HCCA initialized at %p(%p).\n",
346 instance->hcca, instance->registers->hcca);
347
348 /* Use queues */
349 instance->registers->bulk_head = instance->transfers_bulk.list_head_pa;
350 usb_log_debug2("Bulk HEAD set to: %p(%p).\n",
351 instance->transfers_bulk.list_head,
352 instance->transfers_bulk.list_head_pa);
353
354 instance->registers->control_head =
355 instance->transfers_control.list_head_pa;
356 usb_log_debug2("Control HEAD set to: %p(%p).\n",
357 instance->transfers_control.list_head,
358 instance->transfers_control.list_head_pa);
359
360 unsigned i = 0;
361 for (; i < 32; ++i) {
362 instance->hcca->int_ep[i] =
363 instance->transfers_interrupt.list_head_pa;
364 }
365 usb_log_debug2("Interrupt HEADs set to: %p(%p).\n",
366 instance->transfers_interrupt.list_head,
367 instance->transfers_interrupt.list_head_pa);
368
369 return EOK;
370}
371/**
372 * @}
373 */
Note: See TracBrowser for help on using the repository browser.