]> begriffs open source - cmsis-freertos/blob - Source/portable/MPLAB/PIC18F/portmacro.h
Initial commit
[cmsis-freertos] / Source / portable / MPLAB / PIC18F / portmacro.h
1 /*
2     FreeRTOS V9.0.0 - Copyright (C) 2016 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 #ifndef PORTMACRO_H
71 #define PORTMACRO_H
72
73 /*-----------------------------------------------------------
74  * Port specific definitions.
75  *
76  * The settings in this file configure FreeRTOS correctly for the
77  * given hardware and compiler.
78  *
79  * These settings should not be altered.
80  *-----------------------------------------------------------
81  */
82
83 /* Type definitions. */
84 #define portCHAR                char
85 #define portFLOAT               float
86 #define portDOUBLE              double
87 #define portLONG                long
88 #define portSHORT               int
89 #define portSTACK_TYPE  uint8_t
90 #define portBASE_TYPE   char
91
92 typedef portSTACK_TYPE StackType_t;
93 typedef signed char BaseType_t;
94 typedef unsigned char UBaseType_t;
95
96 #if( configUSE_16_BIT_TICKS == 1 )
97         typedef uint16_t TickType_t;
98         #define portMAX_DELAY ( TickType_t ) 0xffff
99 #else
100         typedef uint32_t TickType_t;
101         #define portMAX_DELAY ( TickType_t ) 0xffffffffUL
102 #endif
103 /*-----------------------------------------------------------*/
104
105 /* Hardware specifics. */
106 #define portBYTE_ALIGNMENT                      1
107 #define portGLOBAL_INT_ENABLE_BIT       0x80
108 #define portSTACK_GROWTH                        1
109 #define portTICK_PERIOD_MS                      ( ( TickType_t ) 1000 / configTICK_RATE_HZ )
110 /*-----------------------------------------------------------*/
111
112 /* Critical section management. */
113 #define portDISABLE_INTERRUPTS()        INTCONbits.GIEH = 0;
114 #define portENABLE_INTERRUPTS()         INTCONbits.GIEH = 1;
115
116 /* Push the INTCON register onto the stack, then disable interrupts. */
117 #define portENTER_CRITICAL()            POSTINC1 = INTCON;                              \
118                                                                         INTCONbits.GIEH = 0;
119
120 /* Retrieve the INTCON register from the stack, and enable interrupts
121 if they were saved as being enabled.  Don't modify any other bits
122 within the INTCON register as these may have lagitimately have been
123 modified within the critical region. */
124 #define portEXIT_CRITICAL()                     _asm                                                                    \
125                                                                                 MOVF    POSTDEC1, 1, 0                          \
126                                                                         _endasm                                                                 \
127                                                                         if( INDF1 & portGLOBAL_INT_ENABLE_BIT ) \
128                                                                         {                                                                               \
129                                                                                 portENABLE_INTERRUPTS();                        \
130                                                                         }
131 /*-----------------------------------------------------------*/
132
133 /* Task utilities. */
134 extern void vPortYield( void );
135 #define portYIELD()                             vPortYield()
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
143 /* Required by the kernel aware debugger. */
144 #ifdef __DEBUG
145         #define portREMOVE_STATIC_QUALIFIER
146 #endif
147
148
149 #define portNOP()                               _asm    \
150                                                                         NOP \
151                                                                 _endasm
152
153 #endif /* PORTMACRO_H */
154