Re: [PATCH] power_supply: Fix documentation for TEMP_*ALERT* properties

[jonghwa3.lee@samsung.com]

On 2013년 10월 28일 14:27, Anton Vorontsov wrote:

> All temperatures should be in tenth degrees Celsius.
> 


Let me tell you one thing that thermal framework uses milli centigrade for
temperature. And also we have some relation with thermal framework already in
power suppply core. So, what do think of using milli centigrade in power supply
class either?

Thanks,
Jonghwa

> bq24190_charger.c probably should be fixed.
> 
> Reported-by: Jonghwa Lee <jonghwa3.lee@samsung.com>
> Cc: Mark A. Greer <mgreer@animalcreek.com>
> Signed-off-by: Anton Vorontsov <anton@enomsg.org>
> ---
> 
> On Mon, Oct 28, 2013 at 11:00:52AM +0900, jonghwa3.lee@samsung.com wrote:
>>>  * All voltages, currents, charges, energies, time and temperatures in uV,      
>>>  * µA, µAh, µWh, seconds and tenths of degree Celsius unless otherwise          
>>>  * stated
>>>
>>> So, the current code seems to be correct.
>>
>> Honestly, I missed the above paragraph you showed rather I read following one.
>>
>> TEMP - temperature of the power supply.
>> TEMP_ALERT_MIN - minimum battery temperature alert value in milli centigrade.
>> TEMP_ALERT_MAX - maximum battery temperature alert value in milli centigrade.
>> TEMP_AMBIENT - ambient temperature.
>> TEMP_AMBIENT_ALERT_MIN - minimum ambient temperature alert value in milli
>> centigrade.
>> TEMP_AMBIENT_ALERT_MAX - maximum ambient temperature alert value in milli
>> centigrade.
>>
>> So, we use different unit for properties related temperature, right?
>> current temperature is in tenth of centigrade and threshold temperatures and
>> ambient temperature are in milli centigrade. Wouldn't it have to be in same unit?
> 
> :( They should. Thanks for spotting.
> 
> The patch down below should fix the issue...
> 
> Documentation/power/power_supply_class.txt | 8 ++++----
>  1 file changed, 4 insertions(+), 4 deletions(-)
> 
> diff --git a/Documentation/power/power_supply_class.txt b/Documentation/power/power_supply_class.txt
> index 3f10b39..89a8816 100644
> --- a/Documentation/power/power_supply_class.txt
> +++ b/Documentation/power/power_supply_class.txt
> @@ -135,11 +135,11 @@ CAPACITY_LEVEL - capacity level. This corresponds to
>  POWER_SUPPLY_CAPACITY_LEVEL_*.
>  
>  TEMP - temperature of the power supply.
> -TEMP_ALERT_MIN - minimum battery temperature alert value in milli centigrade.
> -TEMP_ALERT_MAX - maximum battery temperature alert value in milli centigrade.
> +TEMP_ALERT_MIN - minimum battery temperature alert.
> +TEMP_ALERT_MAX - maximum battery temperature alert.
>  TEMP_AMBIENT - ambient temperature.
> -TEMP_AMBIENT_ALERT_MIN - minimum ambient temperature alert value in milli centigrade.
> -TEMP_AMBIENT_ALERT_MAX - maximum ambient temperature alert value in milli centigrade.
> +TEMP_AMBIENT_ALERT_MIN - minimum ambient temperature alert.
> +TEMP_AMBIENT_ALERT_MAX - maximum ambient temperature alert.
>  
>  TIME_TO_EMPTY - seconds left for battery to be considered empty (i.e.
>  while battery powers a load)