Common.h 9.95 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
32
33
34
35
36
  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
 *  \brief Common library convenience macros and functions.
 *
 *  This file contains macros which are common to all library elements, and which may be useful in user code. It
 *  also includes other common headers, such as Atomic.h, Attributes.h and BoardTypes.h.
 */
37

38
39
40
41
42
43
44
45
46
47
48
49
/** @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.
 */
50

51
52
53
54
55
56
57
58
59
/** @defgroup Group_BitManip Endian and Bit Macros
 *
 *  Functions for swapping endianness and reversing bit orders.
 */

#ifndef __COMMON_H__
#define __COMMON_H__

	/* Includes: */
60
61
		#include <stdint.h>
		#include <stdbool.h>
62

63
64
65
66
		#include "Attributes.h"
		#include "BoardTypes.h"

	/* Public Interface - May be used in end-application: */
67
		/* Macros: */
68
69
70
71
72
73
74
75
76
77
78
79
80
			/** 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
			 *  a block (such as inline IF statements).
			 */
			#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
			 *  a block (such as inline IF statements).
			 */
			#define MACROE                  while (0)
81

82
			/** Defines a volatile NOP statement which cannot be optimized out by the compiler, and thus can always
83
			 *  be set as a breakpoint in the resulting code. Useful for debugging purposes, where the optimiser
84
85
86
87
			 *  removes/reorders code to the point where break points cannot reliably be set.
			 *
			 *  \ingroup Group_Debugging
			 */
88
			#define JTAG_DEBUG_POINT()      __asm__ __volatile__ ("NOP" ::)
89
90
91
92
93
94

			/** Defines an explicit JTAG break point in the resulting binary via the ASM BREAK statement. When
			 *  a JTAG is used, this causes the program execution to halt when reached until manually resumed.
			 *
			 *  \ingroup Group_Debugging
			 */
95
			#define JTAG_DEBUG_BREAK()      __asm__ __volatile__ ("BREAK" ::)
96

97
			/** Macro for testing condition "x" and breaking via JTAG_DEBUG_BREAK() if the condition is false.
98
99
			 *
			 *  \param[in] Condition  Condition that will be evaluated,
100
101
102
			 *
			 *  \ingroup Group_Debugging
			*/
103
			#define JTAG_DEBUG_ASSERT(Condition)    MACROS{ if (!(Condition)) { JTAG_DEBUG_BREAK(); } }MACROE
104

105
106
107
			/** Macro for testing condition "x" and writing debug data to the stdout stream if false. The stdout stream
			 *  must be pre-initialized before this macro is run and linked to an output device, such as the AVR's USART
			 *  peripheral.
108
			 *
109
			 *  The output takes the form "{FILENAME}: Function {FUNCTION NAME}, Line {LINE NUMBER}: Assertion {Condition} failed."
110
			 *
111
112
			 *  \param[in] Condition  Condition that will be evaluated,
			 *
113
114
			 *  \ingroup Group_Debugging
			 */
115
116
			#define STDOUT_ASSERT(Condition)        MACROS{ if (!(x)) { printf_P(PSTR("%s: Function \"%s\", Line %d: "   \
			                                                "Assertion \"%s\" failed.\r\n"),     \
117
			                                                __FILE__, __func__, __LINE__, #Condition); } }MACROE
118
119
120
121
122
123
124
125
126
127
			
			/** Forces GCC to use pointer indirection (via the AVR's pointer register pairs) when accessing the given
			 *  struct pointer. In some cases GCC will emit non-optimal assembly code when accessing a structure through
			 *  a pointer, resulting in a larger binary. When this macro is used on a (non-const) structure pointer before
			 *  use, it will force GCC to use pointer indirection on the elements rather than direct store and load
			 *  instructions.
			 *
			 *  \param[in, out] StructPtr  Pointer to a structure which is to be forced into indirect access mode.
			 */
			#define GCC_FORCE_POINTER_ACCESS(StructPtr) __asm__ __volatile__("" : "=b" (StructPtr) : "0" (StructPtr))
