| 1 | /*
|
|---|
| 2 | * Copyright (c) 2010 Matus Dekanek
|
|---|
| 3 | * Copyright (c) 2011 Jan Vesely
|
|---|
| 4 | * All rights reserved.
|
|---|
| 5 | *
|
|---|
| 6 | * Redistribution and use in source and binary forms, with or without
|
|---|
| 7 | * modification, are permitted provided that the following conditions
|
|---|
| 8 | * are met:
|
|---|
| 9 | *
|
|---|
| 10 | * - Redistributions of source code must retain the above copyright
|
|---|
| 11 | * notice, this list of conditions and the following disclaimer.
|
|---|
| 12 | * - Redistributions in binary form must reproduce the above copyright
|
|---|
| 13 | * notice, this list of conditions and the following disclaimer in the
|
|---|
| 14 | * documentation and/or other materials provided with the distribution.
|
|---|
| 15 | * - The name of the author may not be used to endorse or promote products
|
|---|
| 16 | * derived from this software without specific prior written permission.
|
|---|
| 17 | *
|
|---|
| 18 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
|
|---|
| 19 | * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
|---|
| 20 | * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
|
|---|
| 21 | * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
|
|---|
| 22 | * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
|
|---|
| 23 | * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|---|
| 24 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|---|
| 25 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|---|
| 26 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
|
|---|
| 27 | * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|---|
| 28 | */
|
|---|
| 29 | /** @addtogroup drvusbhub
|
|---|
| 30 | * @{
|
|---|
| 31 | */
|
|---|
| 32 |
|
|---|
| 33 | #ifndef HUB_STATUS_H
|
|---|
| 34 | #define HUB_STATUS_H
|
|---|
| 35 |
|
|---|
| 36 | #include <bool.h>
|
|---|
| 37 | #include <sys/types.h>
|
|---|
| 38 | #include <usb/dev/request.h>
|
|---|
| 39 |
|
|---|
| 40 | /**
|
|---|
| 41 | * structure holding port status and changes flags.
|
|---|
| 42 | * should not be accessed directly, use supplied getter/setter methods.
|
|---|
| 43 | *
|
|---|
| 44 | * For more information refer to tables 11-15 and 11-16 in
|
|---|
| 45 | * "Universal Serial Bus Specification Revision 1.1" pages 274 and 277
|
|---|
| 46 | * (290 and 293 in pdf)
|
|---|
| 47 | *
|
|---|
| 48 | */
|
|---|
| 49 | typedef uint32_t usb_port_status_t;
|
|---|
| 50 | #define USB_HUB_PORT_STATUS_CONNECTION \
|
|---|
| 51 | (uint32_usb2host(1 << (USB_HUB_FEATURE_PORT_CONNECTION)))
|
|---|
| 52 | #define USB_HUB_PORT_STATUS_ENABLED \
|
|---|
| 53 | (uint32_usb2host(1 << (USB_HUB_FEATURE_PORT_ENABLE)))
|
|---|
| 54 | #define USB_HUB_PORT_STATUS_SUSPEND \
|
|---|
| 55 | (uint32_usb2host(1 << (USB_HUB_FEATURE_PORT_SUSPEND)))
|
|---|
| 56 | #define USB_HUB_PORT_STATUS_OC \
|
|---|
| 57 | (uint32_usb2host(1 << (USB_HUB_FEATURE_PORT_OVER_CURRENT)))
|
|---|
| 58 | #define USB_HUB_PORT_STATUS_RESET \
|
|---|
| 59 | (uint32_usb2host(1 << (USB_HUB_FEATURE_PORT_RESET)))
|
|---|
| 60 | #define USB_HUB_PORT_STATUS_POWER \
|
|---|
| 61 | (uint32_usb2host(1 << (USB_HUB_FEATURE_PORT_POWER)))
|
|---|
| 62 | #define USB_HUB_PORT_STATUS_LOW_SPEED \
|
|---|
| 63 | (uint32_usb2host(1 << (USB_HUB_FEATURE_PORT_LOW_SPEED)))
|
|---|
| 64 | #define USB_HUB_PORT_STATUS_HIGH_SPEED \
|
|---|
| 65 | (uint32_usb2host(1 << 10))
|
|---|
| 66 |
|
|---|
| 67 | #define USB_HUB_PORT_C_STATUS_CONNECTION \
|
|---|
| 68 | (uint32_usb2host(1 << (USB_HUB_FEATURE_C_PORT_CONNECTION)))
|
|---|
| 69 | #define USB_HUB_PORT_C_STATUS_ENABLED \
|
|---|
| 70 | (uint32_usb2host(1 << (USB_HUB_FEATURE_C_PORT_ENABLE)))
|
|---|
| 71 | #define USB_HUB_PORT_C_STATUS_SUSPEND \
|
|---|
| 72 | (uint32_usb2host(1 << (USB_HUB_FEATURE_C_PORT_SUSPEND)))
|
|---|
| 73 | #define USB_HUB_PORT_C_STATUS_OC \
|
|---|
| 74 | (uint32_usb2host(1 << (USB_HUB_FEATURE_C_PORT_OVER_CURRENT)))
|
|---|
| 75 | #define USB_HUB_PORT_C_STATUS_RESET \
|
|---|
| 76 | (uint32_usb2host(1 << (USB_HUB_FEATURE_C_PORT_RESET)))
|
|---|
| 77 |
|
|---|
| 78 | /**
|
|---|
| 79 | * structure holding hub status and changes flags.
|
|---|
| 80 | *
|
|---|
| 81 | * For more information refer to table 11.16.2.5 in
|
|---|
| 82 | * "Universal Serial Bus Specification Revision 1.1"
|
|---|
| 83 | *
|
|---|
| 84 | */
|
|---|
| 85 | typedef uint32_t usb_hub_status_t;
|
|---|
| 86 | #define USB_HUB_STATUS_OVER_CURRENT \
|
|---|
| 87 | (uint32_usb2host(1 << (USB_HUB_FEATURE_HUB_OVER_CURRENT)))
|
|---|
| 88 | #define USB_HUB_STATUS_LOCAL_POWER \
|
|---|
| 89 | (uint32_usb2host(1 << (USB_HUB_FEATURE_HUB_LOCAL_POWER)))
|
|---|
| 90 |
|
|---|
| 91 | #define USB_HUB_STATUS_C_OVER_CURRENT \
|
|---|
| 92 | (uint32_usb2host(1 << (16 + USB_HUB_FEATURE_C_HUB_OVER_CURRENT)))
|
|---|
| 93 | #define USB_HUB_STATUS_C_LOCAL_POWER \
|
|---|
| 94 | (uint32_usb2host(1 << (16 + USB_HUB_FEATURE_C_HUB_LOCAL_POWER)))
|
|---|
| 95 |
|
|---|
| 96 |
|
|---|
| 97 | /**
|
|---|
| 98 | * speed getter for port status
|
|---|
| 99 | *
|
|---|
| 100 | * @param status
|
|---|
| 101 | * @return speed of usb device (for more see usb specification)
|
|---|
| 102 | */
|
|---|
| 103 | static inline usb_speed_t usb_port_speed(usb_port_status_t status)
|
|---|
| 104 | {
|
|---|
| 105 | if ((status & USB_HUB_PORT_STATUS_LOW_SPEED) != 0)
|
|---|
| 106 | return USB_SPEED_LOW;
|
|---|
| 107 | if ((status & USB_HUB_PORT_STATUS_HIGH_SPEED) != 0)
|
|---|
| 108 | return USB_SPEED_HIGH;
|
|---|
| 109 | return USB_SPEED_FULL;
|
|---|
| 110 | }
|
|---|
| 111 |
|
|---|
| 112 | #endif /* HUB_STATUS_H */
|
|---|
| 113 | /**
|
|---|
| 114 | * @}
|
|---|
| 115 | */
|
|---|
