hid: Import HID transport method definitions and helper functions.
Create an abstract HID interface that provides hardware independent access to HID capabilities and functions through the device tree. hid_if.m resembles existing USBHID KPI and consist of next methods: HID method USBHID variant ----------------------------------------------------------------------- hid_intr_setup usbd_transfer_setup (INTERRUPT IN xfer) hid_intr_unsetup usbd_transfer_unsetup (INTERRUPT IN xfer) hid_intr_start usbd_transfer_start (INTERRUPT IN xfer) hid_intr_stop usbd_transfer_drain (INTERRUPT IN xfer) hid_intr_poll usbd_transfer_poll (INTERRUPT IN xfer) hid_get_rdesc usbd_req_get_report_descriptor hid_read No direct analog. Not intended for common use. hid_write uhid(4) write() hid_get_report usbd_req_get_report hid_set_report usbd_req_set_report hid_set_idle usbd_req_set_idle hid_set_protocol usbd_req_set_protocol This change is part of D27888
This commit is contained in:
parent
eead9017d2
commit
961a3535db
@ -1816,6 +1816,7 @@ dev/gpio/gpiobus_if.m optional gpio
|
|||||||
dev/gpio/gpiopps.c optional gpiopps fdt
|
dev/gpio/gpiopps.c optional gpiopps fdt
|
||||||
dev/gpio/ofw_gpiobus.c optional fdt gpio
|
dev/gpio/ofw_gpiobus.c optional fdt gpio
|
||||||
dev/hid/hid.c optional hid
|
dev/hid/hid.c optional hid
|
||||||
|
dev/hid/hid_if.m optional hid
|
||||||
dev/hifn/hifn7751.c optional hifn
|
dev/hifn/hifn7751.c optional hifn
|
||||||
dev/hptiop/hptiop.c optional hptiop scbus
|
dev/hptiop/hptiop.c optional hptiop scbus
|
||||||
dev/hwpmc/hwpmc_logging.c optional hwpmc
|
dev/hwpmc/hwpmc_logging.c optional hwpmc
|
||||||
|
@ -46,6 +46,8 @@
|
|||||||
#include <dev/hid/hid.h>
|
#include <dev/hid/hid.h>
|
||||||
#include <dev/hid/hidquirk.h>
|
#include <dev/hid/hidquirk.h>
|
||||||
|
|
||||||
|
#include "hid_if.h"
|
||||||
|
|
||||||
/*
|
/*
|
||||||
* Define this unconditionally in case a kernel module is loaded that
|
* Define this unconditionally in case a kernel module is loaded that
|
||||||
* has been compiled with debugging options.
|
* has been compiled with debugging options.
|
||||||
@ -1025,4 +1027,49 @@ hid_quirk_unload(void *arg)
|
|||||||
pause("WAIT", hz);
|
pause("WAIT", hz);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
int
|
||||||
|
hid_get_rdesc(device_t dev, void *data, hid_size_t len)
|
||||||
|
{
|
||||||
|
return (HID_GET_RDESC(device_get_parent(dev), data, len));
|
||||||
|
}
|
||||||
|
|
||||||
|
int
|
||||||
|
hid_read(device_t dev, void *data, hid_size_t maxlen, hid_size_t *actlen)
|
||||||
|
{
|
||||||
|
return (HID_READ(device_get_parent(dev), data, maxlen, actlen));
|
||||||
|
}
|
||||||
|
|
||||||
|
int
|
||||||
|
hid_write(device_t dev, const void *data, hid_size_t len)
|
||||||
|
{
|
||||||
|
return (HID_WRITE(device_get_parent(dev), data, len));
|
||||||
|
}
|
||||||
|
|
||||||
|
int
|
||||||
|
hid_get_report(device_t dev, void *data, hid_size_t maxlen, hid_size_t *actlen,
|
||||||
|
uint8_t type, uint8_t id)
|
||||||
|
{
|
||||||
|
return (HID_GET_REPORT(device_get_parent(dev), data, maxlen, actlen,
|
||||||
|
type, id));
|
||||||
|
}
|
||||||
|
|
||||||
|
int
|
||||||
|
hid_set_report(device_t dev, const void *data, hid_size_t len, uint8_t type,
|
||||||
|
uint8_t id)
|
||||||
|
{
|
||||||
|
return (HID_SET_REPORT(device_get_parent(dev), data, len, type, id));
|
||||||
|
}
|
||||||
|
|
||||||
|
int
|
||||||
|
hid_set_idle(device_t dev, uint16_t duration, uint8_t id)
|
||||||
|
{
|
||||||
|
return (HID_SET_IDLE(device_get_parent(dev), duration, id));
|
||||||
|
}
|
||||||
|
|
||||||
|
int
|
||||||
|
hid_set_protocol(device_t dev, uint16_t protocol)
|
||||||
|
{
|
||||||
|
return (HID_SET_PROTOCOL(device_get_parent(dev), protocol));
|
||||||
|
}
|
||||||
|
|
||||||
MODULE_VERSION(hid, 1);
|
MODULE_VERSION(hid, 1);
|
||||||
|
@ -331,5 +331,14 @@ bool hid_test_quirk(const struct hid_device_info *dev_info, uint16_t quirk);
|
|||||||
int hid_add_dynamic_quirk(struct hid_device_info *dev_info,
|
int hid_add_dynamic_quirk(struct hid_device_info *dev_info,
|
||||||
uint16_t quirk);
|
uint16_t quirk);
|
||||||
void hid_quirk_unload(void *arg);
|
void hid_quirk_unload(void *arg);
|
||||||
|
|
||||||
|
int hid_get_rdesc(device_t, void *, hid_size_t);
|
||||||
|
int hid_read(device_t, void *, hid_size_t, hid_size_t *);
|
||||||
|
int hid_write(device_t, const void *, hid_size_t);
|
||||||
|
int hid_get_report(device_t, void *, hid_size_t, hid_size_t *, uint8_t,
|
||||||
|
uint8_t);
|
||||||
|
int hid_set_report(device_t, const void *, hid_size_t, uint8_t, uint8_t);
|
||||||
|
int hid_set_idle(device_t, uint16_t, uint8_t);
|
||||||
|
int hid_set_protocol(device_t, uint16_t);
|
||||||
#endif /* _KERNEL || _STANDALONE */
|
#endif /* _KERNEL || _STANDALONE */
|
||||||
#endif /* _HID_HID_H_ */
|
#endif /* _HID_HID_H_ */
|
||||||
|
165
sys/dev/hid/hid_if.m
Normal file
165
sys/dev/hid/hid_if.m
Normal file
@ -0,0 +1,165 @@
|
|||||||
|
#-
|
||||||
|
# Copyright (c) 2019 Vladimir Kondratyev
|
||||||
|
#
|
||||||
|
# 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.
|
||||||
|
#
|
||||||
|
# $FreeBSD$
|
||||||
|
#
|
||||||
|
|
||||||
|
#include <sys/param.h>
|
||||||
|
#include <sys/bus.h>
|
||||||
|
#include <sys/kernel.h>
|
||||||
|
#include <sys/malloc.h>
|
||||||
|
#include <dev/hid/hid.h>
|
||||||
|
|
||||||
|
# Any function listed here can do unbound sleeps waiting for IO to complete.
|
||||||
|
|
||||||
|
INTERFACE hid;
|
||||||
|
|
||||||
|
# Interrupts interface
|
||||||
|
|
||||||
|
#
|
||||||
|
# Allocate memory and initialise interrupt transfers.
|
||||||
|
# intr callback function which is called if input data is available.
|
||||||
|
# context is the private softc pointer, which will be used to callback.
|
||||||
|
# rdesc is pointer to structire containing requested maximal sizes of input,
|
||||||
|
# output and feature reports. It is used by hardware transport drivers
|
||||||
|
# to determine sizes of internal buffers.
|
||||||
|
# This function returns zero upon success. A non-zero return value indicates
|
||||||
|
# failure.
|
||||||
|
#
|
||||||
|
METHOD void intr_setup {
|
||||||
|
device_t dev;
|
||||||
|
hid_intr_t intr;
|
||||||
|
void *context;
|
||||||
|
struct hid_rdesc_info *rdesc;
|
||||||
|
};
|
||||||
|
|
||||||
|
#
|
||||||
|
# Release all allocated resources associated with interrupt transfers.
|
||||||
|
#
|
||||||
|
METHOD void intr_unsetup {
|
||||||
|
device_t dev;
|
||||||
|
};
|
||||||
|
|
||||||
|
#
|
||||||
|
# Start the interrupt transfers if not already started.
|
||||||
|
#
|
||||||
|
METHOD int intr_start {
|
||||||
|
device_t dev;
|
||||||
|
};
|
||||||
|
|
||||||
|
#
|
||||||
|
# Stop the interrupt transfers if not already stopped.
|
||||||
|
#
|
||||||
|
METHOD int intr_stop {
|
||||||
|
device_t dev;
|
||||||
|
};
|
||||||
|
|
||||||
|
#
|
||||||
|
# The following function gets called from the HID keyboard driver
|
||||||
|
# when the system has paniced.
|
||||||
|
#
|
||||||
|
METHOD void intr_poll {
|
||||||
|
device_t dev;
|
||||||
|
};
|
||||||
|
|
||||||
|
# HID interface
|
||||||
|
|
||||||
|
#
|
||||||
|
# Read out an report descriptor from the HID device.
|
||||||
|
#
|
||||||
|
METHOD int get_rdesc {
|
||||||
|
device_t dev;
|
||||||
|
void *data;
|
||||||
|
hid_size_t len;
|
||||||
|
};
|
||||||
|
|
||||||
|
#
|
||||||
|
# Get input data from the device. Data should be read in chunks
|
||||||
|
# of the size prescribed by the report descriptor.
|
||||||
|
# This function interferes with interrupt transfers and should not be used.
|
||||||
|
#
|
||||||
|
METHOD int read {
|
||||||
|
device_t dev;
|
||||||
|
void *data;
|
||||||
|
hid_size_t maxlen;
|
||||||
|
hid_size_t *actlen;
|
||||||
|
};
|
||||||
|
|
||||||
|
#
|
||||||
|
# Send data to the device. Data should be written in
|
||||||
|
# chunks of the size prescribed by the report descriptor.
|
||||||
|
#
|
||||||
|
METHOD int write {
|
||||||
|
device_t dev;
|
||||||
|
const void *data;
|
||||||
|
hid_size_t len;
|
||||||
|
};
|
||||||
|
|
||||||
|
#
|
||||||
|
# Get a report from the device without waiting for data on the interrupt.
|
||||||
|
# Copies a maximum of len bytes of the report data into the memory specified
|
||||||
|
# by data. Upon return actlen is set to the number of bytes copied. The type
|
||||||
|
# field indicates which report is requested. It should be HID_INPUT_REPORT,
|
||||||
|
# HID_OUTPUT_REPORT, or HID_FEATURE_REPORT. This call may fail if the device
|
||||||
|
# does not support this feature.
|
||||||
|
#
|
||||||
|
METHOD int get_report {
|
||||||
|
device_t dev;
|
||||||
|
void *data;
|
||||||
|
hid_size_t maxlen;
|
||||||
|
hid_size_t *actlen;
|
||||||
|
uint8_t type;
|
||||||
|
uint8_t id;
|
||||||
|
};
|
||||||
|
|
||||||
|
#
|
||||||
|
# Set a report in the device. The type field indicates which report is to be
|
||||||
|
# set. It should be HID_INPUT_REPORT, HID_OUTPUT_REPORT, or HID_FEATURE_REPORT.
|
||||||
|
# The value of the report is specified by the data and the len fields.
|
||||||
|
# This call may fail if the device does not support this feature.
|
||||||
|
#
|
||||||
|
METHOD int set_report {
|
||||||
|
device_t dev;
|
||||||
|
const void *data;
|
||||||
|
hid_size_t len;
|
||||||
|
uint8_t type;
|
||||||
|
uint8_t id;
|
||||||
|
};
|
||||||
|
|
||||||
|
#
|
||||||
|
# Set duration between input reports (in mSec).
|
||||||
|
#
|
||||||
|
METHOD int set_idle {
|
||||||
|
device_t dev;
|
||||||
|
uint16_t duration;
|
||||||
|
uint8_t id;
|
||||||
|
};
|
||||||
|
|
||||||
|
#
|
||||||
|
# Switch between the boot protocol and the report protocol (or vice versa).
|
||||||
|
#
|
||||||
|
METHOD int set_protocol {
|
||||||
|
device_t dev;
|
||||||
|
uint16_t protocol;
|
||||||
|
};
|
@ -3,7 +3,8 @@
|
|||||||
.PATH: ${SRCTOP}/sys/dev/hid
|
.PATH: ${SRCTOP}/sys/dev/hid
|
||||||
|
|
||||||
KMOD= hid
|
KMOD= hid
|
||||||
SRCS= hid.c
|
SRCS= hid.c hid_if.c
|
||||||
SRCS+= opt_hid.h
|
SRCS+= opt_hid.h
|
||||||
|
SRCS+= bus_if.h device_if.h hid_if.h
|
||||||
|
|
||||||
.include <bsd.kmod.mk>
|
.include <bsd.kmod.mk>
|
||||||
|
Loading…
Reference in New Issue
Block a user