diff mbox series

[v4,12/63] Documentation: ACPI: move i2c-muxes.txt to firmware-guide/acpi and convert to reST

Message ID 20190423162932.21428-13-changbin.du@gmail.com (mailing list archive)
State New, archived
Delegated to: Bjorn Helgaas
Headers show
Series Include linux ACPI/PCI/X86 docs into Sphinx TOC tree | expand

Commit Message

Changbin Du April 23, 2019, 4:28 p.m. UTC 
This converts the plain text documentation to reStructuredText format and
add it to Sphinx TOC tree. No essential content change.

Signed-off-by: Changbin Du <changbin.du@gmail.com>
---
 Documentation/acpi/i2c-muxes.txt              | 58 ------------------
 .../firmware-guide/acpi/i2c-muxes.rst         | 61 +++++++++++++++++++
 Documentation/firmware-guide/acpi/index.rst   |  3 +-
 3 files changed, 63 insertions(+), 59 deletions(-)
 delete mode 100644 Documentation/acpi/i2c-muxes.txt
 create mode 100644 Documentation/firmware-guide/acpi/i2c-muxes.rst

Comments

Mauro Carvalho Chehab April 23, 2019, 9:09 p.m. UTC | #1 
Em Wed, 24 Apr 2019 00:28:41 +0800
Changbin Du <changbin.du@gmail.com> escreveu:

> This converts the plain text documentation to reStructuredText format and
> add it to Sphinx TOC tree. No essential content change.
> 
> Signed-off-by: Changbin Du <changbin.du@gmail.com>

For the conversion itself:

Reviewed-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>

