[PATCH 1/2] devicetree: add documentation for MAX30102 oximeter

[PATCH 1/2] devicetree: add documentation for MAX30102 oximeter

[Matt Ranostay]

Cc: devicetree-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
Signed-off-by: Matt Ranostay <matt-sk+viVC6FLCDq+mSdOJa79kegs52MxvZ@public.gmane.org>
---
 .../devicetree/bindings/iio/health/max30102.txt    | 30 ++++++++++++++++++++++
 1 file changed, 30 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/iio/health/max30102.txt

diff --git a/Documentation/devicetree/bindings/iio/health/max30102.txt b/Documentation/devicetree/bindings/iio/health/max30102.txt
new file mode 100644
index 000000000000..c93d1bb25597
--- /dev/null
+++ b/Documentation/devicetree/bindings/iio/health/max30102.txt
@@ -0,0 +1,30 @@
+Maxim MAX30102 heart rate and pulse oximeter sensor
+
+* https://datasheets.maximintegrated.com/en/ds/MAX30102.pdf
+
+Required properties:
+  - compatible: must be "maxim,max30102"
+  - reg: the I2C address of the sensor
+  - interrupt-parent: should be the phandle for the interrupt controller
+  - interrupts: the sole interrupt generated by the device
+
+  Refer to interrupt-controller/interrupts.txt for generic
+  interrupt client node bindings.
+
+Optional properties:
+  - maxim,red-led-current-microamp: configuration for RED LED current
+  - maxim,ir-led-current-microamp: configuration for IR LED current
+
+    Note that each step is approximately 200 microamps, ranging from 0 uA to
+    50800 uA.
+
+Example:
+
+max30100@57 {
+	compatible = "maxim,max30102";
+	reg = <57>;
+	maxim,red-led-current-microamp = <7000>;
+	maxim,ir-led-current-microamp = <7000>;
+	interrupt-parent = <&gpio1>;
+	interrupts = <16 2>;
+};
-- 
2.10.2

--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: [PATCH 1/2] devicetree: add documentation for MAX30102 oximeter

[Jonathan Cameron]

On 20/01/17 05:40, Matt Ranostay wrote:
> Cc: devicetree-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
> Signed-off-by: Matt Ranostay <matt-sk+viVC6FLCDq+mSdOJa79kegs52MxvZ@public.gmane.org>
> ---
>  .../devicetree/bindings/iio/health/max30102.txt    | 30 ++++++++++++++++++++++
>  1 file changed, 30 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/iio/health/max30102.txt
> 
> diff --git a/Documentation/devicetree/bindings/iio/health/max30102.txt b/Documentation/devicetree/bindings/iio/health/max30102.txt
> new file mode 100644
> index 000000000000..c93d1bb25597
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/health/max30102.txt
> @@ -0,0 +1,30 @@
> +Maxim MAX30102 heart rate and pulse oximeter sensor
> +
> +* https://datasheets.maximintegrated.com/en/ds/MAX30102.pdf
> +
> +Required properties:
> +  - compatible: must be "maxim,max30102"
> +  - reg: the I2C address of the sensor
> +  - interrupt-parent: should be the phandle for the interrupt controller
> +  - interrupts: the sole interrupt generated by the device
> +
> +  Refer to interrupt-controller/interrupts.txt for generic
> +  interrupt client node bindings.
> +
> +Optional properties:
> +  - maxim,red-led-current-microamp: configuration for RED LED current
> +  - maxim,ir-led-current-microamp: configuration for IR LED current
> +
> +    Note that each step is approximately 200 microamps, ranging from 0 uA to
> +    50800 uA.
Are these due to the hardware present, or are we looking at something that should
be controllable from userspace?
> +
> +Example:
> +
> +max30100@57 {
> +	compatible = "maxim,max30102";
> +	reg = <57>;
> +	maxim,red-led-current-microamp = <7000>;
> +	maxim,ir-led-current-microamp = <7000>;
> +	interrupt-parent = <&gpio1>;
> +	interrupts = <16 2>;
> +};
> 

--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: [PATCH 1/2] devicetree: add documentation for MAX30102 oximeter

[Matt Ranostay]

