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

   1 /*\r
   2  * FreeRTOS Kernel V10.1.1\r
   3  * Copyright (C) 2018 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 #ifdef configISR_STACK_SIZE\r
  38         /* The stack used by interrupt service routines. */\r
  39         static __attribute__ ((aligned(16))) StackType_t xISRStack[ configISR_STACK_SIZE ] = { 0 };\r
  40         const StackType_t * const xISRStackTop = &( xISRStack[ ( configISR_STACK_SIZE & ~portBYTE_ALIGNMENT_MASK ) - 1 ] );\r
  41 #else\r
  42         extern const uint32_t __freertos_irq_stack_top[];\r
  43         const uint32_t xISRStackTop = ( uint32_t ) __freertos_irq_stack_top;\r
  44 #endif\r
  45 \r
  46 /*\r
  47  * Setup the timer to generate the tick interrupts.  The implementation in this\r
  48  * file is weak to allow application writers to change the timer used to\r
  49  * generate the tick interrupt.\r
  50  */\r
  51 void vPortSetupTimerInterrupt( void ) __attribute__(( weak ));\r
  52 \r
  53 /*\r
  54  * Used to catch tasks that attempt to return from their implementing function.\r
  55  */\r
  56 static void prvTaskExitError( void );\r
  57 \r
  58 /*-----------------------------------------------------------*/\r
  59 \r
  60 /* Used to program the machine timer compare register. */\r
  61 uint64_t ullNextTime = 0ULL;\r
  62 const uint64_t *pullNextTime = &ullNextTime;\r
  63 const uint32_t ulTimerIncrementsForOneTick = ( uint32_t ) ( configCPU_CLOCK_HZ / configTICK_RATE_HZ ); /* Assumes increment won't go over 32-bits. */\r
  64 volatile uint64_t * const pullMachineTimerCompareRegister = ( volatile uint64_t * const ) ( configCLINT_BASE_ADDRESS + 0x4000 );\r
  65 \r
  66 /* Set configCHECK_FOR_STACK_OVERFLOW to 3 to add ISR stack checking to task\r
  67 stack checking.  A problem in the ISR stack will trigger an assert, not call the\r
  68 stack overflow hook function (because the stack overflow hook is specific to a\r
  69 task stack, not the ISR stack). */\r
  70 #if( configCHECK_FOR_STACK_OVERFLOW > 2 )\r
  71         #warning This path not tested, or even compiled yet.\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 \r
  77         static const uint8_t ucExpectedStackBytes[] = {\r
  78                                                                         portISR_STACK_FILL_BYTE, portISR_STACK_FILL_BYTE, portISR_STACK_FILL_BYTE, portISR_STACK_FILL_BYTE,             \\r
  79                                                                         portISR_STACK_FILL_BYTE, portISR_STACK_FILL_BYTE, portISR_STACK_FILL_BYTE, portISR_STACK_FILL_BYTE,             \\r
  80                                                                         portISR_STACK_FILL_BYTE, portISR_STACK_FILL_BYTE, portISR_STACK_FILL_BYTE, portISR_STACK_FILL_BYTE,             \\r
  81                                                                         portISR_STACK_FILL_BYTE, portISR_STACK_FILL_BYTE, portISR_STACK_FILL_BYTE, portISR_STACK_FILL_BYTE,             \\r
  82                                                                         portISR_STACK_FILL_BYTE, portISR_STACK_FILL_BYTE, portISR_STACK_FILL_BYTE, portISR_STACK_FILL_BYTE };   \\r
  83 \r
  84         #define portCHECK_ISR_STACK() configASSERT( ( memcmp( ( void * ) xISRStack, ( void * ) ucExpectedStackBytes, sizeof( ucExpectedStackBytes ) ) == 0 ) )\r
  85 #else\r
  86         /* Define the function away. */\r
  87         #define portCHECK_ISR_STACK()\r
  88 #endif /* configCHECK_FOR_STACK_OVERFLOW > 2 */\r
  89 \r
  90 /*-----------------------------------------------------------*/\r
  91 \r
  92 void prvTaskExitError( void )\r
  93 {\r
  94 volatile uint32_t ulx = 0;\r
  95 \r
  96         /* A function that implements a task must not exit or attempt to return to\r
  97         its caller as there is nothing to return to.  If a task wants to exit it\r
  98         should instead call vTaskDelete( NULL ).\r
  99 \r
 100         Artificially force an assert() to be triggered if configASSERT() is\r
 101         defined, then stop here so application writers can catch the error. */\r
 102         configASSERT( ulx == ~0UL );\r
 103         portDISABLE_INTERRUPTS();\r
 104         for( ;; );\r
 105 }\r
 106 /*-----------------------------------------------------------*/\r
 107 \r
 108 /*\r
 109  * See header file for description.\r
 110  */\r
 111 StackType_t *pxPortInitialiseStack( StackType_t *pxTopOfStack, TaskFunction_t pxCode, void *pvParameters )\r
 112 {\r
 113 uint32_t mstatus;\r
 114 const uint32_t ulMPIE_Bit = 0x80, ulMPP_Bits = 0x1800;\r
 115         /*\r
 116            X1 to X31 integer registers for the 'I' profile, X1 to X15 for the 'E' profile.\r
 117 \r
 118                 Register        ABI Name                Description                                     Saver\r
 119                 x0                      zero                    Hard-wired zero                                 -\r
 120                 x1                      ra                              Return address                                  Caller\r
 121                 x2                      sp                              Stack pointer                                   Callee\r
 122                 x3                      gp                              Global pointer                                  -\r
 123                 x4                      tp                              Thread pointer                                  -\r
 124                 x5-7            t0-2                    Temporaries                                     Caller\r
 125                 x8                      s0/fp                   Saved register/Frame pointer    Callee\r
 126                 x9                      s1                              Saved register                                  Callee\r
 127                 x10-11          a0-1                    Function Arguments/return values Caller\r
 128                 x12-17          a2-7                    Function arguments                              Caller\r
 129                 x18-27          s2-11                   Saved registers                                 Callee\r
 130                 x28-31          t3-6                    Temporaries                                     Caller\r
 131         */\r
 132 \r
 133         /* Start task with interrupt enabled. */\r
 134         __asm volatile ("csrr %0, mstatus" : "=r"(mstatus));\r
 135         mstatus |= ulMPIE_Bit | ulMPP_Bits;\r
 136         pxTopOfStack--;\r
 137         *pxTopOfStack = mstatus;\r
 138 \r
 139         /* Numbers correspond to the x register number. */\r
 140         pxTopOfStack--;\r
 141         *pxTopOfStack = ( StackType_t ) 31;\r
 142         pxTopOfStack--;\r
 143         *pxTopOfStack = ( StackType_t ) 30;\r
 144         pxTopOfStack--;\r
 145         *pxTopOfStack = ( StackType_t ) 29;\r
 146         pxTopOfStack--;\r
 147         *pxTopOfStack = ( StackType_t ) 28;\r
 148         pxTopOfStack--;\r
 149         *pxTopOfStack = ( StackType_t ) 27;\r
 150         pxTopOfStack--;\r
 151         *pxTopOfStack = ( StackType_t ) 26;\r
 152         pxTopOfStack--;\r
 153         *pxTopOfStack = ( StackType_t ) 25;\r
 154         pxTopOfStack--;\r
 155         *pxTopOfStack = ( StackType_t ) 24;\r
 156         pxTopOfStack--;\r
 157         *pxTopOfStack = ( StackType_t ) 23;\r
 158         pxTopOfStack--;\r
 159         *pxTopOfStack = ( StackType_t ) 22;\r
 160         pxTopOfStack--;\r
 161         *pxTopOfStack = ( StackType_t ) 21;\r
 162         pxTopOfStack--;\r
 163         *pxTopOfStack = ( StackType_t ) 20;\r
 164         pxTopOfStack--;\r
 165         *pxTopOfStack = ( StackType_t ) 19;\r
 166         pxTopOfStack--;\r
 167         *pxTopOfStack = ( StackType_t ) 18;\r
 168         pxTopOfStack--;\r
 169         *pxTopOfStack = ( StackType_t ) 17;\r
 170         pxTopOfStack--;\r
 171         *pxTopOfStack = ( StackType_t ) 16;\r
 172         pxTopOfStack--;\r
 173         *pxTopOfStack = ( StackType_t ) 15;\r
 174         pxTopOfStack--;\r
 175         *pxTopOfStack = ( StackType_t ) 14;\r
 176         pxTopOfStack--;\r
 177         *pxTopOfStack = ( StackType_t ) 13;\r
 178         pxTopOfStack--;\r
 179         *pxTopOfStack = ( StackType_t ) 12;\r
 180         pxTopOfStack--;\r
 181         *pxTopOfStack = ( StackType_t ) 11;\r
 182         pxTopOfStack--;\r
 183         *pxTopOfStack = ( StackType_t ) pvParameters;\r
 184         pxTopOfStack--;\r
 185         *pxTopOfStack = ( StackType_t ) 9;\r
 186         pxTopOfStack--;\r
 187         *pxTopOfStack = ( StackType_t ) 8;\r
 188         pxTopOfStack--;\r
 189         *pxTopOfStack = ( StackType_t ) 7;\r
 190         pxTopOfStack--;\r
 191         *pxTopOfStack = ( StackType_t ) 6;\r
 192         pxTopOfStack--;\r
 193         *pxTopOfStack = ( StackType_t ) 5;\r
 194         pxTopOfStack--;\r
 195 //      *pxTopOfStack = ( StackType_t ) 4;  /* Thread pointer. */\r
 196 //      pxTopOfStack--;\r
 197 //      *pxTopOfStack = ( StackType_t ) 3;  /* Global pointer. */\r
 198 //      pxTopOfStack--;\r
 199 //      *pxTopOfStack = ( StackType_t ) 2;  /* Stack pointer. */\r
 200 //      pxTopOfStack--;\r
 201         *pxTopOfStack = ( StackType_t ) prvTaskExitError;\r
 202         pxTopOfStack--;\r
 203         *pxTopOfStack = ( StackType_t ) pxCode;\r
 204 \r
 205         return pxTopOfStack;\r
 206 }\r
 207 /*-----------------------------------------------------------*/\r
 208 \r
 209 #if( configCLINT_BASE_ADDRESS != 0 )\r
 210 \r
 211         void vPortSetupTimerInterrupt( void )\r
 212         {\r
 213         uint32_t ulCurrentTimeHigh, ulCurrentTimeLow;\r
 214         volatile uint32_t * const pulTimeHigh = ( volatile uint32_t * const ) ( configCLINT_BASE_ADDRESS + 0xBFFC );\r
 215         volatile uint32_t * const pulTimeLow = ( volatile uint32_t * const ) ( configCLINT_BASE_ADDRESS + 0xBFF8 );\r
 216 \r
 217                 do\r
 218                 {\r
 219                         ulCurrentTimeHigh = *pulTimeHigh;\r
 220                         ulCurrentTimeLow = *pulTimeLow;\r
 221                 } while( ulCurrentTimeHigh != *pulTimeHigh );\r
 222 \r
 223                 ullNextTime = ( uint64_t ) ulCurrentTimeHigh;\r
 224                 ullNextTime <<= 32ULL;\r
 225                 ullNextTime |= ( uint64_t ) ulCurrentTimeLow;\r
 226                 ullNextTime += ( uint64_t ) ulTimerIncrementsForOneTick;\r
 227                 *pullMachineTimerCompareRegister = ullNextTime;\r
 228 \r
 229                 /* Prepare the time to use after the next tick interrupt. */\r
 230                 ullNextTime += ( uint64_t ) ulTimerIncrementsForOneTick;\r
 231         }\r
 232 \r
 233 #endif /* ( configCLINT_BASE_ADDRESS != 0 ) */\r
 234 /*-----------------------------------------------------------*/\r
 235 \r
 236 BaseType_t xPortStartScheduler( void )\r
 237 {\r
 238 extern void xPortStartFirstTask( void );\r
 239 \r
 240         #if( configASSERT_DEFINED == 1 )\r
 241         {\r
 242                 volatile uint32_t mtvec = 0;\r
 243 \r
 244                 /* Check the least significant two bits of mtvec are 00 - indicating\r
 245                 single vector mode. */\r
 246                 __asm volatile( "csrr %0, mtvec" : "=r"( mtvec ) );\r
 247                 configASSERT( ( mtvec & 0x03UL ) == 0 );\r
 248 \r
 249                 /* Check alignment of the interrupt stack - which is the same as the\r
 250                 stack that was being used by main() prior to the scheduler being\r
 251                 started. */\r
 252                 configASSERT( ( xISRStackTop & portBYTE_ALIGNMENT_MASK ) == 0 );\r
 253         }\r
 254         #endif /* configASSERT_DEFINED */\r
 255 \r
 256         /* If there is a CLINT then it is ok to use the default implementation\r
 257         in this file, otherwise vPortSetupTimerInterrupt() must be implemented to\r
 258         configure whichever clock is to be used to generate the tick interrupt. */\r
 259         vPortSetupTimerInterrupt();\r
 260 \r
 261         #if( configCLINT_BASE_ADDRESS != 0 )\r
 262         {\r
 263                 /* Enable mtime and external interrupts.  1<<7 for timer interrupt, 1<<11\r
 264                 for external interrupt.  _RB_ What happens here when mtime is not present as\r
 265                 with pulpino? */\r
 266                 __asm volatile( "csrs mie, %0" :: "r"(0x880) );\r
 267         }\r
 268         #else\r
 269         {\r
 270                 /* Enable external interrupts. */\r
 271                 __asm volatile( "csrs mie, %0" :: "r"(0x800) );\r
 272         }\r
 273         #endif /* configCLINT_BASE_ADDRESS */\r
 274 \r
 275         xPortStartFirstTask();\r
 276 \r
 277         /* Should not get here as after calling xPortStartFirstTask() only tasks\r
 278         should be executing. */\r
 279         return pdFAIL;\r
 280 }\r
 281 /*-----------------------------------------------------------*/\r
 282 \r
 283 void vPortEndScheduler( void )\r
 284 {\r
 285         /* Not implemented. */\r
 286         for( ;; );\r
 287 }\r
 288 \r
 289 \r
 290 \r
 291 \r
 292 \r