// SPDX-License-Identifier: GPL-2.0-only
/*
 * drivers/media/i2c/lm3560.c
 * General device driver for TI lm3559, lm3560, FLASH LED Driver
 *
 * Copyright (C) 2013 Texas Instruments
 *
 * Contact: Daniel Jeong <gshark.jeong@gmail.com>
 *                      Ldd-Mlp <ldd-mlp@list.ti.com>
 */

#include <linux/delay.h>
#include <linux/module.h>
#include <linux/i2c.h>
#include <linux/slab.h>
#include <linux/mutex.h>
#include <linux/regmap.h>
#include <linux/videodev2.h>
#include <media/i2c/lm3560.h>
#include <media/v4l2-ctrls.h>
#include <media/v4l2-device.h>

/* registers definitions */
#define REG_ENABLE              0x10
#define REG_TORCH_BR    0xa0
#define REG_FLASH_BR    0xb0
#define REG_FLASH_TOUT  0xc0
#define REG_FLAG                0xd0
#define REG_CONFIG1             0xe0

/* fault mask */
#define FAULT_TIMEOUT   (1<<0)
#define FAULT_OVERTEMP  (1<<1)
#define FAULT_SHORT_CIRCUIT     (1<<2)

enum led_enable {
        MODE_SHDN = 0x0,
        MODE_TORCH = 0x2,
        MODE_FLASH = 0x3,
};

/**
 * struct lm3560_flash
 *
 * @dev: pointer to &struct device
 * @pdata: platform data
 * @regmap: reg. map for i2c
 * @lock: muxtex for serial access.
 * @led_mode: V4L2 LED mode
 * @ctrls_led: V4L2 controls
 * @subdev_led: V4L2 subdev
 */
struct lm3560_flash {
        struct device *dev;
        struct lm3560_platform_data *pdata;
        struct regmap *regmap;
        struct mutex lock;

        enum v4l2_flash_led_mode led_mode;
        struct v4l2_ctrl_handler ctrls_led[LM3560_LED_MAX];
        struct v4l2_subdev subdev_led[LM3560_LED_MAX];
};

#define to_lm3560_flash(_ctrl, _no)     \
        container_of(_ctrl->handler, struct lm3560_flash, ctrls_led[_no])

/* enable mode control */
static int lm3560_mode_ctrl(struct lm3560_flash *flash)
{
        int rval = -EINVAL;

        switch (flash->led_mode) {
        case V4L2_FLASH_LED_MODE_NONE:
                rval = regmap_update_bits(flash->regmap,
                                          REG_ENABLE, 0x03, MODE_SHDN);
                break;
        case V4L2_FLASH_LED_MODE_TORCH:
                rval = regmap_update_bits(flash->regmap,
                                          REG_ENABLE, 0x03, MODE_TORCH);
                break;
        case V4L2_FLASH_LED_MODE_FLASH:
                rval = regmap_update_bits(flash->regmap,
                                          REG_ENABLE, 0x03, MODE_FLASH);
                break;
        }
        return rval;
}

/* led1/2 enable/disable */
static int lm3560_enable_ctrl(struct lm3560_flash *flash,
                              enum lm3560_led_id led_no, bool on)
{
        int rval;

        if (led_no == LM3560_LED0) {
                if (on)
                        rval = regmap_update_bits(flash->regmap,
                                                  REG_ENABLE, 0x08, 0x08);
                else
                        rval = regmap_update_bits(flash->regmap,
                                                  REG_ENABLE, 0x08, 0x00);
        } else {
                if (on)
                        rval = regmap_update_bits(flash->regmap,
                                                  REG_ENABLE, 0x10, 0x10);
                else
                        rval = regmap_update_bits(flash->regmap,
                                                  REG_ENABLE, 0x10, 0x00);
        }
        return rval;
}

/* torch1/2 brightness control */
static int lm3560_torch_brt_ctrl(struct lm3560_flash *flash,
                                 enum lm3560_led_id led_no, unsigned int brt)
{
        int rval;
        u8 br_bits;

        if (brt < LM3560_TORCH_BRT_MIN)
                return lm3560_enable_ctrl(flash, led_no, false);
        else
                rval = lm3560_enable_ctrl(flash, led_no, true);

        br_bits = LM3560_TORCH_BRT_uA_TO_REG(brt);
        if (led_no == LM3560_LED0)
                rval = regmap_update_bits(flash->regmap,
                                          REG_TORCH_BR, 0x07, br_bits);
        else
                rval = regmap_update_bits(flash->regmap,
                                          REG_TORCH_BR, 0x38, br_bits << 3);

