Kconfig help descriptions

Kconfig help descriptions

[Russell King - ARM Linux]

Some of the Kconfig help descriptions aren't very useful - for example:

| CONFIG_TWL4030_MADC:
| 
| This driver provides support for triton TWL4030-MADC. The
| driver supports both RT and SW conversion methods.
| 
| This driver can be built as a module. If so it will be
| named twl4030-madc

What is madc?  What does it do?  Do I enable it for the OMAP 4430SDP ?

Re: Kconfig help descriptions

[Felipe Balbi]

[-- Attachment #1: Type: text/plain, Size: 506 bytes --]

On Thu, Jul 21, 2011 at 10:22:21AM +0100, Russell King - ARM Linux wrote:
> Some of the Kconfig help descriptions aren't very useful - for example:
> 
> | CONFIG_TWL4030_MADC:
> | 
> | This driver provides support for triton TWL4030-MADC. The
> | driver supports both RT and SW conversion methods.
> | 
> | This driver can be built as a module. If so it will be
> | named twl4030-madc
> 
> What is madc?  What does it do?  Do I enable it for the OMAP 4430SDP ?

Monitoring ADC.

-- 
balbi

[-- Attachment #2: Digital signature --]
[-- Type: application/pgp-signature, Size: 490 bytes --]

Re: Kconfig help descriptions

[Russell King - ARM Linux]

On Thu, Jul 21, 2011 at 12:37:19PM +0300, Felipe Balbi wrote:
> On Thu, Jul 21, 2011 at 10:22:21AM +0100, Russell King - ARM Linux wrote:
> > Some of the Kconfig help descriptions aren't very useful - for example:
> > 
> > | CONFIG_TWL4030_MADC:
> > | 
> > | This driver provides support for triton TWL4030-MADC. The
> > | driver supports both RT and SW conversion methods.
> > | 
> > | This driver can be built as a module. If so it will be
> > | named twl4030-madc
> > 
> > What is madc?  What does it do?  Do I enable it for the OMAP 4430SDP ?
> 
> Monitoring ADC.

Well, why doesn't the text _say_ that then?  I'm still none the wiser
whether it should be enabled or not.  What's it used for?  Who uses it?
When should it be enabled?

Re: Kconfig help descriptions

[Felipe Balbi]

[-- Attachment #1: Type: text/plain, Size: 2075 bytes --]

Hi,

On Thu, Jul 21, 2011 at 10:22:21AM +0100, Russell King - ARM Linux wrote:
> Some of the Kconfig help descriptions aren't very useful - for example:
> 
> | CONFIG_TWL4030_MADC:
> | 
> | This driver provides support for triton TWL4030-MADC. The
> | driver supports both RT and SW conversion methods.
> | 
> | This driver can be built as a module. If so it will be
> | named twl4030-madc
> 
> What is madc?  What does it do?  Do I enable it for the OMAP 4430SDP ?

the problem seems to be worse then you thought:

$ git ls-files drivers/  | grep madc
drivers/hwmon/twl4030-madc-hwmon.c
drivers/mfd/twl4030-madc.c

Both from the same author:

$ git grep -e MODULE_AUTHOR drivers/mfd/twl4030-madc.c drivers/hwmon/twl4030-madc-hwmon.c
drivers/hwmon/twl4030-madc-hwmon.c:MODULE_AUTHOR("J Keerthy");
drivers/mfd/twl4030-madc.c:MODULE_AUTHOR("J Keerthy");

but added on different commits:

commit f99c1d4f94f91fd3a20bd2eaa3be9c5e7d2668eb
Author: Keerthy <j-keerthy@ti.com>
Date:   Tue Mar 1 19:12:26 2011 +0530

    mfd: Add twl4030 madc driver
    
    Introducing a driver for MADC on TWL4030 powerIC. MADC stands for monitoring
    ADC. This driver monitors the real time conversion of analog signals like
    battery temperature, battery cuurent etc.
    
    Signed-off-by: Keerthy <j-keerthy@ti.com>
    Signed-off-by: Samuel Ortiz <sameo@linux.intel.com>

commit 0070bddfe7275e5bc763884a8ac59651f4e79eab
Author: Keerthy <j-keerthy@ti.com>
Date:   Tue Mar 1 19:12:36 2011 +0530

    hwmon: twl4030: Hwmon Driver for TWL4030 MADC
    
    This driver exposes the sysfs nodes of the TWL4030 MADC module.
    All the voltage channel values are expressed in terms of mV. Channel 13
    and channel 14 are reserved. There are channels which represent
    temperature and current the output is represented by celcius
    and mA respectively.
    
    Signed-off-by: Keerthy <j-keerthy@ti.com>
    Acked-by: Guenter Roeck <guenter.roeck@ericsson.com>
    Signed-off-by: Samuel Ortiz <sameo@linux.intel.com>


-- 
balbi

[-- Attachment #2: Digital signature --]
[-- Type: application/pgp-signature, Size: 490 bytes --]

Re: Kconfig help descriptions

[J, KEERTHY]

Hello Russel,

MADC stands for monitoring ADC. It is part of TWL4030 power IC.
TWL4030 is only on OMAP3 and hence not applicable for OMAP4.

The driver is split accross mfd and hwmon. Generic ADC
reading part is in mfd and exposing the individual ADC channel
sysfs nodes is part of hwmon. I apologize for missing this
information in KConfig help. I will post a patch to update this.

On Thu, Jul 21, 2011 at 3:27 PM, Felipe Balbi <balbi@ti.com> wrote:
> Hi,
>
> On Thu, Jul 21, 2011 at 10:22:21AM +0100, Russell King - ARM Linux wrote:
>> Some of the Kconfig help descriptions aren't very useful - for example:
>>
>> | CONFIG_TWL4030_MADC:
>> |
>> | This driver provides support for triton TWL4030-MADC. The
>> | driver supports both RT and SW conversion methods.
>> |
>> | This driver can be built as a module. If so it will be
>> | named twl4030-madc
>>
>> What is madc?  What does it do?  Do I enable it for the OMAP 4430SDP ?
>
> the problem seems to be worse then you thought:
>
> $ git ls-files drivers/  | grep madc
> drivers/hwmon/twl4030-madc-hwmon.c
> drivers/mfd/twl4030-madc.c
>
> Both from the same author:
>
> $ git grep -e MODULE_AUTHOR drivers/mfd/twl4030-madc.c drivers/hwmon/twl4030-madc-hwmon.c
> drivers/hwmon/twl4030-madc-hwmon.c:MODULE_AUTHOR("J Keerthy");
> drivers/mfd/twl4030-madc.c:MODULE_AUTHOR("J Keerthy");
>
> but added on different commits:
>
> commit f99c1d4f94f91fd3a20bd2eaa3be9c5e7d2668eb
> Author: Keerthy <j-keerthy@ti.com>
> Date:   Tue Mar 1 19:12:26 2011 +0530
>
>    mfd: Add twl4030 madc driver
>
>    Introducing a driver for MADC on TWL4030 powerIC. MADC stands for monitoring
>    ADC. This driver monitors the real time conversion of analog signals like
>    battery temperature, battery cuurent etc.
>
>    Signed-off-by: Keerthy <j-keerthy@ti.com>
>    Signed-off-by: Samuel Ortiz <sameo@linux.intel.com>
>
> commit 0070bddfe7275e5bc763884a8ac59651f4e79eab
> Author: Keerthy <j-keerthy@ti.com>
> Date:   Tue Mar 1 19:12:36 2011 +0530
>
>    hwmon: twl4030: Hwmon Driver for TWL4030 MADC
>
>    This driver exposes the sysfs nodes of the TWL4030 MADC module.
>    All the voltage channel values are expressed in terms of mV. Channel 13
>    and channel 14 are reserved. There are channels which represent
>    temperature and current the output is represented by celcius
>    and mA respectively.
>
>    Signed-off-by: Keerthy <j-keerthy@ti.com>
>    Acked-by: Guenter Roeck <guenter.roeck@ericsson.com>
>    Signed-off-by: Samuel Ortiz <sameo@linux.intel.com>
>
>
> --
> balbi
>



-- 
Regards and Thanks,
Keerthy
--
To unsubscribe from this list: send the line "unsubscribe linux-omap" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: Kconfig help descriptions

[Santosh Shilimkar]

Keerthy,

On 7/21/2011 4:49 PM, J, KEERTHY wrote:
> Hello Russel,
>
> MADC stands for monitoring ADC. It is part of TWL4030 power IC.
> TWL4030 is only on OMAP3 and hence not applicable for OMAP4.
>
> The driver is split accross mfd and hwmon. Generic ADC
> reading part is in mfd and exposing the individual ADC channel
> sysfs nodes is part of hwmon. I apologize for missing this
> information in KConfig help. I will post a patch to update this.
>
Avoid top posting while replying on patches.

Regards
Santosh

Re: Kconfig help descriptions

[Mark Brown]

On Thu, Jul 21, 2011 at 12:57:03PM +0300, Felipe Balbi wrote:

> the problem seems to be worse then you thought:

> $ git ls-files drivers/  | grep madc
> drivers/hwmon/twl4030-madc-hwmon.c
> drivers/mfd/twl4030-madc.c

This is normal for this sort of auxiliary ADC - they're *normally* used
for system monitoring and should show up in hwmon but are more general
purpose than that so you get a MFD core which drives the actual ADC and
a hwomon driver which uses the core to expose things to userspace.

Sadly we don't have a subsystem for ADCs yet, IIO might be it but it's
really designed for much higher volume ADCs.