1 What: /sys/devices/platform/soc@X/XX 1 What: /sys/devices/platform/soc@X/XXXXXXX.ipa/
2 Date: June 2021 2 Date: June 2021
3 KernelVersion: v5.14 3 KernelVersion: v5.14
4 Contact: Alex Elder <elder@kernel.org> 4 Contact: Alex Elder <elder@kernel.org>
5 Description: 5 Description:
6 The /sys/devices/platform/soc@ 6 The /sys/devices/platform/soc@X/XXXXXXX.ipa/ directory
7 contains read-only attributes 7 contains read-only attributes exposing information about
8 an IPA device. The X values c 8 an IPA device. The X values could vary, but are typically
9 "soc@0/1e40000.ipa". 9 "soc@0/1e40000.ipa".
10 10
11 What: .../XXXXXXX.ipa/version 11 What: .../XXXXXXX.ipa/version
12 Date: June 2021 12 Date: June 2021
13 KernelVersion: v5.14 13 KernelVersion: v5.14
14 Contact: Alex Elder <elder@kernel.org> 14 Contact: Alex Elder <elder@kernel.org>
15 Description: 15 Description:
16 The .../XXXXXXX.ipa/version fi 16 The .../XXXXXXX.ipa/version file contains the IPA hardware
17 version, as a period-separated 17 version, as a period-separated set of two or three integers
18 (e.g., "3.5.1" or "4.2"). 18 (e.g., "3.5.1" or "4.2").
19 19
20 What: .../XXXXXXX.ipa/feature/ 20 What: .../XXXXXXX.ipa/feature/
21 Date: June 2021 21 Date: June 2021
22 KernelVersion: v5.14 22 KernelVersion: v5.14
23 Contact: Alex Elder <elder@kernel.org> 23 Contact: Alex Elder <elder@kernel.org>
24 Description: 24 Description:
25 The .../XXXXXXX.ipa/feature/ d 25 The .../XXXXXXX.ipa/feature/ directory contains a set of
26 attributes describing features 26 attributes describing features implemented by the IPA
27 hardware. 27 hardware.
28 28
29 What: .../XXXXXXX.ipa/feature/rx_off 29 What: .../XXXXXXX.ipa/feature/rx_offload
30 Date: June 2021 30 Date: June 2021
31 KernelVersion: v5.14 31 KernelVersion: v5.14
32 Contact: Alex Elder <elder@kernel.org> 32 Contact: Alex Elder <elder@kernel.org>
33 Description: 33 Description:
34 The .../XXXXXXX.ipa/feature/rx 34 The .../XXXXXXX.ipa/feature/rx_offload file contains a
35 string indicating the type of 35 string indicating the type of receive checksum offload
36 that is supported by the hardw 36 that is supported by the hardware. The possible values
37 are "MAPv4" or "MAPv5". 37 are "MAPv4" or "MAPv5".
38 38
39 What: .../XXXXXXX.ipa/feature/tx_off 39 What: .../XXXXXXX.ipa/feature/tx_offload
40 Date: June 2021 40 Date: June 2021
41 KernelVersion: v5.14 41 KernelVersion: v5.14
42 Contact: Alex Elder <elder@kernel.org> 42 Contact: Alex Elder <elder@kernel.org>
43 Description: 43 Description:
44 The .../XXXXXXX.ipa/feature/tx 44 The .../XXXXXXX.ipa/feature/tx_offload file contains a
45 string indicating the type of 45 string indicating the type of transmit checksum offload
46 that is supported by the hardw 46 that is supported by the hardware. The possible values
47 are "MAPv4" or "MAPv5". 47 are "MAPv4" or "MAPv5".
48 48
49 What: .../XXXXXXX.ipa/endpoint_id/ 49 What: .../XXXXXXX.ipa/endpoint_id/
50 Date: July 2022 50 Date: July 2022
51 KernelVersion: v5.19 51 KernelVersion: v5.19
52 Contact: Alex Elder <elder@kernel.org> 52 Contact: Alex Elder <elder@kernel.org>
53 Description: 53 Description:
54 The .../XXXXXXX.ipa/endpoint_i 54 The .../XXXXXXX.ipa/endpoint_id/ directory contains
55 attributes that define IDs ass 55 attributes that define IDs associated with IPA
56 endpoints. The "rx" or "tx" i 56 endpoints. The "rx" or "tx" in an endpoint name is
57 from the perspective of the AP 57 from the perspective of the AP. An endpoint ID is a
58 small unsigned integer. 58 small unsigned integer.
59 59
60 What: .../XXXXXXX.ipa/endpoint_id/mo 60 What: .../XXXXXXX.ipa/endpoint_id/modem_rx
61 Date: July 2022 61 Date: July 2022
62 KernelVersion: v5.19 62 KernelVersion: v5.19
63 Contact: Alex Elder <elder@kernel.org> 63 Contact: Alex Elder <elder@kernel.org>
64 Description: 64 Description:
65 The .../XXXXXXX.ipa/endpoint_i 65 The .../XXXXXXX.ipa/endpoint_id/modem_rx file contains
66 the ID of the AP endpoint on w 66 the ID of the AP endpoint on which packets originating
67 from the embedded modem are re 67 from the embedded modem are received.
68 68
69 What: .../XXXXXXX.ipa/endpoint_id/mo 69 What: .../XXXXXXX.ipa/endpoint_id/modem_tx
70 Date: July 2022 70 Date: July 2022
71 KernelVersion: v5.19 71 KernelVersion: v5.19
72 Contact: Alex Elder <elder@kernel.org> 72 Contact: Alex Elder <elder@kernel.org>
73 Description: 73 Description:
74 The .../XXXXXXX.ipa/endpoint_i 74 The .../XXXXXXX.ipa/endpoint_id/modem_tx file contains
75 the ID of the AP endpoint on w 75 the ID of the AP endpoint on which packets destined
76 for the embedded modem are sen 76 for the embedded modem are sent.
77 77
78 What: .../XXXXXXX.ipa/endpoint_id/mo 78 What: .../XXXXXXX.ipa/endpoint_id/monitor_rx
79 Date: July 2022 79 Date: July 2022
80 KernelVersion: v5.19 80 KernelVersion: v5.19
81 Contact: Alex Elder <elder@kernel.org> 81 Contact: Alex Elder <elder@kernel.org>
82 Description: 82 Description:
83 The .../XXXXXXX.ipa/endpoint_i 83 The .../XXXXXXX.ipa/endpoint_id/monitor_rx file contains
84 the ID of the AP endpoint on w 84 the ID of the AP endpoint on which IPA "monitor" data is
85 received. The monitor endpoin 85 received. The monitor endpoint supplies replicas of
86 packets that enter the IPA har 86 packets that enter the IPA hardware for processing.
87 Each replicated packet is prec 87 Each replicated packet is preceded by a fixed-size "ODL"
88 header (see .../XXXXXXX.ipa/fe 88 header (see .../XXXXXXX.ipa/feature/monitor, above).
89 Large packets are truncated, t 89 Large packets are truncated, to reduce the bandwidth
90 required to provide the monito 90 required to provide the monitor function.
91 91
92 What: .../XXXXXXX.ipa/modem/ 92 What: .../XXXXXXX.ipa/modem/
93 Date: June 2021 93 Date: June 2021
94 KernelVersion: v5.14 94 KernelVersion: v5.14
95 Contact: Alex Elder <elder@kernel.org> 95 Contact: Alex Elder <elder@kernel.org>
96 Description: 96 Description:
97 The .../XXXXXXX.ipa/modem/ dir 97 The .../XXXXXXX.ipa/modem/ directory contains attributes
98 describing properties of the m 98 describing properties of the modem embedded in the SoC.
99 99
100 What: .../XXXXXXX.ipa/modem/rx_endpo 100 What: .../XXXXXXX.ipa/modem/rx_endpoint_id
101 Date: June 2021 101 Date: June 2021
102 KernelVersion: v5.14 102 KernelVersion: v5.14
103 Contact: Alex Elder <elder@kernel.org> 103 Contact: Alex Elder <elder@kernel.org>
104 Description: 104 Description:
105 The .../XXXXXXX.ipa/modem/rx_e 105 The .../XXXXXXX.ipa/modem/rx_endpoint_id file duplicates
106 the value found in .../XXXXXXX 106 the value found in .../XXXXXXX.ipa/endpoint_id/modem_rx.
107 107
108 What: .../XXXXXXX.ipa/modem/tx_endpo 108 What: .../XXXXXXX.ipa/modem/tx_endpoint_id
109 Date: June 2021 109 Date: June 2021
110 KernelVersion: v5.14 110 KernelVersion: v5.14
111 Contact: Alex Elder <elder@kernel.org> 111 Contact: Alex Elder <elder@kernel.org>
112 Description: 112 Description:
113 The .../XXXXXXX.ipa/modem/tx_e 113 The .../XXXXXXX.ipa/modem/tx_endpoint_id file duplicates
114 the value found in .../XXXXXXX 114 the value found in .../XXXXXXX.ipa/endpoint_id/modem_tx.
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.