pmbus_core.c 40 KB

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