MSPM0L122X_L222X Driver Library  2.05.00.05
dl_scratchpad.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2023, Texas Instruments Incorporated
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * * Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  *
12  * * Redistributions in binary form must reproduce the above copyright
13  * notice, this list of conditions and the following disclaimer in the
14  * documentation and/or other materials provided with the 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 "AS IS"
21  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
22  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
24  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
27  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
29  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
30  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32 /*!****************************************************************************
33  * @file dl_scratchpad.h
34  * @brief Scratchpad Memory Driver Library
35  * @defgroup Scratchpad Memory
36  *
37  * @anchor ti_dl_dl_scratchpad_Overview
38  * # Overview
39  *
40  * The Scratchpad Memory Library allows full configuration of
41  * the MSPM0 Scratchpad Memory within the LFSS IP.
42  *
43  * The LFSS scratch pad memory is a 16- to 128-byte register based memory,
44  * which will retain data similar to a non-volatile memory as long as VBAT is
45  * supplied. The number of implemented bytes shall be configurable in a granularity
46  * of 4 bytes. This means the scratch pad memory retains data when the main VDD supply
47  * is lost or during the SHUTDOWN mode. However, the memory content won’t be retained,
48  * when the VBAT domain itself is lost.
49  *
50  * <hr>
51  ******************************************************************************
52  */
56 #ifndef ti_dl_dl_scratchpad__include
57 #define ti_dl_dl_scratchpad__include
58 
59 #include <stdbool.h>
60 #include <stdint.h>
61 
62 #include <ti/driverlib/dl_lfss.h>
63 
64 #ifdef __MSPM0_HAS_SCRATCHPAD__
65 
66 #ifdef __cplusplus
67 extern "C" {
68 #endif
69 
70 /* clang-format off */
71 
75 #define DL_SCRATCHPAD_MEM_WORD_0 DL_LFSS_SCRATCHPAD_MEM_WORD_0
76 
80 #define DL_SCRATCHPAD_MEM_WORD_1 DL_LFSS_SCRATCHPAD_MEM_WORD_1
81 
85 #define DL_SCRATCHPAD_MEM_WORD_1 DL_LFSS_SCRATCHPAD_MEM_WORD_1
86 
90 #define DL_SCRATCHPAD_MEM_WORD_2 DL_LFSS_SCRATCHPAD_MEM_WORD_2
91 
95 #define DL_SCRATCHPAD_MEM_WORD_3 DL_LFSS_SCRATCHPAD_MEM_WORD_3
96 
100 #define DL_SCRATCHPAD_MEM_WORD_4 DL_LFSS_SCRATCHPAD_MEM_WORD_4
101 
105 #define DL_SCRATCHPAD_MEM_WORD_5 DL_LFSS_SCRATCHPAD_MEM_WORD_5
106 
110 #define DL_SCRATCHPAD_MEM_WORD_6 DL_LFSS_SCRATCHPAD_MEM_WORD_6
111 
115 #define DL_SCRATCHPAD_MEM_WORD_7 DL_LFSS_SCRATCHPAD_MEM_WORD_7
116 
120 #define DL_SCRATCHPAD_MEM_BYTE_0 DL_LFSS_SCRATCHPAD_MEM_BYTE_0
121 
125 #define DL_SCRATCHPAD_MEM_BYTE_1 DL_LFSS_SCRATCHPAD_MEM_BYTE_1
126 
130 #define DL_SCRATCHPAD_MEM_BYTE_2 DL_LFSS_SCRATCHPAD_MEM_BYTE_2
131 
135 #define DL_SCRATCHPAD_MEM_WORD_2 DL_LFSS_SCRATCHPAD_MEM_WORD_2
136 
140 #define DL_SCRATCHPAD_MEM_BYTE_3 DL_LFSS_SCRATCHPAD_MEM_BYTE_3
141 
145 #define DL_ScratchPad_writeDataWord(lfss, memIndex, data) DL_LFSS_writeScratchPadData32(lfss, \
146  (DL_LFSS_SCRATCHPAD_MEM_WORD)memIndex, \
147  data)
148 
152 #define DL_ScratchPad_writeDataByte(lfss, memIndex, byteIndex, data) DL_LFSS_writeScratchPadData8(lfss, \
153  (DL_LFSS_SCRATCHPAD_MEM_WORD)memIndex, \
154  (DL_LFSS_SCRATCHPAD_MEM_BYTE)byteIndex, \
155  data)
156 
160 #define DL_ScratchPad_readDataWord(lfss, memIndex) DL_LFSS_readScratchPadDataWord(lfss, \
161  (DL_LFSS_SCRATCHPAD_MEM_WORD)memIndex)
162 
166 #define DL_ScratchPad_readDataByte(lfss, memIndex, byteIndex) DL_LFSS_readScratchPadDataByte(lfss, \
167  (DL_LFSS_SCRATCHPAD_MEM_WORD)memIndex, \
168  (DL_LFSS_SCRATCHPAD_MEM_BYTE)byteIndex)
169 
173 #define DL_ScratchPad_enableWriteProtectByte(lfss, memIndex, byteIndex) DL_LFSS_enableScratchPadWriteProtectByte(lfss, \
174  (DL_LFSS_SCRATCHPAD_MEM_WORD)memIndex, \
175  (DL_LFSS_SCRATCHPAD_MEM_BYTE)byteIndex)
176 
180 #define DL_ScratchPad_isWriteProtectByteEnabled(lfss, memIndex, byteIndex) DL_LFSS_isScratchPadWriteProtectByteEnabled(lfss, \
181  (DL_LFSS_SCRATCHPAD_MEM_WORD)memIndex, \
182  (DL_LFSS_SCRATCHPAD_MEM_BYTE)byteIndex)
183 
184 
188 #define DL_ScratchPad_disableWriteProtectByte(lfss, memIndex, byteIndex) DL_LFSS_disableScratchPadWriteProtectByte(lfss, \
189  (DL_LFSS_SCRATCHPAD_MEM_WORD)memIndex, \
190  (DL_LFSS_SCRATCHPAD_MEM_BYTE)byteIndex)
191 
195 #define DL_ScratchPad_enableTamperEraseByte(lfss, memIndex, byteIndex) DL_LFSS_enableScratchPadTamperEraseByte(lfss, \
196  (DL_LFSS_SCRATCHPAD_MEM_WORD)memIndex, \
197  (DL_LFSS_SCRATCHPAD_MEM_BYTE)byteIndex)
198 
199 
203 #define DL_ScratchPad_isTamperEraseByteEnabled(lfss, memIndex, byteIndex) DL_LFSS_isScratchPadTamperEraseByteEnabled(lfss, \
204  (DL_LFSS_SCRATCHPAD_MEM_WORD)memIndex, \
205  (DL_LFSS_SCRATCHPAD_MEM_BYTE)byteIndex)
206 
207 
211 #define DL_ScratchPad_disableTamperEraseByte(lfss, memIndex, byteIndex) DL_LFSS_disableScratchPadTamperEraseByte(lfss, \
212  (DL_LFSS_SCRATCHPAD_MEM_WORD)memIndex, \
213  (DL_LFSS_SCRATCHPAD_MEM_BYTE)byteIndex)
214 
215 /* clang-format on */
216 
217 #ifdef __cplusplus
218 }
219 #endif
220 
221 #endif /* __MSPM0_HAS_SCRATCHPAD__ */
222 
223 #endif /* ti_dl_dl_scratchpad__include */
224 
dl_lfss.h
LFSS(Low Frequency Sub-System) Peripheral Interface.
© Copyright 1995-2025, Texas Instruments Incorporated. All rights reserved.
Trademarks | Privacy policy | Terms of use | Terms of sale