| 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 <async.h>
|
|---|
| 42 | #include <usb/usb.h>
|
|---|
| 43 |
|
|---|
| 44 | typedef intptr_t usb_device_handle_t;
|
|---|
| 45 | enum {
|
|---|
| 46 | USB_DEVICE_HANDLE_INVALID = -1
|
|---|
| 47 | };
|
|---|
| 48 | typedef async_sess_t usb_dev_session_t;
|
|---|
| 49 |
|
|---|
| 50 | usb_dev_session_t *usb_dev_connect(devman_handle_t);
|
|---|
| 51 | usb_dev_session_t *usb_dev_connect_to_self(ddf_dev_t *);
|
|---|
| 52 | void usb_dev_disconnect(usb_dev_session_t *);
|
|---|
| 53 |
|
|---|
| 54 | int usb_get_my_address(async_exch_t *, usb_address_t *);
|
|---|
| 55 | int usb_get_my_interface(async_exch_t *, int *);
|
|---|
| 56 | int usb_get_hc_handle(async_exch_t *, devman_handle_t *);
|
|---|
| 57 | int usb_get_device_handle(async_exch_t *, devman_handle_t *);
|
|---|
| 58 |
|
|---|
| 59 | int usb_reserve_default_address(async_exch_t *, usb_speed_t);
|
|---|
| 60 | int usb_release_default_address(async_exch_t *);
|
|---|
| 61 |
|
|---|
| 62 | int usb_device_enumerate(async_exch_t *, usb_device_handle_t *);
|
|---|
| 63 | int usb_device_remove(async_exch_t *, usb_device_handle_t);
|
|---|
| 64 |
|
|---|
| 65 | int usb_register_endpoint(async_exch_t *, usb_endpoint_t, usb_transfer_type_t,
|
|---|
| 66 | usb_direction_t, size_t, unsigned);
|
|---|
| 67 | int usb_unregister_endpoint(async_exch_t *, usb_endpoint_t, usb_direction_t);
|
|---|
| 68 | int usb_read(async_exch_t *, usb_endpoint_t, uint64_t, void *, size_t, size_t *);
|
|---|
| 69 | int usb_write(async_exch_t *, usb_endpoint_t, uint64_t, const void *, size_t);
|
|---|
| 70 |
|
|---|
| 71 | /** Callback for outgoing transfer. */
|
|---|
| 72 | typedef void (*usbhc_iface_transfer_out_callback_t)(int, void *);
|
|---|
| 73 |
|
|---|
| 74 | /** Callback for incoming transfer. */
|
|---|
| 75 | typedef void (*usbhc_iface_transfer_in_callback_t)(int, size_t, void *);
|
|---|
| 76 |
|
|---|
| 77 | /** USB device communication interface. */
|
|---|
| 78 | typedef struct {
|
|---|
| 79 | int (*get_my_address)(ddf_fun_t *, usb_address_t *);
|
|---|
| 80 | int (*get_my_interface)(ddf_fun_t *, int *);
|
|---|
| 81 | int (*get_hc_handle)(ddf_fun_t *, devman_handle_t *);
|
|---|
| 82 |
|
|---|
| 83 | int (*get_device_handle)(ddf_fun_t *, devman_handle_t *);
|
|---|
| 84 |
|
|---|
| 85 | int (*reserve_default_address)(ddf_fun_t *, usb_speed_t);
|
|---|
| 86 | int (*release_default_address)(ddf_fun_t *);
|
|---|
| 87 | int (*device_enumerate)(ddf_fun_t *, usb_device_handle_t *);
|
|---|
| 88 | int (*device_remove)(ddf_fun_t *, usb_device_handle_t);
|
|---|
| 89 | int (*register_endpoint)(ddf_fun_t *, usb_endpoint_t,
|
|---|
| 90 | usb_transfer_type_t, usb_direction_t, size_t, unsigned);
|
|---|
| 91 | int (*unregister_endpoint)(ddf_fun_t *, usb_endpoint_t,
|
|---|
| 92 | usb_direction_t);
|
|---|
| 93 | int (*read)(ddf_fun_t *, usb_endpoint_t, uint64_t, uint8_t *, size_t,
|
|---|
| 94 | usbhc_iface_transfer_in_callback_t, void *);
|
|---|
| 95 | int (*write)(ddf_fun_t *, usb_endpoint_t, uint64_t, const uint8_t *,
|
|---|
| 96 | size_t, usbhc_iface_transfer_out_callback_t, void *);
|
|---|
| 97 | } usb_iface_t;
|
|---|
| 98 |
|
|---|
| 99 | #endif
|
|---|
| 100 | /**
|
|---|
| 101 | * @}
|
|---|
| 102 | */
|
|---|
