1What:		/sys/devices/platform/soc@X/XXXXXXX.ipa/
2Date:		June 2021
3KernelVersion:	v5.14
4Contact:	Alex Elder <[email protected]>
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 <[email protected]>
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 <[email protected]>
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 <[email protected]>
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 <[email protected]>
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/endpoint_id/
50Date:		July 2022
51KernelVersion:	v5.19
52Contact:	Alex Elder <[email protected]>
53Description:
54		The .../XXXXXXX.ipa/endpoint_id/ directory contains
55		attributes that define IDs associated with IPA
56		endpoints.  The "rx" or "tx" in an endpoint name is
57		from the perspective of the AP.  An endpoint ID is a
58		small unsigned integer.
59
60What:		.../XXXXXXX.ipa/endpoint_id/modem_rx
61Date:		July 2022
62KernelVersion:	v5.19
63Contact:	Alex Elder <[email protected]>
64Description:
65		The .../XXXXXXX.ipa/endpoint_id/modem_rx file contains
66		the ID of the AP endpoint on which packets originating
67		from the embedded modem are received.
68
69What:		.../XXXXXXX.ipa/endpoint_id/modem_tx
70Date:		July 2022
71KernelVersion:	v5.19
72Contact:	Alex Elder <[email protected]>
73Description:
74		The .../XXXXXXX.ipa/endpoint_id/modem_tx file contains
75		the ID of the AP endpoint on which packets destined
76		for the embedded modem are sent.
77
78What:		.../XXXXXXX.ipa/endpoint_id/monitor_rx
79Date:		July 2022
80KernelVersion:	v5.19
81Contact:	Alex Elder <[email protected]>
82Description:
83		The .../XXXXXXX.ipa/endpoint_id/monitor_rx file contains
84		the ID of the AP endpoint on which IPA "monitor" data is
85		received.  The monitor endpoint supplies replicas of
86		packets that enter the IPA hardware for processing.
87		Each replicated packet is preceded by a fixed-size "ODL"
88		header (see .../XXXXXXX.ipa/feature/monitor, above).
89		Large packets are truncated, to reduce the bandwidth
90		required to provide the monitor function.
91
92What:		.../XXXXXXX.ipa/modem/
93Date:		June 2021
94KernelVersion:	v5.14
95Contact:	Alex Elder <[email protected]>
96Description:
97		The .../XXXXXXX.ipa/modem/ directory contains attributes
98		describing properties of the modem embedded in the SoC.
99
100What:		.../XXXXXXX.ipa/modem/rx_endpoint_id
101Date:		June 2021
102KernelVersion:	v5.14
103Contact:	Alex Elder <[email protected]>
104Description:
105		The .../XXXXXXX.ipa/modem/rx_endpoint_id file duplicates
106		the value found in .../XXXXXXX.ipa/endpoint_id/modem_rx.
107
108What:		.../XXXXXXX.ipa/modem/tx_endpoint_id
109Date:		June 2021
110KernelVersion:	v5.14
111Contact:	Alex Elder <[email protected]>
112Description:
113		The .../XXXXXXX.ipa/modem/tx_endpoint_id file duplicates
114		the value found in .../XXXXXXX.ipa/endpoint_id/modem_tx.
115