1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * HWMON driver for ASUS B550/X570 motherboards that publish sensor
4 * values via the embedded controller registers.
6 * Copyright (C) 2021 Eugene Shalygin <eugene.shalygin@gmail.com>
7 * Copyright (C) 2018-2019 Ed Brindley <kernel@maidavale.org>
10 * - Chipset temperature
12 * - Motherboard temperature
13 * - T_Sensor temperature
15 * - Water In temperature
16 * - Water Out temperature
17 * - CPU Optional Fan RPM
19 * - Water Flow Fan RPM
23 #include <linux/acpi.h>
24 #include <linux/dmi.h>
25 #include <linux/hwmon.h>
26 #include <linux/init.h>
27 #include <linux/jiffies.h>
28 #include <linux/kernel.h>
29 #include <linux/module.h>
30 #include <linux/mutex.h>
31 #include <linux/nls.h>
32 #include <linux/units.h>
33 #include <linux/wmi.h>
35 #include <asm/unaligned.h>
37 #define ASUSWMI_MONITORING_GUID "466747A0-70EC-11DE-8A39-0800200C9A66"
38 #define ASUSWMI_METHODID_BLOCK_READ_EC 0x42524543 /* BREC */
39 /* From the ASUS DSDT source */
40 #define ASUSWMI_BREC_REGISTERS_MAX 16
41 #define ASUSWMI_MAX_BUF_LEN 128
42 #define SENSOR_LABEL_LEN 16
44 static u32 hwmon_attributes[hwmon_max] = {
45 [hwmon_chip] = HWMON_C_REGISTER_TZ,
46 [hwmon_temp] = HWMON_T_INPUT | HWMON_T_LABEL,
47 [hwmon_in] = HWMON_I_INPUT | HWMON_I_LABEL,
48 [hwmon_curr] = HWMON_C_INPUT | HWMON_C_LABEL,
49 [hwmon_fan] = HWMON_F_INPUT | HWMON_F_LABEL,
52 struct asus_wmi_ec_sensor_address {
58 #define MAKE_SENSOR_ADDRESS(size_i, bank_i, index_i) { \
64 struct ec_sensor_info {
65 struct asus_wmi_ec_sensor_address addr;
66 char label[SENSOR_LABEL_LEN];
67 enum hwmon_sensor_types type;
70 #define EC_SENSOR(sensor_label, sensor_type, size, bank, index) { \
71 .addr = MAKE_SENSOR_ADDRESS(size, bank, index), \
72 .label = sensor_label, \
73 .type = sensor_type, \
76 enum known_ec_sensor {
85 SENSOR_FAN_WATER_FLOW,
88 SENSOR_TEMP_WATER_OUT,
92 /* All known sensors for ASUS EC controllers */
93 static const struct ec_sensor_info known_ec_sensors[] = {
94 [SENSOR_TEMP_CHIPSET] = EC_SENSOR("Chipset", hwmon_temp, 1, 0x00, 0x3a),
95 [SENSOR_TEMP_CPU] = EC_SENSOR("CPU", hwmon_temp, 1, 0x00, 0x3b),
96 [SENSOR_TEMP_MB] = EC_SENSOR("Motherboard", hwmon_temp, 1, 0x00, 0x3c),
97 [SENSOR_TEMP_T_SENSOR] = EC_SENSOR("T_Sensor", hwmon_temp, 1, 0x00, 0x3d),
98 [SENSOR_TEMP_VRM] = EC_SENSOR("VRM", hwmon_temp, 1, 0x00, 0x3e),
99 [SENSOR_FAN_CPU_OPT] = EC_SENSOR("CPU_Opt", hwmon_fan, 2, 0x00, 0xb0),
100 [SENSOR_FAN_VRM_HS] = EC_SENSOR("VRM HS", hwmon_fan, 2, 0x00, 0xb2),
101 [SENSOR_FAN_CHIPSET] = EC_SENSOR("Chipset", hwmon_fan, 2, 0x00, 0xb4),
102 [SENSOR_FAN_WATER_FLOW] = EC_SENSOR("Water_Flow", hwmon_fan, 2, 0x00, 0xbc),
103 [SENSOR_CURR_CPU] = EC_SENSOR("CPU", hwmon_curr, 1, 0x00, 0xf4),
104 [SENSOR_TEMP_WATER_IN] = EC_SENSOR("Water_In", hwmon_temp, 1, 0x01, 0x00),
105 [SENSOR_TEMP_WATER_OUT] = EC_SENSOR("Water_Out", hwmon_temp, 1, 0x01, 0x01),
108 struct asus_wmi_data {
109 const enum known_ec_sensor known_board_sensors[SENSOR_MAX + 1];
112 /* boards with EC support */
113 static struct asus_wmi_data sensors_board_PW_X570_P = {
114 .known_board_sensors = {
115 SENSOR_TEMP_CHIPSET, SENSOR_TEMP_CPU, SENSOR_TEMP_MB, SENSOR_TEMP_VRM,
121 static struct asus_wmi_data sensors_board_PW_X570_A = {
122 .known_board_sensors = {
123 SENSOR_TEMP_CHIPSET, SENSOR_TEMP_CPU, SENSOR_TEMP_MB, SENSOR_TEMP_VRM,
130 static struct asus_wmi_data sensors_board_R_C8H = {
131 .known_board_sensors = {
132 SENSOR_TEMP_CHIPSET, SENSOR_TEMP_CPU, SENSOR_TEMP_MB,
133 SENSOR_TEMP_T_SENSOR, SENSOR_TEMP_VRM,
134 SENSOR_TEMP_WATER_IN, SENSOR_TEMP_WATER_OUT,
135 SENSOR_FAN_CPU_OPT, SENSOR_FAN_CHIPSET, SENSOR_FAN_WATER_FLOW,
141 /* Same as Hero but without chipset fan */
142 static struct asus_wmi_data sensors_board_R_C8DH = {
143 .known_board_sensors = {
144 SENSOR_TEMP_CHIPSET, SENSOR_TEMP_CPU, SENSOR_TEMP_MB,
145 SENSOR_TEMP_T_SENSOR, SENSOR_TEMP_VRM,
146 SENSOR_TEMP_WATER_IN, SENSOR_TEMP_WATER_OUT,
147 SENSOR_FAN_CPU_OPT, SENSOR_FAN_WATER_FLOW,
153 /* Same as Hero but without water */
154 static struct asus_wmi_data sensors_board_R_C8F = {
155 .known_board_sensors = {
156 SENSOR_TEMP_CHIPSET, SENSOR_TEMP_CPU, SENSOR_TEMP_MB,
157 SENSOR_TEMP_T_SENSOR, SENSOR_TEMP_VRM,
158 SENSOR_FAN_CPU_OPT, SENSOR_FAN_CHIPSET,
164 static struct asus_wmi_data sensors_board_RS_B550_E_G = {
165 .known_board_sensors = {
166 SENSOR_TEMP_CHIPSET, SENSOR_TEMP_CPU, SENSOR_TEMP_MB,
167 SENSOR_TEMP_T_SENSOR, SENSOR_TEMP_VRM,
173 static struct asus_wmi_data sensors_board_RS_B550_I_G = {
174 .known_board_sensors = {
175 SENSOR_TEMP_CHIPSET, SENSOR_TEMP_CPU, SENSOR_TEMP_MB,
176 SENSOR_TEMP_T_SENSOR, SENSOR_TEMP_VRM,
183 static struct asus_wmi_data sensors_board_RS_X570_E_G = {
184 .known_board_sensors = {
185 SENSOR_TEMP_CHIPSET, SENSOR_TEMP_CPU, SENSOR_TEMP_MB,
186 SENSOR_TEMP_T_SENSOR, SENSOR_TEMP_VRM,
193 #define DMI_EXACT_MATCH_ASUS_BOARD_NAME(name, sensors) { \
195 DMI_EXACT_MATCH(DMI_BOARD_VENDOR, "ASUSTeK COMPUTER INC."), \
196 DMI_EXACT_MATCH(DMI_BOARD_NAME, name), \
198 .driver_data = sensors, \
201 static const struct dmi_system_id asus_wmi_ec_dmi_table[] = {
202 DMI_EXACT_MATCH_ASUS_BOARD_NAME("PRIME X570-PRO", &sensors_board_PW_X570_P),
203 DMI_EXACT_MATCH_ASUS_BOARD_NAME("Pro WS X570-ACE", &sensors_board_PW_X570_A),
204 DMI_EXACT_MATCH_ASUS_BOARD_NAME("ROG CROSSHAIR VIII DARK HERO", &sensors_board_R_C8DH),
205 DMI_EXACT_MATCH_ASUS_BOARD_NAME("ROG CROSSHAIR VIII FORMULA", &sensors_board_R_C8F),
206 DMI_EXACT_MATCH_ASUS_BOARD_NAME("ROG CROSSHAIR VIII HERO", &sensors_board_R_C8H),
207 DMI_EXACT_MATCH_ASUS_BOARD_NAME("ROG STRIX B550-E GAMING", &sensors_board_RS_B550_E_G),
208 DMI_EXACT_MATCH_ASUS_BOARD_NAME("ROG STRIX B550-I GAMING", &sensors_board_RS_B550_I_G),
209 DMI_EXACT_MATCH_ASUS_BOARD_NAME("ROG STRIX X570-E GAMING", &sensors_board_RS_X570_E_G),
212 MODULE_DEVICE_TABLE(dmi, asus_wmi_ec_dmi_table);
215 enum known_ec_sensor info_index;
220 * struct asus_wmi_ec_info - sensor info.
221 * @sensors: list of sensors.
222 * @read_arg: UTF-16LE string to pass to BRxx() WMI function.
223 * @read_buffer: decoded output from WMI result.
224 * @nr_sensors: number of board EC sensors.
225 * @nr_registers: number of EC registers to read (sensor might span more than 1 register).
226 * @last_updated: in jiffies.
228 struct asus_wmi_ec_info {
229 struct ec_sensor sensors[SENSOR_MAX];
230 char read_arg[(ASUSWMI_BREC_REGISTERS_MAX * 4 + 1) * 2];
231 u8 read_buffer[ASUSWMI_BREC_REGISTERS_MAX];
232 unsigned int nr_sensors;
233 unsigned int nr_registers;
234 unsigned long last_updated;
237 struct asus_wmi_sensors {
238 struct asus_wmi_ec_info ec;
239 /* lock access to internal cache */
243 static int asus_wmi_ec_fill_board_sensors(struct asus_wmi_ec_info *ec,
244 const enum known_ec_sensor *bsi)
246 struct ec_sensor *s = ec->sensors;
250 ec->nr_registers = 0;
252 for (i = 0; bsi[i] != SENSOR_MAX; i++) {
253 s[i].info_index = bsi[i];
255 ec->nr_registers += known_ec_sensors[bsi[i]].addr.size;
262 * The next four functions convert to or from BRxx string argument format.
263 * The format of the string is as follows:
264 * - The string consists of two-byte UTF-16LE characters.
265 * - The value of the very first byte in the string is equal to the total
266 * length of the next string in bytes, thus excluding the first two-byte
268 * - The rest of the string encodes the pairs of (bank, index) pairs, where
269 * both values are byte-long (0x00 to 0xFF).
270 * - Numbers are encoded as UTF-16LE hex values.
272 static int asus_wmi_ec_decode_reply_buffer(const u8 *in, u32 length, u8 *out)
274 char buffer[ASUSWMI_MAX_BUF_LEN * 2];
275 u32 len = min_t(u32, get_unaligned_le16(in), length - 2);
277 utf16s_to_utf8s((wchar_t *)(in + 2), len / 2, UTF16_LITTLE_ENDIAN, buffer, sizeof(buffer));
279 return hex2bin(out, buffer, len / 4);
282 static void asus_wmi_ec_encode_registers(const u8 *in, u32 len, char *out)
284 char buffer[ASUSWMI_MAX_BUF_LEN * 2];
286 bin2hex(buffer, in, len);
288 utf8s_to_utf16s(buffer, len * 2, UTF16_LITTLE_ENDIAN, (wchar_t *)(out + 2), len * 2);
290 put_unaligned_le16(len * 4, out);
293 static void asus_wmi_ec_make_block_read_query(struct asus_wmi_ec_info *ec)
295 u8 registers[ASUSWMI_BREC_REGISTERS_MAX * 2];
296 const struct ec_sensor_info *si;
300 for (i = 0; i < ec->nr_sensors; i++) {
301 si = &known_ec_sensors[ec->sensors[i].info_index];
302 for (j = 0; j < si->addr.size; j++) {
303 registers[offset++] = si->addr.bank;
304 registers[offset++] = si->addr.index + j;
308 asus_wmi_ec_encode_registers(registers, offset, ec->read_arg);
311 static int asus_wmi_ec_block_read(u32 method_id, char *query, u8 *out)
313 struct acpi_buffer output = { ACPI_ALLOCATE_BUFFER, NULL };
314 struct acpi_buffer input;
315 union acpi_object *obj;
319 /* The first byte of the BRxx() argument string has to be the string size. */
320 input.length = query[0] + 2;
321 input.pointer = query;
322 status = wmi_evaluate_method(ASUSWMI_MONITORING_GUID, 0, method_id, &input, &output);
323 if (ACPI_FAILURE(status))
326 obj = output.pointer;
330 if (obj->type != ACPI_TYPE_BUFFER || obj->buffer.length < 2) {
335 ret = asus_wmi_ec_decode_reply_buffer(obj->buffer.pointer, obj->buffer.length, out);
342 static inline long get_sensor_value(const struct ec_sensor_info *si, u8 *data)
344 switch (si->addr.size) {
348 return get_unaligned_be16(data);
350 return get_unaligned_be32(data);
356 static void asus_wmi_ec_update_ec_sensors(struct asus_wmi_ec_info *ec)
358 const struct ec_sensor_info *si;
363 data = ec->read_buffer;
364 for (i_sensor = 0; i_sensor < ec->nr_sensors; i_sensor++) {
365 s = &ec->sensors[i_sensor];
366 si = &known_ec_sensors[s->info_index];
367 s->cached_value = get_sensor_value(si, data);
368 data += si->addr.size;
372 static long asus_wmi_ec_scale_sensor_value(long value, int data_type)
378 return value * MILLI;
384 static int asus_wmi_ec_find_sensor_index(const struct asus_wmi_ec_info *ec,
385 enum hwmon_sensor_types type, int channel)
389 for (i = 0; i < ec->nr_sensors; i++) {
390 if (known_ec_sensors[ec->sensors[i].info_index].type == type) {
400 static int asus_wmi_ec_get_cached_value_or_update(struct asus_wmi_sensors *sensor_data,
404 struct asus_wmi_ec_info *ec = &sensor_data->ec;
407 mutex_lock(&sensor_data->lock);
409 if (time_after(jiffies, ec->last_updated + HZ)) {
410 ret = asus_wmi_ec_block_read(ASUSWMI_METHODID_BLOCK_READ_EC,
411 ec->read_arg, ec->read_buffer);
415 asus_wmi_ec_update_ec_sensors(ec);
416 ec->last_updated = jiffies;
419 *value = ec->sensors[sensor_index].cached_value;
422 mutex_unlock(&sensor_data->lock);
427 /* Now follow the functions that implement the hwmon interface */
429 static int asus_wmi_ec_hwmon_read(struct device *dev, enum hwmon_sensor_types type,
430 u32 attr, int channel, long *val)
432 struct asus_wmi_sensors *sensor_data = dev_get_drvdata(dev);
433 struct asus_wmi_ec_info *ec = &sensor_data->ec;
434 int ret, sidx, info_index;
437 sidx = asus_wmi_ec_find_sensor_index(ec, type, channel);
441 ret = asus_wmi_ec_get_cached_value_or_update(sensor_data, sidx, &value);
445 info_index = ec->sensors[sidx].info_index;
446 *val = asus_wmi_ec_scale_sensor_value(value, known_ec_sensors[info_index].type);
451 static int asus_wmi_ec_hwmon_read_string(struct device *dev,
452 enum hwmon_sensor_types type, u32 attr,
453 int channel, const char **str)
455 struct asus_wmi_sensors *sensor_data = dev_get_drvdata(dev);
456 struct asus_wmi_ec_info *ec = &sensor_data->ec;
459 sensor_index = asus_wmi_ec_find_sensor_index(ec, type, channel);
460 *str = known_ec_sensors[ec->sensors[sensor_index].info_index].label;
465 static umode_t asus_wmi_ec_hwmon_is_visible(const void *drvdata,
466 enum hwmon_sensor_types type, u32 attr,
469 const struct asus_wmi_sensors *sensor_data = drvdata;
470 const struct asus_wmi_ec_info *ec = &sensor_data->ec;
473 index = asus_wmi_ec_find_sensor_index(ec, type, channel);
475 return index < 0 ? 0 : 0444;
478 static int asus_wmi_hwmon_add_chan_info(struct hwmon_channel_info *asus_wmi_hwmon_chan,
479 struct device *dev, int num,
480 enum hwmon_sensor_types type, u32 config)
484 cfg = devm_kcalloc(dev, num + 1, sizeof(*cfg), GFP_KERNEL);
488 asus_wmi_hwmon_chan->type = type;
489 asus_wmi_hwmon_chan->config = cfg;
490 memset32(cfg, config, num);
495 static const struct hwmon_ops asus_wmi_ec_hwmon_ops = {
496 .is_visible = asus_wmi_ec_hwmon_is_visible,
497 .read = asus_wmi_ec_hwmon_read,
498 .read_string = asus_wmi_ec_hwmon_read_string,
501 static struct hwmon_chip_info asus_wmi_ec_chip_info = {
502 .ops = &asus_wmi_ec_hwmon_ops,
505 static int asus_wmi_ec_configure_sensor_setup(struct device *dev,
506 const enum known_ec_sensor *bsi)
508 struct asus_wmi_sensors *sensor_data = dev_get_drvdata(dev);
509 struct asus_wmi_ec_info *ec = &sensor_data->ec;
510 struct hwmon_channel_info *asus_wmi_hwmon_chan;
511 const struct hwmon_channel_info **asus_wmi_ci;
512 int nr_count[hwmon_max] = {}, nr_types = 0;
513 const struct hwmon_chip_info *chip_info;
514 const struct ec_sensor_info *si;
515 enum hwmon_sensor_types type;
516 struct device *hwdev;
519 ret = asus_wmi_ec_fill_board_sensors(ec, bsi);
523 if (!sensor_data->ec.nr_sensors)
526 for (i = 0; i < ec->nr_sensors; i++) {
527 si = &known_ec_sensors[ec->sensors[i].info_index];
528 if (!nr_count[si->type])
530 nr_count[si->type]++;
533 if (nr_count[hwmon_temp]) {
534 nr_count[hwmon_chip]++;
539 * If we can get values for all the registers in a single query,
540 * the query will not change from call to call.
542 asus_wmi_ec_make_block_read_query(ec);
544 asus_wmi_hwmon_chan = devm_kcalloc(dev, nr_types, sizeof(*asus_wmi_hwmon_chan),
546 if (!asus_wmi_hwmon_chan)
549 asus_wmi_ci = devm_kcalloc(dev, nr_types + 1, sizeof(*asus_wmi_ci), GFP_KERNEL);
553 asus_wmi_ec_chip_info.info = asus_wmi_ci;
554 chip_info = &asus_wmi_ec_chip_info;
556 for (type = 0; type < hwmon_max; type++) {
560 ret = asus_wmi_hwmon_add_chan_info(asus_wmi_hwmon_chan, dev,
561 nr_count[type], type,
562 hwmon_attributes[type]);
566 *asus_wmi_ci++ = asus_wmi_hwmon_chan++;
569 dev_dbg(dev, "board has %d EC sensors that span %d registers",
570 ec->nr_sensors, ec->nr_registers);
572 hwdev = devm_hwmon_device_register_with_info(dev, "asus_wmi_ec_sensors",
573 sensor_data, chip_info, NULL);
575 return PTR_ERR_OR_ZERO(hwdev);
578 static int asus_wmi_probe(struct wmi_device *wdev, const void *context)
580 struct asus_wmi_sensors *sensor_data;
581 struct asus_wmi_data *board_sensors;
582 const struct dmi_system_id *dmi_id;
583 const enum known_ec_sensor *bsi;
584 struct device *dev = &wdev->dev;
586 dmi_id = dmi_first_match(asus_wmi_ec_dmi_table);
590 board_sensors = dmi_id->driver_data;
591 bsi = board_sensors->known_board_sensors;
593 sensor_data = devm_kzalloc(dev, sizeof(*sensor_data), GFP_KERNEL);
597 mutex_init(&sensor_data->lock);
599 dev_set_drvdata(dev, sensor_data);
601 return asus_wmi_ec_configure_sensor_setup(dev, bsi);
604 static const struct wmi_device_id asus_ec_wmi_id_table[] = {
605 { ASUSWMI_MONITORING_GUID, NULL },
609 static struct wmi_driver asus_sensors_wmi_driver = {
611 .name = "asus_wmi_ec_sensors",
613 .id_table = asus_ec_wmi_id_table,
614 .probe = asus_wmi_probe,
616 module_wmi_driver(asus_sensors_wmi_driver);
618 MODULE_AUTHOR("Ed Brindley <kernel@maidavale.org>");
619 MODULE_AUTHOR("Eugene Shalygin <eugene.shalygin@gmail.com>");
620 MODULE_DESCRIPTION("Asus WMI Sensors Driver");
621 MODULE_LICENSE("GPL");