11802d0beSThomas Gleixner // SPDX-License-Identifier: GPL-2.0-only
2bee3d511SPavel Machek /*
3bee3d511SPavel Machek * drivers/media/i2c/ad5820.c
4bee3d511SPavel Machek *
5bee3d511SPavel Machek * AD5820 DAC driver for camera voice coil focus.
6bee3d511SPavel Machek *
7bee3d511SPavel Machek * Copyright (C) 2008 Nokia Corporation
8bee3d511SPavel Machek * Copyright (C) 2007 Texas Instruments
9bee3d511SPavel Machek * Copyright (C) 2016 Pavel Machek <pavel@ucw.cz>
10bee3d511SPavel Machek *
11bee3d511SPavel Machek * Contact: Tuukka Toivonen <tuukkat76@gmail.com>
12bee3d511SPavel Machek * Sakari Ailus <sakari.ailus@iki.fi>
13bee3d511SPavel Machek *
14bee3d511SPavel Machek * Based on af_d88.c by Texas Instruments.
15bee3d511SPavel Machek */
16bee3d511SPavel Machek
17bee3d511SPavel Machek #include <linux/errno.h>
18bee3d511SPavel Machek #include <linux/i2c.h>
19bee3d511SPavel Machek #include <linux/kernel.h>
20bee3d511SPavel Machek #include <linux/module.h>
21bee3d511SPavel Machek #include <linux/regulator/consumer.h>
22c01674e7SRicardo Ribalda Delgado #include <linux/gpio/consumer.h>
23bee3d511SPavel Machek
24bee3d511SPavel Machek #include <media/v4l2-ctrls.h>
25bee3d511SPavel Machek #include <media/v4l2-device.h>
26bee3d511SPavel Machek #include <media/v4l2-subdev.h>
27bee3d511SPavel Machek
28bee3d511SPavel Machek /* Register definitions */
29bee3d511SPavel Machek #define AD5820_POWER_DOWN (1 << 15)
30bee3d511SPavel Machek #define AD5820_DAC_SHIFT 4
31bee3d511SPavel Machek #define AD5820_RAMP_MODE_LINEAR (0 << 3)
32bee3d511SPavel Machek #define AD5820_RAMP_MODE_64_16 (1 << 3)
33bee3d511SPavel Machek
34bee3d511SPavel Machek #define CODE_TO_RAMP_US(s) ((s) == 0 ? 0 : (1 << ((s) - 1)) * 50)
35bee3d511SPavel Machek #define RAMP_US_TO_CODE(c) fls(((c) + ((c)>>1)) / 50)
36bee3d511SPavel Machek
37bee3d511SPavel Machek #define to_ad5820_device(sd) container_of(sd, struct ad5820_device, subdev)
38bee3d511SPavel Machek
39bee3d511SPavel Machek struct ad5820_device {
40bee3d511SPavel Machek struct v4l2_subdev subdev;
41bee3d511SPavel Machek struct ad5820_platform_data *platform_data;
42bee3d511SPavel Machek struct regulator *vana;
43bee3d511SPavel Machek
44bee3d511SPavel Machek struct v4l2_ctrl_handler ctrls;
45bee3d511SPavel Machek u32 focus_absolute;
46bee3d511SPavel Machek u32 focus_ramp_time;
47bee3d511SPavel Machek u32 focus_ramp_mode;
48bee3d511SPavel Machek
49c01674e7SRicardo Ribalda Delgado struct gpio_desc *enable_gpio;
50c01674e7SRicardo Ribalda Delgado
51bee3d511SPavel Machek struct mutex power_lock;
52bee3d511SPavel Machek int power_count;
53bee3d511SPavel Machek
543933186aSSakari Ailus bool standby;
55bee3d511SPavel Machek };
56bee3d511SPavel Machek
ad5820_write(struct ad5820_device * coil,u16 data)57bee3d511SPavel Machek static int ad5820_write(struct ad5820_device *coil, u16 data)
58bee3d511SPavel Machek {
59bee3d511SPavel Machek struct i2c_client *client = v4l2_get_subdevdata(&coil->subdev);
60bee3d511SPavel Machek struct i2c_msg msg;
611ff52fa0SSakari Ailus __be16 be_data;
62bee3d511SPavel Machek int r;
63bee3d511SPavel Machek
64bee3d511SPavel Machek if (!client->adapter)
65bee3d511SPavel Machek return -ENODEV;
66bee3d511SPavel Machek
671ff52fa0SSakari Ailus be_data = cpu_to_be16(data);
68bee3d511SPavel Machek msg.addr = client->addr;
69bee3d511SPavel Machek msg.flags = 0;
70bee3d511SPavel Machek msg.len = 2;
711ff52fa0SSakari Ailus msg.buf = (u8 *)&be_data;
72bee3d511SPavel Machek
73bee3d511SPavel Machek r = i2c_transfer(client->adapter, &msg, 1);
74bee3d511SPavel Machek if (r < 0) {
75bee3d511SPavel Machek dev_err(&client->dev, "write failed, error %d\n", r);
76bee3d511SPavel Machek return r;
77bee3d511SPavel Machek }
78bee3d511SPavel Machek
79bee3d511SPavel Machek return 0;
80bee3d511SPavel Machek }
81bee3d511SPavel Machek
82bee3d511SPavel Machek /*
83bee3d511SPavel Machek * Calculate status word and write it to the device based on current
84bee3d511SPavel Machek * values of V4L2 controls. It is assumed that the stored V4L2 control
85bee3d511SPavel Machek * values are properly limited and rounded.
86bee3d511SPavel Machek */
ad5820_update_hw(struct ad5820_device * coil)87bee3d511SPavel Machek static int ad5820_update_hw(struct ad5820_device *coil)
88bee3d511SPavel Machek {
89bee3d511SPavel Machek u16 status;
90bee3d511SPavel Machek
91bee3d511SPavel Machek status = RAMP_US_TO_CODE(coil->focus_ramp_time);
92bee3d511SPavel Machek status |= coil->focus_ramp_mode
93bee3d511SPavel Machek ? AD5820_RAMP_MODE_64_16 : AD5820_RAMP_MODE_LINEAR;
94bee3d511SPavel Machek status |= coil->focus_absolute << AD5820_DAC_SHIFT;
95bee3d511SPavel Machek
96bee3d511SPavel Machek if (coil->standby)
97bee3d511SPavel Machek status |= AD5820_POWER_DOWN;
98bee3d511SPavel Machek
99bee3d511SPavel Machek return ad5820_write(coil, status);
100bee3d511SPavel Machek }
101bee3d511SPavel Machek
102bee3d511SPavel Machek /*
103bee3d511SPavel Machek * Power handling
104bee3d511SPavel Machek */
ad5820_power_off(struct ad5820_device * coil,bool standby)1053933186aSSakari Ailus static int ad5820_power_off(struct ad5820_device *coil, bool standby)
106bee3d511SPavel Machek {
107bee3d511SPavel Machek int ret = 0, ret2;
108bee3d511SPavel Machek
109bee3d511SPavel Machek /*
110bee3d511SPavel Machek * Go to standby first as real power off my be denied by the hardware
111bee3d511SPavel Machek * (single power line control for both coil and sensor).
112bee3d511SPavel Machek */
113bee3d511SPavel Machek if (standby) {
1143933186aSSakari Ailus coil->standby = true;
115bee3d511SPavel Machek ret = ad5820_update_hw(coil);
116bee3d511SPavel Machek }
117bee3d511SPavel Machek
118c01674e7SRicardo Ribalda Delgado gpiod_set_value_cansleep(coil->enable_gpio, 0);
119c01674e7SRicardo Ribalda Delgado
120bee3d511SPavel Machek ret2 = regulator_disable(coil->vana);
121bee3d511SPavel Machek if (ret)
122bee3d511SPavel Machek return ret;
123bee3d511SPavel Machek return ret2;
124bee3d511SPavel Machek }
125bee3d511SPavel Machek
ad5820_power_on(struct ad5820_device * coil,bool restore)1263933186aSSakari Ailus static int ad5820_power_on(struct ad5820_device *coil, bool restore)
127bee3d511SPavel Machek {
128bee3d511SPavel Machek int ret;
129bee3d511SPavel Machek
130bee3d511SPavel Machek ret = regulator_enable(coil->vana);
131bee3d511SPavel Machek if (ret < 0)
132bee3d511SPavel Machek return ret;
133bee3d511SPavel Machek
134c01674e7SRicardo Ribalda Delgado gpiod_set_value_cansleep(coil->enable_gpio, 1);
135c01674e7SRicardo Ribalda Delgado
136bee3d511SPavel Machek if (restore) {
137bee3d511SPavel Machek /* Restore the hardware settings. */
1383933186aSSakari Ailus coil->standby = false;
139bee3d511SPavel Machek ret = ad5820_update_hw(coil);
140bee3d511SPavel Machek if (ret)
141bee3d511SPavel Machek goto fail;
142bee3d511SPavel Machek }
143bee3d511SPavel Machek return 0;
144bee3d511SPavel Machek
145bee3d511SPavel Machek fail:
146c01674e7SRicardo Ribalda Delgado gpiod_set_value_cansleep(coil->enable_gpio, 0);
1473933186aSSakari Ailus coil->standby = true;
148bee3d511SPavel Machek regulator_disable(coil->vana);
149bee3d511SPavel Machek
150bee3d511SPavel Machek return ret;
151bee3d511SPavel Machek }
152bee3d511SPavel Machek
153bee3d511SPavel Machek /*
154bee3d511SPavel Machek * V4L2 controls
155bee3d511SPavel Machek */
ad5820_set_ctrl(struct v4l2_ctrl * ctrl)156bee3d511SPavel Machek static int ad5820_set_ctrl(struct v4l2_ctrl *ctrl)
157bee3d511SPavel Machek {
158bee3d511SPavel Machek struct ad5820_device *coil =
159bee3d511SPavel Machek container_of(ctrl->handler, struct ad5820_device, ctrls);
160bee3d511SPavel Machek
161bee3d511SPavel Machek switch (ctrl->id) {
162bee3d511SPavel Machek case V4L2_CID_FOCUS_ABSOLUTE:
163bee3d511SPavel Machek coil->focus_absolute = ctrl->val;
164bee3d511SPavel Machek return ad5820_update_hw(coil);
165bee3d511SPavel Machek }
166bee3d511SPavel Machek
167bee3d511SPavel Machek return 0;
168bee3d511SPavel Machek }
169bee3d511SPavel Machek
170bee3d511SPavel Machek static const struct v4l2_ctrl_ops ad5820_ctrl_ops = {
171bee3d511SPavel Machek .s_ctrl = ad5820_set_ctrl,
172bee3d511SPavel Machek };
173bee3d511SPavel Machek
174bee3d511SPavel Machek
ad5820_init_controls(struct ad5820_device * coil)175bee3d511SPavel Machek static int ad5820_init_controls(struct ad5820_device *coil)
176bee3d511SPavel Machek {
177bee3d511SPavel Machek v4l2_ctrl_handler_init(&coil->ctrls, 1);
178bee3d511SPavel Machek
179bee3d511SPavel Machek /*
180bee3d511SPavel Machek * V4L2_CID_FOCUS_ABSOLUTE
181bee3d511SPavel Machek *
182bee3d511SPavel Machek * Minimum current is 0 mA, maximum is 100 mA. Thus, 1 code is
183bee3d511SPavel Machek * equivalent to 100/1023 = 0.0978 mA. Nevertheless, we do not use [mA]
184bee3d511SPavel Machek * for focus position, because it is meaningless for user. Meaningful
185bee3d511SPavel Machek * would be to use focus distance or even its inverse, but since the
186bee3d511SPavel Machek * driver doesn't have sufficiently knowledge to do the conversion, we
187bee3d511SPavel Machek * will just use abstract codes here. In any case, smaller value = focus
188bee3d511SPavel Machek * position farther from camera. The default zero value means focus at
189bee3d511SPavel Machek * infinity, and also least current consumption.
190bee3d511SPavel Machek */
191bee3d511SPavel Machek v4l2_ctrl_new_std(&coil->ctrls, &ad5820_ctrl_ops,
192bee3d511SPavel Machek V4L2_CID_FOCUS_ABSOLUTE, 0, 1023, 1, 0);
193bee3d511SPavel Machek
194bee3d511SPavel Machek if (coil->ctrls.error)
195bee3d511SPavel Machek return coil->ctrls.error;
196bee3d511SPavel Machek
197bee3d511SPavel Machek coil->focus_absolute = 0;
198bee3d511SPavel Machek coil->focus_ramp_time = 0;
199bee3d511SPavel Machek coil->focus_ramp_mode = 0;
200bee3d511SPavel Machek
201bee3d511SPavel Machek coil->subdev.ctrl_handler = &coil->ctrls;
202bee3d511SPavel Machek
203bee3d511SPavel Machek return 0;
204bee3d511SPavel Machek }
205bee3d511SPavel Machek
206bee3d511SPavel Machek /*
207bee3d511SPavel Machek * V4L2 subdev operations
208bee3d511SPavel Machek */
ad5820_registered(struct v4l2_subdev * subdev)209bee3d511SPavel Machek static int ad5820_registered(struct v4l2_subdev *subdev)
210bee3d511SPavel Machek {
211bee3d511SPavel Machek struct ad5820_device *coil = to_ad5820_device(subdev);
212bee3d511SPavel Machek
213bee3d511SPavel Machek return ad5820_init_controls(coil);
214bee3d511SPavel Machek }
215bee3d511SPavel Machek
216bee3d511SPavel Machek static int
ad5820_set_power(struct v4l2_subdev * subdev,int on)217bee3d511SPavel Machek ad5820_set_power(struct v4l2_subdev *subdev, int on)
218bee3d511SPavel Machek {
219bee3d511SPavel Machek struct ad5820_device *coil = to_ad5820_device(subdev);
220bee3d511SPavel Machek int ret = 0;
221bee3d511SPavel Machek
222bee3d511SPavel Machek mutex_lock(&coil->power_lock);
223bee3d511SPavel Machek
224bee3d511SPavel Machek /*
225bee3d511SPavel Machek * If the power count is modified from 0 to != 0 or from != 0 to 0,
226bee3d511SPavel Machek * update the power state.
227bee3d511SPavel Machek */
228bee3d511SPavel Machek if (coil->power_count == !on) {
2293933186aSSakari Ailus ret = on ? ad5820_power_on(coil, true) :
2303933186aSSakari Ailus ad5820_power_off(coil, true);
231bee3d511SPavel Machek if (ret < 0)
232bee3d511SPavel Machek goto done;
233bee3d511SPavel Machek }
234bee3d511SPavel Machek
235bee3d511SPavel Machek /* Update the power count. */
236bee3d511SPavel Machek coil->power_count += on ? 1 : -1;
237bee3d511SPavel Machek WARN_ON(coil->power_count < 0);
238bee3d511SPavel Machek
239bee3d511SPavel Machek done:
240bee3d511SPavel Machek mutex_unlock(&coil->power_lock);
241bee3d511SPavel Machek return ret;
242bee3d511SPavel Machek }
243bee3d511SPavel Machek
ad5820_open(struct v4l2_subdev * sd,struct v4l2_subdev_fh * fh)244bee3d511SPavel Machek static int ad5820_open(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh)
245bee3d511SPavel Machek {
246bee3d511SPavel Machek return ad5820_set_power(sd, 1);
247bee3d511SPavel Machek }
248bee3d511SPavel Machek
ad5820_close(struct v4l2_subdev * sd,struct v4l2_subdev_fh * fh)249bee3d511SPavel Machek static int ad5820_close(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh)
250bee3d511SPavel Machek {
251bee3d511SPavel Machek return ad5820_set_power(sd, 0);
252bee3d511SPavel Machek }
253bee3d511SPavel Machek
254bee3d511SPavel Machek static const struct v4l2_subdev_core_ops ad5820_core_ops = {
255bee3d511SPavel Machek .s_power = ad5820_set_power,
256bee3d511SPavel Machek };
257bee3d511SPavel Machek
258bee3d511SPavel Machek static const struct v4l2_subdev_ops ad5820_ops = {
259bee3d511SPavel Machek .core = &ad5820_core_ops,
260bee3d511SPavel Machek };
261bee3d511SPavel Machek
262bee3d511SPavel Machek static const struct v4l2_subdev_internal_ops ad5820_internal_ops = {
263bee3d511SPavel Machek .registered = ad5820_registered,
264bee3d511SPavel Machek .open = ad5820_open,
265bee3d511SPavel Machek .close = ad5820_close,
266bee3d511SPavel Machek };
267bee3d511SPavel Machek
268bee3d511SPavel Machek /*
269bee3d511SPavel Machek * I2C driver
270bee3d511SPavel Machek */
ad5820_suspend(struct device * dev)27137f0644fSArnd Bergmann static int __maybe_unused ad5820_suspend(struct device *dev)
272bee3d511SPavel Machek {
2733d520123SKrzysztof Kozlowski struct v4l2_subdev *subdev = dev_get_drvdata(dev);
274bee3d511SPavel Machek struct ad5820_device *coil = to_ad5820_device(subdev);
275bee3d511SPavel Machek
276bee3d511SPavel Machek if (!coil->power_count)
277bee3d511SPavel Machek return 0;
278bee3d511SPavel Machek
2793933186aSSakari Ailus return ad5820_power_off(coil, false);
280bee3d511SPavel Machek }
281bee3d511SPavel Machek
ad5820_resume(struct device * dev)28237f0644fSArnd Bergmann static int __maybe_unused ad5820_resume(struct device *dev)
283bee3d511SPavel Machek {
2843d520123SKrzysztof Kozlowski struct v4l2_subdev *subdev = dev_get_drvdata(dev);
285bee3d511SPavel Machek struct ad5820_device *coil = to_ad5820_device(subdev);
286bee3d511SPavel Machek
287bee3d511SPavel Machek if (!coil->power_count)
288bee3d511SPavel Machek return 0;
289bee3d511SPavel Machek
2903933186aSSakari Ailus return ad5820_power_on(coil, true);
291bee3d511SPavel Machek }
292bee3d511SPavel Machek
ad5820_probe(struct i2c_client * client)2934ed24a64SUwe Kleine-König static int ad5820_probe(struct i2c_client *client)
294bee3d511SPavel Machek {
295bee3d511SPavel Machek struct ad5820_device *coil;
296bee3d511SPavel Machek int ret;
297bee3d511SPavel Machek
298bee3d511SPavel Machek coil = devm_kzalloc(&client->dev, sizeof(*coil), GFP_KERNEL);
299bee3d511SPavel Machek if (!coil)
300bee3d511SPavel Machek return -ENOMEM;
301bee3d511SPavel Machek
302bee3d511SPavel Machek coil->vana = devm_regulator_get(&client->dev, "VANA");
3036cb7d1b3SYang Yingliang if (IS_ERR(coil->vana))
3046cb7d1b3SYang Yingliang return dev_err_probe(&client->dev, PTR_ERR(coil->vana),
3056cb7d1b3SYang Yingliang "could not get regulator for vana\n");
306bee3d511SPavel Machek
307c01674e7SRicardo Ribalda Delgado coil->enable_gpio = devm_gpiod_get_optional(&client->dev, "enable",
308c01674e7SRicardo Ribalda Delgado GPIOD_OUT_LOW);
3096cb7d1b3SYang Yingliang if (IS_ERR(coil->enable_gpio))
3106cb7d1b3SYang Yingliang return dev_err_probe(&client->dev, PTR_ERR(coil->enable_gpio),
3116cb7d1b3SYang Yingliang "could not get enable gpio\n");
312c01674e7SRicardo Ribalda Delgado
313bee3d511SPavel Machek mutex_init(&coil->power_lock);
314bee3d511SPavel Machek
315bee3d511SPavel Machek v4l2_i2c_subdev_init(&coil->subdev, client, &ad5820_ops);
316bee3d511SPavel Machek coil->subdev.flags |= V4L2_SUBDEV_FL_HAS_DEVNODE;
317bee3d511SPavel Machek coil->subdev.internal_ops = &ad5820_internal_ops;
318801ef7c4SRicardo Ribalda Delgado coil->subdev.entity.function = MEDIA_ENT_F_LENS;
319cc1e6315SMauro Carvalho Chehab strscpy(coil->subdev.name, "ad5820 focus", sizeof(coil->subdev.name));
320bee3d511SPavel Machek
321bee3d511SPavel Machek ret = media_entity_pads_init(&coil->subdev.entity, 0, NULL);
322bee3d511SPavel Machek if (ret < 0)
3239fce2416SRicardo Ribalda goto clean_mutex;
324bee3d511SPavel Machek
325bee3d511SPavel Machek ret = v4l2_async_register_subdev(&coil->subdev);
326bee3d511SPavel Machek if (ret < 0)
3279fce2416SRicardo Ribalda goto clean_entity;
328bee3d511SPavel Machek
329bee3d511SPavel Machek return ret;
330bee3d511SPavel Machek
3319fce2416SRicardo Ribalda clean_entity:
332bee3d511SPavel Machek media_entity_cleanup(&coil->subdev.entity);
3339fce2416SRicardo Ribalda clean_mutex:
3349fce2416SRicardo Ribalda mutex_destroy(&coil->power_lock);
335bee3d511SPavel Machek return ret;
336bee3d511SPavel Machek }
337bee3d511SPavel Machek
ad5820_remove(struct i2c_client * client)338ed5c2f5fSUwe Kleine-König static void ad5820_remove(struct i2c_client *client)
339bee3d511SPavel Machek {
340bee3d511SPavel Machek struct v4l2_subdev *subdev = i2c_get_clientdata(client);
341bee3d511SPavel Machek struct ad5820_device *coil = to_ad5820_device(subdev);
342bee3d511SPavel Machek
343586248a7SSakari Ailus v4l2_async_unregister_subdev(&coil->subdev);
344bee3d511SPavel Machek v4l2_ctrl_handler_free(&coil->ctrls);
345bee3d511SPavel Machek media_entity_cleanup(&coil->subdev.entity);
346bee3d511SPavel Machek mutex_destroy(&coil->power_lock);
347bee3d511SPavel Machek }
348bee3d511SPavel Machek
349bee3d511SPavel Machek static const struct i2c_device_id ad5820_id_table[] = {
350b8bf7313SRicardo Ribalda Delgado { "ad5820", 0 },
351b8bf7313SRicardo Ribalda Delgado { "ad5821", 0 },
352bee3d511SPavel Machek { }
353bee3d511SPavel Machek };
354bee3d511SPavel Machek MODULE_DEVICE_TABLE(i2c, ad5820_id_table);
355bee3d511SPavel Machek
3561c7ae4a5SRicardo Ribalda Delgado static const struct of_device_id ad5820_of_table[] = {
3571c7ae4a5SRicardo Ribalda Delgado { .compatible = "adi,ad5820" },
358b8bf7313SRicardo Ribalda Delgado { .compatible = "adi,ad5821" },
3591c7ae4a5SRicardo Ribalda Delgado { }
3601c7ae4a5SRicardo Ribalda Delgado };
3611c7ae4a5SRicardo Ribalda Delgado MODULE_DEVICE_TABLE(of, ad5820_of_table);
3621c7ae4a5SRicardo Ribalda Delgado
363bee3d511SPavel Machek static SIMPLE_DEV_PM_OPS(ad5820_pm, ad5820_suspend, ad5820_resume);
364bee3d511SPavel Machek
365bee3d511SPavel Machek static struct i2c_driver ad5820_i2c_driver = {
366bee3d511SPavel Machek .driver = {
367b8bf7313SRicardo Ribalda Delgado .name = "ad5820",
368bee3d511SPavel Machek .pm = &ad5820_pm,
3691c7ae4a5SRicardo Ribalda Delgado .of_match_table = ad5820_of_table,
370bee3d511SPavel Machek },
371*aaeb31c0SUwe Kleine-König .probe = ad5820_probe,
37278cea55cSDmitry Torokhov .remove = ad5820_remove,
373bee3d511SPavel Machek .id_table = ad5820_id_table,
374bee3d511SPavel Machek };
375bee3d511SPavel Machek
376bee3d511SPavel Machek module_i2c_driver(ad5820_i2c_driver);
377bee3d511SPavel Machek
378bee3d511SPavel Machek MODULE_AUTHOR("Tuukka Toivonen");
379bee3d511SPavel Machek MODULE_DESCRIPTION("AD5820 camera lens driver");
380bee3d511SPavel Machek MODULE_LICENSE("GPL");
381