iLLD_TC27xC  1.0
IfxGtm_Trig.h
Go to the documentation of this file.
1 /**
2  * \file IfxGtm_Trig.h
3  * \brief GTM TRIG details
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_Trig GTM Trigger Configuration
25  * \ingroup IfxLld_Gtm
26  * \defgroup IfxLld_Gtm_Trig_Enumerations Enumerations
27  * \ingroup IfxLld_Gtm_Trig
28  * \defgroup IfxLld_Gtm_Trig_Data_Structures Data Structures
29  * \ingroup IfxLld_Gtm_Trig
30  * \defgroup IfxLld_Gtm_Trig_Trigger_Functions Trigger Functions
31  * \ingroup IfxLld_Gtm_Trig
32  */
33 
34 #ifndef IFXGTM_TRIG_H
35 #define IFXGTM_TRIG_H 1
36 
37 /******************************************************************************/
38 /*----------------------------------Includes----------------------------------*/
39 /******************************************************************************/
40 
41 #include "Cpu/Std/Ifx_Types.h"
42 #include "_Impl/IfxGtm_cfg.h"
43 #include "Gtm/Std/IfxGtm_Tim.h"
44 
45 /******************************************************************************/
46 /*--------------------------------Enumerations--------------------------------*/
47 /******************************************************************************/
48 
49 /** \addtogroup IfxLld_Gtm_Trig_Enumerations
50  * \{ */
51 /** \brief Enum for ADC group
52  */
53 typedef enum
54 {
55  IfxGtm_Trig_AdcGroup_0, /**< \brief For ADC group 0 */
56  IfxGtm_Trig_AdcGroup_1, /**< \brief For ADC group 1 */
57  IfxGtm_Trig_AdcGroup_2, /**< \brief For ADC group 2 */
58  IfxGtm_Trig_AdcGroup_3, /**< \brief For ADC group 3 */
59  IfxGtm_Trig_AdcGroup_4, /**< \brief For ADC group 4 */
60  IfxGtm_Trig_AdcGroup_5, /**< \brief For ADC group 5 */
61  IfxGtm_Trig_AdcGroup_6, /**< \brief For ADC group 6 */
62  IfxGtm_Trig_AdcGroup_7, /**< \brief For ADC group 7 */
63  IfxGtm_Trig_AdcGroup_8, /**< \brief For ADC group 8 */
65 
66 /** \brief Enum for ADC trigger
67  */
68 typedef enum
69 {
72  IfxGtm_Trig_AdcTrig_count /**< \brief count of the enum definition */
74 
75 /** \brief Enum for ADC trigger channel
76  */
77 typedef enum
78 {
86  IfxGtm_Trig_AdcTrigChannel_count /**< \brief count of the enum definition */
88 
89 /** \brief Enum for ADC trigger source
90  */
91 typedef enum
92 {
100  IfxGtm_Trig_AdcTrigSource_count /**< \brief count of the enum definition */
102 
103 /** \brief Enum for DSADC trigger
104  */
105 typedef enum
106 {
110 
111 /** \brief Enum for DSADC trigger source
112  */
113 typedef enum
114 {
124 
125 /** \} */
126 
127 /** \addtogroup IfxLld_Gtm_Trig_Trigger_Functions
128  * \{ */
129 
130 /******************************************************************************/
131 /*-------------------------Global Function Prototypes-------------------------*/
132 /******************************************************************************/
133 
134 /**
135  * \param gtm Pointer to GTM module
136  * \param dsadcChannel DSADC channel
137  * \param tim TIM object
138  * \param timChannel TIM channel
139  * \return TRUE on success else FALSE
140  */
141 IFX_EXTERN boolean IfxGtm_Trig_fromDsadc(Ifx_GTM *gtm, uint32 dsadcChannel, IfxGtm_Tim tim, IfxGtm_Tim_Ch timChannel);
142 
143 /**
144  * \param gtm Pointer to GTM module
145  * \param dsadcChannel DSADC channel
146  * \param dsadcTrig DSADC trigger
147  * \param sel DSADC trigger source
148  * \return None
149  */
150 IFX_EXTERN void IfxGtm_Trig_toDsadc(Ifx_GTM *gtm, uint32 dsadcChannel, IfxGtm_Trig_DsadcTrig dsadcTrig, IfxGtm_Trig_DsadcTrigSource sel);
151 
152 /**
153  * \param gtm Pointer to GTM module
154  * \param adcGroup ADC group
155  * \param adcTrig ADC trigger
156  * \param source ADC trigger source
157  * \param channel ADC trigger channel
158  * \return TRUE on success else FALSE
159  */
161 
162 /** \} */
163 
164 #endif /* IFXGTM_TRIG_H */