________________________________________________________________________
	  Example I3C Dual Clock Design Read Me
-------------------------------------------------------------------------
Object device:GW1NS-4CQFN48
---------------------------------------------------------------------------
File List:
---------------------------------------------------------------------------
.
|-- docs
|   `-- Readme.txt                      	-->  Read Me file (this file)
|-- tb 
|   `-- tm_modelsim.v                       -->  TestBench for Example I3C Dual Clock design of modelsim
|   `-- tm_vcs.v                            -->  TestBench for Example I3C Dual Clock design of VCS
|   `-- ts.v                                -->  Slave operation of I3C
|   `-- c_model			                    -->  C drive of Example I3C Dual Clock design
|-- project
|   `-- I3C_M3_INI.gprj          		    -->  Gowin Project File for Example Design
|   `-- I3C_M3_INI.gprj.user           	    -->  Gowin Project File for Example Design
|   |-- impl
|   |-- src                                 -->  File for Gowin Project in it
|   |   |-- gowin_empu
|   |   |   |-- gowin_empu.ipc
|   |   |   |-- gowin_empu.v
|   |   |   |-- gowin_empu.vo
|   |   |-- gowin_pllvr_fclk
|   |   |   |-- gowin_pllvr_fclk.ipc
|   |   |   |-- gowin_pllvr_fclk.v
|   |   |-- gowin_pllvr_i3c
|   |   |   |-- gowin_pllvr_i3c.ipc
|   |   |   |-- gowin_pllvr_i3c.v
|   |   |-- i3c_dual_clock
|   |   |   |-- i3c_dual_clock.ipc
|   |   |   |-- i3c_dual_clock.v
|   |   |   |-- i3c_dual_clock.vo
|   |   |-- Gowin_EMPU_Template.v
|   |   |-- I3C_M3_INI.cst
|   |   |-- I3C_M3_INI.sdc
|-- simulation
|   `-- Modelsim
|   |   |-- cmd.do					        -->  Command script
|   |   |-- wave.do					        -->  Wave script
|   `-- VCS_SIM
|   |   |-- Makefile					    -->  Command script
---------------------------------------------------------------------------------------------------------------
HOW TO OPEN A PROJECT IN Gowin:
---------------------------------------------------------------------------------------------------------------
1. Unzip the respective design files.
2. Launch Gowin and select "File -> Open -> Project"
3. In the Open Project dialog, enter the Project location -- "project",select the project"I3C_M3_INI.gprj".
4. Click Finish. Now the project is successfully loaded. 

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

1. Click the Process tab in the process panel of the Gowin dashboard. 
   Double click on Synthesize. This will bring the design through synthesis.
2. Click the Process tab in the process panel of the Gowin 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.
----------------------------------------------------------------------------------------------------------------

HOW TO RUN SIMULATION
1. User can run functional simulation by software VCS or modelsim. 
2. User can check waveform by software Verdi or modelsim.
3. During the simulation, the user needs to add prim_sim.v in the "Gowin" to the directory of "tb".
   File path:installation path\IDE\simlib\gw1n\prim_sim.v;or installation path\IDE\simlib\gw2a\prim_sim.v.
4. Script usage description
         Makefile script of VCS:Makefile script should be ran under the directory of "VCS_SIM"
			(1)make vcs:simulation
			(2)make vd:view waveform
			(3)make clean:clear the files generated by the simulation
         cmd.do script of modelsim:cmd.do script should be ran under the directory of "Modelsim"
			do cmd.do:simulation and view waveform
----------------------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------------------

HOW TO  GENERATE IP CORE
1. Click the IP Core Generator tab in the Window panel of the Gowin dashboard.
   Double click on "I3C Dual Clock". This will generate the IP Core for the design.
--------------------------------------------------------------------------------------------------------------
