projdefs.h

00001 /*
00002     FreeRTOS V8.2.1 - Copyright (C) 2015 Real Time Engineers Ltd.
00003     All rights reserved
00004 
00005     VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.
00006 
00007     This file is part of the FreeRTOS distribution.
00008 
00009     FreeRTOS is free software; you can redistribute it and/or modify it under
00010     the terms of the GNU General Public License (version 2) as published by the
00011     Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.
00012 
00013     ***************************************************************************
00014     >>!   NOTE: The modification to the GPL is included to allow you to     !<<
00015     >>!   distribute a combined work that includes FreeRTOS without being   !<<
00016     >>!   obliged to provide the source code for proprietary components     !<<
00017     >>!   outside of the FreeRTOS kernel.                                   !<<
00018     ***************************************************************************
00019 
00020     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY
00021     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
00022     FOR A PARTICULAR PURPOSE.  Full license text is available on the following
00023     link: http://www.freertos.org/a00114.html
00024 
00025     ***************************************************************************
00026      *                                                                       *
00027      *    FreeRTOS provides completely free yet professionally developed,    *
00028      *    robust, strictly quality controlled, supported, and cross          *
00029      *    platform software that is more than just the market leader, it     *
00030      *    is the industry's de facto standard.                               *
00031      *                                                                       *
00032      *    Help yourself get started quickly while simultaneously helping     *
00033      *    to support the FreeRTOS project by purchasing a FreeRTOS           *
00034      *    tutorial book, reference manual, or both:                          *
00035      *    http://www.FreeRTOS.org/Documentation                              *
00036      *                                                                       *
00037     ***************************************************************************
00038 
00039     http://www.FreeRTOS.org/FAQHelp.html - Having a problem?  Start by reading
00040     the FAQ page "My application does not run, what could be wrong?".  Have you
00041     defined configASSERT()?
00042 
00043     http://www.FreeRTOS.org/support - In return for receiving this top quality
00044     embedded software for free we request you assist our global community by
00045     participating in the support forum.
00046 
00047     http://www.FreeRTOS.org/training - Investing in training allows your team to
00048     be as productive as possible as early as possible.  Now you can receive
00049     FreeRTOS training directly from Richard Barry, CEO of Real Time Engineers
00050     Ltd, and the world's leading authority on the world's leading RTOS.
00051 
00052     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,
00053     including FreeRTOS+Trace - an indispensable productivity tool, a DOS
00054     compatible FAT file system, and our tiny thread aware UDP/IP stack.
00055 
00056     http://www.FreeRTOS.org/labs - Where new FreeRTOS products go to incubate.
00057     Come and try FreeRTOS+TCP, our new open source TCP/IP stack for FreeRTOS.
00058 
00059     http://www.OpenRTOS.com - Real Time Engineers ltd. license FreeRTOS to High
00060     Integrity Systems ltd. to sell under the OpenRTOS brand.  Low cost OpenRTOS
00061     licenses offer ticketed support, indemnification and commercial middleware.
00062 
00063     http://www.SafeRTOS.com - High Integrity Systems also provide a safety
00064     engineered and independently SIL3 certified version for use in safety and
00065     mission critical applications that require provable dependability.
00066 
00067     1 tab == 4 spaces!
00068 */
00069 
00070 #ifndef PROJDEFS_H
00071 #define PROJDEFS_H
00072 
00073 /*
00074  * Defines the prototype to which task functions must conform.  Defined in this
00075  * file to ensure the type is known before portable.h is included.
00076  */
00077 typedef void (*TaskFunction_t)( void * );
00078 
00079 /* Converts a time in milliseconds to a time in ticks. */
00080 #define pdMS_TO_TICKS( xTimeInMs ) ( ( TickType_t ) ( ( ( TickType_t ) ( xTimeInMs ) * ( TickType_t ) configTICK_RATE_HZ ) / ( TickType_t ) 1000 ) )
00081 
00082 #define pdFALSE         ( ( BaseType_t ) 0 )
00083 #define pdTRUE          ( ( BaseType_t ) 1 )
00084 
00085 #define pdPASS          ( pdTRUE )
00086 #define pdFAIL          ( pdFALSE )
00087 #define errQUEUE_EMPTY  ( ( BaseType_t ) 0 )
00088 #define errQUEUE_FULL   ( ( BaseType_t ) 0 )
00089 
00090 /* FreeRTOS error definitions. */
00091 #define errCOULD_NOT_ALLOCATE_REQUIRED_MEMORY   ( -1 )
00092 #define errQUEUE_BLOCKED                        ( -4 )
00093 #define errQUEUE_YIELD                          ( -5 )
00094 
00095 /* Macros used for basic data corruption checks. */
00096 #ifndef configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES
00097     #define configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES 0
00098 #endif
00099 
00100 #if( configUSE_16_BIT_TICKS == 1 )
00101     #define pdINTEGRITY_CHECK_VALUE 0x5a5a
00102 #else
00103     #define pdINTEGRITY_CHECK_VALUE 0x5a5a5a5aUL
00104 #endif
00105 
00106 /* The following endian values are used by FreeRTOS+ components, not FreeRTOS
00107 itself. */
00108 #define pdFREERTOS_LITTLE_ENDIAN    0
00109 #define pdFREERTOS_BIG_ENDIAN       1
00110 
00111 #endif /* PROJDEFS_H */
00112 
00113 
00114 
00115