ti-ads1298.c 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772
  1. // SPDX-License-Identifier: GPL-2.0
  2. /* TI ADS1298 chip family driver
  3. * Copyright (C) 2023 - 2024 Topic Embedded Products
  4. */
  5. #include <linux/bitfield.h>
  6. #include <linux/cleanup.h>
  7. #include <linux/clk.h>
  8. #include <linux/err.h>
  9. #include <linux/delay.h>
  10. #include <linux/device.h>
  11. #include <linux/gpio/consumer.h>
  12. #include <linux/log2.h>
  13. #include <linux/math.h>
  14. #include <linux/module.h>
  15. #include <linux/regmap.h>
  16. #include <linux/regulator/consumer.h>
  17. #include <linux/slab.h>
  18. #include <linux/spi/spi.h>
  19. #include <linux/units.h>
  20. #include <linux/iio/iio.h>
  21. #include <linux/iio/buffer.h>
  22. #include <linux/iio/kfifo_buf.h>
  23. #include <linux/unaligned.h>
  24. /* Commands */
  25. #define ADS1298_CMD_WAKEUP 0x02
  26. #define ADS1298_CMD_STANDBY 0x04
  27. #define ADS1298_CMD_RESET 0x06
  28. #define ADS1298_CMD_START 0x08
  29. #define ADS1298_CMD_STOP 0x0a
  30. #define ADS1298_CMD_RDATAC 0x10
  31. #define ADS1298_CMD_SDATAC 0x11
  32. #define ADS1298_CMD_RDATA 0x12
  33. #define ADS1298_CMD_RREG 0x20
  34. #define ADS1298_CMD_WREG 0x40
  35. /* Registers */
  36. #define ADS1298_REG_ID 0x00
  37. #define ADS1298_MASK_ID_FAMILY GENMASK(7, 3)
  38. #define ADS1298_MASK_ID_CHANNELS GENMASK(2, 0)
  39. #define ADS1298_ID_FAMILY_ADS129X 0x90
  40. #define ADS1298_ID_FAMILY_ADS129XR 0xd0
  41. #define ADS1298_REG_CONFIG1 0x01
  42. #define ADS1298_MASK_CONFIG1_HR BIT(7)
  43. #define ADS1298_MASK_CONFIG1_DR GENMASK(2, 0)
  44. #define ADS1298_SHIFT_DR_HR 6
  45. #define ADS1298_SHIFT_DR_LP 7
  46. #define ADS1298_LOWEST_DR 0x06
  47. #define ADS1298_REG_CONFIG2 0x02
  48. #define ADS1298_MASK_CONFIG2_RESERVED BIT(6)
  49. #define ADS1298_MASK_CONFIG2_WCT_CHOP BIT(5)
  50. #define ADS1298_MASK_CONFIG2_INT_TEST BIT(4)
  51. #define ADS1298_MASK_CONFIG2_TEST_AMP BIT(2)
  52. #define ADS1298_MASK_CONFIG2_TEST_FREQ_DC GENMASK(1, 0)
  53. #define ADS1298_MASK_CONFIG2_TEST_FREQ_SLOW 0
  54. #define ADS1298_MASK_CONFIG2_TEST_FREQ_FAST BIT(0)
  55. #define ADS1298_REG_CONFIG3 0x03
  56. #define ADS1298_MASK_CONFIG3_PWR_REFBUF BIT(7)
  57. #define ADS1298_MASK_CONFIG3_RESERVED BIT(6)
  58. #define ADS1298_MASK_CONFIG3_VREF_4V BIT(5)
  59. #define ADS1298_REG_LOFF 0x04
  60. #define ADS1298_REG_CHnSET(n) (0x05 + n)
  61. #define ADS1298_MASK_CH_PD BIT(7)
  62. #define ADS1298_MASK_CH_PGA GENMASK(6, 4)
  63. #define ADS1298_MASK_CH_MUX GENMASK(2, 0)
  64. #define ADS1298_REG_LOFF_STATP 0x12
  65. #define ADS1298_REG_LOFF_STATN 0x13
  66. #define ADS1298_REG_CONFIG4 0x17
  67. #define ADS1298_MASK_CONFIG4_SINGLE_SHOT BIT(3)
  68. #define ADS1298_REG_WCT1 0x18
  69. #define ADS1298_REG_WCT2 0x19
  70. #define ADS1298_MAX_CHANNELS 8
  71. #define ADS1298_BITS_PER_SAMPLE 24
  72. #define ADS1298_CLK_RATE_HZ 2048000
  73. #define ADS1298_CLOCKS_TO_USECS(x) \
  74. (DIV_ROUND_UP((x) * MICROHZ_PER_HZ, ADS1298_CLK_RATE_HZ))
  75. /*
  76. * Read/write register commands require 4 clocks to decode, for speeds above
  77. * 2x the clock rate, this would require extra time between the command byte and
  78. * the data. Much simpler is to just limit the SPI transfer speed while doing
  79. * register access.
  80. */
  81. #define ADS1298_SPI_BUS_SPEED_SLOW ADS1298_CLK_RATE_HZ
  82. /* For reading and writing registers, we need a 3-byte buffer */
  83. #define ADS1298_SPI_CMD_BUFFER_SIZE 3
  84. /* Outputs status word and 'n' 24-bit samples, plus the command byte */
  85. #define ADS1298_SPI_RDATA_BUFFER_SIZE(n) (((n) + 1) * 3 + 1)
  86. #define ADS1298_SPI_RDATA_BUFFER_SIZE_MAX \
  87. ADS1298_SPI_RDATA_BUFFER_SIZE(ADS1298_MAX_CHANNELS)
  88. struct ads1298_private {
  89. const struct ads1298_chip_info *chip_info;
  90. struct spi_device *spi;
  91. struct regulator *reg_avdd;
  92. struct regulator *reg_vref;
  93. struct clk *clk;
  94. struct regmap *regmap;
  95. struct completion completion;
  96. struct iio_trigger *trig;
  97. struct spi_transfer rdata_xfer;
  98. struct spi_message rdata_msg;
  99. spinlock_t irq_busy_lock; /* Handshake between SPI and DRDY irqs */
  100. /*
  101. * rdata_xfer_busy increments when a DRDY occurs and decrements when SPI
  102. * completion is reported. Hence its meaning is:
  103. * 0 = Waiting for DRDY interrupt
  104. * 1 = SPI transfer in progress
  105. * 2 = DRDY during SPI transfer, start another transfer on completion
  106. * >2 = Multiple DRDY during transfer, lost rdata_xfer_busy - 2 samples
  107. */
  108. unsigned int rdata_xfer_busy;
  109. /* Temporary storage for demuxing data after SPI transfer */
  110. u32 bounce_buffer[ADS1298_MAX_CHANNELS];
  111. /* For synchronous SPI exchanges (read/write registers) */
  112. u8 cmd_buffer[ADS1298_SPI_CMD_BUFFER_SIZE] __aligned(IIO_DMA_MINALIGN);
  113. /* Buffer used for incoming SPI data */
  114. u8 rx_buffer[ADS1298_SPI_RDATA_BUFFER_SIZE_MAX];
  115. /* Contains the RDATA command and zeroes to clock out */
  116. u8 tx_buffer[ADS1298_SPI_RDATA_BUFFER_SIZE_MAX];
  117. };
  118. /* Three bytes per sample in RX buffer, starting at offset 4 */
  119. #define ADS1298_OFFSET_IN_RX_BUFFER(index) (3 * (index) + 4)
  120. #define ADS1298_CHAN(index) \
  121. { \
  122. .type = IIO_VOLTAGE, \
  123. .indexed = 1, \
  124. .channel = index, \
  125. .address = ADS1298_OFFSET_IN_RX_BUFFER(index), \
  126. .info_mask_separate = \
  127. BIT(IIO_CHAN_INFO_RAW) | \
  128. BIT(IIO_CHAN_INFO_SCALE), \
  129. .info_mask_shared_by_all = \
  130. BIT(IIO_CHAN_INFO_SAMP_FREQ) | \
  131. BIT(IIO_CHAN_INFO_OVERSAMPLING_RATIO), \
  132. .scan_index = index, \
  133. .scan_type = { \
  134. .sign = 's', \
  135. .realbits = ADS1298_BITS_PER_SAMPLE, \
  136. .storagebits = 32, \
  137. .endianness = IIO_CPU, \
  138. }, \
  139. }
  140. static const struct iio_chan_spec ads1298_channels[] = {
  141. ADS1298_CHAN(0),
  142. ADS1298_CHAN(1),
  143. ADS1298_CHAN(2),
  144. ADS1298_CHAN(3),
  145. ADS1298_CHAN(4),
  146. ADS1298_CHAN(5),
  147. ADS1298_CHAN(6),
  148. ADS1298_CHAN(7),
  149. };
  150. static int ads1298_write_cmd(struct ads1298_private *priv, u8 command)
  151. {
  152. struct spi_transfer xfer = {
  153. .tx_buf = priv->cmd_buffer,
  154. .rx_buf = priv->cmd_buffer,
  155. .len = 1,
  156. .speed_hz = ADS1298_SPI_BUS_SPEED_SLOW,
  157. .delay = {
  158. .value = 2,
  159. .unit = SPI_DELAY_UNIT_USECS,
  160. },
  161. };
  162. priv->cmd_buffer[0] = command;
  163. return spi_sync_transfer(priv->spi, &xfer, 1);
  164. }
  165. static int ads1298_read_one(struct ads1298_private *priv, int chan_index)
  166. {
  167. int ret;
  168. /* Enable the channel */
  169. ret = regmap_update_bits(priv->regmap, ADS1298_REG_CHnSET(chan_index),
  170. ADS1298_MASK_CH_PD, 0);
  171. if (ret)
  172. return ret;
  173. /* Enable single-shot mode, so we don't need to send a STOP */
  174. ret = regmap_update_bits(priv->regmap, ADS1298_REG_CONFIG4,
  175. ADS1298_MASK_CONFIG4_SINGLE_SHOT,
  176. ADS1298_MASK_CONFIG4_SINGLE_SHOT);
  177. if (ret)
  178. return ret;
  179. reinit_completion(&priv->completion);
  180. ret = ads1298_write_cmd(priv, ADS1298_CMD_START);
  181. if (ret < 0) {
  182. dev_err(&priv->spi->dev, "CMD_START error: %d\n", ret);
  183. return ret;
  184. }
  185. /* Cannot take longer than 40ms (250Hz) */
  186. ret = wait_for_completion_timeout(&priv->completion, msecs_to_jiffies(50));
  187. if (!ret)
  188. return -ETIMEDOUT;
  189. return 0;
  190. }
  191. static int ads1298_get_samp_freq(struct ads1298_private *priv, int *val)
  192. {
  193. unsigned long rate;
  194. unsigned int cfg;
  195. int ret;
  196. ret = regmap_read(priv->regmap, ADS1298_REG_CONFIG1, &cfg);
  197. if (ret)
  198. return ret;
  199. if (priv->clk)
  200. rate = clk_get_rate(priv->clk);
  201. else
  202. rate = ADS1298_CLK_RATE_HZ;
  203. if (!rate)
  204. return -EINVAL;
  205. /* Data rate shift depends on HR/LP mode */
  206. if (cfg & ADS1298_MASK_CONFIG1_HR)
  207. rate >>= ADS1298_SHIFT_DR_HR;
  208. else
  209. rate >>= ADS1298_SHIFT_DR_LP;
  210. *val = rate >> (cfg & ADS1298_MASK_CONFIG1_DR);
  211. return IIO_VAL_INT;
  212. }
  213. static int ads1298_set_samp_freq(struct ads1298_private *priv, int val)
  214. {
  215. unsigned long rate;
  216. unsigned int factor;
  217. unsigned int cfg;
  218. if (priv->clk)
  219. rate = clk_get_rate(priv->clk);
  220. else
  221. rate = ADS1298_CLK_RATE_HZ;
  222. if (!rate)
  223. return -EINVAL;
  224. if (val <= 0)
  225. return -EINVAL;
  226. factor = (rate >> ADS1298_SHIFT_DR_HR) / val;
  227. if (factor >= BIT(ADS1298_SHIFT_DR_LP))
  228. cfg = ADS1298_LOWEST_DR;
  229. else if (factor)
  230. cfg = ADS1298_MASK_CONFIG1_HR | ilog2(factor); /* Use HR mode */
  231. else
  232. cfg = ADS1298_MASK_CONFIG1_HR; /* Fastest possible */
  233. return regmap_update_bits(priv->regmap, ADS1298_REG_CONFIG1,
  234. ADS1298_MASK_CONFIG1_HR | ADS1298_MASK_CONFIG1_DR,
  235. cfg);
  236. }
  237. static const u8 ads1298_pga_settings[] = { 6, 1, 2, 3, 4, 8, 12 };
  238. static int ads1298_get_scale(struct ads1298_private *priv,
  239. int channel, int *val, int *val2)
  240. {
  241. int ret;
  242. unsigned int regval;
  243. u8 gain;
  244. if (priv->reg_vref) {
  245. ret = regulator_get_voltage(priv->reg_vref);
  246. if (ret < 0)
  247. return ret;
  248. *val = ret / MILLI; /* Convert to millivolts */
  249. } else {
  250. ret = regmap_read(priv->regmap, ADS1298_REG_CONFIG3, &regval);
  251. if (ret)
  252. return ret;
  253. /* Refererence in millivolts */
  254. *val = regval & ADS1298_MASK_CONFIG3_VREF_4V ? 4000 : 2400;
  255. }
  256. ret = regmap_read(priv->regmap, ADS1298_REG_CHnSET(channel), &regval);
  257. if (ret)
  258. return ret;
  259. gain = ads1298_pga_settings[FIELD_GET(ADS1298_MASK_CH_PGA, regval)];
  260. *val /= gain; /* Full scale is VREF / gain */
  261. *val2 = ADS1298_BITS_PER_SAMPLE - 1; /* Signed, hence the -1 */
  262. return IIO_VAL_FRACTIONAL_LOG2;
  263. }
  264. static int ads1298_read_raw(struct iio_dev *indio_dev,
  265. struct iio_chan_spec const *chan,
  266. int *val, int *val2, long mask)
  267. {
  268. struct ads1298_private *priv = iio_priv(indio_dev);
  269. int ret;
  270. switch (mask) {
  271. case IIO_CHAN_INFO_RAW:
  272. ret = iio_device_claim_direct_mode(indio_dev);
  273. if (ret)
  274. return ret;
  275. ret = ads1298_read_one(priv, chan->scan_index);
  276. iio_device_release_direct_mode(indio_dev);
  277. if (ret)
  278. return ret;
  279. *val = sign_extend32(get_unaligned_be24(priv->rx_buffer + chan->address),
  280. ADS1298_BITS_PER_SAMPLE - 1);
  281. return IIO_VAL_INT;
  282. case IIO_CHAN_INFO_SCALE:
  283. return ads1298_get_scale(priv, chan->channel, val, val2);
  284. case IIO_CHAN_INFO_SAMP_FREQ:
  285. return ads1298_get_samp_freq(priv, val);
  286. case IIO_CHAN_INFO_OVERSAMPLING_RATIO:
  287. ret = regmap_read(priv->regmap, ADS1298_REG_CONFIG1, val);
  288. if (ret)
  289. return ret;
  290. *val = 16 << (*val & ADS1298_MASK_CONFIG1_DR);
  291. return IIO_VAL_INT;
  292. default:
  293. return -EINVAL;
  294. }
  295. }
  296. static int ads1298_write_raw(struct iio_dev *indio_dev,
  297. struct iio_chan_spec const *chan, int val,
  298. int val2, long mask)
  299. {
  300. struct ads1298_private *priv = iio_priv(indio_dev);
  301. switch (mask) {
  302. case IIO_CHAN_INFO_SAMP_FREQ:
  303. return ads1298_set_samp_freq(priv, val);
  304. default:
  305. return -EINVAL;
  306. }
  307. }
  308. static int ads1298_reg_write(void *context, unsigned int reg, unsigned int val)
  309. {
  310. struct ads1298_private *priv = context;
  311. struct spi_transfer reg_write_xfer = {
  312. .tx_buf = priv->cmd_buffer,
  313. .rx_buf = priv->cmd_buffer,
  314. .len = 3,
  315. .speed_hz = ADS1298_SPI_BUS_SPEED_SLOW,
  316. .delay = {
  317. .value = 2,
  318. .unit = SPI_DELAY_UNIT_USECS,
  319. },
  320. };
  321. priv->cmd_buffer[0] = ADS1298_CMD_WREG | reg;
  322. priv->cmd_buffer[1] = 0; /* Number of registers to be written - 1 */
  323. priv->cmd_buffer[2] = val;
  324. return spi_sync_transfer(priv->spi, &reg_write_xfer, 1);
  325. }
  326. static int ads1298_reg_read(void *context, unsigned int reg, unsigned int *val)
  327. {
  328. struct ads1298_private *priv = context;
  329. struct spi_transfer reg_read_xfer = {
  330. .tx_buf = priv->cmd_buffer,
  331. .rx_buf = priv->cmd_buffer,
  332. .len = 3,
  333. .speed_hz = ADS1298_SPI_BUS_SPEED_SLOW,
  334. .delay = {
  335. .value = 2,
  336. .unit = SPI_DELAY_UNIT_USECS,
  337. },
  338. };
  339. int ret;
  340. priv->cmd_buffer[0] = ADS1298_CMD_RREG | reg;
  341. priv->cmd_buffer[1] = 0; /* Number of registers to be read - 1 */
  342. priv->cmd_buffer[2] = 0;
  343. ret = spi_sync_transfer(priv->spi, &reg_read_xfer, 1);
  344. if (ret)
  345. return ret;
  346. *val = priv->cmd_buffer[2];
  347. return 0;
  348. }
  349. static int ads1298_reg_access(struct iio_dev *indio_dev, unsigned int reg,
  350. unsigned int writeval, unsigned int *readval)
  351. {
  352. struct ads1298_private *priv = iio_priv(indio_dev);
  353. if (readval)
  354. return regmap_read(priv->regmap, reg, readval);
  355. return regmap_write(priv->regmap, reg, writeval);
  356. }
  357. static void ads1298_rdata_unmark_busy(struct ads1298_private *priv)
  358. {
  359. /* Notify we're no longer waiting for the SPI transfer to complete */
  360. guard(spinlock_irqsave)(&priv->irq_busy_lock);
  361. priv->rdata_xfer_busy = 0;
  362. }
  363. static int ads1298_update_scan_mode(struct iio_dev *indio_dev,
  364. const unsigned long *scan_mask)
  365. {
  366. struct ads1298_private *priv = iio_priv(indio_dev);
  367. unsigned int val;
  368. int ret;
  369. int i;
  370. /* Make the interrupt routines start with a clean slate */
  371. ads1298_rdata_unmark_busy(priv);
  372. /* Configure power-down bits to match scan mask */
  373. for (i = 0; i < indio_dev->num_channels; i++) {
  374. val = test_bit(i, scan_mask) ? 0 : ADS1298_MASK_CH_PD;
  375. ret = regmap_update_bits(priv->regmap, ADS1298_REG_CHnSET(i),
  376. ADS1298_MASK_CH_PD, val);
  377. if (ret)
  378. return ret;
  379. }
  380. return 0;
  381. }
  382. static const struct iio_info ads1298_info = {
  383. .read_raw = &ads1298_read_raw,
  384. .write_raw = &ads1298_write_raw,
  385. .update_scan_mode = &ads1298_update_scan_mode,
  386. .debugfs_reg_access = &ads1298_reg_access,
  387. };
  388. static void ads1298_rdata_release_busy_or_restart(struct ads1298_private *priv)
  389. {
  390. guard(spinlock_irqsave)(&priv->irq_busy_lock);
  391. if (priv->rdata_xfer_busy > 1) {
  392. /*
  393. * DRDY interrupt occurred before SPI completion. Start a new
  394. * SPI transaction now to retrieve the data that wasn't latched
  395. * into the ADS1298 chip's transfer buffer yet.
  396. */
  397. spi_async(priv->spi, &priv->rdata_msg);
  398. /*
  399. * If more than one DRDY took place, there was an overrun. Since
  400. * the sample is already lost, reset the counter to 1 so that
  401. * we will wait for a DRDY interrupt after this SPI transaction.
  402. */
  403. priv->rdata_xfer_busy = 1;
  404. } else {
  405. /* No pending data, wait for DRDY */
  406. priv->rdata_xfer_busy = 0;
  407. }
  408. }
  409. /* Called from SPI completion interrupt handler */
  410. static void ads1298_rdata_complete(void *context)
  411. {
  412. struct iio_dev *indio_dev = context;
  413. struct ads1298_private *priv = iio_priv(indio_dev);
  414. int scan_index;
  415. u32 *bounce = priv->bounce_buffer;
  416. if (!iio_buffer_enabled(indio_dev)) {
  417. /*
  418. * for a single transfer mode we're kept in direct_mode until
  419. * completion, avoiding a race with buffered IO.
  420. */
  421. ads1298_rdata_unmark_busy(priv);
  422. complete(&priv->completion);
  423. return;
  424. }
  425. /* Demux the channel data into our bounce buffer */
  426. iio_for_each_active_channel(indio_dev, scan_index) {
  427. const struct iio_chan_spec *scan_chan =
  428. &indio_dev->channels[scan_index];
  429. const u8 *data = priv->rx_buffer + scan_chan->address;
  430. *bounce++ = get_unaligned_be24(data);
  431. }
  432. /* rx_buffer can be overwritten from this point on */
  433. ads1298_rdata_release_busy_or_restart(priv);
  434. iio_push_to_buffers(indio_dev, priv->bounce_buffer);
  435. }
  436. static irqreturn_t ads1298_interrupt(int irq, void *dev_id)
  437. {
  438. struct iio_dev *indio_dev = dev_id;
  439. struct ads1298_private *priv = iio_priv(indio_dev);
  440. unsigned int wasbusy;
  441. guard(spinlock_irqsave)(&priv->irq_busy_lock);
  442. wasbusy = priv->rdata_xfer_busy++;
  443. /* When no SPI transfer in transit, start one now */
  444. if (!wasbusy)
  445. spi_async(priv->spi, &priv->rdata_msg);
  446. return IRQ_HANDLED;
  447. };
  448. static int ads1298_buffer_postenable(struct iio_dev *indio_dev)
  449. {
  450. struct ads1298_private *priv = iio_priv(indio_dev);
  451. int ret;
  452. /* Disable single-shot mode */
  453. ret = regmap_update_bits(priv->regmap, ADS1298_REG_CONFIG4,
  454. ADS1298_MASK_CONFIG4_SINGLE_SHOT, 0);
  455. if (ret)
  456. return ret;
  457. return ads1298_write_cmd(priv, ADS1298_CMD_START);
  458. }
  459. static int ads1298_buffer_predisable(struct iio_dev *indio_dev)
  460. {
  461. struct ads1298_private *priv = iio_priv(indio_dev);
  462. return ads1298_write_cmd(priv, ADS1298_CMD_STOP);
  463. }
  464. static const struct iio_buffer_setup_ops ads1298_setup_ops = {
  465. .postenable = &ads1298_buffer_postenable,
  466. .predisable = &ads1298_buffer_predisable,
  467. };
  468. static void ads1298_reg_disable(void *reg)
  469. {
  470. regulator_disable(reg);
  471. }
  472. static const struct regmap_range ads1298_regmap_volatile_range[] = {
  473. regmap_reg_range(ADS1298_REG_LOFF_STATP, ADS1298_REG_LOFF_STATN),
  474. };
  475. static const struct regmap_access_table ads1298_regmap_volatile = {
  476. .yes_ranges = ads1298_regmap_volatile_range,
  477. .n_yes_ranges = ARRAY_SIZE(ads1298_regmap_volatile_range),
  478. };
  479. static const struct regmap_config ads1298_regmap_config = {
  480. .reg_bits = 8,
  481. .val_bits = 8,
  482. .reg_read = ads1298_reg_read,
  483. .reg_write = ads1298_reg_write,
  484. .max_register = ADS1298_REG_WCT2,
  485. .volatile_table = &ads1298_regmap_volatile,
  486. .cache_type = REGCACHE_MAPLE,
  487. };
  488. static int ads1298_init(struct iio_dev *indio_dev)
  489. {
  490. struct ads1298_private *priv = iio_priv(indio_dev);
  491. struct device *dev = &priv->spi->dev;
  492. const char *suffix;
  493. unsigned int val;
  494. int ret;
  495. /* Device initializes into RDATAC mode, which we don't want */
  496. ret = ads1298_write_cmd(priv, ADS1298_CMD_SDATAC);
  497. if (ret)
  498. return ret;
  499. ret = regmap_read(priv->regmap, ADS1298_REG_ID, &val);
  500. if (ret)
  501. return ret;
  502. /* Fill in name and channel count based on what the chip told us */
  503. indio_dev->num_channels = 4 + 2 * (val & ADS1298_MASK_ID_CHANNELS);
  504. switch (val & ADS1298_MASK_ID_FAMILY) {
  505. case ADS1298_ID_FAMILY_ADS129X:
  506. suffix = "";
  507. break;
  508. case ADS1298_ID_FAMILY_ADS129XR:
  509. suffix = "r";
  510. break;
  511. default:
  512. return dev_err_probe(dev, -ENODEV, "Unknown ID: 0x%x\n", val);
  513. }
  514. indio_dev->name = devm_kasprintf(dev, GFP_KERNEL, "ads129%u%s",
  515. indio_dev->num_channels, suffix);
  516. if (!indio_dev->name)
  517. return -ENOMEM;
  518. /* Enable internal test signal, double amplitude, double frequency */
  519. ret = regmap_write(priv->regmap, ADS1298_REG_CONFIG2,
  520. ADS1298_MASK_CONFIG2_RESERVED |
  521. ADS1298_MASK_CONFIG2_INT_TEST |
  522. ADS1298_MASK_CONFIG2_TEST_AMP |
  523. ADS1298_MASK_CONFIG2_TEST_FREQ_FAST);
  524. if (ret)
  525. return ret;
  526. val = ADS1298_MASK_CONFIG3_RESERVED; /* Must write 1 always */
  527. if (!priv->reg_vref) {
  528. /* Enable internal reference */
  529. val |= ADS1298_MASK_CONFIG3_PWR_REFBUF;
  530. /* Use 4V VREF when power supply is at least 4.4V */
  531. if (regulator_get_voltage(priv->reg_avdd) >= 4400000)
  532. val |= ADS1298_MASK_CONFIG3_VREF_4V;
  533. }
  534. return regmap_write(priv->regmap, ADS1298_REG_CONFIG3, val);
  535. }
  536. static int ads1298_probe(struct spi_device *spi)
  537. {
  538. struct ads1298_private *priv;
  539. struct iio_dev *indio_dev;
  540. struct device *dev = &spi->dev;
  541. struct gpio_desc *reset_gpio;
  542. int ret;
  543. indio_dev = devm_iio_device_alloc(dev, sizeof(*priv));
  544. if (!indio_dev)
  545. return -ENOMEM;
  546. priv = iio_priv(indio_dev);
  547. /* Reset to be asserted before enabling clock and power */
  548. reset_gpio = devm_gpiod_get_optional(dev, "reset", GPIOD_OUT_HIGH);
  549. if (IS_ERR(reset_gpio))
  550. return dev_err_probe(dev, PTR_ERR(reset_gpio),
  551. "Cannot get reset GPIO\n");
  552. /* VREF can be supplied externally, otherwise use internal reference */
  553. priv->reg_vref = devm_regulator_get_optional(dev, "vref");
  554. if (IS_ERR(priv->reg_vref)) {
  555. if (PTR_ERR(priv->reg_vref) != -ENODEV)
  556. return dev_err_probe(dev, PTR_ERR(priv->reg_vref),
  557. "Failed to get vref regulator\n");
  558. priv->reg_vref = NULL;
  559. } else {
  560. ret = regulator_enable(priv->reg_vref);
  561. if (ret)
  562. return ret;
  563. ret = devm_add_action_or_reset(dev, ads1298_reg_disable, priv->reg_vref);
  564. if (ret)
  565. return ret;
  566. }
  567. priv->clk = devm_clk_get_optional_enabled(dev, "clk");
  568. if (IS_ERR(priv->clk))
  569. return dev_err_probe(dev, PTR_ERR(priv->clk), "Failed to get clk\n");
  570. priv->reg_avdd = devm_regulator_get(dev, "avdd");
  571. if (IS_ERR(priv->reg_avdd))
  572. return dev_err_probe(dev, PTR_ERR(priv->reg_avdd),
  573. "Failed to get avdd regulator\n");
  574. ret = regulator_enable(priv->reg_avdd);
  575. if (ret)
  576. return dev_err_probe(dev, ret, "Failed to enable avdd regulator\n");
  577. ret = devm_add_action_or_reset(dev, ads1298_reg_disable, priv->reg_avdd);
  578. if (ret)
  579. return ret;
  580. priv->spi = spi;
  581. init_completion(&priv->completion);
  582. spin_lock_init(&priv->irq_busy_lock);
  583. priv->regmap = devm_regmap_init(dev, NULL, priv, &ads1298_regmap_config);
  584. if (IS_ERR(priv->regmap))
  585. return PTR_ERR(priv->regmap);
  586. indio_dev->modes = INDIO_DIRECT_MODE | INDIO_BUFFER_SOFTWARE;
  587. indio_dev->channels = ads1298_channels;
  588. indio_dev->info = &ads1298_info;
  589. if (reset_gpio) {
  590. /*
  591. * Deassert reset now that clock and power are active.
  592. * Minimum reset pulsewidth is 2 clock cycles.
  593. */
  594. fsleep(ADS1298_CLOCKS_TO_USECS(2));
  595. gpiod_set_value_cansleep(reset_gpio, 0);
  596. } else {
  597. ret = ads1298_write_cmd(priv, ADS1298_CMD_RESET);
  598. if (ret)
  599. return dev_err_probe(dev, ret, "RESET failed\n");
  600. }
  601. /* Wait 18 clock cycles for reset command to complete */
  602. fsleep(ADS1298_CLOCKS_TO_USECS(18));
  603. ret = ads1298_init(indio_dev);
  604. if (ret)
  605. return dev_err_probe(dev, ret, "Init failed\n");
  606. priv->tx_buffer[0] = ADS1298_CMD_RDATA;
  607. priv->rdata_xfer.tx_buf = priv->tx_buffer;
  608. priv->rdata_xfer.rx_buf = priv->rx_buffer;
  609. priv->rdata_xfer.len = ADS1298_SPI_RDATA_BUFFER_SIZE(indio_dev->num_channels);
  610. /* Must keep CS low for 4 clocks */
  611. priv->rdata_xfer.delay.value = 2;
  612. priv->rdata_xfer.delay.unit = SPI_DELAY_UNIT_USECS;
  613. spi_message_init_with_transfers(&priv->rdata_msg, &priv->rdata_xfer, 1);
  614. priv->rdata_msg.complete = &ads1298_rdata_complete;
  615. priv->rdata_msg.context = indio_dev;
  616. ret = devm_request_irq(dev, spi->irq, &ads1298_interrupt,
  617. IRQF_TRIGGER_FALLING, indio_dev->name,
  618. indio_dev);
  619. if (ret)
  620. return ret;
  621. ret = devm_iio_kfifo_buffer_setup(dev, indio_dev, &ads1298_setup_ops);
  622. if (ret)
  623. return ret;
  624. return devm_iio_device_register(dev, indio_dev);
  625. }
  626. static const struct spi_device_id ads1298_id[] = {
  627. { "ads1298" },
  628. { }
  629. };
  630. MODULE_DEVICE_TABLE(spi, ads1298_id);
  631. static const struct of_device_id ads1298_of_table[] = {
  632. { .compatible = "ti,ads1298" },
  633. { }
  634. };
  635. MODULE_DEVICE_TABLE(of, ads1298_of_table);
  636. static struct spi_driver ads1298_driver = {
  637. .driver = {
  638. .name = "ads1298",
  639. .of_match_table = ads1298_of_table,
  640. },
  641. .probe = ads1298_probe,
  642. .id_table = ads1298_id,
  643. };
  644. module_spi_driver(ads1298_driver);
  645. MODULE_AUTHOR("Mike Looijmans <mike.looijmans@topic.nl>");
  646. MODULE_DESCRIPTION("TI ADS1298 ADC");
  647. MODULE_LICENSE("GPL");