Added board hardware driver support for the Olimex AVR-USB-162 development board (thanks to Steve Fawcett).

13 files changed, 261 insertions, 7 deletions

diff --git a/LUFA/Common/BoardTypes.h b/LUFA/Common/BoardTypes.h
index 4849384fc..57fc12216 100644
--- a/LUFA/Common/BoardTypes.h
+++ b/LUFA/Common/BoardTypes.h
@@ -107,6 +107,9 @@
 			/** Selects the JM-DB-U2 specific board drivers, including the Button and LEDs drivers. */
 			#define BOARD_JMDBU2        14
 
+			/** Selects the Olimex AVR-USB-162 specific board drivers, including the Button and LEDs drivers. */
+			#define BOARD_OLIMEX162     15
+			
 			#if !defined(__DOXYGEN__)
 				#define BOARD_          BOARD_NONE
 				
diff --git a/LUFA/Drivers/Board/Buttons.h b/LUFA/Drivers/Board/Buttons.h
index 02550a1db..10ad18fca 100644
--- a/LUFA/Drivers/Board/Buttons.h
+++ b/LUFA/Drivers/Board/Buttons.h
@@ -39,6 +39,8 @@
  *
  *  If the BOARD value is set to BOARD_USER, this will include the /Board/Buttons.h file in the user project
  *  directory.
+ *
+ *  For possible BOARD makefile values, see \ref Group_BoardTypes.
  */
 
 /** \ingroup Group_BoardDrivers
@@ -56,6 +58,8 @@
  *  If the BOARD value is set to BOARD_USER, this will include the /Board/Dataflash.h file in the user project
  *  directory. Otherwise, it will include the appropriate built in board driver header file.
  *
+ *  For possible BOARD makefile values, see \ref Group_BoardTypes.
+ *
  *  @{
  */
 
@@ -91,6 +95,8 @@
 		#include "BENITO/Buttons.h"
 	#elif (BOARD == BOARD_JMDBU2)
 		#include "JMDBU2/Buttons.h"
+	#elif (BOARD == BOARD_OLIMEX162)
+		#include "OLIMEX162/Buttons.h"
 	#elif (BOARD == BOARD_USER)
 		#include "Board/Buttons.h"
 	#else
diff --git a/LUFA/Drivers/Board/Dataflash.h b/LUFA/Drivers/Board/Dataflash.h
index 92eae7a8f..b4bd39da0 100644
--- a/LUFA/Drivers/Board/Dataflash.h
+++ b/LUFA/Drivers/Board/Dataflash.h
@@ -39,6 +39,8 @@
  *
  *  If the BOARD value is set to BOARD_USER, this will include the /Board/Dataflash.h file in the user project
  *  directory.
+ *
+ *  For possible BOARD makefile values, see \ref Group_BoardTypes.
  */
  
 /** \ingroup Group_BoardDrivers
@@ -55,6 +57,8 @@
  *  If the BOARD value is set to BOARD_USER, this will include the /Board/Dataflash.h file in the user project
  *  directory. Otherwise, it will include the appropriate built in board driver header file.
  *
+ *  For possible BOARD makefile values, see \ref Group_BoardTypes.
+ *
  *  @{
  */
  
diff --git a/LUFA/Drivers/Board/Joystick.h b/LUFA/Drivers/Board/Joystick.h
index 4119a9be5..f4423fb23 100644
--- a/LUFA/Drivers/Board/Joystick.h
+++ b/LUFA/Drivers/Board/Joystick.h
@@ -39,6 +39,8 @@
  *
  *  If the BOARD value is set to BOARD_USER, this will include the /Board/Joystick.h file in the user project
  *  directory.
+ *
+ *  For possible BOARD makefile values, see \ref Group_BoardTypes. 
  */
  
 /** \ingroup Group_BoardDrivers
@@ -55,6 +57,8 @@
  *  If the BOARD value is set to BOARD_USER, this will include the /Board/Dataflash.h file in the user project
  *  directory. Otherwise, it will include the appropriate built in board driver header file.
  *
+ *  For possible BOARD makefile values, see \ref Group_BoardTypes.
+ *
  *  @{
  */
 
