qubes-doc/user/hardware/how-to-use-the-hcl.md

---
lang: en
layout: doc
permalink: /doc/how-to-use-the-hcl/
ref: 146
title: How to use the hardware compatibility list (HCL)
---

The [HCL](/hcl) is a compilation of reports generated and submitted by users across various Qubes versions about their hardware's compatibility with Qubes.

 **Note:**
 Except in the case of developer-reported entries, the Qubes team has not independently verified the accuracy of these reports.
 Please first consult the data sheets (CPU, chipset, motherboard) prior to buying new hardware for Qubes.
 Make sure it meets the [System Requirements](/doc/system-requirements/) and search in particular for support of:

-   HVM ("AMD virtualization (AMD-V)", "Intel virtualization (VT-x)", "VIA virtualization (VIA VT)")
-   IOMMU ("AMD I/O Virtualization Technology (AMD-Vi)", "Intel Virtualization Technology for Directed I/O (VT-d)")
-   TPM ("Trusted Platform Module (TPM)" connected to a "20-pin TPM header" on motherboards.)

If using the list to make a purchasing decision, we recommend that you choose hardware with:

-   the best achievable Qubes security level (green columns in HVM, IOMMU, TPM)
-   and general machine compatibility (green columns in Qubes version, dom0 kernel, remarks).

Also see [Certified Hardware](/doc/certified-hardware/).

Generating and Submitting New Reports
-------------------------------------

In order to generate an HCL report in Qubes, simply open a terminal in dom0 (Applications Menu > Terminal Emulator) and run `qubes-hcl-report <qube-name>`, where `<qube-name>` is the name of the qube in which the generated HCL files will be saved.

