Skip to content

Commit 2262ecb

Browse files
FPGA: Remove all references to Windows in README (#1273)
1 parent f29e3c7 commit 2262ecb

File tree

1 file changed

+2
-56
lines changed
  • DirectProgramming/C++SYCL_FPGA/Tutorials/DesignPatterns/shannonization

1 file changed

+2
-56
lines changed

DirectProgramming/C++SYCL_FPGA/Tutorials/DesignPatterns/shannonization/README.md

+2-56
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ This tutorial describes the process of _Shannonization_ (named after [Claude Sha
33

44
| Optimized for | Description
55
|:--- |:---
6-
| OS | Linux* Ubuntu* 18.04/20.04 <br> RHEL*/CentOS* 8 <br> SUSE* 15 <br> Windows* 10
6+
| OS | Linux* Ubuntu* 18.04/20.04 <br> RHEL*/CentOS* 8 <br> SUSE* 15
77
| Hardware | Intel&reg; Programmable Acceleration Card (PAC) with Intel Arria&reg; 10 GX FPGA <br> Intel&reg; FPGA Programmable Acceleration Card (PAC) D5005 (with Intel Stratix&reg; 10 SX) <br> Intel&reg; FPGA 3rd party / custom platforms with oneAPI support <br> *__Note__: Intel&reg; FPGA PAC hardware is only compatible with Ubuntu 18.04*
88
| Software | Intel® oneAPI DPC++/C++ Compiler
99
| What you will learn | How to make FPGA-specific optimizations to remove computation from the critical path and improve f<sub>MAX</sub>/II
@@ -154,11 +154,7 @@ To achieve an II of 1 for the main `while` loop in the FPGA code shown above, th
154154
> - For private installations: ` . ~/intel/oneapi/setvars.sh`
155155
> - For non-POSIX shells, like csh, use the following command: `bash -c 'source <install-dir>/setvars.sh ; exec csh'`
156156
>
157-
> Windows*:
158-
> - `C:\Program Files(x86)\Intel\oneAPI\setvars.bat`
159-
> - Windows PowerShell*, use the following command: `cmd.exe "/K" '"C:\Program Files (x86)\Intel\oneAPI\setvars.bat" && powershell'`
160-
>
161-
> For more information on configuring environment variables, see [Use the setvars Script with Linux* or macOS*](https://www.intel.com/content/www/us/en/develop/documentation/oneapi-programming-guide/top/oneapi-development-environment-setup/use-the-setvars-script-with-linux-or-macos.html) or [Use the setvars Script with Windows*](https://www.intel.com/content/www/us/en/develop/documentation/oneapi-programming-guide/top/oneapi-development-environment-setup/use-the-setvars-script-with-windows.html).
157+
> For more information on configuring environment variables, see [Use the setvars Script with Linux* or macOS*](https://www.intel.com/content/www/us/en/develop/documentation/oneapi-programming-guide/top/oneapi-development-environment-setup/use-the-setvars-script-with-linux-or-macos.html).
162158
### On a Linux* System
163159
164160
1. Generate the `Makefile` by running `cmake`.
@@ -200,48 +196,6 @@ To achieve an II of 1 for the main `while` loop in the FPGA code shown above, th
200196
```
201197
3. (Optional) As the above hardware compile may take several hours to complete, FPGA precompiled binaries (compatible with Linux* Ubuntu* 18.04) can be downloaded <a href="https://iotdk.intel.com/fpga-precompiled-binaries/latest/shannonization.fpga.tar.gz" download>here</a>.
202198
203-
### On a Windows* System
204-
205-
1. Generate the `Makefile` by running `cmake`.
206-
```
207-
mkdir build
208-
cd build
209-
```
210-
To compile for the Intel&reg; PAC with Intel Arria&reg; 10 GX FPGA, run `cmake` using the command:
211-
```
212-
cmake -G "NMake Makefiles" ..
213-
```
214-
Alternatively, to compile for the Intel&reg; FPGA PAC D5005 (with Intel Stratix&reg; 10 SX), run `cmake` using the command:
215-
216-
```
217-
cmake -G "NMake Makefiles" .. -DFPGA_DEVICE=intel_s10sx_pac:pac_s10
218-
```
219-
You can also compile for a custom FPGA platform. Ensure that the board support package is installed on your system. Then run `cmake` using the command:
220-
```
221-
cmake -G "NMake Makefiles" .. -DFPGA_DEVICE=<board-support-package>:<board-variant>
222-
```
223-
224-
2. Compile the design through the generated `Makefile`. The following build targets are provided, matching the recommended development flow:
225-
226-
* Compile for emulation (fast compile time, targets emulated FPGA device):
227-
```
228-
nmake fpga_emu
229-
```
230-
* Compile for simulation (fast compile time, targets simulator FPGA device):
231-
```
232-
nmake fpga_sim
233-
```
234-
* Generate the optimization report:
235-
```
236-
nmake report
237-
```
238-
* Compile for FPGA hardware (longer compile time, targets FPGA device):
239-
```
240-
nmake fpga
241-
```
242-
243-
*Note:* The Intel&reg; PAC with Intel Arria&reg; 10 GX FPGA and Intel&reg; FPGA PAC D5005 (with Intel Stratix&reg; 10 SX) do not support Windows*. Compiling to FPGA hardware on Windows* requires a third-party or custom Board Support Package (BSP) with Windows* support.
244-
245199
## Examining the Reports
246200
This section will walk through how the HTML reports show the result of the optimizations we made in each version of the kernel, the definition of which can be found in `src/IntersectionKernel.hpp`. Start by locating `report.html` in the `shannonization_report.prj/reports/` directory. Open the report in Chrome*, Firefox*, Edge*, or Internet Explorer*. The f<sub>MAX</sub> numbers mentioned in these sections assume that the Arria&reg; 10 GX FPGA is the target. However, the discussion is similar for the Stratix&reg; 10 SX FPGA.
247201
@@ -326,23 +280,15 @@ As a consequence of the fabric architecture of the Intel Stratix&reg; 10 SX FPGA
326280
1. Run the sample on the FPGA emulator (the kernel executes on the CPU):
327281
```
328282
./shannonization.fpga_emu (Linux)
329-
shannonization.fpga_emu.exe (Windows)
330283
```
331284
2. Run the sample on the FPGA simulator device:
332285
* On Linux
333286
```
334287
CL_CONTEXT_MPSIM_DEVICE_INTELFPGA=1 ./shannonization.fpga_sim
335288
```
336-
* On Windows
337-
```
338-
set CL_CONTEXT_MPSIM_DEVICE_INTELFPGA=1
339-
shannonization.fpga_sim.exe
340-
set CL_CONTEXT_MPSIM_DEVICE_INTELFPGA=
341-
```
342289
3. Run the sample on the FPGA device:
343290
```
344291
./shannonization.fpga (Linux)
345-
shannonization.fpga.exe (Windows)
346292
```
347293
348294
### Application Parameters

0 commit comments

Comments
 (0)