uspace/lib/drv/include/usbhid_iface.h

   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  * @{
  31  */
  32 /** @file
  33  * USB HID interface definition.
  34  */
  35
  36 #ifndef LIBDRV_USBHID_IFACE_H_
  37 #define LIBDRV_USBHID_IFACE_H_
  38
  39 #include "ddf/driver.h"
  40
  41 extern errno_t usbhid_dev_get_event_length(async_sess_t *, size_t *);
  42 extern errno_t usbhid_dev_get_event(async_sess_t *, uint8_t *, size_t, size_t *,
  43     int *, unsigned int);
  44 extern errno_t usbhid_dev_get_report_descriptor_length(async_sess_t *, size_t *);
  45 extern errno_t usbhid_dev_get_report_descriptor(async_sess_t *, uint8_t *, size_t,
  46     size_t *);
  47
  48 /** USB HID device communication interface. */
  49 typedef struct {
  50         /** Get size of the event in bytes.
  51          *
  52          * @param[in] fun DDF function answering the request.
  53          * @return Size of the event in bytes.
  54          */
  55         size_t (*get_event_length)(ddf_fun_t *fun);
  56
  57         /** Get single event from the HID device.
  58          *
  59          * @param[in] fun DDF function answering the request.
  60          * @param[out] buffer Buffer with raw data from the device.
  61          * @param[out] act_size Actual number of returned events.
  62          * @param[in] flags Flags (see USBHID_IFACE_FLAG_*).
  63          * @return Error code.
  64          */
  65         errno_t (*get_event)(ddf_fun_t *fun, uint8_t *buffer, size_t size,
  66             size_t *act_size, int *event_nr, unsigned int flags);
  67
  68         /** Get size of the report descriptor in bytes.
  69          *
  70          * @param[in] fun DDF function answering the request.
  71          * @return Size of the report descriptor in bytes.
  72          */
  73         size_t (*get_report_descriptor_length)(ddf_fun_t *fun);
  74
  75         /** Get the report descriptor from the HID device.
  76          *
  77          * @param[in] fun DDF function answering the request.
  78          * @param[out] desc Buffer with the report descriptor.
  79          * @param[in] size Size of the allocated @p desc buffer.
  80          * @param[out] act_size Actual size of the report descriptor returned.
  81          * @return Error code.
  82          */
  83         errno_t (*get_report_descriptor)(ddf_fun_t *fun, uint8_t *desc,
  84             size_t size, size_t *act_size);
  85 } usbhid_iface_t;
  86
  87 #endif
  88 /**
  89  * @}
  90  */