ugfx/src/gos/sys_options.h

95 lines
2.2 KiB
C

/*
* This file is subject to the terms of the GFX License. If a copy of
* the license was not distributed with this file, you can obtain one at:
*
* http://ugfx.org/license.html
*/
/**
* @file src/gos/sys_options.h
* @brief GOS - Operating System options header file.
*
* @addtogroup GOS
* @{
*/
#ifndef _GOS_OPTIONS_H
#define _GOS_OPTIONS_H
/**
* @name GOS The operating system to use. One (and only one) of these must be defined.
* @{
*/
/**
* @brief Use ChibiOS
* @details Defaults to FALSE
*/
#ifndef GFX_USE_OS_CHIBIOS
#define GFX_USE_OS_CHIBIOS FALSE
#endif
/**
* @brief Use FreeRTOS
* @details Defaults to FALSE
*/
#ifndef GFX_USE_OS_FREERTOS
#define GFX_USE_OS_FREERTOS FALSE
#endif
/**
* @brief Use Win32
* @details Defaults to FALSE
*/
#ifndef GFX_USE_OS_WIN32
#define GFX_USE_OS_WIN32 FALSE
#endif
/**
* @brief Use a linux based system running X11
* @details Defaults to FALSE
*/
#ifndef GFX_USE_OS_LINUX
#define GFX_USE_OS_LINUX FALSE
#endif
/**
* @brief Use a Mac OS-X based system
* @details Defaults to FALSE
*/
#ifndef GFX_USE_OS_OSX
#define GFX_USE_OS_OSX FALSE
#endif
/**
* @brief Use a Raw 32 bit CPU based system
* @details Defaults to FALSE
*/
#ifndef GFX_USE_OS_RAW32
#define GFX_USE_OS_RAW32 FALSE
#endif
/**
* @}
*
* @name GOS Optional Parameters
* @{
*/
/**
* @brief Should uGFX stuff be added to the FreeRTOS+Tracer
* @details Defaults to FALSE
*/
#ifndef GFX_FREERTOS_USE_TRACE
#define GFX_FREERTOS_USE_TRACE FALSE
#endif
/**
* @brief How much RAM should uGFX use for the heap
* @details Defaults to 0. Only valid with GFX_USE_OS_RAW32
* @note If 0 then the standard C runtime malloc(), free() and realloc()
* are used.
* @note If it is non-zero then this is the number of bytes of RAM
* to use for the heap (gfxAlloc() and gfxFree()). No C
* runtime routines will be used and a new routine @p gfxAddHeapBlock()
* is added allowing the user to add extra memory blocks to the heap.
*/
#ifndef GOS_RAW_HEAP_SIZE
#define GOS_RAW_HEAP_SIZE 0
#endif
/** @} */
#endif /* _GOS_OPTIONS_H */
/** @} */