tmk_core/protocol/arm_atsam/usb/udi_hid.h

   1 /**
   2  * \file
   3  *
   4  * \brief USB Device Human Interface Device (HID) interface definitions.
   5  *
   6  * Copyright (c) 2009-2015 Atmel Corporation. All rights reserved.
   7  *
   8  * \asf_license_start
   9  *
  10  * \page License
  11  *
  12  * Redistribution and use in source and binary forms, with or without
  13  * modification, are permitted provided that the following conditions are met:
  14  *
  15  * 1. Redistributions of source code must retain the above copyright notice,
  16  *    this list of conditions and the following disclaimer.
  17  *
  18  * 2. Redistributions in binary form must reproduce the above copyright notice,
  19  *    this list of conditions and the following disclaimer in the documentation
  20  *    and/or other materials provided with the distribution.
  21  *
  22  * 3. The name of Atmel may not be used to endorse or promote products derived
  23  *    from this software without specific prior written permission.
  24  *
  25  * 4. This software may only be redistributed and used in connection with an
  26  *    Atmel microcontroller product.
  27  *
  28  * THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR IMPLIED
  29  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  30  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
  31  * EXPRESSLY AND SPECIFICALLY DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR
  32  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  33  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  34  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  35  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  36  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  37  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  38  * POSSIBILITY OF SUCH DAMAGE.
  39  *
  40  * \asf_license_stop
  41  *
  42  */
  43 /*
  44  * Support and FAQ: visit <a href="http://www.atmel.com/design-support/">Atmel Support</a>
  45  */
  46
  47 #ifndef _UDI_HID_H_
  48 #define _UDI_HID_H_
  49
  50 #include "conf_usb.h"
  51 #include "usb_protocol.h"
  52 #include "usb_protocol_hid.h"
  53 #include "udd.h"
  54
  55 #ifdef __cplusplus
  56 extern "C" {
  57 #endif
  58
  59 /**
  60  * \ingroup udi_group
  61  * \defgroup udi_hid_group USB Device Interface (UDI) for Human Interface Device (HID)
  62  *
  63  * Common library for all Human Interface Device (HID) implementation.
  64  *
  65  * @{
  66  */
  67
  68 /**
  69  * \brief Decode HID setup request
  70  *
  71  * \param rate         Pointer on rate of current HID interface
  72  * \param protocol     Pointer on protocol of current HID interface
  73  * \param report_desc  Pointer on report descriptor of current HID interface
  74  * \param set_report   Pointer on set_report callback of current HID interface
  75  *
  76  * \return \c 1 if function was successfully done, otherwise \c 0.
  77  */
  78 bool udi_hid_setup( uint8_t *rate, uint8_t *protocol, uint8_t *report_desc, bool (*setup_report)(void) );
  79
  80 //@}
  81
  82 #ifdef __cplusplus
  83 }
  84 #endif
  85 #endif // _UDI_HID_H_