Fix outdated filename references in the LUFA documentation.
[pub/USBasp.git] / Projects / Magstripe / Descriptors.h
index 3dbfb8b..0f4869f 100644 (file)
@@ -1,6 +1,6 @@
 /*
              LUFA Library
 /*
              LUFA Library
-     Copyright (C) Dean Camera, 2012.
+     Copyright (C) Dean Camera, 2013.
 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
@@ -8,7 +8,7 @@
 
 /*
   Copyright 2010  Denver Gingerich (denver [at] ossguy [dot] com)
 
 /*
   Copyright 2010  Denver Gingerich (denver [at] ossguy [dot] com)
-  Copyright 2012  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2013  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
 
   Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted
                USB_Descriptor_Endpoint_t             HID_ReportINEndpoint; /**< Keyboard key report endpoint descriptor */
                } USB_Descriptor_Configuration_t;
 
                USB_Descriptor_Endpoint_t             HID_ReportINEndpoint; /**< Keyboard key report endpoint descriptor */
                } USB_Descriptor_Configuration_t;
 
+               /** 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)
        /* Macros: */
                /** Endpoint address of the keyboard key press reporting endpoint. */
                #define KEYBOARD_EPADDR              (ENDPOINT_DIR_IN | 1)