source: mainline/uspace/drv/ohci/root_hub.h@ 28d9c95

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

Doxygen and other minor fixes (no functional change)

  • Property mode set to 100644
File size: 2.6 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 drvusbohci
29 * @{
30 */
31/** @file
32 * @brief OHCI driver
33 */
34#ifndef DRV_OHCI_ROOT_HUB_H
35#define DRV_OHCI_ROOT_HUB_H
36
37#include <usb/usb.h>
38#include <usb/devdrv.h>
39
40#include "ohci_regs.h"
41#include "batch.h"
42
43/**
44 * ohci root hub representation
45 */
46typedef struct rh {
47 /** pointer to ohci driver registers */
48 ohci_regs_t *registers;
49 /** usb address of the root hub */
50 usb_address_t address;
51 /** hub port count */
52 size_t port_count;
53 /** hubs descriptors */
54 usb_device_descriptors_t descriptors;
55 /** interrupt transfer waiting for an actual interrupt to occur */
56 usb_transfer_batch_t * unfinished_interrupt_transfer;
57 /** pre-allocated interrupt mask
58 *
59 * This is allocated when initializing instance, so that memory
60 * allocation is not needed when processing request. Buffer is used for
61 * interrupt bitmask.
62 */
63 uint8_t * interrupt_buffer;
64 /** size of interrupt buffer */
65 size_t interrupt_mask_size;
66 /** instance`s descriptor*/
67 uint8_t * hub_descriptor;
68 /** size of hub descriptor */
69 size_t descriptor_size;
70
71
72} rh_t;
73
74int rh_init(rh_t *instance, ohci_regs_t *regs);
75
76int rh_request(rh_t *instance, usb_transfer_batch_t *request);
77
78void rh_interrupt(rh_t *instance);
79#endif
80/**
81 * @}
82 */
Note: See TracBrowser for help on using the repository browser.