From: Jonathan Cameron <jic23@kernel.org>
To: Hartmut Knaack <knaack.h@gmx.de>,
Stanimir Varbanov <svarbanov@mm-sol.com>,
Ian Campbell <ijc+devicetree@hellion.org.uk>,
Pawel Moll <pawel.moll@arm.com>, Rob Herring <robh+dt@kernel.org>,
Kumar Gala <galak@codeaurora.org>,
Mark Rutland <mark.rutland@arm.com>,
Grant Likely <grant.likely@linaro.org>,
Arnd Bergmann <arnd@arndb.de>
Cc: linux-arm-msm@vger.kernel.org, linux-kernel@vger.kernel.org,
linux-iio@vger.kernel.org, devicetree@vger.kernel.org,
Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
Lars-Peter Clausen <lars@metafoo.de>,
Angelo Compagnucci <angelo.compagnucci@gmail.com>,
Doug Anderson <dianders@chromium.org>,
Fugang Duan <B38611@freescale.com>,
Johannes Thumshirn <johannes.thumshirn@men.de>,
Jean Delvare <jdelvare@suse.de>,
Philippe Reynes <tremyfr@yahoo.fr>,
Lee Jones <lee.jones@linaro.org>,
Josh Cartwright <joshc@codeaurora.org>,
Stephen Boyd <sboyd@codeaurora.org>,
David Collins <collinsd@codeaurora.org>,
"Ivan T. Ivanov" <iivanov@mm-sol.com>
Subject: Re: [PATCH v2 2/2] DT: iio: vadc: document dt binding
Date: Sat, 13 Sep 2014 18:32:15 +0100 [thread overview]
Message-ID: <54147F9F.3070804@kernel.org> (raw)
In-Reply-To: <5413832F.6040503@gmx.de>
On 13/09/14 00:35, Hartmut Knaack wrote:
> Stanimir Varbanov schrieb, Am 11.09.2014 17:13:
>> Document DT binding for Qualcomm SPMI PMIC voltage ADC
>> driver.
>>
> Still one typo left.
>> Signed-off-by: Stanimir Varbanov <svarbanov@mm-sol.com>
>> Signed-off-by: Ivan T. Ivanov <iivanov@mm-sol.com>
>> ---
>> .../devicetree/bindings/iio/adc/qcom,spmi-vadc.txt | 123 ++++++++++++++++++++
>> 1 files changed, 123 insertions(+), 0 deletions(-)
>> create mode 100644 Documentation/devicetree/bindings/iio/adc/qcom,spmi-vadc.txt
>>
>> diff --git a/Documentation/devicetree/bindings/iio/adc/qcom,spmi-vadc.txt b/Documentation/devicetree/bindings/iio/adc/qcom,spmi-vadc.txt
>> new file mode 100644
>> index 0000000..5abb491
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/iio/adc/qcom,spmi-vadc.txt
>> @@ -0,0 +1,123 @@
>> +Qualcomm's SPMI PMIC voltage ADC
>> +
>> +SPMI PMIC voltage ADC (VADC) provides interface to clients to read
>> +voltage. A 15 bit ADC is used for voltage measurements. There are multiple
>> +peripherals to the VADC and the scope of the driver is to provide interface
>> +for the USR peripheral of the VADC.
>> +
>> +VADC node:
>> +
>> +- compatible:
>> + Usage: required
>> + Value type: <string>
>> + Definition: Should contain "qcom,spmi-vadc".
>> +
>> +- reg:
>> + Usage: required
>> + Value type: <u32>
>> + Definition: Base address in the SPMI PMIC register map.
>> +
>> +- address-cells:
>> + Usage: required
>> + Value type: <u32>
>> + Definition: Must be one.
>> +
>> +- size-cells:
>> + Usage: required
>> + Value type: <u32>
>> + Definition: Must be zero.
>> +
>> +- interrupts:
>> + Usage: required
>> + Value type: <prop-encoded-array>
>> + Definition: End of convertion interrupt number.
> Typo: conversion
>> +
>> +- qcom,poll-eoc:
>> + Usage: optional
>> + Value type: <empty>
>> + Definition: Use polling instead of interrupt for end of conversion
>> + completion.
>> +
>> +Channel node properties:
>> +
>> +- reg:
>> + Usage: required
>> + Value type: <u32>
>> + Definition: AMUX channel number.
>> + See include/dt-bindings/iio/qcom,spmi-pmic-vadc.h
>> +
>> +- qcom,decimation:
>> + Usage: optional
>> + Value type: <u32>
>> + Definition: Sampling rate to use for the individual channel measurement.
>> + Quicker measurements can be made by reducing decimation ratio.
>> + Valid values are 512, 1024, 2048, 4096.
>> + If property is not found, default value of 512 will be used.
>> +
>> +- qcom,pre-scaling:
>> + Usage: optional
>> + Value type: <u32 array>
>> + Definition: Used for scaling the channel input signal before the signal is
>> + fed to VADC. The configuration for this node is to know the
>> + pre-determined ratio and use it for post scaling. Select one from
>> + the following options.
>> + <1 1>, <1 3>, <1 4>, <1 6>, <1 20>, <1 8>, <10 81>, <1 10>
>> + If property is not found default value depending of chip will be used.
>> +
>> +- qcom,ratiometric:
>> + Usage: optional
>> + Value type: <empty>
>> + Definition: Channel calibration type. If this property is specified
>> + VADC will use the VDD reference(1.8V) and GND for channel
>> + calibration. If property is not found, channel will be
>> + calibrated with 625mV and 1.25V reference channels.
>> +
>> +- qcom,hw-settle-time:
>> + Usage: optional
>> + Value type: <u32>
>> + Definition: Time between AMUX getting configured and the ADC starting
>> + conversion. Delay = 100us * (value) for value < 11, and
>> + 2ms * (value - 10) otherwise.
>> + Valid values are: 0, 100, 200, 300, 400, 500, 600, 700, 800,
>> + 900 us and 1, 2, 4, 6, 8, 10 ms
>> + If property is not found, channel will use 0us.
>> +
>> +- qcom,avg-samples:
>> + Usage: optional
>> + Value type: <u32>
>> + Definition: Number of samples to be used for measurement.
>> + Fast averaging provides the option to obtain a single measurement
>> + from the ADC that is an average of multiple samples. The value
>> + selected is 2^(value).
>> + Valid values are: 1, 2, 4, 8, 16, 32, 64, 128, 256, 512
>> + If property is not found, 1 sample will be used.
>> +
>> +NOTE: At least one channel node is required.
Why? As far as I can see it will register all the channels anyway. If that is not the intent
you need to build the iio_chan_spec array rather than using a static one.
I'm fine with it providing channels with sensible defaults if they aren't overridden, but then
it should work fine with no channel nodes.
Jonathan
>> +
>> +Example:
>> + /* VADC node */
>> + pmic_vadc: vadc@3100 {
>> + compatible = "qcom,spmi-vadc";
>> + reg = <0x3100 0x100>;
>> + interrupts = <0x0 0x31 0x0 IRQ_TYPE_EDGE_RISING>;
>> + #address-cells = <1>;
>> + #size-cells = <0>;
>> + #io-channel-cells = <1>;
>> + io-channel-ranges;
>> +
>> + /* Channel node */
>> + usb_id_nopull {
>> + reg = <VADC_LR_MUX10_USB_ID>;
>> + qcom,decimation = <512>;
>> + qcom,ratiometric;
>> + qcom,hw-settle-time = <200>;
>> + qcom,avg-samples = <1>;
>> + qcom,pre-scaling = <1 3>;
>> + };
>> + };
>> +
>> + /* IIO client node */
>> + usb {
>> + io-channels = <&pmic_vadc VADC_LR_MUX10_USB_ID>;
>> + io-channel-names = "vadc";
>> + };
>>
>
> --
> To unsubscribe from this list: send the line "unsubscribe linux-iio" in
> the body of a message to majordomo@vger.kernel.org
> More majordomo info at http://vger.kernel.org/majordomo-info.html
>
prev parent reply other threads:[~2014-09-13 17:32 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-09-11 15:13 [PATCH v2 0/2] Intial support for voltage ADC Stanimir Varbanov
2014-09-11 15:13 ` [PATCH v2 1/2] iio: vadc: Qualcomm SPMI PMIC voltage ADC driver Stanimir Varbanov
2014-09-12 23:27 ` Hartmut Knaack
2014-09-13 17:27 ` Jonathan Cameron
2014-09-15 14:12 ` Stanimir Varbanov
2014-09-15 16:11 ` Jonathan Cameron
2014-09-18 9:57 ` Stanimir Varbanov
2014-09-21 13:29 ` Jonathan Cameron
2014-09-22 1:01 ` Kim, Milo
2014-09-15 14:16 ` Stanimir Varbanov
2014-09-11 15:13 ` [PATCH v2 2/2] DT: iio: vadc: document dt binding Stanimir Varbanov
2014-09-12 23:35 ` Hartmut Knaack
2014-09-13 17:32 ` Jonathan Cameron [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=54147F9F.3070804@kernel.org \
--to=jic23@kernel.org \
--cc=B38611@freescale.com \
--cc=angelo.compagnucci@gmail.com \
--cc=arnd@arndb.de \
--cc=collinsd@codeaurora.org \
--cc=devicetree@vger.kernel.org \
--cc=dianders@chromium.org \
--cc=galak@codeaurora.org \
--cc=grant.likely@linaro.org \
--cc=gregkh@linuxfoundation.org \
--cc=iivanov@mm-sol.com \
--cc=ijc+devicetree@hellion.org.uk \
--cc=jdelvare@suse.de \
--cc=johannes.thumshirn@men.de \
--cc=joshc@codeaurora.org \
--cc=knaack.h@gmx.de \
--cc=lars@metafoo.de \
--cc=lee.jones@linaro.org \
--cc=linux-arm-msm@vger.kernel.org \
--cc=linux-iio@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mark.rutland@arm.com \
--cc=pawel.moll@arm.com \
--cc=robh+dt@kernel.org \
--cc=sboyd@codeaurora.org \
--cc=svarbanov@mm-sol.com \
--cc=tremyfr@yahoo.fr \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).