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

Subversion Repositories neorv32

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

Details | Compare with Previous | View Log


// #################################################################################################
// # << NEORV32: neorv32_rte.h - NEORV32 Runtime Environment >>                                    #
// # ********************************************************************************************* #
// # BSD 3-Clause License                                                                          #
// #                                                                                               #
// # Copyright (c) 2021, Stephan Nolting. All rights reserved.                                     #
// #                                                                                               #
// # 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.                                                            #
// #                                                                                               #
// # 3. Neither the name of the copyright holder nor the names of its contributors may be used to  #
// #    endorse or promote products derived from this software without specific prior written      #
// #    permission.                                                                                #
// #                                                                                               #
// # 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 HOLDER 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.                                                            #
// # ********************************************************************************************* #
// # The NEORV32 Processor - https://github.com/stnolting/neorv32              (c) Stephan Nolting #
// #################################################################################################
 
 
/**********************************************************************//**
 * @file neorv32_rte.h
 * @brief NEORV32 Runtime Environment.
 **************************************************************************/
 
#ifndef neorv32_rte_h
#define neorv32_rte_h
 
/**********************************************************************//**
 * NEORV32 runtime environment trap IDs.
 **************************************************************************/
enum NEORV32_RTE_TRAP_enum {
  RTE_TRAP_I_MISALIGNED =  0, /**< Instruction address misaligned */
  RTE_TRAP_I_ACCESS     =  1, /**< Instruction (bus) access fault */
  RTE_TRAP_I_ILLEGAL    =  2, /**< Illegal instruction */
  RTE_TRAP_BREAKPOINT   =  3, /**< Breakpoint (EBREAK instruction) */
  RTE_TRAP_L_MISALIGNED =  4, /**< Load address misaligned */
  RTE_TRAP_L_ACCESS     =  5, /**< Load (bus) access fault */
  RTE_TRAP_S_MISALIGNED =  6, /**< Store address misaligned */
  RTE_TRAP_S_ACCESS     =  7, /**< Store (bus) access fault */
  RTE_TRAP_UENV_CALL    =  8, /**< Environment call from user mode (ECALL instruction) */
  RTE_TRAP_MENV_CALL    =  9, /**< Environment call from machine mode (ECALL instruction) */
  RTE_TRAP_MSI          = 10, /**< Machine software interrupt */
  RTE_TRAP_MTI          = 11, /**< Machine timer interrupt */
  RTE_TRAP_MEI          = 12, /**< Machine external interrupt */
  RTE_TRAP_FIRQ_0       = 13, /**< Fast interrupt channel 0 */
  RTE_TRAP_FIRQ_1       = 14, /**< Fast interrupt channel 1 */
  RTE_TRAP_FIRQ_2       = 15, /**< Fast interrupt channel 2 */
  RTE_TRAP_FIRQ_3       = 16, /**< Fast interrupt channel 3 */
  RTE_TRAP_FIRQ_4       = 17, /**< Fast interrupt channel 4 */
  RTE_TRAP_FIRQ_5       = 18, /**< Fast interrupt channel 5 */
  RTE_TRAP_FIRQ_6       = 19, /**< Fast interrupt channel 6 */
  RTE_TRAP_FIRQ_7       = 20, /**< Fast interrupt channel 7 */
  RTE_TRAP_FIRQ_8       = 21, /**< Fast interrupt channel 8 */
  RTE_TRAP_FIRQ_9       = 22, /**< Fast interrupt channel 9 */
  RTE_TRAP_FIRQ_10      = 23, /**< Fast interrupt channel 10 */
  RTE_TRAP_FIRQ_11      = 24, /**< Fast interrupt channel 11 */
  RTE_TRAP_FIRQ_12      = 25, /**< Fast interrupt channel 12 */
  RTE_TRAP_FIRQ_13      = 26, /**< Fast interrupt channel 13 */
  RTE_TRAP_FIRQ_14      = 27, /**< Fast interrupt channel 14 */
  RTE_TRAP_FIRQ_15      = 28  /**< Fast interrupt channel 15 */
};
 
 
/**********************************************************************//**
 * NEORV32 runtime environment: Number of available traps.
 **************************************************************************/
#define NEORV32_RTE_NUM_TRAPS 29
 
 
// prototypes
void neorv32_rte_setup(void);
int  neorv32_rte_exception_install(uint8_t id, void (*handler)(void));
int  neorv32_rte_exception_uninstall(uint8_t id);
 
void neorv32_rte_print_hw_config(void);
void neorv32_rte_print_hw_version(void);
void neorv32_rte_print_credits(void);
void neorv32_rte_print_logo(void);
void neorv32_rte_print_license(void);
 
uint32_t neorv32_rte_get_compiler_isa(void);
int      neorv32_rte_check_isa(int silent);
 
#endif // neorv32_rte_h

