OpenCores
URL https://opencores.org/ocsvn/neorv32/neorv32/trunk

Subversion Repositories neorv32

[/] [neorv32/] [trunk/] [sw/] [lib/] [include/] [neorv32.h] - Blame information for rev 3

Go to most recent revision | Details | Compare with Previous | View Log

Line No. Rev Author Line
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 
 * @date 30 May 2020
40 
 *
41 
 * @brief Main NEORV32 core library file.
42 
 *
43 
 * @details This file defines the addresses of the IO devices and their according
44 
 * registers and register bits as well as the available CPU CSRs and flags.
45 
 **************************************************************************/
46 
 
47 
#ifndef neorv32_h
48 
#define neorv32_h
49 
 
50 
// Standard libraries
51 
#include <stdint.h>
52 
#include <stdlib.h>
53 
#include <string.h>
54 
#include <stdbool.h>
55 
#include <inttypes.h>
56 
#include <limits.h>
57 
 
58 
 
59 
/**********************************************************************//**
60 
 * Available CPU Control and Status Registers (CSRs)
61 
 **************************************************************************/
62 
enum NEORV32_CPU_CSRS_enum {
63 
  CSR_MSTATUS     = 0x300, /**< 0x300 - mstatus  (r/w): Machine status register */
64 
  CSR_MISA        = 0x301, /**< 0x301 - misa     (r/-): CPU ISA and extensions */
65 
  CSR_MIE         = 0x304, /**< 0x304 - mie      (r/w): Machine interrupt-enable register */
66 
  CSR_MTVEC       = 0x305, /**< 0x305 - mtvec    (r/w): Machine trap-handler base address (for ALL traps) */
67 
 
68 
  CSR_MSCRATCH    = 0x340, /**< 0x340 - mscratch (r/w): Machine scratch register */
69 
  CSR_MEPC        = 0x341, /**< 0x341 - mepc     (r/w): Machine exception program counter */
70 
  CSR_MCAUSE      = 0x342, /**< 0x342 - mcause   (r/-): Machine trap cause */
71 
  CSR_MTVAL       = 0x343, /**< 0x343 - mtval    (r/-): Machine bad address or instruction */
72 
  CSR_MIP         = 0x344, /**< 0x344 - mip      (r/w): Machine interrupt pending register */
73 
  CSR_MTINST      = 0x34a, /**< 0x34a - mtinst   (r/-): Machine trap instruction (transformed) */
74 
 
75 
  CSR_MCYCLE      = 0xb00, /**< 0xb00 - mcycle    (r/-): Machine cycle counter low word */
76 
  CSR_MINSTRET    = 0xb02, /**< 0xb02 - minstret  (r/-): Machine instructions-retired counter low word */
77 
  CSR_MCYCLEH     = 0xb80, /**< 0xb80 - mcycleh   (r/-): Machine cycle counter high word */
78 
  CSR_MINSTRETH   = 0xb82, /**< 0xb82 - minstreth (r/-): Machine instructions-retired counter high word */
79 
 
80 
  CSR_CYCLE       = 0xc00, /**< 0xc00 - cycle    (r/-): Cycle counter low word */
81 
  CSR_TIME        = 0xc01, /**< 0xc01 - time     (r/-): Timer low word*/
82 
  CSR_INSTRET     = 0xc02, /**< 0xc02 - instret  (r/-): Instructions-retired counter low word */
83 
 
84 
  CSR_CYCLEH      = 0xc80, /**< 0xc80 - cycleh   (r/-): Cycle counter high word */
85 
  CSR_TIMEH       = 0xc81, /**< 0xc81 - timeh    (r/-): Timer high word*/
86 
  CSR_INSTRETH    = 0xc82, /**< 0xc82 - instreth (r/-): Instructions-retired counter high word */
87 
 
88 
  CSR_MIMPID      = 0xf13, /**< 0xf13 - mimpid  (r/-): Implementation ID/version */
89 
  CSR_MHARTID     = 0xf14, /**< 0xf14 - mhartid (r/-): Hardware thread ID (via HART_ID generic) */
90 
 
91 
  CSR_MFEATURES   = 0xfc0, /**< 0xfc0 - CUSTOM (r/-): Implemented processor devices/features (via IO_x_USE generics) */
92 
  CSR_MCLOCK      = 0xfc1, /**< 0xfc1 - CUSTOM (r/-): Processor primary clock spedd in Hz (via CLOCK_FREQUENCY generic)*/
93 
  CSR_MISPACEBASE = 0xfc4, /**< 0xfc4 - CUSTOM (r/-): Base address of instruction memory space (via MEM_ISPACE_BASE generic) */
94 
  CSR_MDSPACEBASE = 0xfc5, /**< 0xfc5 - CUSTOM (r/-): Base address of data memory space (via MEM_DSPACE_BASE generic) */
95 
  CSR_MISPACESIZE = 0xfc6, /**< 0xfc6 - CUSTOM (r/-): Total size of instruction memory space in byte (via MEM_ISPACE_SIZE generic) */
96 
  CSR_MDSPACESIZE = 0xfc7  /**< 0xfc7 - CUSTOM (r/-): Total size of data memory space in byte (via MEM_DSPACE_SIZE generic) */
97 
};
98 
 
