Documentation: acpi: Add an example for PRP0001
authorThomas Preston <thomas.preston@codethink.co.uk>
Mon, 25 Mar 2019 16:53:38 +0000 (16:53 +0000)
committerRafael J. Wysocki <rafael.j.wysocki@intel.com>
Thu, 28 Mar 2019 09:30:00 +0000 (10:30 +0100)
Add an example for the magic PRP0001 device ID which allows matching
ACPI devices against drivers using OF Device Tree compatible property.

Signed-off-by: Thomas Preston <thomas.preston@codethink.co.uk>
Reviewed-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Acked-by: Mika Westerberg <mika.westerberg@linux.intel.com>
Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
Documentation/acpi/enumeration.txt

index 7bcf9c3..1395b84 100644 (file)
@@ -410,6 +410,32 @@ Specifically, the device IDs returned by _HID and preceding PRP0001 in the _CID
 return package will be checked first.  Also in that case the bus type the device
 will be enumerated to depends on the device ID returned by _HID.
 
+For example, the following ACPI sample might be used to enumerate an lm75-type
+I2C temperature sensor and match it to the driver using the Device Tree
+namespace link:
+
+       Device (TMP0)
+       {
+               Name (_HID, "PRP0001")
+               Name (_DSD, Package() {
+                       ToUUID("daffd814-6eba-4d8c-8a91-bc9bbf4aa301"),
+                       Package () {
+                               Package (2) { "compatible", "ti,tmp75" },
+                       }
+               })
+               Method (_CRS, 0, Serialized)
+               {
+                       Name (SBUF, ResourceTemplate ()
+                       {
+                               I2cSerialBusV2 (0x48, ControllerInitiated,
+                                       400000, AddressingMode7Bit,
+                                       "\\_SB.PCI0.I2C1", 0x00,
+                                       ResourceConsumer, , Exclusive,)
+                       })
+                       Return (SBUF)
+               }
+       }
+
 It is valid to define device objects with a _HID returning PRP0001 and without
 the "compatible" property in the _DSD or a _CID as long as one of their
 ancestors provides a _DSD with a valid "compatible" property.  Such device