| Message ID | 20200822104401.60648-1-jaap.aarts1@gmail.com |
|---|---|
| State | New |
| Headers | show |
| Series | [V7] hwmon: add fan/pwm driver for corsair h100i platinum | expand |
Hello guenter and/or Barnabás (+ others), Sorry for me being slow on my last patch, since the previous reviews ware done within a week I just wanted to make sure this patch didnt slip under the radar. Let me know if there is anything still to do, I couldnt find anything I needed to do on my end once everything is satisfying, but if there is some final step I would appreciate if you let me know what that would be. Kind redards, Jaap Aarts On Sat, 22 Aug 2020 at 12:47, jaap aarts <jaap.aarts1@gmail.com> wrote: > > Adds fan/pwm support for H100i platinum. > Custom temp/fan curves are not supported. > > v7: > - redo memory management with regards to device setup. (no more use after > free, double frees, fixed sizeof) > - add myself to MAINTAINERS > - add documentation for this driver > > Signed-off-by: Jaap Aarts <jaap.aarts1@gmail.com> > --- > Documentation/hwmon/corsair_hydro_i_pro.rst | 54 ++ > MAINTAINERS | 6 + > drivers/hwmon/Kconfig | 7 + > drivers/hwmon/Makefile | 1 + > drivers/hwmon/corsair_hydro_i_pro.c | 719 ++++++++++++++++++++ > 5 files changed, 787 insertions(+) > create mode 100644 Documentation/hwmon/corsair_hydro_i_pro.rst > create mode 100644 drivers/hwmon/corsair_hydro_i_pro.c > > diff --git a/Documentation/hwmon/corsair_hydro_i_pro.rst b/Documentation/hwmon/corsair_hydro_i_pro.rst > new file mode 100644 > index 000000000000..17d90d1b8e33 > --- /dev/null > +++ b/Documentation/hwmon/corsair_hydro_i_pro.rst > @@ -0,0 +1,54 @@ > +.. SPDX-License-Identifier: GPL-2.0-or-later > + > +Kernel driver corsair_hydro_i_pro > +========================== > + > +Supported devices: > + > + * Corsair H100i pro > + > +Author: Jaap Aarts > + > +Description > +----------- > + > +This driver implements the hwmon interface for the corsair H100i pro. > +Suppor for more All In One liquid coolers(AIOs) from this product range > +should be supported, only testing and a new config should be required. > +These AIOs can be controlled via USB, with control over fans, pumps, RGB > +lighting, and temperature sensors. > +Currently only fans are supported, but no custom fan curves are supported. > +There is always one pump and 1-3 fans. > + > +The H100i pro configuration: > +fans: 2 > +minrpm: 200, > +maxrpm: 3000, > +maxpwm 100, > +device name: "corsair_H100i_pro", > + > +Usage Notes > +----------- > + > +Since it is a USB device, hotswapping is possible. The device is autodetected. > + > +Sysfs entries > +------------- > + > +======================= ===================================================================== > +fan[1-2]_input Connected fan rpm. > +fan[1-2]_target Sets fan speed target rpm, when writing and if fan_mode is not > + set to one returns -EINVAL. > + When reading, it reports the last value if it was set by the driver. > + When the mode is not set to 1 (manual) read value will be 0. > + Otherwise returns an error. > +fan[1-2]_min Reports the minimum rpm value. for the H100i pro this is 200 > +fan[1-2]_max Reports the maximum rpm value. for the H100i pro this is 3000 > + > +pwm[1-2] Sets the fan speed. Values from 0-100, when writing and if > + fan_mode is not set to one returns -EINVAL. > +pwm[1-2]_enable Set the mode for the fan. > + 0: no fan speed control (i.e. default fan profile) > + 1: manual fan control > + 2: default fan profile > +======================= ===================================================================== > diff --git a/MAINTAINERS b/MAINTAINERS > index f0068bceeb61..0e7553a0e2e5 100644 > --- a/MAINTAINERS > +++ b/MAINTAINERS > @@ -4461,6 +4461,12 @@ L: linux-hwmon@vger.kernel.org > S: Maintained > F: drivers/hwmon/corsair-cpro.c > > +CORSAIR-HYDRO-I-PRO HARDWARE MONITOR DRIVER > +M: Jaap Aarts <jaap.aarts1>@gmail.com> > +L: linux-hwmon@vger.kernel.org > +S: Maintained > +F: drivers/hwmon/corsair_hydro_i_pro.c > + > COSA/SRP SYNC SERIAL DRIVER > M: Jan "Yenya" Kasprzak <kas@fi.muni.cz> > S: Maintained > diff --git a/drivers/hwmon/Kconfig b/drivers/hwmon/Kconfig > index 8dc28b26916e..9a721659313f 100644 > --- a/drivers/hwmon/Kconfig > +++ b/drivers/hwmon/Kconfig > @@ -378,6 +378,13 @@ config SENSORS_ARM_SCPI > and power sensors available on ARM Ltd's SCP based platforms. The > actual number and type of sensors exported depend on the platform. > > +config SENSORS_CORSAIR_HYDRO_I_PRO > + tristate "Corsair hydro HXXXi pro driver" > + depends on USB > + help > + If you say yes here you get support for the corsair hydro HXXXi pro > + range of devices. > + > config SENSORS_ASB100 > tristate "Asus ASB100 Bach" > depends on X86 && I2C > diff --git a/drivers/hwmon/Makefile b/drivers/hwmon/Makefile > index a8f4b35b136b..3bad054054fe 100644 > --- a/drivers/hwmon/Makefile > +++ b/drivers/hwmon/Makefile > @@ -20,6 +20,7 @@ obj-$(CONFIG_SENSORS_W83793) += w83793.o > obj-$(CONFIG_SENSORS_W83795) += w83795.o > obj-$(CONFIG_SENSORS_W83781D) += w83781d.o > obj-$(CONFIG_SENSORS_W83791D) += w83791d.o > +obj-$(CONFIG_SENSORS_CORSAIR_HYDRO_I_PRO) += corsair_hydro_i_pro.o > > obj-$(CONFIG_SENSORS_AB8500) += abx500.o ab8500.o > obj-$(CONFIG_SENSORS_ABITUGURU) += abituguru.o > diff --git a/drivers/hwmon/corsair_hydro_i_pro.c b/drivers/hwmon/corsair_hydro_i_pro.c > new file mode 100644 > index 000000000000..42869f32a7bd > --- /dev/null > +++ b/drivers/hwmon/corsair_hydro_i_pro.c > @@ -0,0 +1,719 @@ > +// SPDX-License-Identifier: GPL-2.0-or-later > +/* > + * A hwmon driver for all corsair hyxro HXXXi pro all-in-one liquid coolers. > + * Copyright (c) Jaap Aarts 2020 > + * > + * Protocol partially reverse engineered by audiohacked > + * https://github.com/audiohacked/OpendriverLink > + */ > + > +/* > + * Supports following liquid coolers: > + * H100i platinum > + * > + * Other products should work with this driver with slight modification. > + * > + * Note: platinum is the codename name for pro within the driver, so H100i platinum = H100i pro. > + * But some products are actually called platinum, these are not intended to be supported (yet). > + * > + * Note: fan curve control has not been implemented > + */ > + > +#include <linux/errno.h> > +#include <linux/hwmon.h> > +#include <linux/kernel.h> > +#include <linux/module.h> > +#include <linux/slab.h> > +#include <linux/usb.h> > + > +struct device_config { > + const u16 vendor_id; > + const u16 product_id; > + const u8 fancount; > + const u16 rpm_min; > + const u16 rpm_max; > + const u8 pwm_max; > + const char *name; > + const struct hwmon_channel_info **hwmon_info; > +}; > + > +struct hydro_i_pro_device { > + struct usb_device *udev; > + > + const struct device_config *config; > + > + unsigned char *bulk_out_buffer; > + unsigned char *bulk_in_buffer; > + size_t bulk_out_size; > + size_t bulk_in_size; > + char bulk_in_endpointAddr; > + char bulk_out_endpointAddr; > + > + struct usb_interface *interface; /* the interface for this device */ > + struct mutex io_mutex; > +}; > + > +#define MAX_FAN_COUNT 2 > +#define MAX_PWM_CHANNEL_COUNT MAX_FAN_COUNT > + > +struct hwmon_data { > + struct hydro_i_pro_device *hdev; > + u8 channel_count; > + void *channel_data[MAX_PWM_CHANNEL_COUNT]; > +}; > + > +struct curve_point { > + u8 temp; > + u8 pwm; > +}; > + > +#define FAN_CURVE_COUNT 7 > + > +struct hwmon_fan_data { > + u8 fan_channel; > + u16 fan_target; > + u8 fan_pwm_target; > + u8 mode; > + struct curve_point curve[FAN_CURVE_COUNT]; > +}; > + > +static struct curve_point quiet_curve[FAN_CURVE_COUNT] = { > + { > + .temp = 0x1F, > + .pwm = 0x15, > + }, > + { > + .temp = 0x21, > + .pwm = 0x1E, > + }, > + { > + .temp = 0x24, > + .pwm = 0x25, > + }, > + { > + .temp = 0x27, > + .pwm = 0x2D, > + }, > + { > + .temp = 0x29, > + .pwm = 0x38, > + }, > + { > + .temp = 0x2C, > + .pwm = 0x4A, > + }, > + { > + .temp = 0x2F, > + .pwm = 0x64, > + }, > +}; > + > +#define DEFAULT_CURVE quiet_curve > + > +static const struct hwmon_channel_info *dual_fan[] = { > + HWMON_CHANNEL_INFO( > + fan, HWMON_F_INPUT | HWMON_F_TARGET | HWMON_F_MIN | HWMON_F_MAX, > + HWMON_F_INPUT | HWMON_F_TARGET | HWMON_F_MIN | HWMON_F_MAX), > + HWMON_CHANNEL_INFO(pwm, HWMON_PWM_INPUT | HWMON_PWM_ENABLE, > + HWMON_PWM_INPUT | HWMON_PWM_ENABLE), > + NULL > +}; > + > +static const struct device_config config_table[] = { > + { > + .fancount = 2, > + .rpm_min = 200, > + .rpm_max = 3000, > + .pwm_max = 100, > + .name = "corsair_H100i_pro", > + .hwmon_info = dual_fan, > + }, > +}; > + > +#define BULK_TIMEOUT 100 > + > +enum opcodes { > + PWM_FAN_CURVE_CMD = 0x40, > + PWM_GET_CURRENT_CMD = 0x41, > + PWM_FAN_TARGET_CMD = 0x42, > + RPM_FAN_TARGET_CMD = 0x43, > +}; > + > +#define SUCCES_LENGTH 3 > +#define SUCCES_CODE 0x12, 0x34 > + > +static bool check_succes(enum opcodes command, char ret[static SUCCES_LENGTH]) > +{ > + char success[SUCCES_LENGTH] = { command, SUCCES_CODE }; > + > + return memcmp(ret, success, SUCCES_LENGTH) == 0; > +} > + > +static int acquire_lock(struct hydro_i_pro_device *hdev) > +{ > + int retval = usb_autopm_get_interface(hdev->interface); > + > + if (retval) > + return retval; > + > + return mutex_lock_interruptible(&hdev->io_mutex); > +} > + > +static int transfer_usb(struct hydro_i_pro_device *hdev, > + unsigned char *send_buf, unsigned char *recv_buf, > + int send_len, int recv_len) > +{ > + int retval; > + int wrote; > + int sndpipe = usb_sndbulkpipe(hdev->udev, hdev->bulk_out_endpointAddr); > + int rcvpipe = usb_rcvbulkpipe(hdev->udev, hdev->bulk_in_endpointAddr); > + > + retval = usb_bulk_msg(hdev->udev, sndpipe, send_buf, send_len, &wrote, > + BULK_TIMEOUT); > + if (retval) > + return retval; > + if (wrote != send_len) > + return -EIO; > + > + retval = usb_bulk_msg(hdev->udev, rcvpipe, recv_buf, recv_len, &wrote, > + BULK_TIMEOUT); > + if (retval) > + return retval; > + if (wrote != recv_len) > + return -EIO; > + > + return 0; > +} > + > +static int set_fan_pwm_curve(struct hydro_i_pro_device *hdev, > + struct hwmon_fan_data *fan_data, > + struct curve_point point[static FAN_CURVE_COUNT]) > +{ > + int retval; > + unsigned char *send_buf = hdev->bulk_out_buffer; > + unsigned char *recv_buf = hdev->bulk_in_buffer; > + > + send_buf[0] = PWM_FAN_CURVE_CMD; > + send_buf[1] = fan_data->fan_channel; > + send_buf[2] = point[0].temp; > + send_buf[3] = point[1].temp; > + send_buf[4] = point[2].temp; > + send_buf[5] = point[3].temp; > + send_buf[6] = point[4].temp; > + send_buf[7] = point[5].temp; > + send_buf[8] = point[6].temp; > + send_buf[9] = point[0].pwm; > + send_buf[10] = point[1].pwm; > + send_buf[11] = point[2].pwm; > + send_buf[12] = point[3].pwm; > + send_buf[13] = point[4].pwm; > + send_buf[14] = point[5].pwm; > + send_buf[15] = point[6].pwm; > + > + retval = transfer_usb(hdev, send_buf, recv_buf, 16, 3); > + if (retval) > + return retval; > + > + if (!check_succes(send_buf[0], recv_buf)) { > + dev_warn( > + &hdev->udev->dev, > + "failed setting fan pwm/temp curve for %s on channel %d %d,%d,%d\n", > + hdev->config->name, fan_data->fan_channel, recv_buf[0], > + recv_buf[1], recv_buf[2]); > + return -EINVAL; > + } > + > + memcpy(fan_data->curve, point, sizeof(fan_data->curve)); > + > + return 0; > +} > + > +static int set_fan_target_rpm(struct hydro_i_pro_device *hdev, > + struct hwmon_fan_data *fan_data, u16 val) > +{ > + int retval; > + unsigned char *send_buf = hdev->bulk_out_buffer; > + unsigned char *recv_buf = hdev->bulk_in_buffer; > + > + send_buf[0] = RPM_FAN_TARGET_CMD; > + send_buf[1] = fan_data->fan_channel; > + send_buf[2] = (val >> 8); > + send_buf[3] = val; > + > + retval = transfer_usb(hdev, send_buf, recv_buf, 4, 3); > + if (retval) > + return retval; > + > + if (!check_succes(send_buf[0], recv_buf)) { > + dev_warn( > + &hdev->udev->dev, > + "failed setting fan rpm for %s on channel %d %d,%d,%d\n", > + hdev->config->name, fan_data->fan_channel, recv_buf[0], > + recv_buf[1], recv_buf[2]); > + return -EINVAL; > + } > + fan_data->fan_target = val; > + fan_data->fan_pwm_target = 0; > + > + return 0; > +} > + > +static int get_fan_current_rpm(struct hydro_i_pro_device *hdev, > + struct hwmon_fan_data *fan_data, long *val) > +{ > + int retval; > + unsigned char *send_buf = hdev->bulk_out_buffer; > + unsigned char *recv_buf = hdev->bulk_in_buffer; > + > + send_buf[0] = PWM_GET_CURRENT_CMD; > + send_buf[1] = fan_data->fan_channel; > + > + retval = transfer_usb(hdev, send_buf, recv_buf, 2, 6); > + if (retval) > + return retval; > + > + if (!check_succes(send_buf[0], recv_buf) || > + recv_buf[3] != fan_data->fan_channel) { > + dev_warn( > + &hdev->udev->dev, > + "failed retrieving fan pwm for %s on channel %d %d,%d,%d/%d\n", > + hdev->config->name, fan_data->fan_channel, recv_buf[0], > + recv_buf[1], recv_buf[2], recv_buf[3]); > + return -EINVAL; > + } > + > + *val = ((recv_buf[4]) << 8) + recv_buf[5]; > + return 0; > +} > + > +static int set_fan_target_pwm(struct hydro_i_pro_device *hdev, > + struct hwmon_fan_data *fan_data, u8 val) > +{ > + int retval; > + unsigned char *send_buf = hdev->bulk_out_buffer; > + unsigned char *recv_buf = hdev->bulk_in_buffer; > + > + send_buf[0] = PWM_FAN_TARGET_CMD; > + send_buf[1] = fan_data->fan_channel; > + send_buf[2] = val; > + > + retval = transfer_usb(hdev, send_buf, recv_buf, 3, 3); > + if (retval) > + return retval; > + > + if (!check_succes(send_buf[0], recv_buf)) { > + dev_warn( > + &hdev->udev->dev, > + "failed setting fan pwm for %s on channel %d %d,%d,%d\n", > + hdev->config->name, fan_data->fan_channel, recv_buf[0], > + recv_buf[1], recv_buf[2]); > + return -EINVAL; > + } > + fan_data->fan_target = 0; > + fan_data->fan_pwm_target = val; > + > + return 0; > +} > + > +static umode_t hwmon_is_visible(const void *d, enum hwmon_sensor_types type, > + u32 attr, int channel) > +{ > + switch (type) { > + case hwmon_fan: > + switch (attr) { > + case hwmon_fan_input: > + return 0444; > + case hwmon_fan_target: > + return 0644; > + case hwmon_fan_min: > + return 0444; > + case hwmon_fan_max: > + return 0444; > + default: > + break; > + } > + break; > + case hwmon_pwm: > + switch (attr) { > + case hwmon_pwm_input: > + return 0200; > + case hwmon_pwm_enable: > + return 0644; > + default: > + break; > + } > + break; > + default: > + break; > + } > + return 0; > +} > + > +static int hwmon_write(struct device *dev, enum hwmon_sensor_types type, > + u32 attr, int channel, long val) > +{ > + struct hwmon_data *data = dev_get_drvdata(dev); > + struct hydro_i_pro_device *hdev = data->hdev; > + struct hwmon_fan_data *fan_data; > + int retval = 0; > + > + switch (type) { > + case hwmon_fan: > + switch (attr) { > + case hwmon_fan_target: > + fan_data = data->channel_data[channel]; > + if (fan_data->mode != 1) > + return -EINVAL; > + > + val = clamp_val(val, hdev->config->rpm_min, > + hdev->config->rpm_max); > + > + retval = acquire_lock(hdev); > + if (retval) > + goto exit; > + > + retval = set_fan_target_rpm(hdev, fan_data, val); > + if (retval) > + goto cleanup; > + > + break; > + default: > + return -EINVAL; > + } > + break; > + case hwmon_pwm: > + switch (attr) { > + case hwmon_pwm_input: > + fan_data = data->channel_data[channel]; > + if (fan_data->mode != 1) > + return -EINVAL; > + > + val = clamp_val(val, 0, hdev->config->pwm_max); > + retval = acquire_lock(hdev); > + if (retval) > + goto exit; > + > + retval = set_fan_target_pwm(hdev, fan_data, val); > + if (retval) > + goto cleanup; > + > + break; > + case hwmon_pwm_enable: > + fan_data = data->channel_data[channel]; > + > + switch (val) { > + case 2: > + case 0: > + retval = acquire_lock(hdev); > + if (retval) > + goto exit; > + > + retval = set_fan_pwm_curve(hdev, fan_data, > + DEFAULT_CURVE); > + if (retval) > + goto cleanup; > + fan_data->mode = val; > + break; > + case 1: > + retval = acquire_lock(hdev); > + if (retval) > + goto exit; > + > + if (fan_data->fan_target != 0) { > + retval = set_fan_target_rpm( > + hdev, fan_data, > + fan_data->fan_target); > + if (retval) > + goto cleanup; > + } else if (fan_data->fan_pwm_target != 0) { > + retval = set_fan_target_pwm( > + hdev, fan_data, > + fan_data->fan_pwm_target); > + if (retval) > + goto cleanup; > + } > + fan_data->mode = 1; > + break; > + default: > + return -EINVAL; > + } > + break; > + default: > + return -EINVAL; > + } > + break; > + default: > + return -EINVAL; > + } > + > +cleanup: > + mutex_unlock(&hdev->io_mutex); > + usb_autopm_put_interface(hdev->interface); > +exit: > + return retval; > +} > + > +static int hwmon_read(struct device *dev, enum hwmon_sensor_types type, > + u32 attr, int channel, long *val) > +{ > + struct hwmon_data *data = dev_get_drvdata(dev); > + struct hydro_i_pro_device *hdev = data->hdev; > + struct hwmon_fan_data *fan_data; > + int retval = 0; > + > + switch (type) { > + case hwmon_fan: > + switch (attr) { > + case hwmon_fan_input: > + fan_data = data->channel_data[channel]; > + > + retval = acquire_lock(hdev); > + if (retval) > + goto exit; > + > + retval = get_fan_current_rpm(hdev, fan_data, val); > + break; > + case hwmon_fan_target: > + fan_data = data->channel_data[channel]; > + if (fan_data->mode != 1) { > + *val = 0; > + goto exit; > + } > + *val = fan_data->fan_target; > + goto exit; > + case hwmon_fan_min: > + *val = hdev->config->rpm_min; > + goto exit; > + case hwmon_fan_max: > + *val = hdev->config->rpm_max; > + goto exit; > + > + default: > + return -EINVAL; > + } > + break; > + case hwmon_pwm: > + switch (attr) { > + case hwmon_pwm_enable: > + fan_data = data->channel_data[channel]; > + *val = fan_data->mode; > + goto exit; > + default: > + return -EINVAL; > + } > + goto exit; > + > + default: > + return -EINVAL; > + } > + > + mutex_unlock(&hdev->io_mutex); > + usb_autopm_put_interface(hdev->interface); > +exit: > + return retval; > +} > + > +static const struct hwmon_ops i_pro_ops = { > + .is_visible = hwmon_is_visible, > + .read = hwmon_read, > + .write = hwmon_write, > +}; > + > +static int hwmon_init(struct hydro_i_pro_device *hdev) > +{ > + u8 fan_id; > + struct device *hwmon_dev; > + struct hwmon_fan_data *fan; > + struct hwmon_data *data; > + struct hwmon_chip_info *hwmon_info; > + > + data = devm_kzalloc(&hdev->udev->dev, sizeof(*data), GFP_KERNEL); > + if (!data) > + return -ENOMEM; > + hwmon_info = > + devm_kzalloc(&hdev->udev->dev, sizeof(*hwmon_info), GFP_KERNEL); > + if (!hwmon_info) { > + devm_kfree(&hdev->udev->dev, data); > + return -ENOMEM; > + } > + > + /* You did something bad!! Either adjust MAX_FAN_COUNT or the fancount for the config!*/ > + WARN_ON(hdev->config->fancount >= MAX_PWM_CHANNEL_COUNT); > + data->channel_count = > + clamp_val(hdev->config->fancount, 0, MAX_PWM_CHANNEL_COUNT); > + > + /* For each fan create a data channel a fan config entry and a pwm config entry */ > + for (fan_id = 0; fan_id < data->channel_count; fan_id++) { > + fan = devm_kzalloc(&hdev->udev->dev, sizeof(fan), GFP_KERNEL); > + if (!fan) > + return -ENOMEM; > + > + fan->fan_channel = fan_id; > + fan->mode = 0; > + data->channel_data[fan_id] = fan; > + } > + > + hwmon_info->ops = &i_pro_ops; > + hwmon_info->info = hdev->config->hwmon_info; > + > + data->hdev = hdev; > + hwmon_dev = devm_hwmon_device_register_with_info( > + &hdev->udev->dev, hdev->config->name, data, hwmon_info, NULL); > + if (IS_ERR(hwmon_dev)) > + return PTR_ERR(hwmon_dev); > + > + dev_info(&hdev->udev->dev, "setup hwmon for %s\n", hdev->config->name); > + return 0; > +} > + > +#define USB_VENDOR_ID_CORSAIR 0x1b1c > +#define USB_PRODUCT_ID_H100I_PRO 0x0c15 > +/* > + * Devices that work with this driver. > + * More devices should work, however none have been tested. > + */ > +static const struct usb_device_id astk_table[] = { > + { USB_DEVICE(USB_VENDOR_ID_CORSAIR, USB_PRODUCT_ID_H100I_PRO), > + .driver_info = (kernel_ulong_t)&config_table[0] }, > + {}, > +}; > + > +MODULE_DEVICE_TABLE(usb, astk_table); > + > +static int init_device(struct usb_device *udev) > +{ > + int retval; > + > + /* > + * This is needed because when running windows in a vm with proprietary driver > + * and you switch to this driver, the device will not respond unless you run this. > + */ > + retval = usb_control_msg(udev, usb_sndctrlpipe(udev, 0), 0x00, 0x40, > + 0xffff, 0x0000, 0, 0, 0); > + > + /*this always returns error, but it required for propper initialisation*/ > + if (retval != -EPIPE) > + return retval; > + > + return usb_control_msg(udev, usb_sndctrlpipe(udev, 0), 0x02, 0x40, > + 0x0002, 0x0000, 0, 0, 0); > +} > + > +static int deinit_device(struct usb_device *udev) > +{ > + return usb_control_msg(udev, usb_sndctrlpipe(udev, 0), 0x02, 0x40, > + 0x0004, 0x0000, 0, 0, 0); > +} > + > +static void astk_delete(struct hydro_i_pro_device *hdev) > +{ > + usb_put_intf(hdev->interface); > + mutex_destroy(&hdev->io_mutex); > + usb_put_dev(hdev->udev); > +} > + > +static int astk_probe(struct usb_interface *interface, > + const struct usb_device_id *id) > +{ > + struct usb_device *udev = usb_get_dev(interface_to_usbdev(interface)); > + struct hydro_i_pro_device *hdev; > + int retval; > + struct usb_endpoint_descriptor *bulk_in, *bulk_out; > + > + hdev = devm_kzalloc(&udev->dev, sizeof(*hdev), GFP_KERNEL); > + > + if (!hdev) { > + retval = -ENOMEM; > + goto exit; > + } > + > + hdev->config = (const struct device_config *)id->driver_info; > + /* You should set the driver_info to a pointer to the correct configuration!!*/ > + WARN_ON(!hdev->config); > + > + hdev->udev = udev; > + hdev->interface = usb_get_intf(interface); > + mutex_init(&hdev->io_mutex); > + > + retval = usb_find_common_endpoints(interface->cur_altsetting, &bulk_in, > + &bulk_out, NULL, NULL); > + if (retval) { > + astk_delete(hdev); > + goto exit; > + } > + > + /* > + * set up the endpoint information > + * use only the first bulk-in and bulk-out endpoints > + */ > + hdev->bulk_in_size = usb_endpoint_maxp(bulk_in); > + hdev->bulk_in_buffer = > + devm_kzalloc(&hdev->udev->dev, hdev->bulk_in_size, GFP_KERNEL); > + hdev->bulk_in_endpointAddr = bulk_in->bEndpointAddress; > + if (!hdev->bulk_in_buffer) { > + astk_delete(hdev); > + goto exit; > + } > + > + hdev->bulk_out_size = usb_endpoint_maxp(bulk_out); > + hdev->bulk_out_buffer = > + devm_kzalloc(&hdev->udev->dev, hdev->bulk_out_size, GFP_KERNEL); > + hdev->bulk_out_endpointAddr = bulk_out->bEndpointAddress; > + if (!hdev->bulk_out_buffer) { > + astk_delete(hdev); > + goto exit; > + } > + > + retval = init_device(hdev->udev); > + if (retval) { > + astk_delete(hdev); > + goto exit; > + } > + > + retval = hwmon_init(hdev); > + if (retval) { > + astk_delete(hdev); > + goto exit; > + } > + > + usb_set_intfdata(interface, hdev); > +exit: > + return retval; > +} > + > +static void astk_disconnect(struct usb_interface *interface) > +{ > + struct hydro_i_pro_device *hdev = usb_get_intfdata(interface); > + > + dev_info(&hdev->udev->dev, "removed hwmon for %s\n", > + hdev->config->name); > + deinit_device(hdev->udev); > + usb_set_intfdata(interface, NULL); > + astk_delete(hdev); > +} > + > +static int astk_resume(struct usb_interface *intf) > +{ > + return 0; > +} > + > +static int astk_suspend(struct usb_interface *intf, pm_message_t message) > +{ > + return 0; > +} > + > +static struct usb_driver hydro_i_pro_driver = { > + .name = "hydro_i_pro_device", > + .id_table = astk_table, > + .probe = astk_probe, > + .disconnect = astk_disconnect, > + .resume = astk_resume, > + .suspend = astk_suspend, > + .supports_autosuspend = 1, > +}; > + > +module_usb_driver(hydro_i_pro_driver); > + > +MODULE_LICENSE("GPL"); > +MODULE_AUTHOR("Jaap Aarts <jaap.aarts1@gmail.com>"); > +MODULE_DESCRIPTION("Corsair HXXXi pro device driver"); > -- > 2.28.0 >
I just want to make sure that I am not asking to review everything right now, or ever. If you do not want this driver in the kernel for one or another reason then, there is no reason to continue reviewing it. I also have no time presure to get this in so if you want to review this in a year or 10 that is probably also fine by me. (although I might not have acces to a device to test on in 10 years) Kind regards, Jaap Aarts On Tue, 8 Sep 2020 at 13:11, jaap aarts <jaap.aarts1@gmail.com> wrote: > > Most of these issues have already been adressed in previous patches, but > I do not mind going over them again. I dont expect you to remember every > detail of course. > > On Tue, 8 Sep 2020 at 04:36, Guenter Roeck <linux@roeck-us.net> wrote: > > I have a number of concerns with your patch. Just to give a quick summary, > > > > - I already mentioned a couple of times that the kernel is not in the business of defining > > fan curves. You eliminated nost, but one still remains. > > I cannot remove this last fan-curve, I would want this one removed as > well but there is no > way to "reset" the device as far as I know. I understand that this is > not ideal but there is > no way around this for now. This was addresed in V3 of this patch, I > asumed this was > fine because I did not receive any feedback about this in any of the > subsequent patches. > > > - pwm_enable values 0 and 2 do the same. That neither makes sense nor is acceptable. > > The documentation on the values for this states: > 0: no fan speed control (i.e. fan at full speed) > This is indeed not really what I do, I did not know the max PWM at the > time I could > have spend time figuring that out. I should have changed this when I > added those. > If I am going to send in another patch I will change this > > 2+: automatic fan speed control enabled > This clearly states automatic fan control, this is exactly what I do. > > > - There are various style issues with your code. checkpatch --strict will point to some > most checks are saying no `(` on the end of line, not according to the hwmon > submitting patches documentation: > Please align continuation lines with ‘(‘ on the previous line. > Implying that it is ok to end with `(` on a line. > > There is also an error indicationg "complex" macros need `()` surrounding it. > I also already mentioned this saying that I have no idea how this > should be fixed. > I have tried multiple ways of using this macro that would allow `()` > around the values > but all of these did not work and errord out in the compiler or gave > the wrong result. > > > of them, but there are others (such as goto to a label which just returns). > > > - check_succes() is quite ineffient (and, as I just noticed, misspelled). > > I do not think it maters that this is not extremely performant, I dont > see any way > of making it faster right now, but at least it is very clear in its > purpoise and how it works. > I can spend time trying to optimise it but it would probably end up > less readable. > If you already know how to make it faster please let me know, but I do not. > > > - The method to acquire and release mutex and calling usb_autopm_get_interface() > > compared to releasing the same is inconsistent. It optimizes error handling over > > clean code, which doesn't really make much sense and makes the code both > > difficult to review and error prone, especially if changes are ever made in the > > future. > > I really do not understand what you are getting at, I have one > function to acquire the lock > and device, and then I release both of them at the end of the function. > I can wrap the cleanup in a function too if that is what you are trying to say? > > > - The resume and suspend functions seem pretty pointless, since they are doing nothing. > > As said before, these are supposed to do nothing, they just need to > exist. I can remove them > but it will just disable autosuspend. > > > - There are variuos unacceptable backtraces pointing to (and expecting) bugs in the code. > > I can try to fix them, I dont know what you mean exactly, I have not > had any problems with > the driver myself. If you cannot run it send the backtraces and I can > see if I can fix them. > > > - At least some of the other messages, such as "setup hwmon for %s", are unaccpetable. > > - Error handling is sometimes improperly implemented. The point of using goto for > > error handling is to have it in one place. Yet, there is repeated code such as > > if (error) { > > do_something; > > goto exit; > > } > > ... > > exit: > > return; > > which completely defeats the purpose of unified error handling. > > From what I understand it is bad to jump over a return statement, so I > would have to do > something like this: > if (error){ > goto handle_error; > } > ... > goto exit //succesfull return > handle_error: > do_something; > exit: > return > > in order to not jump over the return here. Maybe the recomended way is to jump > over the return like this: > > if (error){ > goto handle_error; > } > ... > return //succesfull return > handle_error: > do_something; > return > > > There is more; this is just a start. Given the previous issues, where you kept > > arguing about things like the semaphores until you realized yourself that it was buggy, > > Sure I kept arguing about semaphores, because I didnt understand them > and was told > to use semaphores before. I was told to use semaphores, this was not > something of my > own creation. I thought using semaphores was the best way, because another linux > maintainer told me to use them. > > > I'll have to explore each of those cases one by one and spend a lot of time convincing > > you to consider changing your code. Unfortunately, I am severely time constraint and > > just don't have the time to do that right now. > > I asked before sending in this patch if there was anything I would > still have to change, > since I heard nothing back I assumed everything was ok. All of these > are not things > added by this new patch, you could have asked about them back then. > > Jaap Aarts > > > > Guenter > > > > > Kind redards, > > > > > > Jaap Aarts > > > > > > > > > On Sat, 22 Aug 2020 at 12:47, jaap aarts <jaap.aarts1@gmail.com> wrote: > > >> > > >> Adds fan/pwm support for H100i platinum. > > >> Custom temp/fan curves are not supported. > > >> > > >> v7: > > >> - redo memory management with regards to device setup. (no more use after > > >> free, double frees, fixed sizeof) > > >> - add myself to MAINTAINERS > > >> - add documentation for this driver > > >> > > >> Signed-off-by: Jaap Aarts <jaap.aarts1@gmail.com> > > >> --- > > >> Documentation/hwmon/corsair_hydro_i_pro.rst | 54 ++ > > >> MAINTAINERS | 6 + > > >> drivers/hwmon/Kconfig | 7 + > > >> drivers/hwmon/Makefile | 1 + > > >> drivers/hwmon/corsair_hydro_i_pro.c | 719 ++++++++++++++++++++ > > >> 5 files changed, 787 insertions(+) > > >> create mode 100644 Documentation/hwmon/corsair_hydro_i_pro.rst > > >> create mode 100644 drivers/hwmon/corsair_hydro_i_pro.c > > >> > > >> diff --git a/Documentation/hwmon/corsair_hydro_i_pro.rst b/Documentation/hwmon/corsair_hydro_i_pro.rst > > >> new file mode 100644 > > >> index 000000000000..17d90d1b8e33 > > >> --- /dev/null > > >> +++ b/Documentation/hwmon/corsair_hydro_i_pro.rst > > >> @@ -0,0 +1,54 @@ > > >> +.. SPDX-License-Identifier: GPL-2.0-or-later > > >> + > > >> +Kernel driver corsair_hydro_i_pro > > >> +========================== > > >> + > > >> +Supported devices: > > >> + > > >> + * Corsair H100i pro > > >> + > > >> +Author: Jaap Aarts > > >> + > > >> +Description > > >> +----------- > > >> + > > >> +This driver implements the hwmon interface for the corsair H100i pro. > > >> +Suppor for more All In One liquid coolers(AIOs) from this product range > > >> +should be supported, only testing and a new config should be required. > > >> +These AIOs can be controlled via USB, with control over fans, pumps, RGB > > >> +lighting, and temperature sensors. > > >> +Currently only fans are supported, but no custom fan curves are supported. > > >> +There is always one pump and 1-3 fans. > > >> + > > >> +The H100i pro configuration: > > >> +fans: 2 > > >> +minrpm: 200, > > >> +maxrpm: 3000, > > >> +maxpwm 100, > > >> +device name: "corsair_H100i_pro", > > >> + > > >> +Usage Notes > > >> +----------- > > >> + > > >> +Since it is a USB device, hotswapping is possible. The device is autodetected. > > >> + > > >> +Sysfs entries > > >> +------------- > > >> + > > >> +======================= ===================================================================== > > >> +fan[1-2]_input Connected fan rpm. > > >> +fan[1-2]_target Sets fan speed target rpm, when writing and if fan_mode is not > > >> + set to one returns -EINVAL. > > >> + When reading, it reports the last value if it was set by the driver. > > >> + When the mode is not set to 1 (manual) read value will be 0. > > >> + Otherwise returns an error. > > >> +fan[1-2]_min Reports the minimum rpm value. for the H100i pro this is 200 > > >> +fan[1-2]_max Reports the maximum rpm value. for the H100i pro this is 3000 > > >> + > > >> +pwm[1-2] Sets the fan speed. Values from 0-100, when writing and if > > >> + fan_mode is not set to one returns -EINVAL. > > >> +pwm[1-2]_enable Set the mode for the fan. > > >> + 0: no fan speed control (i.e. default fan profile) > > >> + 1: manual fan control > > >> + 2: default fan profile > > >> +======================= ===================================================================== > > >> diff --git a/MAINTAINERS b/MAINTAINERS > > >> index f0068bceeb61..0e7553a0e2e5 100644 > > >> --- a/MAINTAINERS > > >> +++ b/MAINTAINERS > > >> @@ -4461,6 +4461,12 @@ L: linux-hwmon@vger.kernel.org > > >> S: Maintained > > >> F: drivers/hwmon/corsair-cpro.c > > >> > > >> +CORSAIR-HYDRO-I-PRO HARDWARE MONITOR DRIVER > > >> +M: Jaap Aarts <jaap.aarts1>@gmail.com> > > >> +L: linux-hwmon@vger.kernel.org > > >> +S: Maintained > > >> +F: drivers/hwmon/corsair_hydro_i_pro.c > > >> + > > >> COSA/SRP SYNC SERIAL DRIVER > > >> M: Jan "Yenya" Kasprzak <kas@fi.muni.cz> > > >> S: Maintained > > >> diff --git a/drivers/hwmon/Kconfig b/drivers/hwmon/Kconfig > > >> index 8dc28b26916e..9a721659313f 100644 > > >> --- a/drivers/hwmon/Kconfig > > >> +++ b/drivers/hwmon/Kconfig > > >> @@ -378,6 +378,13 @@ config SENSORS_ARM_SCPI > > >> and power sensors available on ARM Ltd's SCP based platforms. The > > >> actual number and type of sensors exported depend on the platform. > > >> > > >> +config SENSORS_CORSAIR_HYDRO_I_PRO > > >> + tristate "Corsair hydro HXXXi pro driver" > > >> + depends on USB > > >> + help > > >> + If you say yes here you get support for the corsair hydro HXXXi pro > > >> + range of devices. > > >> + > > >> config SENSORS_ASB100 > > >> tristate "Asus ASB100 Bach" > > >> depends on X86 && I2C > > >> diff --git a/drivers/hwmon/Makefile b/drivers/hwmon/Makefile > > >> index a8f4b35b136b..3bad054054fe 100644 > > >> --- a/drivers/hwmon/Makefile > > >> +++ b/drivers/hwmon/Makefile > > >> @@ -20,6 +20,7 @@ obj-$(CONFIG_SENSORS_W83793) += w83793.o > > >> obj-$(CONFIG_SENSORS_W83795) += w83795.o > > >> obj-$(CONFIG_SENSORS_W83781D) += w83781d.o > > >> obj-$(CONFIG_SENSORS_W83791D) += w83791d.o > > >> +obj-$(CONFIG_SENSORS_CORSAIR_HYDRO_I_PRO) += corsair_hydro_i_pro.o > > >> > > >> obj-$(CONFIG_SENSORS_AB8500) += abx500.o ab8500.o > > >> obj-$(CONFIG_SENSORS_ABITUGURU) += abituguru.o > > >> diff --git a/drivers/hwmon/corsair_hydro_i_pro.c b/drivers/hwmon/corsair_hydro_i_pro.c > > >> new file mode 100644 > > >> index 000000000000..42869f32a7bd > > >> --- /dev/null > > >> +++ b/drivers/hwmon/corsair_hydro_i_pro.c > > >> @@ -0,0 +1,719 @@ > > >> +// SPDX-License-Identifier: GPL-2.0-or-later > > >> +/* > > >> + * A hwmon driver for all corsair hyxro HXXXi pro all-in-one liquid coolers. > > >> + * Copyright (c) Jaap Aarts 2020 > > >> + * > > >> + * Protocol partially reverse engineered by audiohacked > > >> + * https://github.com/audiohacked/OpendriverLink > > >> + */ > > >> + > > >> +/* > > >> + * Supports following liquid coolers: > > >> + * H100i platinum > > >> + * > > >> + * Other products should work with this driver with slight modification. > > >> + * > > >> + * Note: platinum is the codename name for pro within the driver, so H100i platinum = H100i pro. > > >> + * But some products are actually called platinum, these are not intended to be supported (yet). > > >> + * > > >> + * Note: fan curve control has not been implemented > > >> + */ > > >> + > > >> +#include <linux/errno.h> > > >> +#include <linux/hwmon.h> > > >> +#include <linux/kernel.h> > > >> +#include <linux/module.h> > > >> +#include <linux/slab.h> > > >> +#include <linux/usb.h> > > >> + > > >> +struct device_config { > > >> + const u16 vendor_id; > > >> + const u16 product_id; > > >> + const u8 fancount; > > >> + const u16 rpm_min; > > >> + const u16 rpm_max; > > >> + const u8 pwm_max; > > >> + const char *name; > > >> + const struct hwmon_channel_info **hwmon_info; > > >> +}; > > >> + > > >> +struct hydro_i_pro_device { > > >> + struct usb_device *udev; > > >> + > > >> + const struct device_config *config; > > >> + > > >> + unsigned char *bulk_out_buffer; > > >> + unsigned char *bulk_in_buffer; > > >> + size_t bulk_out_size; > > >> + size_t bulk_in_size; > > >> + char bulk_in_endpointAddr; > > >> + char bulk_out_endpointAddr; > > >> + > > >> + struct usb_interface *interface; /* the interface for this device */ > > >> + struct mutex io_mutex; > > >> +}; > > >> + > > >> +#define MAX_FAN_COUNT 2 > > >> +#define MAX_PWM_CHANNEL_COUNT MAX_FAN_COUNT > > >> + > > >> +struct hwmon_data { > > >> + struct hydro_i_pro_device *hdev; > > >> + u8 channel_count; > > >> + void *channel_data[MAX_PWM_CHANNEL_COUNT]; > > >> +}; > > >> + > > >> +struct curve_point { > > >> + u8 temp; > > >> + u8 pwm; > > >> +}; > > >> + > > >> +#define FAN_CURVE_COUNT 7 > > >> + > > >> +struct hwmon_fan_data { > > >> + u8 fan_channel; > > >> + u16 fan_target; > > >> + u8 fan_pwm_target; > > >> + u8 mode; > > >> + struct curve_point curve[FAN_CURVE_COUNT]; > > >> +}; > > >> + > > >> +static struct curve_point quiet_curve[FAN_CURVE_COUNT] = { > > >> + { > > >> + .temp = 0x1F, > > >> + .pwm = 0x15, > > >> + }, > > >> + { > > >> + .temp = 0x21, > > >> + .pwm = 0x1E, > > >> + }, > > >> + { > > >> + .temp = 0x24, > > >> + .pwm = 0x25, > > >> + }, > > >> + { > > >> + .temp = 0x27, > > >> + .pwm = 0x2D, > > >> + }, > > >> + { > > >> + .temp = 0x29, > > >> + .pwm = 0x38, > > >> + }, > > >> + { > > >> + .temp = 0x2C, > > >> + .pwm = 0x4A, > > >> + }, > > >> + { > > >> + .temp = 0x2F, > > >> + .pwm = 0x64, > > >> + }, > > >> +}; > > >> + > > >> +#define DEFAULT_CURVE quiet_curve > > >> + > > >> +static const struct hwmon_channel_info *dual_fan[] = { > > >> + HWMON_CHANNEL_INFO( > > >> + fan, HWMON_F_INPUT | HWMON_F_TARGET | HWMON_F_MIN | HWMON_F_MAX, > > >> + HWMON_F_INPUT | HWMON_F_TARGET | HWMON_F_MIN | HWMON_F_MAX), > > >> + HWMON_CHANNEL_INFO(pwm, HWMON_PWM_INPUT | HWMON_PWM_ENABLE, > > >> + HWMON_PWM_INPUT | HWMON_PWM_ENABLE), > > >> + NULL > > >> +}; > > >> + > > >> +static const struct device_config config_table[] = { > > >> + { > > >> + .fancount = 2, > > >> + .rpm_min = 200, > > >> + .rpm_max = 3000, > > >> + .pwm_max = 100, > > >> + .name = "corsair_H100i_pro", > > >> + .hwmon_info = dual_fan, > > >> + }, > > >> +}; > > >> + > > >> +#define BULK_TIMEOUT 100 > > >> + > > >> +enum opcodes { > > >> + PWM_FAN_CURVE_CMD = 0x40, > > >> + PWM_GET_CURRENT_CMD = 0x41, > > >> + PWM_FAN_TARGET_CMD = 0x42, > > >> + RPM_FAN_TARGET_CMD = 0x43, > > >> +}; > > >> + > > >> +#define SUCCES_LENGTH 3 > > >> +#define SUCCES_CODE 0x12, 0x34 > > >> + > > >> +static bool check_succes(enum opcodes command, char ret[static SUCCES_LENGTH]) > > >> +{ > > >> + char success[SUCCES_LENGTH] = { command, SUCCES_CODE }; > > >> + > > >> + return memcmp(ret, success, SUCCES_LENGTH) == 0; > > >> +} > > >> + > > >> +static int acquire_lock(struct hydro_i_pro_device *hdev) > > >> +{ > > >> + int retval = usb_autopm_get_interface(hdev->interface); > > >> + > > >> + if (retval) > > >> + return retval; > > >> + > > >> + return mutex_lock_interruptible(&hdev->io_mutex); > > >> +} > > >> + > > >> +static int transfer_usb(struct hydro_i_pro_device *hdev, > > >> + unsigned char *send_buf, unsigned char *recv_buf, > > >> + int send_len, int recv_len) > > >> +{ > > >> + int retval; > > >> + int wrote; > > >> + int sndpipe = usb_sndbulkpipe(hdev->udev, hdev->bulk_out_endpointAddr); > > >> + int rcvpipe = usb_rcvbulkpipe(hdev->udev, hdev->bulk_in_endpointAddr); > > >> + > > >> + retval = usb_bulk_msg(hdev->udev, sndpipe, send_buf, send_len, &wrote, > > >> + BULK_TIMEOUT); > > >> + if (retval) > > >> + return retval; > > >> + if (wrote != send_len) > > >> + return -EIO; > > >> + > > >> + retval = usb_bulk_msg(hdev->udev, rcvpipe, recv_buf, recv_len, &wrote, > > >> + BULK_TIMEOUT); > > >> + if (retval) > > >> + return retval; > > >> + if (wrote != recv_len) > > >> + return -EIO; > > >> + > > >> + return 0; > > >> +} > > >> + > > >> +static int set_fan_pwm_curve(struct hydro_i_pro_device *hdev, > > >> + struct hwmon_fan_data *fan_data, > > >> + struct curve_point point[static FAN_CURVE_COUNT]) > > >> +{ > > >> + int retval; > > >> + unsigned char *send_buf = hdev->bulk_out_buffer; > > >> + unsigned char *recv_buf = hdev->bulk_in_buffer; > > >> + > > >> + send_buf[0] = PWM_FAN_CURVE_CMD; > > >> + send_buf[1] = fan_data->fan_channel; > > >> + send_buf[2] = point[0].temp; > > >> + send_buf[3] = point[1].temp; > > >> + send_buf[4] = point[2].temp; > > >> + send_buf[5] = point[3].temp; > > >> + send_buf[6] = point[4].temp; > > >> + send_buf[7] = point[5].temp; > > >> + send_buf[8] = point[6].temp; > > >> + send_buf[9] = point[0].pwm; > > >> + send_buf[10] = point[1].pwm; > > >> + send_buf[11] = point[2].pwm; > > >> + send_buf[12] = point[3].pwm; > > >> + send_buf[13] = point[4].pwm; > > >> + send_buf[14] = point[5].pwm; > > >> + send_buf[15] = point[6].pwm; > > >> + > > >> + retval = transfer_usb(hdev, send_buf, recv_buf, 16, 3); > > >> + if (retval) > > >> + return retval; > > >> + > > >> + if (!check_succes(send_buf[0], recv_buf)) { > > >> + dev_warn( > > >> + &hdev->udev->dev, > > >> + "failed setting fan pwm/temp curve for %s on channel %d %d,%d,%d\n", > > >> + hdev->config->name, fan_data->fan_channel, recv_buf[0], > > >> + recv_buf[1], recv_buf[2]); > > >> + return -EINVAL; > > >> + } > > >> + > > >> + memcpy(fan_data->curve, point, sizeof(fan_data->curve)); > > >> + > > >> + return 0; > > >> +} > > >> + > > >> +static int set_fan_target_rpm(struct hydro_i_pro_device *hdev, > > >> + struct hwmon_fan_data *fan_data, u16 val) > > >> +{ > > >> + int retval; > > >> + unsigned char *send_buf = hdev->bulk_out_buffer; > > >> + unsigned char *recv_buf = hdev->bulk_in_buffer; > > >> + > > >> + send_buf[0] = RPM_FAN_TARGET_CMD; > > >> + send_buf[1] = fan_data->fan_channel; > > >> + send_buf[2] = (val >> 8); > > >> + send_buf[3] = val; > > >> + > > >> + retval = transfer_usb(hdev, send_buf, recv_buf, 4, 3); > > >> + if (retval) > > >> + return retval; > > >> + > > >> + if (!check_succes(send_buf[0], recv_buf)) { > > >> + dev_warn( > > >> + &hdev->udev->dev, > > >> + "failed setting fan rpm for %s on channel %d %d,%d,%d\n", > > >> + hdev->config->name, fan_data->fan_channel, recv_buf[0], > > >> + recv_buf[1], recv_buf[2]); > > >> + return -EINVAL; > > >> + } > > >> + fan_data->fan_target = val; > > >> + fan_data->fan_pwm_target = 0; > > >> + > > >> + return 0; > > >> +} > > >> + > > >> +static int get_fan_current_rpm(struct hydro_i_pro_device *hdev, > > >> + struct hwmon_fan_data *fan_data, long *val) > > >> +{ > > >> + int retval; > > >> + unsigned char *send_buf = hdev->bulk_out_buffer; > > >> + unsigned char *recv_buf = hdev->bulk_in_buffer; > > >> + > > >> + send_buf[0] = PWM_GET_CURRENT_CMD; > > >> + send_buf[1] = fan_data->fan_channel; > > >> + > > >> + retval = transfer_usb(hdev, send_buf, recv_buf, 2, 6); > > >> + if (retval) > > >> + return retval; > > >> + > > >> + if (!check_succes(send_buf[0], recv_buf) || > > >> + recv_buf[3] != fan_data->fan_channel) { > > >> + dev_warn( > > >> + &hdev->udev->dev, > > >> + "failed retrieving fan pwm for %s on channel %d %d,%d,%d/%d\n", > > >> + hdev->config->name, fan_data->fan_channel, recv_buf[0], > > >> + recv_buf[1], recv_buf[2], recv_buf[3]); > > >> + return -EINVAL; > > >> + } > > >> + > > >> + *val = ((recv_buf[4]) << 8) + recv_buf[5]; > > >> + return 0; > > >> +} > > >> + > > >> +static int set_fan_target_pwm(struct hydro_i_pro_device *hdev, > > >> + struct hwmon_fan_data *fan_data, u8 val) > > >> +{ > > >> + int retval; > > >> + unsigned char *send_buf = hdev->bulk_out_buffer; > > >> + unsigned char *recv_buf = hdev->bulk_in_buffer; > > >> + > > >> + send_buf[0] = PWM_FAN_TARGET_CMD; > > >> + send_buf[1] = fan_data->fan_channel; > > >> + send_buf[2] = val; > > >> + > > >> + retval = transfer_usb(hdev, send_buf, recv_buf, 3, 3); > > >> + if (retval) > > >> + return retval; > > >> + > > >> + if (!check_succes(send_buf[0], recv_buf)) { > > >> + dev_warn( > > >> + &hdev->udev->dev, > > >> + "failed setting fan pwm for %s on channel %d %d,%d,%d\n", > > >> + hdev->config->name, fan_data->fan_channel, recv_buf[0], > > >> + recv_buf[1], recv_buf[2]); > > >> + return -EINVAL; > > >> + } > > >> + fan_data->fan_target = 0; > > >> + fan_data->fan_pwm_target = val; > > >> + > > >> + return 0; > > >> +} > > >> + > > >> +static umode_t hwmon_is_visible(const void *d, enum hwmon_sensor_types type, > > >> + u32 attr, int channel) > > >> +{ > > >> + switch (type) { > > >> + case hwmon_fan: > > >> + switch (attr) { > > >> + case hwmon_fan_input: > > >> + return 0444; > > >> + case hwmon_fan_target: > > >> + return 0644; > > >> + case hwmon_fan_min: > > >> + return 0444; > > >> + case hwmon_fan_max: > > >> + return 0444; > > >> + default: > > >> + break; > > >> + } > > >> + break; > > >> + case hwmon_pwm: > > >> + switch (attr) { > > >> + case hwmon_pwm_input: > > >> + return 0200; > > >> + case hwmon_pwm_enable: > > >> + return 0644; > > >> + default: > > >> + break; > > >> + } > > >> + break; > > >> + default: > > >> + break; > > >> + } > > >> + return 0; > > >> +} > > >> + > > >> +static int hwmon_write(struct device *dev, enum hwmon_sensor_types type, > > >> + u32 attr, int channel, long val) > > >> +{ > > >> + struct hwmon_data *data = dev_get_drvdata(dev); > > >> + struct hydro_i_pro_device *hdev = data->hdev; > > >> + struct hwmon_fan_data *fan_data; > > >> + int retval = 0; > > >> + > > >> + switch (type) { > > >> + case hwmon_fan: > > >> + switch (attr) { > > >> + case hwmon_fan_target: > > >> + fan_data = data->channel_data[channel]; > > >> + if (fan_data->mode != 1) > > >> + return -EINVAL; > > >> + > > >> + val = clamp_val(val, hdev->config->rpm_min, > > >> + hdev->config->rpm_max); > > >> + > > >> + retval = acquire_lock(hdev); > > >> + if (retval) > > >> + goto exit; > > >> + > > >> + retval = set_fan_target_rpm(hdev, fan_data, val); > > >> + if (retval) > > >> + goto cleanup; > > >> + > > >> + break; > > >> + default: > > >> + return -EINVAL; > > >> + } > > >> + break; > > >> + case hwmon_pwm: > > >> + switch (attr) { > > >> + case hwmon_pwm_input: > > >> + fan_data = data->channel_data[channel]; > > >> + if (fan_data->mode != 1) > > >> + return -EINVAL; > > >> + > > >> + val = clamp_val(val, 0, hdev->config->pwm_max); > > >> + retval = acquire_lock(hdev); > > >> + if (retval) > > >> + goto exit; > > >> + > > >> + retval = set_fan_target_pwm(hdev, fan_data, val); > > >> + if (retval) > > >> + goto cleanup; > > >> + > > >> + break; > > >> + case hwmon_pwm_enable: > > >> + fan_data = data->channel_data[channel]; > > >> + > > >> + switch (val) { > > >> + case 2: > > >> + case 0: > > >> + retval = acquire_lock(hdev); > > >> + if (retval) > > >> + goto exit; > > >> + > > >> + retval = set_fan_pwm_curve(hdev, fan_data, > > >> + DEFAULT_CURVE); > > >> + if (retval) > > >> + goto cleanup; > > >> + fan_data->mode = val; > > >> + break; > > >> + case 1: > > >> + retval = acquire_lock(hdev); > > >> + if (retval) > > >> + goto exit; > > >> + > > >> + if (fan_data->fan_target != 0) { > > >> + retval = set_fan_target_rpm( > > >> + hdev, fan_data, > > >> + fan_data->fan_target); > > >> + if (retval) > > >> + goto cleanup; > > >> + } else if (fan_data->fan_pwm_target != 0) { > > >> + retval = set_fan_target_pwm( > > >> + hdev, fan_data, > > >> + fan_data->fan_pwm_target); > > >> + if (retval) > > >> + goto cleanup; > > >> + } > > >> + fan_data->mode = 1; > > >> + break; > > >> + default: > > >> + return -EINVAL; > > >> + } > > >> + break; > > >> + default: > > >> + return -EINVAL; > > >> + } > > >> + break; > > >> + default: > > >> + return -EINVAL; > > >> + } > > >> + > > >> +cleanup: > > >> + mutex_unlock(&hdev->io_mutex); > > >> + usb_autopm_put_interface(hdev->interface); > > >> +exit: > > >> + return retval; > > >> +} > > >> + > > >> +static int hwmon_read(struct device *dev, enum hwmon_sensor_types type, > > >> + u32 attr, int channel, long *val) > > >> +{ > > >> + struct hwmon_data *data = dev_get_drvdata(dev); > > >> + struct hydro_i_pro_device *hdev = data->hdev; > > >> + struct hwmon_fan_data *fan_data; > > >> + int retval = 0; > > >> + > > >> + switch (type) { > > >> + case hwmon_fan: > > >> + switch (attr) { > > >> + case hwmon_fan_input: > > >> + fan_data = data->channel_data[channel]; > > >> + > > >> + retval = acquire_lock(hdev); > > >> + if (retval) > > >> + goto exit; > > >> + > > >> + retval = get_fan_current_rpm(hdev, fan_data, val); > > >> + break; > > >> + case hwmon_fan_target: > > >> + fan_data = data->channel_data[channel]; > > >> + if (fan_data->mode != 1) { > > >> + *val = 0; > > >> + goto exit; > > >> + } > > >> + *val = fan_data->fan_target; > > >> + goto exit; > > >> + case hwmon_fan_min: > > >> + *val = hdev->config->rpm_min; > > >> + goto exit; > > >> + case hwmon_fan_max: > > >> + *val = hdev->config->rpm_max; > > >> + goto exit; > > >> + > > >> + default: > > >> + return -EINVAL; > > >> + } > > >> + break; > > >> + case hwmon_pwm: > > >> + switch (attr) { > > >> + case hwmon_pwm_enable: > > >> + fan_data = data->channel_data[channel]; > > >> + *val = fan_data->mode; > > >> + goto exit; > > >> + default: > > >> + return -EINVAL; > > >> + } > > >> + goto exit; > > >> + > > >> + default: > > >> + return -EINVAL; > > >> + } > > >> + > > >> + mutex_unlock(&hdev->io_mutex); > > >> + usb_autopm_put_interface(hdev->interface); > > >> +exit: > > >> + return retval; > > >> +} > > >> + > > >> +static const struct hwmon_ops i_pro_ops = { > > >> + .is_visible = hwmon_is_visible, > > >> + .read = hwmon_read, > > >> + .write = hwmon_write, > > >> +}; > > >> + > > >> +static int hwmon_init(struct hydro_i_pro_device *hdev) > > >> +{ > > >> + u8 fan_id; > > >> + struct device *hwmon_dev; > > >> + struct hwmon_fan_data *fan; > > >> + struct hwmon_data *data; > > >> + struct hwmon_chip_info *hwmon_info; > > >> + > > >> + data = devm_kzalloc(&hdev->udev->dev, sizeof(*data), GFP_KERNEL); > > >> + if (!data) > > >> + return -ENOMEM; > > >> + hwmon_info = > > >> + devm_kzalloc(&hdev->udev->dev, sizeof(*hwmon_info), GFP_KERNEL); > > >> + if (!hwmon_info) { > > >> + devm_kfree(&hdev->udev->dev, data); > > >> + return -ENOMEM; > > >> + } > > >> + > > >> + /* You did something bad!! Either adjust MAX_FAN_COUNT or the fancount for the config!*/ > > >> + WARN_ON(hdev->config->fancount >= MAX_PWM_CHANNEL_COUNT); > > >> + data->channel_count = > > >> + clamp_val(hdev->config->fancount, 0, MAX_PWM_CHANNEL_COUNT); > > >> + > > >> + /* For each fan create a data channel a fan config entry and a pwm config entry */ > > >> + for (fan_id = 0; fan_id < data->channel_count; fan_id++) { > > >> + fan = devm_kzalloc(&hdev->udev->dev, sizeof(fan), GFP_KERNEL); > > >> + if (!fan) > > >> + return -ENOMEM; > > >> + > > >> + fan->fan_channel = fan_id; > > >> + fan->mode = 0; > > >> + data->channel_data[fan_id] = fan; > > >> + } > > >> + > > >> + hwmon_info->ops = &i_pro_ops; > > >> + hwmon_info->info = hdev->config->hwmon_info; > > >> + > > >> + data->hdev = hdev; > > >> + hwmon_dev = devm_hwmon_device_register_with_info( > > >> + &hdev->udev->dev, hdev->config->name, data, hwmon_info, NULL); > > >> + if (IS_ERR(hwmon_dev)) > > >> + return PTR_ERR(hwmon_dev); > > >> + > > >> + dev_info(&hdev->udev->dev, "setup hwmon for %s\n", hdev->config->name); > > >> + return 0; > > >> +} > > >> + > > >> +#define USB_VENDOR_ID_CORSAIR 0x1b1c > > >> +#define USB_PRODUCT_ID_H100I_PRO 0x0c15 > > >> +/* > > >> + * Devices that work with this driver. > > >> + * More devices should work, however none have been tested. > > >> + */ > > >> +static const struct usb_device_id astk_table[] = { > > >> + { USB_DEVICE(USB_VENDOR_ID_CORSAIR, USB_PRODUCT_ID_H100I_PRO), > > >> + .driver_info = (kernel_ulong_t)&config_table[0] }, > > >> + {}, > > >> +}; > > >> + > > >> +MODULE_DEVICE_TABLE(usb, astk_table); > > >> + > > >> +static int init_device(struct usb_device *udev) > > >> +{ > > >> + int retval; > > >> + > > >> + /* > > >> + * This is needed because when running windows in a vm with proprietary driver > > >> + * and you switch to this driver, the device will not respond unless you run this. > > >> + */ > > >> + retval = usb_control_msg(udev, usb_sndctrlpipe(udev, 0), 0x00, 0x40, > > >> + 0xffff, 0x0000, 0, 0, 0); > > >> + > > >> + /*this always returns error, but it required for propper initialisation*/ > > >> + if (retval != -EPIPE) > > >> + return retval; > > >> + > > >> + return usb_control_msg(udev, usb_sndctrlpipe(udev, 0), 0x02, 0x40, > > >> + 0x0002, 0x0000, 0, 0, 0); > > >> +} > > >> + > > >> +static int deinit_device(struct usb_device *udev) > > >> +{ > > >> + return usb_control_msg(udev, usb_sndctrlpipe(udev, 0), 0x02, 0x40, > > >> + 0x0004, 0x0000, 0, 0, 0); > > >> +} > > >> + > > >> +static void astk_delete(struct hydro_i_pro_device *hdev) > > >> +{ > > >> + usb_put_intf(hdev->interface); > > >> + mutex_destroy(&hdev->io_mutex); > > >> + usb_put_dev(hdev->udev); > > >> +} > > >> + > > >> +static int astk_probe(struct usb_interface *interface, > > >> + const struct usb_device_id *id) > > >> +{ > > >> + struct usb_device *udev = usb_get_dev(interface_to_usbdev(interface)); > > >> + struct hydro_i_pro_device *hdev; > > >> + int retval; > > >> + struct usb_endpoint_descriptor *bulk_in, *bulk_out; > > >> + > > >> + hdev = devm_kzalloc(&udev->dev, sizeof(*hdev), GFP_KERNEL); > > >> + > > >> + if (!hdev) { > > >> + retval = -ENOMEM; > > >> + goto exit; > > >> + } > > >> + > > >> + hdev->config = (const struct device_config *)id->driver_info; > > >> + /* You should set the driver_info to a pointer to the correct configuration!!*/ > > >> + WARN_ON(!hdev->config); > > >> + > > >> + hdev->udev = udev; > > >> + hdev->interface = usb_get_intf(interface); > > >> + mutex_init(&hdev->io_mutex); > > >> + > > >> + retval = usb_find_common_endpoints(interface->cur_altsetting, &bulk_in, > > >> + &bulk_out, NULL, NULL); > > >> + if (retval) { > > >> + astk_delete(hdev); > > >> + goto exit; > > >> + } > > >> + > > >> + /* > > >> + * set up the endpoint information > > >> + * use only the first bulk-in and bulk-out endpoints > > >> + */ > > >> + hdev->bulk_in_size = usb_endpoint_maxp(bulk_in); > > >> + hdev->bulk_in_buffer = > > >> + devm_kzalloc(&hdev->udev->dev, hdev->bulk_in_size, GFP_KERNEL); > > >> + hdev->bulk_in_endpointAddr = bulk_in->bEndpointAddress; > > >> + if (!hdev->bulk_in_buffer) { > > >> + astk_delete(hdev); > > >> + goto exit; > > >> + } > > >> + > > >> + hdev->bulk_out_size = usb_endpoint_maxp(bulk_out); > > >> + hdev->bulk_out_buffer = > > >> + devm_kzalloc(&hdev->udev->dev, hdev->bulk_out_size, GFP_KERNEL); > > >> + hdev->bulk_out_endpointAddr = bulk_out->bEndpointAddress; > > >> + if (!hdev->bulk_out_buffer) { > > >> + astk_delete(hdev); > > >> + goto exit; > > >> + } > > >> + > > >> + retval = init_device(hdev->udev); > > >> + if (retval) { > > >> + astk_delete(hdev); > > >> + goto exit; > > >> + } > > >> + > > >> + retval = hwmon_init(hdev); > > >> + if (retval) { > > >> + astk_delete(hdev); > > >> + goto exit; > > >> + } > > >> + > > >> + usb_set_intfdata(interface, hdev); > > >> +exit: > > >> + return retval; > > >> +} > > >> + > > >> +static void astk_disconnect(struct usb_interface *interface) > > >> +{ > > >> + struct hydro_i_pro_device *hdev = usb_get_intfdata(interface); > > >> + > > >> + dev_info(&hdev->udev->dev, "removed hwmon for %s\n", > > >> + hdev->config->name); > > >> + deinit_device(hdev->udev); > > >> + usb_set_intfdata(interface, NULL); > > >> + astk_delete(hdev); > > >> +} > > >> + > > >> +static int astk_resume(struct usb_interface *intf) > > >> +{ > > >> + return 0; > > >> +} > > >> + > > >> +static int astk_suspend(struct usb_interface *intf, pm_message_t message) > > >> +{ > > >> + return 0; > > >> +} > > >> + > > >> +static struct usb_driver hydro_i_pro_driver = { > > >> + .name = "hydro_i_pro_device", > > >> + .id_table = astk_table, > > >> + .probe = astk_probe, > > >> + .disconnect = astk_disconnect, > > >> + .resume = astk_resume, > > >> + .suspend = astk_suspend, > > >> + .supports_autosuspend = 1, > > >> +}; > > >> + > > >> +module_usb_driver(hydro_i_pro_driver); > > >> + > > >> +MODULE_LICENSE("GPL"); > > >> +MODULE_AUTHOR("Jaap Aarts <jaap.aarts1@gmail.com>"); > > >> +MODULE_DESCRIPTION("Corsair HXXXi pro device driver"); > > >> -- > > >> 2.28.0 > > >> > >
diff --git a/Documentation/hwmon/corsair_hydro_i_pro.rst b/Documentation/hwmon/corsair_hydro_i_pro.rst new file mode 100644 index 000000000000..17d90d1b8e33 --- /dev/null +++ b/Documentation/hwmon/corsair_hydro_i_pro.rst @@ -0,0 +1,54 @@ +.. SPDX-License-Identifier: GPL-2.0-or-later + +Kernel driver corsair_hydro_i_pro +========================== + +Supported devices: + + * Corsair H100i pro + +Author: Jaap Aarts + +Description +----------- + +This driver implements the hwmon interface for the corsair H100i pro. +Suppor for more All In One liquid coolers(AIOs) from this product range +should be supported, only testing and a new config should be required. +These AIOs can be controlled via USB, with control over fans, pumps, RGB +lighting, and temperature sensors. +Currently only fans are supported, but no custom fan curves are supported. +There is always one pump and 1-3 fans. + +The H100i pro configuration: +fans: 2 +minrpm: 200, +maxrpm: 3000, +maxpwm 100, +device name: "corsair_H100i_pro", + +Usage Notes +----------- + +Since it is a USB device, hotswapping is possible. The device is autodetected. + +Sysfs entries +------------- + +======================= ===================================================================== +fan[1-2]_input Connected fan rpm. +fan[1-2]_target Sets fan speed target rpm, when writing and if fan_mode is not + set to one returns -EINVAL. + When reading, it reports the last value if it was set by the driver. + When the mode is not set to 1 (manual) read value will be 0. + Otherwise returns an error. +fan[1-2]_min Reports the minimum rpm value. for the H100i pro this is 200 +fan[1-2]_max Reports the maximum rpm value. for the H100i pro this is 3000 + +pwm[1-2] Sets the fan speed. Values from 0-100, when writing and if + fan_mode is not set to one returns -EINVAL. +pwm[1-2]_enable Set the mode for the fan. + 0: no fan speed control (i.e. default fan profile) + 1: manual fan control + 2: default fan profile +======================= ===================================================================== diff --git a/MAINTAINERS b/MAINTAINERS index f0068bceeb61..0e7553a0e2e5 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -4461,6 +4461,12 @@ L: linux-hwmon@vger.kernel.org S: Maintained F: drivers/hwmon/corsair-cpro.c +CORSAIR-HYDRO-I-PRO HARDWARE MONITOR DRIVER +M: Jaap Aarts <jaap.aarts1>@gmail.com> +L: linux-hwmon@vger.kernel.org +S: Maintained +F: drivers/hwmon/corsair_hydro_i_pro.c + COSA/SRP SYNC SERIAL DRIVER M: Jan "Yenya" Kasprzak <kas@fi.muni.cz> S: Maintained diff --git a/drivers/hwmon/Kconfig b/drivers/hwmon/Kconfig index 8dc28b26916e..9a721659313f 100644 --- a/drivers/hwmon/Kconfig +++ b/drivers/hwmon/Kconfig @@ -378,6 +378,13 @@ config SENSORS_ARM_SCPI and power sensors available on ARM Ltd's SCP based platforms. The actual number and type of sensors exported depend on the platform. +config SENSORS_CORSAIR_HYDRO_I_PRO + tristate "Corsair hydro HXXXi pro driver" + depends on USB + help + If you say yes here you get support for the corsair hydro HXXXi pro + range of devices. + config SENSORS_ASB100 tristate "Asus ASB100 Bach" depends on X86 && I2C diff --git a/drivers/hwmon/Makefile b/drivers/hwmon/Makefile index a8f4b35b136b..3bad054054fe 100644 --- a/drivers/hwmon/Makefile +++ b/drivers/hwmon/Makefile @@ -20,6 +20,7 @@ obj-$(CONFIG_SENSORS_W83793) += w83793.o obj-$(CONFIG_SENSORS_W83795) += w83795.o obj-$(CONFIG_SENSORS_W83781D) += w83781d.o obj-$(CONFIG_SENSORS_W83791D) += w83791d.o +obj-$(CONFIG_SENSORS_CORSAIR_HYDRO_I_PRO) += corsair_hydro_i_pro.o obj-$(CONFIG_SENSORS_AB8500) += abx500.o ab8500.o obj-$(CONFIG_SENSORS_ABITUGURU) += abituguru.o diff --git a/drivers/hwmon/corsair_hydro_i_pro.c b/drivers/hwmon/corsair_hydro_i_pro.c new file mode 100644 index 000000000000..42869f32a7bd --- /dev/null +++ b/drivers/hwmon/corsair_hydro_i_pro.c @@ -0,0 +1,719 @@ +// SPDX-License-Identifier: GPL-2.0-or-later +/* + * A hwmon driver for all corsair hyxro HXXXi pro all-in-one liquid coolers. + * Copyright (c) Jaap Aarts 2020 + * + * Protocol partially reverse engineered by audiohacked + * https://github.com/audiohacked/OpendriverLink + */ + +/* + * Supports following liquid coolers: + * H100i platinum + * + * Other products should work with this driver with slight modification. + * + * Note: platinum is the codename name for pro within the driver, so H100i platinum = H100i pro. + * But some products are actually called platinum, these are not intended to be supported (yet). + * + * Note: fan curve control has not been implemented + */ + +#include <linux/errno.h> +#include <linux/hwmon.h> +#include <linux/kernel.h> +#include <linux/module.h> +#include <linux/slab.h> +#include <linux/usb.h> + +struct device_config { + const u16 vendor_id; + const u16 product_id; + const u8 fancount; + const u16 rpm_min; + const u16 rpm_max; + const u8 pwm_max; + const char *name; + const struct hwmon_channel_info **hwmon_info; +}; + +struct hydro_i_pro_device { + struct usb_device *udev; + + const struct device_config *config; + + unsigned char *bulk_out_buffer; + unsigned char *bulk_in_buffer; + size_t bulk_out_size; + size_t bulk_in_size; + char bulk_in_endpointAddr; + char bulk_out_endpointAddr; + + struct usb_interface *interface; /* the interface for this device */ + struct mutex io_mutex; +}; + +#define MAX_FAN_COUNT 2 +#define MAX_PWM_CHANNEL_COUNT MAX_FAN_COUNT + +struct hwmon_data { + struct hydro_i_pro_device *hdev; + u8 channel_count; + void *channel_data[MAX_PWM_CHANNEL_COUNT]; +}; + +struct curve_point { + u8 temp; + u8 pwm; +}; + +#define FAN_CURVE_COUNT 7 + +struct hwmon_fan_data { + u8 fan_channel; + u16 fan_target; + u8 fan_pwm_target; + u8 mode; + struct curve_point curve[FAN_CURVE_COUNT]; +}; + +static struct curve_point quiet_curve[FAN_CURVE_COUNT] = { + { + .temp = 0x1F, + .pwm = 0x15, + }, + { + .temp = 0x21, + .pwm = 0x1E, + }, + { + .temp = 0x24, + .pwm = 0x25, + }, + { + .temp = 0x27, + .pwm = 0x2D, + }, + { + .temp = 0x29, + .pwm = 0x38, + }, + { + .temp = 0x2C, + .pwm = 0x4A, + }, + { + .temp = 0x2F, + .pwm = 0x64, + }, +}; + +#define DEFAULT_CURVE quiet_curve + +static const struct hwmon_channel_info *dual_fan[] = { + HWMON_CHANNEL_INFO( + fan, HWMON_F_INPUT | HWMON_F_TARGET | HWMON_F_MIN | HWMON_F_MAX, + HWMON_F_INPUT | HWMON_F_TARGET | HWMON_F_MIN | HWMON_F_MAX), + HWMON_CHANNEL_INFO(pwm, HWMON_PWM_INPUT | HWMON_PWM_ENABLE, + HWMON_PWM_INPUT | HWMON_PWM_ENABLE), + NULL +}; + +static const struct device_config config_table[] = { + { + .fancount = 2, + .rpm_min = 200, + .rpm_max = 3000, + .pwm_max = 100, + .name = "corsair_H100i_pro", + .hwmon_info = dual_fan, + }, +}; + +#define BULK_TIMEOUT 100 + +enum opcodes { + PWM_FAN_CURVE_CMD = 0x40, + PWM_GET_CURRENT_CMD = 0x41, + PWM_FAN_TARGET_CMD = 0x42, + RPM_FAN_TARGET_CMD = 0x43, +}; + +#define SUCCES_LENGTH 3 +#define SUCCES_CODE 0x12, 0x34 + +static bool check_succes(enum opcodes command, char ret[static SUCCES_LENGTH]) +{ + char success[SUCCES_LENGTH] = { command, SUCCES_CODE }; + + return memcmp(ret, success, SUCCES_LENGTH) == 0; +} + +static int acquire_lock(struct hydro_i_pro_device *hdev) +{ + int retval = usb_autopm_get_interface(hdev->interface); + + if (retval) + return retval; + + return mutex_lock_interruptible(&hdev->io_mutex); +} + +static int transfer_usb(struct hydro_i_pro_device *hdev, + unsigned char *send_buf, unsigned char *recv_buf, + int send_len, int recv_len) +{ + int retval; + int wrote; + int sndpipe = usb_sndbulkpipe(hdev->udev, hdev->bulk_out_endpointAddr); + int rcvpipe = usb_rcvbulkpipe(hdev->udev, hdev->bulk_in_endpointAddr); + + retval = usb_bulk_msg(hdev->udev, sndpipe, send_buf, send_len, &wrote, + BULK_TIMEOUT); + if (retval) + return retval; + if (wrote != send_len) + return -EIO; + + retval = usb_bulk_msg(hdev->udev, rcvpipe, recv_buf, recv_len, &wrote, + BULK_TIMEOUT); + if (retval) + return retval; + if (wrote != recv_len) + return -EIO; + + return 0; +} + +static int set_fan_pwm_curve(struct hydro_i_pro_device *hdev, + struct hwmon_fan_data *fan_data, + struct curve_point point[static FAN_CURVE_COUNT]) +{ + int retval; + unsigned char *send_buf = hdev->bulk_out_buffer; + unsigned char *recv_buf = hdev->bulk_in_buffer; + + send_buf[0] = PWM_FAN_CURVE_CMD; + send_buf[1] = fan_data->fan_channel; + send_buf[2] = point[0].temp; + send_buf[3] = point[1].temp; + send_buf[4] = point[2].temp; + send_buf[5] = point[3].temp; + send_buf[6] = point[4].temp; + send_buf[7] = point[5].temp; + send_buf[8] = point[6].temp; + send_buf[9] = point[0].pwm; + send_buf[10] = point[1].pwm; + send_buf[11] = point[2].pwm; + send_buf[12] = point[3].pwm; + send_buf[13] = point[4].pwm; + send_buf[14] = point[5].pwm; + send_buf[15] = point[6].pwm; + + retval = transfer_usb(hdev, send_buf, recv_buf, 16, 3); + if (retval) + return retval; + + if (!check_succes(send_buf[0], recv_buf)) { + dev_warn( + &hdev->udev->dev, + "failed setting fan pwm/temp curve for %s on channel %d %d,%d,%d\n", + hdev->config->name, fan_data->fan_channel, recv_buf[0], + recv_buf[1], recv_buf[2]); + return -EINVAL; + } + + memcpy(fan_data->curve, point, sizeof(fan_data->curve)); + + return 0; +} + +static int set_fan_target_rpm(struct hydro_i_pro_device *hdev, + struct hwmon_fan_data *fan_data, u16 val) +{ + int retval; + unsigned char *send_buf = hdev->bulk_out_buffer; + unsigned char *recv_buf = hdev->bulk_in_buffer; + + send_buf[0] = RPM_FAN_TARGET_CMD; + send_buf[1] = fan_data->fan_channel; + send_buf[2] = (val >> 8); + send_buf[3] = val; + + retval = transfer_usb(hdev, send_buf, recv_buf, 4, 3); + if (retval) + return retval; + + if (!check_succes(send_buf[0], recv_buf)) { + dev_warn( + &hdev->udev->dev, + "failed setting fan rpm for %s on channel %d %d,%d,%d\n", + hdev->config->name, fan_data->fan_channel, recv_buf[0], + recv_buf[1], recv_buf[2]); + return -EINVAL; + } + fan_data->fan_target = val; + fan_data->fan_pwm_target = 0; + + return 0; +} + +static int get_fan_current_rpm(struct hydro_i_pro_device *hdev, + struct hwmon_fan_data *fan_data, long *val) +{ + int retval; + unsigned char *send_buf = hdev->bulk_out_buffer; + unsigned char *recv_buf = hdev->bulk_in_buffer; + + send_buf[0] = PWM_GET_CURRENT_CMD; + send_buf[1] = fan_data->fan_channel; + + retval = transfer_usb(hdev, send_buf, recv_buf, 2, 6); + if (retval) + return retval; + + if (!check_succes(send_buf[0], recv_buf) || + recv_buf[3] != fan_data->fan_channel) { + dev_warn( + &hdev->udev->dev, + "failed retrieving fan pwm for %s on channel %d %d,%d,%d/%d\n", + hdev->config->name, fan_data->fan_channel, recv_buf[0], + recv_buf[1], recv_buf[2], recv_buf[3]); + return -EINVAL; + } + + *val = ((recv_buf[4]) << 8) + recv_buf[5]; + return 0; +} + +static int set_fan_target_pwm(struct hydro_i_pro_device *hdev, + struct hwmon_fan_data *fan_data, u8 val) +{ + int retval; + unsigned char *send_buf = hdev->bulk_out_buffer; + unsigned char *recv_buf = hdev->bulk_in_buffer; + + send_buf[0] = PWM_FAN_TARGET_CMD; + send_buf[1] = fan_data->fan_channel; + send_buf[2] = val; + + retval = transfer_usb(hdev, send_buf, recv_buf, 3, 3); + if (retval) + return retval; + + if (!check_succes(send_buf[0], recv_buf)) { + dev_warn( + &hdev->udev->dev, + "failed setting fan pwm for %s on channel %d %d,%d,%d\n", + hdev->config->name, fan_data->fan_channel, recv_buf[0], + recv_buf[1], recv_buf[2]); + return -EINVAL; + } + fan_data->fan_target = 0; + fan_data->fan_pwm_target = val; + + return 0; +} + +static umode_t hwmon_is_visible(const void *d, enum hwmon_sensor_types type, + u32 attr, int channel) +{ + switch (type) { + case hwmon_fan: + switch (attr) { + case hwmon_fan_input: + return 0444; + case hwmon_fan_target: + return 0644; + case hwmon_fan_min: + return 0444; + case hwmon_fan_max: + return 0444; + default: + break; + } + break; + case hwmon_pwm: + switch (attr) { + case hwmon_pwm_input: + return 0200; + case hwmon_pwm_enable: + return 0644; + default: + break; + } + break; + default: + break; + } + return 0; +} + +static int hwmon_write(struct device *dev, enum hwmon_sensor_types type, + u32 attr, int channel, long val) +{ + struct hwmon_data *data = dev_get_drvdata(dev); + struct hydro_i_pro_device *hdev = data->hdev; + struct hwmon_fan_data *fan_data; + int retval = 0; + + switch (type) { + case hwmon_fan: + switch (attr) { + case hwmon_fan_target: + fan_data = data->channel_data[channel]; + if (fan_data->mode != 1) + return -EINVAL; + + val = clamp_val(val, hdev->config->rpm_min, + hdev->config->rpm_max); + + retval = acquire_lock(hdev); + if (retval) + goto exit; + + retval = set_fan_target_rpm(hdev, fan_data, val); + if (retval) + goto cleanup; + + break; + default: + return -EINVAL; + } + break; + case hwmon_pwm: + switch (attr) { + case hwmon_pwm_input: + fan_data = data->channel_data[channel]; + if (fan_data->mode != 1) + return -EINVAL; + + val = clamp_val(val, 0, hdev->config->pwm_max); + retval = acquire_lock(hdev); + if (retval) + goto exit; + + retval = set_fan_target_pwm(hdev, fan_data, val); + if (retval) + goto cleanup; + + break; + case hwmon_pwm_enable: + fan_data = data->channel_data[channel]; + + switch (val) { + case 2: + case 0: + retval = acquire_lock(hdev); + if (retval) + goto exit; + + retval = set_fan_pwm_curve(hdev, fan_data, + DEFAULT_CURVE); + if (retval) + goto cleanup; + fan_data->mode = val; + break; + case 1: + retval = acquire_lock(hdev); + if (retval) + goto exit; + + if (fan_data->fan_target != 0) { + retval = set_fan_target_rpm( + hdev, fan_data, + fan_data->fan_target); + if (retval) + goto cleanup; + } else if (fan_data->fan_pwm_target != 0) { + retval = set_fan_target_pwm( + hdev, fan_data, + fan_data->fan_pwm_target); + if (retval) + goto cleanup; + } + fan_data->mode = 1; + break; + default: + return -EINVAL; + } + break; + default: + return -EINVAL; + } + break; + default: + return -EINVAL; + } + +cleanup: + mutex_unlock(&hdev->io_mutex); + usb_autopm_put_interface(hdev->interface); +exit: + return retval; +} + +static int hwmon_read(struct device *dev, enum hwmon_sensor_types type, + u32 attr, int channel, long *val) +{ + struct hwmon_data *data = dev_get_drvdata(dev); + struct hydro_i_pro_device *hdev = data->hdev; + struct hwmon_fan_data *fan_data; + int retval = 0; + + switch (type) { + case hwmon_fan: + switch (attr) { + case hwmon_fan_input: + fan_data = data->channel_data[channel]; + + retval = acquire_lock(hdev); + if (retval) + goto exit; + + retval = get_fan_current_rpm(hdev, fan_data, val); + break; + case hwmon_fan_target: + fan_data = data->channel_data[channel]; + if (fan_data->mode != 1) { + *val = 0; + goto exit; + } + *val = fan_data->fan_target; + goto exit; + case hwmon_fan_min: + *val = hdev->config->rpm_min; + goto exit; + case hwmon_fan_max: + *val = hdev->config->rpm_max; + goto exit; + + default: + return -EINVAL; + } + break; + case hwmon_pwm: + switch (attr) { + case hwmon_pwm_enable: + fan_data = data->channel_data[channel]; + *val = fan_data->mode; + goto exit; + default: + return -EINVAL; + } + goto exit; + + default: + return -EINVAL; + } + + mutex_unlock(&hdev->io_mutex); + usb_autopm_put_interface(hdev->interface); +exit: + return retval; +} + +static const struct hwmon_ops i_pro_ops = { + .is_visible = hwmon_is_visible, + .read = hwmon_read, + .write = hwmon_write, +}; + +static int hwmon_init(struct hydro_i_pro_device *hdev) +{ + u8 fan_id; + struct device *hwmon_dev; + struct hwmon_fan_data *fan; + struct hwmon_data *data; + struct hwmon_chip_info *hwmon_info; + + data = devm_kzalloc(&hdev->udev->dev, sizeof(*data), GFP_KERNEL); + if (!data) + return -ENOMEM; + hwmon_info = + devm_kzalloc(&hdev->udev->dev, sizeof(*hwmon_info), GFP_KERNEL); + if (!hwmon_info) { + devm_kfree(&hdev->udev->dev, data); + return -ENOMEM; + } + + /* You did something bad!! Either adjust MAX_FAN_COUNT or the fancount for the config!*/ + WARN_ON(hdev->config->fancount >= MAX_PWM_CHANNEL_COUNT); + data->channel_count = + clamp_val(hdev->config->fancount, 0, MAX_PWM_CHANNEL_COUNT); + + /* For each fan create a data channel a fan config entry and a pwm config entry */ + for (fan_id = 0; fan_id < data->channel_count; fan_id++) { + fan = devm_kzalloc(&hdev->udev->dev, sizeof(fan), GFP_KERNEL); + if (!fan) + return -ENOMEM; + + fan->fan_channel = fan_id; + fan->mode = 0; + data->channel_data[fan_id] = fan; + } + + hwmon_info->ops = &i_pro_ops; + hwmon_info->info = hdev->config->hwmon_info; + + data->hdev = hdev; + hwmon_dev = devm_hwmon_device_register_with_info( + &hdev->udev->dev, hdev->config->name, data, hwmon_info, NULL); + if (IS_ERR(hwmon_dev)) + return PTR_ERR(hwmon_dev); + + dev_info(&hdev->udev->dev, "setup hwmon for %s\n", hdev->config->name); + return 0; +} + +#define USB_VENDOR_ID_CORSAIR 0x1b1c +#define USB_PRODUCT_ID_H100I_PRO 0x0c15 +/* + * Devices that work with this driver. + * More devices should work, however none have been tested. + */ +static const struct usb_device_id astk_table[] = { + { USB_DEVICE(USB_VENDOR_ID_CORSAIR, USB_PRODUCT_ID_H100I_PRO), + .driver_info = (kernel_ulong_t)&config_table[0] }, + {}, +}; + +MODULE_DEVICE_TABLE(usb, astk_table); + +static int init_device(struct usb_device *udev) +{ + int retval; + + /* + * This is needed because when running windows in a vm with proprietary driver + * and you switch to this driver, the device will not respond unless you run this. + */ + retval = usb_control_msg(udev, usb_sndctrlpipe(udev, 0), 0x00, 0x40, + 0xffff, 0x0000, 0, 0, 0); + + /*this always returns error, but it required for propper initialisation*/ + if (retval != -EPIPE) + return retval; + + return usb_control_msg(udev, usb_sndctrlpipe(udev, 0), 0x02, 0x40, + 0x0002, 0x0000, 0, 0, 0); +} + +static int deinit_device(struct usb_device *udev) +{ + return usb_control_msg(udev, usb_sndctrlpipe(udev, 0), 0x02, 0x40, + 0x0004, 0x0000, 0, 0, 0); +} + +static void astk_delete(struct hydro_i_pro_device *hdev) +{ + usb_put_intf(hdev->interface); + mutex_destroy(&hdev->io_mutex); + usb_put_dev(hdev->udev); +} + +static int astk_probe(struct usb_interface *interface, + const struct usb_device_id *id) +{ + struct usb_device *udev = usb_get_dev(interface_to_usbdev(interface)); + struct hydro_i_pro_device *hdev; + int retval; + struct usb_endpoint_descriptor *bulk_in, *bulk_out; + + hdev = devm_kzalloc(&udev->dev, sizeof(*hdev), GFP_KERNEL); + + if (!hdev) { + retval = -ENOMEM; + goto exit; + } + + hdev->config = (const struct device_config *)id->driver_info; + /* You should set the driver_info to a pointer to the correct configuration!!*/ + WARN_ON(!hdev->config); + + hdev->udev = udev; + hdev->interface = usb_get_intf(interface); + mutex_init(&hdev->io_mutex); + + retval = usb_find_common_endpoints(interface->cur_altsetting, &bulk_in, + &bulk_out, NULL, NULL); + if (retval) { + astk_delete(hdev); + goto exit; + } + + /* + * set up the endpoint information + * use only the first bulk-in and bulk-out endpoints + */ + hdev->bulk_in_size = usb_endpoint_maxp(bulk_in); + hdev->bulk_in_buffer = + devm_kzalloc(&hdev->udev->dev, hdev->bulk_in_size, GFP_KERNEL); + hdev->bulk_in_endpointAddr = bulk_in->bEndpointAddress; + if (!hdev->bulk_in_buffer) { + astk_delete(hdev); + goto exit; + } + + hdev->bulk_out_size = usb_endpoint_maxp(bulk_out); + hdev->bulk_out_buffer = + devm_kzalloc(&hdev->udev->dev, hdev->bulk_out_size, GFP_KERNEL); + hdev->bulk_out_endpointAddr = bulk_out->bEndpointAddress; + if (!hdev->bulk_out_buffer) { + astk_delete(hdev); + goto exit; + } + + retval = init_device(hdev->udev); + if (retval) { + astk_delete(hdev); + goto exit; + } + + retval = hwmon_init(hdev); + if (retval) { + astk_delete(hdev); + goto exit; + } + + usb_set_intfdata(interface, hdev); +exit: + return retval; +} + +static void astk_disconnect(struct usb_interface *interface) +{ + struct hydro_i_pro_device *hdev = usb_get_intfdata(interface); + + dev_info(&hdev->udev->dev, "removed hwmon for %s\n", + hdev->config->name); + deinit_device(hdev->udev); + usb_set_intfdata(interface, NULL); + astk_delete(hdev); +} + +static int astk_resume(struct usb_interface *intf) +{ + return 0; +} + +static int astk_suspend(struct usb_interface *intf, pm_message_t message) +{ + return 0; +} + +static struct usb_driver hydro_i_pro_driver = { + .name = "hydro_i_pro_device", + .id_table = astk_table, + .probe = astk_probe, + .disconnect = astk_disconnect, + .resume = astk_resume, + .suspend = astk_suspend, + .supports_autosuspend = 1, +}; + +module_usb_driver(hydro_i_pro_driver); + +MODULE_LICENSE("GPL"); +MODULE_AUTHOR("Jaap Aarts <jaap.aarts1@gmail.com>"); +MODULE_DESCRIPTION("Corsair HXXXi pro device driver");
Adds fan/pwm support for H100i platinum. Custom temp/fan curves are not supported. v7: - redo memory management with regards to device setup. (no more use after free, double frees, fixed sizeof) - add myself to MAINTAINERS - add documentation for this driver Signed-off-by: Jaap Aarts <jaap.aarts1@gmail.com> --- Documentation/hwmon/corsair_hydro_i_pro.rst | 54 ++ MAINTAINERS | 6 + drivers/hwmon/Kconfig | 7 + drivers/hwmon/Makefile | 1 + drivers/hwmon/corsair_hydro_i_pro.c | 719 ++++++++++++++++++++ 5 files changed, 787 insertions(+) create mode 100644 Documentation/hwmon/corsair_hydro_i_pro.rst create mode 100644 drivers/hwmon/corsair_hydro_i_pro.c