Demos/Device/Incomplete/TestAndMeasurement/TestAndMeasurement.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2010.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2010  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 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 #ifndef _TESTANDMEASUREMENT_H_
  32 #define _TESTANDMEASUREMENT_H_
  33
  34         /* Includes: */
  35                 #include <avr/io.h>
  36                 #include <avr/wdt.h>
  37                 #include <avr/power.h>
  38                 #include <avr/interrupt.h>
  39
  40                 #include "Descriptors.h"
  41
  42                 #include <LUFA/Version.h>
  43                 #include <LUFA/Drivers/USB/USB.h>
  44                 #include <LUFA/Drivers/Board/LEDs.h>
  45
  46         /* Macros: */
  47                 /** LED mask for the library LED driver, to indicate that the USB interface is not ready. */
  48                 #define LEDMASK_USB_NOTREADY                   LEDS_LED1
  49
  50                 /** LED mask for the library LED driver, to indicate that the USB interface is enumerating. */
  51                 #define LEDMASK_USB_ENUMERATING               (LEDS_LED2 | LEDS_LED3)
  52
  53                 /** LED mask for the library LED driver, to indicate that the USB interface is ready. */
  54                 #define LEDMASK_USB_READY                     (LEDS_LED2 | LEDS_LED4)
  55
  56                 /** LED mask for the library LED driver, to indicate that an error has occurred in the USB interface. */
  57                 #define LEDMASK_USB_ERROR                     (LEDS_LED1 | LEDS_LED3)
  58
  59                 #define Req_InitiateAbortBulkOut              0x01
  60                 #define Req_CheckAbortBulkOutStatus           0x02
  61                 #define Req_InitiateAbortBulkIn               0x03
  62                 #define Req_CheckAbortBulkInStatus            0x04
  63                 #define Req_InitiateClear                     0x05
  64                 #define Req_CheckClearStatus                  0x06
  65                 #define Req_GetCapabilities                   0x07
  66                 #define Req_IndicatorPulse                    0x40
  67
  68                 #define TMC_STATUS_SUCCESS                    0x01
  69                 #define TMC_STATUS_PENDING                    0x02
  70                 #define TMC_STATUS_FAILED                     0x80
  71                 #define TMC_STATUS_TRANSFER_NOT_IN_PROGRESS   0x81
  72                 #define TMC_STATUS_SPLIT_NOT_IN_PROGRESS      0x82
  73                 #define TMC_STATUS_SPLIT_IN_PROGRESS          0x83
  74
  75                 #define TMC_MESSAGEID_DEV_DEP_MSG_OUT         0x01
  76                 #define TMC_MESSAGEID_DEV_DEP_MSG_IN          0x02
  77                 #define TMC_MESSAGEID_DEV_VENDOR_OUT          0x7E
  78                 #define TMC_MESSAGEID_DEV_VENDOR_IN           0x7F
  79
  80         /* Type Defines */
  81                 typedef struct
  82                 {
  83                         uint8_t  Status;
  84                         uint8_t  Reserved;
  85
  86                         uint16_t TMCVersion;
  87
  88                         struct
  89                         {
  90                                 unsigned char ListenOnly             : 1;
  91                                 unsigned char TalkOnly               : 1;
  92                                 unsigned char PulseIndicateSupported : 1;
  93                                 unsigned char Reserved               : 5;
  94                         } Interface;
  95
  96                         struct
  97                         {
  98                                 unsigned char SupportsAbortINOnMatch : 1;
  99                                 unsigned char Reserved               : 7;
 100                         } Device;
 101
 102                         uint8_t Reserved2[6];
 103                         uint8_t Reserved3[12];
 104                 } TMC_Capabilities_t;
 105
 106                 typedef struct
 107                 {
 108                         unsigned char LastMessageTransaction : 1;
 109                         unsigned char Reserved               : 7;
 110
 111                         uint8_t Reserved2[3];
 112                 } TMC_DevOUTMessageHeader_t;
 113
 114                 typedef struct
 115                 {
 116                         unsigned char TermCharEnabled        : 1;
 117                         unsigned char Reserved               : 7;
 118
 119                         uint8_t TermChar;
 120                         uint8_t Reserved2[2];
 121                 } TMC_DevINMessageHeader_t;
 122
 123                 typedef struct
 124                 {
 125                         uint8_t  MessageID;
 126                         uint8_t  Tag;
 127                         uint8_t  InverseTag;
 128                         uint8_t  Reserved;
 129                         uint32_t TransferSize;
 130
 131                         union
 132                         {
 133                                 TMC_DevOUTMessageHeader_t DeviceOUT;
 134                                 TMC_DevINMessageHeader_t  DeviceIN;
 135                                 uint32_t                  VendorSpecific;
 136                         } MessageIDSpecific;
 137                 } TMC_MessageHeader_t;
 138
 139         /* Function Prototypes: */
 140                 void SetupHardware(void);
 141                 void TMC_Task(void);
 142
 143                 void EVENT_USB_Device_Connect(void);
 144                 void EVENT_USB_Device_Disconnect(void);
 145                 void EVENT_USB_Device_ConfigurationChanged(void);
 146                 void EVENT_USB_Device_UnhandledControlRequest(void);
 147
 148                 uint8_t StreamCallback_AbortINOnRequest(void);
 149                 uint8_t StreamCallback_AbortOUTOnRequest(void);
 150
 151 #endif