Common.h 12.3 KB
Newer Older
1
2
/*
             LUFA Library
3
     Copyright (C) Dean Camera, 2012.
4

5
  dean [at] fourwalledcubicle [dot] com
6
           www.lufa-lib.org
7
8
9
*/

/*
10
  Copyright 2012  Dean Camera (dean [at] fourwalledcubicle [dot] com)
11

12
  Permission to use, copy, modify, distribute, and sell this
13
  software and its documentation for any purpose is hereby granted
14
  without fee, provided that the above copyright notice appear in
15
  all copies and that both that the copyright notice and this
16
17
18
  permission notice and warranty disclaimer appear in supporting
  documentation, and that the name of the author not be used in
  advertising or publicity pertaining to distribution of the
19
20
  software without specific, written prior permission.

21
  The author disclaims all warranties with regard to this
22
23
24
25
26
27
28
29
30
  software, including all implied warranties of merchantability
  and fitness.  In no event shall the author be liable for any
  special, indirect or consequential damages or any damages
  whatsoever resulting from loss of use, data or profits, whether
  in an action of contract, negligence or other tortious action,
  arising out of or in connection with the use or performance of
  this software.
*/

31
32
33
34
35
36
37
/** \dir
 *  \brief Common library header files.
 *
 *  This folder contains header files which are common to all parts of the LUFA library. They may be used freely in
 *  user applications.
 */

38
/** \file
39
 *  \brief Common library convenience headers, macros and functions.
40
 *
41
 *  \copydetails Group_Common
42
 */
43

44
/** \defgroup Group_Common Common Utility Headers - LUFA/Drivers/Common/Common.h
45
 *  \brief Common library convenience headers, macros and functions.
46
47
48
49
50
51
 *
 *  Common utility headers containing macros, functions, enums and types which are common to all
 *  aspects of the library.
 *
 *  @{
 */
52

53
54
55
56
57
/** \defgroup Group_GlobalInt Global Interrupt Macros
 *  \brief Convenience macros for the management of interrupts globally within the device.
 *
 *  Macros and functions to create and control global interrupts within the device.
 */
58

59
60
#ifndef __LUFA_COMMON_H__
#define __LUFA_COMMON_H__
61

62
	/* Macros: */
63
		#define __INCLUDE_FROM_COMMON_H
64

65
	/* Includes: */
66
67
		#include <stdint.h>
		#include <stdbool.h>
68
		#include <string.h>
69
		#include <stddef.h>
70

71
72
		#include "Architectures.h"
		#include "BoardTypes.h"
73
		#include "ArchitectureSpecific.h"
74
		#include "CompilerSpecific.h"
75
		#include "Attributes.h"
76

77
78
79
80
		#if defined(USE_LUFA_CONFIG_HEADER)
			#include "LUFAConfig.h"
		#endif

