
________________________________________________________________________
	  Example I3C Master/Slave Design Read Me
-------------------------------------------------------------------------
Object device:GW1N-LV9LQ144C6/I5
---------------------------------------------------------------------------
File List:
---------------------------------------------------------------------------
.
|-- doc
|   `-- write.txt			-->  Read Me file (this file)
|--	tb
|   `-- tb.v						-->  TestBench for Example I3C Master to I3C Slave design
|-- `simulation 
|   `-- prim_sim.v					-->  Verilog simulation File for tb
|	`--	vcs.sh						-->	 Script file
|	`--	verdi.sh					-->	 Script file
|-- project_M
|   `-- master.gprj				-->  GowinYunYuan Project File for Example I3C Master Design
|   `-- master.gprj.user		-->  GowinYunYuan Project File for Example I3C Master Design
|   |-- impl
|   |   `-- dualpin_config.ini
|   |   |-- pnr
|   |   `-- pnr_config.ini             -->  GowinYunYuan Place & Route Config File for Example I3C Master Design
|   |   `-- synthesis_config.ini       -->  Synplify_Pro Config File for Example I3C Master Design
|   |   |-- synthesize
|   |-- src                          
|		|-- dejitter.sv				-->  File for GowinYunYuan Project
|		|-- parameter.v				-->  File for GowinYunYuan Project
|		|-- master.v				-->  File for GowinYunYuan Project
|       |-- dk_start_ge1n4.cst		-->  File for GowinYunYuan Project
|       |-- fdc.fdc					-->  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
|       `-- i3c_hdr                       
|           |-- i3c_hdr.v			-->  File for GowinYunYuan Project
|           |-- i3c_hdr.vo			-->  File for GowinYunYuan Project
|           `-- i3c_hdr.ipc			-->  File for GowinYunYuan Project
|-- project_S
|   `-- slave.gprj					-->  GowinYunYuan Project File for Example I3C Slave Design
|   `-- slave.gprj.user				-->  GowinYunYuan Project File for Example I3C Slave Design
|   |-- impl
|   |   `-- dualpin_config.ini
|   |   |-- pnr
|   |   `-- pnr_config.ini             -->  GowinYunYuan Place & Route Config File for Example I3C Slave Design
|   |   `-- synthesis_config.ini       -->  Synplify_Pro Config File for Example I3C Slave Design
|   |   |-- synthesize
|   |-- src                          
|		|-- dejitter.sv				-->  File for GowinYunYuan Project
|		|-- parameter.v				-->  File for GowinYunYuan Project
|		|-- master.v				-->  File for GowinYunYuan Project
|       |-- dk_start_ge1n4.cst		-->  File for GowinYunYuan Project
|       |-- fdc.fdc					-->  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
|       `-- i3c_hdr                       
|           |-- i3c_hdr.v			-->  File for GowinYunYuan Project
|           |-- i3c_hdr.vo			-->  File for GowinYunYuan Project
|           `-- i3c_hdr.ipc			-->  File for GowinYunYuan Project
 
---------------------------------------------------------------------------------------------------------------
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"*.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 "I3C". This will generate the IP Core for the design.
--------------------------------------------------------------------------------------------------------------

