Descriptors.h 2.78 KB
Newer Older
1
2
/*
             LUFA Library
Dean Camera's avatar
Dean Camera committed
3
     Copyright (C) Dean Camera, 2018.
4
5
6
7
8
9

  dean [at] fourwalledcubicle [dot] com
           www.lufa-lib.org
*/

/*
Dean Camera's avatar
Dean Camera committed
10
  Copyright 2018  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
17
18
  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
  software without specific, written prior permission.

21
  The author disclaims all warranties with regard to this
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
47
48
49
  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 Descriptors.c.
 */

#ifndef _DESCRIPTORS_H_
#define _DESCRIPTORS_H_

	/* Includes: */
		#include <LUFA/Drivers/USB/USB.h>

	/* Type Defines: */
		/** Type define for the device configuration descriptor structure. This must be defined in the
		 *  application code, as the configuration descriptor contains several sub-descriptors which
		 *  vary between devices, and which describe the device's usage to the host.
		 */
		typedef struct
		{
			USB_Descriptor_Configuration_Header_t Config;
50

51
52
53
			// Generic HID Interface
			USB_Descriptor_Interface_t            HID_Interface;
			USB_HID_Descriptor_HID_t              HID_VendorHID;
54
			USB_Descriptor_Endpoint_t             HID_ReportINEndpoint;
55
		} USB_Descriptor_Configuration_t;
56

57
58
59
60
61
62
		/** Enum for the device interface descriptor IDs within the device. Each interface descriptor
		 *  should have a unique ID index associated with it, which can be used to refer to the
		 *  interface from other descriptors.
		 */
		enum InterfaceDescriptors_t
		{
63
			INTERFACE_ID_GenericHID = 0, /**< GenericHID interface descriptor ID */
64
65
		};

66
	/* Macros: */
67
68
		/** Endpoint address of the HID data IN endpoint. */
		#define HID_IN_EPADDR                (ENDPOINT_DIR_IN | 1)
69

70
		/** Size in bytes of the HID reporting IN endpoint. */
71
72
73
74
		#define HID_IN_EPSIZE                64

	/* Function Prototypes: */
		uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
75
		                                    const uint16_t wIndex,
76
77
78
79
		                                    const void** const DescriptorAddress)
		                                    ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3);

#endif
80