Subversion Repositories LedShow

Rev

Go to most recent revision | Details | Last modification | View Log | RSS feed

Rev Author Line No. Line
2 mjames 1
/**
2
  ******************************************************************************
3
  * @file    stm32f1xx_hal_def.h
4
  * @author  MCD Application Team
5
  * @brief   This file contains HAL common defines, enumeration, macros and
6
  *          structures definitions.
7
  ******************************************************************************
8
  * @attention
9
  *
10
  * <h2><center>&copy; COPYRIGHT(c) 2017 STMicroelectronics</center></h2>
11
  *
12
  * Redistribution and use in source and binary forms, with or without modification,
13
  * are permitted provided that the following conditions are met:
14
  *   1. Redistributions of source code must retain the above copyright notice,
15
  *      this list of conditions and the following disclaimer.
16
  *   2. Redistributions in binary form must reproduce the above copyright notice,
17
  *      this list of conditions and the following disclaimer in the documentation
18
  *      and/or other materials provided with the distribution.
19
  *   3. Neither the name of STMicroelectronics nor the names of its contributors
20
  *      may be used to endorse or promote products derived from this software
21
  *      without specific prior written permission.
22
  *
23
  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
24
  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25
  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
26
  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
27
  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28
  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
29
  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
30
  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
31
  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
32
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33
  *
34
  ******************************************************************************
35
  */
36
 
37
/* Define to prevent recursive inclusion -------------------------------------*/
38
#ifndef __STM32F1xx_HAL_DEF
39
#define __STM32F1xx_HAL_DEF
40
 
