1What:		/sys/devices/platform/soc@X/XXXXXXX.ipa/
2Date:		June 2021
3KernelVersion:	v5.14
4Contact:	Alex Elder <elder@kernel.org>
5Description:
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
11What:		.../XXXXXXX.ipa/version
12Date:		June 2021
13KernelVersion:	v5.14
14Contact:	Alex Elder <elder@kernel.org>
15Description:
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
20What:		.../XXXXXXX.ipa/feature/
21Date:		June 2021
22KernelVersion:	v5.14
23Contact:	Alex Elder <elder@kernel.org>
24Description:
25		The .../XXXXXXX.ipa/feature/ directory contains a set of
26		attributes describing features implemented by the IPA
27		hardware.
28
29What:		.../XXXXXXX.ipa/feature/rx_offload
30Date:		June 2021
31KernelVersion:	v5.14
32Contact:	Alex Elder <elder@kernel.org>
33Description:
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
39What:		.../XXXXXXX.ipa/feature/tx_offload
40Date:		June 2021
41KernelVersion:	v5.14
42Contact:	Alex Elder <elder@kernel.org>
43Description:
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
49What:		.../XXXXXXX.ipa/modem/
50Date:		June 2021
51KernelVersion:	v5.14
52Contact:	Alex Elder <elder@kernel.org>
53Description:
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
58What:		.../XXXXXXX.ipa/modem/rx_endpoint_id
59Date:		June 2021
60KernelVersion:	v5.14
61Contact:	Alex Elder <elder@kernel.org>
62Description:
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
69What:		.../XXXXXXX.ipa/modem/tx_endpoint_id
70Date:		June 2021
71KernelVersion:	v5.14
72Contact:	Alex Elder <elder@kernel.org>
73Description:
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.
79