diff --git a/LUFA/Drivers/Board/LEDs.h b/LUFA/Drivers/Board/LEDs.h
index b8e45559f..8ebcc06f7 100644
--- a/LUFA/Drivers/Board/LEDs.h
+++ b/LUFA/Drivers/Board/LEDs.h
@@ -39,6 +39,8 @@
  *
  *  If the BOARD value is set to BOARD_USER, this will include the /Board/LEDs.h file in the user project
  *  directory.
+ *
+ *  For possible BOARD makefile values, see \ref Group_BoardTypes.
  */
 
 /** \ingroup Group_BoardDrivers
@@ -56,6 +58,8 @@
  *  directory. Otherwise, it will include the appropriate built in board driver header file. If the BOARD value
  *  is set to BOARD_NONE, this driver is silently disabled.
  *
+ *  For possible BOARD makefile values, see \ref Group_BoardTypes.
+ *
  *  \note To make code as compatible as possible, it is assumed that all boards carry a minimum of four LEDs. If
  *        a board contains less than four LEDs, the remaining LED masks are defined to 0 so as to have no effect.
  *        If other behaviour is desired, either alias the remaining LED masks to existing LED masks via the -D 
@@ -111,6 +115,8 @@
 		#include "BENITO/LEDs.h"
 	#elif (BOARD == BOARD_JMDBU2)
 		#include "JMDBU2/LEDs.h"
+	#elif (BOARD == BOARD_OLIMEX162)
+		#include "OLIMEX162/LEDs.h"
 	#elif (BOARD == BOARD_USER)
 		#include "Board/LEDs.h"
 	#endif
diff --git a/LUFA/Drivers/Board/OLIMEX162/Buttons.h b/LUFA/Drivers/Board/OLIMEX162/Buttons.h
new file mode 100644
index 000000000..f5e8fda80
--- /dev/null
+++ b/LUFA/Drivers/Board/OLIMEX162/Buttons.h
@@ -0,0 +1,97 @@
+/*

+             LUFA Library

+     Copyright (C) Dean Camera, 2010.

+              

+  dean [at] fourwalledcubicle [dot] com

+      www.fourwalledcubicle.com

+*/

+

+/*

+  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)

+

+  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 

+  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 Board specific Buttons driver header for the Olimex AVR-USB-162 Development Board.

+ *

+ *  Board specific Buttons driver header for the Olimex AVR-USB-162 Development Board (http://www.olimex.com/dev/avr-usb-162.html).

+ *

+ *  \note This file should not be included directly. It is automatically included as needed by the Buttons driver

+ *        dispatch header located in LUFA/Drivers/Board/Buttons.h.

+ */

+ 

+/** \ingroup Group_Buttons

+ *  @defgroup Group_Buttons_OLIMEX162 OLIMEX162

+ *

+ *  Board specific Buttons driver header for the Olimex AVR-USB-162 Development Board (http://www.olimex.com/dev/avr-usb-162.html).

+ *

+ *  \note This file should not be included directly. It is automatically included as needed by the Buttons driver

+ *        dispatch header located in LUFA/Drivers/Board/Buttons.h.

+ *

+ *  @{

+ */

+

+#ifndef __BUTTONS_OLIMEX162_H__

+#define __BUTTONS_OLIMEX162_H__

+

+	/* Includes: */

+		#include <avr/io.h>

+		#include <stdbool.h>

+

+		#include "../../../Common/Common.h"

+

+	/* Enable C linkage for C++ Compilers: */

+		#if defined(__cplusplus)

+			extern "C" {

+		#endif

+

+	/* Preprocessor Checks: */

+		#if !defined(__INCLUDE_FROM_BUTTONS_H)

+			#error Do not include this file directly. Include LUFA/Drivers/Board/Buttons.h instead.

+		#endif

+		

+	/* Public Interface - May be used in end-application: */

+		/* Macros: */

+			/** Button mask for the first button on the board. */

+			#define BUTTONS_BUTTON1      (1 << 7)

+	

+		/* Inline Functions: */

+		#if !defined(__DOXYGEN__)

+			static inline void Buttons_Init(void)

+			{

+				DDRD  &= ~BUTTONS_BUTTON1;

+				PORTD |=  BUTTONS_BUTTON1;

+			}

+

+			static inline uint8_t Buttons_GetStatus(void) ATTR_WARN_UNUSED_RESULT;

+			static inline uint8_t Buttons_GetStatus(void)

+			{

+				return ((PIND & BUTTONS_BUTTON1) ^ BUTTONS_BUTTON1);

+			}

+		#endif

+

+	/* Disable C linkage for C++ Compilers: */

+		#if defined(__cplusplus)

+			}

