config.h

Go to the documentation of this file.

/************************************************************************//**
 * \file heivs/config.h
 * \brief libheivs configuration file
 *
 * \defgroup config_h_options Project configuration
 * @{ \ingroup config
 *
 * \brief Configuration options for the current project
 *
 ***************************************************************************/
#ifndef HEIVS_CHECK_CONFIG_H
#define HEIVS_CHECK_CONFIG_H

#define _HEIVS_CHECK_CONFIG_H
#include "config/config.h"
#undef _HEIVS_CHECK_CONFIG_H

/**
 * \def USE_FREERTOS
 * \brief Use the FreeRTOS real time OS.
 *
 * Possible values:
 * - 0 : Don't use FreeRTOS
 * - 1 : Use FreeRTOS
 *
 * FIXME : examples
 *
 * \see FreeRTOS site : http://www.freertos.org/
 */
#if !defined(USE_FREERTOS)
    #define USE_FREERTOS 0
#endif
#if USE_FREERTOS != 0 && USE_FREERTOS != 1
    #error USE_FREERTOS valid values are 0 or 1, please check your config/config.h, there is a model in "heivs/samples/config.h.txt"
#endif

/**
 * \def USE_UGFX
 * \brief Use the uGFX graphical library.
 *
 * Possible values:
 * - 0 : Don't use uGFX
 * - 1 : Use uGFX
 *
 * FIXME : examples
 * \see uFGX site : http://ugfx.org
 */
#if !defined(USE_UGFX)
    #define USE_UGFX 0
#endif
#if USE_UGFX != 0 && USE_UGFX != 1
    #error USE_UGFX valid values are 0 or 1, please check your config/config.h, there is a model in "heivs/samples/config.h.txt"
#endif

/**
 * \def USE_LWIP
 * \brief Use the lwip TCP/IP stack.
 *
 * Possible values:
 * - 0 : Don't use lwip
 * - 1 : Use lwip
 *
 * FIXME : examples
 * \see uFGX site : http://lwip.org
 */
#if !defined(USE_LWIP)
    #define USE_LWIP 0
#endif
#if USE_LWIP != 0 && USE_LWIP != 1
    #error USE_LWIP valid values are 0 or 1, please check your config/config.h, there is a model in "heivs/samples/config.h.txt"
#endif

/**
 * \def USE_STM32_LIB_ASSERT
 * \brief Call bsp_fatal when the stm32 library detects a problem
 *
 * Possible values:
 * - 0 : Call bsp_fatal in case of problem
 * - 1 : Do nothing
 */
#if !defined(USE_STM32_LIB_ASSERT)
    #define USE_STM32_LIB_ASSERT 0
#endif
#if USE_STM32_LIB_ASSERT != 0 && USE_STM32_LIB_ASSERT != 1
    #error USE_STM32_LIB_ASSERT valid values are 0 or 1, please check your config/config.h, there is a model in "heivs/samples/config.h.txt"
#endif

/**
 * \def USE_BOOT_TIME_CRITICAL
 * \brief Boot as fast as possible
 *
 * Possible values:
 * - 0 : Boot slower, but debugging will be easier.
 * - 1 : Boot as fast as possible.
 */
#if !defined(USE_BOOT_TIME_CRITICAL)
    #define USE_BOOT_TIME_CRITICAL 0
#endif
#if USE_BOOT_TIME_CRITICAL != 0 && USE_BOOT_TIME_CRITICAL != 1
    #error USE_BOOT_TIME_CRITICAL valid values are 0 or 1, please check your config/config.h, there is a model in "heivs/samples/config.h.txt"
#endif

/**
 * \def USE_STM32_USB_USE_DEVICE_MODE
 * \brief Use the ST USB device library
 *
 * Possible values:
 * - 0 : Don't use that library
 * - 1 : Use that library
 *
 * FIXME : examples + config files
 */
#if !defined(USE_STM32_USB_USE_DEVICE_MODE)
    #define USE_STM32_USB_USE_DEVICE_MODE 0
#endif
#if USE_STM32_USB_USE_DEVICE_MODE != 0 && USE_STM32_USB_USE_DEVICE_MODE != 1
    #error USE_STM32_USB_USE_DEVICE_MODE valid values are 0 or 1, please check your config/config.h, there is a model in "heivs/samples/config.h.txt"
