File Index
Files and directories
Sign in
FILE

ibmaem.c

File preview with syntax highlighting.

linux-6.19.14/drivers/hwmon/ibmaem.c C
   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;
 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	if (!wait_for_completion_timeout(&ipmi->read_complete, IPMI_TIMEOUT))
 387		return -ETIMEDOUT;
 388
 389	if (ipmi->rx_result || ipmi->rx_msg_len != rs_size ||
 390	    memcmp(&rs_resp->id, &system_x_id, sizeof(system_x_id)))
 391		return -ENOENT;
 392
 393	switch (size) {
 394	case 1: {
 395		u8 *x = buf;
 396		*x = rs_resp->bytes[0];
 397		break;
 398	}
 399	case 2: {
 400		u16 *x = buf;
 401		*x = be16_to_cpup((__be16 *)rs_resp->bytes);
 402		break;
 403	}
 404	case 4: {
 405		u32 *x = buf;
 406		*x = be32_to_cpup((__be32 *)rs_resp->bytes);
 407		break;
 408	}
 409	case 8: {
 410		u64 *x = buf;
 411		*x = be64_to_cpup((__be64 *)rs_resp->bytes);
 412		break;
 413	}
 414	}
 415
 416	return 0;
 417}
 418
 419/* Update AEM energy registers */
 420static void update_aem_energy_one(struct aem_data *data, int which)
 421{
 422	aem_read_sensor(data, AEM_ENERGY_ELEMENT, which,
 423			&data->energy[which], 8);
 424}
 425
 426static void update_aem_energy(struct aem_data *data)
 427{
 428	update_aem_energy_one(data, 0);
 429	if (data->ver_major < 2)
 430		return;
 431	update_aem_energy_one(data, 1);
 432}
 433
 434/* Update all AEM1 sensors */
 435static void update_aem1_sensors(struct aem_data *data)
 436{
 437	mutex_lock(&data->lock);
 438	if (time_before(jiffies, data->last_updated + REFRESH_INTERVAL) &&
 439	    data->valid)
 440		goto out;
 441
 442	update_aem_energy(data);
 443out:
 444	mutex_unlock(&data->lock);
 445}
 446
 447/* Update all AEM2 sensors */
 448static void update_aem2_sensors(struct aem_data *data)
 449{
 450	int i;
 451
 452	mutex_lock(&data->lock);
 453	if (time_before(jiffies, data->last_updated + REFRESH_INTERVAL) &&
 454	    data->valid)
 455		goto out;
 456
 457	update_aem_energy(data);
 458	aem_read_sensor(data, AEM_EXHAUST_ELEMENT, 0, &data->temp[0], 1);
 459	aem_read_sensor(data, AEM_EXHAUST_ELEMENT, 1, &data->temp[1], 1);
 460
 461	for (i = POWER_CAP; i <= POWER_AUX; i++)
 462		aem_read_sensor(data, AEM_POWER_CAP_ELEMENT, i,
 463				&data->pcap[i], 2);
 464out:
 465	mutex_unlock(&data->lock);
 466}
 467
 468/* Delete an AEM instance */
 469static void aem_delete(struct aem_data *data)
 470{
 471	list_del(&data->list);
 472	aem_remove_sensors(data);
 473	kfree(data->rs_resp);
 474	hwmon_device_unregister(data->hwmon_dev);
 475	ipmi_destroy_user(data->ipmi.user);
 476	platform_set_drvdata(data->pdev, NULL);
 477	platform_device_unregister(data->pdev);
 478	ida_free(&aem_ida, data->id);
 479	kfree(data);
 480}
 481
 482/* Probe functions for AEM1 devices */
 483
 484/* Retrieve version and module handle for an AEM1 instance */
 485static int aem_find_aem1_count(struct aem_ipmi_data *data)
 486{
 487	struct aem_find_firmware_req	ff_req;
 488	struct aem_find_firmware_resp	ff_resp;
 489
 490	ff_req.id = system_x_id;
 491	ff_req.index = 0;
 492	ff_req.module_type_id = cpu_to_be16(AEM_MODULE_TYPE_ID);
 493
 494	data->tx_message.cmd = AEM_FIND_FW_CMD;
 495	data->tx_message.data = (char *)&ff_req;
 496	data->tx_message.data_len = sizeof(ff_req);
 497
 498	data->rx_msg_data = &ff_resp;
 499	data->rx_msg_len = sizeof(ff_resp);
 500
 501	aem_send_message(data);
 502
 503	if (!wait_for_completion_timeout(&data->read_complete, IPMI_TIMEOUT))
 504		return -ETIMEDOUT;
 505
 506	if (data->rx_result || data->rx_msg_len != sizeof(ff_resp) ||
 507	    memcmp(&ff_resp.id, &system_x_id, sizeof(system_x_id)))
 508		return -ENOENT;
 509
 510	return ff_resp.num_instances;
 511}
 512
 513/* Find and initialize one AEM1 instance */
 514static int aem_init_aem1_inst(struct aem_ipmi_data *probe, u8 module_handle)
 515{
 516	struct aem_data *data;
 517	int i;
 518	int res = -ENOMEM;
 519
 520	data = kzalloc(sizeof(*data), GFP_KERNEL);
 521	if (!data)
 522		return res;
 523	mutex_init(&data->lock);
 524
 525	/* Copy instance data */
 526	data->ver_major = 1;
 527	data->ver_minor = 0;
 528	data->module_handle = module_handle;
 529	for (i = 0; i < AEM1_NUM_ENERGY_REGS; i++)
 530		data->power_period[i] = AEM_DEFAULT_POWER_INTERVAL;
 531
 532	/* Create sub-device for this fw instance */
 533	data->id = ida_alloc(&aem_ida, GFP_KERNEL);
 534	if (data->id < 0)
 535		goto id_err;
 536
 537	data->pdev = platform_device_alloc(DRVNAME, data->id);
 538	if (!data->pdev)
 539		goto dev_err;
 540	data->pdev->dev.driver = &aem_driver.driver;
 541
 542	res = platform_device_add(data->pdev);
 543	if (res)
 544		goto dev_add_err;
 545
 546	platform_set_drvdata(data->pdev, data);
 547
 548	/* Set up IPMI interface */
 549	res = aem_init_ipmi_data(&data->ipmi, probe->interface,
 550				 probe->bmc_device);
 551	if (res)
 552		goto ipmi_err;
 553
 554	/* Register with hwmon */
 555	data->hwmon_dev = hwmon_device_register(&data->pdev->dev);
 556	if (IS_ERR(data->hwmon_dev)) {
 557		dev_err(&data->pdev->dev,
 558			"Unable to register hwmon device for IPMI interface %d\n",
 559			probe->interface);
 560		res = PTR_ERR(data->hwmon_dev);
 561		goto hwmon_reg_err;
 562	}
 563
 564	data->update = update_aem1_sensors;
 565	data->rs_resp = kzalloc(sizeof(*(data->rs_resp)) + 8, GFP_KERNEL);
 566	if (!data->rs_resp) {
 567		res = -ENOMEM;
 568		goto alloc_resp_err;
 569	}
 570
 571	/* Find sensors */
 572	res = aem1_find_sensors(data);
 573	if (res)
 574		goto sensor_err;
 575
 576	/* Add to our list of AEM devices */
 577	list_add_tail(&data->list, &driver_data.aem_devices);
 578
 579	dev_info(data->ipmi.bmc_device, "Found AEM v%d.%d at 0x%X\n",
 580		 data->ver_major, data->ver_minor,
 581		 data->module_handle);
 582	return 0;
 583
 584sensor_err:
 585	kfree(data->rs_resp);
 586alloc_resp_err:
 587	hwmon_device_unregister(data->hwmon_dev);
 588hwmon_reg_err:
 589	ipmi_destroy_user(data->ipmi.user);
 590ipmi_err:
 591	platform_set_drvdata(data->pdev, NULL);
 592	platform_device_del(data->pdev);
 593dev_add_err:
 594	platform_device_put(data->pdev);
 595dev_err:
 596	ida_free(&aem_ida, data->id);
 597id_err:
 598	kfree(data);
 599
 600	return res;
 601}
 602
 603/* Find and initialize all AEM1 instances */
 604static void aem_init_aem1(struct aem_ipmi_data *probe)
 605{
 606	int num, i, err;
 607
 608	num = aem_find_aem1_count(probe);
 609	for (i = 0; i < num; i++) {
 610		err = aem_init_aem1_inst(probe, i);
 611		if (err) {
 612			dev_err(probe->bmc_device,
 613				"Error %d initializing AEM1 0x%X\n",
 614				err, i);
 615		}
 616	}
 617}
 618
 619/* Probe functions for AEM2 devices */
 620
 621/* Retrieve version and module handle for an AEM2 instance */
 622static int aem_find_aem2(struct aem_ipmi_data *data,
 623			    struct aem_find_instance_resp *fi_resp,
 624			    int instance_num)
 625{
 626	struct aem_find_instance_req fi_req;
 627
 628	fi_req.id = system_x_id;
 629	fi_req.instance_number = instance_num;
 630	fi_req.module_type_id = cpu_to_be16(AEM_MODULE_TYPE_ID);
 631
 632	data->tx_message.cmd = AEM_FW_INSTANCE_CMD;
 633	data->tx_message.data = (char *)&fi_req;
 634	data->tx_message.data_len = sizeof(fi_req);
 635
 636	data->rx_msg_data = fi_resp;
 637	data->rx_msg_len = sizeof(*fi_resp);
 638
 639	aem_send_message(data);
 640
 641	if (!wait_for_completion_timeout(&data->read_complete, IPMI_TIMEOUT))
 642		return -ETIMEDOUT;
 643
 644	if (data->rx_result || data->rx_msg_len != sizeof(*fi_resp) ||
 645	    memcmp(&fi_resp->id, &system_x_id, sizeof(system_x_id)) ||
 646	    fi_resp->num_instances <= instance_num)
 647		return -ENOENT;
 648
 649	return 0;
 650}
 651
 652/* Find and initialize one AEM2 instance */
 653static int aem_init_aem2_inst(struct aem_ipmi_data *probe,
 654			      struct aem_find_instance_resp *fi_resp)
 655{
 656	struct aem_data *data;
 657	int i;
 658	int res = -ENOMEM;
 659
 660	data = kzalloc(sizeof(*data), GFP_KERNEL);
 661	if (!data)
 662		return res;
 663	mutex_init(&data->lock);
 664
 665	/* Copy instance data */
 666	data->ver_major = fi_resp->major;
 667	data->ver_minor = fi_resp->minor;
 668	data->module_handle = fi_resp->module_handle;
 669	for (i = 0; i < AEM2_NUM_ENERGY_REGS; i++)
 670		data->power_period[i] = AEM_DEFAULT_POWER_INTERVAL;
 671
 672	/* Create sub-device for this fw instance */
 673	data->id = ida_alloc(&aem_ida, GFP_KERNEL);
 674	if (data->id < 0)
 675		goto id_err;
 676
 677	data->pdev = platform_device_alloc(DRVNAME, data->id);
 678	if (!data->pdev)
 679		goto dev_err;
 680	data->pdev->dev.driver = &aem_driver.driver;
 681
 682	res = platform_device_add(data->pdev);
 683	if (res)
 684		goto dev_add_err;
 685
 686	platform_set_drvdata(data->pdev, data);
 687
 688	/* Set up IPMI interface */
 689	res = aem_init_ipmi_data(&data->ipmi, probe->interface,
 690				 probe->bmc_device);
 691	if (res)
 692		goto ipmi_err;
 693
 694	/* Register with hwmon */
 695	data->hwmon_dev = hwmon_device_register(&data->pdev->dev);
 696	if (IS_ERR(data->hwmon_dev)) {
 697		dev_err(&data->pdev->dev,
 698			"Unable to register hwmon device for IPMI interface %d\n",
 699			probe->interface);
 700		res = PTR_ERR(data->hwmon_dev);
 701		goto hwmon_reg_err;
 702	}
 703
 704	data->update = update_aem2_sensors;
 705	data->rs_resp = kzalloc(sizeof(*(data->rs_resp)) + 8, GFP_KERNEL);
 706	if (!data->rs_resp) {
 707		res = -ENOMEM;
 708		goto alloc_resp_err;
 709	}
 710
 711	/* Find sensors */
 712	res = aem2_find_sensors(data);
 713	if (res)
 714		goto sensor_err;
 715
 716	/* Add to our list of AEM devices */
 717	list_add_tail(&data->list, &driver_data.aem_devices);
 718
 719	dev_info(data->ipmi.bmc_device, "Found AEM v%d.%d at 0x%X\n",
 720		 data->ver_major, data->ver_minor,
 721		 data->module_handle);
 722	return 0;
 723
 724sensor_err:
 725	kfree(data->rs_resp);
 726alloc_resp_err:
 727	hwmon_device_unregister(data->hwmon_dev);
 728hwmon_reg_err:
 729	ipmi_destroy_user(data->ipmi.user);
 730ipmi_err:
 731	platform_set_drvdata(data->pdev, NULL);
 732	platform_device_del(data->pdev);
 733dev_add_err:
 734	platform_device_put(data->pdev);
 735dev_err:
 736	ida_free(&aem_ida, data->id);
 737id_err:
 738	kfree(data);
 739
 740	return res;
 741}
 742
 743/* Find and initialize all AEM2 instances */
 744static void aem_init_aem2(struct aem_ipmi_data *probe)
 745{
 746	struct aem_find_instance_resp fi_resp;
 747	int err;
 748	int i = 0;
 749
 750	while (!aem_find_aem2(probe, &fi_resp, i)) {
 751		if (fi_resp.major != 2) {
 752			dev_err(probe->bmc_device,
 753				"Unknown AEM v%d; please report this to the maintainer.\n",
 754				fi_resp.major);
 755			i++;
 756			continue;
 757		}
 758		err = aem_init_aem2_inst(probe, &fi_resp);
 759		if (err) {
 760			dev_err(probe->bmc_device,
 761				"Error %d initializing AEM2 0x%X\n",
 762				err, fi_resp.module_handle);
 763		}
 764		i++;
 765	}
 766}
 767
 768/* Probe a BMC for AEM firmware instances */
 769static void aem_register_bmc(int iface, struct device *dev)
 770{
 771	struct aem_ipmi_data probe;
 772
 773	if (aem_init_ipmi_data(&probe, iface, dev))
 774		return;
 775
 776	/* Ignore probe errors; they won't cause problems */
 777	aem_init_aem1(&probe);
 778	aem_init_aem2(&probe);
 779
 780	ipmi_destroy_user(probe.user);
 781}
 782
 783/* Handle BMC deletion */
 784static void aem_bmc_gone(int iface)
 785{
 786	struct aem_data *p1, *next1;
 787
 788	list_for_each_entry_safe(p1, next1, &driver_data.aem_devices, list)
 789		if (p1->ipmi.interface == iface)
 790			aem_delete(p1);
 791}
 792
 793/* sysfs support functions */
 794
 795/* AEM device name */
 796static ssize_t name_show(struct device *dev, struct device_attribute *devattr,
 797			 char *buf)
 798{
 799	struct aem_data *data = dev_get_drvdata(dev);
 800
 801	return sprintf(buf, "%s%d\n", DRVNAME, data->ver_major);
 802}
 803static SENSOR_DEVICE_ATTR_RO(name, name, 0);
 804
 805/* AEM device version */
 806static ssize_t version_show(struct device *dev,
 807			    struct device_attribute *devattr, char *buf)
 808{
 809	struct aem_data *data = dev_get_drvdata(dev);
 810
 811	return sprintf(buf, "%d.%d\n", data->ver_major, data->ver_minor);
 812}
 813static SENSOR_DEVICE_ATTR_RO(version, version, 0);
 814
 815/* Display power use */
 816static ssize_t aem_show_power(struct device *dev,
 817			      struct device_attribute *devattr,
 818			      char *buf)
 819{
 820	struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
 821	struct aem_data *data = dev_get_drvdata(dev);
 822	u64 before, after, delta, time;
 823	signed long leftover;
 824
 825	mutex_lock(&data->lock);
 826	update_aem_energy_one(data, attr->index);
 827	time = ktime_get_ns();
 828	before = data->energy[attr->index];
 829
 830	leftover = schedule_timeout_interruptible(
 831			msecs_to_jiffies(data->power_period[attr->index])
 832		   );
 833	if (leftover) {
 834		mutex_unlock(&data->lock);
 835		return 0;
 836	}
 837
 838	update_aem_energy_one(data, attr->index);
 839	time = ktime_get_ns() - time;
 840	after = data->energy[attr->index];
 841	mutex_unlock(&data->lock);
 842
 843	delta = (after - before) * UJ_PER_MJ;
 844
 845	return sprintf(buf, "%llu\n",
 846		(unsigned long long)div64_u64(delta * NSEC_PER_SEC, time));
 847}
 848
 849/* Display energy use */
 850static ssize_t aem_show_energy(struct device *dev,
 851			       struct device_attribute *devattr,
 852			       char *buf)
 853{
 854	struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
 855	struct aem_data *a = dev_get_drvdata(dev);
 856	mutex_lock(&a->lock);
 857	update_aem_energy_one(a, attr->index);
 858	mutex_unlock(&a->lock);
 859
 860	return sprintf(buf, "%llu\n",
 861			(unsigned long long)a->energy[attr->index] * 1000);
 862}
 863
 864/* Display power interval registers */
 865static ssize_t aem_show_power_period(struct device *dev,
 866				     struct device_attribute *devattr,
 867				     char *buf)
 868{
 869	struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
 870	struct aem_data *a = dev_get_drvdata(dev);
 871	a->update(a);
 872
 873	return sprintf(buf, "%lu\n", a->power_period[attr->index]);
 874}
 875
 876/* Set power interval registers */
 877static ssize_t aem_set_power_period(struct device *dev,
 878				    struct device_attribute *devattr,
 879				    const char *buf, size_t count)
 880{
 881	struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
 882	struct aem_data *a = dev_get_drvdata(dev);
 883	unsigned long temp;
 884	int res;
 885
 886	res = kstrtoul(buf, 10, &temp);
 887	if (res)
 888		return res;
 889
 890	if (temp < AEM_MIN_POWER_INTERVAL)
 891		return -EINVAL;
 892
 893	mutex_lock(&a->lock);
 894	a->power_period[attr->index] = temp;
 895	mutex_unlock(&a->lock);
 896
 897	return count;
 898}
 899
 900/* Discover sensors on an AEM device */
 901static int aem_register_sensors(struct aem_data *data,
 902				const struct aem_ro_sensor_template *ro,
 903				const struct aem_rw_sensor_template *rw)
 904{
 905	struct device *dev = &data->pdev->dev;
 906	struct sensor_device_attribute *sensors = data->sensors;
 907	int err;
 908
 909	/* Set up read-only sensors */
 910	while (ro->label) {
 911		sysfs_attr_init(&sensors->dev_attr.attr);
 912		sensors->dev_attr.attr.name = ro->label;
 913		sensors->dev_attr.attr.mode = 0444;
 914		sensors->dev_attr.show = ro->show;
 915		sensors->index = ro->index;
 916
 917		err = device_create_file(dev, &sensors->dev_attr);
 918		if (err) {
 919			sensors->dev_attr.attr.name = NULL;
 920			goto error;
 921		}
 922		sensors++;
 923		ro++;
 924	}
 925
 926	/* Set up read-write sensors */
 927	while (rw->label) {
 928		sysfs_attr_init(&sensors->dev_attr.attr);
 929		sensors->dev_attr.attr.name = rw->label;
 930		sensors->dev_attr.attr.mode = 0644;
 931		sensors->dev_attr.show = rw->show;
 932		sensors->dev_attr.store = rw->set;
 933		sensors->index = rw->index;
 934
 935		err = device_create_file(dev, &sensors->dev_attr);
 936		if (err) {
 937			sensors->dev_attr.attr.name = NULL;
 938			goto error;
 939		}
 940		sensors++;
 941		rw++;
 942	}
 943
 944	err = device_create_file(dev, &sensor_dev_attr_name.dev_attr);
 945	if (err)
 946		goto error;
 947	err = device_create_file(dev, &sensor_dev_attr_version.dev_attr);
 948	return err;
 949
 950error:
 951	aem_remove_sensors(data);
 952	return err;
 953}
 954
 955/* sysfs support functions for AEM2 sensors */
 956
 957/* Display temperature use */
 958static ssize_t aem2_show_temp(struct device *dev,
 959			      struct device_attribute *devattr,
 960			      char *buf)
 961{
 962	struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
 963	struct aem_data *a = dev_get_drvdata(dev);
 964	a->update(a);
 965
 966	return sprintf(buf, "%u\n", a->temp[attr->index] * 1000);
 967}
 968
 969/* Display power-capping registers */
 970static ssize_t aem2_show_pcap_value(struct device *dev,
 971				    struct device_attribute *devattr,
 972				    char *buf)
 973{
 974	struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
 975	struct aem_data *a = dev_get_drvdata(dev);
 976	a->update(a);
 977
 978	return sprintf(buf, "%u\n", a->pcap[attr->index] * 100000);
 979}
 980
 981/* Remove sensors attached to an AEM device */
 982static void aem_remove_sensors(struct aem_data *data)
 983{
 984	int i;
 985
 986	for (i = 0; i < AEM_NUM_SENSORS; i++) {
 987		if (!data->sensors[i].dev_attr.attr.name)
 988			continue;
 989		device_remove_file(&data->pdev->dev,
 990				   &data->sensors[i].dev_attr);
 991	}
 992
 993	device_remove_file(&data->pdev->dev,
 994			   &sensor_dev_attr_name.dev_attr);
 995	device_remove_file(&data->pdev->dev,
 996			   &sensor_dev_attr_version.dev_attr);
 997}
 998
 999/* Sensor probe functions */
