1/* SPDX-License-Identifier: GPL-2.0 */
2/* LED Multicolor class interface
3 * Copyright (C) 2019-20 Texas Instruments Incorporated - http://www.ti.com/
4 */
5
6#ifndef _LINUX_MULTICOLOR_LEDS_H_INCLUDED
7#define _LINUX_MULTICOLOR_LEDS_H_INCLUDED
8
9#include <linux/leds.h>
10#include <dt-bindings/leds/common.h>
11
12struct mc_subled {
13	unsigned int color_index;
14	unsigned int brightness;
15	unsigned int intensity;
16	unsigned int channel;
17};
18
19struct led_classdev_mc {
20	/* led class device */
21	struct led_classdev led_cdev;
22	unsigned int num_colors;
23
24	struct mc_subled *subled_info;
25};
26
27static inline struct led_classdev_mc *lcdev_to_mccdev(
28						struct led_classdev *led_cdev)
29{
30	return container_of(led_cdev, struct led_classdev_mc, led_cdev);
31}
32
33/**
34 * led_classdev_multicolor_register_ext - register a new object of led_classdev
35 *				      class with support for multicolor LEDs
36 * @parent: the multicolor LED to register
37 * @mcled_cdev: the led_classdev_mc structure for this device
38 * @init_data: the LED class multicolor device initialization data
39 *
40 * Returns: 0 on success or negative error value on failure
41 */
42int led_classdev_multicolor_register_ext(struct device *parent,
43					    struct led_classdev_mc *mcled_cdev,
44					    struct led_init_data *init_data);
45
46/**
47 * led_classdev_multicolor_unregister - unregisters an object of led_classdev
48 *					class with support for multicolor LEDs
49 * @mcled_cdev: the multicolor LED to unregister
50 *
51 * Unregister a previously registered via led_classdev_multicolor_register
52 * object
53 */
54void led_classdev_multicolor_unregister(struct led_classdev_mc *mcled_cdev);
55
56/* Calculate brightness for the monochrome LED cluster */
57int led_mc_calc_color_components(struct led_classdev_mc *mcled_cdev,
58				 enum led_brightness brightness);
59
60int devm_led_classdev_multicolor_register_ext(struct device *parent,
61					  struct led_classdev_mc *mcled_cdev,
62					  struct led_init_data *init_data);
63
64void devm_led_classdev_multicolor_unregister(struct device *parent,
65					    struct led_classdev_mc *mcled_cdev);
66
67static inline int led_classdev_multicolor_register(struct device *parent,
68					    struct led_classdev_mc *mcled_cdev)
69{
70	return led_classdev_multicolor_register_ext(parent, mcled_cdev, NULL);
71}
72
73static inline int devm_led_classdev_multicolor_register(struct device *parent,
74					     struct led_classdev_mc *mcled_cdev)
75{
76	return devm_led_classdev_multicolor_register_ext(parent, mcled_cdev,
77							 NULL);
78}
79
80#endif	/* _LINUX_MULTICOLOR_LEDS_H_INCLUDED */
81