99 
 
100 
/**********************************************************************//**
101 
 * CPU <b>mstatus</b> CSR (r/w): Machine status (RISC-V spec.)
102 
 **************************************************************************/
103 
enum NEORV32_CPU_MSTATUS_enum {
104 
  CPU_MSTATUS_MIE  = 3, /**< CPU mstatus CSR (3): Machine interrupt enable bit (r/w) */
105 
  CPU_MSTATUS_MPIE = 7  /**< CPU mstatus CSR (7): Machine previous interrupt enable bit (r/w) */
106 
};
107 
 
108 
 
109 
/**********************************************************************//**
110 
 * CPU <b>mie</b> CSR (r/w): Machine interrupt enable (RISC-V spec.)
111 
 **************************************************************************/
112 
enum NEORV32_CPU_MIE_enum {
113 
  CPU_MIE_MSIE  =  3, /**< CPU mie CSR (3): Machine software interrupt enable bit (r/w) */
114 
  CPU_MIE_MTIE  =  7, /**< CPU mie CSR (7): Machine timer interrupt (MTIME) enable bit (r/w) */
115 
  CPU_MIE_MEIE  = 11  /**< CPU mie CSR (11): Machine external interrupt (via CLIC) enable bit (r/w) */
116 
};
117 
 
118 
 
119 
/**********************************************************************//**
120 
 * CPU <b>mip</b> CSR (r/w): Machine interrupt pending (RISC-V spec.)
121 
 **************************************************************************/
122 
enum NEORV32_CPU_MIP_enum {
123 
  CPU_MIP_MSIP  =  3, /**< CPU mip CSR (3): Machine software interrupt pending (r/w), can be triggered when set */
124 
  CPU_MIP_MTIP  =  7, /**< CPU mip CSR (7): Machine timer interrupt (MTIME) pending (r/-) */
125 
  CPU_MIP_MEIP  = 11  /**< CPU mip CSR (11): Machine external interrupt (via CLIC) pending (r/-) */
126 
};
127 
 
128 
 
129 
/**********************************************************************//**
130 
 * CPU <b>mfeatures</b> CSR (r/-): Implemented processor devices/features (CUSTOM)
131 
 **************************************************************************/
132 
 enum NEORV32_CPU_MFEATURES_enum {
133 
  CPU_MFEATURES_BOOTLOADER       =  0, /**< CPU mfeatures CSR (0) (r/-): Bootloader implemented when 1 (via BOOTLOADER_USE generic) */
134 
  CPU_MFEATURES_MEM_EXT          =  1, /**< CPU mfeatures CSR (1) (r/-): External bus interface implemented when 1 (via MEM_EXT_USE generic) */
135 
  CPU_MFEATURES_MEM_INT_IMEM     =  2, /**< CPU mfeatures CSR (2) (r/-): Processor-internal instruction memory implemented when 1 (via MEM_INT_IMEM_USE generic) */
136 
  CPU_MFEATURES_MEM_INT_IMEM_ROM =  3, /**< CPU mfeatures CSR (3) (r/-): Processor-internal instruction memory implemented as ROM when 1 (via MEM_INT_IMEM_ROM generic) */
137 
  CPU_MFEATURES_MEM_INT_DMEM     =  4, /**< CPU mfeatures CSR (4) (r/-): Processor-internal data memory implemented when 1 (via MEM_INT_DMEM_USE generic) */
138 
 
139 
  CPU_MFEATURES_IO_GPIO          = 16, /**< CPU mfeatures CSR (16) (r/-): General purpose input/output port unit implemented when 1 (via IO_GPIO_USE generic) */
140 
  CPU_MFEATURES_IO_MTIME         = 17, /**< CPU mfeatures CSR (17) (r/-): Machine system timer implemented when 1 (via IO_MTIME_USE generic) */
141 
  CPU_MFEATURES_IO_UART          = 18, /**< CPU mfeatures CSR (18) (r/-): Universal asynchronous receiver/transmitter implemented when 1 (via IO_UART_USE generic) */
142 
  CPU_MFEATURES_IO_SPI           = 19, /**< CPU mfeatures CSR (19) (r/-): Serial peripheral interface implemented when 1 (via IO_SPI_USE generic) */
143 
  CPU_MFEATURES_IO_TWI           = 20, /**< CPU mfeatures CSR (20) (r/-): Two-wire interface implemented when 1 (via IO_TWI_USE generic) */
144 
  CPU_MFEATURES_IO_PWM           = 21, /**< CPU mfeatures CSR (21) (r/-): Pulse-width modulation unit implemented when 1 (via IO_PWM_USE generic) */
145 
  CPU_MFEATURES_IO_WDT           = 22, /**< CPU mfeatures CSR (22) (r/-): Watchdog timer implemented when 1 (via IO_WDT_USE generic) */
146 
  CPU_MFEATURES_IO_CLIC          = 23, /**< CPU mfeatures CSR (23) (r/-): Core-local interrupt controller implemented when 1 (via IO_CLIC_USE generic) */
147 3 zero_gravi 
  CPU_MFEATURES_IO_TRNG          = 24, /**< CPU mfeatures CSR (24) (r/-): True random number generator implemented when 1 (via IO_TRNG_USE generic) */
148 
  CPU_MFEATURES_IO_DEVNULL       = 25  /**< CPU mfeatures CSR (24) (r/-): Dummy device implemented when 1 (via IO_DEVNULL_USE generic) */
149 2 zero_gravi 
};
150 
 
