2 * A hwmon driver for the IBM PowerExecutive temperature/power sensors
3 * Copyright (C) 2007 IBM
5 * Author: Darrick J. Wong <djwong@us.ibm.com>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22 #include <linux/ipmi.h>
23 #include <linux/module.h>
24 #include <linux/hwmon.h>
25 #include <linux/hwmon-sysfs.h>
26 #include <linux/jiffies.h>
27 #include <linux/mutex.h>
29 #define REFRESH_INTERVAL (2 * HZ)
30 #define DRVNAME "ibmpex"
32 #define PEX_GET_VERSION 1
33 #define PEX_GET_SENSOR_COUNT 2
34 #define PEX_GET_SENSOR_NAME 3
35 #define PEX_RESET_HIGH_LOW 4
36 #define PEX_GET_SENSOR_DATA 6
38 #define PEX_NET_FUNCTION 0x3A
39 #define PEX_COMMAND 0x3C
41 static inline u16 extract_value(const char *data, int offset)
43 return be16_to_cpup((u16 *)&data[offset]);
47 #define POWER_SENSOR 2
49 #define PEX_SENSOR_TYPE_LEN 3
50 static u8 const power_sensor_sig[] = {0x70, 0x77, 0x72};
51 static u8 const temp_sensor_sig[] = {0x74, 0x65, 0x6D};
53 #define PEX_MULT_LEN 2
54 static u8 const watt_sensor_sig[] = {0x41, 0x43};
56 #define PEX_NUM_SENSOR_FUNCS 3
57 static char const * const power_sensor_name_templates[] = {
59 "%s%d_average_lowest",
60 "%s%d_average_highest"
62 static char const * const temp_sensor_name_templates[] = {
68 static void ibmpex_msg_handler(struct ipmi_recv_msg *msg, void *user_msg_data);
69 static void ibmpex_register_bmc(int iface, struct device *dev);
70 static void ibmpex_bmc_gone(int iface);
72 struct ibmpex_sensor_data {
74 s16 values[PEX_NUM_SENSOR_FUNCS];
77 struct sensor_device_attribute_2 attr[PEX_NUM_SENSOR_FUNCS];
80 struct ibmpex_bmc_data {
81 struct list_head list;
82 struct device *hwmon_dev;
83 struct device *bmc_device;
86 unsigned long last_updated; /* In jiffies */
88 struct ipmi_addr address;
89 struct completion read_complete;
93 struct kernel_ipmi_msg tx_message;
94 unsigned char tx_msg_data[IPMI_MAX_MSG_LENGTH];
97 unsigned char rx_msg_data[IPMI_MAX_MSG_LENGTH];
98 unsigned long rx_msg_len;
99 unsigned char rx_result;
102 unsigned char sensor_major;
103 unsigned char sensor_minor;
105 unsigned char num_sensors;
106 struct ibmpex_sensor_data *sensors;
109 struct ibmpex_driver_data {
110 struct list_head bmc_data;
111 struct ipmi_smi_watcher bmc_events;
112 struct ipmi_user_hndl ipmi_hndlrs;
115 static struct ibmpex_driver_data driver_data = {
116 .bmc_data = LIST_HEAD_INIT(driver_data.bmc_data),
118 .owner = THIS_MODULE,
119 .new_smi = ibmpex_register_bmc,
120 .smi_gone = ibmpex_bmc_gone,
123 .ipmi_recv_hndl = ibmpex_msg_handler,
127 static int ibmpex_send_message(struct ibmpex_bmc_data *data)
131 err = ipmi_validate_addr(&data->address, sizeof(data->address));
136 err = ipmi_request_settime(data->user, &data->address, data->tx_msgid,
137 &data->tx_message, data, 0, 0, 0);
143 printk(KERN_ERR "%s: request_settime=%x\n", __FUNCTION__, err);
146 printk(KERN_ERR "%s: validate_addr=%x\n", __FUNCTION__, err);
150 static int ibmpex_ver_check(struct ibmpex_bmc_data *data)
152 data->tx_msg_data[0] = PEX_GET_VERSION;
153 data->tx_message.data_len = 1;
154 ibmpex_send_message(data);
156 wait_for_completion(&data->read_complete);
158 if (data->rx_result || data->rx_msg_len != 6)
161 data->sensor_major = data->rx_msg_data[0];
162 data->sensor_minor = data->rx_msg_data[1];
164 printk(KERN_INFO DRVNAME ": Found BMC with sensor interface "
165 "v%d.%d %d-%02d-%02d on interface %d\n",
168 extract_value(data->rx_msg_data, 2),
169 data->rx_msg_data[4],
170 data->rx_msg_data[5],
176 static int ibmpex_query_sensor_count(struct ibmpex_bmc_data *data)
178 data->tx_msg_data[0] = PEX_GET_SENSOR_COUNT;
179 data->tx_message.data_len = 1;
180 ibmpex_send_message(data);
182 wait_for_completion(&data->read_complete);
184 if (data->rx_result || data->rx_msg_len != 1)
187 return data->rx_msg_data[0];
190 static int ibmpex_query_sensor_name(struct ibmpex_bmc_data *data, int sensor)
192 data->tx_msg_data[0] = PEX_GET_SENSOR_NAME;
193 data->tx_msg_data[1] = sensor;
194 data->tx_message.data_len = 2;
195 ibmpex_send_message(data);
197 wait_for_completion(&data->read_complete);
199 if (data->rx_result || data->rx_msg_len < 1)
205 static int ibmpex_query_sensor_data(struct ibmpex_bmc_data *data, int sensor)
207 data->tx_msg_data[0] = PEX_GET_SENSOR_DATA;
208 data->tx_msg_data[1] = sensor;
209 data->tx_message.data_len = 2;
210 ibmpex_send_message(data);
212 wait_for_completion(&data->read_complete);
214 if (data->rx_result || data->rx_msg_len < 26) {
215 printk(KERN_ERR "Error reading sensor %d, please check.\n",
223 static int ibmpex_reset_high_low_data(struct ibmpex_bmc_data *data)
225 data->tx_msg_data[0] = PEX_RESET_HIGH_LOW;
226 data->tx_message.data_len = 1;
227 ibmpex_send_message(data);
229 wait_for_completion(&data->read_complete);
234 static void ibmpex_update_device(struct ibmpex_bmc_data *data)
238 mutex_lock(&data->lock);
239 if (time_before(jiffies, data->last_updated + REFRESH_INTERVAL) &&
243 for (i = 0; i < data->num_sensors; i++) {
244 if (!data->sensors[i].in_use)
246 err = ibmpex_query_sensor_data(data, i);
249 data->sensors[i].values[0] =
250 extract_value(data->rx_msg_data, 16);
251 data->sensors[i].values[1] =
252 extract_value(data->rx_msg_data, 18);
253 data->sensors[i].values[2] =
254 extract_value(data->rx_msg_data, 20);
257 data->last_updated = jiffies;
261 mutex_unlock(&data->lock);
264 static struct ibmpex_bmc_data *get_bmc_data(int iface)
266 struct ibmpex_bmc_data *p, *next;
268 list_for_each_entry_safe(p, next, &driver_data.bmc_data, list)
269 if (p->interface == iface)
275 static ssize_t show_name(struct device *dev, struct device_attribute *devattr,
278 return sprintf(buf, "%s\n", DRVNAME);
280 static SENSOR_DEVICE_ATTR(name, S_IRUGO, show_name, NULL, 0);
282 static ssize_t ibmpex_show_sensor(struct device *dev,
283 struct device_attribute *devattr,
286 struct sensor_device_attribute_2 *attr = to_sensor_dev_attr_2(devattr);
287 struct ibmpex_bmc_data *data = dev_get_drvdata(dev);
288 int mult = data->sensors[attr->index].multiplier;
289 ibmpex_update_device(data);
291 return sprintf(buf, "%d\n",
292 data->sensors[attr->index].values[attr->nr] * mult);
295 static ssize_t ibmpex_reset_high_low(struct device *dev,
296 struct device_attribute *devattr,
300 struct ibmpex_bmc_data *data = dev_get_drvdata(dev);
302 ibmpex_reset_high_low_data(data);
307 static SENSOR_DEVICE_ATTR(reset_high_low, S_IWUSR, NULL,
308 ibmpex_reset_high_low, 0);
310 static int is_power_sensor(const char *sensor_id, int len)
312 if (len < PEX_SENSOR_TYPE_LEN)
315 if (!memcmp(sensor_id, power_sensor_sig, PEX_SENSOR_TYPE_LEN))
320 static int is_temp_sensor(const char *sensor_id, int len)
322 if (len < PEX_SENSOR_TYPE_LEN)
325 if (!memcmp(sensor_id, temp_sensor_sig, PEX_SENSOR_TYPE_LEN))
330 static int power_sensor_multiplier(const char *sensor_id, int len)
334 for (i = PEX_SENSOR_TYPE_LEN; i < len - 1; i++)
335 if (!memcmp(&sensor_id[i], watt_sensor_sig, PEX_MULT_LEN))
341 static int create_sensor(struct ibmpex_bmc_data *data, int type,
342 int counter, int sensor, int func)
347 n = kmalloc(32, GFP_KERNEL);
351 if (type == TEMP_SENSOR)
352 sprintf(n, temp_sensor_name_templates[func], "temp", counter);
353 else if (type == POWER_SENSOR)
354 sprintf(n, power_sensor_name_templates[func], "power", counter);
356 data->sensors[sensor].attr[func].dev_attr.attr.name = n;
357 data->sensors[sensor].attr[func].dev_attr.attr.mode = S_IRUGO;
358 data->sensors[sensor].attr[func].dev_attr.show = ibmpex_show_sensor;
359 data->sensors[sensor].attr[func].index = sensor;
360 data->sensors[sensor].attr[func].nr = func;
362 err = device_create_file(data->bmc_device,
363 &data->sensors[sensor].attr[func].dev_attr);
365 data->sensors[sensor].attr[func].dev_attr.attr.name = NULL;
373 static int ibmpex_find_sensors(struct ibmpex_bmc_data *data)
381 err = ibmpex_query_sensor_count(data);
384 data->num_sensors = err;
386 data->sensors = kzalloc(data->num_sensors * sizeof(*data->sensors),
391 for (i = 0; i < data->num_sensors; i++) {
392 err = ibmpex_query_sensor_name(data, i);
396 if (is_power_sensor(data->rx_msg_data, data->rx_msg_len)) {
397 sensor_type = POWER_SENSOR;
399 sensor_counter = num_power;
400 data->sensors[i].multiplier =
401 power_sensor_multiplier(data->rx_msg_data,
403 } else if (is_temp_sensor(data->rx_msg_data,
405 sensor_type = TEMP_SENSOR;
407 sensor_counter = num_temp;
408 data->sensors[i].multiplier = 1;
412 data->sensors[i].in_use = 1;
414 /* Create attributes */
415 for (j = 0; j < PEX_NUM_SENSOR_FUNCS; j++) {
416 err = create_sensor(data, sensor_type, sensor_counter,
423 err = device_create_file(data->bmc_device,
424 &sensor_dev_attr_reset_high_low.dev_attr);
428 err = device_create_file(data->bmc_device,
429 &sensor_dev_attr_name.dev_attr);
436 device_remove_file(data->bmc_device,
437 &sensor_dev_attr_reset_high_low.dev_attr);
438 device_remove_file(data->bmc_device, &sensor_dev_attr_name.dev_attr);
439 for (i = 0; i < data->num_sensors; i++)
440 for (j = 0; j < PEX_NUM_SENSOR_FUNCS; j++) {
441 if (!data->sensors[i].attr[j].dev_attr.attr.name)
443 device_remove_file(data->bmc_device,
444 &data->sensors[i].attr[j].dev_attr);
445 kfree(data->sensors[i].attr[j].dev_attr.attr.name);
448 kfree(data->sensors);
452 static void ibmpex_register_bmc(int iface, struct device *dev)
454 struct ibmpex_bmc_data *data;
457 data = kzalloc(sizeof(*data), GFP_KERNEL);
459 printk(KERN_ERR DRVNAME ": Insufficient memory for BMC "
464 data->address.addr_type = IPMI_SYSTEM_INTERFACE_ADDR_TYPE;
465 data->address.channel = IPMI_BMC_CHANNEL;
466 data->address.data[0] = 0;
467 data->interface = iface;
468 data->bmc_device = dev;
470 /* Create IPMI messaging interface user */
471 err = ipmi_create_user(data->interface, &driver_data.ipmi_hndlrs,
474 printk(KERN_ERR DRVNAME ": Error, unable to register user with "
475 "ipmi interface %d\n",
480 mutex_init(&data->lock);
482 /* Initialize message */
484 init_completion(&data->read_complete);
485 data->tx_message.netfn = PEX_NET_FUNCTION;
486 data->tx_message.cmd = PEX_COMMAND;
487 data->tx_message.data = data->tx_msg_data;
489 /* Does this BMC support PowerExecutive? */
490 err = ibmpex_ver_check(data);
494 /* Register the BMC as a HWMON class device */
495 data->hwmon_dev = hwmon_device_register(data->bmc_device);
497 if (IS_ERR(data->hwmon_dev)) {
498 printk(KERN_ERR DRVNAME ": Error, unable to register hwmon "
499 "class device for interface %d\n",
504 /* finally add the new bmc data to the bmc data list */
505 dev_set_drvdata(dev, data);
506 list_add_tail(&data->list, &driver_data.bmc_data);
508 /* Now go find all the sensors */
509 err = ibmpex_find_sensors(data);
511 printk(KERN_ERR "Error %d allocating memory\n", err);
518 hwmon_device_unregister(data->hwmon_dev);
520 ipmi_destroy_user(data->user);
525 static void ibmpex_bmc_delete(struct ibmpex_bmc_data *data)
529 device_remove_file(data->bmc_device,
530 &sensor_dev_attr_reset_high_low.dev_attr);
531 device_remove_file(data->bmc_device, &sensor_dev_attr_name.dev_attr);
532 for (i = 0; i < data->num_sensors; i++)
533 for (j = 0; j < PEX_NUM_SENSOR_FUNCS; j++) {
534 if (!data->sensors[i].attr[j].dev_attr.attr.name)
536 device_remove_file(data->bmc_device,
537 &data->sensors[i].attr[j].dev_attr);
538 kfree(data->sensors[i].attr[j].dev_attr.attr.name);
541 list_del(&data->list);
542 dev_set_drvdata(data->bmc_device, NULL);
543 hwmon_device_unregister(data->hwmon_dev);
544 ipmi_destroy_user(data->user);
545 kfree(data->sensors);
549 static void ibmpex_bmc_gone(int iface)
551 struct ibmpex_bmc_data *data = get_bmc_data(iface);
556 ibmpex_bmc_delete(data);
559 static void ibmpex_msg_handler(struct ipmi_recv_msg *msg, void *user_msg_data)
561 struct ibmpex_bmc_data *data = (struct ibmpex_bmc_data *)user_msg_data;
563 if (msg->msgid != data->tx_msgid) {
564 printk(KERN_ERR "Received msgid (%02x) and transmitted "
565 "msgid (%02x) mismatch!\n",
567 (int)data->tx_msgid);
568 ipmi_free_recv_msg(msg);
572 data->rx_recv_type = msg->recv_type;
573 if (msg->msg.data_len > 0)
574 data->rx_result = msg->msg.data[0];
576 data->rx_result = IPMI_UNKNOWN_ERR_COMPLETION_CODE;
578 if (msg->msg.data_len > 1) {
579 data->rx_msg_len = msg->msg.data_len - 1;
580 memcpy(data->rx_msg_data, msg->msg.data + 1, data->rx_msg_len);
582 data->rx_msg_len = 0;
584 ipmi_free_recv_msg(msg);
585 complete(&data->read_complete);
588 static int __init ibmpex_init(void)
590 return ipmi_smi_watcher_register(&driver_data.bmc_events);
593 static void __exit ibmpex_exit(void)
595 struct ibmpex_bmc_data *p, *next;
597 ipmi_smi_watcher_unregister(&driver_data.bmc_events);
598 list_for_each_entry_safe(p, next, &driver_data.bmc_data, list)
599 ibmpex_bmc_delete(p);
602 MODULE_AUTHOR("Darrick J. Wong <djwong@us.ibm.com>");
603 MODULE_DESCRIPTION("IBM PowerExecutive power/temperature sensor driver");
604 MODULE_LICENSE("GPL");
606 module_init(ibmpex_init);
607 module_exit(ibmpex_exit);