AM243x MCU+ SDK  10.00.00
sdl_mtog.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) Texas Instruments Incorporated 2022-2023
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *
11  * Redistributions in binary form must reproduce the above copyright
12  * notice, this list of conditions and the following disclaimer in the
13  * documentation and/or other materials provided with the
14  * distribution.
15  *
16  * Neither the name of Texas Instruments Incorporated nor the names of
17  * its contributors may be used to endorse or promote products derived
18  * from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29  * (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  */
65 #ifndef SDL_MTOG_H_
66 #define SDL_MTOG_H_
67 
68 #ifdef __cplusplus
69 extern "C" {
70 #endif
71 
72 #include <stdint.h>
73 #include <stdbool.h>
74 
76 #include <sdl/mtog/soc/sdl_soc_mtog.h>
77 
78 /* Magic value used to force a timeout */
79 #define SDL_MTOG_FORCE_KEY ((uint32_t) 0x95U)
80 
88 typedef struct {
90  uint32_t mtogCtrlRegister;
92 
93 /* This structure contains Master TOG configuration value */
94 typedef struct {
98 
99 /* ========================================================================== */
100 /* Function Declarations */
101 /* ========================================================================== */
102 
122 int32_t SDL_MTOG_init(SDL_MTOG_Inst instance, const SDL_MTOG_config *pConfig);
123 
137 int32_t SDL_MTOG_verifyConfig(SDL_MTOG_Inst instance, const SDL_MTOG_config *pConfig);
138 
149 int32_t SDL_MTOG_start( SDL_MTOG_Inst instance );
150 
161 int32_t SDL_MTOG_stop( SDL_MTOG_Inst instance );
162 
177 
194 int32_t SDL_MTOG_reset( SDL_MTOG_Inst instance );
195 
210  SDL_MTOG_staticRegs *pStaticRegs);
211 
212 
213 #ifdef __cplusplus
214 }
215 #endif
216 
217 #endif /* SDL_MTOG_H_ */
218 
219 /* nothing past this point */
sdl_ip_mtog.h
SDL_MTOG_config::timeOut
SDL_MTOGVal timeOut
Definition: sdl_mtog.h:96
SDL_MTOG_config
Definition: sdl_mtog.h:94
SDL_MTOG_verifyConfig
int32_t SDL_MTOG_verifyConfig(SDL_MTOG_Inst instance, const SDL_MTOG_config *pConfig)
Verifying written configuration with Master TOG module.
SDL_MTOG_reset
int32_t SDL_MTOG_reset(SDL_MTOG_Inst instance)
Reset the timeout functionality.
SDL_MTOG_forceTimeout
int32_t SDL_MTOG_forceTimeout(SDL_MTOG_Inst instance)
Force a timeout.
SDL_MTOG_init
int32_t SDL_MTOG_init(SDL_MTOG_Inst instance, const SDL_MTOG_config *pConfig)
Initialize Master TOG module with respect of instance.
SDL_MTOG_staticRegs
Master TOG Static Registers.
Definition: sdl_mtog.h:88
SDL_MTOG_getStaticRegisters
int32_t SDL_MTOG_getStaticRegisters(SDL_MTOG_Inst instance, SDL_MTOG_staticRegs *pStaticRegs)
Readback Static configuration register.
SDL_MTOG_stop
int32_t SDL_MTOG_stop(SDL_MTOG_Inst instance)
Stop the timeout function.
SDL_MTOG_staticRegs::mtogCtrlRegister
uint32_t mtogCtrlRegister
Definition: sdl_mtog.h:90
SDL_MTOGVal
uint32_t SDL_MTOGVal
Definition: sdl_ip_mtog.h:59
SDL_MTOG_start
int32_t SDL_MTOG_start(SDL_MTOG_Inst instance)
Start the timeout function.
SDL_MTOG_Inst
uint8_t SDL_MTOG_Inst
MTOG Instance supported.
Definition: sdl_soc_mtog.h:58