/*!
    \file  readme.txt
    \brief description of EXMC NandFlash demo
    
    \version 2025-08-20, V3.0.2, demo for GD32F403
*/

/*
    Copyright (c) 2025, GigaDevice Semiconductor Inc.

    All rights reserved.

    Redistribution and use in source and binary forms, with or without modification, 
are permitted provided that the following conditions are met:

    1. Redistributions of source code must retain the above copyright notice, this 
       list of conditions and the following disclaimer.
    2. Redistributions in binary form must reproduce the above copyright notice, 
       this list of conditions and the following disclaimer in the documentation 
       and/or other materials provided with the distribution.
    3. Neither the name of the copyright holder nor the names of its contributors 
       may be used to endorse or promote products derived from this software without 
       specific prior written permission.

    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY 
OF SUCH DAMAGE.
*/

  This demo is based on the GD32403Z-EVAL-V1.1 board, it shows how to use EXMC peripheral
to control NandFlash. This board uses EXMC_BANK1_NAND to support NAND memory.
  This demo shows the write and read data operation process of NandFlash by EXMC module. 
Firstly, read NAND_ID. If the operation fails,  this demo will print out the failure information 
and light on LED4, otherwise print out the ID information. Secondly, write and read the NAND 
memory. If the test result is correct, LED2 will be turned on and the data writed to the NAND 
will be printed out.
  The timing parameters are calculated according to the 168MHz system clock.
  JP5 and JP6 must be fitted to the USART port.
  P2 and P3 must be fitted to the EXMC port.
  JP24 must be fitted to the Nwait port.
