MOD: moved sdk sources according to the digilent-vivado-scripts flow

MOD: removed hw_handoff according to the flow
FIX: pulled in changes from vivado-library to fix CSI-2 ILA timing issue, also documented in the ila_timing_workaround.tcl

.gitignore

@@ -45,33 +45,10 @@ src/ip/*/**
 !src/other
 !src/other/**
 
-# NEW-WAY sdk application sources
+# sdk application sources
 # sdk/**
 # !sdk/appsrc
 # !sdk/appsrc/**
 
-# OLD-WAY sdk exclusions
-sdk/.metadata
-sdk/**/*RemoteSystemsTempFiles
-sdk/**/*Debug/*
-sdk/**/*Release
-sdk/**/*webtalk
-sdk/.sdk
-sdk/*.log
-# ignore everything in the hw_platform
-sdk/*hw_platform*/*
-# except
-!sdk/*hw_platform*/*.hdf
-!sdk/*hw_platform*/.*project
-# ignore everything in the BSP
-sdk/*_bsp*/*
-# except
-!sdk/*_bsp*/system.mss
-!sdk/*_bsp*/Makefile
-!sdk/*_bsp*/.*project
-# include the relevant elf files
-!sdk/**/*Debug/*.elf
-!sdk/**/*Debug/*.elf.size
-
 # maintain required directories
 !**/.keep

README.md

@@ -1,6 +1,72 @@
-# Zybo Z7-20 Pcam 5C Demo Project 
-Created for Vivado 2017.4
+Zybo Z7 -20 Pcam 5C Demo
+====================
 
-Wiki page: https://reference.digilentinc.com/learn/programmable-logic/tutorials/zybo-z7-pcam-5c-demo/start
+Description
+-----------
 
-Digilent Demo Project How-to: https://reference.digilentinc.com/learn/programmable-logic/tutorials/github-demos/start
+ The Zybo Z7 Pcam 5C project demonstrates the usage of the Pcam 5C as a video source by forwarding the streaming image data out to the HDMI TX port. Video data streams in through the Pcam port and out through the HDMI source (TX) port. A UART interface is available to configure the image sensor and additional post processing IP Cores.
+
+
+Requirements
+------------
+* **Zybo Z7 -20**
+* **Pcam 5C**
+* **Monitor with HDMI/DVI input**
+* **Vivado 2018.2 Installation with Xilinx SDK**: To set up Vivado, see the [Installing Vivado and Digilent Board Files Tutorial](https://reference.digilentinc.com/vivado/installing-vivado/start).
+
+Demo Setup
+----------
+
+1. Download the most recent release ZIP archive ("Zybo-Z7-20-Pcam-5C-2018.2-*.zip") from the repo's [releases page](https://github.com/Digilent/Zybo-Z7-20-pcam-5c/releases).
+2. Extract the downloaded ZIP.
+3. Open the XPR project file, found at \<archive extracted location\>/vivado_proj/Zybo-Z7-20-pcam-5c.xpr, included in the extracted release archive in Vivado 2018.2.
+4. In the toolbar at the top of the Vivado window, select **File -> Export -> Export Hardware**. Select **\<Local to Project\>** as the Exported Location and make sure that the **Include bitstream** box is checked, then click **OK**.
+5. In the toolbar at the top of the Vivado window, select **File -> Launch SDK**. Select **\<Local to Project\>** as both the workspace location and exported location, then click **OK**.
+6. With Vivado SDK opened, wait for the hardware platform exported by Vivado to be imported.
+7. In the toolbar at the top of the SDK window, select **File -> New -> Application Project**.
+8. Fill out the fields in the first page of the New Application Project Wizard as in the table below. Most of the listed values will be the wizard's defaults, but are included in the table for completeness.
+
+| Setting                                 | Value                                     |
+| --------------------------------------- | ----------------------------------------- |
+| Project Name                            | pcam_vdma_hdmi                            |
+| Use default location                    | Checked box                               |
+| OS Platform                             | standalone                                |
+| Target Hardware: Hardware Platform      | system_wrapper_hw_platform_0              |
+| Target Hardware: Processor              | (default)                                 |
+| Target Software: Language               | C                                         |
+| Target Software: Board Support Package  | Create New (pcam_vdma_hdmi_bsp)           |
+
+9. Click **Next**.
+10. From the list of template applications, select "Empty Application", then click **Finish**.
+11. In the Project Explorer pane to the left of the SDK window, expand the new application project (named "Npcam_vdma_hdmi").
+12. Right click on the "src" subdirectory of the application project and select **Import**.
+13. In the "Select an import wizard" pane of the window that pops up, expand **General** and select **File System**. Then click **Next**.
+14. Fill out the fields of the "File system" screen as in the table below. Most of the listed values will be the defaults, but are included in the table for completeness.
+
+| Setting                                                | Value                                                     |
+| -                                                      | -                                                         |
+| From directory                                         | \<archive extracted location\>/sdk_appsrc/pcam_vdma_hdmi  |
+| Files to import pane: sdk_appsrc                       | Checked box                                               |
+| Into folder                                            | pcam_vdma_hdmi/src                                        |
+| Options: Overwrite existing resources without warning  | Checked box                                               |
+| Options: Create top-level folder                       | Unchecked box                                             |
+
+15. Click **Finish**.
+
+16. Repeat to create a new Application Project for the sdk_appsrc/fsbl source
+
+16. Open a serial terminal application (such as TeraTerm) and connect it to the Zybo Z7's serial port, using a baud rate of 115200.
+17. In the toolbar at the top of the SDK window, select **Xilinx -> Program FPGA**. Leave all fields as their defaults and click "Program".
+18. In the Project Explorer pane, right click on the "pcam_vdma_hdmi" application project and select "Run As -> Launch on Hardware (System Debugger)".
+19. The application will now be running on the Zybo Z7. It can be interacted with as described in the first section of this README.
+
+Next Steps
+----------
+This demo can be used as a basis for other projects by modifying the hardware platform in the Vivado project's block design or by modifying the SDK application project.
+Check out the wiki page of the demo [here](https://reference.digilentinc.com/learn/programmable-logic/tutorials/zybo-z7-pcam-5c-demo/start).
+
+For technical support or questions, please post on the [Digilent Forum](forum.digilentinc.com).
+
+Additional Notes
+----------------
+For more information on how this project is version controlled, refer to the [digilent-vivado-scripts repo](https://github.com/digilent/digilent-vivado-scripts).