File content as of revision 14:2044ad5cd3fe:

/**
 * @author  Tilen Majerle
 * @email   tilen@majerle.eu
 * @website http://stm32f4-discovery.com
 * @version v1.0
 * @license GNU GPL v3
@verbatim
   ----------------------------------------------------------------------
    Copyright (C) Tilen Majerle, 2015
    
    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    any later version.
     
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
    
    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
   ----------------------------------------------------------------------
@endverbatim
 */
#ifndef TM_STM32Fxxx_H
#define TM_STM32Fxxx_H

/* C++ detection */
#ifdef __cplusplus
extern "C" {
#endif

/**
 * @addtogroup TM_STM32Fxxx_HAL_Libraries
 * @{
 *
 *
 * \par Beginning for libraries
 *
 * For start using these libraries, check @ref TM_HAL.
 */

/**
 * @defgroup TM_HAL
 * @brief    Main description and usage of TM HAL based libraries
 * @{
 *
 * \par About libraries
 *
 * These libraries are provided by Tilen Majerle and are developed under GNU GPL v3 licence. For more information about that, please check website of license.
 *
 * To use it, I suppose you know C language and at least basics of STM32 devices (especially STM32F0, STM32F4 or STM32F7 series).
 *
 * \par Download libraries
 *
 * Download for all libraries is on this link: http://stm32f4-discovery.com/?wpdmdl=2618
 *
 * \par Examples
 *
 * Each library has Keil uVision based example on my Github account, https://github.com/MaJerle/stm32fxxx_hal_libraries.
 *
 * If you are beginner, then I suggest you to download entire repository from Github, install basic demo version of Keil uVision and open examples directly from download.
 * Almost all examples works with demo version of Keil uVision.
 *
 * \par Libraries structure
 *
 * Each library is structured in the same way where you have these parts:
 *  - Header file:
 *    - Library description with link on website
 *    - Includes section
 *    - Defines section for different configurations in library
 *    - Enumerations and structures section
 *    - Function declaration section
 *  - Source file:
 *    - Function implementations
 *
 * Each library includes at least these 2 files:
 *  - stm32fxxx_hal.h file:
 *    This file was done by me for better organization between several STM32 families to use with my libraries for future use.
 *    It sets some basic defines, which can also be set using compiler's preprocessor defines. Check file for more information with detailed description.
 *
 *  - defines.h file:
 *    <b>This file is totally based on user and should also be created by user</b>.
 *
 *    It is used for library configuration settings, so you don't have to edit library file. 
 *    If you edit library file, then if new version is out, it will be overwritten what you don't wanna have.
 *
 *    Check example below for meaning.
 *
\code
//------------------------------------
//tm_stm32_exti.h file:
//------------------------------------
//Content in this file is similar to this below:

//Include defines.h file for user configuration
#include "defines.h"

//Set default NVIC preemption priority if not defined by user to 0x03
#ifndef EXTI_NVIC_PRIORITY
#define EXTI_NVIC_PRIORITY     0x03
#endif

//------------------------------------
//defines.h file: (set by user)
//------------------------------------

//User wants to change that, use defines.h file like this:
#ifndef DEFINES_FILE
#define DEFINES_FILE

//Let's set EXTI NVIC preemption priority to highest, so we will do:
#define EXTI_NVIC_PRIORITY    0x00

#endif
\endcode
 *
 * Code above shows how you can use defines.h file to change default library settings.
 *
 * \par HAL Source from ST
 *
 * TM HAL libraries works on STM32Cube provided from ST and are not included in package of libraries.
 *
 * @note  You have to go to ST website and download STM32Cube package for your family and use that STM32Fxxx_HAL_Drivers libraries in your project together with my libraries.
 *        On my Github, you have example how they are used together.
 *
 * \par About defines.h file
 *
 * Please check above about this.
 *
 */

/**
 * @defgroup TM_HAL_Family
 * @brief    In stm32fxxx_hal.h file you have to specify STM32 family used for HAL drivers.
 * @{
 */

/* Defines for family used with libraries */
/* Uncomment line for your family used with HAL libraries */
//#define STM32F0xx /*!< Use STM32F0xx libraries */
//#define STM32F4xx /*!< Use STM32F4xx libraries */
#define STM32F7xx /*!< Use STM32F7xx libraries */

/**
 * @}
 */

/* Include project config file */
#include "defines.h"

/* Check if HAL drivers enabled */
#ifndef USE_HAL_DRIVER
#define USE_HAL_DRIVER
#endif

/* Include proper header file */
/* STM32F7xx */
#if defined(STM32F0xx) || defined(STM32F0XX)
#ifndef STM32F0xx
#define STM32F0xx
#endif
#ifndef STM32F0XX
#define STM32F0XX
#endif
#include "stm32f0xx.h"
#include "stm32f0xx_hal.h"
#endif

/* STM32F4xx */
#if defined(STM32F4xx) || defined(STM32F4XX)
#ifndef STM32F4xx
#define STM32F4xx
#endif
#ifndef STM32F4XX
#define STM32F4XX
#endif
#include "stm32f4xx.h"
#include "stm32f4xx_hal.h"
#endif

/* STM32F7xx */
#if defined(STM32F7xx) || defined(STM32F7XX)
#ifndef STM32F7xx
#define STM32F7xx
#endif
#ifndef STM32F7XX
#define STM32F7XX
#endif
#include "stm32f7xx.h"
#include "stm32f7xx_hal.h"
#endif

/* Check if anything defined */
#if !defined(STM32F0xx) && !defined(STM32F4xx) && !defined(STM32F7xx)
#error "There is not selected STM32 family used. Check stm32fxxx_hal.h file for configuration!"
#endif

/* Init main libraries used everywhere */
#include "defines.h"
#include "tm_stm32_rcc.h"
#include "tm_stm32_gpio.h"

/**
 * @}
 */

/**
 * @}
 */

/* C++ detection */
#ifdef __cplusplus
}
#endif

#endif