| 1 | /*
|
|---|
| 2 | * Copyright (c) 2011 Jan Vesely
|
|---|
| 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 libusbdev
|
|---|
| 29 | * @{
|
|---|
| 30 | */
|
|---|
| 31 | /** @file
|
|---|
| 32 | * Common USB types and functions.
|
|---|
| 33 | */
|
|---|
| 34 | #ifndef LIBUSBDEV_DEVICE_CONNECTION_H_
|
|---|
| 35 | #define LIBUSBDEV_DEVICE_CONNECTION_H_
|
|---|
| 36 |
|
|---|
| 37 | #include <errno.h>
|
|---|
| 38 | #include <devman.h>
|
|---|
| 39 | #include <usb/usb.h>
|
|---|
| 40 | #include <usb/hc.h>
|
|---|
| 41 |
|
|---|
| 42 |
|
|---|
| 43 | /** Abstraction of a physical connection to the device.
|
|---|
| 44 | * This type is an abstraction of the USB wire that connects the host and
|
|---|
| 45 | * the function (device).
|
|---|
| 46 | */
|
|---|
| 47 | typedef struct {
|
|---|
| 48 | /** Connection to the host controller device is connected to. */
|
|---|
| 49 | usb_hc_connection_t *hc_connection;
|
|---|
| 50 | /** Address of the device. */
|
|---|
| 51 | usb_address_t address;
|
|---|
| 52 | } usb_device_connection_t;
|
|---|
| 53 |
|
|---|
| 54 | static inline int usb_device_connection_initialize(
|
|---|
| 55 | usb_device_connection_t *connection, usb_hc_connection_t *hc_connection,
|
|---|
| 56 | usb_address_t address)
|
|---|
| 57 | {
|
|---|
| 58 | assert(connection);
|
|---|
| 59 |
|
|---|
| 60 | if (hc_connection == NULL) {
|
|---|
| 61 | return EBADMEM;
|
|---|
| 62 | }
|
|---|
| 63 |
|
|---|
| 64 | if ((address < 0) || (address >= USB11_ADDRESS_MAX)) {
|
|---|
| 65 | return EINVAL;
|
|---|
| 66 | }
|
|---|
| 67 |
|
|---|
| 68 | connection->hc_connection = hc_connection;
|
|---|
| 69 | connection->address = address;
|
|---|
| 70 | return EOK;
|
|---|
| 71 | }
|
|---|
| 72 | /*----------------------------------------------------------------------------*/
|
|---|
| 73 | /** Initialize connection to USB device on default address.
|
|---|
| 74 | *
|
|---|
| 75 | * @param dev_connection Device connection structure to be initialized.
|
|---|
| 76 | * @param hc_connection Initialized connection to host controller.
|
|---|
| 77 | * @return Error code.
|
|---|
| 78 | */
|
|---|
| 79 | static inline int usb_device_connection_initialize_on_default_address(
|
|---|
| 80 | usb_device_connection_t *connection, usb_hc_connection_t *hc_conn)
|
|---|
| 81 | {
|
|---|
| 82 | return usb_device_connection_initialize(connection, hc_conn, 0);
|
|---|
| 83 | }
|
|---|
| 84 | #endif
|
|---|
| 85 | /**
|
|---|
| 86 | * @}
|
|---|
| 87 | */
|
|---|
