ibmaem.c 26 KB

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