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

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

/*
10
  Copyright 2011  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
45
 *
 *  Common utility headers containing macros, functions, enums and types which are common to all
 *  aspects of the library.
 *
 *  @{
 */

46
/** \defgroup Group_Debugging Debugging Macros
47
 *  \brief Convenience macros to aid in debugging applications.
48
 *
49
 *  Macros to aid debugging of a user application.
50
 */
51
52
53
54
55
56
 
/** \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.
 */
57

58
59
#ifndef __LUFA_COMMON_H__
#define __LUFA_COMMON_H__
60

61
	/* Macros: */
62
		#define __INCLUDE_FROM_COMMON_H
63
		
64
	/* Includes: */
65
66
		#include <stdint.h>
		#include <stdbool.h>
67
		#include <string.h>
68
		#include <stddef.h>
69
		
70
71
72
73
		#if defined(USE_LUFA_CONFIG_HEADER)
			#include "LUFAConfig.h"
		#endif

74
		#include "CompilerSpecific.h"
75
		#include "Architectures.h"
76
77
		#include "Attributes.h"
		#include "BoardTypes.h"
78
		
79
80
81
82
83
	/* Enable C linkage for C++ Compilers: */
		#if defined(__cplusplus)
			extern "C" {
		#endif

84
	/* Architecture specific utility includes: */
85
		#if defined(__DOXYGEN__)
Dean Camera's avatar
Dean Camera committed
86
87
88
89
			/** 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).
			 */
90
91
			typedef MACHINE_REG_t uint_reg_t;
		#elif (ARCH == ARCH_AVR8)
92
93
94
95
			#include <avr/io.h>
			#include <avr/interrupt.h>
			#include <avr/pgmspace.h>
			#include <avr/eeprom.h>
96
			#include <avr/boot.h>
97
			#include <util/delay.h>
98
			
99
			typedef uint8_t uint_reg_t;
100
			
101
102
103
104
105
			#define ARCH_HAS_EEPROM_ADDRESS_SPACE
			#define ARCH_HAS_FLASH_ADDRESS_SPACE
			#define ARCH_HAS_MULTI_ADDRESS_SPACE
			#define ARCH_LITTLE_ENDIAN

106
			#include "Endianness.h"
107
		#elif (ARCH == ARCH_UC3)
108
109
			#include <avr32/io.h>

110
			// === TODO: Find abstracted way to handle these ===
111
112
113
114
			#define PROGMEM                  const
			#define pgm_read_byte(x)         *x
			#define memcmp_P(...)            memcmp(__VA_ARGS__)
			#define memcpy_P(...)            memcpy(__VA_ARGS__)
115
			// =================================================
116
117
118

			typedef uint32_t uint_reg_t;
			
119
			#define ARCH_BIG_ENDIAN
120

121
			#include "Endianness.h"
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
		#elif (ARCH == ARCH_XMEGA)
			#include <avr/io.h>
			#include <avr/interrupt.h>
			#include <avr/pgmspace.h>
			#include <avr/eeprom.h>
			#include <util/delay.h>
			
			typedef uint8_t uint_reg_t;
			
			#define ARCH_HAS_EEPROM_ADDRESS_SPACE
			#define ARCH_HAS_FLASH_ADDRESS_SPACE
			#define ARCH_HAS_MULTI_ADDRESS_SPACE
			#define ARCH_LITTLE_ENDIAN

			#include "Endianness.h"		
137
138
		#else
			#error Unknown device architecture specified.
139
		#endif
140
141

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

157
158
159
160
161
162
163
164
165
166
			/** 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
			 */
167
168
169
			#if !defined(MAX) || defined(__DOXYGEN__)
				#define MAX(x, y)               ((x > y) ? x : y)
			#endif
170
171
172
173
174
175
176
177
178
179
180

			/** 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
			 */
181
182
183
			#if !defined(MIN) || defined(__DOXYGEN__)
				#define MIN(x, y)               ((x < y) ? x : y)
			#endif
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
			
			#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
204

205
			#if (ARCH == ARCH_AVR8) || defined(__DOXYGEN__)
206
				/** Defines a volatile \c NOP statement which cannot be optimized out by the compiler, and thus can always
207
				 *  be set as a breakpoint in the resulting code. Useful for debugging purposes, where the optimizer
208
209
				 *  removes/reorders code to the point where break points cannot reliably be set.
				 *
210
211
				 *  \note This macro is not available for all architectures.
				 *
212
213
214
				 *  \ingroup Group_Debugging
				 */
				#define JTAG_DEBUG_POINT()      __asm__ __volatile__ ("NOP" ::)
215

216
217
218
				/** Defines an explicit JTAG break point in the resulting binary via the assembly \c BREAK statement. When
				 *  a JTAG is used, this causes the program execution to halt when reached until manually resumed.
				 *
219
220
				 *  \note This macro is not available for all architectures.
				 *
221
222
223
224
225
226
				 *  \ingroup Group_Debugging
				 */
				#define JTAG_DEBUG_BREAK()      __asm__ __volatile__ ("BREAK" ::)

				/** Macro for testing condition "x" and breaking via \ref JTAG_DEBUG_BREAK() if the condition is false.
				 *
227
228
229
				 *  \note This macro is not available for all architectures.
				 *
				 *  \param[in] Condition  Condition that will be evaluated.
230
231
232
233
				 *
				 *  \ingroup Group_Debugging
				*/
				#define JTAG_DEBUG_ASSERT(Condition)    MACROS{ if (!(Condition)) { JTAG_DEBUG_BREAK(); } }MACROE
234

235
				/** Macro for testing condition "x" and writing debug data to the stdout stream if \c false. The stdout stream
236
237
				 *  must be pre-initialized before this macro is run and linked to an output device, such as the microcontroller's
				 *  USART peripheral.
238
239
240
				 *
				 *  The output takes the form "{FILENAME}: Function {FUNCTION NAME}, Line {LINE NUMBER}: Assertion {Condition} failed."
				 *
241
242
				 *  \note This macro is not available for all architectures.
				 *
243
244
245
246
247
248
249
				 *  \param[in] Condition  Condition that will be evaluated,
				 *
				 *  \ingroup Group_Debugging
				 */
				#define STDOUT_ASSERT(Condition)        MACROS{ if (!(x)) { printf_P(PSTR("%s: Function \"%s\", Line %d: "   \
				                                                "Assertion \"%s\" failed.\r\n"),     \
				                                                __FILE__, __func__, __LINE__, #Condition); } }MACROE
