Add drivers for HID over I2C devices, and a driver for I2C mices.

From OpenBSD.
This commit is contained in:
bouyer 2017-12-10 17:05:54 +00:00
parent 404d04cdb7
commit 42f98eb28f
4 changed files with 1258 additions and 1 deletions

View File

@ -1,4 +1,4 @@
# $NetBSD: files.i2c,v 1.78 2017/10/07 18:22:06 jmcneill Exp $
# $NetBSD: files.i2c,v 1.79 2017/12/10 17:05:54 bouyer Exp $
obsolete defflag opt_i2cbus.h I2C_SCAN
define i2cbus { }
@ -284,3 +284,22 @@ file dev/i2c/tcagpio.c tcagpio
device sy8106a
attach sy8106a at iic
file dev/i2c/sy8106a.c sy8106a
# HID over i2c
# HID "bus"
define ihidbus {[ reportid = -1 ]}
# HID root device for multiple report IDs
device ihidev: hid, ihidbus
attach ihidev at iic
file dev/i2c/ihidev.c ihidev
#HID mice
device ims: hid, hidms, wsmousedev
attach ims at ihidbus
file dev/i2c/ims.c ims
#HID multitouch
device imt: hid, hidmt, wsmousedev
attach imt at ihidbus
file dev/i2c/imt.c imt

874
sys/dev/i2c/ihidev.c Normal file
View File