151 
 
152 
/**********************************************************************//**
153 
 * Exception IDs.
154 
 **************************************************************************/
155 
enum NEORV32_EXCEPTION_IDS_enum {
156 
  EXCID_I_MISALIGNED =  0, /**< 0: Instruction address misaligned */
157 
  EXCID_I_ACCESS     =  1, /**< 1: Instruction (bus) access fault */
158 
  EXCID_I_ILLEGAL    =  2, /**< 2: Illegal instruction */
159 
  EXCID_BREAKPOINT   =  3, /**< 3: Breakpoint (EBREAK instruction) */
160 
  EXCID_L_MISALIGNED =  4, /**< 4: Load address misaligned */
161 
  EXCID_L_ACCESS     =  5, /**< 5: Load (bus) access fault */
162 
  EXCID_S_MISALIGNED =  6, /**< 6: Store address misaligned */
163 
  EXCID_S_ACCESS     =  7, /**< 7: Store (bus) access fault */
164 
  EXCID_MENV_CALL    = 11, /**< 11: Environment call from machine mode (ECALL instruction) */
165 
  EXCID_MSI          = 19, /**< 16 + 3: Machine software interrupt */
166 
  EXCID_MTI          = 23, /**< 16 + 7: Machine timer interrupt (via MTIME) */
167 
  EXCID_MEI          = 27  /**< 16 + 11: Machine external interrupt (via CLIC) */
168 
};
169 
 
170 
 
171 
/**********************************************************************//**
172 
 * Processor clock prescalers
173 
 **************************************************************************/
174 
enum NEORV32_CLOCK_PRSC_enum {
175 
  CLK_PRSC_2    =  0, /**< CPU_CLK / 2 */
176 
  CLK_PRSC_4    =  1, /**< CPU_CLK / 4 */
177 
  CLK_PRSC_8    =  2, /**< CPU_CLK / 8 */
178 
  CLK_PRSC_64   =  3, /**< CPU_CLK / 64 */
179 
  CLK_PRSC_128  =  4, /**< CPU_CLK / 128 */
180 
  CLK_PRSC_1024 =  5, /**< CPU_CLK / 1024 */
181 
  CLK_PRSC_2048 =  6, /**< CPU_CLK / 2048 */
182 
  CLK_PRSC_4096 =  7  /**< CPU_CLK / 4096 */
183 
};
184 
 
185 
 
186 
/**********************************************************************//**
187 
 * @name Helper macros for easy memory-mapped register access
188 
 **************************************************************************/
189 
/**@{*/
190 
/** memory-mapped byte (8-bit) read/write register */
191 
#define IO_REG8  (volatile uint8_t*)
192 
/** memory-mapped half-word (16-bit) read/write register */
193 
#define IO_REG16 (volatile uint16_t*)
194 
/** memory-mapped word (32-bit) read/write register */
195 
#define IO_REG32 (volatile uint32_t*)
196 
/** memory-mapped double-word (64-bit) read/write register */
197 
#define IO_REG64 (volatile uint64_t*)
198 
/** memory-mapped byte (8-bit) read-only register */
199 
#define IO_ROM8  (const volatile uint8_t*)
200 
/** memory-mapped half-word (16-bit) read-only register */
201 
#define IO_ROM16 (const volatile uint16_t*)
202 
/** memory-mapped word (32-bit) read-only register */
203 
#define IO_ROM32 (const volatile uint32_t*)
204 
/** memory-mapped double-word (64-bit) read-only register */
205 
#define IO_ROM64 (const volatile uint64_t*)
206 
/**@}*/
207 
 
