86 lines
2.8 KiB
C
86 lines
2.8 KiB
C
/**
|
|
* \file
|
|
*
|
|
* \brief USB Device Human Interface Device (HID) interface definitions.
|
|
*
|
|
* Copyright (c) 2009-2015 Atmel Corporation. All rights reserved.
|
|
*
|
|
* \asf_license_start
|
|
*
|
|
* \page License
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions are met:
|
|
*
|
|
* 1. Redistributions of source code must retain the above copyright notice,
|
|
* this list of conditions and the following disclaimer.
|
|
*
|
|
* 2. Redistributions in binary form must reproduce the above copyright notice,
|
|
* this list of conditions and the following disclaimer in the documentation
|
|
* and/or other materials provided with the distribution.
|
|
*
|
|
* 3. The name of Atmel may not be used to endorse or promote products derived
|
|
* from this software without specific prior written permission.
|
|
*
|
|
* 4. This software may only be redistributed and used in connection with an
|
|
* Atmel microcontroller product.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR IMPLIED
|
|
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
|
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
|
|
* EXPRESSLY AND SPECIFICALLY DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR
|
|
* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
|
|
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
|
|
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
* POSSIBILITY OF SUCH DAMAGE.
|
|
*
|
|
* \asf_license_stop
|
|
*
|
|
*/
|
|
/*
|
|
* Support and FAQ: visit <a href="http://www.atmel.com/design-support/">Atmel Support</a>
|
|
*/
|
|
|
|
#ifndef _UDI_HID_H_
|
|
#define _UDI_HID_H_
|
|
|
|
#include "conf_usb.h"
|
|
#include "usb_protocol.h"
|
|
#include "usb_protocol_hid.h"
|
|
#include "udd.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* \ingroup udi_group
|
|
* \defgroup udi_hid_group USB Device Interface (UDI) for Human Interface Device (HID)
|
|
*
|
|
* Common library for all Human Interface Device (HID) implementation.
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* \brief Decode HID setup request
|
|
*
|
|
* \param rate Pointer on rate of current HID interface
|
|
* \param protocol Pointer on protocol of current HID interface
|
|
* \param report_desc Pointer on report descriptor of current HID interface
|
|
* \param set_report Pointer on set_report callback of current HID interface
|
|
*
|
|
* \return \c 1 if function was successfully done, otherwise \c 0.
|
|
*/
|
|
bool udi_hid_setup(uint8_t *rate, uint8_t *protocol, uint8_t *report_desc, bool (*setup_report)(void));
|
|
|
|
//@}
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
#endif // _UDI_HID_H_
|