linux/drivers/hwmon/ibmaem.c
<<
>>
Prefs
   1/*
   2 * A hwmon driver for the IBM Active Energy Manager temperature/power sensors
   3 * 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
  88static DEFINE_IDR(aem_idr);
  89static DEFINE_SPINLOCK(aem_idr_lock);
  90
  91static struct device_driver aem_driver = {
  92        .name = DRVNAME,
  93        .bus = &platform_bus_type,
  94};
  95
  96struct 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
 113struct 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
 121struct 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
 132struct 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 */
 181struct aem_iana_id {
 182        u8                      bytes[3];
 183};
 184static struct aem_iana_id system_x_id = {
 185        .bytes = {0x4D, 0x4F, 0x00}
 186};
 187
 188/* These are used to find AEM1 instances */
 189struct aem_find_firmware_req {
 190        struct aem_iana_id      id;
 191        u8                      rsvd;
 192        __be16                  index;
 193        __be16                  module_type_id;
 194} __packed;
 195
 196struct 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 */
 202struct aem_find_instance_req {
 203        struct aem_iana_id      id;
 204        u8                      instance_number;
 205        __be16                  module_type_id;
 206} __packed;
 207
 208struct 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 */
 218struct 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
 227struct 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 */
 233struct 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
 239static void aem_register_bmc(int iface, struct device *dev);
 240static void aem_bmc_gone(int iface);
 241static void aem_msg_handler(struct ipmi_recv_msg *msg, void *user_msg_data);
 242
 243static void aem_remove_sensors(struct aem_data *data);
 244static int aem_init_aem1(struct aem_ipmi_data *probe);
 245static int aem_init_aem2(struct aem_ipmi_data *probe);
 246static int aem1_find_sensors(struct aem_data *data);
 247static int aem2_find_sensors(struct aem_data *data);
 248static void update_aem1_sensors(struct aem_data *data);
 249static void update_aem2_sensors(struct aem_data *data);
 250
 251static 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 */
 266static 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 */
 297static 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;
 312out1:
 313        dev_err(data->bmc_device, "request_settime=%x\n", err);
 314        return err;
 315out:
 316        dev_err(data->bmc_device, "validate_addr=%x\n", err);
 317        return err;
 318}
 319
 320/* Dispatch IPMI messages to callers */
 321static 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 */
 357static int aem_idr_get(int *id)
 358{
 359        int i, err;
 360
 361again:
 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 */
 379static 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 */
 389static 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 */
 466static 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 */
 475static 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);
 483out:
 484        mutex_unlock(&data->lock);
 485}
 486
 487/* Update all AEM2 sensors */
 488static 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);
 504out:
 505        mutex_unlock(&data->lock);
 506}
 507
 508/* Delete an AEM instance */
 509static 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 */
 524static 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 */
 555static 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
 617sensor_err:
 618        hwmon_device_unregister(data->hwmon_dev);
 619hwmon_reg_err:
 620        ipmi_destroy_user(data->ipmi.user);
 621ipmi_err:
 622        dev_set_drvdata(&data->pdev->dev, NULL);
 623        platform_device_unregister(data->pdev);
 624dev_err:
 625        aem_idr_put(data->id);
 626id_err:
 627        kfree(data);
 628
 629        return res;
 630}
 631
 632/* Find and initialize all AEM1 instances */
 633static 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 */
 654static 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                return -ENOENT;
 681
 682        return 0;
 683}
 684
 685/* Find and initialize one AEM2 instance */
 686static int aem_init_aem2_inst(struct aem_ipmi_data *probe,
 687                              struct aem_find_instance_resp *fi_resp)
 688{
 689        struct aem_data *data;
 690        int i;
 691        int res = -ENOMEM;
 692
 693        data = kzalloc(sizeof(*data), GFP_KERNEL);
 694        if (!data)
 695                return res;
 696        mutex_init(&data->lock);
 697
 698        /* Copy instance data */
 699        data->ver_major = fi_resp->major;
 700        data->ver_minor = fi_resp->minor;
 701        data->module_handle = fi_resp->module_handle;
 702        for (i = 0; i < AEM2_NUM_ENERGY_REGS; i++)
 703                data->power_period[i] = AEM_DEFAULT_POWER_INTERVAL;
 704
 705        /* Create sub-device for this fw instance */
 706        if (aem_idr_get(&data->id))
 707                goto id_err;
 708
 709        data->pdev = platform_device_alloc(DRVNAME, data->id);
 710        if (!data->pdev)
 711                goto dev_err;
 712        data->pdev->dev.driver = &aem_driver;
 713
 714        res = platform_device_add(data->pdev);
 715        if (res)
 716                goto ipmi_err;
 717
 718        dev_set_drvdata(&data->pdev->dev, data);
 719
 720        /* Set up IPMI interface */
 721        if (aem_init_ipmi_data(&data->ipmi, probe->interface,
 722                               probe->bmc_device))
 723                goto ipmi_err;
 724
 725        /* Register with hwmon */
 726        data->hwmon_dev = hwmon_device_register(&data->pdev->dev);
 727
 728        if (IS_ERR(data->hwmon_dev)) {
 729                dev_err(&data->pdev->dev, "Unable to register hwmon "
 730                        "device for IPMI interface %d\n",
 731                        probe->interface);
 732                goto hwmon_reg_err;
 733        }
 734
 735        data->update = update_aem2_sensors;
 736
 737        /* Find sensors */
 738        if (aem2_find_sensors(data))
 739                goto sensor_err;
 740
 741        /* Add to our list of AEM devices */
 742        list_add_tail(&data->list, &driver_data.aem_devices);
 743
 744        dev_info(data->ipmi.bmc_device, "Found AEM v%d.%d at 0x%X\n",
 745                 data->ver_major, data->ver_minor,
 746                 data->module_handle);
 747        return 0;
 748
 749sensor_err:
 750        hwmon_device_unregister(data->hwmon_dev);
 751hwmon_reg_err:
 752        ipmi_destroy_user(data->ipmi.user);
 753ipmi_err:
 754        dev_set_drvdata(&data->pdev->dev, NULL);
 755        platform_device_unregister(data->pdev);
 756dev_err:
 757        aem_idr_put(data->id);
 758id_err:
 759        kfree(data);
 760
 761        return res;
 762}
 763
 764/* Find and initialize all AEM2 instances */
 765static int aem_init_aem2(struct aem_ipmi_data *probe)
 766{
 767        struct aem_find_instance_resp fi_resp;
 768        int err;
 769        int i = 0;
 770
 771        while (!aem_find_aem2(probe, &fi_resp, i)) {
 772                if (fi_resp.major != 2) {
 773                        dev_err(probe->bmc_device, "Unknown AEM v%d; please "
 774                                "report this to the maintainer.\n",
 775                                fi_resp.major);
 776                        i++;
 777                        continue;
 778                }
 779                err = aem_init_aem2_inst(probe, &fi_resp);
 780                if (err) {
 781                        dev_err(probe->bmc_device,
 782                                "Error %d initializing AEM2 0x%X\n",
 783                                err, fi_resp.module_handle);
 784                        return err;
 785                }
 786                i++;
 787        }
 788
 789        return 0;
 790}
 791
 792/* Probe a BMC for AEM firmware instances */
 793static void aem_register_bmc(int iface, struct device *dev)
 794{
 795        struct aem_ipmi_data probe;
 796
 797        if (aem_init_ipmi_data(&probe, iface, dev))
 798                return;
 799
 800        /* Ignore probe errors; they won't cause problems */
 801        aem_init_aem1(&probe);
 802        aem_init_aem2(&probe);
 803
 804        ipmi_destroy_user(probe.user);
 805}
 806
 807/* Handle BMC deletion */
 808static void aem_bmc_gone(int iface)
 809{
 810        struct aem_data *p1, *next1;
 811
 812        list_for_each_entry_safe(p1, next1, &driver_data.aem_devices, list)
 813                if (p1->ipmi.interface == iface)
 814                        aem_delete(p1);
 815}
 816
 817/* sysfs support functions */
 818
 819/* AEM device name */
 820static ssize_t show_name(struct device *dev, struct device_attribute *devattr,
 821                         char *buf)
 822{
 823        struct aem_data *data = dev_get_drvdata(dev);
 824
 825        return sprintf(buf, "%s%d\n", DRVNAME, data->ver_major);
 826}
 827static SENSOR_DEVICE_ATTR(name, S_IRUGO, show_name, NULL, 0);
 828
 829/* AEM device version */
 830static ssize_t show_version(struct device *dev,
 831                            struct device_attribute *devattr,
 832                            char *buf)
 833{
 834        struct aem_data *data = dev_get_drvdata(dev);
 835
 836        return sprintf(buf, "%d.%d\n", data->ver_major, data->ver_minor);
 837}
 838static SENSOR_DEVICE_ATTR(version, S_IRUGO, show_version, NULL, 0);
 839
 840/* Display power use */
 841static ssize_t aem_show_power(struct device *dev,
 842                              struct device_attribute *devattr,
 843                              char *buf)
 844{
 845        struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
 846        struct aem_data *data = dev_get_drvdata(dev);
 847        u64 before, after, delta, time;
 848        signed long leftover;
 849        struct timespec b, a;
 850
 851        mutex_lock(&data->lock);
 852        update_aem_energy(data);
 853        getnstimeofday(&b);
 854        before = data->energy[attr->index];
 855
 856        leftover = schedule_timeout_interruptible(
 857                        msecs_to_jiffies(data->power_period[attr->index])
 858                   );
 859        if (leftover) {
 860                mutex_unlock(&data->lock);
 861                return 0;
 862        }
 863
 864        update_aem_energy(data);
 865        getnstimeofday(&a);
 866        after = data->energy[attr->index];
 867        mutex_unlock(&data->lock);
 868
 869        time = timespec_to_ns(&a) - timespec_to_ns(&b);
 870        delta = (after - before) * UJ_PER_MJ;
 871
 872        return sprintf(buf, "%llu\n",
 873                (unsigned long long)div64_u64(delta * NSEC_PER_SEC, time));
 874}
 875
 876/* Display energy use */
 877static ssize_t aem_show_energy(struct device *dev,
 878                               struct device_attribute *devattr,
 879                               char *buf)
 880{
 881        struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
 882        struct aem_data *a = dev_get_drvdata(dev);
 883        a->update(a);
 884
 885        return sprintf(buf, "%llu\n",
 886                        (unsigned long long)a->energy[attr->index] * 1000);
 887}
 888
 889/* Display power interval registers */
 890static ssize_t aem_show_power_period(struct device *dev,
 891                                     struct device_attribute *devattr,
 892                                     char *buf)
 893{
 894        struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
 895        struct aem_data *a = dev_get_drvdata(dev);
 896        a->update(a);
 897
 898        return sprintf(buf, "%lu\n", a->power_period[attr->index]);
 899}
 900
 901/* Set power interval registers */
 902static ssize_t aem_set_power_period(struct device *dev,
 903                                    struct device_attribute *devattr,
 904                                    const char *buf, size_t count)
 905{
 906        struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
 907        struct aem_data *a = dev_get_drvdata(dev);
 908        unsigned long temp;
 909        int res;
 910
 911        res = strict_strtoul(buf, 10, &temp);
 912        if (res)
 913                return res;
 914
 915        if (temp < AEM_MIN_POWER_INTERVAL)
 916                return -EINVAL;
 917
 918        mutex_lock(&a->lock);
 919        a->power_period[attr->index] = temp;
 920        mutex_unlock(&a->lock);
 921
 922        return count;
 923}
 924
 925/* Discover sensors on an AEM device */
 926static int aem_register_sensors(struct aem_data *data,
 927                                struct aem_ro_sensor_template *ro,
 928                                struct aem_rw_sensor_template *rw)
 929{
 930        struct device *dev = &data->pdev->dev;
 931        struct sensor_device_attribute *sensors = data->sensors;
 932        int err;
 933
 934        /* Set up read-only sensors */
 935        while (ro->label) {
 936                sensors->dev_attr.attr.name = ro->label;
 937                sensors->dev_attr.attr.mode = S_IRUGO;
 938                sensors->dev_attr.show = ro->show;
 939                sensors->index = ro->index;
 940
 941                err = device_create_file(dev, &sensors->dev_attr);
 942                if (err) {
 943                        sensors->dev_attr.attr.name = NULL;
 944                        goto error;
 945                }
 946                sensors++;
 947                ro++;
 948        }
 949
 950        /* Set up read-write sensors */
 951        while (rw->label) {
 952                sensors->dev_attr.attr.name = rw->label;
 953                sensors->dev_attr.attr.mode = S_IRUGO | S_IWUSR;
 954                sensors->dev_attr.show = rw->show;
 955                sensors->dev_attr.store = rw->set;
 956                sensors->index = rw->index;
 957
 958                err = device_create_file(dev, &sensors->dev_attr);
 959                if (err) {
 960                        sensors->dev_attr.attr.name = NULL;
 961                        goto error;
 962                }
 963                sensors++;
 964                rw++;
 965        }
 966
 967        err = device_create_file(dev, &sensor_dev_attr_name.dev_attr);
 968        if (err)
 969                goto error;
 970        err = device_create_file(dev, &sensor_dev_attr_version.dev_attr);
 971        return err;
 972
 973error:
 974        aem_remove_sensors(data);
 975        return err;
 976}
 977
 978/* sysfs support functions for AEM2 sensors */
 979
 980/* Display temperature use */
 981static ssize_t aem2_show_temp(struct device *dev,
 982                              struct device_attribute *devattr,
 983                              char *buf)
 984{
 985        struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
 986        struct aem_data *a = dev_get_drvdata(dev);
 987        a->update(a);
 988
 989        return sprintf(buf, "%u\n", a->temp[attr->index] * 1000);
 990}
 991
 992/* Display power-capping registers */
 993static ssize_t aem2_show_pcap_value(struct device *dev,
 994                                    struct device_attribute *devattr,
 995                                    char *buf)
 996{
 997        struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
 998        struct aem_data *a = dev_get_drvdata(dev);
 999        a->update(a);
1000
1001        return sprintf(buf, "%u\n", a->pcap[attr->index] * 100000);
1002}
1003
1004/* Remove sensors attached to an AEM device */
1005static void aem_remove_sensors(struct aem_data *data)
1006{
1007        int i;
1008
1009        for (i = 0; i < AEM_NUM_SENSORS; i++) {
1010                if (!data->sensors[i].dev_attr.attr.name)
1011                        continue;
1012                device_remove_file(&data->pdev->dev,
1013                                   &data->sensors[i].dev_attr);
1014        }
1015
1016        device_remove_file(&data->pdev->dev,
1017                           &sensor_dev_attr_name.dev_attr);
1018        device_remove_file(&data->pdev->dev,
1019                           &sensor_dev_attr_version.dev_attr);
1020}
1021
1022/* Sensor probe functions */
1023
1024/* Description of AEM1 sensors */
1025static struct aem_ro_sensor_template aem1_ro_sensors[] = {
1026{"energy1_input",  aem_show_energy, 0},
1027{"power1_average", aem_show_power,  0},
1028{NULL,             NULL,            0},
1029};
1030
1031static struct aem_rw_sensor_template aem1_rw_sensors[] = {
1032{"power1_average_interval", aem_show_power_period, aem_set_power_period, 0},
1033{NULL,                      NULL,                  NULL,                 0},
1034};
1035
1036/* Description of AEM2 sensors */
1037static struct aem_ro_sensor_template aem2_ro_sensors[] = {
1038{"energy1_input",         aem_show_energy,      0},
1039{"energy2_input",         aem_show_energy,      1},
1040{"power1_average",        aem_show_power,       0},
1041{"power2_average",        aem_show_power,       1},
1042{"temp1_input",           aem2_show_temp,       0},
1043{"temp2_input",           aem2_show_temp,       1},
1044
1045{"power4_average",        aem2_show_pcap_value, POWER_CAP_MAX_HOTPLUG},
1046{"power5_average",        aem2_show_pcap_value, POWER_CAP_MAX},
1047{"power6_average",        aem2_show_pcap_value, POWER_CAP_MIN_WARNING},
1048{"power7_average",        aem2_show_pcap_value, POWER_CAP_MIN},
1049
1050{"power3_average",        aem2_show_pcap_value, POWER_AUX},
1051{"power_cap",             aem2_show_pcap_value, POWER_CAP},
1052{NULL,                    NULL,                 0},
1053};
1054
1055static struct aem_rw_sensor_template aem2_rw_sensors[] = {
1056{"power1_average_interval", aem_show_power_period, aem_set_power_period, 0},
1057{"power2_average_interval", aem_show_power_period, aem_set_power_period, 1},
1058{NULL,                      NULL,                  NULL,                 0},
1059};
1060
1061/* Set up AEM1 sensor attrs */
1062static int aem1_find_sensors(struct aem_data *data)
1063{
1064        return aem_register_sensors(data, aem1_ro_sensors, aem1_rw_sensors);
1065}
1066
1067/* Set up AEM2 sensor attrs */
1068static int aem2_find_sensors(struct aem_data *data)
1069{
1070        return aem_register_sensors(data, aem2_ro_sensors, aem2_rw_sensors);
1071}
1072
1073/* Module init/exit routines */
1074
1075static int __init aem_init(void)
1076{
1077        int res;
1078
1079        res = driver_register(&aem_driver);
1080        if (res) {
1081                printk(KERN_ERR "Can't register aem driver\n");
1082                return res;
1083        }
1084
1085        res = ipmi_smi_watcher_register(&driver_data.bmc_events);
1086        if (res)
1087                goto ipmi_reg_err;
1088        return 0;
1089
1090ipmi_reg_err:
1091        driver_unregister(&aem_driver);
1092        return res;
1093
1094}
1095
1096static void __exit aem_exit(void)
1097{
1098        struct aem_data *p1, *next1;
1099
1100        ipmi_smi_watcher_unregister(&driver_data.bmc_events);
1101        driver_unregister(&aem_driver);
1102        list_for_each_entry_safe(p1, next1, &driver_data.aem_devices, list)
1103                aem_delete(p1);
1104}
1105
1106MODULE_AUTHOR("Darrick J. Wong <djwong@us.ibm.com>");
1107MODULE_DESCRIPTION("IBM Active Energy Manager power/temp sensor driver");
1108MODULE_LICENSE("GPL");
1109
1110module_init(aem_init);
1111module_exit(aem_exit);
1112
lxr.linux.no kindly hosted by Redpill Linpro AS, provider of Linux consulting and operations services since 1995.