Line No.	Rev	Author	Line
1	2	zero_gravi	`// #################################################################################################`
2			`// # << NEORV32: neorv32_rte.h - NEORV32 Runtime Environment >> #`
3			`// # ********************************************************************************************* #`
4			`// # BSD 3-Clause License #`
5			`// # #`
6	44	zero_gravi	`// # Copyright (c) 2021, Stephan Nolting. All rights reserved. #`
7	2	zero_gravi	`// # #`
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_rte.h`
38			`* @brief NEORV32 Runtime Environment.`
39			`**************************************************************************/`
40
41			`#ifndef neorv32_rte_h`
42			`#define neorv32_rte_h`
43
44	14	zero_gravi	`/********************************************************************//`
45	44	zero_gravi	`* NEORV32 runtime environment trap IDs.`
46	14	zero_gravi	`**************************************************************************/`
47			`enum NEORV32_RTE_TRAP_enum {`
48			`RTE_TRAP_I_MISALIGNED = 0, /*< Instruction address misaligned /`
49			`RTE_TRAP_I_ACCESS = 1, /*< Instruction (bus) access fault /`
50			`RTE_TRAP_I_ILLEGAL = 2, /*< Illegal instruction /`
51			`RTE_TRAP_BREAKPOINT = 3, /*< Breakpoint (EBREAK instruction) /`
52			`RTE_TRAP_L_MISALIGNED = 4, /*< Load address misaligned /`
53			`RTE_TRAP_L_ACCESS = 5, /*< Load (bus) access fault /`
54			`RTE_TRAP_S_MISALIGNED = 6, /*< Store address misaligned /`
55			`RTE_TRAP_S_ACCESS = 7, /*< Store (bus) access fault /`
56	40	zero_gravi	`RTE_TRAP_UENV_CALL = 8, /*< Environment call from user mode (ECALL instruction) /`
57			`RTE_TRAP_MENV_CALL = 9, /*< Environment call from machine mode (ECALL instruction) /`
58	64	zero_gravi	`RTE_TRAP_MSI = 10, /*< Machine software interrupt /`
59			`RTE_TRAP_MTI = 11, /*< Machine timer interrupt /`
60			`RTE_TRAP_MEI = 12, /*< Machine external interrupt /`
61			`RTE_TRAP_FIRQ_0 = 13, /*< Fast interrupt channel 0 /`
62			`RTE_TRAP_FIRQ_1 = 14, /*< Fast interrupt channel 1 /`
63			`RTE_TRAP_FIRQ_2 = 15, /*< Fast interrupt channel 2 /`
64			`RTE_TRAP_FIRQ_3 = 16, /*< Fast interrupt channel 3 /`
65			`RTE_TRAP_FIRQ_4 = 17, /*< Fast interrupt channel 4 /`
66			`RTE_TRAP_FIRQ_5 = 18, /*< Fast interrupt channel 5 /`
67			`RTE_TRAP_FIRQ_6 = 19, /*< Fast interrupt channel 6 /`
68			`RTE_TRAP_FIRQ_7 = 20, /*< Fast interrupt channel 7 /`
69			`RTE_TRAP_FIRQ_8 = 21, /*< Fast interrupt channel 8 /`
70			`RTE_TRAP_FIRQ_9 = 22, /*< Fast interrupt channel 9 /`
71			`RTE_TRAP_FIRQ_10 = 23, /*< Fast interrupt channel 10 /`
72			`RTE_TRAP_FIRQ_11 = 24, /*< Fast interrupt channel 11 /`
73			`RTE_TRAP_FIRQ_12 = 25, /*< Fast interrupt channel 12 /`
74			`RTE_TRAP_FIRQ_13 = 26, /*< Fast interrupt channel 13 /`
75			`RTE_TRAP_FIRQ_14 = 27, /*< Fast interrupt channel 14 /`
76			`RTE_TRAP_FIRQ_15 = 28 /*< Fast interrupt channel 15 /`
77	14	zero_gravi	`};`
78
79	48	zero_gravi
80			`/********************************************************************//`
81			`* NEORV32 runtime environment: Number of available traps.`
82			`**************************************************************************/`
83	64	zero_gravi	`#define NEORV32_RTE_NUM_TRAPS 29`
84	48	zero_gravi
85
86	2	zero_gravi	`// prototypes`
87	14	zero_gravi	`void neorv32_rte_setup(void);`
88			`int neorv32_rte_exception_install(uint8_t id, void (*handler)(void));`
89			`int neorv32_rte_exception_uninstall(uint8_t id);`
90	11	zero_gravi
91	6	zero_gravi	`void neorv32_rte_print_hw_config(void);`
92	12	zero_gravi	`void neorv32_rte_print_hw_version(void);`
93	11	zero_gravi	`void neorv32_rte_print_credits(void);`
94	37	zero_gravi	`void neorv32_rte_print_logo(void);`
95	22	zero_gravi	`void neorv32_rte_print_license(void);`
96	2	zero_gravi
97	44	zero_gravi	`uint32_t neorv32_rte_get_compiler_isa(void);`
98	74	zero_gravi	`int neorv32_rte_check_isa(int silent);`
99	44	zero_gravi
100	2	zero_gravi	`#endif // neorv32_rte_h`

Browse

Tools

Subversion Repositories neorv32

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