267 lines
8.3 KiB
C
267 lines
8.3 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/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 GFXOFF
|
|
*/
|
|
#ifndef GFX_USE_OS_CHIBIOS
|
|
#define GFX_USE_OS_CHIBIOS GFXOFF
|
|
#endif
|
|
/**
|
|
* @brief Use FreeRTOS
|
|
* @details Defaults to GFXOFF
|
|
*/
|
|
#ifndef GFX_USE_OS_FREERTOS
|
|
#define GFX_USE_OS_FREERTOS GFXOFF
|
|
#endif
|
|
/**
|
|
* @brief Use Win32
|
|
* @details Defaults to GFXOFF
|
|
*/
|
|
#ifndef GFX_USE_OS_WIN32
|
|
#define GFX_USE_OS_WIN32 GFXOFF
|
|
#endif
|
|
/**
|
|
* @brief Use a linux based system running X11
|
|
* @details Defaults to GFXOFF
|
|
*/
|
|
#ifndef GFX_USE_OS_LINUX
|
|
#define GFX_USE_OS_LINUX GFXOFF
|
|
#endif
|
|
/**
|
|
* @brief Use a Mac OS-X based system
|
|
* @details Defaults to GFXOFF
|
|
*/
|
|
#ifndef GFX_USE_OS_OSX
|
|
#define GFX_USE_OS_OSX GFXOFF
|
|
#endif
|
|
/**
|
|
* @brief Use a Raw 32-bit CPU based system (Bare Metal)
|
|
* @details Defaults to GFXOFF
|
|
*/
|
|
#ifndef GFX_USE_OS_RAW32
|
|
#define GFX_USE_OS_RAW32 GFXOFF
|
|
#endif
|
|
/**
|
|
* @brief Use a eCos
|
|
* @details Defaults to GFXOFF
|
|
*/
|
|
#ifndef GFX_USE_OS_ECOS
|
|
#define GFX_USE_OS_ECOS GFXOFF
|
|
#endif
|
|
/**
|
|
* @brief Use RAWRTOS
|
|
* @details Defaults to GFXOFF
|
|
*/
|
|
#ifndef GFX_USE_OS_RAWRTOS
|
|
#define GFX_USE_OS_RAWRTOS GFXOFF
|
|
#endif
|
|
/**
|
|
* @brief Use Arduino
|
|
* @details Defaults to GFXOFF
|
|
*/
|
|
#ifndef GFX_USE_OS_ARDUINO
|
|
#define GFX_USE_OS_ARDUINO GFXOFF
|
|
#endif
|
|
/**
|
|
* @brief Use CMSIS RTOS compatible OS
|
|
* @details Defaults to GFXOFF
|
|
*/
|
|
#ifndef GFX_USE_OS_CMSIS
|
|
#define GFX_USE_OS_CMSIS GFXOFF
|
|
#endif
|
|
/**
|
|
* @brief Use CMSIS2 RTOS compatible OS
|
|
* @details Defaults to GFXOFF
|
|
*/
|
|
#ifndef GFX_USE_OS_CMSIS2
|
|
#define GFX_USE_OS_CMSIS2 GFXOFF
|
|
#endif
|
|
/**
|
|
* @brief Use Keil CMSIS 1.x (RTOS, RTX4)
|
|
* @details Defaults to GFXOFF
|
|
*/
|
|
#ifndef GFX_USE_OS_KEIL
|
|
#define GFX_USE_OS_KEIL GFXOFF
|
|
#endif
|
|
/**
|
|
* @brief Use Keil RTX5
|
|
* @details Defaults to GFXOFF
|
|
*/
|
|
#ifndef GFX_USE_OS_RTX5
|
|
#define GFX_USE_OS_RTX5 GFXOFF
|
|
#endif
|
|
/**
|
|
* @brief Use NIOS-II
|
|
* @details Defaults to GFXOFF
|
|
*/
|
|
#ifndef GFX_USE_OS_NIOS
|
|
#define GFX_USE_OS_NIOS GFXOFF
|
|
#endif
|
|
/**
|
|
* @brief Use Zephyr
|
|
* @details Defaults to GFXOFF
|
|
*/
|
|
#ifndef GFX_USE_OS_ZEPHYR
|
|
#define GFX_USE_OS_ZEPHYR GFXOFF
|
|
#endif
|
|
/**
|
|
* @brief Use Qt
|
|
* @details Defaults to GFXOFF
|
|
*/
|
|
#ifndef GFX_USE_OS_QT
|
|
#define GFX_USE_OS_QT GFXOFF
|
|
#endif
|
|
/**
|
|
* @}
|
|
*
|
|
* @name GOS Optional Parameters
|
|
* @{
|
|
*/
|
|
/**
|
|
* @name GFX_OS_PRE_INIT_FUNCTION
|
|
* @brief A macro that defines a function that uGFX calls as part of gfxInit() in order to initialize hardware
|
|
* @details Defaults to undefined
|
|
* @note If defined the specified function is called before any other initialization.
|
|
* It is typically used to initialize hardware or the C runtime.
|
|
* @note Eg. In your source:
|
|
* void myHardwareInitRoutine(void);
|
|
* In gfxconf.h:
|
|
* #define GFX_OS_PRE_INIT_FUNCTION myHardwareInitRoutine
|
|
*/
|
|
//#define GFX_OS_PRE_INIT_FUNCTION myHardwareInitRoutine
|
|
/**
|
|
* @name GFX_OS_EXTRA_INIT_FUNCTION
|
|
* @brief A macro that defines a function that uGFX calls as part of gfxInit() just after initializing
|
|
* the operating system.
|
|
* @details Defaults to undefined
|
|
* @note If defined the specified function is called just after the operating system is initialized by
|
|
* gfxInit(). Note that if gfxInit() is set up to not initialize an operating system it is called after
|
|
* the GFX_OS_PRE_INIT_FUNCTION function (if any).
|
|
* @note Eg. In your source:
|
|
* void myOSInitRoutine(void);
|
|
* In gfxconf.h:
|
|
* #define GFX_OS_EXTRA_INIT_FUNCTION myOSInitRoutine
|
|
*/
|
|
//#define GFX_OS_EXTRA_INIT_FUNCTION myOSInitRoutine
|
|
/**
|
|
* @name GFX_OS_EXTRA_DEINIT_FUNCTION
|
|
* @brief A macro that defines a function that uGFX calls as part of gfxDeInit() just before de-initializing
|
|
* the operating system.
|
|
* @details Defaults to undefined
|
|
* @note If defined the specified function is called just before the operating system is de-initialized by
|
|
* gfxDeInit().
|
|
* @note Eg. In your source:
|
|
* void myOSDeInitRoutine(void);
|
|
* In gfxconf.h:
|
|
* #define GFX_OS_EXTRA_DEINIT_FUNCTION myOSDeInitRoutine
|
|
*/
|
|
//#define GFX_OS_EXTRA_DEINIT_FUNCTION myOSDeInitRoutine
|
|
/**
|
|
* @brief Should uGFX avoid initializing the operating system
|
|
* @details Defaults to GFXOFF
|
|
* @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_OS_NO_INIT
|
|
#define GFX_OS_NO_INIT GFXOFF
|
|
#endif
|
|
/**
|
|
* @brief Turn off warnings about initializing the operating system
|
|
* @details Defaults to GFXOFF
|
|
* @note This is only relevant where GOS cannot initialize the operating
|
|
* system automatically or the operating system initialization has been
|
|
* explicitly turned off.
|
|
*/
|
|
#ifndef GFX_OS_INIT_NO_WARNING
|
|
#define GFX_OS_INIT_NO_WARNING GFXOFF
|
|
#endif
|
|
/**
|
|
* @brief Call uGFXMain() after all initialisation
|
|
* @details Defaults to GFXOFF
|
|
* @note uGFXMain() is a function defined by the user in their project
|
|
* that contains the application main code. This is not expected to return
|
|
* and thus gfxInit() will also never return. This is required for some
|
|
* operating systems whose main thread never returns after starting the
|
|
* scheduler.<br>
|
|
* Its prototype is:<br>
|
|
* void uGFXMain(void);<br>
|
|
*/
|
|
#ifndef GFX_OS_CALL_UGFXMAIN
|
|
#define GFX_OS_CALL_UGFXMAIN GFXOFF
|
|
#endif
|
|
/**
|
|
* @brief When uGFXMain() is started as a thread, what stack size should be used
|
|
* @details Defaults to 0
|
|
* @note uGFXMain() contains the application main code. Some operating systems
|
|
* will start this as a thread. eg FreeRTOS. When it is started as a thread
|
|
* this defines how many bytes should be used for the thread stack.
|
|
* @note 0 means to use the operating systems default stack size.
|
|
*/
|
|
#ifndef GFX_OS_UGFXMAIN_STACKSIZE
|
|
#define GFX_OS_UGFXMAIN_STACKSIZE 0
|
|
#endif
|
|
/**
|
|
* @brief Should uGFX stuff be added to the FreeRTOS+Tracer
|
|
* @details Defaults to GFXOFF
|
|
*/
|
|
#ifndef GFX_FREERTOS_USE_TRACE
|
|
#define GFX_FREERTOS_USE_TRACE GFXOFF
|
|
#endif
|
|
/**
|
|
* @brief How much RAM should uGFX use for the heap when using its own internal heap allocator
|
|
* @details Defaults to 0.
|
|
* @note Only used when the internal ugfx heap allocator is used
|
|
* (GFX_USE_OS_RAW32, GFX_USE_OS_ARDUINO, GFX_US_OS_KEIL, GFX_USE_OS_CMSIS)
|
|
* @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 GFX_OS_HEAP_SIZE
|
|
#define GFX_OS_HEAP_SIZE 0
|
|
#endif
|
|
/**
|
|
* @brief Enable wrappers for malloc() and free()
|
|
* @details Defaults to GFXOFF
|
|
* @note If enabled, malloc() and free() will be implemented as wrappers that call gfxAlloc() and
|
|
* gfxFree() in order to provide portability to libraries using these function.
|
|
* @note Enabling this can solve 'unresolved _sbrk' issues
|
|
* @note It is strongly recommended to always use gfxAlloc() and gfxFree() directy to ensure
|
|
* portability of uGFX applications across all platforms.
|
|
*/
|
|
#ifndef GFX_EMULATE_MALLOC
|
|
#define GFX_EMULATE_MALLOC GFXOFF
|
|
#endif
|
|
/** @} */
|
|
|
|
#endif /* _GOS_OPTIONS_H */
|
|
/** @} */
|