include/linux/led-lm3530.h

0001 /* SPDX-License-Identifier: GPL-2.0-only */
0002 /*
0003  * Copyright (C) 2011 ST-Ericsson SA.
0004  * Copyright (C) 2009 Motorola, Inc.
0005  *
0006  * Simple driver for National Semiconductor LM35330 Backlight driver chip
0007  *
0008  * Author: Shreshtha Kumar SAHU <shreshthakumar.sahu@stericsson.com>
0009  * based on leds-lm3530.c by Dan Murphy <D.Murphy@motorola.com>
0010  */
0011
0012 #ifndef _LINUX_LED_LM3530_H__
0013 #define _LINUX_LED_LM3530_H__
0014
0015 #define LM3530_FS_CURR_5mA      (0) /* Full Scale Current */
0016 #define LM3530_FS_CURR_8mA      (1)
0017 #define LM3530_FS_CURR_12mA     (2)
0018 #define LM3530_FS_CURR_15mA     (3)
0019 #define LM3530_FS_CURR_19mA     (4)
0020 #define LM3530_FS_CURR_22mA     (5)
0021 #define LM3530_FS_CURR_26mA     (6)
0022 #define LM3530_FS_CURR_29mA     (7)
0023
0024 #define LM3530_ALS_AVRG_TIME_32ms   (0) /* ALS Averaging Time */
0025 #define LM3530_ALS_AVRG_TIME_64ms   (1)
0026 #define LM3530_ALS_AVRG_TIME_128ms  (2)
0027 #define LM3530_ALS_AVRG_TIME_256ms  (3)
0028 #define LM3530_ALS_AVRG_TIME_512ms  (4)
0029 #define LM3530_ALS_AVRG_TIME_1024ms (5)
0030 #define LM3530_ALS_AVRG_TIME_2048ms (6)
0031 #define LM3530_ALS_AVRG_TIME_4096ms (7)
0032
0033 #define LM3530_RAMP_TIME_1ms        (0) /* Brigtness Ramp Time */
0034 #define LM3530_RAMP_TIME_130ms      (1) /* Max to 0 and vice versa */
0035 #define LM3530_RAMP_TIME_260ms      (2)
0036 #define LM3530_RAMP_TIME_520ms      (3)
0037 #define LM3530_RAMP_TIME_1s     (4)
0038 #define LM3530_RAMP_TIME_2s     (5)
0039 #define LM3530_RAMP_TIME_4s     (6)
0040 #define LM3530_RAMP_TIME_8s     (7)
0041
0042 /* ALS Resistor Select */
0043 #define LM3530_ALS_IMPD_Z       (0x00) /* ALS Impedance */
0044 #define LM3530_ALS_IMPD_13_53kOhm   (0x01)
0045 #define LM3530_ALS_IMPD_9_01kOhm    (0x02)
0046 #define LM3530_ALS_IMPD_5_41kOhm    (0x03)
0047 #define LM3530_ALS_IMPD_2_27kOhm    (0x04)
0048 #define LM3530_ALS_IMPD_1_94kOhm    (0x05)
0049 #define LM3530_ALS_IMPD_1_81kOhm    (0x06)
0050 #define LM3530_ALS_IMPD_1_6kOhm     (0x07)
0051 #define LM3530_ALS_IMPD_1_138kOhm   (0x08)
0052 #define LM3530_ALS_IMPD_1_05kOhm    (0x09)
0053 #define LM3530_ALS_IMPD_1_011kOhm   (0x0A)
0054 #define LM3530_ALS_IMPD_941Ohm      (0x0B)
0055 #define LM3530_ALS_IMPD_759Ohm      (0x0C)
0056 #define LM3530_ALS_IMPD_719Ohm      (0x0D)
0057 #define LM3530_ALS_IMPD_700Ohm      (0x0E)
0058 #define LM3530_ALS_IMPD_667Ohm      (0x0F)
0059
0060 enum lm3530_mode {
0061     LM3530_BL_MODE_MANUAL = 0,  /* "man" */
0062     LM3530_BL_MODE_ALS,     /* "als" */
0063     LM3530_BL_MODE_PWM,     /* "pwm" */
0064 };
0065
0066 /* ALS input select */
0067 enum lm3530_als_mode {
0068     LM3530_INPUT_AVRG = 0,  /* ALS1 and ALS2 input average */
0069     LM3530_INPUT_ALS1,  /* ALS1 Input */
0070     LM3530_INPUT_ALS2,  /* ALS2 Input */
0071     LM3530_INPUT_CEIL,  /* Max of ALS1 and ALS2 */
0072 };
0073
0074 /* PWM Platform Specific Data */
0075 struct lm3530_pwm_data {
0076     void (*pwm_set_intensity) (int brightness, int max_brightness);
0077     int (*pwm_get_intensity) (int max_brightness);
0078 };
0079
0080 /**
0081  * struct lm3530_platform_data
0082  * @mode: mode of operation i.e. Manual, ALS or PWM
0083  * @als_input_mode: select source of ALS input - ALS1/2 or average
0084  * @max_current: full scale LED current
0085  * @pwm_pol_hi: PWM input polarity - active high/active low
0086  * @als_avrg_time: ALS input averaging time
0087  * @brt_ramp_law: brightness mapping mode - exponential/linear
0088  * @brt_ramp_fall: rate of fall of led current
0089  * @brt_ramp_rise: rate of rise of led current
0090  * @als1_resistor_sel: internal resistance from ALS1 input to ground
0091  * @als2_resistor_sel: internal resistance from ALS2 input to ground
0092  * @als_vmin: als input voltage calibrated for max brightness in mV
0093  * @als_vmax: als input voltage calibrated for min brightness in mV
0094  * @brt_val: brightness value (0-127)
0095  * @pwm_data: PWM control functions (only valid when the mode is PWM)
0096  */
0097 struct lm3530_platform_data {
0098     enum lm3530_mode mode;
0099     enum lm3530_als_mode als_input_mode;
0100
0101     u8 max_current;
0102     bool pwm_pol_hi;
0103     u8 als_avrg_time;
0104
0105     bool brt_ramp_law;
0106     u8 brt_ramp_fall;
0107     u8 brt_ramp_rise;
0108
0109     u8 als1_resistor_sel;
0110     u8 als2_resistor_sel;
0111
0112     u32 als_vmin;
0113     u32 als_vmax;
0114
0115     u8 brt_val;
0116
0117     struct lm3530_pwm_data pwm_data;
0118 };
0119
0120 #endif  /* _LINUX_LED_LM3530_H__ */