docs: Fix broken link to intel 0x80 debug port

Previous link to provide details of `0x80 debug port` is removed, which
could no longer be found on intel site [1]. Use snapshot found in web
archive [2] to fix this link.

Format `debug-port.md` using `mdformat` with GitHub Flavored Markdown
(GFM).

[1] https://www.intel.com/content/www/us/en/homepage.html
[2] https://web.archive.org

Signed-off-by: Ruoqing He <heruoqing@iscas.ac.cn>
This commit is contained in:
Ruoqing He
2025-02-08 15:59:29 +08:00
parent 1caa69d0cc
commit 730cf1e944
2 changed files with 16 additions and 15 deletions

View File

@@ -1,7 +1,8 @@
# `cloud-hypervisor` debug IO ports # `cloud-hypervisor` debug IO ports
When running x86 guests, `cloud-hypervisor` provides different kinds of debug ports: When running x86 guests, `cloud-hypervisor` provides different kinds of debug ports:
- [`0x80` debug port](https://www.intel.com/content/www/us/en/support/articles/000005500/boards-and-kits.html)
- [`0x80` debug port](https://web.archive.org/web/20211028033025/https://www.intel.com/content/www/us/en/support/articles/000005500/boards-and-kits.html)
- Debug console (by default at `0xe9`). - Debug console (by default at `0xe9`).
- Firmware debug port at `0x402`. - Firmware debug port at `0x402`.
@@ -25,13 +26,13 @@ for debugging specific components of the guest software stack. When logging a
write of one of those codes to the debug port, `cloud-hypervisor` adds a write of one of those codes to the debug port, `cloud-hypervisor` adds a
pre-defined string to the logs. pre-defined string to the logs.
| Code Range | Component | Log string | | Code Range | Component | Log string |
| ---------------- | ----------- | ------------ | | ---------------- | ---------- | ------------ |
| `0x00` to `0x1f` | Firmware | `Firmware` | | `0x00` to `0x1f` | Firmware | `Firmware` |
| `0x20` to `0x3f` | Bootloader | `Bootloader` | | `0x20` to `0x3f` | Bootloader | `Bootloader` |
| `0x40` to `0x5f` | Kernel | `Kernel` | | `0x40` to `0x5f` | Kernel | `Kernel` |
| `0x60` to `0x7f` | Userspace | `Userspace` | | `0x60` to `0x7f` | Userspace | `Userspace` |
| `0x80` to `0xff` | Custom | `Custom` | | `0x80` to `0xff` | Custom | `Custom` |
One typical use case is guest boot time measurement and tracing. By writing One typical use case is guest boot time measurement and tracing. By writing
different values to the debug I/O port at different boot process steps, the different values to the debug I/O port at different boot process steps, the

View File

@@ -3216,7 +3216,7 @@ enabled by default.
Based on the Firecracker idea of using a dedicated I/O port to measure guest Based on the Firecracker idea of using a dedicated I/O port to measure guest
boot times, we added support for logging guest events through the boot times, we added support for logging guest events through the
[0x80](https://www.intel.com/content/www/us/en/support/articles/000005500/boards-and-kits.html) [0x80](https://web.archive.org/web/20211028033025/https://www.intel.com/content/www/us/en/support/articles/000005500/boards-and-kits.html)
PC debug port. This allows, among other things, for granular guest boot time PC debug port. This allows, among other things, for granular guest boot time
measurements. See our [debug port documentation](docs/debug-port.md) for more measurements. See our [debug port documentation](docs/debug-port.md) for more
details. details.