]> begriffs open source - freertos/blob - portable/MPLAB/PIC24_dsPIC/portmacro.h
[AUTO][RELEASE]: Bump file header version to "10.5.1"
[freertos] / portable / MPLAB / PIC24_dsPIC / portmacro.h
1 /*\r
2  * FreeRTOS Kernel V10.5.1\r
3  * Copyright (C) 2021 Amazon.com, Inc. or its affiliates.  All Rights Reserved.\r
4  *\r
5  * SPDX-License-Identifier: MIT\r
6  *\r
7  * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
8  * this software and associated documentation files (the "Software"), to deal in\r
9  * the Software without restriction, including without limitation the rights to\r
10  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
11  * the Software, and to permit persons to whom the Software is furnished to do so,\r
12  * subject to the following conditions:\r
13  *\r
14  * The above copyright notice and this permission notice shall be included in all\r
15  * copies or substantial portions of the Software.\r
16  *\r
17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
19  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
20  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
21  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
22  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
23  *\r
24  * https://www.FreeRTOS.org\r
25  * https://github.com/FreeRTOS\r
26  *\r
27  */\r
28 \r
29 #ifndef PORTMACRO_H\r
30 #define PORTMACRO_H\r
31 \r
32 #ifdef __cplusplus\r
33 extern "C" {\r
34 #endif\r
35 \r
36 /*-----------------------------------------------------------\r
37  * Port specific definitions.\r
38  *\r
39  * The settings in this file configure FreeRTOS correctly for the\r
40  * given hardware and compiler.\r
41  *\r
42  * These settings should not be altered.\r
43  *-----------------------------------------------------------\r
44  */\r
45 \r
46 /* Type definitions. */\r
47 #define portCHAR                char\r
48 #define portFLOAT               float\r
49 #define portDOUBLE              double\r
50 #define portLONG                long\r
51 #define portSHORT               short\r
52 #define portSTACK_TYPE  uint16_t\r
53 #define portBASE_TYPE   short\r
54 \r
55 typedef portSTACK_TYPE StackType_t;\r
56 typedef short BaseType_t;\r
57 typedef unsigned short UBaseType_t;\r
58 \r
59 #if( configUSE_16_BIT_TICKS == 1 )\r
60         typedef uint16_t TickType_t;\r
61         #define portMAX_DELAY ( TickType_t ) 0xffff\r
62 /* 16-bit tick type on a 16-bit architecture, so reads of the tick count do\r
63  * not need to be guarded with a critical section. */\r
64         #define portTICK_TYPE_IS_ATOMIC 1\r
65 #else\r
66         typedef uint32_t TickType_t;\r
67         #define portMAX_DELAY ( TickType_t ) 0xffffffffUL\r
68 #endif\r
69 /*-----------------------------------------------------------*/\r
70 \r
71 /* Hardware specifics. */\r
72 #define portBYTE_ALIGNMENT                      2\r
73 #define portSTACK_GROWTH                        1\r
74 #define portTICK_PERIOD_MS                      ( ( TickType_t ) 1000 / configTICK_RATE_HZ )\r
75 /*-----------------------------------------------------------*/\r
76 \r
77 /* Critical section management. */\r
78 #define portDISABLE_INTERRUPTS()        SET_CPU_IPL( configKERNEL_INTERRUPT_PRIORITY ); __asm volatile ( "NOP" )\r
79 #define portENABLE_INTERRUPTS()         SET_CPU_IPL( 0 )\r
80 \r
81 /* Note that exiting a critical sectino will set the IPL bits to 0, nomatter\r
82 what their value was prior to entering the critical section. */\r
83 extern void vPortEnterCritical( void );\r
84 extern void vPortExitCritical( void );\r
85 #define portENTER_CRITICAL()            vPortEnterCritical()\r
86 #define portEXIT_CRITICAL()                     vPortExitCritical()\r
87 /*-----------------------------------------------------------*/\r
88 \r
89 /* Task utilities. */\r
90 extern void vPortYield( void );\r
91 #define portYIELD()                             asm volatile ( "CALL _vPortYield                        \n"             \\r
92                                                                                                 "NOP                                      " );\r
93 /*-----------------------------------------------------------*/\r
94 \r
95 /* Task function macros as described on the FreeRTOS.org WEB site. */\r
96 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
97 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
98 /*-----------------------------------------------------------*/\r
99 \r
100 /* Required by the kernel aware debugger. */\r
101 #ifdef __DEBUG\r
102         #define portREMOVE_STATIC_QUALIFIER\r
103 #endif\r
104 \r
105 #define portNOP()                               asm volatile ( "NOP" )\r
106 \r
107 #ifdef __cplusplus\r
108 }\r
109 #endif\r
110 \r
111 #endif /* PORTMACRO_H */\r
112 \r