More Doxygen fixes - ensure no undocumented function parameters.
[pub/USBasp.git] / Demos / Device / ClassDriver / CDC / CDC.c
1 /*
2 LUFA Library
3 Copyright (C) Dean Camera, 2009.
4
5 dean [at] fourwalledcubicle [dot] com
6 www.fourwalledcubicle.com
7 */
8
9 /*
10 Copyright 2009 Dean Camera (dean [at] fourwalledcubicle [dot] com)
11
12 Permission to use, copy, modify, and distribute this software
13 and its documentation for any purpose and without fee is hereby
14 granted, provided that the above copyright notice appear in all
15 copies and that both that the copyright notice and this
16 permission notice and warranty disclaimer appear in supporting
17 documentation, and that the name of the author not be used in
18 advertising or publicity pertaining to distribution of the
19 software without specific, written prior permission.
20
21 The author disclaim all warranties with regard to this
22 software, including all implied warranties of merchantability
23 and fitness. In no event shall the author be liable for any
24 special, indirect or consequential damages or any damages
25 whatsoever resulting from loss of use, data or profits, whether
26 in an action of contract, negligence or other tortious action,
27 arising out of or in connection with the use or performance of
28 this software.
29 */
30
31 /** \file
32 *
33 * Main source file for the CDC demo. This file contains the main tasks of
34 * the demo and is responsible for the initial application hardware configuration.
35 */
36
37 #include "CDC.h"
38
39 /** LUFA CDC Class driver interface configuration and state information. This structure is
40 * passed to all CDC Class driver functions, so that multiple instances of the same class
41 * within a device can be differentiated from one another.
42 */
43 USB_ClassInfo_CDC_t VirtualSerial_CDC_Interface =
44 {
45 .ControlInterfaceNumber = 0,
46
47 .DataINEndpointNumber = CDC_TX_EPNUM,
48 .DataINEndpointSize = CDC_TXRX_EPSIZE,
49
50 .DataOUTEndpointNumber = CDC_RX_EPNUM,
51 .DataOUTEndpointSize = CDC_TXRX_EPSIZE,
52
53 .NotificationEndpointNumber = CDC_NOTIFICATION_EPNUM,
54 .NotificationEndpointSize = CDC_NOTIFICATION_EPSIZE,
55 };
56
57 /** Main program entry point. This routine contains the overall program flow, including initial
58 * setup of all components and the main program loop.
59 */
60 int main(void)
61 {
62 SetupHardware();
63
64 LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
65
66 for (;;)
67 {
68 CheckJoystickMovement();
69
70 uint16_t BytesToDiscard = CDC_Device_BytesReceived(&VirtualSerial_CDC_Interface);
71 while (BytesToDiscard--)
72 CDC_Device_ReceiveByte(&VirtualSerial_CDC_Interface);
73
74 CDC_Device_USBTask(&VirtualSerial_CDC_Interface);
75 USB_USBTask();
76 }
77 }
78
79 /** Configures the board hardware and chip peripherals for the demo's functionality. */
80 void SetupHardware(void)
81 {
82 /* Disable watchdog if enabled by bootloader/fuses */
83 MCUSR &= ~(1 << WDRF);
84 wdt_disable();
85
86 /* Disable clock division */
87 clock_prescale_set(clock_div_1);
88
89 /* Hardware Initialization */
90 Joystick_Init();
91 LEDs_Init();
92 USB_Init();
93 }
94
95 /** Checks for changes in the position of the board joystick, sending strings to the host upon each change. */
96 void CheckJoystickMovement(void)
97 {
98 uint8_t JoyStatus_LCL = Joystick_GetStatus();
99 char* ReportString = NULL;
100 static bool ActionSent = false;
101
102 char* JoystickStrings[] =
103 {
104 "Joystick Up\r\n",
105 "Joystick Down\r\n",
106 "Joystick Left\r\n",
107 "Joystick Right\r\n",
108 "Joystick Pressed\r\n",
109 };
110
111 if (JoyStatus_LCL & JOY_UP)
112 ReportString = JoystickStrings[0];
113 else if (JoyStatus_LCL & JOY_DOWN)
114 ReportString = JoystickStrings[1];
115 else if (JoyStatus_LCL & JOY_LEFT)
116 ReportString = JoystickStrings[2];
117 else if (JoyStatus_LCL & JOY_RIGHT)
118 ReportString = JoystickStrings[3];
119 else if (JoyStatus_LCL & JOY_PRESS)
120 ReportString = JoystickStrings[4];
121 else
122 ActionSent = false;
123
124 if ((ReportString != NULL) && (ActionSent == false))
125 {
126 ActionSent = true;
127
128 CDC_Device_SendString(&VirtualSerial_CDC_Interface, ReportString, strlen(ReportString));
129 }
130 }
131
132 /** Event handler for the library USB Connection event. */
133 void EVENT_USB_Connect(void)
134 {
135 LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
136 }
137
138 /** Event handler for the library USB Disconnection event. */
139 void EVENT_USB_Disconnect(void)
140 {
141 LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
142 }
143
144 /** Event handler for the library USB Configuration Changed event. */
145 void EVENT_USB_ConfigurationChanged(void)
146 {
147 LEDs_SetAllLEDs(LEDMASK_USB_READY);
148
149 if (!(CDC_Device_ConfigureEndpoints(&VirtualSerial_CDC_Interface)))
150 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
151 }
152
153 /** Event handler for the library USB Unhandled Control Packet event. */
154 void EVENT_USB_UnhandledControlPacket(void)
155 {
156 CDC_Device_ProcessControlPacket(&VirtualSerial_CDC_Interface);
157 }