]> begriffs open source - freertos/blob - portable/GCC/ARM_CM0/portmacro.h
RP2040: Fix compiler warning and comment (#509)
[freertos] / portable / GCC / ARM_CM0 / 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
29 #ifndef PORTMACRO_H
30     #define PORTMACRO_H
31
32     #ifdef __cplusplus
33         extern "C" {
34     #endif
35
36 /*-----------------------------------------------------------
37  * Port specific definitions.
38  *
39  * The settings in this file configure FreeRTOS correctly for the
40  * given hardware and compiler.
41  *
42  * These settings should not be altered.
43  *-----------------------------------------------------------
44  */
45
46 /* Type definitions. */
47     #define portCHAR          char
48     #define portFLOAT         float
49     #define portDOUBLE        double
50     #define portLONG          long
51     #define portSHORT         short
52     #define portSTACK_TYPE    uint32_t
53     #define portBASE_TYPE     long
54
55     typedef portSTACK_TYPE   StackType_t;
56     typedef long             BaseType_t;
57     typedef unsigned long    UBaseType_t;
58
59     #if ( configUSE_16_BIT_TICKS == 1 )
60         typedef uint16_t     TickType_t;
61         #define portMAX_DELAY              ( TickType_t ) 0xffff
62     #else
63         typedef uint32_t     TickType_t;
64         #define portMAX_DELAY              ( TickType_t ) 0xffffffffUL
65
66 /* 32-bit tick type on a 32-bit architecture, so reads of the tick count do
67  * not need to be guarded with a critical section. */
68         #define portTICK_TYPE_IS_ATOMIC    1
69     #endif
70 /*-----------------------------------------------------------*/
71
72 /* Architecture specifics. */
73     #define portSTACK_GROWTH      ( -1 )
74     #define portTICK_PERIOD_MS    ( ( TickType_t ) 1000 / configTICK_RATE_HZ )
75     #define portBYTE_ALIGNMENT    8
76     #define portDONT_DISCARD      __attribute__( ( used ) )
77 /*-----------------------------------------------------------*/
78
79
80 /* Scheduler utilities. */
81     extern void vPortYield( void );
82     #define portNVIC_INT_CTRL_REG     ( *( ( volatile uint32_t * ) 0xe000ed04 ) )
83     #define portNVIC_PENDSVSET_BIT    ( 1UL << 28UL )
84     #define portYIELD()                                 vPortYield()
85     #define portEND_SWITCHING_ISR( xSwitchRequired )    if( xSwitchRequired ) portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT
86     #define portYIELD_FROM_ISR( x )                     portEND_SWITCHING_ISR( x )
87 /*-----------------------------------------------------------*/
88
89
90 /* Critical section management. */
91     extern void vPortEnterCritical( void );
92     extern void vPortExitCritical( void );
93     extern uint32_t ulSetInterruptMaskFromISR( void ) __attribute__( ( naked ) );
94     extern void vClearInterruptMaskFromISR( uint32_t ulMask )  __attribute__( ( naked ) );
95
96     #define portSET_INTERRUPT_MASK_FROM_ISR()         ulSetInterruptMaskFromISR()
97     #define portCLEAR_INTERRUPT_MASK_FROM_ISR( x )    vClearInterruptMaskFromISR( x )
98     #define portDISABLE_INTERRUPTS()                  __asm volatile ( " cpsid i " ::: "memory" )
99     #define portENABLE_INTERRUPTS()                   __asm volatile ( " cpsie i " ::: "memory" )
100     #define portENTER_CRITICAL()                      vPortEnterCritical()
101     #define portEXIT_CRITICAL()                       vPortExitCritical()
102
103 /*-----------------------------------------------------------*/
104
105 /* Tickless idle/low power functionality. */
106     #ifndef portSUPPRESS_TICKS_AND_SLEEP
107         extern void vPortSuppressTicksAndSleep( TickType_t xExpectedIdleTime );
108         #define portSUPPRESS_TICKS_AND_SLEEP( xExpectedIdleTime )    vPortSuppressTicksAndSleep( xExpectedIdleTime )
109     #endif
110 /*-----------------------------------------------------------*/
111
112 /* Task function macros as described on the FreeRTOS.org WEB site. */
113     #define portTASK_FUNCTION_PROTO( vFunction, pvParameters )    void vFunction( void * pvParameters )
114     #define portTASK_FUNCTION( vFunction, pvParameters )          void vFunction( void * pvParameters )
115
116     #define portNOP()
117
118     #define portMEMORY_BARRIER()    __asm volatile ( "" ::: "memory" )
119
120     #ifdef __cplusplus
121         }
122     #endif
123
124 #endif /* PORTMACRO_H */