Doxygen corrections to fix Doxygen warnings in some demos.
[pub/USBasp.git] / Demos / Device / ClassDriver / Mouse / Mouse.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 Mouse demo. This file contains the main tasks of
34 * the demo and is responsible for the initial application hardware configuration.
35 */
36
37 #include "Mouse.h"
38
39 /** LUFA HID Class driver interface configuration and state information. This structure is
40 * passed to all HID 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_HID_t Mouse_HID_Interface =
44 {
45 .InterfaceNumber = 0,
46
47 .ReportINEndpointNumber = MOUSE_EPNUM,
48 .ReportINEndpointSize = MOUSE_EPSIZE,
49
50 .ReportINBufferSize = sizeof(USB_MouseReport_Data_t),
51 };
52
53 /** Main program entry point. This routine contains the overall program flow, including initial
54 * setup of all components and the main program loop.
55 */
56 int main(void)
57 {
58 SetupHardware();
59
60 LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
61
62 for (;;)
63 {
64 HID_Device_USBTask(&Mouse_HID_Interface);
65 USB_USBTask();
66 }
67 }
68
69 /** Configures the board hardware and chip peripherals for the demo's functionality. */
70 void SetupHardware(void)
71 {
72 /* Disable watchdog if enabled by bootloader/fuses */
73 MCUSR &= ~(1 << WDRF);
74 wdt_disable();
75
76 /* Disable clock division */
77 clock_prescale_set(clock_div_1);
78
79 /* Hardware Initialization */
80 Joystick_Init();
81 LEDs_Init();
82 Buttons_Init();
83 USB_Init();
84
85 /* Millisecond timer initialization, with output compare interrupt enabled for the idle timing */
86 OCR0A = ((F_CPU / 64) / 1000);
87 TCCR0A = (1 << WGM01);
88 TCCR0B = ((1 << CS01) | (1 << CS00));
89 TIMSK0 = (1 << OCIE0A);
90 }
91
92 /** Event handler for the library USB Connection event. */
93 void EVENT_USB_Connect(void)
94 {
95 LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
96 }
97
98 /** Event handler for the library USB Disconnection event. */
99 void EVENT_USB_Disconnect(void)
100 {
101 LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
102 }
103
104 /** Event handler for the library USB Configuration Changed event. */
105 void EVENT_USB_ConfigurationChanged(void)
106 {
107 LEDs_SetAllLEDs(LEDMASK_USB_READY);
108
109 if (!(HID_Device_ConfigureEndpoints(&Mouse_HID_Interface)))
110 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
111 }
112
113 /** Event handler for the library USB Unhandled Control Packet event. */
114 void EVENT_USB_UnhandledControlPacket(void)
115 {
116 HID_Device_ProcessControlPacket(&Mouse_HID_Interface);
117 }
118
119 /** ISR to keep track of each millisecond interrupt, for determining the HID class idle period remaining when set. */
120 ISR(TIMER0_COMPA_vect, ISR_BLOCK)
121 {
122 if (Mouse_HID_Interface.IdleMSRemaining)
123 Mouse_HID_Interface.IdleMSRemaining--;
124 }
125
126 /** HID class driver callback function for the creation of HID reports to the host.
127 *
128 * \param HIDInterfaceInfo Pointer to the HID class interface configuration structure being referenced
129 * \param ReportID Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID
130 * \param ReportData Pointer to a buffer where the created report should be stored
131 *
132 * \return Number of bytes written in the report (or zero if no report is to be sent
133 */
134 uint16_t CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_t* HIDInterfaceInfo, uint8_t* ReportID, void* ReportData)
135 {
136 USB_MouseReport_Data_t* MouseReport = (USB_MouseReport_Data_t*)ReportData;
137
138 uint8_t JoyStatus_LCL = Joystick_GetStatus();
139 uint8_t ButtonStatus_LCL = Buttons_GetStatus();
140
141 if (JoyStatus_LCL & JOY_UP)
142 MouseReport->Y = -1;
143 else if (JoyStatus_LCL & JOY_DOWN)
144 MouseReport->Y = 1;
145
146 if (JoyStatus_LCL & JOY_RIGHT)
147 MouseReport->X = 1;
148 else if (JoyStatus_LCL & JOY_LEFT)
149 MouseReport->X = -1;
150
151 if (JoyStatus_LCL & JOY_PRESS)
152 MouseReport->Button = (1 << 0);
153
154 if (ButtonStatus_LCL & BUTTONS_BUTTON1)
155 MouseReport->Button |= (1 << 1);
156
157 return sizeof(USB_MouseReport_Data_t);
158 }
159
160 /** HID class driver callback function for the processing of HID reports from the host.
161 *
162 * \param HIDInterfaceInfo Pointer to the HID class interface configuration structure being referenced
163 * \param ReportID Report ID of the received report from the host
164 * \param ReportData Pointer to a buffer where the created report has been stored
165 * \param ReportSize Size in bytes of the received HID report
166 */
167 void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_t* HIDInterfaceInfo, uint8_t ReportID,
168 void* ReportData, uint16_t ReportSize)
169 {
170 // Unused (but mandatory for the HID class driver) in this demo, since there are no Host->Device reports
171 }