2012-12-26 20:52:40 +01:00
|
|
|
/*
|
2013-01-18 08:39:42 +01:00
|
|
|
* hid_host.h
|
2012-12-26 20:52:40 +01:00
|
|
|
*
|
2013-01-18 06:28:12 +01:00
|
|
|
* Created on: Jan 18, 2013
|
2012-12-26 20:52:40 +01:00
|
|
|
* Author: hathach
|
|
|
|
*/
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Software License Agreement (BSD License)
|
2013-03-25 05:46:30 +01:00
|
|
|
* Copyright (c) 2013, hathach (tinyusb.org)
|
2012-12-26 20:52:40 +01:00
|
|
|
* 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. The name of the author may not be used to endorse or promote products
|
|
|
|
* derived from this software without specific prior written permission.
|
|
|
|
*
|
|
|
|
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 AUTHOR 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 tiny usb stack.
|
|
|
|
*/
|
|
|
|
|
2013-01-18 08:39:42 +01:00
|
|
|
/** \file
|
|
|
|
* \brief TBD
|
|
|
|
*
|
|
|
|
* \note TBD
|
|
|
|
*/
|
|
|
|
|
|
|
|
/** \ingroup TBD
|
|
|
|
* \defgroup TBD
|
|
|
|
* \brief TBD
|
|
|
|
*
|
|
|
|
* @{
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef _TUSB_HID_HOST_H_
|
|
|
|
#define _TUSB_HID_HOST_H_
|
|
|
|
|
|
|
|
#ifdef __cplusplus
|
|
|
|
extern "C" {
|
|
|
|
#endif
|
|
|
|
|
2013-02-04 07:51:20 +01:00
|
|
|
#include "common/common.h"
|
2013-02-04 06:29:50 +01:00
|
|
|
#include "host/usbh.h"
|
2013-01-18 08:39:42 +01:00
|
|
|
#include "hid.h"
|
|
|
|
|
2013-03-26 05:41:41 +01:00
|
|
|
//--------------------------------------------------------------------+
|
|
|
|
// KEYBOARD Public API
|
|
|
|
//--------------------------------------------------------------------+
|
2013-03-26 06:14:04 +01:00
|
|
|
bool tusbh_hid_keyboard_is_supported(uint8_t dev_addr) ATTR_PURE ATTR_WARN_UNUSED_RESULT;
|
2013-03-27 05:51:44 +01:00
|
|
|
tusb_error_t tusbh_hid_keyboard_get_report(uint8_t dev_addr, uint8_t instance_num, uint8_t * const report) ATTR_WARN_UNUSED_RESULT;
|
2013-03-26 10:39:25 +01:00
|
|
|
tusb_interface_status_t tusbh_hid_keyboard_status(uint8_t dev_addr, uint8_t instance_num) ATTR_WARN_UNUSED_RESULT;
|
2013-03-26 05:41:41 +01:00
|
|
|
|
|
|
|
//--------------------------------------------------------------------+
|
|
|
|
// MOUSE Public API
|
|
|
|
//--------------------------------------------------------------------+
|
2013-04-07 00:09:18 +02:00
|
|
|
bool tusbh_hid_mouse_is_supported(uint8_t dev_addr) ATTR_PURE ATTR_WARN_UNUSED_RESULT;
|
|
|
|
tusb_error_t tusbh_hid_mouse_get_report(uint8_t dev_addr, uint8_t instance_num, uint8_t * const report) ATTR_WARN_UNUSED_RESULT;
|
|
|
|
tusb_interface_status_t tusbh_hid_mouse_status(uint8_t dev_addr, uint8_t instance_num) ATTR_WARN_UNUSED_RESULT;
|
2013-01-25 19:37:15 +01:00
|
|
|
|
|
|
|
//--------------------------------------------------------------------+
|
2013-03-26 05:41:41 +01:00
|
|
|
// GENERIC Public API
|
2013-01-25 19:37:15 +01:00
|
|
|
//--------------------------------------------------------------------+
|
2013-02-08 06:52:46 +01:00
|
|
|
|
2013-03-09 07:11:02 +01:00
|
|
|
//--------------------------------------------------------------------+
|
2013-03-26 05:41:41 +01:00
|
|
|
// USBH-CLASS DRIVER API
|
2013-03-09 07:11:02 +01:00
|
|
|
//--------------------------------------------------------------------+
|
2013-03-25 07:08:40 +01:00
|
|
|
#ifdef _TINY_USB_SOURCE_FILE_
|
|
|
|
|
2013-04-07 00:09:18 +02:00
|
|
|
typedef struct {
|
|
|
|
pipe_handle_t pipe_hdl;
|
|
|
|
uint16_t report_size;
|
|
|
|
volatile tusb_interface_status_t status;
|
|
|
|
}hidh_interface_info_t;
|
|
|
|
|
2013-03-25 20:02:54 +01:00
|
|
|
void hidh_init(void);
|
2013-03-26 06:14:04 +01:00
|
|
|
tusb_error_t hidh_open_subtask(uint8_t dev_addr, tusb_descriptor_interface_t const *p_interface_desc, uint16_t *p_length) ATTR_WARN_UNUSED_RESULT;
|
2013-04-07 00:09:18 +02:00
|
|
|
void hidh_isr(pipe_handle_t pipe_hdl, tusb_event_t event);
|
2013-03-25 20:02:54 +01:00
|
|
|
void hidh_close(uint8_t dev_addr);
|
2013-01-18 08:39:42 +01:00
|
|
|
|
2013-01-27 06:18:01 +01:00
|
|
|
#endif
|
|
|
|
|
2013-01-18 08:39:42 +01:00
|
|
|
#ifdef __cplusplus
|
2013-01-22 12:09:58 +01:00
|
|
|
}
|
2013-01-18 08:39:42 +01:00
|
|
|
#endif
|
2012-12-26 20:52:40 +01:00
|
|
|
|
2013-01-18 08:39:42 +01:00
|
|
|
#endif /* _TUSB_HID_HOST_H_ */
|
2013-01-18 06:41:30 +01:00
|
|
|
|
2013-01-18 08:39:42 +01:00
|
|
|
/** @} */
|