drivers/leds/leds-lm355x.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /*
   3 * Simple driver for Texas Instruments LM355x LED Flash driver chip
   4 * Copyright (C) 2012 Texas Instruments
   5 */
   6
   7 #include <linux/module.h>
   8 #include <linux/delay.h>
   9 #include <linux/i2c.h>
  10 #include <linux/gpio.h>
  11 #include <linux/leds.h>
  12 #include <linux/slab.h>
  13 #include <linux/platform_device.h>
  14 #include <linux/fs.h>
  15 #include <linux/regmap.h>
  16 #include <linux/platform_data/leds-lm355x.h>
  17
  18 enum lm355x_type {
  19         CHIP_LM3554 = 0,
  20         CHIP_LM3556,
  21 };
  22
  23 enum lm355x_regs {
  24         REG_FLAG = 0,
  25         REG_TORCH_CFG,
  26         REG_TORCH_CTRL,
  27         REG_STROBE_CFG,
  28         REG_FLASH_CTRL,
  29         REG_INDI_CFG,
  30         REG_INDI_CTRL,
  31         REG_OPMODE,
  32         REG_MAX,
  33 };
  34
  35 /* operation mode */
  36 enum lm355x_mode {
  37         MODE_SHDN = 0,
  38         MODE_INDIC,
  39         MODE_TORCH,
  40         MODE_FLASH
  41 };
  42
  43 /* register map info. */
  44 struct lm355x_reg_data {
  45         u8 regno;
  46         u8 mask;
  47         u8 shift;
  48 };
  49
  50 struct lm355x_chip_data {
  51         struct device *dev;
  52         enum lm355x_type type;
  53
  54         struct led_classdev cdev_flash;
  55         struct led_classdev cdev_torch;
  56         struct led_classdev cdev_indicator;
  57
  58         struct lm355x_platform_data *pdata;
  59         struct regmap *regmap;
  60         struct mutex lock;
  61
  62         unsigned int last_flag;
  63         struct lm355x_reg_data *regs;
  64 };
  65
  66 /* specific indicator function for lm3556 */
  67 enum lm3556_indic_pulse_time {
  68         PULSE_TIME_0_MS = 0,
  69         PULSE_TIME_32_MS,
  70         PULSE_TIME_64_MS,
  71         PULSE_TIME_92_MS,
  72         PULSE_TIME_128_MS,
  73         PULSE_TIME_160_MS,
  74         PULSE_TIME_196_MS,
  75         PULSE_TIME_224_MS,
  76         PULSE_TIME_256_MS,
  77         PULSE_TIME_288_MS,
  78         PULSE_TIME_320_MS,
  79         PULSE_TIME_352_MS,
  80         PULSE_TIME_384_MS,
  81         PULSE_TIME_416_MS,
  82         PULSE_TIME_448_MS,
  83         PULSE_TIME_480_MS,
  84 };
  85
  86 enum lm3556_indic_n_blank {
  87         INDIC_N_BLANK_0 = 0,
  88         INDIC_N_BLANK_1,
  89         INDIC_N_BLANK_2,
  90         INDIC_N_BLANK_3,
  91         INDIC_N_BLANK_4,
  92         INDIC_N_BLANK_5,
  93         INDIC_N_BLANK_6,
  94         INDIC_N_BLANK_7,
  95         INDIC_N_BLANK_8,
  96         INDIC_N_BLANK_9,
  97         INDIC_N_BLANK_10,
  98         INDIC_N_BLANK_11,
  99         INDIC_N_BLANK_12,
 100         INDIC_N_BLANK_13,
 101         INDIC_N_BLANK_14,
 102         INDIC_N_BLANK_15,
 103 };
 104
 105 enum lm3556_indic_period {
 106         INDIC_PERIOD_0 = 0,
 107         INDIC_PERIOD_1,
 108         INDIC_PERIOD_2,
 109         INDIC_PERIOD_3,
 110         INDIC_PERIOD_4,
 111         INDIC_PERIOD_5,
 112         INDIC_PERIOD_6,
 113         INDIC_PERIOD_7,
 114 };
 115
 116 #define INDIC_PATTERN_SIZE 4
 117
 118 struct indicator {
 119         u8 blinking;
 120         u8 period_cnt;
 121 };
 122
 123 /* indicator pattern data only for lm3556 */
 124 static struct indicator indicator_pattern[INDIC_PATTERN_SIZE] = {
 125         [0] = {(INDIC_N_BLANK_1 << 4) | PULSE_TIME_32_MS, INDIC_PERIOD_1},
 126         [1] = {(INDIC_N_BLANK_15 << 4) | PULSE_TIME_32_MS, INDIC_PERIOD_2},
 127         [2] = {(INDIC_N_BLANK_10 << 4) | PULSE_TIME_32_MS, INDIC_PERIOD_4},
 128         [3] = {(INDIC_N_BLANK_5 << 4) | PULSE_TIME_32_MS, INDIC_PERIOD_7},
 129 };
 130
 131 static struct lm355x_reg_data lm3554_regs[REG_MAX] = {
 132         [REG_FLAG] = {0xD0, 0xBF, 0},
 133         [REG_TORCH_CFG] = {0xE0, 0x80, 7},
 134         [REG_TORCH_CTRL] = {0xA0, 0x38, 3},
 135         [REG_STROBE_CFG] = {0xE0, 0x04, 2},
 136         [REG_FLASH_CTRL] = {0xB0, 0x78, 3},
 137         [REG_INDI_CFG] = {0xE0, 0x08, 3},
 138         [REG_INDI_CTRL] = {0xA0, 0xC0, 6},
 139         [REG_OPMODE] = {0xA0, 0x03, 0},
 140 };
 141
 142 static struct lm355x_reg_data lm3556_regs[REG_MAX] = {
 143         [REG_FLAG] = {0x0B, 0xFF, 0},
 144         [REG_TORCH_CFG] = {0x0A, 0x10, 4},
 145         [REG_TORCH_CTRL] = {0x09, 0x70, 4},
 146         [REG_STROBE_CFG] = {0x0A, 0x20, 5},
 147         [REG_FLASH_CTRL] = {0x09, 0x0F, 0},
 148         [REG_INDI_CFG] = {0xFF, 0xFF, 0},
 149         [REG_INDI_CTRL] = {0x09, 0x70, 4},
 150         [REG_OPMODE] = {0x0A, 0x03, 0},
 151 };
 152
 153 static char lm355x_name[][I2C_NAME_SIZE] = {
 154         [CHIP_LM3554] = LM3554_NAME,
 155         [CHIP_LM3556] = LM3556_NAME,
 156 };
 157
 158 /* chip initialize */
 159 static int lm355x_chip_init(struct lm355x_chip_data *chip)
 160 {
 161         int ret;
 162         unsigned int reg_val;
 163         struct lm355x_platform_data *pdata = chip->pdata;
 164
 165         /* input and output pins configuration */
 166         switch (chip->type) {
 167         case CHIP_LM3554:
 168                 reg_val = (u32)pdata->pin_tx2 | (u32)pdata->ntc_pin;
 169                 ret = regmap_update_bits(chip->regmap, 0xE0, 0x28, reg_val);
 170                 if (ret < 0)
 171                         goto out;
 172                 reg_val = (u32)pdata->pass_mode;
 173                 ret = regmap_update_bits(chip->regmap, 0xA0, 0x04, reg_val);
 174                 if (ret < 0)
 175                         goto out;
 176                 break;
 177
 178         case CHIP_LM3556:
 179                 reg_val = (u32)pdata->pin_tx2 | (u32)pdata->ntc_pin |
 180                           (u32)pdata->pass_mode;
 181                 ret = regmap_update_bits(chip->regmap, 0x0A, 0xC4, reg_val);
 182                 if (ret < 0)
 183                         goto out;
 184                 break;
 185         default:
 186                 return -ENODATA;
 187         }
 188
 189         return ret;
 190 out:
 191         dev_err(chip->dev, "%s:i2c access fail to register\n", __func__);
 192         return ret;
 193 }
 194
 195 /* chip control */
 196 static int lm355x_control(struct lm355x_chip_data *chip,
 197                            u8 brightness, enum lm355x_mode opmode)
 198 {
 199         int ret;
 200         unsigned int reg_val;
 201         struct lm355x_platform_data *pdata = chip->pdata;
 202         struct lm355x_reg_data *preg = chip->regs;
 203
 204         ret = regmap_read(chip->regmap, preg[REG_FLAG].regno, &chip->last_flag);
 205         if (ret < 0)
 206                 goto out;
 207         if (chip->last_flag & preg[REG_FLAG].mask)
 208                 dev_info(chip->dev, "%s Last FLAG is 0x%x\n",
 209                          lm355x_name[chip->type],
 210                          chip->last_flag & preg[REG_FLAG].mask);
 211         /* brightness 0 means shutdown */
 212         if (!brightness)
 213                 opmode = MODE_SHDN;
 214
 215         switch (opmode) {
 216         case MODE_TORCH:
 217                 ret =
 218                     regmap_update_bits(chip->regmap, preg[REG_TORCH_CTRL].regno,
 219                                        preg[REG_TORCH_CTRL].mask,
 220                                        (brightness - 1)
 221                                        << preg[REG_TORCH_CTRL].shift);
 222                 if (ret < 0)
 223                         goto out;
 224
 225                 if (pdata->pin_tx1 != LM355x_PIN_TORCH_DISABLE) {
 226                         ret =
 227                             regmap_update_bits(chip->regmap,
 228                                                preg[REG_TORCH_CFG].regno,
 229                                                preg[REG_TORCH_CFG].mask,
 230                                                0x01 <<
 231                                                preg[REG_TORCH_CFG].shift);
 232                         if (ret < 0)
 233                                 goto out;
 234                         opmode = MODE_SHDN;
 235                         dev_info(chip->dev,
 236                                  "torch brt is set - ext. torch pin mode\n");
 237                 }
 238                 break;
 239
 240         case MODE_FLASH:
 241
 242                 ret =
 243                     regmap_update_bits(chip->regmap, preg[REG_FLASH_CTRL].regno,
 244                                        preg[REG_FLASH_CTRL].mask,
 245                                        (brightness - 1)
 246                                        << preg[REG_FLASH_CTRL].shift);
 247                 if (ret < 0)
 248                         goto out;
 249
 250                 if (pdata->pin_strobe != LM355x_PIN_STROBE_DISABLE) {
 251                         if (chip->type == CHIP_LM3554)
 252                                 reg_val = 0x00;
 253                         else
 254                                 reg_val = 0x01;
 255                         ret =
 256                             regmap_update_bits(chip->regmap,
 257                                                preg[REG_STROBE_CFG].regno,
 258                                                preg[REG_STROBE_CFG].mask,
 259                                                reg_val <<
 260                                                preg[REG_STROBE_CFG].shift);
 261                         if (ret < 0)
 262                                 goto out;
 263                         opmode = MODE_SHDN;
 264                         dev_info(chip->dev,
 265                                  "flash brt is set - ext. strobe pin mode\n");
 266                 }
 267                 break;
 268
 269         case MODE_INDIC:
 270                 ret =
 271                     regmap_update_bits(chip->regmap, preg[REG_INDI_CTRL].regno,
 272                                        preg[REG_INDI_CTRL].mask,
 273                                        (brightness - 1)
 274                                        << preg[REG_INDI_CTRL].shift);
 275                 if (ret < 0)
 276                         goto out;
 277
 278                 if (pdata->pin_tx2 != LM355x_PIN_TX_DISABLE) {
 279                         ret =
 280                             regmap_update_bits(chip->regmap,
 281                                                preg[REG_INDI_CFG].regno,
 282                                                preg[REG_INDI_CFG].mask,
 283                                                0x01 <<
 284                                                preg[REG_INDI_CFG].shift);
 285                         if (ret < 0)
 286                                 goto out;
 287                         opmode = MODE_SHDN;
 288                 }
 289                 break;
 290         case MODE_SHDN:
 291                 break;
 292         default:
 293                 return -EINVAL;
 294         }
 295         /* operation mode control */
 296         ret = regmap_update_bits(chip->regmap, preg[REG_OPMODE].regno,
 297                                  preg[REG_OPMODE].mask,
 298                                  opmode << preg[REG_OPMODE].shift);
 299         if (ret < 0)
 300                 goto out;
 301         return ret;
 302 out:
 303         dev_err(chip->dev, "%s:i2c access fail to register\n", __func__);
 304         return ret;
 305 }
 306
 307 /* torch */
 308
 309 static int lm355x_torch_brightness_set(struct led_classdev *cdev,
 310                                         enum led_brightness brightness)
 311 {
 312         struct lm355x_chip_data *chip =
 313             container_of(cdev, struct lm355x_chip_data, cdev_torch);
 314         int ret;
 315
 316         mutex_lock(&chip->lock);
 317         ret = lm355x_control(chip, brightness, MODE_TORCH);
 318         mutex_unlock(&chip->lock);
 319         return ret;
 320 }
 321
 322 /* flash */
 323
 324 static int lm355x_strobe_brightness_set(struct led_classdev *cdev,
 325                                          enum led_brightness brightness)
 326 {
 327         struct lm355x_chip_data *chip =
 328             container_of(cdev, struct lm355x_chip_data, cdev_flash);
 329         int ret;
 330
 331         mutex_lock(&chip->lock);
 332         ret = lm355x_control(chip, brightness, MODE_FLASH);
 333         mutex_unlock(&chip->lock);
 334         return ret;
 335 }
 336
 337 /* indicator */
 338
 339 static int lm355x_indicator_brightness_set(struct led_classdev *cdev,
 340                                             enum led_brightness brightness)
 341 {
 342         struct lm355x_chip_data *chip =
 343             container_of(cdev, struct lm355x_chip_data, cdev_indicator);
 344         int ret;
 345
 346         mutex_lock(&chip->lock);
 347         ret = lm355x_control(chip, brightness, MODE_INDIC);
 348         mutex_unlock(&chip->lock);
 349         return ret;
 350 }
 351
 352 /* indicator pattern only for lm3556*/
 353 static ssize_t lm3556_indicator_pattern_store(struct device *dev,
 354                                               struct device_attribute *attr,
 355                                               const char *buf, size_t size)
 356 {
 357         ssize_t ret;
 358         struct led_classdev *led_cdev = dev_get_drvdata(dev);
 359         struct lm355x_chip_data *chip =
 360             container_of(led_cdev, struct lm355x_chip_data, cdev_indicator);
 361         unsigned int state;
 362
 363         ret = kstrtouint(buf, 10, &state);
 364         if (ret)
 365                 goto out;
 366         if (state > INDIC_PATTERN_SIZE - 1)
 367                 state = INDIC_PATTERN_SIZE - 1;
 368
 369         ret = regmap_write(chip->regmap, 0x04,
 370                            indicator_pattern[state].blinking);
 371         if (ret < 0)
 372                 goto out;
 373
 374         ret = regmap_write(chip->regmap, 0x05,
 375                            indicator_pattern[state].period_cnt);
 376         if (ret < 0)
 377                 goto out;
 378
 379         return size;
 380 out:
 381         dev_err(chip->dev, "%s:i2c access fail to register\n", __func__);
 382         return ret;
 383 }
 384
 385 static DEVICE_ATTR(pattern, S_IWUSR, NULL, lm3556_indicator_pattern_store);
 386
 387 static struct attribute *lm355x_indicator_attrs[] = {
 388         &dev_attr_pattern.attr,
 389         NULL
 390 };
 391 ATTRIBUTE_GROUPS(lm355x_indicator);
 392
 393 static const struct regmap_config lm355x_regmap = {
 394         .reg_bits = 8,
 395         .val_bits = 8,
 396         .max_register = 0xFF,
 397 };
 398
 399 /* module initialize */
 400 static int lm355x_probe(struct i2c_client *client,
 401                                   const struct i2c_device_id *id)
 402 {
 403         struct lm355x_platform_data *pdata = dev_get_platdata(&client->dev);
 404         struct lm355x_chip_data *chip;
 405
 406         int err;
 407
 408         if (!i2c_check_functionality(client->adapter, I2C_FUNC_I2C)) {
 409                 dev_err(&client->dev, "i2c functionality check fail.\n");
 410                 return -EOPNOTSUPP;
 411         }
 412
 413         if (pdata == NULL) {
 414                 dev_err(&client->dev, "needs Platform Data.\n");
 415                 return -ENODATA;
 416         }
 417
 418         chip = devm_kzalloc(&client->dev,
 419                             sizeof(struct lm355x_chip_data), GFP_KERNEL);
 420         if (!chip)
 421                 return -ENOMEM;
 422
 423         chip->dev = &client->dev;
 424         chip->type = id->driver_data;
 425         switch (id->driver_data) {
 426         case CHIP_LM3554:
 427                 chip->regs = lm3554_regs;
 428                 break;
 429         case CHIP_LM3556:
 430                 chip->regs = lm3556_regs;
 431                 break;
 432         default:
 433                 return -ENOSYS;
 434         }
 435         chip->pdata = pdata;
 436
 437         chip->regmap = devm_regmap_init_i2c(client, &lm355x_regmap);
 438         if (IS_ERR(chip->regmap)) {
 439                 err = PTR_ERR(chip->regmap);
 440                 dev_err(&client->dev,
 441                         "Failed to allocate register map: %d\n", err);
 442                 return err;
 443         }
 444
 445         mutex_init(&chip->lock);
 446         i2c_set_clientdata(client, chip);
 447
 448         err = lm355x_chip_init(chip);
 449         if (err < 0)
 450                 goto err_out;
 451
 452         /* flash */
 453         chip->cdev_flash.name = "flash";
 454         chip->cdev_flash.max_brightness = 16;
 455         chip->cdev_flash.brightness_set_blocking = lm355x_strobe_brightness_set;
 456         chip->cdev_flash.default_trigger = "flash";
 457         err = led_classdev_register((struct device *)
 458                                     &client->dev, &chip->cdev_flash);
 459         if (err < 0)
 460                 goto err_out;
 461         /* torch */
 462         chip->cdev_torch.name = "torch";
 463         chip->cdev_torch.max_brightness = 8;
 464         chip->cdev_torch.brightness_set_blocking = lm355x_torch_brightness_set;
 465         chip->cdev_torch.default_trigger = "torch";
 466         err = led_classdev_register((struct device *)
 467                                     &client->dev, &chip->cdev_torch);
 468         if (err < 0)
 469                 goto err_create_torch_file;
 470         /* indicator */
 471         chip->cdev_indicator.name = "indicator";
 472         if (id->driver_data == CHIP_LM3554)
 473                 chip->cdev_indicator.max_brightness = 4;
 474         else
 475                 chip->cdev_indicator.max_brightness = 8;
 476         chip->cdev_indicator.brightness_set_blocking =
 477                                         lm355x_indicator_brightness_set;
 478         /* indicator pattern control only for LM3556 */
 479         if (id->driver_data == CHIP_LM3556)
 480                 chip->cdev_indicator.groups = lm355x_indicator_groups;
 481         err = led_classdev_register((struct device *)
 482                                     &client->dev, &chip->cdev_indicator);
 483         if (err < 0)
 484                 goto err_create_indicator_file;
 485
 486         dev_info(&client->dev, "%s is initialized\n",
 487                  lm355x_name[id->driver_data]);
 488         return 0;
 489
 490 err_create_indicator_file:
 491         led_classdev_unregister(&chip->cdev_torch);
 492 err_create_torch_file:
 493         led_classdev_unregister(&chip->cdev_flash);
 494 err_out:
 495         return err;
 496 }
 497
 498 static int lm355x_remove(struct i2c_client *client)
 499 {
 500         struct lm355x_chip_data *chip = i2c_get_clientdata(client);
 501         struct lm355x_reg_data *preg = chip->regs;
 502
 503         regmap_write(chip->regmap, preg[REG_OPMODE].regno, 0);
 504         led_classdev_unregister(&chip->cdev_indicator);
 505         led_classdev_unregister(&chip->cdev_torch);
 506         led_classdev_unregister(&chip->cdev_flash);
 507         dev_info(&client->dev, "%s is removed\n", lm355x_name[chip->type]);
 508
 509         return 0;
 510 }
 511
 512 static const struct i2c_device_id lm355x_id[] = {
 513         {LM3554_NAME, CHIP_LM3554},
 514         {LM3556_NAME, CHIP_LM3556},
 515         {}
 516 };
 517
 518 MODULE_DEVICE_TABLE(i2c, lm355x_id);
 519
 520 static struct i2c_driver lm355x_i2c_driver = {
 521         .driver = {
 522                    .name = LM355x_NAME,
 523                    .pm = NULL,
 524                    },
 525         .probe = lm355x_probe,
 526         .remove = lm355x_remove,
 527         .id_table = lm355x_id,
 528 };
 529
 530 module_i2c_driver(lm355x_i2c_driver);
 531
 532 MODULE_DESCRIPTION("Texas Instruments Flash Lighting driver for LM355x");
 533 MODULE_AUTHOR("Daniel Jeong <daniel.jeong@ti.com>");
 534 MODULE_AUTHOR("G.Shark Jeong <gshark.jeong@gmail.com>");
 535 MODULE_LICENSE("GPL v2");