/*!
    \file    readme.txt
    \brief   description of the CAN Pretended Networking mode demo

    \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
CAN0 peripheral to Pretended Networking mode, and CAN1 peripheral to transmit wakeup frame.

  When KEY_A button is pressed, CAN0 enters Pretended Networking mode. If KEY_B button is
not pressed within (0xFFFF * 64 / 1000K = 4.19) seconds, a wakeup timeout event is occurred,
and LED2 will be toggled, otherwise CAN1 will send a wakeup frame, and a match event will
occur, LED1 is toggled, the received data will be printed in the hyperthermia.

  User must connect L pin to L pin, and H pin to H pin of JP10 and JP12 on the board for sending and
receiving frames.

  GD32G553Q-EVAL-V1.0 CAN transceiver needs 5V power supply.
