Re: [PATCH 5/5] Documentation: Short descriptions for bhsfh and apds990xdrivers
From: Jonathan Cameron
Date: Tue Oct 05 2010 - 10:07:39 EST
On 10/05/10 13:22, Onkalo Samu wrote:
>
> Jonathan, thanks.
>
> -Samu
>
> On Tue, 2010-10-05 at 13:53 +0200, ext Jonathan Cameron wrote:
>> On 10/05/10 10:42, Samu Onkalo wrote:
>>> Add short documentation for two ALS / proximity chip drivers.
>>
>> Hi Samu,
>>
>> Good to see the documentation as it makes commenting on naming etc far simpler.
>>
>> There are a lot of comments, but that's because you define a lot of new
>> interfaces and as ever I'm interested in working out how to keep them
>> clear and as relevant to as many parts as possible.
>>
>> For reference, a very similar device driver (capability wise) was proposed on
>> linux-iio by Dongguen Kim. I don't personally care about the location of these
>> drivers, but I do care about the interfaces.
>>
>> http://marc.info/?t=128453241000001&r=1&w=2
>>
>> [PATCH V2] staging: iio: tmd2771x: Add tmd2771x proximity and ambient light sensor driver
>>
>
> Looks quite similar indeed.
>
>>> Signed-off-by: Samu Onkalo <samu.p.onkalo@xxxxxxxxx>
>>> ---
>>> Documentation/misc-devices/apds990x.txt | 126 +++++++++++++++++++++++++++++++
>>> Documentation/misc-devices/bhsfh.txt | 125 ++++++++++++++++++++++++++++++
>>> 2 files changed, 251 insertions(+), 0 deletions(-)
>>> create mode 100644 Documentation/misc-devices/apds990x.txt
>>> create mode 100644 Documentation/misc-devices/bhsfh.txt
>>>
>>> diff --git a/Documentation/misc-devices/apds990x.txt b/Documentation/misc-devices/apds990x.txt
>>> new file mode 100644
>>> index 0000000..edffbea
>>> --- /dev/null
>>> +++ b/Documentation/misc-devices/apds990x.txt
>>> @@ -0,0 +1,126 @@
>>> +Kernel driver apds990x
>>> +======================
>>> +
>>> +Supported chips:
>>> +Avago APDS990X
>>> +
>>> +Data sheet:
>>> +Not freely available
>>> +
>>> +Author:
>>> +Samu Onkalo <samu.p.onkalo@xxxxxxxxx>
>>> +
>>> +Description
>>> +-----------
>>> +
>>> +APDS990x is a combined ambient light and proximity sensor. ALS and proximity
>>> +functionality are highly connected. ALS measurement path must be running
>>> +while the proximity functionality is enabled.
>>> +
>>> +ALS produces only raw measurement values. Further processing is needed
>>> +to get sensible LUX values. Vice versa, HW threshold control has nothing
>>> +to do with LUX values. Threshold detection triggs to raw conversion values.
>>> +Driver makes necessary conversions to both directions so that user handles
>>> +only LUX values. ALS contains 4 different gain steps. Driver automatically
>>> +selects suitable gain step. After each measurement, reliability of the results
>>> +is estimated and new measurement is trigged if necessary.
>> Nice.
>>> +
>>> +Platform data can provide tuned values to the conversion formulas if
>>> +values are known. Othervise plain sensor default values are used.
>> Typo: Otherwise
>>> +
>>> +Proximity side is little bit simpler. It produces directly usable values.
>> In what sense? What units are the values in? If they are raw values,
>> I'd denote that in the attribute name (_raw rather than _input).
>
> I'll change it to _raw. I just meant here that proximity doesn't need
> lot of conversions etc. to have usable values.
Cool. That is what I thought you meant, just wanted to be sure.
>>> +
>>> +Driver controls chip operational state using pm_runtime framework.
>>> +Voltage regulators are controlled based on chip operational state.
>>> +
>>> +SYSFS
>>> +-----
>>> +chip_id
>>> + RO - shows detected chip type and version
>>> +
>>> +power_state
>>> + RW - enable / disable chip. Uses counting logic
>>> + 1 enables the chip
>>> + 0 disables the chip
>>> +lux0_input
>>> + RO - measured LUX value
>>> + range: 0 .. 65535
>>> + sysfs_notify called when threshold interrupt occurs
>> Personally I'm still in favour (for generality) of using illuminance0
>> rather than lux0 but I think the mass of drivers mean I'm losing that
>> argument. (argument for those who haven't seen it before is that lux is
>> the unit, the thing being measured is illuminance - units don't
>> generalize to other sensor types e.g. acceleration)
>>
>
> I think Alan just got one driver queued with lux :)
Yup, that was largely why I was giving up on the argument. I won it
with als but as that never merged, the consensus is beating me
this time ;) Its a small point anyway and I can always blame it
on Alan if anyone points out it is inconsistent in the future :)
>
>>> +
>>> +lux0_input10x
>>> + RO - Same as lux0_input but values are 10x larger so accuracy
>>> + is 0.1 lux
>>> + range: 0 .. 655350
>> Why do we care? Just do a bit of fixed point arithmetic and output
>> it in lux0_input (yes hwmon is fussy about not having decimal places,
>> I think everyone else is more flexible in cases like this).
>
> %d.%d :)
Exactly, might be hideous, but it does the job.
>
>>> +lux0_rate
>>> + RW - measurement period in milliseconds
>> Then it's not a rate is it. Please fix naming or what comes out.
>> Rate = sampling frequency, not sampling period.
>>
>
> rate -> period
Snag there is that I don't think anyone is using period for this
particular parameter... If it's easy I'd stick with rate or sampling
frequency and output 1/rate If I'm wrong and for example Alan has used
this then feel free!
>
>>> +
>>> +lux0_rate_avail
>>> + RO - supported measurement periods
>>> +
>>> +lux0_calib
>>> + RW - calibration value. Set to neutral value by default
>> That tells me nothing about what this parameter is. Please provide
>> some info on this so we can work out a clearer naming convention.
>>> +
>
> Shortly - results are multiplied with calib value. And calib_format
> tells what is the neutral value ( == 1.00 multiplier).
Then can we have calib_default or perhaps. calib_neutral
It clearly isn't what we would normally think of as a format.
> This is used to
> compensate differences between sensors. To get proper value, you need
> calibrated source of light and check what is the output from the sensor.
> Then just set calib value so that reported lux value is about the
> correct one.
In IIO we have gone with _calibscale for the equivalent parameter
(and _calibbias for devices where there is an offset as well).
>
>>> +lux0_calib_format
>>> + RO - neutral calibration value
>>> +
>>> +lux0_threshold_range
>>> + RW - lo and hi threshold values like "100 1000"
>>> + range: 0 .. 65535
>> Are these conceptually one value... Maybe. I proposed an
>> RFC with a general naming convention the other day. I'm happy to reopen
>> that debate if you disagree, but do feel it is vital to pick a standard
>> and keep to it. I've move iio to the conventions proposed in that discussion
>> (on linux-iio for review at the moment).
>>
>> Under that convention this would be (I think, given I don't have the data sheet)
>>
>> lux0_input_thresh_rising_value
>> lux0_input_thresh_falling_value
>>
>
> Data sheets often uses HI and LO threshold naming. But yes, interrupt
> comes when the level is above the hi-limit or below lo-limit.
> Strictly, it is not crossing the limit.
Fair point, the rising falling was the most concise way of indicating
which side of the threshold causes the interrupt. A lot of devices
act as 'edge' triggers. That is they won't retrigger until the
value has fallen below the threshold. (corresponds to an infinite
delay before resetting)
>
> Two separate entries makes sense but how about the naming...
>
> lux0_input_thresh_above_value
> lux0_input_thresh_below_value
Works for me.
>
> would tell when interrupt is triggered.
>
>> For reference the naming convention discussion follows from
>>
>> http://linux.derkeiler.com/Mailing-Lists/Kernel/2010-09/msg08622.html
>> (lkml.org seems to be down)
>>> +
>>> +prox0_enable
>> For proximity, I'd be more inclined to not abbreviate this.
>>> + RW - enable / disable proximity - counting logic
>>> + 1 enables the proximity
>>> + 0 disables the proximity
>> So this is concerned with the thresholds below? Again, proposed
>> naming would be:
>>
>> proximity0_thresh_rising_en (might have naming wrong there, I'm not sure what it
>> is).
>
> no, this is enabling the proximity measurement in general. Obviously it
> is not clear :(
Then your original was fine! I just got confused by the other attributes.
>
>>> +
>>> +prox0_input
>>> + RO - measured proximity value
>>> + range 0 .. 1023
>>> + sysfs_notify called when threshold interrupt occurs
>> So this only exists when a threshold interrupt has occurred? If so can we
>> name it in a fashion to indicate this? If the units are SI or at least
>> obvious, please call it _raw to indicate that.
>
> _input -> _raw
>
>>> +
>>> +prox0_continuous_mode
>>> + RW - When set, results above threshold are reported periodically.
>>> + In this mode rough distance estimation is possible.
>>> + Values: 0 and 1
>> This naming needs some thought. It's far from obvious that _continuous_mode
>> would correspond to this behaviour.
>
> any ideas about naming?
I've seen this in a couple of devices but none of the drivers actually support
it yet. Perhaps, persistenceperiod? (added to meanperiod and period that
we already have defined for IIO).
>
>
>>> +
>>> +prox0_threshold
>>> + RW - threshold level which trigs proximity events.
>> Name could be more informative.
>
> prox0_raw_thres_above_value?
If it doesn't matter to you can we have thresh rather than thres
(easy way of matching IIO!)
>
>>> +
>>> +Platform data
>>> +-------------
>>> +
>>> +
>>> +#define APDS_IRLED_CURR_12mA 0x3
>>> +#define APDS_IRLED_CURR_25mA 0x2
>>> +#define APDS_IRLED_CURR_50mA 0x1
>>> +#define APDS_IRLED_CURR_100mA 0x0
>>> +
>>> +/*
>>> + * Structure for tuning ALS calculation to match with environment.
>>> + * There depends on the material above the sensor and the sensor
>>> + * itself. If the GA is zero, driver will use uncovered sensor default values
>>> + * format: decimal value * APDS_PARAM_SCALE
>>> + */
>>> +#define APDS_PARAM_SCALE 4096
>>> +struct apds990x_chip_factors {
>>> + int ga; /* Glass attenuation */
>>> + int cf1; /* Clear channel factor 1 */
>>> + int irf1; /* Ir channel factor 1 */
>>> + int cf2; /* Clear channel factor 2 */
>>> + int irf2; /* Ir channel factor 2 */
>>> + int df; /* Device factor. Decimal number */
>>> +};
>>> +
>>> +struct apds990x_platform_data {
>>> + struct apds990x_chip_factors cf;
>>> + u8 pdrive;
>>> + int (*setup_resources)(void);
>>> + int (*release_resources)(void);
>>> +};
>>> +
>>> +chip factors are specific to for example dark plastic window
>>> +above the sensor. Driver uses plain (uncovered) sensor default values
>>> +if the platform data contains zero ga factor.
>>> +
>>> +pdrive is the IR led driver current
>>> +
>>> +setup / release resources handles interrupt line configurations.
>>> diff --git a/Documentation/misc-devices/bhsfh.txt b/Documentation/misc-devices/bhsfh.txt
>>> new file mode 100644
>>> index 0000000..7f72f84
>>> --- /dev/null
>>> +++ b/Documentation/misc-devices/bhsfh.txt
>>> @@ -0,0 +1,125 @@
>>> +Kernel driver bhsfh
>>> +===================
>>> +
>>> +Supported chips:
>>> +ROHM BH1770GLC
>>> +OSRAM SFH7770
>>> +
>>> +Data sheet:
>>> +Not freely available
>>> +
>>> +Author:
>>> +Samu Onkalo <samu.p.onkalo@xxxxxxxxx>
>>> +
>>> +Description
>>> +-----------
>>> +BH1770GLC and SFH7770 (I'm calling them as bhsfh) are combined ambient
>>> +light and proximity sensors. ALS and proximity parts operates on their own,
>>> +but they shares common I2C interface and interrupt logic.
>>> +
>>> +ALS produces 16 bit LUX values. The chip contains interrupt logic to produce
>>> +low and high threshold interrupts.
>>> +
>>> +Proximity part contains IR-led driver up to 3 IR leds. The chip measures
>>> +amount of reflected IR light and produces proximity result. Resolution is
>>> +8 bit. Driver supports only one channel. Driver uses ALS results to estimate
>>> +realibility of the proximity results. Thus ALS is always running while
>>> +proximity detection is needed.
>>> +
>>> +Driver uses threshold interrupts to avoid need for polling the values.
>>> +Proximity low interrupt doesn't exists in the chip. This is simulated
>>> +by using a delayed work.
>>> +
>>> +SYSFS
>>> +-----
>>> +
>>> +chip_id
>>> + RO - shows detected chip type and version
>>> +
>>> +power_state
>>> + RW - enable / disable chip. Uses counting logic
>>> + 1 enables the chip
>>> + 0 disables the chip
>>> +
>>> +lux0_input
>>> + RO - measured LUX value
>>> + range: 0 .. 65535
>>> + sysfs_notify called when threshold interrupt occurs
>>> +
>>> +lux0_rate
>>> + RW - measurement period in milliseconds
>>> +
>>> +lux0_rate_avail
>>> + RO - supported measurement periods
>>> +
>>> +lux0_threshold_range
>>> + RW - lo and hi threshold values like "100 1000"
>>> + range: 0 .. 65535
>>> +
>>> +lux0_calib
>>> + RW - calibration value. Set to neutral value by default
>> That is not sufficient documentation. What is the calibration value used
>> for? As a random user coming in who isn't going to read the data sheet this
>> comment tells me nothing.
>>> +
>>> +lux0_calib_format
>>> + RO - neutral calibration value
>> This one tells me even less.
>>> +
>>> +prox0_input
>>> + RO - measured proximity value
>>> + range 0 .. 255
>>> + sysfs_notify called when threshold interrupt occurs
>>> +
>>> +prox0_enable
>>> + RW - enable / disable proximity - uses counting logic
>>> + 1 enables the proximity
>>> + 0 disables the proximity
>> So this is enabling the threshold? Or is it turning on the ability to
>> read directly from the sensor? Not clear in the naming (and it should be).
>
> prox0_raw_enable?
prox0_raw_en (again if it doesn't cost you anything, it matches various iio devices).
>
>>> +
>>> +prox0_persistence
>>> + RW - number of proximity interrupts needed before triggering the event
>> naming RFC proposed calling this (roughly given I'm not clear on type of interrupt)
>>
>> proximity0_thresh_rising_period
>
> prox0_thresh_above_count
period is defined as exactly this in IIO so I'd rather stay with that if possible.
Snag is that is in seconds so conversion code would be needed.
>
>
>>> +
>>> +prox0_rate
>>> + RW - supported measurement periods. There are two values in this entry:
>>> + First one is used when waiting for proximity event and the second
>>> + one is used when waiting proximity reason to go away.
>> That's not conceptually one value, so break it in two.
>
> ok
>
>>> +
>>> +prox0_rate
>>> + RO - available measurement periods
>>> +
>>> +prox0_threshold
>>> + RW - threshold level which trigs proximity events.
>>> + Filtered by persistence filter
>>> +
>
> prox0_raw_thres_above_value?
thresh again if it doesn't matter. Otherwise yes.
>
>
>>> +prox0_abs_thres
>>> + RW - threshold level which trigs event immediately
>> The naming of these last two is extremely confusing and inconsistent.
>> Why abs? Is it on the absolute value? That seems an odd thing given
>> I doubt proximity is a signed value? Or is this just a second alarm
>> that ignores the persistence filter?
>>
>
>
> Idea here is that "prox0_threshold" limit is something which must trig
> proximit event, but there is no hurry. Since the sensor may be noisy
> (false events every now and then), there must be several interrupts in a
> row (persistence value) to get proximity event at that level.
> However, high enough value (sensor covered totally) must trig event
> immediately (abs_thres).
>
> prox0_raw_thres_above_value_strict?
Could we just add numbers to the two detectors one of which has a
period of 1 (or not specified) Easier to generalise than applying
another keyword to the name.
prox0_raw_thresh_above0_value
prox0_raw_thresh_above0_period
and this one
prox0_raw_thresh_above1_value
I think that would be the best place to apply the index?
Attributes that apply to both alarms would just not specify
it. So if they were for example, enabled together.
prox0_raw_thresh_above_en
>
>>> +
>>> +Platform data:
>>> +
>>> +struct bhsfh_platform_data {
>>> +#define BHSFH_LED_5mA 0
>>> +#define BHSFH_LED_10mA 1
>>> +#define BHSFH_LED_20mA 2
>>> +#define BHSFH_LED_50mA 3
>>> +#define BHSFH_LED_100mA 4
>>> +#define BHSFH_LED_150mA 5
>>> +#define BHSFH_LED_200mA 6
>>> + __u8 led_def_curr;
>>> +#define BHFSH_NEUTRAL_GA 16384 /* 16384 / 16384 = 1 */
>>> + __u32 glass_attenuation;
>>> + int (*setup_resources)(void);
>>> + int (*release_resources)(void);
>>> +};
>>> +
>>> +led_def_curr controls IR led driving current
>>> +glass_attenuation tells darkness of the covering window
>>> +setup / release resources are call back functions for controlling
>>> +interrupt line.
>>> +
>>> +Example:
>>> +static struct bhsfh_platform_data rm680_bhsfh_data = {
>>> + .led_def_curr = BHSFH_LED_50mA,
>>> + .glass_attenuation = (16384 * 385) / 100,
>>> + .setup_resources = bhsfh_setup,
>>> + .release_resources = bhsfh_release,
>>> +};
>>> +
>>> +glass_attenuation: 385 in above formula means 3.85 in decimal.
>>> +light_above_sensors = light_above_cover_window / 3.85
>>
>> --
>> To unsubscribe from this list: send the line "unsubscribe linux-i2c" in
>> the body of a message to majordomo@xxxxxxxxxxxxxxx
>> More majordomo info at http://vger.kernel.org/majordomo-info.html
>
> --
> To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
> the body of a message to majordomo@xxxxxxxxxxxxxxx
> More majordomo info at http://vger.kernel.org/majordomo-info.html
> Please read the FAQ at http://www.tux.org/lkml/
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/