hid_device.h File Reference

#include "common/common.h"
#include "device/usbd.h"
#include "hid.h"

Go to the source code of this file.

Functions
bool	tusbd_hid_keyboard_is_busy (uint8_t coreid)
	Check if the interface is currently busy or not. More...
tusb_error_t	tusbd_hid_keyboard_send (uint8_t coreid, hid_keyboard_report_t const *p_report)
	Submit USB transfer. More...
void	tusbd_hid_keyboard_mounted_cb (uint8_t coreid)
	Callback function that will be invoked when this interface is mounted (configured) by USB host. More...
void	tusbd_hid_keyboard_unmounted_cb (uint8_t coreid)
	Callback function that will be invoked when this interface is unmounted (bus reset/unplugged) More...
void	tusbd_hid_keyboard_cb (uint8_t coreid, tusb_event_t event, uint32_t xferred_bytes)
	Callback function that is invoked when an transferring event occurred after invoking tusbd_hid_keyboard_send. More...
uint16_t	tusbd_hid_keyboard_get_report_cb (uint8_t coreid, hid_request_report_type_t report_type, void **pp_report, uint16_t requested_length)
	Callback function that is invoked when USB host request HID_REQUEST_CONTROL_GET_REPORT via control endpoint. More...
void	tusbd_hid_keyboard_set_report_cb (uint8_t coreid, hid_request_report_type_t report_type, uint8_t p_report_data[], uint16_t length)
	Callback function that is invoked when USB host request HID_REQUEST_CONTROL_SET_REPORT via control endpoint. More...
bool	tusbd_hid_mouse_is_busy (uint8_t coreid)
	Check if the interface is currently busy or not. More...
tusb_error_t	tusbd_hid_mouse_send (uint8_t coreid, hid_mouse_report_t const *p_report)
	Perform transfer queuing. More...
void	tusbd_hid_mouse_mounted_cb (uint8_t coreid)
	Callback function that will be invoked when this interface is mounted (configured) by USB host. More...
void	tusbd_hid_mouse_unmounted_cb (uint8_t coreid)
	Callback function that will be invoked when this interface is unmounted (bus reset/unplugged) More...
void	tusbd_hid_mouse_cb (uint8_t coreid, tusb_event_t event, uint32_t xferred_bytes)
	Callback function that is invoked when an transferring event occurred after invoking tusbd_hid_mouse_send. More...
uint16_t	tusbd_hid_mouse_get_report_cb (uint8_t coreid, hid_request_report_type_t report_type, void **pp_report, uint16_t requested_length)
	Callback function that is invoked when USB host request HID_REQUEST_CONTROL_GET_REPORT via control endpoint. More...
void	tusbd_hid_mouse_set_report_cb (uint8_t coreid, hid_request_report_type_t report_type, uint8_t p_report_data[], uint16_t length)
	Callback function that is invoked when USB host request HID_REQUEST_CONTROL_SET_REPORT via control endpoint. More...

Detailed Description

Author

hathach (tinyusb.org)

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.

Definition in file hid_device.h.