iLLD_TC27xC  1.0
IfxGtm.h
Go to the documentation of this file.
1 /**
2  * \file IfxGtm.h
3  * \brief GTM basic functionality
4  * \ingroup IfxLld_Gtm
5  *
6  * \version iLLD_0_1_0_10
7  * \copyright Copyright (c) 2013 Infineon Technologies AG. All rights reserved.
8  *
9  *
10  * IMPORTANT NOTICE
11  *
12  *
13  * Infineon Technologies AG (Infineon) is supplying this file for use
14  * exclusively with Infineon's microcontroller products. This file can be freely
15  * distributed within development tools that are supporting such microcontroller
16  * products.
17  *
18  * THIS SOFTWARE IS PROVIDED "AS IS". NO WARRANTIES, WHETHER EXPRESS, IMPLIED
19  * OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF
20  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE.
21  * INFINEON SHALL NOT, IN ANY CIRCUMSTANCES, BE LIABLE FOR SPECIAL, INCIDENTAL,
22  * OR CONSEQUENTIAL DAMAGES, FOR ANY REASON WHATSOEVER.
23  *
24  * \defgroup IfxLld_Gtm GTM
25  * \ingroup IfxLld
26  * \defgroup IfxLld_Gtm_Std Standard Driver
27  * \ingroup IfxLld_Gtm
28  * \defgroup IfxLld_Gtm_Std_Basic_Functions Basic Functions
29  * \ingroup IfxLld_Gtm_Std
30  * \defgroup IfxLld_Gtm_Std_Enumerations Enumerations
31  * \ingroup IfxLld_Gtm_Std
32  */
33 
34 #ifndef IFXGTM_H
35 #define IFXGTM_H 1
36 
37 /******************************************************************************/
38 /*----------------------------------Includes----------------------------------*/
39 /******************************************************************************/
40 
41 #include "_Impl/IfxGtm_cfg.h"
42 
43 /******************************************************************************/
44 /*--------------------------------Enumerations--------------------------------*/
45 /******************************************************************************/
46 
47 /** \addtogroup IfxLld_Gtm_Std_Enumerations
48  * \{ */
49 /** \brief Enum for GTM interrupt modes
50  */
51 typedef enum
52 {
58 
59 /** \} */
60 
61 /** \addtogroup IfxLld_Gtm_Std_Basic_Functions
62  * \{ */
63 
64 /******************************************************************************/
65 /*-------------------------Inline Function Prototypes-------------------------*/
66 /******************************************************************************/
67 
68 /** \brief Returs the status of module enabled or disabled
69  * \param gtm Pointer to GTM module
70  * \return status: TRUE/FALSE
71  */
72 IFX_INLINE boolean IfxGtm_isEnabled(Ifx_GTM *gtm);
73 
74 /******************************************************************************/
75 /*-------------------------Global Function Prototypes-------------------------*/
76 /******************************************************************************/
77 
78 /** \brief Disables the module
79  * \param gtm Pointer to GTM module
80  * \return None
81  */
82 IFX_EXTERN void IfxGtm_disable(Ifx_GTM *gtm);
83 
84 /** \brief Enables the module
85  * \param gtm Pointer to GTM module
86  * \return None
87  */
88 IFX_EXTERN void IfxGtm_enable(Ifx_GTM *gtm);
89 
90 /** \} */
91 
92 /******************************************************************************/
93 /*---------------------Inline Function Implementations------------------------*/
94 /******************************************************************************/
95 
96 IFX_INLINE boolean IfxGtm_isEnabled(Ifx_GTM *gtm)
97 {
98  return gtm->CLC.B.DISS == 0;
99 }
100 
101 
102 #endif /* IFXGTM_H */