xref: /OK3568_Linux_fs/kernel/include/linux/platform_data/apds990x.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0-only */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * This file is part of the APDS990x sensor driver.
4*4882a593Smuzhiyun  * Chip is combined proximity and ambient light sensor.
5*4882a593Smuzhiyun  *
6*4882a593Smuzhiyun  * Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
7*4882a593Smuzhiyun  *
8*4882a593Smuzhiyun  * Contact: Samu Onkalo <samu.p.onkalo@nokia.com>
9*4882a593Smuzhiyun  */
10*4882a593Smuzhiyun 
11*4882a593Smuzhiyun #ifndef __APDS990X_H__
12*4882a593Smuzhiyun #define __APDS990X_H__
13*4882a593Smuzhiyun 
14*4882a593Smuzhiyun 
15*4882a593Smuzhiyun #define APDS_IRLED_CURR_12mA	0x3
16*4882a593Smuzhiyun #define APDS_IRLED_CURR_25mA	0x2
17*4882a593Smuzhiyun #define APDS_IRLED_CURR_50mA	0x1
18*4882a593Smuzhiyun #define APDS_IRLED_CURR_100mA	0x0
19*4882a593Smuzhiyun 
20*4882a593Smuzhiyun /**
21*4882a593Smuzhiyun  * struct apds990x_chip_factors - defines effect of the cover window
22*4882a593Smuzhiyun  * @ga: Total glass attenuation
23*4882a593Smuzhiyun  * @cf1: clear channel factor 1 for raw to lux conversion
24*4882a593Smuzhiyun  * @irf1: IR channel factor 1 for raw to lux conversion
25*4882a593Smuzhiyun  * @cf2: clear channel factor 2 for raw to lux conversion
26*4882a593Smuzhiyun  * @irf2: IR channel factor 2 for raw to lux conversion
27*4882a593Smuzhiyun  * @df: device factor for conversion formulas
28*4882a593Smuzhiyun  *
29*4882a593Smuzhiyun  * Structure for tuning ALS calculation to match with environment.
30*4882a593Smuzhiyun  * Values depend on the material above the sensor and the sensor
31*4882a593Smuzhiyun  * itself. If the GA is zero, driver will use uncovered sensor default values
32*4882a593Smuzhiyun  * format: decimal value * APDS_PARAM_SCALE except df which is plain integer.
33*4882a593Smuzhiyun  */
34*4882a593Smuzhiyun #define APDS_PARAM_SCALE 4096
35*4882a593Smuzhiyun struct apds990x_chip_factors {
36*4882a593Smuzhiyun 	int ga;
37*4882a593Smuzhiyun 	int cf1;
38*4882a593Smuzhiyun 	int irf1;
39*4882a593Smuzhiyun 	int cf2;
40*4882a593Smuzhiyun 	int irf2;
41*4882a593Smuzhiyun 	int df;
42*4882a593Smuzhiyun };
43*4882a593Smuzhiyun 
44*4882a593Smuzhiyun /**
45*4882a593Smuzhiyun  * struct apds990x_platform_data - platform data for apsd990x.c driver
46*4882a593Smuzhiyun  * @cf: chip factor data
47*4882a593Smuzhiyun  * @pddrive: IR-led driving current
48*4882a593Smuzhiyun  * @ppcount: number of IR pulses used for proximity estimation
49*4882a593Smuzhiyun  * @setup_resources: interrupt line setup call back function
50*4882a593Smuzhiyun  * @release_resources: interrupt line release call back function
51*4882a593Smuzhiyun  *
52*4882a593Smuzhiyun  * Proximity detection result depends heavily on correct ppcount, pdrive
53*4882a593Smuzhiyun  * and cover window.
54*4882a593Smuzhiyun  *
55*4882a593Smuzhiyun  */
56*4882a593Smuzhiyun 
57*4882a593Smuzhiyun struct apds990x_platform_data {
58*4882a593Smuzhiyun 	struct apds990x_chip_factors cf;
59*4882a593Smuzhiyun 	u8     pdrive;
60*4882a593Smuzhiyun 	u8     ppcount;
61*4882a593Smuzhiyun 	int    (*setup_resources)(void);
62*4882a593Smuzhiyun 	int    (*release_resources)(void);
63*4882a593Smuzhiyun };
64*4882a593Smuzhiyun 
65*4882a593Smuzhiyun #endif
66