2 * Copyright 2007-2008 Extreme Engineering Solutions, Inc.
4 * Author: Nate Case <ncase@xes-inc.com>
6 * This file is subject to the terms and conditions of version 2 of
7 * the GNU General Public License. See the file COPYING in the main
8 * directory of this archive for more details.
10 * LED driver for various PCA955x I2C LED drivers
14 * Device Description 7-bit slave address
15 * ------ ----------- -------------------
16 * PCA9550 2-bit driver 0x60 .. 0x61
17 * PCA9551 8-bit driver 0x60 .. 0x67
18 * PCA9552 16-bit driver 0x60 .. 0x67
19 * PCA9553/01 4-bit driver 0x62
20 * PCA9553/02 4-bit driver 0x63
22 * Philips PCA955x LED driver chips follow a register map as shown below:
24 * Control Register Description
25 * ---------------- -----------
26 * 0x0 Input register 0
28 * NUM_INPUT_REGS - 1 Last Input register X
30 * NUM_INPUT_REGS Frequency prescaler 0
31 * NUM_INPUT_REGS + 1 PWM register 0
32 * NUM_INPUT_REGS + 2 Frequency prescaler 1
33 * NUM_INPUT_REGS + 3 PWM register 1
35 * NUM_INPUT_REGS + 4 LED selector 0
37 * + NUM_LED_REGS - 1 Last LED selector
39 * where NUM_INPUT_REGS and NUM_LED_REGS vary depending on how many
40 * bits the chip supports.
43 #include <linux/acpi.h>
44 #include <linux/ctype.h>
45 #include <linux/delay.h>
46 #include <linux/err.h>
47 #include <linux/gpio.h>
48 #include <linux/i2c.h>
49 #include <linux/leds.h>
50 #include <linux/module.h>
51 #include <linux/of_device.h>
53 #include <linux/slab.h>
54 #include <linux/string.h>
56 #include <dt-bindings/leds/leds-pca955x.h>
58 /* LED select registers determine the source that drives LED outputs */
59 #define PCA955X_LS_LED_ON 0x0 /* Output LOW */
60 #define PCA955X_LS_LED_OFF 0x1 /* Output HI-Z */
61 #define PCA955X_LS_BLINK0 0x2 /* Blink at PWM0 rate */
62 #define PCA955X_LS_BLINK1 0x3 /* Blink at PWM1 rate */
64 #define PCA955X_GPIO_INPUT LED_OFF
65 #define PCA955X_GPIO_HIGH LED_OFF
66 #define PCA955X_GPIO_LOW LED_FULL
75 struct pca955x_chipdef {
77 u8 slv_addr; /* 7-bit slave address mask */
78 int slv_addr_shift; /* Number of bits to ignore */
81 static struct pca955x_chipdef pca955x_chipdefs[] = {
84 .slv_addr = /* 110000x */ 0x60,
89 .slv_addr = /* 1100xxx */ 0x60,
94 .slv_addr = /* 1100xxx */ 0x60,
99 .slv_addr = /* 110001x */ 0x62,
104 static const struct i2c_device_id pca955x_id[] = {
105 { "pca9550", pca9550 },
106 { "pca9551", pca9551 },
107 { "pca9552", pca9552 },
108 { "pca9553", pca9553 },
111 MODULE_DEVICE_TABLE(i2c, pca955x_id);
113 static const struct acpi_device_id pca955x_acpi_ids[] = {
114 { "PCA9550", pca9550 },
115 { "PCA9551", pca9551 },
116 { "PCA9552", pca9552 },
117 { "PCA9553", pca9553 },
120 MODULE_DEVICE_TABLE(acpi, pca955x_acpi_ids);
124 struct pca955x_led *leds;
125 struct pca955x_chipdef *chipdef;
126 struct i2c_client *client;
127 #ifdef CONFIG_LEDS_PCA955X_GPIO
128 struct gpio_chip gpio;
133 struct pca955x *pca955x;
134 struct led_classdev led_cdev;
135 int led_num; /* 0 .. 15 potentially */
138 const char *default_trigger;
141 struct pca955x_platform_data {
142 struct pca955x_led *leds;
146 /* 8 bits per input register */
147 static inline int pca95xx_num_input_regs(int bits)
149 return (bits + 7) / 8;
152 /* 4 bits per LED selector register */
153 static inline int pca95xx_num_led_regs(int bits)
155 return (bits + 3) / 4;
159 * Return an LED selector register value based on an existing one, with
160 * the appropriate 2-bit state value set for the given LED number (0-3).
162 static inline u8 pca955x_ledsel(u8 oldval, int led_num, int state)
164 return (oldval & (~(0x3 << (led_num << 1)))) |
165 ((state & 0x3) << (led_num << 1));
169 * Write to frequency prescaler register, used to program the
170 * period of the PWM output. period = (PSCx + 1) / 38
172 static int pca955x_write_psc(struct i2c_client *client, int n, u8 val)
174 struct pca955x *pca955x = i2c_get_clientdata(client);
177 ret = i2c_smbus_write_byte_data(client,
178 pca95xx_num_input_regs(pca955x->chipdef->bits) + 2*n,
181 dev_err(&client->dev, "%s: reg 0x%x, val 0x%x, err %d\n",
182 __func__, n, val, ret);
187 * Write to PWM register, which determines the duty cycle of the
188 * output. LED is OFF when the count is less than the value of this
189 * register, and ON when it is greater. If PWMx == 0, LED is always OFF.
191 * Duty cycle is (256 - PWMx) / 256
193 static int pca955x_write_pwm(struct i2c_client *client, int n, u8 val)
195 struct pca955x *pca955x = i2c_get_clientdata(client);
198 ret = i2c_smbus_write_byte_data(client,
199 pca95xx_num_input_regs(pca955x->chipdef->bits) + 1 + 2*n,
202 dev_err(&client->dev, "%s: reg 0x%x, val 0x%x, err %d\n",
203 __func__, n, val, ret);
208 * Write to LED selector register, which determines the source that
209 * drives the LED output.
211 static int pca955x_write_ls(struct i2c_client *client, int n, u8 val)
213 struct pca955x *pca955x = i2c_get_clientdata(client);
216 ret = i2c_smbus_write_byte_data(client,
217 pca95xx_num_input_regs(pca955x->chipdef->bits) + 4 + n,
220 dev_err(&client->dev, "%s: reg 0x%x, val 0x%x, err %d\n",
221 __func__, n, val, ret);
226 * Read the LED selector register, which determines the source that
227 * drives the LED output.
229 static int pca955x_read_ls(struct i2c_client *client, int n, u8 *val)
231 struct pca955x *pca955x = i2c_get_clientdata(client);
234 ret = i2c_smbus_read_byte_data(client,
235 pca95xx_num_input_regs(pca955x->chipdef->bits) + 4 + n);
237 dev_err(&client->dev, "%s: reg 0x%x, err %d\n",
245 static int pca955x_led_set(struct led_classdev *led_cdev,
246 enum led_brightness value)
248 struct pca955x_led *pca955x_led;
249 struct pca955x *pca955x;
251 int chip_ls; /* which LSx to use (0-3 potentially) */
252 int ls_led; /* which set of bits within LSx to use (0-3) */
255 pca955x_led = container_of(led_cdev, struct pca955x_led, led_cdev);
256 pca955x = pca955x_led->pca955x;
258 chip_ls = pca955x_led->led_num / 4;
259 ls_led = pca955x_led->led_num % 4;
261 mutex_lock(&pca955x->lock);
263 ret = pca955x_read_ls(pca955x->client, chip_ls, &ls);
269 ls = pca955x_ledsel(ls, ls_led, PCA955X_LS_LED_ON);
272 ls = pca955x_ledsel(ls, ls_led, PCA955X_LS_LED_OFF);
275 ls = pca955x_ledsel(ls, ls_led, PCA955X_LS_BLINK0);
279 * Use PWM1 for all other values. This has the unwanted
280 * side effect of making all LEDs on the chip share the
281 * same brightness level if set to a value other than
282 * OFF, HALF, or FULL. But, this is probably better than
283 * just turning off for all other values.
285 ret = pca955x_write_pwm(pca955x->client, 1, 255 - value);
288 ls = pca955x_ledsel(ls, ls_led, PCA955X_LS_BLINK1);
292 ret = pca955x_write_ls(pca955x->client, chip_ls, ls);
295 mutex_unlock(&pca955x->lock);
300 #ifdef CONFIG_LEDS_PCA955X_GPIO
302 * Read the INPUT register, which contains the state of LEDs.
304 static int pca955x_read_input(struct i2c_client *client, int n, u8 *val)
306 int ret = i2c_smbus_read_byte_data(client, n);
309 dev_err(&client->dev, "%s: reg 0x%x, err %d\n",
318 static int pca955x_gpio_request_pin(struct gpio_chip *gc, unsigned int offset)
320 struct pca955x *pca955x = gpiochip_get_data(gc);
321 struct pca955x_led *led = &pca955x->leds[offset];
323 if (led->type == PCA955X_TYPE_GPIO)
329 static int pca955x_set_value(struct gpio_chip *gc, unsigned int offset,
332 struct pca955x *pca955x = gpiochip_get_data(gc);
333 struct pca955x_led *led = &pca955x->leds[offset];
336 return pca955x_led_set(&led->led_cdev, PCA955X_GPIO_HIGH);
338 return pca955x_led_set(&led->led_cdev, PCA955X_GPIO_LOW);
341 static void pca955x_gpio_set_value(struct gpio_chip *gc, unsigned int offset,
344 pca955x_set_value(gc, offset, val);
347 static int pca955x_gpio_get_value(struct gpio_chip *gc, unsigned int offset)
349 struct pca955x *pca955x = gpiochip_get_data(gc);
350 struct pca955x_led *led = &pca955x->leds[offset];
353 /* There is nothing we can do about errors */
354 pca955x_read_input(pca955x->client, led->led_num / 8, ®);
356 return !!(reg & (1 << (led->led_num % 8)));
359 static int pca955x_gpio_direction_input(struct gpio_chip *gc,
362 struct pca955x *pca955x = gpiochip_get_data(gc);
363 struct pca955x_led *led = &pca955x->leds[offset];
365 /* To use as input ensure pin is not driven. */
366 return pca955x_led_set(&led->led_cdev, PCA955X_GPIO_INPUT);
369 static int pca955x_gpio_direction_output(struct gpio_chip *gc,
370 unsigned int offset, int val)
372 return pca955x_set_value(gc, offset, val);
374 #endif /* CONFIG_LEDS_PCA955X_GPIO */
376 #if IS_ENABLED(CONFIG_OF)
377 static struct pca955x_platform_data *
378 pca955x_pdata_of_init(struct i2c_client *client, struct pca955x_chipdef *chip)
380 struct device_node *np = client->dev.of_node;
381 struct device_node *child;
382 struct pca955x_platform_data *pdata;
385 count = of_get_child_count(np);
386 if (!count || count > chip->bits)
387 return ERR_PTR(-ENODEV);
389 pdata = devm_kzalloc(&client->dev, sizeof(*pdata), GFP_KERNEL);
391 return ERR_PTR(-ENOMEM);
393 pdata->leds = devm_kzalloc(&client->dev,
394 sizeof(struct pca955x_led) * chip->bits,
397 return ERR_PTR(-ENOMEM);
399 for_each_child_of_node(np, child) {
404 res = of_property_read_u32(child, "reg", ®);
405 if ((res != 0) || (reg >= chip->bits))
408 if (of_property_read_string(child, "label", &name))
411 snprintf(pdata->leds[reg].name, sizeof(pdata->leds[reg].name),
414 pdata->leds[reg].type = PCA955X_TYPE_LED;
415 of_property_read_u32(child, "type", &pdata->leds[reg].type);
416 of_property_read_string(child, "linux,default-trigger",
417 &pdata->leds[reg].default_trigger);
420 pdata->num_leds = chip->bits;
425 static const struct of_device_id of_pca955x_match[] = {
426 { .compatible = "nxp,pca9550", .data = (void *)pca9550 },
427 { .compatible = "nxp,pca9551", .data = (void *)pca9551 },
428 { .compatible = "nxp,pca9552", .data = (void *)pca9552 },
429 { .compatible = "nxp,pca9553", .data = (void *)pca9553 },
433 MODULE_DEVICE_TABLE(of, of_pca955x_match);
435 static struct pca955x_platform_data *
436 pca955x_pdata_of_init(struct i2c_client *client, struct pca955x_chipdef *chip)
438 return ERR_PTR(-ENODEV);
442 static int pca955x_probe(struct i2c_client *client,
443 const struct i2c_device_id *id)
445 struct pca955x *pca955x;
446 struct pca955x_led *pca955x_led;
447 struct pca955x_chipdef *chip;
448 struct i2c_adapter *adapter;
450 struct pca955x_platform_data *pdata;
454 chip = &pca955x_chipdefs[id->driver_data];
456 const struct acpi_device_id *acpi_id;
458 acpi_id = acpi_match_device(pca955x_acpi_ids, &client->dev);
461 chip = &pca955x_chipdefs[acpi_id->driver_data];
463 adapter = to_i2c_adapter(client->dev.parent);
464 pdata = dev_get_platdata(&client->dev);
466 pdata = pca955x_pdata_of_init(client, chip);
468 return PTR_ERR(pdata);
471 /* Make sure the slave address / chip type combo given is possible */
472 if ((client->addr & ~((1 << chip->slv_addr_shift) - 1)) !=
474 dev_err(&client->dev, "invalid slave address %02x\n",
479 dev_info(&client->dev, "leds-pca955x: Using %s %d-bit LED driver at "
480 "slave address 0x%02x\n",
481 client->name, chip->bits, client->addr);
483 if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA))
486 if (pdata->num_leds != chip->bits) {
487 dev_err(&client->dev,
488 "board info claims %d LEDs on a %d-bit chip\n",
489 pdata->num_leds, chip->bits);
493 pca955x = devm_kzalloc(&client->dev, sizeof(*pca955x), GFP_KERNEL);
497 pca955x->leds = devm_kzalloc(&client->dev,
498 sizeof(*pca955x_led) * chip->bits, GFP_KERNEL);
502 i2c_set_clientdata(client, pca955x);
504 mutex_init(&pca955x->lock);
505 pca955x->client = client;
506 pca955x->chipdef = chip;
508 for (i = 0; i < chip->bits; i++) {
509 pca955x_led = &pca955x->leds[i];
510 pca955x_led->led_num = i;
511 pca955x_led->pca955x = pca955x;
512 pca955x_led->type = pdata->leds[i].type;
514 switch (pca955x_led->type) {
515 case PCA955X_TYPE_NONE:
517 case PCA955X_TYPE_GPIO:
520 case PCA955X_TYPE_LED:
522 * Platform data can specify LED names and
525 if (pdata->leds[i].name[0] == '\0')
526 snprintf(pdata->leds[i].name,
527 sizeof(pdata->leds[i].name), "%d", i);
529 snprintf(pca955x_led->name,
530 sizeof(pca955x_led->name), "pca955x:%s",
531 pdata->leds[i].name);
533 if (pdata->leds[i].default_trigger)
534 pca955x_led->led_cdev.default_trigger =
535 pdata->leds[i].default_trigger;
537 pca955x_led->led_cdev.name = pca955x_led->name;
538 pca955x_led->led_cdev.brightness_set_blocking =
541 err = devm_led_classdev_register(&client->dev,
542 &pca955x_led->led_cdev);
547 err = pca955x_led_set(&pca955x_led->led_cdev, LED_OFF);
553 /* PWM0 is used for half brightness or 50% duty cycle */
554 err = pca955x_write_pwm(client, 0, 255 - LED_HALF);
558 /* PWM1 is used for variable brightness, default to OFF */
559 err = pca955x_write_pwm(client, 1, 0);
563 /* Set to fast frequency so we do not see flashing */
564 err = pca955x_write_psc(client, 0, 0);
567 err = pca955x_write_psc(client, 1, 0);
571 #ifdef CONFIG_LEDS_PCA955X_GPIO
573 pca955x->gpio.label = "gpio-pca955x";
574 pca955x->gpio.direction_input = pca955x_gpio_direction_input;
575 pca955x->gpio.direction_output = pca955x_gpio_direction_output;
576 pca955x->gpio.set = pca955x_gpio_set_value;
577 pca955x->gpio.get = pca955x_gpio_get_value;
578 pca955x->gpio.request = pca955x_gpio_request_pin;
579 pca955x->gpio.can_sleep = 1;
580 pca955x->gpio.base = -1;
581 pca955x->gpio.ngpio = ngpios;
582 pca955x->gpio.parent = &client->dev;
583 pca955x->gpio.owner = THIS_MODULE;
585 err = devm_gpiochip_add_data(&client->dev, &pca955x->gpio,
588 /* Use data->gpio.dev as a flag for freeing gpiochip */
589 pca955x->gpio.parent = NULL;
590 dev_warn(&client->dev, "could not add gpiochip\n");
593 dev_info(&client->dev, "gpios %i...%i\n",
594 pca955x->gpio.base, pca955x->gpio.base +
595 pca955x->gpio.ngpio - 1);
602 static struct i2c_driver pca955x_driver = {
604 .name = "leds-pca955x",
605 .acpi_match_table = ACPI_PTR(pca955x_acpi_ids),
606 .of_match_table = of_match_ptr(of_pca955x_match),
608 .probe = pca955x_probe,
609 .id_table = pca955x_id,
612 module_i2c_driver(pca955x_driver);
614 MODULE_AUTHOR("Nate Case <ncase@xes-inc.com>");
615 MODULE_DESCRIPTION("PCA955x LED driver");
616 MODULE_LICENSE("GPL v2");