# System Configuration Files system_<device>.c and system_<device>.h¶

The System Configuration Files system_<device>.c and system_<device>.h provides as a minimum the functions described under System Device Configuration.

These functions are device specific and need adaptations. In addition, the file might have configuration settings for the device such as XTAL frequency or PLL prescaler settings, necessary system initilization, vendor customized interrupt, exception and nmi handling code, refer to System Device Configuration for more details.

For devices with external memory BUS the system_<device>.c also configures the BUS system.

The silicon vendor might expose other functions (i.e. for power configuration) in the system_<device>.c file. In case of additional features the function prototypes need to be added to the system_<device>.h header file.

## system_Device.c Template File¶

Here we provided system_Device.c template file as below:

  1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 /* * Copyright (c) 2009-2018 Arm Limited. All rights reserved. * Copyright (c) 2019 Nuclei Limited. All rights reserved. * * SPDX-License-Identifier: Apache-2.0 * * Licensed under the Apache License, Version 2.0 (the License); you may * not use this file except in compliance with the License. * You may obtain a copy of the License at * * www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an AS IS BASIS, WITHOUT * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /****************************************************************************** * @file system_.c * @brief NMSIS Nuclei N/NX Device Peripheral Access Layer Source File for * Device * @version V1.00 * @date 17. Dec 2019 ******************************************************************************/ #include #include ".h" /*---------------------------------------------------------------------------- Define clocks *----------------------------------------------------------------------------*/ /* TODO: add here your necessary defines for device initialization following is an example for different system frequencies */ #define XTAL (12000000U) /* Oscillator frequency */ #define SYSTEM_CLOCK (5 * XTAL) /** * \defgroup NMSIS_Core_SystemConfig System Device Configuration * \brief Functions for system init, clock setup and interrupt/exception/nmi functions available in system_.c. * \details * Nuclei provides a template file **system_Device.c** that must be adapted by * the silicon vendor to match their actual device. As a minimum requirement, * this file must provide: * - A device-specific system configuration function, \ref SystemInit. * - A global variable that contains the system frequency, \ref SystemCoreClock. * - A global eclic configuration initialization, \ref ECLIC_Init. * - Global c library \ref _init and \ref _fini functions called right before calling main function. * - Vendor customized interrupt, exception and nmi handling code, see \ref NMSIS_Core_IntExcNMI_Handling * * The file configures the device and, typically, initializes the oscillator (PLL) that is part * of the microcontroller device. This file might export other functions or variables that provide * a more flexible configuration of the microcontroller system. * * And this file also provided common interrupt, exception and NMI exception handling framework template, * Silicon vendor can customize these template code as they want. * * \note Please pay special attention to the static variable \c SystemCoreClock. This variable might be * used throughout the whole system initialization and runtime to calculate frequency/time related values. * Thus one must assure that the variable always reflects the actual system clock speed. * * \attention * Be aware that a value stored to \c SystemCoreClock during low level initializaton (i.e. \c SystemInit()) might get * overwritten by C libray startup code and/or .bss section initialization. * Thus its highly recommended to call \ref SystemCoreClockUpdate at the beginning of the user \c main() routine. * * @{ */ /*---------------------------------------------------------------------------- System Core Clock Variable *----------------------------------------------------------------------------*/ /* TODO: initialize SystemCoreClock with the system core clock frequency value achieved after system intitialization. This means system core clock frequency after call to SystemInit() */ /** * \brief Variable to hold the system core clock value * \details * Holds the system core clock, which is the system clock frequency supplied to the SysTick * timer and the processor core clock. This variable can be used by debuggers to query the * frequency of the debug timer or to configure the trace clock speed. * * \attention * Compilers must be configured to avoid removing this variable in case the application * program is not using it. Debugging systems require the variable to be physically * present in memory so that it can be examined to configure the debugger. */ uint32_t SystemCoreClock = SYSTEM_CLOCK; /* System Clock Frequency (Core Clock) */ /*---------------------------------------------------------------------------- Clock functions *----------------------------------------------------------------------------*/ /** * \brief Function to update the variable \ref SystemCoreClock * \details * Updates the variable \ref SystemCoreClock and must be called whenever the core clock is changed * during program execution. The function evaluates the clock register settings and calculates * the current core clock. */ void SystemCoreClockUpdate (void) /* Get Core Clock Frequency */ { /* TODO: add code to calculate the system frequency based upon the current * register settings. * Note: This function can be used to retrieve the system core clock frequeny * after user changed register settings. */ SystemCoreClock = SYSTEM_CLOCK; } /** * \brief Function to Initialize the system. * \details * Initializes the microcontroller system. Typically, this function configures the * oscillator (PLL) that is part of the microcontroller device. For systems * with a variable clock speed, it updates the variable \ref SystemCoreClock. * SystemInit is called from the file startup_device. */ void SystemInit (void) { /* TODO: add code to initialize the system * Warn: do not use global variables because this function is called before * reaching pre-main. RW section maybe overwritten afterwards. */ SystemCoreClock = SYSTEM_CLOCK; } /** * \defgroup NMSIS_Core_IntExcNMI_Handling Interrupt and Exception and NMI Handling * \brief Functions for interrupt, exception and nmi handle available in system_.c. * \details * Nuclei provide a template for interrupt, exception and NMI handling. Silicon Vendor could adapat according * to their requirement. Silicon vendor could implement interface for different exception code and * replace current implementation. * * @{ */ /** \brief Max exception handler number, don't include the NMI(0xFFF) one */ #define MAX_SYSTEM_EXCEPTION_NUM 12 /** * \brief Store the exception handlers for each exception ID * \note * - This SystemExceptionHandlers are used to store all the handlers for all * the exception codes Nuclei N/NX core provided. * - Exception code 0 - 11, totally 12 exceptions are mapped to SystemExceptionHandlers[0:11] * - Exception for NMI is also re-routed to exception handling(exception code 0xFFF) in startup code configuration, the handler itself is mapped to SystemExceptionHandlers[MAX_SYSTEM_EXCEPTION_NUM] */ static unsigned long SystemExceptionHandlers[MAX_SYSTEM_EXCEPTION_NUM+1]; /** * \brief Exception Handler Function Typedef * \note * This typedef is only used internal in this system_.c file. * It is used to do type conversion for registered exception handler before calling it. */ typedef void (*EXC_HANDLER) (unsigned long mcause, unsigned long sp); /** * \brief System Default Exception Handler * \details * This function provided a default exception and NMI handling code for all exception ids. * By default, It will just print some information for debug, Vendor can customize it according to its requirements. */ static void system_default_exception_handler(unsigned long mcause, unsigned long sp) { /* TODO: Uncomment this if you have implement printf function. * Or you can implement your own version as you like */ //printf("MCAUSE: 0x%lx\r\n", mcause); //printf("MEPC : 0x%lx\r\n", __RV_CSR_READ(CSR_MEPC)); //printf("MTVAL : 0x%lx\r\n", __RV_CSR_READ(CSR_MBADADDR)); while(1); } /** * \brief Initialize all the default core exception handlers * \details * The core exception handler for each exception id will be initialized to \ref system_default_exception_handler. * \note * Called in \ref _init function, used to initialize default exception handlers for all exception IDs */ static void Exception_Init(void) { for (int i = 0; i < MAX_SYSTEM_EXCEPTION_NUM+1; i++) { SystemExceptionHandlers[i] = (unsigned long)system_default_exception_handler; } } /** * \brief Register an exception handler for exception code EXCn * \details * * For EXCn < \ref MAX_SYSTEM_EXCEPTION_NUM, it will be registered into SystemExceptionHandlers[EXCn-1]. * * For EXCn == NMI_EXCn, it will be registered into SystemExceptionHandlers[MAX_SYSTEM_EXCEPTION_NUM]. * \param EXCn See \ref EXCn_Type * \param exc_handler The exception handler for this exception code EXCn */ void Exception_Register_EXC(uint32_t EXCn, unsigned long exc_handler) { if ((EXCn < MAX_SYSTEM_EXCEPTION_NUM) && (EXCn >= 0)) { SystemExceptionHandlers[EXCn] = exc_handler; } else if (EXCn == NMI_EXCn) { SystemExceptionHandlers[MAX_SYSTEM_EXCEPTION_NUM] = exc_handler; } } /** * \brief Get current exception handler for exception code EXCn * \details * * For EXCn < \ref MAX_SYSTEM_EXCEPTION_NUM, it will return SystemExceptionHandlers[EXCn-1]. * * For EXCn == NMI_EXCn, it will return SystemExceptionHandlers[MAX_SYSTEM_EXCEPTION_NUM]. * \param EXCn See \ref EXCn_Type * \return Current exception handler for exception code EXCn, if not found, return 0. */ unsigned long Exception_Get_EXC(uint32_t EXCn) { if ((EXCn < MAX_SYSTEM_EXCEPTION_NUM) && (EXCn >= 0)) { return SystemExceptionHandlers[EXCn]; } else if (EXCn == NMI_EXCn) { return SystemExceptionHandlers[MAX_SYSTEM_EXCEPTION_NUM]; } else { return 0; } } /** * \brief Common NMI and Exception handler entry * \details * This function provided a command entry for NMI and exception. Silicon Vendor could modify * this template implementation according to requirement. * \remarks * - RISCV provided common entry for all types of exception. This is proposed code template * for exception entry function, Silicon Vendor could modify the implementation. * - For the core_exception_handler template, we provided exception register function \ref Exception_Register_EXCn * which can help developer to register your exception handler for specific exception number. */ uint32_t core_exception_handler(unsigned long mcause, unsigned long sp) { uint32_t EXCn = (uint32_t)(mcause & 0X00000fff); EXC_HANDLER exc_handler; if ((EXCn < MAX_SYSTEM_EXCEPTION_NUM) && (EXCn >= 0)) { exc_handler = (EXC_HANDLER)SystemExceptionHandlers[EXCn]; } else if (EXCn == NMI_EXCn) { exc_handler = (EXC_HANDLER)SystemExceptionHandlers[MAX_SYSTEM_EXCEPTION_NUM]; } else { exc_handler = (EXC_HANDLER)system_default_exception_handler; } if (exc_handler != NULL) { exc_handler(mcause, sp); } return 0; } /** * \brief Initialize Global ECLIC Config * \details * ECLIC needs be initialized after boot up, * Vendor could also change the initialization * configuration. */ void ECLIC_Init(void) { /* Global Configuration about MTH and NLBits. * TODO: Please adapt it according to your system requirement. * This function is called in _init function */ /* Set CSR MTH to zero */ ECLIC_SetMth(0); /* Set Nlbits to the CLICINTCTLBITS, all the bits are level bits */ ECLIC_SetCfgNlbits(__ECLIC_INTCTLBITS); } /** * \brief Initialize a specific IRQ and register the handler * \details * This function set vector mode, trigger mode and polarity, interrupt level and priority, * assign handler for specific IRQn. * \param [in] IRQn NMI interrupt handler address * \param [in] shv \ref ECLIC_NON_VECTOR_INTERRUPT means non-vector mode, and \ref ECLIC_VECTOR_INTERRUPT is vector mode * \param [in] trig_mode see \ref ECLIC_TRIGGER_Type * \param [in] lvl interupt level * \param [in] priority interrupt priority * \param [in] handler interrupt handler, if NULL, handler will not be installed * * \return -1 means invalid input parameter. 0 means successful. * \remarks * - This function use to configure specific eclic interrupt and register its interrupt handler and enable its interrupt. * - If the vector table is placed in read-only section(FLASHXIP mode), handler could not be installed */ int32_t ECLIC_Register_IRQ(IRQn_Type IRQn, uint8_t shv, ECLIC_TRIGGER_Type trig_mode, uint8_t lvl, uint8_t priority, void *handler) { if ((IRQn > SOC_INT_MAX) || (shv > ECLIC_VECTOR_INTERRUPT) \ || (trig_mode > ECLIC_NEGTIVE_EDGE_TRIGGER )) { return -1; } /* set interrupt vector mode */ ECLIC_SetShvIRQ(IRQn, shv); /* set interrupt trigger mode and polarity */ ECLIC_SetTrigIRQ(IRQn, trig_mode); /* set interrupt level */ ECLIC_SetLevelIRQ(IRQn, lvl); /* set interrupt priority */ ECLIC_SetPriorityIRQ(IRQn, priority); if (handler != NULL) { /* set interrupt handler entry to vector table */ ECLIC_SetVector(IRQn, (rv_csr_t)handler); } /* enable interrupt */ ECLIC_EnableIRQ(IRQn); return 0; } /** @} */ /* End of Doxygen Group NMSIS_Core_ExceptionAndNMI */ /** * \brief early init function before main * \details * This function is executed right before main function. * For RISC-V gnu toolchain, _init function might not be called * by __libc_init_array function, so we defined a new function * to do initialization */ void _premain_init(void) { /* TODO: Add your own initialization code here, called before main */ /* __ICACHE_PRESENT and __DCACHE_PRESENT are defined in .h */ #if defined(__ICACHE_PRESENT) && __ICACHE_PRESENT == 1 EnableICache(); #endif #if defined(__DCACHE_PRESENT) && __DCACHE_PRESENT == 1 EnableDCache(); #endif // TODO: Add code to set the system clock frequency value SystemCoreClock // TODO: Add code to initialize necessary gpio and basic uart for debug print /* Initialize exception default handlers */ Exception_Init(); /* ECLIC initilization, mainly MTH and NLBIT settings */ ECLIC_Init(); } /** * \brief finish function after main * \param [in] status status code return from main * \details * This function is executed right after main function. * For RISC-V gnu toolchain, _fini function might not be called * by __libc_fini_array function, so we defined a new function * to do initialization */ void _postmain_fini(int status) { /* TODO: Add your own finishing code here, called after main */ } /** * \brief _init function called in __libc_init_array() * \details * This __libc_init_array() function is called during startup code, * user need to implement this function, otherwise when link it will * error init.c:(.text.__libc_init_array+0x26): undefined reference to _init' * \note * Please use \ref _premain_init function now */ void _init(void) { /* Don't put any code here, please use _premain_init now */ } /** * \brief _fini function called in __libc_fini_array() * \details * This __libc_fini_array() function is called when exit main. * user need to implement this function, otherwise when link it will * error fini.c:(.text.__libc_fini_array+0x28): undefined reference to _fini' * \note * Please use \ref _postmain_fini function now */ void _fini(void) { /* Don't put any code here, please use _postmain_fini now */ } /** @} */ /* End of Doxygen Group NMSIS_Core_SystemAndClock */ 