        return rval;
}

/* flash1/2 brightness control */
static int lm3560_flash_brt_ctrl(struct lm3560_flash *flash,
                                 enum lm3560_led_id led_no, unsigned int brt)
{
        int rval;
        u8 br_bits;

        if (brt < LM3560_FLASH_BRT_MIN)
                return lm3560_enable_ctrl(flash, led_no, false);
        else
                rval = lm3560_enable_ctrl(flash, led_no, true);

        br_bits = LM3560_FLASH_BRT_uA_TO_REG(brt);
        if (led_no == LM3560_LED0)
                rval = regmap_update_bits(flash->regmap,
                                          REG_FLASH_BR, 0x0f, br_bits);
        else
                rval = regmap_update_bits(flash->regmap,
                                          REG_FLASH_BR, 0xf0, br_bits << 4);

        return rval;
}

/* v4l2 controls  */
static int lm3560_get_ctrl(struct v4l2_ctrl *ctrl, enum lm3560_led_id led_no)
{
        struct lm3560_flash *flash = to_lm3560_flash(ctrl, led_no);
        int rval = -EINVAL;

        mutex_lock(&flash->lock);

        if (ctrl->id == V4L2_CID_FLASH_FAULT) {
                s32 fault = 0;
                unsigned int reg_val;
                rval = regmap_read(flash->regmap, REG_FLAG, &reg_val);
                if (rval < 0)
                        goto out;
                if (reg_val & FAULT_SHORT_CIRCUIT)
                        fault |= V4L2_FLASH_FAULT_SHORT_CIRCUIT;
                if (reg_val & FAULT_OVERTEMP)
                        fault |= V4L2_FLASH_FAULT_OVER_TEMPERATURE;
                if (reg_val & FAULT_TIMEOUT)
                        fault |= V4L2_FLASH_FAULT_TIMEOUT;
                ctrl->cur.val = fault;
        }

out:
        mutex_unlock(&flash->lock);
        return rval;
}

static int lm3560_set_ctrl(struct v4l2_ctrl *ctrl, enum lm3560_led_id led_no)
{
        struct lm3560_flash *flash = to_lm3560_flash(ctrl, led_no);
        u8 tout_bits;
        int rval = -EINVAL;

        mutex_lock(&flash->lock);

        switch (ctrl->id) {
        case V4L2_CID_FLASH_LED_MODE:
                flash->led_mode = ctrl->val;
                if (flash->led_mode != V4L2_FLASH_LED_MODE_FLASH)
                        rval = lm3560_mode_ctrl(flash);
                break;

        case V4L2_CID_FLASH_STROBE_SOURCE:
                rval = regmap_update_bits(flash->regmap,
                                          REG_CONFIG1, 0x04, (ctrl->val) << 2);
                if (rval < 0)
                        goto err_out;
                break;

        case V4L2_CID_FLASH_STROBE:
                if (flash->led_mode != V4L2_FLASH_LED_MODE_FLASH) {
                        rval = -EBUSY;
                        goto err_out;
                }
                flash->led_mode = V4L2_FLASH_LED_MODE_FLASH;
                rval = lm3560_mode_ctrl(flash);
                break;

        case V4L2_CID_FLASH_STROBE_STOP:
                if (flash->led_mode != V4L2_FLASH_LED_MODE_FLASH) {
                        rval = -EBUSY;
                        goto err_out;
                }
                flash->led_mode = V4L2_FLASH_LED_MODE_NONE;
                rval = lm3560_mode_ctrl(flash);
                break;

        case V4L2_CID_FLASH_TIMEOUT:
                tout_bits = LM3560_FLASH_TOUT_ms_TO_REG(ctrl->val);
                rval = regmap_update_bits(flash->regmap,
                                          REG_FLASH_TOUT, 0x1f, tout_bits);
                break;

        case V4L2_CID_FLASH_INTENSITY:
                rval = lm3560_flash_brt_ctrl(flash, led_no, ctrl->val);
                break;

        case V4L2_CID_FLASH_TORCH_INTENSITY:
                rval = lm3560_torch_brt_ctrl(flash, led_no, ctrl->val);
                break;
        }

err_out:
        mutex_unlock(&flash->lock);
        return rval;
}

static int lm3560_led1_get_ctrl(struct v4l2_ctrl *ctrl)
{
        return lm3560_get_ctrl(ctrl, LM3560_LED1);
}

static int lm3560_led1_set_ctrl(struct v4l2_ctrl *ctrl)
{
        return lm3560_set_ctrl(ctrl, LM3560_LED1);
}

