Minor documentation page updates.
[pub/USBasp.git] / Demos / Device / CDC / CDC.h
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 * Header file for CDC.c.
34 */
35
36 #ifndef _CDC_H_
37 #define _CDC_H_
38
39 /* Includes: */
40 #include <avr/io.h>
41 #include <avr/wdt.h>
42 #include <avr/power.h>
43 #include <string.h>
44
45 #include "Descriptors.h"
46
47 #include <LUFA/Version.h>
48 #include <LUFA/Drivers/Board/LEDs.h>
49 #include <LUFA/Drivers/Board/Joystick.h>
50 #include <LUFA/Drivers/USB/USB.h>
51 #include <LUFA/Drivers/USB/Class/Device/CDC.h>
52
53 /* Macros: */
54 /** LED mask for the library LED driver, to indicate that the USB interface is not ready. */
55 #define LEDMASK_USB_NOTREADY LEDS_LED1
56
57 /** LED mask for the library LED driver, to indicate that the USB interface is enumerating. */
58 #define LEDMASK_USB_ENUMERATING (LEDS_LED2 | LEDS_LED3)
59
60 /** LED mask for the library LED driver, to indicate that the USB interface is ready. */
61 #define LEDMASK_USB_READY (LEDS_LED2 | LEDS_LED4)
62
63 /** LED mask for the library LED driver, to indicate that an error has occurred in the USB interface. */
64 #define LEDMASK_USB_ERROR (LEDS_LED1 | LEDS_LED3)
65
66 /* Function Prototypes: */
67 void SetupHardware(void);
68 void CheckJoystickMovement(void);
69
70 void EVENT_USB_Connect(void);
71 void EVENT_USB_Disconnect(void);
72 void EVENT_USB_ConfigurationChanged(void);
73 void EVENT_USB_UnhandledControlPacket(void);
74
75 #endif