Skip to content

Commit c217844

Browse files
committed
Make small updates to READMEs
1 parent 2ac3690 commit c217844

File tree

6 files changed

+25
-73
lines changed

6 files changed

+25
-73
lines changed

DirectProgramming/C++SYCL_FPGA/ReferenceDesigns/fft2d/README.md

Lines changed: 3 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -216,39 +216,29 @@ Additionally, the `cmake` build system can be configured using the following par
216216
217217
### On Linux
218218
219-
#### Run on FPGA Emulator
220-
221219
1. Run the sample on the FPGA emulator (the kernel executes on the CPU).
222220
```
223221
./fft2d.fpga_emu
224222
```
225223
226-
#### Run on FPGA Simulator
227-
228-
1. Run the sample on the FPGA simulator.
224+
2. Run the sample on the FPGA simulator.
229225
```
230226
CL_CONTEXT_MPSIM_DEVICE_INTELFPGA=1 ./fft2d.fpga_sim
231227
```
232228
233-
#### Run on FPGA
234-
235-
1. Run the sample on the FPGA device (only if you ran `cmake` with `-DFPGA_DEVICE=<board-support-package>:<board-variant>`).
229+
3. Run the sample on the FPGA device (only if you ran `cmake` with `-DFPGA_DEVICE=<board-support-package>:<board-variant>`).
236230
```
237231
./fft2d.fpga
238232
```
239233
240234
### On Windows
241235
242-
#### Run on FPGA Emulator
243-
244236
1. Run the sample on the FPGA emulator (the kernel executes on the CPU).
245237
```
246238
fft2d.fpga_emu.exe
247239
```
248240
249-
#### Run on FPGA Simulator
250-
251-
1. Run the sample on the FPGA simulator.
241+
2. Run the sample on the FPGA simulator.
252242
```
253243
set CL_CONTEXT_MPSIM_DEVICE_INTELFPGA=1
254244
fft2d.fpga_sim.exe

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

Lines changed: 3 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -307,39 +307,29 @@ You can perform the multiplication of the set of matrices repeatedly. This step
307307
308308
### On Linux
309309
310-
#### Run on FPGA Emulator
311-
312310
1. Run the sample on the FPGA emulator (the kernel executes on the CPU).
313311
```
314312
./matmul.fpga_emu
315313
```
316314
317-
#### Run on FPGA Simulator
318-
319-
1. Run the sample on the FPGA simulator.
315+
2. Run the sample on the FPGA simulator.
320316
```
321317
CL_CONTEXT_MPSIM_DEVICE_INTELFPGA=1 ./matmul.fpga_sim
322318
```
323319
324-
#### Run on FPGA
325-
326-
1. Run the sample on the FPGA device (only if you ran `cmake` with `-DFPGA_DEVICE=<board-support-package>:<board-variant>`).
320+
3. Run the sample on the FPGA device (only if you ran `cmake` with `-DFPGA_DEVICE=<board-support-package>:<board-variant>`).
327321
```
328322
./matmul.fpga
329323
```
330324
331325
### On Windows
332326
333-
#### Run on FPGA Emulator
334-
335327
1. Run the sample on the FPGA emulator (the kernel executes on the CPU).
336328
```
337329
matmul.fpga_emu.exe
338330
```
339331
340-
#### Run on FPGA Simulator
341-
342-
1. Run the sample on the FPGA simulator.
332+
2. Run the sample on the FPGA simulator.
343333
```
344334
set CL_CONTEXT_MPSIM_DEVICE_INTELFPGA=1
345335
matmul.fpga_sim.exe

DirectProgramming/C++SYCL_FPGA/ReferenceDesigns/pca/README.md