@ -0,0 +1,874 @@
/* $NetBSD: ihidev.c,v 1.1 2017/12/10 17:05:54 bouyer Exp $ */
/* $OpenBSD ihidev.c,v 1.13 2017/04/08 02:57:23 deraadt Exp $ */
/*-
* Copyright (c) 2017 The NetBSD Foundation, Inc.
* All rights reserved.
*
* This code is derived from software contributed to The NetBSD Foundation
* by Manuel Bouyer.
*
* 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 NETBSD FOUNDATION, INC. 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 FOUNDATION 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.
*/
/*
* Copyright (c) 2015, 2016 joshua stein <jcs@openbsd.org>
*
* Permission to use, copy, modify, and distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
* copyright notice and this permission notice appear in all copies.
*
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
/*
* HID-over-i2c driver
*
* https://msdn.microsoft.com/en-us/library/windows/hardware/dn642101%28v=vs.85%29.aspx
*
*/
#include <sys/cdefs.h>
__KERNEL_RCSID(0, "$NetBSD: ihidev.c,v 1.1 2017/12/10 17:05:54 bouyer Exp $");
#include <sys/param.h>
#include <sys/systm.h>
#include <sys/device.h>
#include <sys/kmem.h>
#include <dev/i2c/i2cvar.h>
#include <dev/i2c/ihidev.h>
#include <dev/hid/hid.h>
#if defined(__i386__) || defined(__amd64__)
# include "acpica.h"
#endif
#if NACPICA > 0
#include <dev/acpi/acpi_intr.h>
#endif
#include "locators.h"
/* #define IHIDEV_DEBUG */
#ifdef IHIDEV_DEBUG
#define DPRINTF(x) printf x
#else
#define DPRINTF(x)
#endif
/* 7.2 */
enum {
I2C_HID_CMD_DESCR = 0x0,
I2C_HID_CMD_RESET = 0x1,
I2C_HID_CMD_GET_REPORT = 0x2,
I2C_HID_CMD_SET_REPORT = 0x3,
I2C_HID_CMD_GET_IDLE = 0x4,
I2C_HID_CMD_SET_IDLE = 0x5,
I2C_HID_CMD_GET_PROTO = 0x6,
I2C_HID_CMD_SET_PROTO = 0x7,
I2C_HID_CMD_SET_POWER = 0x8,
/* pseudo commands */
I2C_HID_REPORT_DESCR = 0x100,
};
static int I2C_HID_POWER_ON = 0x0;
static int I2C_HID_POWER_OFF = 0x1;
static int ihidev_match(device_t, cfdata_t, void *);
static void ihidev_attach(device_t, device_t, void *);
static int ihidev_detach(device_t, int);
CFATTACH_DECL_NEW(ihidev, sizeof(struct ihidev_softc),
ihidev_match, ihidev_attach, ihidev_detach, NULL);
static bool ihidev_suspend(device_t, const pmf_qual_t *);
static bool ihidev_resume(device_t, const pmf_qual_t *);
static int ihidev_hid_command(struct ihidev_softc *, int, void *, bool);
static unsigned int ihidev_intr(void *);
static int ihidev_reset(struct ihidev_softc *, bool);
static int ihidev_hid_desc_parse(struct ihidev_softc *);
static int ihidev_maxrepid(void *, int);
static int ihidev_print(void *, const char *);
static int ihidev_submatch(device_t, cfdata_t, const int *, void *);
static const char *ihidev_compats[] = {
"hid-over-i2c",
NULL
};
static int
ihidev_match(device_t parent, cfdata_t match, void *aux)
{
struct i2c_attach_args * const ia = aux;
if (ia->ia_ncompat > 0) {
if (iic_compat_match(ia, ihidev_compats))
return 1;
}
return 0;
}
static void
ihidev_attach(device_t parent, device_t self, void *aux)
{
struct ihidev_softc *sc = device_private(self);
struct i2c_attach_args *ia = aux;
struct ihidev_attach_arg iha;
device_t dev;
int repid, repsz;
int isize;
uint32_t v;
int locs[IHIDBUSCF_NLOCS];
sc->sc_dev = self;
sc->sc_tag = ia->ia_tag;
sc->sc_addr = ia->ia_addr;
sc->sc_phandle = ia->ia_cookie;
mutex_init(&sc->sc_intr_lock, MUTEX_DEFAULT, IPL_VM);
if (!prop_dictionary_get_uint32(ia->ia_prop, "hid-descr-addr", &v)) {
aprint_error(": no hid-descr-addr value\n");
return;
}
sc->sc_hid_desc_addr = v;
if (ihidev_hid_command(sc, I2C_HID_CMD_DESCR, NULL, false) ||
ihidev_hid_desc_parse(sc)) {
aprint_error(": failed fetching initial HID descriptor\n");
return;
}
aprint_naive("\n");
aprint_normal(": vendor 0x%x product 0x%x, %s\n",
le16toh(sc->hid_desc.wVendorID), le16toh(sc->hid_desc.wProductID),
ia->ia_name);
sc->sc_nrepid = ihidev_maxrepid(sc->sc_report, sc->sc_reportlen);
if (sc->sc_nrepid < 0)
return;
aprint_normal_dev(self, "%d report id%s\n", sc->sc_nrepid,
sc->sc_nrepid > 1 ? "s" : "");
sc->sc_nrepid++;
sc->sc_subdevs = kmem_zalloc(sc->sc_nrepid * sizeof(struct ihidev *),
KM_NOSLEEP);
if (sc->sc_subdevs == NULL) {
aprint_error_dev(self, "failed allocating memory\n");
return;
}
/* find largest report size and allocate memory for input buffer */
sc->sc_isize = le16toh(sc->hid_desc.wMaxInputLength);
for (repid = 0; repid < sc->sc_nrepid; repid++) {
repsz = hid_report_size(sc->sc_report, sc->sc_reportlen,
hid_input, repid);
isize = repsz + 2; /* two bytes for the length */
isize += (sc->sc_nrepid != 1); /* one byte for the report ID */
if (isize > sc->sc_isize)
sc->sc_isize = isize;
DPRINTF(("%s: repid %d size %d\n", sc->sc_dev.dv_xname, repid,
repsz));
}
sc->sc_ibuf = kmem_zalloc(sc->sc_isize, KM_NOSLEEP);
#if NACPICA > 0
{
char buf[100];
sc->sc_ih = acpi_intr_establish(self, sc->sc_phandle, ihidev_intr, sc);
if (sc->sc_ih == NULL)
aprint_error_dev(self, "can't establish interrupt\n");
aprint_normal_dev(self, "interrupting at %s\n",
acpi_intr_string(sc->sc_ih, buf, sizeof(buf)));
}
#endif
iha.iaa = ia;
iha.parent = sc;
/* Look for a driver claiming all report IDs first. */
iha.reportid = IHIDEV_CLAIM_ALLREPORTID;
locs[IHIDBUSCF_REPORTID] = IHIDEV_CLAIM_ALLREPORTID;
dev = config_found_sm_loc(self, "ihidbus", locs, &iha,
ihidev_print, ihidev_submatch);
if (dev != NULL) {
for (repid = 0; repid < sc->sc_nrepid; repid++)
sc->sc_subdevs[repid] = device_private(dev);
return;
}
for (repid = 0; repid < sc->sc_nrepid; repid++) {
if (hid_report_size(sc->sc_report, sc->sc_reportlen, hid_input,
repid) == 0 &&
hid_report_size(sc->sc_report, sc->sc_reportlen,
hid_output, repid) == 0 &&
hid_report_size(sc->sc_report, sc->sc_reportlen,
hid_feature, repid) == 0)
continue;
iha.reportid = repid;
locs[IHIDBUSCF_REPORTID] = repid;
dev = config_found_sm_loc(self, "ihidbus", locs,
&iha, ihidev_print, ihidev_submatch);
sc->sc_subdevs[repid] = device_private(dev);
}
/* power down until we're opened */
if (ihidev_hid_command(sc, I2C_HID_CMD_SET_POWER, &I2C_HID_POWER_OFF, false)) {
aprint_error_dev(sc->sc_dev, "failed to power down\n");
return;
}
if (!pmf_device_register(self, ihidev_suspend, ihidev_resume))
aprint_error_dev(self, "couldn't establish power handler\n");
}
static int
ihidev_detach(device_t self, int flags)
{
struct ihidev_softc *sc = device_private(self);
mutex_enter(&sc->sc_intr_lock);
#if NACPICA > 0
if (sc->sc_ih != NULL)
acpi_intr_disestablish(sc->sc_ih, ihidev_intr);
#endif
if (ihidev_hid_command(sc, I2C_HID_CMD_SET_POWER,
&I2C_HID_POWER_OFF, true))
aprint_error_dev(sc->sc_dev, "failed to power down\n");
mutex_exit(&sc->sc_intr_lock);
if (sc->sc_ibuf != NULL) {
kmem_free(sc->sc_ibuf, sc->sc_isize);
sc->sc_ibuf = NULL;
}
if (sc->sc_report != NULL)
kmem_free(sc->sc_report, sc->sc_reportlen);
pmf_device_deregister(self);
return (0);
}
static bool
ihidev_suspend(device_t self, const pmf_qual_t *q)
{
struct ihidev_softc *sc = device_private(self);
mutex_enter(&sc->sc_intr_lock);
if (sc->sc_refcnt > 0) {
printf("ihidev power off\n");
if (ihidev_hid_command(sc, I2C_HID_CMD_SET_POWER,
&I2C_HID_POWER_OFF, true))
aprint_error_dev(sc->sc_dev, "failed to power down\n");
}
mutex_exit(&sc->sc_intr_lock);
return true;
}
static bool
ihidev_resume(device_t self, const pmf_qual_t *q)
{
struct ihidev_softc *sc = device_private(self);
mutex_enter(&sc->sc_intr_lock);
if (sc->sc_refcnt > 0) {
printf("ihidev power reset\n");
ihidev_reset(sc, true);
}
mutex_exit(&sc->sc_intr_lock);
return true;
}
static int
ihidev_hid_command(struct ihidev_softc *sc, int hidcmd, void *arg, bool poll)
{
int i, res = 1;
int flags = poll ? I2C_F_POLL : 0;
iic_acquire_bus(sc->sc_tag, flags);
switch (hidcmd) {
case I2C_HID_CMD_DESCR: {
/*
* 5.2.2 - HID Descriptor Retrieval
* register is passed from the controller
*/
uint8_t cmd[] = {
htole16(sc->sc_hid_desc_addr) & 0xff,
htole16(sc->sc_hid_desc_addr) >> 8,
};
DPRINTF(("%s: HID command I2C_HID_CMD_DESCR at 0x%x\n",
sc->sc_dev.dv_xname, htole16(sc->sc_hid_desc_addr)));
/* 20 00 */
res = iic_exec(sc->sc_tag, I2C_OP_READ_WITH_STOP, sc->sc_addr,
&cmd, sizeof(cmd), &sc->hid_desc_buf,
sizeof(struct i2c_hid_desc), flags);
DPRINTF(("%s: HID descriptor:", sc->sc_dev.dv_xname));
for (i = 0; i < sizeof(struct i2c_hid_desc); i++)
DPRINTF((" %.2x", sc->hid_desc_buf[i]));
DPRINTF(("\n"));
break;
}
case I2C_HID_CMD_RESET: {
uint8_t cmd[] = {
htole16(sc->hid_desc.wCommandRegister) & 0xff,
htole16(sc->hid_desc.wCommandRegister) >> 8,
0,
I2C_HID_CMD_RESET,
};
DPRINTF(("%s: HID command I2C_HID_CMD_RESET\n",
sc->sc_dev.dv_xname));
/* 22 00 00 01 */
res = iic_exec(sc->sc_tag, I2C_OP_WRITE_WITH_STOP, sc->sc_addr,
&cmd, sizeof(cmd), NULL, 0, flags);
break;
}
case I2C_HID_CMD_GET_REPORT: {
struct i2c_hid_report_request *rreq =
(struct i2c_hid_report_request *)arg;
uint8_t cmd[] = {
htole16(sc->hid_desc.wCommandRegister) & 0xff,
htole16(sc->hid_desc.wCommandRegister) >> 8,
0,
I2C_HID_CMD_GET_REPORT,
0, 0, 0,
};
int cmdlen = 7;
int dataoff = 4;
int report_id = rreq->id;
int report_id_len = 1;
int report_len = rreq->len + 2;
int d;
uint8_t *tmprep;
DPRINTF(("%s: HID command I2C_HID_CMD_GET_REPORT %d "
"(type %d, len %d)\n", sc->sc_dev.dv_xname, report_id,
rreq->type, rreq->len));
/*
* 7.2.2.4 - "The protocol is optimized for Report < 15. If a
* report ID >= 15 is necessary, then the Report ID in the Low
* Byte must be set to 1111 and a Third Byte is appended to the
* protocol. This Third Byte contains the entire/actual report
* ID."
*/
if (report_id >= 15) {
cmd[dataoff++] = report_id;
report_id = 15;
report_id_len = 2;
} else
cmdlen--;
cmd[2] = report_id | rreq->type << 4;
cmd[dataoff++] = sc->hid_desc.wDataRegister & 0xff;
cmd[dataoff] = sc->hid_desc.wDataRegister >> 8;
/*
* 7.2.2.2 - Response will be a 2-byte length value, the report
* id with length determined above, and then the report.
* Allocate rreq->len + 2 + 2 bytes, read into that temporary
* buffer, and then copy only the report back out to
* rreq->data.
*/
report_len += report_id_len;
tmprep = kmem_zalloc(report_len, KM_NOSLEEP);
/* type 3 id 8: 22 00 38 02 23 00 */
res = iic_exec(sc->sc_tag, I2C_OP_READ_WITH_STOP, sc->sc_addr,
&cmd, cmdlen, tmprep, report_len, flags);
d = tmprep[0] | tmprep[1] << 8;
if (d != report_len) {
DPRINTF(("%s: response size %d != expected length %d\n",
sc->sc_dev.dv_xname, d, report_len));
}
if (report_id_len == 2)
d = tmprep[2] | tmprep[3] << 8;
else
d = tmprep[2];
if (d != rreq->id) {
DPRINTF(("%s: response report id %d != %d\n",
sc->sc_dev.dv_xname, d, rreq->id));
iic_release_bus(sc->sc_tag, 0);
kmem_free(tmprep, report_len);
return (1);
}
DPRINTF(("%s: response:", sc->sc_dev.dv_xname));
for (i = 0; i < report_len; i++)
DPRINTF((" %.2x", tmprep[i]));
DPRINTF(("\n"));
memcpy(rreq->data, tmprep + 2 + report_id_len, rreq->len);
kmem_free(tmprep, report_len);
break;
}
case I2C_HID_CMD_SET_REPORT: {
struct i2c_hid_report_request *rreq =
(struct i2c_hid_report_request *)arg;
uint8_t cmd[] = {
htole16(sc->hid_desc.wCommandRegister) & 0xff,
htole16(sc->hid_desc.wCommandRegister) >> 8,
0,
I2C_HID_CMD_SET_REPORT,
0, 0, 0, 0, 0, 0,
};
int cmdlen = 10;
int report_id = rreq->id;
int report_len = 2 + (report_id ? 1 : 0) + rreq->len;
int dataoff;
uint8_t *finalcmd;
DPRINTF(("%s: HID command I2C_HID_CMD_SET_REPORT %d "
"(type %d, len %d):", sc->sc_dev.dv_xname, report_id,
rreq->type, rreq->len));
for (i = 0; i < rreq->len; i++)
DPRINTF((" %.2x", ((uint8_t *)rreq->data)[i]));
DPRINTF(("\n"));
/*
* 7.2.2.4 - "The protocol is optimized for Report < 15. If a
* report ID >= 15 is necessary, then the Report ID in the Low
* Byte must be set to 1111 and a Third Byte is appended to the
* protocol. This Third Byte contains the entire/actual report
* ID."
*/
dataoff = 4;
if (report_id >= 15) {
cmd[dataoff++] = report_id;
report_id = 15;
} else
cmdlen--;
cmd[2] = report_id | rreq->type << 4;
if (rreq->type == I2C_HID_REPORT_TYPE_FEATURE) {
cmd[dataoff++] = htole16(sc->hid_desc.wDataRegister)
& 0xff;
cmd[dataoff++] = htole16(sc->hid_desc.wDataRegister)
>> 8;
} else {
cmd[dataoff++] = htole16(sc->hid_desc.wOutputRegister)
& 0xff;
cmd[dataoff++] = htole16(sc->hid_desc.wOutputRegister)
>> 8;
}
cmd[dataoff++] = report_len & 0xff;
cmd[dataoff++] = report_len >> 8;
cmd[dataoff] = rreq->id;
finalcmd = kmem_zalloc(cmdlen + rreq->len, KM_NOSLEEP);
memcpy(finalcmd, cmd, cmdlen);
memcpy(finalcmd + cmdlen, rreq->data, rreq->len);
/* type 3 id 4: 22 00 34 03 23 00 04 00 04 03 */
res = iic_exec(sc->sc_tag, I2C_OP_WRITE_WITH_STOP, sc->sc_addr,
finalcmd, cmdlen + rreq->len, NULL, 0, flags);
kmem_free(finalcmd, cmdlen + rreq->len);
break;
}
case I2C_HID_CMD_SET_POWER: {
int power = *(int *)arg;
uint8_t cmd[] = {
htole16(sc->hid_desc.wCommandRegister) & 0xff,
htole16(sc->hid_desc.wCommandRegister) >> 8,
power,
I2C_HID_CMD_SET_POWER,
};
DPRINTF(("%s: HID command I2C_HID_CMD_SET_POWER(%d)\n",
sc->sc_dev.dv_xname, power));
/* 22 00 00 08 */
res = iic_exec(sc->sc_tag, I2C_OP_WRITE_WITH_STOP, sc->sc_addr,
&cmd, sizeof(cmd), NULL, 0, flags);
break;
}
case I2C_HID_REPORT_DESCR: {
uint8_t cmd[] = {
htole16(sc->hid_desc.wReportDescRegister) & 0xff,
htole16(sc->hid_desc.wReportDescRegister) >> 8,
};
DPRINTF(("%s: HID command I2C_HID_REPORT_DESCR at 0x%x with "
"size %d\n", sc->sc_dev.dv_xname, cmd[0],
sc->sc_reportlen));
/* 20 00 */
res = iic_exec(sc->sc_tag, I2C_OP_READ_WITH_STOP, sc->sc_addr,
&cmd, sizeof(cmd), sc->sc_report, sc->sc_reportlen, flags);
DPRINTF(("%s: HID report descriptor:", sc->sc_dev.dv_xname));
for (i = 0; i < sc->sc_reportlen; i++)
DPRINTF((" %.2x", sc->sc_report[i]));
DPRINTF(("\n"));
break;
}
default:
aprint_error_dev(sc->sc_dev, "unknown command %d\n",
hidcmd);
}
iic_release_bus(sc->sc_tag, flags);
return (res);
}
static int
ihidev_reset(struct ihidev_softc *sc, bool poll)
{
DPRINTF(("%s: resetting\n", sc->sc_dev.dv_xname));
if (ihidev_hid_command(sc, I2C_HID_CMD_SET_POWER,
&I2C_HID_POWER_ON, poll)) {
aprint_error_dev(sc->sc_dev, "failed to power on\n");
return (1);
}
DELAY(1000);
if (ihidev_hid_command(sc, I2C_HID_CMD_RESET, 0, poll)) {
aprint_error_dev(sc->sc_dev, "failed to reset hardware\n");
ihidev_hid_command(sc, I2C_HID_CMD_SET_POWER,
&I2C_HID_POWER_OFF, poll);
return (1);
}
DELAY(1000);
return (0);
}
/*
* 5.2.2 - HID Descriptor Retrieval
*
* parse HID Descriptor that has already been read into hid_desc with
* I2C_HID_CMD_DESCR
*/
static int
ihidev_hid_desc_parse(struct ihidev_softc *sc)
{
int retries = 3;
/* must be v01.00 */
if (le16toh(sc->hid_desc.bcdVersion) != 0x0100) {
aprint_error_dev(sc->sc_dev,
"bad HID descriptor bcdVersion (0x%x)\n",
le16toh(sc->hid_desc.bcdVersion));
return (1);
}
/* must be 30 bytes for v1.00 */
if (le16toh(sc->hid_desc.wHIDDescLength !=
sizeof(struct i2c_hid_desc))) {
aprint_error_dev(sc->sc_dev,
"bad HID descriptor size (%d != %zu)\n",
le16toh(sc->hid_desc.wHIDDescLength),
sizeof(struct i2c_hid_desc));
return (1);
}
if (le16toh(sc->hid_desc.wReportDescLength) <= 0) {
aprint_error_dev(sc->sc_dev,
"bad HID report descriptor size (%d)\n",
le16toh(sc->hid_desc.wReportDescLength));
return (1);
}
while (retries-- > 0) {
if (ihidev_reset(sc, false)) {
if (retries == 0)
return(1);
DELAY(1000);
}
else
break;
}
sc->sc_reportlen = le16toh(sc->hid_desc.wReportDescLength);
sc->sc_report = kmem_zalloc(sc->sc_reportlen, KM_NOSLEEP);
if (ihidev_hid_command(sc, I2C_HID_REPORT_DESCR, 0, false)) {
aprint_error_dev(sc->sc_dev, "failed fetching HID report\n");
return (1);
}
return (0);
}
static unsigned int
ihidev_intr(void *arg)
{
struct ihidev_softc *sc = arg;
struct ihidev *scd;
u_int psize;
int res, i;
u_char *p;
u_int rep = 0;
/*
* XXX: force I2C_F_POLL for now to avoid dwiic interrupting
* while we are interrupting
*/
mutex_enter(&sc->sc_intr_lock);
iic_acquire_bus(sc->sc_tag, I2C_F_POLL);
res = iic_exec(sc->sc_tag, I2C_OP_READ_WITH_STOP, sc->sc_addr, NULL, 0,
sc->sc_ibuf, sc->sc_isize, I2C_F_POLL);
iic_release_bus(sc->sc_tag, I2C_F_POLL);
mutex_exit(&sc->sc_intr_lock);
if (res != 0)
return 1;
/*
* 6.1.1 - First two bytes are the packet length, which must be less
* than or equal to wMaxInputLength
*/
psize = sc->sc_ibuf[0] | sc->sc_ibuf[1] << 8;
if (!psize || psize > sc->sc_isize) {
DPRINTF(("%s: %s: invalid packet size (%d vs. %d)\n",
sc->sc_dev.dv_xname, __func__, psize, sc->sc_isize));
return (1);
}
/* 3rd byte is the report id */
p = sc->sc_ibuf + 2;
psize -= 2;
if (sc->sc_nrepid != 1)
rep = *p++, psize--;
if (rep >= sc->sc_nrepid) {
aprint_error_dev(sc->sc_dev, "%s: bad report id %d\n",
__func__, rep);
return (1);
}
DPRINTF(("%s: ihidev_intr: hid input (rep %d):", sc->sc_dev.dv_xname,
rep));
for (i = 0; i < sc->sc_isize; i++)
DPRINTF((" %.2x", sc->sc_ibuf[i]));
DPRINTF(("\n"));
scd = sc->sc_subdevs[rep];
if (scd == NULL || !(scd->sc_state & IHIDEV_OPEN))
return (1);
scd->sc_intr(scd, p, psize);
return 1;
}
static int
ihidev_maxrepid(void *buf, int len)
{
struct hid_data *d;
struct hid_item h;
int maxid;
maxid = -1;
h.report_ID = 0;
for (d = hid_start_parse(buf, len, hid_none); hid_get_item(d, &h); )
if (h.report_ID > maxid)
maxid = h.report_ID;
hid_end_parse(d);
return (maxid);
}
static int
ihidev_print(void *aux, const char *pnp)
{
struct ihidev_attach_arg *iha = aux;
if (iha->reportid == IHIDEV_CLAIM_ALLREPORTID)
return (QUIET);
if (pnp)
aprint_normal("hid at %s", pnp);
if (iha->reportid != 0)
aprint_normal(" reportid %d", iha->reportid);
return (UNCONF);
}
static int
ihidev_submatch(device_t parent, cfdata_t cf, const int *locs, void *aux)
{
struct ihidev_attach_arg *iha = aux;
if (cf->ihidevcf_reportid != IHIDEV_UNK_REPORTID &&
cf->ihidevcf_reportid != iha->reportid)
return (0);
return config_match(parent, cf, aux);
}
int
ihidev_open(struct ihidev *scd)
{
struct ihidev_softc *sc = scd->sc_parent;
DPRINTF(("%s: %s: state=%d refcnt=%d\n", sc->sc_dev.dv_xname,
__func__, scd->sc_state, sc->sc_refcnt));
if (scd->sc_state & IHIDEV_OPEN)
return (EBUSY);
scd->sc_state |= IHIDEV_OPEN;
if (sc->sc_refcnt++ || sc->sc_isize == 0)
return (0);
/* power on */
ihidev_reset(sc, false);
return (0);
}
void
ihidev_close(struct ihidev *scd)
{
struct ihidev_softc *sc = scd->sc_parent;
DPRINTF(("%s: %s: state=%d refcnt=%d\n", sc->sc_dev.dv_xname,
__func__, scd->sc_state, sc->sc_refcnt));
if (!(scd->sc_state & IHIDEV_OPEN))
return;
scd->sc_state &= ~IHIDEV_OPEN;
if (--sc->sc_refcnt)
return;
if (ihidev_hid_command(sc, I2C_HID_CMD_SET_POWER,
&I2C_HID_POWER_OFF, false))
aprint_error_dev(sc->sc_dev, "failed to power down\n");
}
void
ihidev_get_report_desc(struct ihidev_softc *sc, void **desc, int *size)
{
*desc = sc->sc_report;
*size = sc->sc_reportlen;
}
/* convert hid_* constants used throughout HID code to i2c HID equivalents */
int
ihidev_report_type_conv(int hid_type_id)
{
switch (hid_type_id) {
case hid_input:
return I2C_HID_REPORT_TYPE_INPUT;
case hid_output:
return I2C_HID_REPORT_TYPE_OUTPUT;
case hid_feature:
return I2C_HID_REPORT_TYPE_FEATURE;
default:
return -1;
}
}
int
ihidev_get_report(struct device *dev, int type, int id, void *data, int len)
{
struct ihidev_softc *sc = (struct ihidev_softc *)dev;
struct i2c_hid_report_request rreq;
int ctype;
if ((ctype = ihidev_report_type_conv(type)) < 0)
return (1);
rreq.type = ctype;
rreq.id = id;
rreq.data = data;
rreq.len = len;
if (ihidev_hid_command(sc, I2C_HID_CMD_GET_REPORT, &rreq, false)) {
aprint_error_dev(sc->sc_dev, "failed fetching report\n");
return (1);
}
return 0;
}
int
ihidev_set_report(struct device *dev, int type, int id, void *data,
int len)
{
struct ihidev_softc *sc = (struct ihidev_softc *)dev;
struct i2c_hid_report_request rreq;
int ctype;
if ((ctype = ihidev_report_type_conv(type)) < 0)
return (1);
rreq.type = ctype;
rreq.id = id;
rreq.data = data;
rreq.len = len;
if (ihidev_hid_command(sc, I2C_HID_CMD_SET_REPORT, &rreq, false)) {
aprint_error_dev(sc->sc_dev, "failed setting report\n");
return (1);
}
return 0;
}

