jsa1212.c 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452
  1. // SPDX-License-Identifier: GPL-2.0-only
  2. /*
  3. * JSA1212 Ambient Light & Proximity Sensor Driver
  4. *
  5. * Copyright (c) 2014, Intel Corporation.
  6. *
  7. * JSA1212 I2C slave address: 0x44(ADDR tied to GND), 0x45(ADDR tied to VDD)
  8. *
  9. * TODO: Interrupt support, thresholds, range support.
  10. */
  11. #include <linux/kernel.h>
  12. #include <linux/slab.h>
  13. #include <linux/module.h>
  14. #include <linux/delay.h>
  15. #include <linux/i2c.h>
  16. #include <linux/mutex.h>
  17. #include <linux/acpi.h>
  18. #include <linux/regmap.h>
  19. #include <linux/iio/iio.h>
  20. #include <linux/iio/sysfs.h>
  21. /* JSA1212 reg address */
  22. #define JSA1212_CONF_REG 0x01
  23. #define JSA1212_INT_REG 0x02
  24. #define JSA1212_PXS_LT_REG 0x03
  25. #define JSA1212_PXS_HT_REG 0x04
  26. #define JSA1212_ALS_TH1_REG 0x05
  27. #define JSA1212_ALS_TH2_REG 0x06
  28. #define JSA1212_ALS_TH3_REG 0x07
  29. #define JSA1212_PXS_DATA_REG 0x08
  30. #define JSA1212_ALS_DT1_REG 0x09
  31. #define JSA1212_ALS_DT2_REG 0x0A
  32. #define JSA1212_ALS_RNG_REG 0x0B
  33. #define JSA1212_MAX_REG 0x0C
  34. /* JSA1212 reg masks */
  35. #define JSA1212_CONF_MASK 0xFF
  36. #define JSA1212_INT_MASK 0xFF
  37. #define JSA1212_PXS_LT_MASK 0xFF
  38. #define JSA1212_PXS_HT_MASK 0xFF
  39. #define JSA1212_ALS_TH1_MASK 0xFF
  40. #define JSA1212_ALS_TH2_LT_MASK 0x0F
  41. #define JSA1212_ALS_TH2_HT_MASK 0xF0
  42. #define JSA1212_ALS_TH3_MASK 0xFF
  43. #define JSA1212_PXS_DATA_MASK 0xFF
  44. #define JSA1212_ALS_DATA_MASK 0x0FFF
  45. #define JSA1212_ALS_DT1_MASK 0xFF
  46. #define JSA1212_ALS_DT2_MASK 0x0F
  47. #define JSA1212_ALS_RNG_MASK 0x07
  48. /* JSA1212 CONF REG bits */
  49. #define JSA1212_CONF_PXS_MASK 0x80
  50. #define JSA1212_CONF_PXS_ENABLE 0x80
  51. #define JSA1212_CONF_PXS_DISABLE 0x00
  52. #define JSA1212_CONF_ALS_MASK 0x04
  53. #define JSA1212_CONF_ALS_ENABLE 0x04
  54. #define JSA1212_CONF_ALS_DISABLE 0x00
  55. #define JSA1212_CONF_IRDR_MASK 0x08
  56. /* Proxmity sensing IRDR current sink settings */
  57. #define JSA1212_CONF_IRDR_200MA 0x08
  58. #define JSA1212_CONF_IRDR_100MA 0x00
  59. #define JSA1212_CONF_PXS_SLP_MASK 0x70
  60. #define JSA1212_CONF_PXS_SLP_0MS 0x70
  61. #define JSA1212_CONF_PXS_SLP_12MS 0x60
  62. #define JSA1212_CONF_PXS_SLP_50MS 0x50
  63. #define JSA1212_CONF_PXS_SLP_75MS 0x40
  64. #define JSA1212_CONF_PXS_SLP_100MS 0x30
  65. #define JSA1212_CONF_PXS_SLP_200MS 0x20
  66. #define JSA1212_CONF_PXS_SLP_400MS 0x10
  67. #define JSA1212_CONF_PXS_SLP_800MS 0x00
  68. /* JSA1212 INT REG bits */
  69. #define JSA1212_INT_CTRL_MASK 0x01
  70. #define JSA1212_INT_CTRL_EITHER 0x00
  71. #define JSA1212_INT_CTRL_BOTH 0x01
  72. #define JSA1212_INT_ALS_PRST_MASK 0x06
  73. #define JSA1212_INT_ALS_PRST_1CONV 0x00
  74. #define JSA1212_INT_ALS_PRST_4CONV 0x02
  75. #define JSA1212_INT_ALS_PRST_8CONV 0x04
  76. #define JSA1212_INT_ALS_PRST_16CONV 0x06
  77. #define JSA1212_INT_ALS_FLAG_MASK 0x08
  78. #define JSA1212_INT_ALS_FLAG_CLR 0x00
  79. #define JSA1212_INT_PXS_PRST_MASK 0x60
  80. #define JSA1212_INT_PXS_PRST_1CONV 0x00
  81. #define JSA1212_INT_PXS_PRST_4CONV 0x20
  82. #define JSA1212_INT_PXS_PRST_8CONV 0x40
  83. #define JSA1212_INT_PXS_PRST_16CONV 0x60
  84. #define JSA1212_INT_PXS_FLAG_MASK 0x80
  85. #define JSA1212_INT_PXS_FLAG_CLR 0x00
  86. /* JSA1212 ALS RNG REG bits */
  87. #define JSA1212_ALS_RNG_0_2048 0x00
  88. #define JSA1212_ALS_RNG_0_1024 0x01
  89. #define JSA1212_ALS_RNG_0_512 0x02
  90. #define JSA1212_ALS_RNG_0_256 0x03
  91. #define JSA1212_ALS_RNG_0_128 0x04
  92. /* JSA1212 INT threshold range */
  93. #define JSA1212_ALS_TH_MIN 0x0000
  94. #define JSA1212_ALS_TH_MAX 0x0FFF
  95. #define JSA1212_PXS_TH_MIN 0x00
  96. #define JSA1212_PXS_TH_MAX 0xFF
  97. #define JSA1212_ALS_DELAY_MS 200
  98. #define JSA1212_PXS_DELAY_MS 100
  99. #define JSA1212_DRIVER_NAME "jsa1212"
  100. #define JSA1212_REGMAP_NAME "jsa1212_regmap"
  101. enum jsa1212_op_mode {
  102. JSA1212_OPMODE_ALS_EN,
  103. JSA1212_OPMODE_PXS_EN,
  104. };
  105. struct jsa1212_data {
  106. struct i2c_client *client;
  107. struct mutex lock;
  108. u8 als_rng_idx;
  109. bool als_en; /* ALS enable status */
  110. bool pxs_en; /* proximity enable status */
  111. struct regmap *regmap;
  112. };
  113. /* ALS range idx to val mapping */
  114. static const int jsa1212_als_range_val[] = {2048, 1024, 512, 256, 128,
  115. 128, 128, 128};
  116. /* Enables or disables ALS function based on status */
  117. static int jsa1212_als_enable(struct jsa1212_data *data, u8 status)
  118. {
  119. int ret;
  120. ret = regmap_update_bits(data->regmap, JSA1212_CONF_REG,
  121. JSA1212_CONF_ALS_MASK,
  122. status);
  123. if (ret < 0)
  124. return ret;
  125. data->als_en = !!status;
  126. return 0;
  127. }
  128. /* Enables or disables PXS function based on status */
  129. static int jsa1212_pxs_enable(struct jsa1212_data *data, u8 status)
  130. {
  131. int ret;
  132. ret = regmap_update_bits(data->regmap, JSA1212_CONF_REG,
  133. JSA1212_CONF_PXS_MASK,
  134. status);
  135. if (ret < 0)
  136. return ret;
  137. data->pxs_en = !!status;
  138. return 0;
  139. }
  140. static int jsa1212_read_als_data(struct jsa1212_data *data,
  141. unsigned int *val)
  142. {
  143. int ret;
  144. __le16 als_data;
  145. ret = jsa1212_als_enable(data, JSA1212_CONF_ALS_ENABLE);
  146. if (ret < 0)
  147. return ret;
  148. /* Delay for data output */
  149. msleep(JSA1212_ALS_DELAY_MS);
  150. /* Read 12 bit data */
  151. ret = regmap_bulk_read(data->regmap, JSA1212_ALS_DT1_REG, &als_data, 2);
  152. if (ret < 0) {
  153. dev_err(&data->client->dev, "als data read err\n");
  154. goto als_data_read_err;
  155. }
  156. *val = le16_to_cpu(als_data);
  157. als_data_read_err:
  158. return jsa1212_als_enable(data, JSA1212_CONF_ALS_DISABLE);
  159. }
  160. static int jsa1212_read_pxs_data(struct jsa1212_data *data,
  161. unsigned int *val)
  162. {
  163. int ret;
  164. unsigned int pxs_data;
  165. ret = jsa1212_pxs_enable(data, JSA1212_CONF_PXS_ENABLE);
  166. if (ret < 0)
  167. return ret;
  168. /* Delay for data output */
  169. msleep(JSA1212_PXS_DELAY_MS);
  170. /* Read out all data */
  171. ret = regmap_read(data->regmap, JSA1212_PXS_DATA_REG, &pxs_data);
  172. if (ret < 0) {
  173. dev_err(&data->client->dev, "pxs data read err\n");
  174. goto pxs_data_read_err;
  175. }
  176. *val = pxs_data & JSA1212_PXS_DATA_MASK;
  177. pxs_data_read_err:
  178. return jsa1212_pxs_enable(data, JSA1212_CONF_PXS_DISABLE);
  179. }
  180. static int jsa1212_read_raw(struct iio_dev *indio_dev,
  181. struct iio_chan_spec const *chan,
  182. int *val, int *val2, long mask)
  183. {
  184. int ret;
  185. struct jsa1212_data *data = iio_priv(indio_dev);
  186. switch (mask) {
  187. case IIO_CHAN_INFO_RAW:
  188. mutex_lock(&data->lock);
  189. switch (chan->type) {
  190. case IIO_LIGHT:
  191. ret = jsa1212_read_als_data(data, val);
  192. break;
  193. case IIO_PROXIMITY:
  194. ret = jsa1212_read_pxs_data(data, val);
  195. break;
  196. default:
  197. ret = -EINVAL;
  198. break;
  199. }
  200. mutex_unlock(&data->lock);
  201. return ret < 0 ? ret : IIO_VAL_INT;
  202. case IIO_CHAN_INFO_SCALE:
  203. switch (chan->type) {
  204. case IIO_LIGHT:
  205. *val = jsa1212_als_range_val[data->als_rng_idx];
  206. *val2 = BIT(12); /* Max 12 bit value */
  207. return IIO_VAL_FRACTIONAL;
  208. default:
  209. break;
  210. }
  211. break;
  212. default:
  213. break;
  214. }
  215. return -EINVAL;
  216. }
  217. static const struct iio_chan_spec jsa1212_channels[] = {
  218. {
  219. .type = IIO_LIGHT,
  220. .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) |
  221. BIT(IIO_CHAN_INFO_SCALE),
  222. },
  223. {
  224. .type = IIO_PROXIMITY,
  225. .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
  226. }
  227. };
  228. static const struct iio_info jsa1212_info = {
  229. .read_raw = &jsa1212_read_raw,
  230. };
  231. static int jsa1212_chip_init(struct jsa1212_data *data)
  232. {
  233. int ret;
  234. ret = regmap_write(data->regmap, JSA1212_CONF_REG,
  235. (JSA1212_CONF_PXS_SLP_50MS |
  236. JSA1212_CONF_IRDR_200MA));
  237. if (ret < 0)
  238. return ret;
  239. ret = regmap_write(data->regmap, JSA1212_INT_REG,
  240. JSA1212_INT_ALS_PRST_4CONV);
  241. if (ret < 0)
  242. return ret;
  243. data->als_rng_idx = JSA1212_ALS_RNG_0_2048;
  244. return 0;
  245. }
  246. static bool jsa1212_is_volatile_reg(struct device *dev, unsigned int reg)
  247. {
  248. switch (reg) {
  249. case JSA1212_PXS_DATA_REG:
  250. case JSA1212_ALS_DT1_REG:
  251. case JSA1212_ALS_DT2_REG:
  252. case JSA1212_INT_REG:
  253. return true;
  254. default:
  255. return false;
  256. }
  257. }
  258. static const struct regmap_config jsa1212_regmap_config = {
  259. .name = JSA1212_REGMAP_NAME,
  260. .reg_bits = 8,
  261. .val_bits = 8,
  262. .max_register = JSA1212_MAX_REG,
  263. .cache_type = REGCACHE_RBTREE,
  264. .volatile_reg = jsa1212_is_volatile_reg,
  265. };
  266. static int jsa1212_probe(struct i2c_client *client,
  267. const struct i2c_device_id *id)
  268. {
  269. struct jsa1212_data *data;
  270. struct iio_dev *indio_dev;
  271. struct regmap *regmap;
  272. int ret;
  273. indio_dev = devm_iio_device_alloc(&client->dev, sizeof(*data));
  274. if (!indio_dev)
  275. return -ENOMEM;
  276. regmap = devm_regmap_init_i2c(client, &jsa1212_regmap_config);
  277. if (IS_ERR(regmap)) {
  278. dev_err(&client->dev, "Regmap initialization failed.\n");
  279. return PTR_ERR(regmap);
  280. }
  281. data = iio_priv(indio_dev);
  282. i2c_set_clientdata(client, indio_dev);
  283. data->client = client;
  284. data->regmap = regmap;
  285. mutex_init(&data->lock);
  286. ret = jsa1212_chip_init(data);
  287. if (ret < 0)
  288. return ret;
  289. indio_dev->channels = jsa1212_channels;
  290. indio_dev->num_channels = ARRAY_SIZE(jsa1212_channels);
  291. indio_dev->name = JSA1212_DRIVER_NAME;
  292. indio_dev->modes = INDIO_DIRECT_MODE;
  293. indio_dev->info = &jsa1212_info;
  294. ret = iio_device_register(indio_dev);
  295. if (ret < 0)
  296. dev_err(&client->dev, "%s: register device failed\n", __func__);
  297. return ret;
  298. }
  299. /* power off the device */
  300. static int jsa1212_power_off(struct jsa1212_data *data)
  301. {
  302. int ret;
  303. mutex_lock(&data->lock);
  304. ret = regmap_update_bits(data->regmap, JSA1212_CONF_REG,
  305. JSA1212_CONF_ALS_MASK |
  306. JSA1212_CONF_PXS_MASK,
  307. JSA1212_CONF_ALS_DISABLE |
  308. JSA1212_CONF_PXS_DISABLE);
  309. if (ret < 0)
  310. dev_err(&data->client->dev, "power off cmd failed\n");
  311. mutex_unlock(&data->lock);
  312. return ret;
  313. }
  314. static void jsa1212_remove(struct i2c_client *client)
  315. {
  316. struct iio_dev *indio_dev = i2c_get_clientdata(client);
  317. struct jsa1212_data *data = iio_priv(indio_dev);
  318. iio_device_unregister(indio_dev);
  319. jsa1212_power_off(data);
  320. }
  321. static int jsa1212_suspend(struct device *dev)
  322. {
  323. struct jsa1212_data *data;
  324. data = iio_priv(i2c_get_clientdata(to_i2c_client(dev)));
  325. return jsa1212_power_off(data);
  326. }
  327. static int jsa1212_resume(struct device *dev)
  328. {
  329. int ret = 0;
  330. struct jsa1212_data *data;
  331. data = iio_priv(i2c_get_clientdata(to_i2c_client(dev)));
  332. mutex_lock(&data->lock);
  333. if (data->als_en) {
  334. ret = jsa1212_als_enable(data, JSA1212_CONF_ALS_ENABLE);
  335. if (ret < 0) {
  336. dev_err(dev, "als resume failed\n");
  337. goto unlock_and_ret;
  338. }
  339. }
  340. if (data->pxs_en) {
  341. ret = jsa1212_pxs_enable(data, JSA1212_CONF_PXS_ENABLE);
  342. if (ret < 0)
  343. dev_err(dev, "pxs resume failed\n");
  344. }
  345. unlock_and_ret:
  346. mutex_unlock(&data->lock);
  347. return ret;
  348. }
  349. static DEFINE_SIMPLE_DEV_PM_OPS(jsa1212_pm_ops, jsa1212_suspend,
  350. jsa1212_resume);
  351. static const struct acpi_device_id jsa1212_acpi_match[] = {
  352. {"JSA1212", 0},
  353. { },
  354. };
  355. MODULE_DEVICE_TABLE(acpi, jsa1212_acpi_match);
  356. static const struct i2c_device_id jsa1212_id[] = {
  357. { JSA1212_DRIVER_NAME, 0 },
  358. { }
  359. };
  360. MODULE_DEVICE_TABLE(i2c, jsa1212_id);
  361. static struct i2c_driver jsa1212_driver = {
  362. .driver = {
  363. .name = JSA1212_DRIVER_NAME,
  364. .pm = pm_sleep_ptr(&jsa1212_pm_ops),
  365. .acpi_match_table = ACPI_PTR(jsa1212_acpi_match),
  366. },
  367. .probe = jsa1212_probe,
  368. .remove = jsa1212_remove,
  369. .id_table = jsa1212_id,
  370. };
  371. module_i2c_driver(jsa1212_driver);
  372. MODULE_AUTHOR("Sathya Kuppuswamy <[email protected]>");
  373. MODULE_DESCRIPTION("JSA1212 proximity/ambient light sensor driver");
  374. MODULE_LICENSE("GPL v2");