Linux Audio

Check our new training course

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