160
sys/dev/i2c/ihidev.h Normal file
View File

@ -0,0 +1,160 @@
/* $NetBSD: ihidev.h,v 1.1 2017/12/10 17:05:54 bouyer Exp $ */
/* $OpenBSD ihidev.h,v 1.4 2016/01/31 18:24:35 jcs Exp $ */
/*-
* Copyright (c) 2017 The NetBSD Foundation, Inc.
* All rights reserved.
*
* This code is derived from software contributed to The NetBSD Foundation
* by Manuel Bouyer.
*
* 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 NETBSD FOUNDATION, INC. 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 FOUNDATION 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.
*/
/*
* HID-over-i2c driver
*
* Copyright (c) 2015, 2016 joshua stein <jcs@openbsd.org>
*
* Permission to use, copy, modify, and distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
* copyright notice and this permission notice appear in all copies.
*
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
/* from usbdi.h: Match codes. */
/* First five codes is for a whole device. */
#define IMATCH_VENDOR_PRODUCT_REV 14
#define IMATCH_VENDOR_PRODUCT 13
#define IMATCH_VENDOR_DEVCLASS_DEVPROTO 12
#define IMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO 11
#define IMATCH_DEVCLASS_DEVSUBCLASS 10
/* Next six codes are for interfaces. */
#define IMATCH_VENDOR_PRODUCT_REV_CONF_IFACE 9
#define IMATCH_VENDOR_PRODUCT_CONF_IFACE 8
#define IMATCH_VENDOR_IFACESUBCLASS_IFACEPROTO 7
#define IMATCH_VENDOR_IFACESUBCLASS 6
#define IMATCH_IFACECLASS_IFACESUBCLASS_IFACEPROTO 5
#define IMATCH_IFACECLASS_IFACESUBCLASS 4
#define IMATCH_IFACECLASS 3
#define IMATCH_IFACECLASS_GENERIC 2
/* Generic driver */
#define IMATCH_GENERIC 1
/* No match */
#define IMATCH_NONE 0
#define IHIDBUSCF_REPORTID 0
#define IHIDBUSCF_REPORTID_DEFAULT -1
#define ihidevcf_reportid cf_loc[IHIDBUSCF_REPORTID]
#define IHIDEV_UNK_REPORTID IHIDBUSCF_REPORTID_DEFAULT
/* 5.1.1 - HID Descriptor Format */
struct i2c_hid_desc {
uint16_t wHIDDescLength;
uint16_t bcdVersion;
uint16_t wReportDescLength;
uint16_t wReportDescRegister;
uint16_t wInputRegister;
uint16_t wMaxInputLength;
uint16_t wOutputRegister;
uint16_t wMaxOutputLength;
uint16_t wCommandRegister;
uint16_t wDataRegister;
uint16_t wVendorID;
uint16_t wProductID;
uint16_t wVersionID;
uint32_t reserved;
} __packed;
struct ihidev_softc {
device_t sc_dev;
i2c_tag_t sc_tag;
i2c_addr_t sc_addr;
uint64_t sc_phandle;
void * sc_ih;
kmutex_t sc_intr_lock;
u_int sc_hid_desc_addr;
union {
uint8_t hid_desc_buf[sizeof(struct i2c_hid_desc)];
struct i2c_hid_desc hid_desc;
};
uint8_t *sc_report;
int sc_reportlen;
int sc_nrepid;
struct ihidev **sc_subdevs;
u_int sc_isize;
u_char *sc_ibuf;
int sc_refcnt;
};
struct ihidev {
device_t sc_idev;
struct ihidev_softc *sc_parent;
uint8_t sc_report_id;
uint8_t sc_state;
#define IHIDEV_OPEN 0x01 /* device is open */
void (*sc_intr)(struct ihidev *, void *, u_int);
int sc_isize;
int sc_osize;
int sc_fsize;
};
struct ihidev_attach_arg {
struct i2c_attach_args *iaa;
struct ihidev_softc *parent;
uint8_t reportid;
#define IHIDEV_CLAIM_ALLREPORTID 255
};
struct i2c_hid_report_request {
u_int id;
u_int type;
#define I2C_HID_REPORT_TYPE_INPUT 0x1
#define I2C_HID_REPORT_TYPE_OUTPUT 0x2
#define I2C_HID_REPORT_TYPE_FEATURE 0x3
void *data;
u_int len;
};
void ihidev_get_report_desc(struct ihidev_softc *, void **, int *);
int ihidev_open(struct ihidev *);
void ihidev_close(struct ihidev *);
int ihidev_set_report(device_t, int, int, void *, int);
int ihidev_get_report(device_t, int, int, void *, int);
int ihidev_report_type_conv(int);

