ibmaem: prevent infinite probing loop on x3650 M2 systems
[linux-2.6.git] / drivers / hwmon / ibmaem.c
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
5  *
6  * Author: Darrick J. Wong <djwong@us.ibm.com>
7  *
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.
12  *
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.
17  *
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
21  */
22
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/sched.h>
33 #include <linux/platform_device.h>
34 #include <linux/math64.h>
35 #include <linux/time.h>
36
37 #define REFRESH_INTERVAL        (HZ)
38 #define IPMI_TIMEOUT            (30 * HZ)
39 #define DRVNAME                 "aem"
40
41 #define AEM_NETFN               0x2E
42
43 #define AEM_FIND_FW_CMD         0x80
44 #define AEM_ELEMENT_CMD         0x81
45 #define AEM_FW_INSTANCE_CMD     0x82
46
47 #define AEM_READ_ELEMENT_CFG    0x80
48 #define AEM_READ_BUFFER         0x81
49 #define AEM_READ_REGISTER       0x82
50 #define AEM_WRITE_REGISTER      0x83
51 #define AEM_SET_REG_MASK        0x84
52 #define AEM_CLEAR_REG_MASK      0x85
53 #define AEM_READ_ELEMENT_CFG2   0x86
54
55 #define AEM_CONTROL_ELEMENT     0
56 #define AEM_ENERGY_ELEMENT      1
57 #define AEM_CLOCK_ELEMENT       4
58 #define AEM_POWER_CAP_ELEMENT   7
59 #define AEM_EXHAUST_ELEMENT     9
60 #define AEM_POWER_ELEMENT       10
61
62 #define AEM_MODULE_TYPE_ID      0x0001
63
64 #define AEM2_NUM_ENERGY_REGS    2
65 #define AEM2_NUM_PCAP_REGS      6
66 #define AEM2_NUM_TEMP_REGS      2
67 #define AEM2_NUM_SENSORS        14
68
69 #define AEM1_NUM_ENERGY_REGS    1
70 #define AEM1_NUM_SENSORS        3
71
72 /* AEM 2.x has more energy registers */
73 #define AEM_NUM_ENERGY_REGS     AEM2_NUM_ENERGY_REGS
74 /* AEM 2.x needs more sensor files */
75 #define AEM_NUM_SENSORS         AEM2_NUM_SENSORS
76
77 #define POWER_CAP               0
78 #define POWER_CAP_MAX_HOTPLUG   1
79 #define POWER_CAP_MAX           2
80 #define POWER_CAP_MIN_WARNING   3
81 #define POWER_CAP_MIN           4
82 #define POWER_AUX               5
83
84 #define AEM_DEFAULT_POWER_INTERVAL 1000
85 #define AEM_MIN_POWER_INTERVAL  200
86 #define UJ_PER_MJ               1000L
87
88 static DEFINE_IDR(aem_idr);
89 static DEFINE_SPINLOCK(aem_idr_lock);
90
91 static struct device_driver aem_driver = {
92         .name = DRVNAME,
93         .bus = &platform_bus_type,
94 };
95
96 struct aem_ipmi_data {
97         struct completion       read_complete;
98         struct ipmi_addr        address;
99         ipmi_user_t             user;
100         int                     interface;
101
102         struct kernel_ipmi_msg  tx_message;
103         long                    tx_msgid;
104
105         void                    *rx_msg_data;
106         unsigned short          rx_msg_len;
107         unsigned char           rx_result;
108         int                     rx_recv_type;
109
110         struct device           *bmc_device;
111 };
112
113 struct aem_ro_sensor_template {
114         char *label;
115         ssize_t (*show)(struct device *dev,
116                         struct device_attribute *devattr,
117                         char *buf);
118         int index;
119 };
120
121 struct aem_rw_sensor_template {
122         char *label;
123         ssize_t (*show)(struct device *dev,
124                         struct device_attribute *devattr,
125                         char *buf);
126         ssize_t (*set)(struct device *dev,
127                        struct device_attribute *devattr,
128                        const char *buf, size_t count);
129         int index;
130 };
131
132 struct aem_data {
133         struct list_head        list;
134
135         struct device           *hwmon_dev;
136         struct platform_device  *pdev;
137         struct mutex            lock;
138         char                    valid;
139         unsigned long           last_updated;   /* In jiffies */
140         u8                      ver_major;
141         u8                      ver_minor;
142         u8                      module_handle;
143         int                     id;
144         struct aem_ipmi_data    ipmi;
145
146         /* Function to update sensors */
147         void (*update)(struct aem_data *data);
148
149         /*
150          * AEM 1.x sensors:
151          * Available sensors:
152          * Energy meter
153          * Power meter
154          *
155          * AEM 2.x sensors:
156          * Two energy meters
157          * Two power meters
158          * Two temperature sensors
159          * Six power cap registers
160          */
161
162         /* sysfs attrs */
163         struct sensor_device_attribute  sensors[AEM_NUM_SENSORS];
164
165         /* energy use in mJ */
166         u64                     energy[AEM_NUM_ENERGY_REGS];
167
168         /* power sampling interval in ms */
169         unsigned long           power_period[AEM_NUM_ENERGY_REGS];
170
171         /* Everything past here is for AEM2 only */
172
173         /* power caps in dW */
174         u16                     pcap[AEM2_NUM_PCAP_REGS];
175
176         /* exhaust temperature in C */
177         u8                      temp[AEM2_NUM_TEMP_REGS];
178 };
179
180 /* Data structures returned by the AEM firmware */
181 struct aem_iana_id {
182         u8                      bytes[3];
183 };
184 static struct aem_iana_id system_x_id = {
185         .bytes = {0x4D, 0x4F, 0x00}
186 };
187
188 /* These are used to find AEM1 instances */
189 struct aem_find_firmware_req {
190         struct aem_iana_id      id;
191         u8                      rsvd;
192         __be16                  index;
193         __be16                  module_type_id;
194 } __packed;
195
196 struct aem_find_firmware_resp {
197         struct aem_iana_id      id;
198         u8                      num_instances;
199 } __packed;
200
201 /* These are used to find AEM2 instances */
202 struct aem_find_instance_req {
203         struct aem_iana_id      id;
204         u8                      instance_number;
205         __be16                  module_type_id;
206 } __packed;
207
208 struct aem_find_instance_resp {
209         struct aem_iana_id      id;
210         u8                      num_instances;
211         u8                      major;
212         u8                      minor;
213         u8                      module_handle;
214         u16                     record_id;
215 } __packed;
216
217 /* These are used to query sensors */
218 struct aem_read_sensor_req {
219         struct aem_iana_id      id;
220         u8                      module_handle;
221         u8                      element;
222         u8                      subcommand;
223         u8                      reg;
224         u8                      rx_buf_size;
225 } __packed;
226
227 struct aem_read_sensor_resp {
228         struct aem_iana_id      id;
229         u8                      bytes[0];
230 } __packed;
231
232 /* Data structures to talk to the IPMI layer */
233 struct aem_driver_data {
234         struct list_head        aem_devices;
235         struct ipmi_smi_watcher bmc_events;
236         struct ipmi_user_hndl   ipmi_hndlrs;
237 };
238
239 static void aem_register_bmc(int iface, struct device *dev);
240 static void aem_bmc_gone(int iface);
241 static void aem_msg_handler(struct ipmi_recv_msg *msg, void *user_msg_data);
242
243 static void aem_remove_sensors(struct aem_data *data);
244 static int aem_init_aem1(struct aem_ipmi_data *probe);
245 static int aem_init_aem2(struct aem_ipmi_data *probe);
246 static int aem1_find_sensors(struct aem_data *data);
247 static int aem2_find_sensors(struct aem_data *data);
248 static void update_aem1_sensors(struct aem_data *data);
249 static void update_aem2_sensors(struct aem_data *data);
250
251 static struct aem_driver_data driver_data = {
252         .aem_devices = LIST_HEAD_INIT(driver_data.aem_devices),
253         .bmc_events = {
254                 .owner = THIS_MODULE,
255                 .new_smi = aem_register_bmc,
256                 .smi_gone = aem_bmc_gone,
257         },
258         .ipmi_hndlrs = {
259                 .ipmi_recv_hndl = aem_msg_handler,
260         },
261 };
262
263 /* Functions to talk to the IPMI layer */
264
265 /* Initialize IPMI address, message buffers and user data */
266 static int aem_init_ipmi_data(struct aem_ipmi_data *data, int iface,
267                               struct device *bmc)
268 {
269         int err;
270
271         init_completion(&data->read_complete);
272         data->bmc_device = bmc;
273
274         /* Initialize IPMI address */
275         data->address.addr_type = IPMI_SYSTEM_INTERFACE_ADDR_TYPE;
276         data->address.channel = IPMI_BMC_CHANNEL;
277         data->address.data[0] = 0;
278         data->interface = iface;
279
280         /* Initialize message buffers */
281         data->tx_msgid = 0;
282         data->tx_message.netfn = AEM_NETFN;
283
284         /* Create IPMI messaging interface user */
285         err = ipmi_create_user(data->interface, &driver_data.ipmi_hndlrs,
286                                data, &data->user);
287         if (err < 0) {
288                 dev_err(bmc, "Unable to register user with IPMI "
289                         "interface %d\n", data->interface);
290                 return -EACCES;
291         }
292
293         return 0;
294 }
295
296 /* Send an IPMI command */
297 static int aem_send_message(struct aem_ipmi_data *data)
298 {
299         int err;
300
301         err = ipmi_validate_addr(&data->address, sizeof(data->address));
302         if (err)
303                 goto out;
304
305         data->tx_msgid++;
306         err = ipmi_request_settime(data->user, &data->address, data->tx_msgid,
307                                    &data->tx_message, data, 0, 0, 0);
308         if (err)
309                 goto out1;
310
311         return 0;
312 out1:
313         dev_err(data->bmc_device, "request_settime=%x\n", err);
314         return err;
315 out:
316         dev_err(data->bmc_device, "validate_addr=%x\n", err);
317         return err;
318 }
319
320 /* Dispatch IPMI messages to callers */
321 static void aem_msg_handler(struct ipmi_recv_msg *msg, void *user_msg_data)
322 {
323         unsigned short rx_len;
324         struct aem_ipmi_data *data = user_msg_data;
325
326         if (msg->msgid != data->tx_msgid) {
327                 dev_err(data->bmc_device, "Mismatch between received msgid "
328                         "(%02x) and transmitted msgid (%02x)!\n",
329                         (int)msg->msgid,
330                         (int)data->tx_msgid);
331                 ipmi_free_recv_msg(msg);
332                 return;
333         }
334
335         data->rx_recv_type = msg->recv_type;
336         if (msg->msg.data_len > 0)
337                 data->rx_result = msg->msg.data[0];
338         else
339                 data->rx_result = IPMI_UNKNOWN_ERR_COMPLETION_CODE;
340
341         if (msg->msg.data_len > 1) {
342                 rx_len = msg->msg.data_len - 1;
343                 if (data->rx_msg_len < rx_len)
344                         rx_len = data->rx_msg_len;
345                 data->rx_msg_len = rx_len;
346                 memcpy(data->rx_msg_data, msg->msg.data + 1, data->rx_msg_len);
347         } else
348                 data->rx_msg_len = 0;
349
350         ipmi_free_recv_msg(msg);
351         complete(&data->read_complete);
352 }
353
354 /* ID functions */
355
356 /* Obtain an id */
357 static int aem_idr_get(int *id)
358 {
359         int i, err;
360
361 again:
362         if (unlikely(!idr_pre_get(&aem_idr, GFP_KERNEL)))
363                 return -ENOMEM;
364
365         spin_lock(&aem_idr_lock);
366         err = idr_get_new(&aem_idr, NULL, &i);
367         spin_unlock(&aem_idr_lock);
368
369         if (unlikely(err == -EAGAIN))
370                 goto again;
371         else if (unlikely(err))
372                 return err;
373
374         *id = i & MAX_ID_MASK;
375         return 0;
376 }
377
378 /* Release an object ID */
379 static void aem_idr_put(int id)
380 {
381         spin_lock(&aem_idr_lock);
382         idr_remove(&aem_idr, id);
383         spin_unlock(&aem_idr_lock);
384 }
385
386 /* Sensor support functions */
387
388 /* Read a sensor value */
389 static int aem_read_sensor(struct aem_data *data, u8 elt, u8 reg,
390                            void *buf, size_t size)
391 {
392         int rs_size, res;
393         struct aem_read_sensor_req rs_req;
394         struct aem_read_sensor_resp *rs_resp;
395         struct aem_ipmi_data *ipmi = &data->ipmi;
396
397         /* AEM registers are 1, 2, 4 or 8 bytes */
398         switch (size) {
399         case 1:
400         case 2:
401         case 4:
402         case 8:
403                 break;
404         default:
405                 return -EINVAL;
406         }
407
408         rs_req.id = system_x_id;
409         rs_req.module_handle = data->module_handle;
410         rs_req.element = elt;
411         rs_req.subcommand = AEM_READ_REGISTER;
412         rs_req.reg = reg;
413         rs_req.rx_buf_size = size;
414
415         ipmi->tx_message.cmd = AEM_ELEMENT_CMD;
416         ipmi->tx_message.data = (char *)&rs_req;
417         ipmi->tx_message.data_len = sizeof(rs_req);
418
419         rs_size = sizeof(*rs_resp) + size;
420         rs_resp = kzalloc(rs_size, GFP_KERNEL);
421         if (!rs_resp)
422                 return -ENOMEM;
423
424         ipmi->rx_msg_data = rs_resp;
425         ipmi->rx_msg_len = rs_size;
426
427         aem_send_message(ipmi);
428
429         res = wait_for_completion_timeout(&ipmi->read_complete, IPMI_TIMEOUT);
430         if (!res)
431                 return -ETIMEDOUT;
432
433         if (ipmi->rx_result || ipmi->rx_msg_len != rs_size ||
434             memcmp(&rs_resp->id, &system_x_id, sizeof(system_x_id))) {
435                 kfree(rs_resp);
436                 return -ENOENT;
437         }
438
439         switch (size) {
440         case 1: {
441                 u8 *x = buf;
442                 *x = rs_resp->bytes[0];
443                 break;
444         }
445         case 2: {
446                 u16 *x = buf;
447                 *x = be16_to_cpup((__be16 *)rs_resp->bytes);
448                 break;
449         }
450         case 4: {
451                 u32 *x = buf;
452                 *x = be32_to_cpup((__be32 *)rs_resp->bytes);
453                 break;
454         }
455         case 8: {
456                 u64 *x = buf;
457                 *x = be64_to_cpup((__be64 *)rs_resp->bytes);
458                 break;
459         }
460         }
461
462         return 0;
463 }
464
465 /* Update AEM energy registers */
466 static void update_aem_energy(struct aem_data *data)
467 {
468         aem_read_sensor(data, AEM_ENERGY_ELEMENT, 0, &data->energy[0], 8);
469         if (data->ver_major < 2)
470                 return;
471         aem_read_sensor(data, AEM_ENERGY_ELEMENT, 1, &data->energy[1], 8);
472 }
473
474 /* Update all AEM1 sensors */
475 static void update_aem1_sensors(struct aem_data *data)
476 {
477         mutex_lock(&data->lock);
478         if (time_before(jiffies, data->last_updated + REFRESH_INTERVAL) &&
479             data->valid)
480                 goto out;
481
482         update_aem_energy(data);
483 out:
484         mutex_unlock(&data->lock);
485 }
486
487 /* Update all AEM2 sensors */
488 static void update_aem2_sensors(struct aem_data *data)
489 {
490         int i;
491
492         mutex_lock(&data->lock);
493         if (time_before(jiffies, data->last_updated + REFRESH_INTERVAL) &&
494             data->valid)
495                 goto out;
496
497         update_aem_energy(data);
498         aem_read_sensor(data, AEM_EXHAUST_ELEMENT, 0, &data->temp[0], 1);
499         aem_read_sensor(data, AEM_EXHAUST_ELEMENT, 1, &data->temp[1], 1);
500
501         for (i = POWER_CAP; i <= POWER_AUX; i++)
502                 aem_read_sensor(data, AEM_POWER_CAP_ELEMENT, i,
503                                 &data->pcap[i], 2);
504 out:
505         mutex_unlock(&data->lock);
506 }
507
508 /* Delete an AEM instance */
509 static void aem_delete(struct aem_data *data)
510 {
511         list_del(&data->list);
512         aem_remove_sensors(data);
513         hwmon_device_unregister(data->hwmon_dev);
514         ipmi_destroy_user(data->ipmi.user);
515         dev_set_drvdata(&data->pdev->dev, NULL);
516         platform_device_unregister(data->pdev);
517         aem_idr_put(data->id);
518         kfree(data);
519 }
520
521 /* Probe functions for AEM1 devices */
522
523 /* Retrieve version and module handle for an AEM1 instance */
524 static int aem_find_aem1_count(struct aem_ipmi_data *data)
525 {
526         int res;
527         struct aem_find_firmware_req    ff_req;
528         struct aem_find_firmware_resp   ff_resp;
529
530         ff_req.id = system_x_id;
531         ff_req.index = 0;
532         ff_req.module_type_id = cpu_to_be16(AEM_MODULE_TYPE_ID);
533
534         data->tx_message.cmd = AEM_FIND_FW_CMD;
535         data->tx_message.data = (char *)&ff_req;
536         data->tx_message.data_len = sizeof(ff_req);
537
538         data->rx_msg_data = &ff_resp;
539         data->rx_msg_len = sizeof(ff_resp);
540
541         aem_send_message(data);
542
543         res = wait_for_completion_timeout(&data->read_complete, IPMI_TIMEOUT);
544         if (!res)
545                 return -ETIMEDOUT;
546
547         if (data->rx_result || data->rx_msg_len != sizeof(ff_resp) ||
548             memcmp(&ff_resp.id, &system_x_id, sizeof(system_x_id)))
549                 return -ENOENT;
550
551         return ff_resp.num_instances;
552 }
553
554 /* Find and initialize one AEM1 instance */
555 static int aem_init_aem1_inst(struct aem_ipmi_data *probe, u8 module_handle)
556 {
557         struct aem_data *data;
558         int i;
559         int res = -ENOMEM;
560
561         data = kzalloc(sizeof(*data), GFP_KERNEL);
562         if (!data)
563                 return res;
564         mutex_init(&data->lock);
565
566         /* Copy instance data */
567         data->ver_major = 1;
568         data->ver_minor = 0;
569         data->module_handle = module_handle;
570         for (i = 0; i < AEM1_NUM_ENERGY_REGS; i++)
571                 data->power_period[i] = AEM_DEFAULT_POWER_INTERVAL;
572
573         /* Create sub-device for this fw instance */
574         if (aem_idr_get(&data->id))
575                 goto id_err;
576
577         data->pdev = platform_device_alloc(DRVNAME, data->id);
578         if (!data->pdev)
579                 goto dev_err;
580         data->pdev->dev.driver = &aem_driver;
581
582         res = platform_device_add(data->pdev);
583         if (res)
584                 goto ipmi_err;
585
586         dev_set_drvdata(&data->pdev->dev, data);
587
588         /* Set up IPMI interface */
589         if (aem_init_ipmi_data(&data->ipmi, probe->interface,
590                                probe->bmc_device))
591                 goto ipmi_err;
592
593         /* Register with hwmon */
594         data->hwmon_dev = hwmon_device_register(&data->pdev->dev);
595
596         if (IS_ERR(data->hwmon_dev)) {
597                 dev_err(&data->pdev->dev, "Unable to register hwmon "
598                         "device for IPMI interface %d\n",
599                         probe->interface);
600                 goto hwmon_reg_err;
601         }
602
603         data->update = update_aem1_sensors;
604
605         /* Find sensors */
606         if (aem1_find_sensors(data))
607                 goto sensor_err;
608
609         /* Add to our list of AEM devices */
610         list_add_tail(&data->list, &driver_data.aem_devices);
611
612         dev_info(data->ipmi.bmc_device, "Found AEM v%d.%d at 0x%X\n",
613                  data->ver_major, data->ver_minor,
614                  data->module_handle);
615         return 0;
616
617 sensor_err:
618         hwmon_device_unregister(data->hwmon_dev);
619 hwmon_reg_err:
620         ipmi_destroy_user(data->ipmi.user);
621 ipmi_err:
622         dev_set_drvdata(&data->pdev->dev, NULL);
623         platform_device_unregister(data->pdev);
624 dev_err:
625         aem_idr_put(data->id);
626 id_err:
627         kfree(data);
628
629         return res;
630 }
631
632 /* Find and initialize all AEM1 instances */
633 static int aem_init_aem1(struct aem_ipmi_data *probe)
634 {
635         int num, i, err;
636
637         num = aem_find_aem1_count(probe);
638         for (i = 0; i < num; i++) {
639                 err = aem_init_aem1_inst(probe, i);
640                 if (err) {
641                         dev_err(probe->bmc_device,
642                                 "Error %d initializing AEM1 0x%X\n",
643                                 err, i);
644                         return err;
645                 }
646         }
647
648         return 0;
649 }
650
651 /* Probe functions for AEM2 devices */
652
653 /* Retrieve version and module handle for an AEM2 instance */
654 static int aem_find_aem2(struct aem_ipmi_data *data,
655                             struct aem_find_instance_resp *fi_resp,
656                             int instance_num)
657 {
658         int res;
659         struct aem_find_instance_req fi_req;
660
661         fi_req.id = system_x_id;
662         fi_req.instance_number = instance_num;
663         fi_req.module_type_id = cpu_to_be16(AEM_MODULE_TYPE_ID);
664
665         data->tx_message.cmd = AEM_FW_INSTANCE_CMD;
666         data->tx_message.data = (char *)&fi_req;
667         data->tx_message.data_len = sizeof(fi_req);
668
669         data->rx_msg_data = fi_resp;
670         data->rx_msg_len = sizeof(*fi_resp);
671
672         aem_send_message(data);
673
674         res = wait_for_completion_timeout(&data->read_complete, IPMI_TIMEOUT);
675         if (!res)
676                 return -ETIMEDOUT;
677
678         if (data->rx_result || data->rx_msg_len != sizeof(*fi_resp) ||
679             memcmp(&fi_resp->id, &system_x_id, sizeof(system_x_id)) ||
680             fi_resp->num_instances <= instance_num)
681                 return -ENOENT;
682
683         return 0;
684 }
685
686 /* Find and initialize one AEM2 instance */
687 static int aem_init_aem2_inst(struct aem_ipmi_data *probe,
688                               struct aem_find_instance_resp *fi_resp)
689 {
690         struct aem_data *data;
691         int i;
692         int res = -ENOMEM;
693
694         data = kzalloc(sizeof(*data), GFP_KERNEL);
695         if (!data)
696                 return res;
697         mutex_init(&data->lock);
698
699         /* Copy instance data */
700         data->ver_major = fi_resp->major;
701         data->ver_minor = fi_resp->minor;
702         data->module_handle = fi_resp->module_handle;
703         for (i = 0; i < AEM2_NUM_ENERGY_REGS; i++)
704                 data->power_period[i] = AEM_DEFAULT_POWER_INTERVAL;
705
706         /* Create sub-device for this fw instance */
707         if (aem_idr_get(&data->id))
708                 goto id_err;
709
710         data->pdev = platform_device_alloc(DRVNAME, data->id);
711         if (!data->pdev)
712                 goto dev_err;
713         data->pdev->dev.driver = &aem_driver;
714
715         res = platform_device_add(data->pdev);
716         if (res)
717                 goto ipmi_err;
718
719         dev_set_drvdata(&data->pdev->dev, data);
720
721         /* Set up IPMI interface */
722         if (aem_init_ipmi_data(&data->ipmi, probe->interface,
723                                probe->bmc_device))
724                 goto ipmi_err;
725
726         /* Register with hwmon */
727         data->hwmon_dev = hwmon_device_register(&data->pdev->dev);
728
729         if (IS_ERR(data->hwmon_dev)) {
730                 dev_err(&data->pdev->dev, "Unable to register hwmon "
731                         "device for IPMI interface %d\n",
732                         probe->interface);
733                 goto hwmon_reg_err;
734         }
735
736         data->update = update_aem2_sensors;
737
738         /* Find sensors */
739         if (aem2_find_sensors(data))
740                 goto sensor_err;
741
742         /* Add to our list of AEM devices */
743         list_add_tail(&data->list, &driver_data.aem_devices);
744
745         dev_info(data->ipmi.bmc_device, "Found AEM v%d.%d at 0x%X\n",
746                  data->ver_major, data->ver_minor,
747                  data->module_handle);
748         return 0;
749
750 sensor_err:
751         hwmon_device_unregister(data->hwmon_dev);
752 hwmon_reg_err:
753         ipmi_destroy_user(data->ipmi.user);
754 ipmi_err:
755         dev_set_drvdata(&data->pdev->dev, NULL);
756         platform_device_unregister(data->pdev);
757 dev_err:
758         aem_idr_put(data->id);
759 id_err:
760         kfree(data);
761
762         return res;
763 }
764
765 /* Find and initialize all AEM2 instances */
766 static int aem_init_aem2(struct aem_ipmi_data *probe)
767 {
768         struct aem_find_instance_resp fi_resp;
769         int err;
770         int i = 0;
771
772         while (!aem_find_aem2(probe, &fi_resp, i)) {
773                 if (fi_resp.major != 2) {
774                         dev_err(probe->bmc_device, "Unknown AEM v%d; please "
775                                 "report this to the maintainer.\n",
776                                 fi_resp.major);
777                         i++;
778                         continue;
779                 }
780                 err = aem_init_aem2_inst(probe, &fi_resp);
781                 if (err) {
782                         dev_err(probe->bmc_device,
783                                 "Error %d initializing AEM2 0x%X\n",
784                                 err, fi_resp.module_handle);
785                         return err;
786                 }
787                 i++;
788         }
789
790         return 0;
791 }
792
793 /* Probe a BMC for AEM firmware instances */
794 static void aem_register_bmc(int iface, struct device *dev)
795 {
796         struct aem_ipmi_data probe;
797
798         if (aem_init_ipmi_data(&probe, iface, dev))
799                 return;
800
801         /* Ignore probe errors; they won't cause problems */
802         aem_init_aem1(&probe);
803         aem_init_aem2(&probe);
804
805         ipmi_destroy_user(probe.user);
806 }
807
808 /* Handle BMC deletion */
809 static void aem_bmc_gone(int iface)
810 {
811         struct aem_data *p1, *next1;
812
813         list_for_each_entry_safe(p1, next1, &driver_data.aem_devices, list)
814                 if (p1->ipmi.interface == iface)
815                         aem_delete(p1);
816 }
817
818 /* sysfs support functions */
819
820 /* AEM device name */
821 static ssize_t show_name(struct device *dev, struct device_attribute *devattr,
822                          char *buf)
823 {
824         struct aem_data *data = dev_get_drvdata(dev);
825
826         return sprintf(buf, "%s%d\n", DRVNAME, data->ver_major);
827 }
828 static SENSOR_DEVICE_ATTR(name, S_IRUGO, show_name, NULL, 0);
829
830 /* AEM device version */
831 static ssize_t show_version(struct device *dev,
832                             struct device_attribute *devattr,
833                             char *buf)
834 {
835         struct aem_data *data = dev_get_drvdata(dev);
836
837         return sprintf(buf, "%d.%d\n", data->ver_major, data->ver_minor);
838 }
839 static SENSOR_DEVICE_ATTR(version, S_IRUGO, show_version, NULL, 0);
840
841 /* Display power use */
842 static ssize_t aem_show_power(struct device *dev,
843                               struct device_attribute *devattr,
844                               char *buf)
845 {
846         struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
847         struct aem_data *data = dev_get_drvdata(dev);
848         u64 before, after, delta, time;
849         signed long leftover;
850         struct timespec b, a;
851
852         mutex_lock(&data->lock);
853         update_aem_energy(data);
854         getnstimeofday(&b);
855         before = data->energy[attr->index];
856
857         leftover = schedule_timeout_interruptible(
858                         msecs_to_jiffies(data->power_period[attr->index])
859                    );
860         if (leftover) {
861                 mutex_unlock(&data->lock);
862                 return 0;
863         }
864
865         update_aem_energy(data);
866         getnstimeofday(&a);
867         after = data->energy[attr->index];
868         mutex_unlock(&data->lock);
869
870         time = timespec_to_ns(&a) - timespec_to_ns(&b);
871         delta = (after - before) * UJ_PER_MJ;
872
873         return sprintf(buf, "%llu\n",
874                 (unsigned long long)div64_u64(delta * NSEC_PER_SEC, time));
875 }
876
877 /* Display energy use */
878 static ssize_t aem_show_energy(struct device *dev,
879                                struct device_attribute *devattr,
880                                char *buf)
881 {
882         struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
883         struct aem_data *a = dev_get_drvdata(dev);
884         a->update(a);
885
886         return sprintf(buf, "%llu\n",
887                         (unsigned long long)a->energy[attr->index] * 1000);
888 }
889
890 /* Display power interval registers */
891 static ssize_t aem_show_power_period(struct device *dev,
892                                      struct device_attribute *devattr,
893                                      char *buf)
894 {
895         struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
896         struct aem_data *a = dev_get_drvdata(dev);
897         a->update(a);
898
899         return sprintf(buf, "%lu\n", a->power_period[attr->index]);
900 }
901
902 /* Set power interval registers */
903 static ssize_t aem_set_power_period(struct device *dev,
904                                     struct device_attribute *devattr,
905                                     const char *buf, size_t count)
906 {
907         struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
908         struct aem_data *a = dev_get_drvdata(dev);
909         unsigned long temp;
910         int res;
911
912         res = strict_strtoul(buf, 10, &temp);
913         if (res)
914                 return res;
915
916         if (temp < AEM_MIN_POWER_INTERVAL)
917                 return -EINVAL;
918
919         mutex_lock(&a->lock);
920         a->power_period[attr->index] = temp;
921         mutex_unlock(&a->lock);
922
923         return count;
924 }
925
926 /* Discover sensors on an AEM device */
927 static int aem_register_sensors(struct aem_data *data,
928                                 struct aem_ro_sensor_template *ro,
929                                 struct aem_rw_sensor_template *rw)
930 {
931         struct device *dev = &data->pdev->dev;
932         struct sensor_device_attribute *sensors = data->sensors;
933         int err;
934
935         /* Set up read-only sensors */
936         while (ro->label) {
937                 sensors->dev_attr.attr.name = ro->label;
938                 sensors->dev_attr.attr.mode = S_IRUGO;
939                 sensors->dev_attr.show = ro->show;
940                 sensors->index = ro->index;
941
942                 err = device_create_file(dev, &sensors->dev_attr);
943                 if (err) {
944                         sensors->dev_attr.attr.name = NULL;
945                         goto error;
946                 }
947                 sensors++;
948                 ro++;
949         }
950
951         /* Set up read-write sensors */
952         while (rw->label) {
953                 sensors->dev_attr.attr.name = rw->label;
954                 sensors->dev_attr.attr.mode = S_IRUGO | S_IWUSR;
955                 sensors->dev_attr.show = rw->show;
956                 sensors->dev_attr.store = rw->set;
957                 sensors->index = rw->index;
958
959                 err = device_create_file(dev, &sensors->dev_attr);
960                 if (err) {
961                         sensors->dev_attr.attr.name = NULL;
962                         goto error;
963                 }
964                 sensors++;
965                 rw++;
966         }
967
968         err = device_create_file(dev, &sensor_dev_attr_name.dev_attr);
969         if (err)
970                 goto error;
971         err = device_create_file(dev, &sensor_dev_attr_version.dev_attr);
972         return err;
973
974 error:
975         aem_remove_sensors(data);
976         return err;
977 }
978
979 /* sysfs support functions for AEM2 sensors */
980
981 /* Display temperature use */
982 static ssize_t aem2_show_temp(struct device *dev,
983                               struct device_attribute *devattr,
984                               char *buf)
985 {
986         struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
987         struct aem_data *a = dev_get_drvdata(dev);
988         a->update(a);
989
990         return sprintf(buf, "%u\n", a->temp[attr->index] * 1000);
991 }
992
993 /* Display power-capping registers */
994 static ssize_t aem2_show_pcap_value(struct device *dev,
995                                     struct device_attribute *devattr,
996                                     char *buf)
997 {
998         struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
999         struct aem_data *a = dev_get_drvdata(dev);
1000         a->update(a);
1001
1002         return sprintf(buf, "%u\n", a->pcap[attr->index] * 100000);
1003 }
1004
1005 /* Remove sensors attached to an AEM device */
1006 static void aem_remove_sensors(struct aem_data *data)
1007 {
1008         int i;
1009
1010         for (i = 0; i < AEM_NUM_SENSORS; i++) {
1011                 if (!data->sensors[i].dev_attr.attr.name)
1012                         continue;
1013                 device_remove_file(&data->pdev->dev,
1014                                    &data->sensors[i].dev_attr);
1015         }
1016
1017         device_remove_file(&data->pdev->dev,
1018                            &sensor_dev_attr_name.dev_attr);
1019         device_remove_file(&data->pdev->dev,
1020                            &sensor_dev_attr_version.dev_attr);
1021 }
1022
1023 /* Sensor probe functions */
1024
1025 /* Description of AEM1 sensors */
1026 static struct aem_ro_sensor_template aem1_ro_sensors[] = {
1027 {"energy1_input",  aem_show_energy, 0},
1028 {"power1_average", aem_show_power,  0},
1029 {NULL,             NULL,            0},
1030 };
1031
1032 static struct aem_rw_sensor_template aem1_rw_sensors[] = {
1033 {"power1_average_interval", aem_show_power_period, aem_set_power_period, 0},
1034 {NULL,                      NULL,                  NULL,                 0},
1035 };
1036
1037 /* Description of AEM2 sensors */
1038 static struct aem_ro_sensor_template aem2_ro_sensors[] = {
1039 {"energy1_input",         aem_show_energy,      0},
1040 {"energy2_input",         aem_show_energy,      1},
1041 {"power1_average",        aem_show_power,       0},
1042 {"power2_average",        aem_show_power,       1},
1043 {"temp1_input",           aem2_show_temp,       0},
1044 {"temp2_input",           aem2_show_temp,       1},
1045
1046 {"power4_average",        aem2_show_pcap_value, POWER_CAP_MAX_HOTPLUG},
1047 {"power5_average",        aem2_show_pcap_value, POWER_CAP_MAX},
1048 {"power6_average",        aem2_show_pcap_value, POWER_CAP_MIN_WARNING},
1049 {"power7_average",        aem2_show_pcap_value, POWER_CAP_MIN},
1050
1051 {"power3_average",        aem2_show_pcap_value, POWER_AUX},
1052 {"power_cap",             aem2_show_pcap_value, POWER_CAP},
1053 {NULL,                    NULL,                 0},
1054 };
1055
1056 static struct aem_rw_sensor_template aem2_rw_sensors[] = {
1057 {"power1_average_interval", aem_show_power_period, aem_set_power_period, 0},
1058 {"power2_average_interval", aem_show_power_period, aem_set_power_period, 1},
1059 {NULL,                      NULL,                  NULL,                 0},
1060 };
1061
1062 /* Set up AEM1 sensor attrs */
1063 static int aem1_find_sensors(struct aem_data *data)
1064 {
1065         return aem_register_sensors(data, aem1_ro_sensors, aem1_rw_sensors);
1066 }
1067
1068 /* Set up AEM2 sensor attrs */
1069 static int aem2_find_sensors(struct aem_data *data)
1070 {
1071         return aem_register_sensors(data, aem2_ro_sensors, aem2_rw_sensors);
1072 }
1073
1074 /* Module init/exit routines */
1075
1076 static int __init aem_init(void)
1077 {
1078         int res;
1079
1080         res = driver_register(&aem_driver);
1081         if (res) {
1082                 printk(KERN_ERR "Can't register aem driver\n");
1083                 return res;
1084         }
1085
1086         res = ipmi_smi_watcher_register(&driver_data.bmc_events);
1087         if (res)
1088                 goto ipmi_reg_err;
1089         return 0;
1090
1091 ipmi_reg_err:
1092         driver_unregister(&aem_driver);
1093         return res;
1094
1095 }
1096
1097 static void __exit aem_exit(void)
1098 {
1099         struct aem_data *p1, *next1;
1100
1101         ipmi_smi_watcher_unregister(&driver_data.bmc_events);
1102         driver_unregister(&aem_driver);
1103         list_for_each_entry_safe(p1, next1, &driver_data.aem_devices, list)
1104                 aem_delete(p1);
1105 }
1106
1107 MODULE_AUTHOR("Darrick J. Wong <djwong@us.ibm.com>");
1108 MODULE_DESCRIPTION("IBM AEM power/temp/energy sensor driver");
1109 MODULE_LICENSE("GPL");
1110
1111 module_init(aem_init);
1112 module_exit(aem_exit);