iLLD_TC29x  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_1_0_0_11_0
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_Std_Basic_Functions Basic Functions
25  * \ingroup IfxLld_Gtm_Std
26  * \defgroup IfxLld_Gtm_Std_Enumerations Enumerations
27  * \ingroup IfxLld_Gtm_Std
28  */
29 
30 #ifndef IFXGTM_H
31 #define IFXGTM_H 1
32 
33 /******************************************************************************/
34 /*----------------------------------Includes----------------------------------*/
35 /******************************************************************************/
36 
37 #include "_Impl/IfxGtm_cfg.h"
38 
39 /******************************************************************************/
40 /*--------------------------------Enumerations--------------------------------*/
41 /******************************************************************************/
42 
43 /** \addtogroup IfxLld_Gtm_Std_Enumerations
44  * \{ */
45 /** \brief Enum for GTM interrupt modes
46  */
47 typedef enum
48 {
49  IfxGtm_IrqMode_level = 0,
50  IfxGtm_IrqMode_pulse = 1,
51  IfxGtm_IrqMode_pulseNotify = 2,
52  IfxGtm_IrqMode_singlePulse = 3
53 } IfxGtm_IrqMode;
54 
55 /** \} */
56 
57 /** \addtogroup IfxLld_Gtm_Std_Basic_Functions
58  * \{ */
59 
60 /******************************************************************************/
61 /*-------------------------Inline Function Prototypes-------------------------*/
62 /******************************************************************************/
63 
64 /** \brief Returs the status of module enabled or disabled
65  * \param gtm Pointer to GTM module
66  * \return status: TRUE/FALSE
67  */
68 IFX_INLINE boolean IfxGtm_isEnabled(Ifx_GTM *gtm);
69 
70 /******************************************************************************/
71 /*-------------------------Global Function Prototypes-------------------------*/
72 /******************************************************************************/
73 
74 /** \brief Disables the module
75  * \param gtm Pointer to GTM module
76  * \return None
77  */
78 IFX_EXTERN void IfxGtm_disable(Ifx_GTM *gtm);
79 
80 /** \brief Enables the module
81  * \param gtm Pointer to GTM module
82  * \return None
83  */
84 IFX_EXTERN void IfxGtm_enable(Ifx_GTM *gtm);
85 
86 /** \} */
87 
88 /******************************************************************************/
89 /*---------------------Inline Function Implementations------------------------*/
90 /******************************************************************************/
91 
92 IFX_INLINE boolean IfxGtm_isEnabled(Ifx_GTM *gtm)
93 {
94  return gtm->CLC.B.DISS == 0;
95 }
96 
97 
98 #endif /* IFXGTM_H */