________________________________________________________________________
	  Example SDRAM Controller Design Read Me
-------------------------------------------------------------------------
Object device:GW1NR-LV4QN88C6/I5
---------------------------------------------------------------------------
File List:
---------------------------------------------------------------------------
.
|-- doc
|   `-- Readme.txt                          -->  Read Me file (this file)
|-- tb 
|   `-- tb.v                                -->  TestBench for Example SDRAM Controller design
|-- project
|   `-- SDRAM_Controller_top.gprj          	   -->  GowinYunYuan Project File for Example Design
|   `-- SDRAM_Controller_top.gprj.user         -->  GowinYunYuan Project File for Example Design
|   |-- impl
|   |   `-- dualpin_config.ini
|   |   |-- pnr
|   |   `-- pnr_config.ini             -->  GowinYunYuan Place & Route Config File for Example Design
|   |   `-- synthesis_config.ini       -->  Synplify_Pro Config File for Example Design
|   |   |-- synthesize
|   |-- src                          
|       |-- sdrc_defines.v               -->  File for GowinYunYuan Project 
|       |-- sdrc_interface_used.v        -->  File for GowinYunYuan Project
|       |-- sdrc_interface_test_top.v    -->  File for GowinYunYuan Project
|       |-- sdrc.cst                    -->  File for GowinYunYuan Project
|       |-- sdrc.sdc                    -->  File for GowinYunYuan Project
|       |-- gw_pll                       
|       |   |-- gw_pll.v                 -->  File for GowinYunYuan Project
|       |   `-- gw_pll.ipc               -->  File for GowinYunYuan Project
|       |   `-- gw_pll.mod               -->  File for GowinYunYuan Project
|       `-- SDRAM_controller_top_SIP          
|           |-- SDRAM_controller_top_SIP.v   -->  File for GowinYunYuan Project(Encrypted)
|           `-- SDRAM_controller_top_SIP.ipc -->  File for GowinYunYuan Project
|           |-- temp                         -->  File for GowinYunYuan Project
|-- simulation                               --> Simulation Environment
 
---------------------------------------------------------------------------------------------------------------
Complier Directives\Parameters used:
---------------------------------------------------------------------------------------------------------------
`define SDRAM_DATA_WIDTH	>> Defines the SDRAM Data Width;

`define SDRAM_BANK_WIDTH	>> Defines the SDRAM Bank Width;

`define SDRAM_ADDR_ROW_WIDTH	>> Defines the SDRAM Row Address Width;

`define SDRAM_ADDR_COLUMN_WIDTH	>> Defines the SDRAM Column Address Width;


---------------------------------------------------------------------------------------------------------------
HOW TO OPEN A PROJECT IN GowinYunYuan:
---------------------------------------------------------------------------------------------------------------
1. Unzip the respective design files.
2. Launch GowinYunYuan and select "File -> Open -> Project"
3. In the Open Project dialog, enter the Project location -- "project",select select the project"SDRAM_Controller_top.gprj".
4. Click Finish. Now the project is successfully loaded. 

---------------------------------------------------------------------------------------------------------------
HOW TO RUN SYNTHESIZE, PLACE AND ROUTE, IP CORE GENERATION, AND TIMING ANALYSIS IN GowinYunYuan:
---------------------------------------------------------------------------------------------------------------

1. Click the Process tab in the process panel of the GowinYunYuan dashboard. 
   Double click on Synthsize(Synplify Pro). This will bring the design through synthesis.
2. Click the Process tab in the process panel of the GowinYunYuan dashboard. 
   Double click on Place & Route. This will bring the design through mapping, place and route.
3. Once Place & Route is done, user can double click on Timing Analysis Report to get 
   the timing analysis result.
4. Click on "Project -> Configuration -> Place & Route" to configurate the Post-Place File 
   and SDF File of the design.
----------------------------------------------------------------------------------------------------------------

HOW TO RUN SIMULATION
1. User can run functional simulation by software VCS. 
2. User can check waveform by software Verdi.
----------------------------------------------------------------------------------------------------------------

HOW TO  GENERATE IP CORE
1. Click the IP Core Generator tab in the Window panel of the GowinYunYuan dashboard.
   Double click on "SDRAM Controller(With embedded SDRAM)/SDRAM Controller(With external SDRAM)". This will generate the IP Core for the design.
--------------------------------------------------------------------------------------------------------------