81
82
83
84
85
	/* Enable C linkage for C++ Compilers: */
		#if defined(__cplusplus)
			extern "C" {
		#endif

86
	/* Architecture specific utility includes: */
87
		#if defined(__DOXYGEN__)
Dean Camera's avatar
Dean Camera committed
88
			/** Type define for an unsigned integer the same width as the selected architecture's machine register.
Dean Camera's avatar
Dean Camera committed
89
			 *  This is distinct from the non-specific standard int data type, whose width is machine dependent but
Dean Camera's avatar
Dean Camera committed
90
91
			 *  which may not reflect the actual machine register width on some targets (e.g. AVR8).
			 */
92
93
			typedef MACHINE_REG_t uint_reg_t;
		#elif (ARCH == ARCH_AVR8)
94
95
96
97
			#include <avr/io.h>
			#include <avr/interrupt.h>
			#include <avr/pgmspace.h>
			#include <avr/eeprom.h>
98
			#include <avr/boot.h>
99
			#include <math.h>
100
			#include <util/delay.h>
101

102
			typedef uint8_t uint_reg_t;
103

104
105
106
107
108
			#define ARCH_HAS_EEPROM_ADDRESS_SPACE
			#define ARCH_HAS_FLASH_ADDRESS_SPACE
			#define ARCH_HAS_MULTI_ADDRESS_SPACE
			#define ARCH_LITTLE_ENDIAN

109
			#include "Endianness.h"
110
		#elif (ARCH == ARCH_UC3)
111
			#include <avr32/io.h>
112
			#include <math.h>
113

114
			// === TODO: Find abstracted way to handle these ===
Dean Camera's avatar
Dean Camera committed
115
			#define PROGMEM
116
117
118
			#define pgm_read_byte(x)         *x
			#define memcmp_P(...)            memcmp(__VA_ARGS__)
			#define memcpy_P(...)            memcpy(__VA_ARGS__)
119
			// =================================================
120
121

			typedef uint32_t uint_reg_t;
122

123
			#define ARCH_BIG_ENDIAN
124

125
			#include "Endianness.h"
126
127
128
129
130
		#elif (ARCH == ARCH_XMEGA)
			#include <avr/io.h>
			#include <avr/interrupt.h>
			#include <avr/pgmspace.h>
			#include <avr/eeprom.h>
131
			#include <math.h>
132
			#include <util/delay.h>
133

134
			typedef uint8_t uint_reg_t;
135

136
137
138
139
140
			#define ARCH_HAS_EEPROM_ADDRESS_SPACE
			#define ARCH_HAS_FLASH_ADDRESS_SPACE
			#define ARCH_HAS_MULTI_ADDRESS_SPACE
			#define ARCH_LITTLE_ENDIAN

141
			#include "Endianness.h"
142
143
		#else
			#error Unknown device architecture specified.
144
		#endif
145
146

	/* Public Interface - May be used in end-application: */
147
		/* Macros: */
148
149
150
			/** Macro for encasing other multi-statement macros. This should be used along with an opening brace
			 *  before the start of any multi-statement macro, so that the macros contents as a whole are treated
			 *  as a discrete block and not as a list of separate statements which may cause problems when used as
151
			 *  a block (such as inline \c if statements).
152
153
154
155
156
157
			 */
			#define MACROS                  do

			/** Macro for encasing other multi-statement macros. This should be used along with a preceding closing
			 *  brace at the end of any multi-statement macro, so that the macros contents as a whole are treated
			 *  as a discrete block and not as a list of separate statements which may cause problems when used as
158
			 *  a block (such as inline \c if statements).
159
160
			 */
			#define MACROE                  while (0)
161

162
163
			/** Convenience macro to determine the larger of two values.
			 *
164
165
			 *  \attention This macro should only be used with operands that do not have side effects from being evaluated
			 *             multiple times.
166
167
168
169
170
171
			 *
			 *  \param[in] x  First value to compare
			 *  \param[in] y  First value to compare
			 *
			 *  \return The larger of the two input parameters
			 */
172
			#if !defined(MAX) || defined(__DOXYGEN__)
Dean Camera's avatar
Dean Camera committed
173
				#define MAX(x, y)               (((x) > (y)) ? (x) : (y))
174
			#endif
175
176
177

			/** Convenience macro to determine the smaller of two values.
			 *
178
179
			 *  \attention This macro should only be used with operands that do not have side effects from being evaluated
			 *             multiple times.
180
181
182
183
184
185
			 *
			 *  \param[in] x  First value to compare
			 *  \param[in] y  First value to compare
			 *
			 *  \return The smaller of the two input parameters
			 */
186
			#if !defined(MIN) || defined(__DOXYGEN__)
Dean Camera's avatar
Dean Camera committed
187
				#define MIN(x, y)               (((x) < (y)) ? (x) : (y))
188
			#endif
189

190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
			#if !defined(STRINGIFY) || defined(__DOXYGEN__)
				/** Converts the given input into a string, via the C Preprocessor. This macro puts literal quotation
				 *  marks around the input, converting the source into a string literal.
				 *
				 *  \param[in] x  Input to convert into a string literal.
				 *
				 *  \return String version of the input.
				 */
				#define STRINGIFY(x)            #x

				/** Converts the given input into a string after macro expansion, via the C Preprocessor. This macro puts
				 *  literal quotation marks around the expanded input, converting the source into a string literal.
				 *
				 *  \param[in] x  Input to expand and convert into a string literal.
				 *
				 *  \return String version of the expanded input.
				 */
				#define STRINGIFY_EXPANDED(x)   STRINGIFY(x)
			#endif
209

210
211
212
213
214
215
216
217
			#if !defined(ISR) || defined(__DOXYGEN__)
				/** Macro for the definition of interrupt service routines, so that the compiler can insert the required
				 *  prologue and epilogue code to properly manage the interrupt routine without affecting the main thread's
				 *  state with unintentional side-effects.
				 *
				 *  Interrupt handlers written using this macro may still need to be registered with the microcontroller's
				 *  Interrupt Controller (if present) before they will properly handle incoming interrupt events.
				 *
218
219
				 *  \note This macro is only supplied on some architectures, where the standard library does not include a valid
				 *        definition. If an existing definition exists, the alternative definition here will be ignored.
220
				 *
221
222
				 *  \ingroup Group_GlobalInt
				 *
223
				 *  \param[in] Name  Unique name of the interrupt service routine.
224
				 */
Dean Camera's avatar
Dean Camera committed
225
				#define ISR(Name, ...)          void Name (void) __attribute__((__interrupt__)) __VA_ARGS__; void Name (void)
226
227
			#endif

228
229
230
231
		/* Inline Functions: */
			/** Function to reverse the individual bits in a byte - i.e. bit 7 is moved to bit 0, bit 6 to bit 1,
			 *  etc.
			 *
232
			 *  \param[in] Byte  Byte of data whose bits are to be reversed.
233
234
			 *
			 *  \return Input data with the individual bits reversed (mirrored).
235
236
237
238
239
240
241
242
243
244
			 */
			static inline uint8_t BitReverse(uint8_t Byte) ATTR_WARN_UNUSED_RESULT ATTR_CONST;
			static inline uint8_t BitReverse(uint8_t Byte)
			{
				Byte = (((Byte & 0xF0) >> 4) | ((Byte & 0x0F) << 4));
				Byte = (((Byte & 0xCC) >> 2) | ((Byte & 0x33) << 2));
				Byte = (((Byte & 0xAA) >> 1) | ((Byte & 0x55) << 1));

				return Byte;
			}
245

246
247
248
			/** Function to perform a blocking delay for a specified number of milliseconds. The actual delay will be
			 *  at a minimum the specified number of milliseconds, however due to loop overhead and internal calculations
			 *  may be slightly higher.
249
250
			 *
			 *  \param[in] Milliseconds  Number of milliseconds to delay
251
			 */
252
253
			static inline void Delay_MS(uint16_t Milliseconds) ATTR_ALWAYS_INLINE;
			static inline void Delay_MS(uint16_t Milliseconds)
254
			{
255
				#if (ARCH == ARCH_AVR8)
256
				if (GCC_IS_COMPILE_CONST(Milliseconds))
257
258
259
260
261
262
263
264
265
				{
					_delay_ms(Milliseconds);
				}
				else
				{
					while (Milliseconds--)
					  _delay_ms(1);
				}
				#elif (ARCH == ARCH_UC3)
266
267
268
				while (Milliseconds--)
				{
					__builtin_mtsr(AVR32_COUNT, 0);
269
					while ((uint32_t)__builtin_mfsr(AVR32_COUNT) < (F_CPU / 1000));
270
				}
271
272
273
274
275
276
277
278
279
				#elif (ARCH == ARCH_XMEGA)
				if (GCC_IS_COMPILE_CONST(Milliseconds))
				{
					_delay_ms(Milliseconds);
				}
				else
				{
					while (Milliseconds--)
					  _delay_ms(1);
280
				}
281
				#endif
282
283
			}

284
285
286
287
			/** Retrieves a mask which contains the current state of the global interrupts for the device. This
			 *  value can be stored before altering the global interrupt enable state, before restoring the
			 *  flag(s) back to their previous values after a critical section using \ref SetGlobalInterruptMask().
			 *
288
289
			 *  \ingroup Group_GlobalInt
			 *
290
291
292
293
294
295
296
297
298
299
			 *  \return  Mask containing the current Global Interrupt Enable Mask bit(s).
			 */
			static inline uint_reg_t GetGlobalInterruptMask(void) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT;
			static inline uint_reg_t GetGlobalInterruptMask(void)
			{
				GCC_MEMORY_BARRIER();

				#if (ARCH == ARCH_AVR8)
				return SREG;
				#elif (ARCH == ARCH_UC3)
300
301
302
				return __builtin_mfsr(AVR32_SR);
				#elif (ARCH == ARCH_XMEGA)
				return SREG;
303
304
305
306
307
308
309
				#endif
			}

			/** Sets the global interrupt enable state of the microcontroller to the mask passed into the function.
			 *  This can be combined with \ref GetGlobalInterruptMask() to save and restore the Global Interrupt Enable
			 *  Mask bit(s) of the device after a critical section has completed.
			 *
310
311
			 *  \ingroup Group_GlobalInt
			 *
312
313
314
315
316
317
318
319
320
321
322
323
324
325
			 *  \param[in] GlobalIntState  Global Interrupt Enable Mask value to use
			 */
			static inline void SetGlobalInterruptMask(const uint_reg_t GlobalIntState) ATTR_ALWAYS_INLINE;
			static inline void SetGlobalInterruptMask(const uint_reg_t GlobalIntState)
			{
				GCC_MEMORY_BARRIER();

				#if (ARCH == ARCH_AVR8)
				SREG = GlobalIntState;
				#elif (ARCH == ARCH_UC3)
				if (GlobalIntState & AVR32_SR_GM)
				  __builtin_ssrf(AVR32_SR_GM_OFFSET);
				else
				  __builtin_csrf(AVR32_SR_GM_OFFSET);
326
				#elif (ARCH == ARCH_XMEGA)
327
				SREG = GlobalIntState;
328
				#endif
329

330
331
				GCC_MEMORY_BARRIER();
			}
332

333
334
335
336
			/** Enables global interrupt handling for the device, allowing interrupts to be handled.
			 *
			 *  \ingroup Group_GlobalInt
			 */
337
338
339
340
341
342
343
344
345
			static inline void GlobalInterruptEnable(void) ATTR_ALWAYS_INLINE;
			static inline void GlobalInterruptEnable(void)
			{
				GCC_MEMORY_BARRIER();

				#if (ARCH == ARCH_AVR8)
				sei();
				#elif (ARCH == ARCH_UC3)
				__builtin_csrf(AVR32_SR_GM_OFFSET);
346
347
				#elif (ARCH == ARCH_XMEGA)
				sei();
348
349
350
				#endif

				GCC_MEMORY_BARRIER();
351
			}
352

353
354
355
356
			/** Disabled global interrupt handling for the device, preventing interrupts from being handled.
			 *
			 *  \ingroup Group_GlobalInt
			 */
357
358
359
360
361
362
363
364
365
			static inline void GlobalInterruptDisable(void) ATTR_ALWAYS_INLINE;
			static inline void GlobalInterruptDisable(void)
			{
				GCC_MEMORY_BARRIER();

				#if (ARCH == ARCH_AVR8)
				cli();
				#elif (ARCH == ARCH_UC3)
				__builtin_ssrf(AVR32_SR_GM_OFFSET);
366
367
				#elif (ARCH == ARCH_XMEGA)
				cli();
368
369
370
371
372
				#endif

				GCC_MEMORY_BARRIER();
			}

373
374
375
376
377
	/* Disable C linkage for C++ Compilers: */
		#if defined(__cplusplus)
			}
		#endif

378
379
380
#endif

/** @} */
381