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