usb_hid.h

Go to the documentation of this file.

/*
 * Copyright (c) 2018 Intel Corporation
 * Copyright (c) 2018,2021 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_USB_HID_CLASS_DEVICE_H_
#define ZEPHYR_INCLUDE_USB_HID_CLASS_DEVICE_H_
 
#include <zephyr/usb/class/hid.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef int (*hid_cb_t)(const struct device *dev,
                        struct usb_setup_packet *setup, int32_t *len,
                        uint8_t **data);
typedef void (*hid_int_ready_callback)(const struct device *dev);
typedef void (*hid_protocol_cb_t)(const struct device *dev, uint8_t protocol);
typedef void (*hid_idle_cb_t)(const struct device *dev, uint16_t report_id);
 
struct hid_ops {
        hid_cb_t get_report;
        hid_cb_t set_report;
        hid_protocol_cb_t protocol_change;
        hid_idle_cb_t on_idle;
        /*
         * int_in_ready is an optional callback that is called when
         * the current interrupt IN transfer has completed.  This can
         * be used to wait for the endpoint to go idle or to trigger
         * the next transfer.
         */
        hid_int_ready_callback int_in_ready;
#ifdef CONFIG_ENABLE_HID_INT_OUT_EP
        hid_int_ready_callback int_out_ready;
#endif
};
 
void usb_hid_register_device(const struct device *dev,
                             const uint8_t *desc,
                             size_t size,
                             const struct hid_ops *op);
 
int hid_int_ep_write(const struct device *dev,
                     const uint8_t *data,
                     uint32_t data_len,
                     uint32_t *bytes_ret);
 
int hid_int_ep_read(const struct device *dev,
                    uint8_t *data,
                    uint32_t max_data_len,
                    uint32_t *ret_bytes);
 
int usb_hid_set_proto_code(const struct device *dev, uint8_t proto_code);
 
int usb_hid_init(const struct device *dev);
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_USB_HID_CLASS_DEVICE_H_ */