uspace/lib/usbdev/include/usb/dev/device.h

   1 /*
   2  * Copyright (c) 2011 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 libusbdev
  30  * @{
  31  */
  32 /** @file
  33  * USB device driver framework.
  34  */
  35
  36 #ifndef LIBUSBDEV_DEVICE_H_
  37 #define LIBUSBDEV_DEVICE_H_
  38
  39 #include <ddf/driver.h>
  40 #include <usb/usb.h>
  41 #include <usb/descriptor.h>
  42 #include <usb/dev/alternate_ifaces.h>
  43 #include <usb/dev/pipes.h>
  44
  45 #include <assert.h>
  46 #include <async.h>
  47
  48 /** Some useful descriptors for USB device. */
  49 typedef struct {
  50         /** Standard device descriptor. */
  51         usb_standard_device_descriptor_t device;
  52         /** Full configuration descriptor of current configuration. */
  53         void *full_config;
  54         size_t full_config_size;
  55 } usb_device_descriptors_t;
  56
  57 typedef struct usb_device usb_device_t;
  58
  59 /* DDF parts */
  60 errno_t usb_device_create_ddf(ddf_dev_t *, const usb_endpoint_description_t **, const char **);
  61 void usb_device_destroy_ddf(ddf_dev_t *);
  62
  63 static inline usb_device_t *usb_device_get(ddf_dev_t *dev)
  64 {
  65         assert(dev);
  66         return ddf_dev_data_get(dev);
  67 }
  68
  69 usb_device_t * usb_device_create(devman_handle_t);
  70 void usb_device_destroy(usb_device_t *);
  71
  72 const char * usb_device_get_name(usb_device_t *);
  73 ddf_fun_t *usb_device_ddf_fun_create(usb_device_t *, fun_type_t, const char *);
  74
  75 async_exch_t * usb_device_bus_exchange_begin(usb_device_t *);
  76 void usb_device_bus_exchange_end(async_exch_t *);
  77
  78 errno_t usb_device_select_interface(usb_device_t *, uint8_t,
  79     const usb_endpoint_description_t **);
  80
  81 errno_t usb_device_create_pipes(usb_device_t *usb_dev,
  82     const usb_endpoint_description_t **endpoints);
  83 void usb_device_destroy_pipes(usb_device_t *);
  84
  85 usb_pipe_t *usb_device_get_default_pipe(usb_device_t *);
  86 usb_endpoint_mapping_t * usb_device_get_mapped_ep_desc(usb_device_t *,
  87     const usb_endpoint_description_t *);
  88 usb_endpoint_mapping_t * usb_device_get_mapped_ep(usb_device_t *,
  89     usb_endpoint_t);
  90
  91 int usb_device_get_iface_number(usb_device_t *);
  92 devman_handle_t usb_device_get_devman_handle(usb_device_t *);
  93
  94 const usb_device_descriptors_t * usb_device_descriptors(usb_device_t *);
  95
  96 const usb_alternate_interfaces_t * usb_device_get_alternative_ifaces(
  97     usb_device_t *);
  98
  99 void * usb_device_data_alloc(usb_device_t *, size_t);
 100 void * usb_device_data_get(usb_device_t *);
 101
 102 #endif
 103 /**
 104  * @}
 105  */