hp03.c 6.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292
  1. // SPDX-License-Identifier: GPL-2.0-only
  2. /*
  3. * Copyright (c) 2016 Marek Vasut <[email protected]>
  4. *
  5. * Driver for Hope RF HP03 digital temperature and pressure sensor.
  6. */
  7. #define pr_fmt(fmt) "hp03: " fmt
  8. #include <linux/module.h>
  9. #include <linux/delay.h>
  10. #include <linux/gpio/consumer.h>
  11. #include <linux/i2c.h>
  12. #include <linux/regmap.h>
  13. #include <linux/iio/iio.h>
  14. #include <linux/iio/sysfs.h>
  15. /*
  16. * The HP03 sensor occupies two fixed I2C addresses:
  17. * 0x50 ... read-only EEPROM with calibration data
  18. * 0x77 ... read-write ADC for pressure and temperature
  19. */
  20. #define HP03_EEPROM_ADDR 0x50
  21. #define HP03_ADC_ADDR 0x77
  22. #define HP03_EEPROM_CX_OFFSET 0x10
  23. #define HP03_EEPROM_AB_OFFSET 0x1e
  24. #define HP03_EEPROM_CD_OFFSET 0x20
  25. #define HP03_ADC_WRITE_REG 0xff
  26. #define HP03_ADC_READ_REG 0xfd
  27. #define HP03_ADC_READ_PRESSURE 0xf0 /* D1 in datasheet */
  28. #define HP03_ADC_READ_TEMP 0xe8 /* D2 in datasheet */
  29. struct hp03_priv {
  30. struct i2c_client *client;
  31. struct mutex lock;
  32. struct gpio_desc *xclr_gpio;
  33. struct i2c_client *eeprom_client;
  34. struct regmap *eeprom_regmap;
  35. s32 pressure; /* kPa */
  36. s32 temp; /* Deg. C */
  37. };
  38. static const struct iio_chan_spec hp03_channels[] = {
  39. {
  40. .type = IIO_PRESSURE,
  41. .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
  42. .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_SCALE),
  43. },
  44. {
  45. .type = IIO_TEMP,
  46. .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
  47. .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_SCALE),
  48. },
  49. };
  50. static bool hp03_is_writeable_reg(struct device *dev, unsigned int reg)
  51. {
  52. return false;
  53. }
  54. static bool hp03_is_volatile_reg(struct device *dev, unsigned int reg)
  55. {
  56. return false;
  57. }
  58. static const struct regmap_config hp03_regmap_config = {
  59. .reg_bits = 8,
  60. .val_bits = 8,
  61. .max_register = HP03_EEPROM_CD_OFFSET + 1,
  62. .cache_type = REGCACHE_RBTREE,
  63. .writeable_reg = hp03_is_writeable_reg,
  64. .volatile_reg = hp03_is_volatile_reg,
  65. };
  66. static int hp03_get_temp_pressure(struct hp03_priv *priv, const u8 reg)
  67. {
  68. int ret;
  69. ret = i2c_smbus_write_byte_data(priv->client, HP03_ADC_WRITE_REG, reg);
  70. if (ret < 0)
  71. return ret;
  72. msleep(50); /* Wait for conversion to finish */
  73. return i2c_smbus_read_word_data(priv->client, HP03_ADC_READ_REG);
  74. }
  75. static int hp03_update_temp_pressure(struct hp03_priv *priv)
  76. {
  77. struct device *dev = &priv->client->dev;
  78. u8 coefs[18];
  79. u16 cx_val[7];
  80. int ab_val, d1_val, d2_val, diff_val, dut, off, sens, x;
  81. int i, ret;
  82. /* Sample coefficients from EEPROM */
  83. ret = regmap_bulk_read(priv->eeprom_regmap, HP03_EEPROM_CX_OFFSET,
  84. coefs, sizeof(coefs));
  85. if (ret < 0) {
  86. dev_err(dev, "Failed to read EEPROM (reg=%02x)\n",
  87. HP03_EEPROM_CX_OFFSET);
  88. return ret;
  89. }
  90. /* Sample Temperature and Pressure */
  91. gpiod_set_value_cansleep(priv->xclr_gpio, 1);
  92. ret = hp03_get_temp_pressure(priv, HP03_ADC_READ_PRESSURE);
  93. if (ret < 0) {
  94. dev_err(dev, "Failed to read pressure\n");
  95. goto err_adc;
  96. }
  97. d1_val = ret;
  98. ret = hp03_get_temp_pressure(priv, HP03_ADC_READ_TEMP);
  99. if (ret < 0) {
  100. dev_err(dev, "Failed to read temperature\n");
  101. goto err_adc;
  102. }
  103. d2_val = ret;
  104. gpiod_set_value_cansleep(priv->xclr_gpio, 0);
  105. /* The Cx coefficients and Temp/Pressure values are MSB first. */
  106. for (i = 0; i < 7; i++)
  107. cx_val[i] = (coefs[2 * i] << 8) | (coefs[(2 * i) + 1] << 0);
  108. d1_val = ((d1_val >> 8) & 0xff) | ((d1_val & 0xff) << 8);
  109. d2_val = ((d2_val >> 8) & 0xff) | ((d2_val & 0xff) << 8);
  110. /* Coefficient voodoo from the HP03 datasheet. */
  111. if (d2_val >= cx_val[4])
  112. ab_val = coefs[14]; /* A-value */
  113. else
  114. ab_val = coefs[15]; /* B-value */
  115. diff_val = d2_val - cx_val[4];
  116. dut = (ab_val * (diff_val >> 7) * (diff_val >> 7)) >> coefs[16];
  117. dut = diff_val - dut;
  118. off = (cx_val[1] + (((cx_val[3] - 1024) * dut) >> 14)) * 4;
  119. sens = cx_val[0] + ((cx_val[2] * dut) >> 10);
  120. x = ((sens * (d1_val - 7168)) >> 14) - off;
  121. priv->pressure = ((x * 100) >> 5) + (cx_val[6] * 10);
  122. priv->temp = 250 + ((dut * cx_val[5]) >> 16) - (dut >> coefs[17]);
  123. return 0;
  124. err_adc:
  125. gpiod_set_value_cansleep(priv->xclr_gpio, 0);
  126. return ret;
  127. }
  128. static int hp03_read_raw(struct iio_dev *indio_dev,
  129. struct iio_chan_spec const *chan,
  130. int *val, int *val2, long mask)
  131. {
  132. struct hp03_priv *priv = iio_priv(indio_dev);
  133. int ret;
  134. mutex_lock(&priv->lock);
  135. ret = hp03_update_temp_pressure(priv);
  136. mutex_unlock(&priv->lock);
  137. if (ret)
  138. return ret;
  139. switch (mask) {
  140. case IIO_CHAN_INFO_RAW:
  141. switch (chan->type) {
  142. case IIO_PRESSURE:
  143. *val = priv->pressure;
  144. return IIO_VAL_INT;
  145. case IIO_TEMP:
  146. *val = priv->temp;
  147. return IIO_VAL_INT;
  148. default:
  149. return -EINVAL;
  150. }
  151. break;
  152. case IIO_CHAN_INFO_SCALE:
  153. switch (chan->type) {
  154. case IIO_PRESSURE:
  155. *val = 0;
  156. *val2 = 1000;
  157. return IIO_VAL_INT_PLUS_MICRO;
  158. case IIO_TEMP:
  159. *val = 10;
  160. return IIO_VAL_INT;
  161. default:
  162. return -EINVAL;
  163. }
  164. break;
  165. default:
  166. return -EINVAL;
  167. }
  168. return -EINVAL;
  169. }
  170. static const struct iio_info hp03_info = {
  171. .read_raw = &hp03_read_raw,
  172. };
  173. static int hp03_probe(struct i2c_client *client,
  174. const struct i2c_device_id *id)
  175. {
  176. struct device *dev = &client->dev;
  177. struct iio_dev *indio_dev;
  178. struct hp03_priv *priv;
  179. int ret;
  180. indio_dev = devm_iio_device_alloc(dev, sizeof(*priv));
  181. if (!indio_dev)
  182. return -ENOMEM;
  183. priv = iio_priv(indio_dev);
  184. priv->client = client;
  185. mutex_init(&priv->lock);
  186. indio_dev->name = id->name;
  187. indio_dev->channels = hp03_channels;
  188. indio_dev->num_channels = ARRAY_SIZE(hp03_channels);
  189. indio_dev->info = &hp03_info;
  190. indio_dev->modes = INDIO_DIRECT_MODE;
  191. priv->xclr_gpio = devm_gpiod_get_index(dev, "xclr", 0, GPIOD_OUT_HIGH);
  192. if (IS_ERR(priv->xclr_gpio)) {
  193. dev_err(dev, "Failed to claim XCLR GPIO\n");
  194. ret = PTR_ERR(priv->xclr_gpio);
  195. return ret;
  196. }
  197. /*
  198. * Allocate another device for the on-sensor EEPROM,
  199. * which has it's dedicated I2C address and contains
  200. * the calibration constants for the sensor.
  201. */
  202. priv->eeprom_client = devm_i2c_new_dummy_device(dev, client->adapter,
  203. HP03_EEPROM_ADDR);
  204. if (IS_ERR(priv->eeprom_client)) {
  205. dev_err(dev, "New EEPROM I2C device failed\n");
  206. return PTR_ERR(priv->eeprom_client);
  207. }
  208. priv->eeprom_regmap = devm_regmap_init_i2c(priv->eeprom_client,
  209. &hp03_regmap_config);
  210. if (IS_ERR(priv->eeprom_regmap)) {
  211. dev_err(dev, "Failed to allocate EEPROM regmap\n");
  212. return PTR_ERR(priv->eeprom_regmap);
  213. }
  214. ret = devm_iio_device_register(dev, indio_dev);
  215. if (ret) {
  216. dev_err(dev, "Failed to register IIO device\n");
  217. return ret;
  218. }
  219. return 0;
  220. }
  221. static const struct i2c_device_id hp03_id[] = {
  222. { "hp03", 0 },
  223. { },
  224. };
  225. MODULE_DEVICE_TABLE(i2c, hp03_id);
  226. static const struct of_device_id hp03_of_match[] = {
  227. { .compatible = "hoperf,hp03" },
  228. { },
  229. };
  230. MODULE_DEVICE_TABLE(of, hp03_of_match);
  231. static struct i2c_driver hp03_driver = {
  232. .driver = {
  233. .name = "hp03",
  234. .of_match_table = hp03_of_match,
  235. },
  236. .probe = hp03_probe,
  237. .id_table = hp03_id,
  238. };
  239. module_i2c_driver(hp03_driver);
  240. MODULE_AUTHOR("Marek Vasut <[email protected]>");
  241. MODULE_DESCRIPTION("Driver for Hope RF HP03 pressure and temperature sensor");
  242. MODULE_LICENSE("GPL v2");