______________________________________________________________________________________________________________________________________________
                                            APB SD Host IP Reference Design Read Me File
______________________________________________________________________________________________________________________________________________

----------------------------------------------------------------------------------------------------------------------------------------------
Object Target
----------------------------------------------------------------------------------------------------------------------------------------------
EVAL_XXX_GW5AST-LV138FPG676A_V1.0
    GW5AST-LV138FPG676AC2/I1
    GW5AST-138
    C

----------------------------------------------------------------------------------------------------------------------------------------------
Software Version
----------------------------------------------------------------------------------------------------------------------------------------------
Version tested:
    Gowin_V1.9.12.04 (64-bit)
    GMD V2025.01

----------------------------------------------------------------------------------------------------------------------------------------------
File List
----------------------------------------------------------------------------------------------------------------------------------------------
.
|-- doc                                           -->  Documents
|   `-- ReadMe.txt                                -->  Read me file (this file)
|   `-- ReleaseNote.txt                           -->  Release note file
|-- library                                       -->  Software programming libraries
|   |-- doc                                       -->  Documents
|       `-- ReadMe.txt                            -->  Read me file
|       `-- ReleaseNote.txt                       -->  Release note file
|   |-- lib                                       -->  Drivers
|       |-- _bsp                                  -->  Bsp
|       |   `bsp.h                                -->  Bsp
|       `-- apb_sd_host.h                         -->  APB SD Host driver
|       `-- apb_sd_host.c                         -->  APB SD Host driver
|-- ref_design                                    -->  Reference design
|   |-- FPGA_RefDesign                            -->  FPGA reference design
|       `-- ReadMe.txt                            -->  Read me file
|       |-- EVAL_XXX_GW5AST138_V1.0               -->  FPGA reference design for EVAL_XXX_GW5AST-LV138FPG676A_V1.0
|       |   `-- ReadMe.txt                        -->  Read me file
|       |   |-- apb_sd_host                       -->  FPGA reference design
|   |-- MCU_RefDesign                             -->  MCU reference design
|       `-- ReadMe.txt                            -->  Read me file
|       |-- apb_sd_host                           -->  MCU reference design
|       |-- apb_sd_fatfs                          -->  MCU reference design

----------------------------------------------------------------------------------------------------------------------------------------------
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 -- "apb_sd_host", select the project "apb_sd_host.gprj".
4. Click Finish. Now the project is successfully loaded.

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

----------------------------------------------------------------------------------------------------------------------------------------------
HOW TO RUN SYNTHESIZE, PLACE AND ROUTE, IP CORE GENERATOR, AND TIMING ANALYSIS IN Gowin
----------------------------------------------------------------------------------------------------------------------------------------------
1. Click the Process tab in the process panel of the Gowin dashboard.
   Double click on Synthsize(GowinSynthesis). 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 DOWNLOAD
----------------------------------------------------------------------------------------------------------------------------------------------
For example :
1. Arora V
   (1) External Flash Mode Arora V --> exFlash Erase, Program Arora V
       File name: apb_sd_host.fs
       Start Address: 0x0000000
   (2) External Flash Mode Arora V --> exFlash C Bin Erase, Program Arora V
       Start Address: 0x0600000
       Firmware/Binary File: apb_sd_host.bin

-----------------------------------------------------------------------------------------------------------------------------------------------
HOW TO GENERATE IP CORE
-----------------------------------------------------------------------------------------------------------------------------------------------
1. Click the IP Core Generator tab in the Window panel of the Gowin dashboard.
   Double click on "Soft IP Core > Microprocessor System > Peripheral > APB SD Host".
   This will generate the 'APB SD Host' IP.
2. Click the IP Core Generator tab in the Window panel of the Gowin dashboard.
   Double click on "Soft IP Core > Microprocessor System > Soft-Core-MCU > Gowin_GoRV32".
   This will generate the 'Gowin_GoRV32' IP.
-----------------------------------------------------------------------------------------------------------------------------------------------