#endif

/**
 * \def USE_STM32_USB_HOST_MODE
 * \brief Use the ST USB host library
 *
 * Possible values:
 * - 0 : Don't use that library
 * - 1 : Use that library
 *
 * FIXME : examples + config files
 */
#if !defined(USE_STM32_USB_HOST_MODE)
    #define USE_STM32_USB_HOST_MODE 0
#endif
#if USE_STM32_USB_HOST_MODE != 0 && USE_STM32_USB_HOST_MODE != 1
    #error USE_STM32_USB_HOST_MODE valid values are 0 or 1, please check your config/config.h, there is a model in "heivs/samples/config.h.txt"
#endif

/**
 * \def USE_STM32_USB_OTG_MODE
 * \brief Use the ST USB on the go library
 *
 * Possible values:
 * - 0 : Don't use that library
 * - 1 : Use that library
 *
 * FIXME : examples + config files
 * \warning This mode is untested
 */
#if !defined(USE_STM32_USB_OTG_MODE)
    #define USE_STM32_USB_OTG_MODE 0
#endif
#if USE_STM32_USB_OTG_MODE != 0 && USE_STM32_USB_OTG_MODE != 1
    #error USE_STM32_USB_OTG_MODE valid values are 0 or 1, please check your config/config.h, there is a model in "heivs/samples/config.h.txt"
#endif

#if defined(USE_STDIO_USART) && defined(USE_SEMIHOSTING)
    #error USE_STDIO_USART & USE_SEMIHOSTING are exclusive, please check your config/config.h, there is a model in "heivs/samples/config.h.txt"
#endif

/**
 * \def USE_STDIO_USART
 * \brief Use this usart number for stdio redirection.
 *
 * The speed is currently fixed at 115200.
 *
 * FIXME : examples
 */
#if !defined(USE_STDIO_USART) && !defined(USE_SEMIHOSTING)
    #define USE_STDIO_USART 0
#endif
/**
 * \def USE_SEMIHOSTING
 * \brief Use semihosting for stdio
 *
 * Possible values:
 * - 0 : Don't use that library
 * - 1 : Use that library
 *
 * FIXME : examples
 */
#if !defined(USE_SEMIHOSTING)
    #define USE_SEMIHOSTING 0
#endif
#if USE_SEMIHOSTING != 0 && USE_SEMIHOSTING != 1
    #error USE_SEMIHOSTING valid values are 0 or 1, please check your config/config.h, there is a model in "heivs/samples/config.h.txt"
#endif

/**
 * \def USE_STDIO_NOBUF
 * \brief Disable stdio buffering
 *
 * Possible values:
 * - 0 : use stdio buffers
 * - 1 : don't use stdio buffers
 *
 * Defaults to 1
 */

#if !defined(USE_STDIO_NOBUF)
    #define USE_STDIO_NOBUF 1
#endif

/**
 * \def USE_FATAL_MALLOC_FAILED
 * \brief Call #bsp_fatal(ERROR_OUT_OF_MEMORY) when a malloc fails
 *
 * \see #configUSE_MALLOC_FAILED_HOOK when USE_FREERTOS = 1
 *
 * Possible values:
 * - 0 : malloc will return NULL when out of memory
 * - 1 : malloc will call #bsp_fatal(ERROR_OUT_OF_MEMORY) when out of memory
 *
 * Defaults to 1
 */

#if !defined(USE_FATAL_MALLOC_FAILED)
    #define USE_FATAL_MALLOC_FAILED 1
#endif
/**
 * \def USE_STDIO_ECHO
 * \brief Enable echo for stdio
 *
 * Possible values:
 * - 1 : generate echo
 * - 0 : don't generate echo
 */
#if !defined(USE_STDIO_ECHO)
    #define USE_STDIO_ECHO 0
#endif


/**
 * \def USE_STDIO_AUTO_CR_BEFORE_LF
 * \brief Put a CR ('\r') before every LF ('\n') on stdout (and stderr)
 *
 * Possible values:
 * - 0 : Don't use that workaround
 * - 1 : Use that workaround (DEFAULT)
 *
 * FIXME : examples
 *
 * This can be used to make the terminal emulator happy.
 */
