source: mainline/uspace/drv/bus/usb/ehci/hc.h@ e4d7363

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since e4d7363 was e4d7363, checked in by Ondřej Hlavatý <aearsis@…>, 8 years ago

usbhost: refactor the initialization

Before that, drivers had to setup MMIO range multiple times, or even parse hw
resources themselves again. The former init method was split in half - init and
start. Init shall allocate and initialize inner structures, start shall start
the HC.

In the XHCI it is demonstrated how to isolate inner HC implementation from the
fact this driver is using libusbhost. It adds some boilerplate code, but
I think it leads to cleaner design.

  • Property mode set to 100644
File size: 3.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 drvusbehci
29 * @{
30 */
31/** @file
32 * @brief EHCI host controller driver structure
33 */
34#ifndef DRV_EHCI_HC_H
35#define DRV_EHCI_HC_H
36
37#include <adt/list.h>
38#include <ddi.h>
39#include <ddf/driver.h>
40#include <device/hw_res_parsed.h>
41#include <fibril.h>
42#include <fibril_synch.h>
43#include <stdbool.h>
44#include <stdint.h>
45
46#include <usb/host/hcd.h>
47#include <usb/host/endpoint.h>
48#include <usb/host/usb_transfer_batch.h>
49
50#include "ehci_regs.h"
51#include "ehci_rh.h"
52#include "hw_struct/link_pointer.h"
53#include "endpoint_list.h"
54
55/** Main EHCI driver structure */
56typedef struct hc {
57 /** Memory mapped CAPS register area */
58 ehci_caps_regs_t *caps;
59 /** Memory mapped I/O registers area */
60 ehci_regs_t *registers;
61
62 /** Iso transfer list */
63 link_pointer_t *periodic_list_base;
64
65 /** CONTROL and BULK schedules */
66 endpoint_list_t async_list;
67
68 /** INT schedule */
69 endpoint_list_t int_list;
70
71 /** List of active transfers */
72 list_t pending_batches;
73
74 /** Guards schedule and endpoint manipulation */
75 fibril_mutex_t guard;
76
77 /** Wait for hc to restart async chedule */
78 fibril_condvar_t async_doorbell;
79
80 /** USB hub emulation structure */
81 ehci_rh_t rh;
82} hc_t;
83
84int hc_init(hc_t *instance, const hw_res_list_parsed_t *hw_res);
85int hc_start(hc_t *instance, bool interrupts);
86void hc_fini(hc_t *instance);
87
88void hc_enqueue_endpoint(hc_t *instance, const endpoint_t *ep);
89void hc_dequeue_endpoint(hc_t *instance, const endpoint_t *ep);
90
91int ehci_hc_gen_irq_code(irq_code_t *code, hcd_t *hcd, const hw_res_list_parsed_t *hw_res);
92
93void ehci_hc_interrupt(hcd_t *hcd, uint32_t status);
94int ehci_hc_status(hcd_t *hcd, uint32_t *status);
95int ehci_hc_schedule(hcd_t *hcd, usb_transfer_batch_t *batch);
96#endif
97/**
98 * @}
99 */
Note: See TracBrowser for help on using the repository browser.