Minor documentation cleanups.
[pub/USBasp.git] / Projects / TemperatureDataLogger / TempDataLogger.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 /** \file
32 *
33 * Header file for TempDataLogger.c.
34 */
35
36 #ifndef _TEMP_DATALOGGER_H_
37 #define _TEMP_DATALOGGER_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 <stdio.h>
45
46 #include "Descriptors.h"
47
48 #include "Lib/SCSI.h"
49 #include "Lib/DataflashManager.h"
50 #include "Lib/FATFs/ff.h"
51 #include "Lib/DS1307.h"
52
53 #include <LUFA/Version.h>
54 #include <LUFA/Drivers/Board/LEDs.h>
55 #include <LUFA/Drivers/Board/Temperature.h>
56 #include <LUFA/Drivers/Peripheral/ADC.h>
57 #include <LUFA/Drivers/USB/USB.h>
58 #include <LUFA/Drivers/USB/Class/MassStorage.h>
59 #include <LUFA/Drivers/USB/Class/HID.h>
60
61 /* Macros: */
62 /** LED mask for the library LED driver, to indicate that the USB interface is not ready. */
63 #define LEDMASK_USB_NOTREADY LEDS_LED1
64
65 /** LED mask for the library LED driver, to indicate that the USB interface is enumerating. */
66 #define LEDMASK_USB_ENUMERATING (LEDS_LED2 | LEDS_LED3)
67
68 /** LED mask for the library LED driver, to indicate that the USB interface is ready. */
69 #define LEDMASK_USB_READY (LEDS_LED2 | LEDS_LED4)
70
71 /** LED mask for the library LED driver, to indicate that an error has occurred in the USB interface. */
72 #define LEDMASK_USB_ERROR (LEDS_LED1 | LEDS_LED3)
73
74 /** LED mask for the library LED driver, to indicate that the USB interface is busy. */
75 #define LEDMASK_USB_BUSY LEDS_LED2
76
77 /** Filename for the log data when written to the dataflash FAT filesystem. */
78 #define LOG_FILENAME "TEMPLOG.txt"
79
80 /** Data log interval between samples, in tens of milliseconds. */
81 #define LOG_INTERVAL_10MS 1000
82
83 /* Type Defines: */
84 typedef struct
85 {
86 uint8_t Day;
87 uint8_t Month;
88 uint8_t Year;
89
90 uint8_t Hour;
91 uint8_t Minute;
92 uint8_t Second;
93
94 uint8_t LogInterval500MS;
95 } Device_Report_t;
96
97 /* Function Prototypes: */
98 void SetupHardware(void);
99 void OpenLogFile(void);
100 void CloseLogFile(void);
101
102 void EVENT_USB_Device_Connect(void);
103 void EVENT_USB_Device_Disconnect(void);
104 void EVENT_USB_Device_ConfigurationChanged(void);
105 void EVENT_USB_Device_UnhandledControlRequest(void);
106
107 bool CALLBACK_MS_Device_SCSICommandReceived(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo);
108 bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, uint8_t* const ReportID,
109 const uint8_t ReportType, void* ReportData, uint16_t* ReportSize);
110 void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, const uint8_t ReportID,
111 const uint8_t ReportType, const void* ReportData, const uint16_t ReportSize);
112
113 #endif