1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright 2007-2008 Extreme Engineering Solutions, Inc.
5 * Author: Nate Case <ncase@xes-inc.com>
7 * LED driver for various PCA955x I2C LED drivers
11 * Device Description 7-bit slave address
12 * ------ ----------- -------------------
13 * PCA9550 2-bit driver 0x60 .. 0x61
14 * PCA9551 8-bit driver 0x60 .. 0x67
15 * PCA9552 16-bit driver 0x60 .. 0x67
16 * PCA9553/01 4-bit driver 0x62
17 * PCA9553/02 4-bit driver 0x63
19 * Philips PCA955x LED driver chips follow a register map as shown below:
21 * Control Register Description
22 * ---------------- -----------
23 * 0x0 Input register 0
25 * NUM_INPUT_REGS - 1 Last Input register X
27 * NUM_INPUT_REGS Frequency prescaler 0
28 * NUM_INPUT_REGS + 1 PWM register 0
29 * NUM_INPUT_REGS + 2 Frequency prescaler 1
30 * NUM_INPUT_REGS + 3 PWM register 1
32 * NUM_INPUT_REGS + 4 LED selector 0
34 * + NUM_LED_REGS - 1 Last LED selector
36 * where NUM_INPUT_REGS and NUM_LED_REGS vary depending on how many
37 * bits the chip supports.
40 #include <linux/ctype.h>
41 #include <linux/delay.h>
42 #include <linux/err.h>
43 #include <linux/gpio/driver.h>
44 #include <linux/i2c.h>
45 #include <linux/leds.h>
46 #include <linux/module.h>
48 #include <linux/property.h>
49 #include <linux/slab.h>
50 #include <linux/string.h>
52 #include <dt-bindings/leds/leds-pca955x.h>
54 /* LED select registers determine the source that drives LED outputs */
55 #define PCA955X_LS_LED_ON 0x0 /* Output LOW */
56 #define PCA955X_LS_LED_OFF 0x1 /* Output HI-Z */
57 #define PCA955X_LS_BLINK0 0x2 /* Blink at PWM0 rate */
58 #define PCA955X_LS_BLINK1 0x3 /* Blink at PWM1 rate */
60 #define PCA955X_GPIO_INPUT LED_OFF
61 #define PCA955X_GPIO_HIGH LED_OFF
62 #define PCA955X_GPIO_LOW LED_FULL
72 struct pca955x_chipdef {
74 u8 slv_addr; /* 7-bit slave address mask */
75 int slv_addr_shift; /* Number of bits to ignore */
78 static struct pca955x_chipdef pca955x_chipdefs[] = {
81 .slv_addr = /* 110000x */ 0x60,
86 .slv_addr = /* 1100xxx */ 0x60,
91 .slv_addr = /* 1100xxx */ 0x60,
96 .slv_addr = /* 0110xxx */ 0x30,
101 .slv_addr = /* 110001x */ 0x62,
106 static const struct i2c_device_id pca955x_id[] = {
107 { "pca9550", pca9550 },
108 { "pca9551", pca9551 },
109 { "pca9552", pca9552 },
110 { "ibm-pca9552", ibm_pca9552 },
111 { "pca9553", pca9553 },
114 MODULE_DEVICE_TABLE(i2c, pca955x_id);
118 struct pca955x_led *leds;
119 struct pca955x_chipdef *chipdef;
120 struct i2c_client *client;
121 #ifdef CONFIG_LEDS_PCA955X_GPIO
122 struct gpio_chip gpio;
127 struct pca955x *pca955x;
128 struct led_classdev led_cdev;
129 int led_num; /* 0 .. 15 potentially */
132 struct fwnode_handle *fwnode;
135 struct pca955x_platform_data {
136 struct pca955x_led *leds;
140 /* 8 bits per input register */
141 static inline int pca95xx_num_input_regs(int bits)
143 return (bits + 7) / 8;
146 /* 4 bits per LED selector register */
147 static inline int pca95xx_num_led_regs(int bits)
149 return (bits + 3) / 4;
153 * Return an LED selector register value based on an existing one, with
154 * the appropriate 2-bit state value set for the given LED number (0-3).
156 static inline u8 pca955x_ledsel(u8 oldval, int led_num, int state)
158 return (oldval & (~(0x3 << (led_num << 1)))) |
159 ((state & 0x3) << (led_num << 1));
163 * Write to frequency prescaler register, used to program the
164 * period of the PWM output. period = (PSCx + 1) / 38
166 static int pca955x_write_psc(struct i2c_client *client, int n, u8 val)
168 struct pca955x *pca955x = i2c_get_clientdata(client);
169 u8 cmd = pca95xx_num_input_regs(pca955x->chipdef->bits) + (2 * n);
172 ret = i2c_smbus_write_byte_data(client, cmd, val);
174 dev_err(&client->dev, "%s: reg 0x%x, val 0x%x, err %d\n",
175 __func__, n, val, ret);
180 * Write to PWM register, which determines the duty cycle of the
181 * output. LED is OFF when the count is less than the value of this
182 * register, and ON when it is greater. If PWMx == 0, LED is always OFF.
184 * Duty cycle is (256 - PWMx) / 256
186 static int pca955x_write_pwm(struct i2c_client *client, int n, u8 val)
188 struct pca955x *pca955x = i2c_get_clientdata(client);
189 u8 cmd = pca95xx_num_input_regs(pca955x->chipdef->bits) + 1 + (2 * n);
192 ret = i2c_smbus_write_byte_data(client, cmd, val);
194 dev_err(&client->dev, "%s: reg 0x%x, val 0x%x, err %d\n",
195 __func__, n, val, ret);
200 * Write to LED selector register, which determines the source that
201 * drives the LED output.
203 static int pca955x_write_ls(struct i2c_client *client, int n, u8 val)
205 struct pca955x *pca955x = i2c_get_clientdata(client);
206 u8 cmd = pca95xx_num_input_regs(pca955x->chipdef->bits) + 4 + n;
209 ret = i2c_smbus_write_byte_data(client, cmd, val);
211 dev_err(&client->dev, "%s: reg 0x%x, val 0x%x, err %d\n",
212 __func__, n, val, ret);
217 * Read the LED selector register, which determines the source that
218 * drives the LED output.
220 static int pca955x_read_ls(struct i2c_client *client, int n, u8 *val)
222 struct pca955x *pca955x = i2c_get_clientdata(client);
223 u8 cmd = pca95xx_num_input_regs(pca955x->chipdef->bits) + 4 + n;
226 ret = i2c_smbus_read_byte_data(client, cmd);
228 dev_err(&client->dev, "%s: reg 0x%x, err %d\n",
236 static int pca955x_read_pwm(struct i2c_client *client, int n, u8 *val)
238 struct pca955x *pca955x = i2c_get_clientdata(client);
239 u8 cmd = pca95xx_num_input_regs(pca955x->chipdef->bits) + 1 + (2 * n);
242 ret = i2c_smbus_read_byte_data(client, cmd);
244 dev_err(&client->dev, "%s: reg 0x%x, err %d\n",
252 static enum led_brightness pca955x_led_get(struct led_classdev *led_cdev)
254 struct pca955x_led *pca955x_led = container_of(led_cdev,
257 struct pca955x *pca955x = pca955x_led->pca955x;
261 ret = pca955x_read_ls(pca955x->client, pca955x_led->led_num / 4, &ls);
265 ls = (ls >> ((pca955x_led->led_num % 4) << 1)) & 0x3;
267 case PCA955X_LS_LED_ON:
270 case PCA955X_LS_LED_OFF:
273 case PCA955X_LS_BLINK0:
276 case PCA955X_LS_BLINK1:
277 ret = pca955x_read_pwm(pca955x->client, 1, &pwm);
287 static int pca955x_led_set(struct led_classdev *led_cdev,
288 enum led_brightness value)
290 struct pca955x_led *pca955x_led;
291 struct pca955x *pca955x;
293 int chip_ls; /* which LSx to use (0-3 potentially) */
294 int ls_led; /* which set of bits within LSx to use (0-3) */
297 pca955x_led = container_of(led_cdev, struct pca955x_led, led_cdev);
298 pca955x = pca955x_led->pca955x;
300 chip_ls = pca955x_led->led_num / 4;
301 ls_led = pca955x_led->led_num % 4;
303 mutex_lock(&pca955x->lock);
305 ret = pca955x_read_ls(pca955x->client, chip_ls, &ls);
311 ls = pca955x_ledsel(ls, ls_led, PCA955X_LS_LED_ON);
314 ls = pca955x_ledsel(ls, ls_led, PCA955X_LS_LED_OFF);
317 ls = pca955x_ledsel(ls, ls_led, PCA955X_LS_BLINK0);
321 * Use PWM1 for all other values. This has the unwanted
322 * side effect of making all LEDs on the chip share the
323 * same brightness level if set to a value other than
324 * OFF, HALF, or FULL. But, this is probably better than
325 * just turning off for all other values.
327 ret = pca955x_write_pwm(pca955x->client, 1, 255 - value);
330 ls = pca955x_ledsel(ls, ls_led, PCA955X_LS_BLINK1);
334 ret = pca955x_write_ls(pca955x->client, chip_ls, ls);
337 mutex_unlock(&pca955x->lock);
342 #ifdef CONFIG_LEDS_PCA955X_GPIO
344 * Read the INPUT register, which contains the state of LEDs.
346 static int pca955x_read_input(struct i2c_client *client, int n, u8 *val)
348 int ret = i2c_smbus_read_byte_data(client, n);
351 dev_err(&client->dev, "%s: reg 0x%x, err %d\n",
360 static int pca955x_gpio_request_pin(struct gpio_chip *gc, unsigned int offset)
362 struct pca955x *pca955x = gpiochip_get_data(gc);
363 struct pca955x_led *led = &pca955x->leds[offset];
365 if (led->type == PCA955X_TYPE_GPIO)
371 static int pca955x_set_value(struct gpio_chip *gc, unsigned int offset,
374 struct pca955x *pca955x = gpiochip_get_data(gc);
375 struct pca955x_led *led = &pca955x->leds[offset];
378 return pca955x_led_set(&led->led_cdev, PCA955X_GPIO_HIGH);
380 return pca955x_led_set(&led->led_cdev, PCA955X_GPIO_LOW);
383 static void pca955x_gpio_set_value(struct gpio_chip *gc, unsigned int offset,
386 pca955x_set_value(gc, offset, val);
389 static int pca955x_gpio_get_value(struct gpio_chip *gc, unsigned int offset)
391 struct pca955x *pca955x = gpiochip_get_data(gc);
392 struct pca955x_led *led = &pca955x->leds[offset];
395 /* There is nothing we can do about errors */
396 pca955x_read_input(pca955x->client, led->led_num / 8, ®);
398 return !!(reg & (1 << (led->led_num % 8)));
401 static int pca955x_gpio_direction_input(struct gpio_chip *gc,
404 struct pca955x *pca955x = gpiochip_get_data(gc);
405 struct pca955x_led *led = &pca955x->leds[offset];
407 /* To use as input ensure pin is not driven. */
408 return pca955x_led_set(&led->led_cdev, PCA955X_GPIO_INPUT);
411 static int pca955x_gpio_direction_output(struct gpio_chip *gc,
412 unsigned int offset, int val)
414 return pca955x_set_value(gc, offset, val);
416 #endif /* CONFIG_LEDS_PCA955X_GPIO */
418 static struct pca955x_platform_data *
419 pca955x_get_pdata(struct i2c_client *client, struct pca955x_chipdef *chip)
421 struct pca955x_platform_data *pdata;
422 struct pca955x_led *led;
423 struct fwnode_handle *child;
426 count = device_get_child_node_count(&client->dev);
427 if (!count || count > chip->bits)
428 return ERR_PTR(-ENODEV);
430 pdata = devm_kzalloc(&client->dev, sizeof(*pdata), GFP_KERNEL);
432 return ERR_PTR(-ENOMEM);
434 pdata->leds = devm_kcalloc(&client->dev,
435 chip->bits, sizeof(struct pca955x_led),
438 return ERR_PTR(-ENOMEM);
440 device_for_each_child_node(&client->dev, child) {
445 res = fwnode_property_read_u32(child, "reg", ®);
446 if ((res != 0) || (reg >= chip->bits))
449 led = &pdata->leds[reg];
450 led->type = PCA955X_TYPE_LED;
452 fwnode_property_read_u32(child, "type", &led->type);
454 if (!fwnode_property_read_string(child, "default-state",
456 if (!strcmp(state, "keep"))
457 led->default_state = LEDS_GPIO_DEFSTATE_KEEP;
458 else if (!strcmp(state, "on"))
459 led->default_state = LEDS_GPIO_DEFSTATE_ON;
461 led->default_state = LEDS_GPIO_DEFSTATE_OFF;
463 led->default_state = LEDS_GPIO_DEFSTATE_OFF;
467 pdata->num_leds = chip->bits;
472 static const struct of_device_id of_pca955x_match[] = {
473 { .compatible = "nxp,pca9550", .data = (void *)pca9550 },
474 { .compatible = "nxp,pca9551", .data = (void *)pca9551 },
475 { .compatible = "nxp,pca9552", .data = (void *)pca9552 },
476 { .compatible = "ibm,pca9552", .data = (void *)ibm_pca9552 },
477 { .compatible = "nxp,pca9553", .data = (void *)pca9553 },
480 MODULE_DEVICE_TABLE(of, of_pca955x_match);
482 static int pca955x_probe(struct i2c_client *client)
484 struct pca955x *pca955x;
485 struct pca955x_led *pca955x_led;
486 struct pca955x_chipdef *chip;
487 struct led_classdev *led;
488 struct led_init_data init_data;
489 struct i2c_adapter *adapter;
491 struct pca955x_platform_data *pdata;
493 bool set_default_label = false;
494 bool keep_pwm = false;
495 char default_label[8];
496 enum pca955x_type chip_type;
497 const void *md = device_get_match_data(&client->dev);
500 chip_type = (enum pca955x_type)md;
502 const struct i2c_device_id *id = i2c_match_id(pca955x_id,
506 chip_type = (enum pca955x_type)id->driver_data;
508 dev_err(&client->dev, "unknown chip\n");
513 chip = &pca955x_chipdefs[chip_type];
514 adapter = client->adapter;
515 pdata = dev_get_platdata(&client->dev);
517 pdata = pca955x_get_pdata(client, chip);
519 return PTR_ERR(pdata);
522 /* Make sure the slave address / chip type combo given is possible */
523 if ((client->addr & ~((1 << chip->slv_addr_shift) - 1)) !=
525 dev_err(&client->dev, "invalid slave address %02x\n",
530 dev_info(&client->dev, "leds-pca955x: Using %s %d-bit LED driver at "
531 "slave address 0x%02x\n", client->name, chip->bits,
534 if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA))
537 if (pdata->num_leds != chip->bits) {
538 dev_err(&client->dev,
539 "board info claims %d LEDs on a %d-bit chip\n",
540 pdata->num_leds, chip->bits);
544 pca955x = devm_kzalloc(&client->dev, sizeof(*pca955x), GFP_KERNEL);
548 pca955x->leds = devm_kcalloc(&client->dev, chip->bits,
549 sizeof(*pca955x_led), GFP_KERNEL);
553 i2c_set_clientdata(client, pca955x);
555 mutex_init(&pca955x->lock);
556 pca955x->client = client;
557 pca955x->chipdef = chip;
559 init_data.devname_mandatory = false;
560 init_data.devicename = "pca955x";
562 for (i = 0; i < chip->bits; i++) {
563 pca955x_led = &pca955x->leds[i];
564 pca955x_led->led_num = i;
565 pca955x_led->pca955x = pca955x;
566 pca955x_led->type = pdata->leds[i].type;
568 switch (pca955x_led->type) {
569 case PCA955X_TYPE_NONE:
571 case PCA955X_TYPE_GPIO:
574 case PCA955X_TYPE_LED:
575 led = &pca955x_led->led_cdev;
576 led->brightness_set_blocking = pca955x_led_set;
577 led->brightness_get = pca955x_led_get;
579 if (pdata->leds[i].default_state ==
580 LEDS_GPIO_DEFSTATE_OFF) {
581 err = pca955x_led_set(led, LED_OFF);
584 } else if (pdata->leds[i].default_state ==
585 LEDS_GPIO_DEFSTATE_ON) {
586 err = pca955x_led_set(led, LED_FULL);
591 init_data.fwnode = pdata->leds[i].fwnode;
593 if (is_of_node(init_data.fwnode)) {
594 if (to_of_node(init_data.fwnode)->name[0] ==
596 set_default_label = true;
598 set_default_label = false;
600 set_default_label = true;
603 if (set_default_label) {
604 snprintf(default_label, sizeof(default_label),
606 init_data.default_label = default_label;
608 init_data.default_label = NULL;
611 err = devm_led_classdev_register_ext(&client->dev, led,
617 * For default-state == "keep", let the core update the
618 * brightness from the hardware, then check the
619 * brightness to see if it's using PWM1. If so, PWM1
620 * should not be written below.
622 if (pdata->leds[i].default_state ==
623 LEDS_GPIO_DEFSTATE_KEEP) {
624 if (led->brightness != LED_FULL &&
625 led->brightness != LED_OFF &&
626 led->brightness != LED_HALF)
632 /* PWM0 is used for half brightness or 50% duty cycle */
633 err = pca955x_write_pwm(client, 0, 255 - LED_HALF);
638 /* PWM1 is used for variable brightness, default to OFF */
639 err = pca955x_write_pwm(client, 1, 0);
644 /* Set to fast frequency so we do not see flashing */
645 err = pca955x_write_psc(client, 0, 0);
648 err = pca955x_write_psc(client, 1, 0);
652 #ifdef CONFIG_LEDS_PCA955X_GPIO
654 pca955x->gpio.label = "gpio-pca955x";
655 pca955x->gpio.direction_input = pca955x_gpio_direction_input;
656 pca955x->gpio.direction_output = pca955x_gpio_direction_output;
657 pca955x->gpio.set = pca955x_gpio_set_value;
658 pca955x->gpio.get = pca955x_gpio_get_value;
659 pca955x->gpio.request = pca955x_gpio_request_pin;
660 pca955x->gpio.can_sleep = 1;
661 pca955x->gpio.base = -1;
662 pca955x->gpio.ngpio = ngpios;
663 pca955x->gpio.parent = &client->dev;
664 pca955x->gpio.owner = THIS_MODULE;
666 err = devm_gpiochip_add_data(&client->dev, &pca955x->gpio,
669 /* Use data->gpio.dev as a flag for freeing gpiochip */
670 pca955x->gpio.parent = NULL;
671 dev_warn(&client->dev, "could not add gpiochip\n");
674 dev_info(&client->dev, "gpios %i...%i\n",
675 pca955x->gpio.base, pca955x->gpio.base +
676 pca955x->gpio.ngpio - 1);
683 static struct i2c_driver pca955x_driver = {
685 .name = "leds-pca955x",
686 .of_match_table = of_pca955x_match,
688 .probe_new = pca955x_probe,
689 .id_table = pca955x_id,
692 module_i2c_driver(pca955x_driver);
694 MODULE_AUTHOR("Nate Case <ncase@xes-inc.com>");
695 MODULE_DESCRIPTION("PCA955x LED driver");
696 MODULE_LICENSE("GPL v2");