| 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 libdrv
|
|---|
| 30 | * @addtogroup usb
|
|---|
| 31 | * @{
|
|---|
| 32 | */
|
|---|
| 33 | /** @file
|
|---|
| 34 | * @brief USB interface definition.
|
|---|
| 35 | */
|
|---|
| 36 |
|
|---|
| 37 | #ifndef LIBDRV_USB_IFACE_H_
|
|---|
| 38 | #define LIBDRV_USB_IFACE_H_
|
|---|
| 39 |
|
|---|
| 40 | #include "ddf/driver.h"
|
|---|
| 41 | #include <usb/usb.h>
|
|---|
| 42 | typedef enum {
|
|---|
| 43 | /** Tell USB address assigned to device.
|
|---|
| 44 | * Parameters:
|
|---|
| 45 | * - devman handle id
|
|---|
| 46 | * Answer:
|
|---|
| 47 | * - EINVAL - unknown handle or handle not managed by this driver
|
|---|
| 48 | * - ENOTSUP - operation not supported (shall not happen)
|
|---|
| 49 | * - arbitrary error code if returned by remote implementation
|
|---|
| 50 | * - EOK - handle found, first parameter contains the USB address
|
|---|
| 51 | *
|
|---|
| 52 | * The handle must be the one used for binding USB address with
|
|---|
| 53 | * it (IPC_M_USBHC_BIND_ADDRESS), otherwise the host controller
|
|---|
| 54 | * (that this request would eventually reach) would not be able
|
|---|
| 55 | * to find it.
|
|---|
| 56 | * The problem is that this handle is actually assigned to the
|
|---|
| 57 | * function inside driver of the parent device (usually hub driver).
|
|---|
| 58 | * To bypass this problem, the initial caller specify handle as
|
|---|
| 59 | * zero and the first parent assigns the actual value.
|
|---|
| 60 | * See usb_iface_get_address_hub_child_impl() implementation
|
|---|
| 61 | * that could be assigned to device ops of a child device of in a
|
|---|
| 62 | * hub driver.
|
|---|
| 63 | * For example, the USB multi interface device driver (MID)
|
|---|
| 64 | * passes this initial zero without any modification because the
|
|---|
| 65 | * handle must be resolved by its parent.
|
|---|
| 66 | */
|
|---|
| 67 | IPC_M_USB_GET_ADDRESS,
|
|---|
| 68 |
|
|---|
| 69 | /** Tell interface number given device can use.
|
|---|
| 70 | * Parameters
|
|---|
| 71 | * - devman handle id of the device
|
|---|
| 72 | * Answer:
|
|---|
| 73 | * - ENOTSUP - operation not supported (can also mean any interface)
|
|---|
| 74 | * - EOK - operation okay, first parameter contains interface number
|
|---|
| 75 | */
|
|---|
| 76 | IPC_M_USB_GET_INTERFACE,
|
|---|
| 77 |
|
|---|
| 78 | /** Tell devman handle of device host controller.
|
|---|
| 79 | * Parameters:
|
|---|
| 80 | * - none
|
|---|
| 81 | * Answer:
|
|---|
| 82 | * - EOK - request processed without errors
|
|---|
| 83 | * - ENOTSUP - this indicates invalid USB driver
|
|---|
| 84 | * Parameters of the answer:
|
|---|
| 85 | * - devman handle of HC caller is physically connected to
|
|---|
| 86 | */
|
|---|
| 87 | IPC_M_USB_GET_HOST_CONTROLLER_HANDLE
|
|---|
| 88 | } usb_iface_funcs_t;
|
|---|
| 89 |
|
|---|
| 90 | /** USB device communication interface. */
|
|---|
| 91 | typedef struct {
|
|---|
| 92 | int (*get_address)(ddf_fun_t *, devman_handle_t, usb_address_t *);
|
|---|
| 93 | int (*get_interface)(ddf_fun_t *, devman_handle_t, int *);
|
|---|
| 94 | int (*get_hc_handle)(ddf_fun_t *, devman_handle_t *);
|
|---|
| 95 | } usb_iface_t;
|
|---|
| 96 |
|
|---|
| 97 |
|
|---|
| 98 | #endif
|
|---|
| 99 | /**
|
|---|
| 100 | * @}
|
|---|
| 101 | */
|
|---|
