xref: /Kernel-v10.6.2/portable/MPLAB/PIC18F/portmacro.h (revision ef7b253b56c9788077f5ecd6c9deb4021923d646) 
1 /*
2  * FreeRTOS Kernel V10.6.2
3  * Copyright (C) 2021 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
4  *
5  * SPDX-License-Identifier: MIT
6  *
7  * Permission is hereby granted, free of charge, to any person obtaining a copy of
8  * this software and associated documentation files (the "Software"), to deal in
9  * the Software without restriction, including without limitation the rights to
10  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
11  * the Software, and to permit persons to whom the Software is furnished to do so,
12  * subject to the following conditions:
13  *
14  * The above copyright notice and this permission notice shall be included in all
15  * copies or substantial portions of the Software.
16  *
17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
19  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
20  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
21  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
22  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23  *
24  * https://www.FreeRTOS.org
25  * https://github.com/FreeRTOS
26  *
27  */
28 
29 #ifndef PORTMACRO_H
30 #define PORTMACRO_H
31 
32 /*-----------------------------------------------------------
33  * Port specific definitions.
34  *
35  * The settings in this file configure FreeRTOS correctly for the
36  * given hardware and compiler.
37  *
38  * These settings should not be altered.
39  *-----------------------------------------------------------
40  */
41 
42 /* Type definitions. */
43 #define portCHAR        char
44 #define portFLOAT       float
45 #define portDOUBLE      double
46 #define portLONG        long
47 #define portSHORT       int
48 #define portSTACK_TYPE  uint8_t
49 #define portBASE_TYPE   char
50 
51 typedef portSTACK_TYPE StackType_t;
52 typedef signed char BaseType_t;
53 typedef unsigned char UBaseType_t;
54 
55 #if( configTICK_TYPE_WIDTH_IN_BITS == TICK_TYPE_WIDTH_16_BITS )
56     typedef uint16_t TickType_t;
57     #define portMAX_DELAY ( TickType_t ) 0xffff
58 #elif ( configTICK_TYPE_WIDTH_IN_BITS  == TICK_TYPE_WIDTH_32_BITS )
59     typedef uint32_t             TickType_t;
60     #define portMAX_DELAY    ( TickType_t ) 0xffffffffUL
61 #else
62     #error configTICK_TYPE_WIDTH_IN_BITS set to unsupported tick type width.
63 #endif
64 /*-----------------------------------------------------------*/
65 
66 /* Hardware specifics. */
67 #define portBYTE_ALIGNMENT          1
68 #define portGLOBAL_INT_ENABLE_BIT   0x80
69 #define portSTACK_GROWTH            1
70 #define portTICK_PERIOD_MS          ( ( TickType_t ) 1000 / configTICK_RATE_HZ )
71 /*-----------------------------------------------------------*/
72 
73 /* Critical section management. */
74 #define portDISABLE_INTERRUPTS()    INTCONbits.GIEH = 0;
75 #define portENABLE_INTERRUPTS()     INTCONbits.GIEH = 1;
76 
77 /* Push the INTCON register onto the stack, then disable interrupts. */
78 #define portENTER_CRITICAL()        POSTINC1 = INTCON;              \
79                                     INTCONbits.GIEH = 0;
80 
81 /* Retrieve the INTCON register from the stack, and enable interrupts
82 if they were saved as being enabled.  Don't modify any other bits
83 within the INTCON register as these may have lagitimately have been
84 modified within the critical region. */
85 #define portEXIT_CRITICAL()         _asm                                    \
86                                         MOVF    POSTDEC1, 1, 0              \
87                                     _endasm                                 \
88                                     if( INDF1 & portGLOBAL_INT_ENABLE_BIT ) \
89                                     {                                       \
90                                         portENABLE_INTERRUPTS();            \
91                                     }
92 /*-----------------------------------------------------------*/
93 
94 /* Task utilities. */
95 extern void vPortYield( void );
96 #define portYIELD()             vPortYield()
97 /*-----------------------------------------------------------*/
98 
99 /* Task function macros as described on the FreeRTOS.org WEB site. */
100 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void *pvParameters )
101 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void *pvParameters )
102 /*-----------------------------------------------------------*/
103 
104 /* Required by the kernel aware debugger. */
105 #ifdef __DEBUG
106     #define portREMOVE_STATIC_QUALIFIER
107 #endif
108 
109 
110 #define portNOP()               _asm    \
111                                     NOP \
112                                 _endasm
113 
114 #endif /* PORTMACRO_H */
115