Lines changed: 3 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -427,39 +427,29 @@ Additionally, the `cmake` build system can be configured using the following par
427427
428428
### On Linux
429429
430-
#### Run on FPGA Emulator
431-
432430
1. Run the sample on the FPGA emulator (the kernel executes on the CPU).
433431
```
434432
./pca.fpga_emu <path to data/abalone.csv>
435433
```
436434
437-
#### Run on FPGA Simulator
438-
439-
1. Run the sample on the FPGA simulator.
435+
2. Run the sample on the FPGA simulator.
440436
```
441437
CL_CONTEXT_MPSIM_DEVICE_INTELFPGA=1 ./pca.fpga_sim <path to data/abalone.csv>
442438
```
443439
444-
#### Run on FPGA
445-
446-
1. Run the sample on the FPGA device (only if you ran `cmake` with `-DFPGA_DEVICE=<board-support-package>:<board-variant>`).
440+
3. Run the sample on the FPGA device (only if you ran `cmake` with `-DFPGA_DEVICE=<board-support-package>:<board-variant>`).
447441
```
448442
./pca.fpga <path to data/abalone.csv>
449443
```
450444
451445
### On Windows
452446
453-
#### Run on FPGA Emulator
454-
455447
1. Run the sample on the FPGA emulator (the kernel executes on the CPU).
456448
```
457449
pca.fpga_emu.exe <path to data/abalone.csv>
458450
```
459451
460-
#### Run on FPGA Simulator
461-
462-
1. Run the sample on the FPGA simulator.
452+
2. Run the sample on the FPGA simulator.
463453
```
464454
set CL_CONTEXT_MPSIM_DEVICE_INTELFPGA=1
465455
pca.fpga_sim.exe <path to data/abalone.csv>

DirectProgramming/C++SYCL_FPGA/ReferenceDesigns/qrd/README.md

Lines changed: 7 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -253,43 +253,33 @@ You can perform the QR decomposition of the set of matrices repeatedly. This ste
253253
254254
### On Linux
255255
256-
#### Run on FPGA Emulator
257-
258-
1. Increase the amount of memory that the emulator runtime is permitted to allocate by exporting the `CL_CONFIG_CPU_FORCE_PRIVATE_MEM_SIZE` environment variable before running the executable.
259-
2. Run the sample on the FPGA emulator (the kernel executes on the CPU).
256+
1. Run the sample on the FPGA emulator (the kernel executes on the CPU).
260257
```
261258
export CL_CONFIG_CPU_FORCE_PRIVATE_MEM_SIZE=32MB
262259
./qrd.fpga_emu
263260
```
261+
* Increase the amount of memory that the emulator runtime is permitted to allocate by exporting the `CL_CONFIG_CPU_FORCE_PRIVATE_MEM_SIZE` environment variable before running the executable.
264262
265-
#### Run on FPGA Simulator
266-
267-
1. Run the sample on the FPGA simulator.
263+
2. Run the sample on the FPGA simulator.
268264
```
269265
CL_CONTEXT_MPSIM_DEVICE_INTELFPGA=1 ./qrd.fpga_sim
270266
```
271267
272-
#### Run on FPGA
273-
274-
1. Run the sample on the FPGA device (only if you ran `cmake` with `-DFPGA_DEVICE=<board-support-package>:<board-variant>`).
268+
3. Run the sample on the FPGA device (only if you ran `cmake` with `-DFPGA_DEVICE=<board-support-package>:<board-variant>`).
275269
```
276270
./qrd.fpga
277271
```
278272
279273
### On Windows
280274
281-
#### Run on FPGA Emulator
282-
283-
1. Increase the amount of memory that the emulator runtime is permitted to allocate by setting the `CL_CONFIG_CPU_FORCE_PRIVATE_MEM_SIZE` environment variable before running the executable.
284-
2. Run the sample on the FPGA emulator (the kernel executes on the CPU).
275+
1. Run the sample on the FPGA emulator (the kernel executes on the CPU).
285276
```
286277
set CL_CONFIG_CPU_FORCE_PRIVATE_MEM_SIZE=32MB
287278
qrd.fpga_emu.exe
288279
```
280+
* Increase the amount of memory that the emulator runtime is permitted to allocate by setting the `CL_CONFIG_CPU_FORCE_PRIVATE_MEM_SIZE` environment variable before running the executable.
289281
290-
#### Run on FPGA Simulator
291-
292-
1. Run the sample on the FPGA simulator.
282+
2. Run the sample on the FPGA simulator.
293283
```
294284
set CL_CONTEXT_MPSIM_DEVICE_INTELFPGA=1
295285
qrd.fpga_sim.exe

