pmbus_core.c 44 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639
  1. /*
  2. * Hardware monitoring driver for PMBus devices
  3. *
  4. * Copyright (c) 2010, 2011 Ericsson AB.
  5. *
  6. * This program is free software; you can redistribute it and/or modify
  7. * it under the terms of the GNU General Public License as published by
  8. * the Free Software Foundation; either version 2 of the License, or
  9. * (at your option) any later version.
  10. *
  11. * This program is distributed in the hope that it will be useful,
  12. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14. * GNU General Public License for more details.
  15. *
  16. * You should have received a copy of the GNU General Public License
  17. * along with this program; if not, write to the Free Software
  18. * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  19. */
  20. #include <linux/kernel.h>
  21. #include <linux/module.h>
  22. #include <linux/init.h>
  23. #include <linux/err.h>
  24. #include <linux/slab.h>
  25. #include <linux/i2c.h>
  26. #include <linux/hwmon.h>
  27. #include <linux/hwmon-sysfs.h>
  28. #include <linux/delay.h>
  29. #include <linux/i2c/pmbus.h>
  30. #include "pmbus.h"
  31. /*
  32. * Constants needed to determine number of sensors, booleans, and labels.
  33. */
  34. #define PMBUS_MAX_INPUT_SENSORS 11 /* 6*volt, 3*curr, 2*power */
  35. #define PMBUS_VOUT_SENSORS_PER_PAGE 5 /* input, min, max, lcrit,
  36. crit */
  37. #define PMBUS_IOUT_SENSORS_PER_PAGE 4 /* input, min, max, crit */
  38. #define PMBUS_POUT_SENSORS_PER_PAGE 4 /* input, cap, max, crit */
  39. #define PMBUS_MAX_SENSORS_PER_FAN 1 /* input */
  40. #define PMBUS_MAX_SENSORS_PER_TEMP 5 /* input, min, max, lcrit,
  41. crit */
  42. #define PMBUS_MAX_INPUT_BOOLEANS 7 /* v: min_alarm, max_alarm,
  43. lcrit_alarm, crit_alarm;
  44. c: alarm, crit_alarm;
  45. p: crit_alarm */
  46. #define PMBUS_VOUT_BOOLEANS_PER_PAGE 4 /* min_alarm, max_alarm,
  47. lcrit_alarm, crit_alarm */
  48. #define PMBUS_IOUT_BOOLEANS_PER_PAGE 3 /* alarm, lcrit_alarm,
  49. crit_alarm */
  50. #define PMBUS_POUT_BOOLEANS_PER_PAGE 2 /* alarm, crit_alarm */
  51. #define PMBUS_MAX_BOOLEANS_PER_FAN 2 /* alarm, fault */
  52. #define PMBUS_MAX_BOOLEANS_PER_TEMP 4 /* min_alarm, max_alarm,
  53. lcrit_alarm, crit_alarm */
  54. #define PMBUS_MAX_INPUT_LABELS 4 /* vin, vcap, iin, pin */
  55. /*
  56. * status, status_vout, status_iout, status_fans, status_fan34, and status_temp
  57. * are paged. status_input is unpaged.
  58. */
  59. #define PB_NUM_STATUS_REG (PMBUS_PAGES * 6 + 1)
  60. /*
  61. * Index into status register array, per status register group
  62. */
  63. #define PB_STATUS_BASE 0
  64. #define PB_STATUS_VOUT_BASE (PB_STATUS_BASE + PMBUS_PAGES)
  65. #define PB_STATUS_IOUT_BASE (PB_STATUS_VOUT_BASE + PMBUS_PAGES)
  66. #define PB_STATUS_FAN_BASE (PB_STATUS_IOUT_BASE + PMBUS_PAGES)
  67. #define PB_STATUS_FAN34_BASE (PB_STATUS_FAN_BASE + PMBUS_PAGES)
  68. #define PB_STATUS_INPUT_BASE (PB_STATUS_FAN34_BASE + PMBUS_PAGES)
  69. #define PB_STATUS_TEMP_BASE (PB_STATUS_INPUT_BASE + 1)
  70. struct pmbus_sensor {
  71. char name[I2C_NAME_SIZE]; /* sysfs sensor name */
  72. struct sensor_device_attribute attribute;
  73. u8 page; /* page number */
  74. u8 reg; /* register */
  75. enum pmbus_sensor_classes class; /* sensor class */
  76. bool update; /* runtime sensor update needed */
  77. int data; /* Sensor data.
  78. Negative if there was a read error */
  79. };
  80. struct pmbus_boolean {
  81. char name[I2C_NAME_SIZE]; /* sysfs boolean name */
  82. struct sensor_device_attribute attribute;
  83. };
  84. struct pmbus_label {
  85. char name[I2C_NAME_SIZE]; /* sysfs label name */
  86. struct sensor_device_attribute attribute;
  87. char label[I2C_NAME_SIZE]; /* label */
  88. };
  89. struct pmbus_data {
  90. struct device *hwmon_dev;
  91. u32 flags; /* from platform data */
  92. int exponent; /* linear mode: exponent for output voltages */
  93. const struct pmbus_driver_info *info;
  94. int max_attributes;
  95. int num_attributes;
  96. struct attribute **attributes;
  97. struct attribute_group group;
  98. /*
  99. * Sensors cover both sensor and limit registers.
  100. */
  101. int max_sensors;
  102. int num_sensors;
  103. struct pmbus_sensor *sensors;
  104. /*
  105. * Booleans are used for alarms.
  106. * Values are determined from status registers.
  107. */
  108. int max_booleans;
  109. int num_booleans;
  110. struct pmbus_boolean *booleans;
  111. /*
  112. * Labels are used to map generic names (e.g., "in1")
  113. * to PMBus specific names (e.g., "vin" or "vout1").
  114. */
  115. int max_labels;
  116. int num_labels;
  117. struct pmbus_label *labels;
  118. struct mutex update_lock;
  119. bool valid;
  120. unsigned long last_updated; /* in jiffies */
  121. /*
  122. * A single status register covers multiple attributes,
  123. * so we keep them all together.
  124. */
  125. u8 status_bits;
  126. u8 status[PB_NUM_STATUS_REG];
  127. u8 currpage;
  128. };
  129. int pmbus_set_page(struct i2c_client *client, u8 page)
  130. {
  131. struct pmbus_data *data = i2c_get_clientdata(client);
  132. int rv = 0;
  133. int newpage;
  134. if (page != data->currpage) {
  135. rv = i2c_smbus_write_byte_data(client, PMBUS_PAGE, page);
  136. newpage = i2c_smbus_read_byte_data(client, PMBUS_PAGE);
  137. if (newpage != page)
  138. rv = -EINVAL;
  139. else
  140. data->currpage = page;
  141. }
  142. return rv;
  143. }
  144. EXPORT_SYMBOL_GPL(pmbus_set_page);
  145. static int pmbus_write_byte(struct i2c_client *client, u8 page, u8 value)
  146. {
  147. int rv;
  148. rv = pmbus_set_page(client, page);
  149. if (rv < 0)
  150. return rv;
  151. return i2c_smbus_write_byte(client, value);
  152. }
  153. static int pmbus_write_word_data(struct i2c_client *client, u8 page, u8 reg,
  154. u16 word)
  155. {
  156. int rv;
  157. rv = pmbus_set_page(client, page);
  158. if (rv < 0)
  159. return rv;
  160. return i2c_smbus_write_word_data(client, reg, word);
  161. }
  162. int pmbus_read_word_data(struct i2c_client *client, u8 page, u8 reg)
  163. {
  164. int rv;
  165. rv = pmbus_set_page(client, page);
  166. if (rv < 0)
  167. return rv;
  168. return i2c_smbus_read_word_data(client, reg);
  169. }
  170. EXPORT_SYMBOL_GPL(pmbus_read_word_data);
  171. static int pmbus_read_byte_data(struct i2c_client *client, u8 page, u8 reg)
  172. {
  173. int rv;
  174. rv = pmbus_set_page(client, page);
  175. if (rv < 0)
  176. return rv;
  177. return i2c_smbus_read_byte_data(client, reg);
  178. }
  179. static void pmbus_clear_fault_page(struct i2c_client *client, int page)
  180. {
  181. pmbus_write_byte(client, page, PMBUS_CLEAR_FAULTS);
  182. }
  183. void pmbus_clear_faults(struct i2c_client *client)
  184. {
  185. struct pmbus_data *data = i2c_get_clientdata(client);
  186. int i;
  187. for (i = 0; i < data->info->pages; i++)
  188. pmbus_clear_fault_page(client, i);
  189. }
  190. EXPORT_SYMBOL_GPL(pmbus_clear_faults);
  191. static int pmbus_check_status_cml(struct i2c_client *client, int page)
  192. {
  193. int status, status2;
  194. status = pmbus_read_byte_data(client, page, PMBUS_STATUS_BYTE);
  195. if (status < 0 || (status & PB_STATUS_CML)) {
  196. status2 = pmbus_read_byte_data(client, page, PMBUS_STATUS_CML);
  197. if (status2 < 0 || (status2 & PB_CML_FAULT_INVALID_COMMAND))
  198. return -EINVAL;
  199. }
  200. return 0;
  201. }
  202. bool pmbus_check_byte_register(struct i2c_client *client, int page, int reg)
  203. {
  204. int rv;
  205. struct pmbus_data *data = i2c_get_clientdata(client);
  206. rv = pmbus_read_byte_data(client, page, reg);
  207. if (rv >= 0 && !(data->flags & PMBUS_SKIP_STATUS_CHECK))
  208. rv = pmbus_check_status_cml(client, page);
  209. pmbus_clear_fault_page(client, page);
  210. return rv >= 0;
  211. }
  212. EXPORT_SYMBOL_GPL(pmbus_check_byte_register);
  213. bool pmbus_check_word_register(struct i2c_client *client, int page, int reg)
  214. {
  215. int rv;
  216. struct pmbus_data *data = i2c_get_clientdata(client);
  217. rv = pmbus_read_word_data(client, page, reg);
  218. if (rv >= 0 && !(data->flags & PMBUS_SKIP_STATUS_CHECK))
  219. rv = pmbus_check_status_cml(client, page);
  220. pmbus_clear_fault_page(client, page);
  221. return rv >= 0;
  222. }
  223. EXPORT_SYMBOL_GPL(pmbus_check_word_register);
  224. const struct pmbus_driver_info *pmbus_get_driver_info(struct i2c_client *client)
  225. {
  226. struct pmbus_data *data = i2c_get_clientdata(client);
  227. return data->info;
  228. }
  229. EXPORT_SYMBOL_GPL(pmbus_get_driver_info);
  230. static int pmbus_get_status(struct i2c_client *client, int page, int reg)
  231. {
  232. struct pmbus_data *data = i2c_get_clientdata(client);
  233. const struct pmbus_driver_info *info = data->info;
  234. int status;
  235. if (info->get_status) {
  236. status = info->get_status(client, page, reg);
  237. if (status != -ENODATA)
  238. return status;
  239. }
  240. return pmbus_read_byte_data(client, page, reg);
  241. }
  242. static struct pmbus_data *pmbus_update_device(struct device *dev)
  243. {
  244. struct i2c_client *client = to_i2c_client(dev);
  245. struct pmbus_data *data = i2c_get_clientdata(client);
  246. const struct pmbus_driver_info *info = data->info;
  247. mutex_lock(&data->update_lock);
  248. if (time_after(jiffies, data->last_updated + HZ) || !data->valid) {
  249. int i;
  250. for (i = 0; i < info->pages; i++)
  251. data->status[PB_STATUS_BASE + i]
  252. = pmbus_read_byte_data(client, i,
  253. PMBUS_STATUS_BYTE);
  254. for (i = 0; i < info->pages; i++) {
  255. if (!(info->func[i] & PMBUS_HAVE_STATUS_VOUT))
  256. continue;
  257. data->status[PB_STATUS_VOUT_BASE + i]
  258. = pmbus_get_status(client, i, PMBUS_STATUS_VOUT);
  259. }
  260. for (i = 0; i < info->pages; i++) {
  261. if (!(info->func[i] & PMBUS_HAVE_STATUS_IOUT))
  262. continue;
  263. data->status[PB_STATUS_IOUT_BASE + i]
  264. = pmbus_get_status(client, i, PMBUS_STATUS_IOUT);
  265. }
  266. for (i = 0; i < info->pages; i++) {
  267. if (!(info->func[i] & PMBUS_HAVE_STATUS_TEMP))
  268. continue;
  269. data->status[PB_STATUS_TEMP_BASE + i]
  270. = pmbus_get_status(client, i,
  271. PMBUS_STATUS_TEMPERATURE);
  272. }
  273. for (i = 0; i < info->pages; i++) {
  274. if (!(info->func[i] & PMBUS_HAVE_STATUS_FAN12))
  275. continue;
  276. data->status[PB_STATUS_FAN_BASE + i]
  277. = pmbus_get_status(client, i, PMBUS_STATUS_FAN_12);
  278. }
  279. for (i = 0; i < info->pages; i++) {
  280. if (!(info->func[i] & PMBUS_HAVE_STATUS_FAN34))
  281. continue;
  282. data->status[PB_STATUS_FAN34_BASE + i]
  283. = pmbus_get_status(client, i, PMBUS_STATUS_FAN_34);
  284. }
  285. if (info->func[0] & PMBUS_HAVE_STATUS_INPUT)
  286. data->status[PB_STATUS_INPUT_BASE]
  287. = pmbus_get_status(client, 0, PMBUS_STATUS_INPUT);
  288. for (i = 0; i < data->num_sensors; i++) {
  289. struct pmbus_sensor *sensor = &data->sensors[i];
  290. if (!data->valid || sensor->update)
  291. sensor->data
  292. = pmbus_read_word_data(client, sensor->page,
  293. sensor->reg);
  294. }
  295. pmbus_clear_faults(client);
  296. data->last_updated = jiffies;
  297. data->valid = 1;
  298. }
  299. mutex_unlock(&data->update_lock);
  300. return data;
  301. }
  302. /*
  303. * Convert linear sensor values to milli- or micro-units
  304. * depending on sensor type.
  305. */
  306. static int pmbus_reg2data_linear(struct pmbus_data *data,
  307. struct pmbus_sensor *sensor)
  308. {
  309. s16 exponent, mantissa;
  310. long val;
  311. if (sensor->class == PSC_VOLTAGE_OUT) {
  312. exponent = data->exponent;
  313. mantissa = (s16) sensor->data;
  314. } else {
  315. exponent = (sensor->data >> 11) & 0x001f;
  316. mantissa = sensor->data & 0x07ff;
  317. if (exponent > 0x0f)
  318. exponent |= 0xffe0; /* sign extend exponent */
  319. if (mantissa > 0x03ff)
  320. mantissa |= 0xf800; /* sign extend mantissa */
  321. }
  322. val = mantissa;
  323. /* scale result to milli-units for all sensors except fans */
  324. if (sensor->class != PSC_FAN)
  325. val = val * 1000L;
  326. /* scale result to micro-units for power sensors */
  327. if (sensor->class == PSC_POWER)
  328. val = val * 1000L;
  329. if (exponent >= 0)
  330. val <<= exponent;
  331. else
  332. val >>= -exponent;
  333. return (int)val;
  334. }
  335. /*
  336. * Convert direct sensor values to milli- or micro-units
  337. * depending on sensor type.
  338. */
  339. static int pmbus_reg2data_direct(struct pmbus_data *data,
  340. struct pmbus_sensor *sensor)
  341. {
  342. long val = (s16) sensor->data;
  343. long m, b, R;
  344. m = data->info->m[sensor->class];
  345. b = data->info->b[sensor->class];
  346. R = data->info->R[sensor->class];
  347. if (m == 0)
  348. return 0;
  349. /* X = 1/m * (Y * 10^-R - b) */
  350. R = -R;
  351. /* scale result to milli-units for everything but fans */
  352. if (sensor->class != PSC_FAN) {
  353. R += 3;
  354. b *= 1000;
  355. }
  356. /* scale result to micro-units for power sensors */
  357. if (sensor->class == PSC_POWER) {
  358. R += 3;
  359. b *= 1000;
  360. }
  361. while (R > 0) {
  362. val *= 10;
  363. R--;
  364. }
  365. while (R < 0) {
  366. val = DIV_ROUND_CLOSEST(val, 10);
  367. R++;
  368. }
  369. return (int)((val - b) / m);
  370. }
  371. static int pmbus_reg2data(struct pmbus_data *data, struct pmbus_sensor *sensor)
  372. {
  373. int val;
  374. if (data->info->direct[sensor->class])
  375. val = pmbus_reg2data_direct(data, sensor);
  376. else
  377. val = pmbus_reg2data_linear(data, sensor);
  378. return val;
  379. }
  380. #define MAX_MANTISSA (1023 * 1000)
  381. #define MIN_MANTISSA (511 * 1000)
  382. static u16 pmbus_data2reg_linear(struct pmbus_data *data,
  383. enum pmbus_sensor_classes class, long val)
  384. {
  385. s16 exponent = 0, mantissa = 0;
  386. bool negative = false;
  387. /* simple case */
  388. if (val == 0)
  389. return 0;
  390. if (val < 0) {
  391. negative = true;
  392. val = -val;
  393. }
  394. if (class == PSC_VOLTAGE_OUT) {
  395. /*
  396. * For a static exponents, we don't have a choice
  397. * but to adjust the value to it.
  398. */
  399. if (data->exponent < 0)
  400. val <<= -data->exponent;
  401. else
  402. val >>= data->exponent;
  403. val = DIV_ROUND_CLOSEST(val, 1000);
  404. if (val > 0x7fff)
  405. val = 0x7fff;
  406. return negative ? -val : val;
  407. }
  408. /* Power is in uW. Convert to mW before converting. */
  409. if (class == PSC_POWER)
  410. val = DIV_ROUND_CLOSEST(val, 1000L);
  411. /*
  412. * For simplicity, convert fan data to milli-units
  413. * before calculating the exponent.
  414. */
  415. if (class == PSC_FAN)
  416. val = val * 1000;
  417. /* Reduce large mantissa until it fits into 10 bit */
  418. while (val >= MAX_MANTISSA && exponent < 15) {
  419. exponent++;
  420. val >>= 1;
  421. }
  422. /* Increase small mantissa to improve precision */
  423. while (val < MIN_MANTISSA && exponent > -15) {
  424. exponent--;
  425. val <<= 1;
  426. }
  427. /* Convert mantissa from milli-units to units */
  428. mantissa = DIV_ROUND_CLOSEST(val, 1000);
  429. /* Ensure that resulting number is within range */
  430. if (mantissa > 0x3ff)
  431. mantissa = 0x3ff;
  432. /* restore sign */
  433. if (negative)
  434. mantissa = -mantissa;
  435. /* Convert to 5 bit exponent, 11 bit mantissa */
  436. return (mantissa & 0x7ff) | ((exponent << 11) & 0xf800);
  437. }
  438. static u16 pmbus_data2reg_direct(struct pmbus_data *data,
  439. enum pmbus_sensor_classes class, long val)
  440. {
  441. long m, b, R;
  442. m = data->info->m[class];
  443. b = data->info->b[class];
  444. R = data->info->R[class];
  445. /* Power is in uW. Adjust R and b. */
  446. if (class == PSC_POWER) {
  447. R -= 3;
  448. b *= 1000;
  449. }
  450. /* Calculate Y = (m * X + b) * 10^R */
  451. if (class != PSC_FAN) {
  452. R -= 3; /* Adjust R and b for data in milli-units */
  453. b *= 1000;
  454. }
  455. val = val * m + b;
  456. while (R > 0) {
  457. val *= 10;
  458. R--;
  459. }
  460. while (R < 0) {
  461. val = DIV_ROUND_CLOSEST(val, 10);
  462. R++;
  463. }
  464. return val;
  465. }
  466. static u16 pmbus_data2reg(struct pmbus_data *data,
  467. enum pmbus_sensor_classes class, long val)
  468. {
  469. u16 regval;
  470. if (data->info->direct[class])
  471. regval = pmbus_data2reg_direct(data, class, val);
  472. else
  473. regval = pmbus_data2reg_linear(data, class, val);
  474. return regval;
  475. }
  476. /*
  477. * Return boolean calculated from converted data.
  478. * <index> defines a status register index and mask, and optionally
  479. * two sensor indexes.
  480. * The upper half-word references the two sensors,
  481. * two sensor indices.
  482. * The upper half-word references the two optional sensors,
  483. * the lower half word references status register and mask.
  484. * The function returns true if (status[reg] & mask) is true and,
  485. * if specified, if v1 >= v2.
  486. * To determine if an object exceeds upper limits, specify <v, limit>.
  487. * To determine if an object exceeds lower limits, specify <limit, v>.
  488. *
  489. * For booleans created with pmbus_add_boolean_reg(), only the lower 16 bits of
  490. * index are set. s1 and s2 (the sensor index values) are zero in this case.
  491. * The function returns true if (status[reg] & mask) is true.
  492. *
  493. * If the boolean was created with pmbus_add_boolean_cmp(), a comparison against
  494. * a specified limit has to be performed to determine the boolean result.
  495. * In this case, the function returns true if v1 >= v2 (where v1 and v2 are
  496. * sensor values referenced by sensor indices s1 and s2).
  497. *
  498. * To determine if an object exceeds upper limits, specify <s1,s2> = <v,limit>.
  499. * To determine if an object exceeds lower limits, specify <s1,s2> = <limit,v>.
  500. *
  501. * If a negative value is stored in any of the referenced registers, this value
  502. * reflects an error code which will be returned.
  503. */
  504. static int pmbus_get_boolean(struct pmbus_data *data, int index, int *val)
  505. {
  506. u8 s1 = (index >> 24) & 0xff;
  507. u8 s2 = (index >> 16) & 0xff;
  508. u8 reg = (index >> 8) & 0xff;
  509. u8 mask = index & 0xff;
  510. int status;
  511. u8 regval;
  512. status = data->status[reg];
  513. if (status < 0)
  514. return status;
  515. regval = status & mask;
  516. if (!s1 && !s2)
  517. *val = !!regval;
  518. else {
  519. int v1, v2;
  520. struct pmbus_sensor *sensor1, *sensor2;
  521. sensor1 = &data->sensors[s1];
  522. if (sensor1->data < 0)
  523. return sensor1->data;
  524. sensor2 = &data->sensors[s2];
  525. if (sensor2->data < 0)
  526. return sensor2->data;
  527. v1 = pmbus_reg2data(data, sensor1);
  528. v2 = pmbus_reg2data(data, sensor2);
  529. *val = !!(regval && v1 >= v2);
  530. }
  531. return 0;
  532. }
  533. static ssize_t pmbus_show_boolean(struct device *dev,
  534. struct device_attribute *da, char *buf)
  535. {
  536. struct sensor_device_attribute *attr = to_sensor_dev_attr(da);
  537. struct pmbus_data *data = pmbus_update_device(dev);
  538. int val;
  539. int err;
  540. err = pmbus_get_boolean(data, attr->index, &val);
  541. if (err)
  542. return err;
  543. return snprintf(buf, PAGE_SIZE, "%d\n", val);
  544. }
  545. static ssize_t pmbus_show_sensor(struct device *dev,
  546. struct device_attribute *da, char *buf)
  547. {
  548. struct sensor_device_attribute *attr = to_sensor_dev_attr(da);
  549. struct pmbus_data *data = pmbus_update_device(dev);
  550. struct pmbus_sensor *sensor;
  551. sensor = &data->sensors[attr->index];
  552. if (sensor->data < 0)
  553. return sensor->data;
  554. return snprintf(buf, PAGE_SIZE, "%d\n", pmbus_reg2data(data, sensor));
  555. }
  556. static ssize_t pmbus_set_sensor(struct device *dev,
  557. struct device_attribute *devattr,
  558. const char *buf, size_t count)
  559. {
  560. struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
  561. struct i2c_client *client = to_i2c_client(dev);
  562. struct pmbus_data *data = i2c_get_clientdata(client);
  563. struct pmbus_sensor *sensor = &data->sensors[attr->index];
  564. ssize_t rv = count;
  565. long val = 0;
  566. int ret;
  567. u16 regval;
  568. if (strict_strtol(buf, 10, &val) < 0)
  569. return -EINVAL;
  570. mutex_lock(&data->update_lock);
  571. regval = pmbus_data2reg(data, sensor->class, val);
  572. ret = pmbus_write_word_data(client, sensor->page, sensor->reg, regval);
  573. if (ret < 0)
  574. rv = ret;
  575. else
  576. data->sensors[attr->index].data = regval;
  577. mutex_unlock(&data->update_lock);
  578. return rv;
  579. }
  580. static ssize_t pmbus_show_label(struct device *dev,
  581. struct device_attribute *da, char *buf)
  582. {
  583. struct i2c_client *client = to_i2c_client(dev);
  584. struct pmbus_data *data = i2c_get_clientdata(client);
  585. struct sensor_device_attribute *attr = to_sensor_dev_attr(da);
  586. return snprintf(buf, PAGE_SIZE, "%s\n",
  587. data->labels[attr->index].label);
  588. }
  589. #define PMBUS_ADD_ATTR(data, _name, _idx, _mode, _type, _show, _set) \
  590. do { \
  591. struct sensor_device_attribute *a \
  592. = &data->_type##s[data->num_##_type##s].attribute; \
  593. BUG_ON(data->num_attributes >= data->max_attributes); \
  594. a->dev_attr.attr.name = _name; \
  595. a->dev_attr.attr.mode = _mode; \
  596. a->dev_attr.show = _show; \
  597. a->dev_attr.store = _set; \
  598. a->index = _idx; \
  599. data->attributes[data->num_attributes] = &a->dev_attr.attr; \
  600. data->num_attributes++; \
  601. } while (0)
  602. #define PMBUS_ADD_GET_ATTR(data, _name, _type, _idx) \
  603. PMBUS_ADD_ATTR(data, _name, _idx, S_IRUGO, _type, \
  604. pmbus_show_##_type, NULL)
  605. #define PMBUS_ADD_SET_ATTR(data, _name, _type, _idx) \
  606. PMBUS_ADD_ATTR(data, _name, _idx, S_IWUSR | S_IRUGO, _type, \
  607. pmbus_show_##_type, pmbus_set_##_type)
  608. static void pmbus_add_boolean(struct pmbus_data *data,
  609. const char *name, const char *type, int seq,
  610. int idx)
  611. {
  612. struct pmbus_boolean *boolean;
  613. BUG_ON(data->num_booleans >= data->max_booleans);
  614. boolean = &data->booleans[data->num_booleans];
  615. snprintf(boolean->name, sizeof(boolean->name), "%s%d_%s",
  616. name, seq, type);
  617. PMBUS_ADD_GET_ATTR(data, boolean->name, boolean, idx);
  618. data->num_booleans++;
  619. }
  620. static void pmbus_add_boolean_reg(struct pmbus_data *data,
  621. const char *name, const char *type,
  622. int seq, int reg, int bit)
  623. {
  624. pmbus_add_boolean(data, name, type, seq, (reg << 8) | bit);
  625. }
  626. static void pmbus_add_boolean_cmp(struct pmbus_data *data,
  627. const char *name, const char *type,
  628. int seq, int i1, int i2, int reg, int mask)
  629. {
  630. pmbus_add_boolean(data, name, type, seq,
  631. (i1 << 24) | (i2 << 16) | (reg << 8) | mask);
  632. }
  633. static void pmbus_add_sensor(struct pmbus_data *data,
  634. const char *name, const char *type, int seq,
  635. int page, int reg, enum pmbus_sensor_classes class,
  636. bool update)
  637. {
  638. struct pmbus_sensor *sensor;
  639. BUG_ON(data->num_sensors >= data->max_sensors);
  640. sensor = &data->sensors[data->num_sensors];
  641. snprintf(sensor->name, sizeof(sensor->name), "%s%d_%s",
  642. name, seq, type);
  643. sensor->page = page;
  644. sensor->reg = reg;
  645. sensor->class = class;
  646. sensor->update = update;
  647. if (update)
  648. PMBUS_ADD_GET_ATTR(data, sensor->name, sensor,
  649. data->num_sensors);
  650. else
  651. PMBUS_ADD_SET_ATTR(data, sensor->name, sensor,
  652. data->num_sensors);
  653. data->num_sensors++;
  654. }
  655. static void pmbus_add_label(struct pmbus_data *data,
  656. const char *name, int seq,
  657. const char *lstring, int index)
  658. {
  659. struct pmbus_label *label;
  660. BUG_ON(data->num_labels >= data->max_labels);
  661. label = &data->labels[data->num_labels];
  662. snprintf(label->name, sizeof(label->name), "%s%d_label", name, seq);
  663. if (!index)
  664. strncpy(label->label, lstring, sizeof(label->label) - 1);
  665. else
  666. snprintf(label->label, sizeof(label->label), "%s%d", lstring,
  667. index);
  668. PMBUS_ADD_GET_ATTR(data, label->name, label, data->num_labels);
  669. data->num_labels++;
  670. }
  671. static const int pmbus_temp_registers[] = {
  672. PMBUS_READ_TEMPERATURE_1,
  673. PMBUS_READ_TEMPERATURE_2,
  674. PMBUS_READ_TEMPERATURE_3
  675. };
  676. static const int pmbus_fan_registers[] = {
  677. PMBUS_READ_FAN_SPEED_1,
  678. PMBUS_READ_FAN_SPEED_2,
  679. PMBUS_READ_FAN_SPEED_3,
  680. PMBUS_READ_FAN_SPEED_4
  681. };
  682. static const int pmbus_fan_config_registers[] = {
  683. PMBUS_FAN_CONFIG_12,
  684. PMBUS_FAN_CONFIG_12,
  685. PMBUS_FAN_CONFIG_34,
  686. PMBUS_FAN_CONFIG_34
  687. };
  688. static const int pmbus_fan_status_registers[] = {
  689. PMBUS_STATUS_FAN_12,
  690. PMBUS_STATUS_FAN_12,
  691. PMBUS_STATUS_FAN_34,
  692. PMBUS_STATUS_FAN_34
  693. };
  694. static const u32 pmbus_fan_flags[] = {
  695. PMBUS_HAVE_FAN12,
  696. PMBUS_HAVE_FAN12,
  697. PMBUS_HAVE_FAN34,
  698. PMBUS_HAVE_FAN34
  699. };
  700. static const u32 pmbus_fan_status_flags[] = {
  701. PMBUS_HAVE_STATUS_FAN12,
  702. PMBUS_HAVE_STATUS_FAN12,
  703. PMBUS_HAVE_STATUS_FAN34,
  704. PMBUS_HAVE_STATUS_FAN34
  705. };
  706. /*
  707. * Determine maximum number of sensors, booleans, and labels.
  708. * To keep things simple, only make a rough high estimate.
  709. */
  710. static void pmbus_find_max_attr(struct i2c_client *client,
  711. struct pmbus_data *data)
  712. {
  713. const struct pmbus_driver_info *info = data->info;
  714. int page, max_sensors, max_booleans, max_labels;
  715. max_sensors = PMBUS_MAX_INPUT_SENSORS;
  716. max_booleans = PMBUS_MAX_INPUT_BOOLEANS;
  717. max_labels = PMBUS_MAX_INPUT_LABELS;
  718. for (page = 0; page < info->pages; page++) {
  719. if (info->func[page] & PMBUS_HAVE_VOUT) {
  720. max_sensors += PMBUS_VOUT_SENSORS_PER_PAGE;
  721. max_booleans += PMBUS_VOUT_BOOLEANS_PER_PAGE;
  722. max_labels++;
  723. }
  724. if (info->func[page] & PMBUS_HAVE_IOUT) {
  725. max_sensors += PMBUS_IOUT_SENSORS_PER_PAGE;
  726. max_booleans += PMBUS_IOUT_BOOLEANS_PER_PAGE;
  727. max_labels++;
  728. }
  729. if (info->func[page] & PMBUS_HAVE_POUT) {
  730. max_sensors += PMBUS_POUT_SENSORS_PER_PAGE;
  731. max_booleans += PMBUS_POUT_BOOLEANS_PER_PAGE;
  732. max_labels++;
  733. }
  734. if (info->func[page] & PMBUS_HAVE_FAN12) {
  735. max_sensors += 2 * PMBUS_MAX_SENSORS_PER_FAN;
  736. max_booleans += 2 * PMBUS_MAX_BOOLEANS_PER_FAN;
  737. }
  738. if (info->func[page] & PMBUS_HAVE_FAN34) {
  739. max_sensors += 2 * PMBUS_MAX_SENSORS_PER_FAN;
  740. max_booleans += 2 * PMBUS_MAX_BOOLEANS_PER_FAN;
  741. }
  742. if (info->func[page] & PMBUS_HAVE_TEMP) {
  743. if (page == 0) {
  744. max_sensors +=
  745. ARRAY_SIZE(pmbus_temp_registers) *
  746. PMBUS_MAX_SENSORS_PER_TEMP;
  747. max_booleans +=
  748. ARRAY_SIZE(pmbus_temp_registers) *
  749. PMBUS_MAX_BOOLEANS_PER_TEMP;
  750. } else {
  751. max_sensors += PMBUS_MAX_SENSORS_PER_TEMP;
  752. max_booleans += PMBUS_MAX_BOOLEANS_PER_TEMP;
  753. }
  754. }
  755. }
  756. data->max_sensors = max_sensors;
  757. data->max_booleans = max_booleans;
  758. data->max_labels = max_labels;
  759. data->max_attributes = max_sensors + max_booleans + max_labels;
  760. }
  761. /*
  762. * Search for attributes. Allocate sensors, booleans, and labels as needed.
  763. */
  764. static void pmbus_find_attributes(struct i2c_client *client,
  765. struct pmbus_data *data)
  766. {
  767. const struct pmbus_driver_info *info = data->info;
  768. int page, i0, i1, in_index;
  769. /*
  770. * Input voltage sensors
  771. */
  772. in_index = 1;
  773. if (info->func[0] & PMBUS_HAVE_VIN) {
  774. bool have_alarm = false;
  775. i0 = data->num_sensors;
  776. pmbus_add_label(data, "in", in_index, "vin", 0);
  777. pmbus_add_sensor(data, "in", "input", in_index,
  778. 0, PMBUS_READ_VIN, PSC_VOLTAGE_IN, true);
  779. if (pmbus_check_word_register(client, 0,
  780. PMBUS_VIN_UV_WARN_LIMIT)) {
  781. i1 = data->num_sensors;
  782. pmbus_add_sensor(data, "in", "min", in_index,
  783. 0, PMBUS_VIN_UV_WARN_LIMIT,
  784. PSC_VOLTAGE_IN, false);
  785. if (info->func[0] & PMBUS_HAVE_STATUS_INPUT) {
  786. pmbus_add_boolean_reg(data, "in", "min_alarm",
  787. in_index,
  788. PB_STATUS_INPUT_BASE,
  789. PB_VOLTAGE_UV_WARNING);
  790. have_alarm = true;
  791. }
  792. }
  793. if (pmbus_check_word_register(client, 0,
  794. PMBUS_VIN_UV_FAULT_LIMIT)) {
  795. i1 = data->num_sensors;
  796. pmbus_add_sensor(data, "in", "lcrit", in_index,
  797. 0, PMBUS_VIN_UV_FAULT_LIMIT,
  798. PSC_VOLTAGE_IN, false);
  799. if (info->func[0] & PMBUS_HAVE_STATUS_INPUT) {
  800. pmbus_add_boolean_reg(data, "in", "lcrit_alarm",
  801. in_index,
  802. PB_STATUS_INPUT_BASE,
  803. PB_VOLTAGE_UV_FAULT);
  804. have_alarm = true;
  805. }
  806. }
  807. if (pmbus_check_word_register(client, 0,
  808. PMBUS_VIN_OV_WARN_LIMIT)) {
  809. i1 = data->num_sensors;
  810. pmbus_add_sensor(data, "in", "max", in_index,
  811. 0, PMBUS_VIN_OV_WARN_LIMIT,
  812. PSC_VOLTAGE_IN, false);
  813. if (info->func[0] & PMBUS_HAVE_STATUS_INPUT) {
  814. pmbus_add_boolean_reg(data, "in", "max_alarm",
  815. in_index,
  816. PB_STATUS_INPUT_BASE,
  817. PB_VOLTAGE_OV_WARNING);
  818. have_alarm = true;
  819. }
  820. }
  821. if (pmbus_check_word_register(client, 0,
  822. PMBUS_VIN_OV_FAULT_LIMIT)) {
  823. i1 = data->num_sensors;
  824. pmbus_add_sensor(data, "in", "crit", in_index,
  825. 0, PMBUS_VIN_OV_FAULT_LIMIT,
  826. PSC_VOLTAGE_IN, false);
  827. if (info->func[0] & PMBUS_HAVE_STATUS_INPUT) {
  828. pmbus_add_boolean_reg(data, "in", "crit_alarm",
  829. in_index,
  830. PB_STATUS_INPUT_BASE,
  831. PB_VOLTAGE_OV_FAULT);
  832. have_alarm = true;
  833. }
  834. }
  835. /*
  836. * Add generic alarm attribute only if there are no individual
  837. * attributes.
  838. */
  839. if (!have_alarm)
  840. pmbus_add_boolean_reg(data, "in", "alarm",
  841. in_index,
  842. PB_STATUS_BASE,
  843. PB_STATUS_VIN_UV);
  844. in_index++;
  845. }
  846. if (info->func[0] & PMBUS_HAVE_VCAP) {
  847. pmbus_add_label(data, "in", in_index, "vcap", 0);
  848. pmbus_add_sensor(data, "in", "input", in_index, 0,
  849. PMBUS_READ_VCAP, PSC_VOLTAGE_IN, true);
  850. in_index++;
  851. }
  852. /*
  853. * Output voltage sensors
  854. */
  855. for (page = 0; page < info->pages; page++) {
  856. bool have_alarm = false;
  857. if (!(info->func[page] & PMBUS_HAVE_VOUT))
  858. continue;
  859. i0 = data->num_sensors;
  860. pmbus_add_label(data, "in", in_index, "vout", page + 1);
  861. pmbus_add_sensor(data, "in", "input", in_index, page,
  862. PMBUS_READ_VOUT, PSC_VOLTAGE_OUT, true);
  863. if (pmbus_check_word_register(client, page,
  864. PMBUS_VOUT_UV_WARN_LIMIT)) {
  865. i1 = data->num_sensors;
  866. pmbus_add_sensor(data, "in", "min", in_index, page,
  867. PMBUS_VOUT_UV_WARN_LIMIT,
  868. PSC_VOLTAGE_OUT, false);
  869. if (info->func[page] & PMBUS_HAVE_STATUS_VOUT) {
  870. pmbus_add_boolean_reg(data, "in", "min_alarm",
  871. in_index,
  872. PB_STATUS_VOUT_BASE +
  873. page,
  874. PB_VOLTAGE_UV_WARNING);
  875. have_alarm = true;
  876. }
  877. }
  878. if (pmbus_check_word_register(client, page,
  879. PMBUS_VOUT_UV_FAULT_LIMIT)) {
  880. i1 = data->num_sensors;
  881. pmbus_add_sensor(data, "in", "lcrit", in_index, page,
  882. PMBUS_VOUT_UV_FAULT_LIMIT,
  883. PSC_VOLTAGE_OUT, false);
  884. if (info->func[page] & PMBUS_HAVE_STATUS_VOUT) {
  885. pmbus_add_boolean_reg(data, "in", "lcrit_alarm",
  886. in_index,
  887. PB_STATUS_VOUT_BASE +
  888. page,
  889. PB_VOLTAGE_UV_FAULT);
  890. have_alarm = true;
  891. }
  892. }
  893. if (pmbus_check_word_register(client, page,
  894. PMBUS_VOUT_OV_WARN_LIMIT)) {
  895. i1 = data->num_sensors;
  896. pmbus_add_sensor(data, "in", "max", in_index, page,
  897. PMBUS_VOUT_OV_WARN_LIMIT,
  898. PSC_VOLTAGE_OUT, false);
  899. if (info->func[page] & PMBUS_HAVE_STATUS_VOUT) {
  900. pmbus_add_boolean_reg(data, "in", "max_alarm",
  901. in_index,
  902. PB_STATUS_VOUT_BASE +
  903. page,
  904. PB_VOLTAGE_OV_WARNING);
  905. have_alarm = true;
  906. }
  907. }
  908. if (pmbus_check_word_register(client, page,
  909. PMBUS_VOUT_OV_FAULT_LIMIT)) {
  910. i1 = data->num_sensors;
  911. pmbus_add_sensor(data, "in", "crit", in_index, page,
  912. PMBUS_VOUT_OV_FAULT_LIMIT,
  913. PSC_VOLTAGE_OUT, false);
  914. if (info->func[page] & PMBUS_HAVE_STATUS_VOUT) {
  915. pmbus_add_boolean_reg(data, "in", "crit_alarm",
  916. in_index,
  917. PB_STATUS_VOUT_BASE +
  918. page,
  919. PB_VOLTAGE_OV_FAULT);
  920. have_alarm = true;
  921. }
  922. }
  923. /*
  924. * Add generic alarm attribute only if there are no individual
  925. * attributes.
  926. */
  927. if (!have_alarm)
  928. pmbus_add_boolean_reg(data, "in", "alarm",
  929. in_index,
  930. PB_STATUS_BASE + page,
  931. PB_STATUS_VOUT_OV);
  932. in_index++;
  933. }
  934. /*
  935. * Current sensors
  936. */
  937. /*
  938. * Input current sensors
  939. */
  940. in_index = 1;
  941. if (info->func[0] & PMBUS_HAVE_IIN) {
  942. i0 = data->num_sensors;
  943. pmbus_add_label(data, "curr", in_index, "iin", 0);
  944. pmbus_add_sensor(data, "curr", "input", in_index,
  945. 0, PMBUS_READ_IIN, PSC_CURRENT_IN, true);
  946. if (pmbus_check_word_register(client, 0,
  947. PMBUS_IIN_OC_WARN_LIMIT)) {
  948. i1 = data->num_sensors;
  949. pmbus_add_sensor(data, "curr", "max", in_index,
  950. 0, PMBUS_IIN_OC_WARN_LIMIT,
  951. PSC_CURRENT_IN, false);
  952. if (info->func[0] & PMBUS_HAVE_STATUS_INPUT) {
  953. pmbus_add_boolean_reg(data, "curr", "max_alarm",
  954. in_index,
  955. PB_STATUS_INPUT_BASE,
  956. PB_IIN_OC_WARNING);
  957. }
  958. }
  959. if (pmbus_check_word_register(client, 0,
  960. PMBUS_IIN_OC_FAULT_LIMIT)) {
  961. i1 = data->num_sensors;
  962. pmbus_add_sensor(data, "curr", "crit", in_index,
  963. 0, PMBUS_IIN_OC_FAULT_LIMIT,
  964. PSC_CURRENT_IN, false);
  965. if (info->func[0] & PMBUS_HAVE_STATUS_INPUT)
  966. pmbus_add_boolean_reg(data, "curr",
  967. "crit_alarm",
  968. in_index,
  969. PB_STATUS_INPUT_BASE,
  970. PB_IIN_OC_FAULT);
  971. }
  972. in_index++;
  973. }
  974. /*
  975. * Output current sensors
  976. */
  977. for (page = 0; page < info->pages; page++) {
  978. bool have_alarm = false;
  979. if (!(info->func[page] & PMBUS_HAVE_IOUT))
  980. continue;
  981. i0 = data->num_sensors;
  982. pmbus_add_label(data, "curr", in_index, "iout", page + 1);
  983. pmbus_add_sensor(data, "curr", "input", in_index, page,
  984. PMBUS_READ_IOUT, PSC_CURRENT_OUT, true);
  985. if (pmbus_check_word_register(client, page,
  986. PMBUS_IOUT_OC_WARN_LIMIT)) {
  987. i1 = data->num_sensors;
  988. pmbus_add_sensor(data, "curr", "max", in_index, page,
  989. PMBUS_IOUT_OC_WARN_LIMIT,
  990. PSC_CURRENT_OUT, false);
  991. if (info->func[page] & PMBUS_HAVE_STATUS_IOUT) {
  992. pmbus_add_boolean_reg(data, "curr", "max_alarm",
  993. in_index,
  994. PB_STATUS_IOUT_BASE +
  995. page, PB_IOUT_OC_WARNING);
  996. have_alarm = true;
  997. }
  998. }
  999. if (pmbus_check_word_register(client, page,
  1000. PMBUS_IOUT_UC_FAULT_LIMIT)) {
  1001. i1 = data->num_sensors;
  1002. pmbus_add_sensor(data, "curr", "lcrit", in_index, page,
  1003. PMBUS_IOUT_UC_FAULT_LIMIT,
  1004. PSC_CURRENT_OUT, false);
  1005. if (info->func[page] & PMBUS_HAVE_STATUS_IOUT) {
  1006. pmbus_add_boolean_reg(data, "curr",
  1007. "lcrit_alarm",
  1008. in_index,
  1009. PB_STATUS_IOUT_BASE +
  1010. page, PB_IOUT_UC_FAULT);
  1011. have_alarm = true;
  1012. }
  1013. }
  1014. if (pmbus_check_word_register(client, page,
  1015. PMBUS_IOUT_OC_FAULT_LIMIT)) {
  1016. i1 = data->num_sensors;
  1017. pmbus_add_sensor(data, "curr", "crit", in_index, page,
  1018. PMBUS_IOUT_OC_FAULT_LIMIT,
  1019. PSC_CURRENT_OUT, false);
  1020. if (info->func[page] & PMBUS_HAVE_STATUS_IOUT) {
  1021. pmbus_add_boolean_reg(data, "curr",
  1022. "crit_alarm",
  1023. in_index,
  1024. PB_STATUS_IOUT_BASE +
  1025. page, PB_IOUT_OC_FAULT);
  1026. have_alarm = true;
  1027. }
  1028. }
  1029. /*
  1030. * Add generic alarm attribute only if there are no individual
  1031. * attributes.
  1032. */
  1033. if (!have_alarm)
  1034. pmbus_add_boolean_reg(data, "curr", "alarm",
  1035. in_index,
  1036. PB_STATUS_BASE + page,
  1037. PB_STATUS_IOUT_OC);
  1038. in_index++;
  1039. }
  1040. /*
  1041. * Power sensors
  1042. */
  1043. /*
  1044. * Input Power sensors
  1045. */
  1046. in_index = 1;
  1047. if (info->func[0] & PMBUS_HAVE_PIN) {
  1048. i0 = data->num_sensors;
  1049. pmbus_add_label(data, "power", in_index, "pin", 0);
  1050. pmbus_add_sensor(data, "power", "input", in_index,
  1051. 0, PMBUS_READ_PIN, PSC_POWER, true);
  1052. if (pmbus_check_word_register(client, 0,
  1053. PMBUS_PIN_OP_WARN_LIMIT)) {
  1054. i1 = data->num_sensors;
  1055. pmbus_add_sensor(data, "power", "max", in_index,
  1056. 0, PMBUS_PIN_OP_WARN_LIMIT, PSC_POWER,
  1057. false);
  1058. if (info->func[0] & PMBUS_HAVE_STATUS_INPUT)
  1059. pmbus_add_boolean_reg(data, "power",
  1060. "alarm",
  1061. in_index,
  1062. PB_STATUS_INPUT_BASE,
  1063. PB_PIN_OP_WARNING);
  1064. }
  1065. in_index++;
  1066. }
  1067. /*
  1068. * Output Power sensors
  1069. */
  1070. for (page = 0; page < info->pages; page++) {
  1071. bool need_alarm = false;
  1072. if (!(info->func[page] & PMBUS_HAVE_POUT))
  1073. continue;
  1074. i0 = data->num_sensors;
  1075. pmbus_add_label(data, "power", in_index, "pout", page + 1);
  1076. pmbus_add_sensor(data, "power", "input", in_index, page,
  1077. PMBUS_READ_POUT, PSC_POWER, true);
  1078. /*
  1079. * Per hwmon sysfs API, power_cap is to be used to limit output
  1080. * power.
  1081. * We have two registers related to maximum output power,
  1082. * PMBUS_POUT_MAX and PMBUS_POUT_OP_WARN_LIMIT.
  1083. * PMBUS_POUT_MAX matches the powerX_cap attribute definition.
  1084. * There is no attribute in the API to match
  1085. * PMBUS_POUT_OP_WARN_LIMIT. We use powerX_max for now.
  1086. */
  1087. if (pmbus_check_word_register(client, page, PMBUS_POUT_MAX)) {
  1088. i1 = data->num_sensors;
  1089. pmbus_add_sensor(data, "power", "cap", in_index, page,
  1090. PMBUS_POUT_MAX, PSC_POWER, false);
  1091. need_alarm = true;
  1092. }
  1093. if (pmbus_check_word_register(client, page,
  1094. PMBUS_POUT_OP_WARN_LIMIT)) {
  1095. i1 = data->num_sensors;
  1096. pmbus_add_sensor(data, "power", "max", in_index, page,
  1097. PMBUS_POUT_OP_WARN_LIMIT, PSC_POWER,
  1098. false);
  1099. need_alarm = true;
  1100. }
  1101. if (need_alarm && (info->func[page] & PMBUS_HAVE_STATUS_IOUT))
  1102. pmbus_add_boolean_reg(data, "power", "alarm",
  1103. in_index,
  1104. PB_STATUS_IOUT_BASE + page,
  1105. PB_POUT_OP_WARNING
  1106. | PB_POWER_LIMITING);
  1107. if (pmbus_check_word_register(client, page,
  1108. PMBUS_POUT_OP_FAULT_LIMIT)) {
  1109. i1 = data->num_sensors;
  1110. pmbus_add_sensor(data, "power", "crit", in_index, page,
  1111. PMBUS_POUT_OP_FAULT_LIMIT, PSC_POWER,
  1112. false);
  1113. if (info->func[page] & PMBUS_HAVE_STATUS_IOUT)
  1114. pmbus_add_boolean_reg(data, "power",
  1115. "crit_alarm",
  1116. in_index,
  1117. PB_STATUS_IOUT_BASE
  1118. + page,
  1119. PB_POUT_OP_FAULT);
  1120. }
  1121. in_index++;
  1122. }
  1123. /*
  1124. * Temperature sensors
  1125. */
  1126. in_index = 1;
  1127. for (page = 0; page < info->pages; page++) {
  1128. int t, temps;
  1129. if (!(info->func[page] & PMBUS_HAVE_TEMP))
  1130. continue;
  1131. temps = page ? 1 : ARRAY_SIZE(pmbus_temp_registers);
  1132. for (t = 0; t < temps; t++) {
  1133. bool have_alarm = false;
  1134. if (!pmbus_check_word_register
  1135. (client, page, pmbus_temp_registers[t]))
  1136. break;
  1137. i0 = data->num_sensors;
  1138. pmbus_add_sensor(data, "temp", "input", in_index, page,
  1139. pmbus_temp_registers[t],
  1140. PSC_TEMPERATURE, true);
  1141. /*
  1142. * PMBus provides only one status register for TEMP1-3.
  1143. * Thus, we can not use the status register to determine
  1144. * which of the three sensors actually caused an alarm.
  1145. * Always compare current temperature against the limit
  1146. * registers to determine alarm conditions for a
  1147. * specific sensor.
  1148. */
  1149. if (pmbus_check_word_register
  1150. (client, page, PMBUS_UT_WARN_LIMIT)) {
  1151. i1 = data->num_sensors;
  1152. pmbus_add_sensor(data, "temp", "min", in_index,
  1153. page, PMBUS_UT_WARN_LIMIT,
  1154. PSC_TEMPERATURE, false);
  1155. if (info->func[page] & PMBUS_HAVE_STATUS_TEMP) {
  1156. pmbus_add_boolean_cmp(data, "temp",
  1157. "min_alarm", in_index, i1, i0,
  1158. PB_STATUS_TEMP_BASE + page,
  1159. PB_TEMP_UT_WARNING);
  1160. have_alarm = true;
  1161. }
  1162. }
  1163. if (pmbus_check_word_register(client, page,
  1164. PMBUS_UT_FAULT_LIMIT)) {
  1165. i1 = data->num_sensors;
  1166. pmbus_add_sensor(data, "temp", "lcrit",
  1167. in_index, page,
  1168. PMBUS_UT_FAULT_LIMIT,
  1169. PSC_TEMPERATURE, false);
  1170. if (info->func[page] & PMBUS_HAVE_STATUS_TEMP) {
  1171. pmbus_add_boolean_cmp(data, "temp",
  1172. "lcrit_alarm", in_index, i1, i0,
  1173. PB_STATUS_TEMP_BASE + page,
  1174. PB_TEMP_UT_FAULT);
  1175. have_alarm = true;
  1176. }
  1177. }
  1178. if (pmbus_check_word_register
  1179. (client, page, PMBUS_OT_WARN_LIMIT)) {
  1180. i1 = data->num_sensors;
  1181. pmbus_add_sensor(data, "temp", "max", in_index,
  1182. page, PMBUS_OT_WARN_LIMIT,
  1183. PSC_TEMPERATURE, false);
  1184. if (info->func[page] & PMBUS_HAVE_STATUS_TEMP) {
  1185. pmbus_add_boolean_cmp(data, "temp",
  1186. "max_alarm", in_index, i0, i1,
  1187. PB_STATUS_TEMP_BASE + page,
  1188. PB_TEMP_OT_WARNING);
  1189. have_alarm = true;
  1190. }
  1191. }
  1192. if (pmbus_check_word_register(client, page,
  1193. PMBUS_OT_FAULT_LIMIT)) {
  1194. i1 = data->num_sensors;
  1195. pmbus_add_sensor(data, "temp", "crit", in_index,
  1196. page, PMBUS_OT_FAULT_LIMIT,
  1197. PSC_TEMPERATURE, false);
  1198. if (info->func[page] & PMBUS_HAVE_STATUS_TEMP) {
  1199. pmbus_add_boolean_cmp(data, "temp",
  1200. "crit_alarm", in_index, i0, i1,
  1201. PB_STATUS_TEMP_BASE + page,
  1202. PB_TEMP_OT_FAULT);
  1203. have_alarm = true;
  1204. }
  1205. }
  1206. /*
  1207. * Last resort - we were not able to create any alarm
  1208. * registers. Report alarm for all sensors using the
  1209. * status register temperature alarm bit.
  1210. */
  1211. if (!have_alarm)
  1212. pmbus_add_boolean_reg(data, "temp", "alarm",
  1213. in_index,
  1214. PB_STATUS_BASE + page,
  1215. PB_STATUS_TEMPERATURE);
  1216. in_index++;
  1217. }
  1218. }
  1219. /*
  1220. * Fans
  1221. */
  1222. in_index = 1;
  1223. for (page = 0; page < info->pages; page++) {
  1224. int f;
  1225. for (f = 0; f < ARRAY_SIZE(pmbus_fan_registers); f++) {
  1226. int regval;
  1227. if (!(info->func[page] & pmbus_fan_flags[f]))
  1228. break;
  1229. if (!pmbus_check_word_register(client, page,
  1230. pmbus_fan_registers[f])
  1231. || !pmbus_check_byte_register(client, page,
  1232. pmbus_fan_config_registers[f]))
  1233. break;
  1234. /*
  1235. * Skip fan if not installed.
  1236. * Each fan configuration register covers multiple fans,
  1237. * so we have to do some magic.
  1238. */
  1239. regval = pmbus_read_byte_data(client, page,
  1240. pmbus_fan_config_registers[f]);
  1241. if (regval < 0 ||
  1242. (!(regval & (PB_FAN_1_INSTALLED >> ((f & 1) * 4)))))
  1243. continue;
  1244. i0 = data->num_sensors;
  1245. pmbus_add_sensor(data, "fan", "input", in_index, page,
  1246. pmbus_fan_registers[f], PSC_FAN, true);
  1247. /*
  1248. * Each fan status register covers multiple fans,
  1249. * so we have to do some magic.
  1250. */
  1251. if ((info->func[page] & pmbus_fan_status_flags[f]) &&
  1252. pmbus_check_byte_register(client,
  1253. page, pmbus_fan_status_registers[f])) {
  1254. int base;
  1255. if (f > 1) /* fan 3, 4 */
  1256. base = PB_STATUS_FAN34_BASE + page;
  1257. else
  1258. base = PB_STATUS_FAN_BASE + page;
  1259. pmbus_add_boolean_reg(data, "fan", "alarm",
  1260. in_index, base,
  1261. PB_FAN_FAN1_WARNING >> (f & 1));
  1262. pmbus_add_boolean_reg(data, "fan", "fault",
  1263. in_index, base,
  1264. PB_FAN_FAN1_FAULT >> (f & 1));
  1265. }
  1266. in_index++;
  1267. }
  1268. }
  1269. }
  1270. /*
  1271. * Identify chip parameters.
  1272. * This function is called for all chips.
  1273. */
  1274. static int pmbus_identify_common(struct i2c_client *client,
  1275. struct pmbus_data *data)
  1276. {
  1277. int vout_mode = -1, exponent;
  1278. if (pmbus_check_byte_register(client, 0, PMBUS_VOUT_MODE))
  1279. vout_mode = pmbus_read_byte_data(client, 0, PMBUS_VOUT_MODE);
  1280. if (vout_mode >= 0 && vout_mode != 0xff) {
  1281. /*
  1282. * Not all chips support the VOUT_MODE command,
  1283. * so a failure to read it is not an error.
  1284. */
  1285. switch (vout_mode >> 5) {
  1286. case 0: /* linear mode */
  1287. if (data->info->direct[PSC_VOLTAGE_OUT])
  1288. return -ENODEV;
  1289. exponent = vout_mode & 0x1f;
  1290. /* and sign-extend it */
  1291. if (exponent & 0x10)
  1292. exponent |= ~0x1f;
  1293. data->exponent = exponent;
  1294. break;
  1295. case 2: /* direct mode */
  1296. if (!data->info->direct[PSC_VOLTAGE_OUT])
  1297. return -ENODEV;
  1298. break;
  1299. default:
  1300. return -ENODEV;
  1301. }
  1302. }
  1303. /* Determine maximum number of sensors, booleans, and labels */
  1304. pmbus_find_max_attr(client, data);
  1305. pmbus_clear_fault_page(client, 0);
  1306. return 0;
  1307. }
  1308. int pmbus_do_probe(struct i2c_client *client, const struct i2c_device_id *id,
  1309. struct pmbus_driver_info *info)
  1310. {
  1311. const struct pmbus_platform_data *pdata = client->dev.platform_data;
  1312. struct pmbus_data *data;
  1313. int ret;
  1314. if (!info) {
  1315. dev_err(&client->dev, "Missing chip information");
  1316. return -ENODEV;
  1317. }
  1318. if (!i2c_check_functionality(client->adapter, I2C_FUNC_SMBUS_WRITE_BYTE
  1319. | I2C_FUNC_SMBUS_BYTE_DATA
  1320. | I2C_FUNC_SMBUS_WORD_DATA))
  1321. return -ENODEV;
  1322. data = kzalloc(sizeof(*data), GFP_KERNEL);
  1323. if (!data) {
  1324. dev_err(&client->dev, "No memory to allocate driver data\n");
  1325. return -ENOMEM;
  1326. }
  1327. i2c_set_clientdata(client, data);
  1328. mutex_init(&data->update_lock);
  1329. /*
  1330. * Bail out if status register or PMBus revision register
  1331. * does not exist.
  1332. */
  1333. if (i2c_smbus_read_byte_data(client, PMBUS_STATUS_BYTE) < 0
  1334. || i2c_smbus_read_byte_data(client, PMBUS_REVISION) < 0) {
  1335. dev_err(&client->dev,
  1336. "Status or revision register not found\n");
  1337. ret = -ENODEV;
  1338. goto out_data;
  1339. }
  1340. if (pdata)
  1341. data->flags = pdata->flags;
  1342. data->info = info;
  1343. pmbus_clear_faults(client);
  1344. if (info->identify) {
  1345. ret = (*info->identify)(client, info);
  1346. if (ret < 0) {
  1347. dev_err(&client->dev, "Chip identification failed\n");
  1348. goto out_data;
  1349. }
  1350. }
  1351. if (info->pages <= 0 || info->pages > PMBUS_PAGES) {
  1352. dev_err(&client->dev, "Bad number of PMBus pages: %d\n",
  1353. info->pages);
  1354. ret = -EINVAL;
  1355. goto out_data;
  1356. }
  1357. /*
  1358. * Bail out if more than one page was configured, but we can not
  1359. * select the highest page. This is an indication that the wrong
  1360. * chip type was selected. Better bail out now than keep
  1361. * returning errors later on.
  1362. */
  1363. if (info->pages > 1 && pmbus_set_page(client, info->pages - 1) < 0) {
  1364. dev_err(&client->dev, "Failed to select page %d\n",
  1365. info->pages - 1);
  1366. ret = -EINVAL;
  1367. goto out_data;
  1368. }
  1369. ret = pmbus_identify_common(client, data);
  1370. if (ret < 0) {
  1371. dev_err(&client->dev, "Failed to identify chip capabilities\n");
  1372. goto out_data;
  1373. }
  1374. ret = -ENOMEM;
  1375. data->sensors = kzalloc(sizeof(struct pmbus_sensor) * data->max_sensors,
  1376. GFP_KERNEL);
  1377. if (!data->sensors) {
  1378. dev_err(&client->dev, "No memory to allocate sensor data\n");
  1379. goto out_data;
  1380. }
  1381. data->booleans = kzalloc(sizeof(struct pmbus_boolean)
  1382. * data->max_booleans, GFP_KERNEL);
  1383. if (!data->booleans) {
  1384. dev_err(&client->dev, "No memory to allocate boolean data\n");
  1385. goto out_sensors;
  1386. }
  1387. data->labels = kzalloc(sizeof(struct pmbus_label) * data->max_labels,
  1388. GFP_KERNEL);
  1389. if (!data->labels) {
  1390. dev_err(&client->dev, "No memory to allocate label data\n");
  1391. goto out_booleans;
  1392. }
  1393. data->attributes = kzalloc(sizeof(struct attribute *)
  1394. * data->max_attributes, GFP_KERNEL);
  1395. if (!data->attributes) {
  1396. dev_err(&client->dev, "No memory to allocate attribute data\n");
  1397. goto out_labels;
  1398. }
  1399. pmbus_find_attributes(client, data);
  1400. /*
  1401. * If there are no attributes, something is wrong.
  1402. * Bail out instead of trying to register nothing.
  1403. */
  1404. if (!data->num_attributes) {
  1405. dev_err(&client->dev, "No attributes found\n");
  1406. ret = -ENODEV;
  1407. goto out_attributes;
  1408. }
  1409. /* Register sysfs hooks */
  1410. data->group.attrs = data->attributes;
  1411. ret = sysfs_create_group(&client->dev.kobj, &data->group);
  1412. if (ret) {
  1413. dev_err(&client->dev, "Failed to create sysfs entries\n");
  1414. goto out_attributes;
  1415. }
  1416. data->hwmon_dev = hwmon_device_register(&client->dev);
  1417. if (IS_ERR(data->hwmon_dev)) {
  1418. ret = PTR_ERR(data->hwmon_dev);
  1419. dev_err(&client->dev, "Failed to register hwmon device\n");
  1420. goto out_hwmon_device_register;
  1421. }
  1422. return 0;
  1423. out_hwmon_device_register:
  1424. sysfs_remove_group(&client->dev.kobj, &data->group);
  1425. out_attributes:
  1426. kfree(data->attributes);
  1427. out_labels:
  1428. kfree(data->labels);
  1429. out_booleans:
  1430. kfree(data->booleans);
  1431. out_sensors:
  1432. kfree(data->sensors);
  1433. out_data:
  1434. kfree(data);
  1435. return ret;
  1436. }
  1437. EXPORT_SYMBOL_GPL(pmbus_do_probe);
  1438. int pmbus_do_remove(struct i2c_client *client)
  1439. {
  1440. struct pmbus_data *data = i2c_get_clientdata(client);
  1441. hwmon_device_unregister(data->hwmon_dev);
  1442. sysfs_remove_group(&client->dev.kobj, &data->group);
  1443. kfree(data->attributes);
  1444. kfree(data->labels);
  1445. kfree(data->booleans);
  1446. kfree(data->sensors);
  1447. kfree(data);
  1448. return 0;
  1449. }
  1450. EXPORT_SYMBOL_GPL(pmbus_do_remove);
  1451. MODULE_AUTHOR("Guenter Roeck");
  1452. MODULE_DESCRIPTION("PMBus core driver");
  1453. MODULE_LICENSE("GPL");