drivers/leds/leds-lp5523.c

   1 /*
   2  * lp5523.c - LP5523 LED Driver
   3  *
   4  * Copyright (C) 2010 Nokia Corporation
   5  *
   6  * Contact: Samu Onkalo <samu.p.onkalo@nokia.com>
   7  *
   8  * This program is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU General Public License
  10  * version 2 as published by the Free Software Foundation.
  11  *
  12  * This program is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
  20  * 02110-1301 USA
  21  */
  22
  23 #include <linux/module.h>
  24 #include <linux/init.h>
  25 #include <linux/i2c.h>
  26 #include <linux/mutex.h>
  27 #include <linux/gpio.h>
  28 #include <linux/interrupt.h>
  29 #include <linux/delay.h>
  30 #include <linux/ctype.h>
  31 #include <linux/spinlock.h>
  32 #include <linux/wait.h>
  33 #include <linux/leds.h>
  34 #include <linux/leds-lp5523.h>
  35 #include <linux/workqueue.h>
  36 #include <linux/slab.h>
  37
  38 #define LP5523_REG_ENABLE               0x00
  39 #define LP5523_REG_OP_MODE              0x01
  40 #define LP5523_REG_RATIOMETRIC_MSB      0x02
  41 #define LP5523_REG_RATIOMETRIC_LSB      0x03
  42 #define LP5523_REG_ENABLE_LEDS_MSB      0x04
  43 #define LP5523_REG_ENABLE_LEDS_LSB      0x05
  44 #define LP5523_REG_LED_CNTRL_BASE       0x06
  45 #define LP5523_REG_LED_PWM_BASE         0x16
  46 #define LP5523_REG_LED_CURRENT_BASE     0x26
  47 #define LP5523_REG_CONFIG               0x36
  48 #define LP5523_REG_CHANNEL1_PC          0x37
  49 #define LP5523_REG_CHANNEL2_PC          0x38
  50 #define LP5523_REG_CHANNEL3_PC          0x39
  51 #define LP5523_REG_STATUS               0x3a
  52 #define LP5523_REG_GPO                  0x3b
  53 #define LP5523_REG_VARIABLE             0x3c
  54 #define LP5523_REG_RESET                0x3d
  55 #define LP5523_REG_TEMP_CTRL            0x3e
  56 #define LP5523_REG_TEMP_READ            0x3f
  57 #define LP5523_REG_TEMP_WRITE           0x40
  58 #define LP5523_REG_LED_TEST_CTRL        0x41
  59 #define LP5523_REG_LED_TEST_ADC         0x42
  60 #define LP5523_REG_ENG1_VARIABLE        0x45
  61 #define LP5523_REG_ENG2_VARIABLE        0x46
  62 #define LP5523_REG_ENG3_VARIABLE        0x47
  63 #define LP5523_REG_MASTER_FADER1        0x48
  64 #define LP5523_REG_MASTER_FADER2        0x49
  65 #define LP5523_REG_MASTER_FADER3        0x4a
  66 #define LP5523_REG_CH1_PROG_START       0x4c
  67 #define LP5523_REG_CH2_PROG_START       0x4d
  68 #define LP5523_REG_CH3_PROG_START       0x4e
  69 #define LP5523_REG_PROG_PAGE_SEL        0x4f
  70 #define LP5523_REG_PROG_MEM             0x50
  71
  72 #define LP5523_CMD_LOAD                 0x15 /* 00010101 */
  73 #define LP5523_CMD_RUN                  0x2a /* 00101010 */
  74 #define LP5523_CMD_DISABLED             0x00 /* 00000000 */
  75
  76 #define LP5523_ENABLE                   0x40
  77 #define LP5523_AUTO_INC                 0x40
  78 #define LP5523_PWR_SAVE                 0x20
  79 #define LP5523_PWM_PWR_SAVE             0x04
  80 #define LP5523_CP_1                     0x08
  81 #define LP5523_CP_1_5                   0x10
  82 #define LP5523_CP_AUTO                  0x18
  83 #define LP5523_INT_CLK                  0x01
  84 #define LP5523_AUTO_CLK                 0x02
  85 #define LP5523_EN_LEDTEST               0x80
  86 #define LP5523_LEDTEST_DONE             0x80
  87
  88 #define LP5523_DEFAULT_CURRENT          50 /* microAmps */
  89 #define LP5523_PROGRAM_LENGTH           32 /* in bytes */
  90 #define LP5523_PROGRAM_PAGES            6
  91 #define LP5523_ADC_SHORTCIRC_LIM        80
  92
  93 #define LP5523_LEDS                     9
  94 #define LP5523_ENGINES                  3
  95
  96 #define LP5523_ENG_MASK_BASE            0x30 /* 00110000 */
  97
  98 #define LP5523_ENG_STATUS_MASK          0x07 /* 00000111 */
  99
 100 #define LP5523_IRQ_FLAGS                IRQF_TRIGGER_FALLING
 101
 102 #define LP5523_EXT_CLK_USED             0x08
 103
 104 #define LED_ACTIVE(mux, led)            (!!(mux & (0x0001 << led)))
 105 #define SHIFT_MASK(id)                  (((id) - 1) * 2)
 106
 107 struct lp5523_engine {
 108         const struct attribute_group *attributes;
 109         int             id;
 110         u8              mode;
 111         u8              prog_page;
 112         u8              mux_page;
 113         u16             led_mux;
 114         u8              engine_mask;
 115 };
 116
 117 struct lp5523_led {
 118         int                     id;
 119         u8                      chan_nr;
 120         u8                      led_current;
 121         u8                      max_current;
 122         struct led_classdev     cdev;
 123         struct work_struct      brightness_work;
 124         u8                      brightness;
 125 };
 126
 127 struct lp5523_chip {
 128         struct mutex            lock; /* Serialize control */
 129         struct i2c_client       *client;
 130         struct lp5523_engine    engines[LP5523_ENGINES];
 131         struct lp5523_led       leds[LP5523_LEDS];
 132         struct lp5523_platform_data *pdata;
 133         u8                      num_channels;
 134         u8                      num_leds;
 135 };
 136
 137 #define cdev_to_led(c)          container_of(c, struct lp5523_led, cdev)
 138
 139 static struct lp5523_chip *engine_to_lp5523(struct lp5523_engine *engine)
 140 {
 141         return container_of(engine, struct lp5523_chip,
 142                             engines[engine->id - 1]);
 143 }
 144
 145 static struct lp5523_chip *led_to_lp5523(struct lp5523_led *led)
 146 {
 147         return container_of(led, struct lp5523_chip,
 148                             leds[led->id]);
 149 }
 150
 151 static int lp5523_set_mode(struct lp5523_engine *engine, u8 mode);
 152 static int lp5523_set_engine_mode(struct lp5523_engine *engine, u8 mode);
 153 static int lp5523_load_program(struct lp5523_engine *engine, u8 *pattern);
 154
 155 static void lp5523_led_brightness_work(struct work_struct *work);
 156
 157 static int lp5523_write(struct i2c_client *client, u8 reg, u8 value)
 158 {
 159         return i2c_smbus_write_byte_data(client, reg, value);
 160 }
 161
 162 static int lp5523_read(struct i2c_client *client, u8 reg, u8 *buf)
 163 {
 164         s32 ret = i2c_smbus_read_byte_data(client, reg);
 165
 166         if (ret < 0)
 167                 return -EIO;
 168
 169         *buf = ret;
 170         return 0;
 171 }
 172
 173 static int lp5523_detect(struct i2c_client *client)
 174 {
 175         int ret;
 176         u8 buf;
 177
 178         ret = lp5523_write(client, LP5523_REG_ENABLE, 0x40);
 179         if (ret)
 180                 return ret;
 181         ret = lp5523_read(client, LP5523_REG_ENABLE, &buf);
 182         if (ret)
 183                 return ret;
 184         if (buf == 0x40)
 185                 return 0;
 186         else
 187                 return -ENODEV;
 188 }
 189
 190 static int lp5523_configure(struct i2c_client *client)
 191 {
 192         struct lp5523_chip *chip = i2c_get_clientdata(client);
 193         int ret = 0;
 194         u8 status;
 195
 196         /* one pattern per engine setting led mux start and stop addresses */
 197         u8 pattern[][LP5523_PROGRAM_LENGTH] =  {
 198                 { 0x9c, 0x30, 0x9c, 0xb0, 0x9d, 0x80, 0xd8, 0x00, 0},
 199                 { 0x9c, 0x40, 0x9c, 0xc0, 0x9d, 0x80, 0xd8, 0x00, 0},
 200                 { 0x9c, 0x50, 0x9c, 0xd0, 0x9d, 0x80, 0xd8, 0x00, 0},
 201         };
 202
 203         lp5523_write(client, LP5523_REG_RESET, 0xff);
 204
 205         usleep_range(10000, 100000);
 206
 207         ret |= lp5523_write(client, LP5523_REG_ENABLE, LP5523_ENABLE);
 208         /* Chip startup time after reset is 500 us */
 209         usleep_range(1000, 10000);
 210
 211         ret |= lp5523_write(client, LP5523_REG_CONFIG,
 212                             LP5523_AUTO_INC | LP5523_PWR_SAVE |
 213                             LP5523_CP_AUTO | LP5523_AUTO_CLK |
 214                             LP5523_PWM_PWR_SAVE);
 215
 216         /* turn on all leds */
 217         ret |= lp5523_write(client, LP5523_REG_ENABLE_LEDS_MSB, 0x01);
 218         ret |= lp5523_write(client, LP5523_REG_ENABLE_LEDS_LSB, 0xff);
 219
 220         /* hardcode 32 bytes of memory for each engine from program memory */
 221         ret |= lp5523_write(client, LP5523_REG_CH1_PROG_START, 0x00);
 222         ret |= lp5523_write(client, LP5523_REG_CH2_PROG_START, 0x10);
 223         ret |= lp5523_write(client, LP5523_REG_CH3_PROG_START, 0x20);
 224
 225         /* write led mux address space for each channel */
 226         ret |= lp5523_load_program(&chip->engines[0], pattern[0]);
 227         ret |= lp5523_load_program(&chip->engines[1], pattern[1]);
 228         ret |= lp5523_load_program(&chip->engines[2], pattern[2]);
 229
 230         if (ret) {
 231                 dev_err(&client->dev, "could not load mux programs\n");
 232                 return -1;
 233         }
 234
 235         /* set all engines exec state and mode to run 00101010 */
 236         ret |= lp5523_write(client, LP5523_REG_ENABLE,
 237                             (LP5523_CMD_RUN | LP5523_ENABLE));
 238
 239         ret |= lp5523_write(client, LP5523_REG_OP_MODE, LP5523_CMD_RUN);
 240
 241         if (ret) {
 242                 dev_err(&client->dev, "could not start mux programs\n");
 243                 return -1;
 244         }
 245
 246         /* Wait 3ms and check the engine status */
 247         usleep_range(3000, 20000);
 248         lp5523_read(client, LP5523_REG_STATUS, &status);
 249         status &= LP5523_ENG_STATUS_MASK;
 250
 251         if (status == LP5523_ENG_STATUS_MASK) {
 252                 dev_dbg(&client->dev, "all engines configured\n");
 253         } else {
 254                 dev_info(&client->dev, "status == %x\n", status);
 255                 dev_err(&client->dev, "cound not configure LED engine\n");
 256                 return -1;
 257         }
 258
 259         dev_info(&client->dev, "disabling engines\n");
 260
 261         ret |= lp5523_write(client, LP5523_REG_OP_MODE, LP5523_CMD_DISABLED);
 262
 263         return ret;
 264 }
 265
 266 static int lp5523_set_engine_mode(struct lp5523_engine *engine, u8 mode)
 267 {
 268         struct lp5523_chip *chip = engine_to_lp5523(engine);
 269         struct i2c_client *client = chip->client;
 270         int ret;
 271         u8 engine_state;
 272
 273         ret = lp5523_read(client, LP5523_REG_OP_MODE, &engine_state);
 274         if (ret)
 275                 goto fail;
 276
 277         engine_state &= ~(engine->engine_mask);
 278
 279         /* set mode only for this engine */
 280         mode &= engine->engine_mask;
 281
 282         engine_state |= mode;
 283
 284         ret |= lp5523_write(client, LP5523_REG_OP_MODE, engine_state);
 285 fail:
 286         return ret;
 287 }
 288
 289 static int lp5523_load_mux(struct lp5523_engine *engine, u16 mux)
 290 {
 291         struct lp5523_chip *chip = engine_to_lp5523(engine);
 292         struct i2c_client *client = chip->client;
 293         int ret = 0;
 294
 295         ret |= lp5523_set_engine_mode(engine, LP5523_CMD_LOAD);
 296
 297         ret |= lp5523_write(client, LP5523_REG_PROG_PAGE_SEL, engine->mux_page);
 298         ret |= lp5523_write(client, LP5523_REG_PROG_MEM,
 299                             (u8)(mux >> 8));
 300         ret |= lp5523_write(client, LP5523_REG_PROG_MEM + 1, (u8)(mux));
 301         engine->led_mux = mux;
 302
 303         return ret;
 304 }
 305
 306 static int lp5523_load_program(struct lp5523_engine *engine, u8 *pattern)
 307 {
 308         struct lp5523_chip *chip = engine_to_lp5523(engine);
 309         struct i2c_client *client = chip->client;
 310
 311         int ret = 0;
 312
 313         ret |= lp5523_set_engine_mode(engine, LP5523_CMD_LOAD);
 314
 315         ret |= lp5523_write(client, LP5523_REG_PROG_PAGE_SEL,
 316                             engine->prog_page);
 317         ret |= i2c_smbus_write_i2c_block_data(client, LP5523_REG_PROG_MEM,
 318                                               LP5523_PROGRAM_LENGTH, pattern);
 319
 320         return ret;
 321 }
 322
 323 static int lp5523_run_program(struct lp5523_engine *engine)
 324 {
 325         struct lp5523_chip *chip = engine_to_lp5523(engine);
 326         struct i2c_client *client = chip->client;
 327         int ret;
 328
 329         ret = lp5523_write(client, LP5523_REG_ENABLE,
 330                                         LP5523_CMD_RUN | LP5523_ENABLE);
 331         if (ret)
 332                 goto fail;
 333
 334         ret = lp5523_set_engine_mode(engine, LP5523_CMD_RUN);
 335 fail:
 336         return ret;
 337 }
 338
 339 static int lp5523_mux_parse(const char *buf, u16 *mux, size_t len)
 340 {
 341         int i;
 342         u16 tmp_mux = 0;
 343         len = len < LP5523_LEDS ? len : LP5523_LEDS;
 344         for (i = 0; i < len; i++) {
 345                 switch (buf[i]) {
 346                 case '1':
 347                         tmp_mux |= (1 << i);
 348                         break;
 349                 case '0':
 350                         break;
 351                 case '\n':
 352                         i = len;
 353                         break;
 354                 default:
 355                         return -1;
 356                 }
 357         }
 358         *mux = tmp_mux;
 359
 360         return 0;
 361 }
 362
 363 static void lp5523_mux_to_array(u16 led_mux, char *array)
 364 {
 365         int i, pos = 0;
 366         for (i = 0; i < LP5523_LEDS; i++)
 367                 pos += sprintf(array + pos, "%x", LED_ACTIVE(led_mux, i));
 368
 369         array[pos] = '\0';
 370 }
 371
 372 /*--------------------------------------------------------------*/
 373 /*                      Sysfs interface                         */
 374 /*--------------------------------------------------------------*/
 375
 376 static ssize_t show_engine_leds(struct device *dev,
 377                             struct device_attribute *attr,
 378                             char *buf, int nr)
 379 {
 380         struct i2c_client *client = to_i2c_client(dev);
 381         struct lp5523_chip *chip = i2c_get_clientdata(client);
 382         char mux[LP5523_LEDS + 1];
 383
 384         lp5523_mux_to_array(chip->engines[nr - 1].led_mux, mux);
 385
 386         return sprintf(buf, "%s\n", mux);
 387 }
 388
 389 #define show_leds(nr)                                                   \
 390 static ssize_t show_engine##nr##_leds(struct device *dev,               \
 391                             struct device_attribute *attr,              \
 392                             char *buf)                                  \
 393 {                                                                       \
 394         return show_engine_leds(dev, attr, buf, nr);                    \
 395 }
 396 show_leds(1)
 397 show_leds(2)
 398 show_leds(3)
 399
 400 static ssize_t store_engine_leds(struct device *dev,
 401                              struct device_attribute *attr,
 402                              const char *buf, size_t len, int nr)
 403 {
 404         struct i2c_client *client = to_i2c_client(dev);
 405         struct lp5523_chip *chip = i2c_get_clientdata(client);
 406         u16 mux = 0;
 407
 408         if (lp5523_mux_parse(buf, &mux, len))
 409                 return -EINVAL;
 410
 411         if (lp5523_load_mux(&chip->engines[nr - 1], mux))
 412                 return -EINVAL;
 413
 414         return len;
 415 }
 416
 417 #define store_leds(nr)                                          \
 418 static ssize_t store_engine##nr##_leds(struct device *dev,      \
 419                              struct device_attribute *attr,     \
 420                              const char *buf, size_t len)       \
 421 {                                                               \
 422         return store_engine_leds(dev, attr, buf, len, nr);      \
 423 }
 424 store_leds(1)
 425 store_leds(2)
 426 store_leds(3)
 427
 428 static ssize_t lp5523_selftest(struct device *dev,
 429                                struct device_attribute *attr,
 430                                char *buf)
 431 {
 432         struct i2c_client *client = to_i2c_client(dev);
 433         struct lp5523_chip *chip = i2c_get_clientdata(client);
 434         int i, ret, pos = 0;
 435         int led = 0;
 436         u8 status, adc, vdd;
 437
 438         mutex_lock(&chip->lock);
 439
 440         ret = lp5523_read(chip->client, LP5523_REG_STATUS, &status);
 441         if (ret < 0)
 442                 goto fail;
 443
 444         /* Check that ext clock is really in use if requested */
 445         if ((chip->pdata) && (chip->pdata->clock_mode == LP5523_CLOCK_EXT))
 446                 if  ((status & LP5523_EXT_CLK_USED) == 0)
 447                         goto fail;
 448
 449         /* Measure VDD (i.e. VBAT) first (channel 16 corresponds to VDD) */
 450         lp5523_write(chip->client, LP5523_REG_LED_TEST_CTRL,
 451                                     LP5523_EN_LEDTEST | 16);
 452         usleep_range(3000, 10000);
 453         ret = lp5523_read(chip->client, LP5523_REG_STATUS, &status);
 454         if (!(status & LP5523_LEDTEST_DONE))
 455                 usleep_range(3000, 10000);
 456
 457         ret |= lp5523_read(chip->client, LP5523_REG_LED_TEST_ADC, &vdd);
 458         vdd--;  /* There may be some fluctuation in measurement */
 459
 460         for (i = 0; i < LP5523_LEDS; i++) {
 461                 /* Skip non-existing channels */
 462                 if (chip->pdata->led_config[i].led_current == 0)
 463                         continue;
 464
 465                 /* Set default current */
 466                 lp5523_write(chip->client,
 467                         LP5523_REG_LED_CURRENT_BASE + i,
 468                         chip->pdata->led_config[i].led_current);
 469
 470                 lp5523_write(chip->client, LP5523_REG_LED_PWM_BASE + i, 0xff);
 471                 /* let current stabilize 2ms before measurements start */
 472                 usleep_range(2000, 10000);
 473                 lp5523_write(chip->client,
 474                              LP5523_REG_LED_TEST_CTRL,
 475                              LP5523_EN_LEDTEST | i);
 476                 /* ledtest takes 2.7ms */
 477                 usleep_range(3000, 10000);
 478                 ret = lp5523_read(chip->client, LP5523_REG_STATUS, &status);
 479                 if (!(status & LP5523_LEDTEST_DONE))
 480                         usleep_range(3000, 10000);
 481                 ret |= lp5523_read(chip->client, LP5523_REG_LED_TEST_ADC, &adc);
 482
 483                 if (adc >= vdd || adc < LP5523_ADC_SHORTCIRC_LIM)
 484                         pos += sprintf(buf + pos, "LED %d FAIL\n", i);
 485
 486                 lp5523_write(chip->client, LP5523_REG_LED_PWM_BASE + i, 0x00);
 487
 488                 /* Restore current */
 489                 lp5523_write(chip->client,
 490                         LP5523_REG_LED_CURRENT_BASE + i,
 491                         chip->leds[led].led_current);
 492                 led++;
 493         }
 494         if (pos == 0)
 495                 pos = sprintf(buf, "OK\n");
 496         goto release_lock;
 497 fail:
 498         pos = sprintf(buf, "FAIL\n");
 499
 500 release_lock:
 501         mutex_unlock(&chip->lock);
 502
 503         return pos;
 504 }
 505
 506 static void lp5523_set_brightness(struct led_classdev *cdev,
 507                              enum led_brightness brightness)
 508 {
 509         struct lp5523_led *led = cdev_to_led(cdev);
 510
 511         led->brightness = (u8)brightness;
 512
 513         schedule_work(&led->brightness_work);
 514 }
 515
 516 static void lp5523_led_brightness_work(struct work_struct *work)
 517 {
 518         struct lp5523_led *led = container_of(work,
 519                                               struct lp5523_led,
 520                                               brightness_work);
 521         struct lp5523_chip *chip = led_to_lp5523(led);
 522         struct i2c_client *client = chip->client;
 523
 524         mutex_lock(&chip->lock);
 525
 526         lp5523_write(client, LP5523_REG_LED_PWM_BASE + led->chan_nr,
 527                      led->brightness);
 528
 529         mutex_unlock(&chip->lock);
 530 }
 531
 532 static int lp5523_do_store_load(struct lp5523_engine *engine,
 533                                 const char *buf, size_t len)
 534 {
 535         struct lp5523_chip *chip = engine_to_lp5523(engine);
 536         struct i2c_client *client = chip->client;
 537         int  ret, nrchars, offset = 0, i = 0;
 538         char c[3];
 539         unsigned cmd;
 540         u8 pattern[LP5523_PROGRAM_LENGTH] = {0};
 541
 542         while ((offset < len - 1) && (i < LP5523_PROGRAM_LENGTH)) {
 543                 /* separate sscanfs because length is working only for %s */
 544                 ret = sscanf(buf + offset, "%2s%n ", c, &nrchars);
 545                 ret = sscanf(c, "%2x", &cmd);
 546                 if (ret != 1)
 547                         goto fail;
 548                 pattern[i] = (u8)cmd;
 549
 550                 offset += nrchars;
 551                 i++;
 552         }
 553
 554         /* Each instruction is 16bit long. Check that length is even */
 555         if (i % 2)
 556                 goto fail;
 557
 558         mutex_lock(&chip->lock);
 559
 560         ret = lp5523_load_program(engine, pattern);
 561         mutex_unlock(&chip->lock);
 562
 563         if (ret) {
 564                 dev_err(&client->dev, "failed loading pattern\n");
 565                 return ret;
 566         }
 567
 568         return len;
 569 fail:
 570         dev_err(&client->dev, "wrong pattern format\n");
 571         return -EINVAL;
 572 }
 573
 574 static ssize_t store_engine_load(struct device *dev,
 575                                      struct device_attribute *attr,
 576                                      const char *buf, size_t len, int nr)
 577 {
 578         struct i2c_client *client = to_i2c_client(dev);
 579         struct lp5523_chip *chip = i2c_get_clientdata(client);
 580         return lp5523_do_store_load(&chip->engines[nr - 1], buf, len);
 581 }
 582
 583 #define store_load(nr)                                                  \
 584 static ssize_t store_engine##nr##_load(struct device *dev,              \
 585                                      struct device_attribute *attr,     \
 586                                      const char *buf, size_t len)       \
 587 {                                                                       \
 588         return store_engine_load(dev, attr, buf, len, nr);              \
 589 }
 590 store_load(1)
 591 store_load(2)
 592 store_load(3)
 593
 594 static ssize_t show_engine_mode(struct device *dev,
 595                                 struct device_attribute *attr,
 596                                 char *buf, int nr)
 597 {
 598         struct i2c_client *client = to_i2c_client(dev);
 599         struct lp5523_chip *chip = i2c_get_clientdata(client);
 600         switch (chip->engines[nr - 1].mode) {
 601         case LP5523_CMD_RUN:
 602                 return sprintf(buf, "run\n");
 603         case LP5523_CMD_LOAD:
 604                 return sprintf(buf, "load\n");
 605         case LP5523_CMD_DISABLED:
 606                 return sprintf(buf, "disabled\n");
 607         default:
 608                 return sprintf(buf, "disabled\n");
 609         }
 610 }
 611
 612 #define show_mode(nr)                                                   \
 613 static ssize_t show_engine##nr##_mode(struct device *dev,               \
 614                                     struct device_attribute *attr,      \
 615                                     char *buf)                          \
 616 {                                                                       \
 617         return show_engine_mode(dev, attr, buf, nr);                    \
 618 }
 619 show_mode(1)
 620 show_mode(2)
 621 show_mode(3)
 622
 623 static ssize_t store_engine_mode(struct device *dev,
 624                                  struct device_attribute *attr,
 625                                  const char *buf, size_t len, int nr)
 626 {
 627         struct i2c_client *client = to_i2c_client(dev);
 628         struct lp5523_chip *chip = i2c_get_clientdata(client);
 629         struct lp5523_engine *engine = &chip->engines[nr - 1];
 630         mutex_lock(&chip->lock);
 631
 632         if (!strncmp(buf, "run", 3))
 633                 lp5523_set_mode(engine, LP5523_CMD_RUN);
 634         else if (!strncmp(buf, "load", 4))
 635                 lp5523_set_mode(engine, LP5523_CMD_LOAD);
 636         else if (!strncmp(buf, "disabled", 8))
 637                 lp5523_set_mode(engine, LP5523_CMD_DISABLED);
 638
 639         mutex_unlock(&chip->lock);
 640         return len;
 641 }
 642
 643 #define store_mode(nr)                                                  \
 644 static ssize_t store_engine##nr##_mode(struct device *dev,              \
 645                                      struct device_attribute *attr,     \
 646                                      const char *buf, size_t len)       \
 647 {                                                                       \
 648         return store_engine_mode(dev, attr, buf, len, nr);              \
 649 }
 650 store_mode(1)
 651 store_mode(2)
 652 store_mode(3)
 653
 654 static ssize_t show_max_current(struct device *dev,
 655                             struct device_attribute *attr,
 656                             char *buf)
 657 {
 658         struct led_classdev *led_cdev = dev_get_drvdata(dev);
 659         struct lp5523_led *led = cdev_to_led(led_cdev);
 660
 661         return sprintf(buf, "%d\n", led->max_current);
 662 }
 663
 664 static ssize_t show_current(struct device *dev,
 665                             struct device_attribute *attr,
 666                             char *buf)
 667 {
 668         struct led_classdev *led_cdev = dev_get_drvdata(dev);
 669         struct lp5523_led *led = cdev_to_led(led_cdev);
 670
 671         return sprintf(buf, "%d\n", led->led_current);
 672 }
 673
 674 static ssize_t store_current(struct device *dev,
 675                              struct device_attribute *attr,
 676                              const char *buf, size_t len)
 677 {
 678         struct led_classdev *led_cdev = dev_get_drvdata(dev);
 679         struct lp5523_led *led = cdev_to_led(led_cdev);
 680         struct lp5523_chip *chip = led_to_lp5523(led);
 681         ssize_t ret;
 682         unsigned long curr;
 683
 684         if (strict_strtoul(buf, 0, &curr))
 685                 return -EINVAL;
 686
 687         if (curr > led->max_current)
 688                 return -EINVAL;
 689
 690         mutex_lock(&chip->lock);
 691         ret = lp5523_write(chip->client,
 692                         LP5523_REG_LED_CURRENT_BASE + led->chan_nr,
 693                         (u8)curr);
 694         mutex_unlock(&chip->lock);
 695
 696         if (ret < 0)
 697                 return ret;
 698
 699         led->led_current = (u8)curr;
 700
 701         return len;
 702 }
 703
 704 /* led class device attributes */
 705 static DEVICE_ATTR(led_current, S_IRUGO | S_IWUGO, show_current, store_current);
 706 static DEVICE_ATTR(max_current, S_IRUGO , show_max_current, NULL);
 707
 708 static struct attribute *lp5523_led_attributes[] = {
 709         &dev_attr_led_current.attr,
 710         &dev_attr_max_current.attr,
 711         NULL,
 712 };
 713
 714 static struct attribute_group lp5523_led_attribute_group = {
 715         .attrs = lp5523_led_attributes
 716 };
 717
 718 /* device attributes */
 719 static DEVICE_ATTR(engine1_mode, S_IRUGO | S_IWUGO,
 720                    show_engine1_mode, store_engine1_mode);
 721 static DEVICE_ATTR(engine2_mode, S_IRUGO | S_IWUGO,
 722                    show_engine2_mode, store_engine2_mode);
 723 static DEVICE_ATTR(engine3_mode, S_IRUGO | S_IWUGO,
 724                    show_engine3_mode, store_engine3_mode);
 725 static DEVICE_ATTR(engine1_leds, S_IRUGO | S_IWUGO,
 726                    show_engine1_leds, store_engine1_leds);
 727 static DEVICE_ATTR(engine2_leds, S_IRUGO | S_IWUGO,
 728                    show_engine2_leds, store_engine2_leds);
 729 static DEVICE_ATTR(engine3_leds, S_IRUGO | S_IWUGO,
 730                    show_engine3_leds, store_engine3_leds);
 731 static DEVICE_ATTR(engine1_load, S_IWUGO, NULL, store_engine1_load);
 732 static DEVICE_ATTR(engine2_load, S_IWUGO, NULL, store_engine2_load);
 733 static DEVICE_ATTR(engine3_load, S_IWUGO, NULL, store_engine3_load);
 734 static DEVICE_ATTR(selftest, S_IRUGO, lp5523_selftest, NULL);
 735
 736 static struct attribute *lp5523_attributes[] = {
 737         &dev_attr_engine1_mode.attr,
 738         &dev_attr_engine2_mode.attr,
 739         &dev_attr_engine3_mode.attr,
 740         &dev_attr_selftest.attr,
 741         NULL
 742 };
 743
 744 static struct attribute *lp5523_engine1_attributes[] = {
 745         &dev_attr_engine1_load.attr,
 746         &dev_attr_engine1_leds.attr,
 747         NULL
 748 };
 749
 750 static struct attribute *lp5523_engine2_attributes[] = {
 751         &dev_attr_engine2_load.attr,
 752         &dev_attr_engine2_leds.attr,
 753         NULL
 754 };
 755
 756 static struct attribute *lp5523_engine3_attributes[] = {
 757         &dev_attr_engine3_load.attr,
 758         &dev_attr_engine3_leds.attr,
 759         NULL
 760 };
 761
 762 static const struct attribute_group lp5523_group = {
 763         .attrs = lp5523_attributes,
 764 };
 765
 766 static const struct attribute_group lp5523_engine_group[] = {
 767         {.attrs = lp5523_engine1_attributes },
 768         {.attrs = lp5523_engine2_attributes },
 769         {.attrs = lp5523_engine3_attributes },
 770 };
 771
 772 static int lp5523_register_sysfs(struct i2c_client *client)
 773 {
 774         struct device *dev = &client->dev;
 775         int ret;
 776
 777         ret = sysfs_create_group(&dev->kobj, &lp5523_group);
 778         if (ret < 0)
 779                 return ret;
 780
 781         return 0;
 782 }
 783
 784 static void lp5523_unregister_sysfs(struct i2c_client *client)
 785 {
 786         struct lp5523_chip *chip = i2c_get_clientdata(client);
 787         struct device *dev = &client->dev;
 788         int i;
 789
 790         sysfs_remove_group(&dev->kobj, &lp5523_group);
 791
 792         for (i = 0; i < ARRAY_SIZE(chip->engines); i++)
 793                 if (chip->engines[i].mode == LP5523_CMD_LOAD)
 794                         sysfs_remove_group(&dev->kobj, &lp5523_engine_group[i]);
 795
 796         for (i = 0; i < chip->num_leds; i++)
 797                 sysfs_remove_group(&chip->leds[i].cdev.dev->kobj,
 798                                 &lp5523_led_attribute_group);
 799 }
 800
 801 /*--------------------------------------------------------------*/
 802 /*                      Set chip operating mode                 */
 803 /*--------------------------------------------------------------*/
 804 static int lp5523_set_mode(struct lp5523_engine *engine, u8 mode)
 805 {
 806         /*  engine to chip */
 807         struct lp5523_chip *chip = engine_to_lp5523(engine);
 808         struct i2c_client *client = chip->client;
 809         struct device *dev = &client->dev;
 810         int ret = 0;
 811
 812         /* if in that mode already do nothing, except for run */
 813         if (mode == engine->mode && mode != LP5523_CMD_RUN)
 814                 return 0;
 815
 816         if (mode == LP5523_CMD_RUN) {
 817                 ret = lp5523_run_program(engine);
 818         } else if (mode == LP5523_CMD_LOAD) {
 819                 lp5523_set_engine_mode(engine, LP5523_CMD_DISABLED);
 820                 lp5523_set_engine_mode(engine, LP5523_CMD_LOAD);
 821
 822                 ret = sysfs_create_group(&dev->kobj, engine->attributes);
 823                 if (ret)
 824                         return ret;
 825         } else if (mode == LP5523_CMD_DISABLED) {
 826                 lp5523_set_engine_mode(engine, LP5523_CMD_DISABLED);
 827         }
 828
 829         /* remove load attribute from sysfs if not in load mode */
 830         if (engine->mode == LP5523_CMD_LOAD && mode != LP5523_CMD_LOAD)
 831                 sysfs_remove_group(&dev->kobj, engine->attributes);
 832
 833         engine->mode = mode;
 834
 835         return ret;
 836 }
 837
 838 /*--------------------------------------------------------------*/
 839 /*                      Probe, Attach, Remove                   */
 840 /*--------------------------------------------------------------*/
 841 static int __init lp5523_init_engine(struct lp5523_engine *engine, int id)
 842 {
 843         if (id < 1 || id > LP5523_ENGINES)
 844                 return -1;
 845         engine->id = id;
 846         engine->engine_mask = LP5523_ENG_MASK_BASE >> SHIFT_MASK(id);
 847         engine->prog_page = id - 1;
 848         engine->mux_page = id + 2;
 849         engine->attributes = &lp5523_engine_group[id - 1];
 850
 851         return 0;
 852 }
 853
 854 static int __init lp5523_init_led(struct lp5523_led *led, struct device *dev,
 855                            int chan, struct lp5523_platform_data *pdata)
 856 {
 857         char name[32];
 858         int res;
 859
 860         if (chan >= LP5523_LEDS)
 861                 return -EINVAL;
 862
 863         if (pdata->led_config[chan].led_current) {
 864                 led->led_current = pdata->led_config[chan].led_current;
 865                 led->max_current = pdata->led_config[chan].max_current;
 866                 led->chan_nr = pdata->led_config[chan].chan_nr;
 867
 868                 if (led->chan_nr >= LP5523_LEDS) {
 869                         dev_err(dev, "Use channel numbers between 0 and %d\n",
 870                                 LP5523_LEDS - 1);
 871                         return -EINVAL;
 872                 }
 873
 874                 snprintf(name, 32, "lp5523:channel%d", chan);
 875
 876                 led->cdev.name = name;
 877                 led->cdev.brightness_set = lp5523_set_brightness;
 878                 res = led_classdev_register(dev, &led->cdev);
 879                 if (res < 0) {
 880                         dev_err(dev, "couldn't register led on channel %d\n",
 881                                 chan);
 882                         return res;
 883                 }
 884                 res = sysfs_create_group(&led->cdev.dev->kobj,
 885                                 &lp5523_led_attribute_group);
 886                 if (res < 0) {
 887                         dev_err(dev, "couldn't register current attribute\n");
 888                         led_classdev_unregister(&led->cdev);
 889                         return res;
 890                 }
 891         } else {
 892                 led->led_current = 0;
 893         }
 894         return 0;
 895 }
 896
 897 static struct i2c_driver lp5523_driver;
 898
 899 static int lp5523_probe(struct i2c_client *client,
 900                         const struct i2c_device_id *id)
 901 {
 902         struct lp5523_chip              *chip;
 903         struct lp5523_platform_data     *pdata;
 904         int ret, i, led;
 905
 906         chip = kzalloc(sizeof(*chip), GFP_KERNEL);
 907         if (!chip)
 908                 return -ENOMEM;
 909
 910         i2c_set_clientdata(client, chip);
 911         chip->client = client;
 912
 913         pdata = client->dev.platform_data;
 914
 915         if (!pdata) {
 916                 dev_err(&client->dev, "no platform data\n");
 917                 ret = -EINVAL;
 918                 goto fail1;
 919         }
 920
 921         mutex_init(&chip->lock);
 922
 923         chip->pdata   = pdata;
 924
 925         if (pdata->setup_resources) {
 926                 ret = pdata->setup_resources();
 927                 if (ret < 0)
 928                         goto fail1;
 929         }
 930
 931         if (pdata->enable) {
 932                 pdata->enable(0);
 933                 usleep_range(1000, 10000);
 934                 pdata->enable(1);
 935                 usleep_range(1000, 10000); /* Spec says min 500us */
 936         }
 937
 938         ret = lp5523_detect(client);
 939         if (ret)
 940                 goto fail2;
 941
 942         dev_info(&client->dev, "LP5523 Programmable led chip found\n");
 943
 944         /* Initialize engines */
 945         for (i = 0; i < ARRAY_SIZE(chip->engines); i++) {
 946                 ret = lp5523_init_engine(&chip->engines[i], i + 1);
 947                 if (ret) {
 948                         dev_err(&client->dev, "error initializing engine\n");
 949                         goto fail2;
 950                 }
 951         }
 952         ret = lp5523_configure(client);
 953         if (ret < 0) {
 954                 dev_err(&client->dev, "error configuring chip\n");
 955                 goto fail2;
 956         }
 957
 958         /* Initialize leds */
 959         chip->num_channels = pdata->num_channels;
 960         chip->num_leds = 0;
 961         led = 0;
 962         for (i = 0; i < pdata->num_channels; i++) {
 963                 /* Do not initialize channels that are not connected */
 964                 if (pdata->led_config[i].led_current == 0)
 965                         continue;
 966
 967                 ret = lp5523_init_led(&chip->leds[led], &client->dev, i, pdata);
 968                 if (ret) {
 969                         dev_err(&client->dev, "error initializing leds\n");
 970                         goto fail3;
 971                 }
 972                 chip->num_leds++;
 973
 974                 chip->leds[led].id = led;
 975                 /* Set LED current */
 976                 lp5523_write(client,
 977                           LP5523_REG_LED_CURRENT_BASE + chip->leds[led].chan_nr,
 978                           chip->leds[led].led_current);
 979
 980                 INIT_WORK(&(chip->leds[led].brightness_work),
 981                         lp5523_led_brightness_work);
 982
 983                 led++;
 984         }
 985
 986         ret = lp5523_register_sysfs(client);
 987         if (ret) {
 988                 dev_err(&client->dev, "registering sysfs failed\n");
 989                 goto fail3;
 990         }
 991         return ret;
 992 fail3:
 993         for (i = 0; i < chip->num_leds; i++) {
 994                 led_classdev_unregister(&chip->leds[i].cdev);
 995                 cancel_work_sync(&chip->leds[i].brightness_work);
 996         }
 997 fail2:
 998         if (pdata->enable)
 999                 pdata->enable(0);
1000         if (pdata->release_resources)
1001                 pdata->release_resources();
1002 fail1:
1003         kfree(chip);
1004         return ret;
1005 }
1006
1007 static int lp5523_remove(struct i2c_client *client)
1008 {
1009         struct lp5523_chip *chip = i2c_get_clientdata(client);
1010         int i;
1011
1012         lp5523_unregister_sysfs(client);
1013
1014         for (i = 0; i < chip->num_leds; i++) {
1015                 led_classdev_unregister(&chip->leds[i].cdev);
1016                 cancel_work_sync(&chip->leds[i].brightness_work);
1017         }
1018
1019         if (chip->pdata->enable)
1020                 chip->pdata->enable(0);
1021         if (chip->pdata->release_resources)
1022                 chip->pdata->release_resources();
1023         kfree(chip);
1024         return 0;
1025 }
1026
1027 static const struct i2c_device_id lp5523_id[] = {
1028         { "lp5523", 0 },
1029         { }
1030 };
1031
1032 MODULE_DEVICE_TABLE(i2c, lp5523_id);
1033
1034 static struct i2c_driver lp5523_driver = {
1035         .driver = {
1036                 .name   = "lp5523",
1037         },
1038         .probe          = lp5523_probe,
1039         .remove         = lp5523_remove,
1040         .id_table       = lp5523_id,
1041 };
1042
1043 static int __init lp5523_init(void)
1044 {
1045         int ret;
1046
1047         ret = i2c_add_driver(&lp5523_driver);
1048
1049         if (ret < 0)
1050                 printk(KERN_ALERT "Adding lp5523 driver failed\n");
1051
1052         return ret;
1053 }
1054
1055 static void __exit lp5523_exit(void)
1056 {
1057         i2c_del_driver(&lp5523_driver);
1058 }
1059
1060 module_init(lp5523_init);
1061 module_exit(lp5523_exit);
1062
1063 MODULE_AUTHOR("Mathias Nyman <mathias.nyman@nokia.com>");
1064 MODULE_DESCRIPTION("LP5523 LED engine");
1065 MODULE_LICENSE("GPL");