xref: /linux/Documentation/driver-api/cxl/conventions.rst (revision d41e5839d80043beaa63973eab602579ebdb238f)
1.. SPDX-License-Identifier: GPL-2.0
2.. include:: <isonum.txt>
3
4=======================================
5Compute Express Link: Linux Conventions
6=======================================
7
8There exists shipping platforms that bend or break CXL specification
9expectations. Record the details and the rationale for those deviations.
10Borrow the ACPI Code First template format to capture the assumptions
11and tradeoffs such that multiple platform implementations can follow the
12same convention.
13
14<(template) Title>
15==================
16
17Document
18--------
19CXL Revision <rev>, Version <ver>
20
21License
22-------
23SPDX-License Identifier: CC-BY-4.0
24
25Creator/Contributors
26--------------------
27
28Summary of the Change
29---------------------
30
31<Detail the conflict with the specification and where available the
32assumptions and tradeoffs taken by the hardware platform.>
33
34
35Benefits of the Change
36----------------------
37
38<Detail what happens if platforms and Linux do not adopt this
39convention.>
40
41References
42----------
43
44Detailed Description of the Change
45----------------------------------
46
47<Propose spec language that corrects the conflict.>
48