#if !defined(USE_STDIO_AUTO_CR_BEFORE_LF)
#define USE_STDIO_AUTO_CR_BEFORE_LF 1
#endif
#if USE_STDIO_AUTO_CR_BEFORE_LF != 0 && USE_STDIO_AUTO_CR_BEFORE_LF != 1
    #error USE_STDIO_AUTO_CR_BEFORE_LF valid values are 0 or 1, please check your config/config.h, there is a model in "heivs/samples/config.h.txt"
#endif

/**
 * \def USE_LIBJPEG
 * \brief Use the libjpeg JPEG compression and decompression library
 *
 * Possible values:
 * - 0 : Don't use that library
 * - 1 : Use that library
 *
 * FIXME : examples
 *
 * \see The Sourceforge site for libjpeg : http://libjpeg.sourceforge.net/
 */
#if !defined(USE_LIBJPEG)
#define USE_LIBJPEG 0
#endif
#if USE_LIBJPEG != 0 && USE_LIBJPEG != 1
    #error USE_LIBJPEG valid values are 0 or 1, please check your config/config.h, there is a model in "heivs/samples/config.h.txt"
#endif

/**
 * \def USE_FATFS
 * \brief Use the FatFS library by ChaN
 *
 * Possible values:
 * - 0 : Don't use that library
 * - 1 : Use that library
 *
 * FIXME : examples
 *
 * \see The website for fatfs : http://elm-chan.org/fsw/ff/00index_e.html
 */
#if !defined(USE_FATFS)
    #define USE_FATFS 0
#endif
#if USE_FATFS != 0 && USE_FATFS != 1
    #error USE_FATFS valid values are 0 or 1, please check your config/config.h, there is a model in "heivs/samples/config.h.txt"
#endif

/**
 * \def USE_GCC_STACK_PROTECTOR
 * \brief gcc -fstack-protector and -fstack-protector-all support
 *
 * \ingroup automatic_config
 */
#ifdef __GNUC__
    #if defined (USE_GCC_STACK_PROTECTOR)
        #error USE_GCC_STACK_PROTECTOR is an automatic define
    #endif
    #if (defined(__SSP_ALL__) || defined (__SSP__))
        #define USE_GCC_STACK_PROTECTOR 1
    #else
        #define USE_GCC_STACK_PROTECTOR 0
    #endif
#else
    #define USE_GCC_STACK_PROTECTOR 0
#endif /* __GNUC__ */

/**
 * GCC stack protections is incompatible with FreeRTOS
 */
#if USE_GCC_STACK_PROTECTOR && USE_FREERTOS
        #error FreeRTOS is incompatible with gcc options -fstack-protector and -fstack-protector-all
#endif /* USE_FREERTOS */

/**
 * \def USE_GPL_LICENSE
 *
 * \brief This project has a GPL licence, so GPL libraries are enable.
 * \see http://www.gnu.org/licenses/gpl-2.0.html
 *
 * Possible values:
 * - 0 : Project is GPL
 * - 1 : Project is not GPL
 *
 */
#if !defined(USE_GPL_LICENSE)
    #define USE_GPL_LICENSE 0
#endif

#if USE_GPL_LICENSE != 0 && USE_GPL_LICENSE != 1
    #error USE_GPL_LICENSE valid values are 0 or 1, please check your config/config.h, there is a model in "heivs/samples/config.h.txt"
#endif

/**
 * \def USE_CYASSL
 * \brief Use the CYASSL library (requires USE_GPL_LICENSE)
 *
 * Possible values:
 * - 0 : Don't use that library
 * - 1 : Use that library
 */
#if !defined(USE_CYASSL)
    #define USE_CYASSL 0
#endif
#if USE_CYASSL != 0 && USE_CYASSL != 1
    #error USE_CYASSL valid values are 0 or 1, please check your config/config.h, there is a model in "heivs/samples/config.h.txt"
#endif
#if USE_CYASSL && !USE_GPL_LICENSE
    #error USE_CYASSL requieres USE_GPL_LICENSE
#endif

/************************************************************************//**
 * @}
 ***************************************************************************/
#endif /* HEIVS_CHECK_CONFIG_H */