Blame view

src/lufa-LUFA-170418/Projects/Magstripe/Descriptors.h 3.55 KB
ca85a266   gperson   le vrai commit, c...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
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
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
  /*
               LUFA Library
       Copyright (C) Dean Camera, 2017.
  
    dean [at] fourwalledcubicle [dot] com
             www.lufa-lib.org
  */
  
  /*
    Copyright 2010  Denver Gingerich (denver [at] ossguy [dot] com)
    Copyright 2017  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  
    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
    software without specific, written prior permission.
  
    The author disclaims 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 Descriptors.c.
   */
  
  #ifndef _DESCRIPTORS_H_
  #define _DESCRIPTORS_H_
  
  	/* Includes: */
  		#include <avr/pgmspace.h>
  
  		#include <LUFA/Drivers/USB/USB.h>
  
  		#include "Config/AppConfig.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; /**< Configuration descriptor header structure */
  
  			// Keyboard HID Interface
  			USB_Descriptor_Interface_t            HID_Interface; /**< Keyboard interface descriptor */
  			USB_HID_Descriptor_HID_t              HID_KeyboardHID; /**< Keyboard HID descriptor */
  			USB_Descriptor_Endpoint_t             HID_ReportINEndpoint; /**< Keyboard key report endpoint descriptor */
  		} USB_Descriptor_Configuration_t;
  
  		/** 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
  		{
  			INTERFACE_ID_Keyboard = 0, /**< Keyboard interface descriptor ID */
  		};
  
  		/** Enum for the device string descriptor IDs within the device. Each string descriptor should
  		 *  have a unique ID index associated with it, which can be used to refer to the string from
  		 *  other descriptors.
  		 */
  		enum StringDescriptors_t
  		{
  			STRING_ID_Language     = 0, /**< Supported Languages string descriptor ID (must be zero) */
  			STRING_ID_Manufacturer = 1, /**< Manufacturer string ID */
  			STRING_ID_Product      = 2, /**< Product string ID */
  		};
  
  	/* Macros: */
  		/** Endpoint address of the keyboard key press reporting endpoint. */
  		#define KEYBOARD_EPADDR              (ENDPOINT_DIR_IN | 1)
  
  		/** Size of the keyboard report endpoints, in bytes. */
  		#define KEYBOARD_EPSIZE              8
  
  	/* Function Prototypes: */
  		uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
  		                                    const uint16_t wIndex,
  		                                    const void** const DescriptorAddress)
  		                                    ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3);
  
  #endif