/*!
    \file    readme.txt
    \brief   description of the master and slave simplex communication using DMA demo

    \version 2026-02-04, V1.6.0, firmware for GD32VW55x
*/

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

    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 example is based on the GD32VW553H-EVAL-V1.2 board, it shows SPI simplex
communication using DMA mode.

1.Master tramsmit slave receive mode:
  Two boards should be connected as described below.
  Connect SPI SCK  PIN(PA5) to SPI SCK  PIN(PA5).
  Connect SPI MOSI PIN(PA7) to SPI MOSI PIN(PA7).
  Connect SPI NSS  PIN(PA4) to SPI NSS  PIN(PA4).

  Modify file: examlple/SPI/SPI_master_simplex_dma/main.c, choose master tramsmit slave
receive mode.
#define MASTER_TRAMSMIT
//#define MASTER_RECEIVE

  After the communication is completed, if the data received is equal to the data sent, LED2
turn on, if not LED2 turn off.

2.Slave tramsmit master receive mode:
  Two boards should be connected as described below.
  Connect SPI SCK  PIN(PA5) to SPI SCK  PIN(PA5).
  Connect SPI MISO PIN(PA6) to SPI MISO PIN(PA6).
  Connect SPI NSS  PIN(PA4) to SPI NSS  PIN(PA4).

  Modify file: examlple/SPI/SPI_master_simplex_dma/main.c, choose slave tramsmit master
receive mode.
//#define MASTER_TRAMSMIT
#define MASTER_RECEIVE

  After the communication is completed, if the data received is equal to the data sent, LED3
turn on, if not LED3 turn off.

  Jump JP3, JP5 to SCK, NSS, IO0