1000
1001/* Description of AEM1 sensors */
1002static const struct aem_ro_sensor_template aem1_ro_sensors[] = {
1003{"energy1_input",  aem_show_energy, 0},
1004{"power1_average", aem_show_power,  0},
1005{NULL,		   NULL,	    0},
1006};
1007
1008static const struct aem_rw_sensor_template aem1_rw_sensors[] = {
1009{"power1_average_interval", aem_show_power_period, aem_set_power_period, 0},
1010{NULL,			    NULL,                  NULL,                 0},
1011};
1012
1013/* Description of AEM2 sensors */
1014static const struct aem_ro_sensor_template aem2_ro_sensors[] = {
1015{"energy1_input",	  aem_show_energy,	0},
1016{"energy2_input",	  aem_show_energy,	1},
1017{"power1_average",	  aem_show_power,	0},
1018{"power2_average",	  aem_show_power,	1},
1019{"temp1_input",		  aem2_show_temp,	0},
1020{"temp2_input",		  aem2_show_temp,	1},
1021
1022{"power4_average",	  aem2_show_pcap_value,	POWER_CAP_MAX_HOTPLUG},
1023{"power5_average",	  aem2_show_pcap_value,	POWER_CAP_MAX},
1024{"power6_average",	  aem2_show_pcap_value,	POWER_CAP_MIN_WARNING},
1025{"power7_average",	  aem2_show_pcap_value,	POWER_CAP_MIN},
1026
1027{"power3_average",	  aem2_show_pcap_value,	POWER_AUX},
1028{"power_cap",		  aem2_show_pcap_value,	POWER_CAP},
1029{NULL,                    NULL,                 0},
1030};
1031
1032static const struct aem_rw_sensor_template aem2_rw_sensors[] = {
1033{"power1_average_interval", aem_show_power_period, aem_set_power_period, 0},
1034{"power2_average_interval", aem_show_power_period, aem_set_power_period, 1},
1035{NULL,			    NULL,                  NULL,                 0},
1036};
1037
1038/* Set up AEM1 sensor attrs */
1039static int aem1_find_sensors(struct aem_data *data)
1040{
1041	return aem_register_sensors(data, aem1_ro_sensors, aem1_rw_sensors);
1042}
1043
1044/* Set up AEM2 sensor attrs */
1045static int aem2_find_sensors(struct aem_data *data)
1046{
1047	return aem_register_sensors(data, aem2_ro_sensors, aem2_rw_sensors);
1048}
1049
1050/* Module init/exit routines */
1051
1052static int __init aem_init(void)
1053{
1054	int res;
1055
1056	res = driver_register(&aem_driver.driver);
1057	if (res) {
1058		pr_err("Can't register aem driver\n");
1059		return res;
1060	}
1061
1062	res = ipmi_smi_watcher_register(&driver_data.bmc_events);
1063	if (res)
1064		goto ipmi_reg_err;
1065	return 0;
1066
1067ipmi_reg_err:
1068	driver_unregister(&aem_driver.driver);
1069	return res;
1070
1071}
1072
1073static void __exit aem_exit(void)
1074{
1075	struct aem_data *p1, *next1;
1076
1077	ipmi_smi_watcher_unregister(&driver_data.bmc_events);
1078	driver_unregister(&aem_driver.driver);
1079	list_for_each_entry_safe(p1, next1, &driver_data.aem_devices, list)
1080		aem_delete(p1);
1081}
1082
1083MODULE_AUTHOR("Darrick J. Wong <darrick.wong@oracle.com>");
1084MODULE_DESCRIPTION("IBM AEM power/temp/energy sensor driver");
1085MODULE_LICENSE("GPL");
1086
1087module_init(aem_init);
1088module_exit(aem_exit);
1089
1090MODULE_ALIAS("dmi:bvnIBM:*:pnIBMSystemx3350-*");
1091MODULE_ALIAS("dmi:bvnIBM:*:pnIBMSystemx3550-*");
1092MODULE_ALIAS("dmi:bvnIBM:*:pnIBMSystemx3650-*");
1093MODULE_ALIAS("dmi:bvnIBM:*:pnIBMSystemx3655-*");
1094MODULE_ALIAS("dmi:bvnIBM:*:pnIBMSystemx3755-*");
1095MODULE_ALIAS("dmi:bvnIBM:*:pnIBM3850M2/x3950M2-*");
1096MODULE_ALIAS("dmi:bvnIBM:*:pnIBMBladeHC10-*");
~/ Read-only file preview.