begriffs open source - freertos/blob - portable/ThirdParty/GCC/rpi_pico/portmacro.h

   1 /*
   2  * FreeRTOS SMP Kernel V202110.00
   3  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining a copy of
   6  * this software and associated documentation files (the "Software"), to deal in
   7  * the Software without restriction, including without limitation the rights to
   8  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
   9  * the Software, and to permit persons to whom the Software is furnished to do so,
  10  * subject to the following conditions:
  11  *
  12  * The above copyright notice and this permission notice shall be included in all
  13  * copies or substantial portions of the Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
  17  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
  18  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
  19  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  20  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  21  *
  22  * https://www.FreeRTOS.org
  23  * https://github.com/FreeRTOS
  24  *
  25  * 1 tab == 4 spaces!
  26  */
  27
  28 // TODO Guard this so it only arrives with the PICO
  29 #include "pico_support.h"
  30
  31 #ifndef PORTMACRO_H
  32     #define PORTMACRO_H
  33
  34     #ifdef __cplusplus
  35         extern "C" {
  36     #endif
  37
  38 /*-----------------------------------------------------------
  39  * Port specific definitions.
  40  *
  41  * The settings in this file configure FreeRTOS correctly for the
  42  * given hardware and compiler.
  43  *
  44  * These settings should not be altered.
  45  *-----------------------------------------------------------
  46  */
  47
  48 /* Type definitions. */
  49     #define portCHAR          char
  50     #define portFLOAT         float
  51     #define portDOUBLE        double
  52     #define portLONG          long
  53     #define portSHORT         short
  54     #define portSTACK_TYPE    uint32_t
  55     #define portBASE_TYPE     long
  56
  57     typedef portSTACK_TYPE   StackType_t;
  58     typedef long             BaseType_t;
  59     typedef unsigned long    UBaseType_t;
  60
  61     #if ( configUSE_16_BIT_TICKS == 1 )
  62         typedef uint16_t     TickType_t;
  63         #define portMAX_DELAY              ( TickType_t ) 0xffff
  64     #else
  65         typedef uint32_t     TickType_t;
  66         #define portMAX_DELAY              ( TickType_t ) 0xffffffffUL
  67
  68 /* 32-bit tick type on a 32-bit architecture, so reads of the tick count do
  69  * not need to be guarded with a critical section. */
  70         #define portTICK_TYPE_IS_ATOMIC    1
  71     #endif
  72 /*-----------------------------------------------------------*/
  73
  74 /* Architecture specifics. */
  75     #define portSTACK_GROWTH      ( -1 )
  76     #define portTICK_PERIOD_MS    ( ( TickType_t ) 1000 / configTICK_RATE_HZ )
  77     #define portBYTE_ALIGNMENT    8
  78     #define portDONT_DISCARD      __attribute__( ( used ) )
  79
  80     // TODO SMP this is in tasks.c & the xmos port
  81     #define portCRITICAL_NESTING_IN_TCB   1
  82
  83 /*-----------------------------------------------------------*/
  84
  85
  86 /* Scheduler utilities. */
  87     extern void vPortYield( void );
  88     #define portNVIC_INT_CTRL_REG     ( *( ( volatile uint32_t * ) 0xe000ed04 ) )
  89     #define portNVIC_PENDSVSET_BIT    ( 1UL << 28UL )
  90     #define portYIELD()                                 vPortYield()
  91     #define portEND_SWITCHING_ISR( xSwitchRequired )    if( xSwitchRequired ) portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT
  92     #define portYIELD_FROM_ISR( x )                     portEND_SWITCHING_ISR( x )
  93 /*-----------------------------------------------------------*/
  94
  95 /* SMP utilities */
  96     #define portGET_CORE_ID() (portSIE_CPUID)
  97 // TODO SMP Implement this
  98     #define portYIELD_CORE(a)
  99
 100 // TODO SMP NEW.  Restore the maskable interrupt state to the valued provided.
 101     #define portRESTORE_INTERRUPTS(ulState)
 102
 103 // TODO SMP NEW. Return a true if we are currently in an ISR and false if we are NOT in an ISR.
 104     #define portCHECK_IF_IN_ISR() (pdFALSE)
 105 /*-----------------------------------------------------------*/
 106
 107 /* Critical section management. */
 108     extern void vPortEnterCritical( void );
 109     extern void vPortExitCritical( void );
 110     extern uint32_t ulSetInterruptMaskFromISR( void ) __attribute__( ( naked ) );
 111     extern void vClearInterruptMaskFromISR( uint32_t ulMask )  __attribute__( ( naked ) );
 112
 113     #define portSET_INTERRUPT_MASK_FROM_ISR()         ulSetInterruptMaskFromISR()
 114     #define portCLEAR_INTERRUPT_MASK_FROM_ISR( x )    vClearInterruptMaskFromISR( x )
 115     // TODO SMP XMOS modified DISABLE_INTERRUPTS to return a value
 116     #define portDISABLE_INTERRUPTS()                  ({ __asm volatile ( " cpsid i " ::: "memory" ); 0;})
 117     #define portENABLE_INTERRUPTS()                   __asm volatile ( " cpsie i " ::: "memory" )
 118     #define portENTER_CRITICAL()                      vPortEnterCritical()
 119     #define portEXIT_CRITICAL()                       vPortExitCritical()
 120
 121 /* PICO port will use the HW spinlocks for these */
 122 /* Read Page 32 of the RP2040 datasheet to see how the spinlocks wrok */
 123 /* using SPINLOCK0 for the ISR & SPINLOCK1 for the task */
 124 #define portGET_ISR_LOCK()      do{ while(!portSIE_SPINLOCK0); }while(0)
 125 #define portRELEASE_ISR_LOCK()  do{ portSIE_SPINLOCK0 = 1; }while(0)
 126 #define portGET_TASK_LOCK()     do{ while(!portSIE_SPINLOCK1); }while(0)
 127 #define portRELEASE_TASK_LOCK() do{ portSIE_SPINLOCK1 = 1; }while(0)
 128
 129 /*-----------------------------------------------------------*/
 130
 131 /* Tickless idle/low power functionality. */
 132     #ifndef portSUPPRESS_TICKS_AND_SLEEP
 133         extern void vPortSuppressTicksAndSleep( TickType_t xExpectedIdleTime );
 134         #define portSUPPRESS_TICKS_AND_SLEEP( xExpectedIdleTime )    vPortSuppressTicksAndSleep( xExpectedIdleTime )
 135     #endif
 136 /*-----------------------------------------------------------*/
 137
 138 /* Task function macros as described on the FreeRTOS.org WEB site. */
 139     #define portTASK_FUNCTION_PROTO( vFunction, pvParameters )    void vFunction( void * pvParameters )
 140     #define portTASK_FUNCTION( vFunction, pvParameters )          void vFunction( void * pvParameters )
 141
 142     #define portNOP()
 143
 144     #define portMEMORY_BARRIER()    __asm volatile ( "" ::: "memory" )
 145
 146     #ifdef __cplusplus
 147         }
 148     #endif
 149
 150 #endif /* PORTMACRO_H */