Common.h 7.31 KB
Newer Older
1
2
/*
             LUFA Library
Dean Camera's avatar
Dean Camera committed
3
     Copyright (C) Dean Camera, 2010.
4
5
6
7
8
9
              
  dean [at] fourwalledcubicle [dot] com
      www.fourwalledcubicle.com
*/

/*
Dean Camera's avatar
Dean Camera committed
10
  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
11

12
13
14
15
16
17
18
  Permission to use, copy, modify, distribute, and sell this 
  software and its documentation for any purpose is hereby granted
  without fee, provided that the above copyright notice appear in 
  all copies and that both that the copyright notice and this
  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
32
33
  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
 *
 *  This file contains macros which are common to all library elements, and which may be useful in user code. It
34
 *  also includes other common headers, such as Atomic.h, FunctionAttributes.h and BoardTypes.h.
35
 */
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
/** @defgroup Group_Common Common Utility Headers - LUFA/Drivers/Common/Common.h
 *
 *  Common utility headers containing macros, functions, enums and types which are common to all
 *  aspects of the library.
 *
 *  @{
 */

/** @defgroup Group_Debugging Debugging Macros
 *
 *  Macros for debugging use.
 */
 
/** @defgroup Group_BitManip Endian and Bit Macros
 *
 *  Functions for swapping endianness and reversing bit orders.
 */
54
55
56
57
58

#ifndef __COMMON_H__
#define __COMMON_H__

	/* Includes: */
59
60
61
62
63
64
		#if defined(__AVR32__)
			#include <avr32/io.h>
			#include <stdint.h>

			#include "Atomic.h"

65
			#define PROGMEM const
66
67
68
69
		#else
			#include <avr/io.h>
		#endif

70
71
72
73
74
		#include "FunctionAttributes.h"
		#include "BoardTypes.h"

	/* Public Interface - May be used in end-application: */
		/* Macros: */		
75
			/** Macro for encasing other multi-statement macros. This should be used along with an opening brace
76
			 *  before the start of any multi-statement macro, so that the macros contents as a whole are treated
77
78
			 *  as a discrete block and not as a list of separate statements which may cause problems when used as
			 *  a block (such as inline IF statements).
79
80
81
			 */
			#define MACROS                  do

82
			/** Macro for encasing other multi-statement macros. This should be used along with a preceding closing
83
			 *  brace at the end of any multi-statement macro, so that the macros contents as a whole are treated
84
85
			 *  as a discrete block and not as a list of separate statements which may cause problems when used as
			 *  a block (such as inline IF statements).
86
87
88
			 */
			#define MACROE                  while (0)
			
89
			/** Defines a volatile NOP statement which cannot be optimized out by the compiler, and thus can always
90
91
			 *  be set as a breakpoint in the resulting code. Useful for debugging purposes, where the optimizer
			 *  removes/reorders code to the point where break points cannot reliably be set.
92
93
			 *
			 *  \ingroup Group_Debugging
94
95
96
			 */
			#define JTAG_DEBUG_POINT()      asm volatile ("NOP" ::)

97
			/** Defines an explicit JTAG break point in the resulting binary via the ASM BREAK statement. When
98
99
100
101
			 *  a JTAG is used, this causes the program execution to halt when reached until manually resumed.
			 *
			 *  \ingroup Group_Debugging
			 */
102
103
			#define JTAG_DEBUG_BREAK()      asm volatile ("BREAK" ::)
			
104
105
106
107
			/** Macro for testing condition "x" and breaking via JTAG_DEBUG_BREAK() if the condition is false.
			 *
			 *  \ingroup Group_Debugging
			*/
108
109
110
			#define JTAG_DEBUG_ASSERT(x)    MACROS{ if (!(x)) { JTAG_DEBUG_BREAK(); } }MACROE

			/** Macro for testing condition "x" and writing debug data to the serial stream if false. As a
111
			 *  prerequisite for this macro, the serial stream should be configured via the Peripheral/SerialStream driver.
112
113
114
			 *
			 *  The serial output takes the form "{FILENAME}: Function {FUNCTION NAME}, Line {LINE NUMBER}: Assertion
			 *  {x} failed."
115
116
			 *
			 *  \ingroup Group_Debugging
117
118
119
120
121
122
123
124
125
126
			 */
			#define SERIAL_STREAM_ASSERT(x) MACROS{ if (!(x)) { printf_P(PSTR("%s: Function \"%s\", Line %d: "   \
																"Assertion \"%s\" failed.\r\n"),   \
																__FILE__, __func__, __LINE__, #x); \
			                                } }MACROE

		/* 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.
			 *
127
128
			 *  \ingroup Group_BitManip
			 *
129
			 *  \param[in] Byte   Byte of data whose bits are to be reversed
130
131
132
133
134
135
136
137
138
139
140
141
			 */
			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;
			}
			
			/** Function to reverse the byte ordering of the individual bytes in a 16 bit number.
142
143
			 *
			 *  \ingroup Group_BitManip
144
			 *
145
			 *  \param[in] Word   Word of data whose bytes are to be swapped
146
147
148
149
150
151
152
153
			 */
			static inline uint16_t SwapEndian_16(uint16_t Word) ATTR_WARN_UNUSED_RESULT ATTR_CONST;
			static inline uint16_t SwapEndian_16(uint16_t Word)
			{
				return ((Word >> 8) | (Word << 8));				
			}

			/** Function to reverse the byte ordering of the individual bytes in a 32 bit number.
154
155
			 *
			 *  \ingroup Group_BitManip
156
			 *
157
			 *  \param[in] DWord   Double word of data whose bytes are to be swapped
158
159
160
161
162
163
164
165
166
167
168
			 */
			static inline uint32_t SwapEndian_32(uint32_t DWord) ATTR_WARN_UNUSED_RESULT ATTR_CONST;
			static inline uint32_t SwapEndian_32(uint32_t DWord)
			{
				return (((DWord & 0xFF000000) >> 24) |
				        ((DWord & 0x00FF0000) >> 8)  |
						((DWord & 0x0000FF00) << 8)  |
						((DWord & 0x000000FF) << 24));
			}

			/** Function to reverse the byte ordering of the individual bytes in a n byte number.
169
170
			 *
			 *  \ingroup Group_BitManip
171
			 *
172
173
			 *  \param[in,out] Data  Pointer to a number containing an even number of bytes to be reversed
			 *  \param[in] Bytes  Length of the data in bytes
174
175
176
177
178
179
180
181
182
183
			 */
			static inline void SwapEndian_n(uint8_t* Data, uint8_t Bytes);
			static inline void SwapEndian_n(uint8_t* Data, uint8_t Bytes)
			{
				uint8_t Temp;
				
				while (Bytes)
				{
					Temp = *Data;
					*Data = *(Data + Bytes - 1);
184
					*(Data + Bytes - 1) = Temp;
185
186
187
188
189
190

					Data++;
					Bytes -= 2;
				}
			}

191
192
		/* Type Defines: */
			#if defined(__AVR32__)
193
				/** Type define for an unsigned native word-sized chunk of data. */
194
				typedef uint32_t uintN_t;
195
196

				/** Type define for a signed native word-sized chunk of data. */
197
198
				typedef int32_t intN_t;
			#else
199
				/** Type define for an unsigned native word-sized chunk of data. */
200
				typedef uint8_t uintN_t;
201
202

				/** Type define for a signed native word-sized chunk of data. */
203
204
				typedef int8_t intN_t;
			#endif
205
#endif
206
207

/** @} */