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

Subversion Repositories neorv32

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

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);
void neorv32_cpu_delay_ms(uint32_t time_ms);
 
 
/**********************************************************************//**
 * 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 machine software interrupt.
 *
 * @note The according IRQ has to be enabled via neorv32_cpu_irq_enable(uint8_t irq_sel) and
 * global interrupts must be enabled via neorv32_cpu_eint(void) to trigger an IRQ via software.
 * The MSI becomes active after 3 clock cycles.
 **************************************************************************/
inline void __attribute__ ((always_inline)) neorv32_cpu_sw_irq(void) {
 
  asm volatile ("csrrsi zero, mip, %0" : : "i" (1 << CPU_MIP_MSIP));
 
  // the MSI becomes active 3 clock cycles afters issueing
  asm volatile ("nop"); // these nops are not required, they just make sure the MSI becomes active
  asm volatile ("nop"); // before the "real" next operation is executed
}
 
 
/**********************************************************************//**
 * 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			`void neorv32_cpu_delay_ms(uint32_t time_ms);`
49
50
51			`/********************************************************************//`
52			`* Read data from CPU configuration and status register (CSR).`
53			`*`
54			`* @param[in] csr_id ID of CSR to read. See #NEORV32_CPU_CSRS_enum.`
55			`* @return Read data (uint32_t).`
56			`**************************************************************************/`
57			`inline uint32_t __attribute__ ((always_inline)) neorv32_cpu_csr_read(const int csr_id) {`
58
59			`register uint32_t csr_data;`
60
61	6	zero_gravi	`asm volatile ("csrr %[result], %[input_i]" : [result] "=r" (csr_data) : [input_i] "i" (csr_id));`
62	2	zero_gravi
63			`return csr_data;`
64			`}`
65
66
67			`/********************************************************************//`
68			`* Write data to CPU configuration and status register (CSR).`
69			`*`
70			`* @param[in] csr_id ID of CSR to write. See #NEORV32_CPU_CSRS_enum.`
71			`* @param[in] data Data to write (uint32_t).`
72			`**************************************************************************/`
73			`inline void __attribute__ ((always_inline)) neorv32_cpu_csr_write(const int csr_id, uint32_t data) {`
74
75			`register uint32_t csr_data = data;`
76
77	6	zero_gravi	`asm volatile ("csrw %[input_i], %[input_j]" : : [input_i] "i" (csr_id), [input_j] "r" (csr_data));`
78	2	zero_gravi	`}`
79
80	9	zero_gravi
81			`/********************************************************************//`
82			`* Put CPU into "sleep" mode.`
83			`*`
84			`* @note This function executes the WFI insstruction.`
85			`* The WFI (wait for interrupt) instruction will make the CPU stall until`
86			`* an interupt request is detected. Interrupts have to be globally enabled`
87			`* and at least one external source must be enabled (e.g., the CLIC or the machine`
88			`* timer) to allow the CPU to wake up again. If 'Zicsr' CPU extension is disabled,`
89			`* this will permanently stall the CPU.`
90			`**************************************************************************/`
91			`inline void __attribute__ ((always_inline)) neorv32_cpu_sleep(void) {`
92
93			`asm volatile ("wfi");`
94			`}`
95
96
97			`/********************************************************************//`
98			`* Enable global CPU interrupts (via MIE flag in mstatus CSR).`
99			`**************************************************************************/`
100			`inline void __attribute__ ((always_inline)) neorv32_cpu_eint(void) {`
101
102			`asm volatile ("csrrsi zero, mstatus, %0" : : "i" (1 << CPU_MSTATUS_MIE));`
103			`}`
104
105
106			`/********************************************************************//`
107			`* Disable global CPU interrupts (via MIE flag in mstatus CSR).`
108			`**************************************************************************/`
109			`inline void __attribute__ ((always_inline)) neorv32_cpu_dint(void) {`
110
111			`asm volatile ("csrrci zero, mstatus, %0" : : "i" (1 << CPU_MSTATUS_MIE));`
112			`}`
113
114
115			`/********************************************************************//`
116			`* Trigger machine software interrupt.`
117			`*`
118			`* @note The according IRQ has to be enabled via neorv32_cpu_irq_enable(uint8_t irq_sel) and`
119			`* global interrupts must be enabled via neorv32_cpu_eint(void) to trigger an IRQ via software.`
120			`* The MSI becomes active after 3 clock cycles.`
121			`**************************************************************************/`
122			`inline void __attribute__ ((always_inline)) neorv32_cpu_sw_irq(void) {`
123
124			`asm volatile ("csrrsi zero, mip, %0" : : "i" (1 << CPU_MIP_MSIP));`
125
126			`// the MSI becomes active 3 clock cycles afters issueing`
127			`asm volatile ("nop"); // these nops are not required, they just make sure the MSI becomes active`
128			`asm volatile ("nop"); // before the "real" next operation is executed`
129			`}`
130
131
132			`/********************************************************************//`
133			`* Trigger breakpoint exception (via EBREAK instruction).`
134			`**************************************************************************/`
135			`inline void __attribute__ ((always_inline)) neorv32_cpu_breakpoint(void) {`
136
137			`asm volatile ("ebreak");`
138			`}`
139
140
141			`/********************************************************************//`
142			`* Trigger "environment call" exception (via ECALL instruction).`
143			`**************************************************************************/`
144			`inline void __attribute__ ((always_inline)) neorv32_cpu_env_call(void) {`
145
146			`asm volatile ("ecall");`
147			`}`
148
149
150	2	zero_gravi	`#endif // neorv32_cpu_h`

Browse

Tools

Subversion Repositories neorv32

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