+/*\r
+ LUFA Library\r
+ Copyright (C) Dean Camera, 2009.\r
+ \r
+ dean [at] fourwalledcubicle [dot] com\r
+ www.fourwalledcubicle.com\r
+*/\r
+\r
+/*\r
+ Copyright 2009 Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+\r
+ Permission to use, copy, modify, and distribute this software\r
+ and its documentation for any purpose and without fee is hereby\r
+ granted, provided that the above copyright notice appear in all\r
+ copies and that both that the copyright notice and this\r
+ permission notice and warranty disclaimer appear in supporting\r
+ documentation, and that the name of the author not be used in\r
+ advertising or publicity pertaining to distribution of the\r
+ software without specific, written prior permission.\r
+\r
+ The author disclaim all warranties with regard to this\r
+ software, including all implied warranties of merchantability\r
+ and fitness. In no event shall the author be liable for any\r
+ special, indirect or consequential damages or any damages\r
+ whatsoever resulting from loss of use, data or profits, whether\r
+ in an action of contract, negligence or other tortious action,\r
+ arising out of or in connection with the use or performance of\r
+ this software.\r
+*/\r
+\r
+/** \file\r
+ *\r
+ * Header file for CDC.c.\r
+ */\r
+\r
+#ifndef _CDC_H_\r
+#define _CDC_H_\r
+\r
+ /* Includes: */\r
+ #include <avr/io.h>\r
+ #include <avr/wdt.h>\r
+ #include <avr/power.h>\r
+ #include <string.h>\r
+\r
+ #include "Descriptors.h"\r
+\r
+ #include <LUFA/Version.h> // Library Version Information\r
+ #include <LUFA/Drivers/USB/USB.h> // USB Functionality\r
+ #include <LUFA/Drivers/Board/Joystick.h> // Joystick driver\r
+ #include <LUFA/Drivers/Board/LEDs.h> // LEDs driver\r
+ #include <LUFA/Scheduler/Scheduler.h> // Simple scheduler for task management\r
+\r
+ /* Macros: */\r
+ /** CDC Class specific request to get the current virtual serial port configuration settings. */\r
+ #define REQ_GetLineEncoding 0x21\r
+\r
+ /** CDC Class specific request to set the current virtual serial port configuration settings. */\r
+ #define REQ_SetLineEncoding 0x20\r
+\r
+ /** CDC Class specific request to set the current virtual serial port handshake line states. */\r
+ #define REQ_SetControlLineState 0x22\r
+ \r
+ /** Notification type constant for a change in the virtual serial port handshake line states, for\r
+ * use with a USB_Notification_Header_t notification structure when sent to the host via the CDC \r
+ * notification endpoint.\r
+ */\r
+ #define NOTIF_SerialState 0x20\r
+\r
+ /** Mask for the DTR handshake line for use with the REQ_SetControlLineState class specific request\r
+ * from the host, to indicate that the DTR line state should be high.\r
+ */\r
+ #define CONTROL_LINE_OUT_DTR (1 << 0)\r
+\r
+ /** Mask for the RTS handshake line for use with the REQ_SetControlLineState class specific request\r
+ * from the host, to indicate that theRTS line state should be high.\r
+ */\r
+ #define CONTROL_LINE_OUT_RTS (1 << 1)\r
+ \r
+ /** Mask for the DCD handshake line for use with the a NOTIF_SerialState class specific notification\r
+ * from the device to the host, to indicate that the DCD line state is currently high.\r
+ */\r
+ #define CONTROL_LINE_IN_DCD (1 << 0)\r
+\r
+ /** Mask for the DSR handshake line for use with the a NOTIF_SerialState class specific notification\r
+ * from the device to the host, to indicate that the DSR line state is currently high.\r
+ */\r
+ #define CONTROL_LINE_IN_DSR (1 << 1)\r
+\r
+ /** Mask for the BREAK handshake line for use with the a NOTIF_SerialState class specific notification\r
+ * from the device to the host, to indicate that the BREAK line state is currently high.\r
+ */\r
+ #define CONTROL_LINE_IN_BREAK (1 << 2)\r
+\r
+ /** Mask for the RING handshake line for use with the a NOTIF_SerialState class specific notification\r
+ * from the device to the host, to indicate that the RING line state is currently high.\r
+ */\r
+ #define CONTROL_LINE_IN_RING (1 << 3)\r
+\r
+ /** Mask for use with the a NOTIF_SerialState class specific notification from the device to the host,\r
+ * to indicate that a framing error has occurred on the virtual serial port.\r
+ */\r
+ #define CONTROL_LINE_IN_FRAMEERROR (1 << 4)\r
+\r
+ /** Mask for use with the a NOTIF_SerialState class specific notification from the device to the host,\r
+ * to indicate that a parity error has occurred on the virtual serial port.\r
+ */\r
+ #define CONTROL_LINE_IN_PARITYERROR (1 << 5)\r
+\r
+ /** Mask for use with the a NOTIF_SerialState class specific notification from the device to the host,\r
+ * to indicate that a data overrun error has occurred on the virtual serial port.\r
+ */\r
+ #define CONTROL_LINE_IN_OVERRUNERROR (1 << 6)\r
+ \r
+ /* Type Defines: */\r
+ /** Type define for the virtual serial port line encoding settings, for storing the current USART configuration\r
+ * as set by the host via a class specific request.\r
+ */\r
+ typedef struct\r
+ {\r
+ uint32_t BaudRateBPS; /**< Baud rate of the virtual serial port, in bits per second */\r
+ uint8_t CharFormat; /**< Character format of the virtual serial port, a value from the\r
+ * CDCDevice_CDC_LineCodingFormats_t enum\r
+ */\r
+ uint8_t ParityType; /**< Parity setting of the virtual serial port, a value from the\r
+ * CDCDevice_LineCodingParity_t enum\r
+ */\r
+ uint8_t DataBits; /**< Bits of data per character of the virtual serial port */\r
+ } CDC_Line_Coding_t;\r
+ \r
+ /** Type define for a CDC notification, sent to the host via the CDC notification endpoint to indicate a\r
+ * change in the device state asynchronously.\r
+ */\r
+ typedef struct\r
+ {\r
+ uint8_t NotificationType; /**< Notification type, a mask of REQDIR_*, REQTYPE_* and REQREC_* constants\r
+ * from the library StdRequestType.h header\r
+ */\r
+ uint8_t Notification; /**< Notification value, a NOTIF_* constant */\r
+ uint16_t wValue; /**< Notification wValue, notification-specific */\r
+ uint16_t wIndex; /**< Notification wIndex, notification-specific */\r
+ uint16_t wLength; /**< Notification wLength, notification-specific */\r
+ } USB_Notification_Header_t;\r
+ \r
+ /* Enums: */\r
+ /** Enum for the possible line encoding formats of a virtual serial port. */\r
+ enum CDCDevice_CDC_LineCodingFormats_t\r
+ {\r
+ OneStopBit = 0, /**< Each frame contains one stop bit */\r
+ OneAndAHalfStopBits = 1, /**< Each frame contains one and a half stop bits */\r
+ TwoStopBits = 2, /**< Each frame contains two stop bits */\r
+ };\r
+ \r
+ /** Enum for the possible line encoding parity settings of a virtual serial port. */\r
+ enum CDCDevice_LineCodingParity_t\r
+ {\r
+ Parity_None = 0, /**< No parity bit mode on each frame */\r
+ Parity_Odd = 1, /**< Odd parity bit mode on each frame */\r
+ Parity_Even = 2, /**< Even parity bit mode on each frame */\r
+ Parity_Mark = 3, /**< Mark parity bit mode on each frame */\r
+ Parity_Space = 4, /**< Space parity bit mode on each frame */\r
+ };\r
+\r
+ /** Enum for the possible status codes for passing to the UpdateStatus() function. */\r
+ enum CDC_StatusCodes_t\r
+ {\r
+ Status_USBNotReady = 0, /**< USB is not ready (disconnected from a USB host) */\r
+ Status_USBEnumerating = 1, /**< USB interface is enumerating */\r
+ Status_USBReady = 2, /**< USB interface is connected and ready */\r
+ };\r
+ \r
+ /* Tasks: */\r
+ TASK(CDC_Task);\r
+\r
+ /* Function Prototypes: */\r
+ void EVENT_USB_Connect(void);\r
+ void EVENT_USB_Disconnect(void);\r
+ void EVENT_USB_ConfigurationChanged(void);\r
+ void EVENT_USB_UnhandledControlPacket(void);\r
+\r
+ void UpdateStatus(uint8_t CurrentStatus);\r
+\r
+#endif\r
projects / pub / lufa.git / blobdiff