2 * Copyright (c) 2015--2017 Intel Corporation.
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public License version
6 * 2 as published by the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
14 #include <linux/delay.h>
15 #include <linux/i2c.h>
16 #include <linux/module.h>
17 #include <linux/pm_runtime.h>
18 #include <media/v4l2-ctrls.h>
19 #include <media/v4l2-device.h>
21 #define DW9714_NAME "dw9714"
22 #define DW9714_MAX_FOCUS_POS 1023
24 * This acts as the minimum granularity of lens movement.
25 * Keep this value power of 2, so the control steps can be
26 * uniformly adjusted for gradual lens movement, with desired
27 * number of control steps.
29 #define DW9714_CTRL_STEPS 16
30 #define DW9714_CTRL_DELAY_US 1000
32 * S[3:2] = 0x00, codes per step for "Linear Slope Control"
33 * S[1:0] = 0x00, step period
35 #define DW9714_DEFAULT_S 0x0
36 #define DW9714_VAL(data, s) ((data) << 4 | (s))
38 /* dw9714 device structure */
39 struct dw9714_device {
40 struct i2c_client *client;
41 struct v4l2_ctrl_handler ctrls_vcm;
42 struct v4l2_subdev sd;
46 static inline struct dw9714_device *to_dw9714_vcm(struct v4l2_ctrl *ctrl)
48 return container_of(ctrl->handler, struct dw9714_device, ctrls_vcm);
51 static inline struct dw9714_device *sd_to_dw9714_vcm(struct v4l2_subdev *subdev)
53 return container_of(subdev, struct dw9714_device, sd);
56 static int dw9714_i2c_write(struct i2c_client *client, u16 data)
59 u16 val = cpu_to_be16(data);
61 ret = i2c_master_send(client, (const char *)&val, sizeof(val));
62 if (ret != sizeof(val)) {
63 dev_err(&client->dev, "I2C write fail\n");
69 static int dw9714_t_focus_vcm(struct dw9714_device *dw9714_dev, u16 val)
71 struct i2c_client *client = dw9714_dev->client;
73 dw9714_dev->current_val = val;
75 return dw9714_i2c_write(client, DW9714_VAL(val, DW9714_DEFAULT_S));
78 static int dw9714_set_ctrl(struct v4l2_ctrl *ctrl)
80 struct dw9714_device *dev_vcm = to_dw9714_vcm(ctrl);
82 if (ctrl->id == V4L2_CID_FOCUS_ABSOLUTE)
83 return dw9714_t_focus_vcm(dev_vcm, ctrl->val);
88 static const struct v4l2_ctrl_ops dw9714_vcm_ctrl_ops = {
89 .s_ctrl = dw9714_set_ctrl,
92 static int dw9714_open(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh)
94 struct dw9714_device *dw9714_dev = sd_to_dw9714_vcm(sd);
95 struct device *dev = &dw9714_dev->client->dev;
98 rval = pm_runtime_get_sync(dev);
100 pm_runtime_put_noidle(dev);
107 static int dw9714_close(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh)
109 struct dw9714_device *dw9714_dev = sd_to_dw9714_vcm(sd);
110 struct device *dev = &dw9714_dev->client->dev;
117 static const struct v4l2_subdev_internal_ops dw9714_int_ops = {
119 .close = dw9714_close,
122 static const struct v4l2_subdev_ops dw9714_ops = { };
124 static void dw9714_subdev_cleanup(struct dw9714_device *dw9714_dev)
126 v4l2_async_unregister_subdev(&dw9714_dev->sd);
127 v4l2_ctrl_handler_free(&dw9714_dev->ctrls_vcm);
128 media_entity_cleanup(&dw9714_dev->sd.entity);
131 static int dw9714_init_controls(struct dw9714_device *dev_vcm)
133 struct v4l2_ctrl_handler *hdl = &dev_vcm->ctrls_vcm;
134 const struct v4l2_ctrl_ops *ops = &dw9714_vcm_ctrl_ops;
135 struct i2c_client *client = dev_vcm->client;
137 v4l2_ctrl_handler_init(hdl, 1);
139 v4l2_ctrl_new_std(hdl, ops, V4L2_CID_FOCUS_ABSOLUTE,
140 0, DW9714_MAX_FOCUS_POS, DW9714_CTRL_STEPS, 0);
143 dev_err(&client->dev, "%s fail error: 0x%x\n",
144 __func__, hdl->error);
145 dev_vcm->sd.ctrl_handler = hdl;
149 static int dw9714_probe(struct i2c_client *client)
151 struct dw9714_device *dw9714_dev;
154 dw9714_dev = devm_kzalloc(&client->dev, sizeof(*dw9714_dev),
156 if (dw9714_dev == NULL)
159 dw9714_dev->client = client;
161 v4l2_i2c_subdev_init(&dw9714_dev->sd, client, &dw9714_ops);
162 dw9714_dev->sd.flags |= V4L2_SUBDEV_FL_HAS_DEVNODE;
163 dw9714_dev->sd.internal_ops = &dw9714_int_ops;
165 rval = dw9714_init_controls(dw9714_dev);
169 rval = media_entity_pads_init(&dw9714_dev->sd.entity, 0, NULL);
173 dw9714_dev->sd.entity.function = MEDIA_ENT_F_LENS;
175 rval = v4l2_async_register_subdev(&dw9714_dev->sd);
179 pm_runtime_set_active(&client->dev);
180 pm_runtime_enable(&client->dev);
185 v4l2_ctrl_handler_free(&dw9714_dev->ctrls_vcm);
186 media_entity_cleanup(&dw9714_dev->sd.entity);
187 dev_err(&client->dev, "Probe failed: %d\n", rval);
191 static int dw9714_remove(struct i2c_client *client)
193 struct v4l2_subdev *sd = i2c_get_clientdata(client);
194 struct dw9714_device *dw9714_dev = sd_to_dw9714_vcm(sd);
196 pm_runtime_disable(&client->dev);
197 dw9714_subdev_cleanup(dw9714_dev);
203 * This function sets the vcm position, so it consumes least current
204 * The lens position is gradually moved in units of DW9714_CTRL_STEPS,
205 * to make the movements smoothly.
207 static int __maybe_unused dw9714_vcm_suspend(struct device *dev)
209 struct i2c_client *client = to_i2c_client(dev);
210 struct v4l2_subdev *sd = i2c_get_clientdata(client);
211 struct dw9714_device *dw9714_dev = sd_to_dw9714_vcm(sd);
214 for (val = dw9714_dev->current_val & ~(DW9714_CTRL_STEPS - 1);
215 val >= 0; val -= DW9714_CTRL_STEPS) {
216 ret = dw9714_i2c_write(client,
217 DW9714_VAL(val, DW9714_DEFAULT_S));
219 dev_err_once(dev, "%s I2C failure: %d", __func__, ret);
220 usleep_range(DW9714_CTRL_DELAY_US, DW9714_CTRL_DELAY_US + 10);
226 * This function sets the vcm position to the value set by the user
227 * through v4l2_ctrl_ops s_ctrl handler
228 * The lens position is gradually moved in units of DW9714_CTRL_STEPS,
229 * to make the movements smoothly.
231 static int __maybe_unused dw9714_vcm_resume(struct device *dev)
233 struct i2c_client *client = to_i2c_client(dev);
234 struct v4l2_subdev *sd = i2c_get_clientdata(client);
235 struct dw9714_device *dw9714_dev = sd_to_dw9714_vcm(sd);
238 for (val = dw9714_dev->current_val % DW9714_CTRL_STEPS;
239 val < dw9714_dev->current_val + DW9714_CTRL_STEPS - 1;
240 val += DW9714_CTRL_STEPS) {
241 ret = dw9714_i2c_write(client,
242 DW9714_VAL(val, DW9714_DEFAULT_S));
244 dev_err_ratelimited(dev, "%s I2C failure: %d",
246 usleep_range(DW9714_CTRL_DELAY_US, DW9714_CTRL_DELAY_US + 10);
252 static const struct i2c_device_id dw9714_id_table[] = {
256 MODULE_DEVICE_TABLE(i2c, dw9714_id_table);
258 static const struct of_device_id dw9714_of_table[] = {
259 { .compatible = "dongwoon,dw9714" },
262 MODULE_DEVICE_TABLE(of, dw9714_of_table);
264 static const struct dev_pm_ops dw9714_pm_ops = {
265 SET_SYSTEM_SLEEP_PM_OPS(dw9714_vcm_suspend, dw9714_vcm_resume)
266 SET_RUNTIME_PM_OPS(dw9714_vcm_suspend, dw9714_vcm_resume, NULL)
269 static struct i2c_driver dw9714_i2c_driver = {
272 .pm = &dw9714_pm_ops,
273 .of_match_table = dw9714_of_table,
275 .probe_new = dw9714_probe,
276 .remove = dw9714_remove,
277 .id_table = dw9714_id_table,
280 module_i2c_driver(dw9714_i2c_driver);
282 MODULE_AUTHOR("Tianshu Qiu <tian.shu.qiu@intel.com>");
283 MODULE_AUTHOR("Jian Xu Zheng <jian.xu.zheng@intel.com>");
284 MODULE_AUTHOR("Yuning Pu <yuning.pu@intel.com>");
285 MODULE_AUTHOR("Jouni Ukkonen <jouni.ukkonen@intel.com>");
286 MODULE_AUTHOR("Tommi Franttila <tommi.franttila@intel.com>");
287 MODULE_DESCRIPTION("DW9714 VCM driver");
288 MODULE_LICENSE("GPL v2");