You are encouraged to submit your HCL report for the benefit of further Qubes development and other users. When submitting reports, test the hardware yourself, if possible. If you would like to submit your HCL report, please copy and paste the contents of the **HCL Info** `.yml` file into an email to the [qubes-users mailing list](/support/#qubes-users) with the subject `HCL - <your machine model name>`, or create a post in the [HCL Reports category](https://forum.qubes-os.org/c/user-support/hcl-reports/23) of the forum. Pasting the contents into the email or post has the advantage that members of the mailing list and the forum can see the report without downloading and opening a file. In addition, new forum members are unable to attach files to posts.

Please include any useful information about any Qubes features you may have tested (see the legend below), as well as general machine compatibility (video, networking, sleep, etc.). Please consider sending the **HCL Support Files** `.cpio.gz` file as well. To generate these add the `-s` or `--support` command line option.

**Please note:**
 The **HCL Support Files** may contain numerous hardware details, including serial numbers. If, for privacy or security reasons, you do not wish to make this information public, please **do not** post the `.cpio.gz` file on a public mailing list or forum.
HCL changed Initial version 2012-05-02 06:44:45 -04:00			`---`
Add lang + ref tags to frontmatter Those are fields used by the language switcher to correlate pages across different languages, even if they have different names/paths/titles. They are generated with the prepare_for_translation.py script. 2021-03-13 13:06:18 -05:00			`lang: en`
wiki -> doc migration 2015-04-10 16:17:45 -04:00			`layout: doc`
Update title to distinguish from main HCL page Moving redirects to main HCL page in a separate commit. 2021-07-14 14:15:29 -04:00			`permalink: /doc/how-to-use-the-hcl/`
Add lang + ref tags to frontmatter Those are fields used by the language switcher to correlate pages across different languages, even if they have different names/paths/titles. They are generated with the prepare_for_translation.py script. 2021-03-13 13:06:18 -05:00			`ref: 146`
Update title to distinguish from main HCL page Moving redirects to main HCL page in a separate commit. 2021-07-14 14:15:29 -04:00			`title: How to use the hardware compatibility list (HCL)`
HCL changed Initial version 2012-05-02 06:44:45 -04:00			`---`

Small Edit to hcl.md * Expanded Introduction * Finished unfinished sentences * Moved some sentences 2017-04-19 14:09:28 -04:00			`The [HCL](/hcl) is a compilation of reports generated and submitted by users across various Qubes versions about their hardware's compatibility with Qubes.`

HCL changed minor changes and rearranging, splitting Apple BIOS Version string, TPM 2014-09-24 16:34:12 -04:00			`Note:`
			`Except in the case of developer-reported entries, the Qubes team has not independently verified the accuracy of these reports.`
			`Please first consult the data sheets (CPU, chipset, motherboard) prior to buying new hardware for Qubes.`
Small Edit to hcl.md * Expanded Introduction * Finished unfinished sentences * Moved some sentences 2017-04-19 14:09:28 -04:00			`Make sure it meets the [System Requirements](/doc/system-requirements/) and search in particular for support of:`
HCL changed minor changes and rearranging, splitting Apple BIOS Version string, TPM 2014-09-24 16:34:12 -04:00
			`- HVM ("AMD virtualization (AMD-V)", "Intel virtualization (VT-x)", "VIA virtualization (VIA VT)")`
			`- IOMMU ("AMD I/O Virtualization Technology (AMD-Vi)", "Intel Virtualization Technology for Directed I/O (VT-d)")`
			`- TPM ("Trusted Platform Module (TPM)" connected to a "20-pin TPM header" on motherboards.)`

Small Edit to hcl.md * Expanded Introduction * Finished unfinished sentences * Moved some sentences 2017-04-19 14:09:28 -04:00			`If using the list to make a purchasing decision, we recommend that you choose hardware with:`
HCL changed minor changes and rearranging, splitting Apple BIOS Version string, TPM 2014-09-24 16:34:12 -04:00
			`- the best achievable Qubes security level (green columns in HVM, IOMMU, TPM)`
			`- and general machine compatibility (green columns in Qubes version, dom0 kernel, remarks).`
HCL changed Link to the old HCL 2013-12-14 03:27:25 -05:00
Deprecate "Hardware testing" page Convert it into a redirect to the community-recommended hardware list on the Qubes Forum. File rename will be in subsequent commit to maintain history. See: https://forum.qubes-os.org/t/short-list-of-laptops-desktops-that-work-well-with-qubes-os/5197/159?u=adw 2021-09-04 01:03:10 -04:00			`Also see [Certified Hardware](/doc/certified-hardware/).`
Link to Hardware Testing and Certified Hardware pages 2019-08-01 22:11:27 -04:00
HCL changed preview: one table per relase: https://groups.google.com/d/msg/qubes-users/XgEMteF0MtA/k_WwoS7mVMcJ 2013-12-14 08:31:53 -05:00			`Generating and Submitting New Reports`
			`-------------------------------------`

Clean up text 2022-07-18 21:22:24 -04:00			In order to generate an HCL report in Qubes, simply open a terminal in dom0 (Applications Menu > Terminal Emulator) and run `qubes-hcl-report <qube-name>`, where `<qube-name>` is the name of the qube in which the generated HCL files will be saved.
remove KDE specifics; add paste request/rationale 2022-07-18 14:22:40 -04:00
Clean up text 2022-07-18 21:22:24 -04:00			You are encouraged to submit your HCL report for the benefit of further Qubes development and other users. When submitting reports, test the hardware yourself, if possible. If you would like to submit your HCL report, please copy and paste the contents of the HCL Info `.yml` file into an email to the [qubes-users mailing list](/support/#qubes-users) with the subject `HCL - <your machine model name>`, or create a post in the [HCL Reports category](https://forum.qubes-os.org/c/user-support/hcl-reports/23) of the forum. Pasting the contents into the email or post has the advantage that members of the mailing list and the forum can see the report without downloading and opening a file. In addition, new forum members are unable to attach files to posts.
remove KDE specifics; add paste request/rationale 2022-07-18 14:22:40 -04:00
			Please include any useful information about any Qubes features you may have tested (see the legend below), as well as general machine compatibility (video, networking, sleep, etc.). Please consider sending the HCL Support Files `.cpio.gz` file as well. To generate these add the `-s` or `--support` command line option.
HCL changed preview: one table per relase: https://groups.google.com/d/msg/qubes-users/XgEMteF0MtA/k_WwoS7mVMcJ 2013-12-14 08:31:53 -05:00
HCL changed updated Legend, inserted TPM/AEM column 2014-04-29 11:55:56 -04:00			`Please note:`
Clean up text 2022-07-18 21:22:24 -04:00			The HCL Support Files may contain numerous hardware details, including serial numbers. If, for privacy or security reasons, you do not wish to make this information public, please do not post the `.cpio.gz` file on a public mailing list or forum.