source: mainline/uspace/drv/ohci/hc.c@ 112d159

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

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