AM261x MCU+ SDK: sdl_soc_tog.h Source File

| AM261x MCU+ SDK 26.00.00 |

sdl_soc_tog.h
Go to the documentation of this file.
1 /********************************************************************
2 *
3 * SOC TOG PROPERTIES. header file
4 *
5 * Copyright (C) 2024 Texas Instruments Incorporated.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 *
10 * Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 *
13 * Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the
16 * distribution.
17 *
18 * Neither the name of Texas Instruments Incorporated nor the names of
19 * its contributors may be used to endorse or promote products derived
20 * from this software without specific prior written permission.
21 *
22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
26 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
27 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
28 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
32 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 *
34 */
35 #ifndef SDL_SOC_TOG_H_
36 #define SDL_SOC_TOG_H_
37
38 #include <sdl/sdlr.h>
39 #include <sdl/include/am261x/sdlr_soc_baseaddress.h>
40
41 #ifdef __cplusplus
42 extern "C"
43 {
44 #endif
45
46 /*
47 * SDL definitions for SoC TOG Instances:
48 */
49
61 typedef uint8_t SDL_TOG_Inst;
63 #define SDL_TOG_INSTANCE_TIMEOUT0_CFG 0U
64
65 #define SDL_TOG_MAX_INSTANCE 1U
66
67 #define SDL_TOG_INSTANCE 0U
68
82 int32_t SDL_TOG_getBaseaddr(SDL_TOG_Inst instance,
83 uint32_t *baseAddr);
84
91 int32_t SDL_TOG_registerInterrupt(void);
92
97 void SDL_TOG_irqHandler(void);
98
99 /*======================================================================================================
100 * This is global array gives the BASE ADDRESS of TOG modules
101 ======================================================================================================*/
102
103 static uint32_t SDL_TOG_baseAddress[SDL_TOG_MAX_INSTANCE] =
104 {
105 SDL_FSS_VBUSM_TO_CFG_U_BASE
106 };
107
108 /* Properties of TOG instances in: TOG */
109
110 #ifdef __cplusplus
111 }
112 #endif
113
114 #endif /* SDL_SOC_TOG_H_ */
SDL_TOG_getBaseaddr
int32_t SDL_TOG_getBaseaddr(SDL_TOG_Inst instance, uint32_t *baseAddr)
This API is used to get the base address of the instance.
SDL_TOG_baseAddress
static uint32_t SDL_TOG_baseAddress[SDL_TOG_MAX_INSTANCE]
Definition: sdl_soc_tog.h:103
SDL_TOG_irqHandler
void SDL_TOG_irqHandler(void)
This API is the interrupt handler for TOG.
SDL_TOG_registerInterrupt
int32_t SDL_TOG_registerInterrupt(void)
This API is used to get the base address of the instance.
SDL_TOG_MAX_INSTANCE
#define SDL_TOG_MAX_INSTANCE
Definition: sdl_soc_tog.h:65
SDL_TOG_Inst
uint8_t SDL_TOG_Inst
Definition: sdl_soc_tog.h:61
sdlr.h
This file contains the macro definations for Register layer.