Changes between Version 3 and Version 4 of OFDMReferenceDesign/SDK

Timestamp:

May 3, 2012, 3:25:32 PM (12 years ago)

Author:

murphpo

Comment:

--

OFDMReferenceDesign/SDK

@@ -5 +5 @@
 
 === Using the OFDM ref design .zip ===
-'''Setup'''
+'''Setup'''[[BR]]
 Before using a WARP reference design XPS or SDK project you must install the Xilinx tools and configure repository settings:
 
  * Install Xilinx ISE 13.4 System Edition (includes ISE, EDK, System Generator)
- * Checkout a copy of the WARP edk_user_repository
- * Add the WARP edk_user_repository to the global repositories in XPS (Edit->Preferences->Application) and SDK (Xilinx Tools->Repositories->Global Repositories).
+ * Checkout a copy of the WARP edk_user_repository to a local directory
+ * Add the WARP edk_user_repository to the global repositories in XPS (Edit->Preferences->Application) and SDK (Xilinx Tools->Repositories->Global Repositories). Close both XPS and SDK.
 
-'''Getting the project files'''
- * Download the reference design .zip file from the [wiki:../Changelog Download page].
+=== Project Files ===
+Download the reference design .zip file from the [wiki:../Changelog Download page].
 
-'''Using the XPS project'''
+The ref design archive includes both the XPS project (i.e. the hardware design) and SDK projects (i.e. the software designs). The archive folder structure is:
+{{{
+SDK/
+ |- SDK_Export/
+ |- SDK_Workspace/
+data/
+etc/
+pcores/
+platgen.opt
+system.make
+system.mhs
+system.xmp
+system_incl.make
+}}}
+
+=== Using the XPS project ===
 The ref design XPS project is at the root of the expanded .zip file, in the directory with the {{{system.xmp}}} and {{{system.mhs}}} files. Open {{{system.xmp}}} in XPS to explore or modify the XPS project.
 
-'''Using the SDK project'''
-Using the SDK requires configuring a workspace. Unfortunately workspaces are not portable. The ref design .zip file contains all the necessary project files to populate a workspace, but you must initialize your workspace first and import these project files manually.
+The project archive does not include the intermediate hardware implementation files (the {{{synthesis/}}}, {{{hdl/}}} and {{{implementation/}}} folders). These will be re-generated if you initiate the 'Generate Bitstream' process. However, this is '''not''' necessary if you only want to iterate on software. For this, refer to the SDK project instructions below.
 
-In the instructions below we'll use {{{<xps_proj>}}} to represent the path where you expanded the ref design .zip. If the XPS project file is in {{{C:\work\WARP\OFDM_RefDesign_FPGAv2_v17.0\system.xmp}}}, then you should use {{{C:\work\WARP\OFDM_RefDesign_FPGAv2_v17.0\}}} in place of {{{<xps_proj>}}} below.
+=== Using the SDK project ===
+The SDK is based on the idea of workspaces and projects. A workspace contains projects. A normal SDK project contains at least three projects:
+ * The hardware specification (auto-generated by XPS)
+ * The board support package (auto-geneated by SDK, derived from the hardware spec)
+ * Software projects (user code in an SDK-generated template)
+
+We have chosen the approach of having one SDK workspace per XPS project, so the SDK workspace always contains exactly one _hw_platform project and one _bsp project, both referenced to the parent XPS project.
+
+Unfortunately workspaces are not portable. The ref design .zip file contains all the necessary project files to populate a workspace, but you must initialize your workspace first and import these project files manually.
+
+In the instructions below we use {{{<xps_proj>}}} to represent the path where you expanded the ref design .zip. If the XPS project file is in {{{C:\work\WARP\OFDM_RefDesign_FPGAv2_v17.0\system.xmp}}}, then you should use {{{C:\work\WARP\OFDM_RefDesign_FPGAv2_v17.0\}}} in place of {{{<xps_proj>}}} below.
  * Launch the Xilinx SDK
    * If prompted to select a workspace, choose {{{<xps_proj>/SDK/SDK_Workspace}}}