1136fe992SRajmohan Mani // SPDX-License-Identifier: GPL-2.0 2136fe992SRajmohan Mani // Copyright (c) 2015--2017 Intel Corporation. 3cc95d342SRajmohan Mani 4cc95d342SRajmohan Mani #include <linux/delay.h> 5cc95d342SRajmohan Mani #include <linux/i2c.h> 6cc95d342SRajmohan Mani #include <linux/module.h> 7cc95d342SRajmohan Mani #include <linux/pm_runtime.h> 8cc95d342SRajmohan Mani #include <media/v4l2-ctrls.h> 9cc95d342SRajmohan Mani #include <media/v4l2-device.h> 10*98442bd0SRicardo Ribalda #include <media/v4l2-event.h> 11cc95d342SRajmohan Mani 12cc95d342SRajmohan Mani #define DW9714_NAME "dw9714" 13cc95d342SRajmohan Mani #define DW9714_MAX_FOCUS_POS 1023 14cc95d342SRajmohan Mani /* 151a58fbf5SRajmohan Mani * This sets the minimum granularity for the focus positions. 161a58fbf5SRajmohan Mani * A value of 1 gives maximum accuracy for a desired focus position 171a58fbf5SRajmohan Mani */ 181a58fbf5SRajmohan Mani #define DW9714_FOCUS_STEPS 1 191a58fbf5SRajmohan Mani /* 20cc95d342SRajmohan Mani * This acts as the minimum granularity of lens movement. 21cc95d342SRajmohan Mani * Keep this value power of 2, so the control steps can be 22cc95d342SRajmohan Mani * uniformly adjusted for gradual lens movement, with desired 23cc95d342SRajmohan Mani * number of control steps. 24cc95d342SRajmohan Mani */ 25cc95d342SRajmohan Mani #define DW9714_CTRL_STEPS 16 26cc95d342SRajmohan Mani #define DW9714_CTRL_DELAY_US 1000 27cc95d342SRajmohan Mani /* 28cc95d342SRajmohan Mani * S[3:2] = 0x00, codes per step for "Linear Slope Control" 29cc95d342SRajmohan Mani * S[1:0] = 0x00, step period 30cc95d342SRajmohan Mani */ 31cc95d342SRajmohan Mani #define DW9714_DEFAULT_S 0x0 32cc95d342SRajmohan Mani #define DW9714_VAL(data, s) ((data) << 4 | (s)) 33cc95d342SRajmohan Mani 34cc95d342SRajmohan Mani /* dw9714 device structure */ 35cc95d342SRajmohan Mani struct dw9714_device { 36cc95d342SRajmohan Mani struct v4l2_ctrl_handler ctrls_vcm; 37cc95d342SRajmohan Mani struct v4l2_subdev sd; 38cc95d342SRajmohan Mani u16 current_val; 39cc95d342SRajmohan Mani }; 40cc95d342SRajmohan Mani 41cc95d342SRajmohan Mani static inline struct dw9714_device *to_dw9714_vcm(struct v4l2_ctrl *ctrl) 42cc95d342SRajmohan Mani { 43cc95d342SRajmohan Mani return container_of(ctrl->handler, struct dw9714_device, ctrls_vcm); 44cc95d342SRajmohan Mani } 45cc95d342SRajmohan Mani 46cc95d342SRajmohan Mani static inline struct dw9714_device *sd_to_dw9714_vcm(struct v4l2_subdev *subdev) 47cc95d342SRajmohan Mani { 48cc95d342SRajmohan Mani return container_of(subdev, struct dw9714_device, sd); 49cc95d342SRajmohan Mani } 50cc95d342SRajmohan Mani 51cc95d342SRajmohan Mani static int dw9714_i2c_write(struct i2c_client *client, u16 data) 52cc95d342SRajmohan Mani { 53cc95d342SRajmohan Mani int ret; 54a4a02b6eSMauro Carvalho Chehab __be16 val = cpu_to_be16(data); 55cc95d342SRajmohan Mani 56cc95d342SRajmohan Mani ret = i2c_master_send(client, (const char *)&val, sizeof(val)); 57cc95d342SRajmohan Mani if (ret != sizeof(val)) { 58cc95d342SRajmohan Mani dev_err(&client->dev, "I2C write fail\n"); 59cc95d342SRajmohan Mani return -EIO; 60cc95d342SRajmohan Mani } 61cc95d342SRajmohan Mani return 0; 62cc95d342SRajmohan Mani } 63cc95d342SRajmohan Mani 64cc95d342SRajmohan Mani static int dw9714_t_focus_vcm(struct dw9714_device *dw9714_dev, u16 val) 65cc95d342SRajmohan Mani { 66a69e9972SSakari Ailus struct i2c_client *client = v4l2_get_subdevdata(&dw9714_dev->sd); 67cc95d342SRajmohan Mani 68cc95d342SRajmohan Mani dw9714_dev->current_val = val; 69cc95d342SRajmohan Mani 70cc95d342SRajmohan Mani return dw9714_i2c_write(client, DW9714_VAL(val, DW9714_DEFAULT_S)); 71cc95d342SRajmohan Mani } 72cc95d342SRajmohan Mani 73cc95d342SRajmohan Mani static int dw9714_set_ctrl(struct v4l2_ctrl *ctrl) 74cc95d342SRajmohan Mani { 75cc95d342SRajmohan Mani struct dw9714_device *dev_vcm = to_dw9714_vcm(ctrl); 76cc95d342SRajmohan Mani 77cc95d342SRajmohan Mani if (ctrl->id == V4L2_CID_FOCUS_ABSOLUTE) 78cc95d342SRajmohan Mani return dw9714_t_focus_vcm(dev_vcm, ctrl->val); 79cc95d342SRajmohan Mani 80cc95d342SRajmohan Mani return -EINVAL; 81cc95d342SRajmohan Mani } 82cc95d342SRajmohan Mani 83cc95d342SRajmohan Mani static const struct v4l2_ctrl_ops dw9714_vcm_ctrl_ops = { 84cc95d342SRajmohan Mani .s_ctrl = dw9714_set_ctrl, 85cc95d342SRajmohan Mani }; 86cc95d342SRajmohan Mani 87cc95d342SRajmohan Mani static int dw9714_open(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh) 88cc95d342SRajmohan Mani { 897917f279SMauro Carvalho Chehab return pm_runtime_resume_and_get(sd->dev); 90cc95d342SRajmohan Mani } 91cc95d342SRajmohan Mani 92cc95d342SRajmohan Mani static int dw9714_close(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh) 93cc95d342SRajmohan Mani { 94a69e9972SSakari Ailus pm_runtime_put(sd->dev); 95cc95d342SRajmohan Mani 96cc95d342SRajmohan Mani return 0; 97cc95d342SRajmohan Mani } 98cc95d342SRajmohan Mani 99cc95d342SRajmohan Mani static const struct v4l2_subdev_internal_ops dw9714_int_ops = { 100cc95d342SRajmohan Mani .open = dw9714_open, 101cc95d342SRajmohan Mani .close = dw9714_close, 102cc95d342SRajmohan Mani }; 103cc95d342SRajmohan Mani 104*98442bd0SRicardo Ribalda static const struct v4l2_subdev_core_ops dw9714_core_ops = { 105*98442bd0SRicardo Ribalda .log_status = v4l2_ctrl_subdev_log_status, 106*98442bd0SRicardo Ribalda .subscribe_event = v4l2_ctrl_subdev_subscribe_event, 107*98442bd0SRicardo Ribalda .unsubscribe_event = v4l2_event_subdev_unsubscribe, 108*98442bd0SRicardo Ribalda }; 109*98442bd0SRicardo Ribalda 110*98442bd0SRicardo Ribalda static const struct v4l2_subdev_ops dw9714_ops = { 111*98442bd0SRicardo Ribalda .core = &dw9714_core_ops, 112*98442bd0SRicardo Ribalda }; 113cc95d342SRajmohan Mani 114cc95d342SRajmohan Mani static void dw9714_subdev_cleanup(struct dw9714_device *dw9714_dev) 115cc95d342SRajmohan Mani { 116cc95d342SRajmohan Mani v4l2_async_unregister_subdev(&dw9714_dev->sd); 117cc95d342SRajmohan Mani v4l2_ctrl_handler_free(&dw9714_dev->ctrls_vcm); 118cc95d342SRajmohan Mani media_entity_cleanup(&dw9714_dev->sd.entity); 119cc95d342SRajmohan Mani } 120cc95d342SRajmohan Mani 121cc95d342SRajmohan Mani static int dw9714_init_controls(struct dw9714_device *dev_vcm) 122cc95d342SRajmohan Mani { 123cc95d342SRajmohan Mani struct v4l2_ctrl_handler *hdl = &dev_vcm->ctrls_vcm; 124cc95d342SRajmohan Mani const struct v4l2_ctrl_ops *ops = &dw9714_vcm_ctrl_ops; 125cc95d342SRajmohan Mani 126cc95d342SRajmohan Mani v4l2_ctrl_handler_init(hdl, 1); 127cc95d342SRajmohan Mani 128cc95d342SRajmohan Mani v4l2_ctrl_new_std(hdl, ops, V4L2_CID_FOCUS_ABSOLUTE, 1291a58fbf5SRajmohan Mani 0, DW9714_MAX_FOCUS_POS, DW9714_FOCUS_STEPS, 0); 130cc95d342SRajmohan Mani 131cc95d342SRajmohan Mani if (hdl->error) 132a69e9972SSakari Ailus dev_err(dev_vcm->sd.dev, "%s fail error: 0x%x\n", 133cc95d342SRajmohan Mani __func__, hdl->error); 134cc95d342SRajmohan Mani dev_vcm->sd.ctrl_handler = hdl; 135cc95d342SRajmohan Mani return hdl->error; 136cc95d342SRajmohan Mani } 137cc95d342SRajmohan Mani 138f758eb23SSakari Ailus static int dw9714_probe(struct i2c_client *client) 139cc95d342SRajmohan Mani { 140cc95d342SRajmohan Mani struct dw9714_device *dw9714_dev; 141cc95d342SRajmohan Mani int rval; 142cc95d342SRajmohan Mani 143cc95d342SRajmohan Mani dw9714_dev = devm_kzalloc(&client->dev, sizeof(*dw9714_dev), 144cc95d342SRajmohan Mani GFP_KERNEL); 145cc95d342SRajmohan Mani if (dw9714_dev == NULL) 146cc95d342SRajmohan Mani return -ENOMEM; 147cc95d342SRajmohan Mani 148cc95d342SRajmohan Mani v4l2_i2c_subdev_init(&dw9714_dev->sd, client, &dw9714_ops); 149*98442bd0SRicardo Ribalda dw9714_dev->sd.flags |= V4L2_SUBDEV_FL_HAS_DEVNODE | 150*98442bd0SRicardo Ribalda V4L2_SUBDEV_FL_HAS_EVENTS; 151cc95d342SRajmohan Mani dw9714_dev->sd.internal_ops = &dw9714_int_ops; 152cc95d342SRajmohan Mani 153cc95d342SRajmohan Mani rval = dw9714_init_controls(dw9714_dev); 154cc95d342SRajmohan Mani if (rval) 155cc95d342SRajmohan Mani goto err_cleanup; 156cc95d342SRajmohan Mani 157cc95d342SRajmohan Mani rval = media_entity_pads_init(&dw9714_dev->sd.entity, 0, NULL); 158cc95d342SRajmohan Mani if (rval < 0) 159cc95d342SRajmohan Mani goto err_cleanup; 160cc95d342SRajmohan Mani 161cc95d342SRajmohan Mani dw9714_dev->sd.entity.function = MEDIA_ENT_F_LENS; 162cc95d342SRajmohan Mani 163cc95d342SRajmohan Mani rval = v4l2_async_register_subdev(&dw9714_dev->sd); 164cc95d342SRajmohan Mani if (rval < 0) 165cc95d342SRajmohan Mani goto err_cleanup; 166cc95d342SRajmohan Mani 167cc95d342SRajmohan Mani pm_runtime_set_active(&client->dev); 168cc95d342SRajmohan Mani pm_runtime_enable(&client->dev); 169fa429334SSakari Ailus pm_runtime_idle(&client->dev); 170cc95d342SRajmohan Mani 171cc95d342SRajmohan Mani return 0; 172cc95d342SRajmohan Mani 173cc95d342SRajmohan Mani err_cleanup: 174f9a0b142SRajmohan Mani v4l2_ctrl_handler_free(&dw9714_dev->ctrls_vcm); 175f9a0b142SRajmohan Mani media_entity_cleanup(&dw9714_dev->sd.entity); 1761c55ecabSSakari Ailus 177cc95d342SRajmohan Mani return rval; 178cc95d342SRajmohan Mani } 179cc95d342SRajmohan Mani 180cc95d342SRajmohan Mani static int dw9714_remove(struct i2c_client *client) 181cc95d342SRajmohan Mani { 182cc95d342SRajmohan Mani struct v4l2_subdev *sd = i2c_get_clientdata(client); 183cc95d342SRajmohan Mani struct dw9714_device *dw9714_dev = sd_to_dw9714_vcm(sd); 184cc95d342SRajmohan Mani 185cc95d342SRajmohan Mani pm_runtime_disable(&client->dev); 186cc95d342SRajmohan Mani dw9714_subdev_cleanup(dw9714_dev); 187cc95d342SRajmohan Mani 188cc95d342SRajmohan Mani return 0; 189cc95d342SRajmohan Mani } 190cc95d342SRajmohan Mani 191cc95d342SRajmohan Mani /* 192cc95d342SRajmohan Mani * This function sets the vcm position, so it consumes least current 193cc95d342SRajmohan Mani * The lens position is gradually moved in units of DW9714_CTRL_STEPS, 194cc95d342SRajmohan Mani * to make the movements smoothly. 195cc95d342SRajmohan Mani */ 196cc95d342SRajmohan Mani static int __maybe_unused dw9714_vcm_suspend(struct device *dev) 197cc95d342SRajmohan Mani { 198cc95d342SRajmohan Mani struct i2c_client *client = to_i2c_client(dev); 199cc95d342SRajmohan Mani struct v4l2_subdev *sd = i2c_get_clientdata(client); 200cc95d342SRajmohan Mani struct dw9714_device *dw9714_dev = sd_to_dw9714_vcm(sd); 201cc95d342SRajmohan Mani int ret, val; 202cc95d342SRajmohan Mani 203cc95d342SRajmohan Mani for (val = dw9714_dev->current_val & ~(DW9714_CTRL_STEPS - 1); 204cc95d342SRajmohan Mani val >= 0; val -= DW9714_CTRL_STEPS) { 205cc95d342SRajmohan Mani ret = dw9714_i2c_write(client, 206cc95d342SRajmohan Mani DW9714_VAL(val, DW9714_DEFAULT_S)); 207cc95d342SRajmohan Mani if (ret) 208cc95d342SRajmohan Mani dev_err_once(dev, "%s I2C failure: %d", __func__, ret); 209cc95d342SRajmohan Mani usleep_range(DW9714_CTRL_DELAY_US, DW9714_CTRL_DELAY_US + 10); 210cc95d342SRajmohan Mani } 211cc95d342SRajmohan Mani return 0; 212cc95d342SRajmohan Mani } 213cc95d342SRajmohan Mani 214cc95d342SRajmohan Mani /* 215cc95d342SRajmohan Mani * This function sets the vcm position to the value set by the user 216cc95d342SRajmohan Mani * through v4l2_ctrl_ops s_ctrl handler 217cc95d342SRajmohan Mani * The lens position is gradually moved in units of DW9714_CTRL_STEPS, 218cc95d342SRajmohan Mani * to make the movements smoothly. 219cc95d342SRajmohan Mani */ 220cc95d342SRajmohan Mani static int __maybe_unused dw9714_vcm_resume(struct device *dev) 221cc95d342SRajmohan Mani { 222cc95d342SRajmohan Mani struct i2c_client *client = to_i2c_client(dev); 223cc95d342SRajmohan Mani struct v4l2_subdev *sd = i2c_get_clientdata(client); 224cc95d342SRajmohan Mani struct dw9714_device *dw9714_dev = sd_to_dw9714_vcm(sd); 225cc95d342SRajmohan Mani int ret, val; 226cc95d342SRajmohan Mani 227cc95d342SRajmohan Mani for (val = dw9714_dev->current_val % DW9714_CTRL_STEPS; 228cc95d342SRajmohan Mani val < dw9714_dev->current_val + DW9714_CTRL_STEPS - 1; 229cc95d342SRajmohan Mani val += DW9714_CTRL_STEPS) { 230cc95d342SRajmohan Mani ret = dw9714_i2c_write(client, 231cc95d342SRajmohan Mani DW9714_VAL(val, DW9714_DEFAULT_S)); 232cc95d342SRajmohan Mani if (ret) 233cc95d342SRajmohan Mani dev_err_ratelimited(dev, "%s I2C failure: %d", 234cc95d342SRajmohan Mani __func__, ret); 235cc95d342SRajmohan Mani usleep_range(DW9714_CTRL_DELAY_US, DW9714_CTRL_DELAY_US + 10); 236cc95d342SRajmohan Mani } 237cc95d342SRajmohan Mani 238cc95d342SRajmohan Mani return 0; 239cc95d342SRajmohan Mani } 240cc95d342SRajmohan Mani 241cc95d342SRajmohan Mani static const struct i2c_device_id dw9714_id_table[] = { 242cc95d342SRajmohan Mani { DW9714_NAME, 0 }, 243f758eb23SSakari Ailus { { 0 } } 244cc95d342SRajmohan Mani }; 245cc95d342SRajmohan Mani MODULE_DEVICE_TABLE(i2c, dw9714_id_table); 246cc95d342SRajmohan Mani 247c2bc8b06SSakari Ailus static const struct of_device_id dw9714_of_table[] = { 248c2bc8b06SSakari Ailus { .compatible = "dongwoon,dw9714" }, 249c2bc8b06SSakari Ailus { { 0 } } 250c2bc8b06SSakari Ailus }; 251c2bc8b06SSakari Ailus MODULE_DEVICE_TABLE(of, dw9714_of_table); 252c2bc8b06SSakari Ailus 253cc95d342SRajmohan Mani static const struct dev_pm_ops dw9714_pm_ops = { 254cc95d342SRajmohan Mani SET_SYSTEM_SLEEP_PM_OPS(dw9714_vcm_suspend, dw9714_vcm_resume) 255cc95d342SRajmohan Mani SET_RUNTIME_PM_OPS(dw9714_vcm_suspend, dw9714_vcm_resume, NULL) 256cc95d342SRajmohan Mani }; 257cc95d342SRajmohan Mani 258cc95d342SRajmohan Mani static struct i2c_driver dw9714_i2c_driver = { 259cc95d342SRajmohan Mani .driver = { 260cc95d342SRajmohan Mani .name = DW9714_NAME, 261cc95d342SRajmohan Mani .pm = &dw9714_pm_ops, 262c2bc8b06SSakari Ailus .of_match_table = dw9714_of_table, 263cc95d342SRajmohan Mani }, 264f758eb23SSakari Ailus .probe_new = dw9714_probe, 265cc95d342SRajmohan Mani .remove = dw9714_remove, 266cc95d342SRajmohan Mani .id_table = dw9714_id_table, 267cc95d342SRajmohan Mani }; 268cc95d342SRajmohan Mani 269cc95d342SRajmohan Mani module_i2c_driver(dw9714_i2c_driver); 270cc95d342SRajmohan Mani 271cc95d342SRajmohan Mani MODULE_AUTHOR("Tianshu Qiu <tian.shu.qiu@intel.com>"); 2728f57763eSSakari Ailus MODULE_AUTHOR("Jian Xu Zheng"); 273cc95d342SRajmohan Mani MODULE_AUTHOR("Yuning Pu <yuning.pu@intel.com>"); 274cc95d342SRajmohan Mani MODULE_AUTHOR("Jouni Ukkonen <jouni.ukkonen@intel.com>"); 275cc95d342SRajmohan Mani MODULE_AUTHOR("Tommi Franttila <tommi.franttila@intel.com>"); 276cc95d342SRajmohan Mani MODULE_DESCRIPTION("DW9714 VCM driver"); 277cc95d342SRajmohan Mani MODULE_LICENSE("GPL v2"); 278