1 /**
2  * @file xmc1_rtc.h
3  * @date 2015-05-20
4  *
5  * @cond
6  *********************************************************************************************************************
7  * XMClib v2.1.24 - XMC Peripheral Driver Library
8  *
9  * Copyright (c) 2015-2019, Infineon Technologies AG
10  * All rights reserved.
11  *
12  * Redistribution and use in source and binary forms, with or without modification,are permitted provided that the
13  * following conditions are met:
14  *
15  * Redistributions of source code must retain the above copyright notice, this list of conditions and the following
16  * disclaimer.
17  *
18  * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following
19  * disclaimer in the documentation and/or other materials provided with the distribution.
20  *
21  * Neither the name of the copyright holders nor the names of its contributors may be used to endorse or promote
22  * products derived from this software without specific prior written permission.
23  *
24  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
25  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
26  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE  FOR ANY DIRECT, INDIRECT, INCIDENTAL,
27  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
28  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
29  * WHETHER IN CONTRACT, STRICT LIABILITY,OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  *
32  * To improve the quality of the software, users are encouraged to share modifications, enhancements or bug fixes with
33  * Infineon Technologies AG dave@infineon.com).
34  *********************************************************************************************************************
35  *
36  * Change History
37  * --------------
38  *
39  * 2015-02-20:
40  *     - Initial version
41  *
42  * 2015-05-20:
43  *     - Documentation updates <br>
44  *
45  * @endcond
46  *
47  */
48 
49 #ifndef XMC1_RTC_H
50 #define XMC1_RTC_H
51 
52 /**
53  * @addtogroup XMClib XMC Peripheral Library
54  * @{
55  */
56 
57 /**
58  * @addtogroup RTC
59  * @{
60  */
61 
62 /*********************************************************************************************************************
63  * ENUMS
64  *********************************************************************************************************************/
65 
66 /**
67  * Debug mode status values
68  */
69 typedef enum XMC_RTC_DEBUG_MODE
70 {
71   XMC_RTC_RUN_IN_DEBUG_MODE  = 0U, /**< RTC is not stopped during halting mode debug */
72   XMC_RTC_STOP_IN_DEBUG_MODE = 1U  /**< RTC is stopped during halting mode debug */
73 } XMC_RTC_DEBUG_MODE_t;
74 
75 /*********************************************************************************************************************
76  * API PROTOTYPES
77  *********************************************************************************************************************/
78 
79 #ifdef __cplusplus
80 extern "C" {
81 #endif
82 
83 /**
84  * @param debug_mode Debug mode value containing in (::XMC_RTC_DEBUG_MODE_t) to be set
85  * @return None
86  *
87  * \par<b>Description: </b><br>
88  * Configures the RTC into running or stopping mode during halting mode debug <br>
89  *
90  * \par
91  * The function sets the CTR.SUS bitfield to configure the RTC into running
92  * or stopping mode during halting mode debug.
93  */
94 void XMC_RTC_SetDebugMode(const XMC_RTC_DEBUG_MODE_t debug_mode);
95 
96 #ifdef __cplusplus
97 }
98 #endif
99 
100 /**
101  * @}
102  */
103 
104 /**
105  * @}
106  */
107 
108 #endif /* XMC1_RTC_H */
109