mcp3564.c 41 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483
  1. // SPDX-License-Identifier: GPL-2.0+
  2. /*
  3. * IIO driver for MCP356X/MCP356XR and MCP346X/MCP346XR series ADC chip family
  4. *
  5. * Copyright (C) 2022-2023 Microchip Technology Inc. and its subsidiaries
  6. *
  7. * Author: Marius Cristea <marius.cristea@microchip.com>
  8. *
  9. * Datasheet for MCP3561, MCP3562, MCP3564 can be found here:
  10. * https://ww1.microchip.com/downloads/aemDocuments/documents/MSLD/ProductDocuments/DataSheets/MCP3561-2-4-Family-Data-Sheet-DS20006181C.pdf
  11. * Datasheet for MCP3561R, MCP3562R, MCP3564R can be found here:
  12. * https://ww1.microchip.com/downloads/aemDocuments/documents/APID/ProductDocuments/DataSheets/MCP3561_2_4R-Data-Sheet-DS200006391C.pdf
  13. * Datasheet for MCP3461, MCP3462, MCP3464 can be found here:
  14. * https://ww1.microchip.com/downloads/aemDocuments/documents/APID/ProductDocuments/DataSheets/MCP3461-2-4-Two-Four-Eight-Channel-153.6-ksps-Low-Noise-16-Bit-Delta-Sigma-ADC-Data-Sheet-20006180D.pdf
  15. * Datasheet for MCP3461R, MCP3462R, MCP3464R can be found here:
  16. * https://ww1.microchip.com/downloads/aemDocuments/documents/APID/ProductDocuments/DataSheets/MCP3461-2-4R-Family-Data-Sheet-DS20006404C.pdf
  17. */
  18. #include <linux/bitfield.h>
  19. #include <linux/iopoll.h>
  20. #include <linux/regulator/consumer.h>
  21. #include <linux/spi/spi.h>
  22. #include <linux/units.h>
  23. #include <linux/util_macros.h>
  24. #include <linux/iio/iio.h>
  25. #include <linux/iio/sysfs.h>
  26. #define MCP3564_ADCDATA_REG 0x00
  27. #define MCP3564_CONFIG0_REG 0x01
  28. #define MCP3564_CONFIG0_ADC_MODE_MASK GENMASK(1, 0)
  29. /* Current Source/Sink Selection Bits for Sensor Bias */
  30. #define MCP3564_CONFIG0_CS_SEL_MASK GENMASK(3, 2)
  31. /* Internal clock is selected and AMCLK is present on the analog master clock output pin */
  32. #define MCP3564_CONFIG0_USE_INT_CLK_OUTPUT_EN 0x03
  33. /* Internal clock is selected and no clock output is present on the CLK pin */
  34. #define MCP3564_CONFIG0_USE_INT_CLK 0x02
  35. /* External digital clock */
  36. #define MCP3564_CONFIG0_USE_EXT_CLK 0x01
  37. /* External digital clock (default) */
  38. #define MCP3564_CONFIG0_USE_EXT_CLK_DEFAULT 0x00
  39. #define MCP3564_CONFIG0_CLK_SEL_MASK GENMASK(5, 4)
  40. #define MCP3456_CONFIG0_BIT6_DEFAULT BIT(6)
  41. #define MCP3456_CONFIG0_VREF_MASK BIT(7)
  42. #define MCP3564_CONFIG1_REG 0x02
  43. #define MCP3564_CONFIG1_OVERSPL_RATIO_MASK GENMASK(5, 2)
  44. #define MCP3564_CONFIG2_REG 0x03
  45. #define MCP3564_CONFIG2_AZ_REF_MASK BIT(1)
  46. #define MCP3564_CONFIG2_AZ_MUX_MASK BIT(2)
  47. #define MCP3564_CONFIG2_HARDWARE_GAIN_MASK GENMASK(5, 3)
  48. #define MCP3564_DEFAULT_HARDWARE_GAIN 0x01
  49. #define MCP3564_CONFIG2_BOOST_CURRENT_MASK GENMASK(7, 6)
  50. #define MCP3564_CONFIG3_REG 0x04
  51. #define MCP3464_CONFIG3_EN_GAINCAL_MASK BIT(0)
  52. #define MCP3464_CONFIG3_EN_OFFCAL_MASK BIT(1)
  53. #define MCP3464_CONFIG3_EN_CRCCOM_MASK BIT(2)
  54. #define MCP3464_CONFIG3_CRC_FORMAT_MASK BIT(3)
  55. /*
  56. * ADC Output Data Format 32-bit (25-bit right justified data + Channel ID):
  57. * CHID[3:0] + SGN extension (4 bits) + 24-bit ADC data.
  58. * It allows overrange with the SGN extension.
  59. */
  60. #define MCP3464_CONFIG3_DATA_FMT_32B_WITH_CH_ID 3
  61. /*
  62. * ADC Output Data Format 32-bit (25-bit right justified data):
  63. * SGN extension (8-bit) + 24-bit ADC data.
  64. * It allows overrange with the SGN extension.
  65. */
  66. #define MCP3464_CONFIG3_DATA_FMT_32B_SGN_EXT 2
  67. /*
  68. * ADC Output Data Format 32-bit (24-bit left justified data):
  69. * 24-bit ADC data + 0x00 (8-bit).
  70. * It does not allow overrange (ADC code locked to 0xFFFFFF or 0x800000).
  71. */
  72. #define MCP3464_CONFIG3_DATA_FMT_32B_LEFT_JUSTIFIED 1
  73. /*
  74. * ADC Output Data Format 24-bit (default ADC coding):
  75. * 24-bit ADC data.
  76. * It does not allow overrange (ADC code locked to 0xFFFFFF or 0x800000).
  77. */
  78. #define MCP3464_CONFIG3_DATA_FMT_24B 0
  79. #define MCP3464_CONFIG3_DATA_FORMAT_MASK GENMASK(5, 4)
  80. /* Continuous Conversion mode or continuous conversion cycle in SCAN mode. */
  81. #define MCP3464_CONFIG3_CONV_MODE_CONTINUOUS 3
  82. /*
  83. * One-shot conversion or one-shot cycle in SCAN mode. It sets ADC_MODE[1:0] to ‘10’
  84. * (standby) at the end of the conversion or at the end of the conversion cycle in SCAN mode.
  85. */
  86. #define MCP3464_CONFIG3_CONV_MODE_ONE_SHOT_STANDBY 2
  87. /*
  88. * One-shot conversion or one-shot cycle in SCAN mode. It sets ADC_MODE[1:0] to ‘0x’ (ADC
  89. * Shutdown) at the end of the conversion or at the end of the conversion cycle in SCAN
  90. * mode (default).
  91. */
  92. #define MCP3464_CONFIG3_CONV_MODE_ONE_SHOT_SHUTDOWN 0
  93. #define MCP3464_CONFIG3_CONV_MODE_MASK GENMASK(7, 6)
  94. #define MCP3564_IRQ_REG 0x05
  95. #define MCP3464_EN_STP_MASK BIT(0)
  96. #define MCP3464_EN_FASTCMD_MASK BIT(1)
  97. #define MCP3464_IRQ_MODE_0_MASK BIT(2)
  98. #define MCP3464_IRQ_MODE_1_MASK BIT(3)
  99. #define MCP3564_POR_STATUS_MASK BIT(4)
  100. #define MCP3564_CRCCFG_STATUS_MASK BIT(5)
  101. #define MCP3564_DATA_READY_MASK BIT(6)
  102. #define MCP3564_MUX_REG 0x06
  103. #define MCP3564_MUX_VIN_P_MASK GENMASK(7, 4)
  104. #define MCP3564_MUX_VIN_N_MASK GENMASK(3, 0)
  105. #define MCP3564_MUX_SET(x, y) (FIELD_PREP(MCP3564_MUX_VIN_P_MASK, (x)) | \
  106. FIELD_PREP(MCP3564_MUX_VIN_N_MASK, (y)))
  107. #define MCP3564_SCAN_REG 0x07
  108. #define MCP3564_SCAN_CH_SEL_MASK GENMASK(15, 0)
  109. #define MCP3564_SCAN_CH_SEL_SET(x) FIELD_PREP(MCP3564_SCAN_CH_SEL_MASK, (x))
  110. #define MCP3564_SCAN_DELAY_TIME_MASK GENMASK(23, 21)
  111. #define MCP3564_SCAN_DELAY_TIME_SET(x) FIELD_PREP(MCP3564_SCAN_DELAY_TIME_MASK, (x))
  112. #define MCP3564_SCAN_DEFAULT_VALUE 0
  113. #define MCP3564_TIMER_REG 0x08
  114. #define MCP3564_TIMER_DEFAULT_VALUE 0
  115. #define MCP3564_OFFSETCAL_REG 0x09
  116. #define MCP3564_DEFAULT_OFFSETCAL 0
  117. #define MCP3564_GAINCAL_REG 0x0A
  118. #define MCP3564_DEFAULT_GAINCAL 0x00800000
  119. #define MCP3564_RESERVED_B_REG 0x0B
  120. #define MCP3564_RESERVED_C_REG 0x0C
  121. #define MCP3564_C_REG_DEFAULT 0x50
  122. #define MCP3564R_C_REG_DEFAULT 0x30
  123. #define MCP3564_LOCK_REG 0x0D
  124. #define MCP3564_LOCK_WRITE_ACCESS_PASSWORD 0xA5
  125. #define MCP3564_RESERVED_E_REG 0x0E
  126. #define MCP3564_CRCCFG_REG 0x0F
  127. #define MCP3564_CMD_HW_ADDR_MASK GENMASK(7, 6)
  128. #define MCP3564_CMD_ADDR_MASK GENMASK(5, 2)
  129. #define MCP3564_HW_ADDR_MASK GENMASK(1, 0)
  130. #define MCP3564_FASTCMD_START 0x0A
  131. #define MCP3564_FASTCMD_RESET 0x0E
  132. #define MCP3461_HW_ID 0x0008
  133. #define MCP3462_HW_ID 0x0009
  134. #define MCP3464_HW_ID 0x000B
  135. #define MCP3561_HW_ID 0x000C
  136. #define MCP3562_HW_ID 0x000D
  137. #define MCP3564_HW_ID 0x000F
  138. #define MCP3564_HW_ID_MASK GENMASK(3, 0)
  139. #define MCP3564R_INT_VREF_MV 2400
  140. #define MCP3564_DATA_READY_TIMEOUT_MS 2000
  141. #define MCP3564_MAX_PGA 8
  142. #define MCP3564_MAX_BURNOUT_IDX 4
  143. #define MCP3564_MAX_CHANNELS 66
  144. enum mcp3564_ids {
  145. mcp3461,
  146. mcp3462,
  147. mcp3464,
  148. mcp3561,
  149. mcp3562,
  150. mcp3564,
  151. mcp3461r,
  152. mcp3462r,
  153. mcp3464r,
  154. mcp3561r,
  155. mcp3562r,
  156. mcp3564r,
  157. };
  158. enum mcp3564_delay_time {
  159. MCP3564_NO_DELAY,
  160. MCP3564_DELAY_8_DMCLK,
  161. MCP3564_DELAY_16_DMCLK,
  162. MCP3564_DELAY_32_DMCLK,
  163. MCP3564_DELAY_64_DMCLK,
  164. MCP3564_DELAY_128_DMCLK,
  165. MCP3564_DELAY_256_DMCLK,
  166. MCP3564_DELAY_512_DMCLK
  167. };
  168. enum mcp3564_adc_conversion_mode {
  169. MCP3564_ADC_MODE_DEFAULT,
  170. MCP3564_ADC_MODE_SHUTDOWN,
  171. MCP3564_ADC_MODE_STANDBY,
  172. MCP3564_ADC_MODE_CONVERSION
  173. };
  174. enum mcp3564_adc_bias_current {
  175. MCP3564_BOOST_CURRENT_x0_50,
  176. MCP3564_BOOST_CURRENT_x0_66,
  177. MCP3564_BOOST_CURRENT_x1_00,
  178. MCP3564_BOOST_CURRENT_x2_00
  179. };
  180. enum mcp3564_burnout {
  181. MCP3564_CONFIG0_CS_SEL_0_0_uA,
  182. MCP3564_CONFIG0_CS_SEL_0_9_uA,
  183. MCP3564_CONFIG0_CS_SEL_3_7_uA,
  184. MCP3564_CONFIG0_CS_SEL_15_uA
  185. };
  186. enum mcp3564_channel_names {
  187. MCP3564_CH0,
  188. MCP3564_CH1,
  189. MCP3564_CH2,
  190. MCP3564_CH3,
  191. MCP3564_CH4,
  192. MCP3564_CH5,
  193. MCP3564_CH6,
  194. MCP3564_CH7,
  195. MCP3564_AGND,
  196. MCP3564_AVDD,
  197. MCP3564_RESERVED, /* do not use */
  198. MCP3564_REFIN_POZ,
  199. MCP3564_REFIN_NEG,
  200. MCP3564_TEMP_DIODE_P,
  201. MCP3564_TEMP_DIODE_M,
  202. MCP3564_INTERNAL_VCM,
  203. };
  204. enum mcp3564_oversampling {
  205. MCP3564_OVERSAMPLING_RATIO_32,
  206. MCP3564_OVERSAMPLING_RATIO_64,
  207. MCP3564_OVERSAMPLING_RATIO_128,
  208. MCP3564_OVERSAMPLING_RATIO_256,
  209. MCP3564_OVERSAMPLING_RATIO_512,
  210. MCP3564_OVERSAMPLING_RATIO_1024,
  211. MCP3564_OVERSAMPLING_RATIO_2048,
  212. MCP3564_OVERSAMPLING_RATIO_4096,
  213. MCP3564_OVERSAMPLING_RATIO_8192,
  214. MCP3564_OVERSAMPLING_RATIO_16384,
  215. MCP3564_OVERSAMPLING_RATIO_20480,
  216. MCP3564_OVERSAMPLING_RATIO_24576,
  217. MCP3564_OVERSAMPLING_RATIO_40960,
  218. MCP3564_OVERSAMPLING_RATIO_49152,
  219. MCP3564_OVERSAMPLING_RATIO_81920,
  220. MCP3564_OVERSAMPLING_RATIO_98304
  221. };
  222. static const unsigned int mcp3564_oversampling_avail[] = {
  223. [MCP3564_OVERSAMPLING_RATIO_32] = 32,
  224. [MCP3564_OVERSAMPLING_RATIO_64] = 64,
  225. [MCP3564_OVERSAMPLING_RATIO_128] = 128,
  226. [MCP3564_OVERSAMPLING_RATIO_256] = 256,
  227. [MCP3564_OVERSAMPLING_RATIO_512] = 512,
  228. [MCP3564_OVERSAMPLING_RATIO_1024] = 1024,
  229. [MCP3564_OVERSAMPLING_RATIO_2048] = 2048,
  230. [MCP3564_OVERSAMPLING_RATIO_4096] = 4096,
  231. [MCP3564_OVERSAMPLING_RATIO_8192] = 8192,
  232. [MCP3564_OVERSAMPLING_RATIO_16384] = 16384,
  233. [MCP3564_OVERSAMPLING_RATIO_20480] = 20480,
  234. [MCP3564_OVERSAMPLING_RATIO_24576] = 24576,
  235. [MCP3564_OVERSAMPLING_RATIO_40960] = 40960,
  236. [MCP3564_OVERSAMPLING_RATIO_49152] = 49152,
  237. [MCP3564_OVERSAMPLING_RATIO_81920] = 81920,
  238. [MCP3564_OVERSAMPLING_RATIO_98304] = 98304
  239. };
  240. /*
  241. * Current Source/Sink Selection Bits for Sensor Bias (source on VIN+/sink on VIN-)
  242. */
  243. static const int mcp3564_burnout_avail[][2] = {
  244. [MCP3564_CONFIG0_CS_SEL_0_0_uA] = { 0, 0 },
  245. [MCP3564_CONFIG0_CS_SEL_0_9_uA] = { 0, 900 },
  246. [MCP3564_CONFIG0_CS_SEL_3_7_uA] = { 0, 3700 },
  247. [MCP3564_CONFIG0_CS_SEL_15_uA] = { 0, 15000 }
  248. };
  249. /*
  250. * BOOST[1:0]: ADC Bias Current Selection
  251. */
  252. static const char * const mcp3564_boost_current_avail[] = {
  253. [MCP3564_BOOST_CURRENT_x0_50] = "0.5",
  254. [MCP3564_BOOST_CURRENT_x0_66] = "0.66",
  255. [MCP3564_BOOST_CURRENT_x1_00] = "1",
  256. [MCP3564_BOOST_CURRENT_x2_00] = "2",
  257. };
  258. /*
  259. * Calibration bias values
  260. */
  261. static const int mcp3564_calib_bias[] = {
  262. -8388608, /* min: -2^23 */
  263. 1, /* step: 1 */
  264. 8388607 /* max: 2^23 - 1 */
  265. };
  266. /*
  267. * Calibration scale values
  268. * The Gain Error Calibration register (GAINCAL) is an
  269. * unsigned 24-bit register that holds the digital gain error
  270. * calibration value, GAINCAL which could be calculated by
  271. * GAINCAL (V/V) = (GAINCAL[23:0])/8388608
  272. * The gain error calibration value range in equivalent voltage is [0; 2-2^(-23)]
  273. */
  274. static const unsigned int mcp3564_calib_scale[] = {
  275. 0, /* min: 0 */
  276. 1, /* step: 1/8388608 */
  277. 16777215 /* max: 2 - 2^(-23) */
  278. };
  279. /* Programmable hardware gain x1/3, x1, x2, x4, x8, x16, x32, x64 */
  280. static const int mcp3564_hwgain_frac[] = {
  281. 3, 10,
  282. 1, 1,
  283. 2, 1,
  284. 4, 1,
  285. 8, 1,
  286. 16, 1,
  287. 32, 1,
  288. 64, 1
  289. };
  290. static const char *mcp3564_channel_labels[2] = {
  291. "burnout_current", "temperature",
  292. };
  293. /**
  294. * struct mcp3564_chip_info - chip specific data
  295. * @name: device name
  296. * @num_channels: number of channels
  297. * @resolution: ADC resolution
  298. * @have_vref: does the hardware have an internal voltage reference?
  299. */
  300. struct mcp3564_chip_info {
  301. const char *name;
  302. unsigned int num_channels;
  303. unsigned int resolution;
  304. bool have_vref;
  305. };
  306. /**
  307. * struct mcp3564_state - working data for a ADC device
  308. * @chip_info: chip specific data
  309. * @spi: SPI device structure
  310. * @vref_mv: voltage reference value in miliVolts
  311. * @lock: synchronize access to driver's state members
  312. * @dev_addr: hardware device address
  313. * @oversampling: the index inside oversampling list of the ADC
  314. * @hwgain: the index inside hardware gain list of the ADC
  315. * @scale_tbls: table with precalculated scale
  316. * @calib_bias: calibration bias value
  317. * @calib_scale: calibration scale value
  318. * @current_boost_mode: the index inside current boost list of the ADC
  319. * @burnout_mode: the index inside current bias list of the ADC
  320. * @auto_zeroing_mux: set if ADC auto-zeroing algorithm is enabled
  321. * @auto_zeroing_ref: set if ADC auto-Zeroing Reference Buffer Setting is enabled
  322. * @have_vref: does the ADC have an internal voltage reference?
  323. * @labels: table with channels labels
  324. */
  325. struct mcp3564_state {
  326. const struct mcp3564_chip_info *chip_info;
  327. struct spi_device *spi;
  328. unsigned short vref_mv;
  329. struct mutex lock; /* Synchronize access to driver's state members */
  330. u8 dev_addr;
  331. enum mcp3564_oversampling oversampling;
  332. unsigned int hwgain;
  333. unsigned int scale_tbls[MCP3564_MAX_PGA][2];
  334. int calib_bias;
  335. int calib_scale;
  336. unsigned int current_boost_mode;
  337. enum mcp3564_burnout burnout_mode;
  338. bool auto_zeroing_mux;
  339. bool auto_zeroing_ref;
  340. bool have_vref;
  341. const char *labels[MCP3564_MAX_CHANNELS];
  342. };
  343. static inline u8 mcp3564_cmd_write(u8 chip_addr, u8 reg)
  344. {
  345. return FIELD_PREP(MCP3564_CMD_HW_ADDR_MASK, chip_addr) |
  346. FIELD_PREP(MCP3564_CMD_ADDR_MASK, reg) |
  347. BIT(1);
  348. }
  349. static inline u8 mcp3564_cmd_read(u8 chip_addr, u8 reg)
  350. {
  351. return FIELD_PREP(MCP3564_CMD_HW_ADDR_MASK, chip_addr) |
  352. FIELD_PREP(MCP3564_CMD_ADDR_MASK, reg) |
  353. BIT(0);
  354. }
  355. static int mcp3564_read_8bits(struct mcp3564_state *adc, u8 reg, u8 *val)
  356. {
  357. int ret;
  358. u8 tx_buf;
  359. u8 rx_buf;
  360. tx_buf = mcp3564_cmd_read(adc->dev_addr, reg);
  361. ret = spi_write_then_read(adc->spi, &tx_buf, sizeof(tx_buf),
  362. &rx_buf, sizeof(rx_buf));
  363. *val = rx_buf;
  364. return ret;
  365. }
  366. static int mcp3564_read_16bits(struct mcp3564_state *adc, u8 reg, u16 *val)
  367. {
  368. int ret;
  369. u8 tx_buf;
  370. __be16 rx_buf;
  371. tx_buf = mcp3564_cmd_read(adc->dev_addr, reg);
  372. ret = spi_write_then_read(adc->spi, &tx_buf, sizeof(tx_buf),
  373. &rx_buf, sizeof(rx_buf));
  374. *val = be16_to_cpu(rx_buf);
  375. return ret;
  376. }
  377. static int mcp3564_read_32bits(struct mcp3564_state *adc, u8 reg, u32 *val)
  378. {
  379. int ret;
  380. u8 tx_buf;
  381. __be32 rx_buf;
  382. tx_buf = mcp3564_cmd_read(adc->dev_addr, reg);
  383. ret = spi_write_then_read(adc->spi, &tx_buf, sizeof(tx_buf),
  384. &rx_buf, sizeof(rx_buf));
  385. *val = be32_to_cpu(rx_buf);
  386. return ret;
  387. }
  388. static int mcp3564_write_8bits(struct mcp3564_state *adc, u8 reg, u8 val)
  389. {
  390. u8 tx_buf[2];
  391. tx_buf[0] = mcp3564_cmd_write(adc->dev_addr, reg);
  392. tx_buf[1] = val;
  393. return spi_write_then_read(adc->spi, tx_buf, sizeof(tx_buf), NULL, 0);
  394. }
  395. static int mcp3564_write_24bits(struct mcp3564_state *adc, u8 reg, u32 val)
  396. {
  397. __be32 val_be;
  398. val |= (mcp3564_cmd_write(adc->dev_addr, reg) << 24);
  399. val_be = cpu_to_be32(val);
  400. return spi_write_then_read(adc->spi, &val_be, sizeof(val_be), NULL, 0);
  401. }
  402. static int mcp3564_fast_cmd(struct mcp3564_state *adc, u8 fast_cmd)
  403. {
  404. u8 val;
  405. val = FIELD_PREP(MCP3564_CMD_HW_ADDR_MASK, adc->dev_addr) |
  406. FIELD_PREP(MCP3564_CMD_ADDR_MASK, fast_cmd);
  407. return spi_write_then_read(adc->spi, &val, 1, NULL, 0);
  408. }
  409. static int mcp3564_update_8bits(struct mcp3564_state *adc, u8 reg, u32 mask, u8 val)
  410. {
  411. u8 tmp;
  412. int ret;
  413. val &= mask;
  414. ret = mcp3564_read_8bits(adc, reg, &tmp);
  415. if (ret < 0)
  416. return ret;
  417. tmp &= ~mask;
  418. tmp |= val;
  419. return mcp3564_write_8bits(adc, reg, tmp);
  420. }
  421. static int mcp3564_set_current_boost_mode(struct iio_dev *indio_dev,
  422. const struct iio_chan_spec *chan,
  423. unsigned int mode)
  424. {
  425. struct mcp3564_state *adc = iio_priv(indio_dev);
  426. int ret;
  427. dev_dbg(&indio_dev->dev, "%s: %d\n", __func__, mode);
  428. mutex_lock(&adc->lock);
  429. ret = mcp3564_update_8bits(adc, MCP3564_CONFIG2_REG, MCP3564_CONFIG2_BOOST_CURRENT_MASK,
  430. FIELD_PREP(MCP3564_CONFIG2_BOOST_CURRENT_MASK, mode));
  431. if (ret)
  432. dev_err(&indio_dev->dev, "Failed to configure CONFIG2 register\n");
  433. else
  434. adc->current_boost_mode = mode;
  435. mutex_unlock(&adc->lock);
  436. return ret;
  437. }
  438. static int mcp3564_get_current_boost_mode(struct iio_dev *indio_dev,
  439. const struct iio_chan_spec *chan)
  440. {
  441. struct mcp3564_state *adc = iio_priv(indio_dev);
  442. return adc->current_boost_mode;
  443. }
  444. static const struct iio_enum mcp3564_current_boost_mode_enum = {
  445. .items = mcp3564_boost_current_avail,
  446. .num_items = ARRAY_SIZE(mcp3564_boost_current_avail),
  447. .set = mcp3564_set_current_boost_mode,
  448. .get = mcp3564_get_current_boost_mode,
  449. };
  450. static const struct iio_chan_spec_ext_info mcp3564_ext_info[] = {
  451. IIO_ENUM("boost_current_gain", IIO_SHARED_BY_ALL, &mcp3564_current_boost_mode_enum),
  452. {
  453. .name = "boost_current_gain_available",
  454. .shared = IIO_SHARED_BY_ALL,
  455. .read = iio_enum_available_read,
  456. .private = (uintptr_t)&mcp3564_current_boost_mode_enum,
  457. },
  458. { }
  459. };
  460. static ssize_t mcp3564_auto_zeroing_mux_show(struct device *dev,
  461. struct device_attribute *attr,
  462. char *buf)
  463. {
  464. struct iio_dev *indio_dev = dev_to_iio_dev(dev);
  465. struct mcp3564_state *adc = iio_priv(indio_dev);
  466. return sysfs_emit(buf, "%d\n", adc->auto_zeroing_mux);
  467. }
  468. static ssize_t mcp3564_auto_zeroing_mux_store(struct device *dev,
  469. struct device_attribute *attr,
  470. const char *buf, size_t len)
  471. {
  472. struct iio_dev *indio_dev = dev_to_iio_dev(dev);
  473. struct mcp3564_state *adc = iio_priv(indio_dev);
  474. bool auto_zero;
  475. int ret;
  476. ret = kstrtobool(buf, &auto_zero);
  477. if (ret)
  478. return ret;
  479. mutex_lock(&adc->lock);
  480. ret = mcp3564_update_8bits(adc, MCP3564_CONFIG2_REG, MCP3564_CONFIG2_AZ_MUX_MASK,
  481. FIELD_PREP(MCP3564_CONFIG2_AZ_MUX_MASK, auto_zero));
  482. if (ret)
  483. dev_err(&indio_dev->dev, "Failed to update CONFIG2 register\n");
  484. else
  485. adc->auto_zeroing_mux = auto_zero;
  486. mutex_unlock(&adc->lock);
  487. return ret ? ret : len;
  488. }
  489. static ssize_t mcp3564_auto_zeroing_ref_show(struct device *dev,
  490. struct device_attribute *attr,
  491. char *buf)
  492. {
  493. struct iio_dev *indio_dev = dev_to_iio_dev(dev);
  494. struct mcp3564_state *adc = iio_priv(indio_dev);
  495. return sysfs_emit(buf, "%d\n", adc->auto_zeroing_ref);
  496. }
  497. static ssize_t mcp3564_auto_zeroing_ref_store(struct device *dev,
  498. struct device_attribute *attr,
  499. const char *buf, size_t len)
  500. {
  501. struct iio_dev *indio_dev = dev_to_iio_dev(dev);
  502. struct mcp3564_state *adc = iio_priv(indio_dev);
  503. bool auto_zero;
  504. int ret;
  505. ret = kstrtobool(buf, &auto_zero);
  506. if (ret)
  507. return ret;
  508. mutex_lock(&adc->lock);
  509. ret = mcp3564_update_8bits(adc, MCP3564_CONFIG2_REG, MCP3564_CONFIG2_AZ_REF_MASK,
  510. FIELD_PREP(MCP3564_CONFIG2_AZ_REF_MASK, auto_zero));
  511. if (ret)
  512. dev_err(&indio_dev->dev, "Failed to update CONFIG2 register\n");
  513. else
  514. adc->auto_zeroing_ref = auto_zero;
  515. mutex_unlock(&adc->lock);
  516. return ret ? ret : len;
  517. }
  518. static const struct iio_chan_spec mcp3564_channel_template = {
  519. .type = IIO_VOLTAGE,
  520. .indexed = 1,
  521. .differential = 1,
  522. .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
  523. .info_mask_shared_by_all = BIT(IIO_CHAN_INFO_SCALE) |
  524. BIT(IIO_CHAN_INFO_CALIBSCALE) |
  525. BIT(IIO_CHAN_INFO_CALIBBIAS) |
  526. BIT(IIO_CHAN_INFO_OVERSAMPLING_RATIO),
  527. .info_mask_shared_by_all_available = BIT(IIO_CHAN_INFO_SCALE) |
  528. BIT(IIO_CHAN_INFO_CALIBSCALE) |
  529. BIT(IIO_CHAN_INFO_CALIBBIAS) |
  530. BIT(IIO_CHAN_INFO_OVERSAMPLING_RATIO),
  531. .ext_info = mcp3564_ext_info,
  532. };
  533. static const struct iio_chan_spec mcp3564_temp_channel_template = {
  534. .type = IIO_TEMP,
  535. .channel = 0,
  536. .address = ((MCP3564_TEMP_DIODE_P << 4) | MCP3564_TEMP_DIODE_M),
  537. .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
  538. .info_mask_shared_by_all = BIT(IIO_CHAN_INFO_SCALE) |
  539. BIT(IIO_CHAN_INFO_CALIBSCALE) |
  540. BIT(IIO_CHAN_INFO_CALIBBIAS) |
  541. BIT(IIO_CHAN_INFO_OVERSAMPLING_RATIO),
  542. .info_mask_shared_by_all_available = BIT(IIO_CHAN_INFO_SCALE) |
  543. BIT(IIO_CHAN_INFO_CALIBSCALE) |
  544. BIT(IIO_CHAN_INFO_CALIBBIAS) |
  545. BIT(IIO_CHAN_INFO_OVERSAMPLING_RATIO),
  546. };
  547. static const struct iio_chan_spec mcp3564_burnout_channel_template = {
  548. .type = IIO_CURRENT,
  549. .output = true,
  550. .channel = 0,
  551. .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
  552. .info_mask_separate_available = BIT(IIO_CHAN_INFO_RAW),
  553. };
  554. /*
  555. * Number of channels could be calculated:
  556. * num_channels = single_ended_input + differential_input + temperature + burnout
  557. * Eg. for MCP3561 (only 2 channels available: CH0 and CH1)
  558. * single_ended_input = (CH0 - GND), (CH1 - GND) = 2
  559. * differential_input = (CH0 - CH1), (CH0 - CH0) = 2
  560. * num_channels = 2 + 2 + 2
  561. * Generic formula is:
  562. * num_channels = P^R(Number_of_single_ended_channels, 2) + 2 (temperature + burnout channels)
  563. * P^R(Number_of_single_ended_channels, 2) is Permutations with Replacement of
  564. * Number_of_single_ended_channels taken by 2
  565. */
  566. static const struct mcp3564_chip_info mcp3564_chip_infos_tbl[] = {
  567. [mcp3461] = {
  568. .name = "mcp3461",
  569. .num_channels = 6,
  570. .resolution = 16,
  571. .have_vref = false,
  572. },
  573. [mcp3462] = {
  574. .name = "mcp3462",
  575. .num_channels = 18,
  576. .resolution = 16,
  577. .have_vref = false,
  578. },
  579. [mcp3464] = {
  580. .name = "mcp3464",
  581. .num_channels = 66,
  582. .resolution = 16,
  583. .have_vref = false,
  584. },
  585. [mcp3561] = {
  586. .name = "mcp3561",
  587. .num_channels = 6,
  588. .resolution = 24,
  589. .have_vref = false,
  590. },
  591. [mcp3562] = {
  592. .name = "mcp3562",
  593. .num_channels = 18,
  594. .resolution = 24,
  595. .have_vref = false,
  596. },
  597. [mcp3564] = {
  598. .name = "mcp3564",
  599. .num_channels = 66,
  600. .resolution = 24,
  601. .have_vref = false,
  602. },
  603. [mcp3461r] = {
  604. .name = "mcp3461r",
  605. .num_channels = 6,
  606. .resolution = 16,
  607. .have_vref = false,
  608. },
  609. [mcp3462r] = {
  610. .name = "mcp3462r",
  611. .num_channels = 18,
  612. .resolution = 16,
  613. .have_vref = true,
  614. },
  615. [mcp3464r] = {
  616. .name = "mcp3464r",
  617. .num_channels = 66,
  618. .resolution = 16,
  619. .have_vref = true,
  620. },
  621. [mcp3561r] = {
  622. .name = "mcp3561r",
  623. .num_channels = 6,
  624. .resolution = 24,
  625. .have_vref = true,
  626. },
  627. [mcp3562r] = {
  628. .name = "mcp3562r",
  629. .num_channels = 18,
  630. .resolution = 24,
  631. .have_vref = true,
  632. },
  633. [mcp3564r] = {
  634. .name = "mcp3564r",
  635. .num_channels = 66,
  636. .resolution = 24,
  637. .have_vref = true,
  638. },
  639. };
  640. static int mcp3564_read_single_value(struct iio_dev *indio_dev,
  641. struct iio_chan_spec const *channel,
  642. int *val)
  643. {
  644. struct mcp3564_state *adc = iio_priv(indio_dev);
  645. int ret;
  646. u8 tmp;
  647. int ret_read = 0;
  648. ret = mcp3564_write_8bits(adc, MCP3564_MUX_REG, channel->address);
  649. if (ret)
  650. return ret;
  651. /* Start ADC Conversion using fast command (overwrites ADC_MODE[1:0] = 11) */
  652. ret = mcp3564_fast_cmd(adc, MCP3564_FASTCMD_START);
  653. if (ret)
  654. return ret;
  655. /*
  656. * Check if the conversion is ready. If not, wait a little bit, and
  657. * in case of timeout exit with an error.
  658. */
  659. ret = read_poll_timeout(mcp3564_read_8bits, ret_read,
  660. ret_read || !(tmp & MCP3564_DATA_READY_MASK),
  661. 20000, MCP3564_DATA_READY_TIMEOUT_MS * 1000, true,
  662. adc, MCP3564_IRQ_REG, &tmp);
  663. /* failed to read status register */
  664. if (ret_read)
  665. return ret_read;
  666. if (ret)
  667. return ret;
  668. if (tmp & MCP3564_DATA_READY_MASK)
  669. /* failing to finish conversion */
  670. return -EBUSY;
  671. return mcp3564_read_32bits(adc, MCP3564_ADCDATA_REG, val);
  672. }
  673. static int mcp3564_read_avail(struct iio_dev *indio_dev,
  674. struct iio_chan_spec const *channel,
  675. const int **vals, int *type,
  676. int *length, long mask)
  677. {
  678. struct mcp3564_state *adc = iio_priv(indio_dev);
  679. switch (mask) {
  680. case IIO_CHAN_INFO_RAW:
  681. if (!channel->output)
  682. return -EINVAL;
  683. *vals = mcp3564_burnout_avail[0];
  684. *length = ARRAY_SIZE(mcp3564_burnout_avail) * 2;
  685. *type = IIO_VAL_INT_PLUS_MICRO;
  686. return IIO_AVAIL_LIST;
  687. case IIO_CHAN_INFO_OVERSAMPLING_RATIO:
  688. *vals = mcp3564_oversampling_avail;
  689. *length = ARRAY_SIZE(mcp3564_oversampling_avail);
  690. *type = IIO_VAL_INT;
  691. return IIO_AVAIL_LIST;
  692. case IIO_CHAN_INFO_SCALE:
  693. *vals = (int *)adc->scale_tbls;
  694. *length = ARRAY_SIZE(adc->scale_tbls) * 2;
  695. *type = IIO_VAL_INT_PLUS_NANO;
  696. return IIO_AVAIL_LIST;
  697. case IIO_CHAN_INFO_CALIBBIAS:
  698. *vals = mcp3564_calib_bias;
  699. *type = IIO_VAL_INT;
  700. return IIO_AVAIL_RANGE;
  701. case IIO_CHAN_INFO_CALIBSCALE:
  702. *vals = mcp3564_calib_scale;
  703. *type = IIO_VAL_INT;
  704. return IIO_AVAIL_RANGE;
  705. default:
  706. return -EINVAL;
  707. }
  708. }
  709. static int mcp3564_read_raw(struct iio_dev *indio_dev,
  710. struct iio_chan_spec const *channel,
  711. int *val, int *val2, long mask)
  712. {
  713. struct mcp3564_state *adc = iio_priv(indio_dev);
  714. int ret;
  715. switch (mask) {
  716. case IIO_CHAN_INFO_RAW:
  717. if (channel->output) {
  718. mutex_lock(&adc->lock);
  719. *val = mcp3564_burnout_avail[adc->burnout_mode][0];
  720. *val2 = mcp3564_burnout_avail[adc->burnout_mode][1];
  721. mutex_unlock(&adc->lock);
  722. return IIO_VAL_INT_PLUS_MICRO;
  723. }
  724. ret = mcp3564_read_single_value(indio_dev, channel, val);
  725. if (ret)
  726. return -EINVAL;
  727. return IIO_VAL_INT;
  728. case IIO_CHAN_INFO_SCALE:
  729. mutex_lock(&adc->lock);
  730. *val = adc->scale_tbls[adc->hwgain][0];
  731. *val2 = adc->scale_tbls[adc->hwgain][1];
  732. mutex_unlock(&adc->lock);
  733. return IIO_VAL_INT_PLUS_NANO;
  734. case IIO_CHAN_INFO_OVERSAMPLING_RATIO:
  735. *val = mcp3564_oversampling_avail[adc->oversampling];
  736. return IIO_VAL_INT;
  737. case IIO_CHAN_INFO_CALIBBIAS:
  738. *val = adc->calib_bias;
  739. return IIO_VAL_INT;
  740. case IIO_CHAN_INFO_CALIBSCALE:
  741. *val = adc->calib_scale;
  742. return IIO_VAL_INT;
  743. default:
  744. return -EINVAL;
  745. }
  746. }
  747. static int mcp3564_write_raw_get_fmt(struct iio_dev *indio_dev,
  748. struct iio_chan_spec const *chan,
  749. long info)
  750. {
  751. switch (info) {
  752. case IIO_CHAN_INFO_RAW:
  753. return IIO_VAL_INT_PLUS_MICRO;
  754. case IIO_CHAN_INFO_CALIBBIAS:
  755. case IIO_CHAN_INFO_CALIBSCALE:
  756. case IIO_CHAN_INFO_OVERSAMPLING_RATIO:
  757. return IIO_VAL_INT;
  758. case IIO_CHAN_INFO_SCALE:
  759. return IIO_VAL_INT_PLUS_NANO;
  760. default:
  761. return -EINVAL;
  762. }
  763. }
  764. static int mcp3564_write_raw(struct iio_dev *indio_dev,
  765. struct iio_chan_spec const *channel, int val,
  766. int val2, long mask)
  767. {
  768. struct mcp3564_state *adc = iio_priv(indio_dev);
  769. int tmp;
  770. unsigned int hwgain;
  771. enum mcp3564_burnout burnout;
  772. int ret = 0;
  773. switch (mask) {
  774. case IIO_CHAN_INFO_RAW:
  775. if (!channel->output)
  776. return -EINVAL;
  777. for (burnout = 0; burnout < MCP3564_MAX_BURNOUT_IDX; burnout++)
  778. if (val == mcp3564_burnout_avail[burnout][0] &&
  779. val2 == mcp3564_burnout_avail[burnout][1])
  780. break;
  781. if (burnout == MCP3564_MAX_BURNOUT_IDX)
  782. return -EINVAL;
  783. if (burnout == adc->burnout_mode)
  784. return ret;
  785. mutex_lock(&adc->lock);
  786. ret = mcp3564_update_8bits(adc, MCP3564_CONFIG0_REG,
  787. MCP3564_CONFIG0_CS_SEL_MASK,
  788. FIELD_PREP(MCP3564_CONFIG0_CS_SEL_MASK, burnout));
  789. if (ret)
  790. dev_err(&indio_dev->dev, "Failed to configure burnout current\n");
  791. else
  792. adc->burnout_mode = burnout;
  793. mutex_unlock(&adc->lock);
  794. return ret;
  795. case IIO_CHAN_INFO_CALIBBIAS:
  796. if (val < mcp3564_calib_bias[0] || val > mcp3564_calib_bias[2])
  797. return -EINVAL;
  798. mutex_lock(&adc->lock);
  799. ret = mcp3564_write_24bits(adc, MCP3564_OFFSETCAL_REG, val);
  800. if (!ret)
  801. adc->calib_bias = val;
  802. mutex_unlock(&adc->lock);
  803. return ret;
  804. case IIO_CHAN_INFO_CALIBSCALE:
  805. if (val < mcp3564_calib_scale[0] || val > mcp3564_calib_scale[2])
  806. return -EINVAL;
  807. if (adc->calib_scale == val)
  808. return ret;
  809. mutex_lock(&adc->lock);
  810. ret = mcp3564_write_24bits(adc, MCP3564_GAINCAL_REG, val);
  811. if (!ret)
  812. adc->calib_scale = val;
  813. mutex_unlock(&adc->lock);
  814. return ret;
  815. case IIO_CHAN_INFO_OVERSAMPLING_RATIO:
  816. if (val < 0)
  817. return -EINVAL;
  818. tmp = find_closest(val, mcp3564_oversampling_avail,
  819. ARRAY_SIZE(mcp3564_oversampling_avail));
  820. if (adc->oversampling == tmp)
  821. return ret;
  822. mutex_lock(&adc->lock);
  823. ret = mcp3564_update_8bits(adc, MCP3564_CONFIG1_REG,
  824. MCP3564_CONFIG1_OVERSPL_RATIO_MASK,
  825. FIELD_PREP(MCP3564_CONFIG1_OVERSPL_RATIO_MASK,
  826. adc->oversampling));
  827. if (!ret)
  828. adc->oversampling = tmp;
  829. mutex_unlock(&adc->lock);
  830. return ret;
  831. case IIO_CHAN_INFO_SCALE:
  832. for (hwgain = 0; hwgain < MCP3564_MAX_PGA; hwgain++)
  833. if (val == adc->scale_tbls[hwgain][0] &&
  834. val2 == adc->scale_tbls[hwgain][1])
  835. break;
  836. if (hwgain == MCP3564_MAX_PGA)
  837. return -EINVAL;
  838. if (hwgain == adc->hwgain)
  839. return ret;
  840. mutex_lock(&adc->lock);
  841. ret = mcp3564_update_8bits(adc, MCP3564_CONFIG2_REG,
  842. MCP3564_CONFIG2_HARDWARE_GAIN_MASK,
  843. FIELD_PREP(MCP3564_CONFIG2_HARDWARE_GAIN_MASK, hwgain));
  844. if (!ret)
  845. adc->hwgain = hwgain;
  846. mutex_unlock(&adc->lock);
  847. return ret;
  848. default:
  849. return -EINVAL;
  850. }
  851. }
  852. static int mcp3564_read_label(struct iio_dev *indio_dev,
  853. struct iio_chan_spec const *chan, char *label)
  854. {
  855. struct mcp3564_state *adc = iio_priv(indio_dev);
  856. return sprintf(label, "%s\n", adc->labels[chan->scan_index]);
  857. }
  858. static int mcp3564_parse_fw_children(struct iio_dev *indio_dev)
  859. {
  860. struct mcp3564_state *adc = iio_priv(indio_dev);
  861. struct device *dev = &adc->spi->dev;
  862. struct iio_chan_spec *channels;
  863. struct iio_chan_spec chanspec = mcp3564_channel_template;
  864. struct iio_chan_spec temp_chanspec = mcp3564_temp_channel_template;
  865. struct iio_chan_spec burnout_chanspec = mcp3564_burnout_channel_template;
  866. int chan_idx = 0;
  867. unsigned int num_ch;
  868. u32 inputs[2];
  869. const char *node_name;
  870. const char *label;
  871. int ret;
  872. num_ch = device_get_child_node_count(dev);
  873. if (num_ch == 0)
  874. return dev_err_probe(&indio_dev->dev, -ENODEV,
  875. "FW has no channels defined\n");
  876. /* Reserve space for burnout and temperature channel */
  877. num_ch += 2;
  878. if (num_ch > adc->chip_info->num_channels)
  879. return dev_err_probe(dev, -EINVAL, "Too many channels %d > %d\n",
  880. num_ch, adc->chip_info->num_channels);
  881. channels = devm_kcalloc(dev, num_ch, sizeof(*channels), GFP_KERNEL);
  882. if (!channels)
  883. return dev_err_probe(dev, -ENOMEM, "Can't allocate memory\n");
  884. device_for_each_child_node_scoped(dev, child) {
  885. node_name = fwnode_get_name(child);
  886. if (fwnode_property_present(child, "diff-channels")) {
  887. ret = fwnode_property_read_u32_array(child,
  888. "diff-channels",
  889. inputs,
  890. ARRAY_SIZE(inputs));
  891. if (ret)
  892. return ret;
  893. chanspec.differential = 1;
  894. } else {
  895. ret = fwnode_property_read_u32(child, "reg", &inputs[0]);
  896. if (ret)
  897. return ret;
  898. chanspec.differential = 0;
  899. inputs[1] = MCP3564_AGND;
  900. }
  901. if (inputs[0] > MCP3564_INTERNAL_VCM ||
  902. inputs[1] > MCP3564_INTERNAL_VCM)
  903. return dev_err_probe(&indio_dev->dev, -EINVAL,
  904. "Channel index > %d, for %s\n",
  905. MCP3564_INTERNAL_VCM + 1,
  906. node_name);
  907. chanspec.address = (inputs[0] << 4) | inputs[1];
  908. chanspec.channel = inputs[0];
  909. chanspec.channel2 = inputs[1];
  910. chanspec.scan_index = chan_idx;
  911. if (fwnode_property_present(child, "label")) {
  912. fwnode_property_read_string(child, "label", &label);
  913. adc->labels[chan_idx] = label;
  914. }
  915. channels[chan_idx] = chanspec;
  916. chan_idx++;
  917. }
  918. /* Add burnout current channel */
  919. burnout_chanspec.scan_index = chan_idx;
  920. channels[chan_idx] = burnout_chanspec;
  921. adc->labels[chan_idx] = mcp3564_channel_labels[0];
  922. chanspec.scan_index = chan_idx;
  923. chan_idx++;
  924. /* Add temperature channel */
  925. temp_chanspec.scan_index = chan_idx;
  926. channels[chan_idx] = temp_chanspec;
  927. adc->labels[chan_idx] = mcp3564_channel_labels[1];
  928. chan_idx++;
  929. indio_dev->num_channels = chan_idx;
  930. indio_dev->channels = channels;
  931. return 0;
  932. }
  933. static void mcp3564_fill_scale_tbls(struct mcp3564_state *adc)
  934. {
  935. unsigned int pow = adc->chip_info->resolution - 1;
  936. int ref;
  937. unsigned int i;
  938. int tmp0;
  939. u64 tmp1;
  940. for (i = 0; i < MCP3564_MAX_PGA; i++) {
  941. ref = adc->vref_mv;
  942. tmp1 = ((u64)ref * NANO) >> pow;
  943. div_u64_rem(tmp1, NANO, &tmp0);
  944. tmp1 = tmp1 * mcp3564_hwgain_frac[(2 * i) + 1];
  945. tmp0 = (int)div_u64(tmp1, mcp3564_hwgain_frac[2 * i]);
  946. adc->scale_tbls[i][1] = tmp0;
  947. }
  948. }
  949. static int mcp3564_config(struct iio_dev *indio_dev, bool *use_internal_vref_attr)
  950. {
  951. struct mcp3564_state *adc = iio_priv(indio_dev);
  952. struct device *dev = &adc->spi->dev;
  953. u8 tmp_reg;
  954. u16 tmp_u16;
  955. enum mcp3564_ids ids;
  956. int ret = 0;
  957. unsigned int tmp = 0x01;
  958. bool internal_vref;
  959. bool err = false;
  960. /*
  961. * The address is set on a per-device basis by fuses in the factory,
  962. * configured on request. If not requested, the fuses are set for 0x1.
  963. * The device address is part of the device markings to avoid
  964. * potential confusion. This address is coded on two bits, so four possible
  965. * addresses are available when multiple devices are present on the same
  966. * SPI bus with only one Chip Select line for all devices.
  967. */
  968. device_property_read_u32(dev, "microchip,hw-device-address", &tmp);
  969. if (tmp > 3) {
  970. dev_err_probe(dev, tmp,
  971. "invalid device address. Must be in range 0-3.\n");
  972. return -EINVAL;
  973. }
  974. adc->dev_addr = FIELD_GET(MCP3564_HW_ADDR_MASK, tmp);
  975. dev_dbg(dev, "use HW device address %i\n", adc->dev_addr);
  976. ret = mcp3564_read_8bits(adc, MCP3564_RESERVED_C_REG, &tmp_reg);
  977. if (ret < 0)
  978. return ret;
  979. switch (tmp_reg) {
  980. case MCP3564_C_REG_DEFAULT:
  981. adc->have_vref = false;
  982. break;
  983. case MCP3564R_C_REG_DEFAULT:
  984. adc->have_vref = true;
  985. break;
  986. default:
  987. dev_info(dev, "Unknown chip found: %d\n", tmp_reg);
  988. err = true;
  989. }
  990. if (!err) {
  991. ret = mcp3564_read_16bits(adc, MCP3564_RESERVED_E_REG, &tmp_u16);
  992. if (ret < 0)
  993. return ret;
  994. switch (tmp_u16 & MCP3564_HW_ID_MASK) {
  995. case MCP3461_HW_ID:
  996. if (adc->have_vref)
  997. ids = mcp3461r;
  998. else
  999. ids = mcp3461;
  1000. break;
  1001. case MCP3462_HW_ID:
  1002. if (adc->have_vref)
  1003. ids = mcp3462r;
  1004. else
  1005. ids = mcp3462;
  1006. break;
  1007. case MCP3464_HW_ID:
  1008. if (adc->have_vref)
  1009. ids = mcp3464r;
  1010. else
  1011. ids = mcp3464;
  1012. break;
  1013. case MCP3561_HW_ID:
  1014. if (adc->have_vref)
  1015. ids = mcp3561r;
  1016. else
  1017. ids = mcp3561;
  1018. break;
  1019. case MCP3562_HW_ID:
  1020. if (adc->have_vref)
  1021. ids = mcp3562r;
  1022. else
  1023. ids = mcp3562;
  1024. break;
  1025. case MCP3564_HW_ID:
  1026. if (adc->have_vref)
  1027. ids = mcp3564r;
  1028. else
  1029. ids = mcp3564;
  1030. break;
  1031. default:
  1032. dev_info(dev, "Unknown chip found: %d\n", tmp_u16);
  1033. err = true;
  1034. }
  1035. }
  1036. if (err) {
  1037. /*
  1038. * If failed to identify the hardware based on internal registers,
  1039. * try using fallback compatible in device tree to deal with some newer part number.
  1040. */
  1041. adc->chip_info = spi_get_device_match_data(adc->spi);
  1042. adc->have_vref = adc->chip_info->have_vref;
  1043. } else {
  1044. adc->chip_info = &mcp3564_chip_infos_tbl[ids];
  1045. }
  1046. dev_dbg(dev, "Found %s chip\n", adc->chip_info->name);
  1047. ret = devm_regulator_get_enable_read_voltage(dev, "vref");
  1048. if (ret < 0 && ret != -ENODEV)
  1049. return dev_err_probe(dev, ret, "Failed to get vref voltage\n");
  1050. internal_vref = ret == -ENODEV;
  1051. adc->vref_mv = internal_vref ? MCP3564R_INT_VREF_MV : ret / MILLI;
  1052. *use_internal_vref_attr = internal_vref;
  1053. if (internal_vref) {
  1054. /* Check if chip has internal vref */
  1055. if (!adc->have_vref)
  1056. return dev_err_probe(dev, -ENODEV, "Unknown Vref\n");
  1057. dev_dbg(dev, "%s: Using internal Vref\n", __func__);
  1058. } else {
  1059. dev_dbg(dev, "%s: Using External Vref\n", __func__);
  1060. }
  1061. ret = mcp3564_parse_fw_children(indio_dev);
  1062. if (ret)
  1063. return ret;
  1064. /*
  1065. * Command sequence that ensures a recovery with the desired settings
  1066. * in any cases of loss-of-power scenario (Full Chip Reset):
  1067. * - Write LOCK register to 0xA5
  1068. * - Write IRQ register to 0x03
  1069. * - Send "Device Full Reset" fast command
  1070. * - Wait 1ms for "Full Reset" to complete
  1071. */
  1072. ret = mcp3564_write_8bits(adc, MCP3564_LOCK_REG, MCP3564_LOCK_WRITE_ACCESS_PASSWORD);
  1073. if (ret)
  1074. return ret;
  1075. ret = mcp3564_write_8bits(adc, MCP3564_IRQ_REG, 0x03);
  1076. if (ret)
  1077. return ret;
  1078. ret = mcp3564_fast_cmd(adc, MCP3564_FASTCMD_RESET);
  1079. if (ret)
  1080. return ret;
  1081. /*
  1082. * After Full reset wait some time to be able to fully reset the part and place
  1083. * it back in a default configuration.
  1084. * From datasheet: POR (Power On Reset Time) is ~1us
  1085. * 1ms should be enough.
  1086. */
  1087. mdelay(1);
  1088. /* set a gain of 1x for GAINCAL */
  1089. ret = mcp3564_write_24bits(adc, MCP3564_GAINCAL_REG, MCP3564_DEFAULT_GAINCAL);
  1090. if (ret)
  1091. return ret;
  1092. adc->calib_scale = MCP3564_DEFAULT_GAINCAL;
  1093. ret = mcp3564_write_24bits(adc, MCP3564_OFFSETCAL_REG, MCP3564_DEFAULT_OFFSETCAL);
  1094. if (ret)
  1095. return ret;
  1096. ret = mcp3564_write_24bits(adc, MCP3564_TIMER_REG, MCP3564_TIMER_DEFAULT_VALUE);
  1097. if (ret)
  1098. return ret;
  1099. ret = mcp3564_write_24bits(adc, MCP3564_SCAN_REG,
  1100. MCP3564_SCAN_DELAY_TIME_SET(MCP3564_NO_DELAY) |
  1101. MCP3564_SCAN_CH_SEL_SET(MCP3564_SCAN_DEFAULT_VALUE));
  1102. if (ret)
  1103. return ret;
  1104. ret = mcp3564_write_8bits(adc, MCP3564_MUX_REG, MCP3564_MUX_SET(MCP3564_CH0, MCP3564_CH1));
  1105. if (ret)
  1106. return ret;
  1107. ret = mcp3564_write_8bits(adc, MCP3564_IRQ_REG,
  1108. FIELD_PREP(MCP3464_EN_FASTCMD_MASK, 1) |
  1109. FIELD_PREP(MCP3464_EN_STP_MASK, 1));
  1110. if (ret)
  1111. return ret;
  1112. tmp_reg = FIELD_PREP(MCP3464_CONFIG3_CONV_MODE_MASK,
  1113. MCP3464_CONFIG3_CONV_MODE_ONE_SHOT_STANDBY);
  1114. tmp_reg |= FIELD_PREP(MCP3464_CONFIG3_DATA_FORMAT_MASK,
  1115. MCP3464_CONFIG3_DATA_FMT_32B_SGN_EXT);
  1116. tmp_reg |= MCP3464_CONFIG3_EN_OFFCAL_MASK;
  1117. tmp_reg |= MCP3464_CONFIG3_EN_GAINCAL_MASK;
  1118. ret = mcp3564_write_8bits(adc, MCP3564_CONFIG3_REG, tmp_reg);
  1119. if (ret)
  1120. return ret;
  1121. tmp_reg = FIELD_PREP(MCP3564_CONFIG2_BOOST_CURRENT_MASK, MCP3564_BOOST_CURRENT_x1_00);
  1122. tmp_reg |= FIELD_PREP(MCP3564_CONFIG2_HARDWARE_GAIN_MASK, 0x01);
  1123. tmp_reg |= FIELD_PREP(MCP3564_CONFIG2_AZ_MUX_MASK, 1);
  1124. ret = mcp3564_write_8bits(adc, MCP3564_CONFIG2_REG, tmp_reg);
  1125. if (ret)
  1126. return ret;
  1127. adc->hwgain = 0x01;
  1128. adc->auto_zeroing_mux = true;
  1129. adc->auto_zeroing_ref = false;
  1130. adc->current_boost_mode = MCP3564_BOOST_CURRENT_x1_00;
  1131. tmp_reg = FIELD_PREP(MCP3564_CONFIG1_OVERSPL_RATIO_MASK, MCP3564_OVERSAMPLING_RATIO_98304);
  1132. ret = mcp3564_write_8bits(adc, MCP3564_CONFIG1_REG, tmp_reg);
  1133. if (ret)
  1134. return ret;
  1135. adc->oversampling = MCP3564_OVERSAMPLING_RATIO_98304;
  1136. tmp_reg = FIELD_PREP(MCP3564_CONFIG0_ADC_MODE_MASK, MCP3564_ADC_MODE_STANDBY);
  1137. tmp_reg |= FIELD_PREP(MCP3564_CONFIG0_CS_SEL_MASK, MCP3564_CONFIG0_CS_SEL_0_0_uA);
  1138. tmp_reg |= FIELD_PREP(MCP3564_CONFIG0_CLK_SEL_MASK, MCP3564_CONFIG0_USE_INT_CLK);
  1139. tmp_reg |= MCP3456_CONFIG0_BIT6_DEFAULT;
  1140. if (internal_vref)
  1141. tmp_reg |= FIELD_PREP(MCP3456_CONFIG0_VREF_MASK, 1);
  1142. ret = mcp3564_write_8bits(adc, MCP3564_CONFIG0_REG, tmp_reg);
  1143. adc->burnout_mode = MCP3564_CONFIG0_CS_SEL_0_0_uA;
  1144. return ret;
  1145. }
  1146. static IIO_DEVICE_ATTR(auto_zeroing_ref_enable, 0644,
  1147. mcp3564_auto_zeroing_ref_show,
  1148. mcp3564_auto_zeroing_ref_store, 0);
  1149. static IIO_DEVICE_ATTR(auto_zeroing_mux_enable, 0644,
  1150. mcp3564_auto_zeroing_mux_show,
  1151. mcp3564_auto_zeroing_mux_store, 0);
  1152. static struct attribute *mcp3564_attributes[] = {
  1153. &iio_dev_attr_auto_zeroing_mux_enable.dev_attr.attr,
  1154. NULL
  1155. };
  1156. static struct attribute *mcp3564r_attributes[] = {
  1157. &iio_dev_attr_auto_zeroing_mux_enable.dev_attr.attr,
  1158. &iio_dev_attr_auto_zeroing_ref_enable.dev_attr.attr,
  1159. NULL
  1160. };
  1161. static struct attribute_group mcp3564_attribute_group = {
  1162. .attrs = mcp3564_attributes,
  1163. };
  1164. static struct attribute_group mcp3564r_attribute_group = {
  1165. .attrs = mcp3564r_attributes,
  1166. };
  1167. static const struct iio_info mcp3564_info = {
  1168. .read_raw = mcp3564_read_raw,
  1169. .read_avail = mcp3564_read_avail,
  1170. .write_raw = mcp3564_write_raw,
  1171. .write_raw_get_fmt = mcp3564_write_raw_get_fmt,
  1172. .read_label = mcp3564_read_label,
  1173. .attrs = &mcp3564_attribute_group,
  1174. };
  1175. static const struct iio_info mcp3564r_info = {
  1176. .read_raw = mcp3564_read_raw,
  1177. .read_avail = mcp3564_read_avail,
  1178. .write_raw = mcp3564_write_raw,
  1179. .write_raw_get_fmt = mcp3564_write_raw_get_fmt,
  1180. .read_label = mcp3564_read_label,
  1181. .attrs = &mcp3564r_attribute_group,
  1182. };
  1183. static int mcp3564_probe(struct spi_device *spi)
  1184. {
  1185. int ret;
  1186. struct iio_dev *indio_dev;
  1187. struct mcp3564_state *adc;
  1188. bool use_internal_vref_attr;
  1189. indio_dev = devm_iio_device_alloc(&spi->dev, sizeof(*adc));
  1190. if (!indio_dev)
  1191. return -ENOMEM;
  1192. adc = iio_priv(indio_dev);
  1193. adc->spi = spi;
  1194. dev_dbg(&spi->dev, "%s: probe(spi = 0x%p)\n", __func__, spi);
  1195. /*
  1196. * Do any chip specific initialization, e.g:
  1197. * read/write some registers
  1198. * enable/disable certain channels
  1199. * change the sampling rate to the requested value
  1200. */
  1201. ret = mcp3564_config(indio_dev, &use_internal_vref_attr);
  1202. if (ret)
  1203. return dev_err_probe(&spi->dev, ret,
  1204. "Can't configure MCP356X device\n");
  1205. dev_dbg(&spi->dev, "%s: Vref (mV): %d\n", __func__, adc->vref_mv);
  1206. mcp3564_fill_scale_tbls(adc);
  1207. indio_dev->name = adc->chip_info->name;
  1208. indio_dev->modes = INDIO_DIRECT_MODE;
  1209. if (use_internal_vref_attr)
  1210. indio_dev->info = &mcp3564r_info;
  1211. else
  1212. indio_dev->info = &mcp3564_info;
  1213. mutex_init(&adc->lock);
  1214. ret = devm_iio_device_register(&spi->dev, indio_dev);
  1215. if (ret)
  1216. return dev_err_probe(&spi->dev, ret,
  1217. "Can't register IIO device\n");
  1218. return 0;
  1219. }
  1220. static const struct of_device_id mcp3564_dt_ids[] = {
  1221. { .compatible = "microchip,mcp3461", .data = &mcp3564_chip_infos_tbl[mcp3461] },
  1222. { .compatible = "microchip,mcp3462", .data = &mcp3564_chip_infos_tbl[mcp3462] },
  1223. { .compatible = "microchip,mcp3464", .data = &mcp3564_chip_infos_tbl[mcp3464] },
  1224. { .compatible = "microchip,mcp3561", .data = &mcp3564_chip_infos_tbl[mcp3561] },
  1225. { .compatible = "microchip,mcp3562", .data = &mcp3564_chip_infos_tbl[mcp3562] },
  1226. { .compatible = "microchip,mcp3564", .data = &mcp3564_chip_infos_tbl[mcp3564] },
  1227. { .compatible = "microchip,mcp3461r", .data = &mcp3564_chip_infos_tbl[mcp3461r] },
  1228. { .compatible = "microchip,mcp3462r", .data = &mcp3564_chip_infos_tbl[mcp3462r] },
  1229. { .compatible = "microchip,mcp3464r", .data = &mcp3564_chip_infos_tbl[mcp3464r] },
  1230. { .compatible = "microchip,mcp3561r", .data = &mcp3564_chip_infos_tbl[mcp3561r] },
  1231. { .compatible = "microchip,mcp3562r", .data = &mcp3564_chip_infos_tbl[mcp3562r] },
  1232. { .compatible = "microchip,mcp3564r", .data = &mcp3564_chip_infos_tbl[mcp3564r] },
  1233. { }
  1234. };
  1235. MODULE_DEVICE_TABLE(of, mcp3564_dt_ids);
  1236. static const struct spi_device_id mcp3564_id[] = {
  1237. { "mcp3461", (kernel_ulong_t)&mcp3564_chip_infos_tbl[mcp3461] },
  1238. { "mcp3462", (kernel_ulong_t)&mcp3564_chip_infos_tbl[mcp3462] },
  1239. { "mcp3464", (kernel_ulong_t)&mcp3564_chip_infos_tbl[mcp3464] },
  1240. { "mcp3561", (kernel_ulong_t)&mcp3564_chip_infos_tbl[mcp3561] },
  1241. { "mcp3562", (kernel_ulong_t)&mcp3564_chip_infos_tbl[mcp3562] },
  1242. { "mcp3564", (kernel_ulong_t)&mcp3564_chip_infos_tbl[mcp3564] },
  1243. { "mcp3461r", (kernel_ulong_t)&mcp3564_chip_infos_tbl[mcp3461r] },
  1244. { "mcp3462r", (kernel_ulong_t)&mcp3564_chip_infos_tbl[mcp3462r] },
  1245. { "mcp3464r", (kernel_ulong_t)&mcp3564_chip_infos_tbl[mcp3464r] },
  1246. { "mcp3561r", (kernel_ulong_t)&mcp3564_chip_infos_tbl[mcp3561r] },
  1247. { "mcp3562r", (kernel_ulong_t)&mcp3564_chip_infos_tbl[mcp3562r] },
  1248. { "mcp3564r", (kernel_ulong_t)&mcp3564_chip_infos_tbl[mcp3564r] },
  1249. { }
  1250. };
  1251. MODULE_DEVICE_TABLE(spi, mcp3564_id);
  1252. static struct spi_driver mcp3564_driver = {
  1253. .driver = {
  1254. .name = "mcp3564",
  1255. .of_match_table = mcp3564_dt_ids,
  1256. },
  1257. .probe = mcp3564_probe,
  1258. .id_table = mcp3564_id,
  1259. };
  1260. module_spi_driver(mcp3564_driver);
  1261. MODULE_AUTHOR("Marius Cristea <marius.cristea@microchip.com>");
  1262. MODULE_DESCRIPTION("Microchip MCP346x/MCP346xR and MCP356x/MCP356xR ADCs");
  1263. MODULE_LICENSE("GPL v2");