/*!
    \file    readme.txt
    \brief   description of the TIMER0 Plymouth complementary signals demo for GD32G5x3

    \version 2025-07-15, V1.0.0, firmware for GD32G5x3
*/

/*
    Copyright (c) 2025, 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 demo is based on the GD32G553Q-EVAL-V1.0 board, it shows how to configure the
TIMER0 peripheral to generate four complementary TIMER0 signals.

  TIMER0 frequency is fixed to systemcoreclock, TIMER0 prescaler is equal to 216,
so TIMER0 counter frequency used is 1MHz, the PWM frequency = 1KHz.

  The four duty cycles are computed as the following description:
  - channel 0 duty cycle is set to 20 %, so multi mode channel 0 is set to 80 %.
  - channel 1 duty cycle is set to 40 %, so multi mode channel 1 is set to 60 %.
  - channel 2 duty cycle is set to 60 %, so multi mode channel 2 is set to 40 %.
  - channel 3 duty cycle is set to 80 %, so multi mode channel 3 is set to 20 %.

  The CH0 / MCH0, CH1 / MCH1, CH2 / MCH2 and CH3 / MCH3 are configured in PWM mode 0.

  Connect the TIMER0 pins to an oscilloscope to monitor the different waveforms:
  - TIMER0_CH0  pin (PC0)
  - TIMER0_MCH0 pin (PA7)
  - TIMER0_CH1  pin (PC1)
  - TIMER0_MCH1 pin (PB0)
  - TIMER0_CH2  pin (PC2)
  - TIMER0_MCH2 pin (PB1)
  - TIMER0_CH3  pin (PC3)
  - TIMER0_MCH3 pin (PC5)
