sx9310.c 29 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075
  1. // SPDX-License-Identifier: GPL-2.0
  2. /*
  3. * Copyright 2018 Google LLC.
  4. *
  5. * Driver for Semtech's SX9310/SX9311 capacitive proximity/button solution.
  6. * Based on SX9500 driver and Semtech driver using the input framework
  7. * <https://my.syncplicity.com/share/teouwsim8niiaud/
  8. * linux-driver-SX9310_NoSmartHSensing>.
  9. * Reworked in April 2019 by Evan Green <evgreen@chromium.org>
  10. * and in January 2020 by Daniel Campello <campello@chromium.org>.
  11. */
  12. #include <linux/acpi.h>
  13. #include <linux/bitfield.h>
  14. #include <linux/delay.h>
  15. #include <linux/i2c.h>
  16. #include <linux/irq.h>
  17. #include <linux/kernel.h>
  18. #include <linux/mod_devicetable.h>
  19. #include <linux/module.h>
  20. #include <linux/pm.h>
  21. #include <linux/regmap.h>
  22. #include <linux/regulator/consumer.h>
  23. #include <linux/slab.h>
  24. #include <linux/iio/buffer.h>
  25. #include <linux/iio/events.h>
  26. #include <linux/iio/iio.h>
  27. #include <linux/iio/sysfs.h>
  28. #include <linux/iio/trigger.h>
  29. #include <linux/iio/triggered_buffer.h>
  30. #include <linux/iio/trigger_consumer.h>
  31. /* Register definitions. */
  32. #define SX9310_REG_IRQ_SRC 0x00
  33. #define SX9310_REG_STAT0 0x01
  34. #define SX9310_REG_STAT1 0x02
  35. #define SX9310_REG_STAT1_COMPSTAT_MASK GENMASK(3, 0)
  36. #define SX9310_REG_IRQ_MSK 0x03
  37. #define SX9310_CONVDONE_IRQ BIT(3)
  38. #define SX9310_FAR_IRQ BIT(5)
  39. #define SX9310_CLOSE_IRQ BIT(6)
  40. #define SX9310_REG_IRQ_FUNC 0x04
  41. #define SX9310_REG_PROX_CTRL0 0x10
  42. #define SX9310_REG_PROX_CTRL0_SENSOREN_MASK GENMASK(3, 0)
  43. #define SX9310_REG_PROX_CTRL0_SCANPERIOD_MASK GENMASK(7, 4)
  44. #define SX9310_REG_PROX_CTRL0_SCANPERIOD_15MS 0x01
  45. #define SX9310_REG_PROX_CTRL1 0x11
  46. #define SX9310_REG_PROX_CTRL2 0x12
  47. #define SX9310_REG_PROX_CTRL2_COMBMODE_CS1_CS2 (0x02 << 6)
  48. #define SX9310_REG_PROX_CTRL2_SHIELDEN_DYNAMIC (0x01 << 2)
  49. #define SX9310_REG_PROX_CTRL3 0x13
  50. #define SX9310_REG_PROX_CTRL3_GAIN0_X8 (0x03 << 2)
  51. #define SX9310_REG_PROX_CTRL3_GAIN12_X4 0x02
  52. #define SX9310_REG_PROX_CTRL4 0x14
  53. #define SX9310_REG_PROX_CTRL4_RESOLUTION_FINEST 0x07
  54. #define SX9310_REG_PROX_CTRL5 0x15
  55. #define SX9310_REG_PROX_CTRL5_RANGE_SMALL (0x03 << 6)
  56. #define SX9310_REG_PROX_CTRL5_STARTUPSENS_CS1 (0x01 << 2)
  57. #define SX9310_REG_PROX_CTRL5_RAWFILT_1P25 0x02
  58. #define SX9310_REG_PROX_CTRL6 0x16
  59. #define SX9310_REG_PROX_CTRL6_AVGTHRESH_DEFAULT 0x20
  60. #define SX9310_REG_PROX_CTRL7 0x17
  61. #define SX9310_REG_PROX_CTRL7_AVGNEGFILT_2 (0x01 << 3)
  62. #define SX9310_REG_PROX_CTRL7_AVGPOSFILT_512 0x05
  63. #define SX9310_REG_PROX_CTRL8 0x18
  64. #define SX9310_REG_PROX_CTRL9 0x19
  65. #define SX9310_REG_PROX_CTRL8_9_PTHRESH_28 (0x08 << 3)
  66. #define SX9310_REG_PROX_CTRL8_9_PTHRESH_96 (0x11 << 3)
  67. #define SX9310_REG_PROX_CTRL8_9_BODYTHRESH_900 0x03
  68. #define SX9310_REG_PROX_CTRL8_9_BODYTHRESH_1500 0x05
  69. #define SX9310_REG_PROX_CTRL10 0x1a
  70. #define SX9310_REG_PROX_CTRL10_HYST_6PCT (0x01 << 4)
  71. #define SX9310_REG_PROX_CTRL10_FAR_DEBOUNCE_2 0x01
  72. #define SX9310_REG_PROX_CTRL11 0x1b
  73. #define SX9310_REG_PROX_CTRL12 0x1c
  74. #define SX9310_REG_PROX_CTRL13 0x1d
  75. #define SX9310_REG_PROX_CTRL14 0x1e
  76. #define SX9310_REG_PROX_CTRL15 0x1f
  77. #define SX9310_REG_PROX_CTRL16 0x20
  78. #define SX9310_REG_PROX_CTRL17 0x21
  79. #define SX9310_REG_PROX_CTRL18 0x22
  80. #define SX9310_REG_PROX_CTRL19 0x23
  81. #define SX9310_REG_SAR_CTRL0 0x2a
  82. #define SX9310_REG_SAR_CTRL0_SARDEB_4_SAMPLES (0x02 << 5)
  83. #define SX9310_REG_SAR_CTRL0_SARHYST_8 (0x02 << 3)
  84. #define SX9310_REG_SAR_CTRL1 0x2b
  85. /* Each increment of the slope register is 0.0078125. */
  86. #define SX9310_REG_SAR_CTRL1_SLOPE(_hnslope) (_hnslope / 78125)
  87. #define SX9310_REG_SAR_CTRL2 0x2c
  88. #define SX9310_REG_SAR_CTRL2_SAROFFSET_DEFAULT 0x3c
  89. #define SX9310_REG_SENSOR_SEL 0x30
  90. #define SX9310_REG_USE_MSB 0x31
  91. #define SX9310_REG_USE_LSB 0x32
  92. #define SX9310_REG_AVG_MSB 0x33
  93. #define SX9310_REG_AVG_LSB 0x34
  94. #define SX9310_REG_DIFF_MSB 0x35
  95. #define SX9310_REG_DIFF_LSB 0x36
  96. #define SX9310_REG_OFFSET_MSB 0x37
  97. #define SX9310_REG_OFFSET_LSB 0x38
  98. #define SX9310_REG_SAR_MSB 0x39
  99. #define SX9310_REG_SAR_LSB 0x3a
  100. #define SX9310_REG_I2C_ADDR 0x40
  101. #define SX9310_REG_PAUSE 0x41
  102. #define SX9310_REG_WHOAMI 0x42
  103. #define SX9310_WHOAMI_VALUE 0x01
  104. #define SX9311_WHOAMI_VALUE 0x02
  105. #define SX9310_REG_RESET 0x7f
  106. #define SX9310_SOFT_RESET 0xde
  107. /* 4 hardware channels, as defined in STAT0: COMB, CS2, CS1 and CS0. */
  108. #define SX9310_NUM_CHANNELS 4
  109. static_assert(SX9310_NUM_CHANNELS < BITS_PER_LONG);
  110. struct sx9310_data {
  111. /* Serialize access to registers and channel configuration */
  112. struct mutex mutex;
  113. struct i2c_client *client;
  114. struct iio_trigger *trig;
  115. struct regmap *regmap;
  116. struct regulator_bulk_data supplies[2];
  117. /*
  118. * Last reading of the proximity status for each channel.
  119. * We only send an event to user space when this changes.
  120. */
  121. unsigned long chan_prox_stat;
  122. bool trigger_enabled;
  123. /* Ensure correct alignment of timestamp when present. */
  124. struct {
  125. __be16 channels[SX9310_NUM_CHANNELS];
  126. s64 ts __aligned(8);
  127. } buffer;
  128. /* Remember enabled channels and sample rate during suspend. */
  129. unsigned int suspend_ctrl0;
  130. struct completion completion;
  131. unsigned long chan_read;
  132. unsigned long chan_event;
  133. unsigned int whoami;
  134. };
  135. static const struct iio_event_spec sx9310_events[] = {
  136. {
  137. .type = IIO_EV_TYPE_THRESH,
  138. .dir = IIO_EV_DIR_EITHER,
  139. .mask_separate = BIT(IIO_EV_INFO_ENABLE),
  140. },
  141. };
  142. #define SX9310_NAMED_CHANNEL(idx, name) \
  143. { \
  144. .type = IIO_PROXIMITY, \
  145. .info_mask_separate = BIT(IIO_CHAN_INFO_RAW), \
  146. .info_mask_shared_by_all = BIT(IIO_CHAN_INFO_SAMP_FREQ), \
  147. .indexed = 1, \
  148. .channel = idx, \
  149. .extend_name = name, \
  150. .address = SX9310_REG_DIFF_MSB, \
  151. .event_spec = sx9310_events, \
  152. .num_event_specs = ARRAY_SIZE(sx9310_events), \
  153. .scan_index = idx, \
  154. .scan_type = { \
  155. .sign = 's', \
  156. .realbits = 12, \
  157. .storagebits = 16, \
  158. .endianness = IIO_BE, \
  159. }, \
  160. }
  161. #define SX9310_CHANNEL(idx) SX9310_NAMED_CHANNEL(idx, NULL)
  162. static const struct iio_chan_spec sx9310_channels[] = {
  163. SX9310_CHANNEL(0), /* CS0 */
  164. SX9310_CHANNEL(1), /* CS1 */
  165. SX9310_CHANNEL(2), /* CS2 */
  166. SX9310_NAMED_CHANNEL(3, "comb"), /* COMB */
  167. IIO_CHAN_SOFT_TIMESTAMP(4),
  168. };
  169. /*
  170. * Each entry contains the integer part (val) and the fractional part, in micro
  171. * seconds. It conforms to the IIO output IIO_VAL_INT_PLUS_MICRO.
  172. */
  173. static const struct {
  174. int val;
  175. int val2;
  176. } sx9310_samp_freq_table[] = {
  177. { 500, 0 }, /* 0000: Min (no idle time) */
  178. { 66, 666666 }, /* 0001: 15 ms */
  179. { 33, 333333 }, /* 0010: 30 ms (Typ.) */
  180. { 22, 222222 }, /* 0011: 45 ms */
  181. { 16, 666666 }, /* 0100: 60 ms */
  182. { 11, 111111 }, /* 0101: 90 ms */
  183. { 8, 333333 }, /* 0110: 120 ms */
  184. { 5, 0 }, /* 0111: 200 ms */
  185. { 2, 500000 }, /* 1000: 400 ms */
  186. { 1, 666666 }, /* 1001: 600 ms */
  187. { 1, 250000 }, /* 1010: 800 ms */
  188. { 1, 0 }, /* 1011: 1 s */
  189. { 0, 500000 }, /* 1100: 2 s */
  190. { 0, 333333 }, /* 1101: 3 s */
  191. { 0, 250000 }, /* 1110: 4 s */
  192. { 0, 200000 }, /* 1111: 5 s */
  193. };
  194. static const unsigned int sx9310_scan_period_table[] = {
  195. 2, 15, 30, 45, 60, 90, 120, 200,
  196. 400, 600, 800, 1000, 2000, 3000, 4000, 5000,
  197. };
  198. static ssize_t sx9310_show_samp_freq_avail(struct device *dev,
  199. struct device_attribute *attr,
  200. char *buf)
  201. {
  202. size_t len = 0;
  203. int i;
  204. for (i = 0; i < ARRAY_SIZE(sx9310_samp_freq_table); i++)
  205. len += scnprintf(buf + len, PAGE_SIZE - len, "%d.%d ",
  206. sx9310_samp_freq_table[i].val,
  207. sx9310_samp_freq_table[i].val2);
  208. buf[len - 1] = '\n';
  209. return len;
  210. }
  211. static IIO_DEV_ATTR_SAMP_FREQ_AVAIL(sx9310_show_samp_freq_avail);
  212. static const struct regmap_range sx9310_writable_reg_ranges[] = {
  213. regmap_reg_range(SX9310_REG_IRQ_MSK, SX9310_REG_IRQ_FUNC),
  214. regmap_reg_range(SX9310_REG_PROX_CTRL0, SX9310_REG_PROX_CTRL19),
  215. regmap_reg_range(SX9310_REG_SAR_CTRL0, SX9310_REG_SAR_CTRL2),
  216. regmap_reg_range(SX9310_REG_SENSOR_SEL, SX9310_REG_SENSOR_SEL),
  217. regmap_reg_range(SX9310_REG_OFFSET_MSB, SX9310_REG_OFFSET_LSB),
  218. regmap_reg_range(SX9310_REG_PAUSE, SX9310_REG_PAUSE),
  219. regmap_reg_range(SX9310_REG_RESET, SX9310_REG_RESET),
  220. };
  221. static const struct regmap_access_table sx9310_writeable_regs = {
  222. .yes_ranges = sx9310_writable_reg_ranges,
  223. .n_yes_ranges = ARRAY_SIZE(sx9310_writable_reg_ranges),
  224. };
  225. static const struct regmap_range sx9310_readable_reg_ranges[] = {
  226. regmap_reg_range(SX9310_REG_IRQ_SRC, SX9310_REG_IRQ_FUNC),
  227. regmap_reg_range(SX9310_REG_PROX_CTRL0, SX9310_REG_PROX_CTRL19),
  228. regmap_reg_range(SX9310_REG_SAR_CTRL0, SX9310_REG_SAR_CTRL2),
  229. regmap_reg_range(SX9310_REG_SENSOR_SEL, SX9310_REG_SAR_LSB),
  230. regmap_reg_range(SX9310_REG_I2C_ADDR, SX9310_REG_WHOAMI),
  231. regmap_reg_range(SX9310_REG_RESET, SX9310_REG_RESET),
  232. };
  233. static const struct regmap_access_table sx9310_readable_regs = {
  234. .yes_ranges = sx9310_readable_reg_ranges,
  235. .n_yes_ranges = ARRAY_SIZE(sx9310_readable_reg_ranges),
  236. };
  237. static const struct regmap_range sx9310_volatile_reg_ranges[] = {
  238. regmap_reg_range(SX9310_REG_IRQ_SRC, SX9310_REG_STAT1),
  239. regmap_reg_range(SX9310_REG_USE_MSB, SX9310_REG_DIFF_LSB),
  240. regmap_reg_range(SX9310_REG_SAR_MSB, SX9310_REG_SAR_LSB),
  241. regmap_reg_range(SX9310_REG_RESET, SX9310_REG_RESET),
  242. };
  243. static const struct regmap_access_table sx9310_volatile_regs = {
  244. .yes_ranges = sx9310_volatile_reg_ranges,
  245. .n_yes_ranges = ARRAY_SIZE(sx9310_volatile_reg_ranges),
  246. };
  247. static const struct regmap_config sx9310_regmap_config = {
  248. .reg_bits = 8,
  249. .val_bits = 8,
  250. .max_register = SX9310_REG_RESET,
  251. .cache_type = REGCACHE_RBTREE,
  252. .wr_table = &sx9310_writeable_regs,
  253. .rd_table = &sx9310_readable_regs,
  254. .volatile_table = &sx9310_volatile_regs,
  255. };
  256. static int sx9310_update_chan_en(struct sx9310_data *data,
  257. unsigned long chan_read,
  258. unsigned long chan_event)
  259. {
  260. int ret;
  261. unsigned long channels = chan_read | chan_event;
  262. if ((data->chan_read | data->chan_event) != channels) {
  263. ret = regmap_update_bits(data->regmap, SX9310_REG_PROX_CTRL0,
  264. SX9310_REG_PROX_CTRL0_SENSOREN_MASK,
  265. channels);
  266. if (ret)
  267. return ret;
  268. }
  269. data->chan_read = chan_read;
  270. data->chan_event = chan_event;
  271. return 0;
  272. }
  273. static int sx9310_get_read_channel(struct sx9310_data *data, int channel)
  274. {
  275. return sx9310_update_chan_en(data, data->chan_read | BIT(channel),
  276. data->chan_event);
  277. }
  278. static int sx9310_put_read_channel(struct sx9310_data *data, int channel)
  279. {
  280. return sx9310_update_chan_en(data, data->chan_read & ~BIT(channel),
  281. data->chan_event);
  282. }
  283. static int sx9310_get_event_channel(struct sx9310_data *data, int channel)
  284. {
  285. return sx9310_update_chan_en(data, data->chan_read,
  286. data->chan_event | BIT(channel));
  287. }
  288. static int sx9310_put_event_channel(struct sx9310_data *data, int channel)
  289. {
  290. return sx9310_update_chan_en(data, data->chan_read,
  291. data->chan_event & ~BIT(channel));
  292. }
  293. static int sx9310_enable_irq(struct sx9310_data *data, unsigned int irq)
  294. {
  295. if (!data->client->irq)
  296. return 0;
  297. return regmap_update_bits(data->regmap, SX9310_REG_IRQ_MSK, irq, irq);
  298. }
  299. static int sx9310_disable_irq(struct sx9310_data *data, unsigned int irq)
  300. {
  301. if (!data->client->irq)
  302. return 0;
  303. return regmap_update_bits(data->regmap, SX9310_REG_IRQ_MSK, irq, 0);
  304. }
  305. static int sx9310_read_prox_data(struct sx9310_data *data,
  306. const struct iio_chan_spec *chan, __be16 *val)
  307. {
  308. int ret;
  309. ret = regmap_write(data->regmap, SX9310_REG_SENSOR_SEL, chan->channel);
  310. if (ret)
  311. return ret;
  312. return regmap_bulk_read(data->regmap, chan->address, val, sizeof(*val));
  313. }
  314. /*
  315. * If we have no interrupt support, we have to wait for a scan period
  316. * after enabling a channel to get a result.
  317. */
  318. static int sx9310_wait_for_sample(struct sx9310_data *data)
  319. {
  320. int ret;
  321. unsigned int val;
  322. ret = regmap_read(data->regmap, SX9310_REG_PROX_CTRL0, &val);
  323. if (ret)
  324. return ret;
  325. val = FIELD_GET(SX9310_REG_PROX_CTRL0_SCANPERIOD_MASK, val);
  326. msleep(sx9310_scan_period_table[val]);
  327. return 0;
  328. }
  329. static int sx9310_read_proximity(struct sx9310_data *data,
  330. const struct iio_chan_spec *chan, int *val)
  331. {
  332. int ret;
  333. __be16 rawval;
  334. mutex_lock(&data->mutex);
  335. ret = sx9310_get_read_channel(data, chan->channel);
  336. if (ret)
  337. goto out;
  338. ret = sx9310_enable_irq(data, SX9310_CONVDONE_IRQ);
  339. if (ret)
  340. goto out_put_channel;
  341. mutex_unlock(&data->mutex);
  342. if (data->client->irq) {
  343. ret = wait_for_completion_interruptible(&data->completion);
  344. reinit_completion(&data->completion);
  345. } else {
  346. ret = sx9310_wait_for_sample(data);
  347. }
  348. mutex_lock(&data->mutex);
  349. if (ret)
  350. goto out_disable_irq;
  351. ret = sx9310_read_prox_data(data, chan, &rawval);
  352. if (ret)
  353. goto out_disable_irq;
  354. *val = sign_extend32(be16_to_cpu(rawval),
  355. chan->address == SX9310_REG_DIFF_MSB ? 11 : 15);
  356. ret = sx9310_disable_irq(data, SX9310_CONVDONE_IRQ);
  357. if (ret)
  358. goto out_put_channel;
  359. ret = sx9310_put_read_channel(data, chan->channel);
  360. if (ret)
  361. goto out;
  362. mutex_unlock(&data->mutex);
  363. return IIO_VAL_INT;
  364. out_disable_irq:
  365. sx9310_disable_irq(data, SX9310_CONVDONE_IRQ);
  366. out_put_channel:
  367. sx9310_put_read_channel(data, chan->channel);
  368. out:
  369. mutex_unlock(&data->mutex);
  370. return ret;
  371. }
  372. static int sx9310_read_samp_freq(struct sx9310_data *data, int *val, int *val2)
  373. {
  374. unsigned int regval;
  375. int ret;
  376. ret = regmap_read(data->regmap, SX9310_REG_PROX_CTRL0, &regval);
  377. if (ret)
  378. return ret;
  379. regval = FIELD_GET(SX9310_REG_PROX_CTRL0_SCANPERIOD_MASK, regval);
  380. *val = sx9310_samp_freq_table[regval].val;
  381. *val2 = sx9310_samp_freq_table[regval].val2;
  382. return IIO_VAL_INT_PLUS_MICRO;
  383. }
  384. static int sx9310_read_raw(struct iio_dev *indio_dev,
  385. const struct iio_chan_spec *chan, int *val,
  386. int *val2, long mask)
  387. {
  388. struct sx9310_data *data = iio_priv(indio_dev);
  389. int ret;
  390. if (chan->type != IIO_PROXIMITY)
  391. return -EINVAL;
  392. switch (mask) {
  393. case IIO_CHAN_INFO_RAW:
  394. ret = iio_device_claim_direct_mode(indio_dev);
  395. if (ret)
  396. return ret;
  397. ret = sx9310_read_proximity(data, chan, val);
  398. iio_device_release_direct_mode(indio_dev);
  399. return ret;
  400. case IIO_CHAN_INFO_SAMP_FREQ:
  401. return sx9310_read_samp_freq(data, val, val2);
  402. default:
  403. return -EINVAL;
  404. }
  405. }
  406. static int sx9310_set_samp_freq(struct sx9310_data *data, int val, int val2)
  407. {
  408. int i, ret;
  409. for (i = 0; i < ARRAY_SIZE(sx9310_samp_freq_table); i++)
  410. if (val == sx9310_samp_freq_table[i].val &&
  411. val2 == sx9310_samp_freq_table[i].val2)
  412. break;
  413. if (i == ARRAY_SIZE(sx9310_samp_freq_table))
  414. return -EINVAL;
  415. mutex_lock(&data->mutex);
  416. ret = regmap_update_bits(
  417. data->regmap, SX9310_REG_PROX_CTRL0,
  418. SX9310_REG_PROX_CTRL0_SCANPERIOD_MASK,
  419. FIELD_PREP(SX9310_REG_PROX_CTRL0_SCANPERIOD_MASK, i));
  420. mutex_unlock(&data->mutex);
  421. return ret;
  422. }
  423. static int sx9310_write_raw(struct iio_dev *indio_dev,
  424. const struct iio_chan_spec *chan, int val, int val2,
  425. long mask)
  426. {
  427. struct sx9310_data *data = iio_priv(indio_dev);
  428. if (chan->type != IIO_PROXIMITY)
  429. return -EINVAL;
  430. if (mask != IIO_CHAN_INFO_SAMP_FREQ)
  431. return -EINVAL;
  432. return sx9310_set_samp_freq(data, val, val2);
  433. }
  434. static irqreturn_t sx9310_irq_handler(int irq, void *private)
  435. {
  436. struct iio_dev *indio_dev = private;
  437. struct sx9310_data *data = iio_priv(indio_dev);
  438. if (data->trigger_enabled)
  439. iio_trigger_poll(data->trig);
  440. /*
  441. * Even if no event is enabled, we need to wake the thread to clear the
  442. * interrupt state by reading SX9310_REG_IRQ_SRC.
  443. * It is not possible to do that here because regmap_read takes a mutex.
  444. */
  445. return IRQ_WAKE_THREAD;
  446. }
  447. static void sx9310_push_events(struct iio_dev *indio_dev)
  448. {
  449. int ret;
  450. unsigned int val, chan;
  451. struct sx9310_data *data = iio_priv(indio_dev);
  452. s64 timestamp = iio_get_time_ns(indio_dev);
  453. unsigned long prox_changed;
  454. /* Read proximity state on all channels */
  455. ret = regmap_read(data->regmap, SX9310_REG_STAT0, &val);
  456. if (ret) {
  457. dev_err(&data->client->dev, "i2c transfer error in irq\n");
  458. return;
  459. }
  460. /*
  461. * Only iterate over channels with changes on proximity status that have
  462. * events enabled.
  463. */
  464. prox_changed = (data->chan_prox_stat ^ val) & data->chan_event;
  465. for_each_set_bit(chan, &prox_changed, SX9310_NUM_CHANNELS) {
  466. int dir;
  467. u64 ev;
  468. dir = (val & BIT(chan)) ? IIO_EV_DIR_FALLING : IIO_EV_DIR_RISING;
  469. ev = IIO_UNMOD_EVENT_CODE(IIO_PROXIMITY, chan,
  470. IIO_EV_TYPE_THRESH, dir);
  471. iio_push_event(indio_dev, ev, timestamp);
  472. }
  473. data->chan_prox_stat = val;
  474. }
  475. static irqreturn_t sx9310_irq_thread_handler(int irq, void *private)
  476. {
  477. struct iio_dev *indio_dev = private;
  478. struct sx9310_data *data = iio_priv(indio_dev);
  479. int ret;
  480. unsigned int val;
  481. mutex_lock(&data->mutex);
  482. ret = regmap_read(data->regmap, SX9310_REG_IRQ_SRC, &val);
  483. if (ret) {
  484. dev_err(&data->client->dev, "i2c transfer error in irq\n");
  485. goto out;
  486. }
  487. if (val & (SX9310_FAR_IRQ | SX9310_CLOSE_IRQ))
  488. sx9310_push_events(indio_dev);
  489. if (val & SX9310_CONVDONE_IRQ)
  490. complete(&data->completion);
  491. out:
  492. mutex_unlock(&data->mutex);
  493. return IRQ_HANDLED;
  494. }
  495. static int sx9310_read_event_config(struct iio_dev *indio_dev,
  496. const struct iio_chan_spec *chan,
  497. enum iio_event_type type,
  498. enum iio_event_direction dir)
  499. {
  500. struct sx9310_data *data = iio_priv(indio_dev);
  501. return !!(data->chan_event & BIT(chan->channel));
  502. }
  503. static int sx9310_write_event_config(struct iio_dev *indio_dev,
  504. const struct iio_chan_spec *chan,
  505. enum iio_event_type type,
  506. enum iio_event_direction dir, int state)
  507. {
  508. struct sx9310_data *data = iio_priv(indio_dev);
  509. unsigned int eventirq = SX9310_FAR_IRQ | SX9310_CLOSE_IRQ;
  510. int ret;
  511. /* If the state hasn't changed, there's nothing to do. */
  512. if (!!(data->chan_event & BIT(chan->channel)) == state)
  513. return 0;
  514. mutex_lock(&data->mutex);
  515. if (state) {
  516. ret = sx9310_get_event_channel(data, chan->channel);
  517. if (ret)
  518. goto out_unlock;
  519. if (!(data->chan_event & ~BIT(chan->channel))) {
  520. ret = sx9310_enable_irq(data, eventirq);
  521. if (ret)
  522. sx9310_put_event_channel(data, chan->channel);
  523. }
  524. } else {
  525. ret = sx9310_put_event_channel(data, chan->channel);
  526. if (ret)
  527. goto out_unlock;
  528. if (!data->chan_event) {
  529. ret = sx9310_disable_irq(data, eventirq);
  530. if (ret)
  531. sx9310_get_event_channel(data, chan->channel);
  532. }
  533. }
  534. out_unlock:
  535. mutex_unlock(&data->mutex);
  536. return ret;
  537. }
  538. static struct attribute *sx9310_attributes[] = {
  539. &iio_dev_attr_sampling_frequency_available.dev_attr.attr,
  540. NULL
  541. };
  542. static const struct attribute_group sx9310_attribute_group = {
  543. .attrs = sx9310_attributes,
  544. };
  545. static const struct iio_info sx9310_info = {
  546. .attrs = &sx9310_attribute_group,
  547. .read_raw = sx9310_read_raw,
  548. .write_raw = sx9310_write_raw,
  549. .read_event_config = sx9310_read_event_config,
  550. .write_event_config = sx9310_write_event_config,
  551. };
  552. static int sx9310_set_trigger_state(struct iio_trigger *trig, bool state)
  553. {
  554. struct iio_dev *indio_dev = iio_trigger_get_drvdata(trig);
  555. struct sx9310_data *data = iio_priv(indio_dev);
  556. int ret = 0;
  557. mutex_lock(&data->mutex);
  558. if (state)
  559. ret = sx9310_enable_irq(data, SX9310_CONVDONE_IRQ);
  560. else if (!data->chan_read)
  561. ret = sx9310_disable_irq(data, SX9310_CONVDONE_IRQ);
  562. if (ret)
  563. goto out;
  564. data->trigger_enabled = state;
  565. out:
  566. mutex_unlock(&data->mutex);
  567. return ret;
  568. }
  569. static const struct iio_trigger_ops sx9310_trigger_ops = {
  570. .set_trigger_state = sx9310_set_trigger_state,
  571. };
  572. static irqreturn_t sx9310_trigger_handler(int irq, void *private)
  573. {
  574. struct iio_poll_func *pf = private;
  575. struct iio_dev *indio_dev = pf->indio_dev;
  576. struct sx9310_data *data = iio_priv(indio_dev);
  577. __be16 val;
  578. int bit, ret, i = 0;
  579. mutex_lock(&data->mutex);
  580. for_each_set_bit(bit, indio_dev->active_scan_mask,
  581. indio_dev->masklength) {
  582. ret = sx9310_read_prox_data(data, &indio_dev->channels[bit],
  583. &val);
  584. if (ret)
  585. goto out;
  586. data->buffer.channels[i++] = val;
  587. }
  588. iio_push_to_buffers_with_timestamp(indio_dev, &data->buffer,
  589. pf->timestamp);
  590. out:
  591. mutex_unlock(&data->mutex);
  592. iio_trigger_notify_done(indio_dev->trig);
  593. return IRQ_HANDLED;
  594. }
  595. static int sx9310_buffer_preenable(struct iio_dev *indio_dev)
  596. {
  597. struct sx9310_data *data = iio_priv(indio_dev);
  598. unsigned long channels = 0;
  599. int bit, ret;
  600. mutex_lock(&data->mutex);
  601. for_each_set_bit(bit, indio_dev->active_scan_mask,
  602. indio_dev->masklength)
  603. __set_bit(indio_dev->channels[bit].channel, &channels);
  604. ret = sx9310_update_chan_en(data, channels, data->chan_event);
  605. mutex_unlock(&data->mutex);
  606. return ret;
  607. }
  608. static int sx9310_buffer_postdisable(struct iio_dev *indio_dev)
  609. {
  610. struct sx9310_data *data = iio_priv(indio_dev);
  611. int ret;
  612. mutex_lock(&data->mutex);
  613. ret = sx9310_update_chan_en(data, 0, data->chan_event);
  614. mutex_unlock(&data->mutex);
  615. return ret;
  616. }
  617. static const struct iio_buffer_setup_ops sx9310_buffer_setup_ops = {
  618. .preenable = sx9310_buffer_preenable,
  619. .postdisable = sx9310_buffer_postdisable,
  620. };
  621. struct sx9310_reg_default {
  622. u8 reg;
  623. u8 def;
  624. };
  625. static const struct sx9310_reg_default sx9310_default_regs[] = {
  626. { SX9310_REG_IRQ_MSK, 0x00 },
  627. { SX9310_REG_IRQ_FUNC, 0x00 },
  628. /*
  629. * The lower 4 bits should not be set as it enable sensors measurements.
  630. * Turning the detection on before the configuration values are set to
  631. * good values can cause the device to return erroneous readings.
  632. */
  633. { SX9310_REG_PROX_CTRL0, SX9310_REG_PROX_CTRL0_SCANPERIOD_15MS },
  634. { SX9310_REG_PROX_CTRL1, 0x00 },
  635. { SX9310_REG_PROX_CTRL2, SX9310_REG_PROX_CTRL2_COMBMODE_CS1_CS2 |
  636. SX9310_REG_PROX_CTRL2_SHIELDEN_DYNAMIC },
  637. { SX9310_REG_PROX_CTRL3, SX9310_REG_PROX_CTRL3_GAIN0_X8 |
  638. SX9310_REG_PROX_CTRL3_GAIN12_X4 },
  639. { SX9310_REG_PROX_CTRL4, SX9310_REG_PROX_CTRL4_RESOLUTION_FINEST },
  640. { SX9310_REG_PROX_CTRL5, SX9310_REG_PROX_CTRL5_RANGE_SMALL |
  641. SX9310_REG_PROX_CTRL5_STARTUPSENS_CS1 |
  642. SX9310_REG_PROX_CTRL5_RAWFILT_1P25 },
  643. { SX9310_REG_PROX_CTRL6, SX9310_REG_PROX_CTRL6_AVGTHRESH_DEFAULT },
  644. { SX9310_REG_PROX_CTRL7, SX9310_REG_PROX_CTRL7_AVGNEGFILT_2 |
  645. SX9310_REG_PROX_CTRL7_AVGPOSFILT_512 },
  646. { SX9310_REG_PROX_CTRL8, SX9310_REG_PROX_CTRL8_9_PTHRESH_96 |
  647. SX9310_REG_PROX_CTRL8_9_BODYTHRESH_1500 },
  648. { SX9310_REG_PROX_CTRL9, SX9310_REG_PROX_CTRL8_9_PTHRESH_28 |
  649. SX9310_REG_PROX_CTRL8_9_BODYTHRESH_900 },
  650. { SX9310_REG_PROX_CTRL10, SX9310_REG_PROX_CTRL10_HYST_6PCT |
  651. SX9310_REG_PROX_CTRL10_FAR_DEBOUNCE_2 },
  652. { SX9310_REG_PROX_CTRL11, 0x00 },
  653. { SX9310_REG_PROX_CTRL12, 0x00 },
  654. { SX9310_REG_PROX_CTRL13, 0x00 },
  655. { SX9310_REG_PROX_CTRL14, 0x00 },
  656. { SX9310_REG_PROX_CTRL15, 0x00 },
  657. { SX9310_REG_PROX_CTRL16, 0x00 },
  658. { SX9310_REG_PROX_CTRL17, 0x00 },
  659. { SX9310_REG_PROX_CTRL18, 0x00 },
  660. { SX9310_REG_PROX_CTRL19, 0x00 },
  661. { SX9310_REG_SAR_CTRL0, SX9310_REG_SAR_CTRL0_SARDEB_4_SAMPLES |
  662. SX9310_REG_SAR_CTRL0_SARHYST_8 },
  663. { SX9310_REG_SAR_CTRL1, SX9310_REG_SAR_CTRL1_SLOPE(10781250) },
  664. { SX9310_REG_SAR_CTRL2, SX9310_REG_SAR_CTRL2_SAROFFSET_DEFAULT },
  665. };
  666. /* Activate all channels and perform an initial compensation. */
  667. static int sx9310_init_compensation(struct iio_dev *indio_dev)
  668. {
  669. struct sx9310_data *data = iio_priv(indio_dev);
  670. int ret;
  671. unsigned int val;
  672. unsigned int ctrl0;
  673. ret = regmap_read(data->regmap, SX9310_REG_PROX_CTRL0, &ctrl0);
  674. if (ret)
  675. return ret;
  676. /* run the compensation phase on all channels */
  677. ret = regmap_write(data->regmap, SX9310_REG_PROX_CTRL0,
  678. ctrl0 | SX9310_REG_PROX_CTRL0_SENSOREN_MASK);
  679. if (ret)
  680. return ret;
  681. ret = regmap_read_poll_timeout(data->regmap, SX9310_REG_STAT1, val,
  682. !(val & SX9310_REG_STAT1_COMPSTAT_MASK),
  683. 20000, 2000000);
  684. if (ret) {
  685. if (ret == -ETIMEDOUT)
  686. dev_err(&data->client->dev,
  687. "initial compensation timed out: 0x%02x\n",
  688. val);
  689. return ret;
  690. }
  691. regmap_write(data->regmap, SX9310_REG_PROX_CTRL0, ctrl0);
  692. return ret;
  693. }
  694. static int sx9310_init_device(struct iio_dev *indio_dev)
  695. {
  696. struct sx9310_data *data = iio_priv(indio_dev);
  697. const struct sx9310_reg_default *initval;
  698. int ret;
  699. unsigned int i, val;
  700. ret = regmap_write(data->regmap, SX9310_REG_RESET, SX9310_SOFT_RESET);
  701. if (ret)
  702. return ret;
  703. usleep_range(1000, 2000); /* power-up time is ~1ms. */
  704. /* Clear reset interrupt state by reading SX9310_REG_IRQ_SRC. */
  705. ret = regmap_read(data->regmap, SX9310_REG_IRQ_SRC, &val);
  706. if (ret)
  707. return ret;
  708. /* Program some sane defaults. */
  709. for (i = 0; i < ARRAY_SIZE(sx9310_default_regs); i++) {
  710. initval = &sx9310_default_regs[i];
  711. ret = regmap_write(data->regmap, initval->reg, initval->def);
  712. if (ret)
  713. return ret;
  714. }
  715. return sx9310_init_compensation(indio_dev);
  716. }
  717. static int sx9310_set_indio_dev_name(struct device *dev,
  718. struct iio_dev *indio_dev,
  719. unsigned int whoami)
  720. {
  721. unsigned int long ddata;
  722. ddata = (uintptr_t)device_get_match_data(dev);
  723. if (ddata != whoami) {
  724. dev_err(dev, "WHOAMI does not match device data: %u\n", whoami);
  725. return -ENODEV;
  726. }
  727. switch (whoami) {
  728. case SX9310_WHOAMI_VALUE:
  729. indio_dev->name = "sx9310";
  730. break;
  731. case SX9311_WHOAMI_VALUE:
  732. indio_dev->name = "sx9311";
  733. break;
  734. default:
  735. dev_err(dev, "unexpected WHOAMI response: %u\n", whoami);
  736. return -ENODEV;
  737. }
  738. return 0;
  739. }
  740. static void sx9310_regulator_disable(void *_data)
  741. {
  742. struct sx9310_data *data = _data;
  743. regulator_bulk_disable(ARRAY_SIZE(data->supplies), data->supplies);
  744. }
  745. static int sx9310_probe(struct i2c_client *client)
  746. {
  747. int ret;
  748. struct device *dev = &client->dev;
  749. struct iio_dev *indio_dev;
  750. struct sx9310_data *data;
  751. indio_dev = devm_iio_device_alloc(dev, sizeof(*data));
  752. if (!indio_dev)
  753. return -ENOMEM;
  754. data = iio_priv(indio_dev);
  755. data->client = client;
  756. data->supplies[0].supply = "vdd";
  757. data->supplies[1].supply = "svdd";
  758. mutex_init(&data->mutex);
  759. init_completion(&data->completion);
  760. data->regmap = devm_regmap_init_i2c(client, &sx9310_regmap_config);
  761. if (IS_ERR(data->regmap))
  762. return PTR_ERR(data->regmap);
  763. ret = devm_regulator_bulk_get(dev, ARRAY_SIZE(data->supplies),
  764. data->supplies);
  765. if (ret)
  766. return ret;
  767. ret = regulator_bulk_enable(ARRAY_SIZE(data->supplies), data->supplies);
  768. if (ret)
  769. return ret;
  770. /* Must wait for Tpor time after initial power up */
  771. usleep_range(1000, 1100);
  772. ret = devm_add_action_or_reset(dev, sx9310_regulator_disable, data);
  773. if (ret)
  774. return ret;
  775. ret = regmap_read(data->regmap, SX9310_REG_WHOAMI, &data->whoami);
  776. if (ret) {
  777. dev_err(dev, "error in reading WHOAMI register: %d", ret);
  778. return ret;
  779. }
  780. ret = sx9310_set_indio_dev_name(dev, indio_dev, data->whoami);
  781. if (ret)
  782. return ret;
  783. ACPI_COMPANION_SET(&indio_dev->dev, ACPI_COMPANION(dev));
  784. indio_dev->channels = sx9310_channels;
  785. indio_dev->num_channels = ARRAY_SIZE(sx9310_channels);
  786. indio_dev->info = &sx9310_info;
  787. indio_dev->modes = INDIO_DIRECT_MODE;
  788. i2c_set_clientdata(client, indio_dev);
  789. ret = sx9310_init_device(indio_dev);
  790. if (ret)
  791. return ret;
  792. if (client->irq) {
  793. ret = devm_request_threaded_irq(dev, client->irq,
  794. sx9310_irq_handler,
  795. sx9310_irq_thread_handler,
  796. IRQF_ONESHOT,
  797. "sx9310_event", indio_dev);
  798. if (ret)
  799. return ret;
  800. data->trig = devm_iio_trigger_alloc(dev, "%s-dev%d",
  801. indio_dev->name,
  802. indio_dev->id);
  803. if (!data->trig)
  804. return -ENOMEM;
  805. data->trig->dev.parent = dev;
  806. data->trig->ops = &sx9310_trigger_ops;
  807. iio_trigger_set_drvdata(data->trig, indio_dev);
  808. ret = devm_iio_trigger_register(dev, data->trig);
  809. if (ret)
  810. return ret;
  811. }
  812. ret = devm_iio_triggered_buffer_setup(dev, indio_dev,
  813. iio_pollfunc_store_time,
  814. sx9310_trigger_handler,
  815. &sx9310_buffer_setup_ops);
  816. if (ret)
  817. return ret;
  818. return devm_iio_device_register(dev, indio_dev);
  819. }
  820. static int __maybe_unused sx9310_suspend(struct device *dev)
  821. {
  822. struct iio_dev *indio_dev = i2c_get_clientdata(to_i2c_client(dev));
  823. struct sx9310_data *data = iio_priv(indio_dev);
  824. u8 ctrl0;
  825. int ret;
  826. disable_irq_nosync(data->client->irq);
  827. mutex_lock(&data->mutex);
  828. ret = regmap_read(data->regmap, SX9310_REG_PROX_CTRL0,
  829. &data->suspend_ctrl0);
  830. if (ret)
  831. goto out;
  832. ctrl0 = data->suspend_ctrl0 & ~SX9310_REG_PROX_CTRL0_SENSOREN_MASK;
  833. ret = regmap_write(data->regmap, SX9310_REG_PROX_CTRL0, ctrl0);
  834. if (ret)
  835. goto out;
  836. ret = regmap_write(data->regmap, SX9310_REG_PAUSE, 0);
  837. out:
  838. mutex_unlock(&data->mutex);
  839. return ret;
  840. }
  841. static int __maybe_unused sx9310_resume(struct device *dev)
  842. {
  843. struct iio_dev *indio_dev = i2c_get_clientdata(to_i2c_client(dev));
  844. struct sx9310_data *data = iio_priv(indio_dev);
  845. int ret;
  846. mutex_lock(&data->mutex);
  847. ret = regmap_write(data->regmap, SX9310_REG_PAUSE, 1);
  848. if (ret)
  849. goto out;
  850. ret = regmap_write(data->regmap, SX9310_REG_PROX_CTRL0,
  851. data->suspend_ctrl0);
  852. out:
  853. mutex_unlock(&data->mutex);
  854. if (ret)
  855. return ret;
  856. enable_irq(data->client->irq);
  857. return 0;
  858. }
  859. static const struct dev_pm_ops sx9310_pm_ops = {
  860. SET_SYSTEM_SLEEP_PM_OPS(sx9310_suspend, sx9310_resume)
  861. };
  862. static const struct acpi_device_id sx9310_acpi_match[] = {
  863. { "STH9310", SX9310_WHOAMI_VALUE },
  864. { "STH9311", SX9311_WHOAMI_VALUE },
  865. {}
  866. };
  867. MODULE_DEVICE_TABLE(acpi, sx9310_acpi_match);
  868. static const struct of_device_id sx9310_of_match[] = {
  869. { .compatible = "semtech,sx9310", (void *)SX9310_WHOAMI_VALUE },
  870. { .compatible = "semtech,sx9311", (void *)SX9311_WHOAMI_VALUE },
  871. {}
  872. };
  873. MODULE_DEVICE_TABLE(of, sx9310_of_match);
  874. static const struct i2c_device_id sx9310_id[] = {
  875. { "sx9310", SX9310_WHOAMI_VALUE },
  876. { "sx9311", SX9311_WHOAMI_VALUE },
  877. {}
  878. };
  879. MODULE_DEVICE_TABLE(i2c, sx9310_id);
  880. static struct i2c_driver sx9310_driver = {
  881. .driver = {
  882. .name = "sx9310",
  883. .acpi_match_table = sx9310_acpi_match,
  884. .of_match_table = sx9310_of_match,
  885. .pm = &sx9310_pm_ops,
  886. /*
  887. * Lots of i2c transfers in probe + over 200 ms waiting in
  888. * sx9310_init_compensation() mean a slow probe; prefer async
  889. * so we don't delay boot if we're builtin to the kernel.
  890. */
  891. .probe_type = PROBE_PREFER_ASYNCHRONOUS,
  892. },
  893. .probe_new = sx9310_probe,
  894. .id_table = sx9310_id,
  895. };
  896. module_i2c_driver(sx9310_driver);
  897. MODULE_AUTHOR("Gwendal Grignou <gwendal@chromium.org>");
  898. MODULE_AUTHOR("Daniel Campello <campello@chromium.org>");
  899. MODULE_DESCRIPTION("Driver for Semtech SX9310/SX9311 proximity sensor");
  900. MODULE_LICENSE("GPL v2");