208 
 
209 
/**********************************************************************//**
210 
 * @name Address space sections
211 
 **************************************************************************/
212 
/**@{*/
213 
/** instruction memory base address (r/w/x) */
214 
#define INSTR_MEM_BASE_ADDR 0x00000000
215 
/** data memory base address (r/w/x) */
216 
#define DATA_MEM_BASE_ADDR 0x80000000
217 
/** bootloader memory base address (r/-/x) */
218 
#define BOOTLOADER_BASE_ADDRESS 0xFFFF0000
219 
/** peripheral/IO devices memory base address (r/w/x) */
220 
#define IO_BASE_ADDRESS 0xFFFFFF80
221 
/**@}*/
222 
 
223 
 
224 
/**********************************************************************//**
225 
 * @name IO Device: General Purpose Input/Output Port Unit (GPIO)
226 
 **************************************************************************/
227 
/**@{*/
228 
/** GPIO parallel input port (r/-) */
229 
#define GPIO_INPUT  (*(IO_ROM32 0xFFFFFF80))
230 
/** GPIO parallel output port (r/w) */
231 
#define GPIO_OUTPUT (*(IO_REG32 0xFFFFFF84))
232 
/**@}*/
233 
 
234 
 
235 
/**********************************************************************//**
236 
 * @name IO Device: Core Local Interrupts Controller (CLIC)
237 
 **************************************************************************/
238 
/**@{*/
239 
/** CLIC control register (r/w) */
240 
#define CLIC_CT (*(IO_REG32 0xFFFFFF88))
241 
 
242 
/** CLIC control register bits */
243 
enum NEORV32_CLIC_CT_enum {
244 
  CLIC_CT_SRC0        =  0, /**< CLIC control register(0) (r/-): IRQ source bit 0 */
245 
  CLIC_CT_SRC1        =  1, /**< CLIC control register(1) (r/-): IRQ source bit 1 */
246 
  CLIC_CT_SRC2        =  2, /**< CLIC control register(2) (r/-): IRQ source bit 2 */
247 
  CLIC_CT_ACK         =  3, /**< CLIC control register(3) (-/w): Acknowledge current IRQ when set, auto-clears when set */
248 
  CLIC_CT_EN          =  4, /**< CLIC control register(4) (r/w): Unit enable */
249 
 
250 
  CLIC_CT_IRQ0_EN     =  8, /**< CLIC control register(8)  (r/w): Enable IRQ channel 0 */
251 
  CLIC_CT_IRQ1_EN     =  9, /**< CLIC control register(9)  (r/w): Enable IRQ channel 1 */
252 
  CLIC_CT_IRQ2_EN     = 10, /**< CLIC control register(10) (r/w): Enable IRQ channel 2 */
253 
  CLIC_CT_IRQ3_EN     = 11, /**< CLIC control register(11) (r/w): Enable IRQ channel 3 */
254 
  CLIC_CT_IRQ4_EN     = 12, /**< CLIC control register(12) (r/w): Enable IRQ channel 4 */
255 
  CLIC_CT_IRQ5_EN     = 13, /**< CLIC control register(13) (r/w): Enable IRQ channel 5 */
256 
  CLIC_CT_IRQ6_EN     = 14, /**< CLIC control register(14) (r/w): Enable IRQ channel 6 */
257 
  CLIC_CT_IRQ7_EN     = 15, /**< CLIC control register(15) (r/w): Enable IRQ channel 7 */
258 
 
259 
  CLIC_CT_SW_IRQ_SRC0 = 16, /**< CLIC control register(16) (-/w): SW IRQ trigger, IRQ select bit 0, auto-clears when set */
260 
  CLIC_CT_SW_IRQ_SRC1 = 17, /**< CLIC control register(17) (-/w): SW IRQ trigger, IRQ select bit 1, auto-clears when set */
261 
  CLIC_CT_SW_IRQ_SRC2 = 18, /**< CLIC control register(18) (-/w): SW IRQ trigger, IRQ select bit 2, auto-clears when set */
262 
  CLIC_CT_SW_IRQ_EN   = 19  /**< CLIC control register(19) (-/w): SW IRQ trigger enable, auto-clears when set */
263 
};
264 
/**@}*/
265 
 
266 
 
267 
/**********************************************************************//**
268 
 * Core-local interrupt controller IRQ channel
269 
 **************************************************************************/
