cxl: Add documentation for userspace APIs
[linux-2.6-block.git] / Documentation / ABI / testing / sysfs-class-cxl
CommitLineData
a9282d01
IM
1Slave contexts (eg. /sys/class/cxl/afu0.0s):
2
3What: /sys/class/cxl/<afu>/irqs_max
4Date: September 2014
5Contact: linuxppc-dev@lists.ozlabs.org
6Description: read/write
7 Decimal value of maximum number of interrupts that can be
8 requested by userspace. The default on probe is the maximum
9 that hardware can support (eg. 2037). Write values will limit
10 userspace applications to that many userspace interrupts. Must
11 be >= irqs_min.
12
13What: /sys/class/cxl/<afu>/irqs_min
14Date: September 2014
15Contact: linuxppc-dev@lists.ozlabs.org
16Description: read only
17 Decimal value of the minimum number of interrupts that
18 userspace must request on a CXL_START_WORK ioctl. Userspace may
19 omit the num_interrupts field in the START_WORK IOCTL to get
20 this minimum automatically.
21
22What: /sys/class/cxl/<afu>/mmio_size
23Date: September 2014
24Contact: linuxppc-dev@lists.ozlabs.org
25Description: read only
26 Decimal value of the size of the MMIO space that may be mmaped
27 by userspace.
28
29What: /sys/class/cxl/<afu>/modes_supported
30Date: September 2014
31Contact: linuxppc-dev@lists.ozlabs.org
32Description: read only
33 List of the modes this AFU supports. One per line.
34 Valid entries are: "dedicated_process" and "afu_directed"
35
36What: /sys/class/cxl/<afu>/mode
37Date: September 2014
38Contact: linuxppc-dev@lists.ozlabs.org
39Description: read/write
40 The current mode the AFU is using. Will be one of the modes
41 given in modes_supported. Writing will change the mode
42 provided that no user contexts are attached.
43
44
45What: /sys/class/cxl/<afu>/prefault_mode
46Date: September 2014
47Contact: linuxppc-dev@lists.ozlabs.org
48Description: read/write
49 Set the mode for prefaulting in segments into the segment table
50 when performing the START_WORK ioctl. Possible values:
51 none: No prefaulting (default)
52 work_element_descriptor: Treat the work element
53 descriptor as an effective address and
54 prefault what it points to.
55 all: all segments process calling START_WORK maps.
56
57What: /sys/class/cxl/<afu>/reset
58Date: September 2014
59Contact: linuxppc-dev@lists.ozlabs.org
60Description: write only
61 Writing 1 here will reset the AFU provided there are not
62 contexts active on the AFU.
63
64What: /sys/class/cxl/<afu>/api_version
65Date: September 2014
66Contact: linuxppc-dev@lists.ozlabs.org
67Description: read only
68 Decimal value of the current version of the kernel/user API.
69
70What: /sys/class/cxl/<afu>/api_version_com
71Date: September 2014
72Contact: linuxppc-dev@lists.ozlabs.org
73Description: read only
74 Decimal value of the the lowest version of the userspace API
75 this this kernel supports.
76
77
78
79Master contexts (eg. /sys/class/cxl/afu0.0m)
80
81What: /sys/class/cxl/<afu>m/mmio_size
82Date: September 2014
83Contact: linuxppc-dev@lists.ozlabs.org
84Description: read only
85 Decimal value of the size of the MMIO space that may be mmaped
86 by userspace. This includes all slave contexts space also.
87
88What: /sys/class/cxl/<afu>m/pp_mmio_len
89Date: September 2014
90Contact: linuxppc-dev@lists.ozlabs.org
91Description: read only
92 Decimal value of the Per Process MMIO space length.
93
94What: /sys/class/cxl/<afu>m/pp_mmio_off
95Date: September 2014
96Contact: linuxppc-dev@lists.ozlabs.org
97Description: read only
98 Decimal value of the Per Process MMIO space offset.
99
100
101Card info (eg. /sys/class/cxl/card0)
102
103What: /sys/class/cxl/<card>/caia_version
104Date: September 2014
105Contact: linuxppc-dev@lists.ozlabs.org
106Description: read only
107 Identifies the CAIA Version the card implements.
108
109What: /sys/class/cxl/<card>/psl_version
110Date: September 2014
111Contact: linuxppc-dev@lists.ozlabs.org
112Description: read only
113 Identifies the revision level of the PSL.
114
115What: /sys/class/cxl/<card>/base_image
116Date: September 2014
117Contact: linuxppc-dev@lists.ozlabs.org
118Description: read only
119 Identifies the revision level of the base image for devices
120 that support loadable PSLs. For FPGAs this field identifies
121 the image contained in the on-adapter flash which is loaded
122 during the initial program load.
123
124What: /sys/class/cxl/<card>/image_loaded
125Date: September 2014
126Contact: linuxppc-dev@lists.ozlabs.org
127Description: read only
128 Will return "user" or "factory" depending on the image loaded
129 onto the card.