mirror of
https://github.com/opnsense/src.git
synced 2026-04-15 14:29:58 -04:00
7545c8c116
to Linux hidraw compatibility API. Respective Linux commit f43d3870cafa made by Dean Camera message is: Currently the hidraw module can only read and write feature HID reports on demand, via dedicated ioctls. Input reports are read from the device through the read() interface, while output reports are written through the write interface(). This is insufficient; it is desirable in many situations to be able to read and write input and output reports through the control interface to cover additional scenarios: - Reading an input report by its report ID, to get initial state - Writing an input report, to set initial input state in the device - Reading an output report by its report ID, to obtain current state - Writing an output report by its report ID, out of band This patch adds these missing ioctl requests to read and write the remaining HID report types. Note that not all HID backends will neccesarily support this (e.g. while the USB link layer supports setting Input reports, others may not). FreeBSD native uhid(4) compatible API already has similar ioctls. MFC after: 3 days (cherry picked from commit fd6690e2d5cd5b15fce2c74ab0cac77a83514f6a)
100 lines
3.7 KiB
C
100 lines
3.7 KiB
C
/*-
|
|
* SPDX-License-Identifier: BSD-2-Clause
|
|
*
|
|
* Copyright (c) 2020 Vladimir Kondratyev <wulf@FreeBSD.org>
|
|
*
|
|
* 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.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``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 OR CONTRIBUTORS 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.
|
|
*/
|
|
|
|
#ifndef _HID_HIDRAW_H
|
|
#define _HID_HIDRAW_H
|
|
|
|
#include <sys/ioccom.h>
|
|
|
|
#define HIDRAW_BUFFER_SIZE 64 /* number of input reports buffered */
|
|
#define HID_MAX_DESCRIPTOR_SIZE 4096 /* artificial limit taken from Linux */
|
|
|
|
/* Compatible with usb_gen_descriptor structure */
|
|
struct hidraw_gen_descriptor {
|
|
void *hgd_data;
|
|
uint16_t hgd_lang_id;
|
|
uint16_t hgd_maxlen;
|
|
uint16_t hgd_actlen;
|
|
uint16_t hgd_offset;
|
|
uint8_t hgd_config_index;
|
|
uint8_t hgd_string_index;
|
|
uint8_t hgd_iface_index;
|
|
uint8_t hgd_altif_index;
|
|
uint8_t hgd_endpt_index;
|
|
uint8_t hgd_report_type;
|
|
uint8_t reserved[8];
|
|
};
|
|
|
|
/* Compatible with usb_device_info structure */
|
|
struct hidraw_device_info {
|
|
uint16_t hdi_product;
|
|
uint16_t hdi_vendor;
|
|
uint16_t hdi_version;
|
|
uint8_t occupied[18]; /* by usb_device_info */
|
|
uint16_t hdi_bustype;
|
|
uint8_t reserved[14]; /* leave space for the future */
|
|
char hdi_name[128];
|
|
char hdi_phys[128];
|
|
char hdi_uniq[64];
|
|
char hdi_release[8]; /* decrypted USB bcdDevice */
|
|
};
|
|
|
|
struct hidraw_report_descriptor {
|
|
uint32_t size;
|
|
uint8_t value[HID_MAX_DESCRIPTOR_SIZE];
|
|
};
|
|
|
|
struct hidraw_devinfo {
|
|
uint32_t bustype;
|
|
int16_t vendor;
|
|
int16_t product;
|
|
};
|
|
|
|
/* FreeBSD uhid(4)-compatible ioctl interface */
|
|
#define HIDRAW_GET_REPORT_DESC _IOWR('U', 21, struct hidraw_gen_descriptor)
|
|
#define HIDRAW_SET_IMMED _IOW ('U', 22, int)
|
|
#define HIDRAW_GET_REPORT _IOWR('U', 23, struct hidraw_gen_descriptor)
|
|
#define HIDRAW_SET_REPORT _IOW ('U', 24, struct hidraw_gen_descriptor)
|
|
#define HIDRAW_GET_REPORT_ID _IOR ('U', 25, int)
|
|
#define HIDRAW_SET_REPORT_DESC _IOW ('U', 26, struct hidraw_gen_descriptor)
|
|
#define HIDRAW_GET_DEVICEINFO _IOR ('U', 112, struct hidraw_device_info)
|
|
|
|
/* Linux hidraw-compatible ioctl interface */
|
|
#define HIDIOCGRDESCSIZE _IOR('U', 30, int)
|
|
#define HIDIOCGRDESC _IO ('U', 31)
|
|
#define HIDIOCGRAWINFO _IOR('U', 32, struct hidraw_devinfo)
|
|
#define HIDIOCGRAWNAME(len) _IOC(IOC_OUT, 'U', 33, len)
|
|
#define HIDIOCGRAWPHYS(len) _IOC(IOC_OUT, 'U', 34, len)
|
|
#define HIDIOCSFEATURE(len) _IOC(IOC_IN, 'U', 35, len)
|
|
#define HIDIOCGFEATURE(len) _IOC(IOC_INOUT, 'U', 36, len)
|
|
#define HIDIOCGRAWUNIQ(len) _IOC(IOC_OUT, 'U', 37, len)
|
|
#define HIDIOCSINPUT(len) _IOC(IOC_IN, 'U', 38, len)
|
|
#define HIDIOCGINPUT(len) _IOC(IOC_INOUT, 'U', 39, len)
|
|
#define HIDIOCSOUTPUT(len) _IOC(IOC_IN, 'U', 40, len)
|
|
#define HIDIOCGOUTPUT(len) _IOC(IOC_INOUT, 'U', 41, len)
|
|
|
|
#endif /* _HID_HIDRAW_H */
|