code style scripts/checkpatch.pl (linux-3.9-rc1) formatting
[linux-2.6.34.14-moxart.git] / drivers / hwmon / ibmaem.c
blobfd4dbefc3e1756583ff719fb365401219871d9fe
1 /*
2 * A hwmon driver for the IBM System Director Active Energy Manager (AEM)
3 * temperature/power/energy sensors and capping functionality.
4 * Copyright (C) 2008 IBM
6 * Author: Darrick J. Wong <djwong@us.ibm.com>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23 #include <linux/ipmi.h>
24 #include <linux/module.h>
25 #include <linux/hwmon.h>
26 #include <linux/hwmon-sysfs.h>
27 #include <linux/jiffies.h>
28 #include <linux/mutex.h>
29 #include <linux/kdev_t.h>
30 #include <linux/spinlock.h>
31 #include <linux/idr.h>
32 #include <linux/slab.h>
33 #include <linux/sched.h>
34 #include <linux/platform_device.h>
35 #include <linux/math64.h>
36 #include <linux/time.h>
38 #define REFRESH_INTERVAL (HZ)
39 #define IPMI_TIMEOUT (30 * HZ)
40 #define DRVNAME "aem"
42 #define AEM_NETFN 0x2E
44 #define AEM_FIND_FW_CMD 0x80
45 #define AEM_ELEMENT_CMD 0x81
46 #define AEM_FW_INSTANCE_CMD 0x82
48 #define AEM_READ_ELEMENT_CFG 0x80
49 #define AEM_READ_BUFFER 0x81
50 #define AEM_READ_REGISTER 0x82
51 #define AEM_WRITE_REGISTER 0x83
52 #define AEM_SET_REG_MASK 0x84
53 #define AEM_CLEAR_REG_MASK 0x85
54 #define AEM_READ_ELEMENT_CFG2 0x86
56 #define AEM_CONTROL_ELEMENT 0
57 #define AEM_ENERGY_ELEMENT 1
58 #define AEM_CLOCK_ELEMENT 4
59 #define AEM_POWER_CAP_ELEMENT 7
60 #define AEM_EXHAUST_ELEMENT 9
61 #define AEM_POWER_ELEMENT 10
63 #define AEM_MODULE_TYPE_ID 0x0001
65 #define AEM2_NUM_ENERGY_REGS 2
66 #define AEM2_NUM_PCAP_REGS 6
67 #define AEM2_NUM_TEMP_REGS 2
68 #define AEM2_NUM_SENSORS 14
70 #define AEM1_NUM_ENERGY_REGS 1
71 #define AEM1_NUM_SENSORS 3
73 /* AEM 2.x has more energy registers */
74 #define AEM_NUM_ENERGY_REGS AEM2_NUM_ENERGY_REGS
75 /* AEM 2.x needs more sensor files */
76 #define AEM_NUM_SENSORS AEM2_NUM_SENSORS
78 #define POWER_CAP 0
79 #define POWER_CAP_MAX_HOTPLUG 1
80 #define POWER_CAP_MAX 2
81 #define POWER_CAP_MIN_WARNING 3
82 #define POWER_CAP_MIN 4
83 #define POWER_AUX 5
85 #define AEM_DEFAULT_POWER_INTERVAL 1000
86 #define AEM_MIN_POWER_INTERVAL 200
87 #define UJ_PER_MJ 1000L
89 static DEFINE_IDR(aem_idr);
90 static DEFINE_SPINLOCK(aem_idr_lock);
92 static struct platform_driver aem_driver = {
93 .driver = {
94 .name = DRVNAME,
95 .bus = &platform_bus_type,
99 struct aem_ipmi_data {
100 struct completion read_complete;
101 struct ipmi_addr address;
102 ipmi_user_t user;
103 int interface;
105 struct kernel_ipmi_msg tx_message;
106 long tx_msgid;
108 void *rx_msg_data;
109 unsigned short rx_msg_len;
110 unsigned char rx_result;
111 int rx_recv_type;
113 struct device *bmc_device;
116 struct aem_ro_sensor_template {
117 char *label;
118 ssize_t (*show)(struct device *dev,
119 struct device_attribute *devattr,
120 char *buf);
121 int index;
124 struct aem_rw_sensor_template {
125 char *label;
126 ssize_t (*show)(struct device *dev,
127 struct device_attribute *devattr,
128 char *buf);
129 ssize_t (*set)(struct device *dev,
130 struct device_attribute *devattr,
131 const char *buf, size_t count);
132 int index;
135 struct aem_data {
136 struct list_head list;
138 struct device *hwmon_dev;
139 struct platform_device *pdev;
140 struct mutex lock;
141 char valid;
142 unsigned long last_updated; /* In jiffies */
143 u8 ver_major;
144 u8 ver_minor;
145 u8 module_handle;
146 int id;
147 struct aem_ipmi_data ipmi;
149 /* Function to update sensors */
150 void (*update)(struct aem_data *data);
153 * AEM 1.x sensors:
154 * Available sensors:
155 * Energy meter
156 * Power meter
158 * AEM 2.x sensors:
159 * Two energy meters
160 * Two power meters
161 * Two temperature sensors
162 * Six power cap registers
165 /* sysfs attrs */
166 struct sensor_device_attribute sensors[AEM_NUM_SENSORS];
168 /* energy use in mJ */
169 u64 energy[AEM_NUM_ENERGY_REGS];
171 /* power sampling interval in ms */
172 unsigned long power_period[AEM_NUM_ENERGY_REGS];
174 /* Everything past here is for AEM2 only */
176 /* power caps in dW */
177 u16 pcap[AEM2_NUM_PCAP_REGS];
179 /* exhaust temperature in C */
180 u8 temp[AEM2_NUM_TEMP_REGS];
183 /* Data structures returned by the AEM firmware */
184 struct aem_iana_id {
185 u8 bytes[3];
187 static struct aem_iana_id system_x_id = {
188 .bytes = {0x4D, 0x4F, 0x00}
191 /* These are used to find AEM1 instances */
192 struct aem_find_firmware_req {
193 struct aem_iana_id id;
194 u8 rsvd;
195 __be16 index;
196 __be16 module_type_id;
197 } __packed;
199 struct aem_find_firmware_resp {
200 struct aem_iana_id id;
201 u8 num_instances;
202 } __packed;
204 /* These are used to find AEM2 instances */
205 struct aem_find_instance_req {
206 struct aem_iana_id id;
207 u8 instance_number;
208 __be16 module_type_id;
209 } __packed;
211 struct aem_find_instance_resp {
212 struct aem_iana_id id;
213 u8 num_instances;
214 u8 major;
215 u8 minor;
216 u8 module_handle;
217 u16 record_id;
218 } __packed;
220 /* These are used to query sensors */
221 struct aem_read_sensor_req {
222 struct aem_iana_id id;
223 u8 module_handle;
224 u8 element;
225 u8 subcommand;
226 u8 reg;
227 u8 rx_buf_size;
228 } __packed;
230 struct aem_read_sensor_resp {
231 struct aem_iana_id id;
232 u8 bytes[0];
233 } __packed;
235 /* Data structures to talk to the IPMI layer */
236 struct aem_driver_data {
237 struct list_head aem_devices;
238 struct ipmi_smi_watcher bmc_events;
239 struct ipmi_user_hndl ipmi_hndlrs;
242 static void aem_register_bmc(int iface, struct device *dev);
243 static void aem_bmc_gone(int iface);
244 static void aem_msg_handler(struct ipmi_recv_msg *msg, void *user_msg_data);
246 static void aem_remove_sensors(struct aem_data *data);
247 static int aem_init_aem1(struct aem_ipmi_data *probe);
248 static int aem_init_aem2(struct aem_ipmi_data *probe);
249 static int aem1_find_sensors(struct aem_data *data);
250 static int aem2_find_sensors(struct aem_data *data);
251 static void update_aem1_sensors(struct aem_data *data);
252 static void update_aem2_sensors(struct aem_data *data);
254 static struct aem_driver_data driver_data = {
255 .aem_devices = LIST_HEAD_INIT(driver_data.aem_devices),
256 .bmc_events = {
257 .owner = THIS_MODULE,
258 .new_smi = aem_register_bmc,
259 .smi_gone = aem_bmc_gone,
261 .ipmi_hndlrs = {
262 .ipmi_recv_hndl = aem_msg_handler,
266 /* Functions to talk to the IPMI layer */
268 /* Initialize IPMI address, message buffers and user data */
269 static int aem_init_ipmi_data(struct aem_ipmi_data *data, int iface,
270 struct device *bmc)
272 int err;
274 init_completion(&data->read_complete);
275 data->bmc_device = bmc;
277 /* Initialize IPMI address */
278 data->address.addr_type = IPMI_SYSTEM_INTERFACE_ADDR_TYPE;
279 data->address.channel = IPMI_BMC_CHANNEL;
280 data->address.data[0] = 0;
281 data->interface = iface;
283 /* Initialize message buffers */
284 data->tx_msgid = 0;
285 data->tx_message.netfn = AEM_NETFN;
287 /* Create IPMI messaging interface user */
288 err = ipmi_create_user(data->interface, &driver_data.ipmi_hndlrs,
289 data, &data->user);
290 if (err < 0) {
291 dev_err(bmc, "Unable to register user with IPMI "
292 "interface %d\n", data->interface);
293 return -EACCES;
296 return 0;
299 /* Send an IPMI command */
300 static int aem_send_message(struct aem_ipmi_data *data)
302 int err;
304 err = ipmi_validate_addr(&data->address, sizeof(data->address));
305 if (err)
306 goto out;
308 data->tx_msgid++;
309 err = ipmi_request_settime(data->user, &data->address, data->tx_msgid,
310 &data->tx_message, data, 0, 0, 0);
311 if (err)
312 goto out1;
314 return 0;
315 out1:
316 dev_err(data->bmc_device, "request_settime=%x\n", err);
317 return err;
318 out:
319 dev_err(data->bmc_device, "validate_addr=%x\n", err);
320 return err;
323 /* Dispatch IPMI messages to callers */
324 static void aem_msg_handler(struct ipmi_recv_msg *msg, void *user_msg_data)
326 unsigned short rx_len;
327 struct aem_ipmi_data *data = user_msg_data;
329 if (msg->msgid != data->tx_msgid) {
330 dev_err(data->bmc_device, "Mismatch between received msgid "
331 "(%02x) and transmitted msgid (%02x)!\n",
332 (int)msg->msgid,
333 (int)data->tx_msgid);
334 ipmi_free_recv_msg(msg);
335 return;
338 data->rx_recv_type = msg->recv_type;
339 if (msg->msg.data_len > 0)
340 data->rx_result = msg->msg.data[0];
341 else
342 data->rx_result = IPMI_UNKNOWN_ERR_COMPLETION_CODE;
344 if (msg->msg.data_len > 1) {
345 rx_len = msg->msg.data_len - 1;
346 if (data->rx_msg_len < rx_len)
347 rx_len = data->rx_msg_len;
348 data->rx_msg_len = rx_len;
349 memcpy(data->rx_msg_data, msg->msg.data + 1, data->rx_msg_len);
350 } else
351 data->rx_msg_len = 0;
353 ipmi_free_recv_msg(msg);
354 complete(&data->read_complete);
357 /* ID functions */
359 /* Obtain an id */
360 static int aem_idr_get(int *id)
362 int i, err;
364 again:
365 if (unlikely(!idr_pre_get(&aem_idr, GFP_KERNEL)))
366 return -ENOMEM;
368 spin_lock(&aem_idr_lock);
369 err = idr_get_new(&aem_idr, NULL, &i);
370 spin_unlock(&aem_idr_lock);
372 if (unlikely(err == -EAGAIN))
373 goto again;
374 else if (unlikely(err))
375 return err;
377 *id = i & MAX_ID_MASK;
378 return 0;
381 /* Release an object ID */
382 static void aem_idr_put(int id)
384 spin_lock(&aem_idr_lock);
385 idr_remove(&aem_idr, id);
386 spin_unlock(&aem_idr_lock);
389 /* Sensor support functions */
391 /* Read a sensor value */
392 static int aem_read_sensor(struct aem_data *data, u8 elt, u8 reg,
393 void *buf, size_t size)
395 int rs_size, res;
396 struct aem_read_sensor_req rs_req;
397 struct aem_read_sensor_resp *rs_resp;
398 struct aem_ipmi_data *ipmi = &data->ipmi;
400 /* AEM registers are 1, 2, 4 or 8 bytes */
401 switch (size) {
402 case 1:
403 case 2:
404 case 4:
405 case 8:
406 break;
407 default:
408 return -EINVAL;
411 rs_req.id = system_x_id;
412 rs_req.module_handle = data->module_handle;
413 rs_req.element = elt;
414 rs_req.subcommand = AEM_READ_REGISTER;
415 rs_req.reg = reg;
416 rs_req.rx_buf_size = size;
418 ipmi->tx_message.cmd = AEM_ELEMENT_CMD;
419 ipmi->tx_message.data = (char *)&rs_req;
420 ipmi->tx_message.data_len = sizeof(rs_req);
422 rs_size = sizeof(*rs_resp) + size;
423 rs_resp = kzalloc(rs_size, GFP_KERNEL);
424 if (!rs_resp)
425 return -ENOMEM;
427 ipmi->rx_msg_data = rs_resp;
428 ipmi->rx_msg_len = rs_size;
430 aem_send_message(ipmi);
432 res = wait_for_completion_timeout(&ipmi->read_complete, IPMI_TIMEOUT);
433 if (!res) {
434 res = -ETIMEDOUT;
435 goto out;
438 if (ipmi->rx_result || ipmi->rx_msg_len != rs_size ||
439 memcmp(&rs_resp->id, &system_x_id, sizeof(system_x_id))) {
440 res = -ENOENT;
441 goto out;
444 switch (size) {
445 case 1: {
446 u8 *x = buf;
447 *x = rs_resp->bytes[0];
448 break;
450 case 2: {
451 u16 *x = buf;
452 *x = be16_to_cpup((__be16 *)rs_resp->bytes);
453 break;
455 case 4: {
456 u32 *x = buf;
457 *x = be32_to_cpup((__be32 *)rs_resp->bytes);
458 break;
460 case 8: {
461 u64 *x = buf;
462 *x = be64_to_cpup((__be64 *)rs_resp->bytes);
463 break;
466 res = 0;
468 out:
469 kfree(rs_resp);
470 return res;
473 /* Update AEM energy registers */
474 static void update_aem_energy_one(struct aem_data *data, int which)
476 aem_read_sensor(data, AEM_ENERGY_ELEMENT, which,
477 &data->energy[which], 8);
480 static void update_aem_energy(struct aem_data *data)
482 update_aem_energy_one(data, 0);
483 if (data->ver_major < 2)
484 return;
485 update_aem_energy_one(data, 1);
488 /* Update all AEM1 sensors */
489 static void update_aem1_sensors(struct aem_data *data)
491 mutex_lock(&data->lock);
492 if (time_before(jiffies, data->last_updated + REFRESH_INTERVAL) &&
493 data->valid)
494 goto out;
496 update_aem_energy(data);
497 out:
498 mutex_unlock(&data->lock);
501 /* Update all AEM2 sensors */
502 static void update_aem2_sensors(struct aem_data *data)
504 int i;
506 mutex_lock(&data->lock);
507 if (time_before(jiffies, data->last_updated + REFRESH_INTERVAL) &&
508 data->valid)
509 goto out;
511 update_aem_energy(data);
512 aem_read_sensor(data, AEM_EXHAUST_ELEMENT, 0, &data->temp[0], 1);
513 aem_read_sensor(data, AEM_EXHAUST_ELEMENT, 1, &data->temp[1], 1);
515 for (i = POWER_CAP; i <= POWER_AUX; i++)
516 aem_read_sensor(data, AEM_POWER_CAP_ELEMENT, i,
517 &data->pcap[i], 2);
518 out:
519 mutex_unlock(&data->lock);
522 /* Delete an AEM instance */
523 static void aem_delete(struct aem_data *data)
525 list_del(&data->list);
526 aem_remove_sensors(data);
527 hwmon_device_unregister(data->hwmon_dev);
528 ipmi_destroy_user(data->ipmi.user);
529 dev_set_drvdata(&data->pdev->dev, NULL);
530 platform_device_unregister(data->pdev);
531 aem_idr_put(data->id);
532 kfree(data);
535 /* Probe functions for AEM1 devices */
537 /* Retrieve version and module handle for an AEM1 instance */
538 static int aem_find_aem1_count(struct aem_ipmi_data *data)
540 int res;
541 struct aem_find_firmware_req ff_req;
542 struct aem_find_firmware_resp ff_resp;
544 ff_req.id = system_x_id;
545 ff_req.index = 0;
546 ff_req.module_type_id = cpu_to_be16(AEM_MODULE_TYPE_ID);
548 data->tx_message.cmd = AEM_FIND_FW_CMD;
549 data->tx_message.data = (char *)&ff_req;
550 data->tx_message.data_len = sizeof(ff_req);
552 data->rx_msg_data = &ff_resp;
553 data->rx_msg_len = sizeof(ff_resp);
555 aem_send_message(data);
557 res = wait_for_completion_timeout(&data->read_complete, IPMI_TIMEOUT);
558 if (!res)
559 return -ETIMEDOUT;
561 if (data->rx_result || data->rx_msg_len != sizeof(ff_resp) ||
562 memcmp(&ff_resp.id, &system_x_id, sizeof(system_x_id)))
563 return -ENOENT;
565 return ff_resp.num_instances;
568 /* Find and initialize one AEM1 instance */
569 static int aem_init_aem1_inst(struct aem_ipmi_data *probe, u8 module_handle)
571 struct aem_data *data;
572 int i;
573 int res = -ENOMEM;
575 data = kzalloc(sizeof(*data), GFP_KERNEL);
576 if (!data)
577 return res;
578 mutex_init(&data->lock);
580 /* Copy instance data */
581 data->ver_major = 1;
582 data->ver_minor = 0;
583 data->module_handle = module_handle;
584 for (i = 0; i < AEM1_NUM_ENERGY_REGS; i++)
585 data->power_period[i] = AEM_DEFAULT_POWER_INTERVAL;
587 /* Create sub-device for this fw instance */
588 if (aem_idr_get(&data->id))
589 goto id_err;
591 data->pdev = platform_device_alloc(DRVNAME, data->id);
592 if (!data->pdev)
593 goto dev_err;
594 data->pdev->dev.driver = &aem_driver.driver;
596 res = platform_device_add(data->pdev);
597 if (res)
598 goto ipmi_err;
600 dev_set_drvdata(&data->pdev->dev, data);
602 /* Set up IPMI interface */
603 if (aem_init_ipmi_data(&data->ipmi, probe->interface,
604 probe->bmc_device))
605 goto ipmi_err;
607 /* Register with hwmon */
608 data->hwmon_dev = hwmon_device_register(&data->pdev->dev);
610 if (IS_ERR(data->hwmon_dev)) {
611 dev_err(&data->pdev->dev, "Unable to register hwmon "
612 "device for IPMI interface %d\n",
613 probe->interface);
614 goto hwmon_reg_err;
617 data->update = update_aem1_sensors;
619 /* Find sensors */
620 if (aem1_find_sensors(data))
621 goto sensor_err;
623 /* Add to our list of AEM devices */
624 list_add_tail(&data->list, &driver_data.aem_devices);
626 dev_info(data->ipmi.bmc_device, "Found AEM v%d.%d at 0x%X\n",
627 data->ver_major, data->ver_minor,
628 data->module_handle);
629 return 0;
631 sensor_err:
632 hwmon_device_unregister(data->hwmon_dev);
633 hwmon_reg_err:
634 ipmi_destroy_user(data->ipmi.user);
635 ipmi_err:
636 dev_set_drvdata(&data->pdev->dev, NULL);
637 platform_device_unregister(data->pdev);
638 dev_err:
639 aem_idr_put(data->id);
640 id_err:
641 kfree(data);
643 return res;
646 /* Find and initialize all AEM1 instances */
647 static int aem_init_aem1(struct aem_ipmi_data *probe)
649 int num, i, err;
651 num = aem_find_aem1_count(probe);
652 for (i = 0; i < num; i++) {
653 err = aem_init_aem1_inst(probe, i);
654 if (err) {
655 dev_err(probe->bmc_device,
656 "Error %d initializing AEM1 0x%X\n",
657 err, i);
658 return err;
662 return 0;
665 /* Probe functions for AEM2 devices */
667 /* Retrieve version and module handle for an AEM2 instance */
668 static int aem_find_aem2(struct aem_ipmi_data *data,
669 struct aem_find_instance_resp *fi_resp,
670 int instance_num)
672 int res;
673 struct aem_find_instance_req fi_req;
675 fi_req.id = system_x_id;
676 fi_req.instance_number = instance_num;
677 fi_req.module_type_id = cpu_to_be16(AEM_MODULE_TYPE_ID);
679 data->tx_message.cmd = AEM_FW_INSTANCE_CMD;
680 data->tx_message.data = (char *)&fi_req;
681 data->tx_message.data_len = sizeof(fi_req);
683 data->rx_msg_data = fi_resp;
684 data->rx_msg_len = sizeof(*fi_resp);
686 aem_send_message(data);
688 res = wait_for_completion_timeout(&data->read_complete, IPMI_TIMEOUT);
689 if (!res)
690 return -ETIMEDOUT;
692 if (data->rx_result || data->rx_msg_len != sizeof(*fi_resp) ||
693 memcmp(&fi_resp->id, &system_x_id, sizeof(system_x_id)) ||
694 fi_resp->num_instances <= instance_num)
695 return -ENOENT;
697 return 0;
700 /* Find and initialize one AEM2 instance */
701 static int aem_init_aem2_inst(struct aem_ipmi_data *probe,
702 struct aem_find_instance_resp *fi_resp)
704 struct aem_data *data;
705 int i;
706 int res = -ENOMEM;
708 data = kzalloc(sizeof(*data), GFP_KERNEL);
709 if (!data)
710 return res;
711 mutex_init(&data->lock);
713 /* Copy instance data */
714 data->ver_major = fi_resp->major;
715 data->ver_minor = fi_resp->minor;
716 data->module_handle = fi_resp->module_handle;
717 for (i = 0; i < AEM2_NUM_ENERGY_REGS; i++)
718 data->power_period[i] = AEM_DEFAULT_POWER_INTERVAL;
720 /* Create sub-device for this fw instance */
721 if (aem_idr_get(&data->id))
722 goto id_err;
724 data->pdev = platform_device_alloc(DRVNAME, data->id);
725 if (!data->pdev)
726 goto dev_err;
727 data->pdev->dev.driver = &aem_driver.driver;
729 res = platform_device_add(data->pdev);
730 if (res)
731 goto ipmi_err;
733 dev_set_drvdata(&data->pdev->dev, data);
735 /* Set up IPMI interface */
736 if (aem_init_ipmi_data(&data->ipmi, probe->interface,
737 probe->bmc_device))
738 goto ipmi_err;
740 /* Register with hwmon */
741 data->hwmon_dev = hwmon_device_register(&data->pdev->dev);
743 if (IS_ERR(data->hwmon_dev)) {
744 dev_err(&data->pdev->dev, "Unable to register hwmon "
745 "device for IPMI interface %d\n",
746 probe->interface);
747 goto hwmon_reg_err;
750 data->update = update_aem2_sensors;
752 /* Find sensors */
753 if (aem2_find_sensors(data))
754 goto sensor_err;
756 /* Add to our list of AEM devices */
757 list_add_tail(&data->list, &driver_data.aem_devices);
759 dev_info(data->ipmi.bmc_device, "Found AEM v%d.%d at 0x%X\n",
760 data->ver_major, data->ver_minor,
761 data->module_handle);
762 return 0;
764 sensor_err:
765 hwmon_device_unregister(data->hwmon_dev);
766 hwmon_reg_err:
767 ipmi_destroy_user(data->ipmi.user);
768 ipmi_err:
769 dev_set_drvdata(&data->pdev->dev, NULL);
770 platform_device_unregister(data->pdev);
771 dev_err:
772 aem_idr_put(data->id);
773 id_err:
774 kfree(data);
776 return res;
779 /* Find and initialize all AEM2 instances */
780 static int aem_init_aem2(struct aem_ipmi_data *probe)
782 struct aem_find_instance_resp fi_resp;
783 int err;
784 int i = 0;
786 while (!aem_find_aem2(probe, &fi_resp, i)) {
787 if (fi_resp.major != 2) {
788 dev_err(probe->bmc_device, "Unknown AEM v%d; please "
789 "report this to the maintainer.\n",
790 fi_resp.major);
791 i++;
792 continue;
794 err = aem_init_aem2_inst(probe, &fi_resp);
795 if (err) {
796 dev_err(probe->bmc_device,
797 "Error %d initializing AEM2 0x%X\n",
798 err, fi_resp.module_handle);
799 return err;
801 i++;
804 return 0;
807 /* Probe a BMC for AEM firmware instances */
808 static void aem_register_bmc(int iface, struct device *dev)
810 struct aem_ipmi_data probe;
812 if (aem_init_ipmi_data(&probe, iface, dev))
813 return;
815 /* Ignore probe errors; they won't cause problems */
816 aem_init_aem1(&probe);
817 aem_init_aem2(&probe);
819 ipmi_destroy_user(probe.user);
822 /* Handle BMC deletion */
823 static void aem_bmc_gone(int iface)
825 struct aem_data *p1, *next1;
827 list_for_each_entry_safe(p1, next1, &driver_data.aem_devices, list)
828 if (p1->ipmi.interface == iface)
829 aem_delete(p1);
832 /* sysfs support functions */
834 /* AEM device name */
835 static ssize_t show_name(struct device *dev, struct device_attribute *devattr,
836 char *buf)
838 struct aem_data *data = dev_get_drvdata(dev);
840 return sprintf(buf, "%s%d\n", DRVNAME, data->ver_major);
842 static SENSOR_DEVICE_ATTR(name, S_IRUGO, show_name, NULL, 0);
844 /* AEM device version */
845 static ssize_t show_version(struct device *dev,
846 struct device_attribute *devattr,
847 char *buf)
849 struct aem_data *data = dev_get_drvdata(dev);
851 return sprintf(buf, "%d.%d\n", data->ver_major, data->ver_minor);
853 static SENSOR_DEVICE_ATTR(version, S_IRUGO, show_version, NULL, 0);
855 /* Display power use */
856 static ssize_t aem_show_power(struct device *dev,
857 struct device_attribute *devattr,
858 char *buf)
860 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
861 struct aem_data *data = dev_get_drvdata(dev);
862 u64 before, after, delta, time;
863 signed long leftover;
864 struct timespec b, a;
866 mutex_lock(&data->lock);
867 update_aem_energy_one(data, attr->index);
868 getnstimeofday(&b);
869 before = data->energy[attr->index];
871 leftover = schedule_timeout_interruptible(
872 msecs_to_jiffies(data->power_period[attr->index])
874 if (leftover) {
875 mutex_unlock(&data->lock);
876 return 0;
879 update_aem_energy_one(data, attr->index);
880 getnstimeofday(&a);
881 after = data->energy[attr->index];
882 mutex_unlock(&data->lock);
884 time = timespec_to_ns(&a) - timespec_to_ns(&b);
885 delta = (after - before) * UJ_PER_MJ;
887 return sprintf(buf, "%llu\n",
888 (unsigned long long)div64_u64(delta * NSEC_PER_SEC, time));
891 /* Display energy use */
892 static ssize_t aem_show_energy(struct device *dev,
893 struct device_attribute *devattr,
894 char *buf)
896 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
897 struct aem_data *a = dev_get_drvdata(dev);
898 mutex_lock(&a->lock);
899 update_aem_energy_one(a, attr->index);
900 mutex_unlock(&a->lock);
902 return sprintf(buf, "%llu\n",
903 (unsigned long long)a->energy[attr->index] * 1000);
906 /* Display power interval registers */
907 static ssize_t aem_show_power_period(struct device *dev,
908 struct device_attribute *devattr,
909 char *buf)
911 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
912 struct aem_data *a = dev_get_drvdata(dev);
913 a->update(a);
915 return sprintf(buf, "%lu\n", a->power_period[attr->index]);
918 /* Set power interval registers */
919 static ssize_t aem_set_power_period(struct device *dev,
920 struct device_attribute *devattr,
921 const char *buf, size_t count)
923 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
924 struct aem_data *a = dev_get_drvdata(dev);
925 unsigned long temp;
926 int res;
928 res = strict_strtoul(buf, 10, &temp);
929 if (res)
930 return res;
932 if (temp < AEM_MIN_POWER_INTERVAL)
933 return -EINVAL;
935 mutex_lock(&a->lock);
936 a->power_period[attr->index] = temp;
937 mutex_unlock(&a->lock);
939 return count;
942 /* Discover sensors on an AEM device */
943 static int aem_register_sensors(struct aem_data *data,
944 struct aem_ro_sensor_template *ro,
945 struct aem_rw_sensor_template *rw)
947 struct device *dev = &data->pdev->dev;
948 struct sensor_device_attribute *sensors = data->sensors;
949 int err;
951 /* Set up read-only sensors */
952 while (ro->label) {
953 sensors->dev_attr.attr.name = ro->label;
954 sensors->dev_attr.attr.mode = S_IRUGO;
955 sensors->dev_attr.show = ro->show;
956 sensors->index = ro->index;
958 err = device_create_file(dev, &sensors->dev_attr);
959 if (err) {
960 sensors->dev_attr.attr.name = NULL;
961 goto error;
963 sensors++;
964 ro++;
967 /* Set up read-write sensors */
968 while (rw->label) {
969 sensors->dev_attr.attr.name = rw->label;
970 sensors->dev_attr.attr.mode = S_IRUGO | S_IWUSR;
971 sensors->dev_attr.show = rw->show;
972 sensors->dev_attr.store = rw->set;
973 sensors->index = rw->index;
975 err = device_create_file(dev, &sensors->dev_attr);
976 if (err) {
977 sensors->dev_attr.attr.name = NULL;
978 goto error;
980 sensors++;
981 rw++;
984 err = device_create_file(dev, &sensor_dev_attr_name.dev_attr);
985 if (err)
986 goto error;
987 err = device_create_file(dev, &sensor_dev_attr_version.dev_attr);
988 return err;
990 error:
991 aem_remove_sensors(data);
992 return err;
995 /* sysfs support functions for AEM2 sensors */
997 /* Display temperature use */
998 static ssize_t aem2_show_temp(struct device *dev,
999 struct device_attribute *devattr,
1000 char *buf)
1002 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
1003 struct aem_data *a = dev_get_drvdata(dev);
1004 a->update(a);
1006 return sprintf(buf, "%u\n", a->temp[attr->index] * 1000);
1009 /* Display power-capping registers */
1010 static ssize_t aem2_show_pcap_value(struct device *dev,
1011 struct device_attribute *devattr,
1012 char *buf)
1014 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
1015 struct aem_data *a = dev_get_drvdata(dev);
1016 a->update(a);
1018 return sprintf(buf, "%u\n", a->pcap[attr->index] * 100000);
1021 /* Remove sensors attached to an AEM device */
1022 static void aem_remove_sensors(struct aem_data *data)
1024 int i;
1026 for (i = 0; i < AEM_NUM_SENSORS; i++) {
1027 if (!data->sensors[i].dev_attr.attr.name)
1028 continue;
1029 device_remove_file(&data->pdev->dev,
1030 &data->sensors[i].dev_attr);
1033 device_remove_file(&data->pdev->dev,
1034 &sensor_dev_attr_name.dev_attr);
1035 device_remove_file(&data->pdev->dev,
1036 &sensor_dev_attr_version.dev_attr);
1039 /* Sensor probe functions */
1041 /* Description of AEM1 sensors */
1042 static struct aem_ro_sensor_template aem1_ro_sensors[] = {
1043 {"energy1_input", aem_show_energy, 0},
1044 {"power1_average", aem_show_power, 0},
1045 {NULL, NULL, 0},
1048 static struct aem_rw_sensor_template aem1_rw_sensors[] = {
1049 {"power1_average_interval", aem_show_power_period, aem_set_power_period, 0},
1050 {NULL, NULL, NULL, 0},
1053 /* Description of AEM2 sensors */
1054 static struct aem_ro_sensor_template aem2_ro_sensors[] = {
1055 {"energy1_input", aem_show_energy, 0},
1056 {"energy2_input", aem_show_energy, 1},
1057 {"power1_average", aem_show_power, 0},
1058 {"power2_average", aem_show_power, 1},
1059 {"temp1_input", aem2_show_temp, 0},
1060 {"temp2_input", aem2_show_temp, 1},
1062 {"power4_average", aem2_show_pcap_value, POWER_CAP_MAX_HOTPLUG},
1063 {"power5_average", aem2_show_pcap_value, POWER_CAP_MAX},
1064 {"power6_average", aem2_show_pcap_value, POWER_CAP_MIN_WARNING},
1065 {"power7_average", aem2_show_pcap_value, POWER_CAP_MIN},
1067 {"power3_average", aem2_show_pcap_value, POWER_AUX},
1068 {"power_cap", aem2_show_pcap_value, POWER_CAP},
1069 {NULL, NULL, 0},
1072 static struct aem_rw_sensor_template aem2_rw_sensors[] = {
1073 {"power1_average_interval", aem_show_power_period, aem_set_power_period, 0},
1074 {"power2_average_interval", aem_show_power_period, aem_set_power_period, 1},
1075 {NULL, NULL, NULL, 0},
1078 /* Set up AEM1 sensor attrs */
1079 static int aem1_find_sensors(struct aem_data *data)
1081 return aem_register_sensors(data, aem1_ro_sensors, aem1_rw_sensors);
1084 /* Set up AEM2 sensor attrs */
1085 static int aem2_find_sensors(struct aem_data *data)
1087 return aem_register_sensors(data, aem2_ro_sensors, aem2_rw_sensors);
1090 /* Module init/exit routines */
1092 static int __init aem_init(void)
1094 int res;
1096 res = driver_register(&aem_driver.driver);
1097 if (res) {
1098 printk(KERN_ERR "Can't register aem driver\n");
1099 return res;
1102 res = ipmi_smi_watcher_register(&driver_data.bmc_events);
1103 if (res)
1104 goto ipmi_reg_err;
1105 return 0;
1107 ipmi_reg_err:
1108 driver_unregister(&aem_driver.driver);
1109 return res;
1113 static void __exit aem_exit(void)
1115 struct aem_data *p1, *next1;
1117 ipmi_smi_watcher_unregister(&driver_data.bmc_events);
1118 driver_unregister(&aem_driver.driver);
1119 list_for_each_entry_safe(p1, next1, &driver_data.aem_devices, list)
1120 aem_delete(p1);
1123 MODULE_AUTHOR("Darrick J. Wong <djwong@us.ibm.com>");
1124 MODULE_DESCRIPTION("IBM AEM power/temp/energy sensor driver");
1125 MODULE_LICENSE("GPL");
1127 module_init(aem_init);
1128 module_exit(aem_exit);
1130 MODULE_ALIAS("dmi:bvnIBM:*:pnIBMSystemx3350-*");
1131 MODULE_ALIAS("dmi:bvnIBM:*:pnIBMSystemx3550-*");
1132 MODULE_ALIAS("dmi:bvnIBM:*:pnIBMSystemx3650-*");
1133 MODULE_ALIAS("dmi:bvnIBM:*:pnIBMSystemx3655-*");
1134 MODULE_ALIAS("dmi:bvnIBM:*:pnIBMSystemx3755-*");
1135 MODULE_ALIAS("dmi:bvnIBM:*:pnIBM3850M2/x3950M2-*");
1136 MODULE_ALIAS("dmi:bvnIBM:*:pnIBMBladeHC10-*");