On Sun, Jan 22, 2017 at 4:22 AM, Jonathan Cameron <jic23-DgEjT+Ai2ygdnm+yROfE0A@public.gmane.org> wrote:
> On 20/01/17 05:40, Matt Ranostay wrote:
>> Cc: devicetree-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
>> Signed-off-by: Matt Ranostay <matt-sk+viVC6FLCDq+mSdOJa79kegs52MxvZ@public.gmane.org>
>> ---
>>  .../devicetree/bindings/iio/health/max30102.txt    | 30 ++++++++++++++++++++++
>>  1 file changed, 30 insertions(+)
>>  create mode 100644 Documentation/devicetree/bindings/iio/health/max30102.txt
>>
>> diff --git a/Documentation/devicetree/bindings/iio/health/max30102.txt b/Documentation/devicetree/bindings/iio/health/max30102.txt
>> new file mode 100644
>> index 000000000000..c93d1bb25597
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/iio/health/max30102.txt
>> @@ -0,0 +1,30 @@
>> +Maxim MAX30102 heart rate and pulse oximeter sensor
>> +
>> +* https://datasheets.maximintegrated.com/en/ds/MAX30102.pdf
>> +
>> +Required properties:
>> +  - compatible: must be "maxim,max30102"
>> +  - reg: the I2C address of the sensor
>> +  - interrupt-parent: should be the phandle for the interrupt controller
>> +  - interrupts: the sole interrupt generated by the device
>> +
>> +  Refer to interrupt-controller/interrupts.txt for generic
>> +  interrupt client node bindings.
>> +
>> +Optional properties:
>> +  - maxim,red-led-current-microamp: configuration for RED LED current
>> +  - maxim,ir-led-current-microamp: configuration for IR LED current
>> +
>> +    Note that each step is approximately 200 microamps, ranging from 0 uA to
>> +    50800 uA.
> Are these due to the hardware present, or are we looking at something that should
> be controllable from userspace?

Generally you'd set this value based on the hardware application it is
being used for.. namely if you had a plastic case or wristband that is
affecting the signal..

>> +
>> +Example:
>> +
>> +max30100@57 {
>> +     compatible = "maxim,max30102";
>> +     reg = <57>;
>> +     maxim,red-led-current-microamp = <7000>;
>> +     maxim,ir-led-current-microamp = <7000>;
>> +     interrupt-parent = <&gpio1>;
>> +     interrupts = <16 2>;
>> +};
>>
>
> --
> To unsubscribe from this list: send the line "unsubscribe linux-iio" in
> the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
> More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: [PATCH 1/2] devicetree: add documentation for MAX30102 oximeter

[Jonathan Cameron]

On 24/01/17 22:16, Matt Ranostay wrote:
> On Sun, Jan 22, 2017 at 4:22 AM, Jonathan Cameron <jic23-DgEjT+Ai2ygdnm+yROfE0A@public.gmane.org> wrote:
>> On 20/01/17 05:40, Matt Ranostay wrote:
>>> Cc: devicetree-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
>>> Signed-off-by: Matt Ranostay <matt-sk+viVC6FLCDq+mSdOJa79kegs52MxvZ@public.gmane.org>
>>> ---
>>>  .../devicetree/bindings/iio/health/max30102.txt    | 30 ++++++++++++++++++++++
>>>  1 file changed, 30 insertions(+)
>>>  create mode 100644 Documentation/devicetree/bindings/iio/health/max30102.txt
>>>
>>> diff --git a/Documentation/devicetree/bindings/iio/health/max30102.txt b/Documentation/devicetree/bindings/iio/health/max30102.txt
>>> new file mode 100644
>>> index 000000000000..c93d1bb25597
>>> --- /dev/null
>>> +++ b/Documentation/devicetree/bindings/iio/health/max30102.txt
>>> @@ -0,0 +1,30 @@
>>> +Maxim MAX30102 heart rate and pulse oximeter sensor
>>> +
>>> +* https://datasheets.maximintegrated.com/en/ds/MAX30102.pdf
>>> +
>>> +Required properties:
>>> +  - compatible: must be "maxim,max30102"
>>> +  - reg: the I2C address of the sensor
>>> +  - interrupt-parent: should be the phandle for the interrupt controller
>>> +  - interrupts: the sole interrupt generated by the device
>>> +
>>> +  Refer to interrupt-controller/interrupts.txt for generic
>>> +  interrupt client node bindings.
>>> +
>>> +Optional properties:
>>> +  - maxim,red-led-current-microamp: configuration for RED LED current
>>> +  - maxim,ir-led-current-microamp: configuration for IR LED current
>>> +
>>> +    Note that each step is approximately 200 microamps, ranging from 0 uA to
>>> +    50800 uA.
>> Are these due to the hardware present, or are we looking at something that should
>> be controllable from userspace?
> 
> Generally you'd set this value based on the hardware application it is
> being used for.. namely if you had a plastic case or wristband that is
> affecting the signal..
Fair enough.
> 
>>> +
>>> +Example:
>>> +
>>> +max30100@57 {
>>> +     compatible = "maxim,max30102";
>>> +     reg = <57>;
>>> +     maxim,red-led-current-microamp = <7000>;
>>> +     maxim,ir-led-current-microamp = <7000>;
>>> +     interrupt-parent = <&gpio1>;
>>> +     interrupts = <16 2>;
>>> +};
>>>
>>
>> --
>> To unsubscribe from this list: send the line "unsubscribe linux-iio" in
>> the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
>> More majordomo info at  http://vger.kernel.org/majordomo-info.html

--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html