+		#endif

+			

+#endif

+

+/** @} */

diff --git a/LUFA/Drivers/Board/OLIMEX162/LEDs.h b/LUFA/Drivers/Board/OLIMEX162/LEDs.h
new file mode 100644
index 000000000..625d953dc
--- /dev/null
+++ b/LUFA/Drivers/Board/OLIMEX162/LEDs.h
@@ -0,0 +1,128 @@
+/*

+             LUFA Library

+     Copyright (C) Dean Camera, 2010.

+              

+  dean [at] fourwalledcubicle [dot] com

+      www.fourwalledcubicle.com

+*/

+

+/*

+  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)

+

+  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 

+  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 Board specific LED driver header for the Olimex AVR-USB-162 Development Board.

+ *

+ *  Board specific LED driver header for the Olimex AVR-USB-162 Development Board (http://www.olimex.com/dev/avr-usb-162.html).

+ *

+ *  \note This file should not be included directly. It is automatically included as needed by the LEDs driver

+ *        dispatch header located in LUFA/Drivers/Board/LEDs.h.

+ */

+

+/** \ingroup Group_LEDs

+ *  @defgroup Group_LEDs_OLIMEX162 OLIMEX162

+ *

+ *  Board specific LED driver header for the Olimex AVR-USB-162 Development Board (http://www.olimex.com/dev/avr-usb-162.html).

+ *

+ *  \note This file should not be included directly. It is automatically included as needed by the LEDs driver

+ *        dispatch header located in LUFA/Drivers/Board/LEDs.h.

+ *

+ *  @{

+ */

+ 

+#ifndef __LEDS_OLIMEX162_H__

+#define __LEDS_OLIMEX162_H__

+

+	/* Includes: */

+		#include <avr/io.h>

+

+		#include "../../../Common/Common.h"

+

+	/* Enable C linkage for C++ Compilers: */

+		#if defined(__cplusplus)

+			extern "C" {

+		#endif

+

+	/* Preprocessor Checks: */

+		#if !defined(__INCLUDE_FROM_LEDS_H)

+			#error Do not include this file directly. Include LUFA/Drivers/Board/LEDS.h instead.

+		#endif

+

+	/* Public Interface - May be used in end-application: */

+		/* Macros: */

+			/** LED mask for the first LED on the board. */

+			#define LEDS_LED1             (1 << 4)

+

+			/** LED mask for all the LEDs on the board. */

+			#define LEDS_ALL_LEDS         (1 << 4)

+

+			/** LED mask for the none of the board LEDs. */

+			#define LEDS_NO_LEDS          0

+			

+		/* Inline Functions: */

+		#if !defined(__DOXYGEN__)

+			static inline void LEDs_Init(void)

+			{

+				DDRD  |= LEDS_ALL_LEDS;

+				PORTD |= LEDS_ALL_LEDS;

+			}

+			

+			static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask)

+			{

+				PORTD &= ~LEDMask;

+			}

+

+			static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask)

+			{

+				PORTD |= LEDMask;

+			}

+

+			static inline void LEDs_SetAllLEDs(const uint8_t LEDMask)

+			{

+				PORTD = ((PORTD | LEDS_ALL_LEDS) & ~LEDMask);

+			}

+			

+			static inline void LEDs_ChangeLEDs(const uint8_t LEDMask,

+			                                   const uint8_t ActiveMask)

+			{

+				PORTD = ((PORTD | LEDMask) & ~ActiveMask);

+			}

+			

+			static inline void LEDs_ToggleLEDs(const uint8_t LEDMask)

+			{

+				PORTD ^= LEDMask;

+			}

+

+			static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT;

+			static inline uint8_t LEDs_GetLEDs(void)

+			{

+				return (~PORTD & LEDS_ALL_LEDS);

+			}

+		#endif

+

+	/* Disable C linkage for C++ Compilers: */

+		#if defined(__cplusplus)

+			}

+		#endif

+	

+#endif

+

+/** @} */

