source: mainline/uspace/drv/usbhub/ports.h@ a546687

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

Add missing documentation

  • Property mode set to 100644
File size: 2.5 KB
RevLine 
[578a2547]1/*
2 * Copyright (c) 2011 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 drvusbhub
30 * @{
31 */
32/** @file
33 * Hub ports related functions.
34 */
35#ifndef DRV_USBHUB_PORTS_H
36#define DRV_USBHUB_PORTS_H
37
38#include <ipc/devman.h>
39#include <usb/usb.h>
40#include <ddf/driver.h>
41#include <fibril_synch.h>
42
43#include <usb/hub.h>
44
45#include <usb/pipes.h>
46#include <usb/devdrv.h>
47
[69df9373]48/** Information about single port on a hub. */
[578a2547]49typedef struct {
[69df9373]50 /** Mutex needed by CV for checking port reset. */
[578a2547]51 fibril_mutex_t reset_mutex;
[69df9373]52 /** CV for waiting to port reset completion. */
[578a2547]53 fibril_condvar_t reset_cv;
[69df9373]54 /** Whether port reset is completed.
55 * Guarded by @c reset_mutex.
56 */
[578a2547]57 bool reset_completed;
[69df9373]58
59 /** Information about attached device. */
60 usb_hc_attached_device_t attached_device;
[578a2547]61} usb_hub_port_t;
62
[69df9373]63/** Initialize hub port information.
64 *
65 * @param port Port to be initialized.
66 */
[578a2547]67static inline void usb_hub_port_init(usb_hub_port_t *port) {
68 port->attached_device.address = -1;
69 port->attached_device.handle = 0;
70 fibril_mutex_initialize(&port->reset_mutex);
71 fibril_condvar_initialize(&port->reset_cv);
72}
73
74bool hub_port_changes_callback(usb_device_t *, uint8_t *, size_t, void *);
75
76
77#endif
78/**
79 * @}
80 */
Note: See TracBrowser for help on using the repository browser.