Common.h 12.1 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
21
22
23
24
25
26
27
28
29
30
31
  software without specific, written prior permission.

  The author disclaim all warranties with regard to this
  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.
*/

/** \file
32
 *  \brief Common library convenience headers, macros and functions.
33
 *
34
 *  \copydetails Group_Common
35
 */
36

37
/** \defgroup Group_Common Common Utility Headers - LUFA/Drivers/Common/Common.h
38
 *  \brief Common library convenience headers, macros and functions.
39
40
41
42
43
44
 *
 *  Common utility headers containing macros, functions, enums and types which are common to all
 *  aspects of the library.
 *
 *  @{
 */
45

46
47
48
49
50
/** \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.
 */
51

52
53
#ifndef __LUFA_COMMON_H__
#define __LUFA_COMMON_H__
54

55
	/* Macros: */
56
		#define __INCLUDE_FROM_COMMON_H
57

58
	/* Includes: */
59
60
		#include <stdint.h>
		#include <stdbool.h>
61
		#include <string.h>
62
		#include <stddef.h>
63

64
65
66
67
		#if defined(USE_LUFA_CONFIG_HEADER)
			#include "LUFAConfig.h"
		#endif

68
69
		#include "Architectures.h"
		#include "BoardTypes.h"
70
		#include "ArchitectureSpecific.h"
71
		#include "CompilerSpecific.h"
72
		#include "Attributes.h"
73

74
75
76
77
78
	/* Enable C linkage for C++ Compilers: */
		#if defined(__cplusplus)
			extern "C" {
		#endif

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

95
			typedef uint8_t uint_reg_t;
96

97
98
99
100
101
			#define ARCH_HAS_EEPROM_ADDRESS_SPACE
			#define ARCH_HAS_FLASH_ADDRESS_SPACE
			#define ARCH_HAS_MULTI_ADDRESS_SPACE
			#define ARCH_LITTLE_ENDIAN

102
			#include "Endianness.h"
103
		#elif (ARCH == ARCH_UC3)
104
105
			#include <avr32/io.h>

106
			// === TODO: Find abstracted way to handle these ===
107
108
109
110
			#define PROGMEM                  const
			#define pgm_read_byte(x)         *x
			#define memcmp_P(...)            memcmp(__VA_ARGS__)
			#define memcpy_P(...)            memcpy(__VA_ARGS__)
111
			// =================================================
112
113

			typedef uint32_t uint_reg_t;
114

115
			#define ARCH_BIG_ENDIAN
116

117
			#include "Endianness.h"
118
119
120
121
122
		#elif (ARCH == ARCH_XMEGA)
			#include <avr/io.h>
			#include <avr/interrupt.h>
			#include <avr/pgmspace.h>
			#include <avr/eeprom.h>
123
			#include <math.h>
124
			#include <util/delay.h>
125

126
			typedef uint8_t uint_reg_t;
127

128
129
130
131
132
			#define ARCH_HAS_EEPROM_ADDRESS_SPACE
			#define ARCH_HAS_FLASH_ADDRESS_SPACE
			#define ARCH_HAS_MULTI_ADDRESS_SPACE
			#define ARCH_LITTLE_ENDIAN

133
			#include "Endianness.h"
134
135
		#else
			#error Unknown device architecture specified.
136
		#endif
137
138

	/* Public Interface - May be used in end-application: */
139
		/* Macros: */
140
141
142
			/** 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
143
			 *  a block (such as inline \c if statements).
144
145
146
147
148
149
			 */
			#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
150
			 *  a block (such as inline \c if statements).
151
152
			 */
			#define MACROE                  while (0)
153

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

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

182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
			#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
201

202
203
204
205
206
207
208
209
			#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.
				 *
210
211
				 *  \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.
212
				 *
213
214
				 *  \ingroup Group_GlobalInt
				 *
215
216
				 *  \param Name  Unique name of the interrupt service routine.
				 */
Dean Camera's avatar
Dean Camera committed
217
				#define ISR(Name, ...)          void Name (void) __attribute__((__interrupt__)) __VA_ARGS__; void Name (void)
218
219
			#endif

220
221
222
223
		/* 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.
			 *
224
			 *  \param[in] Byte  Byte of data whose bits are to be reversed.
225
226
			 *
			 *  \return Input data with the individual bits reversed (mirrored).
227
228
229
230
231
232
233
234
235
236
			 */
			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;
			}
237

238
239
240
			/** 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.
241
242
			 *
			 *  \param[in] Milliseconds  Number of milliseconds to delay
243
			 */
244
245
			static inline void Delay_MS(uint16_t Milliseconds) ATTR_ALWAYS_INLINE;
			static inline void Delay_MS(uint16_t Milliseconds)
246
			{
247
				#if (ARCH == ARCH_AVR8)
248
				if (GCC_IS_COMPILE_CONST(Milliseconds))
249
250
251
252
253
254
255
256
257
				{
					_delay_ms(Milliseconds);
				}
				else
				{
					while (Milliseconds--)
					  _delay_ms(1);
				}
				#elif (ARCH == ARCH_UC3)
258
259
260
				while (Milliseconds--)
				{
					__builtin_mtsr(AVR32_COUNT, 0);
261
					while ((uint32_t)__builtin_mfsr(AVR32_COUNT) < (F_CPU / 1000));
262
				}
263
264
265
266
267
268
269
270
271
				#elif (ARCH == ARCH_XMEGA)
				if (GCC_IS_COMPILE_CONST(Milliseconds))
				{
					_delay_ms(Milliseconds);
				}
				else
				{
					while (Milliseconds--)
					  _delay_ms(1);
272
				}
273
				#endif
274
275
			}

276
277
278
279
			/** 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().
			 *
280
281
			 *  \ingroup Group_GlobalInt
			 *
282
283
284
285
286
287
288
289
290
291
			 *  \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)
292
293
294
				return __builtin_mfsr(AVR32_SR);
				#elif (ARCH == ARCH_XMEGA)
				return SREG;
295
296
297
298
299
300
301
302
303
				#endif

				GCC_MEMORY_BARRIER();
			}

			/** 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.
			 *
304
305
			 *  \ingroup Group_GlobalInt
			 *
306
307
308
309
310
311
312
313
314
315
316
317
318
319
			 *  \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);
320
				#elif (ARCH == ARCH_XMEGA)
321
				SREG = GlobalIntState;
322
				#endif
323

324
325
				GCC_MEMORY_BARRIER();
			}
326

327
328
329
330
			/** Enables global interrupt handling for the device, allowing interrupts to be handled.
			 *
			 *  \ingroup Group_GlobalInt
			 */
331
332
333
334
335
336
337
338
339
			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);
340
341
				#elif (ARCH == ARCH_XMEGA)
				sei();
342
343
344
				#endif

				GCC_MEMORY_BARRIER();
345
			}
346

347
348
349
350
			/** Disabled global interrupt handling for the device, preventing interrupts from being handled.
			 *
			 *  \ingroup Group_GlobalInt
			 */
351
352
353
354
355
356
357
358
359
			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);
360
361
				#elif (ARCH == ARCH_XMEGA)
				cli();
362
363
364
365
366
				#endif

				GCC_MEMORY_BARRIER();
			}

367
368
369
370
371
	/* Disable C linkage for C++ Compilers: */
		#if defined(__cplusplus)
			}
		#endif

372
373
374
#endif

/** @} */
375