1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * drivers/hwmon/lis3lv02d_i2c.c
4 *
5 * Implements I2C interface for lis3lv02d (STMicroelectronics) accelerometer.
6 * Driver is based on corresponding SPI driver written by Daniel Mack
7 * (lis3lv02d_spi.c (C) 2009 Daniel Mack <daniel@caiaq.de> ).
8 *
9 * Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
10 *
11 * Contact: Samu Onkalo <samu.p.onkalo@nokia.com>
12 */
13
14#include <linux/module.h>
15#include <linux/kernel.h>
16#include <linux/err.h>
17#include <linux/i2c.h>
18#include <linux/pm_runtime.h>
19#include <linux/delay.h>
20#include <linux/of.h>
21#include <linux/of_platform.h>
22#include <linux/of_device.h>
23
24#include "lis3lv02d.h"
25
26#define DRV_NAME "lis3lv02d_i2c"
27
28static const char reg_vdd[] = "Vdd";
29static const char reg_vdd_io[] = "Vdd_IO";
30
31static int lis3_reg_ctrl(struct lis3lv02d *lis3, bool state)
32{
33 int ret;
34 if (state == LIS3_REG_OFF) {
35 ret = regulator_bulk_disable(ARRAY_SIZE(lis3->regulators),
36 consumers: lis3->regulators);
37 } else {
38 ret = regulator_bulk_enable(ARRAY_SIZE(lis3->regulators),
39 consumers: lis3->regulators);
40 /* Chip needs time to wakeup. Not mentioned in datasheet */
41 usleep_range(min: 10000, max: 20000);
42 }
43 return ret;
44}
45
46static inline s32 lis3_i2c_write(struct lis3lv02d *lis3, int reg, u8 value)
47{
48 struct i2c_client *c = lis3->bus_priv;
49 return i2c_smbus_write_byte_data(client: c, command: reg, value);
50}
51
52static inline s32 lis3_i2c_read(struct lis3lv02d *lis3, int reg, u8 *v)
53{
54 struct i2c_client *c = lis3->bus_priv;
55 *v = i2c_smbus_read_byte_data(client: c, command: reg);
56 return 0;
57}
58
59static inline s32 lis3_i2c_blockread(struct lis3lv02d *lis3, int reg, int len,
60 u8 *v)
61{
62 struct i2c_client *c = lis3->bus_priv;
63 reg |= (1 << 7); /* 7th bit enables address auto incrementation */
64 return i2c_smbus_read_i2c_block_data(client: c, command: reg, length: len, values: v);
65}
66
67static int lis3_i2c_init(struct lis3lv02d *lis3)
68{
69 u8 reg;
70 int ret;
71
72 lis3_reg_ctrl(lis3, state: LIS3_REG_ON);
73
74 lis3->read(lis3, WHO_AM_I, &reg);
75 if (reg != lis3->whoami)
76 printk(KERN_ERR "lis3: power on failure\n");
77
78 /* power up the device */
79 ret = lis3->read(lis3, CTRL_REG1, &reg);
80 if (ret < 0)
81 return ret;
82
83 if (lis3->whoami == WAI_3DLH)
84 reg |= CTRL1_PM0 | CTRL1_Xen | CTRL1_Yen | CTRL1_Zen;
85 else
86 reg |= CTRL1_PD0 | CTRL1_Xen | CTRL1_Yen | CTRL1_Zen;
87
88 return lis3->write(lis3, CTRL_REG1, reg);
89}
90
91/* Default axis mapping but it can be overwritten by platform data */
92static union axis_conversion lis3lv02d_axis_map =
93 { .as_array = { LIS3_DEV_X, LIS3_DEV_Y, LIS3_DEV_Z } };
94
95#ifdef CONFIG_OF
96static const struct of_device_id lis3lv02d_i2c_dt_ids[] = {
97 { .compatible = "st,lis3lv02d" },
98 {}
99};
100MODULE_DEVICE_TABLE(of, lis3lv02d_i2c_dt_ids);
101#endif
102
103static int lis3lv02d_i2c_probe(struct i2c_client *client)
104{
105 int ret = 0;
106 struct lis3lv02d_platform_data *pdata = client->dev.platform_data;
107
108#ifdef CONFIG_OF
109 if (of_match_device(matches: lis3lv02d_i2c_dt_ids, dev: &client->dev)) {
110 lis3_dev.of_node = client->dev.of_node;
111 ret = lis3lv02d_init_dt(lis3: &lis3_dev);
112 if (ret)
113 return ret;
114 pdata = lis3_dev.pdata;
115 }
116#endif
117
118 if (pdata) {
119 if ((pdata->driver_features & LIS3_USE_BLOCK_READ) &&
120 (i2c_check_functionality(adap: client->adapter,
121 I2C_FUNC_SMBUS_I2C_BLOCK)))
122 lis3_dev.blkread = lis3_i2c_blockread;
123
124 if (pdata->axis_x)
125 lis3lv02d_axis_map.x = pdata->axis_x;
126
127 if (pdata->axis_y)
128 lis3lv02d_axis_map.y = pdata->axis_y;
129
130 if (pdata->axis_z)
131 lis3lv02d_axis_map.z = pdata->axis_z;
132
133 if (pdata->setup_resources)
134 ret = pdata->setup_resources();
135
136 if (ret)
137 goto fail;
138 }
139
140 lis3_dev.regulators[0].supply = reg_vdd;
141 lis3_dev.regulators[1].supply = reg_vdd_io;
142 ret = regulator_bulk_get(dev: &client->dev,
143 ARRAY_SIZE(lis3_dev.regulators),
144 consumers: lis3_dev.regulators);
145 if (ret < 0)
146 goto fail;
147
148 lis3_dev.pdata = pdata;
149 lis3_dev.bus_priv = client;
150 lis3_dev.init = lis3_i2c_init;
151 lis3_dev.read = lis3_i2c_read;
152 lis3_dev.write = lis3_i2c_write;
153 lis3_dev.reg_ctrl = lis3_reg_ctrl;
154 lis3_dev.irq = client->irq;
155 lis3_dev.ac = lis3lv02d_axis_map;
156 lis3_dev.pm_dev = &client->dev;
157
158 i2c_set_clientdata(client, data: &lis3_dev);
159
160 /* Provide power over the init call */
161 lis3_reg_ctrl(lis3: &lis3_dev, state: LIS3_REG_ON);
162
163 ret = lis3lv02d_init_device(lis3: &lis3_dev);
164
165 lis3_reg_ctrl(lis3: &lis3_dev, state: LIS3_REG_OFF);
166
167 if (ret)
168 goto fail2;
169 return 0;
170
171fail2:
172 regulator_bulk_free(ARRAY_SIZE(lis3_dev.regulators),
173 consumers: lis3_dev.regulators);
174fail:
175 if (pdata && pdata->release_resources)
176 pdata->release_resources();
177 return ret;
178}
179
180static void lis3lv02d_i2c_remove(struct i2c_client *client)
181{
182 struct lis3lv02d *lis3 = i2c_get_clientdata(client);
183 struct lis3lv02d_platform_data *pdata = client->dev.platform_data;
184
185 if (pdata && pdata->release_resources)
186 pdata->release_resources();
187
188 lis3lv02d_joystick_disable(lis3);
189 lis3lv02d_remove_fs(lis3: &lis3_dev);
190
191 regulator_bulk_free(ARRAY_SIZE(lis3->regulators),
192 consumers: lis3_dev.regulators);
193}
194
195#ifdef CONFIG_PM_SLEEP
196static int lis3lv02d_i2c_suspend(struct device *dev)
197{
198 struct i2c_client *client = to_i2c_client(dev);
199 struct lis3lv02d *lis3 = i2c_get_clientdata(client);
200
201 /* Turn on for wakeup if turned off by runtime suspend */
202 if (lis3->pdata && lis3->pdata->wakeup_flags) {
203 if (pm_runtime_suspended(dev))
204 lis3lv02d_poweron(lis3);
205 /* For non wakeup turn off if not already turned off by runtime suspend */
206 } else if (!pm_runtime_suspended(dev))
207 lis3lv02d_poweroff(lis3);
208
209 return 0;
210}
211
212static int lis3lv02d_i2c_resume(struct device *dev)
213{
214 struct i2c_client *client = to_i2c_client(dev);
215 struct lis3lv02d *lis3 = i2c_get_clientdata(client);
216
217 /* Turn back off if turned on for wakeup and runtime suspended*/
218 if (lis3->pdata && lis3->pdata->wakeup_flags) {
219 if (pm_runtime_suspended(dev))
220 lis3lv02d_poweroff(lis3);
221 /* For non wakeup turn back on if not runtime suspended */
222 } else if (!pm_runtime_suspended(dev))
223 lis3lv02d_poweron(lis3);
224
225 return 0;
226}
227#endif /* CONFIG_PM_SLEEP */
228
229#ifdef CONFIG_PM
230static int lis3_i2c_runtime_suspend(struct device *dev)
231{
232 struct i2c_client *client = to_i2c_client(dev);
233 struct lis3lv02d *lis3 = i2c_get_clientdata(client);
234
235 lis3lv02d_poweroff(lis3);
236 return 0;
237}
238
239static int lis3_i2c_runtime_resume(struct device *dev)
240{
241 struct i2c_client *client = to_i2c_client(dev);
242 struct lis3lv02d *lis3 = i2c_get_clientdata(client);
243
244 lis3lv02d_poweron(lis3);
245 return 0;
246}
247#endif /* CONFIG_PM */
248
249static const struct i2c_device_id lis3lv02d_id[] = {
250 {"lis3lv02d", LIS3LV02D},
251 {"lis331dlh", LIS331DLH},
252 {}
253};
254
255MODULE_DEVICE_TABLE(i2c, lis3lv02d_id);
256
257static const struct dev_pm_ops lis3_pm_ops = {
258 SET_SYSTEM_SLEEP_PM_OPS(lis3lv02d_i2c_suspend,
259 lis3lv02d_i2c_resume)
260 SET_RUNTIME_PM_OPS(lis3_i2c_runtime_suspend,
261 lis3_i2c_runtime_resume,
262 NULL)
263};
264
265static struct i2c_driver lis3lv02d_i2c_driver = {
266 .driver = {
267 .name = DRV_NAME,
268 .pm = &lis3_pm_ops,
269 .of_match_table = of_match_ptr(lis3lv02d_i2c_dt_ids),
270 },
271 .probe = lis3lv02d_i2c_probe,
272 .remove = lis3lv02d_i2c_remove,
273 .id_table = lis3lv02d_id,
274};
275
276module_i2c_driver(lis3lv02d_i2c_driver);
277
278MODULE_AUTHOR("Nokia Corporation");
279MODULE_DESCRIPTION("lis3lv02d I2C interface");
280MODULE_LICENSE("GPL");
281

source code of linux/drivers/misc/lis3lv02d/lis3lv02d_i2c.c