source: mainline/uspace/drv/bus/usb/uhci/uhci_rh.h@ 3f03199

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

uhci: Cleanup.

include guard, doxygen, line wrap.

  • Property mode set to 100644
File size: 2.5 KB
Line 
1/*
2 * Copyright (c) 2013 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
29/** @addtogroup drvusbuhci
30 * @{
31 */
32/** @file
33 * @brief UHCI host controller driver structure
34 */
35#ifndef DRV_UHCI_UHCI_RH_H
36#define DRV_UHCI_UHCI_RH_H
37
38#include <usbvirt/virthub_base.h>
39#include <usb/host/usb_transfer_batch.h>
40
41/** Endpoint number for status change pipe. */
42#define HUB_STATUS_CHANGE_PIPE 1
43
44/** Virtual to UHCI hub connector */
45typedef struct {
46 /** Virtual hub software implementation */
47 virthub_base_t base;
48 /** UHCI root hub port io registers */
49 ioport16_t *ports[2];
50 /** Reset change indicator, it is not reported by regs */
51 bool reset_changed[2];
52} uhci_rh_t;
53
54int uhci_rh_init(uhci_rh_t *instance, ioport16_t *ports, const char *name);
55int uhci_rh_schedule(uhci_rh_t *instance, usb_transfer_batch_t *batch);
56
57/** Get UHCI rh address.
58 *
59 * @param instance UHCI rh instance.
60 * @return USB address assigned to the hub.
61 * Wrapper for virtual hub address
62 */
63static inline usb_address_t uhci_rh_get_address(uhci_rh_t *instance)
64{
65 assert(instance);
66 return virthub_base_get_address(&instance->base);
67}
68
69#endif
70/**
71 * @}
72 */
Note: See TracBrowser for help on using the repository browser.