| 1 | /*
|
|---|
| 2 | * Copyright (c) 2010 Vojtech Horky
|
|---|
| 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 libdrv
|
|---|
| 30 | * @addtogroup usb
|
|---|
| 31 | * @{
|
|---|
| 32 | */
|
|---|
| 33 | /** @file
|
|---|
| 34 | * @brief USB host controller interface definition.
|
|---|
| 35 | */
|
|---|
| 36 |
|
|---|
| 37 | #ifndef LIBDRV_USBHC_IFACE_H_
|
|---|
| 38 | #define LIBDRV_USBHC_IFACE_H_
|
|---|
| 39 |
|
|---|
| 40 | #include "ddf/driver.h"
|
|---|
| 41 | #include <usb/usb.h>
|
|---|
| 42 | #include <bool.h>
|
|---|
| 43 |
|
|---|
| 44 | int usbhc_request_address(async_exch_t *, usb_address_t *, bool, usb_speed_t);
|
|---|
| 45 | int usbhc_bind_address(async_exch_t *, usb_address_t, devman_handle_t);
|
|---|
| 46 | int usbhc_get_handle(async_exch_t *, usb_address_t, devman_handle_t *);
|
|---|
| 47 | int usbhc_release_address(async_exch_t *, usb_address_t);
|
|---|
| 48 | int usbhc_register_endpoint(async_exch_t *, usb_address_t, usb_endpoint_t,
|
|---|
| 49 | usb_transfer_type_t, usb_direction_t, size_t, unsigned int);
|
|---|
| 50 | int usbhc_unregister_endpoint(async_exch_t *, usb_address_t, usb_endpoint_t,
|
|---|
| 51 | usb_direction_t);
|
|---|
| 52 | int usbhc_read(async_exch_t *, usb_address_t, usb_endpoint_t,
|
|---|
| 53 | uint64_t, void *, size_t, size_t *);
|
|---|
| 54 | int usbhc_write(async_exch_t *, usb_address_t, usb_endpoint_t,
|
|---|
| 55 | uint64_t, const void *, size_t);
|
|---|
| 56 |
|
|---|
| 57 | /** Callback for outgoing transfer. */
|
|---|
| 58 | typedef void (*usbhc_iface_transfer_out_callback_t)(ddf_fun_t *, int, void *);
|
|---|
| 59 |
|
|---|
| 60 | /** Callback for incoming transfer. */
|
|---|
| 61 | typedef void (*usbhc_iface_transfer_in_callback_t)(ddf_fun_t *,
|
|---|
| 62 | int, size_t, void *);
|
|---|
| 63 |
|
|---|
| 64 | /** USB host controller communication interface. */
|
|---|
| 65 | typedef struct {
|
|---|
| 66 | int (*request_address)(ddf_fun_t *, usb_address_t *, bool, usb_speed_t);
|
|---|
| 67 | int (*bind_address)(ddf_fun_t *, usb_address_t, devman_handle_t);
|
|---|
| 68 | int (*get_handle)(ddf_fun_t *, usb_address_t,
|
|---|
| 69 | devman_handle_t *);
|
|---|
| 70 | int (*release_address)(ddf_fun_t *, usb_address_t);
|
|---|
| 71 |
|
|---|
| 72 | int (*register_endpoint)(ddf_fun_t *,
|
|---|
| 73 | usb_address_t, usb_endpoint_t,
|
|---|
| 74 | usb_transfer_type_t, usb_direction_t, size_t, unsigned int);
|
|---|
| 75 | int (*unregister_endpoint)(ddf_fun_t *, usb_address_t, usb_endpoint_t,
|
|---|
| 76 | usb_direction_t);
|
|---|
| 77 |
|
|---|
| 78 | int (*read)(ddf_fun_t *, usb_target_t, uint64_t, uint8_t *, size_t,
|
|---|
| 79 | usbhc_iface_transfer_in_callback_t, void *);
|
|---|
| 80 |
|
|---|
| 81 | int (*write)(ddf_fun_t *, usb_target_t, uint64_t, const uint8_t *,
|
|---|
| 82 | size_t, usbhc_iface_transfer_out_callback_t, void *);
|
|---|
| 83 | } usbhc_iface_t;
|
|---|
| 84 |
|
|---|
| 85 |
|
|---|
| 86 | #endif
|
|---|
| 87 | /**
|
|---|
| 88 | * @}
|
|---|
| 89 | */
|
|---|
