Commit 830751d5 authored by Andy Shevchenko's avatar Andy Shevchenko Committed by Rafael J. Wysocki
Browse files

ACPI: docs: gpio-properties: Unify ASL style for GPIO examples 



GPIO examples of ASL in the board.rst, enumeration.rst and gpio-properties.rst
are not unified. Unify them for better reader experience.

Signed-off-by: default avatarAndy Shevchenko <andriy.shevchenko@linux.intel.com>
Reviewed-by: default avatarMika Westerberg <mika.westerberg@linux.intel.com>
Signed-off-by: default avatarRafael J. Wysocki <rafael.j.wysocki@intel.com>
parent 01399a99

Documentation/driver-api/gpio/board.rst

+9 −12
Original line number Diff line number Diff line
@@ -71,14 +71,14 @@ with the help of _DSD (Device Specific Data), introduced in ACPI 5.1:: 


	Device (FOO) {

		Name (_CRS, ResourceTemplate () {

			GpioIo (Exclusive, ..., IoRestrictionOutputOnly,

				"\\_SB.GPI0") {15} // red

			GpioIo (Exclusive, ..., IoRestrictionOutputOnly,

				"\\_SB.GPI0") {16} // green

			GpioIo (Exclusive, ..., IoRestrictionOutputOnly,

				"\\_SB.GPI0") {17} // blue

			GpioIo (Exclusive, ..., IoRestrictionOutputOnly,

				"\\_SB.GPI0") {1} // power

			GpioIo (Exclusive, PullUp, 0, 0, IoRestrictionOutputOnly,

				"\\_SB.GPI0", 0, ResourceConsumer) { 15 } // red

			GpioIo (Exclusive, PullUp, 0, 0, IoRestrictionOutputOnly,

				"\\_SB.GPI0", 0, ResourceConsumer) { 16 } // green

			GpioIo (Exclusive, PullUp, 0, 0, IoRestrictionOutputOnly,

				"\\_SB.GPI0", 0, ResourceConsumer) { 17 } // blue

			GpioIo (Exclusive, PullNone, 0, 0, IoRestrictionOutputOnly,

				"\\_SB.GPI0", 0, ResourceConsumer) { 1 } // power

		})



		Name (_DSD, Package () {
@@ -92,10 +92,7 @@ with the help of _DSD (Device Specific Data), introduced in ACPI 5.1:: 
						^FOO, 2, 0, 1,

					}

				},

				Package () {

					"power-gpios",

					Package () {^FOO, 3, 0, 0},

				},

				Package () { "power-gpios", Package () { ^FOO, 3, 0, 0 } },

			}

		})

	}

Documentation/firmware-guide/acpi/enumeration.rst

+5 −17
Original line number Diff line number Diff line
@@ -295,26 +295,13 @@ For example:: 
		{

			Name (SBUF, ResourceTemplate()

			{

				...

				// Used to power on/off the device

				GpioIo (Exclusive, PullDefault, 0x0000, 0x0000,

					IoRestrictionOutputOnly, "\\_SB.PCI0.GPI0",

					0x00, ResourceConsumer,,)

				{

					// Pin List

					0x0055

				}

				GpioIo (Exclusive, PullNone, 0, 0, IoRestrictionOutputOnly,

					"\\_SB.PCI0.GPI0", 0, ResourceConsumer) { 85 }



				// Interrupt for the device

				GpioInt (Edge, ActiveHigh, ExclusiveAndWake, PullNone,

					0x0000, "\\_SB.PCI0.GPI0", 0x00, ResourceConsumer,,)

				{

					// Pin list

					0x0058

				}



				...



				GpioInt (Edge, ActiveHigh, ExclusiveAndWake, PullNone, 0,

					 "\\_SB.PCI0.GPI0", 0, ResourceConsumer) { 88 }

			}



			Return (SBUF)
@@ -331,6 +318,7 @@ For example:: 
			}

		})

		...

	}



These GPIO numbers are controller relative and path "\\_SB.PCI0.GPI0"

specifies the path to the controller. In order to use these GPIOs in Linux

Documentation/firmware-guide/acpi/gpio-properties.rst

+14 −12
Original line number Diff line number Diff line
@@ -275,6 +275,8 @@ have a device like below:: 
The driver might expect to get the right GPIO when it does::



  desc = gpiod_get(dev, "reset", GPIOD_OUT_LOW);

  if (IS_ERR(desc))

	...error handling...



but since there is no way to know the mapping between "reset" and

the GpioIo() in _CRS desc will hold ERR_PTR(-ENOENT).