Commit | Line | Data |
---|---|---|
6cf23dff CO |
1 | /* |
2 | * Device driver for the the HMC5843 multi-chip module designed | |
3 | * for low field magnetic sensing. | |
4 | * | |
5 | * Copyright (C) 2010 Texas Instruments | |
6 | * | |
7 | * Author: Shubhrajyoti Datta <shubhrajyoti@ti.com> | |
8 | * Acknowledgment: Jonathan Cameron <jic23@kernel.org> for valuable inputs. | |
9 | * Support for HMC5883 and HMC5883L by Peter Meerwald <pmeerw@pmeerw.net>. | |
10 | * Split to multiple files by Josef Gajdusek <atx@atx.name> - 2014 | |
11 | * | |
12 | * This program is free software; you can redistribute it and/or modify | |
13 | * it under the terms of the GNU General Public License as published by | |
14 | * the Free Software Foundation; either version 2 of the License, or | |
15 | * (at your option) any later version. | |
16 | * | |
17 | * This program is distributed in the hope that it will be useful, | |
18 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
19 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
20 | * GNU General Public License for more details. | |
6cf23dff | 21 | */ |
b4e17822 S |
22 | |
23 | #include <linux/module.h> | |
f326a525 | 24 | #include <linux/regmap.h> |
06458e27 JC |
25 | #include <linux/iio/iio.h> |
26 | #include <linux/iio/sysfs.h> | |
cb9b9a82 PM |
27 | #include <linux/iio/trigger_consumer.h> |
28 | #include <linux/iio/buffer.h> | |
29 | #include <linux/iio/triggered_buffer.h> | |
4dedf31c | 30 | #include <linux/delay.h> |
b4e17822 | 31 | |
fc35a91b | 32 | #include "hmc5843.h" |
16b91a40 | 33 | |
b4e17822 | 34 | /* |
16b91a40 PM |
35 | * Range gain settings in (+-)Ga |
36 | * Beware: HMC5843 and HMC5883 have different recommended sensor field | |
37 | * ranges; default corresponds to +-1.0 Ga and +-1.3 Ga, respectively | |
38 | */ | |
39 | #define HMC5843_RANGE_GAIN_OFFSET 0x05 | |
40 | #define HMC5843_RANGE_GAIN_DEFAULT 0x01 | |
f326a525 | 41 | #define HMC5843_RANGE_GAIN_MASK 0xe0 |
b4e17822 | 42 | |
9728fe3f | 43 | /* Device status */ |
16b91a40 PM |
44 | #define HMC5843_DATA_READY 0x01 |
45 | #define HMC5843_DATA_OUTPUT_LOCK 0x02 | |
b4e17822 | 46 | |
9728fe3f | 47 | /* Mode register configuration */ |
16b91a40 PM |
48 | #define HMC5843_MODE_CONVERSION_CONTINUOUS 0x00 |
49 | #define HMC5843_MODE_CONVERSION_SINGLE 0x01 | |
50 | #define HMC5843_MODE_IDLE 0x02 | |
51 | #define HMC5843_MODE_SLEEP 0x03 | |
52 | #define HMC5843_MODE_MASK 0x03 | |
53 | ||
54 | /* | |
55 | * HMC5843: Minimum data output rate | |
56 | * HMC5883: Typical data output rate | |
57 | */ | |
58 | #define HMC5843_RATE_OFFSET 0x02 | |
8e2e2971 | 59 | #define HMC5843_RATE_DEFAULT 0x04 |
f326a525 | 60 | #define HMC5843_RATE_MASK 0x1c |
b4e17822 | 61 | |
9728fe3f | 62 | /* Device measurement configuration */ |
16b91a40 PM |
63 | #define HMC5843_MEAS_CONF_NORMAL 0x00 |
64 | #define HMC5843_MEAS_CONF_POSITIVE_BIAS 0x01 | |
65 | #define HMC5843_MEAS_CONF_NEGATIVE_BIAS 0x02 | |
16b91a40 | 66 | #define HMC5843_MEAS_CONF_MASK 0x03 |
b4e17822 | 67 | |
1c7be4c2 CM |
68 | /* |
69 | * API for setting the measurement configuration to | |
70 | * Normal, Positive bias and Negative bias | |
71 | * | |
72 | * From the datasheet: | |
73 | * 0 - Normal measurement configuration (default): In normal measurement | |
74 | * configuration the device follows normal measurement flow. Pins BP | |
75 | * and BN are left floating and high impedance. | |
76 | * | |
77 | * 1 - Positive bias configuration: In positive bias configuration, a | |
78 | * positive current is forced across the resistive load on pins BP | |
79 | * and BN. | |
80 | * | |
81 | * 2 - Negative bias configuration. In negative bias configuration, a | |
82 | * negative current is forced across the resistive load on pins BP | |
83 | * and BN. | |
84 | * | |
85 | * 3 - Only available on HMC5983. Magnetic sensor is disabled. | |
86 | * Temperature sensor is enabled. | |
87 | */ | |
88 | ||
89 | static const char *const hmc5843_meas_conf_modes[] = {"normal", "positivebias", | |
90 | "negativebias"}; | |
91 | ||
92 | static const char *const hmc5983_meas_conf_modes[] = {"normal", "positivebias", | |
93 | "negativebias", | |
94 | "disabled"}; | |
9728fe3f | 95 | /* Scaling factors: 10000000/Gain */ |
585f7ce2 | 96 | static const int hmc5843_regval_to_nanoscale[] = { |
494c6b15 | 97 | 6173, 7692, 10309, 12821, 18868, 21739, 25641, 35714 |
b4e17822 | 98 | }; |
494c6b15 | 99 | |
585f7ce2 | 100 | static const int hmc5883_regval_to_nanoscale[] = { |
357fcff5 PM |
101 | 7812, 9766, 13021, 16287, 24096, 27701, 32573, 45662 |
102 | }; | |
103 | ||
585f7ce2 | 104 | static const int hmc5883l_regval_to_nanoscale[] = { |
357fcff5 PM |
105 | 7299, 9174, 12195, 15152, 22727, 25641, 30303, 43478 |
106 | }; | |
107 | ||
c7c34af0 PM |
108 | /* |
109 | * From the datasheet: | |
357fcff5 PM |
110 | * Value | HMC5843 | HMC5883/HMC5883L |
111 | * | Data output rate (Hz) | Data output rate (Hz) | |
112 | * 0 | 0.5 | 0.75 | |
113 | * 1 | 1 | 1.5 | |
114 | * 2 | 2 | 3 | |
115 | * 3 | 5 | 7.5 | |
116 | * 4 | 10 (default) | 15 | |
117 | * 5 | 20 | 30 | |
118 | * 6 | 50 | 75 | |
119 | * 7 | Not used | Not used | |
c7c34af0 | 120 | */ |
585f7ce2 | 121 | static const int hmc5843_regval_to_samp_freq[][2] = { |
d4dc0a34 | 122 | {0, 500000}, {1, 0}, {2, 0}, {5, 0}, {10, 0}, {20, 0}, {50, 0} |
357fcff5 PM |
123 | }; |
124 | ||
585f7ce2 | 125 | static const int hmc5883_regval_to_samp_freq[][2] = { |
d4dc0a34 PM |
126 | {0, 750000}, {1, 500000}, {3, 0}, {7, 500000}, {15, 0}, {30, 0}, |
127 | {75, 0} | |
b4e17822 S |
128 | }; |
129 | ||
5a059bd2 JG |
130 | static const int hmc5983_regval_to_samp_freq[][2] = { |
131 | {0, 750000}, {1, 500000}, {3, 0}, {7, 500000}, {15, 0}, {30, 0}, | |
132 | {75, 0}, {220, 0} | |
133 | }; | |
134 | ||
357fcff5 PM |
135 | /* Describe chip variants */ |
136 | struct hmc5843_chip_info { | |
137 | const struct iio_chan_spec *channels; | |
d4dc0a34 | 138 | const int (*regval_to_samp_freq)[2]; |
585f7ce2 | 139 | const int n_regval_to_samp_freq; |
357fcff5 | 140 | const int *regval_to_nanoscale; |
585f7ce2 | 141 | const int n_regval_to_nanoscale; |
357fcff5 PM |
142 | }; |
143 | ||
c7c34af0 | 144 | /* The lower two bits contain the current conversion mode */ |
62248758 | 145 | static s32 hmc5843_set_mode(struct hmc5843_data *data, u8 operating_mode) |
b4e17822 | 146 | { |
62248758 PM |
147 | int ret; |
148 | ||
149 | mutex_lock(&data->lock); | |
f326a525 | 150 | ret = regmap_update_bits(data->regmap, HMC5843_MODE_REG, |
7079f21b | 151 | HMC5843_MODE_MASK, operating_mode); |
62248758 PM |
152 | mutex_unlock(&data->lock); |
153 | ||
154 | return ret; | |
b4e17822 S |
155 | } |
156 | ||
39c18828 | 157 | static int hmc5843_wait_measurement(struct hmc5843_data *data) |
b4e17822 | 158 | { |
4dedf31c | 159 | int tries = 150; |
883fc268 | 160 | unsigned int val; |
f326a525 | 161 | int ret; |
b4e17822 | 162 | |
4dedf31c | 163 | while (tries-- > 0) { |
f326a525 JG |
164 | ret = regmap_read(data->regmap, HMC5843_STATUS_REG, &val); |
165 | if (ret < 0) | |
166 | return ret; | |
167 | if (val & HMC5843_DATA_READY) | |
4dedf31c PM |
168 | break; |
169 | msleep(20); | |
170 | } | |
171 | ||
172 | if (tries < 0) { | |
fc35a91b | 173 | dev_err(data->dev, "data not ready\n"); |
4dedf31c PM |
174 | return -EIO; |
175 | } | |
b4e17822 | 176 | |
39c18828 PM |
177 | return 0; |
178 | } | |
179 | ||
180 | /* Return the measurement value from the specified channel */ | |
181 | static int hmc5843_read_measurement(struct hmc5843_data *data, | |
182 | int idx, int *val) | |
183 | { | |
39c18828 | 184 | __be16 values[3]; |
f326a525 | 185 | int ret; |
39c18828 PM |
186 | |
187 | mutex_lock(&data->lock); | |
f326a525 JG |
188 | ret = hmc5843_wait_measurement(data); |
189 | if (ret < 0) { | |
39c18828 | 190 | mutex_unlock(&data->lock); |
f326a525 | 191 | return ret; |
39c18828 | 192 | } |
f326a525 | 193 | ret = regmap_bulk_read(data->regmap, HMC5843_DATA_OUT_MSB_REGS, |
7079f21b | 194 | values, sizeof(values)); |
b4e17822 | 195 | mutex_unlock(&data->lock); |
f326a525 JG |
196 | if (ret < 0) |
197 | return ret; | |
b4e17822 | 198 | |
39c18828 | 199 | *val = sign_extend32(be16_to_cpu(values[idx]), 15); |
494c6b15 | 200 | return IIO_VAL_INT; |
b4e17822 | 201 | } |
494c6b15 | 202 | |
f326a525 | 203 | static int hmc5843_set_meas_conf(struct hmc5843_data *data, u8 meas_conf) |
b4e17822 | 204 | { |
4f1ca415 PM |
205 | int ret; |
206 | ||
207 | mutex_lock(&data->lock); | |
f326a525 | 208 | ret = regmap_update_bits(data->regmap, HMC5843_CONFIG_REG_A, |
7079f21b | 209 | HMC5843_MEAS_CONF_MASK, meas_conf); |
4f1ca415 PM |
210 | mutex_unlock(&data->lock); |
211 | ||
212 | return ret; | |
b4e17822 S |
213 | } |
214 | ||
7079f21b | 215 | static |
1c7be4c2 CM |
216 | int hmc5843_show_measurement_configuration(struct iio_dev *indio_dev, |
217 | const struct iio_chan_spec *chan) | |
b4e17822 | 218 | { |
1c7be4c2 | 219 | struct hmc5843_data *data = iio_priv(indio_dev); |
883fc268 | 220 | unsigned int val; |
f326a525 JG |
221 | int ret; |
222 | ||
223 | ret = regmap_read(data->regmap, HMC5843_CONFIG_REG_A, &val); | |
224 | if (ret) | |
225 | return ret; | |
f326a525 | 226 | |
1c7be4c2 | 227 | return val & HMC5843_MEAS_CONF_MASK; |
b4e17822 S |
228 | } |
229 | ||
7079f21b | 230 | static |
1c7be4c2 CM |
231 | int hmc5843_set_measurement_configuration(struct iio_dev *indio_dev, |
232 | const struct iio_chan_spec *chan, | |
233 | unsigned int meas_conf) | |
b4e17822 | 234 | { |
1c7be4c2 | 235 | struct hmc5843_data *data = iio_priv(indio_dev); |
e278df1c | 236 | |
1c7be4c2 CM |
237 | return hmc5843_set_meas_conf(data, meas_conf); |
238 | } | |
e278df1c | 239 | |
1c7be4c2 CM |
240 | static const struct iio_enum hmc5843_meas_conf_enum = { |
241 | .items = hmc5843_meas_conf_modes, | |
242 | .num_items = ARRAY_SIZE(hmc5843_meas_conf_modes), | |
243 | .get = hmc5843_show_measurement_configuration, | |
244 | .set = hmc5843_set_measurement_configuration, | |
245 | }; | |
b4e17822 | 246 | |
1c7be4c2 CM |
247 | static const struct iio_chan_spec_ext_info hmc5843_ext_info[] = { |
248 | IIO_ENUM("meas_conf", true, &hmc5843_meas_conf_enum), | |
249 | IIO_ENUM_AVAILABLE("meas_conf", &hmc5843_meas_conf_enum), | |
250 | { }, | |
251 | }; | |
c7c34af0 | 252 | |
1c7be4c2 CM |
253 | static const struct iio_enum hmc5983_meas_conf_enum = { |
254 | .items = hmc5983_meas_conf_modes, | |
255 | .num_items = ARRAY_SIZE(hmc5983_meas_conf_modes), | |
256 | .get = hmc5843_show_measurement_configuration, | |
257 | .set = hmc5843_set_measurement_configuration, | |
258 | }; | |
259 | ||
260 | static const struct iio_chan_spec_ext_info hmc5983_ext_info[] = { | |
261 | IIO_ENUM("meas_conf", true, &hmc5983_meas_conf_enum), | |
262 | IIO_ENUM_AVAILABLE("meas_conf", &hmc5983_meas_conf_enum), | |
263 | { }, | |
264 | }; | |
b4e17822 | 265 | |
7079f21b CO |
266 | static |
267 | ssize_t hmc5843_show_samp_freq_avail(struct device *dev, | |
268 | struct device_attribute *attr, char *buf) | |
357fcff5 | 269 | { |
9a3b2d5e | 270 | struct hmc5843_data *data = iio_priv(dev_to_iio_dev(dev)); |
dd28e482 | 271 | size_t len = 0; |
357fcff5 PM |
272 | int i; |
273 | ||
585f7ce2 | 274 | for (i = 0; i < data->variant->n_regval_to_samp_freq; i++) |
dd28e482 | 275 | len += scnprintf(buf + len, PAGE_SIZE - len, |
9a3b2d5e PM |
276 | "%d.%d ", data->variant->regval_to_samp_freq[i][0], |
277 | data->variant->regval_to_samp_freq[i][1]); | |
dd28e482 | 278 | |
357fcff5 | 279 | /* replace trailing space by newline */ |
dd28e482 PM |
280 | buf[len - 1] = '\n'; |
281 | ||
282 | return len; | |
283 | } | |
357fcff5 | 284 | |
d4dc0a34 | 285 | static IIO_DEV_ATTR_SAMP_FREQ_AVAIL(hmc5843_show_samp_freq_avail); |
b4e17822 | 286 | |
ca4c6172 | 287 | static int hmc5843_set_samp_freq(struct hmc5843_data *data, u8 rate) |
b4e17822 | 288 | { |
ca4c6172 PM |
289 | int ret; |
290 | ||
291 | mutex_lock(&data->lock); | |
f326a525 | 292 | ret = regmap_update_bits(data->regmap, HMC5843_CONFIG_REG_A, |
7079f21b CO |
293 | HMC5843_RATE_MASK, |
294 | rate << HMC5843_RATE_OFFSET); | |
ca4c6172 | 295 | mutex_unlock(&data->lock); |
4fd4d7d8 | 296 | |
ca4c6172 | 297 | return ret; |
b4e17822 S |
298 | } |
299 | ||
9a3b2d5e | 300 | static int hmc5843_get_samp_freq_index(struct hmc5843_data *data, |
7079f21b | 301 | int val, int val2) |
13f6eb69 | 302 | { |
9a3b2d5e PM |
303 | int i; |
304 | ||
585f7ce2 | 305 | for (i = 0; i < data->variant->n_regval_to_samp_freq; i++) |
9a3b2d5e | 306 | if (val == data->variant->regval_to_samp_freq[i][0] && |
7079f21b | 307 | val2 == data->variant->regval_to_samp_freq[i][1]) |
9a3b2d5e PM |
308 | return i; |
309 | ||
310 | return -EINVAL; | |
13f6eb69 PM |
311 | } |
312 | ||
f3f75519 PM |
313 | static int hmc5843_set_range_gain(struct hmc5843_data *data, u8 range) |
314 | { | |
315 | int ret; | |
316 | ||
317 | mutex_lock(&data->lock); | |
f326a525 | 318 | ret = regmap_update_bits(data->regmap, HMC5843_CONFIG_REG_B, |
7079f21b CO |
319 | HMC5843_RANGE_GAIN_MASK, |
320 | range << HMC5843_RANGE_GAIN_OFFSET); | |
f3f75519 PM |
321 | mutex_unlock(&data->lock); |
322 | ||
323 | return ret; | |
324 | } | |
325 | ||
ae6f54d2 | 326 | static ssize_t hmc5843_show_scale_avail(struct device *dev, |
7079f21b CO |
327 | struct device_attribute *attr, |
328 | char *buf) | |
b4e17822 | 329 | { |
ae6f54d2 PM |
330 | struct hmc5843_data *data = iio_priv(dev_to_iio_dev(dev)); |
331 | ||
332 | size_t len = 0; | |
333 | int i; | |
b4e17822 | 334 | |
585f7ce2 | 335 | for (i = 0; i < data->variant->n_regval_to_nanoscale; i++) |
ae6f54d2 PM |
336 | len += scnprintf(buf + len, PAGE_SIZE - len, |
337 | "0.%09d ", data->variant->regval_to_nanoscale[i]); | |
338 | ||
339 | /* replace trailing space by newline */ | |
340 | buf[len - 1] = '\n'; | |
341 | ||
342 | return len; | |
b4e17822 S |
343 | } |
344 | ||
ae6f54d2 PM |
345 | static IIO_DEVICE_ATTR(scale_available, S_IRUGO, |
346 | hmc5843_show_scale_avail, NULL, 0); | |
c7c34af0 | 347 | |
ae6f54d2 PM |
348 | static int hmc5843_get_scale_index(struct hmc5843_data *data, int val, int val2) |
349 | { | |
350 | int i; | |
b4e17822 | 351 | |
cd857a15 | 352 | if (val) |
ae6f54d2 | 353 | return -EINVAL; |
b4e17822 | 354 | |
585f7ce2 | 355 | for (i = 0; i < data->variant->n_regval_to_nanoscale; i++) |
ae6f54d2 PM |
356 | if (val2 == data->variant->regval_to_nanoscale[i]) |
357 | return i; | |
b4e17822 | 358 | |
ae6f54d2 | 359 | return -EINVAL; |
b4e17822 | 360 | } |
c7c34af0 | 361 | |
494c6b15 JC |
362 | static int hmc5843_read_raw(struct iio_dev *indio_dev, |
363 | struct iio_chan_spec const *chan, | |
d4dc0a34 | 364 | int *val, int *val2, long mask) |
b4e17822 | 365 | { |
88fa4de4 | 366 | struct hmc5843_data *data = iio_priv(indio_dev); |
883fc268 | 367 | unsigned int rval; |
f326a525 | 368 | int ret; |
494c6b15 JC |
369 | |
370 | switch (mask) { | |
4d9948b3 | 371 | case IIO_CHAN_INFO_RAW: |
cb9b9a82 | 372 | return hmc5843_read_measurement(data, chan->scan_index, val); |
c8a9f805 | 373 | case IIO_CHAN_INFO_SCALE: |
f326a525 JG |
374 | ret = regmap_read(data->regmap, HMC5843_CONFIG_REG_B, &rval); |
375 | if (ret < 0) | |
376 | return ret; | |
377 | rval >>= HMC5843_RANGE_GAIN_OFFSET; | |
494c6b15 | 378 | *val = 0; |
f326a525 | 379 | *val2 = data->variant->regval_to_nanoscale[rval]; |
494c6b15 | 380 | return IIO_VAL_INT_PLUS_NANO; |
d4dc0a34 | 381 | case IIO_CHAN_INFO_SAMP_FREQ: |
f326a525 JG |
382 | ret = regmap_read(data->regmap, HMC5843_CONFIG_REG_A, &rval); |
383 | if (ret < 0) | |
384 | return ret; | |
385 | rval >>= HMC5843_RATE_OFFSET; | |
386 | *val = data->variant->regval_to_samp_freq[rval][0]; | |
387 | *val2 = data->variant->regval_to_samp_freq[rval][1]; | |
d4dc0a34 | 388 | return IIO_VAL_INT_PLUS_MICRO; |
73327b4c | 389 | } |
494c6b15 | 390 | return -EINVAL; |
b4e17822 | 391 | } |
494c6b15 | 392 | |
d4dc0a34 PM |
393 | static int hmc5843_write_raw(struct iio_dev *indio_dev, |
394 | struct iio_chan_spec const *chan, | |
395 | int val, int val2, long mask) | |
396 | { | |
397 | struct hmc5843_data *data = iio_priv(indio_dev); | |
f3f75519 | 398 | int rate, range; |
d4dc0a34 PM |
399 | |
400 | switch (mask) { | |
401 | case IIO_CHAN_INFO_SAMP_FREQ: | |
9a3b2d5e | 402 | rate = hmc5843_get_samp_freq_index(data, val, val2); |
d4dc0a34 PM |
403 | if (rate < 0) |
404 | return -EINVAL; | |
405 | ||
ca4c6172 | 406 | return hmc5843_set_samp_freq(data, rate); |
ae6f54d2 PM |
407 | case IIO_CHAN_INFO_SCALE: |
408 | range = hmc5843_get_scale_index(data, val, val2); | |
409 | if (range < 0) | |
410 | return -EINVAL; | |
411 | ||
f3f75519 | 412 | return hmc5843_set_range_gain(data, range); |
ae6f54d2 PM |
413 | default: |
414 | return -EINVAL; | |
415 | } | |
416 | } | |
417 | ||
418 | static int hmc5843_write_raw_get_fmt(struct iio_dev *indio_dev, | |
7079f21b CO |
419 | struct iio_chan_spec const *chan, |
420 | long mask) | |
ae6f54d2 PM |
421 | { |
422 | switch (mask) { | |
423 | case IIO_CHAN_INFO_SAMP_FREQ: | |
424 | return IIO_VAL_INT_PLUS_MICRO; | |
425 | case IIO_CHAN_INFO_SCALE: | |
426 | return IIO_VAL_INT_PLUS_NANO; | |
d4dc0a34 PM |
427 | default: |
428 | return -EINVAL; | |
429 | } | |
430 | } | |
431 | ||
cb9b9a82 PM |
432 | static irqreturn_t hmc5843_trigger_handler(int irq, void *p) |
433 | { | |
434 | struct iio_poll_func *pf = p; | |
435 | struct iio_dev *indio_dev = pf->indio_dev; | |
436 | struct hmc5843_data *data = iio_priv(indio_dev); | |
437 | int ret; | |
438 | ||
439 | mutex_lock(&data->lock); | |
440 | ret = hmc5843_wait_measurement(data); | |
441 | if (ret < 0) { | |
442 | mutex_unlock(&data->lock); | |
443 | goto done; | |
444 | } | |
445 | ||
f326a525 | 446 | ret = regmap_bulk_read(data->regmap, HMC5843_DATA_OUT_MSB_REGS, |
7079f21b | 447 | data->buffer, 3 * sizeof(__be16)); |
f326a525 | 448 | |
cb9b9a82 PM |
449 | mutex_unlock(&data->lock); |
450 | if (ret < 0) | |
451 | goto done; | |
452 | ||
453 | iio_push_to_buffers_with_timestamp(indio_dev, data->buffer, | |
7079f21b | 454 | iio_get_time_ns()); |
cb9b9a82 PM |
455 | |
456 | done: | |
457 | iio_trigger_notify_done(indio_dev->trig); | |
458 | ||
459 | return IRQ_HANDLED; | |
460 | } | |
461 | ||
39c18828 | 462 | #define HMC5843_CHANNEL(axis, idx) \ |
494c6b15 JC |
463 | { \ |
464 | .type = IIO_MAGN, \ | |
465 | .modified = 1, \ | |
466 | .channel2 = IIO_MOD_##axis, \ | |
b3700970 | 467 | .info_mask_separate = BIT(IIO_CHAN_INFO_RAW), \ |
d4dc0a34 PM |
468 | .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_SCALE) | \ |
469 | BIT(IIO_CHAN_INFO_SAMP_FREQ), \ | |
cb9b9a82 | 470 | .scan_index = idx, \ |
c5fe7a41 JC |
471 | .scan_type = { \ |
472 | .sign = 's', \ | |
473 | .realbits = 16, \ | |
474 | .storagebits = 16, \ | |
475 | .endianness = IIO_BE, \ | |
476 | }, \ | |
1c7be4c2 CM |
477 | .ext_info = hmc5843_ext_info, \ |
478 | } | |
479 | ||
480 | #define HMC5983_CHANNEL(axis, idx) \ | |
481 | { \ | |
482 | .type = IIO_MAGN, \ | |
483 | .modified = 1, \ | |
484 | .channel2 = IIO_MOD_##axis, \ | |
485 | .info_mask_separate = BIT(IIO_CHAN_INFO_RAW), \ | |
486 | .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_SCALE) | \ | |
487 | BIT(IIO_CHAN_INFO_SAMP_FREQ), \ | |
488 | .scan_index = idx, \ | |
489 | .scan_type = { \ | |
490 | .sign = 's', \ | |
491 | .realbits = 16, \ | |
492 | .storagebits = 16, \ | |
493 | .endianness = IIO_BE, \ | |
494 | }, \ | |
495 | .ext_info = hmc5983_ext_info, \ | |
494c6b15 JC |
496 | } |
497 | ||
498 | static const struct iio_chan_spec hmc5843_channels[] = { | |
39c18828 PM |
499 | HMC5843_CHANNEL(X, 0), |
500 | HMC5843_CHANNEL(Y, 1), | |
501 | HMC5843_CHANNEL(Z, 2), | |
cb9b9a82 | 502 | IIO_CHAN_SOFT_TIMESTAMP(3), |
494c6b15 | 503 | }; |
b4e17822 | 504 | |
5a059bd2 | 505 | /* Beware: Y and Z are exchanged on HMC5883 and 5983 */ |
357fcff5 | 506 | static const struct iio_chan_spec hmc5883_channels[] = { |
39c18828 PM |
507 | HMC5843_CHANNEL(X, 0), |
508 | HMC5843_CHANNEL(Z, 1), | |
509 | HMC5843_CHANNEL(Y, 2), | |
cb9b9a82 | 510 | IIO_CHAN_SOFT_TIMESTAMP(3), |
357fcff5 PM |
511 | }; |
512 | ||
1c7be4c2 CM |
513 | static const struct iio_chan_spec hmc5983_channels[] = { |
514 | HMC5983_CHANNEL(X, 0), | |
515 | HMC5983_CHANNEL(Z, 1), | |
516 | HMC5983_CHANNEL(Y, 2), | |
517 | IIO_CHAN_SOFT_TIMESTAMP(3), | |
518 | }; | |
519 | ||
b4e17822 | 520 | static struct attribute *hmc5843_attributes[] = { |
ae6f54d2 | 521 | &iio_dev_attr_scale_available.dev_attr.attr, |
357fcff5 | 522 | &iio_dev_attr_sampling_frequency_available.dev_attr.attr, |
b4e17822 S |
523 | NULL |
524 | }; | |
525 | ||
526 | static const struct attribute_group hmc5843_group = { | |
527 | .attrs = hmc5843_attributes, | |
528 | }; | |
529 | ||
357fcff5 PM |
530 | static const struct hmc5843_chip_info hmc5843_chip_info_tbl[] = { |
531 | [HMC5843_ID] = { | |
532 | .channels = hmc5843_channels, | |
d4dc0a34 | 533 | .regval_to_samp_freq = hmc5843_regval_to_samp_freq, |
585f7ce2 JG |
534 | .n_regval_to_samp_freq = |
535 | ARRAY_SIZE(hmc5843_regval_to_samp_freq), | |
357fcff5 | 536 | .regval_to_nanoscale = hmc5843_regval_to_nanoscale, |
585f7ce2 JG |
537 | .n_regval_to_nanoscale = |
538 | ARRAY_SIZE(hmc5843_regval_to_nanoscale), | |
357fcff5 PM |
539 | }, |
540 | [HMC5883_ID] = { | |
541 | .channels = hmc5883_channels, | |
d4dc0a34 | 542 | .regval_to_samp_freq = hmc5883_regval_to_samp_freq, |
585f7ce2 JG |
543 | .n_regval_to_samp_freq = |
544 | ARRAY_SIZE(hmc5883_regval_to_samp_freq), | |
357fcff5 | 545 | .regval_to_nanoscale = hmc5883_regval_to_nanoscale, |
585f7ce2 JG |
546 | .n_regval_to_nanoscale = |
547 | ARRAY_SIZE(hmc5883_regval_to_nanoscale), | |
357fcff5 PM |
548 | }, |
549 | [HMC5883L_ID] = { | |
550 | .channels = hmc5883_channels, | |
d4dc0a34 | 551 | .regval_to_samp_freq = hmc5883_regval_to_samp_freq, |
585f7ce2 JG |
552 | .n_regval_to_samp_freq = |
553 | ARRAY_SIZE(hmc5883_regval_to_samp_freq), | |
357fcff5 | 554 | .regval_to_nanoscale = hmc5883l_regval_to_nanoscale, |
585f7ce2 JG |
555 | .n_regval_to_nanoscale = |
556 | ARRAY_SIZE(hmc5883l_regval_to_nanoscale), | |
357fcff5 | 557 | }, |
5a059bd2 | 558 | [HMC5983_ID] = { |
1c7be4c2 | 559 | .channels = hmc5983_channels, |
5a059bd2 JG |
560 | .regval_to_samp_freq = hmc5983_regval_to_samp_freq, |
561 | .n_regval_to_samp_freq = | |
562 | ARRAY_SIZE(hmc5983_regval_to_samp_freq), | |
563 | .regval_to_nanoscale = hmc5883l_regval_to_nanoscale, | |
564 | .n_regval_to_nanoscale = | |
565 | ARRAY_SIZE(hmc5883l_regval_to_nanoscale), | |
566 | } | |
357fcff5 PM |
567 | }; |
568 | ||
9d5ad0c3 | 569 | static int hmc5843_init(struct hmc5843_data *data) |
b4e17822 | 570 | { |
9d5ad0c3 PM |
571 | int ret; |
572 | u8 id[3]; | |
573 | ||
f326a525 | 574 | ret = regmap_bulk_read(data->regmap, HMC5843_ID_REG, |
7079f21b | 575 | id, ARRAY_SIZE(id)); |
9d5ad0c3 PM |
576 | if (ret < 0) |
577 | return ret; | |
578 | if (id[0] != 'H' || id[1] != '4' || id[2] != '3') { | |
5a059bd2 | 579 | dev_err(data->dev, "no HMC5843/5883/5883L/5983 sensor\n"); |
9d5ad0c3 PM |
580 | return -ENODEV; |
581 | } | |
582 | ||
583 | ret = hmc5843_set_meas_conf(data, HMC5843_MEAS_CONF_NORMAL); | |
584 | if (ret < 0) | |
585 | return ret; | |
586 | ret = hmc5843_set_samp_freq(data, HMC5843_RATE_DEFAULT); | |
587 | if (ret < 0) | |
588 | return ret; | |
589 | ret = hmc5843_set_range_gain(data, HMC5843_RANGE_GAIN_DEFAULT); | |
590 | if (ret < 0) | |
591 | return ret; | |
592 | return hmc5843_set_mode(data, HMC5843_MODE_CONVERSION_CONTINUOUS); | |
b4e17822 S |
593 | } |
594 | ||
6fe8135f JC |
595 | static const struct iio_info hmc5843_info = { |
596 | .attrs = &hmc5843_group, | |
7247645f CM |
597 | .read_raw = &hmc5843_read_raw, |
598 | .write_raw = &hmc5843_write_raw, | |
599 | .write_raw_get_fmt = &hmc5843_write_raw_get_fmt, | |
6fe8135f JC |
600 | .driver_module = THIS_MODULE, |
601 | }; | |
602 | ||
cb9b9a82 PM |
603 | static const unsigned long hmc5843_scan_masks[] = {0x7, 0}; |
604 | ||
fc35a91b JG |
605 | int hmc5843_common_suspend(struct device *dev) |
606 | { | |
607 | return hmc5843_set_mode(iio_priv(dev_get_drvdata(dev)), | |
c099225f | 608 | HMC5843_MODE_SLEEP); |
fc35a91b JG |
609 | } |
610 | EXPORT_SYMBOL(hmc5843_common_suspend); | |
f326a525 | 611 | |
fc35a91b JG |
612 | int hmc5843_common_resume(struct device *dev) |
613 | { | |
614 | return hmc5843_set_mode(iio_priv(dev_get_drvdata(dev)), | |
c099225f | 615 | HMC5843_MODE_CONVERSION_CONTINUOUS); |
fc35a91b JG |
616 | } |
617 | EXPORT_SYMBOL(hmc5843_common_resume); | |
f326a525 | 618 | |
fc35a91b | 619 | int hmc5843_common_probe(struct device *dev, struct regmap *regmap, |
70b2737e | 620 | enum hmc5843_ids id, const char *name) |
b4e17822 S |
621 | { |
622 | struct hmc5843_data *data; | |
88fa4de4 | 623 | struct iio_dev *indio_dev; |
cb9b9a82 | 624 | int ret; |
b4e17822 | 625 | |
fc35a91b | 626 | indio_dev = devm_iio_device_alloc(dev, sizeof(*data)); |
9fb163f4 | 627 | if (!indio_dev) |
a6dcb71b | 628 | return -ENOMEM; |
b4e17822 | 629 | |
fc35a91b JG |
630 | dev_set_drvdata(dev, indio_dev); |
631 | ||
16b91a40 PM |
632 | /* default settings at probe */ |
633 | data = iio_priv(indio_dev); | |
fc35a91b JG |
634 | data->dev = dev; |
635 | data->regmap = regmap; | |
636 | data->variant = &hmc5843_chip_info_tbl[id]; | |
8e2e2971 | 637 | mutex_init(&data->lock); |
b4e17822 | 638 | |
fc35a91b | 639 | indio_dev->dev.parent = dev; |
70b2737e | 640 | indio_dev->name = name; |
88fa4de4 | 641 | indio_dev->info = &hmc5843_info; |
88fa4de4 | 642 | indio_dev->modes = INDIO_DIRECT_MODE; |
8e2e2971 | 643 | indio_dev->channels = data->variant->channels; |
cb9b9a82 PM |
644 | indio_dev->num_channels = 4; |
645 | indio_dev->available_scan_masks = hmc5843_scan_masks; | |
8e2e2971 | 646 | |
9d5ad0c3 PM |
647 | ret = hmc5843_init(data); |
648 | if (ret < 0) | |
649 | return ret; | |
c7c34af0 | 650 | |
cb9b9a82 | 651 | ret = iio_triggered_buffer_setup(indio_dev, NULL, |
7079f21b | 652 | hmc5843_trigger_handler, NULL); |
cb9b9a82 | 653 | if (ret < 0) |
e6767051 | 654 | goto buffer_setup_err; |
cb9b9a82 PM |
655 | |
656 | ret = iio_device_register(indio_dev); | |
657 | if (ret < 0) | |
658 | goto buffer_cleanup; | |
c7c34af0 | 659 | |
b4e17822 | 660 | return 0; |
cb9b9a82 PM |
661 | |
662 | buffer_cleanup: | |
663 | iio_triggered_buffer_cleanup(indio_dev); | |
e6767051 CO |
664 | buffer_setup_err: |
665 | hmc5843_set_mode(iio_priv(indio_dev), HMC5843_MODE_SLEEP); | |
cb9b9a82 | 666 | return ret; |
b4e17822 | 667 | } |
fc35a91b | 668 | EXPORT_SYMBOL(hmc5843_common_probe); |
b4e17822 | 669 | |
fc35a91b | 670 | int hmc5843_common_remove(struct device *dev) |
b4e17822 | 671 | { |
fc35a91b | 672 | struct iio_dev *indio_dev = dev_get_drvdata(dev); |
cb9b9a82 PM |
673 | |
674 | iio_device_unregister(indio_dev); | |
675 | iio_triggered_buffer_cleanup(indio_dev); | |
676 | ||
094509b1 | 677 | /* sleep mode to save power */ |
62248758 | 678 | hmc5843_set_mode(iio_priv(indio_dev), HMC5843_MODE_SLEEP); |
88fa4de4 | 679 | |
b4e17822 S |
680 | return 0; |
681 | } | |
fc35a91b | 682 | EXPORT_SYMBOL(hmc5843_common_remove); |
b4e17822 | 683 | |
b658a377 | 684 | MODULE_AUTHOR("Shubhrajyoti Datta <shubhrajyoti@ti.com>"); |
5a059bd2 | 685 | MODULE_DESCRIPTION("HMC5843/5883/5883L/5983 core driver"); |
b4e17822 | 686 | MODULE_LICENSE("GPL"); |