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

Subversion Repositories neorv32

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

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


// #################################################################################################
// # << NEORV32: neorv32_cpu.h - CPU Core Functions HW Driver >>                                   #
// # ********************************************************************************************* #
// # BSD 3-Clause License                                                                          #
// #                                                                                               #
// # Copyright (c) 2020, 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_cpu.h
 * @author Stephan Nolting
 * @brief CPU Core Functions HW driver header file.
 **************************************************************************/
 
#ifndef neorv32_cpu_h
#define neorv32_cpu_h
 
// prototypes
int neorv32_cpu_irq_enable(uint8_t irq_sel);
int neorv32_cpu_irq_disable(uint8_t irq_sel);
uint64_t neorv32_cpu_get_cycle(void);
void neorv32_cpu_set_mcycle(uint64_t value);
uint64_t neorv32_cpu_get_instret(void);
void neorv32_cpu_set_minstret(uint64_t value);
uint64_t neorv32_cpu_get_systime(void);
void neorv32_cpu_delay_ms(uint32_t time_ms);
void __attribute__((naked)) neorv32_cpu_goto_user_mode(void);
int neorv32_cpu_atomic_cas(uint32_t addr, uint32_t expected, uint32_t desired);
 
 
/**********************************************************************//**
 * Read data from CPU configuration and status register (CSR).
 *
 * @param[in] csr_id ID of CSR to read. See #NEORV32_CPU_CSRS_enum.
 * @return Read data (uint32_t).
 **************************************************************************/
inline uint32_t __attribute__ ((always_inline)) neorv32_cpu_csr_read(const int csr_id) {
 
  register uint32_t csr_data;
 
  asm volatile ("csrr %[result], %[input_i]" : [result] "=r" (csr_data) : [input_i] "i" (csr_id));
 
  return csr_data;
}
 
 
/**********************************************************************//**
 * Write data to CPU configuration and status register (CSR).
 *
 * @param[in] csr_id ID of CSR to write. See #NEORV32_CPU_CSRS_enum.
 * @param[in] data Data to write (uint32_t).
 **************************************************************************/
inline void __attribute__ ((always_inline)) neorv32_cpu_csr_write(const int csr_id, uint32_t data) {
 
  register uint32_t csr_data = data;
 
  asm volatile ("csrw %[input_i], %[input_j]" :  : [input_i] "i" (csr_id), [input_j] "r" (csr_data));
}
 
 
/**********************************************************************//**
 * Put CPU into "sleep" mode.
 *
 * @note This function executes the WFI insstruction.
 * The WFI (wait for interrupt) instruction will make the CPU stall until
 * an interupt request is detected. Interrupts have to be globally enabled
 * and at least one external source must be enabled (e.g., the CLIC or the machine
 * timer) to allow the CPU to wake up again. If 'Zicsr' CPU extension is disabled,
 * this will permanently stall the CPU.
 **************************************************************************/
inline void __attribute__ ((always_inline)) neorv32_cpu_sleep(void) {
 
  asm volatile ("wfi");
}
 
 
/**********************************************************************//**
 * Enable global CPU interrupts (via MIE flag in mstatus CSR).
 **************************************************************************/
inline void __attribute__ ((always_inline)) neorv32_cpu_eint(void) {
 
  asm volatile ("csrrsi zero, mstatus, %0" : : "i" (1 << CPU_MSTATUS_MIE));
}
 
 
/**********************************************************************//**
 * Disable global CPU interrupts (via MIE flag in mstatus CSR).
 **************************************************************************/
inline void __attribute__ ((always_inline)) neorv32_cpu_dint(void) {
 
  asm volatile ("csrrci zero, mstatus, %0" : : "i" (1 << CPU_MSTATUS_MIE));
}
 
 
/**********************************************************************//**
 * Trigger breakpoint exception (via EBREAK instruction).
 **************************************************************************/
inline void __attribute__ ((always_inline)) neorv32_cpu_breakpoint(void) {
 
  asm volatile ("ebreak");
}
 
 
/**********************************************************************//**
 * Trigger "environment call" exception (via ECALL instruction).
 **************************************************************************/
inline void __attribute__ ((always_inline)) neorv32_cpu_env_call(void) {
 
  asm volatile ("ecall");
}
 
 
#endif // neorv32_cpu_h

