git.sur5r.net Git - freertos/blob - FreeRTOS/Source/portable/GCC/RISC-V/port.c

   1 /*\r
   2  * FreeRTOS Kernel V10.2.1\r
   3  * Copyright (C) 2019 Amazon.com, Inc. or its affiliates.  All Rights Reserved.\r
   4  *\r
   5  * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
   6  * this software and associated documentation files (the "Software"), to deal in\r
   7  * the Software without restriction, including without limitation the rights to\r
   8  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
   9  * the Software, and to permit persons to whom the Software is furnished to do so,\r
  10  * subject to the following conditions:\r
  11  *\r
  12  * The above copyright notice and this permission notice shall be included in all\r
  13  * copies or substantial portions of the Software.\r
  14  *\r
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
  17  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
  18  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
  19  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
  20  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
  21  *\r
  22  * http://www.FreeRTOS.org\r
  23  * http://aws.amazon.com/freertos\r
  24  *\r
  25  * 1 tab == 4 spaces!\r
  26  */\r
  27 \r
  28 /*-----------------------------------------------------------\r
  29  * Implementation of functions defined in portable.h for the RISC-V RV32 port.\r
  30  *----------------------------------------------------------*/\r
  31 \r
  32 /* Scheduler includes. */\r
  33 #include "FreeRTOS.h"\r
  34 #include "task.h"\r
  35 #include "portmacro.h"\r
  36 \r
  37 /* Standard includes. */\r
  38 #include "string.h"\r
  39 \r
  40 #ifdef configCLINT_BASE_ADDRESS\r
  41         #warning The configCLINT_BASE_ADDRESS constant has been deprecated.  configMTIME_BASE_ADDRESS and configMTIMECMP_BASE_ADDRESS are currently being derived from configCLINT_BASE_ADDRESS.  Please update to define configMTIME_BASE_ADDRESS and configMTIMECMP_BASE_ADDRESS dirctly in place of configCLINT_BASE_ADDRESS.\r
  42 #endif\r
  43 \r
  44 #ifndef configMTIME_BASE_ADDRESS\r
  45         #warning configMTIME_BASE_ADDRESS must be defined in FreeRTOSConfig.h.  If the target chip includes a memory-mapped mtime register then set configMTIME_BASE_ADDRESS to the mapped address.  Otherwise set configMTIME_BASE_ADDRESS to 0.\r
  46 #endif\r
  47 \r
  48 #ifndef configMTIMECMP_BASE_ADDRESS\r
  49         #warning configMTIMECMP_BASE_ADDRESS must be defined in FreeRTOSConfig.h.  If the target chip includes a memory-mapped mtimecmp register then set configMTIMECMP_BASE_ADDRESS to the mapped address.  Otherwise set configMTIMECMP_BASE_ADDRESS to 0.\r
  50 #endif\r
  51 \r
  52 /* Let the user override the pre-loading of the initial LR with the address of\r
  53 prvTaskExitError() in case it messes up unwinding of the stack in the\r
  54 debugger. */\r
  55 #ifdef configTASK_RETURN_ADDRESS\r
  56         #define portTASK_RETURN_ADDRESS configTASK_RETURN_ADDRESS\r
  57 #else\r
  58         #define portTASK_RETURN_ADDRESS prvTaskExitError\r
  59 #endif\r
  60 \r
  61 /* The stack used by interrupt service routines.  Set configISR_STACK_SIZE_WORDS\r
  62 to use a statically allocated array as the interrupt stack.  Alternative leave\r
  63 configISR_STACK_SIZE_WORDS undefined and update the linker script so that a\r
  64 linker variable names __freertos_irq_stack_top has the same value as the top\r
  65 of the stack used by main.  Using the linker script method will repurpose the\r
  66 stack that was used by main before the scheduler was started for use as the\r
  67 interrupt stack after the scheduler has started. */\r
  68 #ifdef configISR_STACK_SIZE_WORDS\r
  69         static __attribute__ ((aligned(16))) StackType_t xISRStack[ configISR_STACK_SIZE_WORDS ] = { 0 };\r
  70         const StackType_t xISRStackTop = ( StackType_t ) &( xISRStack[ configISR_STACK_SIZE_WORDS & ~portBYTE_ALIGNMENT_MASK ] );\r
  71 \r
  72         /* Don't use 0xa5 as the stack fill bytes as that is used by the kernerl for\r
  73         the task stacks, and so will legitimately appear in many positions within\r
  74         the ISR stack. */\r
  75         #define portISR_STACK_FILL_BYTE 0xee    \r
  76 #else\r
  77         extern const uint32_t __freertos_irq_stack_top[];\r
  78         const StackType_t xISRStackTop = ( StackType_t ) __freertos_irq_stack_top;\r
  79 #endif\r
  80 \r
  81 /*\r
  82  * Setup the timer to generate the tick interrupts.  The implementation in this\r
  83  * file is weak to allow application writers to change the timer used to\r
  84  * generate the tick interrupt.\r
  85  */\r
  86 void vPortSetupTimerInterrupt( void ) __attribute__(( weak ));\r
  87 \r
  88 /*-----------------------------------------------------------*/\r
  89 \r
  90 /* Used to program the machine timer compare register. */\r
  91 uint64_t ullNextTime = 0ULL;\r
  92 const uint64_t *pullNextTime = &ullNextTime;\r
  93 const size_t uxTimerIncrementsForOneTick = ( size_t ) ( ( configCPU_CLOCK_HZ ) / ( configTICK_RATE_HZ ) ); /* Assumes increment won't go over 32-bits. */\r
  94 uint32_t const ullMachineTimerCompareRegisterBase = configMTIMECMP_BASE_ADDRESS;\r
  95 volatile uint64_t * pullMachineTimerCompareRegister = NULL;\r
  96 \r
  97 /* Set configCHECK_FOR_STACK_OVERFLOW to 3 to add ISR stack checking to task\r
  98 stack checking.  A problem in the ISR stack will trigger an assert, not call the\r
  99 stack overflow hook function (because the stack overflow hook is specific to a\r
 100 task stack, not the ISR stack). */\r
 101 #if defined( configISR_STACK_SIZE_WORDS ) && ( configCHECK_FOR_STACK_OVERFLOW > 2 )\r
 102         #warning This path not tested, or even compiled yet.\r
 103 \r
 104         static const uint8_t ucExpectedStackBytes[] = {\r
 105                                                                         portISR_STACK_FILL_BYTE, portISR_STACK_FILL_BYTE, portISR_STACK_FILL_BYTE, portISR_STACK_FILL_BYTE,             \\r
 106                                                                         portISR_STACK_FILL_BYTE, portISR_STACK_FILL_BYTE, portISR_STACK_FILL_BYTE, portISR_STACK_FILL_BYTE,             \\r
 107                                                                         portISR_STACK_FILL_BYTE, portISR_STACK_FILL_BYTE, portISR_STACK_FILL_BYTE, portISR_STACK_FILL_BYTE,             \\r
 108                                                                         portISR_STACK_FILL_BYTE, portISR_STACK_FILL_BYTE, portISR_STACK_FILL_BYTE, portISR_STACK_FILL_BYTE,             \\r
 109                                                                         portISR_STACK_FILL_BYTE, portISR_STACK_FILL_BYTE, portISR_STACK_FILL_BYTE, portISR_STACK_FILL_BYTE };   \\r
 110 \r
 111         #define portCHECK_ISR_STACK() configASSERT( ( memcmp( ( void * ) xISRStack, ( void * ) ucExpectedStackBytes, sizeof( ucExpectedStackBytes ) ) == 0 ) )\r
 112 #else\r
 113         /* Define the function away. */\r
 114         #define portCHECK_ISR_STACK()\r
 115 #endif /* configCHECK_FOR_STACK_OVERFLOW > 2 */\r
 116 \r
 117 /*-----------------------------------------------------------*/\r
 118 \r
 119 #if( configMTIME_BASE_ADDRESS != 0 ) && ( configMTIMECMP_BASE_ADDRESS != 0 )\r
 120 \r
 121         void vPortSetupTimerInterrupt( void )\r
 122         {\r
 123         uint32_t ulCurrentTimeHigh, ulCurrentTimeLow;\r
 124         volatile uint32_t * const pulTimeHigh = ( volatile uint32_t * const ) ( ( configMTIME_BASE_ADDRESS ) + 4UL ); /* 8-byte typer so high 32-bit word is 4 bytes up. */\r
 125         volatile uint32_t * const pulTimeLow = ( volatile uint32_t * const ) ( configMTIME_BASE_ADDRESS );\r
 126         volatile uint32_t ulHartId;\r
 127 \r
 128                 __asm volatile( "csrr %0, mhartid" : "=r"( ulHartId ) );\r
 129                 pullMachineTimerCompareRegister  = ( volatile uint64_t * ) ( ullMachineTimerCompareRegisterBase + ( ulHartId * sizeof( uint64_t ) ) );\r
 130 \r
 131                 do\r
 132                 {\r
 133                         ulCurrentTimeHigh = *pulTimeHigh;\r
 134                         ulCurrentTimeLow = *pulTimeLow;\r
 135                 } while( ulCurrentTimeHigh != *pulTimeHigh );\r
 136 \r
 137                 ullNextTime = ( uint64_t ) ulCurrentTimeHigh;\r
 138                 ullNextTime <<= 32ULL; /* High 4-byte word is 32-bits up. */\r
 139                 ullNextTime |= ( uint64_t ) ulCurrentTimeLow;\r
 140                 ullNextTime += ( uint64_t ) uxTimerIncrementsForOneTick;\r
 141                 *pullMachineTimerCompareRegister = ullNextTime;\r
 142 \r
 143                 /* Prepare the time to use after the next tick interrupt. */\r
 144                 ullNextTime += ( uint64_t ) uxTimerIncrementsForOneTick;\r
 145         }\r
 146 \r
 147 #endif /* ( configMTIME_BASE_ADDRESS != 0 ) && ( configMTIME_BASE_ADDRESS != 0 ) */\r
 148 /*-----------------------------------------------------------*/\r
 149 \r
 150 BaseType_t xPortStartScheduler( void )\r
 151 {\r
 152 extern void xPortStartFirstTask( void );\r
 153 \r
 154         #if( configASSERT_DEFINED == 1 )\r
 155         {\r
 156                 volatile uint32_t mtvec = 0;\r
 157 \r
 158                 /* Check the least significant two bits of mtvec are 00 - indicating\r
 159                 single vector mode. */\r
 160                 __asm volatile( "csrr %0, mtvec" : "=r"( mtvec ) );\r
 161                 configASSERT( ( mtvec & 0x03UL ) == 0 );\r
 162 \r
 163                 /* Check alignment of the interrupt stack - which is the same as the\r
 164                 stack that was being used by main() prior to the scheduler being\r
 165                 started. */\r
 166                 configASSERT( ( xISRStackTop & portBYTE_ALIGNMENT_MASK ) == 0 );\r
 167 \r
 168                 #ifdef configISR_STACK_SIZE_WORDS\r
 169                 {\r
 170                         memset( ( void * ) xISRStack, portISR_STACK_FILL_BYTE, sizeof( xISRStack ) );\r
 171                 }\r
 172                 #endif   /* configISR_STACK_SIZE_WORDS */\r
 173         }\r
 174         #endif /* configASSERT_DEFINED */\r
 175 \r
 176         /* If there is a CLINT then it is ok to use the default implementation\r
 177         in this file, otherwise vPortSetupTimerInterrupt() must be implemented to\r
 178         configure whichever clock is to be used to generate the tick interrupt. */\r
 179         vPortSetupTimerInterrupt();\r
 180 \r
 181         #if( ( configMTIME_BASE_ADDRESS != 0 ) && ( configMTIMECMP_BASE_ADDRESS != 0 ) )\r
 182         {\r
 183                 /* Enable mtime and external interrupts.  1<<7 for timer interrupt, 1<<11\r
 184                 for external interrupt.  _RB_ What happens here when mtime is not present as\r
 185                 with pulpino? */\r
 186                 __asm volatile( "csrs mie, %0" :: "r"(0x880) );\r
 187         }\r
 188         #else\r
 189         {\r
 190                 /* Enable external interrupts. */\r
 191                 __asm volatile( "csrs mie, %0" :: "r"(0x800) );\r
 192         }\r
 193         #endif /* ( configMTIME_BASE_ADDRESS != 0 ) && ( configMTIMECMP_BASE_ADDRESS != 0 ) */\r
 194 \r
 195         xPortStartFirstTask();\r
 196 \r
 197         /* Should not get here as after calling xPortStartFirstTask() only tasks\r
 198         should be executing. */\r
 199         return pdFAIL;\r
 200 }\r
 201 /*-----------------------------------------------------------*/\r
 202 \r
 203 void vPortEndScheduler( void )\r
 204 {\r
 205         /* Not implemented. */\r
 206         for( ;; );\r
 207 }\r
 208 \r
 209 \r
 210 \r
 211 \r
 212 \r