source: mainline/uspace/lib/usb/src/hcdhubd_private.h@ 3b77628

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since 3b77628 was 3b77628, checked in by Vojtech Horky <vojtechhorky@…>, 14 years ago

Doxygen comment fixes

Mainly proper subgrouping and some missing @param comments.

  • Property mode set to 100644
File size: 2.4 KB
Line 
1/*
2 * Copyright (c) 2010 Vojtech Horky
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 libusb
30 * @{
31 */
32/** @file
33 * @brief Common definitions for both HC driver and hub driver.
34 */
35#ifndef LIBUSB_HCDHUBD_PRIVATE_H_
36#define LIBUSB_HCDHUBD_PRIVATE_H_
37
38#define USB_HUB_DEVICE_NAME "usbhub"
39#define USB_KBD_DEVICE_NAME "hid"
40
41extern link_t hc_list;
42extern usb_hc_driver_t *hc_driver;
43
44extern usbhc_iface_t usbhc_interface;
45
46usb_address_t usb_get_address_by_handle(devman_handle_t);
47int usb_add_hc_device(device_t *);
48
49/** lowest allowed usb address */
50extern int usb_lowest_address;
51
52/** highest allowed usb address */
53extern int usb_highest_address;
54
55/**
56 * @brief initialize address list of given hcd
57 *
58 * This function should be used only for hcd initialization.
59 * It creates interval list of free addresses, thus it is initialized as
60 * list with one interval with whole address space. Using an address shrinks
61 * the interval, freeing an address extends an interval or creates a
62 * new one.
63 *
64 * @param hcd
65 * @return
66 */
67void usb_create_address_list(usb_hc_device_t * hcd);
68
69
70
71
72
73
74#endif
75/**
76 * @}
77 */
Note: See TracBrowser for help on using the repository browser.