218 lines
12 KiB
C
218 lines
12 KiB
C
/**************************************************************************/
|
|
/*!
|
|
@file hid_device.h
|
|
@author hathach (tinyusb.org)
|
|
|
|
@section LICENSE
|
|
|
|
Software License Agreement (BSD License)
|
|
|
|
Copyright (c) 2013, hathach (tinyusb.org)
|
|
All rights reserved.
|
|
|
|
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. Neither the name of the copyright holders nor the
|
|
names of its contributors may be used to endorse or promote products
|
|
derived from this software without specific prior written permission.
|
|
|
|
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY
|
|
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
|
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER 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.
|
|
|
|
This file is part of the tinyusb stack.
|
|
*/
|
|
/**************************************************************************/
|
|
|
|
#ifndef _TUSB_HID_DEVICE_H_
|
|
#define _TUSB_HID_DEVICE_H_
|
|
|
|
#include "common/tusb_common.h"
|
|
#include "device/usbd.h"
|
|
#include "hid.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
|
|
//--------------------------------------------------------------------+
|
|
// KEYBOARD APPLICATION API
|
|
//--------------------------------------------------------------------+
|
|
/** \addtogroup ClassDriver_HID_Keyboard Keyboard
|
|
* @{ */
|
|
/** \defgroup Keyboard_Device Device
|
|
* @{ */
|
|
|
|
/** \brief Check if the interface is currently busy or not
|
|
* \param[in] rhport USB Controller ID
|
|
* \retval true if the interface is busy meaning the stack is still transferring/waiting data from/to host
|
|
* \retval false if the interface is not busy meaning the stack successfully transferred data from/to host
|
|
* \note This function is primarily used for polling/waiting result after \ref tusbd_hid_keyboard_send.
|
|
*/
|
|
bool tud_hid_keyboard_busy(uint8_t rhport);
|
|
|
|
/** \brief Submit USB transfer
|
|
* \param[in] rhport USB Controller ID
|
|
* \param[in,out] p_report address that is used to store data from device. Must be accessible by usb controller (see \ref TUSB_CFG_ATTR_USBRAM)
|
|
* \returns \ref tusb_error_t type to indicate success or error condition.
|
|
* \retval TUSB_ERROR_NONE on success
|
|
* \retval TUSB_ERROR_INTERFACE_IS_BUSY if the interface is already transferring data with device
|
|
* \retval TUSB_ERROR_DEVICE_NOT_READY if device is not yet configured (by SET CONFIGURED request)
|
|
* \retval TUSB_ERROR_INVALID_PARA if input parameters are not correct
|
|
* \note This function is non-blocking and returns immediately. Data will be transferred when USB Host work with this interface.
|
|
* The result of usb transfer will be reported by the interface's callback function
|
|
*/
|
|
tusb_error_t tud_hid_keyboard_send(uint8_t rhport, hid_keyboard_report_t const *p_report);
|
|
|
|
//--------------------------------------------------------------------+
|
|
// APPLICATION CALLBACK API
|
|
//--------------------------------------------------------------------+
|
|
|
|
/** \brief Callback function that is invoked when an transferring event occurred
|
|
* after invoking \ref tusbd_hid_keyboard_send
|
|
* \param[in] rhport USB Controller ID
|
|
* \param[in] event an value from \ref tusb_event_t
|
|
* \note event can be one of following
|
|
* - TUSB_EVENT_XFER_COMPLETE : previously scheduled transfer completes successfully.
|
|
* - TUSB_EVENT_XFER_ERROR : previously scheduled transfer encountered a transaction error.
|
|
* - TUSB_EVENT_XFER_STALLED : previously scheduled transfer is stalled by device.
|
|
*/
|
|
void tud_hid_keyboard_cb(uint8_t rhport, tusb_event_t event, uint32_t xferred_bytes);
|
|
|
|
/** \brief Callback function that is invoked when USB host request \ref HID_REQUEST_CONTROL_GET_REPORT
|
|
* via control endpoint.
|
|
* \param[in] rhport USB Controller ID
|
|
* \param[in] report_type specify which report (INPUT, OUTPUT, FEATURE) that host requests
|
|
* \param[out] pp_report pointer to buffer that application need to update, value must be accessible by USB controller (see \ref TUSB_CFG_ATTR_USBRAM)
|
|
* \param[in] requested_length number of bytes that host requested
|
|
* \retval non-zero Actual number of bytes in the response's buffer.
|
|
* \retval zero indicates the current request is not supported. Tinyusb device stack will reject the request by
|
|
* sending STALL in the data phase.
|
|
* \note After this callback, the request is silently executed by the tinyusb stack, thus
|
|
* the completion of this control request will not be reported to application.
|
|
* For Keyboard, USB host often uses this to turn on/off the LED for CAPLOCKS, NUMLOCK (\ref hid_keyboard_led_bm_t)
|
|
*/
|
|
uint16_t tud_hid_keyboard_get_report_cb(uint8_t rhport, hid_request_report_type_t report_type, void** pp_report, uint16_t requested_length);
|
|
|
|
/** \brief Callback function that is invoked when USB host request \ref HID_REQUEST_CONTROL_SET_REPORT
|
|
* via control endpoint.
|
|
* \param[in] rhport USB Controller ID
|
|
* \param[in] report_type specify which report (INPUT, OUTPUT, FEATURE) that host requests
|
|
* \param[in] p_report_data buffer containing the report's data
|
|
* \param[in] length number of bytes in the \a p_report_data
|
|
* \note By the time this callback is invoked, the USB control transfer is already completed in the hardware side.
|
|
* Application are free to handle data at its own will.
|
|
*/
|
|
void tud_hid_keyboard_set_report_cb(uint8_t rhport, hid_request_report_type_t report_type, uint8_t p_report_data[], uint16_t length);
|
|
|
|
/** @} */
|
|
/** @} */
|
|
|
|
//--------------------------------------------------------------------+
|
|
// MOUSE APPLICATION API
|
|
//--------------------------------------------------------------------+
|
|
/** \addtogroup ClassDriver_HID_Mouse Mouse
|
|
* @{ */
|
|
/** \defgroup Mouse_Device Device
|
|
* @{ */
|
|
|
|
/** \brief Check if the interface is currently busy or not
|
|
* \param[in] rhport USB Controller ID
|
|
* \retval true if the interface is busy meaning the stack is still transferring/waiting data from/to host
|
|
* \retval false if the interface is not busy meaning the stack successfully transferred data from/to host
|
|
* \note This function is primarily used for polling/waiting result after \ref tusbd_hid_mouse_send.
|
|
*/
|
|
bool tud_hid_mouse_is_busy(uint8_t rhport);
|
|
|
|
/** \brief Perform transfer queuing
|
|
* \param[in] rhport USB Controller ID
|
|
* \param[in,out] p_report address that is used to store data from device. Must be accessible by usb controller (see \ref TUSB_CFG_ATTR_USBRAM)
|
|
* \returns \ref tusb_error_t type to indicate success or error condition.
|
|
* \retval TUSB_ERROR_NONE on success
|
|
* \retval TUSB_ERROR_INTERFACE_IS_BUSY if the interface is already transferring data with device
|
|
* \retval TUSB_ERROR_DEVICE_NOT_READY if device is not yet configured (by SET CONFIGURED request)
|
|
* \retval TUSB_ERROR_INVALID_PARA if input parameters are not correct
|
|
* \note This function is non-blocking and returns immediately. Data will be transferred when USB Host work with this interface.
|
|
* The result of usb transfer will be reported by the interface's callback function
|
|
*/
|
|
tusb_error_t tud_hid_mouse_send(uint8_t rhport, hid_mouse_report_t const *p_report);
|
|
|
|
//--------------------------------------------------------------------+
|
|
// APPLICATION CALLBACK API
|
|
//--------------------------------------------------------------------+
|
|
|
|
/** \brief Callback function that is invoked when an transferring event occurred
|
|
* after invoking \ref tusbd_hid_mouse_send
|
|
* \param[in] rhport USB Controller ID
|
|
* \param[in] event an value from \ref tusb_event_t
|
|
* \note event can be one of following
|
|
* - TUSB_EVENT_XFER_COMPLETE : previously scheduled transfer completes successfully.
|
|
* - TUSB_EVENT_XFER_ERROR : previously scheduled transfer encountered a transaction error.
|
|
* - TUSB_EVENT_XFER_STALLED : previously scheduled transfer is stalled by device.
|
|
*/
|
|
void tud_hid_mouse_cb(uint8_t rhport, tusb_event_t event, uint32_t xferred_bytes);
|
|
|
|
/** \brief Callback function that is invoked when USB host request \ref HID_REQUEST_CONTROL_GET_REPORT
|
|
* via control endpoint.
|
|
* \param[in] rhport USB Controller ID
|
|
* \param[in] report_type specify which report (INPUT, OUTPUT, FEATURE) that host requests
|
|
* \param[out] pp_report pointer to buffer that application need to update, value must be accessible by USB controller (see \ref TUSB_CFG_ATTR_USBRAM)
|
|
* \param[in] requested_length number of bytes that host requested
|
|
* \retval non-zero Actual number of bytes in the response's buffer.
|
|
* \retval zero indicates the current request is not supported. Tinyusb device stack will reject the request by
|
|
* sending STALL in the data phase.
|
|
* \note After this callback, the request is silently executed by the tinyusb stack, thus
|
|
* the completion of this control request will not be reported to application
|
|
*/
|
|
uint16_t tud_hid_mouse_get_report_cb(uint8_t rhport, hid_request_report_type_t report_type, void** pp_report, uint16_t requested_length);
|
|
|
|
/** \brief Callback function that is invoked when USB host request \ref HID_REQUEST_CONTROL_SET_REPORT
|
|
* via control endpoint.
|
|
* \param[in] rhport USB Controller ID
|
|
* \param[in] report_type specify which report (INPUT, OUTPUT, FEATURE) that host requests
|
|
* \param[in] p_report_data buffer containing the report's data
|
|
* \param[in] length number of bytes in the \a p_report_data
|
|
* \note By the time this callback is invoked, the USB control transfer is already completed in the hardware side.
|
|
* Application are free to handle data at its own will.
|
|
*/
|
|
void tud_hid_mouse_set_report_cb(uint8_t rhport, hid_request_report_type_t report_type, uint8_t p_report_data[], uint16_t length);
|
|
|
|
/** @} */
|
|
/** @} */
|
|
|
|
|
|
|
|
//--------------------------------------------------------------------+
|
|
// USBD-CLASS DRIVER API
|
|
//--------------------------------------------------------------------+
|
|
#ifdef _TINY_USB_SOURCE_FILE_
|
|
|
|
void hidd_init(void);
|
|
tusb_error_t hidd_open(uint8_t rhport, tusb_desc_interface_t const * p_interface_desc, uint16_t *p_length);
|
|
tusb_error_t hidd_control_request_st(uint8_t rhport, tusb_control_request_t const * p_request);
|
|
tusb_error_t hidd_xfer_cb(uint8_t rhport, uint8_t edpt_addr, tusb_event_t event, uint32_t xferred_bytes);
|
|
void hidd_close(uint8_t rhport);
|
|
|
|
#endif
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* _TUSB_HID_DEVICE_H_ */
|
|
|
|
|