begriffs open source - freertos/blob - portable/MPLAB/PIC24_dsPIC/portmacro.h

   1 /*
   2  * FreeRTOS Kernel <DEVELOPMENT BRANCH>
   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 #ifdef __cplusplus
  33 extern "C" {
  34 #endif
  35
  36 /*-----------------------------------------------------------
  37  * Port specific definitions.
  38  *
  39  * The settings in this file configure FreeRTOS correctly for the
  40  * given hardware and compiler.
  41  *
  42  * These settings should not be altered.
  43  *-----------------------------------------------------------
  44  */
  45
  46 /* Type definitions. */
  47 #define portCHAR        char
  48 #define portFLOAT       float
  49 #define portDOUBLE      double
  50 #define portLONG        long
  51 #define portSHORT       short
  52 #define portSTACK_TYPE  uint16_t
  53 #define portBASE_TYPE   short
  54
  55 typedef portSTACK_TYPE StackType_t;
  56 typedef short BaseType_t;
  57 typedef unsigned short UBaseType_t;
  58
  59 #if( configTICK_TYPE_WIDTH_IN_BITS == TICK_TYPE_WIDTH_16_BITS )
  60     typedef uint16_t TickType_t;
  61     #define portMAX_DELAY ( TickType_t ) 0xffff
  62 /* 16-bit tick type on a 16-bit architecture, so reads of the tick count do
  63  * not need to be guarded with a critical section. */
  64     #define portTICK_TYPE_IS_ATOMIC 1
  65 #elif ( configTICK_TYPE_WIDTH_IN_BITS  == TICK_TYPE_WIDTH_32_BITS )
  66     typedef uint32_t             TickType_t;
  67     #define portMAX_DELAY    ( TickType_t ) 0xffffffffUL
  68 #else
  69     #error configTICK_TYPE_WIDTH_IN_BITS set to unsupported tick type width.
  70 #endif
  71 /*-----------------------------------------------------------*/
  72
  73 /* Hardware specifics. */
  74 #define portBYTE_ALIGNMENT          2
  75 #define portSTACK_GROWTH            1
  76 #define portTICK_PERIOD_MS          ( ( TickType_t ) 1000 / configTICK_RATE_HZ )
  77 /*-----------------------------------------------------------*/
  78
  79 /* Critical section management. */
  80 #define portDISABLE_INTERRUPTS()    SET_CPU_IPL( configKERNEL_INTERRUPT_PRIORITY ); __asm volatile ( "NOP" )
  81 #define portENABLE_INTERRUPTS()     SET_CPU_IPL( 0 )
  82
  83 /* Note that exiting a critical sectino will set the IPL bits to 0, nomatter
  84 what their value was prior to entering the critical section. */
  85 extern void vPortEnterCritical( void );
  86 extern void vPortExitCritical( void );
  87 #define portENTER_CRITICAL()        vPortEnterCritical()
  88 #define portEXIT_CRITICAL()         vPortExitCritical()
  89 /*-----------------------------------------------------------*/
  90
  91 /* Task utilities. */
  92 extern void vPortYield( void );
  93 #define portYIELD()             asm volatile ( "CALL _vPortYield            \n"     \
  94                                                 "NOP                      " );
  95 /*-----------------------------------------------------------*/
  96
  97 /* Task function macros as described on the FreeRTOS.org WEB site. */
  98 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void *pvParameters )
  99 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void *pvParameters )
 100 /*-----------------------------------------------------------*/
 101
 102 /* Required by the kernel aware debugger. */
 103 #ifdef __DEBUG
 104     #define portREMOVE_STATIC_QUALIFIER
 105 #endif
 106
 107 #define portNOP()               asm volatile ( "NOP" )
 108
 109 #ifdef __cplusplus
 110 }
 111 #endif
 112
 113 #endif /* PORTMACRO_H */