硬件信息
在填写硬件信息之前
请根据硬件本身的类型确认分类,否则我们不会接受提交。
在将硬件兼容性信息上传到本仓库之前,请先确认硬件具体情况。
确认硬件情况后,复制模板文件 template_hardware.yml 到 /docs/data/hardwares 的指定的硬件类型中,模板文件也可以在此找到。
这是一份模板文件的内容:
model: #型号
brand: #品牌
type: #类型
status: #兼容状态 -1=不兼容 0=未知 1=兼容 2=有限兼容 3=新世界可用
notes: #备注
notes_en: #备注的英语版本(如果有)
link: #链接
link_en: #链接文档的英语版本(如果有)根据模板文件填写完毕后,请一定要修改文件名并根据硬件类型存放到指定的文件夹中,否则我们不会接受该提交,关于文件名规则需根据硬件类型,下文会对具体的文件命名进行解释。
以下值均需注意大小写
model
该值填写硬件具体型号,不同的硬件类型,该值也不相同,均不需要填写品牌信息,填写规则请按下表所示:
| 硬件类型 | 型号填写 |
|---|---|
| 内存(所有接口类型) | 型号位于内存条产品贴纸上的条形码处,根据厂商的不同一般位于容量电压时序信息的左侧或右侧,若内存条属于厂商的一个系列中,可以在型号前添加该系列的名称,例如 HyperX (有空格,需使用空格隔开)。 |
| 显卡 | 对外的公开硬件名称,例如 Radeon RX 580,若有不同流处理器版本需小括号说明,例如 Radeon RX 580 (2048SP)。docs/contribution/index.md |
| 有线网卡 | 对外的公开硬件名称,若为 PCIe 接口需在此标明 (PCIe),若为 USB 接口需在此标明 (USB)。 |
| 无线网卡 | 对外的公开硬件名称,若为 PCIe 接口需在此标明 (PCIe),若为 USB 接口需在此标明 (USB)。 |
| 固态硬盘(SATA) | 厂商对该硬件的对外宣传型号,例如 SC001 Active。 |
| 固态硬盘(NVMe) | 厂商对该硬件的对外宣传型号,例如 SN750 。 |
| 机械硬盘(SATA) | 厂商对该硬件的对外宣传型号,例如 ST4000DM004,并在结尾加上硬盘容量 (4TB)。 |
| 其他存储类设备(SATA) | 厂商对该硬件的对外宣传型号,例如 BC-12D2HT |
| 键盘 | 厂商对该硬件的对外宣传型号。 |
| 鼠标 | 厂商对该硬件的对外宣传型号。 |
| 手柄控制器 | 厂商对该硬件的对外宣传型号。 |
| 打印机 | 厂商对该硬件的对外宣传型号。 |
| 扫描仪 | 厂商对该硬件的对外宣传型号。 |
| 打印复印一体机 | 厂商对该硬件的对外宣传型号。 |
| PCIe 扩展卡 | 厂商对该硬件的对外宣传型号。 |
| USB 设备 | 厂商对该硬件的对外宣传型号。 |
brand
该值仅填写硬件所属厂商,均需使用英语填写。
此处提供部分厂商的英文名称,可作为参考,排名不分先后:
| 厂商 | 英文名称 (brand值) | 备注 |
|---|---|---|
| 致态/长江存储 | ZHITAI/YMTC | 对于长江存储旗下的原厂产品,此处均填 ZHITAI/YMTC |
| 合肥长鑫 | CXMT | |
| 福建晋华 | JHICC | |
| 威刚 | ADATA | |
| 七彩虹 | Colorful | |
| 江波龙 | longsys/FORESEE | 对于江波龙旗下产品,此处均填 longsys/FORESEE(包括内存条产品和固态硬盘产品) |
| 西安紫光国芯 | UniIC | |
| 三星 | Samsung | |
| 思得/SK海力士 | Solidigm/SK Hynix | 对于SK海力士旗下产品,此处均填 Solidigm/SK Hynix(包括内存条产品和固态硬盘产品) |
| 铨兴 | Quanxing | |
| 美商海盗船 | Corsair | |
| 美光/英睿达 | Crucial/Micron | 对于美光旗下的原厂产品,此处均填 Crucial/Micron |
| 嘉合劲威 | POWEV | 嘉合劲威(POWEV)旗下品牌有:光威(GLOWAY)、阿斯加特(Asgard)、酷兽(CUSO)、神可(SINKER),此处请填写 POWEV,之后在 arch:填写对应品牌 |
| 金百达 | KingBank | |
| 裕太微 | Motorcomm | |
| 沐创 | MUCSE | |
| 铠侠 | Kioxia | |
| 东芝 | Toshiba | |
| 西数(西部数据) | Western Digital | |
| 闪迪 | Sandisk | |
| 超威半导体 | AMD | |
| 英特尔 | Intel | |
| 英伟达 | NVIDIA | 由于 Mellanox 已被 NVIDIA 收购,所有 Mellanox 产品均归属于 NVIDIA 下 |
type
该值填写硬件类型,具体硬件类型按下表所示。
由于硬件种类繁多,该表可能无法做到及时更新,可在该代码找到目前允许收录的最新类型,并填入到 type 中:
| 类型 | type 对应值 | 备注 |
|---|---|---|
| 内存(UDIMM) | Memory_UDIMM | 一般消费级内存条,常见于桌面台式机平台 |
| 内存(UDIMM/ECC) | Memory_UDIMMECC | 一般消费级内存条,但带有 ECC 功能,常见于使用消费级处理器的工作站 |
| 内存(RDIMM) | Memory_RDIMM | 包含寄存器的内存条,即 ECC REG,常见于服务器平台 |
| 内存(SO-DIMM) | Memory_SODIMM | 一般消费级内存条,常见于笔记本移动平台 |
| 显卡 | GPU | |
| 有线网卡 | Ethernet | 此处包含 PCIe 接口网卡和 USB 网卡 |
| 无线网卡 | Wireless | 此处包含 PCIe 接口网卡和 USB 网卡 |
| 固态硬盘(SATA) | SSD_SATA | 使用 SATA 7+15 接口,外形 2.5 寸的固态硬盘,或使用 M.2 B+M 接口(两个缺口)同时贴纸上有标明 SATA logo 的。 |
| 固态硬盘(NVMe) | SSD_NVMe | 所有其他使用 NVMe 协议的硬盘,不限接口(包含 M.2、U.2、U.3、E1.S、E3.S、E1.L 等接口) |
| 机械硬盘(SATA) | HDD_SATA | 使用 SATA 7+15 接口,外形 2.5 寸或 3.5 寸的机械硬盘,此处不包含使用 SAS 接口的产品 |
| 其他存储类设备(SATA) | Storage_SATA | 使用 SATA 7+15 接口的其他存储设备,例如光驱、磁带机等 |
| 键盘 | Keyboard | |
| 鼠标 | Mouse | |
| 手柄控制器 | Gamepad | 各类游戏手柄 |
| 打印机 | Printer | 此处仅表示单打印功能的打印机 |
| 扫描仪 | Scanner | 此处仅表示单扫描功能的扫描仪 |
| 打印复印一体机 | Printer_AIO | 此处仅表示支持打印、复印、扫描、传真等功能的多功能一体机 |
| PCIe 扩展卡 | PCIe_Card | 所有除以上硬件类型外的其他使用 PCIe 接口的硬件归属于此,例如 HBA 卡 |
| USB 设备 | USB_Device | 所有除以上硬件类型外的其他使用 USB 接口的硬件归属于此 |
status
填写该硬件目前的兼容状态,此处均为整数(不是字符串),数值与对应关系如下表所示:
| 数字 | 对应值 |
|---|---|
| 0 | 未知 |
| 1 | 兼容 |
| 2 | 有限兼容 |
| 3 | 新世界可用 |
| -1 | 不兼容 |
notes
该硬件需要注意的简短备注信息,可以将中文产品信息填写在此处。
请注意此处的键只支持中文,如果需要在这里使用其他语言编写(例如英语),请在此额外添加键 notes_en。
对于其他类型的硬件设备,则需要在此备注硬件类型,例如光驱、HBA卡、采集卡等,未来可能会对此进行细分。
过长的内容或有必要通过长文进行解释的请编写为文档,并在 link 中填写文档地址。
link
若该硬件需要正式文档以说明兼容情况,请在 /docs/hardwares/ 下存放 Markdown 文件。
对于硬件,我们建议使用其在 Linux 下的内核模块的名称来命名,例如现代 Intel 无线卡,则命名为 iwlwifi.md。
请注意此处的键只支持指向中文文档,如果需要在这里指向其他语言编写的文档(例如英语),请在此额外添加键 link_en。
然后该值的填写格式如下(请注意文件名不能使用中文,请使用全英文)。
/hardwares/<所写的markdown文件名>之后根据此处的指示将文档展示在指定位置。
最后的文件命名和存放位置
对于文件命名和存放位置,请参考以下表格:
| 硬件类型 | 命名方式 | 存放位置 |
|---|---|---|
| 内存(所有接口类型) | <在产品本身提供的贴纸信息上的具体型号>.yml,与 model 值相同。 | Memory |
| 显卡 | <硬件型号简写>.yml,例如对于 Radeon RX 6400,仅需命名 rx6400.yml 即可。 | GPU |
| 有线网卡 | <硬件具体型号>.yml | Ethernet |
| 无线网卡 | <硬件型号简写>.yml,例如对于 Intel AX210网卡,仅需命名 ax210.yml 即可。 | Wireless |
| 固态硬盘(SATA) | <厂商对该硬件的对外宣传型号的简写>.yml,例如 ZHITAI SC001 Active,仅需命名 sc001.yml 即可,若前缀相同则需要补充多余后缀以区分,例如 ZHITAI SC001 XT,则需命名为 sc001xt.yml。 | SSD_SATA |
| 固态硬盘(NVMe) | <厂商对该硬件的对外宣传型号的简写>.yml ,例如 Western Digital SN750 ,仅需命名 sn750.yml 即可,其他注意事项同 固态硬盘(SATA)。 | SSD_NVME |
| 机械硬盘(SATA) | <厂商对该硬件在官方文档中所示的型号>.yml,例如 Seagate ST4000DM004,则需命名 ST4000DM004.yml,与 model 值相同。 | HDD_SATA |
| 其他存储类设备(SATA) | <厂商对该硬件的对外宣传型号>.yml,与 model 值相同。 | Storage_SATA |
| 键盘 | <厂商对该硬件的对外宣传型号>.yml,与 model 值相同。 | Keyboard |
| 鼠标 | <厂商对该硬件的对外宣传型号>.yml,与 model 值相同。 | Mouse |
| 手柄控制器 | <厂商对该硬件的对外宣传型号>.yml,与 model 值相同。 | Gamepad |
| 打印机 | <厂商对该硬件的对外宣传型号>.yml,与 model 值相同。 | Printer |
| 扫描仪 | <厂商对该硬件的对外宣传型号>.yml,与 model 值相同。 | Scanner |
| 打印复印一体机 | <厂商对该硬件的对外宣传型号>.yml,与 model 值相同。 | Printer_AIO |
| PCIe 扩展卡 | <厂商对该硬件的对外宣传型号>.yml,与 model 值相同。 | PCIe_Card |
| USB 设备 | <厂商对该硬件的对外宣传型号>.yml,与 model 值相同。 | USB_Device |