static int lm3560_led0_get_ctrl(struct v4l2_ctrl *ctrl)
{
        return lm3560_get_ctrl(ctrl, LM3560_LED0);
}

static int lm3560_led0_set_ctrl(struct v4l2_ctrl *ctrl)
{
        return lm3560_set_ctrl(ctrl, LM3560_LED0);
}

static const struct v4l2_ctrl_ops lm3560_led_ctrl_ops[LM3560_LED_MAX] = {
        [LM3560_LED0] = {
                         .g_volatile_ctrl = lm3560_led0_get_ctrl,
                         .s_ctrl = lm3560_led0_set_ctrl,
                         },
        [LM3560_LED1] = {
                         .g_volatile_ctrl = lm3560_led1_get_ctrl,
                         .s_ctrl = lm3560_led1_set_ctrl,
                         }
};

static int lm3560_init_controls(struct lm3560_flash *flash,
                                enum lm3560_led_id led_no)
{
        struct v4l2_ctrl *fault;
        u32 max_flash_brt = flash->pdata->max_flash_brt[led_no];
        u32 max_torch_brt = flash->pdata->max_torch_brt[led_no];
        struct v4l2_ctrl_handler *hdl = &flash->ctrls_led[led_no];
        const struct v4l2_ctrl_ops *ops = &lm3560_led_ctrl_ops[led_no];

        v4l2_ctrl_handler_init(hdl, 8);

        /* flash mode */
        v4l2_ctrl_new_std_menu(hdl, ops, V4L2_CID_FLASH_LED_MODE,
                               V4L2_FLASH_LED_MODE_TORCH, ~0x7,
                               V4L2_FLASH_LED_MODE_NONE);
        flash->led_mode = V4L2_FLASH_LED_MODE_NONE;

        /* flash source */
        v4l2_ctrl_new_std_menu(hdl, ops, V4L2_CID_FLASH_STROBE_SOURCE,
                               0x1, ~0x3, V4L2_FLASH_STROBE_SOURCE_SOFTWARE);

        /* flash strobe */
        v4l2_ctrl_new_std(hdl, ops, V4L2_CID_FLASH_STROBE, 0, 0, 0, 0);

        /* flash strobe stop */
        v4l2_ctrl_new_std(hdl, ops, V4L2_CID_FLASH_STROBE_STOP, 0, 0, 0, 0);

        /* flash strobe timeout */
        v4l2_ctrl_new_std(hdl, ops, V4L2_CID_FLASH_TIMEOUT,
                          LM3560_FLASH_TOUT_MIN,
                          flash->pdata->max_flash_timeout,
                          LM3560_FLASH_TOUT_STEP,
                          flash->pdata->max_flash_timeout);

        /* flash brt */
        v4l2_ctrl_new_std(hdl, ops, V4L2_CID_FLASH_INTENSITY,
                          LM3560_FLASH_BRT_MIN, max_flash_brt,
                          LM3560_FLASH_BRT_STEP, max_flash_brt);

        /* torch brt */
        v4l2_ctrl_new_std(hdl, ops, V4L2_CID_FLASH_TORCH_INTENSITY,
                          LM3560_TORCH_BRT_MIN, max_torch_brt,
                          LM3560_TORCH_BRT_STEP, max_torch_brt);

        /* fault */
        fault = v4l2_ctrl_new_std(hdl, ops, V4L2_CID_FLASH_FAULT, 0,
                                  V4L2_FLASH_FAULT_OVER_VOLTAGE
                                  | V4L2_FLASH_FAULT_OVER_TEMPERATURE
                                  | V4L2_FLASH_FAULT_SHORT_CIRCUIT
                                  | V4L2_FLASH_FAULT_TIMEOUT, 0, 0);
        if (fault != NULL)
                fault->flags |= V4L2_CTRL_FLAG_VOLATILE;

        if (hdl->error)
                return hdl->error;

        flash->subdev_led[led_no].ctrl_handler = hdl;
        return 0;
}

/* initialize device */
static const struct v4l2_subdev_ops lm3560_ops = {
        .core = NULL,
};

static const struct regmap_config lm3560_regmap = {
        .reg_bits = 8,
        .val_bits = 8,
        .max_register = 0xFF,
};

static int lm3560_subdev_init(struct lm3560_flash *flash,
                              enum lm3560_led_id led_no, char *led_name)
{
        struct i2c_client *client = to_i2c_client(flash->dev);
        int rval;

