Linux Audio

Check our new training course

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