Line No.	Rev	Author	Line
1	2	zero_gravi	`// #################################################################################################`
2			`// # << NEORV32: neorv32_cpu.h - CPU Core Functions HW Driver >> #`
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_cpu.h`
38			`* @author Stephan Nolting`
39			`* @brief CPU Core Functions HW driver header file.`
40			`**************************************************************************/`
41
42			`#ifndef neorv32_cpu_h`
43			`#define neorv32_cpu_h`
44
45			`// prototypes`
46			`int neorv32_cpu_irq_enable(uint8_t irq_sel);`
47			`int neorv32_cpu_irq_disable(uint8_t irq_sel);`
48	12	zero_gravi	`uint64_t neorv32_cpu_get_cycle(void);`
49			`void neorv32_cpu_set_mcycle(uint64_t value);`
50			`uint64_t neorv32_cpu_get_instret(void);`
51			`void neorv32_cpu_set_minstret(uint64_t value);`
52			`uint64_t neorv32_cpu_get_systime(void);`
53	2	zero_gravi	`void neorv32_cpu_delay_ms(uint32_t time_ms);`
54	15	zero_gravi	`void __attribute__((naked)) neorv32_cpu_goto_user_mode(void);`
55	39	zero_gravi	`int neorv32_cpu_atomic_cas(uint32_t addr, uint32_t expected, uint32_t desired);`
56	2	zero_gravi
57
58			`/********************************************************************//`
59			`* Read data from CPU configuration and status register (CSR).`
60			`*`
61			`* @param[in] csr_id ID of CSR to read. See #NEORV32_CPU_CSRS_enum.`
62			`* @return Read data (uint32_t).`
63			`**************************************************************************/`
64			`inline uint32_t __attribute__ ((always_inline)) neorv32_cpu_csr_read(const int csr_id) {`
65
66			`register uint32_t csr_data;`
67
68	6	zero_gravi	`asm volatile ("csrr %[result], %[input_i]" : [result] "=r" (csr_data) : [input_i] "i" (csr_id));`
69	2	zero_gravi
70			`return csr_data;`
71			`}`
72
73
74			`/********************************************************************//`
75			`* Write data to CPU configuration and status register (CSR).`
76			`*`
77			`* @param[in] csr_id ID of CSR to write. See #NEORV32_CPU_CSRS_enum.`
78			`* @param[in] data Data to write (uint32_t).`
79			`**************************************************************************/`
80			`inline void __attribute__ ((always_inline)) neorv32_cpu_csr_write(const int csr_id, uint32_t data) {`
81
82			`register uint32_t csr_data = data;`
83
84	6	zero_gravi	`asm volatile ("csrw %[input_i], %[input_j]" : : [input_i] "i" (csr_id), [input_j] "r" (csr_data));`
85	2	zero_gravi	`}`
86
87	9	zero_gravi
88			`/********************************************************************//`
89			`* Put CPU into "sleep" mode.`
90			`*`
91			`* @note This function executes the WFI insstruction.`
92			`* The WFI (wait for interrupt) instruction will make the CPU stall until`
93			`* an interupt request is detected. Interrupts have to be globally enabled`
94			`* and at least one external source must be enabled (e.g., the CLIC or the machine`
95			`* timer) to allow the CPU to wake up again. If 'Zicsr' CPU extension is disabled,`
96			`* this will permanently stall the CPU.`
97			`**************************************************************************/`
98			`inline void __attribute__ ((always_inline)) neorv32_cpu_sleep(void) {`
99
100			`asm volatile ("wfi");`
101			`}`
102
103
104			`/********************************************************************//`
105			`* Enable global CPU interrupts (via MIE flag in mstatus CSR).`
106			`**************************************************************************/`
107			`inline void __attribute__ ((always_inline)) neorv32_cpu_eint(void) {`
108
109			`asm volatile ("csrrsi zero, mstatus, %0" : : "i" (1 << CPU_MSTATUS_MIE));`
110			`}`
111
112
113			`/********************************************************************//`
114			`* Disable global CPU interrupts (via MIE flag in mstatus CSR).`
115			`**************************************************************************/`
116			`inline void __attribute__ ((always_inline)) neorv32_cpu_dint(void) {`
117
118			`asm volatile ("csrrci zero, mstatus, %0" : : "i" (1 << CPU_MSTATUS_MIE));`
119			`}`
120
121
122			`/********************************************************************//`
123			`* Trigger breakpoint exception (via EBREAK instruction).`
124			`**************************************************************************/`
125			`inline void __attribute__ ((always_inline)) neorv32_cpu_breakpoint(void) {`
126
127			`asm volatile ("ebreak");`
128			`}`
129
130
131			`/********************************************************************//`
132			`* Trigger "environment call" exception (via ECALL instruction).`
133			`**************************************************************************/`
134			`inline void __attribute__ ((always_inline)) neorv32_cpu_env_call(void) {`
135
136			`asm volatile ("ecall");`
137			`}`
138
139
140	2	zero_gravi	`#endif // neorv32_cpu_h`

Browse

Tools

Subversion Repositories neorv32

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