        v4l2_i2c_subdev_init(&flash->subdev_led[led_no], client, &lm3560_ops);
        flash->subdev_led[led_no].flags |= V4L2_SUBDEV_FL_HAS_DEVNODE;
        strscpy(flash->subdev_led[led_no].name, led_name,
                sizeof(flash->subdev_led[led_no].name));
        rval = lm3560_init_controls(flash, led_no);
        if (rval)
                goto err_out;
        rval = media_entity_pads_init(&flash->subdev_led[led_no].entity, 0, NULL);
        if (rval < 0)
                goto err_out;
        flash->subdev_led[led_no].entity.function = MEDIA_ENT_F_FLASH;

        return rval;

err_out:
        v4l2_ctrl_handler_free(&flash->ctrls_led[led_no]);
        return rval;
}

static int lm3560_init_device(struct lm3560_flash *flash)
{
        int rval;
        unsigned int reg_val;

        /* set peak current */
        rval = regmap_update_bits(flash->regmap,
                                  REG_FLASH_TOUT, 0x60, flash->pdata->peak);
        if (rval < 0)
                return rval;
        /* output disable */
        flash->led_mode = V4L2_FLASH_LED_MODE_NONE;
        rval = lm3560_mode_ctrl(flash);
        if (rval < 0)
                return rval;
        /* reset faults */
        rval = regmap_read(flash->regmap, REG_FLAG, &reg_val);
        return rval;
}

static int lm3560_probe(struct i2c_client *client)
{
        struct lm3560_flash *flash;
        struct lm3560_platform_data *pdata = dev_get_platdata(&client->dev);
        int rval;

        flash = devm_kzalloc(&client->dev, sizeof(*flash), GFP_KERNEL);
        if (flash == NULL)
                return -ENOMEM;

        flash->regmap = devm_regmap_init_i2c(client, &lm3560_regmap);
        if (IS_ERR(flash->regmap)) {
                rval = PTR_ERR(flash->regmap);
                return rval;
        }

        /* if there is no platform data, use chip default value */
        if (pdata == NULL) {
                pdata = devm_kzalloc(&client->dev, sizeof(*pdata), GFP_KERNEL);
                if (pdata == NULL)
                        return -ENODEV;
                pdata->peak = LM3560_PEAK_3600mA;
                pdata->max_flash_timeout = LM3560_FLASH_TOUT_MAX;
                /* led 1 */
                pdata->max_flash_brt[LM3560_LED0] = LM3560_FLASH_BRT_MAX;
                pdata->max_torch_brt[LM3560_LED0] = LM3560_TORCH_BRT_MAX;
                /* led 2 */
                pdata->max_flash_brt[LM3560_LED1] = LM3560_FLASH_BRT_MAX;
                pdata->max_torch_brt[LM3560_LED1] = LM3560_TORCH_BRT_MAX;
        }
        flash->pdata = pdata;
        flash->dev = &client->dev;
        mutex_init(&flash->lock);

        rval = lm3560_subdev_init(flash, LM3560_LED0, "lm3560-led0");
        if (rval < 0)
                return rval;

        rval = lm3560_subdev_init(flash, LM3560_LED1, "lm3560-led1");
        if (rval < 0)
                return rval;

        rval = lm3560_init_device(flash);
        if (rval < 0)
                return rval;

        i2c_set_clientdata(client, flash);

        return 0;
}

static void lm3560_remove(struct i2c_client *client)
{
        struct lm3560_flash *flash = i2c_get_clientdata(client);
        unsigned int i;

        for (i = LM3560_LED0; i < LM3560_LED_MAX; i++) {
                v4l2_device_unregister_subdev(&flash->subdev_led[i]);
                v4l2_ctrl_handler_free(&flash->ctrls_led[i]);
                media_entity_cleanup(&flash->subdev_led[i].entity);
        }
}

static const struct i2c_device_id lm3560_id_table[] = {
        { LM3559_NAME },
        { LM3560_NAME },
        {}
};

MODULE_DEVICE_TABLE(i2c, lm3560_id_table);

static struct i2c_driver lm3560_i2c_driver = {
        .driver = {
                   .name = LM3560_NAME,
                   .pm = NULL,
                   },
        .probe = lm3560_probe,
        .remove = lm3560_remove,
        .id_table = lm3560_id_table,
};

module_i2c_driver(lm3560_i2c_driver);

MODULE_AUTHOR("Daniel Jeong <gshark.jeong@gmail.com>");
MODULE_AUTHOR("Ldd Mlp <ldd-mlp@list.ti.com>");
MODULE_DESCRIPTION("Texas Instruments LM3560 LED flash driver");
MODULE_LICENSE("GPL");