ESP32-IDF
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
portable.h
Go to the documentation of this file.
1 /*
2  FreeRTOS V8.2.0 - Copyright (C) 2015 Real Time Engineers Ltd.
3  All rights reserved
4 
5  VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.
6 
7  This file is part of the FreeRTOS distribution.
8 
9  FreeRTOS is free software; you can redistribute it and/or modify it under
10  the terms of the GNU General Public License (version 2) as published by the
11  Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.
12 
13  ***************************************************************************
14  >>! NOTE: The modification to the GPL is included to allow you to !<<
15  >>! distribute a combined work that includes FreeRTOS without being !<<
16  >>! obliged to provide the source code for proprietary components !<<
17  >>! outside of the FreeRTOS kernel. !<<
18  ***************************************************************************
19 
20  FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY
21  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
22  FOR A PARTICULAR PURPOSE. Full license text is available on the following
23  link: http://www.freertos.org/a00114.html
24 
25  ***************************************************************************
26  * *
27  * FreeRTOS provides completely free yet professionally developed, *
28  * robust, strictly quality controlled, supported, and cross *
29  * platform software that is more than just the market leader, it *
30  * is the industry's de facto standard. *
31  * *
32  * Help yourself get started quickly while simultaneously helping *
33  * to support the FreeRTOS project by purchasing a FreeRTOS *
34  * tutorial book, reference manual, or both: *
35  * http://www.FreeRTOS.org/Documentation *
36  * *
37  ***************************************************************************
38 
39  http://www.FreeRTOS.org/FAQHelp.html - Having a problem? Start by reading
40  the FAQ page "My application does not run, what could be wrong?". Have you
41  defined configASSERT()?
42 
43  http://www.FreeRTOS.org/support - In return for receiving this top quality
44  embedded software for free we request you assist our global community by
45  participating in the support forum.
46 
47  http://www.FreeRTOS.org/training - Investing in training allows your team to
48  be as productive as possible as early as possible. Now you can receive
49  FreeRTOS training directly from Richard Barry, CEO of Real Time Engineers
50  Ltd, and the world's leading authority on the world's leading RTOS.
51 
52  http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,
53  including FreeRTOS+Trace - an indispensable productivity tool, a DOS
54  compatible FAT file system, and our tiny thread aware UDP/IP stack.
55 
56  http://www.FreeRTOS.org/labs - Where new FreeRTOS products go to incubate.
57  Come and try FreeRTOS+TCP, our new open source TCP/IP stack for FreeRTOS.
58 
59  http://www.OpenRTOS.com - Real Time Engineers ltd. license FreeRTOS to High
60  Integrity Systems ltd. to sell under the OpenRTOS brand. Low cost OpenRTOS
61  licenses offer ticketed support, indemnification and commercial middleware.
62 
63  http://www.SafeRTOS.com - High Integrity Systems also provide a safety
64  engineered and independently SIL3 certified version for use in safety and
65  mission critical applications that require provable dependability.
66 
67  1 tab == 4 spaces!
68 */
69 
70 /*-----------------------------------------------------------
71  * Portable layer API. Each function must be defined for each port.
72  *----------------------------------------------------------*/
73 
74 #ifndef PORTABLE_H
75 #define PORTABLE_H
76 
77 /* Each FreeRTOS port has a unique portmacro.h header file. Originally a
78 pre-processor definition was used to ensure the pre-processor found the correct
79 portmacro.h file for the port being used. That scheme was deprecated in favour
80 of setting the compiler's include path such that it found the correct
81 portmacro.h file - removing the need for the constant and allowing the
82 portmacro.h file to be located anywhere in relation to the port being used.
83 Purely for reasons of backward compatibility the old method is still valid, but
84 to make it clear that new projects should not use it, support for the port
85 specific constants has been moved into the deprecated_definitions.h header
86 file. */
87 #include "deprecated_definitions.h"
88 
89 /* If portENTER_CRITICAL is not defined then including deprecated_definitions.h
90 did not result in a portmacro.h header file being included - and it should be
91 included here. In this case the path to the correct portmacro.h header file
92 must be set in the compiler's include path. */
93 #ifndef portENTER_CRITICAL
94  #include "portmacro.h"
95 #endif
96 
97 #if portBYTE_ALIGNMENT == 8
98  #define portBYTE_ALIGNMENT_MASK ( 0x0007U )
99 #endif
100 
101 #if portBYTE_ALIGNMENT == 4
102  #define portBYTE_ALIGNMENT_MASK ( 0x0003 )
103 #endif
104 
105 #if portBYTE_ALIGNMENT == 2
106  #define portBYTE_ALIGNMENT_MASK ( 0x0001 )
107 #endif
108 
109 #if portBYTE_ALIGNMENT == 1
110  #define portBYTE_ALIGNMENT_MASK ( 0x0000 )
111 #endif
112 
113 #ifndef portBYTE_ALIGNMENT_MASK
114  #error "Invalid portBYTE_ALIGNMENT definition"
115 #endif
116 
117 #ifndef portNUM_CONFIGURABLE_REGIONS
118  #define portNUM_CONFIGURABLE_REGIONS 1
119 #endif
120 
121 #ifdef __cplusplus
122 extern "C" {
123 #endif
124 
125 #include "mpu_wrappers.h"
126 
127 /*
128  * Setup the stack of a new task so it is ready to be placed under the
129  * scheduler control. The registers have to be placed on the stack in
130  * the order that the port expects to find them.
131  *
132  */
133 #if( portUSING_MPU_WRAPPERS == 1 )
134  StackType_t *pxPortInitialiseStack( StackType_t *pxTopOfStack, TaskFunction_t pxCode, void *pvParameters, BaseType_t xRunPrivileged ) PRIVILEGED_FUNCTION;
135 #else
136  StackType_t *pxPortInitialiseStack( StackType_t *pxTopOfStack, TaskFunction_t pxCode, void *pvParameters ) PRIVILEGED_FUNCTION;
137 #endif
138 
139 /* Used by heap_5.c. */
140 typedef struct HeapRegion
141 {
143  size_t xSizeInBytes;
144 } HeapRegion_t;
145 
146 /*
147  * Used to define multiple heap regions for use by heap_5.c. This function
148  * must be called before any calls to pvPortMalloc() - not creating a task,
149  * queue, semaphore, mutex, software timer, event group, etc. will result in
150  * pvPortMalloc being called.
151  *
152  * pxHeapRegions passes in an array of HeapRegion_t structures - each of which
153  * defines a region of memory that can be used as the heap. The array is
154  * terminated by a HeapRegions_t structure that has a size of 0. The region
155  * with the lowest start address must appear first in the array.
156  */
157 void vPortDefineHeapRegions( const HeapRegion_t * const pxHeapRegions );
158 
159 
160 /*
161  * Map to the memory management routines required for the port.
162  */
163 void *pvPortMalloc( size_t xSize ) PRIVILEGED_FUNCTION;
164 void vPortFree( void *pv ) PRIVILEGED_FUNCTION;
165 void vPortInitialiseBlocks( void ) PRIVILEGED_FUNCTION;
166 size_t xPortGetFreeHeapSize( void ) PRIVILEGED_FUNCTION;
167 size_t xPortGetMinimumEverFreeHeapSize( void ) PRIVILEGED_FUNCTION;
168 
169 /*
170  * Setup the hardware ready for the scheduler to take control. This generally
171  * sets up a tick interrupt and sets timers for the correct tick frequency.
172  */
173 BaseType_t xPortStartScheduler( void ) PRIVILEGED_FUNCTION;
174 
175 /*
176  * Undo any hardware/ISR setup that was performed by xPortStartScheduler() so
177  * the hardware is left in its original condition after the scheduler stops
178  * executing.
179  */
180 void vPortEndScheduler( void ) PRIVILEGED_FUNCTION;
181 
182 /*
183  * The structures and methods of manipulating the MPU are contained within the
184  * port layer.
185  *
186  * Fills the xMPUSettings structure with the memory region information
187  * contained in xRegions.
188  */
189 #if( portUSING_MPU_WRAPPERS == 1 )
190  struct xMEMORY_REGION;
191  void vPortStoreTaskMPUSettings( xMPU_SETTINGS *xMPUSettings, const struct xMEMORY_REGION * const xRegions, StackType_t *pxBottomOfStack, uint16_t usStackDepth ) PRIVILEGED_FUNCTION;
192 #endif
193 
194 /* Multi-core: get current core ID */
195 int xPortGetCoreID( void );
196 
197 
198 #ifdef __cplusplus
199 }
200 #endif
201 
202 #endif /* PORTABLE_H */
203 
void vPortFree(void *pv) PRIVILEGED_FUNCTION
Definition: heap_regions.c:357
size_t xPortGetMinimumEverFreeHeapSize(void) PRIVILEGED_FUNCTION
Definition: heap_regions.c:420
Definition: portable.h:140
void * pvPortMalloc(size_t xSize) PRIVILEGED_FUNCTION
Definition: heap_alloc_caps.c:224
Definition: portmacro.h:255
__uint16_t uint16_t
Definition: stdint.h:33
void vPortEndScheduler(void) PRIVILEGED_FUNCTION
Definition: port.c:185
BaseType_t xPortStartScheduler(void) PRIVILEGED_FUNCTION
Definition: port.c:193
StackType_t * pxPortInitialiseStack(StackType_t *pxTopOfStack, TaskFunction_t pxCode, void *pvParameters) PRIVILEGED_FUNCTION
Definition: port.c:129
size_t xPortGetFreeHeapSize(void) PRIVILEGED_FUNCTION
Definition: heap_regions.c:414
size_t xSizeInBytes
Definition: portable.h:143
Definition: task.h:148
struct HeapRegion HeapRegion_t
uint8_t * pucStartAddress
Definition: portable.h:142
int xPortGetCoreID(void)
void(* TaskFunction_t)(void *)
Definition: projdefs.h:77
void vPortDefineHeapRegions(const HeapRegion_t *const pxHeapRegions)
#define PRIVILEGED_FUNCTION
Definition: mpu_wrappers.h:149
void vPortInitialiseBlocks(void) PRIVILEGED_FUNCTION
portBASE_TYPE BaseType_t
Definition: portmacro.h:106
__uint8_t uint8_t
Definition: stdint.h:21
portSTACK_TYPE StackType_t
Definition: portmacro.h:105