Skip to content

Commit 26333fa

Browse files
yuguenyuguen
authored
FPGA: Add information about DEVICE_FLAG in relevant samples READMEs (#2532)
1 parent 72318ab commit 26333fa

File tree

29 files changed

+444
-342
lines changed

29 files changed

+444
-342
lines changed

‎DirectProgramming/C++SYCL_FPGA/ReferenceDesigns/anr/README.md‎

Lines changed: 22 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -168,15 +168,17 @@ The design uses the following generic header files.
168168
> ```
169169
> cmake .. -DFPGA_DEVICE=<board-support-package>:<board-variant> -DIS_BSP=1
170170
> ```
171-
> **Note**: You can poll your system for available BSPs using the `aoc -list-boards` command. The board list that is printed out will be of the form
172-
> ```
173-
> $> aoc -list-boards
174-
> Board list:
175-
> <board-variant>
176-
> Board Package: <path/to/board/package>/board-support-package
177-
> <board-variant2>
178-
> Board Package: <path/to/board/package>/board-support-package
179-
> ```
171+
> The build system will try to infer the FPGA family from the BSP name.
172+
> If it can't, an extra option needs to be passed to `cmake`: `-DDEVICE_FLAG=[A10|S10|Agilex7]`
173+
> **Note**: You can poll your system for available BSPs using the `aoc -list-boards` command. The board list that is printed out will be of the form
174+
> ```
175+
> $> aoc -list-boards
176+
> Board list:
177+
> <board-variant>
178+
> Board Package: <path/to/board/package>/board-support-package
179+
> <board-variant2>
180+
> Board Package: <path/to/board/package>/board-support-package
181+
> ```
180182
>
181183
> You will only be able to run an executable on the FPGA if you specified a BSP.
182184
@@ -220,15 +222,17 @@ The design uses the following generic header files.
220222
> ```
221223
> cmake -G "NMake Makefiles" .. -DFPGA_DEVICE=<board-support-package>:<board-variant> -DIS_BSP=1
222224
> ```
223-
> **Note**: You can poll your system for available BSPs using the `aoc -list-boards` command. The board list that is printed out will be of the form
224-
> ```
225-
> $> aoc -list-boards
226-
> Board list:
227-
> <board-variant>
228-
> Board Package: <path/to/board/package>/board-support-package
229-
> <board-variant2>
230-
> Board Package: <path/to/board/package>/board-support-package
231-
> ```
225+
> The build system will try to infer the FPGA family from the BSP name.
226+
> If it can't, an extra option needs to be passed to `cmake`: `-DDEVICE_FLAG=[A10|S10|Agilex7]`
227+
> **Note**: You can poll your system for available BSPs using the `aoc -list-boards` command. The board list that is printed out will be of the form
228+
> ```
229+
> $> aoc -list-boards
230+
> Board list:
231+
> <board-variant>
232+
> Board Package: <path/to/board/package>/board-support-package
233+
> <board-variant2>
234+
> Board Package: <path/to/board/package>/board-support-package
235+
> ```
232236
>
233237
> You will only be able to run an executable on the FPGA if you specified a BSP.
234238

‎DirectProgramming/C++SYCL_FPGA/ReferenceDesigns/cholesky/README.md‎

Lines changed: 22 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -162,15 +162,17 @@ For `constexpr_math.hpp`, `memory_utils.hpp`, `metaprogramming_utils.hpp`, and `
162162
> ```
163163
> cmake .. -DFPGA_DEVICE=<board-support-package>:<board-variant> -DIS_BSP=1
164164
> ```
165-
> **Note**: You can poll your system for available BSPs using the `aoc -list-boards` command. The board list that is printed out will be of the form
166-
> ```
167-
> $> aoc -list-boards
168-
> Board list:
169-
> <board-variant>
170-
> Board Package: <path/to/board/package>/board-support-package
171-
> <board-variant2>
172-
> Board Package: <path/to/board/package>/board-support-package
173-
> ```
165+
> The build system will try to infer the FPGA family from the BSP name.
166+
> If it can't, an extra option needs to be passed to `cmake`: `-DDEVICE_FLAG=[A10|S10|Agilex7]`
167+
> **Note**: You can poll your system for available BSPs using the `aoc -list-boards` command. The board list that is printed out will be of the form
168+
> ```
169+
> $> aoc -list-boards
170+
> Board list:
171+
> <board-variant>
172+
> Board Package: <path/to/board/package>/board-support-package
173+
> <board-variant2>
174+
> Board Package: <path/to/board/package>/board-support-package
175+
> ```
174176
>
175177
> You will only be able to run an executable on the FPGA if you specified a BSP.
176178
@@ -214,15 +216,17 @@ For `constexpr_math.hpp`, `memory_utils.hpp`, `metaprogramming_utils.hpp`, and `
214216
> ```
215217
> cmake -G "NMake Makefiles" .. -DFPGA_DEVICE=<board-support-package>:<board-variant> -DIS_BSP=1
216218
> ```
217-
> **Note**: You can poll your system for available BSPs using the `aoc -list-boards` command. The board list that is printed out will be of the form
218-
> ```
219-
> $> aoc -list-boards
220-
> Board list:
221-
> <board-variant>
222-
> Board Package: <path/to/board/package>/board-support-package
223-
> <board-variant2>
224-
> Board Package: <path/to/board/package>/board-support-package
225-
> ```
219+
> The build system will try to infer the FPGA family from the BSP name.
220+
> If it can't, an extra option needs to be passed to `cmake`: `-DDEVICE_FLAG=[A10|S10|Agilex7]`
221+
> **Note**: You can poll your system for available BSPs using the `aoc -list-boards` command. The board list that is printed out will be of the form
222+
> ```
223+
> $> aoc -list-boards
224+
> Board list:
225+
> <board-variant>
226+
> Board Package: <path/to/board/package>/board-support-package
227+
> <board-variant2>
228+
> Board Package: <path/to/board/package>/board-support-package
229+
> ```
226230
>
227231
> You will only be able to run an executable on the FPGA if you specified a BSP.
228232

‎DirectProgramming/C++SYCL_FPGA/ReferenceDesigns/cholesky_inversion/README.md‎

Lines changed: 22 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -183,15 +183,17 @@ Additionaly, the cmake build system can be configured using the following parame
183183
> ```
184184
> cmake .. -DFPGA_DEVICE=<board-support-package>:<board-variant> -DIS_BSP=1
185185
> ```
186-
> **Note**: You can poll your system for available BSPs using the `aoc -list-boards` command. The board list that is printed out will be of the form
187-
> ```
188-
> $> aoc -list-boards
189-
> Board list:
190-
> <board-variant>
191-
> Board Package: <path/to/board/package>/board-support-package
192-
> <board-variant2>
193-
> Board Package: <path/to/board/package>/board-support-package
194-
> ```
186+
> The build system will try to infer the FPGA family from the BSP name.
187+
> If it can't, an extra option needs to be passed to `cmake`: `-DDEVICE_FLAG=[A10|S10|Agilex7]`
188+
> **Note**: You can poll your system for available BSPs using the `aoc -list-boards` command. The board list that is printed out will be of the form
189+
> ```
190+
> $> aoc -list-boards
191+
> Board list:
192+
> <board-variant>
193+
> Board Package: <path/to/board/package>/board-support-package
194+
> <board-variant2>
195+
> Board Package: <path/to/board/package>/board-support-package
196+
> ```
195197
>
196198
> You will only be able to run an executable on the FPGA if you specified a BSP.
197199
@@ -235,15 +237,17 @@ Additionaly, the cmake build system can be configured using the following parame
235237
> ```
236238
> cmake -G "NMake Makefiles" .. -DFPGA_DEVICE=<board-support-package>:<board-variant> -DIS_BSP=1
237239
> ```
238-
> **Note**: You can poll your system for available BSPs using the `aoc -list-boards` command. The board list that is printed out will be of the form
239-
> ```
240-
> $> aoc -list-boards
241-
> Board list:
242-
> <board-variant>
243-
> Board Package: <path/to/board/package>/board-support-package
244-
> <board-variant2>
245-
> Board Package: <path/to/board/package>/board-support-package
246-
> ```
240+
> The build system will try to infer the FPGA family from the BSP name.
241+
> If it can't, an extra option needs to be passed to `cmake`: `-DDEVICE_FLAG=[A10|S10|Agilex7]`
242+
> **Note**: You can poll your system for available BSPs using the `aoc -list-boards` command. The board list that is printed out will be of the form
243+
> ```
244+
> $> aoc -list-boards
245+
> Board list:
246+
> <board-variant>
247+
> Board Package: <path/to/board/package>/board-support-package
248+
> <board-variant2>
249+
> Board Package: <path/to/board/package>/board-support-package
250+
> ```
247251
>
248252
> You will only be able to run an executable on the FPGA if you specified a BSP.
249253

‎DirectProgramming/C++SYCL_FPGA/ReferenceDesigns/crr/README.md‎

Lines changed: 22 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -171,15 +171,17 @@ This design measures the FPGA performance to determine how many assets can be pr
171171
> ```
172172
> cmake .. -DFPGA_DEVICE=<board-support-package>:<board-variant>
173173
> ```
174-
> **Note**: You can poll your system for available BSPs using the `aoc -list-boards` command. The board list that is printed out will be of the form
175-
> ```
176-
> $> aoc -list-boards
177-
> Board list:
178-
> <board-variant>
179-
> Board Package: <path/to/board/package>/board-support-package
180-
> <board-variant2>
181-
> Board Package: <path/to/board/package>/board-support-package
182-
> ```
174+
> The build system will try to infer the FPGA family from the BSP name.
175+
> If it can't, an extra option needs to be passed to `cmake`: `-DDEVICE_FLAG=[A10|S10|Agilex7]`
176+
> **Note**: You can poll your system for available BSPs using the `aoc -list-boards` command. The board list that is printed out will be of the form
177+
> ```
178+
> $> aoc -list-boards
179+
> Board list:
180+
> <board-variant>
181+
> Board Package: <path/to/board/package>/board-support-package
182+
> <board-variant2>
183+
> Board Package: <path/to/board/package>/board-support-package
184+
> ```
183185
>
184186
> You will only be able to run an executable on the FPGA if you specified a BSP.
185187
@@ -219,15 +221,17 @@ This design measures the FPGA performance to determine how many assets can be pr
219221
> ```
220222
> cmake -G "NMake Makefiles" .. -DFPGA_DEVICE=<board-support-package>:<board-variant>
221223
> ```
222-
> **Note**: You can poll your system for available BSPs using the `aoc -list-boards` command. The board list that is printed out will be of the form
223-
> ```
224-
> $> aoc -list-boards
225-
> Board list:
226-
> <board-variant>
227-
> Board Package: <path/to/board/package>/board-support-package
228-
> <board-variant2>
229-
> Board Package: <path/to/board/package>/board-support-package
230-
> ```
224+
> The build system will try to infer the FPGA family from the BSP name.
225+
> If it can't, an extra option needs to be passed to `cmake`: `-DDEVICE_FLAG=[A10|S10|Agilex7]`
226+
> **Note**: You can poll your system for available BSPs using the `aoc -list-boards` command. The board list that is printed out will be of the form
227+
> ```
228+
> $> aoc -list-boards
229+
> Board list:
230+
> <board-variant>
231+
> Board Package: <path/to/board/package>/board-support-package
232+
> <board-variant2>
233+
> Board Package: <path/to/board/package>/board-support-package
234+
> ```
231235
>
232236
> You will only be able to run an executable on the FPGA if you specified a BSP.
233237

‎DirectProgramming/C++SYCL_FPGA/ReferenceDesigns/db/README.md‎

Lines changed: 22 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -165,15 +165,17 @@ Query 12 showcases the `MergeJoin` database operator. The block diagram of the d
165165
> ```
166166
> cmake .. -DQUERY=<QUERY_NUMBER> -DFPGA_DEVICE=<board-support-package>:<board-variant>
167167
> ```
168-
> **Note**: You can poll your system for available BSPs using the `aoc -list-boards` command. The board list that is printed out will be of the form
169-
> ```
170-
> $> aoc -list-boards
171-
> Board list:
172-
> <board-variant>
173-
> Board Package: <path/to/board/package>/board-support-package
174-
> <board-variant2>
175-
> Board Package: <path/to/board/package>/board-support-package
176-
> ```
168+
> The build system will try to infer the FPGA family from the BSP name.
169+
> If it can't, an extra option needs to be passed to `cmake`: `-DDEVICE_FLAG=[A10|S10|Agilex7]`
170+
> **Note**: You can poll your system for available BSPs using the `aoc -list-boards` command. The board list that is printed out will be of the form
171+
> ```
172+
> $> aoc -list-boards
173+
> Board list:
174+
> <board-variant>
175+
> Board Package: <path/to/board/package>/board-support-package
176+
> <board-variant2>
177+
> Board Package: <path/to/board/package>/board-support-package
178+
> ```
177179
>
178180
> You will only be able to run an executable on the FPGA if you specified a BSP.
179181
@@ -223,15 +225,17 @@ Query 12 showcases the `MergeJoin` database operator. The block diagram of the d
223225
> ```
224226
> cmake -G "NMake Makefiles" .. -DQUERY=<QUERY_NUMBER> -DFPGA_DEVICE=<board-support-package>:<board-variant>
225227
> ```
226-
> **Note**: You can poll your system for available BSPs using the `aoc -list-boards` command. The board list that is printed out will be of the form
227-
> ```
228-
> $> aoc -list-boards
229-
> Board list:
230-
> <board-variant>
231-
> Board Package: <path/to/board/package>/board-support-package
232-
> <board-variant2>
233-
> Board Package: <path/to/board/package>/board-support-package
234-
> ```
228+
> The build system will try to infer the FPGA family from the BSP name.
229+
> If it can't, an extra option needs to be passed to `cmake`: `-DDEVICE_FLAG=[A10|S10|Agilex7]`
230+
> **Note**: You can poll your system for available BSPs using the `aoc -list-boards` command. The board list that is printed out will be of the form
231+
> ```
232+
> $> aoc -list-boards
233+
> Board list:
234+
> <board-variant>
235+
> Board Package: <path/to/board/package>/board-support-package
236+
> <board-variant2>
237+
> Board Package: <path/to/board/package>/board-support-package
238+
> ```
235239
>
236240
> You will only be able to run an executable on the FPGA if you specified a BSP.
237241

‎DirectProgramming/C++SYCL_FPGA/ReferenceDesigns/decompress/README.md‎

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -327,15 +327,17 @@ For `constexpr_math.hpp`, `memory_utils.hpp`, `metaprogramming_utils.hpp`, `tupl
327327
> ```
328328
> cmake .. -DFPGA_DEVICE=<board-support-package>:<board-variant> -DIS_BSP=1
329329
> ```
330-
> **Note**: You can poll your system for available BSPs using the `aoc -list-boards` command. The board list that is printed out will be of the form
331-
> ```
332-
> $> aoc -list-boards
333-
> Board list:
334-
> <board-variant>
335-
> Board Package: <path/to/board/package>/board-support-package
336-
> <board-variant2>
337-
> Board Package: <path/to/board/package>/board-support-package
338-
> ```
330+
> The build system will try to infer the FPGA family from the BSP name.
331+
> If it can't, an extra option needs to be passed to `cmake`: `-DDEVICE_FLAG=[A10|S10|Agilex7]`
332+
> **Note**: You can poll your system for available BSPs using the `aoc -list-boards` command. The board list that is printed out will be of the form
333+
> ```
334+
> $> aoc -list-boards
335+
> Board list:
336+
> <board-variant>
337+
> Board Package: <path/to/board/package>/board-support-package
338+
> <board-variant2>
339+
> Board Package: <path/to/board/package>/board-support-package
340+
> ```
339341
>
340342
> You will only be able to run an executable on the FPGA if you specified a BSP.
341343
@@ -384,6 +386,8 @@ For `constexpr_math.hpp`, `memory_utils.hpp`, `metaprogramming_utils.hpp`, `tupl
384386
> ```
385387
> cmake -G "NMake Makefiles" .. -DFPGA_DEVICE=<board-support-package>:<board-variant> -DIS_BSP=1
386388
> ```
389+
> The build system will try to infer the FPGA family from the BSP name.
390+
> If it can't, an extra option needs to be passed to `cmake`: `-DDEVICE_FLAG=[A10|S10|Agilex7]`
387391
> **Note**: You can poll your system for available BSPs using the `aoc -list-boards` command. The board list that is printed out will be of the form
388392
> ```
389393
> $> aoc -list-boards

‎DirectProgramming/C++SYCL_FPGA/ReferenceDesigns/gzip/README.md‎

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -160,15 +160,17 @@ Performance results are based on testing as of May 14, 2024.
160160
> ```
161161
> cmake .. -DFPGA_DEVICE=<board-support-package>:<board-variant> -DIS_BSP=1
162162
> ```
163-
> **Note**: You can poll your system for available BSPs using the `aoc -list-boards` command. The board list that is printed out will be of the form
164-
> ```
165-
> $> aoc -list-boards
166-
> Board list:
167-
> <board-variant>
168-
> Board Package: <path/to/board/package>/board-support-package
169-
> <board-variant2>
170-
> Board Package: <path/to/board/package>/board-support-package
171-
> ```
163+
> The build system will try to infer the FPGA family from the BSP name.
164+
> If it can't, an extra option needs to be passed to `cmake`: `-DDEVICE_FLAG=[A10|S10|Agilex7]`
165+
> **Note**: You can poll your system for available BSPs using the `aoc -list-boards` command. The board list that is printed out will be of the form
166+
> ```
167+
> $> aoc -list-boards
168+
> Board list:
169+
> <board-variant>
170+
> Board Package: <path/to/board/package>/board-support-package
171+
> <board-variant2>
172+
> Board Package: <path/to/board/package>/board-support-package
173+
> ```
172174
>
173175
> You will only be able to run an executable on the FPGA if you specified a BSP.
174176
@@ -215,6 +217,8 @@ Performance results are based on testing as of May 14, 2024.
215217
> ```
216218
> cmake -G "NMake Makefiles" .. -DFPGA_DEVICE=<board-support-package>:<board-variant> -DIS_BSP=1
217219
> ```
220+
> The build system will try to infer the FPGA family from the BSP name.
221+
> If it can't, an extra option needs to be passed to `cmake`: `-DDEVICE_FLAG=[A10|S10|Agilex7]`
218222
> **Note**: You can poll your system for available BSPs using the `aoc -list-boards` command. The board list that is printed out will be of the form
219223
> ```
220224
> $> aoc -list-boards

‎DirectProgramming/C++SYCL_FPGA/ReferenceDesigns/matmul/README.md‎

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -87,12 +87,12 @@ In our FPGA implementation, the multiply-accumulate operations are computed in a
8787
```c++
8888
#pragma unroll
8989
for (int row = 0; row < m_PE; row++) {
90-
#pragma unroll
91-
for (int col = 0; col < p_PE; col++) {
92-
  fed_a[i] = fpga_reg(fed_a[i]);
93-
  fed_b[j] = fpga_reg(fed_b[j]);
94-
  accum[i][j] += fed_a[i] * fed_b[j];
95-
  ...
90+
#pragma unroll
91+
for (int col = 0; col < p_PE; col++) {
92+
fed_a[i] = fpga_reg(fed_a[i]);
93+
fed_b[j] = fpga_reg(fed_b[j]);
94+
accum[i][j] += fed_a[i] * fed_b[j];
95+
...
9696
}
9797
}
9898
```
@@ -200,15 +200,17 @@ Additionaly, the cmake build system can be configured using the following parame
200200
> ```
201201
> cmake .. -DFPGA_DEVICE=<board-support-package>:<board-variant> -DIS_BSP=1
202202
> ```
203-
> **Note**: You can poll your system for available BSPs using the `aoc -list-boards` command. The board list that is printed out will be of the form
204-
> ```
205-
> $> aoc -list-boards
206-
> Board list:
207-
> <board-variant>
208-
> Board Package: <path/to/board/package>/board-support-package
209-
> <board-variant2>
210-
> Board Package: <path/to/board/package>/board-support-package
211-
> ```
203+
> The build system will try to infer the FPGA family from the BSP name.
204+
> If it can't, an extra option needs to be passed to `cmake`: `-DDEVICE_FLAG=[A10|S10|Agilex7]`
205+
> **Note**: You can poll your system for available BSPs using the `aoc -list-boards` command. The board list that is printed out will be of the form
206+
> ```
207+
> $> aoc -list-boards
208+
> Board list:
209+
> <board-variant>
210+
> Board Package: <path/to/board/package>/board-support-package
211+
> <board-variant2>
212+
> Board Package: <path/to/board/package>/board-support-package
213+
> ```
212214
>
213215
> You will only be able to run an executable on the FPGA if you specified a BSP.
214216
@@ -254,6 +256,8 @@ Additionaly, the cmake build system can be configured using the following parame
254256
> ```
255257
> cmake -G "NMake Makefiles" .. -DFPGA_DEVICE=<board-support-package>:<board-variant> -DIS_BSP=1
256258
> ```
259+
> The build system will try to infer the FPGA family from the BSP name.
260+
> If it can't, an extra option needs to be passed to `cmake`: `-DDEVICE_FLAG=[A10|S10|Agilex7]`
257261
> **Note**: You can poll your system for available BSPs using the `aoc -list-boards` command. The board list that is printed out will be of the form
258262
> ```
259263
> $> aoc -list-boards

0 commit comments

Comments
 (0)