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.

1 files changed, 32 insertions, 0 deletions

diff --git a/Demos/Device/Joystick/Joystick.c b/Demos/Device/Joystick/Joystick.c
index d5c20737d..66cb808d0 100644
--- a/Demos/Device/Joystick/Joystick.c
+++ b/Demos/Device/Joystick/Joystick.c
@@ -28,8 +28,18 @@
   this software.

 */

 

+/** \file

+ *

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

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

+ */

+

 #include "Joystick.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 Joystick_HID_Interface =

 	{

 		.InterfaceNumber         = 0,

@@ -42,6 +52,9 @@ USB_ClassInfo_HID_t Joystick_HID_Interface =
 		.UsingReportProtocol     = true,

 	};

 

+/** 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();

@@ -55,6 +68,7 @@ int main(void)
 	}

 }

 

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

 void SetupHardware(void)

 {

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

@@ -77,16 +91,19 @@ void SetupHardware(void)
 	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);

@@ -95,17 +112,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(&Joystick_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 (Joystick_HID_Interface.IdleMSRemaining)

 	  Joystick_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_JoystickReport_Data_t* JoystickReport = (USB_JoystickReport_Data_t*)ReportData;

@@ -132,6 +158,12 @@ uint16_t CALLBACK_USB_HID_CreateNextHIDReport(USB_ClassInfo_HID_t* HIDInterfaceI
 	return sizeof(USB_JoystickReport_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)

 {

 	// Unused (but mandatory for the HID class driver) in this demo, since there are no Host->Device reports