41
#ifdef __cplusplus
42
extern "C" {
43
#endif
44
 
45
/* Includes ------------------------------------------------------------------*/
46
#include "stm32f1xx.h"
47
#if defined(USE_HAL_LEGACY)
48
#include "Legacy/stm32_hal_legacy.h"
49
#endif
50
#include <stdio.h>
51
 
52
/* Exported types ------------------------------------------------------------*/
53
 
54
/**
55
  * @brief  HAL Status structures definition
56
  */
57
typedef enum
58
{
59
  HAL_OK       = 0x00U,
60
  HAL_ERROR    = 0x01U,
61
  HAL_BUSY     = 0x02U,
62
  HAL_TIMEOUT  = 0x03U
63
} HAL_StatusTypeDef;
64
 
65
/**
66
  * @brief  HAL Lock structures definition
67
  */
68
typedef enum
69
{
70
  HAL_UNLOCKED = 0x00U,
71
  HAL_LOCKED   = 0x01U
72
} HAL_LockTypeDef;
73
 
74
/* Exported macro ------------------------------------------------------------*/
75
#define HAL_MAX_DELAY      0xFFFFFFFFU
76
 
77
#define HAL_IS_BIT_SET(REG, BIT)         (((REG) & (BIT)) != 0U)
78
#define HAL_IS_BIT_CLR(REG, BIT)         (((REG) & (BIT)) == 0U)
79
 
80
#define __HAL_LINKDMA(__HANDLE__, __PPP_DMA_FIELD__, __DMA_HANDLE__)               \
81
                        do{                                                      \
82
                              (__HANDLE__)->__PPP_DMA_FIELD__ = &(__DMA_HANDLE__); \
83
                              (__DMA_HANDLE__).Parent = (__HANDLE__);             \
84
                          } while(0U)
85
 
86
#define UNUSED(X) (void)X      /* To avoid gcc/g++ warnings */
87
 
88
/** @brief Reset the Handle's State field.
89
  * @param __HANDLE__: specifies the Peripheral Handle.
90
  * @note  This macro can be used for the following purpose:
91
  *          - When the Handle is declared as local variable; before passing it as parameter
92
  *            to HAL_PPP_Init() for the first time, it is mandatory to use this macro
93
  *            to set to 0 the Handle's "State" field.
94
  *            Otherwise, "State" field may have any random value and the first time the function
95
  *            HAL_PPP_Init() is called, the low level hardware initialization will be missed
96
  *            (i.e. HAL_PPP_MspInit() will not be executed).
97
  *          - When there is a need to reconfigure the low level hardware: instead of calling
98
  *            HAL_PPP_DeInit() then HAL_PPP_Init(), user can make a call to this macro then HAL_PPP_Init().
99
  *            In this later function, when the Handle's "State" field is set to 0, it will execute the function
100
  *            HAL_PPP_MspInit() which will reconfigure the low level hardware.
101
  * @retval None
102
  */
103
#define __HAL_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = 0U)
104
 
105
#if (USE_RTOS == 1U)
106
/* Reserved for future use */
107
#error "USE_RTOS should be 0 in the current HAL release"
108
#else
109
#define __HAL_LOCK(__HANDLE__)                                           \
110
                                do{                                        \
111
                                    if((__HANDLE__)->Lock == HAL_LOCKED)   \
112
                                    {                                      \
113
                                       return HAL_BUSY;                    \
114
                                    }                                      \
115
                                    else                                   \
116
                                    {                                      \
117
                                       (__HANDLE__)->Lock = HAL_LOCKED;    \
118
                                    }                                      \
119
                                  }while (0U)
120
 
121
#define __HAL_UNLOCK(__HANDLE__)                                          \
122
                                  do{                                       \
123
                                      (__HANDLE__)->Lock = HAL_UNLOCKED;    \
124
                                    }while (0U)
125
#endif /* USE_RTOS */
126
 
127
#if defined ( __GNUC__ ) && !defined (__CC_ARM) /* GNU Compiler */
128
#ifndef __weak
129
#define __weak   __attribute__((weak))
130
#endif /* __weak */
131
#ifndef __packed
132
#define __packed __attribute__((__packed__))
133
#endif /* __packed */
134
#endif /* __GNUC__ */
135
 
136
 
137
/* Macro to get variable aligned on 4-bytes, for __ICCARM__ the directive "#pragma data_alignment=4" must be used instead */
138
#if defined ( __GNUC__ ) && !defined (__CC_ARM) /* GNU Compiler */
139
#ifndef __ALIGN_END
140
#define __ALIGN_END    __attribute__ ((aligned (4)))
141
#endif /* __ALIGN_END */
142
#ifndef __ALIGN_BEGIN
143
#define __ALIGN_BEGIN
144
#endif /* __ALIGN_BEGIN */
145
#else
146
#ifndef __ALIGN_END
147
#define __ALIGN_END
148
#endif /* __ALIGN_END */
149
#ifndef __ALIGN_BEGIN
150
#if defined   (__CC_ARM)      /* ARM Compiler */
151
#define __ALIGN_BEGIN    __align(4)
152
#elif defined (__ICCARM__)    /* IAR Compiler */
153
#define __ALIGN_BEGIN
154
#endif /* __CC_ARM */
155
#endif /* __ALIGN_BEGIN */
156
#endif /* __GNUC__ */
157
 
158
 
159
/**
160
  * @brief  __RAM_FUNC definition
161
  */
162
#if defined ( __CC_ARM   )
163
/* ARM Compiler
164
   ------------
165
   RAM functions are defined using the toolchain options.
166
   Functions that are executed in RAM should reside in a separate source module.
167
   Using the 'Options for File' dialog you can simply change the 'Code / Const'
168
   area of a module to a memory space in physical RAM.
169
   Available memory areas are declared in the 'Target' tab of the 'Options for Target'
170
   dialog.
171
*/
172
#define __RAM_FUNC
173
 
174
#elif defined ( __ICCARM__ )
175
/* ICCARM Compiler
176
   ---------------
177
   RAM functions are defined using a specific toolchain keyword "__ramfunc".
178
*/
179
#define __RAM_FUNC __ramfunc
180
 
181
#elif defined   (  __GNUC__  )
182
/* GNU Compiler
183
   ------------
184
  RAM functions are defined using a specific toolchain attribute
185
   "__attribute__((section(".RamFunc")))".
186
*/
187
#define __RAM_FUNC __attribute__((section(".RamFunc")))
188
 
189
#endif
190
 
191
/**
192
  * @brief  __NOINLINE definition
193
  */
194
#if defined ( __CC_ARM   ) || defined   (  __GNUC__  )
195
/* ARM & GNUCompiler
196
   ----------------
197
*/
198
#define __NOINLINE __attribute__ ( (noinline) )
199
 
200
#elif defined ( __ICCARM__ )
201
/* ICCARM Compiler
202
   ---------------
203
*/
204
#define __NOINLINE _Pragma("optimize = no_inline")
205
 
206
#endif
207
 
208
#ifdef __cplusplus
209
}
210
#endif
211
 
212
#endif /* ___STM32F1xx_HAL_DEF */
213
 
214
/************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/