pmbus_core.c 44 KB

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