aboutsummaryrefslogtreecommitdiffstats
path: root/src/gos/gos_options.h
diff options
context:
space:
mode:
authorinmarket <andrewh@inmarket.com.au>2015-01-21 17:26:24 +1000
committerinmarket <andrewh@inmarket.com.au>2015-01-21 17:26:24 +1000
commitfa8167b94d13e94a6cb953e7f549a89f155f77c6 (patch)
tree8c33f78c45ca72ac2653327607f1d7caed668c5e /src/gos/gos_options.h
parent34939386d7390b0876973a1969f336b814313a22 (diff)
downloaduGFX-fa8167b94d13e94a6cb953e7f549a89f155f77c6.tar.gz
uGFX-fa8167b94d13e94a6cb953e7f549a89f155f77c6.tar.bz2
uGFX-fa8167b94d13e94a6cb953e7f549a89f155f77c6.zip
Big file rename to reduce problems with brain-dead IDE's that don't handle project file hierarchies well.
Naming is more consistent with the new scheme. May affect some third party drivers (header file renames).
Diffstat (limited to 'src/gos/gos_options.h')
-rw-r--r--src/gos/gos_options.h115
1 files changed, 115 insertions, 0 deletions
diff --git a/src/gos/gos_options.h b/src/gos/gos_options.h
new file mode 100644
index 00000000..611acfb7
--- /dev/null
+++ b/src/gos/gos_options.h
@@ -0,0 +1,115 @@
+/*
+ * 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/gos_options.h
+ * @brief GOS - Operating System options header file.
+ *
+ * @addtogroup GOS
+ * @{
+ */
+
+#ifndef _GOS_OPTIONS_H
+#define _GOS_OPTIONS_H
+
+/**
+ * @name 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
+ /**
+ * @brief Use a eCos
+ * @details Defaults to FALSE
+ */
+ #ifndef GFX_USE_OS_ECOS
+ #define GFX_USE_OS_ECOS FALSE
+ #endif
+/**
+ * @}
+ *
+ * @name GOS Optional Parameters
+ * @{
+ */
+ /**
+ * @brief Should uGFX avoid initializing the operating system
+ * @details Defaults to FALSE
+ * @note This is not relevant to all operating systems eg Win32 never initializes the
+ * operating system as uGFX runs as an application outside the boot process.
+ * @note Operating system initialization is not necessarily implemented for all
+ * operating systems yet even when it is relevant. These operating systems
+ * will display a compile warning reminding you to initialize the operating
+ * system in your application code. Note that on these operating systems the
+ * demo applications will not work without modification.
+ */
+ #ifndef GFX_NO_OS_INIT
+ #define GFX_NO_OS_INIT FALSE
+ #endif
+ /**
+ * @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 */
+/** @} */