| 1 | /*
|
|---|
| 2 | * Copyright (c) 2018 Ondrej Hlavaty
|
|---|
| 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 libusbhost
|
|---|
| 29 | * @{
|
|---|
| 30 | */
|
|---|
| 31 | /** @file
|
|---|
| 32 | *
|
|---|
| 33 | */
|
|---|
| 34 | #ifndef XHCI_DEVICE_H
|
|---|
| 35 | #define XHCI_DEVICE_H
|
|---|
| 36 |
|
|---|
| 37 | #include <usb/host/bus.h>
|
|---|
| 38 | #include <usb/dma_buffer.h>
|
|---|
| 39 |
|
|---|
| 40 | typedef struct xhci_slot_ctx xhci_slot_ctx_t;
|
|---|
| 41 |
|
|---|
| 42 | typedef struct xhci_device {
|
|---|
| 43 | device_t base; /**< Inheritance. Keep this first. */
|
|---|
| 44 |
|
|---|
| 45 | /** Slot ID assigned to the device by xHC. */
|
|---|
| 46 | uint32_t slot_id;
|
|---|
| 47 |
|
|---|
| 48 | /** Corresponding port on RH */
|
|---|
| 49 | uint8_t rh_port;
|
|---|
| 50 |
|
|---|
| 51 | /** Route string */
|
|---|
| 52 | uint32_t route_str;
|
|---|
| 53 |
|
|---|
| 54 | /** Place to store the allocated context */
|
|---|
| 55 | dma_buffer_t dev_ctx;
|
|---|
| 56 |
|
|---|
| 57 | /** Hub specific information. Valid only if the device is_hub. */
|
|---|
| 58 | bool is_hub;
|
|---|
| 59 | uint8_t num_ports;
|
|---|
| 60 | uint8_t tt_think_time;
|
|---|
| 61 | } xhci_device_t;
|
|---|
| 62 |
|
|---|
| 63 | #define XHCI_DEV_FMT "(%s, slot %d)"
|
|---|
| 64 | #define XHCI_DEV_ARGS(dev) ddf_fun_get_name((dev).base.fun), (dev).slot_id
|
|---|
| 65 |
|
|---|
| 66 | /* Bus callbacks */
|
|---|
| 67 | errno_t xhci_device_enumerate(device_t *);
|
|---|
| 68 | void xhci_device_offline(device_t *);
|
|---|
| 69 | errno_t xhci_device_online(device_t *);
|
|---|
| 70 | void xhci_device_gone(device_t *);
|
|---|
| 71 |
|
|---|
| 72 | void xhci_setup_slot_context(xhci_device_t *, xhci_slot_ctx_t *);
|
|---|
| 73 |
|
|---|
| 74 | static inline xhci_device_t *xhci_device_get(device_t *dev)
|
|---|
| 75 | {
|
|---|
| 76 | assert(dev);
|
|---|
| 77 | return (xhci_device_t *) dev;
|
|---|
| 78 | }
|
|---|
| 79 |
|
|---|
| 80 | #endif
|
|---|
| 81 | /**
|
|---|
| 82 | * @}
|
|---|
| 83 | */
|
|---|
