Back to home page

OSCL-LXR
 
 

     

0001 // SPDX-License-Identifier: GPL-2.0-or-later
0002 /*
0003  * A hwmon driver for the IBM PowerExecutive temperature/power sensors
0004  * Copyright (C) 2007 IBM
0005  *
0006  * Author: Darrick J. Wong <darrick.wong@oracle.com>
0007  */
0008 
0009 #include <linux/ipmi.h>
0010 #include <linux/module.h>
0011 #include <linux/hwmon.h>
0012 #include <linux/hwmon-sysfs.h>
0013 #include <linux/jiffies.h>
0014 #include <linux/mutex.h>
0015 #include <linux/slab.h>
0016 #include <linux/err.h>
0017 
0018 #define REFRESH_INTERVAL    (2 * HZ)
0019 #define DRVNAME         "ibmpex"
0020 
0021 #define PEX_GET_VERSION     1
0022 #define PEX_GET_SENSOR_COUNT    2
0023 #define PEX_GET_SENSOR_NAME 3
0024 #define PEX_RESET_HIGH_LOW  4
0025 #define PEX_GET_SENSOR_DATA 6
0026 
0027 #define PEX_NET_FUNCTION    0x3A
0028 #define PEX_COMMAND     0x3C
0029 
0030 static inline u16 extract_value(const char *data, int offset)
0031 {
0032     return be16_to_cpup((__be16 *)&data[offset]);
0033 }
0034 
0035 #define TEMP_SENSOR     1
0036 #define POWER_SENSOR        2
0037 
0038 #define PEX_SENSOR_TYPE_LEN 3
0039 static u8 const power_sensor_sig[] = {0x70, 0x77, 0x72};
0040 static u8 const temp_sensor_sig[]  = {0x74, 0x65, 0x6D};
0041 
0042 #define PEX_MULT_LEN        2
0043 static u8 const watt_sensor_sig[]  = {0x41, 0x43};
0044 
0045 #define PEX_NUM_SENSOR_FUNCS    3
0046 static const char * const sensor_name_suffixes[] = {
0047     "",
0048     "_lowest",
0049     "_highest"
0050 };
0051 
0052 static void ibmpex_msg_handler(struct ipmi_recv_msg *msg, void *user_msg_data);
0053 static void ibmpex_register_bmc(int iface, struct device *dev);
0054 static void ibmpex_bmc_gone(int iface);
0055 
0056 struct ibmpex_sensor_data {
0057     int         in_use;
0058     s16         values[PEX_NUM_SENSOR_FUNCS];
0059     int         multiplier;
0060 
0061     struct sensor_device_attribute_2    attr[PEX_NUM_SENSOR_FUNCS];
0062 };
0063 
0064 struct ibmpex_bmc_data {
0065     struct list_head    list;
0066     struct device       *hwmon_dev;
0067     struct device       *bmc_device;
0068     struct mutex        lock;
0069     bool            valid;
0070     unsigned long       last_updated;   /* In jiffies */
0071 
0072     struct ipmi_addr    address;
0073     struct completion   read_complete;
0074     struct ipmi_user    *user;
0075     int         interface;
0076 
0077     struct kernel_ipmi_msg  tx_message;
0078     unsigned char       tx_msg_data[IPMI_MAX_MSG_LENGTH];
0079     long            tx_msgid;
0080 
0081     unsigned char       rx_msg_data[IPMI_MAX_MSG_LENGTH];
0082     unsigned long       rx_msg_len;
0083     unsigned char       rx_result;
0084     int         rx_recv_type;
0085 
0086     unsigned char       sensor_major;
0087     unsigned char       sensor_minor;
0088 
0089     unsigned char       num_sensors;
0090     struct ibmpex_sensor_data   *sensors;
0091 };
0092 
0093 struct ibmpex_driver_data {
0094     struct list_head    bmc_data;
0095     struct ipmi_smi_watcher bmc_events;
0096     struct ipmi_user_hndl   ipmi_hndlrs;
0097 };
0098 
0099 static struct ibmpex_driver_data driver_data = {
0100     .bmc_data = LIST_HEAD_INIT(driver_data.bmc_data),
0101     .bmc_events = {
0102         .owner = THIS_MODULE,
0103         .new_smi = ibmpex_register_bmc,
0104         .smi_gone = ibmpex_bmc_gone,
0105     },
0106     .ipmi_hndlrs = {
0107         .ipmi_recv_hndl = ibmpex_msg_handler,
0108     },
0109 };
0110 
0111 static int ibmpex_send_message(struct ibmpex_bmc_data *data)
0112 {
0113     int err;
0114 
0115     err = ipmi_validate_addr(&data->address, sizeof(data->address));
0116     if (err)
0117         goto out;
0118 
0119     data->tx_msgid++;
0120     err = ipmi_request_settime(data->user, &data->address, data->tx_msgid,
0121                    &data->tx_message, data, 0, 0, 0);
0122     if (err)
0123         goto out1;
0124 
0125     return 0;
0126 out1:
0127     dev_err(data->bmc_device, "request_settime=%x\n", err);
0128     return err;
0129 out:
0130     dev_err(data->bmc_device, "validate_addr=%x\n", err);
0131     return err;
0132 }
0133 
0134 static int ibmpex_ver_check(struct ibmpex_bmc_data *data)
0135 {
0136     data->tx_msg_data[0] = PEX_GET_VERSION;
0137     data->tx_message.data_len = 1;
0138     ibmpex_send_message(data);
0139 
0140     wait_for_completion(&data->read_complete);
0141 
0142     if (data->rx_result || data->rx_msg_len != 6)
0143         return -ENOENT;
0144 
0145     data->sensor_major = data->rx_msg_data[0];
0146     data->sensor_minor = data->rx_msg_data[1];
0147 
0148     dev_info(data->bmc_device,
0149          "Found BMC with sensor interface v%d.%d %d-%02d-%02d on interface %d\n",
0150          data->sensor_major,
0151          data->sensor_minor,
0152          extract_value(data->rx_msg_data, 2),
0153          data->rx_msg_data[4],
0154          data->rx_msg_data[5],
0155          data->interface);
0156 
0157     return 0;
0158 }
0159 
0160 static int ibmpex_query_sensor_count(struct ibmpex_bmc_data *data)
0161 {
0162     data->tx_msg_data[0] = PEX_GET_SENSOR_COUNT;
0163     data->tx_message.data_len = 1;
0164     ibmpex_send_message(data);
0165 
0166     wait_for_completion(&data->read_complete);
0167 
0168     if (data->rx_result || data->rx_msg_len != 1)
0169         return -ENOENT;
0170 
0171     return data->rx_msg_data[0];
0172 }
0173 
0174 static int ibmpex_query_sensor_name(struct ibmpex_bmc_data *data, int sensor)
0175 {
0176     data->tx_msg_data[0] = PEX_GET_SENSOR_NAME;
0177     data->tx_msg_data[1] = sensor;
0178     data->tx_message.data_len = 2;
0179     ibmpex_send_message(data);
0180 
0181     wait_for_completion(&data->read_complete);
0182 
0183     if (data->rx_result || data->rx_msg_len < 1)
0184         return -ENOENT;
0185 
0186     return 0;
0187 }
0188 
0189 static int ibmpex_query_sensor_data(struct ibmpex_bmc_data *data, int sensor)
0190 {
0191     data->tx_msg_data[0] = PEX_GET_SENSOR_DATA;
0192     data->tx_msg_data[1] = sensor;
0193     data->tx_message.data_len = 2;
0194     ibmpex_send_message(data);
0195 
0196     wait_for_completion(&data->read_complete);
0197 
0198     if (data->rx_result || data->rx_msg_len < 26) {
0199         dev_err(data->bmc_device, "Error reading sensor %d.\n",
0200             sensor);
0201         return -ENOENT;
0202     }
0203 
0204     return 0;
0205 }
0206 
0207 static int ibmpex_reset_high_low_data(struct ibmpex_bmc_data *data)
0208 {
0209     data->tx_msg_data[0] = PEX_RESET_HIGH_LOW;
0210     data->tx_message.data_len = 1;
0211     ibmpex_send_message(data);
0212 
0213     wait_for_completion(&data->read_complete);
0214 
0215     return 0;
0216 }
0217 
0218 static void ibmpex_update_device(struct ibmpex_bmc_data *data)
0219 {
0220     int i, err;
0221 
0222     mutex_lock(&data->lock);
0223     if (time_before(jiffies, data->last_updated + REFRESH_INTERVAL) &&
0224         data->valid)
0225         goto out;
0226 
0227     for (i = 0; i < data->num_sensors; i++) {
0228         if (!data->sensors[i].in_use)
0229             continue;
0230         err = ibmpex_query_sensor_data(data, i);
0231         if (err)
0232             continue;
0233         data->sensors[i].values[0] =
0234             extract_value(data->rx_msg_data, 16);
0235         data->sensors[i].values[1] =
0236             extract_value(data->rx_msg_data, 18);
0237         data->sensors[i].values[2] =
0238             extract_value(data->rx_msg_data, 20);
0239     }
0240 
0241     data->last_updated = jiffies;
0242     data->valid = true;
0243 
0244 out:
0245     mutex_unlock(&data->lock);
0246 }
0247 
0248 static struct ibmpex_bmc_data *get_bmc_data(int iface)
0249 {
0250     struct ibmpex_bmc_data *p, *next;
0251 
0252     list_for_each_entry_safe(p, next, &driver_data.bmc_data, list)
0253         if (p->interface == iface)
0254             return p;
0255 
0256     return NULL;
0257 }
0258 
0259 static ssize_t name_show(struct device *dev, struct device_attribute *devattr,
0260              char *buf)
0261 {
0262     return sprintf(buf, "%s\n", DRVNAME);
0263 }
0264 static SENSOR_DEVICE_ATTR_RO(name, name, 0);
0265 
0266 static ssize_t ibmpex_show_sensor(struct device *dev,
0267                   struct device_attribute *devattr,
0268                   char *buf)
0269 {
0270     struct sensor_device_attribute_2 *attr = to_sensor_dev_attr_2(devattr);
0271     struct ibmpex_bmc_data *data = dev_get_drvdata(dev);
0272     int mult = data->sensors[attr->index].multiplier;
0273     ibmpex_update_device(data);
0274 
0275     return sprintf(buf, "%d\n",
0276                data->sensors[attr->index].values[attr->nr] * mult);
0277 }
0278 
0279 static ssize_t ibmpex_high_low_store(struct device *dev,
0280                      struct device_attribute *devattr,
0281                      const char *buf, size_t count)
0282 {
0283     struct ibmpex_bmc_data *data = dev_get_drvdata(dev);
0284 
0285     ibmpex_reset_high_low_data(data);
0286 
0287     return count;
0288 }
0289 
0290 static SENSOR_DEVICE_ATTR_WO(reset_high_low, ibmpex_high_low, 0);
0291 
0292 static int is_power_sensor(const char *sensor_id, int len)
0293 {
0294     if (len < PEX_SENSOR_TYPE_LEN)
0295         return 0;
0296 
0297     if (!memcmp(sensor_id, power_sensor_sig, PEX_SENSOR_TYPE_LEN))
0298         return 1;
0299     return 0;
0300 }
0301 
0302 static int is_temp_sensor(const char *sensor_id, int len)
0303 {
0304     if (len < PEX_SENSOR_TYPE_LEN)
0305         return 0;
0306 
0307     if (!memcmp(sensor_id, temp_sensor_sig, PEX_SENSOR_TYPE_LEN))
0308         return 1;
0309     return 0;
0310 }
0311 
0312 static int power_sensor_multiplier(struct ibmpex_bmc_data *data,
0313                    const char *sensor_id, int len)
0314 {
0315     int i;
0316 
0317     if (data->sensor_major == 2)
0318         return 1000000;
0319 
0320     for (i = PEX_SENSOR_TYPE_LEN; i < len - 1; i++)
0321         if (!memcmp(&sensor_id[i], watt_sensor_sig, PEX_MULT_LEN))
0322             return 1000000;
0323 
0324     return 100000;
0325 }
0326 
0327 static int create_sensor(struct ibmpex_bmc_data *data, int type,
0328              int counter, int sensor, int func)
0329 {
0330     int err;
0331     char *n;
0332 
0333     n = kmalloc(32, GFP_KERNEL);
0334     if (!n)
0335         return -ENOMEM;
0336 
0337     if (type == TEMP_SENSOR)
0338         sprintf(n, "temp%d_input%s",
0339             counter, sensor_name_suffixes[func]);
0340     else if (type == POWER_SENSOR)
0341         sprintf(n, "power%d_average%s",
0342             counter, sensor_name_suffixes[func]);
0343 
0344     sysfs_attr_init(&data->sensors[sensor].attr[func].dev_attr.attr);
0345     data->sensors[sensor].attr[func].dev_attr.attr.name = n;
0346     data->sensors[sensor].attr[func].dev_attr.attr.mode = 0444;
0347     data->sensors[sensor].attr[func].dev_attr.show = ibmpex_show_sensor;
0348     data->sensors[sensor].attr[func].index = sensor;
0349     data->sensors[sensor].attr[func].nr = func;
0350 
0351     err = device_create_file(data->bmc_device,
0352                  &data->sensors[sensor].attr[func].dev_attr);
0353     if (err) {
0354         data->sensors[sensor].attr[func].dev_attr.attr.name = NULL;
0355         kfree(n);
0356         return err;
0357     }
0358 
0359     return 0;
0360 }
0361 
0362 static int ibmpex_find_sensors(struct ibmpex_bmc_data *data)
0363 {
0364     int i, j, err;
0365     int sensor_type;
0366     int sensor_counter;
0367     int num_power = 0;
0368     int num_temp = 0;
0369 
0370     err = ibmpex_query_sensor_count(data);
0371     if (err <= 0)
0372         return -ENOENT;
0373     data->num_sensors = err;
0374 
0375     data->sensors = kcalloc(data->num_sensors, sizeof(*data->sensors),
0376                 GFP_KERNEL);
0377     if (!data->sensors)
0378         return -ENOMEM;
0379 
0380     for (i = 0; i < data->num_sensors; i++) {
0381         err = ibmpex_query_sensor_name(data, i);
0382         if (err)
0383             continue;
0384 
0385         if (is_power_sensor(data->rx_msg_data, data->rx_msg_len)) {
0386             sensor_type = POWER_SENSOR;
0387             num_power++;
0388             sensor_counter = num_power;
0389             data->sensors[i].multiplier =
0390                 power_sensor_multiplier(data,
0391                             data->rx_msg_data,
0392                             data->rx_msg_len);
0393         } else if (is_temp_sensor(data->rx_msg_data,
0394                       data->rx_msg_len)) {
0395             sensor_type = TEMP_SENSOR;
0396             num_temp++;
0397             sensor_counter = num_temp;
0398             data->sensors[i].multiplier = 1000;
0399         } else
0400             continue;
0401 
0402         data->sensors[i].in_use = 1;
0403 
0404         /* Create attributes */
0405         for (j = 0; j < PEX_NUM_SENSOR_FUNCS; j++) {
0406             err = create_sensor(data, sensor_type, sensor_counter,
0407                         i, j);
0408             if (err)
0409                 goto exit_remove;
0410         }
0411     }
0412 
0413     err = device_create_file(data->bmc_device,
0414             &sensor_dev_attr_reset_high_low.dev_attr);
0415     if (err)
0416         goto exit_remove;
0417 
0418     err = device_create_file(data->bmc_device,
0419             &sensor_dev_attr_name.dev_attr);
0420     if (err)
0421         goto exit_remove;
0422 
0423     return 0;
0424 
0425 exit_remove:
0426     device_remove_file(data->bmc_device,
0427                &sensor_dev_attr_reset_high_low.dev_attr);
0428     device_remove_file(data->bmc_device, &sensor_dev_attr_name.dev_attr);
0429     for (i = 0; i < data->num_sensors; i++)
0430         for (j = 0; j < PEX_NUM_SENSOR_FUNCS; j++) {
0431             if (!data->sensors[i].attr[j].dev_attr.attr.name)
0432                 continue;
0433             device_remove_file(data->bmc_device,
0434                 &data->sensors[i].attr[j].dev_attr);
0435             kfree(data->sensors[i].attr[j].dev_attr.attr.name);
0436         }
0437 
0438     kfree(data->sensors);
0439     return err;
0440 }
0441 
0442 static void ibmpex_register_bmc(int iface, struct device *dev)
0443 {
0444     struct ibmpex_bmc_data *data;
0445     int err;
0446 
0447     data = kzalloc(sizeof(*data), GFP_KERNEL);
0448     if (!data)
0449         return;
0450 
0451     data->address.addr_type = IPMI_SYSTEM_INTERFACE_ADDR_TYPE;
0452     data->address.channel = IPMI_BMC_CHANNEL;
0453     data->address.data[0] = 0;
0454     data->interface = iface;
0455     data->bmc_device = dev;
0456 
0457     /* Create IPMI messaging interface user */
0458     err = ipmi_create_user(data->interface, &driver_data.ipmi_hndlrs,
0459                    data, &data->user);
0460     if (err < 0) {
0461         dev_err(dev,
0462             "Unable to register user with IPMI interface %d\n",
0463             data->interface);
0464         goto out;
0465     }
0466 
0467     mutex_init(&data->lock);
0468 
0469     /* Initialize message */
0470     data->tx_msgid = 0;
0471     init_completion(&data->read_complete);
0472     data->tx_message.netfn = PEX_NET_FUNCTION;
0473     data->tx_message.cmd = PEX_COMMAND;
0474     data->tx_message.data = data->tx_msg_data;
0475 
0476     /* Does this BMC support PowerExecutive? */
0477     err = ibmpex_ver_check(data);
0478     if (err)
0479         goto out_user;
0480 
0481     /* Register the BMC as a HWMON class device */
0482     data->hwmon_dev = hwmon_device_register(data->bmc_device);
0483 
0484     if (IS_ERR(data->hwmon_dev)) {
0485         dev_err(data->bmc_device,
0486             "Unable to register hwmon device for IPMI interface %d\n",
0487             data->interface);
0488         goto out_user;
0489     }
0490 
0491     /* finally add the new bmc data to the bmc data list */
0492     dev_set_drvdata(dev, data);
0493     list_add_tail(&data->list, &driver_data.bmc_data);
0494 
0495     /* Now go find all the sensors */
0496     err = ibmpex_find_sensors(data);
0497     if (err) {
0498         dev_err(data->bmc_device, "Error %d finding sensors\n", err);
0499         goto out_register;
0500     }
0501 
0502     return;
0503 
0504 out_register:
0505     hwmon_device_unregister(data->hwmon_dev);
0506 out_user:
0507     ipmi_destroy_user(data->user);
0508 out:
0509     kfree(data);
0510 }
0511 
0512 static void ibmpex_bmc_delete(struct ibmpex_bmc_data *data)
0513 {
0514     int i, j;
0515 
0516     device_remove_file(data->bmc_device,
0517                &sensor_dev_attr_reset_high_low.dev_attr);
0518     device_remove_file(data->bmc_device, &sensor_dev_attr_name.dev_attr);
0519     for (i = 0; i < data->num_sensors; i++)
0520         for (j = 0; j < PEX_NUM_SENSOR_FUNCS; j++) {
0521             if (!data->sensors[i].attr[j].dev_attr.attr.name)
0522                 continue;
0523             device_remove_file(data->bmc_device,
0524                 &data->sensors[i].attr[j].dev_attr);
0525             kfree(data->sensors[i].attr[j].dev_attr.attr.name);
0526         }
0527 
0528     list_del(&data->list);
0529     dev_set_drvdata(data->bmc_device, NULL);
0530     hwmon_device_unregister(data->hwmon_dev);
0531     ipmi_destroy_user(data->user);
0532     kfree(data->sensors);
0533     kfree(data);
0534 }
0535 
0536 static void ibmpex_bmc_gone(int iface)
0537 {
0538     struct ibmpex_bmc_data *data = get_bmc_data(iface);
0539 
0540     if (!data)
0541         return;
0542 
0543     ibmpex_bmc_delete(data);
0544 }
0545 
0546 static void ibmpex_msg_handler(struct ipmi_recv_msg *msg, void *user_msg_data)
0547 {
0548     struct ibmpex_bmc_data *data = (struct ibmpex_bmc_data *)user_msg_data;
0549 
0550     if (msg->msgid != data->tx_msgid) {
0551         dev_err(data->bmc_device,
0552             "Mismatch between received msgid (%02x) and transmitted msgid (%02x)!\n",
0553             (int)msg->msgid,
0554             (int)data->tx_msgid);
0555         ipmi_free_recv_msg(msg);
0556         return;
0557     }
0558 
0559     data->rx_recv_type = msg->recv_type;
0560     if (msg->msg.data_len > 0)
0561         data->rx_result = msg->msg.data[0];
0562     else
0563         data->rx_result = IPMI_UNKNOWN_ERR_COMPLETION_CODE;
0564 
0565     if (msg->msg.data_len > 1) {
0566         data->rx_msg_len = msg->msg.data_len - 1;
0567         memcpy(data->rx_msg_data, msg->msg.data + 1, data->rx_msg_len);
0568     } else
0569         data->rx_msg_len = 0;
0570 
0571     ipmi_free_recv_msg(msg);
0572     complete(&data->read_complete);
0573 }
0574 
0575 static int __init ibmpex_init(void)
0576 {
0577     return ipmi_smi_watcher_register(&driver_data.bmc_events);
0578 }
0579 
0580 static void __exit ibmpex_exit(void)
0581 {
0582     struct ibmpex_bmc_data *p, *next;
0583 
0584     ipmi_smi_watcher_unregister(&driver_data.bmc_events);
0585     list_for_each_entry_safe(p, next, &driver_data.bmc_data, list)
0586         ibmpex_bmc_delete(p);
0587 }
0588 
0589 MODULE_AUTHOR("Darrick J. Wong <darrick.wong@oracle.com>");
0590 MODULE_DESCRIPTION("IBM PowerExecutive power/temperature sensor driver");
0591 MODULE_LICENSE("GPL");
0592 
0593 module_init(ibmpex_init);
0594 module_exit(ibmpex_exit);
0595 
0596 MODULE_ALIAS("dmi:bvnIBM:*:pnIBMSystemx3350-*");
0597 MODULE_ALIAS("dmi:bvnIBM:*:pnIBMSystemx3550-*");
0598 MODULE_ALIAS("dmi:bvnIBM:*:pnIBMSystemx3650-*");
0599 MODULE_ALIAS("dmi:bvnIBM:*:pnIBMSystemx3655-*");
0600 MODULE_ALIAS("dmi:bvnIBM:*:pnIBMSystemx3755-*");
[ Source navigation ] [ Diff markup ] [ Identifier search ] [ general search ]

This page was automatically generated by the 2.1.0 LXR engine.

The LXR team
Valid CSS 2.1! Valid HTML 4.01!