mirror of
				https://github.com/FreeRTOS/FreeRTOS-Kernel.git
				synced 2025-11-04 11:09:01 +01:00 
			
		
		
		
	
		
			
				
	
	
		
			254 lines
		
	
	
		
			9.6 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
			
		
		
	
	
			254 lines
		
	
	
		
			9.6 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 PORTMACRO_H
 | 
						|
#define PORTMACRO_H
 | 
						|
 | 
						|
/* *INDENT-OFF* */
 | 
						|
#ifdef __cplusplus
 | 
						|
    extern "C" {
 | 
						|
#endif
 | 
						|
/* *INDENT-ON* */
 | 
						|
 | 
						|
/*-----------------------------------------------------------
 | 
						|
 * Port specific definitions.
 | 
						|
 *
 | 
						|
 * The settings in this file configure FreeRTOS correctly for the
 | 
						|
 * given hardware and compiler.
 | 
						|
 *
 | 
						|
 * These settings should not be altered.
 | 
						|
 *-----------------------------------------------------------
 | 
						|
 */
 | 
						|
 | 
						|
/* Type definitions. */
 | 
						|
#define portCHAR          char
 | 
						|
#define portFLOAT         float
 | 
						|
#define portDOUBLE        double
 | 
						|
#define portLONG          long
 | 
						|
#define portSHORT         short
 | 
						|
#define portSTACK_TYPE    uint8_t
 | 
						|
#define portBASE_TYPE     char
 | 
						|
 | 
						|
typedef portSTACK_TYPE   StackType_t;
 | 
						|
typedef signed char      BaseType_t;
 | 
						|
typedef unsigned char    UBaseType_t;
 | 
						|
 | 
						|
 | 
						|
#if ( configTICK_TYPE_WIDTH_IN_BITS == TICK_TYPE_WIDTH_16_BITS )
 | 
						|
    typedef uint16_t     TickType_t;
 | 
						|
    #define portMAX_DELAY    ( TickType_t ) 0xffff
 | 
						|
#elif ( configTICK_TYPE_WIDTH_IN_BITS == TICK_TYPE_WIDTH_32_BITS )
 | 
						|
    typedef uint32_t     TickType_t;
 | 
						|
    #define portMAX_DELAY    ( TickType_t ) ( 0xFFFFFFFFUL )
 | 
						|
#else
 | 
						|
    #error configTICK_TYPE_WIDTH_IN_BITS set to unsupported tick type width.
 | 
						|
#endif
 | 
						|
/*-----------------------------------------------------------*/
 | 
						|
 | 
						|
/* Hardware specifics. */
 | 
						|
#define portBYTE_ALIGNMENT    1
 | 
						|
#define portSTACK_GROWTH      ( -1 )
 | 
						|
#define portTICK_PERIOD_MS    ( ( TickType_t ) 1000 / configTICK_RATE_HZ )
 | 
						|
#define portYIELD()    __asm( "swi" );
 | 
						|
/*-----------------------------------------------------------*/
 | 
						|
 | 
						|
/* Critical section handling. */
 | 
						|
#define portENABLE_INTERRUPTS()     __asm( "cli" )
 | 
						|
#define portDISABLE_INTERRUPTS()    __asm( "sei" )
 | 
						|
 | 
						|
/*
 | 
						|
 * Disable interrupts before incrementing the count of critical section nesting.
 | 
						|
 * The nesting count is maintained so we know when interrupts should be
 | 
						|
 * re-enabled.  Once interrupts are disabled the nesting count can be accessed
 | 
						|
 * directly.  Each task maintains its own nesting count.
 | 
						|
 */
 | 
						|
#define portENTER_CRITICAL()                           \
 | 
						|
    {                                                  \
 | 
						|
        extern volatile UBaseType_t uxCriticalNesting; \
 | 
						|
                                                       \
 | 
						|
        portDISABLE_INTERRUPTS();                      \
 | 
						|
        uxCriticalNesting++;                           \
 | 
						|
    }
 | 
						|
 | 
						|
/*
 | 
						|
 * Interrupts are disabled so we can access the nesting count directly.  If the
 | 
						|
 * nesting is found to be 0 (no nesting) then we are leaving the critical
 | 
						|
 * section and interrupts can be re-enabled.
 | 
						|
 */
 | 
						|
#define  portEXIT_CRITICAL()                           \
 | 
						|
    {                                                  \
 | 
						|
        extern volatile UBaseType_t uxCriticalNesting; \
 | 
						|
                                                       \
 | 
						|
        uxCriticalNesting--;                           \
 | 
						|
        if( uxCriticalNesting == 0 )                   \
 | 
						|
        {                                              \
 | 
						|
            portENABLE_INTERRUPTS();                   \
 | 
						|
        }                                              \
 | 
						|
    }
 | 
						|
/*-----------------------------------------------------------*/
 | 
						|
 | 
						|
/* Task utilities. */
 | 
						|
 | 
						|
/*
 | 
						|
 * These macros are very simple as the processor automatically saves and
 | 
						|
 * restores its registers as interrupts are entered and exited.  In
 | 
						|
 * addition to the (automatically stacked) registers we also stack the
 | 
						|
 * critical nesting count.  Each task maintains its own critical nesting
 | 
						|
 * count as it is legitimate for a task to yield from within a critical
 | 
						|
 * section.  If the banked memory model is being used then the PPAGE
 | 
						|
 * register is also stored as part of the tasks context.
 | 
						|
 */
 | 
						|
 | 
						|
#ifdef BANKED_MODEL
 | 
						|
 | 
						|
/*
 | 
						|
 * Load the stack pointer for the task, then pull the critical nesting
 | 
						|
 * count and PPAGE register from the stack.  The remains of the
 | 
						|
 * context are restored by the RTI instruction.
 | 
						|
 */
 | 
						|
    #define portRESTORE_CONTEXT() \
 | 
						|
    {                             \
 | 
						|
        __asm( "                                \n\
 | 
						|
        .globl pxCurrentTCB         ; void *            \n\
 | 
						|
        .globl uxCriticalNesting        ; char              \n\
 | 
						|
                                            \n\
 | 
						|
        ldx  pxCurrentTCB                           \n\
 | 
						|
        lds  0,x                ; Stack             \n\
 | 
						|
                                            \n\
 | 
						|
        movb 1,sp+,uxCriticalNesting                        \n\
 | 
						|
        movb 1,sp+,0x30             ; PPAGE             \n\
 | 
						|
        " );                      \
 | 
						|
    }
 | 
						|
 | 
						|
/*
 | 
						|
 * By the time this macro is called the processor has already stacked the
 | 
						|
 * registers.  Simply stack the nesting count and PPAGE value, then save
 | 
						|
 * the task stack pointer.
 | 
						|
 */
 | 
						|
    #define portSAVE_CONTEXT() \
 | 
						|
    {                          \
 | 
						|
        __asm( "                                \n\
 | 
						|
        .globl pxCurrentTCB         ; void *            \n\
 | 
						|
        .globl uxCriticalNesting        ; char              \n\
 | 
						|
                                            \n\
 | 
						|
        movb 0x30, 1,-sp            ; PPAGE             \n\
 | 
						|
        movb uxCriticalNesting, 1,-sp                       \n\
 | 
						|
                                            \n\
 | 
						|
        ldx  pxCurrentTCB                           \n\
 | 
						|
        sts  0,x                ; Stack             \n\
 | 
						|
        " );                   \
 | 
						|
    }
 | 
						|
#else /* ifdef BANKED_MODEL */
 | 
						|
 | 
						|
/*
 | 
						|
 * These macros are as per the BANKED versions above, but without saving
 | 
						|
 * and restoring the PPAGE register.
 | 
						|
 */
 | 
						|
 | 
						|
    #define portRESTORE_CONTEXT() \
 | 
						|
    {                             \
 | 
						|
        __asm( "                                \n\
 | 
						|
        .globl pxCurrentTCB         ; void *            \n\
 | 
						|
        .globl uxCriticalNesting        ; char              \n\
 | 
						|
                                            \n\
 | 
						|
        ldx  pxCurrentTCB                           \n\
 | 
						|
        lds  0,x                ; Stack             \n\
 | 
						|
                                            \n\
 | 
						|
        movb 1,sp+,uxCriticalNesting                        \n\
 | 
						|
        " );                      \
 | 
						|
    }
 | 
						|
 | 
						|
    #define portSAVE_CONTEXT() \
 | 
						|
    {                          \
 | 
						|
        __asm( "                                \n\
 | 
						|
        .globl pxCurrentTCB         ; void *            \n\
 | 
						|
        .globl uxCriticalNesting        ; char              \n\
 | 
						|
                                            \n\
 | 
						|
        movb uxCriticalNesting, 1,-sp                       \n\
 | 
						|
                                            \n\
 | 
						|
        ldx  pxCurrentTCB                           \n\
 | 
						|
        sts  0,x                ; Stack             \n\
 | 
						|
        " );                   \
 | 
						|
    }
 | 
						|
#endif /* ifdef BANKED_MODEL */
 | 
						|
 | 
						|
/*
 | 
						|
 * Utility macros to save/restore correct software registers for GCC. This is
 | 
						|
 * useful when GCC does not generate appropriate ISR head/tail code.
 | 
						|
 */
 | 
						|
#define portISR_HEAD() \
 | 
						|
    {                  \
 | 
						|
        __asm( "                                 \n\
 | 
						|
        movw _.frame, 2,-sp                         \n\
 | 
						|
        movw _.tmp, 2,-sp                           \n\
 | 
						|
        movw _.z, 2,-sp                             \n\
 | 
						|
        movw _.xy, 2,-sp                            \n\
 | 
						|
        ;movw _.d2, 2,-sp                           \n\
 | 
						|
        ;movw _.d1, 2,-sp                           \n\
 | 
						|
        " );           \
 | 
						|
    }
 | 
						|
 | 
						|
#define portISR_TAIL() \
 | 
						|
    {                  \
 | 
						|
        __asm( "                                 \n\
 | 
						|
        movw 2,sp+, _.xy                            \n\
 | 
						|
        movw 2,sp+, _.z                             \n\
 | 
						|
        movw 2,sp+, _.tmp                           \n\
 | 
						|
        movw 2,sp+, _.frame                         \n\
 | 
						|
        ;movw 2,sp+, _.d1                           \n\
 | 
						|
        ;movw 2,sp+, _.d2                           \n\
 | 
						|
        rti                                 \n\
 | 
						|
        " );           \
 | 
						|
    }
 | 
						|
 | 
						|
/*
 | 
						|
 * Utility macro to call macros above in correct order in order to perform a
 | 
						|
 * task switch from within a standard ISR.  This macro can only be used if
 | 
						|
 * the ISR does not use any local (stack) variables.  If the ISR uses stack
 | 
						|
 * variables portYIELD() should be used in it's place.
 | 
						|
 */
 | 
						|
 | 
						|
#define portTASK_SWITCH_FROM_ISR() \
 | 
						|
    portSAVE_CONTEXT();            \
 | 
						|
    vTaskSwitchContext();          \
 | 
						|
    portRESTORE_CONTEXT();
 | 
						|
 | 
						|
 | 
						|
/* Task function macros as described on the FreeRTOS.org WEB site. */
 | 
						|
#define portTASK_FUNCTION_PROTO( vFunction, pvParameters )    void vFunction( void * pvParameters )
 | 
						|
#define portTASK_FUNCTION( vFunction, pvParameters )          void vFunction( void * pvParameters )
 | 
						|
 | 
						|
/* *INDENT-OFF* */
 | 
						|
#ifdef __cplusplus
 | 
						|
    }
 | 
						|
#endif
 | 
						|
/* *INDENT-ON* */
 | 
						|
 | 
						|
#endif /* PORTMACRO_H */
 |