AM263Px MCU+ SDK: sdl_rti.h Source File

| AM263Px MCU+ SDK 26.00.00 |

rti/v0/sdl_rti.h
Go to the documentation of this file.
1 /*
2 * Copyright (c) Texas Instruments Incorporated 2022
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 */
33
34 #ifndef SDL_RTI_H_
35 #define SDL_RTI_H_
36 #include <sdl/rti/v0/sdl_ip_rti.h>
37 #ifdef __cplusplus
38 extern "C" {
39 #endif
40
41
60 /* Declarations of API's */
82 int32_t SDL_RTI_config(SDL_RTI_InstanceType InstanceType, const SDL_RTI_configParms *pConfig);
83
96 int32_t SDL_RTI_verifyConfig(SDL_RTI_InstanceType InstanceType, SDL_RTI_configParms *pConfig);
97
108 int32_t SDL_RTI_start(SDL_RTI_InstanceType InstanceType);
109
118 int32_t SDL_RTI_service(SDL_RTI_InstanceType InstanceType);
119
130 int32_t SDL_RTI_clearStatus(SDL_RTI_InstanceType InstanceType, uint32_t status);
131
142 int32_t SDL_RTI_getStatus(SDL_RTI_InstanceType InstanceType, uint32_t *pStatus);
143
153 int32_t SDL_RTI_readStaticRegs(SDL_RTI_InstanceType InstanceType, SDL_RTI_staticRegs *pStaticRegs);
154
155
156 #ifdef __cplusplus
157 }
158 #endif
159
160 #endif /* SDL_RTI_H_ */
161
SDL_RTI_verifyConfig
int32_t SDL_RTI_verifyConfig(SDL_RTI_InstanceType InstanceType, SDL_RTI_configParms *pConfig)
RTI API to verify the written configuration. This API can be used after calling SDL_RTI_config in ord...
SDL_RTI_config
int32_t SDL_RTI_config(SDL_RTI_InstanceType InstanceType, const SDL_RTI_configParms *pConfig)
RTI configuration API. This API configures the specified RTI instance using the provided configuratio...
sdl_ip_rti.h
SDL_RTI_readStaticRegs
int32_t SDL_RTI_readStaticRegs(SDL_RTI_InstanceType InstanceType, SDL_RTI_staticRegs *pStaticRegs)
This API returns the static registers for RTI-DWWD.
SDL_RTI_start
int32_t SDL_RTI_start(SDL_RTI_InstanceType InstanceType)
Enable the RTI instance.
SDL_RTI_staticRegs
List of Static Registers for RTI DWWD.
Definition: sdl_ip_rti.h:73
SDL_RTI_clearStatus
int32_t SDL_RTI_clearStatus(SDL_RTI_InstanceType InstanceType, uint32_t status)
Clear the DWWD status.
SDL_RTI_getStatus
int32_t SDL_RTI_getStatus(SDL_RTI_InstanceType InstanceType, uint32_t *pStatus)
Clear the DWWD status.
SDL_RTI_InstanceType
SDL_RTI_InstanceType
Definition: sdl_soc_rti.h:64
SDL_RTI_service
int32_t SDL_RTI_service(SDL_RTI_InstanceType InstanceType)
Service the RTI instance.
SDL_RTI_configParms
List of Config Parameters for RTI DWWD.
Definition: sdl_ip_rti.h:89