Demos/Host/LowLevel/CDCHost/CDCHost.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 CDCHost.c.
  34  */
  35
  36 #ifndef _CDC_HOST_H_
  37 #define _CDC_HOST_H_
  38
  39         /* Includes: */
  40                 #include <avr/io.h>
  41                 #include <avr/wdt.h>
  42                 #include <avr/pgmspace.h>
  43                 #include <avr/power.h>
  44                 #include <stdio.h>
  45
  46                 #include <LUFA/Version.h>
  47                 #include <LUFA/Drivers/Misc/TerminalCodes.h>
  48                 #include <LUFA/Drivers/USB/USB.h>
  49                 #include <LUFA/Drivers/Peripheral/SerialStream.h>
  50                 #include <LUFA/Drivers/Board/LEDs.h>
  51
  52                 #include "ConfigDescriptor.h"
  53
  54         /* Macros: */
  55                 /** Pipe number for the CDC data IN pipe */
  56                 #define CDC_DATAPIPE_IN                1
  57
  58                 /** Pipe number for the CDC data OUT pipe */
  59                 #define CDC_DATAPIPE_OUT               2
  60
  61                 /** Pipe number for the CDC notification pipe */
  62                 #define CDC_NOTIFICATIONPIPE           3
  63
  64                 /** LED mask for the library LED driver, to indicate that the USB interface is not ready. */
  65                 #define LEDMASK_USB_NOTREADY      LEDS_LED1
  66
  67                 /** LED mask for the library LED driver, to indicate that the USB interface is enumerating. */
  68                 #define LEDMASK_USB_ENUMERATING  (LEDS_LED2 | LEDS_LED3)
  69
  70                 /** LED mask for the library LED driver, to indicate that the USB interface is ready. */
  71                 #define LEDMASK_USB_READY        (LEDS_LED2 | LEDS_LED4)
  72
  73                 /** LED mask for the library LED driver, to indicate that an error has occurred in the USB interface. */
  74                 #define LEDMASK_USB_ERROR        (LEDS_LED1 | LEDS_LED3)
  75
  76         /* Type Defines: */
  77                 /** Class state structure. An instance of this structure should be made for each CDC interface
  78                  *  within the user application, and passed to each of the CDC class driver functions as the
  79                  *  CDCInterfaceInfo parameter. The contents of this structure should be set to their correct
  80                  *  values when used, or ommitted to force the library to use default values.
  81                  */
  82                 typedef struct
  83                 {
  84                         const struct
  85                         {
  86                                 uint8_t  ControlInterfaceNumber; /**< Interface number of the CDC control interface within the device */
  87
  88                                 uint8_t  DataINEndpointNumber; /**< Endpoint number of the CDC interface's IN data endpoint */
  89                                 uint16_t DataINEndpointSize; /**< Size in bytes of the CDC interface's IN data endpoint */
  90
  91                                 uint8_t  DataOUTEndpointNumber; /**< Endpoint number of the CDC interface's OUT data endpoint */
  92                                 uint16_t DataOUTEndpointSize;  /**< Size in bytes of the CDC interface's OUT data endpoint */
  93
  94                                 uint8_t  NotificationEndpointNumber; /**< Endpoint number of the CDC interface's IN notification endpoint, if used */
  95                                 uint16_t NotificationEndpointSize;  /**< Size in bytes of the CDC interface's IN notification endpoint, if used */
  96                         } Config;
  97
  98                         struct
  99                         {
 100                                 uint8_t  ControlLineState; /**< Current control line states, as set by the host */
 101
 102                                 struct
 103                                 {
 104                                         uint32_t BaudRateBPS; /**< Baud rate of the virtual serial port, in bits per second */
 105                                         uint8_t  CharFormat; /**< Character format of the virtual serial port, a value from the
 106                                                                                   *   CDCDevice_CDC_LineCodingFormats_t enum
 107                                                                                   */
 108                                         uint8_t  ParityType; /**< Parity setting of the virtual serial port, a value from the
 109                                                                                   *   CDCDevice_LineCodingParity_t enum
 110                                                                                   */
 111                                         uint8_t  DataBits; /**< Bits of data per character of the virtual serial port */
 112                                 } LineEncoding;
 113                         } State;
 114                 } USB_ClassInfo_CDC_Host_t;
 115
 116         /* Function Prototypes: */
 117                 void SetupHardware(void);
 118                 void CDC_Host_Task(void);
 119
 120                 void EVENT_USB_Host_HostError(const uint8_t ErrorCode);
 121                 void EVENT_USB_Host_DeviceAttached(void);
 122                 void EVENT_USB_Host_DeviceUnattached(void);
 123                 void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8_t SubErrorCode);
 124                 void EVENT_USB_Host_DeviceEnumerationComplete(void);
 125
 126 #endif