From nobody Sat Nov 30 12:43:21 2024 Received: from mail-wm1-f43.google.com (mail-wm1-f43.google.com [209.85.128.43]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id AE7FE14B06C; Mon, 9 Sep 2024 18:53:11 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.128.43 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1725907994; cv=none; b=AJPlSm8u9Ydocu9JXeP2irsNc53Z8vg/+9OJgCx105rjMhnbYCWrd80dkpQiJa9PiZFPA6MRywIblqKCK1muJ4Wg7hayiV+oV0Z4Dh6qGXPKVVgsY9v/UeqMVIQWv7cvwUb+/BYgV/430L/hiN416BSNloB5RLhtgOAWaMrDFZ0= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1725907994; c=relaxed/simple; bh=EuOLXN9dqkihIi3EXa9ef1306N0O2l4djybQ4jeM998=; h=From:To:Cc:Subject:Date:Message-ID:MIME-Version; b=U4MZRB9doFbXXUSU28dVGnVkNJHJkTb28hqBm/LIyftL9nx3N3VFaa4lr/rKjl9ch/KjFOip7qDC31WTapS/TEOZgP6YcCBGWfyJGtoftXEqds9P9fN5r10a6ZX5UNMDNBRmtOIbA3AQT9bnydub9iL/grqB+UFlZYJbhmsHwKQ= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=lLN0gEMt; arc=none smtp.client-ip=209.85.128.43 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="lLN0gEMt" Received: by mail-wm1-f43.google.com with SMTP id 5b1f17b1804b1-42cbb08a1a5so7334635e9.3; Mon, 09 Sep 2024 11:53:11 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1725907989; x=1726512789; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date:message-id:reply-to; bh=KDr0eBYO1PskvMpKKS8B3DeUmu6SCTgOxEomSvKBglQ=; b=lLN0gEMtFXrs6eNijtQXzOMjqE1K15ZdQjUGZEJX4FdJMe1O15tSBSQHc2blmw3+qw WsyBL7EeVuQ4WlXdStP526V/YzRr9HnzSSYIfsmXKL+gMzvTzzFqXXY4NOEjwlR5L+Fv uusd3AfmX91d+AiDWHv1DBX+0UCmtUMCEzGG1wBbZvPRFIJAB2L5zvtyGfVDCrS67sPT rtsRMPS6UzmiWjdH4M8wasJi/PZ3yjarwzD49hH7TXIXcpCq5vFSB7fZO9RWtzb95l42 JgIGWB9a2X2ALyIXanDplqmdUSk8BVeT0UgEni4f6dRZWg7eox2mo8dbeglfVx4Zf1xr 1mZg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1725907989; x=1726512789; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=KDr0eBYO1PskvMpKKS8B3DeUmu6SCTgOxEomSvKBglQ=; b=f3xwATh9Wx1ZT4brzVEJ9BnWWAV17z238m4fLuxgFlbESzvMCQJyROxnw5F/l5NQt2 Qzcn5YLgqOafghue3rKcYZGJLkml8eaBMGMPq7nGxbw1IQuBB8pi/mcB/TtDjvmsg80E ToleCAAEnCMaK89h+CLIdgLB0CbxYNj90PqGDvYCtFkxX27uv8airvX3XSm8ytBYmcps Dw4LlwojalJXv2MibchYmrtwDFUcW/3OdgAWRYC5PknUfdvw27AVxaxcJXAqCPLYtrlZ 8G1e0mGt8lV3ok7MDBltdBZs+eK1qrNP7T4JxesIsxwTcKfFHT/CxQigv+XfjeWkV/lz 8VLg== X-Forwarded-Encrypted: i=1; AJvYcCWBCGjrFAwJvFDYD3FZycXxoNIZ48EsLIqZGxJSzy7SYI0Ck/ivTU6ud9pXE7spMtsk/froSpSKX166hxI=@vger.kernel.org X-Gm-Message-State: AOJu0YwqKn4CvEV1TsILOp8ivj5+MoGyaNZQs8BDaPNq+19EdW2vENIg UjBk9FxZMq+qp/afzzHsHesLWHfA1H9ER2wHQhfCmIixUtwN0ln/q0+NOSWX X-Google-Smtp-Source: AGHT+IEgQwlhzW/9JGkHLdyVue9KLpn9A1/yqfS8fTknQjP5IlgSP4EY8R45hJ3ZaM6qL0slmh8qJw== X-Received: by 2002:a05:600c:1d10:b0:42c:bae0:f066 with SMTP id 5b1f17b1804b1-42cbae0f268mr18897185e9.13.1725907988106; Mon, 09 Sep 2024 11:53:08 -0700 (PDT) Received: from localhost.localdomain ([188.74.74.117]) by smtp.gmail.com with ESMTPSA id 5b1f17b1804b1-42caeb21cdfsm84662825e9.10.2024.09.09.11.53.07 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 09 Sep 2024 11:53:07 -0700 (PDT) From: Stuart Hayhurst To: linux-input@vger.kernel.org Cc: Stuart Hayhurst , Jiri Kosina , Benjamin Tissoires , Christophe JAILLET , linux-kernel@vger.kernel.org Subject: [PATCH v4 RESEND] HID: corsair-void: Add Corsair Void headset family driver Date: Mon, 9 Sep 2024 19:49:37 +0100 Message-ID: <20240909184936.32489-3-stuart.a.hayhurst@gmail.com> X-Mailer: git-send-email 2.45.2 Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" Introduce a driver for the Corsair Void family of headsets, supporting: - Battery reporting (power_supply) - Sidetone setting support - Physical microphone location reporting - Headset and receiver firmware version reporting - Built-in alert triggering - USB wireless_status Tested with a Void Pro Wireless, Void Elite Wireless and a Void Elite Wired Signed-off-by: Stuart Hayhurst --- Just a couple questions about the sysfs attributes: - Should the sysfs documentation use the implementation date (current), or= the date it was submitted? - Are the attribute names correct? I guessed reasonable names, but if ther= e's a convention I'll correct them - For cases where the wireless headset is disconnected, `microphone_up` re= turns -ENODEV - Should it be left like that, or deregister the attributes when the head= set disconnects? v3 -> v4: - Added missing include - Added missing newline, fix indent - Use hid_hw_raw_request return code directly for wireless sidetone - Use battery status enum for remaining values - Use of devm_kasprintf() to create battery string - Moved corsair_void_request_status error reporting to callers - Simplified corsair_void_request_status - Removed battery_struct_size, use sizeof(*battery_data) instead - Removed unnecessary curly brackets in send_alert_store v2 -> v3: - Use __free(kfree) helper to free allocations - Combined similar condition checks - Check power_supply was created successfully before saving it - Removed explicit initialisation of return value in corsair_void_probe - Use preferred syntax for drvdata's struct allocation size - Removed named success exit point from driver probe - Removed unused driver probe exit point v1 -> v2: - Added a module author email address - Removed unused variable (psy_cfg) - Corrected status request buffer size from 12 bytes to 2 bytes - Use enums for battery status - Use kmalloc instead of kzalloc where applicable - Use __le16 type for cpu_to_le16 - Use DEVICE_ATTR_RO and DEVICE_ATTR_WO to create attributes - Simplified corsair_void_set_sidetone_wired - Cleaned up patch description .../ABI/testing/sysfs-driver-hid-corsair-void | 38 + drivers/hid/Kconfig | 10 + drivers/hid/Makefile | 1 + drivers/hid/hid-corsair-void.c | 829 ++++++++++++++++++ 4 files changed, 878 insertions(+) create mode 100644 Documentation/ABI/testing/sysfs-driver-hid-corsair-void create mode 100644 drivers/hid/hid-corsair-void.c diff --git a/Documentation/ABI/testing/sysfs-driver-hid-corsair-void b/Docu= mentation/ABI/testing/sysfs-driver-hid-corsair-void new file mode 100644 index 000000000000..f933ba15dd6d --- /dev/null +++ b/Documentation/ABI/testing/sysfs-driver-hid-corsair-void @@ -0,0 +1,38 @@ +What: /sys/bus/hid/drivers/hid-corsair-void//fw_version_headset +Date: January 2024 +KernelVersion: 6.12 +Contact: Stuart Hayhurst +Description: (R) The firmware version of the headset + * Returns -ENODATA if no version was reported + +What: /sys/bus/hid/drivers/hid-corsair-void//fw_version_receiver +Date: January 2024 +KernelVersion: 6.12 +Contact: Stuart Hayhurst +Description: (R) The firmware version of the receiver + +What: /sys/bus/hid/drivers/hid-corsair-void//microphone_up +Date: July 2023 +KernelVersion: 6.12 +Contact: Stuart Hayhurst +Description: (R) Get the physical position of the microphone + * 1 -> Microphone up + * 0 -> Microphone down + +What: /sys/bus/hid/drivers/hid-corsair-void//send_alert +Date: July 2023 +KernelVersion: 6.12 +Contact: Stuart Hayhurst +Description: (W) Play a built-in notification from the headset (0 / 1) + +What: /sys/bus/hid/drivers/hid-corsair-void//set_sidetone +Date: December 2023 +KernelVersion: 6.12 +Contact: Stuart Hayhurst +Description: (W) Set the sidetone volume (0 - sidetone_max) + +What: /sys/bus/hid/drivers/hid-corsair-void//sidetone_max +Date: July 2024 +KernelVersion: 6.12 +Contact: Stuart Hayhurst +Description: (R) Report the maximum sidetone volume diff --git a/drivers/hid/Kconfig b/drivers/hid/Kconfig index 08446c89eff6..7dcf911f3367 100644 --- a/drivers/hid/Kconfig +++ b/drivers/hid/Kconfig @@ -221,6 +221,16 @@ config HID_CORSAIR - Vengeance K90 - Scimitar PRO RGB =20 +config HID_CORSAIR_VOID + tristate "Corsair Void headsets" + depends on USB_HID + select POWER_SUPPLY + help + Support for Corsair Void headsets. + + Supported devices: + - Corsair Void headsets + config HID_COUGAR tristate "Cougar devices" help diff --git a/drivers/hid/Makefile b/drivers/hid/Makefile index e40f1ddebbb7..037d7e3b6c3e 100644 --- a/drivers/hid/Makefile +++ b/drivers/hid/Makefile @@ -39,6 +39,7 @@ obj-$(CONFIG_HID_CHERRY) +=3D hid-cherry.o obj-$(CONFIG_HID_CHICONY) +=3D hid-chicony.o obj-$(CONFIG_HID_CMEDIA) +=3D hid-cmedia.o obj-$(CONFIG_HID_CORSAIR) +=3D hid-corsair.o +obj-$(CONFIG_HID_CORSAIR_VOID) +=3D hid-corsair-void.o obj-$(CONFIG_HID_COUGAR) +=3D hid-cougar.o obj-$(CONFIG_HID_CP2112) +=3D hid-cp2112.o obj-$(CONFIG_HID_CYPRESS) +=3D hid-cypress.o diff --git a/drivers/hid/hid-corsair-void.c b/drivers/hid/hid-corsair-void.c new file mode 100644 index 000000000000..6ece56b850fc --- /dev/null +++ b/drivers/hid/hid-corsair-void.c @@ -0,0 +1,829 @@ +// SPDX-License-Identifier: GPL-2.0-or-later +/* + * HID driver for Corsair Void headsets + * + * Copyright (C) 2023-2024 Stuart Hayhurst + */ + +/* -----------------------------------------------------------------------= --- */ +/* Receiver report information: (ID 100) = */ +/* -----------------------------------------------------------------------= --- */ +/* + * When queried, the receiver reponds with 5 bytes to describe the battery + * The power button, mute button and moving the mic also trigger this re= port + * This includes power button + mic + connection + battery status and capa= city + * The information below may not be perfect, it's been gathered through gu= esses + * + * 0: REPORT ID + * 100 for the battery packet + * + * 1: POWER BUTTON + (?) + * Largest bit is 1 when power button pressed + * + * 2: BATTERY CAPACITY + MIC STATUS + * Battery capacity: + * Seems to report ~54 higher than reality when charging + * Capped at 100, charging or not + * Microphone status: + * Largest bit is set to 1 when the mic is physically up + * No bits change when the mic is muted, only when physically moved + * This report is sent every time the mic is moved, no polling required + * + * 3: CONNECTION STATUS + * 16: Wired headset + * 38: Initialising + * 49: Lost connection + * 51: Disconnected, searching + * 52: Disconnected, not searching + * 177: Normal + * + * 4: BATTERY STATUS + * 0: Disconnected + * 1: Normal + * 2: Low + * 3: Critical - sent during shutdown + * 4: Fully charged + * 5: Charging + */ +/* -----------------------------------------------------------------------= --- */ + +/* -----------------------------------------------------------------------= --- */ +/* Receiver report information: (ID 102) = */ +/* -----------------------------------------------------------------------= --- */ +/* + * When queried, the recevier responds with 4 bytes to describe the firmwa= re + * The first 2 bytes are for the receiver, the second 2 are the headset + * The headset firmware version will be 0 if no headset is connected + * + * 0: Recevier firmware major version + * Major version of the receiver's firmware + * + * 1: Recevier firmware minor version + * Minor version of the receiver's firmware + * + * 2: Headset firmware major version + * Major version of the headset's firmware + * + * 3: Headset firmware minor version + * Minor version of the headset's firmware + */ +/* -----------------------------------------------------------------------= --- */ + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include "hid-ids.h" + +#define CORSAIR_VOID_DEVICE(id, type) { HID_USB_DEVICE(USB_VENDOR_ID_CORS= AIR, (id)), \ + .driver_data =3D (type) } +#define CORSAIR_VOID_WIRELESS_DEVICE(id) CORSAIR_VOID_DEVICE((id), CORSAIR= _VOID_WIRELESS) +#define CORSAIR_VOID_WIRED_DEVICE(id) CORSAIR_VOID_DEVICE((id), CORSAIR_V= OID_WIRED) + +#define CORSAIR_VOID_STATUS_REQUEST_ID 0xC9 +#define CORSAIR_VOID_NOTIF_REQUEST_ID 0xCA +#define CORSAIR_VOID_SIDETONE_REQUEST_ID 0xFF +#define CORSAIR_VOID_STATUS_REPORT_ID 0x64 +#define CORSAIR_VOID_FIRMWARE_REPORT_ID 0x66 + +#define CORSAIR_VOID_USB_SIDETONE_REQUEST 0x1 +#define CORSAIR_VOID_USB_SIDETONE_REQUEST_TYPE 0x21 +#define CORSAIR_VOID_USB_SIDETONE_VALUE 0x200 +#define CORSAIR_VOID_USB_SIDETONE_INDEX 0xB00 + +#define CORSAIR_VOID_MIC_MASK GENMASK(7, 7) +#define CORSAIR_VOID_CAPACITY_MASK GENMASK(6, 0) + +#define CORSAIR_VOID_WIRELESS_CONNECTED 177 + +#define CORSAIR_VOID_SIDETONE_MAX_WIRELESS 55 +#define CORSAIR_VOID_SIDETONE_MAX_WIRED 4096 + +enum { + CORSAIR_VOID_WIRELESS, + CORSAIR_VOID_WIRED, +}; + +enum { + CORSAIR_VOID_BATTERY_NORMAL =3D 1, + CORSAIR_VOID_BATTERY_LOW =3D 2, + CORSAIR_VOID_BATTERY_CRITICAL =3D 3, + CORSAIR_VOID_BATTERY_CHARGED =3D 4, + CORSAIR_VOID_BATTERY_CHARGING =3D 5, +}; + +static enum power_supply_property corsair_void_battery_props[] =3D { + POWER_SUPPLY_PROP_STATUS, + POWER_SUPPLY_PROP_PRESENT, + POWER_SUPPLY_PROP_CAPACITY, + POWER_SUPPLY_PROP_CAPACITY_LEVEL, + POWER_SUPPLY_PROP_SCOPE, + POWER_SUPPLY_PROP_MODEL_NAME, + POWER_SUPPLY_PROP_MANUFACTURER, +}; + +struct corsair_void_battery_data { + int status; + bool present; + int capacity; + int capacity_level; +}; + +struct corsair_void_drvdata { + struct hid_device *hid_dev; + struct device *dev; + + char *name; + bool is_wired; + unsigned int sidetone_max; + + struct corsair_void_battery_data battery_data; + bool mic_up; + bool connected; + int fw_receiver_major; + int fw_receiver_minor; + int fw_headset_major; + int fw_headset_minor; + + struct power_supply *battery; + struct power_supply_desc battery_desc; + struct mutex battery_mutex; + + struct delayed_work delayed_status_work; + struct delayed_work delayed_firmware_work; + struct work_struct battery_remove_work; + struct work_struct battery_add_work; +}; + +/* + * Functions to process receiver data +*/ + +static void corsair_void_set_wireless_status(struct corsair_void_drvdata *= drvdata) +{ + struct usb_interface *usb_if =3D to_usb_interface(drvdata->dev->parent); + + if (drvdata->is_wired) + return; + + usb_set_wireless_status(usb_if, drvdata->connected ? + USB_WIRELESS_STATUS_CONNECTED : + USB_WIRELESS_STATUS_DISCONNECTED); +} + +static void corsair_void_set_unknown_batt(struct corsair_void_drvdata *drv= data) +{ + struct corsair_void_battery_data *battery_data =3D &drvdata->battery_data; + + battery_data->status =3D POWER_SUPPLY_STATUS_UNKNOWN; + battery_data->present =3D false; + battery_data->capacity =3D 0; + battery_data->capacity_level =3D POWER_SUPPLY_CAPACITY_LEVEL_UNKNOWN; +} + +/* Reset data that may change between wireless connections */ +static void corsair_void_set_unknown_wireless_data(struct corsair_void_drv= data *drvdata) +{ + /* Only 0 out headset, receiver is always known if relevant */ + drvdata->fw_headset_major =3D 0; + drvdata->fw_headset_minor =3D 0; + + drvdata->connected =3D false; + drvdata->mic_up =3D false; + + corsair_void_set_wireless_status(drvdata); +} + +static void corsair_void_process_receiver(struct corsair_void_drvdata *drv= data, + int raw_battery_capacity, + int raw_connection_status, + int raw_battery_status) +{ + struct corsair_void_battery_data *battery_data =3D &drvdata->battery_data; + struct corsair_void_battery_data orig_battery_data; + + /* Save initial battery data, to compare later */ + orig_battery_data =3D *battery_data; + + /* Headset not connected, or it's wired */ + if (raw_connection_status !=3D CORSAIR_VOID_WIRELESS_CONNECTED) + goto unknown_battery; + + /* Battery information unavailable */ + if (raw_battery_status =3D=3D 0) + goto unknown_battery; + + /* Battery must be connected then */ + battery_data->present =3D true; + battery_data->capacity_level =3D POWER_SUPPLY_CAPACITY_LEVEL_NORMAL; + + /* Set battery status */ + switch (raw_battery_status) { + case CORSAIR_VOID_BATTERY_NORMAL: + case CORSAIR_VOID_BATTERY_LOW: + case CORSAIR_VOID_BATTERY_CRITICAL: + battery_data->status =3D POWER_SUPPLY_STATUS_DISCHARGING; + if (raw_battery_status =3D=3D CORSAIR_VOID_BATTERY_LOW) + battery_data->capacity_level =3D POWER_SUPPLY_CAPACITY_LEVEL_LOW; + else if (raw_battery_status =3D=3D CORSAIR_VOID_BATTERY_CRITICAL) + battery_data->capacity_level =3D POWER_SUPPLY_CAPACITY_LEVEL_CRITICAL; + + break; + case CORSAIR_VOID_BATTERY_CHARGED: + battery_data->status =3D POWER_SUPPLY_STATUS_FULL; + break; + case CORSAIR_VOID_BATTERY_CHARGING: + battery_data->status =3D POWER_SUPPLY_STATUS_CHARGING; + break; + default: + hid_warn(drvdata->hid_dev, "unknown battery status '%d'", + raw_battery_status); + goto unknown_battery; + break; + } + + battery_data->capacity =3D raw_battery_capacity; + corsair_void_set_wireless_status(drvdata); + + goto success; +unknown_battery: + corsair_void_set_unknown_batt(drvdata); +success: + + /* Inform power supply if battery values changed */ + if (memcmp(&orig_battery_data, battery_data, sizeof(*battery_data))) { + scoped_guard(mutex, &drvdata->battery_mutex) { + if (drvdata->battery) { + power_supply_changed(drvdata->battery); + } + } + } +} + +/* + * Functions to report stored data +*/ + +static int corsair_void_battery_get_property(struct power_supply *psy, + enum power_supply_property prop, + union power_supply_propval *val) +{ + struct corsair_void_drvdata *drvdata =3D power_supply_get_drvdata(psy); + + switch (prop) { + case POWER_SUPPLY_PROP_SCOPE: + val->intval =3D POWER_SUPPLY_SCOPE_DEVICE; + break; + case POWER_SUPPLY_PROP_MODEL_NAME: + if (!strncmp(drvdata->hid_dev->name, "Corsair ", 8)) + val->strval =3D drvdata->hid_dev->name + 8; + else + val->strval =3D drvdata->hid_dev->name; + break; + case POWER_SUPPLY_PROP_MANUFACTURER: + val->strval =3D "Corsair"; + break; + case POWER_SUPPLY_PROP_STATUS: + val->intval =3D drvdata->battery_data.status; + break; + case POWER_SUPPLY_PROP_PRESENT: + val->intval =3D drvdata->battery_data.present; + break; + case POWER_SUPPLY_PROP_CAPACITY: + val->intval =3D drvdata->battery_data.capacity; + break; + case POWER_SUPPLY_PROP_CAPACITY_LEVEL: + val->intval =3D drvdata->battery_data.capacity_level; + break; + default: + return -EINVAL; + } + + return 0; +} + +static ssize_t microphone_up_show(struct device *dev, + struct device_attribute *attr, char *buf) +{ + struct corsair_void_drvdata *drvdata =3D dev_get_drvdata(dev); + + if (!drvdata->connected) + return -ENODEV; + + return sysfs_emit(buf, "%d\n", drvdata->mic_up); +} + +static ssize_t fw_version_receiver_show(struct device *dev, + struct device_attribute *attr, + char *buf) +{ + struct corsair_void_drvdata *drvdata =3D dev_get_drvdata(dev); + + if (drvdata->fw_receiver_major =3D=3D 0 && drvdata->fw_receiver_minor =3D= =3D 0) + return -ENODATA; + + return sysfs_emit(buf, "%d.%02d\n", drvdata->fw_receiver_major, + drvdata->fw_receiver_minor); +} + + +static ssize_t fw_version_headset_show(struct device *dev, + struct device_attribute *attr, + char *buf) +{ + struct corsair_void_drvdata *drvdata =3D dev_get_drvdata(dev); + + if (drvdata->fw_headset_major =3D=3D 0 && drvdata->fw_headset_minor =3D= =3D 0) + return -ENODATA; + + return sysfs_emit(buf, "%d.%02d\n", drvdata->fw_headset_major, + drvdata->fw_headset_minor); +} + +static ssize_t sidetone_max_show(struct device *dev, + struct device_attribute *attr, + char *buf) +{ + struct corsair_void_drvdata *drvdata =3D dev_get_drvdata(dev); + + return sysfs_emit(buf, "%d\n", drvdata->sidetone_max); +} + +/* + * Functions to send data to headset +*/ + +static ssize_t send_alert_store(struct device *dev, + struct device_attribute *attr, + const char *buf, size_t count) +{ + struct corsair_void_drvdata *drvdata =3D dev_get_drvdata(dev); + struct hid_device *hid_dev =3D drvdata->hid_dev; + unsigned char alert_id; + unsigned char *send_buf __free(kfree) =3D NULL; + int ret; + + if (!drvdata->connected || drvdata->is_wired) + return -ENODEV; + + /* Only accept 0 or 1 for alert ID */ + if (kstrtou8(buf, 10, &alert_id) || alert_id >=3D 2) + return -EINVAL; + + send_buf =3D kmalloc(3, GFP_KERNEL); + if (!send_buf) + return -ENOMEM; + + /* Packet format to send alert with ID alert_id */ + send_buf[0] =3D CORSAIR_VOID_NOTIF_REQUEST_ID; + send_buf[1] =3D 0x02; + send_buf[2] =3D alert_id; + + ret =3D hid_hw_raw_request(hid_dev, CORSAIR_VOID_NOTIF_REQUEST_ID, + send_buf, 3, HID_OUTPUT_REPORT, + HID_REQ_SET_REPORT); + if (ret < 0) + hid_warn(hid_dev, "failed to send alert request (reason: %d)", + ret); + else + ret =3D count; + + return ret; +} + +static int corsair_void_set_sidetone_wired(struct device *dev, const char = *buf, + unsigned int sidetone) +{ + struct usb_interface *usb_if =3D to_usb_interface(dev->parent); + struct usb_device *usb_dev =3D interface_to_usbdev(usb_if); + + /* Packet format to set sidetone for wired headsets */ + __le16 sidetone_le =3D cpu_to_le16(sidetone); + + return usb_control_msg_send(usb_dev, 0, + CORSAIR_VOID_USB_SIDETONE_REQUEST, + CORSAIR_VOID_USB_SIDETONE_REQUEST_TYPE, + CORSAIR_VOID_USB_SIDETONE_VALUE, + CORSAIR_VOID_USB_SIDETONE_INDEX, + &sidetone_le, 2, USB_CTRL_SET_TIMEOUT, + GFP_KERNEL); +} + +static int corsair_void_set_sidetone_wireless(struct device *dev, + const char *buf, + unsigned char sidetone) +{ + struct corsair_void_drvdata *drvdata =3D dev_get_drvdata(dev); + struct hid_device *hid_dev =3D drvdata->hid_dev; + unsigned char *send_buf __free(kfree) =3D NULL; + + send_buf =3D kmalloc(12, GFP_KERNEL); + if (!send_buf) + return -ENOMEM; + + /* Packet format to set sidetone for wireless headsets */ + send_buf[0] =3D CORSAIR_VOID_SIDETONE_REQUEST_ID; + send_buf[1] =3D 0x0B; + send_buf[2] =3D 0x00; + send_buf[3] =3D 0xFF; + send_buf[4] =3D 0x04; + send_buf[5] =3D 0x0E; + send_buf[6] =3D 0xFF; + send_buf[7] =3D 0x05; + send_buf[8] =3D 0x01; + send_buf[9] =3D 0x04; + send_buf[10] =3D 0x00; + send_buf[11] =3D sidetone + 200; + + return hid_hw_raw_request(hid_dev, CORSAIR_VOID_SIDETONE_REQUEST_ID, + send_buf, 12, HID_FEATURE_REPORT, + HID_REQ_SET_REPORT); +} + +static ssize_t set_sidetone_store(struct device *dev, + struct device_attribute *attr, + const char *buf, size_t count) +{ + struct corsair_void_drvdata *drvdata =3D dev_get_drvdata(dev); + struct hid_device *hid_dev =3D drvdata->hid_dev; + unsigned int sidetone; + int ret; + + if (!drvdata->connected) + return -ENODEV; + + /* sidetone must be between 0 and drvdata->sidetone_max inclusive */ + if (kstrtouint(buf, 10, &sidetone) || sidetone > drvdata->sidetone_max) + return -EINVAL; + + if (drvdata->is_wired) + ret =3D corsair_void_set_sidetone_wired(dev, buf, sidetone); + else + ret =3D corsair_void_set_sidetone_wireless(dev, buf, sidetone); + + if (ret < 0) + hid_warn(hid_dev, "failed to send sidetone (reason: %d)", ret); + else + ret =3D count; + + return ret; +} + +static int corsair_void_request_status(struct hid_device *hid_dev, int id) +{ + unsigned char *send_buf __free(kfree) =3D NULL; + + send_buf =3D kmalloc(2, GFP_KERNEL); + if (!send_buf) + return -ENOMEM; + + /* Packet format to request data item (status / firmware) refresh */ + send_buf[0] =3D CORSAIR_VOID_STATUS_REQUEST_ID; + send_buf[1] =3D id; + + /* Send request for data refresh */ + return hid_hw_raw_request(hid_dev, CORSAIR_VOID_STATUS_REQUEST_ID, + send_buf, 2, HID_OUTPUT_REPORT, + HID_REQ_SET_REPORT); +} + +/* + * Headset connect / disconnect handlers and work handlers +*/ + +static void corsair_void_status_work_handler(struct work_struct *work) +{ + struct corsair_void_drvdata *drvdata; + struct delayed_work *delayed_work; + int battery_ret; + + delayed_work =3D container_of(work, struct delayed_work, work); + drvdata =3D container_of(delayed_work, struct corsair_void_drvdata, + delayed_status_work); + + battery_ret =3D corsair_void_request_status(drvdata->hid_dev, + CORSAIR_VOID_STATUS_REPORT_ID); + if (battery_ret < 0) { + hid_warn(drvdata->hid_dev, + "failed to request battery (reason: %d)", battery_ret); + } +} + +static void corsair_void_firmware_work_handler(struct work_struct *work) +{ + struct corsair_void_drvdata *drvdata; + struct delayed_work *delayed_work; + int firmware_ret; + + delayed_work =3D container_of(work, struct delayed_work, work); + drvdata =3D container_of(delayed_work, struct corsair_void_drvdata, + delayed_firmware_work); + + firmware_ret =3D corsair_void_request_status(drvdata->hid_dev, + CORSAIR_VOID_FIRMWARE_REPORT_ID); + if (firmware_ret < 0) { + hid_warn(drvdata->hid_dev, + "failed to request firmware (reason: %d)", firmware_ret); + } + +} + +static void corsair_void_battery_remove_work_handler(struct work_struct *w= ork) +{ + struct corsair_void_drvdata *drvdata; + + drvdata =3D container_of(work, struct corsair_void_drvdata, + battery_remove_work); + scoped_guard(mutex, &drvdata->battery_mutex) { + if (drvdata->battery) { + power_supply_unregister(drvdata->battery); + drvdata->battery =3D NULL; + } + } +} + +static void corsair_void_battery_add_work_handler(struct work_struct *work) +{ + struct corsair_void_drvdata *drvdata; + struct power_supply_config psy_cfg; + struct power_supply *new_supply; + + drvdata =3D container_of(work, struct corsair_void_drvdata, + battery_add_work); + guard(mutex)(&drvdata->battery_mutex); + if (drvdata->battery) + return; + + psy_cfg.drv_data =3D drvdata; + new_supply =3D power_supply_register(drvdata->dev, + &drvdata->battery_desc, + &psy_cfg); + + if (IS_ERR(new_supply)) { + hid_err(drvdata->hid_dev, + "failed to register battery '%s' (reason: %ld)\n", + drvdata->battery_desc.name, + PTR_ERR(new_supply)); + return; + } + + if (power_supply_powers(new_supply, drvdata->dev)) { + power_supply_unregister(new_supply); + return; + } + + drvdata->battery =3D new_supply; +} + +static void corsair_void_headset_connected(struct corsair_void_drvdata *dr= vdata) +{ + schedule_work(&drvdata->battery_add_work); + schedule_delayed_work(&drvdata->delayed_firmware_work, + msecs_to_jiffies(100)); +} + +static void corsair_void_headset_disconnected(struct corsair_void_drvdata = *drvdata) +{ + schedule_work(&drvdata->battery_remove_work); + + corsair_void_set_unknown_wireless_data(drvdata); + corsair_void_set_unknown_batt(drvdata); +} + +/* + * Driver setup, probing and HID event handling +*/ + +static DEVICE_ATTR_RO(fw_version_receiver); +static DEVICE_ATTR_RO(fw_version_headset); +static DEVICE_ATTR_RO(microphone_up); +static DEVICE_ATTR_RO(sidetone_max); + +static DEVICE_ATTR_WO(send_alert); +static DEVICE_ATTR_WO(set_sidetone); + +static struct attribute *corsair_void_attrs[] =3D { + &dev_attr_fw_version_receiver.attr, + &dev_attr_fw_version_headset.attr, + &dev_attr_microphone_up.attr, + &dev_attr_send_alert.attr, + &dev_attr_set_sidetone.attr, + &dev_attr_sidetone_max.attr, + NULL, +}; + +static const struct attribute_group corsair_void_attr_group =3D { + .attrs =3D corsair_void_attrs, +}; + +static int corsair_void_probe(struct hid_device *hid_dev, + const struct hid_device_id *hid_id) +{ + int ret; + struct corsair_void_drvdata *drvdata; + char *name; + + if (!hid_is_usb(hid_dev)) + return -EINVAL; + + drvdata =3D devm_kzalloc(&hid_dev->dev, sizeof(*drvdata), + GFP_KERNEL); + if (!drvdata) + return -ENOMEM; + + hid_set_drvdata(hid_dev, drvdata); + dev_set_drvdata(&hid_dev->dev, drvdata); + + drvdata->dev =3D &hid_dev->dev; + drvdata->hid_dev =3D hid_dev; + drvdata->is_wired =3D hid_id->driver_data =3D=3D CORSAIR_VOID_WIRED; + + drvdata->sidetone_max =3D CORSAIR_VOID_SIDETONE_MAX_WIRELESS; + if (drvdata->is_wired) + drvdata->sidetone_max =3D CORSAIR_VOID_SIDETONE_MAX_WIRED; + + /* Set initial values for no wireless headset attached */ + /* If a headset is attached, it'll be prompted later */ + corsair_void_set_unknown_wireless_data(drvdata); + corsair_void_set_unknown_batt(drvdata); + + /* Receiver version won't be reset after init */ + /* Headset version already set via set_unknown_wireless_data */ + drvdata->fw_receiver_major =3D 0; + drvdata->fw_receiver_minor =3D 0; + + ret =3D hid_parse(hid_dev); + if (ret) { + hid_err(hid_dev, "parse failed (reason: %d)\n", ret); + return ret; + } + + name =3D devm_kasprintf(drvdata->dev, GFP_KERNEL, + "corsair-void-%d-battery", hid_dev->id); + if (!name) + return -ENOMEM; + + drvdata->battery_desc.name =3D name; + drvdata->battery_desc.type =3D POWER_SUPPLY_TYPE_BATTERY; + drvdata->battery_desc.properties =3D corsair_void_battery_props; + drvdata->battery_desc.num_properties =3D ARRAY_SIZE(corsair_void_battery_= props); + drvdata->battery_desc.get_property =3D corsair_void_battery_get_property; + + drvdata->battery =3D NULL; + INIT_WORK(&drvdata->battery_remove_work, + corsair_void_battery_remove_work_handler); + INIT_WORK(&drvdata->battery_add_work, + corsair_void_battery_add_work_handler); + ret =3D devm_mutex_init(drvdata->dev, &drvdata->battery_mutex); + if (ret) + return ret; + + ret =3D sysfs_create_group(&hid_dev->dev.kobj, &corsair_void_attr_group); + if (ret) + return ret; + + /* Any failures after here will need to call hid_hw_stop */ + ret =3D hid_hw_start(hid_dev, HID_CONNECT_DEFAULT); + if (ret) { + hid_err(hid_dev, "hid_hw_start failed (reason: %d)\n", ret); + goto failed_after_sysfs; + } + + /* Refresh battery data, in case wireless headset is already connected */ + INIT_DELAYED_WORK(&drvdata->delayed_status_work, + corsair_void_status_work_handler); + schedule_delayed_work(&drvdata->delayed_status_work, + msecs_to_jiffies(100)); + + /* Refresh firmware versions */ + INIT_DELAYED_WORK(&drvdata->delayed_firmware_work, + corsair_void_firmware_work_handler); + schedule_delayed_work(&drvdata->delayed_firmware_work, + msecs_to_jiffies(100)); + + return 0; + +failed_after_sysfs: + sysfs_remove_group(&hid_dev->dev.kobj, &corsair_void_attr_group); + return ret; +} + +static void corsair_void_remove(struct hid_device *hid_dev) +{ + struct corsair_void_drvdata *drvdata =3D hid_get_drvdata(hid_dev); + + hid_hw_stop(hid_dev); + cancel_work_sync(&drvdata->battery_remove_work); + cancel_work_sync(&drvdata->battery_add_work); + if (drvdata->battery) + power_supply_unregister(drvdata->battery); + + cancel_delayed_work_sync(&drvdata->delayed_firmware_work); + sysfs_remove_group(&hid_dev->dev.kobj, &corsair_void_attr_group); +} + +static int corsair_void_raw_event(struct hid_device *hid_dev, + struct hid_report *hid_report, + u8 *data, int size) +{ + struct corsair_void_drvdata *drvdata =3D hid_get_drvdata(hid_dev); + bool was_connected =3D drvdata->connected; + + /* Description of packets are documented at the top of this file */ + if (hid_report->id =3D=3D CORSAIR_VOID_STATUS_REPORT_ID) { + drvdata->mic_up =3D FIELD_GET(CORSAIR_VOID_MIC_MASK, data[2]); + drvdata->connected =3D (data[3] =3D=3D CORSAIR_VOID_WIRELESS_CONNECTED) = || + drvdata->is_wired; + + corsair_void_process_receiver(drvdata, + FIELD_GET(CORSAIR_VOID_CAPACITY_MASK, data[2]), + data[3], data[4]); + } else if (hid_report->id =3D=3D CORSAIR_VOID_FIRMWARE_REPORT_ID) { + drvdata->fw_receiver_major =3D data[1]; + drvdata->fw_receiver_minor =3D data[2]; + drvdata->fw_headset_major =3D data[3]; + drvdata->fw_headset_minor =3D data[4]; + } + + /* Handle wireless headset connect / disconnect */ + if ((was_connected !=3D drvdata->connected) && !drvdata->is_wired) { + if (drvdata->connected) + corsair_void_headset_connected(drvdata); + else + corsair_void_headset_disconnected(drvdata); + } + + return 0; +} + +static const struct hid_device_id corsair_void_devices[] =3D { + /* Corsair Void Wireless */ + CORSAIR_VOID_WIRELESS_DEVICE(0x0a0c), + CORSAIR_VOID_WIRELESS_DEVICE(0x0a2b), + CORSAIR_VOID_WIRELESS_DEVICE(0x1b23), + CORSAIR_VOID_WIRELESS_DEVICE(0x1b25), + CORSAIR_VOID_WIRELESS_DEVICE(0x1b27), + + /* Corsair Void USB */ + CORSAIR_VOID_WIRED_DEVICE(0x0a0f), + CORSAIR_VOID_WIRED_DEVICE(0x1b1c), + CORSAIR_VOID_WIRED_DEVICE(0x1b29), + CORSAIR_VOID_WIRED_DEVICE(0x1b2a), + + /* Corsair Void Surround */ + CORSAIR_VOID_WIRED_DEVICE(0x0a30), + CORSAIR_VOID_WIRED_DEVICE(0x0a31), + + /* Corsair Void Pro Wireless */ + CORSAIR_VOID_WIRELESS_DEVICE(0x0a14), + CORSAIR_VOID_WIRELESS_DEVICE(0x0a16), + CORSAIR_VOID_WIRELESS_DEVICE(0x0a1a), + + /* Corsair Void Pro USB */ + CORSAIR_VOID_WIRED_DEVICE(0x0a17), + CORSAIR_VOID_WIRED_DEVICE(0x0a1d), + + /* Corsair Void Pro Surround */ + CORSAIR_VOID_WIRED_DEVICE(0x0a18), + CORSAIR_VOID_WIRED_DEVICE(0x0a1e), + CORSAIR_VOID_WIRED_DEVICE(0x0a1f), + + /* Corsair Void Elite Wireless */ + CORSAIR_VOID_WIRELESS_DEVICE(0x0a51), + CORSAIR_VOID_WIRELESS_DEVICE(0x0a55), + CORSAIR_VOID_WIRELESS_DEVICE(0x0a75), + + /* Corsair Void Elite USB */ + CORSAIR_VOID_WIRED_DEVICE(0x0a52), + CORSAIR_VOID_WIRED_DEVICE(0x0a56), + + /* Corsair Void Elite Surround */ + CORSAIR_VOID_WIRED_DEVICE(0x0a53), + CORSAIR_VOID_WIRED_DEVICE(0x0a57), + + {} +}; + +MODULE_DEVICE_TABLE(hid, corsair_void_devices); + +static struct hid_driver corsair_void_driver =3D { + .name =3D "hid-corsair-void", + .id_table =3D corsair_void_devices, + .probe =3D corsair_void_probe, + .remove =3D corsair_void_remove, + .raw_event =3D corsair_void_raw_event, +}; + +module_hid_driver(corsair_void_driver); + +MODULE_LICENSE("GPL"); +MODULE_AUTHOR("Stuart Hayhurst "); +MODULE_DESCRIPTION("HID driver for Corsair Void headsets"); --=20 2.45.2