uspace/lib/usbhost/include/usb/host/ddf_helpers.h

   1 /*
   2  * Copyright (c) 2012 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
  29 /** @addtogroup libusbhost
  30  * @{
  31  */
  32 /** @file
  33  *
  34  */
  35
  36 #ifndef LIBUSBHOST_HOST_DDF_HELPERS_H
  37 #define LIBUSBHOST_HOST_DDF_HELPERS_H
  38
  39 #include <usb/host/hcd.h>
  40 #include <usb/host/usb_bus.h>
  41 #include <usb/usb.h>
  42
  43 #include <ddf/driver.h>
  44 #include <ddf/interrupt.h>
  45 #include <device/hw_res_parsed.h>
  46
  47 typedef int (*driver_init_t)(hcd_t *, const hw_res_list_parsed_t *, bool);
  48 typedef void (*driver_fini_t)(hcd_t *);
  49 typedef int (*claim_t)(ddf_dev_t *);
  50 typedef int (*irq_code_gen_t)(irq_code_t *, const hw_res_list_parsed_t *);
  51
  52 typedef struct {
  53         hcd_ops_t ops;
  54         claim_t claim;
  55         usb_speed_t hc_speed;
  56         driver_init_t init;
  57         driver_fini_t fini;
  58         interrupt_handler_t *irq_handler;
  59         irq_code_gen_t irq_code_gen;
  60         const char *name;
  61 } ddf_hc_driver_t;
  62
  63 int hcd_ddf_add_hc(ddf_dev_t *device, const ddf_hc_driver_t *driver);
  64
  65 int hcd_ddf_setup_hc(ddf_dev_t *device, usb_speed_t max_speed,
  66     size_t bw, bw_count_func_t bw_count);
  67 void hcd_ddf_clean_hc(ddf_dev_t *device);
  68 int hcd_ddf_setup_root_hub(ddf_dev_t *device);
  69
  70 hcd_t *dev_to_hcd(ddf_dev_t *dev);
  71
  72 int hcd_ddf_enable_interrupt(ddf_dev_t *device, int);
  73 int hcd_ddf_get_registers(ddf_dev_t *device, hw_res_list_parsed_t *hw_res);
  74 int hcd_ddf_setup_interrupts(ddf_dev_t *device,
  75     const hw_res_list_parsed_t *hw_res,
  76     interrupt_handler_t handler,
  77     int (*gen_irq_code)(irq_code_t *, const hw_res_list_parsed_t *));
  78 void ddf_hcd_gen_irq_handler(ipc_call_t *call, ddf_dev_t *dev);
  79
  80 #endif
  81
  82 /**
  83  * @}
  84  */