270 
enum NEORV32_CLIC_CHANNELS_enum {
271 
  CLIC_CH_WDT   = 0, /**< CLIC channel 0: Watchdog timer overflow interrupt */
272 
  CLIC_CH_RES   = 1, /**< CLIC channel 1: reserved */
273 
  CLIC_CH_GPIO  = 2, /**< CLIC channel 2: GPIO pin-change interrupt */
274 
  CLIC_CH_UART  = 3, /**< CLIC channel 3: UART RX available or TX done interrupt */
275 
  CLIC_CH_SPI   = 4, /**< CLIC channel 4: SPI transmission done interrupt */
276 
  CLIC_CH_TWI   = 5, /**< CLIC channel 5: TWI transmission done interrupt */
277 
  CLIC_CH_EXT0  = 6, /**< CLIC channel 6: Processor-external interrupt request 0 */
278 
  CLIC_CH_EXT1  = 7  /**< CLIC channel 7: Processor-external interrupt request 1 */
279 
};
280 
 
281 
 
282 
/**********************************************************************//**
283 
 * @name IO Device: Watchdog Timer (WDT)
284 
 **************************************************************************/
285 
/**@{*/
286 
/** Watchdog control register (r/w) */
287 
#define WDT_CT (*(IO_REG32 0xFFFFFF8C))
288 
 
289 
/** WTD control register bits */
290 
enum NEORV32_WDT_CT_enum {
291 
  WDT_CT_CLK_SEL0     =  0, /**< WDT control register(0) (r/w): Clock prescaler select bit 0 */
292 
  WDT_CT_CLK_SEL1     =  1, /**< WDT control register(1) (r/w): Clock prescaler select bit 1 */
293 
  WDT_CT_CLK_SEL2     =  2, /**< WDT control register(2) (r/w): Clock prescaler select bit 2 */
294 
  WDT_CT_EN           =  3, /**< WDT control register(3) (r/w): Watchdog enable */
295 
  WDT_CT_MODE         =  4, /**< WDT control register(4) (r/w): Watchdog mode; when 0: timeout causes interrupt; when 1: timeout causes processor reset */
296 
  WDT_CT_CAUSE        =  5, /**< WDT control register(5) (r/-): Last action (reset/IRQ) cause (0: external reset, 1: watchdog timeout) */
297 
  WDT_CT_PWFAIL       =  6, /**< WDT control register(6) (r/-): Last Watchdog action (reset/IRQ) caused by wrong password when 1 */
298 
 
299 
  WDT_CT_PASSWORD_LSB =  8, /**< WDT control register(8)  (-/w): First bit / position begin for watchdog access password */
300 
  WDT_CT_PASSWORD_MSB = 15  /**< WDT control register(15) (-/w): Last bit / position end for watchdog access password */
301 
};
302 
 
303 
/** Watchdog access passwort, must be set in WDT_CT bits 15:8 for every control register access */
304 
#define WDT_PASSWORD 0x47
305 
/**@}*/
306 
 
307 
 
308 
/**********************************************************************//**
309 
 * @name IO Device: Machine System Timer (MTIME)
310 
 **************************************************************************/
311 
/**@{*/
312 
/** MTIME (time register) low word (r/w) */
313 
#define MTIME_LO     (*(IO_REG32 0xFFFFFF90))
314 
/** MTIME (time register) high word (r/w) */
315 
#define MTIME_HI     (*(IO_REG32 0xFFFFFF94))
316 
/** MTIMECMP (time compare register) low word (r/w) */
317 
#define MTIMECMP_LO  (*(IO_REG32 0xFFFFFF98))
318 
/** MTIMECMP (time register) high word (r/w) */
319 
#define MTIMECMP_HI  (*(IO_REG32 0xFFFFFF9C))
320 
 
321 
/** MTIME (time register) 64-bit access (r/w) */
322 
#define MTIME        (*(IO_REG64 (&MTIME_LO)))
323 
/** MTIMECMP (time compare register) low word (r/w) */
324 
#define MTIMECMP     (*(IO_REG64 (&MTIMECMP_LO)))
325 
/**@}*/
326 
 
327 
 
328 
/**********************************************************************//**
329 
 * @name IO Device: Universal Asynchronous Receiver and Transmitter (UART)
330 
 **************************************************************************/
331 
/**@{*/
332 
/** UART control register (r/w) */
333 
#define UART_CT  (*(IO_REG32 0xFFFFFFA0))
334 
/** UART receive/transmit data register (r/w) */
335 
#define UART_DATA (*(IO_REG32 0xFFFFFFA4))
336 
 
