xref: /Kernel-v10.6.2/portable/GCC/PPC440_Xilinx/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 #include "xexception_l.h"
33 
34 /* *INDENT-OFF* */
35 #ifdef __cplusplus
36     extern "C" {
37 #endif
38 /* *INDENT-ON* */
39 
40 /*-----------------------------------------------------------
41  * Port specific definitions.
42  *
43  * The settings in this file configure FreeRTOS correctly for the
44  * given hardware and compiler.
45  *
46  * These settings should not be altered.
47  *-----------------------------------------------------------
48  */
49 
50 /* Type definitions. */
51 #define portCHAR        char
52 #define portFLOAT       float
53 #define portDOUBLE      double
54 #define portLONG        long
55 #define portSHORT       short
56 #define portSTACK_TYPE  uint32_t
57 #define portBASE_TYPE   long
58 
59 typedef portSTACK_TYPE StackType_t;
60 typedef long BaseType_t;
61 typedef unsigned long UBaseType_t;
62 
63 #if( configTICK_TYPE_WIDTH_IN_BITS == TICK_TYPE_WIDTH_16_BITS )
64     typedef uint16_t TickType_t;
65     #define portMAX_DELAY ( TickType_t ) 0xffff
66 #elif ( configTICK_TYPE_WIDTH_IN_BITS == TICK_TYPE_WIDTH_32_BITS )
67     typedef uint32_t TickType_t;
68     #define portMAX_DELAY ( TickType_t )    ( 0xFFFFFFFFUL )
69 #else
70     #error configTICK_TYPE_WIDTH_IN_BITS set to unsupported tick type width.
71 #endif
72 /*-----------------------------------------------------------*/
73 
74 /* This port uses the critical nesting count from the TCB rather than
75 maintaining a separate value and then saving this value in the task stack. */
76 #define portCRITICAL_NESTING_IN_TCB     1
77 
78 /* Interrupt control macros. */
79 #define portDISABLE_INTERRUPTS()        XExc_mDisableExceptions( XEXC_NON_CRITICAL );
80 #define portENABLE_INTERRUPTS()         XExc_mEnableExceptions( XEXC_NON_CRITICAL );
81 
82 /*-----------------------------------------------------------*/
83 
84 /* Critical section macros. */
85 void vTaskEnterCritical( void );
86 void vTaskExitCritical( void );
87 #define portENTER_CRITICAL()            vTaskEnterCritical()
88 #define portEXIT_CRITICAL()             vTaskExitCritical()
89 
90 /*-----------------------------------------------------------*/
91 
92 /* Task utilities. */
93 void vPortYield( void );
94 #define portYIELD() asm volatile ( "SC \n\t NOP" )
95 #define portYIELD_FROM_ISR() vTaskSwitchContext()
96 
97 /*-----------------------------------------------------------*/
98 
99 /* Hardware specifics. */
100 #define portBYTE_ALIGNMENT          8
101 #define portSTACK_GROWTH            ( -1 )
102 #define portTICK_PERIOD_MS          ( ( TickType_t ) 1000 / configTICK_RATE_HZ )
103 #define portNOP()                   asm volatile ( "NOP" )
104 
105 /* There are 32 * 32bit floating point regieters, plus the FPSCR to save. */
106 #define portNO_FLOP_REGISTERS_TO_SAVE  ( 32 + 1 )
107 
108 /*-----------------------------------------------------------*/
109 
110 /* Task function macros as described on the FreeRTOS.org WEB site. */
111 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void *pvParameters )
112 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void *pvParameters )
113 
114 /* Port specific interrupt handling functions. */
115 void vPortSetupInterruptController( void );
116 BaseType_t xPortInstallInterruptHandler( uint8_t ucInterruptID, XInterruptHandler pxHandler, void *pvCallBackRef );
117 
118 /* *INDENT-OFF* */
119 #ifdef __cplusplus
120     }
121 #endif
122 /* *INDENT-ON* */
123 
124 #endif /* PORTMACRO_H */
125