GenericHID.h 2.98 KB
Newer Older
1
2
/*
             LUFA Library
Dean Camera's avatar
Dean Camera committed
3
     Copyright (C) Dean Camera, 2010.
4
5
6
7
8
9
              
  dean [at] fourwalledcubicle [dot] com
      www.fourwalledcubicle.com
*/

/*
Dean Camera's avatar
Dean Camera committed
10
  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
11

12
13
14
15
16
17
18
  Permission to use, copy, modify, distribute, and sell this 
  software and its documentation for any purpose is hereby granted
  without fee, provided that the above copyright notice appear in 
  all copies and that both that the copyright notice and this
  permission notice and warranty disclaimer appear in supporting 
  documentation, and that the name of the author not be used in 
  advertising or publicity pertaining to distribution of the 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
  software without specific, written prior permission.

  The author disclaim all warranties with regard to this
  software, including all implied warranties of merchantability
  and fitness.  In no event shall the author be liable for any
  special, indirect or consequential damages or any damages
  whatsoever resulting from loss of use, data or profits, whether
  in an action of contract, negligence or other tortious action,
  arising out of or in connection with the use or performance of
  this software.
*/

/** \file
 *
 *  Header file for GenericHID.c.
 */
 
#ifndef _GENERICHID_H_
#define _GENERICHID_H_

	/* Includes: */
		#include <avr/io.h>
		#include <avr/wdt.h>
		#include <avr/power.h>
		#include <string.h>
		
		#include "Descriptors.h"

47
48
49
		#include <LUFA/Version.h>
		#include <LUFA/Drivers/Board/LEDs.h>
		#include <LUFA/Drivers/USB/USB.h>
50
		#include <LUFA/Drivers/USB/Class/HID.h>
51

52
	/* Macros: */
53
		/** LED mask for the library LED driver, to indicate that the USB interface is not ready. */
54
		#define LEDMASK_USB_NOTREADY      LEDS_LED1
55
56

		/** LED mask for the library LED driver, to indicate that the USB interface is enumerating. */
57
		#define LEDMASK_USB_ENUMERATING  (LEDS_LED2 | LEDS_LED3)
58
59

		/** LED mask for the library LED driver, to indicate that the USB interface is ready. */
60
		#define LEDMASK_USB_READY        (LEDS_LED2 | LEDS_LED4)
61
62

		/** LED mask for the library LED driver, to indicate that an error has occurred in the USB interface. */
63
		#define LEDMASK_USB_ERROR        (LEDS_LED1 | LEDS_LED3)
64
65

	/* Function Prototypes: */
66
67
		void SetupHardware(void);

68
69
70
71
		void EVENT_USB_Device_Connect(void);
		void EVENT_USB_Device_Disconnect(void);
		void EVENT_USB_Device_ConfigurationChanged(void);
		void EVENT_USB_Device_UnhandledControlRequest(void);
72
		void EVENT_USB_Device_StartOfFrame(void);
73

74
		bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, uint8_t* const ReportID,
75
                                                 const uint8_t ReportType, void* ReportData, uint16_t* ReportSize);
76
77
		void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, const uint8_t ReportID, 
		                                          const void* ReportData, const uint16_t ReportSize);
78
79
		
#endif