337 
/** UART control register bits */
338 
enum NEORV32_UART_CT_enum {
339 
  UART_CT_BAUD00  =  0, /**< UART control register(0)  (r/w): BAUD rate config value lsb (12-bi, bit 0) */
340 
  UART_CT_BAUD01  =  1, /**< UART control register(1)  (r/w): BAUD rate config value (12-bi, bit 1) */
341 
  UART_CT_BAUD02  =  2, /**< UART control register(2)  (r/w): BAUD rate config value (12-bi, bit 2) */
342 
  UART_CT_BAUD03  =  3, /**< UART control register(3)  (r/w): BAUD rate config value (12-bi, bit 3) */
343 
  UART_CT_BAUD04  =  4, /**< UART control register(4)  (r/w): BAUD rate config value (12-bi, bit 4) */
344 
  UART_CT_BAUD05  =  5, /**< UART control register(5)  (r/w): BAUD rate config value (12-bi, bit 4) */
345 
  UART_CT_BAUD06  =  6, /**< UART control register(6)  (r/w): BAUD rate config value (12-bi, bit 5) */
346 
  UART_CT_BAUD07  =  7, /**< UART control register(7)  (r/w): BAUD rate config value (12-bi, bit 6) */
347 
  UART_CT_BAUD08  =  8, /**< UART control register(8)  (r/w): BAUD rate config value (12-bi, bit 7) */
348 
  UART_CT_BAUD09  =  9, /**< UART control register(9)  (r/w): BAUD rate config value (12-bi, bit 8) */
349 
  UART_CT_BAUD10  = 10, /**< UART control register(10) (r/w): BAUD rate config value (12-bi, bit 9) */
350 
  UART_CT_BAUD11  = 11, /**< UART control register(11) (r/w): BAUD rate config value msb (12-bi, bit 0)*/
351 
 
352 
  UART_CT_PRSC0   = 24, /**< UART control register(24) (r/w): BAUD rate clock prescaler select bit 0 */
353 
  UART_CT_PRSC1   = 25, /**< UART control register(25) (r/w): BAUD rate clock prescaler select bit 1 */
354 
  UART_CT_PRSC2   = 26, /**< UART control register(26) (r/w): BAUD rate clock prescaler select bit 2 */
355 
  UART_CT_RXOR    = 27, /**< UART control register(27) (r/-): RX data overrun when set */
356 
  UART_CT_EN      = 28, /**< UART control register(28) (r/w): UART global enable */
357 
  UART_CT_RX_IRQ  = 29, /**< UART control register(29) (r/w): Activate interrupt on RX done */
358 
  UART_CT_TX_IRQ  = 30, /**< UART control register(30) (r/w): Activate interrupt on TX done */
359 
  UART_CT_TX_BUSY = 31  /**< UART control register(31) (r/-): Transmitter is busy when set */
360 
};
361 
 
362 
/** UART receive/transmit data register bits */
363 
enum NEORV32_UART_DATA_enum {
364 
  UART_DATA_LSB   =  0, /**< UART receive/transmit data register(0)  (r/w): Receive/transmit data LSB (bit 0) */
365 
  UART_DATA_MSB   =  7, /**< UART receive/transmit data register(7)  (r/w): Receive/transmit data MSB (bit 7) */
366 
  UART_DATA_AVAIL = 31  /**< UART receive/transmit data register(31) (r/-): RX data available when set */
367 
};
368 
/**@}*/
369 
 
370 
 
371 
/**********************************************************************//**
372 
 * @name IO Device: Serial Peripheral Interface Master (SPI)
373 
 **************************************************************************/
374 
/**@{*/
375 
/** SPI control register (r/w) */
376 
#define SPI_CT  (*(IO_REG32 0xFFFFFFA8))
377 
/** SPI receive/transmit data register (r/w) */
378 
#define SPI_DATA (*(IO_REG32 0xFFFFFFAC))
379 
 
