pmbus_core.c 45 KB

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