DirectProgramming/C++SYCL_FPGA/ReferenceDesigns/qri/README.md

Lines changed: 7 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -244,43 +244,33 @@ You can perform the QR-based inversion of the set of matrices repeatedly, as sho
244244
245245
### On Linux
246246
247-
#### Run on FPGA Emulator
248-
249-
1. Increase the amount of memory that the emulator runtime is permitted to allocate by exporting the `CL_CONFIG_CPU_FORCE_PRIVATE_MEM_SIZE` environment variable before running the executable.
250-
2. Run the sample on the FPGA emulator (the kernel executes on the CPU).
247+
1. Run the sample on the FPGA emulator (the kernel executes on the CPU).
251248
```
252249
export CL_CONFIG_CPU_FORCE_PRIVATE_MEM_SIZE=32MB
253250
./qri.fpga_emu
254251
```
252+
* Increase the amount of memory that the emulator runtime is permitted to allocate by exporting the `CL_CONFIG_CPU_FORCE_PRIVATE_MEM_SIZE` environment variable before running the executable.
255253
256-
#### Run on FPGA Simulator
257-
258-
1. Run the sample on the FPGA simulator.
254+
2. Run the sample on the FPGA simulator.
259255
```
260256
CL_CONTEXT_MPSIM_DEVICE_INTELFPGA=1 ./qri.fpga_sim
261257
```
262258
263-
#### Run on FPGA
264-
265-
1. Run the sample on the FPGA device (only if you ran `cmake` with `-DFPGA_DEVICE=<board-support-package>:<board-variant>`).
259+
3. Run the sample on the FPGA device (only if you ran `cmake` with `-DFPGA_DEVICE=<board-support-package>:<board-variant>`).
266260
```
267261
./qri.fpga
268262
```
269263
270264
### On Windows
271265
272-
#### Run on FPGA Emulator
273-
274-
1. Increase the amount of memory that the emulator runtime is permitted to allocate by setting the `CL_CONFIG_CPU_FORCE_PRIVATE_MEM_SIZE` environment variable before running the executable.
275-
2. Run the sample on the FPGA emulator (the kernel executes on the CPU).
266+
1. Run the sample on the FPGA emulator (the kernel executes on the CPU).
276267
```
277268
set CL_CONFIG_CPU_FORCE_PRIVATE_MEM_SIZE=32MB
278269
qri.fpga_emu.exe
279270
```
271+
* Increase the amount of memory that the emulator runtime is permitted to allocate by setting the `CL_CONFIG_CPU_FORCE_PRIVATE_MEM_SIZE` environment variable before running the executable.
280272
281-
#### Run on FPGA Simulator
282-
283-
1. Run the sample on the FPGA simulator.
273+
2. Run the sample on the FPGA simulator.
284274
```
285275
set CL_CONTEXT_MPSIM_DEVICE_INTELFPGA=1
286276
qri.fpga_sim.exe

DirectProgramming/C++SYCL_FPGA/Tutorials/Tools/use_library/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -238,6 +238,8 @@ Note that the library files (\*.a) must be included after all of the cpp files i
238238
CL_CONTEXT_MPSIM_DEVICE_INTELFPGA=1 ./use_library.fpga_sim
239239
```
240240
241+
> **Note**: Running this sample on an actual FPGA device requires a BSP that supports host pipes. As there are currently no commercial BSPs with such support, only the SYCL HLS flow is enabled for this code sample.
242+
241243
### On Windows
242244
243245
1. Run the sample on the FPGA emulator (the kernel executes on the CPU).

0 commit comments

Comments
 (0)