diff --git a/LUFA/Drivers/Board/Temperature.h b/LUFA/Drivers/Board/Temperature.h
index d07446a67..40d8e9890 100644
--- a/LUFA/Drivers/Board/Temperature.h
+++ b/LUFA/Drivers/Board/Temperature.h
@@ -31,7 +31,7 @@
 /** \file
  *  \brief Master include file for the board temperature sensor driver.
  *
- *  Master include file for the board temperature sensor driver, for the USB boards which contain a temperature sensor.
+ *  Master include file for the board temperature sensor driver, for the USB boards which contain a temperature sensor. 
  */
 
 /** \ingroup Group_BoardDrivers
diff --git a/LUFA/Drivers/USB/LowLevel/Host.h b/LUFA/Drivers/USB/LowLevel/Host.h
index 3f639c158..aae1fa2f0 100644
--- a/LUFA/Drivers/USB/LowLevel/Host.h
+++ b/LUFA/Drivers/USB/LowLevel/Host.h
@@ -139,20 +139,20 @@
 				                                               *   
 				                                               *   \note Do not manually change to this state in the user code.
 				                                               */
-				HOST_STATE_Powered_WaitForDeviceSettle = 4,   /**< Internally implemented by the library. This state indicates
+				HOST_STATE_Powered_WaitForDeviceSettle  = 4,  /**< Internally implemented by the library. This state indicates
 				                                               *   that the stack is waiting for the initial settling period to
 				                                               *   elapse before beginning the enumeration process.
 				                                               *   
 				                                               *   \note Do not manually change to this state in the user code.
 				                                               */
-				HOST_STATE_Powered_WaitForConnect      = 5,   /**< Internally implemented by the library. This state indicates
+				HOST_STATE_Powered_WaitForConnect       = 5,  /**< Internally implemented by the library. This state indicates
 				                                               *   that the stack is waiting for a connection event from the USB
 				                                               *   controller to indicate a valid USB device has been attached to
 				                                               *   the bus and is ready to be enumerated.
 				                                               *   
 				                                               *   \note Do not manually change to this state in the user code.
 				                                               */
-				HOST_STATE_Powered_DoReset             = 6,   /**< Internally implemented by the library. This state indicates
+				HOST_STATE_Powered_DoReset              = 6,  /**< Internally implemented by the library. This state indicates
 				                                               *   that a valid USB device has been attached, and that it is
 				                                               *   will now be reset to ensure it is ready for enumeration.
 				                                               *   
diff --git a/LUFA/ManPages/ChangeLog.txt b/LUFA/ManPages/ChangeLog.txt
index d7e5f5cef..20590f498 100644
--- a/LUFA/ManPages/ChangeLog.txt
+++ b/LUFA/ManPages/ChangeLog.txt
@@ -11,6 +11,7 @@
   *  - Added new SCSI_ASENSE_NOT_READY_TO_READY_CHANGE constant to the Mass Storage class driver, to indicate when a previously
   *    not ready removable medium has now become ready for the host's use (thanks to Martin Degelsegger)
   *  - Moved the Pipe and Endpoint stream related code to two new USB library core source files EndpointStream.c and PipeStream.c
+  *  - Added board hardware driver support for the Olimex AVR-USB-162 development board (thanks to Steve Fawcett)
   *
   *  <b>Changed:</b>
   *  - Removed complicated logic for the Endpoint_ConfigureEndpoint() function to use inlined or function called versions
diff --git a/LUFA/ManPages/DeviceSupport.txt b/LUFA/ManPages/DeviceSupport.txt
index 47cfc4ad7..83bb0f8cb 100644
--- a/LUFA/ManPages/DeviceSupport.txt
+++ b/LUFA/ManPages/DeviceSupport.txt
@@ -35,7 +35,8 @@
  *   - Benito
  *   - JM-DB-U2
  *   - Teensy (all revisions and versions)
- *   - USBTINY MKII (all revisions and versions)
+ *   - USBTINY-MKII (all revisions and versions)
+ *   - Olimex AVR-USB-162
  *   - Any Other Custom User Boards (with Board Drivers if desired, see \ref Page_WritingBoardDrivers)
  */
  
