include/device: add a comment to pci mmio cfg addr helpers and caching

Add a comment to the newly introduced MMIO address helpers for PCI
config registers, that the pointer returned may change during the boot
processs and, thus, must not be cached.

Change-Id: Ieb90ae9d67a3b944d35587dec54756a17c27c86f
Signed-off-by: Michael Niewöhner <foss@mniewoehner.de>
Reviewed-on: https://review.coreboot.org/c/coreboot/+/36875
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Aaron Durbin <adurbin@chromium.org>
This commit is contained in:
Michael Niewöhner 2019-11-15 22:47:33 +01:00 committed by Patrick Georgi
parent 1248731991
commit efe3cfb476
1 changed files with 6 additions and 0 deletions

View File

@ -86,6 +86,12 @@ void pci_mmio_write_config32(pci_devfn_t dev, uint16_t reg, uint32_t value)
pcicfg(dev)->reg32[reg / sizeof(uint32_t)] = value;
}
/*
* The functions pci_mmio_config*_addr provide a way to determine the MMIO address of a PCI
* config register. The address returned is dependent of both the MMCONF base address and the
* assigned PCI bus number of the requested device, which both can change during the boot
* process. Thus, the pointer returned here must not be cached!
*/
static __always_inline
uint8_t *pci_mmio_config8_addr(pci_devfn_t dev, uint16_t reg)
{