From 438c459ca53cb044ceba69773a74eb84c547a19a Mon Sep 17 00:00:00 2001
From: Jeremy Soller <jackpot51@gmail.com>
Date: Fri, 11 Nov 2022 14:52:57 -0700
Subject: [PATCH] Add hardware compatibility

---
 HARDWARE.md | 124 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 README.md   |   2 +-
 2 files changed, 125 insertions(+), 1 deletion(-)
 create mode 100644 HARDWARE.md

diff --git a/HARDWARE.md b/HARDWARE.md
new file mode 100644
index 0000000..d1a8056
--- /dev/null
+++ b/HARDWARE.md
@@ -0,0 +1,124 @@
+# Redox 0.8.0 Hardware Compatibility
+
+Updated on November 11, 2022 in preparation for the 0.8.0 release. Systems are
+rated on a scale of 🚫 Broken, ⚠️ Booting, and ✅ Recommended. Broken means the
+system cannot boot to a desktop, booting means the system boots to a desktop
+but has issues, and recommended means the system provides all implemented
+features.
+
+## General
+
+Due to incomplete USB support, desktops are generally not recommended.
+
+- Sound support is incomplete and disabled by default
+- USB support is incomplete
+- Wireless networking is not supported
+
+## x86_64
+
+Test performed using https://static.redox-os.org/img/x86_64/redox_desktop_x86_64_2022-11-11_629_livedisk.iso
+
+### Lenovo IdeaPad Y510P
+
+Status: ✅ Recommended
+
+- Booted using both BIOS and UEFI
+- Boots to desktop
+
+### System76 Galago Pro (galp5)
+
+Status: ✅ Recommended
+
+- Booted using UEFI
+- Boots to desktop
+
+### System76 Lemur Pro (lemp9)
+
+Status: ✅ Recommended
+
+- Booted using UEFI
+- Boots to desktop
+
+### Dell XPS 13 (9350)
+
+Status: ⚠️ Booting
+
+- Booted using both BIOS and UEFI
+- Boots to desktop
+- NVMe driver livelocks
+
+### HP Dev One
+
+Status: ⚠️ Booting
+
+- Booted using UEFI
+- Boots to desktop
+- No touchpad support, requires I2C HID
+
+### System76 Oryx Pro (oryp10)
+
+Status: ⚠️ Booting
+
+- Booted using UEFI
+- Boots to desktop
+- No touchpad support, though it should be working
+
+### System76 Pangolin (pang12)
+
+Status: ⚠️ Booting
+
+- Booted using UEFI
+- Boots to desktop
+- No touchpad support, requires I2C HID
+
+### Toshiba Satellite L500
+
+Status: ⚠️ Booting
+
+- Booted using BIOS
+- Correct video mode not offered, this is a firmware issue
+- Boots to desktop
+- No ethernet driver
+
+## i686
+
+Test performed using https://static.redox-os.org/img/i686/redox_desktop_i686_2022-11-11_629_livedisk.iso
+
+### Asus Eee PC 900
+
+Status: ⚠️ Booting
+
+- Booted using BIOS
+- Correct video mode not offered, this is a firmware issue
+- Boots to desktop
+- No ethernet driver
+
+### Dell XPS 13 (9350)
+
+Status: ⚠️ Booting
+
+- Booted using BIOS
+- Boots to desktop
+- NVMe driver livelocks
+
+### Lenovo IdeaPad Y510P
+
+Status: 🚫 Broken
+
+- Booted using BIOS
+- Panics on phys_to_virt overflow, probably having invalid mappings for 32-bit
+
+### Panasonic Toughbook CF-18
+
+Status: 🚫 Broken
+
+- Booted using BIOS
+- Hangs after PIT initialization
+
+### Toshiba Satellite L500
+
+Status: 🚫 Broken
+
+- Booted using BIOS
+- Correct video mode not offered, this is a firmware issue
+- Panics on phys_to_virt overflow, probably having invalid mappings for 32-bit
diff --git a/README.md b/README.md
index 058a30d..8d8c92c 100644
--- a/README.md
+++ b/README.md
@@ -6,7 +6,7 @@
 
 Redox _is not_ just a kernel, it's a **full-featured Operating System**, providing packages (memory allocator, file system, display manager, core utilities, etc.) that together make up a functional and convenient operating system. You can loosely think of it as the GNU or BSD ecosystem, but in a memory safe language and with modern technology. See [this list](#ecosystem) for overview of the ecosystem.
 
-The website can be found at https://www.redox-os.org.
+The website can be found at https://www.redox-os.org. For hardware compatibility, see [HARDWARE.md](HARDWARE.md).
 
 Please make sure you use the **latest nightly** of `rustc` before building (for more troubleshooting, see ["Help! Redox won't compile!"](#compile-help)).