\ No newline at end of file
diff --git a/LUFA/ManPages/LUFAPoweredProjects.txt b/LUFA/ManPages/LUFAPoweredProjects.txt
index 7ab60e35e..0165014b2 100644
--- a/LUFA/ManPages/LUFAPoweredProjects.txt
+++ b/LUFA/ManPages/LUFAPoweredProjects.txt
@@ -20,12 +20,12 @@
  *
  *  - AT90USB162 Breadboard PCB (Russian): http://microsin.ru/content/view/685/44/
  *  - Benito #7, a no-frills USB board: http://www.dorkbotpdx.org/wiki/benito
- *  - JM-DB-U2, an ATMEGA32U2 development board: http://www.mattairtech.com/index.php/development-boards/atmega32u2-development-board.html
+ *  - JM-DB-U2, an ATMEGA32U2 development board: http://u2.mattair.net/index.html
  *  - Micropendous, an open design/source set of AVR USB development boards: http://micropendous.org/
  *  - Nanduino, a do-it-yourself AT90USB162 board: http://www.makestuff.eu/wordpress/?page_id=569
+ *  - AVR-USB-162, a USBKEY like development board for the AT90USB162: http://olimex.com/dev/avr-usb-162.html
  *  - Teensy and Teensy++, two other AVR USB development boards: http://www.pjrc.com/teensy/index.html
  *  - U2DIL/U4DIL, a set of DIP layout USB AVR boards: http://www.reworld.eu/re/en/products/u2dil/
- *  - USB10 AKA "The Ferret", a AT90USB162 development board: http://www.soc-machines.com
  *  - USBFOO 2, AT90USB162 based development board: http://shop.kernelconcepts.de/product_info.php?products_id=102
  * 
  *  \section Sec_LUFAProjects Projects Using LUFA (Hobbyist)
@@ -49,6 +49,7 @@
  *  - Ghetto Drum, a MIDI drum controller: http://noisybox.net/art/gdrum/
  *  - IR Remote to Keyboard decoder: http://netzhansa.blogspot.com/2010/04/our-living-room-hi-fi-setup-needs-mp3.html
  *  - LED Panel controller: http://projects.peterpolidoro.net/caltech/panelscontroller/panelscontroller.htm
+ *  - PSGroove, a Playstation 3 Homebrew dongle: http://github.com/psgroove
  *  - Single LED Matrix Display: http://guysoft.wordpress.com/2009/10/08/bumble-b/
  *  - Linux Secure Storage Dongle: http://github.com/TomMD/teensy
  *  - MakeTV Episode Dispenser: http://www.youtube.com/watch?v=BkWUi18hl3g
@@ -80,6 +81,7 @@
  *  - MIDIFighter, a USB-MIDI controller: http://www.midifighter.com/
  *  - Mobo 4.3, a USB controlled all band (160-10m) HF SDR transceiver: http://sites.google.com/site/lofturj/mobo4_3
  *  - Retrode, a USB Games Console Cartridge Reader: http://www.retrode.org
+ *  - USBTINY-MKII, an AVRISP-MKII Clone AVR Programmer: http://tom-itx.dyndns.org:81/~webpage/boards/USBTiny_Mkii/USBTiny_Mkii_index.php
  *  - XMEGA Development Board, using LUFA as an On-Board Programmer: http://xmega.mattair.net/
  *
  *  \section Sec_LUFAPublications Publications Mentioning LUFA
diff --git a/LUFA/ManPages/LibraryApps.txt b/LUFA/ManPages/LibraryApps.txt
index 7d4f3f7cf..787847f72 100644
--- a/LUFA/ManPages/LibraryApps.txt
+++ b/LUFA/ManPages/LibraryApps.txt
@@ -60,6 +60,8 @@
  *        - <b>VirtualSerial</b> - Virtual Serial Port demo, using the low level LUFA APIs to implement the USB CDC class
  *      - <b>Incomplete</b>
  *        - <b>SideShow</b> - Incomplete Windows SideShow demo, using the low level LUFA APIs to implement the USB SideShow class
+ *        - <b>TestAndMeasurement</b> - Incomplete Test and Measurement demo, using the low level LUFA APIs to implement the USB Test and
+ *                                      Measurement class
  *    - <b>Host</b>
  *      - <b>ClassDriver</b>
  *        - <b>JoystickHostWithParser</b> - Joystick host demo with HID Descriptor parser, using the library USB HID Class driver framework