mirror of
				https://github.com/mfulz/qmk_firmware.git
				synced 2025-11-04 07:12:33 +01:00 
			
		
		
		
	Added new USE_FLASH_DESCRIPTORS compile time option. By default, descriptors can now lie in mixed memory spaces (specified by a new parameter to the CALLBACK_USB_GetDescriptor() function) unless one of the USE_*_DESCRIPTORS compile time option is specified.
		
			
				
	
	
		
			81 lines
		
	
	
		
			3.3 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
			
		
		
	
	
			81 lines
		
	
	
		
			3.3 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
/*
 | 
						|
             LUFA Library
 | 
						|
     Copyright (C) Dean Camera, 2009.
 | 
						|
              
 | 
						|
  dean [at] fourwalledcubicle [dot] com
 | 
						|
      www.fourwalledcubicle.com
 | 
						|
*/
 | 
						|
 | 
						|
/*
 | 
						|
  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
 | 
						|
 | 
						|
  Permission to use, copy, modify, and distribute this software
 | 
						|
  and its documentation for any purpose and without fee is hereby
 | 
						|
  granted, 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 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 ConfigDescriptor.c.
 | 
						|
 */
 | 
						|
 | 
						|
#ifndef _CONFIGDESCRIPTOR_H_
 | 
						|
#define _CONFIGDESCRIPTOR_H_
 | 
						|
 | 
						|
	/* Includes: */
 | 
						|
		#include <LUFA/Drivers/USB/USB.h>                        // USB Functionality
 | 
						|
		
 | 
						|
		#include "HIDReport.h"
 | 
						|
		
 | 
						|
	/* Macros: */
 | 
						|
		/** Interface Class value for the Human Interface Device class */
 | 
						|
		#define KEYBOARD_CLASS                 0x03
 | 
						|
 | 
						|
		/** Interface Protocol value for a Boot Protocol Keyboard compliant device */
 | 
						|
		#define KEYBOARD_PROTOCOL              0x01
 | 
						|
		
 | 
						|
		/** Maximum size of a device configuration descriptor which can be processed by the host, in bytes */
 | 
						|
		#define MAX_CONFIG_DESCRIPTOR_SIZE     512
 | 
						|
 | 
						|
		/** Descriptor header type constant for a HID descriptor */
 | 
						|
		#define DTYPE_HID                      0x21
 | 
						|
 | 
						|
		/** Descriptor header type constant for a HID report descriptor */
 | 
						|
		#define DTYPE_Report                   0x22
 | 
						|
	
 | 
						|
	/* Enums: */
 | 
						|
		/** Enum for the possible return codes of the ProcessConfigurationDescriptor() function. */
 | 
						|
		enum KeyboardHostWithParser_GetConfigDescriptorDataCodes_t
 | 
						|
		{
 | 
						|
			SuccessfulConfigRead            = 0, /**< Configuration Descriptor was processed successfully */
 | 
						|
			ControlError                    = 1, /**< A control request to the device failed to complete successfully */
 | 
						|
			DescriptorTooLarge              = 2, /**< The device's Configuration Descriptor is too large to process */
 | 
						|
			InvalidConfigDataReturned       = 3, /**< The device returned an invalid Configuration Descriptor */
 | 
						|
			NoHIDInterfaceFound             = 4, /**< A compatible HID interface was not found in the device's Configuration Descriptor */
 | 
						|
			NoHIDDescriptorFound            = 5, /**< A compatible HID descriptor was not found in the device's HID interface */
 | 
						|
			NoEndpointFound                 = 5, /**< A compatible HID IN endpoint was not found in the device's HID interface */
 | 
						|
		};
 | 
						|
 | 
						|
	/* Function Prototypes: */
 | 
						|
		uint8_t ProcessConfigurationDescriptor(void);
 | 
						|
 | 
						|
		uint8_t DComp_NextKeyboardInterface(void* CurrentDescriptor);
 | 
						|
		uint8_t DComp_NextInterfaceKeyboardDataEndpoint(void* CurrentDescriptor);
 | 
						|
		uint8_t DComp_NextHID(void* CurrentDescriptor);
 | 
						|
		
 | 
						|
#endif
 |