diff options
| author | Changbin Du <changbin.du@gmail.com> | 2019-04-24 13:52:54 -0400 |
|---|---|---|
| committer | Rafael J. Wysocki <rafael.j.wysocki@intel.com> | 2019-04-25 17:07:20 -0400 |
| commit | 572c9fa516f532d6cfd7123d7753fe52730f1c59 (patch) | |
| tree | 905366cf7b7dfc5b643cb272f1aaf621de4e5fa4 | |
| parent | 34bf473baef086ec0e277ffb0dbddb697da9f02e (diff) | |
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: Changbin Du <changbin.du@gmail.com>
Reviewed-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
| -rw-r--r-- | Documentation/acpi/i2c-muxes.txt | 58 | ||||
| -rw-r--r-- | Documentation/firmware-guide/acpi/i2c-muxes.rst | 61 | ||||
| -rw-r--r-- | Documentation/firmware-guide/acpi/index.rst | 3 |
3 files changed, 63 insertions, 59 deletions
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 @@ | |||
| 1 | ACPI I2C Muxes | ||
| 2 | -------------- | ||
| 3 | |||
| 4 | Describing an I2C device hierarchy that includes I2C muxes requires an ACPI | ||
| 5 | Device () scope per mux channel. | ||
| 6 | |||
| 7 | Consider this topology: | ||
| 8 | |||
| 9 | +------+ +------+ | ||
| 10 | | SMB1 |-->| MUX0 |--CH00--> i2c client A (0x50) | ||
| 11 | | | | 0x70 |--CH01--> i2c client B (0x50) | ||
| 12 | +------+ +------+ | ||
| 13 | |||
| 14 | which corresponds to the following ASL: | ||
| 15 | |||
| 16 | Device (SMB1) | ||
| 17 | { | ||
| 18 | Name (_HID, ...) | ||
| 19 | Device (MUX0) | ||
| 20 | { | ||
| 21 | Name (_HID, ...) | ||
| 22 | Name (_CRS, ResourceTemplate () { | ||
| 23 | I2cSerialBus (0x70, ControllerInitiated, I2C_SPEED, | ||
| 24 | AddressingMode7Bit, "^SMB1", 0x00, | ||
| 25 | ResourceConsumer,,) | ||
| 26 | } | ||
| 27 | |||
| 28 | Device (CH00) | ||
| 29 | { | ||
| 30 | Name (_ADR, 0) | ||
| 31 | |||
| 32 | Device (CLIA) | ||
| 33 | { | ||
| 34 | Name (_HID, ...) | ||
| 35 | Name (_CRS, ResourceTemplate () { | ||
| 36 | I2cSerialBus (0x50, ControllerInitiated, I2C_SPEED, | ||
| 37 | AddressingMode7Bit, "^CH00", 0x00, | ||
| 38 | ResourceConsumer,,) | ||
| 39 | } | ||
| 40 | } | ||
| 41 | } | ||
| 42 | |||
| 43 | Device (CH01) | ||
| 44 | { | ||
| 45 | Name (_ADR, 1) | ||
| 46 | |||
| 47 | Device (CLIB) | ||
| 48 | { | ||
| 49 | Name (_HID, ...) | ||
| 50 | Name (_CRS, ResourceTemplate () { | ||
| 51 | I2cSerialBus (0x50, ControllerInitiated, I2C_SPEED, | ||
| 52 | AddressingMode7Bit, "^CH01", 0x00, | ||
| 53 | ResourceConsumer,,) | ||
| 54 | } | ||
| 55 | } | ||
| 56 | } | ||
| 57 | } | ||
| 58 | } | ||
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 @@ | |||
| 1 | .. SPDX-License-Identifier: GPL-2.0 | ||
| 2 | |||
| 3 | ============== | ||
| 4 | ACPI I2C Muxes | ||
| 5 | ============== | ||
| 6 | |||
| 7 | Describing an I2C device hierarchy that includes I2C muxes requires an ACPI | ||
| 8 | Device () scope per mux channel. | ||
| 9 | |||
| 10 | Consider this topology:: | ||
| 11 | |||
| 12 | +------+ +------+ | ||
| 13 | | SMB1 |-->| MUX0 |--CH00--> i2c client A (0x50) | ||
| 14 | | | | 0x70 |--CH01--> i2c client B (0x50) | ||
| 15 | +------+ +------+ | ||
| 16 | |||
| 17 | which corresponds to the following ASL:: | ||
| 18 | |||
| 19 | Device (SMB1) | ||
| 20 | { | ||
| 21 | Name (_HID, ...) | ||
| 22 | Device (MUX0) | ||
| 23 | { | ||
| 24 | Name (_HID, ...) | ||
| 25 | Name (_CRS, ResourceTemplate () { | ||
| 26 | I2cSerialBus (0x70, ControllerInitiated, I2C_SPEED, | ||
| 27 | AddressingMode7Bit, "^SMB1", 0x00, | ||
| 28 | ResourceConsumer,,) | ||
| 29 | } | ||
| 30 | |||
| 31 | Device (CH00) | ||
| 32 | { | ||
| 33 | Name (_ADR, 0) | ||
| 34 | |||
| 35 | Device (CLIA) | ||
| 36 | { | ||
| 37 | Name (_HID, ...) | ||
| 38 | Name (_CRS, ResourceTemplate () { | ||
| 39 | I2cSerialBus (0x50, ControllerInitiated, I2C_SPEED, | ||
| 40 | AddressingMode7Bit, "^CH00", 0x00, | ||
| 41 | ResourceConsumer,,) | ||
| 42 | } | ||
| 43 | } | ||
| 44 | } | ||
| 45 | |||
| 46 | Device (CH01) | ||
| 47 | { | ||
| 48 | Name (_ADR, 1) | ||
| 49 | |||
| 50 | Device (CLIB) | ||
| 51 | { | ||
| 52 | Name (_HID, ...) | ||
| 53 | Name (_CRS, ResourceTemplate () { | ||
| 54 | I2cSerialBus (0x50, ControllerInitiated, I2C_SPEED, | ||
| 55 | AddressingMode7Bit, "^CH01", 0x00, | ||
| 56 | ResourceConsumer,,) | ||
| 57 | } | ||
| 58 | } | ||
| 59 | } | ||
| 60 | } | ||
| 61 | } | ||
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 | |||
| 12 | osi | 12 | osi |
| 13 | method-customizing | 13 | method-customizing |
| 14 | DSD-properties-rules | 14 | DSD-properties-rules |
| 15 | gpio-properties \ No newline at end of file | 15 | gpio-properties |
| 16 | i2c-muxes | ||
