PCI: Document connection between pci_power_t and hardware PM capability
authorBjorn Helgaas <bhelgaas@google.com>
Fri, 17 Jun 2016 20:23:52 +0000 (15:23 -0500)
committerBjorn Helgaas <bhelgaas@google.com>
Fri, 17 Jun 2016 20:23:52 +0000 (15:23 -0500)
commit224abb67e6eb5ac062de9239163136d5ec3155c8
tree61f5eecdc5499304d8d867acc6491d92d454b038
parent006d44e49a259b39947366728d65a873a19aadc0
PCI: Document connection between pci_power_t and hardware PM capability

The dev.pme_support field, pci_pm_init(), pci_pme_capable(), and
pci_raw_set_power_state() depend on the fact that the pci_power_t values
(PCI_D0, PCI_D1, etc.) match the definition of the Capabilities PME_Support
and the Control/Status PowerState fields in the Power Management capability
(see PCI Bus Power Management spec r1.2, sec 3.2.3).

Add a note to this effect at the pci_power_t typedef.

Signed-off-by: Bjorn Helgaas <bhelgaas@google.com>
Reviewed-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Reviewed-by: Mika Westerberg <mika.westerberg@linux.intel.com>
include/linux/pci.h