usbd_hid.h

Go to the documentation of this file.

/*
 * Copyright (c) 2023 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_USBD_HID_CLASS_DEVICE_H_
#define ZEPHYR_INCLUDE_USBD_HID_CLASS_DEVICE_H_
 
#include <stdint.h>
#include <zephyr/device.h>
#include <zephyr/usb/class/hid.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*
 * HID Device overview:
 *
 * +---------------------+
 * | |
 * | |
 * | HID Device |
 * | User "top half" |
 * | of the device that +-------+
 * | deals with input | |
 * | sampling | |
 * | | |
 * | | |
 * | ------------------- | |
 * | | |
 * | HID Device user | |
 * | callbacks | |
 * | handlers | |
 * +---------------------+ |
 * ^ | HID Device Driver API:
 * | |
 * set_protocol() | | hid_device_register()
 * get_report() | | hid_device_submit_report(
 * .... | | ...
 * v |
 * +---------------------+ |
 * | | |
 * | HID Device | |
 * | "bottom half" |<------+
 * | USB HID class |
 * | implementation |
 * | |
 * | |
 * +---------------------+
 * ^
 * v
 * +--------------------+
 * | |
 * | USB Device |
 * | Support |
 * | |
 * +--------------------+
 */
 
enum {
 HID_REPORT_TYPE_INPUT = 1,
 HID_REPORT_TYPE_OUTPUT,
 HID_REPORT_TYPE_FEATURE,
};
 
struct hid_device_ops {
 void (*iface_ready)(const struct device *dev, const bool ready);
 
 int (*get_report)(const struct device *dev,
 const uint8_t type, const uint8_t id,
 const uint16_t len, uint8_t *const buf);
 
 int (*set_report)(const struct device *dev,
 const uint8_t type, const uint8_t id,
 const uint16_t len, const uint8_t *const buf);
 
 void (*set_idle)(const struct device *dev,
 const uint8_t id, const uint32_t duration);
 
 uint32_t (*get_idle)(const struct device *dev, const uint8_t id);
 
 void (*set_protocol)(const struct device *dev, const uint8_t proto);
 
 void (*input_report_done)(const struct device *dev);
 
 void (*output_report)(const struct device *dev, const uint16_t len,
 const uint8_t *const buf);
 void (*sof)(const struct device *dev);
};
 
int hid_device_register(const struct device *dev,
 const uint8_t *const rdesc, const uint16_t rsize,
 const struct hid_device_ops *const ops);
 
int hid_device_submit_report(const struct device *dev,
 const uint16_t size, const uint8_t *const report);
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_USBD_HID_CLASS_DEVICE_H_ */