1 |
2 |
zero_gravi |
// #################################################################################################
|
2 |
|
|
// # << NEORV32: neorv32.h - Main Core Library File >> #
|
3 |
|
|
// # ********************************************************************************************* #
|
4 |
|
|
// # BSD 3-Clause License #
|
5 |
|
|
// # #
|
6 |
|
|
// # Copyright (c) 2020, Stephan Nolting. All rights reserved. #
|
7 |
|
|
// # #
|
8 |
|
|
// # Redistribution and use in source and binary forms, with or without modification, are #
|
9 |
|
|
// # permitted provided that the following conditions are met: #
|
10 |
|
|
// # #
|
11 |
|
|
// # 1. Redistributions of source code must retain the above copyright notice, this list of #
|
12 |
|
|
// # conditions and the following disclaimer. #
|
13 |
|
|
// # #
|
14 |
|
|
// # 2. Redistributions in binary form must reproduce the above copyright notice, this list of #
|
15 |
|
|
// # conditions and the following disclaimer in the documentation and/or other materials #
|
16 |
|
|
// # provided with the distribution. #
|
17 |
|
|
// # #
|
18 |
|
|
// # 3. Neither the name of the copyright holder nor the names of its contributors may be used to #
|
19 |
|
|
// # endorse or promote products derived from this software without specific prior written #
|
20 |
|
|
// # permission. #
|
21 |
|
|
// # #
|
22 |
|
|
// # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS #
|
23 |
|
|
// # OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF #
|
24 |
|
|
// # MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE #
|
25 |
|
|
// # COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, #
|
26 |
|
|
// # EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE #
|
27 |
|
|
// # GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED #
|
28 |
|
|
// # AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING #
|
29 |
|
|
// # NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED #
|
30 |
|
|
// # OF THE POSSIBILITY OF SUCH DAMAGE. #
|
31 |
|
|
// # ********************************************************************************************* #
|
32 |
|
|
// # The NEORV32 Processor - https://github.com/stnolting/neorv32 (c) Stephan Nolting #
|
33 |
|
|
// #################################################################################################
|
34 |
|
|
|
35 |
|
|
|
36 |
|
|
/**********************************************************************//**
|
37 |
|
|
* @file neorv32.h
|
38 |
|
|
* @author Stephan Nolting
|
39 |
|
|
*
|
40 |
20 |
zero_gravi |
* @brief Main NEORV32 core library include file.
|
41 |
2 |
zero_gravi |
**************************************************************************/
|
42 |
|
|
|
43 |
|
|
#ifndef neorv32_h
|
44 |
|
|
#define neorv32_h
|
45 |
|
|
|
46 |
|
|
// Standard libraries
|
47 |
|
|
#include <stdint.h>
|
48 |
|
|
#include <inttypes.h>
|
49 |
|
|
#include <limits.h>
|
50 |
|
|
|
51 |
|
|
|
52 |
|
|
/**********************************************************************//**
|
53 |
|
|
* Available CPU Control and Status Registers (CSRs)
|
54 |
|
|
**************************************************************************/
|
55 |
|
|
enum NEORV32_CPU_CSRS_enum {
|
56 |
41 |
zero_gravi |
CSR_MSTATUS = 0x300, /**< 0x300 - mstatus (r/w): Machine status register */
|
57 |
|
|
CSR_MISA = 0x301, /**< 0x301 - misa (r/-): CPU ISA and extensions (read-only in NEORV32) */
|
58 |
|
|
CSR_MIE = 0x304, /**< 0x304 - mie (r/w): Machine interrupt-enable register */
|
59 |
|
|
CSR_MTVEC = 0x305, /**< 0x305 - mtvec (r/w): Machine trap-handler base address (for ALL traps) */
|
60 |
|
|
CSR_MCOUNTEREN = 0x306, /**< 0x305 - mcounteren (r/w): Machine counter enable register (controls access rights from U-mode) */
|
61 |
|
|
CSR_MSTATUSH = 0x310, /**< 0x310 - mstatush (r/-): Machine status register - high word */
|
62 |
2 |
zero_gravi |
|
63 |
41 |
zero_gravi |
CSR_MCOUNTINHIBIT = 0x320, /**< 0x320 - mcountinhibit (r/w): Machine counter-inhibit register */
|
64 |
2 |
zero_gravi |
|
65 |
41 |
zero_gravi |
CSR_MSCRATCH = 0x340, /**< 0x340 - mscratch (r/w): Machine scratch register */
|
66 |
|
|
CSR_MEPC = 0x341, /**< 0x341 - mepc (r/w): Machine exception program counter */
|
67 |
|
|
CSR_MCAUSE = 0x342, /**< 0x342 - mcause (r/w): Machine trap cause */
|
68 |
|
|
CSR_MTVAL = 0x343, /**< 0x343 - mtval (r/w): Machine bad address or instruction */
|
69 |
|
|
CSR_MIP = 0x344, /**< 0x344 - mip (r/w): Machine interrupt pending register */
|
70 |
15 |
zero_gravi |
|
71 |
41 |
zero_gravi |
CSR_PMPCFG0 = 0x3a0, /**< 0x3a0 - pmpcfg0 (r/w): Physical memory protection configuration register 0 */
|
72 |
|
|
CSR_PMPCFG1 = 0x3a1, /**< 0x3a1 - pmpcfg1 (r/w): Physical memory protection configuration register 1 */
|
73 |
15 |
zero_gravi |
|
74 |
41 |
zero_gravi |
CSR_PMPADDR0 = 0x3b0, /**< 0x3b0 - pmpaddr0 (r/w): Physical memory protection address register 0 */
|
75 |
|
|
CSR_PMPADDR1 = 0x3b1, /**< 0x3b1 - pmpaddr1 (r/w): Physical memory protection address register 1 */
|
76 |
|
|
CSR_PMPADDR2 = 0x3b2, /**< 0x3b2 - pmpaddr2 (r/w): Physical memory protection address register 2 */
|
77 |
|
|
CSR_PMPADDR3 = 0x3b3, /**< 0x3b3 - pmpaddr3 (r/w): Physical memory protection address register 3 */
|
78 |
|
|
CSR_PMPADDR4 = 0x3b4, /**< 0x3b4 - pmpaddr4 (r/w): Physical memory protection address register 4 */
|
79 |
|
|
CSR_PMPADDR5 = 0x3b5, /**< 0x3b5 - pmpaddr5 (r/w): Physical memory protection address register 5 */
|
80 |
|
|
CSR_PMPADDR6 = 0x3b6, /**< 0x3b6 - pmpaddr6 (r/w): Physical memory protection address register 6 */
|
81 |
|
|
CSR_PMPADDR7 = 0x3b7, /**< 0x3b7 - pmpaddr7 (r/w): Physical memory protection address register 7 */
|
82 |
18 |
zero_gravi |
|
83 |
41 |
zero_gravi |
CSR_MCYCLE = 0xb00, /**< 0xb00 - mcycle (r/w): Machine cycle counter low word */
|
84 |
|
|
CSR_MINSTRET = 0xb02, /**< 0xb02 - minstret (r/w): Machine instructions-retired counter low word */
|
85 |
2 |
zero_gravi |
|
86 |
41 |
zero_gravi |
CSR_MCYCLEH = 0xb80, /**< 0xb80 - mcycleh (r/w): Machine cycle counter high word */
|
87 |
|
|
CSR_MINSTRETH = 0xb82, /**< 0xb82 - minstreth (r/w): Machine instructions-retired counter high word */
|
88 |
2 |
zero_gravi |
|
89 |
41 |
zero_gravi |
CSR_CYCLE = 0xc00, /**< 0xc00 - cycle (r/-): Cycle counter low word (from MCYCLE) */
|
90 |
|
|
CSR_TIME = 0xc01, /**< 0xc01 - time (r/-): Timer low word (from MTIME.TIME_LO) */
|
91 |
|
|
CSR_INSTRET = 0xc02, /**< 0xc02 - instret (r/-): Instructions-retired counter low word (from MINSTRET) */
|
92 |
2 |
zero_gravi |
|
93 |
41 |
zero_gravi |
CSR_CYCLEH = 0xc80, /**< 0xc80 - cycleh (r/-): Cycle counter high word (from MCYCLEH) */
|
94 |
|
|
CSR_TIMEH = 0xc81, /**< 0xc81 - timeh (r/-): Timer high word (from MTIME.TIME_HI) */
|
95 |
|
|
CSR_INSTRETH = 0xc82, /**< 0xc82 - instreth (r/-): Instructions-retired counter high word (from MINSTRETH) */
|
96 |
22 |
zero_gravi |
|
97 |
41 |
zero_gravi |
CSR_MVENDORID = 0xf11, /**< 0xf11 - mvendorid (r/-): Vendor ID */
|
98 |
|
|
CSR_MARCHID = 0xf12, /**< 0xf12 - marchid (r/-): Architecture ID */
|
99 |
|
|
CSR_MIMPID = 0xf13, /**< 0xf13 - mimpid (r/-): Implementation ID/version */
|
100 |
|
|
CSR_MHARTID = 0xf14, /**< 0xf14 - mhartid (r/-): Hardware thread ID (always 0) */
|
101 |
|
|
|
102 |
|
|
CSR_MZEXT = 0xfc0 /**< 0xfc0 - mzext (custom CSR) (r/-): Available Z* CPU extensions */
|
103 |
2 |
zero_gravi |
};
|
104 |
|
|
|
105 |
|
|
|
106 |
|
|
/**********************************************************************//**
|
107 |
|
|
* CPU <b>mstatus</b> CSR (r/w): Machine status (RISC-V spec.)
|
108 |
|
|
**************************************************************************/
|
109 |
|
|
enum NEORV32_CPU_MSTATUS_enum {
|
110 |
40 |
zero_gravi |
CPU_MSTATUS_MIE = 3, /**< CPU mstatus CSR (3): MIE - Machine interrupt enable bit (r/w) */
|
111 |
41 |
zero_gravi |
CPU_MSTATUS_UBE = 6, /**< CPU mstatus CSR (6): UBE - User-mode endianness (little-endian=0, big-endian=1) (r/-) */
|
112 |
40 |
zero_gravi |
CPU_MSTATUS_MPIE = 7, /**< CPU mstatus CSR (7): MPIE - Machine previous interrupt enable bit (r/w) */
|
113 |
|
|
CPU_MSTATUS_MPP_L = 11, /**< CPU mstatus CSR (11): MPP_L - Machine previous privilege mode bit low (r/w) */
|
114 |
|
|
CPU_MSTATUS_MPP_H = 12 /**< CPU mstatus CSR (12): MPP_H - Machine previous privilege mode bit high (r/w) */
|
115 |
2 |
zero_gravi |
};
|
116 |
|
|
|
117 |
|
|
|
118 |
|
|
/**********************************************************************//**
|
119 |
41 |
zero_gravi |
* CPU <b>mstatush</b> CSR (r/-): Machine status - high word (RISC-V spec.)
|
120 |
40 |
zero_gravi |
**************************************************************************/
|
121 |
|
|
enum NEORV32_CPU_MSTATUSH_enum {
|
122 |
41 |
zero_gravi |
CPU_MSTATUSH_MBE = 5 /**< CPU mstatush CSR (5): MBE - Machine-mode endianness (little-endian=0, big-endian=1) (r/-) */
|
123 |
40 |
zero_gravi |
};
|
124 |
|
|
|
125 |
|
|
|
126 |
|
|
/**********************************************************************//**
|
127 |
41 |
zero_gravi |
* CPU <b>mcounteren</b> CSR (r/w): Machine counter enable (RISC-V spec.)
|
128 |
|
|
**************************************************************************/
|
129 |
|
|
enum NEORV32_CPU_MCOUNTEREN_enum {
|
130 |
|
|
CPU_MCOUNTEREN_CY = 0, /**< CPU mcounteren CSR (0): CY - Allow access to cycle[h] CSRs from U-mode when set (r/w) */
|
131 |
|
|
CPU_MCOUNTEREN_TM = 1, /**< CPU mcounteren CSR (1): TM - Allow access to time[h] CSRs from U-mode when set (r/w) */
|
132 |
|
|
CPU_MCOUNTEREN_IR = 2 /**< CPU mcounteren CSR (2): IR - Allow access to instret[h] CSRs from U-mode when set (r/w) */
|
133 |
|
|
};
|
134 |
|
|
|
135 |
|
|
|
136 |
|
|
/**********************************************************************//**
|
137 |
|
|
* CPU <b>mcountinhibit</b> CSR (r/w): Machine counter-inhibit (RISC-V spec.)
|
138 |
|
|
**************************************************************************/
|
139 |
|
|
enum NEORV32_CPU_MCOUNTINHIBIT_enum {
|
140 |
|
|
CPU_MCOUNTINHIBIT_CY = 0, /**< CPU mcountinhibit CSR (0): CY - Enable auto-increment of [m]cycle[h] CSR when set (r/w) */
|
141 |
|
|
CPU_MCOUNTINHIBIT_IR = 2 /**< CPU mcountinhibit CSR (2): IR - Enable auto-increment of [m]instret[h] CSR when set (r/w) */
|
142 |
|
|
};
|
143 |
|
|
|
144 |
|
|
|
145 |
|
|
/**********************************************************************//**
|
146 |
2 |
zero_gravi |
* CPU <b>mie</b> CSR (r/w): Machine interrupt enable (RISC-V spec.)
|
147 |
|
|
**************************************************************************/
|
148 |
|
|
enum NEORV32_CPU_MIE_enum {
|
149 |
40 |
zero_gravi |
CPU_MIE_MSIE = 3, /**< CPU mie CSR (3): MSIE - Machine software interrupt enable (r/w) */
|
150 |
|
|
CPU_MIE_MTIE = 7, /**< CPU mie CSR (7): MTIE - Machine timer interrupt enable bit (r/w) */
|
151 |
|
|
CPU_MIE_MEIE = 11, /**< CPU mie CSR (11): MEIE - Machine external interrupt enable bit (r/w) */
|
152 |
|
|
CPU_MIE_FIRQ0E = 16, /**< CPU mie CSR (16): FIRQ0E - Fast interrupt channel 0 enable bit (r/w) */
|
153 |
|
|
CPU_MIE_FIRQ1E = 17, /**< CPU mie CSR (17): FIRQ1E - Fast interrupt channel 1 enable bit (r/w) */
|
154 |
|
|
CPU_MIE_FIRQ2E = 18, /**< CPU mie CSR (18): FIRQ2E - Fast interrupt channel 2 enable bit (r/w) */
|
155 |
|
|
CPU_MIE_FIRQ3E = 19 /**< CPU mie CSR (19): FIRQ3E - Fast interrupt channel 3 enable bit (r/w) */
|
156 |
2 |
zero_gravi |
};
|
157 |
|
|
|
158 |
|
|
|
159 |
|
|
/**********************************************************************//**
|
160 |
12 |
zero_gravi |
* CPU <b>mip</b> CSR (r/-): Machine interrupt pending (RISC-V spec.)
|
161 |
2 |
zero_gravi |
**************************************************************************/
|
162 |
|
|
enum NEORV32_CPU_MIP_enum {
|
163 |
40 |
zero_gravi |
CPU_MIP_MSIP = 3, /**< CPU mip CSR (3): MSIP - Machine software interrupt pending (r/-) */
|
164 |
|
|
CPU_MIP_MTIP = 7, /**< CPU mip CSR (7): MTIP - Machine timer interrupt pending (r/-) */
|
165 |
|
|
CPU_MIP_MEIP = 11, /**< CPU mip CSR (11): MEIP - Machine external interrupt pending (r/-) */
|
166 |
14 |
zero_gravi |
|
167 |
40 |
zero_gravi |
CPU_MIP_FIRQ0P = 16, /**< CPU mip CSR (16): FIRQ0P - Fast interrupt channel 0 pending (r/-) */
|
168 |
|
|
CPU_MIP_FIRQ1P = 17, /**< CPU mip CSR (17): FIRQ1P - Fast interrupt channel 1 pending (r/-) */
|
169 |
|
|
CPU_MIP_FIRQ2P = 18, /**< CPU mip CSR (18): FIRQ2P - Fast interrupt channel 2 pending (r/-) */
|
170 |
|
|
CPU_MIP_FIRQ3P = 19 /**< CPU mip CSR (19): FIRQ3P - Fast interrupt channel 3 pending (r/-) */
|
171 |
2 |
zero_gravi |
};
|
172 |
|
|
|
173 |
|
|
|
174 |
|
|
/**********************************************************************//**
|
175 |
16 |
zero_gravi |
* CPU <b>misa</b> CSR (r/-): Machine instruction set extensions (RISC-V spec.)
|
176 |
6 |
zero_gravi |
**************************************************************************/
|
177 |
|
|
enum NEORV32_CPU_MISA_enum {
|
178 |
39 |
zero_gravi |
CPU_MISA_A_EXT = 0, /**< CPU misa CSR (0): A: Atomic instructions CPU extension available (r/-)*/
|
179 |
|
|
CPU_MISA_B_EXT = 1, /**< CPU misa CSR (1): B: Bit manipulation CPU extension available (r/-)*/
|
180 |
15 |
zero_gravi |
CPU_MISA_C_EXT = 2, /**< CPU misa CSR (2): C: Compressed instructions CPU extension available (r/-)*/
|
181 |
39 |
zero_gravi |
CPU_MISA_E_EXT = 4, /**< CPU misa CSR (4): E: Embedded CPU extension available (r/-) */
|
182 |
|
|
CPU_MISA_F_EXT = 4, /**< CPU misa CSR (5): F: Floating point (single-precision) extension available (r/-) */
|
183 |
6 |
zero_gravi |
CPU_MISA_I_EXT = 8, /**< CPU misa CSR (8): I: Base integer ISA CPU extension available (r/-) */
|
184 |
15 |
zero_gravi |
CPU_MISA_M_EXT = 12, /**< CPU misa CSR (12): M: Multiplier/divider CPU extension available (r/-)*/
|
185 |
|
|
CPU_MISA_U_EXT = 20, /**< CPU misa CSR (20): U: User mode CPU extension available (r/-)*/
|
186 |
6 |
zero_gravi |
CPU_MISA_X_EXT = 23, /**< CPU misa CSR (23): X: Non-standard CPU extension available (r/-) */
|
187 |
|
|
CPU_MISA_MXL_LO_EXT = 30, /**< CPU misa CSR (30): MXL.lo: CPU data width (r/-) */
|
188 |
|
|
CPU_MISA_MXL_HI_EXT = 31 /**< CPU misa CSR (31): MXL.Hi: CPU data width (r/-) */
|
189 |
|
|
};
|
190 |
|
|
|
191 |
|
|
|
192 |
|
|
/**********************************************************************//**
|
193 |
33 |
zero_gravi |
* CPU <b>mzext</b> custom CSR (r/-): Implemented Z* CPU extensions
|
194 |
|
|
**************************************************************************/
|
195 |
|
|
enum NEORV32_CPU_MZEXT_enum {
|
196 |
|
|
CPU_MZEXT_ZICSR = 0, /**< CPU mzext CSR (0): Zicsr extension available when set (r/-) */
|
197 |
|
|
CPU_MZEXT_ZIFENCEI = 1, /**< CPU mzext CSR (1): Zifencei extension available when set (r/-) */
|
198 |
41 |
zero_gravi |
CPU_MZEXT_PMP = 2 /**< CPU mzext CSR (2): PMP extension available when set (r/-) */
|
199 |
33 |
zero_gravi |
};
|
200 |
|
|
|
201 |
|
|
|
202 |
|
|
/**********************************************************************//**
|
203 |
14 |
zero_gravi |
* Trap codes from mcause CSR.
|
204 |
2 |
zero_gravi |
**************************************************************************/
|
205 |
12 |
zero_gravi |
enum NEORV32_EXCEPTION_CODES_enum {
|
206 |
31 |
zero_gravi |
TRAP_CODE_I_MISALIGNED = 0x00000000, /**< 0.0: Instruction address misaligned */
|
207 |
|
|
TRAP_CODE_I_ACCESS = 0x00000001, /**< 0.1: Instruction (bus) access fault */
|
208 |
|
|
TRAP_CODE_I_ILLEGAL = 0x00000002, /**< 0.2: Illegal instruction */
|
209 |
|
|
TRAP_CODE_BREAKPOINT = 0x00000003, /**< 0.3: Breakpoint (EBREAK instruction) */
|
210 |
|
|
TRAP_CODE_L_MISALIGNED = 0x00000004, /**< 0.4: Load address misaligned */
|
211 |
|
|
TRAP_CODE_L_ACCESS = 0x00000005, /**< 0.5: Load (bus) access fault */
|
212 |
|
|
TRAP_CODE_S_MISALIGNED = 0x00000006, /**< 0.6: Store address misaligned */
|
213 |
|
|
TRAP_CODE_S_ACCESS = 0x00000007, /**< 0.7: Store (bus) access fault */
|
214 |
40 |
zero_gravi |
TRAP_CODE_UENV_CALL = 0x00000008, /**< 0.8: Environment call from user mode (ECALL instruction) */
|
215 |
14 |
zero_gravi |
TRAP_CODE_MENV_CALL = 0x0000000b, /**< 0.11: Environment call from machine mode (ECALL instruction) */
|
216 |
40 |
zero_gravi |
TRAP_CODE_RESET = 0x80000000, /**< 1.0: Hardware reset */
|
217 |
31 |
zero_gravi |
TRAP_CODE_MSI = 0x80000003, /**< 1.3: Machine software interrupt */
|
218 |
|
|
TRAP_CODE_MTI = 0x80000007, /**< 1.7: Machine timer interrupt */
|
219 |
14 |
zero_gravi |
TRAP_CODE_MEI = 0x8000000b, /**< 1.11: Machine external interrupt */
|
220 |
|
|
TRAP_CODE_FIRQ_0 = 0x80000010, /**< 1.16: Fast interrupt channel 0 */
|
221 |
|
|
TRAP_CODE_FIRQ_1 = 0x80000011, /**< 1.17: Fast interrupt channel 1 */
|
222 |
|
|
TRAP_CODE_FIRQ_2 = 0x80000012, /**< 1.18: Fast interrupt channel 2 */
|
223 |
|
|
TRAP_CODE_FIRQ_3 = 0x80000013 /**< 1.19: Fast interrupt channel 3 */
|
224 |
12 |
zero_gravi |
};
|
225 |
|
|
|
226 |
|
|
|
227 |
|
|
/**********************************************************************//**
|
228 |
2 |
zero_gravi |
* Processor clock prescalers
|
229 |
|
|
**************************************************************************/
|
230 |
|
|
enum NEORV32_CLOCK_PRSC_enum {
|
231 |
|
|
CLK_PRSC_2 = 0, /**< CPU_CLK / 2 */
|
232 |
|
|
CLK_PRSC_4 = 1, /**< CPU_CLK / 4 */
|
233 |
|
|
CLK_PRSC_8 = 2, /**< CPU_CLK / 8 */
|
234 |
|
|
CLK_PRSC_64 = 3, /**< CPU_CLK / 64 */
|
235 |
|
|
CLK_PRSC_128 = 4, /**< CPU_CLK / 128 */
|
236 |
|
|
CLK_PRSC_1024 = 5, /**< CPU_CLK / 1024 */
|
237 |
|
|
CLK_PRSC_2048 = 6, /**< CPU_CLK / 2048 */
|
238 |
|
|
CLK_PRSC_4096 = 7 /**< CPU_CLK / 4096 */
|
239 |
|
|
};
|
240 |
|
|
|
241 |
|
|
|
242 |
|
|
/**********************************************************************//**
|
243 |
34 |
zero_gravi |
* Official NEORV32 >RISC-V open-source architecture ID<
|
244 |
|
|
* https://github.com/riscv/riscv-isa-manual/blob/master/marchid.md
|
245 |
32 |
zero_gravi |
**************************************************************************/
|
246 |
|
|
#define NEORV32_ARCHID 19
|
247 |
|
|
|
248 |
|
|
|
249 |
|
|
/**********************************************************************//**
|
250 |
2 |
zero_gravi |
* @name Helper macros for easy memory-mapped register access
|
251 |
|
|
**************************************************************************/
|
252 |
|
|
/**@{*/
|
253 |
|
|
/** memory-mapped byte (8-bit) read/write register */
|
254 |
|
|
#define IO_REG8 (volatile uint8_t*)
|
255 |
|
|
/** memory-mapped half-word (16-bit) read/write register */
|
256 |
|
|
#define IO_REG16 (volatile uint16_t*)
|
257 |
|
|
/** memory-mapped word (32-bit) read/write register */
|
258 |
|
|
#define IO_REG32 (volatile uint32_t*)
|
259 |
|
|
/** memory-mapped double-word (64-bit) read/write register */
|
260 |
|
|
#define IO_REG64 (volatile uint64_t*)
|
261 |
|
|
/** memory-mapped byte (8-bit) read-only register */
|
262 |
|
|
#define IO_ROM8 (const volatile uint8_t*)
|
263 |
|
|
/** memory-mapped half-word (16-bit) read-only register */
|
264 |
|
|
#define IO_ROM16 (const volatile uint16_t*)
|
265 |
|
|
/** memory-mapped word (32-bit) read-only register */
|
266 |
|
|
#define IO_ROM32 (const volatile uint32_t*)
|
267 |
|
|
/** memory-mapped double-word (64-bit) read-only register */
|
268 |
|
|
#define IO_ROM64 (const volatile uint64_t*)
|
269 |
|
|
/**@}*/
|
270 |
|
|
|
271 |
|
|
|
272 |
|
|
/**********************************************************************//**
|
273 |
|
|
* @name Address space sections
|
274 |
|
|
**************************************************************************/
|
275 |
|
|
/**@{*/
|
276 |
|
|
/** instruction memory base address (r/w/x) */
|
277 |
23 |
zero_gravi |
// -> configured via ispace_base_c constant in neorv32_package.vhd and available to SW via SYSCONFIG entry
|
278 |
2 |
zero_gravi |
/** data memory base address (r/w/x) */
|
279 |
23 |
zero_gravi |
// -> configured via dspace_base_c constant in neorv32_package.vhd and available to SW via SYSCONFIG entry
|
280 |
2 |
zero_gravi |
/** bootloader memory base address (r/-/x) */
|
281 |
6 |
zero_gravi |
#define BOOTLOADER_BASE_ADDRESS (0xFFFF0000UL)
|
282 |
2 |
zero_gravi |
/** peripheral/IO devices memory base address (r/w/x) */
|
283 |
6 |
zero_gravi |
#define IO_BASE_ADDRESS (0xFFFFFF80UL)
|
284 |
2 |
zero_gravi |
/**@}*/
|
285 |
|
|
|
286 |
|
|
|
287 |
|
|
/**********************************************************************//**
|
288 |
|
|
* @name IO Device: General Purpose Input/Output Port Unit (GPIO)
|
289 |
|
|
**************************************************************************/
|
290 |
|
|
/**@{*/
|
291 |
23 |
zero_gravi |
/** read access: GPIO parallel input port 32-bit (r/-), write_access: pin-change IRQ for each input pin (-/w) */
|
292 |
|
|
#define GPIO_INPUT (*(IO_REG32 0xFFFFFF80UL))
|
293 |
22 |
zero_gravi |
/** GPIO parallel output port 32-bit (r/w) */
|
294 |
6 |
zero_gravi |
#define GPIO_OUTPUT (*(IO_REG32 0xFFFFFF84UL))
|
295 |
2 |
zero_gravi |
/**@}*/
|
296 |
|
|
|
297 |
|
|
|
298 |
|
|
/**********************************************************************//**
|
299 |
30 |
zero_gravi |
* @name IO Device: True Random Number Generator (TRNG)
|
300 |
18 |
zero_gravi |
**************************************************************************/
|
301 |
|
|
/**@{*/
|
302 |
30 |
zero_gravi |
/** TRNG control/data register (r/w) */
|
303 |
|
|
#define TRNG_CT (*(IO_REG32 0xFFFFFF88UL))
|
304 |
|
|
|
305 |
|
|
/** TRNG control/data register bits */
|
306 |
|
|
enum NEORV32_TRNG_CT_enum {
|
307 |
|
|
TRNG_CT_DATA_LSB = 0, /**< TRNG data/control register(0) (r/-): Random data (8-bit) LSB */
|
308 |
|
|
TRNG_CT_DATA_MSB = 7, /**< TRNG data/control register(7) (r/-): Random data (8-bit) MSB */
|
309 |
|
|
TRNG_CT_VALID = 15, /**< TRNG data/control register(15) (r/-): Random data output valid */
|
310 |
|
|
TRNG_CT_ERROR_0 = 16, /**< TRNG data/control register(16) (r/-): Stuck-at-zero error */
|
311 |
|
|
TRNG_CT_ERROR_1 = 17, /**< TRNG data/control register(17) (r/-): Stuck-at-one error */
|
312 |
|
|
TRNG_CT_EN = 31 /**< TRNG data/control register(31) (r/w): TRNG enable */
|
313 |
|
|
};
|
314 |
18 |
zero_gravi |
/**@}*/
|
315 |
|
|
|
316 |
|
|
|
317 |
|
|
/**********************************************************************//**
|
318 |
2 |
zero_gravi |
* @name IO Device: Watchdog Timer (WDT)
|
319 |
|
|
**************************************************************************/
|
320 |
|
|
/**@{*/
|
321 |
|
|
/** Watchdog control register (r/w) */
|
322 |
6 |
zero_gravi |
#define WDT_CT (*(IO_REG32 0xFFFFFF8CUL))
|
323 |
2 |
zero_gravi |
|
324 |
|
|
/** WTD control register bits */
|
325 |
|
|
enum NEORV32_WDT_CT_enum {
|
326 |
|
|
WDT_CT_CLK_SEL0 = 0, /**< WDT control register(0) (r/w): Clock prescaler select bit 0 */
|
327 |
|
|
WDT_CT_CLK_SEL1 = 1, /**< WDT control register(1) (r/w): Clock prescaler select bit 1 */
|
328 |
|
|
WDT_CT_CLK_SEL2 = 2, /**< WDT control register(2) (r/w): Clock prescaler select bit 2 */
|
329 |
|
|
WDT_CT_EN = 3, /**< WDT control register(3) (r/w): Watchdog enable */
|
330 |
|
|
WDT_CT_MODE = 4, /**< WDT control register(4) (r/w): Watchdog mode; when 0: timeout causes interrupt; when 1: timeout causes processor reset */
|
331 |
|
|
WDT_CT_CAUSE = 5, /**< WDT control register(5) (r/-): Last action (reset/IRQ) cause (0: external reset, 1: watchdog timeout) */
|
332 |
|
|
WDT_CT_PWFAIL = 6, /**< WDT control register(6) (r/-): Last Watchdog action (reset/IRQ) caused by wrong password when 1 */
|
333 |
|
|
|
334 |
|
|
WDT_CT_PASSWORD_LSB = 8, /**< WDT control register(8) (-/w): First bit / position begin for watchdog access password */
|
335 |
|
|
WDT_CT_PASSWORD_MSB = 15 /**< WDT control register(15) (-/w): Last bit / position end for watchdog access password */
|
336 |
|
|
};
|
337 |
|
|
|
338 |
|
|
/** Watchdog access passwort, must be set in WDT_CT bits 15:8 for every control register access */
|
339 |
|
|
#define WDT_PASSWORD 0x47
|
340 |
|
|
/**@}*/
|
341 |
|
|
|
342 |
|
|
|
343 |
|
|
/**********************************************************************//**
|
344 |
|
|
* @name IO Device: Machine System Timer (MTIME)
|
345 |
|
|
**************************************************************************/
|
346 |
|
|
/**@{*/
|
347 |
11 |
zero_gravi |
/** MTIME (time register) low word (r/w) */
|
348 |
|
|
#define MTIME_LO (*(IO_REG32 0xFFFFFF90UL))
|
349 |
|
|
/** MTIME (time register) high word (r/w) */
|
350 |
|
|
#define MTIME_HI (*(IO_REG32 0xFFFFFF94UL))
|
351 |
2 |
zero_gravi |
/** MTIMECMP (time compare register) low word (r/w) */
|
352 |
6 |
zero_gravi |
#define MTIMECMP_LO (*(IO_REG32 0xFFFFFF98UL))
|
353 |
2 |
zero_gravi |
/** MTIMECMP (time register) high word (r/w) */
|
354 |
6 |
zero_gravi |
#define MTIMECMP_HI (*(IO_REG32 0xFFFFFF9CUL))
|
355 |
2 |
zero_gravi |
|
356 |
11 |
zero_gravi |
/** MTIME (time register) 64-bit access (r/w) */
|
357 |
|
|
#define MTIME (*(IO_REG64 (&MTIME_LO)))
|
358 |
2 |
zero_gravi |
/** MTIMECMP (time compare register) low word (r/w) */
|
359 |
|
|
#define MTIMECMP (*(IO_REG64 (&MTIMECMP_LO)))
|
360 |
|
|
/**@}*/
|
361 |
|
|
|
362 |
|
|
|
363 |
|
|
/**********************************************************************//**
|
364 |
|
|
* @name IO Device: Universal Asynchronous Receiver and Transmitter (UART)
|
365 |
|
|
**************************************************************************/
|
366 |
|
|
/**@{*/
|
367 |
|
|
/** UART control register (r/w) */
|
368 |
6 |
zero_gravi |
#define UART_CT (*(IO_REG32 0xFFFFFFA0UL))
|
369 |
2 |
zero_gravi |
/** UART receive/transmit data register (r/w) */
|
370 |
6 |
zero_gravi |
#define UART_DATA (*(IO_REG32 0xFFFFFFA4UL))
|
371 |
2 |
zero_gravi |
|
372 |
|
|
/** UART control register bits */
|
373 |
|
|
enum NEORV32_UART_CT_enum {
|
374 |
30 |
zero_gravi |
UART_CT_BAUD00 = 0, /**< UART control register(0) (r/w): BAUD rate config value lsb (12-bi, bit 0) */
|
375 |
|
|
UART_CT_BAUD01 = 1, /**< UART control register(1) (r/w): BAUD rate config value (12-bi, bit 1) */
|
376 |
|
|
UART_CT_BAUD02 = 2, /**< UART control register(2) (r/w): BAUD rate config value (12-bi, bit 2) */
|
377 |
|
|
UART_CT_BAUD03 = 3, /**< UART control register(3) (r/w): BAUD rate config value (12-bi, bit 3) */
|
378 |
|
|
UART_CT_BAUD04 = 4, /**< UART control register(4) (r/w): BAUD rate config value (12-bi, bit 4) */
|
379 |
|
|
UART_CT_BAUD05 = 5, /**< UART control register(5) (r/w): BAUD rate config value (12-bi, bit 4) */
|
380 |
|
|
UART_CT_BAUD06 = 6, /**< UART control register(6) (r/w): BAUD rate config value (12-bi, bit 5) */
|
381 |
|
|
UART_CT_BAUD07 = 7, /**< UART control register(7) (r/w): BAUD rate config value (12-bi, bit 6) */
|
382 |
|
|
UART_CT_BAUD08 = 8, /**< UART control register(8) (r/w): BAUD rate config value (12-bi, bit 7) */
|
383 |
|
|
UART_CT_BAUD09 = 9, /**< UART control register(9) (r/w): BAUD rate config value (12-bi, bit 8) */
|
384 |
|
|
UART_CT_BAUD10 = 10, /**< UART control register(10) (r/w): BAUD rate config value (12-bi, bit 9) */
|
385 |
|
|
UART_CT_BAUD11 = 11, /**< UART control register(11) (r/w): BAUD rate config value msb (12-bi, bit 0) */
|
386 |
2 |
zero_gravi |
|
387 |
30 |
zero_gravi |
UART_CT_SIM_MODE = 12, /**< UART control register(12) (r/w): Simulation output override enable, for use in simulation only */
|
388 |
|
|
|
389 |
|
|
UART_CT_PRSC0 = 24, /**< UART control register(24) (r/w): BAUD rate clock prescaler select bit 0 */
|
390 |
|
|
UART_CT_PRSC1 = 25, /**< UART control register(25) (r/w): BAUD rate clock prescaler select bit 1 */
|
391 |
|
|
UART_CT_PRSC2 = 26, /**< UART control register(26) (r/w): BAUD rate clock prescaler select bit 2 */
|
392 |
|
|
UART_CT_RXOR = 27, /**< UART control register(27) (r/-): RX data overrun when set */
|
393 |
|
|
UART_CT_EN = 28, /**< UART control register(28) (r/w): UART global enable */
|
394 |
|
|
UART_CT_RX_IRQ = 29, /**< UART control register(29) (r/w): Activate interrupt on RX done */
|
395 |
|
|
UART_CT_TX_IRQ = 30, /**< UART control register(30) (r/w): Activate interrupt on TX done */
|
396 |
|
|
UART_CT_TX_BUSY = 31 /**< UART control register(31) (r/-): Transmitter is busy when set */
|
397 |
2 |
zero_gravi |
};
|
398 |
|
|
|
399 |
|
|
/** UART receive/transmit data register bits */
|
400 |
|
|
enum NEORV32_UART_DATA_enum {
|
401 |
|
|
UART_DATA_LSB = 0, /**< UART receive/transmit data register(0) (r/w): Receive/transmit data LSB (bit 0) */
|
402 |
|
|
UART_DATA_MSB = 7, /**< UART receive/transmit data register(7) (r/w): Receive/transmit data MSB (bit 7) */
|
403 |
|
|
UART_DATA_AVAIL = 31 /**< UART receive/transmit data register(31) (r/-): RX data available when set */
|
404 |
|
|
};
|
405 |
|
|
/**@}*/
|
406 |
|
|
|
407 |
|
|
|
408 |
|
|
/**********************************************************************//**
|
409 |
10 |
zero_gravi |
* @name IO Device: Serial Peripheral Interface Controller (SPI)
|
410 |
2 |
zero_gravi |
**************************************************************************/
|
411 |
|
|
/**@{*/
|
412 |
|
|
/** SPI control register (r/w) */
|
413 |
6 |
zero_gravi |
#define SPI_CT (*(IO_REG32 0xFFFFFFA8UL))
|
414 |
2 |
zero_gravi |
/** SPI receive/transmit data register (r/w) */
|
415 |
6 |
zero_gravi |
#define SPI_DATA (*(IO_REG32 0xFFFFFFACUL))
|
416 |
2 |
zero_gravi |
|
417 |
|
|
/** SPI control register bits */
|
418 |
|
|
enum NEORV32_SPI_CT_enum {
|
419 |
|
|
SPI_CT_CS0 = 0, /**< UART control register(0) (r/w): Direct chip select line 0 (output is low when set) */
|
420 |
|
|
SPI_CT_CS1 = 1, /**< UART control register(1) (r/w): Direct chip select line 1 (output is low when set) */
|
421 |
|
|
SPI_CT_CS2 = 2, /**< UART control register(2) (r/w): Direct chip select line 2 (output is low when set) */
|
422 |
|
|
SPI_CT_CS3 = 3, /**< UART control register(3) (r/w): Direct chip select line 3 (output is low when set) */
|
423 |
|
|
SPI_CT_CS4 = 4, /**< UART control register(4) (r/w): Direct chip select line 4 (output is low when set) */
|
424 |
|
|
SPI_CT_CS5 = 5, /**< UART control register(5) (r/w): Direct chip select line 5 (output is low when set) */
|
425 |
|
|
SPI_CT_CS6 = 6, /**< UART control register(6) (r/w): Direct chip select line 6 (output is low when set) */
|
426 |
|
|
SPI_CT_CS7 = 7, /**< UART control register(7) (r/w): Direct chip select line 7 (output is low when set) */
|
427 |
|
|
|
428 |
|
|
SPI_CT_EN = 8, /**< UART control register(8) (r/w): SPI unit enable */
|
429 |
|
|
SPI_CT_CPHA = 9, /**< UART control register(9) (r/w): Clock polarity (idle polarity) */
|
430 |
|
|
SPI_CT_PRSC0 = 10, /**< UART control register(10) (r/w): Clock prescaler select bit 0 */
|
431 |
|
|
SPI_CT_PRSC1 = 11, /**< UART control register(11) (r/w): Clock prescaler select bit 1 */
|
432 |
|
|
SPI_CT_PRSC2 = 12, /**< UART control register(12) (r/w): Clock prescaler select bit 2 */
|
433 |
36 |
zero_gravi |
SPI_CT_SIZE0 = 13, /**< UART control register(13) (r/w): Transfer data size lsb (00: 8-bit, 01: 16-bit, 10: 24-bit, 11: 32-bit) */
|
434 |
|
|
SPI_CT_SIZE1 = 14, /**< UART control register(14) (r/w): Transfer data size msb (00: 8-bit, 01: 16-bit, 10: 24-bit, 11: 32-bit) */
|
435 |
|
|
SPI_CT_IRQ_EN = 15, /**< UART control register(15) (r/w): Transfer done interrupt enable */
|
436 |
2 |
zero_gravi |
|
437 |
|
|
SPI_CT_BUSY = 31 /**< UART control register(31) (r/-): SPI busy flag */
|
438 |
|
|
};
|
439 |
|
|
/**@}*/
|
440 |
|
|
|
441 |
|
|
|
442 |
|
|
/**********************************************************************//**
|
443 |
10 |
zero_gravi |
* @name IO Device: Two-Wire Interface Controller (TWI)
|
444 |
2 |
zero_gravi |
**************************************************************************/
|
445 |
|
|
/**@{*/
|
446 |
|
|
/** TWI control register (r/w) */
|
447 |
6 |
zero_gravi |
#define TWI_CT (*(IO_REG32 0xFFFFFFB0UL))
|
448 |
2 |
zero_gravi |
/** TWI receive/transmit data register (r/w) */
|
449 |
6 |
zero_gravi |
#define TWI_DATA (*(IO_REG32 0xFFFFFFB4UL))
|
450 |
2 |
zero_gravi |
|
451 |
|
|
/** TWI control register bits */
|
452 |
|
|
enum NEORV32_TWI_CT_enum {
|
453 |
|
|
TWI_CT_EN = 0, /**< TWI control register(0) (r/w): TWI enable */
|
454 |
|
|
TWI_CT_START = 1, /**< TWI control register(1) (-/w): Generate START condition, auto-clears */
|
455 |
|
|
TWI_CT_STOP = 2, /**< TWI control register(2) (-/w): Generate STOP condition, auto-clears */
|
456 |
|
|
TWI_CT_IRQ_EN = 3, /**< TWI control register(3) (r/w): Enable transmission done interrupt */
|
457 |
|
|
TWI_CT_PRSC0 = 4, /**< TWI control register(4) (r/w): Clock prescaler select bit 0 */
|
458 |
|
|
TWI_CT_PRSC1 = 5, /**< TWI control register(5) (r/w): Clock prescaler select bit 1 */
|
459 |
|
|
TWI_CT_PRSC2 = 6, /**< TWI control register(6) (r/w): Clock prescaler select bit 2 */
|
460 |
10 |
zero_gravi |
TWI_CT_MACK = 7, /**< TWI control register(7) (r/w): Generate controller ACK for each transmission */
|
461 |
35 |
zero_gravi |
TWI_CT_CKSTEN = 8, /**< TWI control register(8) (r/w): Enable clock stretching (by peripheral) */
|
462 |
2 |
zero_gravi |
|
463 |
|
|
TWI_CT_ACK = 30, /**< TWI control register(30) (r/-): ACK received when set */
|
464 |
|
|
TWI_CT_BUSY = 31 /**< TWI control register(31) (r/-): Transfer in progress, busy flag */
|
465 |
|
|
};
|
466 |
|
|
|
467 |
|
|
/** WTD receive/transmit data register bits */
|
468 |
|
|
enum NEORV32_TWI_DATA_enum {
|
469 |
|
|
TWI_DATA_LSB = 0, /**< TWI data register(0) (r/w): Receive/transmit data (8-bit) LSB */
|
470 |
|
|
TWI_DATA_MSB = 7 /**< TWI data register(7) (r/w): Receive/transmit data (8-bit) MSB */
|
471 |
|
|
};
|
472 |
|
|
/**@}*/
|
473 |
|
|
|
474 |
|
|
|
475 |
|
|
/**********************************************************************//**
|
476 |
|
|
* @name IO Device: Pulse Width Modulation Controller (PWM)
|
477 |
|
|
**************************************************************************/
|
478 |
|
|
/**@{*/
|
479 |
|
|
/** PWM control register (r/w) */
|
480 |
6 |
zero_gravi |
#define PWM_CT (*(IO_REG32 0xFFFFFFB8UL)) // r/w: control register
|
481 |
2 |
zero_gravi |
/** PWM duty cycle register (4-channels) (r/w) */
|
482 |
6 |
zero_gravi |
#define PWM_DUTY (*(IO_REG32 0xFFFFFFBCUL)) // r/w: duty cycle channel 1 and 0
|
483 |
2 |
zero_gravi |
|
484 |
|
|
/** PWM control register bits */
|
485 |
|
|
enum NEORV32_PWM_CT_enum {
|
486 |
|
|
PWM_CT_EN = 0, /**< PWM control register(0) (r/w): PWM controller enable */
|
487 |
|
|
PWM_CT_PRSC0 = 1, /**< PWM control register(1) (r/w): Clock prescaler select bit 0 */
|
488 |
|
|
PWM_CT_PRSC1 = 2, /**< PWM control register(2) (r/w): Clock prescaler select bit 1 */
|
489 |
|
|
PWM_CT_PRSC2 = 3 /**< PWM control register(3) (r/w): Clock prescaler select bit 2 */
|
490 |
|
|
};
|
491 |
|
|
|
492 |
|
|
/**PWM duty cycle register bits */
|
493 |
|
|
enum NEORV32_PWM_DUTY_enum {
|
494 |
|
|
PWM_DUTY_CH0_LSB = 0, /**< PWM duty cycle register(0) (r/w): Channel 0 duty cycle (8-bit) LSB */
|
495 |
|
|
PWM_DUTY_CH0_MSB = 7, /**< PWM duty cycle register(7) (r/w): Channel 0 duty cycle (8-bit) MSB */
|
496 |
|
|
PWM_DUTY_CH1_LSB = 8, /**< PWM duty cycle register(8) (r/w): Channel 1 duty cycle (8-bit) LSB */
|
497 |
|
|
PWM_DUTY_CH1_MSB = 15, /**< PWM duty cycle register(15) (r/w): Channel 1 duty cycle (8-bit) MSB */
|
498 |
|
|
PWM_DUTY_CH2_LSB = 16, /**< PWM duty cycle register(16) (r/w): Channel 2 duty cycle (8-bit) LSB */
|
499 |
|
|
PWM_DUTY_CH2_MSB = 23, /**< PWM duty cycle register(23) (r/w): Channel 2 duty cycle (8-bit) MSB */
|
500 |
|
|
PWM_DUTY_CH3_LSB = 24, /**< PWM duty cycle register(24) (r/w): Channel 3 duty cycle (8-bit) LSB */
|
501 |
|
|
PWM_DUTY_CH3_MSB = 31 /**< PWM duty cycle register(31) (r/w): Channel 3 duty cycle (8-bit) MSB */
|
502 |
|
|
};
|
503 |
|
|
/**@}*/
|
504 |
|
|
|
505 |
|
|
|
506 |
|
|
/**********************************************************************//**
|
507 |
34 |
zero_gravi |
* @name IO Device: Custom Functions Unit 0 (CFU0)
|
508 |
23 |
zero_gravi |
**************************************************************************/
|
509 |
|
|
/**@{*/
|
510 |
34 |
zero_gravi |
/** CFU0 register 0 ((r)/(w)) */
|
511 |
|
|
#define CFU0_REG_0 (*(IO_REG32 0xFFFFFFC0UL)) // (r)/(w): CFU0 register 0, user-defined
|
512 |
|
|
/** CFU0 register 1 ((r)/(w)) */
|
513 |
|
|
#define CFU0_REG_1 (*(IO_REG32 0xFFFFFFC4UL)) // (r)/(w): CFU0 register 1, user-defined
|
514 |
|
|
/** CFU0 register 2 ((r)/(w)) */
|
515 |
|
|
#define CFU0_REG_2 (*(IO_REG32 0xFFFFFFC8UL)) // (r)/(w): CFU0 register 2, user-defined
|
516 |
|
|
/** CFU0 register 3 ((r)/(w)) */
|
517 |
|
|
#define CFU0_REG_3 (*(IO_REG32 0xFFFFFFCCUL)) // (r)/(w): CFU0 register 3, user-defined
|
518 |
2 |
zero_gravi |
/**@}*/
|
519 |
|
|
|
520 |
|
|
|
521 |
3 |
zero_gravi |
/**********************************************************************//**
|
522 |
34 |
zero_gravi |
* @name IO Device: Custom Functions Unit 1 (CFU1)
|
523 |
|
|
**************************************************************************/
|
524 |
|
|
/**@{*/
|
525 |
|
|
/** CFU1 register 0 ((r)/(w)) */
|
526 |
|
|
#define CFU1_REG_0 (*(IO_REG32 0xFFFFFFD0UL)) // (r)/(w): CFU1 register 0, user-defined
|
527 |
|
|
/** CFU1 register 1 ((r)/(w)) */
|
528 |
|
|
#define CFU1_REG_1 (*(IO_REG32 0xFFFFFFD4UL)) // (r)/(w): CFU1 register 1, user-defined
|
529 |
|
|
/** CFU1 register 2 ((r)/(w)) */
|
530 |
|
|
#define CFU1_REG_2 (*(IO_REG32 0xFFFFFFD8UL)) // (r)/(w): CFU1 register 2, user-defined
|
531 |
|
|
/** CFU1 register 3 ((r)/(w)) */
|
532 |
|
|
#define CFU1_REG_3 (*(IO_REG32 0xFFFFFFDCUL)) // (r)/(w): CFU1 register 3, user-defined
|
533 |
|
|
/**@}*/
|
534 |
|
|
|
535 |
|
|
|
536 |
|
|
/**********************************************************************//**
|
537 |
12 |
zero_gravi |
* @name IO Device: System Configuration Info Memory (SYSINFO)
|
538 |
|
|
**************************************************************************/
|
539 |
|
|
/**@{*/
|
540 |
|
|
/** SYSINFO(0): Clock speed */
|
541 |
|
|
#define SYSINFO_CLK (*(IO_ROM32 0xFFFFFFE0UL))
|
542 |
|
|
/** SYSINFO(1): Custom user code (via "USER_CODE" generic) */
|
543 |
|
|
#define SYSINFO_USER_CODE (*(IO_ROM32 0xFFFFFFE4UL))
|
544 |
|
|
/** SYSINFO(2): Clock speed */
|
545 |
|
|
#define SYSINFO_FEATURES (*(IO_ROM32 0xFFFFFFE8UL))
|
546 |
41 |
zero_gravi |
/** SYSINFO(3): Cache configuration */
|
547 |
|
|
#define SYSINFO_CACHE (*(IO_ROM32 0xFFFFFFECUL))
|
548 |
12 |
zero_gravi |
/** SYSINFO(4): Instruction memory address space base */
|
549 |
|
|
#define SYSINFO_ISPACE_BASE (*(IO_ROM32 0xFFFFFFF0UL))
|
550 |
|
|
/** SYSINFO(5): Data memory address space base */
|
551 |
|
|
#define SYSINFO_DSPACE_BASE (*(IO_ROM32 0xFFFFFFF4UL))
|
552 |
23 |
zero_gravi |
/** SYSINFO(6): Internal instruction memory (IMEM) size in bytes */
|
553 |
|
|
#define SYSINFO_IMEM_SIZE (*(IO_ROM32 0xFFFFFFF8UL))
|
554 |
|
|
/** SYSINFO(7): Internal data memory (DMEM) size in bytes */
|
555 |
|
|
#define SYSINFO_DMEM_SIZE (*(IO_ROM32 0xFFFFFFFCUL))
|
556 |
12 |
zero_gravi |
/**@}*/
|
557 |
|
|
|
558 |
|
|
/**********************************************************************//**
|
559 |
|
|
* SYSINFO_FEATURES (r/-): Implemented processor devices/features
|
560 |
|
|
**************************************************************************/
|
561 |
|
|
enum NEORV32_SYSINFO_FEATURES_enum {
|
562 |
|
|
SYSINFO_FEATURES_BOOTLOADER = 0, /**< SYSINFO_FEATURES (0) (r/-): Bootloader implemented when 1 (via BOOTLOADER_USE generic) */
|
563 |
|
|
SYSINFO_FEATURES_MEM_EXT = 1, /**< SYSINFO_FEATURES (1) (r/-): External bus interface implemented when 1 (via MEM_EXT_USE generic) */
|
564 |
|
|
SYSINFO_FEATURES_MEM_INT_IMEM = 2, /**< SYSINFO_FEATURES (2) (r/-): Processor-internal instruction memory implemented when 1 (via MEM_INT_IMEM_USE generic) */
|
565 |
|
|
SYSINFO_FEATURES_MEM_INT_IMEM_ROM = 3, /**< SYSINFO_FEATURES (3) (r/-): Processor-internal instruction memory implemented as ROM when 1 (via MEM_INT_IMEM_ROM generic) */
|
566 |
|
|
SYSINFO_FEATURES_MEM_INT_DMEM = 4, /**< SYSINFO_FEATURES (4) (r/-): Processor-internal data memory implemented when 1 (via MEM_INT_DMEM_USE generic) */
|
567 |
40 |
zero_gravi |
SYSINFO_FEATURES_MEM_EXT_ENDIAN = 5, /**< SYSINFO_FEATURES (5) (r/-): External bus interface uses BIG-endian byte-order when 1 (via package.xbus_big_endian_c constant) */
|
568 |
41 |
zero_gravi |
SYSINFO_FEATURES_ICACHE = 6, /**< SYSINFO_FEATURES (6) (r/-): Processor-internal instruction cache implemented when 1 (via ICACHE_USE generic) */
|
569 |
12 |
zero_gravi |
|
570 |
|
|
SYSINFO_FEATURES_IO_GPIO = 16, /**< SYSINFO_FEATURES (16) (r/-): General purpose input/output port unit implemented when 1 (via IO_GPIO_USE generic) */
|
571 |
|
|
SYSINFO_FEATURES_IO_MTIME = 17, /**< SYSINFO_FEATURES (17) (r/-): Machine system timer implemented when 1 (via IO_MTIME_USE generic) */
|
572 |
|
|
SYSINFO_FEATURES_IO_UART = 18, /**< SYSINFO_FEATURES (18) (r/-): Universal asynchronous receiver/transmitter implemented when 1 (via IO_UART_USE generic) */
|
573 |
|
|
SYSINFO_FEATURES_IO_SPI = 19, /**< SYSINFO_FEATURES (19) (r/-): Serial peripheral interface implemented when 1 (via IO_SPI_USE generic) */
|
574 |
|
|
SYSINFO_FEATURES_IO_TWI = 20, /**< SYSINFO_FEATURES (20) (r/-): Two-wire interface implemented when 1 (via IO_TWI_USE generic) */
|
575 |
|
|
SYSINFO_FEATURES_IO_PWM = 21, /**< SYSINFO_FEATURES (21) (r/-): Pulse-width modulation unit implemented when 1 (via IO_PWM_USE generic) */
|
576 |
|
|
SYSINFO_FEATURES_IO_WDT = 22, /**< SYSINFO_FEATURES (22) (r/-): Watchdog timer implemented when 1 (via IO_WDT_USE generic) */
|
577 |
34 |
zero_gravi |
SYSINFO_FEATURES_IO_CFU0 = 23, /**< SYSINFO_FEATURES (23) (r/-): Custom functions unit 0 implemented when 1 (via IO_CFU0_USE generic) */
|
578 |
|
|
SYSINFO_FEATURES_IO_TRNG = 24, /**< SYSINFO_FEATURES (24) (r/-): True random number generator implemented when 1 (via IO_TRNG_USE generic) */
|
579 |
|
|
SYSINFO_FEATURES_IO_CFU1 = 25 /**< SYSINFO_FEATURES (25) (r/-): Custom functions unit 1 implemented when 1 (via IO_CFU1_USE generic) */
|
580 |
12 |
zero_gravi |
};
|
581 |
|
|
|
582 |
41 |
zero_gravi |
/**********************************************************************//**
|
583 |
|
|
* SYSINFO_CACHE (r/-): Cache configuration
|
584 |
|
|
**************************************************************************/
|
585 |
|
|
enum NEORV32_SYSINFO_CACHE_enum {
|
586 |
|
|
SYSINFO_CACHE_IC_BLOCK_SIZE_0 = 0, /**< SYSINFO_CACHE (0) (r/-): i-cache: log2(Block size in bytes), bit 0 (via ICACHE_BLOCK_SIZE generic) */
|
587 |
|
|
SYSINFO_CACHE_IC_BLOCK_SIZE_1 = 1, /**< SYSINFO_CACHE (1) (r/-): i-cache: log2(Block size in bytes), bit 1 (via ICACHE_BLOCK_SIZE generic) */
|
588 |
|
|
SYSINFO_CACHE_IC_BLOCK_SIZE_2 = 2, /**< SYSINFO_CACHE (2) (r/-): i-cache: log2(Block size in bytes), bit 2 (via ICACHE_BLOCK_SIZE generic) */
|
589 |
|
|
SYSINFO_CACHE_IC_BLOCK_SIZE_3 = 3, /**< SYSINFO_CACHE (3) (r/-): i-cache: log2(Block size in bytes), bit 3 (via ICACHE_BLOCK_SIZE generic) */
|
590 |
12 |
zero_gravi |
|
591 |
41 |
zero_gravi |
SYSINFO_CACHE_IC_NUM_BLOCKS_0 = 4, /**< SYSINFO_CACHE (4) (r/-): i-cache: log2(Number of cache blocks/pages/lines), bit 0 (via ICACHE_NUM_BLOCKS generic) */
|
592 |
|
|
SYSINFO_CACHE_IC_NUM_BLOCKS_1 = 5, /**< SYSINFO_CACHE (5) (r/-): i-cache: log2(Number of cache blocks/pages/lines), bit 1 (via ICACHE_NUM_BLOCKS generic) */
|
593 |
|
|
SYSINFO_CACHE_IC_NUM_BLOCKS_2 = 6, /**< SYSINFO_CACHE (6) (r/-): i-cache: log2(Number of cache blocks/pages/lines), bit 2 (via ICACHE_NUM_BLOCKS generic) */
|
594 |
|
|
SYSINFO_CACHE_IC_NUM_BLOCKS_3 = 7, /**< SYSINFO_CACHE (7) (r/-): i-cache: log2(Number of cache blocks/pages/lines), bit 3 (via ICACHE_NUM_BLOCKS generic) */
|
595 |
|
|
|
596 |
|
|
SYSINFO_CACHE_IC_ASSOCIATIVITY_0 = 8, /**< SYSINFO_CACHE (10) (r/-): i-cache: log2(associativity), bit 0 (always 0 -> direct mapped) */
|
597 |
|
|
SYSINFO_CACHE_IC_ASSOCIATIVITY_1 = 9, /**< SYSINFO_CACHE (11) (r/-): i-cache: log2(associativity), bit 1 (always 0 -> direct mapped) */
|
598 |
|
|
SYSINFO_CACHE_IC_ASSOCIATIVITY_2 = 10, /**< SYSINFO_CACHE (12) (r/-): i-cache: log2(associativity), bit 2 (always 0 -> direct mapped) */
|
599 |
|
|
SYSINFO_CACHE_IC_ASSOCIATIVITY_3 = 11, /**< SYSINFO_CACHE (13) (r/-): i-cache: log2(associativity), bit 3 (always 0 -> direct mapped) */
|
600 |
|
|
};
|
601 |
|
|
|
602 |
|
|
|
603 |
2 |
zero_gravi |
// ----------------------------------------------------------------------------
|
604 |
|
|
// Include all IO driver headers
|
605 |
|
|
// ----------------------------------------------------------------------------
|
606 |
|
|
// cpu core
|
607 |
|
|
#include "neorv32_cpu.h"
|
608 |
|
|
|
609 |
|
|
// neorv32 runtime environment
|
610 |
|
|
#include "neorv32_rte.h"
|
611 |
|
|
|
612 |
|
|
// io/peripheral devices
|
613 |
26 |
zero_gravi |
#include "neorv32_cfu.h"
|
614 |
2 |
zero_gravi |
#include "neorv32_gpio.h"
|
615 |
|
|
#include "neorv32_mtime.h"
|
616 |
|
|
#include "neorv32_pwm.h"
|
617 |
|
|
#include "neorv32_spi.h"
|
618 |
|
|
#include "neorv32_trng.h"
|
619 |
|
|
#include "neorv32_twi.h"
|
620 |
|
|
#include "neorv32_uart.h"
|
621 |
|
|
#include "neorv32_wdt.h"
|
622 |
|
|
|
623 |
|
|
#endif // neorv32_h
|