Software APIs
clkmgr_regs.h
Go to the documentation of this file.
1/**
2 * @file
3 * @brief Generated register defines for clkmgr
4 */
5
6// Copyright information found in source file:
7// Copyright lowRISC contributors (OpenTitan project).
8
9// Licensing information found in source file:
10// Licensed under the Apache License, Version 2.0, see LICENSE for details.
11// SPDX-License-Identifier: Apache-2.0
12
13#ifndef _CLKMGR_REG_DEFS_
14#define _CLKMGR_REG_DEFS_
15
16#ifdef __cplusplus
17extern "C" {
18#endif
19// Number of clock groups
20#define CLKMGR_PARAM_NUM_GROUPS 8
21
22// Number of SW gateable clocks
23#define CLKMGR_PARAM_NUM_SW_GATEABLE_CLOCKS 4
24
25// Number of hintable clocks
26#define CLKMGR_PARAM_NUM_HINTABLE_CLOCKS 4
27
28// Number of alerts
29#define CLKMGR_PARAM_NUM_ALERTS 2
30
31// Register width
32#define CLKMGR_PARAM_REG_WIDTH 32
33
34// Alert Test Register
35#define CLKMGR_ALERT_TEST_REG_OFFSET 0x0
36#define CLKMGR_ALERT_TEST_REG_RESVAL 0x80000000u
37#define CLKMGR_ALERT_TEST_RECOV_FAULT_BIT 0
38#define CLKMGR_ALERT_TEST_FATAL_FAULT_BIT 1
39#define CLKMGR_ALERT_TEST_REGWEN_BIT 31
40
41// External clock control write enable
42#define CLKMGR_EXTCLK_CTRL_REGWEN_REG_OFFSET 0x4
43#define CLKMGR_EXTCLK_CTRL_REGWEN_REG_RESVAL 0x1u
44#define CLKMGR_EXTCLK_CTRL_REGWEN_EN_BIT 0
45
46// Select external clock
47#define CLKMGR_EXTCLK_CTRL_REG_OFFSET 0x8
48#define CLKMGR_EXTCLK_CTRL_REG_RESVAL 0x99u
49#define CLKMGR_EXTCLK_CTRL_SEL_MASK 0xfu
50#define CLKMGR_EXTCLK_CTRL_SEL_OFFSET 0
51#define CLKMGR_EXTCLK_CTRL_SEL_FIELD \
52 ((bitfield_field32_t) { .mask = CLKMGR_EXTCLK_CTRL_SEL_MASK, .index = CLKMGR_EXTCLK_CTRL_SEL_OFFSET })
53#define CLKMGR_EXTCLK_CTRL_HI_SPEED_SEL_MASK 0xfu
54#define CLKMGR_EXTCLK_CTRL_HI_SPEED_SEL_OFFSET 4
55#define CLKMGR_EXTCLK_CTRL_HI_SPEED_SEL_FIELD \
56 ((bitfield_field32_t) { .mask = CLKMGR_EXTCLK_CTRL_HI_SPEED_SEL_MASK, .index = CLKMGR_EXTCLK_CTRL_HI_SPEED_SEL_OFFSET })
57
58// Status of requested external clock switch
59#define CLKMGR_EXTCLK_STATUS_REG_OFFSET 0xc
60#define CLKMGR_EXTCLK_STATUS_REG_RESVAL 0x9u
61#define CLKMGR_EXTCLK_STATUS_ACK_MASK 0xfu
62#define CLKMGR_EXTCLK_STATUS_ACK_OFFSET 0
63#define CLKMGR_EXTCLK_STATUS_ACK_FIELD \
64 ((bitfield_field32_t) { .mask = CLKMGR_EXTCLK_STATUS_ACK_MASK, .index = CLKMGR_EXTCLK_STATUS_ACK_OFFSET })
65
66// Jitter write enable
67#define CLKMGR_JITTER_REGWEN_REG_OFFSET 0x10
68#define CLKMGR_JITTER_REGWEN_REG_RESVAL 0x1u
69#define CLKMGR_JITTER_REGWEN_EN_BIT 0
70
71// Enable jittery clock
72#define CLKMGR_JITTER_ENABLE_REG_OFFSET 0x14
73#define CLKMGR_JITTER_ENABLE_REG_RESVAL 0x9u
74#define CLKMGR_JITTER_ENABLE_VAL_MASK 0xfu
75#define CLKMGR_JITTER_ENABLE_VAL_OFFSET 0
76#define CLKMGR_JITTER_ENABLE_VAL_FIELD \
77 ((bitfield_field32_t) { .mask = CLKMGR_JITTER_ENABLE_VAL_MASK, .index = CLKMGR_JITTER_ENABLE_VAL_OFFSET })
78
79// Clock enable for software gateable clocks.
80#define CLKMGR_CLK_ENABLES_REG_OFFSET 0x18
81#define CLKMGR_CLK_ENABLES_REG_RESVAL 0xfu
82#define CLKMGR_CLK_ENABLES_CLK_IO_DIV4_PERI_EN_BIT 0
83#define CLKMGR_CLK_ENABLES_CLK_IO_PERI_EN_BIT 1
84#define CLKMGR_CLK_ENABLES_CLK_USB_PERI_EN_BIT 2
85#define CLKMGR_CLK_ENABLES_CLK_IO_SPI_HOST1_EN_BIT 3
86
87// Clock hint for software gateable transactional clocks during active mode.
88#define CLKMGR_CLK_HINTS_REG_OFFSET 0x1c
89#define CLKMGR_CLK_HINTS_REG_RESVAL 0xfu
90#define CLKMGR_CLK_HINTS_CLK_MAIN_AES_HINT_BIT 0
91#define CLKMGR_CLK_HINTS_CLK_MAIN_HMAC_HINT_BIT 1
92#define CLKMGR_CLK_HINTS_CLK_MAIN_KMAC_HINT_BIT 2
93#define CLKMGR_CLK_HINTS_CLK_MAIN_OTBN_HINT_BIT 3
94
95// Since the final state of !!CLK_HINTS is not always determined by software,
96#define CLKMGR_CLK_HINTS_STATUS_REG_OFFSET 0x20
97#define CLKMGR_CLK_HINTS_STATUS_REG_RESVAL 0xfu
98#define CLKMGR_CLK_HINTS_STATUS_CLK_MAIN_AES_VAL_BIT 0
99#define CLKMGR_CLK_HINTS_STATUS_CLK_MAIN_HMAC_VAL_BIT 1
100#define CLKMGR_CLK_HINTS_STATUS_CLK_MAIN_KMAC_VAL_BIT 2
101#define CLKMGR_CLK_HINTS_STATUS_CLK_MAIN_OTBN_VAL_BIT 3
102
103// Measurement control write enable
104#define CLKMGR_MEASURE_CTRL_REGWEN_REG_OFFSET 0x24
105#define CLKMGR_MEASURE_CTRL_REGWEN_REG_RESVAL 0x1u
106#define CLKMGR_MEASURE_CTRL_REGWEN_EN_BIT 0
107
108// Enable for measurement control
109#define CLKMGR_IO_MEAS_CTRL_EN_REG_OFFSET 0x28
110#define CLKMGR_IO_MEAS_CTRL_EN_REG_RESVAL 0x9u
111#define CLKMGR_IO_MEAS_CTRL_EN_EN_MASK 0xfu
112#define CLKMGR_IO_MEAS_CTRL_EN_EN_OFFSET 0
113#define CLKMGR_IO_MEAS_CTRL_EN_EN_FIELD \
114 ((bitfield_field32_t) { .mask = CLKMGR_IO_MEAS_CTRL_EN_EN_MASK, .index = CLKMGR_IO_MEAS_CTRL_EN_EN_OFFSET })
115
116// Configuration controls for io measurement.
117#define CLKMGR_IO_MEAS_CTRL_SHADOWED_REG_OFFSET 0x2c
118#define CLKMGR_IO_MEAS_CTRL_SHADOWED_REG_RESVAL 0x759eau
119#define CLKMGR_IO_MEAS_CTRL_SHADOWED_HI_MASK 0x3ffu
120#define CLKMGR_IO_MEAS_CTRL_SHADOWED_HI_OFFSET 0
121#define CLKMGR_IO_MEAS_CTRL_SHADOWED_HI_FIELD \
122 ((bitfield_field32_t) { .mask = CLKMGR_IO_MEAS_CTRL_SHADOWED_HI_MASK, .index = CLKMGR_IO_MEAS_CTRL_SHADOWED_HI_OFFSET })
123#define CLKMGR_IO_MEAS_CTRL_SHADOWED_LO_MASK 0x3ffu
124#define CLKMGR_IO_MEAS_CTRL_SHADOWED_LO_OFFSET 10
125#define CLKMGR_IO_MEAS_CTRL_SHADOWED_LO_FIELD \
126 ((bitfield_field32_t) { .mask = CLKMGR_IO_MEAS_CTRL_SHADOWED_LO_MASK, .index = CLKMGR_IO_MEAS_CTRL_SHADOWED_LO_OFFSET })
127
128// Enable for measurement control
129#define CLKMGR_IO_DIV4_MEAS_CTRL_EN_REG_OFFSET 0x30
130#define CLKMGR_IO_DIV4_MEAS_CTRL_EN_REG_RESVAL 0x9u
131#define CLKMGR_IO_DIV4_MEAS_CTRL_EN_EN_MASK 0xfu
132#define CLKMGR_IO_DIV4_MEAS_CTRL_EN_EN_OFFSET 0
133#define CLKMGR_IO_DIV4_MEAS_CTRL_EN_EN_FIELD \
134 ((bitfield_field32_t) { .mask = CLKMGR_IO_DIV4_MEAS_CTRL_EN_EN_MASK, .index = CLKMGR_IO_DIV4_MEAS_CTRL_EN_EN_OFFSET })
135
136// Configuration controls for io_div4 measurement.
137#define CLKMGR_IO_DIV4_MEAS_CTRL_SHADOWED_REG_OFFSET 0x34
138#define CLKMGR_IO_DIV4_MEAS_CTRL_SHADOWED_REG_RESVAL 0x6e82u
139#define CLKMGR_IO_DIV4_MEAS_CTRL_SHADOWED_HI_MASK 0xffu
140#define CLKMGR_IO_DIV4_MEAS_CTRL_SHADOWED_HI_OFFSET 0
141#define CLKMGR_IO_DIV4_MEAS_CTRL_SHADOWED_HI_FIELD \
142 ((bitfield_field32_t) { .mask = CLKMGR_IO_DIV4_MEAS_CTRL_SHADOWED_HI_MASK, .index = CLKMGR_IO_DIV4_MEAS_CTRL_SHADOWED_HI_OFFSET })
143#define CLKMGR_IO_DIV4_MEAS_CTRL_SHADOWED_LO_MASK 0xffu
144#define CLKMGR_IO_DIV4_MEAS_CTRL_SHADOWED_LO_OFFSET 8
145#define CLKMGR_IO_DIV4_MEAS_CTRL_SHADOWED_LO_FIELD \
146 ((bitfield_field32_t) { .mask = CLKMGR_IO_DIV4_MEAS_CTRL_SHADOWED_LO_MASK, .index = CLKMGR_IO_DIV4_MEAS_CTRL_SHADOWED_LO_OFFSET })
147
148// Enable for measurement control
149#define CLKMGR_MAIN_MEAS_CTRL_EN_REG_OFFSET 0x38
150#define CLKMGR_MAIN_MEAS_CTRL_EN_REG_RESVAL 0x9u
151#define CLKMGR_MAIN_MEAS_CTRL_EN_EN_MASK 0xfu
152#define CLKMGR_MAIN_MEAS_CTRL_EN_EN_OFFSET 0
153#define CLKMGR_MAIN_MEAS_CTRL_EN_EN_FIELD \
154 ((bitfield_field32_t) { .mask = CLKMGR_MAIN_MEAS_CTRL_EN_EN_MASK, .index = CLKMGR_MAIN_MEAS_CTRL_EN_EN_OFFSET })
155
156// Configuration controls for main measurement.
157#define CLKMGR_MAIN_MEAS_CTRL_SHADOWED_REG_OFFSET 0x3c
158#define CLKMGR_MAIN_MEAS_CTRL_SHADOWED_REG_RESVAL 0x7a9feu
159#define CLKMGR_MAIN_MEAS_CTRL_SHADOWED_HI_MASK 0x3ffu
160#define CLKMGR_MAIN_MEAS_CTRL_SHADOWED_HI_OFFSET 0
161#define CLKMGR_MAIN_MEAS_CTRL_SHADOWED_HI_FIELD \
162 ((bitfield_field32_t) { .mask = CLKMGR_MAIN_MEAS_CTRL_SHADOWED_HI_MASK, .index = CLKMGR_MAIN_MEAS_CTRL_SHADOWED_HI_OFFSET })
163#define CLKMGR_MAIN_MEAS_CTRL_SHADOWED_LO_MASK 0x3ffu
164#define CLKMGR_MAIN_MEAS_CTRL_SHADOWED_LO_OFFSET 10
165#define CLKMGR_MAIN_MEAS_CTRL_SHADOWED_LO_FIELD \
166 ((bitfield_field32_t) { .mask = CLKMGR_MAIN_MEAS_CTRL_SHADOWED_LO_MASK, .index = CLKMGR_MAIN_MEAS_CTRL_SHADOWED_LO_OFFSET })
167
168// Enable for measurement control
169#define CLKMGR_USB_MEAS_CTRL_EN_REG_OFFSET 0x40
170#define CLKMGR_USB_MEAS_CTRL_EN_REG_RESVAL 0x9u
171#define CLKMGR_USB_MEAS_CTRL_EN_EN_MASK 0xfu
172#define CLKMGR_USB_MEAS_CTRL_EN_EN_OFFSET 0
173#define CLKMGR_USB_MEAS_CTRL_EN_EN_FIELD \
174 ((bitfield_field32_t) { .mask = CLKMGR_USB_MEAS_CTRL_EN_EN_MASK, .index = CLKMGR_USB_MEAS_CTRL_EN_EN_OFFSET })
175
176// Configuration controls for usb measurement.
177#define CLKMGR_USB_MEAS_CTRL_SHADOWED_REG_OFFSET 0x44
178#define CLKMGR_USB_MEAS_CTRL_SHADOWED_REG_RESVAL 0x1ccfau
179#define CLKMGR_USB_MEAS_CTRL_SHADOWED_HI_MASK 0x1ffu
180#define CLKMGR_USB_MEAS_CTRL_SHADOWED_HI_OFFSET 0
181#define CLKMGR_USB_MEAS_CTRL_SHADOWED_HI_FIELD \
182 ((bitfield_field32_t) { .mask = CLKMGR_USB_MEAS_CTRL_SHADOWED_HI_MASK, .index = CLKMGR_USB_MEAS_CTRL_SHADOWED_HI_OFFSET })
183#define CLKMGR_USB_MEAS_CTRL_SHADOWED_LO_MASK 0x1ffu
184#define CLKMGR_USB_MEAS_CTRL_SHADOWED_LO_OFFSET 9
185#define CLKMGR_USB_MEAS_CTRL_SHADOWED_LO_FIELD \
186 ((bitfield_field32_t) { .mask = CLKMGR_USB_MEAS_CTRL_SHADOWED_LO_MASK, .index = CLKMGR_USB_MEAS_CTRL_SHADOWED_LO_OFFSET })
187
188// Recoverable Error code
189#define CLKMGR_RECOV_ERR_CODE_REG_OFFSET 0x48
190#define CLKMGR_RECOV_ERR_CODE_REG_RESVAL 0x0u
191#define CLKMGR_RECOV_ERR_CODE_SHADOW_UPDATE_ERR_BIT 0
192#define CLKMGR_RECOV_ERR_CODE_IO_MEASURE_ERR_BIT 1
193#define CLKMGR_RECOV_ERR_CODE_IO_DIV4_MEASURE_ERR_BIT 2
194#define CLKMGR_RECOV_ERR_CODE_MAIN_MEASURE_ERR_BIT 3
195#define CLKMGR_RECOV_ERR_CODE_USB_MEASURE_ERR_BIT 4
196#define CLKMGR_RECOV_ERR_CODE_IO_TIMEOUT_ERR_BIT 5
197#define CLKMGR_RECOV_ERR_CODE_IO_DIV4_TIMEOUT_ERR_BIT 6
198#define CLKMGR_RECOV_ERR_CODE_MAIN_TIMEOUT_ERR_BIT 7
199#define CLKMGR_RECOV_ERR_CODE_USB_TIMEOUT_ERR_BIT 8
200
201// Error code
202#define CLKMGR_FATAL_ERR_CODE_REG_OFFSET 0x4c
203#define CLKMGR_FATAL_ERR_CODE_REG_RESVAL 0x0u
204#define CLKMGR_FATAL_ERR_CODE_REG_INTG_BIT 0
205#define CLKMGR_FATAL_ERR_CODE_IDLE_CNT_BIT 1
206#define CLKMGR_FATAL_ERR_CODE_SHADOW_STORAGE_ERR_BIT 2
207
208#ifdef __cplusplus
209} // extern "C"
210#endif
211#endif // _CLKMGR_REG_DEFS_
212// End generated register defines for clkmgr