380 
/** SPI control register bits */
381 
enum NEORV32_SPI_CT_enum {
382 
  SPI_CT_CS0    =  0, /**< UART control register(0) (r/w): Direct chip select line 0 (output is low when set) */
383 
  SPI_CT_CS1    =  1, /**< UART control register(1) (r/w): Direct chip select line 1 (output is low when set) */
384 
  SPI_CT_CS2    =  2, /**< UART control register(2) (r/w): Direct chip select line 2 (output is low when set) */
385 
  SPI_CT_CS3    =  3, /**< UART control register(3) (r/w): Direct chip select line 3 (output is low when set) */
386 
  SPI_CT_CS4    =  4, /**< UART control register(4) (r/w): Direct chip select line 4 (output is low when set) */
387 
  SPI_CT_CS5    =  5, /**< UART control register(5) (r/w): Direct chip select line 5 (output is low when set) */
388 
  SPI_CT_CS6    =  6, /**< UART control register(6) (r/w): Direct chip select line 6 (output is low when set) */
389 
  SPI_CT_CS7    =  7, /**< UART control register(7) (r/w): Direct chip select line 7 (output is low when set) */
390 
 
391 
  SPI_CT_EN     =  8, /**< UART control register(8) (r/w): SPI unit enable */
392 
  SPI_CT_CPHA   =  9, /**< UART control register(9) (r/w): Clock polarity (idle polarity) */
393 
  SPI_CT_PRSC0  = 10, /**< UART control register(10) (r/w): Clock prescaler select bit 0 */
394 
  SPI_CT_PRSC1  = 11, /**< UART control register(11) (r/w): Clock prescaler select bit 1 */
395 
  SPI_CT_PRSC2  = 12, /**< UART control register(12) (r/w): Clock prescaler select bit 2 */
396 
  SPI_CT_DIR    = 13, /**< UART control register(13) (r/w): Shift direction (0: MSB first, 1: LSB first) */
397 
  SPI_CT_SIZE0  = 14, /**< UART control register(14) (r/w): Transfer data size lsb (00: 8-bit, 01: 16-bit, 10: 24-bit, 11: 32-bit) */
398 
  SPI_CT_SIZE1  = 15, /**< UART control register(15) (r/w): Transfer data size lsb (00: 8-bit, 01: 16-bit, 10: 24-bit, 11: 32-bit) */
399 
 
400 
  SPI_CT_IRQ_EN = 16, /**< UART control register(16) (r/w): Transfer done interrupt enable */
401 
 
402 
  SPI_CT_BUSY   = 31  /**< UART control register(31) (r/-): SPI busy flag */
403 
};
404 
/**@}*/
405 
 
406 
 
407 
/**********************************************************************//**
408 
 * @name IO Device: Two-Wire Interface Master (TWI)
409 
 **************************************************************************/
410 
/**@{*/
411 
/** TWI control register (r/w) */
412 
#define TWI_CT   (*(IO_REG32 0xFFFFFFB0))
413 
/** TWI receive/transmit data register (r/w) */
414 
#define TWI_DATA (*(IO_REG32 0xFFFFFFB4))
415 
 
416 
/** TWI control register bits */
417 
enum NEORV32_TWI_CT_enum {
418 
  TWI_CT_EN     =  0, /**< TWI control register(0) (r/w): TWI enable */
419 
  TWI_CT_START  =  1, /**< TWI control register(1) (-/w): Generate START condition, auto-clears */
420 
  TWI_CT_STOP   =  2, /**< TWI control register(2) (-/w): Generate STOP condition, auto-clears */
421 
  TWI_CT_IRQ_EN =  3, /**< TWI control register(3) (r/w): Enable transmission done interrupt */
422 
  TWI_CT_PRSC0  =  4, /**< TWI control register(4) (r/w): Clock prescaler select bit 0 */
423 
  TWI_CT_PRSC1  =  5, /**< TWI control register(5) (r/w): Clock prescaler select bit 1 */
424 
  TWI_CT_PRSC2  =  6, /**< TWI control register(6) (r/w): Clock prescaler select bit 2 */
425 
  TWI_CT_MACK   =  7, /**< TWI control register(7) (r/w): Generate master ACK for each transmission */
426 
 
427 
  TWI_CT_ACK    = 30, /**< TWI control register(30) (r/-): ACK received when set */
428 
  TWI_CT_BUSY   = 31  /**< TWI control register(31) (r/-): Transfer in progress, busy flag */
429 
};
430 
 
431 
/** WTD receive/transmit data register bits */
432 
enum NEORV32_TWI_DATA_enum {
433 
  TWI_DATA_LSB = 0, /**< TWI data register(0) (r/w): Receive/transmit data (8-bit) LSB */
434 
  TWI_DATA_MSB = 7  /**< TWI data register(7) (r/w): Receive/transmit data (8-bit) MSB */
435 
};
436 
/**@}*/
437 
 
438 
 
439 
/**********************************************************************//**
440 
 * @name IO Device: Pulse Width Modulation Controller (PWM)
441 
 **************************************************************************/
442 
/**@{*/
443 
/** PWM control register (r/w) */
444 
#define PWM_CT   (*(IO_REG32 0xFFFFFFB8)) // r/w: control register
445 
/** PWM duty cycle register (4-channels) (r/w) */
446 
#define PWM_DUTY (*(IO_REG32 0xFFFFFFBC)) // r/w: duty cycle channel 1 and 0
447 
 
