summaryrefslogtreecommitdiffstats
path: root/bsps/include/grlib/ftmctrl-regs.h
blob: fb4203270c918704f34dedf61880d40ac2d7b623 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
/* SPDX-License-Identifier: BSD-2-Clause */

/**
 * @file
 *
 * @ingroup RTEMSDeviceGRLIBFTMCTRL
 *
 * @brief This header file defines the FTMCTRL register block interface.
 */

/*
 * Copyright (C) 2021 embedded brains GmbH & Co. KG
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

/*
 * This file is part of the RTEMS quality process and was automatically
 * generated.  If you find something that needs to be fixed or
 * worded better please post a report or patch to an RTEMS mailing list
 * or raise a bug report:
 *
 * https://www.rtems.org/bugs.html
 *
 * For information on updating and regenerating please refer to the How-To
 * section in the Software Requirements Engineering chapter of the
 * RTEMS Software Engineering manual.  The manual is provided as a part of
 * a release.  For development sources please refer to the online
 * documentation at:
 *
 * https://docs.rtems.org
 */

/* Generated from spec:/dev/grlib/if/ftmctrl-header */

#ifndef _GRLIB_FTMCTRL_REGS_H
#define _GRLIB_FTMCTRL_REGS_H

#include <stdint.h>

#ifdef __cplusplus
extern "C" {
#endif

/* Generated from spec:/dev/grlib/if/ftmctrl */

/**
 * @defgroup RTEMSDeviceGRLIBFTMCTRL FTMCTRL
 *
 * @ingroup RTEMSDeviceGRLIB
 *
 * @brief This group contains the FTMCTRL interfaces.
 *
 * @{
 */

/**
 * @defgroup RTEMSDeviceGRLIBFTMCTRLMCFG1 \
 *   Memory configuration register 1 (MCFG1)
 *
 * @brief This group contains register bit definitions.
 *
 * @{
 */

#define FTMCTRL_MCFG1_PBRDY 0x40000000U

#define FTMCTRL_MCFG1_ABRDY 0x20000000U

#define FTMCTRL_MCFG1_IOBUSW_SHIFT 27
#define FTMCTRL_MCFG1_IOBUSW_MASK 0x18000000U
#define FTMCTRL_MCFG1_IOBUSW_GET( _reg ) \
  ( ( ( _reg ) & FTMCTRL_MCFG1_IOBUSW_MASK ) >> \
    FTMCTRL_MCFG1_IOBUSW_SHIFT )
#define FTMCTRL_MCFG1_IOBUSW_SET( _reg, _val ) \
  ( ( ( _reg ) & ~FTMCTRL_MCFG1_IOBUSW_MASK ) | \
    ( ( ( _val ) << FTMCTRL_MCFG1_IOBUSW_SHIFT ) & \
      FTMCTRL_MCFG1_IOBUSW_MASK ) )
#define FTMCTRL_MCFG1_IOBUSW( _val ) \
  ( ( ( _val ) << FTMCTRL_MCFG1_IOBUSW_SHIFT ) & \
    FTMCTRL_MCFG1_IOBUSW_MASK )

#define FTMCTRL_MCFG1_IBRDY 0x4000000U

#define FTMCTRL_MCFG1_BEXCN 0x2000000U

#define FTMCTRL_MCFG1_IO_WAITSTATES_SHIFT 20
#define FTMCTRL_MCFG1_IO_WAITSTATES_MASK 0xf00000U
#define FTMCTRL_MCFG1_IO_WAITSTATES_GET( _reg ) \
  ( ( ( _reg ) & FTMCTRL_MCFG1_IO_WAITSTATES_MASK ) >> \
    FTMCTRL_MCFG1_IO_WAITSTATES_SHIFT )
#define FTMCTRL_MCFG1_IO_WAITSTATES_SET( _reg, _val ) \
  ( ( ( _reg ) & ~FTMCTRL_MCFG1_IO_WAITSTATES_MASK ) | \
    ( ( ( _val ) << FTMCTRL_MCFG1_IO_WAITSTATES_SHIFT ) & \
      FTMCTRL_MCFG1_IO_WAITSTATES_MASK ) )
#define FTMCTRL_MCFG1_IO_WAITSTATES( _val ) \
  ( ( ( _val ) << FTMCTRL_MCFG1_IO_WAITSTATES_SHIFT ) & \
    FTMCTRL_MCFG1_IO_WAITSTATES_MASK )

#define FTMCTRL_MCFG1_IOEN 0x80000U

#define FTMCTRL_MCFG1_R 0x40000U

#define FTMCTRL_MCFG1_ROMBANKSZ_SHIFT 14
#define FTMCTRL_MCFG1_ROMBANKSZ_MASK 0x3c000U
#define FTMCTRL_MCFG1_ROMBANKSZ_GET( _reg ) \
  ( ( ( _reg ) & FTMCTRL_MCFG1_ROMBANKSZ_MASK ) >> \
    FTMCTRL_MCFG1_ROMBANKSZ_SHIFT )
#define FTMCTRL_MCFG1_ROMBANKSZ_SET( _reg, _val ) \
  ( ( ( _reg ) & ~FTMCTRL_MCFG1_ROMBANKSZ_MASK ) | \
    ( ( ( _val ) << FTMCTRL_MCFG1_ROMBANKSZ_SHIFT ) & \
      FTMCTRL_MCFG1_ROMBANKSZ_MASK ) )
#define FTMCTRL_MCFG1_ROMBANKSZ( _val ) \
  ( ( ( _val ) << FTMCTRL_MCFG1_ROMBANKSZ_SHIFT ) & \
    FTMCTRL_MCFG1_ROMBANKSZ_MASK )

#define FTMCTRL_MCFG1_PWEN 0x800U

#define FTMCTRL_MCFG1_PROM_WIDTH_SHIFT 8
#define FTMCTRL_MCFG1_PROM_WIDTH_MASK 0x300U
#define FTMCTRL_MCFG1_PROM_WIDTH_GET( _reg ) \
  ( ( ( _reg ) & FTMCTRL_MCFG1_PROM_WIDTH_MASK ) >> \
    FTMCTRL_MCFG1_PROM_WIDTH_SHIFT )
#define FTMCTRL_MCFG1_PROM_WIDTH_SET( _reg, _val ) \
  ( ( ( _reg ) & ~FTMCTRL_MCFG1_PROM_WIDTH_MASK ) | \
    ( ( ( _val ) << FTMCTRL_MCFG1_PROM_WIDTH_SHIFT ) & \
      FTMCTRL_MCFG1_PROM_WIDTH_MASK ) )
#define FTMCTRL_MCFG1_PROM_WIDTH( _val ) \
  ( ( ( _val ) << FTMCTRL_MCFG1_PROM_WIDTH_SHIFT ) & \
    FTMCTRL_MCFG1_PROM_WIDTH_MASK )

#define FTMCTRL_MCFG1_PROM_WRITE_WS_SHIFT 4
#define FTMCTRL_MCFG1_PROM_WRITE_WS_MASK 0xf0U
#define FTMCTRL_MCFG1_PROM_WRITE_WS_GET( _reg ) \
  ( ( ( _reg ) & FTMCTRL_MCFG1_PROM_WRITE_WS_MASK ) >> \
    FTMCTRL_MCFG1_PROM_WRITE_WS_SHIFT )
#define FTMCTRL_MCFG1_PROM_WRITE_WS_SET( _reg, _val ) \
  ( ( ( _reg ) & ~FTMCTRL_MCFG1_PROM_WRITE_WS_MASK ) | \
    ( ( ( _val ) << FTMCTRL_MCFG1_PROM_WRITE_WS_SHIFT ) & \
      FTMCTRL_MCFG1_PROM_WRITE_WS_MASK ) )
#define FTMCTRL_MCFG1_PROM_WRITE_WS( _val ) \
  ( ( ( _val ) << FTMCTRL_MCFG1_PROM_WRITE_WS_SHIFT ) & \
    FTMCTRL_MCFG1_PROM_WRITE_WS_MASK )

#define FTMCTRL_MCFG1_PROM_READ_WS_SHIFT 0
#define FTMCTRL_MCFG1_PROM_READ_WS_MASK 0xfU
#define FTMCTRL_MCFG1_PROM_READ_WS_GET( _reg ) \
  ( ( ( _reg ) & FTMCTRL_MCFG1_PROM_READ_WS_MASK ) >> \
    FTMCTRL_MCFG1_PROM_READ_WS_SHIFT )
#define FTMCTRL_MCFG1_PROM_READ_WS_SET( _reg, _val ) \
  ( ( ( _reg ) & ~FTMCTRL_MCFG1_PROM_READ_WS_MASK ) | \
    ( ( ( _val ) << FTMCTRL_MCFG1_PROM_READ_WS_SHIFT ) & \
      FTMCTRL_MCFG1_PROM_READ_WS_MASK ) )
#define FTMCTRL_MCFG1_PROM_READ_WS( _val ) \
  ( ( ( _val ) << FTMCTRL_MCFG1_PROM_READ_WS_SHIFT ) & \
    FTMCTRL_MCFG1_PROM_READ_WS_MASK )

/** @} */

/**
 * @defgroup RTEMSDeviceGRLIBFTMCTRLMCFG3 \
 *   Memory configuration register 3 (MCFG3)
 *
 * @brief This group contains register bit definitions.
 *
 * @{
 */

#define FTMCTRL_MCFG3_ME 0x8000000U

#define FTMCTRL_MCFG3_WB 0x800U

#define FTMCTRL_MCFG3_RB 0x400U

#define FTMCTRL_MCFG3_PE 0x100U

#define FTMCTRL_MCFG3_TCB_SHIFT 0
#define FTMCTRL_MCFG3_TCB_MASK 0xffU
#define FTMCTRL_MCFG3_TCB_GET( _reg ) \
  ( ( ( _reg ) & FTMCTRL_MCFG3_TCB_MASK ) >> \
    FTMCTRL_MCFG3_TCB_SHIFT )
#define FTMCTRL_MCFG3_TCB_SET( _reg, _val ) \
  ( ( ( _reg ) & ~FTMCTRL_MCFG3_TCB_MASK ) | \
    ( ( ( _val ) << FTMCTRL_MCFG3_TCB_SHIFT ) & \
      FTMCTRL_MCFG3_TCB_MASK ) )
#define FTMCTRL_MCFG3_TCB( _val ) \
  ( ( ( _val ) << FTMCTRL_MCFG3_TCB_SHIFT ) & \
    FTMCTRL_MCFG3_TCB_MASK )

/** @} */

/**
 * @defgroup RTEMSDeviceGRLIBFTMCTRLMCFG5 \
 *   Memory configuration register 5 (MCFG5)
 *
 * @brief This group contains register bit definitions.
 *
 * @{
 */

#define FTMCTRL_MCFG5_IOHWS_SHIFT 23
#define FTMCTRL_MCFG5_IOHWS_MASK 0x3f800000U
#define FTMCTRL_MCFG5_IOHWS_GET( _reg ) \
  ( ( ( _reg ) & FTMCTRL_MCFG5_IOHWS_MASK ) >> \
    FTMCTRL_MCFG5_IOHWS_SHIFT )
#define FTMCTRL_MCFG5_IOHWS_SET( _reg, _val ) \
  ( ( ( _reg ) & ~FTMCTRL_MCFG5_IOHWS_MASK ) | \
    ( ( ( _val ) << FTMCTRL_MCFG5_IOHWS_SHIFT ) & \
      FTMCTRL_MCFG5_IOHWS_MASK ) )
#define FTMCTRL_MCFG5_IOHWS( _val ) \
  ( ( ( _val ) << FTMCTRL_MCFG5_IOHWS_SHIFT ) & \
    FTMCTRL_MCFG5_IOHWS_MASK )

#define FTMCTRL_MCFG5_ROMHWS_SHIFT 7
#define FTMCTRL_MCFG5_ROMHWS_MASK 0x3f80U
#define FTMCTRL_MCFG5_ROMHWS_GET( _reg ) \
  ( ( ( _reg ) & FTMCTRL_MCFG5_ROMHWS_MASK ) >> \
    FTMCTRL_MCFG5_ROMHWS_SHIFT )
#define FTMCTRL_MCFG5_ROMHWS_SET( _reg, _val ) \
  ( ( ( _reg ) & ~FTMCTRL_MCFG5_ROMHWS_MASK ) | \
    ( ( ( _val ) << FTMCTRL_MCFG5_ROMHWS_SHIFT ) & \
      FTMCTRL_MCFG5_ROMHWS_MASK ) )
#define FTMCTRL_MCFG5_ROMHWS( _val ) \
  ( ( ( _val ) << FTMCTRL_MCFG5_ROMHWS_SHIFT ) & \
    FTMCTRL_MCFG5_ROMHWS_MASK )

/** @} */

/**
 * @defgroup RTEMSDeviceGRLIBFTMCTRLMCFG7 \
 *   Memory configuration register 7 (MCFG7)
 *
 * @brief This group contains register bit definitions.
 *
 * @{
 */

#define FTMCTRL_MCFG7_BRDYNCNT_SHIFT 16
#define FTMCTRL_MCFG7_BRDYNCNT_MASK 0xffff0000U
#define FTMCTRL_MCFG7_BRDYNCNT_GET( _reg ) \
  ( ( ( _reg ) & FTMCTRL_MCFG7_BRDYNCNT_MASK ) >> \
    FTMCTRL_MCFG7_BRDYNCNT_SHIFT )
#define FTMCTRL_MCFG7_BRDYNCNT_SET( _reg, _val ) \
  ( ( ( _reg ) & ~FTMCTRL_MCFG7_BRDYNCNT_MASK ) | \
    ( ( ( _val ) << FTMCTRL_MCFG7_BRDYNCNT_SHIFT ) & \
      FTMCTRL_MCFG7_BRDYNCNT_MASK ) )
#define FTMCTRL_MCFG7_BRDYNCNT( _val ) \
  ( ( ( _val ) << FTMCTRL_MCFG7_BRDYNCNT_SHIFT ) & \
    FTMCTRL_MCFG7_BRDYNCNT_MASK )

#define FTMCTRL_MCFG7_BRDYNRLD_SHIFT 0
#define FTMCTRL_MCFG7_BRDYNRLD_MASK 0xffffU
#define FTMCTRL_MCFG7_BRDYNRLD_GET( _reg ) \
  ( ( ( _reg ) & FTMCTRL_MCFG7_BRDYNRLD_MASK ) >> \
    FTMCTRL_MCFG7_BRDYNRLD_SHIFT )
#define FTMCTRL_MCFG7_BRDYNRLD_SET( _reg, _val ) \
  ( ( ( _reg ) & ~FTMCTRL_MCFG7_BRDYNRLD_MASK ) | \
    ( ( ( _val ) << FTMCTRL_MCFG7_BRDYNRLD_SHIFT ) & \
      FTMCTRL_MCFG7_BRDYNRLD_MASK ) )
#define FTMCTRL_MCFG7_BRDYNRLD( _val ) \
  ( ( ( _val ) << FTMCTRL_MCFG7_BRDYNRLD_SHIFT ) & \
    FTMCTRL_MCFG7_BRDYNRLD_MASK )

/** @} */

/**
 * @brief This structure defines the FTMCTRL register block memory map.
 */
typedef struct ftmctrl {
  /**
   * @brief See @ref RTEMSDeviceGRLIBFTMCTRLMCFG1.
   */
  uint32_t mcfg1;

  uint32_t reserved_4_8;

  /**
   * @brief See @ref RTEMSDeviceGRLIBFTMCTRLMCFG3.
   */
  uint32_t mcfg3;

  uint32_t reserved_c_10;

  /**
   * @brief See @ref RTEMSDeviceGRLIBFTMCTRLMCFG5.
   */
  uint32_t mcfg5;

  uint32_t reserved_14_18;

  /**
   * @brief See @ref RTEMSDeviceGRLIBFTMCTRLMCFG7.
   */
  uint32_t mcfg7;
} ftmctrl;

/** @} */

#ifdef __cplusplus
}
#endif

#endif /* _GRLIB_FTMCTRL_REGS_H */