1 .. SPDX-License-Identifier: GPL-2.0
2
3 =======================================
4 Linux NVMe feature and and quirk policy
5 =======================================
6
7 This file explains the policy used to decide w
8 Linux NVMe driver and what is not.
9
10
11 Introduction
12 ============
13
14 NVM Express is an open collection of standards
15
16 The Linux NVMe host driver in drivers/nvme/hos
17 implementing the NVM Express (NVMe) family of
18 currently consists of a number of documents:
19
20 - the NVMe Base specification
21 - various Command Set specifications (e.g. NV
22 - various Transport specifications (e.g. PCIe
23 - the NVMe Management Interface specification
24
25 See https://nvmexpress.org/developers/ for the
26
27
28 Supported features
29 ==================
30
31 NVMe is a large suite of specifications, and c
32 useful or suitable for specific use-cases. It
33 does not aim to implement every feature in the
34 feature implemented introduces more code, more
35 bugs. Hence there is an inherent tradeoff bet
36 maintainability of the NVMe host driver.
37
38 Any feature implemented in the Linux NVMe host
39 following requirements:
40
41 1. The feature is specified in a release ver
42 specification, or in a ratified Technical
43 available on NVMe website. Or if it is no
44 on-wire protocol, does not contradict any
45 2. Does not conflict with the Linux architec
46 NVMe host driver.
47 3. Has a clear, indisputable value-propositi
48 the community.
49
50 Vendor specific extensions are generally not s
51 driver.
52
53 It is strongly recommended to work with the Li
54 maintainers and get feedback on specification
55 to be used by the Linux NVMe host driver in or
56 later stage.
57
58
59 Quirks
60 ======
61
62 Sometimes implementations of open standards fa
63 of the standards. Linux uses identifier-based
64 implementation bugs. The intent of quirks is
65 hardware, usually consumer, which Linux users
66 Typically these implementations are not or onl
67 by the hardware manufacturer.
68
69 The Linux NVMe maintainers decide ad hoc wheth
70 based on the impact of the problem to Linux us
71 maintainability of the driver. In general qui
72 firmware updates or other workarounds are avai
73
74 Quirks will not be added to the Linux kernel f
75 on the mass market. Hardware that fails quali
76 distributions, ChromeOS, Android or other cons
77 should be fixed before it is shipped instead o
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.