128
129
130

			#if !defined(pgm_read_ptr) || defined(__DOXYGEN__)
				/** Reads a pointer out of PROGMEM space. This is currently a wrapper for the avr-libc pgm_read_ptr()
131
				 *  macro with a void* cast, so that its value can be assigned directly to a pointer variable or used
132
133
134
135
136
137
138
139
140
141
142
143
				 *  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.
				 *
				 *  \param[in] Addr  Address of the pointer to read.
				 *
				 *  \return Pointer retrieved from PROGMEM space.
				 */
				#define pgm_read_ptr(Addr)    (void*)pgm_read_word(Addr)
			#endif

			/** Swaps the byte ordering of a 16-bit value at compile time. Do not use this macro for swapping byte orderings
			 *  of dynamic values computed at runtime, use \ref SwapEndian_16() instead. The result of this macro can be used
144
			 *  inside struct or other variable initializers outside of a function, something that is not possible with the
145
146
147
148
149
150
151
152
153
154
			 *  inline function variant.
			 *
			 *  \param[in]  x  16-bit value whose byte ordering is to be swapped.
			 *
			 *  \return Input value with the byte ordering reversed.
			 */
			#define SWAPENDIAN_16(x)          ((((x) & 0xFF00) >> 8) | (((x) & 0x00FF) << 8))

			/** Swaps the byte ordering of a 32-bit value at compile time. Do not use this macro for swapping byte orderings
			 *  of dynamic values computed at runtime- use \ref SwapEndian_32() instead. The result of this macro can be used
155
			 *  inside struct or other variable initializers outside of a function, something that is not possible with the
156
157
158
159
160
161
162
163
			 *  inline function variant.
			 *
			 *  \param[in]  x  32-bit value whose byte ordering is to be swapped.
			 *
			 *  \return Input value with the byte ordering reversed.
			 */
			#define SWAPENDIAN_32(x)          ((((x) & 0xFF000000UL) >> 24UL) | (((x) & 0x00FF0000UL) >> 8UL) | \
			                                   (((x) & 0x0000FF00UL) << 8UL)  | (((x) & 0x000000FFUL) << 24UL))
164

165
166
167
168
169
170
		/* 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.
			 *
			 *  \ingroup Group_BitManip
			 *
171
			 *  \param[in] Byte  Byte of data whose bits are to be reversed.
172
173
174
175
176
177
178
179
180
181
			 */
			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;
			}
182

183
184
185
186
			/** Function to reverse the byte ordering of the individual bytes in a 16 bit number.
			 *
			 *  \ingroup Group_BitManip
			 *
187
			 *  \param[in] Word  Word of data whose bytes are to be swapped.
188
			 */
189
190
			static inline uint16_t SwapEndian_16(const uint16_t Word) ATTR_WARN_UNUSED_RESULT ATTR_CONST;
			static inline uint16_t SwapEndian_16(const uint16_t Word)
191
			{
192
193
194
195
196
197
198
				uint8_t Temp;

				union
				{
					uint16_t Word;
					uint8_t  Bytes[2];
				} Data;
199

200
				Data.Word = Word;
201

202
203
204
				Temp = Data.Bytes[0];
				Data.Bytes[0] = Data.Bytes[1];
				Data.Bytes[1] = Temp;
205

206
				return Data.Word;
207
208
209
210
211
212
			}

			/** Function to reverse the byte ordering of the individual bytes in a 32 bit number.
			 *
			 *  \ingroup Group_BitManip
			 *
213
			 *  \param[in] DWord  Double word of data whose bytes are to be swapped.
214
			 */
215
216
			static inline uint32_t SwapEndian_32(const uint32_t DWord) ATTR_WARN_UNUSED_RESULT ATTR_CONST;
			static inline uint32_t SwapEndian_32(const uint32_t DWord)
217
			{
218
219
220
221
222
223
224
				uint8_t Temp;

				union
				{
					uint32_t DWord;
					uint8_t  Bytes[4];
				} Data;
225

226
				Data.DWord = DWord;
227

228
229
230
				Temp = Data.Bytes[0];
				Data.Bytes[0] = Data.Bytes[3];
				Data.Bytes[3] = Temp;
231

232
233
234
				Temp = Data.Bytes[1];
				Data.Bytes[1] = Data.Bytes[2];
				Data.Bytes[2] = Temp;
235

236
				return Data.DWord;
237
238
239
240
241
242
			}

			/** Function to reverse the byte ordering of the individual bytes in a n byte number.
			 *
			 *  \ingroup Group_BitManip
			 *
243
244
			 *  \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.
245
			 */
246
247
248
249
			static inline void SwapEndian_n(void* Data,
			                                uint8_t Bytes) ATTR_NON_NULL_PTR_ARG(1);
			static inline void SwapEndian_n(void* Data,
			                                uint8_t Bytes)
250
			{
251
				uint8_t* CurrDataPos = (uint8_t*)Data;
252

253
				while (Bytes > 1)
254
255
256
257
258
259
260
261
262
263
264
265
266
				{
					uint8_t Temp = *CurrDataPos;
					*CurrDataPos = *(CurrDataPos + Bytes - 1);
					*(CurrDataPos + Bytes - 1) = Temp;

					CurrDataPos++;
					Bytes -= 2;
				}
			}

#endif

/** @} */
267