> ---
>  Documentation/acpi/i2c-muxes.txt              | 58 ------------------
>  .../firmware-guide/acpi/i2c-muxes.rst         | 61 +++++++++++++++++++
>  Documentation/firmware-guide/acpi/index.rst   |  3 +-
>  3 files changed, 63 insertions(+), 59 deletions(-)
>  delete mode 100644 Documentation/acpi/i2c-muxes.txt
>  create mode 100644 Documentation/firmware-guide/acpi/i2c-muxes.rst
> 
> diff --git a/Documentation/acpi/i2c-muxes.txt b/Documentation/acpi/i2c-muxes.txt
> deleted file mode 100644
> index 9fcc4f0b885e..000000000000
> --- a/Documentation/acpi/i2c-muxes.txt
> +++ /dev/null
> @@ -1,58 +0,0 @@
> -ACPI I2C Muxes
> ---------------
> -
> -Describing an I2C device hierarchy that includes I2C muxes requires an ACPI
> -Device () scope per mux channel.
> -
> -Consider this topology:
> -
> -+------+   +------+
> -| SMB1 |-->| MUX0 |--CH00--> i2c client A (0x50)
> -|      |   | 0x70 |--CH01--> i2c client B (0x50)
> -+------+   +------+
> -
> -which corresponds to the following ASL:
> -
> -Device (SMB1)
> -{
> -    Name (_HID, ...)
> -    Device (MUX0)
> -    {
> -        Name (_HID, ...)
> -        Name (_CRS, ResourceTemplate () {
> -            I2cSerialBus (0x70, ControllerInitiated, I2C_SPEED,
> -                          AddressingMode7Bit, "^SMB1", 0x00,
> -                          ResourceConsumer,,)
> -        }
> -
> -        Device (CH00)
> -        {
> -            Name (_ADR, 0)
> -
> -            Device (CLIA)
> -            {
> -                Name (_HID, ...)
> -                Name (_CRS, ResourceTemplate () {
> -                    I2cSerialBus (0x50, ControllerInitiated, I2C_SPEED,
> -                                  AddressingMode7Bit, "^CH00", 0x00,
> -                                  ResourceConsumer,,)
> -                }
> -            }
> -        }
> -
> -        Device (CH01)
> -        {
> -            Name (_ADR, 1)
> -
> -            Device (CLIB)
> -            {
> -                Name (_HID, ...)
> -                Name (_CRS, ResourceTemplate () {
> -                    I2cSerialBus (0x50, ControllerInitiated, I2C_SPEED,
> -                                  AddressingMode7Bit, "^CH01", 0x00,
> -                                  ResourceConsumer,,)
> -                }
> -            }
> -        }
> -    }
> -}
> diff --git a/Documentation/firmware-guide/acpi/i2c-muxes.rst b/Documentation/firmware-guide/acpi/i2c-muxes.rst
> new file mode 100644
> index 000000000000..3a8997ccd7c4
> --- /dev/null
> +++ b/Documentation/firmware-guide/acpi/i2c-muxes.rst
> @@ -0,0 +1,61 @@
> +.. SPDX-License-Identifier: GPL-2.0
> +
> +==============
> +ACPI I2C Muxes
> +==============
> +
> +Describing an I2C device hierarchy that includes I2C muxes requires an ACPI
> +Device () scope per mux channel.
> +
> +Consider this topology::
> +
> +    +------+   +------+
> +    | SMB1 |-->| MUX0 |--CH00--> i2c client A (0x50)
> +    |      |   | 0x70 |--CH01--> i2c client B (0x50)
> +    +------+   +------+
> +
> +which corresponds to the following ASL::
> +
> +    Device (SMB1)
> +    {
> +        Name (_HID, ...)
> +        Device (MUX0)
> +        {
> +            Name (_HID, ...)
> +            Name (_CRS, ResourceTemplate () {
> +                I2cSerialBus (0x70, ControllerInitiated, I2C_SPEED,
> +                            AddressingMode7Bit, "^SMB1", 0x00,
> +                            ResourceConsumer,,)
> +            }
> +
> +            Device (CH00)
> +            {
> +                Name (_ADR, 0)
> +
> +                Device (CLIA)
> +                {
> +                    Name (_HID, ...)
> +                    Name (_CRS, ResourceTemplate () {
> +                        I2cSerialBus (0x50, ControllerInitiated, I2C_SPEED,
> +                                    AddressingMode7Bit, "^CH00", 0x00,
> +                                    ResourceConsumer,,)
> +                    }
> +                }
> +            }
> +
> +            Device (CH01)
> +            {
> +                Name (_ADR, 1)
> +
> +                Device (CLIB)
> +                {
> +                    Name (_HID, ...)
> +                    Name (_CRS, ResourceTemplate () {
> +                        I2cSerialBus (0x50, ControllerInitiated, I2C_SPEED,
> +                                    AddressingMode7Bit, "^CH01", 0x00,
> +                                    ResourceConsumer,,)
> +                    }
> +                }
> +            }
> +        }
> +    }
> diff --git a/Documentation/firmware-guide/acpi/index.rst b/Documentation/firmware-guide/acpi/index.rst
> index d1d069b26bbc..1c89888f6ee8 100644
> --- a/Documentation/firmware-guide/acpi/index.rst
> +++ b/Documentation/firmware-guide/acpi/index.rst
> @@ -12,4 +12,5 @@ ACPI Support
>     osi
>     method-customizing
>     DSD-properties-rules
> -   gpio-properties
> \ No newline at end of file
> +   gpio-properties
> +   i2c-muxes



Thanks,
Mauro
diff mbox series

Patch

diff --git a/Documentation/acpi/i2c-muxes.txt b/Documentation/acpi/i2c-muxes.txt
deleted file mode 100644
index 9fcc4f0b885e..000000000000
--- a/Documentation/acpi/i2c-muxes.txt
+++ /dev/null
@@ -1,58 +0,0 @@ 
-ACPI I2C Muxes
---------------
-
-Describing an I2C device hierarchy that includes I2C muxes requires an ACPI
-Device () scope per mux channel.
-
-Consider this topology:
-
-+------+   +------+
-| SMB1 |-->| MUX0 |--CH00--> i2c client A (0x50)
-|      |   | 0x70 |--CH01--> i2c client B (0x50)
-+------+   +------+
-
-which corresponds to the following ASL:
-
-Device (SMB1)
-{
-    Name (_HID, ...)
-    Device (MUX0)
-    {
-        Name (_HID, ...)
-        Name (_CRS, ResourceTemplate () {
-            I2cSerialBus (0x70, ControllerInitiated, I2C_SPEED,
-                          AddressingMode7Bit, "^SMB1", 0x00,
-                          ResourceConsumer,,)
-        }
-
-        Device (CH00)
-        {
-            Name (_ADR, 0)
-
-            Device (CLIA)
-            {
-                Name (_HID, ...)
-                Name (_CRS, ResourceTemplate () {
-                    I2cSerialBus (0x50, ControllerInitiated, I2C_SPEED,
-                                  AddressingMode7Bit, "^CH00", 0x00,
-                                  ResourceConsumer,,)
-                }
-            }
-        }
-
-        Device (CH01)
-        {
-            Name (_ADR, 1)
-
-            Device (CLIB)
-            {
-                Name (_HID, ...)
-                Name (_CRS, ResourceTemplate () {
-                    I2cSerialBus (0x50, ControllerInitiated, I2C_SPEED,
-                                  AddressingMode7Bit, "^CH01", 0x00,
-                                  ResourceConsumer,,)
-                }
-            }
-        }
-    }
-}
diff --git a/Documentation/firmware-guide/acpi/i2c-muxes.rst b/Documentation/firmware-guide/acpi/i2c-muxes.rst
new file mode 100644
index 000000000000..3a8997ccd7c4
--- /dev/null
+++ b/Documentation/firmware-guide/acpi/i2c-muxes.rst
@@ -0,0 +1,61 @@ 
+.. SPDX-License-Identifier: GPL-2.0
+
+==============
+ACPI I2C Muxes
+==============
+
+Describing an I2C device hierarchy that includes I2C muxes requires an ACPI
+Device () scope per mux channel.
+
+Consider this topology::
+
+    +------+   +------+
+    | SMB1 |-->| MUX0 |--CH00--> i2c client A (0x50)
+    |      |   | 0x70 |--CH01--> i2c client B (0x50)
+    +------+   +------+
+
+which corresponds to the following ASL::
+
+    Device (SMB1)
+    {
+        Name (_HID, ...)
+        Device (MUX0)
+        {
+            Name (_HID, ...)
+            Name (_CRS, ResourceTemplate () {
+                I2cSerialBus (0x70, ControllerInitiated, I2C_SPEED,
+                            AddressingMode7Bit, "^SMB1", 0x00,
+                            ResourceConsumer,,)
+            }
+
+            Device (CH00)
+            {
+                Name (_ADR, 0)
+
+                Device (CLIA)
+                {
+                    Name (_HID, ...)
+                    Name (_CRS, ResourceTemplate () {
+                        I2cSerialBus (0x50, ControllerInitiated, I2C_SPEED,
+                                    AddressingMode7Bit, "^CH00", 0x00,
+                                    ResourceConsumer,,)
+                    }
+                }
+            }
+
+            Device (CH01)
+            {
+                Name (_ADR, 1)
+
+                Device (CLIB)
+                {
+                    Name (_HID, ...)
+                    Name (_CRS, ResourceTemplate () {
+                        I2cSerialBus (0x50, ControllerInitiated, I2C_SPEED,
+                                    AddressingMode7Bit, "^CH01", 0x00,
+                                    ResourceConsumer,,)
+                    }
+                }
+            }
+        }
+    }
diff --git a/Documentation/firmware-guide/acpi/index.rst b/Documentation/firmware-guide/acpi/index.rst
index d1d069b26bbc..1c89888f6ee8 100644
--- a/Documentation/firmware-guide/acpi/index.rst
+++ b/Documentation/firmware-guide/acpi/index.rst
@@ -12,4 +12,5 @@  ACPI Support
    osi
    method-customizing
    DSD-properties-rules
-   gpio-properties
\ No newline at end of file
+   gpio-properties
+   i2c-muxes