FreeRTOS-Kernel/portable/GCC/RISC-V/portContext.h

322 lines
12 KiB
C

/*
* FreeRTOS Kernel <DEVELOPMENT BRANCH>
* Copyright (C) 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* SPDX-License-Identifier: MIT
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of
* this software and associated documentation files (the "Software"), to deal in
* the Software without restriction, including without limitation the rights to
* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
* the Software, and to permit persons to whom the Software is furnished to do so,
* subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*
* https://www.FreeRTOS.org
* https://github.com/FreeRTOS
*
*/
#ifndef PORTCONTEXT_H
#define PORTCONTEXT_H
#if __riscv_xlen == 64
#define portWORD_SIZE 8
#define store_x sd
#define load_x ld
#elif __riscv_xlen == 32
#define store_x sw
#define load_x lw
#define portWORD_SIZE 4
#else
#error Assembler did not define __riscv_xlen
#endif
#include "freertos_risc_v_chip_specific_extensions.h"
/* Only the standard core registers are stored by default. Any additional
* registers must be saved by the portasmSAVE_ADDITIONAL_REGISTERS and
* portasmRESTORE_ADDITIONAL_REGISTERS macros - which can be defined in a chip
* specific version of freertos_risc_v_chip_specific_extensions.h. See the
* notes at the top of portASM.S file. */
#ifdef __riscv_32e
#define portIREG_COUNT 15
#define portCRITICAL_NESTING_OFFSET 13
#define portMSTATUS_OFFSET 14
#else
#define portIREG_COUNT 31
#define portCRITICAL_NESTING_OFFSET 29
#define portMSTATUS_OFFSET 30
#endif
#define portICONTEXT_SIZE ( portIREG_COUNT * portWORD_SIZE )
/* Provide a value for the reserved size for the FPU registers. portFPUCONTEXT_SIZE is always defined,
* but it may be 0 if the FPU is not used */
#ifdef portasmSTORE_FPU_CONTEXT
#define MSTATUS_FS_MASK 0x6000 /* Floating-point Unit Status in mstatus register */
#define MSTATUS_FS_INITIAL 0x2000
#define MSTATUS_FS_CLEAN 0x4000
#define MSTATUS_FS_DIRTY 0x6000
#define MSTATUS_FS_USED_OFFSET 14
#ifdef __riscv_fdiv
#define portFPUREG_SIZE (__riscv_flen / 8)
#if __riscv_flen == 32
#define load_f flw
#define store_f fsw
#elif __riscv_flen == 64
#define load_f fld
#define store_f fsd
#else
#error Assembler did not define __riscv_flen
#endif
#define portFPUREG_COUNT 33 /* 32 Floating point registers plus one CSR */
#define portFPUREG_OFFSET(_fpureg_) (_fpureg_ * portFPUREG_SIZE + portICONTEXT_SIZE)
#define portFPUCONTEXT_SIZE (portFPUREG_SIZE * portFPUREG_COUNT)
#else
#define portFPUCONTEXT_SIZE 0
#endif
#else
#define portFPUCONTEXT_SIZE 0
#endif
#define portCONTEXT_SIZE ( portICONTEXT_SIZE + portFPUCONTEXT_SIZE )
/*-----------------------------------------------------------*/
.extern pxCurrentTCB
.extern xISRStackTop
.extern xCriticalNesting
.extern pxCriticalNesting
/*-----------------------------------------------------------*/
.macro portcontexSAVE_FPU_CONTEXT_INTERNAL
/* Check if the FPU has been used, if it has not, skip the context save */
srl t1, t0, MSTATUS_FS_USED_OFFSET
andi t1, t1, 1
beqz t1, 1f /* The FPU has not been used (FS either initial or clean), skip context save */
/* Store the fp registers */
store_f f0, portFPUREG_OFFSET(0)( sp )
store_f f1, portFPUREG_OFFSET(1)( sp )
store_f f2, portFPUREG_OFFSET(2)( sp )
store_f f3, portFPUREG_OFFSET(3)( sp )
store_f f4, portFPUREG_OFFSET(4)( sp )
store_f f5, portFPUREG_OFFSET(5)( sp )
store_f f6, portFPUREG_OFFSET(6)( sp )
store_f f7, portFPUREG_OFFSET(7)( sp )
store_f f8, portFPUREG_OFFSET(8)( sp )
store_f f9, portFPUREG_OFFSET(9)( sp )
store_f f10, portFPUREG_OFFSET(10)( sp )
store_f f11, portFPUREG_OFFSET(11)( sp )
store_f f12, portFPUREG_OFFSET(12)( sp )
store_f f13, portFPUREG_OFFSET(13)( sp )
store_f f14, portFPUREG_OFFSET(14)( sp )
store_f f15, portFPUREG_OFFSET(15)( sp )
store_f f16, portFPUREG_OFFSET(16)( sp )
store_f f17, portFPUREG_OFFSET(17)( sp )
store_f f18, portFPUREG_OFFSET(18)( sp )
store_f f19, portFPUREG_OFFSET(19)( sp )
store_f f20, portFPUREG_OFFSET(20)( sp )
store_f f21, portFPUREG_OFFSET(21)( sp )
store_f f22, portFPUREG_OFFSET(22)( sp )
store_f f23, portFPUREG_OFFSET(23)( sp )
store_f f24, portFPUREG_OFFSET(24)( sp )
store_f f25, portFPUREG_OFFSET(25)( sp )
store_f f26, portFPUREG_OFFSET(26)( sp )
store_f f27, portFPUREG_OFFSET(27)( sp )
store_f f28, portFPUREG_OFFSET(28)( sp )
store_f f29, portFPUREG_OFFSET(29)( sp )
store_f f30, portFPUREG_OFFSET(30)( sp )
store_f f31, portFPUREG_OFFSET(31)( sp )
csrr t0, fcsr
store_x t0, portFPUREG_OFFSET(32)( sp )
/* Mark the FPU as clean */
li t1, ~MSTATUS_FS_MASK
and t0, t0, t1
li t1, MSTATUS_FS_CLEAN
or t0, t0, t1
csrw mstatus, t0
1:
.endm
/*-----------------------------------------------------------*/
.macro portasmRESTORE_FPU_CONTEXT_INTERNAL
/* Restore fp registers from context */
load_f f0, portFPUREG_OFFSET(0)( sp )
load_f f1, portFPUREG_OFFSET(0)( sp )
load_f f1, portFPUREG_OFFSET(1)( sp )
load_f f2, portFPUREG_OFFSET(2)( sp )
load_f f3, portFPUREG_OFFSET(3)( sp )
load_f f4, portFPUREG_OFFSET(4)( sp )
load_f f5, portFPUREG_OFFSET(5)( sp )
load_f f6, portFPUREG_OFFSET(6)( sp )
load_f f7, portFPUREG_OFFSET(7)( sp )
load_f f8, portFPUREG_OFFSET(8)( sp )
load_f f9, portFPUREG_OFFSET(9)( sp )
load_f f10, portFPUREG_OFFSET(10)( sp )
load_f f11, portFPUREG_OFFSET(11)( sp )
load_f f12, portFPUREG_OFFSET(12)( sp )
load_f f13, portFPUREG_OFFSET(13)( sp )
load_f f14, portFPUREG_OFFSET(14)( sp )
load_f f15, portFPUREG_OFFSET(15)( sp )
load_f f16, portFPUREG_OFFSET(16)( sp )
load_f f17, portFPUREG_OFFSET(17)( sp )
load_f f18, portFPUREG_OFFSET(18)( sp )
load_f f19, portFPUREG_OFFSET(19)( sp )
load_f f20, portFPUREG_OFFSET(20)( sp )
load_f f21, portFPUREG_OFFSET(21)( sp )
load_f f22, portFPUREG_OFFSET(22)( sp )
load_f f23, portFPUREG_OFFSET(23)( sp )
load_f f24, portFPUREG_OFFSET(24)( sp )
load_f f25, portFPUREG_OFFSET(25)( sp )
load_f f26, portFPUREG_OFFSET(26)( sp )
load_f f27, portFPUREG_OFFSET(27)( sp )
load_f f28, portFPUREG_OFFSET(28)( sp )
load_f f29, portFPUREG_OFFSET(29)( sp )
load_f f30, portFPUREG_OFFSET(30)( sp )
load_f f31, portFPUREG_OFFSET(31)( sp )
load_x t0, portFPUREG_OFFSET(32)( sp )
csrw fcsr, t0
1:
.endm
/*-----------------------------------------------------------*/
.macro portcontextSAVE_CONTEXT_INTERNAL
addi sp, sp, -portCONTEXT_SIZE
store_x x1, 1 * portWORD_SIZE( sp )
store_x x5, 2 * portWORD_SIZE( sp )
store_x x6, 3 * portWORD_SIZE( sp )
store_x x7, 4 * portWORD_SIZE( sp )
store_x x8, 5 * portWORD_SIZE( sp )
store_x x9, 6 * portWORD_SIZE( sp )
store_x x10, 7 * portWORD_SIZE( sp )
store_x x11, 8 * portWORD_SIZE( sp )
store_x x12, 9 * portWORD_SIZE( sp )
store_x x13, 10 * portWORD_SIZE( sp )
store_x x14, 11 * portWORD_SIZE( sp )
store_x x15, 12 * portWORD_SIZE( sp )
#ifndef __riscv_32e
store_x x16, 13 * portWORD_SIZE( sp )
store_x x17, 14 * portWORD_SIZE( sp )
store_x x18, 15 * portWORD_SIZE( sp )
store_x x19, 16 * portWORD_SIZE( sp )
store_x x20, 17 * portWORD_SIZE( sp )
store_x x21, 18 * portWORD_SIZE( sp )
store_x x22, 19 * portWORD_SIZE( sp )
store_x x23, 20 * portWORD_SIZE( sp )
store_x x24, 21 * portWORD_SIZE( sp )
store_x x25, 22 * portWORD_SIZE( sp )
store_x x26, 23 * portWORD_SIZE( sp )
store_x x27, 24 * portWORD_SIZE( sp )
store_x x28, 25 * portWORD_SIZE( sp )
store_x x29, 26 * portWORD_SIZE( sp )
store_x x30, 27 * portWORD_SIZE( sp )
store_x x31, 28 * portWORD_SIZE( sp )
#endif /* ifndef __riscv_32e */
load_x t0, xCriticalNesting /* Load the value of xCriticalNesting into t0. */
store_x t0, portCRITICAL_NESTING_OFFSET * portWORD_SIZE( sp ) /* Store the critical nesting value to the stack. */
csrr t0, mstatus /* Required for MPIE bit. */
store_x t0, portMSTATUS_OFFSET * portWORD_SIZE( sp )
#ifdef portasmSTORE_FPU_CONTEXT
portcontexSAVE_FPU_CONTEXT_INTERNAL
#endif /* ifdef portasmSTORE_FPU_CONTEXT */
portasmSAVE_ADDITIONAL_REGISTERS /* Defined in freertos_risc_v_chip_specific_extensions.h to save any registers unique to the RISC-V implementation. */
load_x t0, pxCurrentTCB /* Load pxCurrentTCB. */
store_x sp, 0 ( t0 ) /* Write sp to first TCB member. */
.endm
/*-----------------------------------------------------------*/
.macro portcontextSAVE_EXCEPTION_CONTEXT
portcontextSAVE_CONTEXT_INTERNAL
csrr a0, mcause
csrr a1, mepc
addi a1, a1, 4 /* Synchronous so update exception return address to the instruction after the instruction that generated the exception. */
store_x a1, 0 ( sp ) /* Save updated exception return address. */
load_x sp, xISRStackTop /* Switch to ISR stack. */
.endm
/*-----------------------------------------------------------*/
.macro portcontextSAVE_INTERRUPT_CONTEXT
portcontextSAVE_CONTEXT_INTERNAL
csrr a0, mcause
csrr a1, mepc
store_x a1, 0 ( sp ) /* Asynchronous interrupt so save unmodified exception return address. */
load_x sp, xISRStackTop /* Switch to ISR stack. */
.endm
/*-----------------------------------------------------------*/
.macro portcontextRESTORE_CONTEXT
load_x t1, pxCurrentTCB /* Load pxCurrentTCB. */
load_x sp, 0 ( t1 ) /* Read sp from first TCB member. */
/* Load mepc with the address of the instruction in the task to run next. */
load_x t0, 0 ( sp )
csrw mepc, t0
/* Defined in freertos_risc_v_chip_specific_extensions.h to restore any registers unique to the RISC-V implementation. */
portasmRESTORE_ADDITIONAL_REGISTERS
#ifdef portasmSTORE_FPU_CONTEXT
portasmRESTORE_FPU_CONTEXT_INTERNAL
#endif /* ifdef portasmSTORE_FPU_CONTEXT */
/* Load mstatus with the interrupt enable bits used by the task. */
load_x t0, portMSTATUS_OFFSET * portWORD_SIZE( sp )
csrw mstatus, t0 /* Required for MPIE bit. */
load_x t0, portCRITICAL_NESTING_OFFSET * portWORD_SIZE( sp ) /* Obtain xCriticalNesting value for this task from task's stack. */
load_x t1, pxCriticalNesting /* Load the address of xCriticalNesting into t1. */
store_x t0, 0 ( t1 ) /* Restore the critical nesting value for this task. */
load_x x1, 1 * portWORD_SIZE( sp )
load_x x5, 2 * portWORD_SIZE( sp )
load_x x6, 3 * portWORD_SIZE( sp )
load_x x7, 4 * portWORD_SIZE( sp )
load_x x8, 5 * portWORD_SIZE( sp )
load_x x9, 6 * portWORD_SIZE( sp )
load_x x10, 7 * portWORD_SIZE( sp )
load_x x11, 8 * portWORD_SIZE( sp )
load_x x12, 9 * portWORD_SIZE( sp )
load_x x13, 10 * portWORD_SIZE( sp )
load_x x14, 11 * portWORD_SIZE( sp )
load_x x15, 12 * portWORD_SIZE( sp )
#ifndef __riscv_32e
load_x x16, 13 * portWORD_SIZE( sp )
load_x x17, 14 * portWORD_SIZE( sp )
load_x x18, 15 * portWORD_SIZE( sp )
load_x x19, 16 * portWORD_SIZE( sp )
load_x x20, 17 * portWORD_SIZE( sp )
load_x x21, 18 * portWORD_SIZE( sp )
load_x x22, 19 * portWORD_SIZE( sp )
load_x x23, 20 * portWORD_SIZE( sp )
load_x x24, 21 * portWORD_SIZE( sp )
load_x x25, 22 * portWORD_SIZE( sp )
load_x x26, 23 * portWORD_SIZE( sp )
load_x x27, 24 * portWORD_SIZE( sp )
load_x x28, 25 * portWORD_SIZE( sp )
load_x x29, 26 * portWORD_SIZE( sp )
load_x x30, 27 * portWORD_SIZE( sp )
load_x x31, 28 * portWORD_SIZE( sp )
#endif /* ifndef __riscv_32e */
addi sp, sp, portCONTEXT_SIZE
mret
.endm
/*-----------------------------------------------------------*/
#endif /* PORTCONTEXT_H */