Commit 572c9fa5 authored by Changbin Du's avatar Changbin Du Committed by Rafael J. Wysocki
Browse files

Documentation: ACPI: move i2c-muxes.txt to firmware-guide/acpi and convert to reST 



This converts the plain text documentation to reStructuredText format
and adds it to Sphinx TOC tree.

No essential content change.

Signed-off-by: default avatarChangbin Du <changbin.du@gmail.com>
Reviewed-by: default avatarMauro Carvalho Chehab <mchehab+samsung@kernel.org>
Signed-off-by: default avatarRafael J. Wysocki <rafael.j.wysocki@intel.com>
parent 34bf473b

Documentation/acpi/i2c-muxes.txt

deleted100644 → 0
+0 −58
Original line number Diff line number Diff line 
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,,)

                }

            }

        }

    }

}

Documentation/firmware-guide/acpi/i2c-muxes.rst

0 → 100644
+61 −0
Original line number Diff line number Diff line 
.. 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,,)

                    }

                }

            }

        }

    }

Documentation/firmware-guide/acpi/index.rst

+2 −1
Original line number Diff line number Diff line
@@ -13,3 +13,4 @@ ACPI Support 
   method-customizing

   DSD-properties-rules

   gpio-properties

   i2c-muxes