204
sys/dev/i2c/ims.c Normal file
View File

@ -0,0 +1,204 @@
/* $NetBSD: ims.c,v 1.1 2017/12/10 17:05:54 bouyer Exp $ */
/* $OpenBSD ims.c,v 1.1 2016/01/12 01:11:15 jcs Exp $ */
/*
* HID-over-i2c mouse/trackpad driver
*
* Copyright (c) 2015, 2016 joshua stein <jcs@openbsd.org>
*
* Permission to use, copy, modify, and distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
* copyright notice and this permission notice appear in all copies.
*
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
#include <sys/cdefs.h>
__KERNEL_RCSID(0, "$NetBSD: ims.c,v 1.1 2017/12/10 17:05:54 bouyer Exp $");
#include <sys/param.h>
#include <sys/systm.h>
#include <sys/kernel.h>
#include <sys/device.h>
#include <sys/ioctl.h>
#include <dev/i2c/i2cvar.h>
#include <dev/i2c/ihidev.h>
#include <dev/hid/hid.h>
#include <dev/hid/hidms.h>
struct ims_softc {
struct ihidev sc_hdev;
struct hidms sc_ms;
bool sc_enabled;
};
static void ims_intr(struct ihidev *addr, void *ibuf, u_int len);
static int ims_enable(void *);
static void ims_disable(void *);
static int ims_ioctl(void *, u_long, void *, int, struct lwp *);
const struct wsmouse_accessops ims_accessops = {
ims_enable,
ims_ioctl,
ims_disable,
};
static int ims_match(device_t, cfdata_t, void *);
static void ims_attach(device_t, device_t, void *);
static int ims_detach(device_t, int);
static void ims_childdet(device_t, device_t);
CFATTACH_DECL2_NEW(ims, sizeof(struct ims_softc), ims_match, ims_attach,
ims_detach, NULL, NULL, ims_childdet);
static int
ims_match(device_t parent, cfdata_t match, void *aux)
{
struct ihidev_attach_arg *iha = (struct ihidev_attach_arg *)aux;
int size;
void *desc;
ihidev_get_report_desc(iha->parent, &desc, &size);
if (hid_is_collection(desc, size, iha->reportid,
HID_USAGE2(HUP_GENERIC_DESKTOP, HUG_POINTER)))
return (IMATCH_IFACECLASS);
if (hid_is_collection(desc, size, iha->reportid,
HID_USAGE2(HUP_GENERIC_DESKTOP, HUG_MOUSE)))
return (IMATCH_IFACECLASS);
if (hid_is_collection(desc, size, iha->reportid,
HID_USAGE2(HUP_DIGITIZERS, HUD_PEN)))
return (IMATCH_IFACECLASS);
return (IMATCH_NONE);
}
static void
ims_attach(device_t parent, device_t self, void *aux)
{
struct ims_softc *sc = device_private(self);
struct hidms *ms = &sc->sc_ms;
struct ihidev_attach_arg *iha = (struct ihidev_attach_arg *)aux;
int size, repid;
void *desc;
sc->sc_hdev.sc_idev = self;
sc->sc_hdev.sc_intr = ims_intr;
sc->sc_hdev.sc_parent = iha->parent;
sc->sc_hdev.sc_report_id = iha->reportid;
if (!pmf_device_register(self, NULL, NULL))
aprint_error_dev(self, "couldn't establish power handler\n");
ihidev_get_report_desc(iha->parent, &desc, &size);
repid = iha->reportid;
sc->sc_hdev.sc_isize = hid_report_size(desc, size, hid_input, repid);
sc->sc_hdev.sc_osize = hid_report_size(desc, size, hid_output, repid);
sc->sc_hdev.sc_fsize = hid_report_size(desc, size, hid_feature, repid);
if (!hidms_setup(self, ms, iha->reportid, desc, size) != 0)
return;
hidms_attach(self, ms, &ims_accessops);
}
static int
ims_detach(device_t self, int flags)
{
struct ims_softc *sc = device_private(self);
int rv = 0;
/* No need to do reference counting of ums, wsmouse has all the goo. */
if (sc->sc_ms.hidms_wsmousedev != NULL)
rv = config_detach(sc->sc_ms.hidms_wsmousedev, flags);
pmf_device_deregister(self);
return rv;
}
void
ims_childdet(device_t self, device_t child)
{
struct ims_softc *sc = device_private(self);
KASSERT(sc->sc_ms.hidms_wsmousedev == child);
sc->sc_ms.hidms_wsmousedev = NULL;
}
static void
ims_intr(struct ihidev *addr, void *buf, u_int len)
{
struct ims_softc *sc = (struct ims_softc *)addr;
struct hidms *ms = &sc->sc_ms;
if (sc->sc_enabled)
hidms_intr(ms, buf, len);
}
static int
ims_enable(void *v)
{
struct ims_softc *sc = v;
int error;
if (sc->sc_enabled)
return EBUSY;
sc->sc_enabled = 1;
sc->sc_ms.hidms_buttons = 0;
error = ihidev_open(&sc->sc_hdev);
if (error)
sc->sc_enabled = 0;
return error;
}
static void
ims_disable(void *v)
{
struct ims_softc *sc = v;
#ifdef DIAGNOSTIC
if (!sc->sc_enabled) {
printf("ums_disable: not enabled\n");
return;
}
#endif
if (sc->sc_enabled) {
sc->sc_enabled = 0;
ihidev_close(&sc->sc_hdev);
}
}
static int
ims_ioctl(void *v, u_long cmd, void *data, int flag, struct lwp *l)
{
struct ims_softc *sc = v;
switch (cmd) {
case WSMOUSEIO_GTYPE:
if (sc->sc_ms.flags & HIDMS_ABS) {
*(u_int *)data = WSMOUSE_TYPE_TPANEL;
} else {
/* XXX: should we set something else? */
*(u_int *)data = WSMOUSE_TYPE_USB;
}
return 0;
}
return EPASSTHROUGH;
}