doc: add documentation on usage of PCI support #5404

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 83.17%. Comparing base (4ee4c68) to head (45d5b6c).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files

@@ Coverage Diff @@
## main #5404 +/- ##
==========================================
+ Coverage 83.12% 83.17% +0.04% 
==========================================
 Files 266 266 
 Lines 30527 30533 +6 
==========================================
+ Hits 25377 25397 +20 
+ Misses 5150 5136 -14

Flag	Coverage Δ
5.10-c5n.metal	`83.23% <100.00%> (+<0.01%)`	⬆️
5.10-m5n.metal	`83.23% <100.00%> (+<0.01%)`	⬆️
5.10-m6a.metal	`82.54% <100.00%> (-0.01%)`	⬇️
5.10-m6g.metal	`79.87% <100.00%> (+<0.01%)`	⬆️
5.10-m6i.metal	`83.23% <100.00%> (+<0.01%)`	⬆️
5.10-m7a.metal-48xl	`82.53% <100.00%> (?)`
5.10-m7g.metal	`79.87% <100.00%> (+<0.01%)`	⬆️
5.10-m7i.metal-24xl	`83.20% <100.00%> (?)`
5.10-m7i.metal-48xl	`83.20% <100.00%> (?)`
5.10-m8g.metal-24xl	`79.87% <100.00%> (?)`
5.10-m8g.metal-48xl	`79.87% <100.00%> (?)`
6.1-c5n.metal	`83.27% <100.00%> (+<0.01%)`	⬆️
6.1-m5n.metal	`83.28% <100.00%> (+<0.01%)`	⬆️
6.1-m6a.metal	`82.59% <100.00%> (+0.01%)`	⬆️
6.1-m6g.metal	`79.87% <100.00%> (+<0.01%)`	⬆️
6.1-m6i.metal	`83.27% <100.00%> (+<0.01%)`	⬆️
6.1-m7a.metal-48xl	`82.57% <100.00%> (?)`
6.1-m7g.metal	`79.87% <100.00%> (+<0.01%)`	⬆️
6.1-m7i.metal-24xl	`83.28% <100.00%> (?)`
6.1-m7i.metal-48xl	`83.29% <100.00%> (?)`
6.1-m8g.metal-24xl	`79.87% <100.00%> (?)`
6.1-m8g.metal-48xl	`79.87% <100.00%> (?)`

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@bchalios bchalios force-pushed the pci_docs branch from bcdfcc5 to b052ae4 Compare

August 26, 2025 06:12

ShadowCurse

ShadowCurse reviewed

Aug 26, 2025

View reviewed changes

docs/kernel-policy.md Show resolved Hide resolved

docs/kernel-policy.md Outdated Show resolved Hide resolved

@bchalios bchalios force-pushed the pci_docs branch 3 times, most recently from f530744 to 5840825 Compare

August 26, 2025 09:44

bchalios added 2 commits

August 26, 2025 11:48

@bchalios


 doc: add documentation on usage of PCI support

aa6a11a

Add information in our Documentation regarding how users can enable PCI
support for Firecracker microVMs and mention requirements for building
the guest kernel, as well as the requirements for kernel command line
parameters.
Also, add an entry in the CHANGELOG mentioning the addition of PCI
support.
Signed-off-by: Babis Chalios <bchalios@amazon.es>

@bchalios


 pci: document potential contention on PCI bus lock

45d5b6c

We have a single lock for all devices on the PCI bus that serializes
reads and writes on the devices' PCI configuration space and BARs.
This should not be a problem at the moment. It should be out of any hot
path and only up until we are setting up devices. However, add a comment
that mentions the existence of the contention so that we keep it in mind
for the futuer (and maybe perform some profiling).
Signed-off-by: Babis Chalios <bchalios@amazon.es>