protocol/lufa/LUFA-git/Projects/XPLAINBridge/XPLAINBridge.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2014.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2014  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all 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 disclaims 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 XPLAINBridge.c.
  34  */
  35
  36 #ifndef _XPLAIN_BRIDGE_H_
  37 #define _XPLAIN_BRIDGE_H_
  38
  39         /* Includes: */
  40                 #include <avr/io.h>
  41                 #include <avr/wdt.h>
  42                 #include <avr/power.h>
  43                 #include <avr/interrupt.h>
  44                 #include <util/delay.h>
  45
  46                 #include "USARTDescriptors.h"
  47
  48                 #include "AVRISPDescriptors.h"
  49                 #include "Lib/V2Protocol.h"
  50                 #include "Lib/SoftUART.h"
  51                 #include "Config/AppConfig.h"
  52
  53                 #include <LUFA/Drivers/Board/LEDs.h>
  54                 #include <LUFA/Drivers/Misc/RingBuffer.h>
  55                 #include <LUFA/Drivers/USB/USB.h>
  56                 #include <LUFA/Platform/Platform.h>
  57
  58         /* Macros: */
  59                 /** LED mask for the library LED driver, to indicate that the USB interface is not ready. */
  60                 #define LEDMASK_USB_NOTREADY     LEDS_LED1
  61
  62                 /** LED mask for the library LED driver, to indicate that the USB interface is enumerating. */
  63                 #define LEDMASK_USB_ENUMERATING  LEDS_LED1
  64
  65                 /** LED mask for the library LED driver, to indicate that the USB interface is ready. */
  66                 #define LEDMASK_USB_READY        LEDS_NO_LEDS
  67
  68                 /** LED mask for the library LED driver, to indicate that an error has occurred in the USB interface. */
  69                 #define LEDMASK_USB_ERROR        LEDS_LED1
  70
  71                 /** LED mask for the library LED driver, to indicate that the USB interface is busy. */
  72                 #define LEDMASK_BUSY             LEDS_LED1
  73
  74                 /** Firmware mode define for the USART Bridge mode. */
  75                 #define MODE_USART_BRIDGE        false
  76
  77                 /** Firmware mode define for the AVRISP Programmer mode. */
  78                 #define MODE_PDI_PROGRAMMER      true
  79
  80         /* External Variables: */
  81                 extern bool         CurrentFirmwareMode;
  82                 extern RingBuffer_t UARTtoUSB_Buffer;
  83                 extern RingBuffer_t USBtoUART_Buffer;
  84
  85         /* Function Prototypes: */
  86                 void SetupHardware(void);
  87                 void AVRISP_Task(void);
  88                 void UARTBridge_Task(void);
  89
  90                 void EVENT_USB_Device_ConfigurationChanged(void);
  91                 void EVENT_USB_Device_ControlRequest(void);
  92                 void EVENT_USB_Device_Connect(void);
  93                 void EVENT_USB_Device_Disconnect(void);
  94
  95                 void EVENT_CDC_Device_LineEncodingChanged(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo);
  96
  97                 uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
  98                                                     const uint8_t wIndex,
  99                                                     const void** const DescriptorAddress,
 100                                                     uint8_t* const DescriptorMemorySpace)
 101                                                     ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3) ATTR_NON_NULL_PTR_ARG(4);
 102
 103 #endif
 104