250
251
252
253
254
255
256
257
258
259
260
261
262
263

				#if !defined(pgm_read_ptr) || defined(__DOXYGEN__)
					/** Reads a pointer out of PROGMEM space on the AVR8 architecture. This is currently a wrapper for the
					 *  avr-libc \c pgm_read_ptr() macro with a \c void* cast, so that its value can be assigned directly
					 *  to a pointer variable or used in pointer arithmetic without further casting in C. In a future
					 *  avr-libc distribution this will be part of the standard API and will be implemented in a more formal
					 *  manner.
					 *
					 *  \note This macro is not available for all architectures.
					 *
					 *  \param[in] Address  Address of the pointer to read.
					 *
					 *  \return Pointer retrieved from PROGMEM space.
					 */
264
					#define pgm_read_ptr(Address)        (void*)pgm_read_word(Address)
265
				#endif
266
			#endif
267

268
269
270
271
272
273
274
275
			#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.
				 *
276
277
				 *  \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.
278
				 *
279
280
				 *  \ingroup Group_GlobalInt
				 *
281
282
				 *  \param Name  Unique name of the interrupt service routine.
				 */
283
				#define ISR(Name, ...)                  void Name (void) __attribute__((__interrupt__)) __VA_ARGS__; void Name (void)
284
285
			#endif

286
287
288
289
		/* 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.
			 *
290
			 *  \param[in] Byte  Byte of data whose bits are to be reversed.
291
292
293
294
295
296
297
298
299
300
			 */
			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;
			}
301

302
303
304
			/** 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.
305
306
			 *
			 *  \param[in] Milliseconds  Number of milliseconds to delay
307
			 */
308
			static inline void Delay_MS(uint8_t Milliseconds) ATTR_ALWAYS_INLINE;
309
310
			static inline void Delay_MS(uint8_t Milliseconds)
			{
311
				#if (ARCH == ARCH_AVR8)
312
				if (GCC_IS_COMPILE_CONST(Milliseconds))
313
314
315
316
317
318
319
320
321
				{
					_delay_ms(Milliseconds);
				}
				else
				{
					while (Milliseconds--)
					  _delay_ms(1);
				}
				#elif (ARCH == ARCH_UC3)
322
323
324
325
326
				while (Milliseconds--)
				{
					__builtin_mtsr(AVR32_COUNT, 0);
					while (__builtin_mfsr(AVR32_COUNT) < (F_CPU / 1000));				
				}
327
328
329
330
331
332
333
334
335
336
				#elif (ARCH == ARCH_XMEGA)
				if (GCC_IS_COMPILE_CONST(Milliseconds))
				{
					_delay_ms(Milliseconds);
				}
				else
				{
					while (Milliseconds--)
					  _delay_ms(1);
				}				
337
				#endif
338
339
			}

340
341
342
343
			/** 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().
			 *
344
345
			 *  \ingroup Group_GlobalInt
			 *
346
347
348
349
350
351
352
353
354
355
			 *  \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)
356
357
358
				return __builtin_mfsr(AVR32_SR);
				#elif (ARCH == ARCH_XMEGA)
				return SREG;
359
360
361
362
363
364
365
366
367
				#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.
			 *
368
369
			 *  \ingroup Group_GlobalInt
			 *
370
371
372
373
374
375
376
377
378
379
380
381
382
383
			 *  \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);
384
385
				#elif (ARCH == ARCH_XMEGA)
				SREG = GlobalIntState;				
386
387
388
389
390
				#endif
				
				GCC_MEMORY_BARRIER();
			}
		
391
392
393
394
			/** Enables global interrupt handling for the device, allowing interrupts to be handled.
			 *
			 *  \ingroup Group_GlobalInt
			 */
395
396
397
398
399
400
401
402
403
			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);
404
405
				#elif (ARCH == ARCH_XMEGA)
				sei();
406
407
408
409
410
				#endif

				GCC_MEMORY_BARRIER();
			}		

411
412
413
414
			/** Disabled global interrupt handling for the device, preventing interrupts from being handled.
			 *
			 *  \ingroup Group_GlobalInt
			 */
415
416
417
418
419
420
421
422
423
			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);
424
425
				#elif (ARCH == ARCH_XMEGA)
				cli();
426
427
428
429
430
				#endif

				GCC_MEMORY_BARRIER();
			}

431
432
433
434
435
	/* Disable C linkage for C++ Compilers: */
		#if defined(__cplusplus)
			}
		#endif

436
437
438
#endif

/** @} */
439