448 
/** PWM control register bits */
449 
enum NEORV32_PWM_CT_enum {
450 
  PWM_CT_EN    =  0, /**< PWM control register(0) (r/w): PWM controller enable */
451 
  PWM_CT_PRSC0 =  1, /**< PWM control register(1) (r/w): Clock prescaler select bit 0 */
452 
  PWM_CT_PRSC1 =  2, /**< PWM control register(2) (r/w): Clock prescaler select bit 1 */
453 
  PWM_CT_PRSC2 =  3  /**< PWM control register(3) (r/w): Clock prescaler select bit 2 */
454 
};
455 
 
456 
/**PWM duty cycle register bits */
457 
enum NEORV32_PWM_DUTY_enum {
458 
  PWM_DUTY_CH0_LSB =  0, /**< PWM duty cycle register(0)  (r/w): Channel 0 duty cycle (8-bit) LSB */
459 
  PWM_DUTY_CH0_MSB =  7, /**< PWM duty cycle register(7)  (r/w): Channel 0 duty cycle (8-bit) MSB */
460 
  PWM_DUTY_CH1_LSB =  8, /**< PWM duty cycle register(8)  (r/w): Channel 1 duty cycle (8-bit) LSB */
461 
  PWM_DUTY_CH1_MSB = 15, /**< PWM duty cycle register(15) (r/w): Channel 1 duty cycle (8-bit) MSB */
462 
  PWM_DUTY_CH2_LSB = 16, /**< PWM duty cycle register(16) (r/w): Channel 2 duty cycle (8-bit) LSB */
463 
  PWM_DUTY_CH2_MSB = 23, /**< PWM duty cycle register(23) (r/w): Channel 2 duty cycle (8-bit) MSB */
464 
  PWM_DUTY_CH3_LSB = 24, /**< PWM duty cycle register(24) (r/w): Channel 3 duty cycle (8-bit) LSB */
465 
  PWM_DUTY_CH3_MSB = 31  /**< PWM duty cycle register(31) (r/w): Channel 3 duty cycle (8-bit) MSB */
466 
};
467 
/**@}*/
468 
 
469 
 
470 
/**********************************************************************//**
471 
 * @name IO Device: True Random Number Generator (TRNG)
472 
 **************************************************************************/
473 
/**@{*/
474 
/** TRNG control register (r/w) */
475 
#define TRNG_CT   (*(IO_REG32 0xFFFFFFC0))
476 
/** TRNG data register (r/-) */
477 
#define TRNG_DATA (*(IO_ROM32 0xFFFFFFC4))
478 
 
479 
/** TRNG control register bits */
480 
enum NEORV32_TRNG_CT_enum {
481 
  TRNG_CT_TAP_LSB =  0, /**< TRNG control register(0)  (r/w): TAP mask (16-bit) LSB */
482 
  TRNG_CT_TAP_MSB = 15, /**< TRNG control register(15) (r/w): TAP mask (16-bit) MSB */
483 
  TRNG_CT_EN      = 31  /**< TRNG control register(31) (r/w): TRNG enable */
484 
};
485 
 
486 
/** WTD data register bits */
487 
enum NEORV32_TRNG_DUTY_enum {
488 
  TRNG_DATA_LSB   =  0, /**< TRNG data register(0)  (r/-): Random data (16-bit) LSB */
489 
  TRNG_DATA_MSB   = 15, /**< TRNG data register(15) (r/-): Random data (16-bit) MSB */
490 
  TRNG_DATA_VALID = 31  /**< TRNG data register(31) (r/-): Random data output valid */
491 
};
492 
/**@}*/
493 
 
494 
 
495 3 zero_gravi 
/**********************************************************************//**
496 
 * @name IO Device: Dummy Device (DEVNULL)
497 
 **************************************************************************/
498 
/**@{*/
499 
/** TRNG data register (r/w) */
500 
#define DEVNULL_DATA (*(IO_REG32 0xFFFFFFFC))
501 
/**@}*/
502 
 
503 
 
504 2 zero_gravi 
// ----------------------------------------------------------------------------
505 
// Include all IO driver headers
506 
// ----------------------------------------------------------------------------
507 
// cpu core
508 
#include "neorv32_cpu.h"
509 
 
510 
// neorv32 runtime environment
511 
#include "neorv32_rte.h"
512 
 
513 
// io/peripheral devices
514 
#include "neorv32_clic.h"
515 
#include "neorv32_gpio.h"
516 
#include "neorv32_mtime.h"
517 
#include "neorv32_pwm.h"
518 
#include "neorv32_spi.h"
519 
#include "neorv32_trng.h"
520 
#include "neorv32_twi.h"
521 
#include "neorv32_uart.h"
522 
#include "neorv32_wdt.h"
523 
 
524 
#endif // neorv32_h

powered by: WebSVN 2.1.0

© copyright 1999-2024 OpenCores.org, equivalent to Oliscience, all rights reserved. OpenCores®, registered trademark.