Skip to content

Commit e0f4572

Browse files
carlossanlopcarlossanlop
authored
Automatic port of System.Runtime.Intrinsics documentation (dotnet#4624)
* Automatic port of System.Runtime.Intrinsics documentation * Add dots and remove extra xml tags * Separate A64 Co-authored-by: carlossanlop <[email protected]>
1 parent 1a913ef commit e0f4572

File tree

17 files changed

+10199
-2151
lines changed

17 files changed

+10199
-2151
lines changed

‎xml/System.Runtime.Intrinsics.Arm/AdvSimd+Arm64.xml

Lines changed: 2016 additions & 504 deletions
Large diffs are not rendered by default.

‎xml/System.Runtime.Intrinsics.Arm/AdvSimd.xml

Lines changed: 7346 additions & 1470 deletions
Large diffs are not rendered by default.

‎xml/System.Runtime.Intrinsics.Arm/Aes.xml

Lines changed: 41 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
</Attribute>
2121
</Attributes>
2222
<Docs>
23-
<summary>To be added.</summary>
23+
<summary>This class provides access to the ARM AES hardware instructions via intrinsics.</summary>
2424
<remarks>To be added.</remarks>
2525
</Docs>
2626
<Members>
@@ -46,7 +46,11 @@
4646
<Docs>
4747
<param name="value">To be added.</param>
4848
<param name="roundKey">To be added.</param>
49-
<summary>To be added.</summary>
49+
<summary>
50+
<para>uint8x16_t vaesdq_u8 (uint8x16_t data, uint8x16_t key) </para>
51+
<para>A32: AESD.8 Qd, Qm</para>
52+
<para>A64: AESD Vd.16B, Vn.16B</para>
53+
</summary>
5054
<returns>To be added.</returns>
5155
<remarks>To be added.</remarks>
5256
</Docs>
@@ -73,7 +77,11 @@
7377
<Docs>
7478
<param name="value">To be added.</param>
7579
<param name="roundKey">To be added.</param>
76-
<summary>To be added.</summary>
80+
<summary>
81+
<para>uint8x16_t vaeseq_u8 (uint8x16_t data, uint8x16_t key) </para>
82+
<para>A32: AESE.8 Qd, Qm</para>
83+
<para>A64: AESE Vd.16B, Vn.16B</para>
84+
</summary>
7785
<returns>To be added.</returns>
7886
<remarks>To be added.</remarks>
7987
</Docs>
@@ -98,7 +106,11 @@
98106
</Parameters>
99107
<Docs>
100108
<param name="value">To be added.</param>
101-
<summary>To be added.</summary>
109+
<summary>
110+
<para>uint8x16_t vaesimcq_u8 (uint8x16_t data) </para>
111+
<para>A32: AESIMC.8 Qd, Qm</para>
112+
<para>A64: AESIMC Vd.16B, Vn.16B</para>
113+
</summary>
102114
<returns>To be added.</returns>
103115
<remarks>To be added.</remarks>
104116
</Docs>
@@ -144,7 +156,11 @@
144156
</Parameters>
145157
<Docs>
146158
<param name="value">To be added.</param>
147-
<summary>To be added.</summary>
159+
<summary>
160+
<para>uint8x16_t vaesmcq_u8 (uint8x16_t data) </para>
161+
<para>A32: AESMC.8 Qd, Qm</para>
162+
<para>A64: AESMC V&gt;.16B, Vn.16B</para>
163+
</summary>
148164
<returns>To be added.</returns>
149165
<remarks>To be added.</remarks>
150166
</Docs>
@@ -171,7 +187,11 @@
171187
<Docs>
172188
<param name="left">To be added.</param>
173189
<param name="right">To be added.</param>
174-
<summary>To be added.</summary>
190+
<summary>
191+
<para>poly128_t vmull_p64 (poly64_t a, poly64_t b) </para>
192+
<para>A32: VMULL.P8 Qd, Dn, Dm</para>
193+
<para>A64: PMULL Vd.1Q, Vn.1D, Vm.1D</para>
194+
</summary>
175195
<returns>To be added.</returns>
176196
<remarks>To be added.</remarks>
177197
</Docs>
@@ -198,7 +218,11 @@
198218
<Docs>
199219
<param name="left">To be added.</param>
200220
<param name="right">To be added.</param>
201-
<summary>To be added.</summary>
221+
<summary>
222+
<para>poly128_t vmull_p64 (poly64_t a, poly64_t b) </para>
223+
<para>A32: VMULL.P8 Qd, Dn, Dm</para>
224+
<para>A64: PMULL Vd.1Q, Vn.1D, Vm.1D</para>
225+
</summary>
202226
<returns>To be added.</returns>
203227
<remarks>To be added.</remarks>
204228
</Docs>
@@ -225,7 +249,11 @@
225249
<Docs>
226250
<param name="left">To be added.</param>
227251
<param name="right">To be added.</param>
228-
<summary>To be added.</summary>
252+
<summary>
253+
<para>poly128_t vmull_high_p64 (poly64x2_t a, poly64x2_t b) </para>
254+
<para>A32: VMULL.P8 Qd, Dn+1, Dm+1</para>
255+
<para>A64: PMULL2 Vd.1Q, Vn.2D, Vm.2D</para>
256+
</summary>
229257
<returns>To be added.</returns>
230258
<remarks>To be added.</remarks>
231259
</Docs>
@@ -252,7 +280,11 @@
252280
<Docs>
253281
<param name="left">To be added.</param>
254282
<param name="right">To be added.</param>
255-
<summary>To be added.</summary>
283+
<summary>
284+
<para>poly128_t vmull_high_p64 (poly64x2_t a, poly64x2_t b) </para>
285+
<para>A32: VMULL.P8 Qd, Dn+1, Dm+1</para>
286+
<para>A64: PMULL2 Vd.1Q, Vn.2D, Vm.2D</para>
287+
</summary>
256288
<returns>To be added.</returns>
257289
<remarks>To be added.</remarks>
258290
</Docs>

‎xml/System.Runtime.Intrinsics.Arm/ArmBase+Arm64.xml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@
5959
</Parameters>
6060
<Docs>
6161
<param name="value">To be added.</param>
62-
<summary>To be added.</summary>
62+
<summary>A64: CLS Wd, Wn</summary>
6363
<returns>To be added.</returns>
6464
<remarks>To be added.</remarks>
6565
</Docs>
@@ -84,7 +84,7 @@
8484
</Parameters>
8585
<Docs>
8686
<param name="value">To be added.</param>
87-
<summary>To be added.</summary>
87+
<summary>A64: CLS Xd, Xn</summary>
8888
<returns>To be added.</returns>
8989
<remarks>To be added.</remarks>
9090
</Docs>
@@ -109,7 +109,7 @@
109109
</Parameters>
110110
<Docs>
111111
<param name="value">To be added.</param>
112-
<summary>To be added.</summary>
112+
<summary>A64: CLZ Xd, Xn</summary>
113113
<returns>To be added.</returns>
114114
<remarks>To be added.</remarks>
115115
</Docs>
@@ -134,7 +134,7 @@
134134
</Parameters>
135135
<Docs>
136136
<param name="value">To be added.</param>
137-
<summary>To be added.</summary>
137+
<summary>A64: CLZ Xd, Xn</summary>
138138
<returns>To be added.</returns>
139139
<remarks>To be added.</remarks>
140140
</Docs>
@@ -159,7 +159,7 @@
159159
</Parameters>
160160
<Docs>
161161
<param name="value">To be added.</param>
162-
<summary>To be added.</summary>
162+
<summary>A64: RBIT Xd, Xn</summary>
163163
<returns>To be added.</returns>
164164
<remarks>To be added.</remarks>
165165
</Docs>
@@ -184,7 +184,7 @@
184184
</Parameters>
185185
<Docs>
186186
<param name="value">To be added.</param>
187-
<summary>To be added.</summary>
187+
<summary>A64: RBIT Xd, Xn</summary>
188188
<returns>To be added.</returns>
189189
<remarks>To be added.</remarks>
190190
</Docs>

‎xml/System.Runtime.Intrinsics.Arm/ArmBase.xml

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
</Attribute>
2121
</Attributes>
2222
<Docs>
23-
<summary>To be added.</summary>
23+
<summary>This class provides access to the ARM base hardware instructions via intrinsics.</summary>
2424
<remarks>To be added.</remarks>
2525
</Docs>
2626
<Members>
@@ -65,7 +65,10 @@
6565
</Parameters>
6666
<Docs>
6767
<param name="value">To be added.</param>
68-
<summary>To be added.</summary>
68+
<summary>
69+
<para>A32: CLZ Rd, Rm</para>
70+
<para>A64: CLZ Wd, Wn</para>
71+
</summary>
6972
<returns>To be added.</returns>
7073
<remarks>To be added.</remarks>
7174
</Docs>
@@ -90,7 +93,10 @@
9093
</Parameters>
9194
<Docs>
9295
<param name="value">To be added.</param>
93-
<summary>To be added.</summary>
96+
<summary>
97+
<para>A32: CLZ Rd, Rm</para>
98+
<para>A64: CLZ Wd, Wn</para>
99+
</summary>
94100
<returns>To be added.</returns>
95101
<remarks>To be added.</remarks>
96102
</Docs>
@@ -115,7 +121,10 @@
115121
</Parameters>
116122
<Docs>
117123
<param name="value">To be added.</param>
118-
<summary>To be added.</summary>
124+
<summary>
125+
<para>A32: RBIT Rd, Rm</para>
126+
<para>A64: RBIT Wd, Wn</para>
127+
</summary>
119128
<returns>To be added.</returns>
120129
<remarks>To be added.</remarks>
121130
</Docs>
@@ -140,7 +149,10 @@
140149
</Parameters>
141150
<Docs>
142151
<param name="value">To be added.</param>
143-
<summary>To be added.</summary>
152+
<summary>
153+
<para>A32: RBIT Rd, Rm</para>
154+
<para>A64: RBIT Wd, Wn</para>
155+
</summary>
144156
<returns>To be added.</returns>
145157
<remarks>To be added.</remarks>
146158
</Docs>

‎xml/System.Runtime.Intrinsics.Arm/Crc32+Arm64.xml

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,10 @@
4040
<Docs>
4141
<param name="crc">To be added.</param>
4242
<param name="data">To be added.</param>
43-
<summary>To be added.</summary>
43+
<summary>
44+
<para>uint32_t __crc32d (uint32_t a, uint64_t b) </para>
45+
<para>A64: CRC32X Wd, Wn, Xm</para>
46+
</summary>
4447
<returns>To be added.</returns>
4548
<remarks>To be added.</remarks>
4649
</Docs>
@@ -67,7 +70,10 @@
6770
<Docs>
6871
<param name="crc">To be added.</param>
6972
<param name="data">To be added.</param>
70-
<summary>To be added.</summary>
73+
<summary>
74+
<para>uint32_t __crc32cd (uint32_t a, uint64_t b) </para>
75+
<para>A64: CRC32CX Wd, Wn, Xm</para>
76+
</summary>
7177
<returns>To be added.</returns>
7278
<remarks>To be added.</remarks>
7379
</Docs>

‎xml/System.Runtime.Intrinsics.Arm/Crc32.xml

Lines changed: 31 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
</Attribute>
2121
</Attributes>
2222
<Docs>
23-
<summary>To be added.</summary>
23+
<summary>This class provides access to the ARM Crc32 hardware instructions via intrinsics.</summary>
2424
<remarks>To be added.</remarks>
2525
</Docs>
2626
<Members>
@@ -46,7 +46,11 @@
4646
<Docs>
4747
<param name="crc">To be added.</param>
4848
<param name="data">To be added.</param>
49-
<summary>To be added.</summary>
49+
<summary>
50+
<para>uint32_t __crc32b (uint32_t a, uint8_t b)</para>
51+
<para>A32: CRC32B Rd, Rn, Rm</para>
52+
<para>A64: CRC32B Wd, Wn, Wm</para>
53+
</summary>
5054
<returns>To be added.</returns>
5155
<remarks>To be added.</remarks>
5256
</Docs>
@@ -73,7 +77,11 @@
7377
<Docs>
7478
<param name="crc">To be added.</param>
7579
<param name="data">To be added.</param>
76-
<summary>To be added.</summary>
80+
<summary>
81+
<para>uint32_t __crc32h (uint32_t a, uint16_t b)</para>
82+
<para>A32: CRC32H Rd, Rn, Rm</para>
83+
<para>A64: CRC32H Wd, Wn, Wm</para>
84+
</summary>
7785
<returns>To be added.</returns>
7886
<remarks>To be added.</remarks>
7987
</Docs>
@@ -100,7 +108,11 @@
100108
<Docs>
101109
<param name="crc">To be added.</param>
102110
<param name="data">To be added.</param>
103-
<summary>To be added.</summary>
111+
<summary>
112+
<para>uint32_t __crc32w (uint32_t a, uint32_t b)</para>
113+
<para>A32: CRC32W Rd, Rn, Rm</para>
114+
<para>A64: CRC32W Wd, Wn, Wm</para>
115+
</summary>
104116
<returns>To be added.</returns>
105117
<remarks>To be added.</remarks>
106118
</Docs>
@@ -127,7 +139,11 @@
127139
<Docs>
128140
<param name="crc">To be added.</param>
129141
<param name="data">To be added.</param>
130-
<summary>To be added.</summary>
142+
<summary>
143+
<para>uint32_t __crc32cb (uint32_t a, uint8_t b)</para>
144+
<para>A32: CRC32CB Rd, Rn, Rm</para>
145+
<para>A64: CRC32CB Wd, Wn, Wm</para>
146+
</summary>
131147
<returns>To be added.</returns>
132148
<remarks>To be added.</remarks>
133149
</Docs>
@@ -154,7 +170,11 @@
154170
<Docs>
155171
<param name="crc">To be added.</param>
156172
<param name="data">To be added.</param>
157-
<summary>To be added.</summary>
173+
<summary>
174+
<para>uint32_t __crc32ch (uint32_t a, uint16_t b)</para>
175+
<para>A32: CRC32CH Rd, Rn, Rm</para>
176+
<para>A64: CRC32CH Wd, Wn, Wm</para>
177+
</summary>
158178
<returns>To be added.</returns>
159179
<remarks>To be added.</remarks>
160180
</Docs>
@@ -181,7 +201,11 @@
181201
<Docs>
182202
<param name="crc">To be added.</param>
183203
<param name="data">To be added.</param>
184-
<summary>To be added.</summary>
204+
<summary>
205+
<para>uint32_t __crc32cw (uint32_t a, uint32_t b)</para>
206+
<para>A32: CRC32CW Rd, Rn, Rm</para>
207+
<para>A64: CRC32CW Wd, Wn, Wm</para>
208+
</summary>
185209
<returns>To be added.</returns>
186210
<remarks>To be added.</remarks>
187211
</Docs>

0 commit comments

Comments
 (0)