## system_Device.h Template File¶

Here we provided system_Device.h template file as below:

  1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 /* * Copyright (c) 2009-2018 Arm Limited. All rights reserved. * Copyright (c) 2019 Nuclei Limited. All rights reserved. * * SPDX-License-Identifier: Apache-2.0 * * Licensed under the Apache License, Version 2.0 (the License); you may * not use this file except in compliance with the License. * You may obtain a copy of the License at * * www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an AS IS BASIS, WITHOUT * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /******************************************************************************* * @file system_.h * @brief NMSIS Nuclei N/NX Device Peripheral Access Layer Header File for * Device * @version V1.00 * @date 17. Dec 2019 ******************************************************************************/ #ifndef __SYSTEM__H__ /* TODO: replace '' with your device name */ #define __SYSTEM__H__ #ifdef __cplusplus extern "C" { #endif #include extern uint32_t SystemCoreClock; /*!< System Clock Frequency (Core Clock) */ /** * \brief Setup the microcontroller system. * \details * Initialize the System and update the SystemCoreClock variable. */ extern void SystemInit(void); /** * \brief Update SystemCoreClock variable. * \details * Updates the SystemCoreClock with current core Clock retrieved from cpu registers. */ extern void SystemCoreClockUpdate(void); /** * \brief Register an exception handler for exception code EXCn */ extern void Exception_Register_EXC(uint32_t EXCn, unsigned long exc_handler); /** * \brief Get current exception handler for exception code EXCn */ extern unsigned long Exception_Get_EXC(uint32_t EXCn); /** * \brief Initialize eclic config */ extern void ECLIC_Init(void); /** * \brief initialize a specific IRQ and register the handler * \details * This function set vector mode, trigger mode and polarity, interrupt level and priority, * assign handler for specific IRQn. * \param [in] IRQn NMI interrupt handler address * \param [in] shv \ref ECLIC_NON_VECTOR_INTERRUPT means non-vector mode, and \ref ECLIC_VECTOR_INTERRUPT is vector mode * \param [in] trig_mode see \ref ECLIC_TRIGGER_Type * \param [in] lvl interupt level * \param [in] priority interrupt priority * \param [in] handler interrupt handler * return -1 means invalid input parameter. 0 means successful. * \remarks * - This function use to configure specific eclic interrupt and register its interrupt handler and enable its interrupt. */ extern int32_t ECLIC_Register_IRQ(IRQn_Type IRQn, uint8_t shv, ECLIC_TRIGGER_Type trig_mode, uint8_t lvl, uint8_t priority, void *handler); #ifdef __cplusplus } #endif #endif /* __SYSTEM__H__ */