1 /*!
2     \file    gd32e10x_dbg.h
3     \brief   definitions for the DBG
4 
5     \version 2017-12-26, V1.0.0, firmware for GD32E10x
6     \version 2020-09-30, V1.1.0, firmware for GD32E10x
7     \version 2020-12-31, V1.2.0, firmware for GD32E10x
8     \version 2022-06-30, V1.3.0, firmware for GD32E10x
9 */
10 
11 /*
12     Copyright (c) 2022, GigaDevice Semiconductor Inc.
13 
14     Redistribution and use in source and binary forms, with or without modification,
15 are permitted provided that the following conditions are met:
16 
17     1. Redistributions of source code must retain the above copyright notice, this
18        list of conditions and the following disclaimer.
19     2. Redistributions in binary form must reproduce the above copyright notice,
20        this list of conditions and the following disclaimer in the documentation
21        and/or other materials provided with the distribution.
22     3. Neither the name of the copyright holder nor the names of its contributors
23        may be used to endorse or promote products derived from this software without
24        specific prior written permission.
25 
26     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
27 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
28 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
29 IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
30 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
31 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
33 WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
34 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
35 OF SUCH DAMAGE.
36 */
37 
38 #ifndef GD32E10X_DBG_H
39 #define GD32E10X_DBG_H
40 
41 #include "gd32e10x.h"
42 
43 /* DBG definitions */
44 #define DBG                      DBG_BASE
45 
46 /* registers definitions */
47 #define DBG_ID                   REG32(DBG + 0x00U)         /*!< DBG_ID code register */
48 #define DBG_CTL                  REG32(DBG + 0x04U)         /*!< DBG control register */
49 
50 /* bits definitions */
51 /* DBG_ID */
52 #define DBG_ID_ID_CODE           BITS(0,31)                 /*!< DBG ID code values */
53 
54 /* DBG_CTL */
55 #define DBG_CTL_SLP_HOLD         BIT(0)                     /*!< keep debugger connection during sleep mode */
56 #define DBG_CTL_DSLP_HOLD        BIT(1)                     /*!< keep debugger connection during deepsleep mode */
57 #define DBG_CTL_STB_HOLD         BIT(2)                     /*!< keep debugger connection during standby mode */
58 #define DBG_CTL_TRACE_IOEN       BIT(5)                     /*!< enable trace pin assignment */
59 #define DBG_CTL_FWDGT_HOLD       BIT(8)                     /*!< debug FWDGT kept when core is halted */
60 #define DBG_CTL_WWDGT_HOLD       BIT(9)                     /*!< debug WWDGT kept when core is halted */
61 #define DBG_CTL_TIMER0_HOLD      BIT(10)                    /*!< hold TIMER0 counter when core is halted */
62 #define DBG_CTL_TIMER1_HOLD      BIT(11)                    /*!< hold TIMER1 counter when core is halted */
63 #define DBG_CTL_TIMER2_HOLD      BIT(12)                    /*!< hold TIMER2 counter when core is halted */
64 #define DBG_CTL_TIMER3_HOLD      BIT(13)                    /*!< hold TIMER3 counter when core is halted */
65 #define DBG_CTL_I2C0_HOLD        BIT(15)                    /*!< hold I2C0 smbus when core is halted */
66 #define DBG_CTL_I2C1_HOLD        BIT(16)                    /*!< hold I2C1 smbus when core is halted */
67 #define DBG_CTL_TIMER4_HOLD      BIT(17)                    /*!< hold TIMER4 counter when core is halted */
68 #define DBG_CTL_TIMER5_HOLD      BIT(18)                    /*!< hold TIMER5 counter when core is halted */
69 #define DBG_CTL_TIMER6_HOLD      BIT(19)                    /*!< hold TIMER6 counter when core is halted */
70 #define DBG_CTL_TIMER7_HOLD      BIT(20)                    /*!< hold TIMER7 counter when core is halted */
71 #define DBG_CTL_TIMER11_HOLD     BIT(25)                    /*!< hold TIMER11 counter when core is halted */
72 #define DBG_CTL_TIMER12_HOLD     BIT(26)                    /*!< hold TIMER12 counter when core is halted */
73 #define DBG_CTL_TIMER13_HOLD     BIT(27)                    /*!< hold TIMER13 counter when core is halted */
74 #define DBG_CTL_TIMER8_HOLD      BIT(28)                    /*!< hold TIMER8 counter when core is halted */
75 #define DBG_CTL_TIMER9_HOLD      BIT(29)                    /*!< hold TIMER9 counter when core is halted */
76 #define DBG_CTL_TIMER10_HOLD     BIT(30)                    /*!< hold TIMER10 counter when core is halted */
77 
78 /* constants definitions */
79 #define DBG_LOW_POWER_SLEEP      DBG_CTL_SLP_HOLD           /*!< keep debugger connection during sleep mode */
80 #define DBG_LOW_POWER_DEEPSLEEP  DBG_CTL_DSLP_HOLD          /*!< keep debugger connection during deepsleep mode */
81 #define DBG_LOW_POWER_STANDBY    DBG_CTL_STB_HOLD           /*!< keep debugger connection during standby mode */
82 
83 /* debug hold when core is halted */
84 typedef enum
85 {
86     DBG_FWDGT_HOLD             = BIT(8),                    /*!< debug FWDGT kept when core is halted */
87     DBG_WWDGT_HOLD             = BIT(9),                    /*!< debug WWDGT kept when core is halted */
88     DBG_TIMER0_HOLD            = BIT(10),                   /*!< hold TIMER0 counter when core is halted */
89     DBG_TIMER1_HOLD            = BIT(11),                   /*!< hold TIMER1 counter when core is halted */
90     DBG_TIMER2_HOLD            = BIT(12),                   /*!< hold TIMER2 counter when core is halted */
91     DBG_TIMER3_HOLD            = BIT(13),                   /*!< hold TIMER3 counter when core is halted */
92     DBG_I2C0_HOLD              = BIT(15),                   /*!< hold I2C0 smbus when core is halted */
93     DBG_I2C1_HOLD              = BIT(16),                   /*!< hold I2C1 smbus when core is halted */
94     DBG_TIMER4_HOLD            = BIT(17),                   /*!< hold TIMER4 counter when core is halted */
95     DBG_TIMER5_HOLD            = BIT(18),                   /*!< hold TIMER5 counter when core is halted */
96     DBG_TIMER6_HOLD            = BIT(19),                   /*!< hold TIMER6 counter when core is halted */
97     DBG_TIMER7_HOLD            = BIT(20),                   /*!< hold TIMER7 counter when core is halted */
98     DBG_TIMER11_HOLD           = BIT(25),                   /*!< hold TIMER11 counter when core is halted */
99     DBG_TIMER12_HOLD           = BIT(26),                   /*!< hold TIMER12 counter when core is halted */
100     DBG_TIMER13_HOLD           = BIT(27),                   /*!< hold TIMER13 counter when core is halted */
101     DBG_TIMER8_HOLD            = BIT(28),                   /*!< hold TIMER8 counter when core is halted */
102     DBG_TIMER9_HOLD            = BIT(29),                   /*!< hold TIMER9 counter when core is halted */
103     DBG_TIMER10_HOLD           = BIT(30),                   /*!< hold TIMER10 counter when core is halted */
104 }dbg_periph_enum;
105 
106 /* function declarations */
107 /* read DBG_ID code register */
108 uint32_t dbg_id_get(void);
109 
110 /* enable low power behavior when the MCU is in debug mode */
111 void dbg_low_power_enable(uint32_t dbg_low_power);
112 /* disable low power behavior when the MCU is in debug mode */
113 void dbg_low_power_disable(uint32_t dbg_low_power);
114 
115 /* enable peripheral behavior when the MCU is in debug mode */
116 void dbg_periph_enable(dbg_periph_enum dbg_periph);
117 /* disable peripheral behavior when the MCU is in debug mode */
118 void dbg_periph_disable(dbg_periph_enum dbg_periph);
119 
120 /* enable trace pin assignment */
121 void dbg_trace_pin_enable(void);
122 /* disable trace pin assignment */
123 void dbg_trace_pin_disable(void);
124 
125 #endif /* GD32E10X_DBG_H */
126