SDL API Guide for J721E
sdl_msmc.h
Go to the documentation of this file.
1 /********************************************************************
2  * Copyright (C) 2022 Texas Instruments Incorporated.
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 
47 #ifndef SDL_IP_MSMC_H_
48 #define SDL_IP_MSMC_H_
49 
50 #ifdef __cplusplus
51 extern "C" {
52 #endif
53 
54 #include <stdint.h>
55 #include <stdbool.h>
56 #include <sdl_types.h>
57 #include <sdlr64.h>
58 #if defined (SOC_J721E)
60 #elif defined (SOC_J7200)
61 #include "src/sdl/misc/soc/j7200/sdl_soc_msmc.h"
62 #elif defined (SOC_J721S2)
63 #include "src/sdl/misc/soc/j721s2/sdl_soc_msmc.h"
64 #endif
65 #if defined (SOC_J784S4)
66 #include "src/sdl/misc/soc/j784s4/sdl_soc_msmc.h"
67 #endif
68 
69 /**************************************************************************
70 * Register Macros
71 **************************************************************************/
72 #define SDL_MSMC_SCRUB_ENGINE_REGISTER (0x00003080UL)
73 
74 
75 /**************************************************************************
76 * Field Definition Macros
77 **************************************************************************/
78 /* SMEDCC */
79 #define SDL_MSMC_SCRUB_ENABLE_MASK (0x80000000UL)
80 #define SDL_MSMC_SCRUB_ENABLE_SHIFT (0x0000001FU)
81 #define SDL_MSMC_SCRUB_ENABLE_MAX (0x00000001UL)
82 
107 bool SDL_MSMC_isScrubEnabled(void);
108 
111 #ifdef __cplusplus
112 }
113 #endif
114 
115 #endif /* SDL_IP_MSMC_H_ */
bool SDL_MSMC_isScrubEnabled(void)
Checks enable status of MSMC Scrubbing Engine.