Skip to contentSkip to conversation

Documentation: firmware-guide: gpio-properties: Clarify Explicit and Implicit

PATCH Applied Andy Shevchenko 2 participants 4 messages Feb 13, 2023

Subsystems (3)

v1 of 2 Applied Latest is v2 →

lore
Share & tools
lore

Andy Shevchenko

author maintainer
#0 lore raw

PATCH 1/1 Documentation: firmware-guide: gpio-properties: Clarify Explicit and Implicit

Clarify the Explicit and Implicit meanings in the table of Pull Bias.

While at it, distinguish pull bias keywords used in ACPI by using bold font in the table of the respective terms.

---
 .../firmware-guide/acpi/gpio-properties.rst   | 25 +++++++++++--------
 1 file changed, 14 insertions(+), 11 deletions(-)
Documentation/firmware-guide/acpi/gpio-properties.rst +14 -11
index eaec732cc77c..ae87aa64cb7b 100644
@@ -67,17 +67,20 @@ state of the output pin which driver should use during its initialization.
 Linux tries to use common sense here and derives the state from the bias
 and polarity settings. The table below shows the expectations:
 
-=========  =============  ==============
-Pull Bias     Polarity     Requested...
-=========  =============  ==============
-Implicit     x            AS IS (assumed firmware configured for us)
-Explicit     x (no _DSD)  as Pull Bias (Up == High, Down == Low),
-                          assuming non-active (Polarity = !Pull Bias)
-Down         Low          as low, assuming active
-Down         High         as low, assuming non-active
-Up           Low          as high, assuming non-active
-Up           High         as high, assuming active
-=========  =============  ==============
+=========          =============  ==============
+Pull Bias             Polarity     Requested...
+=========          =============  ==============
+Implicit             x            AS IS (assumed firmware configured it for us)
+(**Default**)
+Explicit             x (no _DSD)  as Pull Bias (**Up** == high, **Down** == low),
+(**Up**, **Down**,                assuming non-active (Polarity = !Pull Bias);
+ **None**)                        or AS IS (assumed firmware configured it for us)
+                                  with no Pull Bias
+**Down**             Low          as low, assuming active
+**Down**             High         as low, assuming non-active
+**Up**               Low          as high, assuming non-active
+**Up**               High         as high, assuming active
+=========          =============  ==============
 
 That said, for our above example the both GPIOs, since the bias setting
 is explicit and _DSD is present, will be treated as active with a high
Signature · 1 line
2.39.1
maintainer Applied
#1 lore raw
Quoted 38 lines · Andy Shevchenko

Clarify the Explicit and Implicit meanings in the table of Pull Bias.

While at it, distinguish pull bias keywords used in ACPI by using bold font in the table of the respective terms.

---
 .../firmware-guide/acpi/gpio-properties.rst   | 25 +++++++++++--------
 1 file changed, 14 insertions(+), 11 deletions(-)
Documentation/firmware-guide/acpi/gpio-properties.rst +8 -11
index eaec732cc77c..ae87aa64cb7b 100644
@@ -67,17 +67,20 @@ state of the output pin which driver should use during its initialization.
 Linux tries to use common sense here and derives the state from the bias
 and polarity settings. The table below shows the expectations:
 
-=========  =============  ==============
-Pull Bias     Polarity     Requested...
-=========  =============  ==============
-Implicit     x            AS IS (assumed firmware configured for us)
-Explicit     x (no _DSD)  as Pull Bias (Up == High, Down == Low),
-                          assuming non-active (Polarity = !Pull Bias)
-Down         Low          as low, assuming active
-Down         High         as low, assuming non-active
-Up           Low          as high, assuming non-active
-Up           High         as high, assuming active
-=========  =============  ==============
+=========          =============  ==============
+Pull Bias             Polarity     Requested...
+=========          =============  ==============
+Implicit             x            AS IS (assumed firmware configured it for us)
+(**Default**)
+Explicit             x (no _DSD)  as Pull Bias (**Up** == high, **Down** == low),
+(**Up**, **Down**,                assuming non-active (Polarity = !Pull Bias);
+ **None**)                        or AS IS (assumed firmware configured it for us)

Documentation/firmware-guide/acpi/gpio-properties.rst state of the output pin which driver should use during its initialization.

Quoted 10 lines
Documentation/firmware-guide/acpi/gpio-properties.rst +6 -1
+                                  with no Pull Bias
+**Down**             Low          as low, assuming active
+**Down**             High         as low, assuming non-active
+**Up**               Low          as high, assuming non-active
+**Up**               High         as high, assuming active
+=========          =============  ==============
 
 That said, for our above example the both GPIOs, since the bias setting
 is explicit and _DSD is present, will be treated as active with a high
--

Applied as 6.3 material, thanks!

author maintainer
#2 lore raw
Quoted 3 lines · Rafael J. Wysocki
Quoted 1 line · Andy Shevchenko

...

Quoted 4 lines
Quoted 2 lines

That said, for our above example the both GPIOs, since the bias setting is explicit and _DSD is present, will be treated as active with a high

Applied as 6.3 material, thanks!

Can you withdraw it for now, please? It has some formatting issues. I will fix and send a new version instead.

Thank you!

Signature · 2 lines
With Best Regards,
Andy Shevchenko
#3 lore raw
Quoted 8 lines · Andy Shevchenko
Quoted 3 lines · Rafael J. Wysocki
Quoted 1 line · Andy Shevchenko

...

Quoted 7 lines
Quoted 4 lines
Quoted 2 lines

That said, for our above example the both GPIOs, since the bias setting is explicit and _DSD is present, will be treated as active with a high

Applied as 6.3 material, thanks!

Can you withdraw it for now, please? It has some formatting issues. I will fix and send a new version instead.

Sure.