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

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

Postpone launching of interrupt emulator after everything else is initialized

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