ibmaem.c 27 KB

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