Minor documentation page updates.

Redocumented all device demos, now that they have changed over to the new USB class drivers.

Added C linkage to class drivers for C++ support.

Added prefixes to most of the class driver constants to prevent name clashes.

2 files changed, 40 insertions, 1 deletions

diff --git a/Demos/Device/Keyboard/Keyboard.c b/Demos/Device/Keyboard/Keyboard.c
index d506657a6..923dd7176 100644
--- a/Demos/Device/Keyboard/Keyboard.c
+++ b/Demos/Device/Keyboard/Keyboard.c
@@ -28,9 +28,19 @@
   arising out of or in connection with the use or performance of

   this software.

 */

- 

+

+/** \file

+ *

+ *  Main source file for the Keyboard demo. This file contains the main tasks of

+ *  the demo and is responsible for the initial application hardware configuration.

+ */

+

 #include "Keyboard.h"

 

+/** LUFA HID Class driver interface configuration and state information. This structure is

+ *  passed to all HID Class driver functions, so that multiple instances of the same class

+ *  within a device can be differentiated from one another.

+ */

 USB_ClassInfo_HID_t Keyboard_HID_Interface =

     {

         .InterfaceNumber         = 0,

@@ -46,6 +56,9 @@ USB_ClassInfo_HID_t Keyboard_HID_Interface =
         .IdleCount               = 500,

     };

 

+/** Main program entry point. This routine contains the overall program flow, including initial

+ *  setup of all components and the main program loop.

+ */

 int main(void)

 {

     SetupHardware();

@@ -59,6 +72,7 @@ int main(void)
     }

 }

 

+/** Configures the board hardware and chip peripherals for the demo's functionality. */

 void SetupHardware()

 {

     /* Disable watchdog if enabled by bootloader/fuses */

@@ -81,16 +95,19 @@ void SetupHardware()
 	TIMSK0 = (1 << OCIE0A);

 }

 

+/** Event handler for the library USB Connection event. */

 void EVENT_USB_Connect(void)

 {

     LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);

 }

 

+/** Event handler for the library USB Disconnection event. */

 void EVENT_USB_Disconnect(void)

 {

     LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);

 }

 

+/** Event handler for the library USB Configuration Changed event. */

 void EVENT_USB_ConfigurationChanged(void)

 {

     LEDs_SetAllLEDs(LEDMASK_USB_READY);

@@ -99,17 +116,26 @@ void EVENT_USB_ConfigurationChanged(void)
       LEDs_SetAllLEDs(LEDMASK_USB_ERROR);

 }

 

+/** Event handler for the library USB Unhandled Control Packet event. */

 void EVENT_USB_UnhandledControlPacket(void)

 {

     USB_HID_ProcessControlPacket(&Keyboard_HID_Interface);

 }

 

+/** ISR to keep track of each millisecond interrupt, for determining the HID class idle period remaining when set. */

 ISR(TIMER0_COMPA_vect, ISR_BLOCK)

 {

 	if (Keyboard_HID_Interface.IdleMSRemaining)

 	  Keyboard_HID_Interface.IdleMSRemaining--;

 }

 

+/** HID class driver callback function for the creation of HID reports to the host.

+ *

+ *  \param HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced

+ *  \param ReportData  Pointer to a buffer where the created report should be stored

+ *

+ *  \return Number of bytes written in the report (or zero if no report is to be sent

+ */

 uint16_t CALLBACK_USB_HID_CreateNextHIDReport(USB_ClassInfo_HID_t* HIDInterfaceInfo, void* ReportData)

 {

     USB_KeyboardReport_Data_t* KeyboardReport = (USB_KeyboardReport_Data_t*)ReportData;

@@ -136,6 +162,12 @@ uint16_t CALLBACK_USB_HID_CreateNextHIDReport(USB_ClassInfo_HID_t* HIDInterfaceI
     return sizeof(USB_KeyboardReport_Data_t);

 }

 

+/** HID class driver callback function for the processing of HID reports from the host.

+ *

+ *  \param HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced

+ *  \param ReportData  Pointer to a buffer where the created report has been stored

+ *  \param ReportSize  Size in bytes of the received HID report

+ */

 void CALLBACK_USB_HID_ProcessReceivedHIDReport(USB_ClassInfo_HID_t* HIDInterfaceInfo, void* ReportData, uint16_t ReportSize)

 {

     uint8_t  LEDMask   = LEDS_NO_LEDS;

diff --git a/Demos/Device/Keyboard/Keyboard.h b/Demos/Device/Keyboard/Keyboard.h
index 9cfc9aba4..e04ae9e34 100644
--- a/Demos/Device/Keyboard/Keyboard.h
+++ b/Demos/Device/Keyboard/Keyboard.h
@@ -66,9 +66,16 @@
 		} USB_KeyboardReport_Data_t;

 			

 	/* Macros: */

+		/** LED mask for the library LED driver, to indicate that the USB interface is not ready. */

 		#define LEDMASK_USB_NOTREADY      LEDS_LED1

+

+		/** LED mask for the library LED driver, to indicate that the USB interface is enumerating. */

 		#define LEDMASK_USB_ENUMERATING  (LEDS_LED2 | LEDS_LED3)

+

+		/** LED mask for the library LED driver, to indicate that the USB interface is ready. */

 		#define LEDMASK_USB_READY        (LEDS_LED2 | LEDS_LED4)

+

+		/** LED mask for the library LED driver, to indicate that an error has occurred in the USB interface. */

 		#define LEDMASK_USB_ERROR        (LEDS_LED1 | LEDS_LED3)

 		

 	/* Function Prototypes: */