pmbus_core.c 44 KB

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