Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/dtor/input
[linux-2.6-microblaze.git] / Documentation / ABI / testing / sysfs-devices-platform-soc-ipa
1 What:           /sys/devices/platform/soc@X/XXXXXXX.ipa/
2 Date:           June 2021
3 KernelVersion:  v5.14
4 Contact:        Alex Elder <elder@kernel.org>
5 Description:
6                 The /sys/devices/platform/soc@X/XXXXXXX.ipa/ directory
7                 contains read-only attributes exposing information about
8                 an IPA device.  The X values could vary, but are typically
9                 "soc@0/1e40000.ipa".
10
11 What:           .../XXXXXXX.ipa/version
12 Date:           June 2021
13 KernelVersion:  v5.14
14 Contact:        Alex Elder <elder@kernel.org>
15 Description:
16                 The .../XXXXXXX.ipa/version file contains the IPA hardware
17                 version, as a period-separated set of two or three integers
18                 (e.g., "3.5.1" or "4.2").
19
20 What:           .../XXXXXXX.ipa/feature/
21 Date:           June 2021
22 KernelVersion:  v5.14
23 Contact:        Alex Elder <elder@kernel.org>
24 Description:
25                 The .../XXXXXXX.ipa/feature/ directory contains a set of
26                 attributes describing features implemented by the IPA
27                 hardware.
28
29 What:           .../XXXXXXX.ipa/feature/rx_offload
30 Date:           June 2021
31 KernelVersion:  v5.14
32 Contact:        Alex Elder <elder@kernel.org>
33 Description:
34                 The .../XXXXXXX.ipa/feature/rx_offload file contains a
35                 string indicating the type of receive checksum offload
36                 that is supported by the hardware.  The possible values
37                 are "MAPv4" or "MAPv5".
38
39 What:           .../XXXXXXX.ipa/feature/tx_offload
40 Date:           June 2021
41 KernelVersion:  v5.14
42 Contact:        Alex Elder <elder@kernel.org>
43 Description:
44                 The .../XXXXXXX.ipa/feature/tx_offload file contains a
45                 string indicating the type of transmit checksum offload
46                 that is supported by the hardware.  The possible values
47                 are "MAPv4" or "MAPv5".
48
49 What:           .../XXXXXXX.ipa/modem/
50 Date:           June 2021
51 KernelVersion:  v5.14
52 Contact:        Alex Elder <elder@kernel.org>
53 Description:
54                 The .../XXXXXXX.ipa/modem/ directory contains a set of
55                 attributes describing properties of the modem execution
56                 environment reachable by the IPA hardware.
57
58 What:           .../XXXXXXX.ipa/modem/rx_endpoint_id
59 Date:           June 2021
60 KernelVersion:  v5.14
61 Contact:        Alex Elder <elder@kernel.org>
62 Description:
63                 The .../XXXXXXX.ipa/feature/rx_endpoint_id file contains
64                 the AP endpoint ID that receives packets originating from
65                 the modem execution environment.  The "rx" is from the
66                 perspective of the AP; this endpoint is considered an "IPA
67                 producer".  An endpoint ID is a small unsigned integer.
68
69 What:           .../XXXXXXX.ipa/modem/tx_endpoint_id
70 Date:           June 2021
71 KernelVersion:  v5.14
72 Contact:        Alex Elder <elder@kernel.org>
73 Description:
74                 The .../XXXXXXX.ipa/feature/tx_endpoint_id file contains
75                 the AP endpoint ID used to transmit packets destined for
76                 the modem execution environment.  The "tx" is from the
77                 perspective of the AP; this endpoint is considered an "IPA
78                 consumer".  An endpoint ID is a small unsigned integer.