Commit 27383ca9 authored by Krzysztof Kozlowski's avatar Krzysztof Kozlowski Committed by Lee Jones

dt-bindings: regulator/mfd: Reorganize S5M8767 bindings

The regulator/s5m8767-regulator.txt duplicates some of the information
about bindings with old mfd/s2mps11.txt. Now common part exists entirely
in mfd/samsung,sec-core.txt so:
 - add company prefix to file name (regulator/samsung,s5m8767.txt),
 - remove duplicated information,
 - reorganize the contents to match style of
   regulator/samsung,s2mps11.txt.
Signed-off-by: default avatarKrzysztof Kozlowski <k.kozlowski@samsung.com>
Acked-by: default avatarMark Brown <broonie@kernel.org>
Acked-by: default avatarRob Herring <robh@kernel.org>
Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
parent a13c7c51
...@@ -14,6 +14,7 @@ addressed by the host system using different I2C slave addresses. ...@@ -14,6 +14,7 @@ addressed by the host system using different I2C slave addresses.
This document describes bindings for main device node. Optional sub-blocks This document describes bindings for main device node. Optional sub-blocks
must be a sub-nodes to it. Bindings for them can be found in: must be a sub-nodes to it. Bindings for them can be found in:
- bindings/regulator/samsung,s2mps11.txt - bindings/regulator/samsung,s2mps11.txt
- bindings/regulator/samsung,s5m8767.txt
- bindings/clock/samsung,s2mps11.txt - bindings/clock/samsung,s2mps11.txt
...@@ -23,7 +24,8 @@ Required properties: ...@@ -23,7 +24,8 @@ Required properties:
- "samsung,s2mps13-pmic", - "samsung,s2mps13-pmic",
- "samsung,s2mps14-pmic", - "samsung,s2mps14-pmic",
- "samsung,s2mps15-pmic", - "samsung,s2mps15-pmic",
- "samsung,s2mpu02-pmic". - "samsung,s2mpu02-pmic",
- "samsung,s5m8767-pmic".
- reg: Specifies the I2C slave address of the pmic block. It should be 0x66. - reg: Specifies the I2C slave address of the pmic block. It should be 0x66.
Optional properties: Optional properties:
......
* Samsung S5M8767 Voltage and Current Regulator Binding for Samsung S5M8767 regulator block
===========================================
The Samsung S5M8767 is a multi-function device which includes voltage and
current regulators, rtc, charger controller and other sub-blocks. It is This is a part of device tree bindings for S5M family multi-function devices.
interfaced to the host controller using a i2c interface. Each sub-block is More information can be found in bindings/mfd/sec-core.txt file.
addressed by the host system using different i2c slave address. This document
describes the bindings for 'pmic' sub-block of s5m8767. The S5M8767 device provide buck and LDO regulators.
Required properties: To register these with regulator framework instantiate under main device node
- compatible: Should be "samsung,s5m8767-pmic". a sub-node named "regulators" with more sub-nodes for each regulator using the
- reg: Specifies the i2c slave address of the pmic block. It should be 0x66. common regulator binding documented in:
- Documentation/devicetree/bindings/regulator/regulator.txt
- s5m8767,pmic-buck2-dvs-voltage: A set of 8 voltage values in micro-volt (uV)
units for buck2 when changing voltage using gpio dvs. Refer to [1] below
for additional information. Required properties of the main device node (the parent!):
- s5m8767,pmic-buck2-dvs-voltage: A set of 8 voltage values in micro-volt (uV)
- s5m8767,pmic-buck3-dvs-voltage: A set of 8 voltage values in micro-volt (uV) units for buck2 when changing voltage using gpio dvs. Refer to [1] below
units for buck3 when changing voltage using gpio dvs. Refer to [1] below for additional information.
for additional information.
- s5m8767,pmic-buck3-dvs-voltage: A set of 8 voltage values in micro-volt (uV)
- s5m8767,pmic-buck4-dvs-voltage: A set of 8 voltage values in micro-volt (uV) units for buck3 when changing voltage using gpio dvs. Refer to [1] below
units for buck4 when changing voltage using gpio dvs. Refer to [1] below for additional information.
for additional information.
- s5m8767,pmic-buck4-dvs-voltage: A set of 8 voltage values in micro-volt (uV)
- s5m8767,pmic-buck-ds-gpios: GPIO specifiers for three host gpio's used units for buck4 when changing voltage using gpio dvs. Refer to [1] below
for selecting GPIO DVS lines. It is one-to-one mapped to dvs gpio lines. for additional information.
[1] If none of the 's5m8767,pmic-buck[2/3/4]-uses-gpio-dvs' optional - s5m8767,pmic-buck-ds-gpios: GPIO specifiers for three host gpio's used
property is specified, the 's5m8767,pmic-buck[2/3/4]-dvs-voltage' for selecting GPIO DVS lines. It is one-to-one mapped to dvs gpio lines.
property should specify atleast one voltage level (which would be a
safe operating voltage). [1] If none of the 's5m8767,pmic-buck[2/3/4]-uses-gpio-dvs' optional
property is specified, the 's5m8767,pmic-buck[2/3/4]-dvs-voltage'
If either of the 's5m8767,pmic-buck[2/3/4]-uses-gpio-dvs' optional property should specify atleast one voltage level (which would be a
property is specified, then all the eight voltage values for the safe operating voltage).
's5m8767,pmic-buck[2/3/4]-dvs-voltage' should be specified.
If either of the 's5m8767,pmic-buck[2/3/4]-uses-gpio-dvs' optional
Optional properties: property is specified, then all the eight voltage values for the
- interrupt-parent: Specifies the phandle of the interrupt controller to which 's5m8767,pmic-buck[2/3/4]-dvs-voltage' should be specified.
the interrupts from s5m8767 are delivered to.
- interrupts: Interrupt specifiers for two interrupt sources. Optional properties of the main device node (the parent!):
- First interrupt specifier is for 'irq1' interrupt. - s5m8767,pmic-buck2-uses-gpio-dvs: 'buck2' can be controlled by gpio dvs.
- Second interrupt specifier is for 'alert' interrupt. - s5m8767,pmic-buck3-uses-gpio-dvs: 'buck3' can be controlled by gpio dvs.
- s5m8767,pmic-buck2-uses-gpio-dvs: 'buck2' can be controlled by gpio dvs. - s5m8767,pmic-buck4-uses-gpio-dvs: 'buck4' can be controlled by gpio dvs.
- s5m8767,pmic-buck3-uses-gpio-dvs: 'buck3' can be controlled by gpio dvs.
- s5m8767,pmic-buck4-uses-gpio-dvs: 'buck4' can be controlled by gpio dvs.
Additional properties required if either of the optional properties are used: Additional properties required if either of the optional properties are used:
- s5m8767,pmic-buck234-default-dvs-idx: Default voltage setting selected from - s5m8767,pmic-buck234-default-dvs-idx: Default voltage setting selected from
the possible 8 options selectable by the dvs gpios. The value of this the possible 8 options selectable by the dvs gpios. The value of this
property should be between 0 and 7. If not specified or if out of range, the property should be between 0 and 7. If not specified or if out of range, the
default value of this property is set to 0. default value of this property is set to 0.
- s5m8767,pmic-buck-dvs-gpios: GPIO specifiers for three host gpio's used - s5m8767,pmic-buck-dvs-gpios: GPIO specifiers for three host gpio's used
for dvs. The format of the gpio specifier depends in the gpio controller. for dvs. The format of the gpio specifier depends in the gpio controller.
Regulators: The regulators of s5m8767 that have to be instantiated should be
included in a sub-node named 'regulators'. Regulator nodes included in this
sub-node should be of the format as listed below.
regulator_name {
ldo1_reg: LDO1 {
regulator-name = "VDD_ALIVE_1.0V";
regulator-min-microvolt = <1100000>;
regulator-max-microvolt = <1100000>;
regulator-always-on;
regulator-boot-on;
op_mode = <1>; /* Normal Mode */
};
};
The above regulator entries are defined in regulator bindings documentation
except these properties:
- op_mode: describes the different operating modes of the LDO's with
power mode change in SOC. The different possible values are,
0 - always off mode
1 - on in normal mode
2 - low power mode
3 - suspend mode
- s5m8767,pmic-ext-control-gpios: (optional) GPIO specifier for one
GPIO controlling this regulator (enable/disable); This is
valid only for buck9.
The following are the names of the regulators that the s5m8767 pmic block
supports. Note: The 'n' in LDOn and BUCKn represents the LDO or BUCK number
as per the datasheet of s5m8767.
Names of regulators supported by S5M8767 device:
- LDOn - LDOn
- valid values for n are 1 to 28 - valid values for n are 1 to 28
- Example: LDO1, LDO2, LDO28 - Example: LDO1, LDO2, LDO28
- BUCKn - BUCKn
- valid values for n are 1 to 9. - valid values for n are 1 to 9.
- Example: BUCK1, BUCK2, BUCK9 - Example: BUCK1, BUCK2, BUCK9
Note: The 'n' in LDOn and BUCKn represents the LDO or BUCK number
The bindings inside the regulator nodes use the standard regulator bindings as per the datasheet of device.
which are documented elsewhere.
Optional properties of the nodes under "regulators" sub-node:
- op_mode: describes the different operating modes of the LDO's with
power mode change in SOC. The different possible values are,
0 - always off mode
1 - on in normal mode
2 - low power mode
3 - suspend mode
- s5m8767,pmic-ext-control-gpios: (optional) GPIO specifier for one
GPIO controlling this regulator
(enable/disable); This is valid only
for buck9.
Example: Example:
......
...@@ -9223,9 +9223,9 @@ F: drivers/regulator/s5m*.c ...@@ -9223,9 +9223,9 @@ F: drivers/regulator/s5m*.c
F: drivers/clk/clk-s2mps11.c F: drivers/clk/clk-s2mps11.c
F: drivers/rtc/rtc-s5m.c F: drivers/rtc/rtc-s5m.c
F: include/linux/mfd/samsung/ F: include/linux/mfd/samsung/
F: Documentation/devicetree/bindings/regulator/s5m8767-regulator.txt
F: Documentation/devicetree/bindings/mfd/samsung,sec-core.txt F: Documentation/devicetree/bindings/mfd/samsung,sec-core.txt
F: Documentation/devicetree/bindings/regulator/samsung,s2m*.txt F: Documentation/devicetree/bindings/regulator/samsung,s2m*.txt
F: Documentation/devicetree/bindings/regulator/samsung,s5m*.txt
F: Documentation/devicetree/bindings/clock/samsung,s2mps11.txt F: Documentation/devicetree/bindings/clock/samsung,s2mps11.txt
SAMSUNG S5P/EXYNOS4 SOC SERIES CAMERA SUBSYSTEM DRIVERS SAMSUNG S5P/EXYNOS4 SOC SERIES CAMERA SUBSYSTEM DRIVERS
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment