espressif_tinyusb/src/class/hid/hid_host.h

130 lines
4.5 KiB
C
Raw Normal View History

2020-01-15 05:30:39 +01:00
/*
* The MIT License (MIT)
*
* Copyright (c) 2019 Ha Thach (tinyusb.org)
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*
* This file is part of the TinyUSB stack.
*/
/** \addtogroup ClassDriver_HID
* @{ */
#ifndef _TUSB_HID_HOST_H_
#define _TUSB_HID_HOST_H_
#include "common/tusb_common.h"
#include "host/usbh.h"
#include "hid.h"
#ifdef __cplusplus
extern "C" {
#endif
2021-02-24 07:54:18 +01:00
//--------------------------------------------------------------------+
// Class Driver Configuration
//--------------------------------------------------------------------+
2021-05-12 10:29:17 +02:00
#ifndef CFG_TUH_HID_REPORT_MAX
#define CFG_TUH_HID_REPORT_MAX 4
2021-02-24 07:54:18 +01:00
#endif
2021-05-12 14:36:52 +02:00
#ifndef CFG_TUH_HID_REPORT_DESCRIPTOR_BUFSIZE
#define CFG_TUH_HID_REPORT_DESCRIPTOR_BUFSIZE 256
#endif
2021-02-24 08:07:33 +01:00
//--------------------------------------------------------------------+
2021-05-12 14:36:52 +02:00
// Application API (Multiple devices)
// Note:
// - tud_n : is multiple devices API
// - class_n : is multiple instances API
2021-02-24 08:07:33 +01:00
//--------------------------------------------------------------------+
2021-05-12 14:36:52 +02:00
// Get the number of HID instances
2021-05-13 09:09:33 +02:00
uint8_t tuh_n_hid_instance_count(uint8_t dev_addr);
2021-05-12 14:36:52 +02:00
// Check if HID instance is mounted
2021-05-13 09:09:33 +02:00
bool tuh_n_hid_n_mounted(uint8_t dev_addr, uint8_t instance);
2021-05-13 08:42:52 +02:00
// Check if the interface is ready to use
bool tuh_n_hid_n_ready(uint8_t dev_addr, uint8_t instance);
2021-05-13 09:09:33 +02:00
// Get Report from device
bool tuh_n_hid_n_get_report(uint8_t dev_addr, uint8_t instance, void* report, uint16_t len);
2021-05-12 14:36:52 +02:00
2021-02-24 08:07:33 +01:00
2021-05-13 08:42:52 +02:00
2021-05-13 09:09:33 +02:00
//------------- -------------//
2021-02-24 08:07:33 +01:00
2021-05-13 09:09:33 +02:00
// Check if HID instance with Keyboard is mounted
bool tuh_n_hid_n_keyboard_mounted(uint8_t dev_addr, uint8_t instance);
2021-05-12 14:36:52 +02:00
2021-05-13 09:09:33 +02:00
// Check if HID instance with Mouse is mounted
bool tuh_n_hid_n_mouse_mounted(uint8_t dev_addr, uint8_t instance);
2021-05-12 10:29:17 +02:00
2021-05-12 14:36:52 +02:00
//--------------------------------------------------------------------+
// Callbacks (Weak is optional)
//--------------------------------------------------------------------+
// Invoked when report descriptor is received
2021-05-13 09:09:33 +02:00
// Note: enumeration is still not complete yet at this time
TU_ATTR_WEAK void tuh_hid_descriptor_report_cb(uint8_t dev_addr, uint8_t instance, uint8_t const* report_desc, uint16_t desc_len);
2021-05-12 14:36:52 +02:00
2021-05-13 09:09:33 +02:00
// Invoked when device with hid interface is mounted
TU_ATTR_WEAK void tuh_hid_mounted_cb (uint8_t dev_addr, uint8_t instance);
2021-05-12 14:36:52 +02:00
2021-05-13 09:09:33 +02:00
// Invoked when device with hid interface is un-mounted
TU_ATTR_WEAK void tuh_hid_unmounted_cb(uint8_t dev_addr, uint8_t instance);
2021-05-12 14:36:52 +02:00
2021-05-13 09:09:33 +02:00
// Invoked when received Report from device
TU_ATTR_WEAK void tuh_hid_get_report_complete_cb(uint8_t dev_addr, uint8_t instance, uint8_t xferred_bytes);
2020-01-15 05:30:39 +01:00
2021-05-13 09:09:33 +02:00
// Invoked when Sent Report to device
TU_ATTR_WEAK void tuh_hid_set_report_complete_cb(uint8_t dev_addr, uint8_t instance, uint8_t xferred_bytes);
2020-01-15 05:30:39 +01:00
//--------------------------------------------------------------------+
2021-05-13 09:09:33 +02:00
// Application API (Single device)
2020-01-15 05:30:39 +01:00
//--------------------------------------------------------------------+
2021-05-13 09:09:33 +02:00
// Get the number of HID instances
TU_ATTR_ALWAYS_INLINE static inline
uint8_t tuh_hid_instance_count(void)
{
return tuh_n_hid_instance_count(1);
}
2020-01-15 05:30:39 +01:00
//--------------------------------------------------------------------+
// Internal Class Driver API
//--------------------------------------------------------------------+
void hidh_init(void);
2021-02-24 07:19:32 +01:00
bool hidh_open(uint8_t rhport, uint8_t dev_addr, tusb_desc_interface_t const *desc_itf, uint16_t *p_length);
bool hidh_set_config(uint8_t dev_addr, uint8_t itf_num);
bool hidh_xfer_cb(uint8_t dev_addr, uint8_t ep_addr, xfer_result_t event, uint32_t xferred_bytes);
2020-01-15 05:30:39 +01:00
void hidh_close(uint8_t dev_addr);
#ifdef __cplusplus
}
#endif
#endif /* _TUSB_HID_HOST_H_ */
/** @} */ // ClassDriver_HID