diff options
| author | Jack Humbert <jack.humb@gmail.com> | 2016-06-18 20:30:24 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2016-06-18 20:30:24 +0200 |
| commit | db32864ce7029d758f57729cc2f75e051a28d0a2 (patch) | |
| tree | f3ac60d9c826a9ad5ef5bc4d199efaddae156ba6 /tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet | |
| parent | 1923cffd41d9d71cd9f434092654dba05513137b (diff) | |
| download | qmk_firmware-db32864ce7029d758f57729cc2f75e051a28d0a2.tar.gz qmk_firmware-db32864ce7029d758f57729cc2f75e051a28d0a2.tar.xz | |
Cleans up quantum/keymap situation, removes extra lufa folders (#416)
* sorts out keycodes
* move midi around
* remove mbed
* replaces keymap with qmk/keymap_common
* fixes keymap.h
* keymap, config, quantum rearrange
* removes unneeded lufa stuff
Diffstat (limited to 'tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet')
30 files changed, 0 insertions, 6248 deletions
diff --git a/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Config/AppConfig.h b/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Config/AppConfig.h deleted file mode 100644 index 92a4f818e..000000000 --- a/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Config/AppConfig.h +++ /dev/null @@ -1,60 +0,0 @@ -/* - LUFA Library - Copyright (C) Dean Camera, 2014. - - dean [at] fourwalledcubicle [dot] com - www.lufa-lib.org -*/ - -/* - Copyright 2014 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 - * \brief Application Configuration Header File - * - * This is a header file which is be used to configure some of - * the application's compile time options, as an alternative to - * specifying the compile time constants supplied through a - * makefile or build system. - * - * For information on what each token does, refer to the - * \ref Sec_Options section of the application documentation. - */ - -#ifndef _APP_CONFIG_H_ -#define _APP_CONFIG_H_ - - #define CLIENT_IP_ADDRESS { 10, 0, 0, 1} - #define SERVER_IP_ADDRESS { 10, 0, 0, 2} - - #define ADAPTER_MAC_ADDRESS {0x02, 0x00, 0x02, 0x00, 0x02, 0x00} - #define SERVER_MAC_ADDRESS {0x00, 0x01, 0x00, 0x01, 0x00, 0x01} - - #define NO_DECODE_ETHERNET - #define NO_DECODE_ARP - #define NO_DECODE_IP - #define NO_DECODE_ICMP - #define NO_DECODE_TCP - #define NO_DECODE_UDP - #define NO_DECODE_DHCP - -#endif diff --git a/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Config/LUFAConfig.h b/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Config/LUFAConfig.h deleted file mode 100644 index fa0397910..000000000 --- a/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Config/LUFAConfig.h +++ /dev/null @@ -1,126 +0,0 @@ -/* - LUFA Library - Copyright (C) Dean Camera, 2014. - - dean [at] fourwalledcubicle [dot] com - www.lufa-lib.org -*/ - -/* - Copyright 2014 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 - * \brief LUFA Library Configuration Header File - * - * This header file is used to configure LUFA's compile time options, - * as an alternative to the compile time constants supplied through - * a makefile. - * - * For information on what each token does, refer to the LUFA - * manual section "Summary of Compile Tokens". - */ - -#ifndef _LUFA_CONFIG_H_ -#define _LUFA_CONFIG_H_ - - #if (ARCH == ARCH_AVR8) - - /* Non-USB Related Configuration Tokens: */ -// #define DISABLE_TERMINAL_CODES - - /* USB Class Driver Related Tokens: */ -// #define HID_HOST_BOOT_PROTOCOL_ONLY -// #define HID_STATETABLE_STACK_DEPTH {Insert Value Here} -// #define HID_USAGE_STACK_DEPTH {Insert Value Here} -// #define HID_MAX_COLLECTIONS {Insert Value Here} -// #define HID_MAX_REPORTITEMS {Insert Value Here} -// #define HID_MAX_REPORT_IDS {Insert Value Here} -// #define NO_CLASS_DRIVER_AUTOFLUSH - - /* General USB Driver Related Tokens: */ -// #define ORDERED_EP_CONFIG - #define USE_STATIC_OPTIONS (USB_DEVICE_OPT_FULLSPEED | USB_OPT_REG_ENABLED | USB_OPT_AUTO_PLL) - #define USB_DEVICE_ONLY -// #define USB_HOST_ONLY -// #define USB_STREAM_TIMEOUT_MS {Insert Value Here} -// #define NO_LIMITED_CONTROLLER_CONNECT -// #define NO_SOF_EVENTS - - /* USB Device Mode Driver Related Tokens: */ -// #define USE_RAM_DESCRIPTORS - #define USE_FLASH_DESCRIPTORS -// #define USE_EEPROM_DESCRIPTORS -// #define NO_INTERNAL_SERIAL - #define FIXED_CONTROL_ENDPOINT_SIZE 8 -// #define DEVICE_STATE_AS_GPIOR {Insert Value Here} - #define FIXED_NUM_CONFIGURATIONS 1 -// #define CONTROL_ONLY_DEVICE -// #define INTERRUPT_CONTROL_ENDPOINT -// #define NO_DEVICE_REMOTE_WAKEUP -// #define NO_DEVICE_SELF_POWER - - /* USB Host Mode Driver Related Tokens: */ -// #define HOST_STATE_AS_GPIOR {Insert Value Here} -// #define USB_HOST_TIMEOUT_MS {Insert Value Here} -// #define HOST_DEVICE_SETTLE_DELAY_MS {Insert Value Here} -// #define NO_AUTO_VBUS_MANAGEMENT -// #define INVERTED_VBUS_ENABLE_LINE - - #elif (ARCH == ARCH_XMEGA) - - /* Non-USB Related Configuration Tokens: */ -// #define DISABLE_TERMINAL_CODES - - /* USB Class Driver Related Tokens: */ -// #define HID_HOST_BOOT_PROTOCOL_ONLY -// #define HID_STATETABLE_STACK_DEPTH {Insert Value Here} -// #define HID_USAGE_STACK_DEPTH {Insert Value Here} -// #define HID_MAX_COLLECTIONS {Insert Value Here} -// #define HID_MAX_REPORTITEMS {Insert Value Here} -// #define HID_MAX_REPORT_IDS {Insert Value Here} -// #define NO_CLASS_DRIVER_AUTOFLUSH - - /* General USB Driver Related Tokens: */ - #define USE_STATIC_OPTIONS (USB_DEVICE_OPT_FULLSPEED | USB_OPT_RC32MCLKSRC | USB_OPT_BUSEVENT_PRIHIGH) -// #define USB_STREAM_TIMEOUT_MS {Insert Value Here} -// #define NO_LIMITED_CONTROLLER_CONNECT -// #define NO_SOF_EVENTS - - /* USB Device Mode Driver Related Tokens: */ -// #define USE_RAM_DESCRIPTORS - #define USE_FLASH_DESCRIPTORS -// #define USE_EEPROM_DESCRIPTORS -// #define NO_INTERNAL_SERIAL - #define FIXED_CONTROL_ENDPOINT_SIZE 8 -// #define DEVICE_STATE_AS_GPIOR {Insert Value Here} - #define FIXED_NUM_CONFIGURATIONS 1 -// #define CONTROL_ONLY_DEVICE - #define MAX_ENDPOINT_INDEX 3 -// #define NO_DEVICE_REMOTE_WAKEUP -// #define NO_DEVICE_SELF_POWER - - #else - - #error Unsupported architecture for this LUFA configuration file. - - #endif -#endif diff --git a/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Descriptors.c b/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Descriptors.c deleted file mode 100644 index cab6717f9..000000000 --- a/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Descriptors.c +++ /dev/null @@ -1,244 +0,0 @@ -/* - LUFA Library - Copyright (C) Dean Camera, 2014. - - dean [at] fourwalledcubicle [dot] com - www.lufa-lib.org -*/ - -/* - Copyright 2014 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 - * - * USB Device Descriptors, for library use when in USB device mode. Descriptors are special - * computer-readable structures which the host requests upon device enumeration, to determine - * the device's capabilities and functions. - */ - -#include "Descriptors.h" - -/** Device descriptor structure. This descriptor, located in FLASH memory, describes the overall - * device characteristics, including the supported USB version, control endpoint size and the - * number of device configurations. The descriptor is read out by the USB host when the enumeration - * process begins. - */ -const USB_Descriptor_Device_t PROGMEM DeviceDescriptor = -{ - .Header = {.Size = sizeof(USB_Descriptor_Device_t), .Type = DTYPE_Device}, - - .USBSpecification = VERSION_BCD(1,1,0), - .Class = CDC_CSCP_CDCClass, - .SubClass = CDC_CSCP_NoSpecificSubclass, - .Protocol = CDC_CSCP_NoSpecificProtocol, - - .Endpoint0Size = FIXED_CONTROL_ENDPOINT_SIZE, - - .VendorID = 0x03EB, - .ProductID = 0x204C, - .ReleaseNumber = VERSION_BCD(0,0,1), - - .ManufacturerStrIndex = STRING_ID_Manufacturer, - .ProductStrIndex = STRING_ID_Product, - .SerialNumStrIndex = NO_DESCRIPTOR, - - .NumberOfConfigurations = FIXED_NUM_CONFIGURATIONS -}; - -/** Configuration descriptor structure. This descriptor, located in FLASH memory, describes the usage - * of the device in one of its supported configurations, including information about any device interfaces - * and endpoints. The descriptor is read out by the USB host during the enumeration process when selecting - * a configuration so that the host may correctly communicate with the USB device. - */ -const USB_Descriptor_Configuration_t PROGMEM ConfigurationDescriptor = -{ - .Config = - { - .Header = {.Size = sizeof(USB_Descriptor_Configuration_Header_t), .Type = DTYPE_Configuration}, - - .TotalConfigurationSize = sizeof(USB_Descriptor_Configuration_t), - .TotalInterfaces = 2, - - .ConfigurationNumber = 1, - .ConfigurationStrIndex = NO_DESCRIPTOR, - - .ConfigAttributes = (USB_CONFIG_ATTR_RESERVED | USB_CONFIG_ATTR_SELFPOWERED), - - .MaxPowerConsumption = USB_CONFIG_POWER_MA(100) - }, - - .CDC_CCI_Interface = - { - .Header = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface}, - - .InterfaceNumber = INTERFACE_ID_CDC_CCI, - .AlternateSetting = 0, - - .TotalEndpoints = 1, - - .Class = CDC_CSCP_CDCClass, - .SubClass = CDC_CSCP_ACMSubclass, - .Protocol = CDC_CSCP_VendorSpecificProtocol, - - .InterfaceStrIndex = NO_DESCRIPTOR - }, - - .CDC_Functional_Header = - { - .Header = {.Size = sizeof(USB_CDC_Descriptor_FunctionalHeader_t), .Type = DTYPE_CSInterface}, - .Subtype = CDC_DSUBTYPE_CSInterface_Header, - - .CDCSpecification = VERSION_BCD(1,1,0), - }, - - .CDC_Functional_ACM = - { - .Header = {.Size = sizeof(USB_CDC_Descriptor_FunctionalACM_t), .Type = DTYPE_CSInterface}, - .Subtype = CDC_DSUBTYPE_CSInterface_ACM, - - .Capabilities = 0x00, - }, - - .CDC_Functional_Union = - { - .Header = {.Size = sizeof(USB_CDC_Descriptor_FunctionalUnion_t), .Type = DTYPE_CSInterface}, - .Subtype = CDC_DSUBTYPE_CSInterface_Union, - - .MasterInterfaceNumber = INTERFACE_ID_CDC_CCI, - .SlaveInterfaceNumber = INTERFACE_ID_CDC_DCI, - }, - - .CDC_NotificationEndpoint = - { - .Header = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint}, - - .EndpointAddress = CDC_NOTIFICATION_EPADDR, - .Attributes = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA), - .EndpointSize = CDC_NOTIFICATION_EPSIZE, - .PollingIntervalMS = 0xFF - }, - - .CDC_DCI_Interface = - { - .Header = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface}, - - .InterfaceNumber = INTERFACE_ID_CDC_DCI, - .AlternateSetting = 0, - - .TotalEndpoints = 2, - - .Class = CDC_CSCP_CDCDataClass, - .SubClass = CDC_CSCP_NoDataSubclass, - .Protocol = CDC_CSCP_NoDataProtocol, - - .InterfaceStrIndex = NO_DESCRIPTOR - }, - - .RNDIS_DataOutEndpoint = - { - .Header = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint}, - - .EndpointAddress = CDC_RX_EPADDR, - .Attributes = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA), - .EndpointSize = CDC_TXRX_EPSIZE, - .PollingIntervalMS = 0x05 - }, - - .RNDIS_DataInEndpoint = - { - .Header = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint}, - - .EndpointAddress = CDC_TX_EPADDR, - .Attributes = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA), - .EndpointSize = CDC_TXRX_EPSIZE, - .PollingIntervalMS = 0x05 - } -}; - -/** Language descriptor structure. This descriptor, located in FLASH memory, is returned when the host requests - * the string descriptor with index 0 (the first index). It is actually an array of 16-bit integers, which indicate - * via the language ID table available at USB.org what languages the device supports for its string descriptors. - */ -const USB_Descriptor_String_t PROGMEM LanguageString = USB_STRING_DESCRIPTOR_ARRAY(LANGUAGE_ID_ENG); - -/** Manufacturer descriptor string. This is a Unicode string containing the manufacturer's details in human readable - * form, and is read out upon request by the host when the appropriate string ID is requested, listed in the Device - * Descriptor. - */ -const USB_Descriptor_String_t PROGMEM ManufacturerString = USB_STRING_DESCRIPTOR(L"Dean Camera"); - -/** Product descriptor string. This is a Unicode string containing the product's details in human readable form, - * and is read out upon request by the host when the appropriate string ID is requested, listed in the Device - * Descriptor. - */ -const USB_Descriptor_String_t PROGMEM ProductString = USB_STRING_DESCRIPTOR(L"LUFA RNDIS CDC Demo"); - -/** This function is called by the library when in device mode, and must be overridden (see library "USB Descriptors" - * documentation) by the application code so that the address and size of a requested descriptor can be given - * to the USB library. When the device receives a Get Descriptor request on the control endpoint, this function - * is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the - * USB host. - */ -uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue, - const uint8_t wIndex, - const void** const DescriptorAddress) -{ - const uint8_t DescriptorType = (wValue >> 8); - const uint8_t DescriptorNumber = (wValue & 0xFF); - - const void* Address = NULL; - uint16_t Size = NO_DESCRIPTOR; - - switch (DescriptorType) - { - case DTYPE_Device: - Address = &DeviceDescriptor; - Size = sizeof(USB_Descriptor_Device_t); - break; - case DTYPE_Configuration: - Address = &ConfigurationDescriptor; - Size = sizeof(USB_Descriptor_Configuration_t); - break; - case DTYPE_String: - switch (DescriptorNumber) - { - case STRING_ID_Language: - Address = &LanguageString; - Size = pgm_read_byte(&LanguageString.Header.Size); - break; - case STRING_ID_Manufacturer: - Address = &ManufacturerString; - Size = pgm_read_byte(&ManufacturerString.Header.Size); - break; - case STRING_ID_Product: - Address = &ProductString; - Size = pgm_read_byte(&ProductString.Header.Size); - break; - } - - break; - } - - *DescriptorAddress = Address; - return Size; -} - diff --git a/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Descriptors.h b/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Descriptors.h deleted file mode 100644 index 4ac270fc8..000000000 --- a/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Descriptors.h +++ /dev/null @@ -1,112 +0,0 @@ -/* - LUFA Library - Copyright (C) Dean Camera, 2014. - - dean [at] fourwalledcubicle [dot] com - www.lufa-lib.org -*/ - -/* - Copyright 2014 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 <LUFA/Drivers/USB/USB.h> - - #include <avr/pgmspace.h> - - #include "Config/AppConfig.h" - - /* Macros: */ - /** Endpoint address of the CDC device-to-host notification IN endpoint. */ - #define CDC_NOTIFICATION_EPADDR (ENDPOINT_DIR_IN | 3) - - /** Endpoint address of the CDC device-to-host data IN endpoint. */ - #define CDC_TX_EPADDR (ENDPOINT_DIR_IN | 1) - - /** Endpoint address of the CDC host-to-device data OUT endpoint. */ - #define CDC_RX_EPADDR (ENDPOINT_DIR_OUT | 2) - - /** Size in bytes of the CDC device-to-host notification IN endpoint. */ - #define CDC_NOTIFICATION_EPSIZE 8 - - /** Size in bytes of the CDC data IN and OUT endpoints. */ - #define CDC_TXRX_EPSIZE 64 - - /* 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; - - // RNDIS CDC Control Interface - USB_Descriptor_Interface_t CDC_CCI_Interface; - USB_CDC_Descriptor_FunctionalHeader_t CDC_Functional_Header; - USB_CDC_Descriptor_FunctionalACM_t CDC_Functional_ACM; - USB_CDC_Descriptor_FunctionalUnion_t CDC_Functional_Union; - USB_Descriptor_Endpoint_t CDC_NotificationEndpoint; - - // RNDIS CDC Data Interface - USB_Descriptor_Interface_t CDC_DCI_Interface; - USB_Descriptor_Endpoint_t RNDIS_DataOutEndpoint; - USB_Descriptor_Endpoint_t RNDIS_DataInEndpoint; - } 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_CDC_CCI = 0, /**< CDC CCI interface descriptor ID */ - INTERFACE_ID_CDC_DCI = 1, /**< CDC DCI 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 */ - }; - - /* Function Prototypes: */ - uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue, - const uint8_t wIndex, - const void** const DescriptorAddress) - ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3); - -#endif - diff --git a/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/LUFA RNDIS.inf b/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/LUFA RNDIS.inf deleted file mode 100644 index f34e55f99..000000000 --- a/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/LUFA RNDIS.inf +++ /dev/null @@ -1,59 +0,0 @@ -; Windows LUFA RNDIS Setup File -; Copyright (c) 2000 Microsoft Corporation - -[DefaultInstall] -CopyINF="LUFA RNDIS.inf" - -[Version] -Signature="$Windows NT$" -Class=Net -ClassGuid={4d36e972-e325-11ce-bfc1-08002be10318} -Provider=%MFGNAME% -DriverVer=7/1/2012,10.0.0.0 - -[Manufacturer] -%MFGNAME%=DeviceList, NTx86, NTamd64, NTia64 - -[ControlFlags] -ExcludeFromSelect=* - -[DriverInstall] -Characteristics=0x84 ; NCF_PHYSICAL + NCF_HAS_UI -BusType=15 -include=netrndis.inf -needs=Usb_Rndis.ndi -AddReg=Rndis_AddReg_Vista - -[DriverInstall.Services] -include=netrndis.inf -needs=Usb_Rndis.ndi.Services - -;------------------------------------------------------------------------------ -; Vendor and Product ID Definitions -;------------------------------------------------------------------------------ -; When developing your USB device, the VID and PID used in the PC side -; application program and the firmware on the microcontroller must match. -; Modify the below line to use your VID and PID. Use the format as shown below. -; Note: One INF file can be used for multiple devices with different VID and PIDs. -; For each supported device, append ",USB\VID_xxxx&PID_yyyy" to the end of the line. -;------------------------------------------------------------------------------ -[DeviceList] -%DESCRIPTION%=DriverInstall, USB\VID_03EB&PID_204C - -[DeviceList.NTx86] -%DESCRIPTION%=DriverInstall, USB\VID_03EB&PID_204C - -[DeviceList.NTamd64] -%DESCRIPTION%=DriverInstall, USB\VID_03EB&PID_204C - -[DeviceList.NTia64] -%DESCRIPTION%=DriverInstall, USB\VID_03EB&PID_204C - -;------------------------------------------------------------------------------ -; String Definitions -;------------------------------------------------------------------------------ -;Modify these strings to customize your device -;------------------------------------------------------------------------------ -[Strings] -MFGNAME="http://www.lufa-lib.org" -DESCRIPTION="LUFA USB RNDIS Demo" diff --git a/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Lib/ARP.c b/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Lib/ARP.c deleted file mode 100644 index 6aaf0edd4..000000000 --- a/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Lib/ARP.c +++ /dev/null @@ -1,87 +0,0 @@ -/* - LUFA Library - Copyright (C) Dean Camera, 2014. - - dean [at] fourwalledcubicle [dot] com - www.lufa-lib.org -*/ - -/* - Copyright 2014 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 - * - * Address Resolution Protocol (ARP) packet handling routines. This protocol handles the - * conversion of physical MAC addresses to protocol IP addresses between the host and the - * device. - */ - -#include "ARP.h" - -/** Processes an ARP packet inside an Ethernet frame, and writes the appropriate response - * to the output Ethernet frame if the host is requesting the IP or MAC address of the - * virtual server device on the network. - * - * \param[in] InDataStart Pointer to the start of the incoming packet's ARP header - * \param[out] OutDataStart Pointer to the start of the outgoing packet's ARP header - * - * \return The number of bytes written to the out Ethernet frame if any, NO_RESPONSE otherwise - */ -int16_t ARP_ProcessARPPacket(void* InDataStart, - void* OutDataStart) -{ - DecodeARPHeader(InDataStart); - - ARP_Header_t* ARPHeaderIN = (ARP_Header_t*)InDataStart; - ARP_Header_t* ARPHeaderOUT = (ARP_Header_t*)OutDataStart; - - /* Ensure that the ARP request is a IPv4 request packet */ - if ((SwapEndian_16(ARPHeaderIN->ProtocolType) == ETHERTYPE_IPV4) && - (SwapEndian_16(ARPHeaderIN->Operation) == ARP_OPERATION_REQUEST)) - { - /* If the ARP packet is requesting the MAC or IP of the virtual webserver, return the response */ - if (IP_COMPARE(&ARPHeaderIN->TPA, &ServerIPAddress) || - MAC_COMPARE(&ARPHeaderIN->THA, &ServerMACAddress)) - { - /* Fill out the ARP response header */ - ARPHeaderOUT->HardwareType = ARPHeaderIN->HardwareType; - ARPHeaderOUT->ProtocolType = ARPHeaderIN->ProtocolType; - ARPHeaderOUT->HLEN = ARPHeaderIN->HLEN; - ARPHeaderOUT->PLEN = ARPHeaderIN->PLEN; - ARPHeaderOUT->Operation = SwapEndian_16(ARP_OPERATION_REPLY); - - /* Copy over the sender MAC/IP to the target fields for the response */ - ARPHeaderOUT->THA = ARPHeaderIN->SHA; - ARPHeaderOUT->TPA = ARPHeaderIN->SPA; - - /* Copy over the new sender MAC/IP - MAC and IP addresses of the virtual webserver */ - ARPHeaderOUT->SHA = ServerMACAddress; - ARPHeaderOUT->SPA = ServerIPAddress; - - /* Return the size of the response so far */ - return sizeof(ARP_Header_t); - } - } - - return NO_RESPONSE; -} - diff --git a/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Lib/ARP.h b/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Lib/ARP.h deleted file mode 100644 index 8535b8545..000000000 --- a/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Lib/ARP.h +++ /dev/null @@ -1,76 +0,0 @@ -/* - LUFA Library - Copyright (C) Dean Camera, 2014. - - dean [at] fourwalledcubicle [dot] com - www.lufa-lib.org -*/ - -/* - Copyright 2014 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 ARP.c. - */ - -#ifndef _ARP_H_ -#define _ARP_H_ - - /* Includes: */ - #include <avr/io.h> - #include <string.h> - - #include "EthernetProtocols.h" - #include "Ethernet.h" - #include "ProtocolDecoders.h" - - /* Macros: */ - /** ARP header operation constant, indicating a request from a host for an address translation. */ - #define ARP_OPERATION_REQUEST 1 - - /** ARP header operation constant, indicating a reply from a host giving an address translation. */ - #define ARP_OPERATION_REPLY 2 - - /* Type Defines: */ - /** Type define for an ARP packet inside an Ethernet frame. */ - typedef struct - { - uint16_t HardwareType; /**< Hardware type constant, indicating the hardware used */ - uint16_t ProtocolType; /**< Protocol being resolved, usually ETHERTYPE_IPV4 */ - - uint8_t HLEN; /**< Length in bytes of the source/destination hardware addresses */ - uint8_t PLEN; /**< Length in bytes of the source/destination protocol addresses */ - uint16_t Operation; /**< Type of operation, either ARP_OPERATION_REQUEST or ARP_OPERATION_REPLY */ - - MAC_Address_t SHA; /**< Sender's hardware address */ - IP_Address_t SPA; /**< Sender's protocol address */ - MAC_Address_t THA; /**< Target's hardware address */ - IP_Address_t TPA; /**< Target's protocol address */ - } ARP_Header_t; - - /* Function Prototypes: */ - int16_t ARP_ProcessARPPacket(void* InDataStart, - void* OutDataStart); - -#endif - diff --git a/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Lib/DHCP.c b/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Lib/DHCP.c deleted file mode 100644 index b3b5d6943..000000000 --- a/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Lib/DHCP.c +++ /dev/null @@ -1,121 +0,0 @@ -/* - LUFA Library - Copyright (C) Dean Camera, 2014. - - dean [at] fourwalledcubicle [dot] com - www.lufa-lib.org -*/ - -/* - Copyright 2014 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 - * - * Dynamic Host Configuration Protocol (DHCP) packet handling routines. This protocol - * handles the automatic IP negotiation to the host, so that the host will use the provided - * IP address given to it by the device. - */ - -#include "DHCP.h" - -/** Processes a DHCP packet inside an Ethernet frame, and writes the appropriate response - * to the output Ethernet frame if the host is requesting or accepting an IP address. - * - * \param[in] IPHeaderInStart Pointer to the start of the incoming packet's IP header - * \param[in] DHCPHeaderInStart Pointer to the start of the incoming packet's DHCP header - * \param[out] DHCPHeaderOutStart Pointer to the start of the outgoing packet's DHCP header - * - * \return The number of bytes written to the out Ethernet frame if any, NO_RESPONSE otherwise - */ -int16_t DHCP_ProcessDHCPPacket(void* IPHeaderInStart, - void* DHCPHeaderInStart, - void* DHCPHeaderOutStart) -{ - IP_Header_t* IPHeaderIN = (IP_Header_t*)IPHeaderInStart; - DHCP_Header_t* DHCPHeaderIN = (DHCP_Header_t*)DHCPHeaderInStart; - DHCP_Header_t* DHCPHeaderOUT = (DHCP_Header_t*)DHCPHeaderOutStart; - - uint8_t* DHCPOptionsINStart = ((uint8_t*)DHCPHeaderInStart + sizeof(DHCP_Header_t)); - uint8_t* DHCPOptionsOUTStart = ((uint8_t*)DHCPHeaderOutStart + sizeof(DHCP_Header_t)); - - DecodeDHCPHeader(DHCPHeaderInStart); - - /* Zero out the response DHCP packet, as much of it is legacy and left at 0 */ - memset(DHCPHeaderOUT, 0, sizeof(DHCP_Header_t)); - - /* Fill out the response DHCP packet */ - DHCPHeaderOUT->HardwareType = DHCPHeaderIN->HardwareType; - DHCPHeaderOUT->Operation = DHCP_OP_BOOTREPLY; - DHCPHeaderOUT->HardwareAddressLength = DHCPHeaderIN->HardwareAddressLength; - DHCPHeaderOUT->Hops = 0; - DHCPHeaderOUT->TransactionID = DHCPHeaderIN->TransactionID; - DHCPHeaderOUT->ElapsedSeconds = 0; - DHCPHeaderOUT->Flags = DHCPHeaderIN->Flags; - DHCPHeaderOUT->YourIP = ClientIPAddress; - memmove(&DHCPHeaderOUT->ClientHardwareAddress, &DHCPHeaderIN->ClientHardwareAddress, sizeof(MAC_Address_t)); - DHCPHeaderOUT->Cookie = SwapEndian_32(DHCP_MAGIC_COOKIE); - - /* Alter the incoming IP packet header so that the corrected IP source and destinations are used - this means that - when the response IP header is generated, it will use the corrected addresses and not the null/broatcast addresses */ - IPHeaderIN->SourceAddress = ClientIPAddress; - IPHeaderIN->DestinationAddress = ServerIPAddress; - - /* Process the incoming DHCP packet options */ - while (DHCPOptionsINStart[0] != DHCP_OPTION_END) - { - /* Find the Message Type DHCP option, to determine the type of DHCP packet */ - if (DHCPOptionsINStart[0] == DHCP_OPTION_MESSAGETYPE) - { - if ((DHCPOptionsINStart[2] == DHCP_MESSAGETYPE_DISCOVER) || (DHCPOptionsINStart[2] == DHCP_MESSAGETYPE_REQUEST)) - { - /* Fill out the response DHCP packet options for a DHCP OFFER or ACK response */ - - *(DHCPOptionsOUTStart++) = DHCP_OPTION_MESSAGETYPE; - *(DHCPOptionsOUTStart++) = 1; - *(DHCPOptionsOUTStart++) = (DHCPOptionsINStart[2] == DHCP_MESSAGETYPE_DISCOVER) ? DHCP_MESSAGETYPE_OFFER - : DHCP_MESSAGETYPE_ACK; - - *(DHCPOptionsOUTStart++) = DHCP_OPTION_SUBNETMASK; - *(DHCPOptionsOUTStart++) = 4; - *(DHCPOptionsOUTStart++) = 0xFF; - *(DHCPOptionsOUTStart++) = 0xFF; - *(DHCPOptionsOUTStart++) = 0xFF; - *(DHCPOptionsOUTStart++) = 0x00; - - *(DHCPOptionsOUTStart++) = DHCP_OPTION_DHCPSERVER; - *(DHCPOptionsOUTStart++) = sizeof(IP_Address_t); - memcpy(DHCPOptionsOUTStart, &ServerIPAddress, sizeof(IP_Address_t)); - DHCPOptionsOUTStart += sizeof(IP_Address_t); - - *(DHCPOptionsOUTStart++) = DHCP_OPTION_END; - - return (sizeof(DHCP_Header_t) + 12 + sizeof(IP_Address_t)); - } - } - - /* Go to the next DHCP option - skip one byte if option is a padding byte, else skip the complete option's size */ - DHCPOptionsINStart += ((DHCPOptionsINStart[0] == DHCP_OPTION_PAD) ? 1 : (DHCPOptionsINStart[1] + 2)); - } - - return NO_RESPONSE; -} - diff --git a/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Lib/DHCP.h b/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Lib/DHCP.h deleted file mode 100644 index 2d57397de..000000000 --- a/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Lib/DHCP.h +++ /dev/null @@ -1,128 +0,0 @@ -/* - LUFA Library - Copyright (C) Dean Camera, 2014. - - dean [at] fourwalledcubicle [dot] com - www.lufa-lib.org -*/ - -/* - Copyright 2014 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 DHCP.c. - */ - -#ifndef _DHCP_H_ -#define _DHCP_H_ - - /* Includes: */ - #include <avr/io.h> - #include <string.h> - - #include "EthernetProtocols.h" - #include "Ethernet.h" - #include "ProtocolDecoders.h" - - /* Macros: */ - /** DHCP operation constant, indicating a request from a host to a DHCP server. */ - #define DHCP_OP_BOOTREQUEST 0x01 - - /** DHCP operation constant, indicating a reply from a DHCP server to a host. */ - #define DHCP_OP_BOOTREPLY 0x02 - - /** Hardware type constant, indicating Ethernet as a carrier. */ - #define DHCP_HTYPE_ETHERNET 0x01 - - /** Magic boot protocol "cookie", inserted into all BOOTP packets (BOOTP is the carrier of DHCP). */ - #define DHCP_MAGIC_COOKIE 0x63825363 - - /** DHCP option list entry header, indicating that a subnet mask will follow. */ - #define DHCP_OPTION_SUBNETMASK 1 - - /** DHCP option list entry header, indicating that the DHCP message type constant will follow. */ - #define DHCP_OPTION_MESSAGETYPE 53 - - /** DHCP option list entry header, indicating that the IP address of the DHCP server will follow. */ - #define DHCP_OPTION_DHCPSERVER 54 - - /** DHCP option list entry header, used to pad out option data. */ - #define DHCP_OPTION_PAD 0 - - /** DHCP option list entry header, indicating the end of option data. */ - #define DHCP_OPTION_END 255 - - /** Message type constant, used in the DHCP option data field, requesting that a DHCP server offer an IP address. */ - #define DHCP_MESSAGETYPE_DISCOVER 1 - - /** Message type constant, used in the DHCP option data field, indicating that a DHCP server is offering an IP address. */ - #define DHCP_MESSAGETYPE_OFFER 2 - - /** Message type constant, used in the DHCP option data field, requesting that a DHCP server lease a given IP address. */ - #define DHCP_MESSAGETYPE_REQUEST 3 - - /** Message type constant, used in the DHCP option data field, declining an offered DHCP server IP address lease. */ - #define DHCP_MESSAGETYPE_DECLINE 4 - - /** Message type constant, used in the DHCP option data field, ACKing a host IP lease request. */ - #define DHCP_MESSAGETYPE_ACK 5 - - /** Message type constant, used in the DHCP option data field, NACKing a host IP lease request. */ - #define DHCP_MESSAGETYPE_NACK 6 - - /** Message type constant, used in the DHCP option data field, indicating that a host is releasing a leased IP address. */ - #define DHCP_MESSAGETYPE_RELEASE 7 - - /* Type Defines: */ - /** Type define for a DHCP packet inside an Ethernet frame. */ - typedef struct - { - uint8_t Operation; /**< DHCP operation, either DHCP_OP_BOOTREQUEST or DHCP_OP_BOOTREPLY */ - uint8_t HardwareType; /**< Hardware carrier type constant */ - uint8_t HardwareAddressLength; /**< Length in bytes of a hardware (MAC) address on the network */ - uint8_t Hops; /**< Number of hops required to reach the server, unused */ - - uint32_t TransactionID; /**< Unique ID of the DHCP packet, for positive matching between sent and received packets */ - - uint16_t ElapsedSeconds; /**< Elapsed seconds since the request was made */ - uint16_t Flags; /**< BOOTP packet flags */ - - IP_Address_t ClientIP; /**< Client IP address, if already leased an IP */ - IP_Address_t YourIP; /**< Client IP address */ - IP_Address_t NextServerIP; /**< Legacy BOOTP protocol field, unused for DHCP */ - IP_Address_t RelayAgentIP; /**< Legacy BOOTP protocol field, unused for DHCP */ - - uint8_t ClientHardwareAddress[16]; /**< Hardware (MAC) address of the client making a request to the DHCP server */ - uint8_t ServerHostnameString[64]; /**< Legacy BOOTP protocol field, unused for DHCP */ - uint8_t BootFileName[128]; /**< Legacy BOOTP protocol field, unused for DHCP */ - - uint32_t Cookie; /**< Magic BOOTP protocol cookie to indicate a valid packet */ - } DHCP_Header_t; - - /* Function Prototypes: */ - int16_t DHCP_ProcessDHCPPacket(void* IPHeaderInStart, - void* DHCPHeaderInStart, - void* DHCPHeaderOutStart); - -#endif - diff --git a/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Lib/Ethernet.c b/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Lib/Ethernet.c deleted file mode 100644 index 676039537..000000000 --- a/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Lib/Ethernet.c +++ /dev/null @@ -1,132 +0,0 @@ -/* - LUFA Library - Copyright (C) Dean Camera, 2014. - - dean [at] fourwalledcubicle [dot] com - www.lufa-lib.org -*/ - -/* - Copyright 2014 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 - * - * Ethernet frame packet handling routines. This protocol handles the processing of raw Ethernet - * frames sent and received, deferring the processing of sub-packet protocols to the appropriate - * protocol handlers, such as DHCP or ARP. - */ - -#include "Ethernet.h" - -/** Constant for convenience when checking against or setting a MAC address to the virtual server MAC address. */ -const MAC_Address_t ServerMACAddress = {SERVER_MAC_ADDRESS}; - -/** Constant for convenience when checking against or setting an IP address to the virtual server IP address. */ -const IP_Address_t ServerIPAddress = {SERVER_IP_ADDRESS}; - -/** Constant for convenience when checking against or setting a MAC address to the broadcast MAC address. */ -const MAC_Address_t BroadcastMACAddress = {BROADCAST_MAC_ADDRESS}; - -/** Constant for convenience when checking against or setting a IP address to the broadcast IP address. */ -const IP_Address_t BroadcastIPAddress = {BROADCAST_IP_ADDRESS}; - -/** Constant for convenience when checking against or setting an IP address to the client (host) IP address. */ -const IP_Address_t ClientIPAddress = {CLIENT_IP_ADDRESS}; - - -/** Processes an incoming Ethernet frame, and writes the appropriate response to the output Ethernet - * frame buffer if the sub protocol handlers create a valid response. - */ -void Ethernet_ProcessPacket(Ethernet_Frame_Info_t* const FrameIN, - Ethernet_Frame_Info_t* const FrameOUT) -{ - DecodeEthernetFrameHeader(FrameIN->FrameData); - - /* Cast the incoming Ethernet frame to the Ethernet header type */ - Ethernet_Frame_Header_t* FrameINHeader = (Ethernet_Frame_Header_t*)&FrameIN->FrameData; - Ethernet_Frame_Header_t* FrameOUTHeader = (Ethernet_Frame_Header_t*)&FrameOUT->FrameData; - - int16_t RetSize = NO_RESPONSE; - - /* Ensure frame is addressed to either all (broadcast) or the virtual webserver, and is a type II frame */ - if ((MAC_COMPARE(&FrameINHeader->Destination, &ServerMACAddress) || - MAC_COMPARE(&FrameINHeader->Destination, &BroadcastMACAddress)) && - (SwapEndian_16(FrameIN->FrameLength) > ETHERNET_VER2_MINSIZE)) - { - /* Process the packet depending on its protocol */ - switch (SwapEndian_16(FrameINHeader->EtherType)) - { - case ETHERTYPE_ARP: - RetSize = ARP_ProcessARPPacket(&FrameIN->FrameData[sizeof(Ethernet_Frame_Header_t)], - &FrameOUT->FrameData[sizeof(Ethernet_Frame_Header_t)]); - break; - case ETHERTYPE_IPV4: - RetSize = IP_ProcessIPPacket(FrameIN, - &FrameIN->FrameData[sizeof(Ethernet_Frame_Header_t)], - &FrameOUT->FrameData[sizeof(Ethernet_Frame_Header_t)]); - break; - } - - /* Protocol processing routine has filled a response, complete the ethernet frame header */ - if (RetSize > 0) - { - /* Fill out the response Ethernet frame header */ - FrameOUTHeader->Source = ServerMACAddress; - FrameOUTHeader->Destination = FrameINHeader->Source; - FrameOUTHeader->EtherType = FrameINHeader->EtherType; - - /* Set the response length in the buffer and indicate that a response is ready to be sent */ - FrameOUT->FrameLength = (sizeof(Ethernet_Frame_Header_t) + RetSize); - } - } - - /* Check if the packet was processed */ - if (RetSize != NO_PROCESS) - { - /* Clear the frame buffer */ - FrameIN->FrameLength = 0; - } -} - -/** Calculates the appropriate ethernet checksum, consisting of the addition of the one's - * compliment of each word, complimented. - * - * \param[in] Data Pointer to the packet buffer data whose checksum must be calculated - * \param[in] Bytes Number of bytes in the data buffer to process - * - * \return A 16-bit Ethernet checksum value - */ -uint16_t Ethernet_Checksum16(void* Data, - uint16_t Bytes) -{ - uint16_t* Words = (uint16_t*)Data; - uint32_t Checksum = 0; - - for (uint16_t CurrWord = 0; CurrWord < (Bytes >> 1); CurrWord++) - Checksum += Words[CurrWord]; - - while (Checksum & 0xFFFF0000) - Checksum = ((Checksum & 0xFFFF) + (Checksum >> 16)); - - return ~Checksum; -} - diff --git a/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Lib/Ethernet.h b/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Lib/Ethernet.h deleted file mode 100644 index 6de4a90cb..000000000 --- a/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Lib/Ethernet.h +++ /dev/null @@ -1,101 +0,0 @@ -/* - LUFA Library - Copyright (C) Dean Camera, 2014. - - dean [at] fourwalledcubicle [dot] com - www.lufa-lib.org -*/ - -/* - Copyright 2014 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 Ethernet.c. - */ - -#ifndef _ETHERNET_H_ -#define _ETHERNET_H_ - - /* Includes: */ - #include <avr/io.h> - #include <string.h> - - #include <LUFA/Drivers/USB/USB.h> - - #include "Config/AppConfig.h" - - #include "EthernetProtocols.h" - #include "ProtocolDecoders.h" - #include "ICMP.h" - #include "TCP.h" - #include "UDP.h" - #include "DHCP.h" - #include "ARP.h" - #include "IP.h" - - /* Macros: */ - /** Physical MAC address of the network broadcast address. */ - #define BROADCAST_MAC_ADDRESS {0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF} - - /** Performs a comparison between two MAC addresses, indicating if they are identical. - * - * \param[in] MAC1 First MAC address - * \param[in] MAC2 Second MAC address - * - * \return True if the addresses match, \c false otherwise - */ - #define MAC_COMPARE(MAC1, MAC2) (memcmp(MAC1, MAC2, sizeof(MAC_Address_t)) == 0) - - /** Minimum size of an Ethernet packet in bytes, to conform to the Ethernet V2 packet standard. */ - #define ETHERNET_VER2_MINSIZE 0x0600 - - /** Return value for all sub protocol handling routines, indicating that no response packet has been generated. */ - #define NO_RESPONSE 0 - - /** Return value for all sub protocol handling routines, indicating that the packet has not yet been handled. */ - #define NO_PROCESS -1 - - /* Type Defines: */ - /** Type define for an Ethernet frame header. */ - typedef struct - { - MAC_Address_t Destination; /**< Physical MAC address of the packet recipient */ - MAC_Address_t Source; /**< Physics MAC address of the packet source */ - uint16_t EtherType; /**< Ethernet packet sub-protocol type, for Ethernet V2 packets */ - } Ethernet_Frame_Header_t; - - /* External Variables: */ - extern const MAC_Address_t ServerMACAddress; - extern const IP_Address_t ServerIPAddress; - extern const MAC_Address_t BroadcastMACAddress; - extern const IP_Address_t BroadcastIPAddress; - extern const IP_Address_t ClientIPAddress; - - /* Function Prototypes: */ - void Ethernet_ProcessPacket(Ethernet_Frame_Info_t* const FrameIN, - Ethernet_Frame_Info_t* const FrameOUT); - uint16_t Ethernet_Checksum16(void* Data, - uint16_t Bytes); - -#endif - diff --git a/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Lib/EthernetProtocols.h b/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Lib/EthernetProtocols.h deleted file mode 100644 index 9db58d5de..000000000 --- a/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Lib/EthernetProtocols.h +++ /dev/null @@ -1,92 +0,0 @@ -/* - LUFA Library - Copyright (C) Dean Camera, 2014. - - dean [at] fourwalledcubicle [dot] com - www.lufa-lib.org -*/ - -/* - Copyright 2014 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 - * - * General Ethernet protocol constants and type defines, for use by - * all network protocol portions of the TCP/IP stack. - */ - -#ifndef _ETHERNET_PROTOCOLS_H_ -#define _ETHERNET_PROTOCOLS_H_ - - /* Includes: */ - #include <LUFA/Drivers/USB/USB.h> - - /* Macros: */ - #define ETHERTYPE_IPV4 0x0800 - #define ETHERTYPE_ARP 0x0806 - #define ETHERTYPE_RARP 0x8035 - #define ETHERTYPE_APPLETALK 0x809b - #define ETHERTYPE_APPLETALKARP 0x80f3 - #define ETHERTYPE_IEEE8021Q 0x8100 - #define ETHERTYPE_NOVELLIPX 0x8137 - #define ETHERTYPE_NOVELL 0x8138 - #define ETHERTYPE_IPV6 0x86DD - #define ETHERTYPE_COBRANET 0x8819 - #define ETHERTYPE_PROVIDERBRIDGING 0x88a8 - #define ETHERTYPE_MPLSUNICAST 0x8847 - #define ETHERTYPE_MPLSMULTICAST 0x8848 - #define ETHERTYPE_PPPoEDISCOVERY 0x8863 - #define ETHERTYPE_PPPoESESSION 0x8864 - #define ETHERTYPE_EAPOVERLAN 0x888E - #define ETHERTYPE_HYPERSCSI 0x889A - #define ETHERTYPE_ATAOVERETHERNET 0x88A2 - #define ETHERTYPE_ETHERCAT 0x88A4 - #define ETHERTYPE_SERCOSIII 0x88CD - #define ETHERTYPE_CESoE 0x88D8 - #define ETHERTYPE_MACSECURITY 0x88E5 - #define ETHERTYPE_FIBRECHANNEL 0x8906 - #define ETHERTYPE_QINQ 0x9100 - #define ETHERTYPE_VLLT 0xCAFE - - #define PROTOCOL_ICMP 1 - #define PROTOCOL_IGMP 2 - #define PROTOCOL_TCP 6 - #define PROTOCOL_UDP 17 - #define PROTOCOL_OSPF 89 - #define PROTOCOL_SCTP 132 - - /* Type Defines: */ - /** Type define for an Ethernet frame buffer data and information structure. */ - typedef struct - { - uint8_t FrameData[ETHERNET_FRAME_SIZE_MAX]; /**< Ethernet frame contents. */ - uint16_t FrameLength; /**< Length in bytes of the Ethernet frame stored in the buffer. */ - } Ethernet_Frame_Info_t; - - /** Type define for a protocol IP address of a device on a network. */ - typedef struct - { - uint8_t Octets[4]; /**< Individual bytes of an IP address */ - } IP_Address_t; - -#endif - diff --git a/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Lib/ICMP.c b/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Lib/ICMP.c deleted file mode 100644 index 20a7b709d..000000000 --- a/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Lib/ICMP.c +++ /dev/null @@ -1,83 +0,0 @@ -/* - LUFA Library - Copyright (C) Dean Camera, 2014. - - dean [at] fourwalledcubicle [dot] com - www.lufa-lib.org -*/ - -/* - Copyright 2014 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 - * - * Internet Control Message Protocol (ICMP) packet handling routines. This protocol handles - * Echo requests from the host, to indicate a successful network connection between the host - * and the virtual server. - */ - -#include "ICMP.h" - -/** Processes an ICMP packet inside an Ethernet frame, and writes the appropriate response - * to the output Ethernet frame if the host is issuing a ICMP ECHO request. - * - * \param[in] FrameIN Pointer to the incoming Ethernet frame information structure - * \param[in] InDataStart Pointer to the start of the incoming packet's ICMP header - * \param[out] OutDataStart Pointer to the start of the outgoing packet's ICMP header - * - * \return The number of bytes written to the out Ethernet frame if any, NO_RESPONSE otherwise - */ -int16_t ICMP_ProcessICMPPacket(Ethernet_Frame_Info_t* const FrameIN, - void* InDataStart, - void* OutDataStart) -{ - ICMP_Header_t* ICMPHeaderIN = (ICMP_Header_t*)InDataStart; - ICMP_Header_t* ICMPHeaderOUT = (ICMP_Header_t*)OutDataStart; - - DecodeICMPHeader(InDataStart); - - /* Determine if the ICMP packet is an echo request (ping) */ - if (ICMPHeaderIN->Type == ICMP_TYPE_ECHOREQUEST) - { - /* Fill out the ICMP response packet */ - ICMPHeaderOUT->Type = ICMP_TYPE_ECHOREPLY; - ICMPHeaderOUT->Code = 0; - ICMPHeaderOUT->Checksum = 0; - ICMPHeaderOUT->Id = ICMPHeaderIN->Id; - ICMPHeaderOUT->Sequence = ICMPHeaderIN->Sequence; - - intptr_t DataSize = FrameIN->FrameLength - ((((intptr_t)InDataStart + sizeof(ICMP_Header_t)) - (intptr_t)FrameIN->FrameData)); - - /* Copy the remaining payload to the response - echo requests should echo back any sent data */ - memmove(&((uint8_t*)OutDataStart)[sizeof(ICMP_Header_t)], - &((uint8_t*)InDataStart)[sizeof(ICMP_Header_t)], - DataSize); - - ICMPHeaderOUT->Checksum = Ethernet_Checksum16(ICMPHeaderOUT, (DataSize + sizeof(ICMP_Header_t))); - - /* Return the size of the response so far */ - return (DataSize + sizeof(ICMP_Header_t)); - } - - return NO_RESPONSE; -} - diff --git a/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Lib/ICMP.h b/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Lib/ICMP.h deleted file mode 100644 index 0226d35ca..000000000 --- a/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Lib/ICMP.h +++ /dev/null @@ -1,83 +0,0 @@ -/* - LUFA Library - Copyright (C) Dean Camera, 2014. - - dean [at] fourwalledcubicle [dot] com - www.lufa-lib.org -*/ - -/* - Copyright 2014 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 ICMP.c. - */ - -#ifndef _ICMP_H_ -#define _ICMP_H_ - - /* Includes: */ - #include <avr/io.h> - #include <string.h> - - #include "EthernetProtocols.h" - #include "Ethernet.h" - #include "ProtocolDecoders.h" - - /* Macros: */ - /** ICMP message type constant, indicating an ICMP ECHO Reply message. */ - #define ICMP_TYPE_ECHOREPLY 0 - - /** ICMP message type constant, indicating a packet destination is unreachable. */ - #define ICMP_TYPE_DESTINATIONUNREACHABLE 3 - - /** ICMP message type constant, indicating an ICMP Source Quench message. */ - #define ICMP_TYPE_SOURCEQUENCH 4 - - /** ICMP message type constant, indicating an ICMP Redirect message. */ - #define ICMP_TYPE_REDIRECTMESSAGE 5 - - /** ICMP message type constant, indicating an ICMP ECHO Request message. */ - #define ICMP_TYPE_ECHOREQUEST 8 - - /** ICMP message type constant, indicating an ICMP Time Exceeded message. */ - #define ICMP_TYPE_TIMEEXCEEDED 11 - - /* Type Defines: */ - /** Type define for an ICMP message header. */ - typedef struct - { - uint8_t Type; /**< ICMP message type, an \c ICMP_TYPE_* constant */ - uint8_t Code; /**< ICMP message code, indicating the message value */ - uint16_t Checksum; /**< Ethernet checksum of the ICMP message */ - uint16_t Id; /**< Id of the ICMP message */ - uint16_t Sequence; /**< Sequence number of the ICMP message, to link together message responses */ - } ICMP_Header_t; - - /* Function Prototypes: */ - int16_t ICMP_ProcessICMPPacket(Ethernet_Frame_Info_t* const FrameIN, - void* InDataStart, - void* OutDataStart); - -#endif - diff --git a/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Lib/IP.c b/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Lib/IP.c deleted file mode 100644 index 15013ce9d..000000000 --- a/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Lib/IP.c +++ /dev/null @@ -1,116 +0,0 @@ -/* - LUFA Library - Copyright (C) Dean Camera, 2014. - - dean [at] fourwalledcubicle [dot] com - www.lufa-lib.org -*/ - -/* - Copyright 2014 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 - * - * Internet Protocol (IP) packet handling routines. This protocol handles IP packets from the - * host which typically encapsulate other protocols such as ICMP, UDP and TCP. - */ - -#include "IP.h" - -/** Processes an IP packet inside an Ethernet frame, and writes the appropriate response - * to the output Ethernet frame if one is created by a sub-protocol handler. - * - * \param[in] FrameIN Pointer to the incoming Ethernet frame information structure - * \param[in] InDataStart Pointer to the start of the incoming packet's IP header - * \param[out] OutDataStart Pointer to the start of the outgoing packet's IP header - * - * \return The number of bytes written to the out Ethernet frame if any, NO_RESPONSE if no - * response was generated, NO_PROCESS if the packet processing was deferred until the - * next Ethernet packet handler iteration - */ -int16_t IP_ProcessIPPacket(Ethernet_Frame_Info_t* const FrameIN, - void* InDataStart, - void* OutDataStart) -{ - DecodeIPHeader(InDataStart); - - IP_Header_t* IPHeaderIN = (IP_Header_t*)InDataStart; - IP_Header_t* IPHeaderOUT = (IP_Header_t*)OutDataStart; - - /* Header length is specified in number of longs in the packet header, convert to bytes */ - uint16_t HeaderLengthBytes = (IPHeaderIN->HeaderLength * sizeof(uint32_t)); - - int16_t RetSize = NO_RESPONSE; - - /* Check to ensure the IP packet is addressed to the virtual webserver's IP or the broadcast IP address */ - if (!(IP_COMPARE(&IPHeaderIN->DestinationAddress, &ServerIPAddress)) && - !(IP_COMPARE(&IPHeaderIN->DestinationAddress, &BroadcastIPAddress))) - { - return NO_RESPONSE; - } - - /* Pass off the IP payload to the appropriate protocol processing routine */ - switch (IPHeaderIN->Protocol) - { - case PROTOCOL_ICMP: - RetSize = ICMP_ProcessICMPPacket(FrameIN, - &((uint8_t*)InDataStart)[HeaderLengthBytes], - &((uint8_t*)OutDataStart)[sizeof(IP_Header_t)]); - break; - case PROTOCOL_TCP: - RetSize = TCP_ProcessTCPPacket(InDataStart, - &((uint8_t*)InDataStart)[HeaderLengthBytes], - &((uint8_t*)OutDataStart)[sizeof(IP_Header_t)]); - break; - case PROTOCOL_UDP: - RetSize = UDP_ProcessUDPPacket(InDataStart, - &((uint8_t*)InDataStart)[HeaderLengthBytes], - &((uint8_t*)OutDataStart)[sizeof(IP_Header_t)]); - break; - } - - /* Check to see if the protocol processing routine has filled out a response */ - if (RetSize > 0) - { - /* Fill out the response IP packet header */ - IPHeaderOUT->TotalLength = SwapEndian_16(sizeof(IP_Header_t) + RetSize); - IPHeaderOUT->TypeOfService = 0; - IPHeaderOUT->HeaderLength = (sizeof(IP_Header_t) / sizeof(uint32_t)); - IPHeaderOUT->Version = 4; - IPHeaderOUT->Flags = 0; - IPHeaderOUT->FragmentOffset = 0; - IPHeaderOUT->Identification = 0; - IPHeaderOUT->HeaderChecksum = 0; - IPHeaderOUT->Protocol = IPHeaderIN->Protocol; - IPHeaderOUT->TTL = DEFAULT_TTL; - IPHeaderOUT->SourceAddress = IPHeaderIN->DestinationAddress; - IPHeaderOUT->DestinationAddress = IPHeaderIN->SourceAddress; - - IPHeaderOUT->HeaderChecksum = Ethernet_Checksum16(IPHeaderOUT, sizeof(IP_Header_t)); - - /* Return the size of the response so far */ - return (sizeof(IP_Header_t) + RetSize); - } - - return RetSize; -} - diff --git a/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Lib/IP.h b/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Lib/IP.h deleted file mode 100644 index 645d7a9da..000000000 --- a/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Lib/IP.h +++ /dev/null @@ -1,93 +0,0 @@ -/* - LUFA Library - Copyright (C) Dean Camera, 2014. - - dean [at] fourwalledcubicle [dot] com - www.lufa-lib.org -*/ - -/* - Copyright 2014 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 IP.c. - */ - -#ifndef _IP_H_ -#define _IP_H_ - - /* Includes: */ - #include <avr/io.h> - #include <string.h> - - #include "EthernetProtocols.h" - #include "Ethernet.h" - #include "ProtocolDecoders.h" - #include "Config/AppConfig.h" - - /* Macros: */ - /** Protocol IP address of the broadcast address. */ - #define BROADCAST_IP_ADDRESS {0xFF, 0xFF, 0xFF, 0xFF} - - /** Default Time To Live (TTL) value for sent packets, indicating the maximum allowable hops until their destination - * is reached. - */ - #define DEFAULT_TTL 128 - - /** Performs a comparison between two IP addresses, indicating if they are identical. - * - * \param[in] IP1 First IP address - * \param[in] IP2 Second IP address - * - * \return True if the addresses match, \c false otherwise - */ - #define IP_COMPARE(IP1, IP2) (memcmp(IP1, IP2, sizeof(IP_Address_t)) == 0) - - /* Type Defines: */ - /** Type define of an IP packet header. */ - typedef struct - { - unsigned HeaderLength : 4; /**< Total length of the packet header, in 4-byte blocks */ - unsigned Version : 4; /**< IP protocol version */ - uint8_t TypeOfService; /**< Special service type identifier, indicating delay/throughput/reliability levels */ - uint16_t TotalLength; /**< Total length of the IP packet, in bytes */ - - uint16_t Identification; /**< Identification value for identifying fragmented packets */ - unsigned FragmentOffset : 13; /**< Offset of this IP fragment */ - unsigned Flags : 3; /**< Fragment flags, to indicate if a packet is fragmented */ - - uint8_t TTL; /**< Maximum allowable number of hops to reach the packet destination */ - uint8_t Protocol; /**< Encapsulated protocol type */ - uint16_t HeaderChecksum; /**< Ethernet checksum of the IP header */ - - IP_Address_t SourceAddress; /**< Source protocol IP address of the packet */ - IP_Address_t DestinationAddress; /**< Destination protocol IP address of the packet */ - } IP_Header_t; - - /* Function Prototypes: */ - int16_t IP_ProcessIPPacket(Ethernet_Frame_Info_t* const FrameIN, - void* InDataStart, - void* OutDataStart); - -#endif - diff --git a/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Lib/ProtocolDecoders.c b/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Lib/ProtocolDecoders.c deleted file mode 100644 index 47e00a146..000000000 --- a/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Lib/ProtocolDecoders.c +++ /dev/null @@ -1,277 +0,0 @@ -/* - LUFA Library - Copyright (C) Dean Camera, 2014. - - dean [at] fourwalledcubicle [dot] com - www.lufa-lib.org -*/ - -/* - Copyright 2014 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. -*/ - -/* Protocol decoders for Ethernet, TCP, IP, ICMP and ARP. Each of these routines - accepts a header to the appropriate protocol and prints out pertinent information - on the packet through the serial port. - - To disable printing of a specific protocol, define the token NO_DECODE_{Protocol} - in the project makefile, and pass it to the compiler using the -D switch. -*/ - -/** \file - * - * Protocol decoding routines, for the plain-text decoding of Ethernet frames for debugging purposes. - * Enabled protocol decoders will print incoming Ethernet frame contents through the USART in a human - * readable format. - * - * Note that the USART is a slow transmission medium, and will slow down packet processing considerably. - * Packet decoding routines can be disabled by defining NO_DECODE_{Protocol Name} in the project makefile - * and passing it to the compiler via the -D switch. - */ - -#include "ProtocolDecoders.h" - -/** Decodes an Ethernet frame header and prints its contents to through the USART in a human readable format. - * - * \param[in] InDataStart Pointer to the start of an Ethernet frame of data - */ -void DecodeEthernetFrameHeader(void* InDataStart) -{ - #if !defined(NO_DECODE_ETHERNET) - Ethernet_Frame_Header_t* FrameHeader = (Ethernet_Frame_Header_t*)InDataStart; - - printf_P(PSTR("\r\n")); - - printf_P(PSTR(" ETHERNET\r\n")); - - if (!(MAC_COMPARE(&FrameHeader->Destination, &ServerMACAddress)) && - !(MAC_COMPARE(&FrameHeader->Destination, &BroadcastMACAddress))) - { - printf_P(PSTR(" + NOT ADDRESSED TO DEVICE\r\n")); - return; - } - - printf_P(PSTR(" + MAC Source : %02X:%02X:%02X:%02X:%02X:%02X\r\n"), FrameHeader->Source.Octets[0], - FrameHeader->Source.Octets[1], - FrameHeader->Source.Octets[2], - FrameHeader->Source.Octets[3], - FrameHeader->Source.Octets[4], - FrameHeader->Source.Octets[5]); - - printf_P(PSTR(" + MAC Dest: %02X:%02X:%02X:%02X:%02X:%02X\r\n"), FrameHeader->Destination.Octets[0], - FrameHeader->Destination.Octets[1], - FrameHeader->Destination.Octets[2], - FrameHeader->Destination.Octets[3], - FrameHeader->Destination.Octets[4], - FrameHeader->Destination.Octets[5]); - - printf_P(PSTR(" + Protocol: 0x%04x\r\n"), SwapEndian_16(FrameHeader->EtherType)); - #endif -} - -/** Decodes an ARP header and prints its contents to through the USART in a human readable format. - * - * \param[in] InDataStart Pointer to the start of an ARP packet header - */ -void DecodeARPHeader(void* InDataStart) -{ - #if !defined(NO_DECODE_ARP) - ARP_Header_t* ARPHeader = (ARP_Header_t*)InDataStart; - - printf_P(PSTR(" \\\r\n ARP\r\n")); - - if (!(IP_COMPARE(&ARPHeader->TPA, &ServerIPAddress)) && - !(MAC_COMPARE(&ARPHeader->THA, &ServerMACAddress))) - { - printf_P(PSTR(" + NOT ADDRESSED TO DEVICE\r\n")); - return; - } - - printf_P(PSTR(" + Protocol: %x\r\n"), SwapEndian_16(ARPHeader->ProtocolType)); - printf_P(PSTR(" + Operation: %u\r\n"), SwapEndian_16(ARPHeader->Operation)); - - if (SwapEndian_16(ARPHeader->ProtocolType) == ETHERTYPE_IPV4) - { - printf_P(PSTR(" + SHA MAC: %02X:%02X:%02X:%02X:%02X:%02X\r\n"), ARPHeader->SHA.Octets[0], - ARPHeader->SHA.Octets[1], - ARPHeader->SHA.Octets[2], - ARPHeader->SHA.Octets[3], - ARPHeader->SHA.Octets[4], - ARPHeader->SHA.Octets[5]); - - printf_P(PSTR(" + SPA IP: %u.%u.%u.%u\r\n"), ARPHeader->SPA.Octets[0], - ARPHeader->SPA.Octets[1], - ARPHeader->SPA.Octets[2], - ARPHeader->SPA.Octets[3]); - - printf_P(PSTR(" + THA MAC: %02X:%02X:%02X:%02X:%02X:%02X\r\n"), ARPHeader->THA.Octets[0], - ARPHeader->THA.Octets[1], - ARPHeader->THA.Octets[2], - ARPHeader->THA.Octets[3], - ARPHeader->THA.Octets[4], - ARPHeader->THA.Octets[5]); - - printf_P(PSTR(" + TPA IP: %u.%u.%u.%u\r\n"), ARPHeader->TPA.Octets[0], - ARPHeader->TPA.Octets[1], - ARPHeader->TPA.Octets[2], - ARPHeader->TPA.Octets[3]); - } - #endif -} - -/** Decodes an IP header and prints its contents to through the USART in a human readable format. - * - * \param[in] InDataStart Pointer to the start of an IP packet header - */ -void DecodeIPHeader(void* InDataStart) -{ - #if !defined(NO_DECODE_IP) - IP_Header_t* IPHeader = (IP_Header_t*)InDataStart; - - uint16_t HeaderLengthBytes = (IPHeader->HeaderLength * sizeof(uint32_t)); - - printf_P(PSTR(" \\\r\n IP\r\n")); - - if (!(IP_COMPARE(&IPHeader->DestinationAddress, &ServerIPAddress))) - { - printf_P(PSTR(" + NOT ADDRESSED TO DEVICE\r\n")); - return; - } - - printf_P(PSTR(" + Header Length: %u Bytes\r\n"), HeaderLengthBytes); - printf_P(PSTR(" + Packet Version: %u\r\n"), IPHeader->Version); - printf_P(PSTR(" + Total Length: %u\r\n"), SwapEndian_16(IPHeader->TotalLength)); - - printf_P(PSTR(" + Protocol: %u\r\n"), IPHeader->Protocol); - printf_P(PSTR(" + TTL: %u\r\n"), IPHeader->TTL); - - printf_P(PSTR(" + IP Src: %u.%u.%u.%u\r\n"), IPHeader->SourceAddress.Octets[0], - IPHeader->SourceAddress.Octets[1], - IPHeader->SourceAddress.Octets[2], - IPHeader->SourceAddress.Octets[3]); - - printf_P(PSTR(" + IP Dst: %u.%u.%u.%u\r\n"), IPHeader->DestinationAddress.Octets[0], - IPHeader->DestinationAddress.Octets[1], - IPHeader->DestinationAddress.Octets[2], - IPHeader->DestinationAddress.Octets[3]); - #endif -} - -/** Decodes an ICMP header and prints its contents to through the USART in a human readable format. - * - * \param[in] InDataStart Pointer to the start of an ICMP packet header - */ -void DecodeICMPHeader(void* InDataStart) -{ - #if !defined(NO_DECODE_ICMP) - ICMP_Header_t* ICMPHeader = (ICMP_Header_t*)InDataStart; - - printf_P(PSTR(" \\\r\n ICMP\r\n")); - - printf_P(PSTR(" + Type: %u\r\n"), ICMPHeader->Type); - printf_P(PSTR(" + Code: %u\r\n"), ICMPHeader->Code); - #endif -} - -/** Decodes a TCP header and prints its contents to through the USART in a human readable format. - * - * \param[in] InDataStart Pointer to the start of a TCP packet header - */ -void DecodeTCPHeader(void* InDataStart) -{ - #if !defined(NO_DECODE_TCP) - TCP_Header_t* TCPHeader = (TCP_Header_t*)InDataStart; - - uint16_t HeaderLengthBytes = (TCPHeader->DataOffset * sizeof(uint32_t)); - - printf_P(PSTR(" \\\r\n TCP\r\n")); - - printf_P(PSTR(" + Header Length: %u Bytes\r\n"), HeaderLengthBytes); - - printf_P(PSTR(" + Source Port: %u\r\n"), SwapEndian_16(TCPHeader->SourcePort)); - printf_P(PSTR(" + Destination Port: %u\r\n"), SwapEndian_16(TCPHeader->DestinationPort)); - - printf_P(PSTR(" + Sequence Number: %lu\r\n"), SwapEndian_32(TCPHeader->SequenceNumber)); - printf_P(PSTR(" + Acknowledgment Number: %lu\r\n"), SwapEndian_32(TCPHeader->AcknowledgmentNumber)); - - printf_P(PSTR(" + Flags: 0x%02X\r\n"), TCPHeader->Flags); - - if (TCP_GetPortState(TCPHeader->DestinationPort) == TCP_Port_Closed) - printf_P(PSTR(" + NOT LISTENING ON DESTINATION PORT\r\n")); - #endif -} - -/** Decodes an UDP header and prints its contents to through the USART in a human readable format. - * - * \param[in] InDataStart Pointer to the start of a UDP packet header - */ -void DecodeUDPHeader(void* InDataStart) -{ - #if !defined(NO_DECODE_UDP) - UDP_Header_t* UDPHeader = (UDP_Header_t*)InDataStart; - - printf_P(PSTR(" \\\r\n UDP\r\n")); - - printf_P(PSTR(" + Source Port: %u\r\n"), SwapEndian_16(UDPHeader->SourcePort)); - printf_P(PSTR(" + Destination Port: %u\r\n"), SwapEndian_16(UDPHeader->DestinationPort)); - - printf_P(PSTR(" + Data Length: %d\r\n"), SwapEndian_16(UDPHeader->Length)); - #endif -} - -/** Decodes an DHCP header and prints its contents to through the USART in a human readable format. - * - * \param[in] InDataStart Pointer to the start of a DHCP packet header - */ -void DecodeDHCPHeader(void* InDataStart) -{ - #if !defined(NO_DECODE_DHCP) - uint8_t* DHCPOptions = (InDataStart + sizeof(DHCP_Header_t)); - - printf_P(PSTR(" \\\r\n DHCP\r\n")); - - while (DHCPOptions[0] != DHCP_OPTION_END) - { - if (DHCPOptions[0] == DHCP_OPTION_MESSAGETYPE) - { - switch (DHCPOptions[2]) - { - case DHCP_MESSAGETYPE_DISCOVER: - printf_P(PSTR(" + DISCOVER\r\n")); - break; - case DHCP_MESSAGETYPE_REQUEST: - printf_P(PSTR(" + REQUEST\r\n")); - break; - case DHCP_MESSAGETYPE_RELEASE: - printf_P(PSTR(" + RELEASE\r\n")); - break; - case DHCP_MESSAGETYPE_DECLINE: - printf_P(PSTR(" + DECLINE\r\n")); - break; - } - } - - DHCPOptions += ((DHCPOptions[0] == DHCP_OPTION_PAD) ? 1 : (DHCPOptions[1] + 2)); - } - - #endif -} - diff --git a/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Lib/ProtocolDecoders.h b/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Lib/ProtocolDecoders.h deleted file mode 100644 index 6a7d20195..000000000 --- a/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Lib/ProtocolDecoders.h +++ /dev/null @@ -1,60 +0,0 @@ -/* - LUFA Library - Copyright (C) Dean Camera, 2014. - - dean [at] fourwalledcubicle [dot] com - www.lufa-lib.org -*/ - -/* - Copyright 2014 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 ProtocolDecoders.c. - */ - -#ifndef _PROTOCOL_DECODERS_H_ -#define _PROTOCOL_DECODERS_H_ - - /* Includes: */ - #include <avr/io.h> - #include <avr/pgmspace.h> - #include <stdio.h> - - #include <LUFA/Drivers/Peripheral/Serial.h> - - #include "EthernetProtocols.h" - #include "Ethernet.h" - #include "Config/AppConfig.h" - - /* Function Prototypes: */ - void DecodeEthernetFrameHeader(void* InDataStart); - void DecodeARPHeader(void* InDataStart); - void DecodeIPHeader(void* InDataStart); - void DecodeICMPHeader(void* InDataStart); - void DecodeTCPHeader(void* InDataStart); - void DecodeUDPHeader(void* InDataStart); - void DecodeDHCPHeader(void* InDataStart); - -#endif - diff --git a/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Lib/TCP.c b/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Lib/TCP.c deleted file mode 100644 index 892c5030b..000000000 --- a/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Lib/TCP.c +++ /dev/null @@ -1,632 +0,0 @@ -/* - LUFA Library - Copyright (C) Dean Camera, 2014. - - dean [at] fourwalledcubicle [dot] com - www.lufa-lib.org -*/ - -/* - Copyright 2014 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 - * - * Transmission Control Protocol (TCP) packet handling routines. This protocol handles the reliable in-order transmission - * and reception of packets to and from devices on a network, to "ports" on the device. It is used in situations where data - * delivery must be reliable and correct, e.g. HTTP, TELNET and most other non-streaming protocols. - */ - -#define INCLUDE_FROM_TCP_C -#include "TCP.h" - -/** Port state table array. This contains the current status of TCP ports in the device. To save on space, only open ports are - * stored - closed ports may be overwritten at any time, and the system will assume any ports not present in the array are closed. This - * allows for MAX_OPEN_TCP_PORTS to be less than the number of ports used by the application if desired. - */ -TCP_PortState_t PortStateTable[MAX_OPEN_TCP_PORTS]; - -/** Connection state table array. This contains the current status of TCP connections in the device. To save on space, only active - * (non-closed) connections are stored - closed connections may be overwritten at any time, and the system will assume any connections - * not present in the array are closed. - */ -TCP_ConnectionState_t ConnectionStateTable[MAX_TCP_CONNECTIONS]; - - -/** Task to handle the calling of each registered application's callback function, to process and generate TCP packets at the application - * level. If an application produces a response, this task constructs the appropriate Ethernet frame and places it into the Ethernet OUT - * buffer for later transmission. - */ -void TCP_TCPTask(USB_ClassInfo_RNDIS_Device_t* const RNDISInterfaceInfo, - Ethernet_Frame_Info_t* const FrameOUT) -{ - /* Run each application in sequence, to process incoming and generate outgoing packets */ - for (uint8_t CSTableEntry = 0; CSTableEntry < MAX_TCP_CONNECTIONS; CSTableEntry++) - { - /* Find the corresponding port entry in the port table */ - for (uint8_t PTableEntry = 0; PTableEntry < MAX_OPEN_TCP_PORTS; PTableEntry++) - { - /* Run the application handler for the port */ - if ((PortStateTable[PTableEntry].Port == ConnectionStateTable[CSTableEntry].Port) && - (PortStateTable[PTableEntry].State == TCP_Port_Open)) - { - PortStateTable[PTableEntry].ApplicationHandler(&ConnectionStateTable[CSTableEntry], - &ConnectionStateTable[CSTableEntry].Info.Buffer); - } - } - } - - /* Bail out early if there is already a frame waiting to be sent in the Ethernet OUT buffer */ - if (FrameOUT->FrameLength) - return; - - /* Send response packets from each application as the TCP packet buffers are filled by the applications */ - for (uint8_t CSTableEntry = 0; CSTableEntry < MAX_TCP_CONNECTIONS; CSTableEntry++) - { - /* For each completely received packet, pass it along to the listening application */ - if ((ConnectionStateTable[CSTableEntry].Info.Buffer.Direction == TCP_PACKETDIR_OUT) && - (ConnectionStateTable[CSTableEntry].Info.Buffer.Ready)) - { - Ethernet_Frame_Header_t* FrameOUTHeader = (Ethernet_Frame_Header_t*)&FrameOUT->FrameData; - IP_Header_t* IPHeaderOUT = (IP_Header_t*)&FrameOUT->FrameData[sizeof(Ethernet_Frame_Header_t)]; - TCP_Header_t* TCPHeaderOUT = (TCP_Header_t*)&FrameOUT->FrameData[sizeof(Ethernet_Frame_Header_t) + - sizeof(IP_Header_t)]; - void* TCPDataOUT = &FrameOUT->FrameData[sizeof(Ethernet_Frame_Header_t) + - sizeof(IP_Header_t) + - sizeof(TCP_Header_t)]; - - uint16_t PacketSize = ConnectionStateTable[CSTableEntry].Info.Buffer.Length; - - /* Fill out the TCP data */ - TCPHeaderOUT->SourcePort = ConnectionStateTable[CSTableEntry].Port; - TCPHeaderOUT->DestinationPort = ConnectionStateTable[CSTableEntry].RemotePort; - TCPHeaderOUT->SequenceNumber = SwapEndian_32(ConnectionStateTable[CSTableEntry].Info.SequenceNumberOut); - TCPHeaderOUT->AcknowledgmentNumber = SwapEndian_32(ConnectionStateTable[CSTableEntry].Info.SequenceNumberIn); - TCPHeaderOUT->DataOffset = (sizeof(TCP_Header_t) / sizeof(uint32_t)); - TCPHeaderOUT->WindowSize = SwapEndian_16(TCP_WINDOW_SIZE); - - TCPHeaderOUT->Flags = TCP_FLAG_ACK; - TCPHeaderOUT->UrgentPointer = 0; - TCPHeaderOUT->Checksum = 0; - TCPHeaderOUT->Reserved = 0; - - memcpy(TCPDataOUT, ConnectionStateTable[CSTableEntry].Info.Buffer.Data, PacketSize); - - ConnectionStateTable[CSTableEntry].Info.SequenceNumberOut += PacketSize; - - TCPHeaderOUT->Checksum = TCP_Checksum16(TCPHeaderOUT, &ServerIPAddress, - &ConnectionStateTable[CSTableEntry].RemoteAddress, - (sizeof(TCP_Header_t) + PacketSize)); - - PacketSize += sizeof(TCP_Header_t); - - /* Fill out the response IP header */ - IPHeaderOUT->TotalLength = SwapEndian_16(sizeof(IP_Header_t) + PacketSize); - IPHeaderOUT->TypeOfService = 0; - IPHeaderOUT->HeaderLength = (sizeof(IP_Header_t) / sizeof(uint32_t)); - IPHeaderOUT->Version = 4; - IPHeaderOUT->Flags = 0; - IPHeaderOUT->FragmentOffset = 0; - IPHeaderOUT->Identification = 0; - IPHeaderOUT->HeaderChecksum = 0; - IPHeaderOUT->Protocol = PROTOCOL_TCP; - IPHeaderOUT->TTL = DEFAULT_TTL; - IPHeaderOUT->SourceAddress = ServerIPAddress; - IPHeaderOUT->DestinationAddress = ConnectionStateTable[CSTableEntry].RemoteAddress; - - IPHeaderOUT->HeaderChecksum = Ethernet_Checksum16(IPHeaderOUT, sizeof(IP_Header_t)); - - PacketSize += sizeof(IP_Header_t); - - /* Fill out the response Ethernet frame header */ - FrameOUTHeader->Source = ServerMACAddress; - FrameOUTHeader->Destination = (MAC_Address_t){{0x02, 0x00, 0x02, 0x00, 0x02, 0x00}}; - FrameOUTHeader->EtherType = SwapEndian_16(ETHERTYPE_IPV4); - - PacketSize += sizeof(Ethernet_Frame_Header_t); - - /* Set the response length in the buffer and indicate that a response is ready to be sent */ - FrameOUT->FrameLength = PacketSize; - - ConnectionStateTable[CSTableEntry].Info.Buffer.Ready = false; - - break; - } - } -} - -/** Initializes the TCP protocol handler, clearing the port and connection state tables. This must be called before TCP packets are - * processed. - */ -void TCP_Init(void) -{ - /* Initialize the port state table with all CLOSED entries */ - for (uint8_t PTableEntry = 0; PTableEntry < MAX_OPEN_TCP_PORTS; PTableEntry++) - PortStateTable[PTableEntry].State = TCP_Port_Closed; - - /* Initialize the connection table with all CLOSED entries */ - for (uint8_t CSTableEntry = 0; CSTableEntry < MAX_TCP_CONNECTIONS; CSTableEntry++) - ConnectionStateTable[CSTableEntry].State = TCP_Connection_Closed; -} - -/** Sets the state and callback handler of the given port, specified in big endian to the given state. - * - * \param[in] Port Port whose state and callback function to set, specified in big endian - * \param[in] State New state of the port, a value from the \ref TCP_PortStates_t enum - * \param[in] Handler Application callback handler for the port - * - * \return Boolean \c true if the port state was set, \c false otherwise (no more space in the port state table) - */ -bool TCP_SetPortState(const uint16_t Port, - const uint8_t State, - void (*Handler)(TCP_ConnectionState_t*, TCP_ConnectionBuffer_t*)) -{ - /* Note, Port number should be specified in BIG endian to simplify network code */ - - /* Check to see if the port entry is already in the port state table */ - for (uint8_t PTableEntry = 0; PTableEntry < MAX_OPEN_TCP_PORTS; PTableEntry++) - { - /* Find existing entry for the port in the table, update it if found */ - if (PortStateTable[PTableEntry].Port == Port) - { - PortStateTable[PTableEntry].State = State; - PortStateTable[PTableEntry].ApplicationHandler = Handler; - return true; - } - } - - /* Check if trying to open the port -- if so we need to find an unused (closed) entry and replace it */ - if (State == TCP_Port_Open) - { - for (uint8_t PTableEntry = 0; PTableEntry < MAX_OPEN_TCP_PORTS; PTableEntry++) - { - /* Find a closed port entry in the table, change it to the given port and state */ - if (PortStateTable[PTableEntry].State == TCP_Port_Closed) - { - PortStateTable[PTableEntry].Port = Port; - PortStateTable[PTableEntry].State = State; - PortStateTable[PTableEntry].ApplicationHandler = Handler; - return true; - } - } - - /* Port not in table and no room to add it, return failure */ - return false; - } - else - { - /* Port not in table but trying to close it, so operation successful */ - return true; - } -} - -/** Retrieves the current state of a given TCP port, specified in big endian. - * - * \param[in] Port TCP port whose state is to be retrieved, given in big-endian - * - * \return A value from the \ref TCP_PortStates_t enum - */ -uint8_t TCP_GetPortState(const uint16_t Port) -{ - /* Note, Port number should be specified in BIG endian to simplify network code */ - - for (uint8_t PTableEntry = 0; PTableEntry < MAX_OPEN_TCP_PORTS; PTableEntry++) - { - /* Find existing entry for the port in the table, return the port status if found */ - if (PortStateTable[PTableEntry].Port == Port) - return PortStateTable[PTableEntry].State; - } - - /* Port not in table, assume closed */ - return TCP_Port_Closed; -} - -/** Sets the connection state of the given port, remote address and remote port to the given TCP connection state. If the - * connection exists in the connection state table it is updated, otherwise it is created if possible. - * - * \param[in] Port TCP port of the connection on the device, specified in big endian - * \param[in] RemoteAddress Remote protocol IP address of the connected device - * \param[in] RemotePort TCP port of the remote device in the connection, specified in big endian - * \param[in] State TCP connection state, a value from the \ref TCP_ConnectionStates_t enum - * - * \return Boolean \c true if the connection was updated or created, \c false otherwise (no more space in the connection state table) - */ -bool TCP_SetConnectionState(const uint16_t Port, - const IP_Address_t* RemoteAddress, - const uint16_t RemotePort, - const uint8_t State) -{ - /* Note, Port number should be specified in BIG endian to simplify network code */ - - for (uint8_t CSTableEntry = 0; CSTableEntry < MAX_TCP_CONNECTIONS; CSTableEntry++) - { - /* Find port entry in the table */ - if ((ConnectionStateTable[CSTableEntry].Port == Port) && - IP_COMPARE(&ConnectionStateTable[CSTableEntry].RemoteAddress, RemoteAddress) && - ConnectionStateTable[CSTableEntry].RemotePort == RemotePort) - { - ConnectionStateTable[CSTableEntry].State = State; - return true; - } - } - - for (uint8_t CSTableEntry = 0; CSTableEntry < MAX_TCP_CONNECTIONS; CSTableEntry++) - { - /* Find empty entry in the table */ - if (ConnectionStateTable[CSTableEntry].State == TCP_Connection_Closed) - { - ConnectionStateTable[CSTableEntry].Port = Port; - ConnectionStateTable[CSTableEntry].RemoteAddress = *RemoteAddress; - ConnectionStateTable[CSTableEntry].RemotePort = RemotePort; - ConnectionStateTable[CSTableEntry].State = State; - return true; - } - } - - return false; -} - -/** Retrieves the current state of a given TCP connection to a host. - * - * \param[in] Port TCP port on the device in the connection, specified in big endian - * \param[in] RemoteAddress Remote protocol IP address of the connected host - * \param[in] RemotePort Remote TCP port of the connected host, specified in big endian - * - * \return A value from the \ref TCP_ConnectionStates_t enum - */ -uint8_t TCP_GetConnectionState(const uint16_t Port, - const IP_Address_t* RemoteAddress, - const uint16_t RemotePort) -{ - /* Note, Port number should be specified in BIG endian to simplify network code */ - - for (uint8_t CSTableEntry = 0; CSTableEntry < MAX_TCP_CONNECTIONS; CSTableEntry++) - { - /* Find port entry in the table */ - if ((ConnectionStateTable[CSTableEntry].Port == Port) && - IP_COMPARE(&ConnectionStateTable[CSTableEntry].RemoteAddress, RemoteAddress) && - ConnectionStateTable[CSTableEntry].RemotePort == RemotePort) - - { - return ConnectionStateTable[CSTableEntry].State; - } - } - - return TCP_Connection_Closed; -} - -/** Retrieves the connection info structure of a given connection to a host. - * - * \param[in] Port TCP port on the device in the connection, specified in big endian - * \param[in] RemoteAddress Remote protocol IP address of the connected host - * \param[in] RemotePort Remote TCP port of the connected host, specified in big endian - * - * \return ConnectionInfo structure of the connection if found, NULL otherwise - */ -TCP_ConnectionInfo_t* TCP_GetConnectionInfo(const uint16_t Port, - const IP_Address_t* RemoteAddress, - const uint16_t RemotePort) -{ - /* Note, Port number should be specified in BIG endian to simplify network code */ - - for (uint8_t CSTableEntry = 0; CSTableEntry < MAX_TCP_CONNECTIONS; CSTableEntry++) - { - /* Find port entry in the table */ - if ((ConnectionStateTable[CSTableEntry].Port == Port) && - IP_COMPARE(&ConnectionStateTable[CSTableEntry].RemoteAddress, RemoteAddress) && - ConnectionStateTable[CSTableEntry].RemotePort == RemotePort) - { - return &ConnectionStateTable[CSTableEntry].Info; - } - } - - return NULL; -} - -/** Processes a TCP packet inside an Ethernet frame, and writes the appropriate response - * to the output Ethernet frame if one is created by a application handler. - * - * \param[in] IPHeaderInStart Pointer to the start of the incoming packet's IP header - * \param[in] TCPHeaderInStart Pointer to the start of the incoming packet's TCP header - * \param[out] TCPHeaderOutStart Pointer to the start of the outgoing packet's TCP header - * - * \return The number of bytes written to the out Ethernet frame if any, NO_RESPONSE if no - * response was generated, NO_PROCESS if the packet processing was deferred until the - * next Ethernet packet handler iteration - */ -int16_t TCP_ProcessTCPPacket(void* IPHeaderInStart, - void* TCPHeaderInStart, - void* TCPHeaderOutStart) -{ - IP_Header_t* IPHeaderIN = (IP_Header_t*)IPHeaderInStart; - TCP_Header_t* TCPHeaderIN = (TCP_Header_t*)TCPHeaderInStart; - TCP_Header_t* TCPHeaderOUT = (TCP_Header_t*)TCPHeaderOutStart; - - TCP_ConnectionInfo_t* ConnectionInfo; - - DecodeTCPHeader(TCPHeaderInStart); - - bool PacketResponse = false; - - /* Check if the destination port is open and allows incoming connections */ - if (TCP_GetPortState(TCPHeaderIN->DestinationPort) == TCP_Port_Open) - { - /* Detect SYN from host to start a connection */ - if (TCPHeaderIN->Flags & TCP_FLAG_SYN) - TCP_SetConnectionState(TCPHeaderIN->DestinationPort, &IPHeaderIN->SourceAddress, TCPHeaderIN->SourcePort, TCP_Connection_Listen); - - /* Detect RST from host to abort existing connection */ - if (TCPHeaderIN->Flags & TCP_FLAG_RST) - { - if (TCP_SetConnectionState(TCPHeaderIN->DestinationPort, &IPHeaderIN->SourceAddress, - TCPHeaderIN->SourcePort, TCP_Connection_Closed)) - { - TCPHeaderOUT->Flags = (TCP_FLAG_RST | TCP_FLAG_ACK); - PacketResponse = true; - } - } - else - { - /* Process the incoming TCP packet based on the current connection state for the sender and port */ - switch (TCP_GetConnectionState(TCPHeaderIN->DestinationPort, &IPHeaderIN->SourceAddress, TCPHeaderIN->SourcePort)) - { - case TCP_Connection_Listen: - if (TCPHeaderIN->Flags == TCP_FLAG_SYN) - { - /* SYN connection starts a connection with a peer */ - if (TCP_SetConnectionState(TCPHeaderIN->DestinationPort, &IPHeaderIN->SourceAddress, - TCPHeaderIN->SourcePort, TCP_Connection_SYNReceived)) - { - TCPHeaderOUT->Flags = (TCP_FLAG_SYN | TCP_FLAG_ACK); - - ConnectionInfo = TCP_GetConnectionInfo(TCPHeaderIN->DestinationPort, &IPHeaderIN->SourceAddress, TCPHeaderIN->SourcePort); - - ConnectionInfo->SequenceNumberIn = (SwapEndian_32(TCPHeaderIN->SequenceNumber) + 1); - ConnectionInfo->SequenceNumberOut = 0; - ConnectionInfo->Buffer.InUse = false; - } - else - { - TCPHeaderOUT->Flags = TCP_FLAG_RST; - } - - PacketResponse = true; - } - - break; - case TCP_Connection_SYNReceived: - if (TCPHeaderIN->Flags == TCP_FLAG_ACK) - { - /* ACK during the connection process completes the connection to a peer */ - - TCP_SetConnectionState(TCPHeaderIN->DestinationPort, &IPHeaderIN->SourceAddress, - TCPHeaderIN->SourcePort, TCP_Connection_Established); - - ConnectionInfo = TCP_GetConnectionInfo(TCPHeaderIN->DestinationPort, &IPHeaderIN->SourceAddress, - TCPHeaderIN->SourcePort); - - ConnectionInfo->SequenceNumberOut++; - } - - break; - case TCP_Connection_Established: - if (TCPHeaderIN->Flags == (TCP_FLAG_FIN | TCP_FLAG_ACK)) - { - /* FIN ACK when connected to a peer starts the finalization process */ - - TCPHeaderOUT->Flags = (TCP_FLAG_FIN | TCP_FLAG_ACK); - PacketResponse = true; - - TCP_SetConnectionState(TCPHeaderIN->DestinationPort, &IPHeaderIN->SourceAddress, - TCPHeaderIN->SourcePort, TCP_Connection_CloseWait); - - ConnectionInfo = TCP_GetConnectionInfo(TCPHeaderIN->DestinationPort, &IPHeaderIN->SourceAddress, - TCPHeaderIN->SourcePort); - - ConnectionInfo->SequenceNumberIn++; - ConnectionInfo->SequenceNumberOut++; - } - else if ((TCPHeaderIN->Flags == TCP_FLAG_ACK) || (TCPHeaderIN->Flags == (TCP_FLAG_ACK | TCP_FLAG_PSH))) - { - ConnectionInfo = TCP_GetConnectionInfo(TCPHeaderIN->DestinationPort, &IPHeaderIN->SourceAddress, - TCPHeaderIN->SourcePort); - - /* Check if the buffer is currently in use either by a buffered data to send, or receive */ - if ((ConnectionInfo->Buffer.InUse == false) && (ConnectionInfo->Buffer.Ready == false)) - { - ConnectionInfo->Buffer.Direction = TCP_PACKETDIR_IN; - ConnectionInfo->Buffer.InUse = true; - ConnectionInfo->Buffer.Length = 0; - } - - /* Check if the buffer has been claimed by us to read in data from the peer */ - if ((ConnectionInfo->Buffer.Direction == TCP_PACKETDIR_IN) && - (ConnectionInfo->Buffer.Length != TCP_WINDOW_SIZE)) - { - uint16_t IPOffset = (IPHeaderIN->HeaderLength * sizeof(uint32_t)); - uint16_t TCPOffset = (TCPHeaderIN->DataOffset * sizeof(uint32_t)); - uint16_t DataLength = (SwapEndian_16(IPHeaderIN->TotalLength) - IPOffset - TCPOffset); - - /* Copy the packet data into the buffer */ - memcpy(&ConnectionInfo->Buffer.Data[ConnectionInfo->Buffer.Length], - &((uint8_t*)TCPHeaderInStart)[TCPOffset], - DataLength); - - ConnectionInfo->SequenceNumberIn += DataLength; - ConnectionInfo->Buffer.Length += DataLength; - - /* Check if the buffer is full or if the PSH flag is set, if so indicate buffer ready */ - if ((!(TCP_WINDOW_SIZE - ConnectionInfo->Buffer.Length)) || (TCPHeaderIN->Flags & TCP_FLAG_PSH)) - { - ConnectionInfo->Buffer.InUse = false; - ConnectionInfo->Buffer.Ready = true; - - TCPHeaderOUT->Flags = TCP_FLAG_ACK; - PacketResponse = true; - } - } - else - { - /* Buffer is currently in use by the application, defer processing of the incoming packet */ - return NO_PROCESS; - } - } - - break; - case TCP_Connection_Closing: - ConnectionInfo = TCP_GetConnectionInfo(TCPHeaderIN->DestinationPort, &IPHeaderIN->SourceAddress, - TCPHeaderIN->SourcePort); - - TCPHeaderOUT->Flags = (TCP_FLAG_ACK | TCP_FLAG_FIN); - PacketResponse = true; - - ConnectionInfo->Buffer.InUse = false; - - TCP_SetConnectionState(TCPHeaderIN->DestinationPort, &IPHeaderIN->SourceAddress, - TCPHeaderIN->SourcePort, TCP_Connection_FINWait1); - - break; - case TCP_Connection_FINWait1: - if (TCPHeaderIN->Flags == (TCP_FLAG_FIN | TCP_FLAG_ACK)) - { - ConnectionInfo = TCP_GetConnectionInfo(TCPHeaderIN->DestinationPort, &IPHeaderIN->SourceAddress, - TCPHeaderIN->SourcePort); - - TCPHeaderOUT->Flags = TCP_FLAG_ACK; - PacketResponse = true; - - ConnectionInfo->SequenceNumberIn++; - ConnectionInfo->SequenceNumberOut++; - - TCP_SetConnectionState(TCPHeaderIN->DestinationPort, &IPHeaderIN->SourceAddress, - TCPHeaderIN->SourcePort, TCP_Connection_Closed); - } - else if (TCPHeaderIN->Flags == TCP_FLAG_ACK) - { - TCP_SetConnectionState(TCPHeaderIN->DestinationPort, &IPHeaderIN->SourceAddress, - TCPHeaderIN->SourcePort, TCP_Connection_FINWait2); - } - - break; - case TCP_Connection_FINWait2: - if (TCPHeaderIN->Flags == (TCP_FLAG_FIN | TCP_FLAG_ACK)) - { - ConnectionInfo = TCP_GetConnectionInfo(TCPHeaderIN->DestinationPort, &IPHeaderIN->SourceAddress, - TCPHeaderIN->SourcePort); - - TCPHeaderOUT->Flags = TCP_FLAG_ACK; - PacketResponse = true; - - ConnectionInfo->SequenceNumberIn++; - ConnectionInfo->SequenceNumberOut++; - - TCP_SetConnectionState(TCPHeaderIN->DestinationPort, &IPHeaderIN->SourceAddress, - TCPHeaderIN->SourcePort, TCP_Connection_Closed); - } - - break; - case TCP_Connection_CloseWait: - if (TCPHeaderIN->Flags == TCP_FLAG_ACK) - { - TCP_SetConnectionState(TCPHeaderIN->DestinationPort, &IPHeaderIN->SourceAddress, - TCPHeaderIN->SourcePort, TCP_Connection_Closed); - } - - break; - } - } - } - else - { - /* Port is not open, indicate via a RST/ACK response to the sender */ - TCPHeaderOUT->Flags = (TCP_FLAG_RST | TCP_FLAG_ACK); - PacketResponse = true; - } - - /* Check if we need to respond to the sent packet */ - if (PacketResponse) - { - ConnectionInfo = TCP_GetConnectionInfo(TCPHeaderIN->DestinationPort, &IPHeaderIN->SourceAddress, - TCPHeaderIN->SourcePort); - - TCPHeaderOUT->SourcePort = TCPHeaderIN->DestinationPort; - TCPHeaderOUT->DestinationPort = TCPHeaderIN->SourcePort; - TCPHeaderOUT->SequenceNumber = SwapEndian_32(ConnectionInfo->SequenceNumberOut); - TCPHeaderOUT->AcknowledgmentNumber = SwapEndian_32(ConnectionInfo->SequenceNumberIn); - TCPHeaderOUT->DataOffset = (sizeof(TCP_Header_t) / sizeof(uint32_t)); - - if (!(ConnectionInfo->Buffer.InUse)) - TCPHeaderOUT->WindowSize = SwapEndian_16(TCP_WINDOW_SIZE); - else - TCPHeaderOUT->WindowSize = SwapEndian_16(TCP_WINDOW_SIZE - ConnectionInfo->Buffer.Length); - - TCPHeaderOUT->UrgentPointer = 0; - TCPHeaderOUT->Checksum = 0; - TCPHeaderOUT->Reserved = 0; - - TCPHeaderOUT->Checksum = TCP_Checksum16(TCPHeaderOUT, &IPHeaderIN->DestinationAddress, - &IPHeaderIN->SourceAddress, sizeof(TCP_Header_t)); - - return sizeof(TCP_Header_t); - } - - return NO_RESPONSE; -} - -/** Calculates the appropriate TCP checksum, consisting of the addition of the one's compliment of each word, - * complimented. - * - * \param[in] TCPHeaderOutStart Pointer to the start of the packet's outgoing TCP header - * \param[in] SourceAddress Source protocol IP address of the outgoing IP header - * \param[in] DestinationAddress Destination protocol IP address of the outgoing IP header - * \param[in] TCPOutSize Size in bytes of the TCP data header and payload - * - * \return A 16-bit TCP checksum value - */ -static uint16_t TCP_Checksum16(void* TCPHeaderOutStart, - const IP_Address_t* SourceAddress, - const IP_Address_t* DestinationAddress, - uint16_t TCPOutSize) -{ - uint32_t Checksum = 0; - - /* TCP/IP checksums are the addition of the one's compliment of each word including the IP pseudo-header, - complimented */ - - Checksum += ((uint16_t*)SourceAddress)[0]; - Checksum += ((uint16_t*)SourceAddress)[1]; - Checksum += ((uint16_t*)DestinationAddress)[0]; - Checksum += ((uint16_t*)DestinationAddress)[1]; - Checksum += SwapEndian_16(PROTOCOL_TCP); - Checksum += SwapEndian_16(TCPOutSize); - - for (uint16_t CurrWord = 0; CurrWord < (TCPOutSize >> 1); CurrWord++) - Checksum += ((uint16_t*)TCPHeaderOutStart)[CurrWord]; - - if (TCPOutSize & 0x01) - Checksum += (((uint16_t*)TCPHeaderOutStart)[TCPOutSize >> 1] & 0x00FF); - - while (Checksum & 0xFFFF0000) - Checksum = ((Checksum & 0xFFFF) + (Checksum >> 16)); - - return ~Checksum; -} - diff --git a/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Lib/TCP.h b/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Lib/TCP.h deleted file mode 100644 index 92fbdf362..000000000 --- a/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Lib/TCP.h +++ /dev/null @@ -1,260 +0,0 @@ -/* - LUFA Library - Copyright (C) Dean Camera, 2014. - - dean [at] fourwalledcubicle [dot] com - www.lufa-lib.org -*/ - -/* - Copyright 2014 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 TCP.c. - */ - -#ifndef _TCP_H_ -#define _TCP_H_ - - /* Includes: */ - #include <avr/io.h> - #include <stdbool.h> - - #include "EthernetProtocols.h" - #include "Ethernet.h" - #include "ProtocolDecoders.h" - - /* Macros: */ - /** Maximum number of TCP ports which can be open at the one time. */ - #define MAX_OPEN_TCP_PORTS 1 - - /** Maximum number of TCP connections which can be sustained at the one time. */ - #define MAX_TCP_CONNECTIONS 3 - - /** TCP window size, giving the maximum number of bytes which can be buffered at the one time. */ - #define TCP_WINDOW_SIZE 512 - - /** Port number for HTTP transmissions. */ - #define TCP_PORT_HTTP SwapEndian_16(80) - - /** Data direction indicator for a TCP application buffer, indicating data from host-to-device. */ - #define TCP_PACKETDIR_IN false - - /** Data direction indicator for a TCP application buffer, indicating data from device-to-host. */ - #define TCP_PACKETDIR_OUT true - - /** Congestion Window Reduced TCP flag mask. */ - #define TCP_FLAG_CWR (1 << 7) - - /** Explicit Congestion Notification TCP flag mask. */ - #define TCP_FLAG_ECE (1 << 6) - - /** Urgent TCP flag mask. */ - #define TCP_FLAG_URG (1 << 5) - - /** Data Acknowledge TCP flag mask. */ - #define TCP_FLAG_ACK (1 << 4) - - /** Data Push TCP flag mask. */ - #define TCP_FLAG_PSH (1 << 3) - - /** Reset TCP flag mask. */ - #define TCP_FLAG_RST (1 << 2) - - /** Synchronize TCP flag mask. */ - #define TCP_FLAG_SYN (1 << 1) - - /** Connection Finalize TCP flag mask. */ - #define TCP_FLAG_FIN (1 << 0) - - /** Application macro: Determines if the given application buffer contains a packet received from the host - * - * \param[in] Buffer Application buffer to check - * - * \return Boolean \c true if the buffer contains a packet from the host, \c false otherwise - */ - #define TCP_APP_HAS_RECEIVED_PACKET(Buffer) (Buffer->Ready && (Buffer->Direction == TCP_PACKETDIR_IN)) - - /** Application macro: Indicates if the application buffer is currently locked by the application for device-to-host transfers. - * - * \param[in] Buffer Application buffer to check - * - * \return Boolean \c true if the buffer has been captured by the application for device-to-host transmissions, \c false otherwise - */ - #define TCP_APP_HAVE_CAPTURED_BUFFER(Buffer) (!(Buffer->Ready) && Buffer->InUse && (Buffer->Direction == TCP_PACKETDIR_OUT)) - - /** Application macro: Indicates if the application can lock the buffer for multiple continued device-to-host transmissions. - * - * \param[in] Buffer Application buffer to check - * - * \return Boolean \c true if the buffer may be captured by the application for device-to-host transmissions, \c false otherwise - */ - #define TCP_APP_CAN_CAPTURE_BUFFER(Buffer) Buffer->InUse - - /** Application macro: Captures the application buffer, locking it for device-to-host transmissions only. This should be - * performed when the application needs to transmit several packets worth of data in succession with no interruptions from the host. - * - * \pre The application must check that the buffer can be locked first using TCP_APP_CAN_CAPTURE_BUFFER(). - * - * \param[in] Buffer Application buffer to lock - */ - #define TCP_APP_CAPTURE_BUFFER(Buffer) do { Buffer->Direction = TCP_PACKETDIR_OUT; Buffer->InUse = true; } while (0) - - /** Application macro: Releases a captured application buffer, allowing for host-to-device packets to be received. - * - * \param[in] Buffer Application buffer to release - */ - #define TCP_APP_RELEASE_BUFFER(Buffer) do { Buffer->InUse = false; } while (0) - - /** Application macro: Sends the contents of the given application buffer to the host. - * - * \param[in] Buffer Application buffer to send - * \param[in] Len Length of data contained in the buffer - */ - #define TCP_APP_SEND_BUFFER(Buffer, Len) do { Buffer->Direction = TCP_PACKETDIR_OUT; Buffer->Length = Len; Buffer->Ready = true; } while (0) - - /** Application macro: Clears the application buffer, ready for a packet to be written to it. - * - * \param[in] Buffer Application buffer to clear - */ - #define TCP_APP_CLEAR_BUFFER(Buffer) do { Buffer->Ready = false; Buffer->Length = 0; } while (0) - - /** Application macro: Closes an open connection to a host. - * - * \param[in] Connection Open TCP connection to close - */ - #define TCP_APP_CLOSECONNECTION(Connection) do { Connection->State = TCP_Connection_Closing; } while (0) - - /* Enums: */ - /** Enum for possible TCP port states. */ - enum TCP_PortStates_t - { - TCP_Port_Closed = 0, /**< TCP port closed, no connections to a host may be made on this port. */ - TCP_Port_Open = 1, /**< TCP port open, connections to a host may be made on this port. */ - }; - - /** Enum for possible TCP connection states. */ - enum TCP_ConnectionStates_t - { - TCP_Connection_Listen = 0, /**< Listening for a connection from a host */ - TCP_Connection_SYNSent = 1, /**< Unused */ - TCP_Connection_SYNReceived = 2, /**< SYN received, waiting for ACK */ - TCP_Connection_Established = 3, /**< Connection established in both directions */ - TCP_Connection_FINWait1 = 4, /**< Closing, waiting for ACK */ - TCP_Connection_FINWait2 = 5, /**< Closing, waiting for FIN ACK */ - TCP_Connection_CloseWait = 6, /**< Closing, waiting for ACK */ - TCP_Connection_Closing = 7, /**< Unused */ - TCP_Connection_LastACK = 8, /**< Unused */ - TCP_Connection_TimeWait = 9, /**< Unused */ - TCP_Connection_Closed = 10, /**< Connection closed in both directions */ - }; - - /* Type Defines: */ - /** Type define for a TCP connection buffer structure, including size, data and direction. */ - typedef struct - { - uint16_t Length; /**< Length of data in the TCP application buffer */ - uint8_t Data[TCP_WINDOW_SIZE]; /**< TCP application data buffer */ - bool Direction; /**< Buffer transmission direction, either TCP_PACKETDIR_IN or TCP_PACKETDIR_OUT */ - bool Ready; /**< If data from host, indicates buffer ready to be read, otherwise indicates - * buffer ready to be sent to the host - */ - bool InUse; /**< Indicates if the buffer is locked to to the current direction, and cannot be changed */ - } TCP_ConnectionBuffer_t; - - /** Type define for a TCP connection information structure. */ - typedef struct - { - uint32_t SequenceNumberIn; /**< Current TCP sequence number for host-to-device */ - uint32_t SequenceNumberOut; /**< Current TCP sequence number for device-to-host */ - TCP_ConnectionBuffer_t Buffer; /**< Connection application data buffer */ - } TCP_ConnectionInfo_t; - - /** Type define for a complete TCP connection state. */ - typedef struct - { - uint16_t Port; /**< Connection port number on the device */ - uint16_t RemotePort; /**< Connection port number on the host */ - IP_Address_t RemoteAddress; /**< Connection protocol IP address of the host */ - TCP_ConnectionInfo_t Info; /**< Connection information, including application buffer */ - uint8_t State; /**< Current connection state, a value from the \ref TCP_ConnectionStates_t enum */ - } TCP_ConnectionState_t; - - /** Type define for a TCP port state. */ - typedef struct - { - uint16_t Port; /**< TCP port number on the device */ - uint8_t State; /**< Current port state, a value from the \ref TCP_PortStates_t enum */ - void (*ApplicationHandler) (TCP_ConnectionState_t* ConnectionState, - TCP_ConnectionBuffer_t* Buffer); /**< Port application handler */ - } TCP_PortState_t; - - /** Type define for a TCP packet header. */ - typedef struct - { - uint16_t SourcePort; /**< Source port of the TCP packet */ - uint16_t DestinationPort; /**< Destination port of the TCP packet */ - - uint32_t SequenceNumber; /**< Data sequence number of the packet */ - uint32_t AcknowledgmentNumber; /**< Data acknowledgment number of the packet */ - - unsigned Reserved : 4; /**< Reserved, must be all 0 */ - unsigned DataOffset : 4; /**< Offset of the data from the start of the header, in 4 byte chunks */ - uint8_t Flags; /**< TCP packet flags */ - uint16_t WindowSize; /**< Current data window size (bytes remaining in reception buffer) */ - - uint16_t Checksum; /**< TCP checksum */ - uint16_t UrgentPointer; /**< Urgent data pointer */ - } TCP_Header_t; - - /* Function Prototypes: */ - void TCP_TCPTask(USB_ClassInfo_RNDIS_Device_t* const RNDISInterfaceInfo, - Ethernet_Frame_Info_t* const FrameOUT); - void TCP_Init(void); - bool TCP_SetPortState(const uint16_t Port, - const uint8_t State, - void (*Handler)(TCP_ConnectionState_t*, TCP_ConnectionBuffer_t*)); - uint8_t TCP_GetPortState(const uint16_t Port); - bool TCP_SetConnectionState(const uint16_t Port, - const IP_Address_t* RemoteAddress, - const uint16_t RemotePort, - const uint8_t State); - uint8_t TCP_GetConnectionState(const uint16_t Port, - const IP_Address_t* RemoteAddress, - const uint16_t RemotePort); - TCP_ConnectionInfo_t* TCP_GetConnectionInfo(const uint16_t Port, - const IP_Address_t* RemoteAddress, - const uint16_t RemotePort); - int16_t TCP_ProcessTCPPacket(void* IPHeaderInStart, - void* TCPHeaderInStart, - void* TCPHeaderOutStart); - - #if defined(INCLUDE_FROM_TCP_C) - static uint16_t TCP_Checksum16(void* TCPHeaderOutStart, - const IP_Address_t* SourceAddress, - const IP_Address_t* DestinationAddress, - uint16_t TCPOutSize); - #endif - -#endif - diff --git a/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Lib/UDP.c b/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Lib/UDP.c deleted file mode 100644 index 95911fc5d..000000000 --- a/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Lib/UDP.c +++ /dev/null @@ -1,84 +0,0 @@ -/* - LUFA Library - Copyright (C) Dean Camera, 2014. - - dean [at] fourwalledcubicle [dot] com - www.lufa-lib.org -*/ - -/* - Copyright 2014 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 - * - * User Datagram Protocol (UDP) packet handling routines. This protocol handles high throughput, low - * reliability packets which are typically used to encapsulate streaming data. - */ - -#define INCLUDE_FROM_UDP_C -#include "UDP.h" - -/** Processes a UDP packet inside an Ethernet frame, and writes the appropriate response - * to the output Ethernet frame if a sub-protocol handler has created a response packet. - * - * \param[in] IPHeaderInStart Pointer to the start of the incoming packet's IP header - * \param[in] UDPHeaderInStart Pointer to the start of the incoming packet's UDP header - * \param[out] UDPHeaderOutStart Pointer to the start of the outgoing packet's UDP header - * - * \return The number of bytes written to the out Ethernet frame if any, NO_RESPONSE otherwise - */ -int16_t UDP_ProcessUDPPacket(void* IPHeaderInStart, - void* UDPHeaderInStart, - void* UDPHeaderOutStart) -{ - UDP_Header_t* UDPHeaderIN = (UDP_Header_t*)UDPHeaderInStart; - UDP_Header_t* UDPHeaderOUT = (UDP_Header_t*)UDPHeaderOutStart; - - int16_t RetSize = NO_RESPONSE; - - DecodeUDPHeader(UDPHeaderInStart); - - switch (SwapEndian_16(UDPHeaderIN->DestinationPort)) - { - case UDP_PORT_DHCP_REQUEST: - RetSize = DHCP_ProcessDHCPPacket(IPHeaderInStart, - &((uint8_t*)UDPHeaderInStart)[sizeof(UDP_Header_t)], - &((uint8_t*)UDPHeaderOutStart)[sizeof(UDP_Header_t)]); - break; - } - - /* Check to see if the protocol processing routine has filled out a response */ - if (RetSize > 0) - { - /* Fill out the response UDP packet header */ - UDPHeaderOUT->SourcePort = UDPHeaderIN->DestinationPort; - UDPHeaderOUT->DestinationPort = UDPHeaderIN->SourcePort; - UDPHeaderOUT->Checksum = 0; - UDPHeaderOUT->Length = SwapEndian_16(sizeof(UDP_Header_t) + RetSize); - - /* Return the size of the response so far */ - return (sizeof(UDP_Header_t) + RetSize); - } - - return NO_RESPONSE; -} - diff --git a/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Lib/UDP.h b/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Lib/UDP.h deleted file mode 100644 index 2a6697780..000000000 --- a/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Lib/UDP.h +++ /dev/null @@ -1,70 +0,0 @@ -/* - LUFA Library - Copyright (C) Dean Camera, 2014. - - dean [at] fourwalledcubicle [dot] com - www.lufa-lib.org -*/ - -/* - Copyright 2014 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 UDP.c. - */ - -#ifndef _UDP_H_ -#define _UDP_H_ - - /* Includes: */ - #include <avr/io.h> - - #include "EthernetProtocols.h" - #include "Ethernet.h" - #include "ProtocolDecoders.h" - #include "DHCP.h" - - /* Macros: */ - /** Source UDP port for a DHCP request. */ - #define UDP_PORT_DHCP_REQUEST 67 - - /** Destination UDP port for a DHCP reply. */ - #define UDP_PORT_DHCP_REPLY 68 - - /* Type Defines: */ - /** Type define for a UDP packet header. */ - typedef struct - { - uint16_t SourcePort; /**< Packet source port */ - uint16_t DestinationPort; /**< Packet destination port */ - uint16_t Length; /**< Total packet length, in bytes */ - uint16_t Checksum; /**< Optional UDP packet checksum */ - } UDP_Header_t; - - /* Function Prototypes: */ - int16_t UDP_ProcessUDPPacket(void* IPHeaderInStart, - void* UDPHeaderInStart, - void* UDPHeaderOutStart); - -#endif - diff --git a/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Lib/Webserver.c b/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Lib/Webserver.c deleted file mode 100644 index 43558c2f5..000000000 --- a/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Lib/Webserver.c +++ /dev/null @@ -1,203 +0,0 @@ -/* - LUFA Library - Copyright (C) Dean Camera, 2014. - - dean [at] fourwalledcubicle [dot] com - www.lufa-lib.org -*/ - -/* - Copyright 2014 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 - * - * Simple webserver application for demonstrating the RNDIS demo and TCP/IP stack. This - * application will serve up a static HTTP web page when requested by the host. - */ - -#include "Webserver.h" - -/** HTTP server response header, for transmission before the page contents. This indicates to the host that a page exists at the - * given location, and gives extra connection information. - */ -const char HTTP200Header[] PROGMEM = "HTTP/1.1 200 OK\r\n" - "Server: LUFA RNDIS\r\n" - "Content-type: text/html\r\n" - "Connection: close\r\n\r\n"; - -/** HTTP server response header, for transmission before a resource not found error. This indicates to the host that the given - * given URL is invalid, and gives extra error information. - */ -const char HTTP404Header[] PROGMEM = "HTTP/1.1 404 Not Found\r\n" - "Server: LUFA RNDIS\r\n" - "Connection: close\r\n\r\n"; - -/** HTTP page to serve to the host when a HTTP request is made. This page is too long for a single response, thus it is automatically - * broken up into smaller blocks and sent as a series of packets each time the webserver application callback is run. - */ -const char HTTPPage[] PROGMEM = - "<html>" - " <head>" - " <title>" - " LUFA Webserver Demo" - " </title>" - " </head>" - " <body>" - " <h1>Hello from your USB AVR!</h1>" - " <p>" - " Hello! Welcome to the LUFA RNDIS Demo Webserver test page, running on your USB AVR via the LUFA library. This demonstrates the HTTP webserver, TCP/IP stack and RNDIS demo all running atop the LUFA USB stack." - " <br /><br />" - " <small>Project Information: <a href=\"http://www.lufa-lib.org\">http://www.lufa-lib.org</a>.</small>" - " <hr />" - " <i>LUFA Version: </i>" LUFA_VERSION_STRING - " </p>" - " </body>" - "</html>"; - - -/** Initializes the Webserver application, opening the appropriate HTTP port in the TCP handler and registering the application - * callback routine for packets sent to the HTTP protocol port. - */ -void Webserver_Init(void) -{ - /* Open the HTTP port in the TCP protocol so that HTTP connections to the device can be established */ - TCP_SetPortState(TCP_PORT_HTTP, TCP_Port_Open, Webserver_ApplicationCallback); -} - -/** Indicates if a given request equals the given HTTP command. - * - * \param[in] RequestHeader HTTP request made by the host - * \param[in] Command HTTP command to compare the request to - * - * \return Boolean \c true if the command matches the request, \c false otherwise - */ -static bool IsHTTPCommand(uint8_t* RequestHeader, - char* Command) -{ - /* Returns true if the non null terminated string in RequestHeader matches the null terminated string Command */ - return (strncmp((char*)RequestHeader, Command, strlen(Command)) == 0); -} - -/** Application callback routine, executed each time the TCP processing task runs. This callback determines what request - * has been made (if any), and serves up appropriate responses. - * - * \param[in] ConnectionState Pointer to a TCP Connection State structure giving connection information - * \param[in,out] Buffer Pointer to the application's send/receive packet buffer - */ -void Webserver_ApplicationCallback(TCP_ConnectionState_t* const ConnectionState, - TCP_ConnectionBuffer_t* const Buffer) -{ - char* BufferDataStr = (char*)Buffer->Data; - static uint8_t PageBlock = 0; - - /* Check to see if a packet has been received on the HTTP port from a remote host */ - if (TCP_APP_HAS_RECEIVED_PACKET(Buffer)) - { - if (IsHTTPCommand(Buffer->Data, "GET")) - { - if (IsHTTPCommand(Buffer->Data, "GET / ")) - { - PageBlock = 0; - - /* Copy the HTTP 200 response header into the packet buffer */ - strcpy_P(BufferDataStr, HTTP200Header); - - /* Send the buffer contents to the host */ - TCP_APP_SEND_BUFFER(Buffer, strlen(BufferDataStr)); - - /* Lock the buffer to Device->Host transmissions only while we send the page contents */ - TCP_APP_CAPTURE_BUFFER(Buffer); - } - else - { - /* Copy the HTTP 404 response header into the packet buffer */ - strcpy_P(BufferDataStr, HTTP404Header); - - /* Send the buffer contents to the host */ - TCP_APP_SEND_BUFFER(Buffer, strlen(BufferDataStr)); - - /* All data sent, close the connection */ - TCP_APP_CLOSECONNECTION(ConnectionState); - } - } - else if (IsHTTPCommand(Buffer->Data, "HEAD")) - { - if (IsHTTPCommand(Buffer->Data, "HEAD / ")) - { - /* Copy the HTTP response header into the packet buffer */ - strcpy_P(BufferDataStr, HTTP200Header); - - /* Send the buffer contents to the host */ - TCP_APP_SEND_BUFFER(Buffer, strlen(BufferDataStr)); - } - else - { - /* Copy the HTTP response header into the packet buffer */ - strcpy_P(BufferDataStr, HTTP404Header); - - /* Send the buffer contents to the host */ - TCP_APP_SEND_BUFFER(Buffer, strlen(BufferDataStr)); - } - - /* All data sent, close the connection */ - TCP_APP_CLOSECONNECTION(ConnectionState); - } - else if (IsHTTPCommand(Buffer->Data, "TRACE")) - { - /* Echo the host's query back to the host */ - TCP_APP_SEND_BUFFER(Buffer, Buffer->Length); - - /* All data sent, close the connection */ - TCP_APP_CLOSECONNECTION(ConnectionState); - } - else - { - /* Unknown request, just clear the buffer (drop the packet) */ - TCP_APP_CLEAR_BUFFER(Buffer); - } - } - else if (TCP_APP_HAVE_CAPTURED_BUFFER(Buffer)) - { - uint16_t RemLength = strlen_P(&HTTPPage[PageBlock * HTTP_REPLY_BLOCK_SIZE]); - uint16_t Length; - - /* Determine the length of the loaded block */ - Length = ((RemLength > HTTP_REPLY_BLOCK_SIZE) ? HTTP_REPLY_BLOCK_SIZE : RemLength); - - /* Copy the next buffer sized block of the page to the packet buffer */ - strncpy_P(BufferDataStr, &HTTPPage[PageBlock * HTTP_REPLY_BLOCK_SIZE], Length); - - /* Send the buffer contents to the host */ - TCP_APP_SEND_BUFFER(Buffer, Length); - - /* Check to see if the entire page has been sent */ - if (PageBlock++ == (sizeof(HTTPPage) / HTTP_REPLY_BLOCK_SIZE)) - { - /* Unlock the buffer so that the host can fill it with future packets */ - TCP_APP_RELEASE_BUFFER(Buffer); - - /* Close the connection to the host */ - TCP_APP_CLOSECONNECTION(ConnectionState); - } - } -} - diff --git a/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Lib/Webserver.h b/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Lib/Webserver.h deleted file mode 100644 index 142dc7a03..000000000 --- a/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Lib/Webserver.h +++ /dev/null @@ -1,57 +0,0 @@ -/* - LUFA Library - Copyright (C) Dean Camera, 2014. - - dean [at] fourwalledcubicle [dot] com - www.lufa-lib.org -*/ - -/* - Copyright 2014 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 Webserver.c. - */ - -#ifndef _WEBSERVER_H_ -#define _WEBSERVER_H_ - - /* Includes: */ - #include <avr/io.h> - #include <avr/pgmspace.h> - - #include <LUFA/Version.h> - - #include "TCP.h" - - /* Macros: */ - /** Maximum size of a HTTP response per transmission */ - #define HTTP_REPLY_BLOCK_SIZE 128 - - /* Function Prototypes: */ - void Webserver_Init(void); - void Webserver_ApplicationCallback(TCP_ConnectionState_t* const ConnectionState, - TCP_ConnectionBuffer_t* const Buffer); - -#endif - diff --git a/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/RNDISEthernet.c b/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/RNDISEthernet.c deleted file mode 100644 index bdb506117..000000000 --- a/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/RNDISEthernet.c +++ /dev/null @@ -1,179 +0,0 @@ -/* - LUFA Library - Copyright (C) Dean Camera, 2014. - - dean [at] fourwalledcubicle [dot] com - www.lufa-lib.org -*/ - -/* - Copyright 2014 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 - * - * Main source file for the RNDISEthernet demo. This file contains the main tasks of - * the demo and is responsible for the initial application hardware configuration. - */ - -#include "RNDISEthernet.h" - -/** Message buffer for RNDIS messages processed by the RNDIS device class driver. */ -static uint8_t RNDIS_Message_Buffer[192]; - -/** Global to store the incoming frame from the host before it is processed by the device. */ -static Ethernet_Frame_Info_t FrameIN; - -/** Global to store the outgoing frame created in the device before it is sent to the host. */ -static Ethernet_Frame_Info_t FrameOUT; - -/** LUFA RNDIS Class driver interface configuration and state information. This structure is - * passed to all RNDIS Class driver functions, so that multiple instances of the same class - * within a device can be differentiated from one another. - */ -USB_ClassInfo_RNDIS_Device_t Ethernet_RNDIS_Interface = - { - .Config = - { - .ControlInterfaceNumber = INTERFACE_ID_CDC_CCI, - .DataINEndpoint = - { - .Address = CDC_TX_EPADDR, - .Size = CDC_TXRX_EPSIZE, - .Banks = 1, - }, - .DataOUTEndpoint = - { - .Address = CDC_RX_EPADDR, - .Size = CDC_TXRX_EPSIZE, - .Banks = 1, - }, - .NotificationEndpoint = - { - .Address = CDC_NOTIFICATION_EPADDR, - .Size = CDC_NOTIFICATION_EPSIZE, - .Banks = 1, - }, - .AdapterVendorDescription = "LUFA RNDIS Demo Adapter", - .AdapterMACAddress = {ADAPTER_MAC_ADDRESS}, - .MessageBuffer = RNDIS_Message_Buffer, - .MessageBufferLength = sizeof(RNDIS_Message_Buffer), - }, - }; - - -/** Main program entry point. This routine contains the overall program flow, including initial - * setup of all components and the main program loop. - */ -int main(void) -{ - SetupHardware(); - - TCP_Init(); - Webserver_Init(); - - LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY); - GlobalInterruptEnable(); - - for (;;) - { - if (RNDIS_Device_IsPacketReceived(&Ethernet_RNDIS_Interface)) - { - LEDs_SetAllLEDs(LEDMASK_USB_BUSY); - - RNDIS_Device_ReadPacket(&Ethernet_RNDIS_Interface, &FrameIN.FrameData, &FrameIN.FrameLength); - Ethernet_ProcessPacket(&FrameIN, &FrameOUT); - - if (FrameOUT.FrameLength) - { - RNDIS_Device_SendPacket(&Ethernet_RNDIS_Interface, &FrameOUT.FrameData, FrameOUT.FrameLength); - FrameOUT.FrameLength = 0; - } - - LEDs_SetAllLEDs(LEDMASK_USB_READY); - } - - TCP_TCPTask(&Ethernet_RNDIS_Interface, &FrameOUT); - - RNDIS_Device_USBTask(&Ethernet_RNDIS_Interface); - USB_USBTask(); - } -} - -/** Configures the board hardware and chip peripherals for the demo's functionality. */ -void SetupHardware(void) -{ -#if (ARCH == ARCH_AVR8) - /* Disable watchdog if enabled by bootloader/fuses */ - MCUSR &= ~(1 << WDRF); - wdt_disable(); - - /* Disable clock division */ - clock_prescale_set(clock_div_1); -#elif (ARCH == ARCH_XMEGA) - /* Start the PLL to multiply the 2MHz RC oscillator to 32MHz and switch the CPU core to run from it */ - XMEGACLK_StartPLL(CLOCK_SRC_INT_RC2MHZ, 2000000, F_CPU); - XMEGACLK_SetCPUClockSource(CLOCK_SRC_PLL); - - /* Start the 32MHz internal RC oscillator and start the DFLL to increase it to 48MHz using the USB SOF as a reference */ - XMEGACLK_StartInternalOscillator(CLOCK_SRC_INT_RC32MHZ); - XMEGACLK_StartDFLL(CLOCK_SRC_INT_RC32MHZ, DFLL_REF_INT_USBSOF, F_USB); - - PMIC.CTRL = PMIC_LOLVLEN_bm | PMIC_MEDLVLEN_bm | PMIC_HILVLEN_bm; -#endif - - /* Hardware Initialization */ - LEDs_Init(); - Serial_Init(9600, false); - USB_Init(); - - /* Create a stdio stream for the serial port for stdin and stdout */ - Serial_CreateStream(NULL); -} - -/** Event handler for the library USB Connection event. */ -void EVENT_USB_Device_Connect(void) -{ - LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING); -} - -/** Event handler for the library USB Disconnection event. */ -void EVENT_USB_Device_Disconnect(void) -{ - LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY); -} - -/** Event handler for the library USB Configuration Changed event. */ -void EVENT_USB_Device_ConfigurationChanged(void) -{ - bool ConfigSuccess = true; - - ConfigSuccess &= RNDIS_Device_ConfigureEndpoints(&Ethernet_RNDIS_Interface); - - LEDs_SetAllLEDs(ConfigSuccess ? LEDMASK_USB_READY : LEDMASK_USB_ERROR); -} - -/** Event handler for the library USB Control Request reception event. */ -void EVENT_USB_Device_ControlRequest(void) -{ - RNDIS_Device_ProcessControlRequest(&Ethernet_RNDIS_Interface); -} - diff --git a/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/RNDISEthernet.h b/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/RNDISEthernet.h deleted file mode 100644 index 56000547f..000000000 --- a/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/RNDISEthernet.h +++ /dev/null @@ -1,84 +0,0 @@ -/* - LUFA Library - Copyright (C) Dean Camera, 2014. - - dean [at] fourwalledcubicle [dot] com - www.lufa-lib.org -*/ - -/* - Copyright 2014 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 RNDISEthernet.c. - */ - -#ifndef _RNDISETHERNET_H_ -#define _RNDISETHERNET_H_ - - /* Includes: */ - #include <avr/io.h> - #include <avr/wdt.h> - #include <avr/power.h> - #include <avr/interrupt.h> - #include <string.h> - - #include "Descriptors.h" - - #include "Lib/Ethernet.h" - #include "Lib/TCP.h" - #include "Lib/ARP.h" - #include "Lib/Webserver.h" - #include "Config/AppConfig.h" - - #include <LUFA/Drivers/Board/LEDs.h> - #include <LUFA/Drivers/Peripheral/Serial.h> - #include <LUFA/Drivers/USB/USB.h> - #include <LUFA/Platform/Platform.h> - - /* Macros: */ - /** LED mask for the library LED driver, to indicate that the USB interface is not ready. */ - #define LEDMASK_USB_NOTREADY LEDS_LED1 - - /** LED mask for the library LED driver, to indicate that the USB interface is enumerating. */ - #define LEDMASK_USB_ENUMERATING (LEDS_LED2 | LEDS_LED3) - - /** LED mask for the library LED driver, to indicate that the USB interface is ready. */ - #define LEDMASK_USB_READY (LEDS_LED2 | LEDS_LED4) - - /** LED mask for the library LED driver, to indicate that an error has occurred in the USB interface. */ - #define LEDMASK_USB_ERROR (LEDS_LED1 | LEDS_LED3) - - /** LED mask for the library LED driver, to indicate that the USB interface is busy. */ - #define LEDMASK_USB_BUSY LEDS_LED2 - - /* Function Prototypes: */ - void SetupHardware(void); - - void EVENT_USB_Device_Connect(void); - void EVENT_USB_Device_Disconnect(void); - void EVENT_USB_Device_ConfigurationChanged(void); - void EVENT_USB_Device_ControlRequest(void); - -#endif - diff --git a/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/RNDISEthernet.txt b/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/RNDISEthernet.txt deleted file mode 100644 index 496ab07a1..000000000 --- a/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/RNDISEthernet.txt +++ /dev/null @@ -1,146 +0,0 @@ -/** \file - * - * This file contains special DoxyGen information for the generation of the main page and other special - * documentation pages. It is not a project source file. - */ - -/** \mainpage RNDIS Class Ethernet Demo (with Webserver/Telnet) - * - * \section Sec_Compat Demo Compatibility: - * - * The following list indicates what microcontrollers are compatible with this demo. - * - * \li Series 7 USB AVRs (AT90USBxxx7) - * \li Series 6 USB AVRs (AT90USBxxx6) - * \li Series AU XMEGA AVRs (ATXMEGAxxxAxU) - * \li Series B XMEGA AVRs (ATXMEGAxxxBxU) - * \li Series C XMEGA AVRs (ATXMEGAxxxCxU) - * - * \section Sec_Info USB Information: - * - * The following table gives a rundown of the USB utilization of this demo. - * - * <table> - * <tr> - * <td><b>USB Mode:</b></td> - * <td>Device</td> - * </tr> - * <tr> - * <td><b>USB Class:</b></td> - * <td>Communications Device Class (CDC)</td> - * </tr> - * <tr> - * <td><b>USB Subclass:</b></td> - * <td>Remote NDIS (Microsoft Proprietary CDC Class Networking Standard)</td> - * </tr> - * <tr> - * <td><b>Relevant Standards:</b></td> - * <td>Microsoft RNDIS Specification</td> - * </tr> - * <tr> - * <td><b>Supported USB Speeds:</b></td> - * <td>Full Speed Mode</td> - * </tr> - * </table> - * - * \section Sec_Description Project Description: - * - * Remote Network Driver Interface demonstration application. - * This gives a simple reference application for implementing - * a CDC RNDIS device acting as a simple network interface for - * ethernet packet exchange. RNDIS is a proprietary Microsoft - * standard; this demo will only work on Windows 2000 (manually - * patched with the Microsoft RNDIS hotfix) and above (with no - * manual patches), or on the latest Linux kernels. - * - * Before running, you will need to install the INF file that - * is located in the RNDISEthernet project directory. This will - * enable Windows to use its inbuilt RNDIS drivers, negating the - * need for special Windows drivers for the device. To install, - * right-click the .INF file and choose the Install option. If - * Windows 2000 is used, the Microsoft INF file in the hotfix - * will need to be altered to use the VID/PID of the demo and - * then chosen instead of the LUFA RNDIS INF file when prompted. - * - * When enumerated, this demo will install as a new network - * adapter which ethernet packets can be sent to and received - * from. Running on top of the adapter is a very simple TCP/IP - * stack with a HTTP webserver and TELNET host which can be - * accessed through a web browser at IP address 10.0.0.2:80 or - * through a TELNET client at 10.0.0.2:25. This device also supports - * ping echos via the ICMP protocol. - * - * \note The TCP/IP stack in this demo has a number of limitations - * and should serve as an example only - it is not fully featured nor - * compliant to the TCP/IP specification. For complete projects, it is - * recommended that it be replaced with an external open source TCP/IP - * stack that is feature complete, such as the uIP stack. - * - * \section Sec_Options Project Options - * - * The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value. - * - * <table> - * <tr> - * <th><b>Define Name:</b></th> - * <th><b>Location:</b></th> - * <th><b>Description:</b></th> - * </tr> - * <tr> - * <td>CLIENT_IP_ADDRESS</td> - * <td>AppConfig.h</td> - * <td>Configures the IP address given to the client (PC) via the DHCP server.</td> - * </tr> - * <tr> - * <td>SERVER_IP_ADDRESS</td> - * <td>AppConfig.h</td> - * <td>Configures the IP address of the virtual server.</td> - * </tr> - * <tr> - * <td>ADAPTER_MAC_ADDRESS</td> - * <td>AppConfig.h</td> - * <td>Configures the MAC address of the RNDIS adapter on the host (PC) side.</td> - * </tr> - * <tr> - * <td>SERVER_MAC_ADDRESS</td> - * <td>AppConfig.h</td> - * <td>Configures the MAC address of the virtual server on the network.</td> - * </tr> - * <tr> - * <td>NO_DECODE_ETHERNET</td> - * <td>AppConfig.h</td> - * <td>When defined, received Ethernet headers will not be decoded and printed to the device serial port.</td> - * </tr> - * <tr> - * <td>NO_DECODE_ARP</td> - * <td>AppConfig.h</td> - * <td>When defined, received ARP headers will not be decoded and printed to the device serial port.</td> - * </tr> - * <tr> - * <td>NO_DECODE_IP</td> - * <td>AppConfig.h</td> - * <td>When defined, received IP headers will not be decoded and printed to the device serial port.</td> - * </tr> - * <tr> - * <td>NO_DECODE_ICMP</td> - * <td>AppConfig.h</td> - * <td>When defined, received ICMP headers will not be decoded and printed to the device serial port.</td> - * </tr> - * <tr> - * <td>NO_DECODE_TCP</td> - * <td>AppConfig.h</td> - * <td>When defined, received TCP headers will not be decoded and printed to the device serial port.</td> - * </tr> - * <tr> - * <td>NO_DECODE_UDP</td> - * <td>AppConfig.h</td> - * <td>When defined, received UDP headers will not be decoded and printed to the device serial port.</td> - * </tr> - * <tr> - * <td>NO_DECODE_DHCP</td> - * <td>AppConfig.h</td> - * <td>When defined, received DHCP headers will not be decoded and printed to the device serial port.</td> - * </tr> - * </table> - */ - diff --git a/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/asf.xml b/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/asf.xml deleted file mode 100644 index 8a85bf948..000000000 --- a/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/asf.xml +++ /dev/null @@ -1,80 +0,0 @@ -<asf xmlversion="1.0">
- <project caption="RNDIS Ethernet Device Demo (Class Driver APIs)" id="lufa.demos.device.class.rndis.example.avr8">
- <require idref="lufa.demos.device.class.rndis"/>
- <require idref="lufa.boards.dummy.avr8"/>
- <generator value="as5_8"/>
-
- <device-support value="at90usb1287"/>
- <config name="lufa.drivers.board.name" value="none"/>
-
- <build type="define" name="F_CPU" value="16000000UL"/>
- <build type="define" name="F_USB" value="16000000UL"/>
- </project>
-
- <project caption="RNDIS Ethernet Device Demo (Class Driver APIs)" id="lufa.demos.device.class.rndis.example.xmega">
- <require idref="lufa.demos.device.class.rndis"/>
- <require idref="lufa.boards.dummy.xmega"/>
- <generator value="as5_8"/>
-
- <device-support value="atxmega128a1u"/>
- <config name="lufa.drivers.board.name" value="none"/>
-
- <build type="define" name="F_CPU" value="32000000UL"/>
- <build type="define" name="F_USB" value="48000000UL"/>
- </project>
-
- <module type="application" id="lufa.demos.device.class.rndis" caption="RNDIS Ethernet Device Demo (Class Driver APIs)">
- <info type="description" value="summary">
- Microsoft RNDIS Ethernet networking device demo, implementing a basic HTTP webserver. This demo uses the user-friendly USB Class Driver APIs to provide a simple, abstracted interface into the USB stack.
- </info>
-
- <info type="gui-flag" value="move-to-root"/>
-
- <info type="keyword" value="Technology">
- <keyword value="Class Driver APIs"/>
- <keyword value="USB Device"/>
- <keyword value="RNDIS Class"/>
- </info>
-
- <device-support-alias value="lufa_avr8"/>
- <device-support-alias value="lufa_xmega"/>
- <device-support-alias value="lufa_uc3"/>
-
- <build type="c-source" value="RNDISEthernet.c"/>
- <build type="c-source" value="Descriptors.c"/>
- <build type="c-source" value="Lib/ARP.c"/>
- <build type="c-source" value="Lib/DHCP.c"/>
- <build type="c-source" value="Lib/Ethernet.c"/>
- <build type="c-source" value="Lib/ICMP.c"/>
- <build type="c-source" value="Lib/IP.c"/>
- <build type="c-source" value="Lib/ProtocolDecoders.c"/>
- <build type="c-source" value="Lib/TCP.c"/>
- <build type="c-source" value="Lib/UDP.c"/>
- <build type="c-source" value="Lib/Webserver.c"/>
- <build type="header-file" value="RNDISEthernet.h"/>
- <build type="header-file" value="Descriptors.h"/>
- <build type="header-file" value="Lib/ARP.h"/>
- <build type="header-file" value="Lib/DHCP.h"/>
- <build type="header-file" value="Lib/Ethernet.h"/>
- <build type="header-file" value="Lib/ICMP.h"/>
- <build type="header-file" value="Lib/IP.h"/>
- <build type="header-file" value="Lib/ProtocolDecoders.h"/>
- <build type="header-file" value="Lib/TCP.h"/>
- <build type="header-file" value="Lib/UDP.h"/>
- <build type="header-file" value="Lib/Webserver.h"/>
- <build type="header-file" value="Lib/EthernetProtocols.h"/>
-
- <build type="module-config" subtype="path" value="Config"/>
- <build type="module-config" subtype="required-header-file" value="AppConfig.h"/>
- <build type="header-file" value="Config/AppConfig.h"/>
- <build type="header-file" value="Config/LUFAConfig.h"/>
-
- <require idref="lufa.common"/>
- <require idref="lufa.platform"/>
- <require idref="lufa.drivers.usb"/>
- <require idref="lufa.drivers.board"/>
- <require idref="lufa.drivers.board.leds"/>
- <require idref="lufa.drivers.peripheral.usart"/>
- <require idref="lufa.drivers.misc.ansi"/>
- </module>
-</asf>
diff --git a/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/doxyfile b/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/doxyfile deleted file mode 100644 index 9147230ec..000000000 --- a/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/doxyfile +++ /dev/null @@ -1,2364 +0,0 @@ -# Doxyfile 1.8.8 - -# This file describes the settings to be used by the documentation system -# doxygen (www.doxygen.org) for a project. -# -# All text after a double hash (##) is considered a comment and is placed in -# front of the TAG it is preceding. -# -# All text after a single hash (#) is considered a comment and will be ignored. -# The format is: -# TAG = value [value, ...] -# For lists, items can also be appended using: -# TAG += value [value, ...] -# Values that contain spaces should be placed between quotes (\" \"). - -#--------------------------------------------------------------------------- -# Project related configuration options -#--------------------------------------------------------------------------- - -# This tag specifies the encoding used for all characters in the config file -# that follow. The default is UTF-8 which is also the encoding used for all text -# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv -# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv -# for the list of possible encodings. -# The default value is: UTF-8. - -DOXYFILE_ENCODING = UTF-8 - -# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by -# double-quotes, unless you are using Doxywizard) that should identify the -# project for which the documentation is generated. This name is used in the -# title of most generated pages and in a few other places. -# The default value is: My Project. - -PROJECT_NAME = "LUFA Library - RNDIS Ethernet Demo" - -# The PROJECT_NUMBER tag can be used to enter a project or revision number. This -# could be handy for archiving the generated documentation or if some version -# control system is used. - -PROJECT_NUMBER = - -# Using the PROJECT_BRIEF tag one can provide an optional one line description -# for a project that appears at the top of each page and should give viewer a -# quick idea about the purpose of the project. Keep the description short. - -PROJECT_BRIEF = - -# With the PROJECT_LOGO tag one can specify an logo or icon that is included in -# the documentation. The maximum height of the logo should not exceed 55 pixels -# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo -# to the output directory. - -PROJECT_LOGO = - -# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path -# into which the generated documentation will be written. If a relative path is -# entered, it will be relative to the location where doxygen was started. If -# left blank the current directory will be used. - -OUTPUT_DIRECTORY = ./Documentation/ - -# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub- -# directories (in 2 levels) under the output directory of each output format and -# will distribute the generated files over these directories. Enabling this -# option can be useful when feeding doxygen a huge amount of source files, where -# putting all generated files in the same directory would otherwise causes -# performance problems for the file system. -# The default value is: NO. - -CREATE_SUBDIRS = NO - -# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII -# characters to appear in the names of generated files. If set to NO, non-ASCII -# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode -# U+3044. -# The default value is: NO. - -ALLOW_UNICODE_NAMES = NO - -# The OUTPUT_LANGUAGE tag is used to specify the language in which all -# documentation generated by doxygen is written. Doxygen will use this -# information to generate all constant output in the proper language. -# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, -# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), -# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, -# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), -# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, -# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, -# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, -# Ukrainian and Vietnamese. -# The default value is: English. - -OUTPUT_LANGUAGE = English - -# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member -# descriptions after the members that are listed in the file and class -# documentation (similar to Javadoc). Set to NO to disable this. -# The default value is: YES. - -BRIEF_MEMBER_DESC = YES - -# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief -# description of a member or function before the detailed description -# -# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the -# brief descriptions will be completely suppressed. -# The default value is: YES. - -REPEAT_BRIEF = YES - -# This tag implements a quasi-intelligent brief description abbreviator that is -# used to form the text in various listings. Each string in this list, if found -# as the leading text of the brief description, will be stripped from the text -# and the result, after processing the whole list, is used as the annotated -# text. Otherwise, the brief description is used as-is. If left blank, the -# following values are used ($name is automatically replaced with the name of -# the entity):The $name class, The $name widget, The $name file, is, provides, -# specifies, contains, represents, a, an and the. - -ABBREVIATE_BRIEF = "The $name class" \ - "The $name widget" \ - "The $name file" \ - is \ - provides \ - specifies \ - contains \ - represents \ - a \ - an \ - the - -# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then -# doxygen will generate a detailed section even if there is only a brief -# description. -# The default value is: NO. - -ALWAYS_DETAILED_SEC = NO - -# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all -# inherited members of a class in the documentation of that class as if those -# members were ordinary class members. Constructors, destructors and assignment -# operators of the base classes will not be shown. -# The default value is: NO. - -INLINE_INHERITED_MEMB = NO - -# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path -# before files name in the file list and in the header files. If set to NO the -# shortest path that makes the file name unique will be used -# The default value is: YES. - -FULL_PATH_NAMES = YES - -# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. -# Stripping is only done if one of the specified strings matches the left-hand -# part of the path. The tag can be used to show relative paths in the file list. -# If left blank the directory from which doxygen is run is used as the path to -# strip. -# -# Note that you can specify absolute paths here, but also relative paths, which -# will be relative from the directory where doxygen is started. -# This tag requires that the tag FULL_PATH_NAMES is set to YES. - -STRIP_FROM_PATH = - -# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the -# path mentioned in the documentation of a class, which tells the reader which -# header file to include in order to use a class. If left blank only the name of -# the header file containing the class definition is used. Otherwise one should -# specify the list of include paths that are normally passed to the compiler -# using the -I flag. - -STRIP_FROM_INC_PATH = - -# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but -# less readable) file names. This can be useful is your file systems doesn't -# support long names like on DOS, Mac, or CD-ROM. -# The default value is: NO. - -SHORT_NAMES = YES - -# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the -# first line (until the first dot) of a Javadoc-style comment as the brief -# description. If set to NO, the Javadoc-style will behave just like regular Qt- -# style comments (thus requiring an explicit @brief command for a brief -# description.) -# The default value is: NO. - -JAVADOC_AUTOBRIEF = NO - -# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first -# line (until the first dot) of a Qt-style comment as the brief description. If -# set to NO, the Qt-style will behave just like regular Qt-style comments (thus -# requiring an explicit \brief command for a brief description.) -# The default value is: NO. - -QT_AUTOBRIEF = NO - -# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a -# multi-line C++ special comment block (i.e. a block of //! or /// comments) as -# a brief description. This used to be the default behavior. The new default is -# to treat a multi-line C++ comment block as a detailed description. Set this -# tag to YES if you prefer the old behavior instead. -# -# Note that setting this tag to YES also means that rational rose comments are -# not recognized any more. -# The default value is: NO. - -MULTILINE_CPP_IS_BRIEF = NO - -# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the -# documentation from any documented member that it re-implements. -# The default value is: YES. - -INHERIT_DOCS = YES - -# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a -# new page for each member. If set to NO, the documentation of a member will be -# part of the file/class/namespace that contains it. -# The default value is: NO. - -SEPARATE_MEMBER_PAGES = NO - -# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen -# uses this value to replace tabs by spaces in code fragments. -# Minimum value: 1, maximum value: 16, default value: 4. - -TAB_SIZE = 4 - -# This tag can be used to specify a number of aliases that act as commands in -# the documentation. An alias has the form: -# name=value -# For example adding -# "sideeffect=@par Side Effects:\n" -# will allow you to put the command \sideeffect (or @sideeffect) in the -# documentation, which will result in a user-defined paragraph with heading -# "Side Effects:". You can put \n's in the value part of an alias to insert -# newlines. - -ALIASES = - -# This tag can be used to specify a number of word-keyword mappings (TCL only). -# A mapping has the form "name=value". For example adding "class=itcl::class" -# will allow you to use the command class in the itcl::class meaning. - -TCL_SUBST = - -# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources -# only. Doxygen will then generate output that is more tailored for C. For -# instance, some of the names that are used will be different. The list of all -# members will be omitted, etc. -# The default value is: NO. - -OPTIMIZE_OUTPUT_FOR_C = YES - -# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or -# Python sources only. Doxygen will then generate output that is more tailored -# for that language. For instance, namespaces will be presented as packages, -# qualified scopes will look different, etc. -# The default value is: NO. - -OPTIMIZE_OUTPUT_JAVA = NO - -# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran -# sources. Doxygen will then generate output that is tailored for Fortran. -# The default value is: NO. - -OPTIMIZE_FOR_FORTRAN = NO - -# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL -# sources. Doxygen will then generate output that is tailored for VHDL. -# The default value is: NO. - -OPTIMIZE_OUTPUT_VHDL = NO - -# Doxygen selects the parser to use depending on the extension of the files it -# parses. With this tag you can assign which parser to use for a given -# extension. Doxygen has a built-in mapping, but you can override or extend it -# using this tag. The format is ext=language, where ext is a file extension, and -# language is one of the parsers supported by doxygen: IDL, Java, Javascript, -# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: -# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: -# Fortran. In the later case the parser tries to guess whether the code is fixed -# or free formatted code, this is the default for Fortran type files), VHDL. For -# instance to make doxygen treat .inc files as Fortran files (default is PHP), -# and .f files as C (default is Fortran), use: inc=Fortran f=C. -# -# Note For files without extension you can use no_extension as a placeholder. -# -# Note that for custom extensions you also need to set FILE_PATTERNS otherwise -# the files are not read by doxygen. - -EXTENSION_MAPPING = - -# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments -# according to the Markdown format, which allows for more readable -# documentation. See http://daringfireball.net/projects/markdown/ for details. -# The output of markdown processing is further processed by doxygen, so you can -# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in -# case of backward compatibilities issues. -# The default value is: YES. - -MARKDOWN_SUPPORT = NO - -# When enabled doxygen tries to link words that correspond to documented -# classes, or namespaces to their corresponding documentation. Such a link can -# be prevented in individual cases by by putting a % sign in front of the word -# or globally by setting AUTOLINK_SUPPORT to NO. -# The default value is: YES. - -AUTOLINK_SUPPORT = YES - -# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want -# to include (a tag file for) the STL sources as input, then you should set this -# tag to YES in order to let doxygen match functions declarations and -# definitions whose arguments contain STL classes (e.g. func(std::string); -# versus func(std::string) {}). This also make the inheritance and collaboration -# diagrams that involve STL classes more complete and accurate. -# The default value is: NO. - -BUILTIN_STL_SUPPORT = NO - -# If you use Microsoft's C++/CLI language, you should set this option to YES to -# enable parsing support. -# The default value is: NO. - -CPP_CLI_SUPPORT = NO - -# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: -# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen -# will parse them like normal C++ but will assume all classes use public instead -# of private inheritance when no explicit protection keyword is present. -# The default value is: NO. - -SIP_SUPPORT = NO - -# For Microsoft's IDL there are propget and propput attributes to indicate -# getter and setter methods for a property. Setting this option to YES will make -# doxygen to replace the get and set methods by a property in the documentation. -# This will only work if the methods are indeed getting or setting a simple -# type. If this is not the case, or you want to show the methods anyway, you -# should set this option to NO. -# The default value is: YES. - -IDL_PROPERTY_SUPPORT = YES - -# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC -# tag is set to YES, then doxygen will reuse the documentation of the first -# member in the group (if any) for the other members of the group. By default -# all members of a group must be documented explicitly. -# The default value is: NO. - -DISTRIBUTE_GROUP_DOC = NO - -# Set the SUBGROUPING tag to YES to allow class member groups of the same type -# (for instance a group of public functions) to be put as a subgroup of that -# type (e.g. under the Public Functions section). Set it to NO to prevent -# subgrouping. Alternatively, this can be done per class using the -# \nosubgrouping command. -# The default value is: YES. - -SUBGROUPING = YES - -# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions -# are shown inside the group in which they are included (e.g. using \ingroup) -# instead of on a separate page (for HTML and Man pages) or section (for LaTeX -# and RTF). -# -# Note that this feature does not work in combination with -# SEPARATE_MEMBER_PAGES. -# The default value is: NO. - -INLINE_GROUPED_CLASSES = NO - -# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions -# with only public data fields or simple typedef fields will be shown inline in -# the documentation of the scope in which they are defined (i.e. file, -# namespace, or group documentation), provided this scope is documented. If set -# to NO, structs, classes, and unions are shown on a separate page (for HTML and -# Man pages) or section (for LaTeX and RTF). -# The default value is: NO. - -INLINE_SIMPLE_STRUCTS = NO - -# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or -# enum is documented as struct, union, or enum with the name of the typedef. So -# typedef struct TypeS {} TypeT, will appear in the documentation as a struct -# with name TypeT. When disabled the typedef will appear as a member of a file, -# namespace, or class. And the struct will be named TypeS. This can typically be -# useful for C code in case the coding convention dictates that all compound -# types are typedef'ed and only the typedef is referenced, never the tag name. -# The default value is: NO. - -TYPEDEF_HIDES_STRUCT = NO - -# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This -# cache is used to resolve symbols given their name and scope. Since this can be -# an expensive process and often the same symbol appears multiple times in the -# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small -# doxygen will become slower. If the cache is too large, memory is wasted. The -# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range -# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 -# symbols. At the end of a run doxygen will report the cache usage and suggest -# the optimal cache size from a speed point of view. -# Minimum value: 0, maximum value: 9, default value: 0. - -LOOKUP_CACHE_SIZE = 0 - -#--------------------------------------------------------------------------- -# Build related configuration options -#--------------------------------------------------------------------------- - -# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in -# documentation are documented, even if no documentation was available. Private -# class members and static file members will be hidden unless the -# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. -# Note: This will also disable the warnings about undocumented members that are -# normally produced when WARNINGS is set to YES. -# The default value is: NO. - -EXTRACT_ALL = YES - -# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will -# be included in the documentation. -# The default value is: NO. - -EXTRACT_PRIVATE = YES - -# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal -# scope will be included in the documentation. -# The default value is: NO. - -EXTRACT_PACKAGE = NO - -# If the EXTRACT_STATIC tag is set to YES all static members of a file will be -# included in the documentation. -# The default value is: NO. - -EXTRACT_STATIC = YES - -# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined -# locally in source files will be included in the documentation. If set to NO -# only classes defined in header files are included. Does not have any effect -# for Java sources. -# The default value is: YES. - -EXTRACT_LOCAL_CLASSES = YES - -# This flag is only useful for Objective-C code. When set to YES local methods, -# which are defined in the implementation section but not in the interface are -# included in the documentation. If set to NO only methods in the interface are -# included. -# The default value is: NO. - -EXTRACT_LOCAL_METHODS = NO - -# If this flag is set to YES, the members of anonymous namespaces will be -# extracted and appear in the documentation as a namespace called -# 'anonymous_namespace{file}', where file will be replaced with the base name of -# the file that contains the anonymous namespace. By default anonymous namespace -# are hidden. -# The default value is: NO. - -EXTRACT_ANON_NSPACES = NO - -# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all -# undocumented members inside documented classes or files. If set to NO these -# members will be included in the various overviews, but no documentation -# section is generated. This option has no effect if EXTRACT_ALL is enabled. -# The default value is: NO. - -HIDE_UNDOC_MEMBERS = NO - -# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all -# undocumented classes that are normally visible in the class hierarchy. If set -# to NO these classes will be included in the various overviews. This option has -# no effect if EXTRACT_ALL is enabled. -# The default value is: NO. - -HIDE_UNDOC_CLASSES = NO - -# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend -# (class|struct|union) declarations. If set to NO these declarations will be -# included in the documentation. -# The default value is: NO. - -HIDE_FRIEND_COMPOUNDS = NO - -# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any -# documentation blocks found inside the body of a function. If set to NO these -# blocks will be appended to the function's detailed documentation block. -# The default value is: NO. - -HIDE_IN_BODY_DOCS = NO - -# The INTERNAL_DOCS tag determines if documentation that is typed after a -# \internal command is included. If the tag is set to NO then the documentation -# will be excluded. Set it to YES to include the internal documentation. -# The default value is: NO. - -INTERNAL_DOCS = NO - -# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file -# names in lower-case letters. If set to YES upper-case letters are also -# allowed. This is useful if you have classes or files whose names only differ -# in case and if your file system supports case sensitive file names. Windows -# and Mac users are advised to set this option to NO. -# The default value is: system dependent. - -CASE_SENSE_NAMES = NO - -# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with -# their full class and namespace scopes in the documentation. If set to YES the -# scope will be hidden. -# The default value is: NO. - -HIDE_SCOPE_NAMES = NO - -# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of -# the files that are included by a file in the documentation of that file. -# The default value is: YES. - -SHOW_INCLUDE_FILES = YES - -# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each -# grouped member an include statement to the documentation, telling the reader -# which file to include in order to use the member. -# The default value is: NO. - -SHOW_GROUPED_MEMB_INC = NO - -# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include -# files with double quotes in the documentation rather than with sharp brackets. -# The default value is: NO. - -FORCE_LOCAL_INCLUDES = NO - -# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the -# documentation for inline members. -# The default value is: YES. - -INLINE_INFO = YES - -# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the -# (detailed) documentation of file and class members alphabetically by member -# name. If set to NO the members will appear in declaration order. -# The default value is: YES. - -SORT_MEMBER_DOCS = YES - -# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief -# descriptions of file, namespace and class members alphabetically by member -# name. If set to NO the members will appear in declaration order. Note that -# this will also influence the order of the classes in the class list. -# The default value is: NO. - -SORT_BRIEF_DOCS = NO - -# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the -# (brief and detailed) documentation of class members so that constructors and -# destructors are listed first. If set to NO the constructors will appear in the -# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. -# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief -# member documentation. -# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting -# detailed member documentation. -# The default value is: NO. - -SORT_MEMBERS_CTORS_1ST = NO - -# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy -# of group names into alphabetical order. If set to NO the group names will -# appear in their defined order. -# The default value is: NO. - -SORT_GROUP_NAMES = NO - -# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by -# fully-qualified names, including namespaces. If set to NO, the class list will -# be sorted only by class name, not including the namespace part. -# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. -# Note: This option applies only to the class list, not to the alphabetical -# list. -# The default value is: NO. - -SORT_BY_SCOPE_NAME = NO - -# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper -# type resolution of all parameters of a function it will reject a match between -# the prototype and the implementation of a member function even if there is -# only one candidate or it is obvious which candidate to choose by doing a -# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still -# accept a match between prototype and implementation in such cases. -# The default value is: NO. - -STRICT_PROTO_MATCHING = NO - -# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the -# todo list. This list is created by putting \todo commands in the -# documentation. -# The default value is: YES. - -GENERATE_TODOLIST = NO - -# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the -# test list. This list is created by putting \test commands in the -# documentation. -# The default value is: YES. - -GENERATE_TESTLIST = NO - -# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug -# list. This list is created by putting \bug commands in the documentation. -# The default value is: YES. - -GENERATE_BUGLIST = NO - -# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO) -# the deprecated list. This list is created by putting \deprecated commands in -# the documentation. -# The default value is: YES. - -GENERATE_DEPRECATEDLIST= YES - -# The ENABLED_SECTIONS tag can be used to enable conditional documentation -# sections, marked by \if <section_label> ... \endif and \cond <section_label> -# ... \endcond blocks. - -ENABLED_SECTIONS = - -# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the -# initial value of a variable or macro / define can have for it to appear in the -# documentation. If the initializer consists of more lines than specified here -# it will be hidden. Use a value of 0 to hide initializers completely. The -# appearance of the value of individual variables and macros / defines can be -# controlled using \showinitializer or \hideinitializer command in the -# documentation regardless of this setting. -# Minimum value: 0, maximum value: 10000, default value: 30. - -MAX_INITIALIZER_LINES = 30 - -# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at -# the bottom of the documentation of classes and structs. If set to YES the list -# will mention the files that were used to generate the documentation. -# The default value is: YES. - -SHOW_USED_FILES = YES - -# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This -# will remove the Files entry from the Quick Index and from the Folder Tree View -# (if specified). -# The default value is: YES. - -SHOW_FILES = YES - -# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces -# page. This will remove the Namespaces entry from the Quick Index and from the -# Folder Tree View (if specified). -# The default value is: YES. - -SHOW_NAMESPACES = YES - -# The FILE_VERSION_FILTER tag can be used to specify a program or script that -# doxygen should invoke to get the current version for each file (typically from -# the version control system). Doxygen will invoke the program by executing (via -# popen()) the command command input-file, where command is the value of the -# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided -# by doxygen. Whatever the program writes to standard output is used as the file -# version. For an example see the documentation. - -FILE_VERSION_FILTER = - -# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed -# by doxygen. The layout file controls the global structure of the generated -# output files in an output format independent way. To create the layout file -# that represents doxygen's defaults, run doxygen with the -l option. You can -# optionally specify a file name after the option, if omitted DoxygenLayout.xml -# will be used as the name of the layout file. -# -# Note that if you run doxygen from a directory containing a file called -# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE -# tag is left empty. - -LAYOUT_FILE = - -# The CITE_BIB_FILES tag can be used to specify one or more bib files containing -# the reference definitions. This must be a list of .bib files. The .bib -# extension is automatically appended if omitted. This requires the bibtex tool -# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. -# For LaTeX the style of the bibliography can be controlled using -# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the -# search path. See also \cite for info how to create references. - -CITE_BIB_FILES = - -#--------------------------------------------------------------------------- -# Configuration options related to warning and progress messages -#--------------------------------------------------------------------------- - -# The QUIET tag can be used to turn on/off the messages that are generated to -# standard output by doxygen. If QUIET is set to YES this implies that the -# messages are off. -# The default value is: NO. - -QUIET = YES - -# The WARNINGS tag can be used to turn on/off the warning messages that are -# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES -# this implies that the warnings are on. -# -# Tip: Turn warnings on while writing the documentation. -# The default value is: YES. - -WARNINGS = YES - -# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate -# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag -# will automatically be disabled. -# The default value is: YES. - -WARN_IF_UNDOCUMENTED = YES - -# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for -# potential errors in the documentation, such as not documenting some parameters -# in a documented function, or documenting parameters that don't exist or using -# markup commands wrongly. -# The default value is: YES. - -WARN_IF_DOC_ERROR = YES - -# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that -# are documented, but have no documentation for their parameters or return -# value. If set to NO doxygen will only warn about wrong or incomplete parameter -# documentation, but not about the absence of documentation. -# The default value is: NO. - -WARN_NO_PARAMDOC = YES - -# The WARN_FORMAT tag determines the format of the warning messages that doxygen -# can produce. The string should contain the $file, $line, and $text tags, which -# will be replaced by the file and line number from which the warning originated -# and the warning text. Optionally the format may contain $version, which will -# be replaced by the version of the file (if it could be obtained via -# FILE_VERSION_FILTER) -# The default value is: $file:$line: $text. - -WARN_FORMAT = "$file:$line: $text" - -# The WARN_LOGFILE tag can be used to specify a file to which warning and error -# messages should be written. If left blank the output is written to standard -# error (stderr). - -WARN_LOGFILE = - -#--------------------------------------------------------------------------- -# Configuration options related to the input files -#--------------------------------------------------------------------------- - -# The INPUT tag is used to specify the files and/or directories that contain -# documented source files. You may enter file names like myfile.cpp or -# directories like /usr/src/myproject. Separate the files or directories with -# spaces. -# Note: If this tag is empty the current directory is searched. - -INPUT = ./ - -# This tag can be used to specify the character encoding of the source files -# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses -# libiconv (or the iconv built into libc) for the transcoding. See the libiconv -# documentation (see: http://www.gnu.org/software/libiconv) for the list of -# possible encodings. -# The default value is: UTF-8. - -INPUT_ENCODING = UTF-8 - -# If the value of the INPUT tag contains directories, you can use the -# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and -# *.h) to filter out the source-files in the directories. If left blank the -# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, -# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, -# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, -# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, -# *.qsf, *.as and *.js. - -FILE_PATTERNS = *.h \ - *.c \ - *.txt - -# The RECURSIVE tag can be used to specify whether or not subdirectories should -# be searched for input files as well. -# The default value is: NO. - -RECURSIVE = YES - -# The EXCLUDE tag can be used to specify files and/or directories that should be -# excluded from the INPUT source files. This way you can easily exclude a -# subdirectory from a directory tree whose root is specified with the INPUT tag. -# -# Note that relative paths are relative to the directory from which doxygen is -# run. - -EXCLUDE = Documentation/ - -# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or -# directories that are symbolic links (a Unix file system feature) are excluded -# from the input. -# The default value is: NO. - -EXCLUDE_SYMLINKS = NO - -# If the value of the INPUT tag contains directories, you can use the -# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude -# certain files from those directories. -# -# Note that the wildcards are matched against the file with absolute path, so to -# exclude all test directories for example use the pattern */test/* - -EXCLUDE_PATTERNS = - -# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names -# (namespaces, classes, functions, etc.) that should be excluded from the -# output. The symbol name can be a fully qualified name, a word, or if the -# wildcard * is used, a substring. Examples: ANamespace, AClass, -# AClass::ANamespace, ANamespace::*Test -# -# Note that the wildcards are matched against the file with absolute path, so to -# exclude all test directories use the pattern */test/* - -EXCLUDE_SYMBOLS = __* \ - INCLUDE_FROM_* - -# The EXAMPLE_PATH tag can be used to specify one or more files or directories -# that contain example code fragments that are included (see the \include -# command). - -EXAMPLE_PATH = - -# If the value of the EXAMPLE_PATH tag contains directories, you can use the -# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and -# *.h) to filter out the source-files in the directories. If left blank all -# files are included. - -EXAMPLE_PATTERNS = * - -# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be -# searched for input files to be used with the \include or \dontinclude commands -# irrespective of the value of the RECURSIVE tag. -# The default value is: NO. - -EXAMPLE_RECURSIVE = NO - -# The IMAGE_PATH tag can be used to specify one or more files or directories -# that contain images that are to be included in the documentation (see the -# \image command). - -IMAGE_PATH = - -# The INPUT_FILTER tag can be used to specify a program that doxygen should -# invoke to filter for each input file. Doxygen will invoke the filter program -# by executing (via popen()) the command: -# -# <filter> <input-file> -# -# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the -# name of an input file. Doxygen will then use the output that the filter -# program writes to standard output. If FILTER_PATTERNS is specified, this tag -# will be ignored. -# -# Note that the filter must not add or remove lines; it is applied before the -# code is scanned, but not when the output code is generated. If lines are added -# or removed, the anchors will not be placed correctly. - -INPUT_FILTER = - -# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern -# basis. Doxygen will compare the file name with each pattern and apply the -# filter if there is a match. The filters are a list of the form: pattern=filter -# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how -# filters are used. If the FILTER_PATTERNS tag is empty or if none of the -# patterns match the file name, INPUT_FILTER is applied. - -FILTER_PATTERNS = - -# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using -# INPUT_FILTER ) will also be used to filter the input files that are used for -# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). -# The default value is: NO. - -FILTER_SOURCE_FILES = NO - -# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file -# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and -# it is also possible to disable source filtering for a specific pattern using -# *.ext= (so without naming a filter). -# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. - -FILTER_SOURCE_PATTERNS = - -# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that -# is part of the input, its contents will be placed on the main page -# (index.html). This can be useful if you have a project on for instance GitHub -# and want to reuse the introduction page also for the doxygen output. - -USE_MDFILE_AS_MAINPAGE = - -#--------------------------------------------------------------------------- -# Configuration options related to source browsing -#--------------------------------------------------------------------------- - -# If the SOURCE_BROWSER tag is set to YES then a list of source files will be -# generated. Documented entities will be cross-referenced with these sources. -# -# Note: To get rid of all source code in the generated output, make sure that -# also VERBATIM_HEADERS is set to NO. -# The default value is: NO. - -SOURCE_BROWSER = NO - -# Setting the INLINE_SOURCES tag to YES will include the body of functions, -# classes and enums directly into the documentation. -# The default value is: NO. - -INLINE_SOURCES = NO - -# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any -# special comment blocks from generated source code fragments. Normal C, C++ and -# Fortran comments will always remain visible. -# The default value is: YES. - -STRIP_CODE_COMMENTS = YES - -# If the REFERENCED_BY_RELATION tag is set to YES then for each documented -# function all documented functions referencing it will be listed. -# The default value is: NO. - -REFERENCED_BY_RELATION = NO - -# If the REFERENCES_RELATION tag is set to YES then for each documented function -# all documented entities called/used by that function will be listed. -# The default value is: NO. - -REFERENCES_RELATION = NO - -# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set -# to YES, then the hyperlinks from functions in REFERENCES_RELATION and -# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will -# link to the documentation. -# The default value is: YES. - -REFERENCES_LINK_SOURCE = NO - -# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the -# source code will show a tooltip with additional information such as prototype, -# brief description and links to the definition and documentation. Since this -# will make the HTML file larger and loading of large files a bit slower, you -# can opt to disable this feature. -# The default value is: YES. -# This tag requires that the tag SOURCE_BROWSER is set to YES. - -SOURCE_TOOLTIPS = YES - -# If the USE_HTAGS tag is set to YES then the references to source code will -# point to the HTML generated by the htags(1) tool instead of doxygen built-in -# source browser. The htags tool is part of GNU's global source tagging system -# (see http://www.gnu.org/software/global/global.html). You will need version -# 4.8.6 or higher. -# -# To use it do the following: -# - Install the latest version of global -# - Enable SOURCE_BROWSER and USE_HTAGS in the config file -# - Make sure the INPUT points to the root of the source tree -# - Run doxygen as normal -# -# Doxygen will invoke htags (and that will in turn invoke gtags), so these -# tools must be available from the command line (i.e. in the search path). -# -# The result: instead of the source browser generated by doxygen, the links to -# source code will now point to the output of htags. -# The default value is: NO. -# This tag requires that the tag SOURCE_BROWSER is set to YES. - -USE_HTAGS = NO - -# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a -# verbatim copy of the header file for each class for which an include is -# specified. Set to NO to disable this. -# See also: Section \class. -# The default value is: YES. - -VERBATIM_HEADERS = NO - -# If the CLANG_ASSISTED_PARSING tag is set to YES, then doxygen will use the -# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the -# cost of reduced performance. This can be particularly helpful with template -# rich C++ code for which doxygen's built-in parser lacks the necessary type -# information. -# Note: The availability of this option depends on whether or not doxygen was -# compiled with the --with-libclang option. -# The default value is: NO. - -CLANG_ASSISTED_PARSING = NO - -# If clang assisted parsing is enabled you can provide the compiler with command -# line options that you would normally use when invoking the compiler. Note that -# the include paths will already be set by doxygen for the files and directories -# specified with INPUT and INCLUDE_PATH. -# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. - -CLANG_OPTIONS = - -#--------------------------------------------------------------------------- -# Configuration options related to the alphabetical class index -#--------------------------------------------------------------------------- - -# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all -# compounds will be generated. Enable this if the project contains a lot of -# classes, structs, unions or interfaces. -# The default value is: YES. - -ALPHABETICAL_INDEX = YES - -# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in -# which the alphabetical index list will be split. -# Minimum value: 1, maximum value: 20, default value: 5. -# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. - -COLS_IN_ALPHA_INDEX = 5 - -# In case all classes in a project start with a common prefix, all classes will -# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag -# can be used to specify a prefix (or a list of prefixes) that should be ignored -# while generating the index headers. -# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. - -IGNORE_PREFIX = - -#--------------------------------------------------------------------------- -# Configuration options related to the HTML output -#--------------------------------------------------------------------------- - -# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output -# The default value is: YES. - -GENERATE_HTML = YES - -# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a -# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of -# it. -# The default directory is: html. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_OUTPUT = html - -# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each -# generated HTML page (for example: .htm, .php, .asp). -# The default value is: .html. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_FILE_EXTENSION = .html - -# The HTML_HEADER tag can be used to specify a user-defined HTML header file for -# each generated HTML page. If the tag is left blank doxygen will generate a -# standard header. -# -# To get valid HTML the header file that includes any scripts and style sheets -# that doxygen needs, which is dependent on the configuration options used (e.g. -# the setting GENERATE_TREEVIEW). It is highly recommended to start with a -# default header using -# doxygen -w html new_header.html new_footer.html new_stylesheet.css -# YourConfigFile -# and then modify the file new_header.html. See also section "Doxygen usage" -# for information on how to generate the default header that doxygen normally -# uses. -# Note: The header is subject to change so you typically have to regenerate the -# default header when upgrading to a newer version of doxygen. For a description -# of the possible markers and block names see the documentation. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_HEADER = - -# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each -# generated HTML page. If the tag is left blank doxygen will generate a standard -# footer. See HTML_HEADER for more information on how to generate a default -# footer and what special commands can be used inside the footer. See also -# section "Doxygen usage" for information on how to generate the default footer -# that doxygen normally uses. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_FOOTER = - -# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style -# sheet that is used by each HTML page. It can be used to fine-tune the look of -# the HTML output. If left blank doxygen will generate a default style sheet. -# See also section "Doxygen usage" for information on how to generate the style -# sheet that doxygen normally uses. -# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as -# it is more robust and this tag (HTML_STYLESHEET) will in the future become -# obsolete. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_STYLESHEET = - -# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined -# cascading style sheets that are included after the standard style sheets -# created by doxygen. Using this option one can overrule certain style aspects. -# This is preferred over using HTML_STYLESHEET since it does not replace the -# standard style sheet and is therefor more robust against future updates. -# Doxygen will copy the style sheet files to the output directory. -# Note: The order of the extra stylesheet files is of importance (e.g. the last -# stylesheet in the list overrules the setting of the previous ones in the -# list). For an example see the documentation. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_EXTRA_STYLESHEET = - -# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or -# other source files which should be copied to the HTML output directory. Note -# that these files will be copied to the base HTML output directory. Use the -# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these -# files. In the HTML_STYLESHEET file, use the file name only. Also note that the -# files will be copied as-is; there are no commands or markers available. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_EXTRA_FILES = - -# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen -# will adjust the colors in the stylesheet and background images according to -# this color. Hue is specified as an angle on a colorwheel, see -# http://en.wikipedia.org/wiki/Hue for more information. For instance the value -# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 -# purple, and 360 is red again. -# Minimum value: 0, maximum value: 359, default value: 220. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_COLORSTYLE_HUE = 220 - -# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors -# in the HTML output. For a value of 0 the output will use grayscales only. A -# value of 255 will produce the most vivid colors. -# Minimum value: 0, maximum value: 255, default value: 100. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_COLORSTYLE_SAT = 100 - -# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the -# luminance component of the colors in the HTML output. Values below 100 -# gradually make the output lighter, whereas values above 100 make the output -# darker. The value divided by 100 is the actual gamma applied, so 80 represents -# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not -# change the gamma. -# Minimum value: 40, maximum value: 240, default value: 80. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_COLORSTYLE_GAMMA = 80 - -# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML -# page will contain the date and time when the page was generated. Setting this -# to NO can help when comparing the output of multiple runs. -# The default value is: YES. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_TIMESTAMP = NO - -# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML -# documentation will contain sections that can be hidden and shown after the -# page has loaded. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_DYNAMIC_SECTIONS = YES - -# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries -# shown in the various tree structured indices initially; the user can expand -# and collapse entries dynamically later on. Doxygen will expand the tree to -# such a level that at most the specified number of entries are visible (unless -# a fully collapsed tree already exceeds this amount). So setting the number of -# entries 1 will produce a full collapsed tree by default. 0 is a special value -# representing an infinite number of entries and will result in a full expanded -# tree by default. -# Minimum value: 0, maximum value: 9999, default value: 100. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_INDEX_NUM_ENTRIES = 100 - -# If the GENERATE_DOCSET tag is set to YES, additional index files will be -# generated that can be used as input for Apple's Xcode 3 integrated development -# environment (see: http://developer.apple.com/tools/xcode/), introduced with -# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a -# Makefile in the HTML output directory. Running make will produce the docset in -# that directory and running make install will install the docset in -# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at -# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html -# for more information. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_DOCSET = NO - -# This tag determines the name of the docset feed. A documentation feed provides -# an umbrella under which multiple documentation sets from a single provider -# (such as a company or product suite) can be grouped. -# The default value is: Doxygen generated docs. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_FEEDNAME = "Doxygen generated docs" - -# This tag specifies a string that should uniquely identify the documentation -# set bundle. This should be a reverse domain-name style string, e.g. -# com.mycompany.MyDocSet. Doxygen will append .docset to the name. -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_BUNDLE_ID = org.doxygen.Project - -# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify -# the documentation publisher. This should be a reverse domain-name style -# string, e.g. com.mycompany.MyDocSet.documentation. -# The default value is: org.doxygen.Publisher. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_PUBLISHER_ID = org.doxygen.Publisher - -# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. -# The default value is: Publisher. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_PUBLISHER_NAME = Publisher - -# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three -# additional HTML index files: index.hhp, index.hhc, and index.hhk. The -# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop -# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on -# Windows. -# -# The HTML Help Workshop contains a compiler that can convert all HTML output -# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML -# files are now used as the Windows 98 help format, and will replace the old -# Windows help format (.hlp) on all Windows platforms in the future. Compressed -# HTML files also contain an index, a table of contents, and you can search for -# words in the documentation. The HTML workshop also contains a viewer for -# compressed HTML files. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_HTMLHELP = NO - -# The CHM_FILE tag can be used to specify the file name of the resulting .chm -# file. You can add a path in front of the file if the result should not be -# written to the html output directory. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -CHM_FILE = - -# The HHC_LOCATION tag can be used to specify the location (absolute path -# including file name) of the HTML help compiler ( hhc.exe). If non-empty -# doxygen will try to run the HTML help compiler on the generated index.hhp. -# The file has to be specified with full path. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -HHC_LOCATION = - -# The GENERATE_CHI flag controls if a separate .chi index file is generated ( -# YES) or that it should be included in the master .chm file ( NO). -# The default value is: NO. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -GENERATE_CHI = NO - -# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc) -# and project file content. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -CHM_INDEX_ENCODING = - -# The BINARY_TOC flag controls whether a binary table of contents is generated ( -# YES) or a normal table of contents ( NO) in the .chm file. Furthermore it -# enables the Previous and Next buttons. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -BINARY_TOC = NO - -# The TOC_EXPAND flag can be set to YES to add extra items for group members to -# the table of contents of the HTML help documentation and to the tree view. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -TOC_EXPAND = YES - -# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and -# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that -# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help -# (.qch) of the generated HTML documentation. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_QHP = NO - -# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify -# the file name of the resulting .qch file. The path specified is relative to -# the HTML output folder. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QCH_FILE = - -# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help -# Project output. For more information please see Qt Help Project / Namespace -# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_NAMESPACE = org.doxygen.Project - -# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt -# Help Project output. For more information please see Qt Help Project / Virtual -# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- -# folders). -# The default value is: doc. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_VIRTUAL_FOLDER = doc - -# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom -# filter to add. For more information please see Qt Help Project / Custom -# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- -# filters). -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_CUST_FILTER_NAME = - -# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the -# custom filter to add. For more information please see Qt Help Project / Custom -# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- -# filters). -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_CUST_FILTER_ATTRS = - -# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this -# project's filter section matches. Qt Help Project / Filter Attributes (see: -# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_SECT_FILTER_ATTRS = - -# The QHG_LOCATION tag can be used to specify the location of Qt's -# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the -# generated .qhp file. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHG_LOCATION = - -# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be -# generated, together with the HTML files, they form an Eclipse help plugin. To -# install this plugin and make it available under the help contents menu in -# Eclipse, the contents of the directory containing the HTML and XML files needs -# to be copied into the plugins directory of eclipse. The name of the directory -# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. -# After copying Eclipse needs to be restarted before the help appears. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_ECLIPSEHELP = NO - -# A unique identifier for the Eclipse help plugin. When installing the plugin -# the directory name containing the HTML and XML files should also have this -# name. Each documentation set should have its own identifier. -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. - -ECLIPSE_DOC_ID = org.doxygen.Project - -# If you want full control over the layout of the generated HTML pages it might -# be necessary to disable the index and replace it with your own. The -# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top -# of each HTML page. A value of NO enables the index and the value YES disables -# it. Since the tabs in the index contain the same information as the navigation -# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -DISABLE_INDEX = YES - -# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index -# structure should be generated to display hierarchical information. If the tag -# value is set to YES, a side panel will be generated containing a tree-like -# index structure (just like the one that is generated for HTML Help). For this -# to work a browser that supports JavaScript, DHTML, CSS and frames is required -# (i.e. any modern browser). Windows users are probably better off using the -# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can -# further fine-tune the look of the index. As an example, the default style -# sheet generated by doxygen has an example that shows how to put an image at -# the root of the tree instead of the PROJECT_NAME. Since the tree basically has -# the same information as the tab index, you could consider setting -# DISABLE_INDEX to YES when enabling this option. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_TREEVIEW = YES - -# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that -# doxygen will group on one line in the generated HTML documentation. -# -# Note that a value of 0 will completely suppress the enum values from appearing -# in the overview section. -# Minimum value: 0, maximum value: 20, default value: 4. -# This tag requires that the tag GENERATE_HTML is set to YES. - -ENUM_VALUES_PER_LINE = 1 - -# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used -# to set the initial width (in pixels) of the frame in which the tree is shown. -# Minimum value: 0, maximum value: 1500, default value: 250. -# This tag requires that the tag GENERATE_HTML is set to YES. - -TREEVIEW_WIDTH = 250 - -# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to -# external symbols imported via tag files in a separate window. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -EXT_LINKS_IN_WINDOW = NO - -# Use this tag to change the font size of LaTeX formulas included as images in -# the HTML documentation. When you change the font size after a successful -# doxygen run you need to manually remove any form_*.png images from the HTML -# output directory to force them to be regenerated. -# Minimum value: 8, maximum value: 50, default value: 10. -# This tag requires that the tag GENERATE_HTML is set to YES. - -FORMULA_FONTSIZE = 10 - -# Use the FORMULA_TRANPARENT tag to determine whether or not the images -# generated for formulas are transparent PNGs. Transparent PNGs are not -# supported properly for IE 6.0, but are supported on all modern browsers. -# -# Note that when changing this option you need to delete any form_*.png files in -# the HTML output directory before the changes have effect. -# The default value is: YES. -# This tag requires that the tag GENERATE_HTML is set to YES. - -FORMULA_TRANSPARENT = YES - -# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see -# http://www.mathjax.org) which uses client side Javascript for the rendering -# instead of using prerendered bitmaps. Use this if you do not have LaTeX -# installed or if you want to formulas look prettier in the HTML output. When -# enabled you may also need to install MathJax separately and configure the path -# to it using the MATHJAX_RELPATH option. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -USE_MATHJAX = NO - -# When MathJax is enabled you can set the default output format to be used for -# the MathJax output. See the MathJax site (see: -# http://docs.mathjax.org/en/latest/output.html) for more details. -# Possible values are: HTML-CSS (which is slower, but has the best -# compatibility), NativeMML (i.e. MathML) and SVG. -# The default value is: HTML-CSS. -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_FORMAT = HTML-CSS - -# When MathJax is enabled you need to specify the location relative to the HTML -# output directory using the MATHJAX_RELPATH option. The destination directory -# should contain the MathJax.js script. For instance, if the mathjax directory -# is located at the same level as the HTML output directory, then -# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax -# Content Delivery Network so you can quickly see the result without installing -# MathJax. However, it is strongly recommended to install a local copy of -# MathJax from http://www.mathjax.org before deployment. -# The default value is: http://cdn.mathjax.org/mathjax/latest. -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest - -# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax -# extension names that should be enabled during MathJax rendering. For example -# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_EXTENSIONS = - -# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces -# of code that will be used on startup of the MathJax code. See the MathJax site -# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an -# example see the documentation. -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_CODEFILE = - -# When the SEARCHENGINE tag is enabled doxygen will generate a search box for -# the HTML output. The underlying search engine uses javascript and DHTML and -# should work on any modern browser. Note that when using HTML help -# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) -# there is already a search function so this one should typically be disabled. -# For large projects the javascript based search engine can be slow, then -# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to -# search using the keyboard; to jump to the search box use <access key> + S -# (what the <access key> is depends on the OS and browser, but it is typically -# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down -# key> to jump into the search results window, the results can be navigated -# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel -# the search. The filter options can be selected when the cursor is inside the -# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys> -# to select a filter and <Enter> or <escape> to activate or cancel the filter -# option. -# The default value is: YES. -# This tag requires that the tag GENERATE_HTML is set to YES. - -SEARCHENGINE = NO - -# When the SERVER_BASED_SEARCH tag is enabled the search engine will be -# implemented using a web server instead of a web client using Javascript. There -# are two flavors of web server based searching depending on the EXTERNAL_SEARCH -# setting. When disabled, doxygen will generate a PHP script for searching and -# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing -# and searching needs to be provided by external tools. See the section -# "External Indexing and Searching" for details. -# The default value is: NO. -# This tag requires that the tag SEARCHENGINE is set to YES. - -SERVER_BASED_SEARCH = NO - -# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP -# script for searching. Instead the search results are written to an XML file -# which needs to be processed by an external indexer. Doxygen will invoke an -# external search engine pointed to by the SEARCHENGINE_URL option to obtain the -# search results. -# -# Doxygen ships with an example indexer ( doxyindexer) and search engine -# (doxysearch.cgi) which are based on the open source search engine library -# Xapian (see: http://xapian.org/). -# -# See the section "External Indexing and Searching" for details. -# The default value is: NO. -# This tag requires that the tag SEARCHENGINE is set to YES. - -EXTERNAL_SEARCH = NO - -# The SEARCHENGINE_URL should point to a search engine hosted by a web server -# which will return the search results when EXTERNAL_SEARCH is enabled. -# -# Doxygen ships with an example indexer ( doxyindexer) and search engine -# (doxysearch.cgi) which are based on the open source search engine library -# Xapian (see: http://xapian.org/). See the section "External Indexing and -# Searching" for details. -# This tag requires that the tag SEARCHENGINE is set to YES. - -SEARCHENGINE_URL = - -# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed -# search data is written to a file for indexing by an external tool. With the -# SEARCHDATA_FILE tag the name of this file can be specified. -# The default file is: searchdata.xml. -# This tag requires that the tag SEARCHENGINE is set to YES. - -SEARCHDATA_FILE = searchdata.xml - -# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the -# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is -# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple -# projects and redirect the results back to the right project. -# This tag requires that the tag SEARCHENGINE is set to YES. - -EXTERNAL_SEARCH_ID = - -# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen -# projects other than the one defined by this configuration file, but that are -# all added to the same external search index. Each project needs to have a -# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of -# to a relative location where the documentation can be found. The format is: -# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ... -# This tag requires that the tag SEARCHENGINE is set to YES. - -EXTRA_SEARCH_MAPPINGS = - -#--------------------------------------------------------------------------- -# Configuration options related to the LaTeX output -#--------------------------------------------------------------------------- - -# If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output. -# The default value is: YES. - -GENERATE_LATEX = NO - -# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a -# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of -# it. -# The default directory is: latex. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -LATEX_OUTPUT = latex - -# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be -# invoked. -# -# Note that when enabling USE_PDFLATEX this option is only used for generating -# bitmaps for formulas in the HTML output, but not in the Makefile that is -# written to the output directory. -# The default file is: latex. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -LATEX_CMD_NAME = latex - -# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate -# index for LaTeX. -# The default file is: makeindex. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -MAKEINDEX_CMD_NAME = makeindex - -# If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX -# documents. This may be useful for small projects and may help to save some -# trees in general. -# The default value is: NO. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -COMPACT_LATEX = NO - -# The PAPER_TYPE tag can be used to set the paper type that is used by the -# printer. -# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x -# 14 inches) and executive (7.25 x 10.5 inches). -# The default value is: a4. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -PAPER_TYPE = a4wide - -# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names -# that should be included in the LaTeX output. To get the times font for -# instance you can specify -# EXTRA_PACKAGES=times -# If left blank no extra packages will be included. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -EXTRA_PACKAGES = - -# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the -# generated LaTeX document. The header should contain everything until the first -# chapter. If it is left blank doxygen will generate a standard header. See -# section "Doxygen usage" for information on how to let doxygen write the -# default header to a separate file. -# -# Note: Only use a user-defined header if you know what you are doing! The -# following commands have a special meaning inside the header: $title, -# $datetime, $date, $doxygenversion, $projectname, $projectnumber, -# $projectbrief, $projectlogo. Doxygen will replace $title with the empy string, -# for the replacement values of the other commands the user is refered to -# HTML_HEADER. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -LATEX_HEADER = - -# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the -# generated LaTeX document. The footer should contain everything after the last -# chapter. If it is left blank doxygen will generate a standard footer. See -# LATEX_HEADER for more information on how to generate a default footer and what -# special commands can be used inside the footer. -# -# Note: Only use a user-defined footer if you know what you are doing! -# This tag requires that the tag GENERATE_LATEX is set to YES. - -LATEX_FOOTER = - -# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or -# other source files which should be copied to the LATEX_OUTPUT output -# directory. Note that the files will be copied as-is; there are no commands or -# markers available. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -LATEX_EXTRA_FILES = - -# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is -# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will -# contain links (just like the HTML output) instead of page references. This -# makes the output suitable for online browsing using a PDF viewer. -# The default value is: YES. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -PDF_HYPERLINKS = YES - -# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate -# the PDF file directly from the LaTeX files. Set this option to YES to get a -# higher quality PDF documentation. -# The default value is: YES. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -USE_PDFLATEX = YES - -# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode -# command to the generated LaTeX files. This will instruct LaTeX to keep running -# if errors occur, instead of asking the user for help. This option is also used -# when generating formulas in HTML. -# The default value is: NO. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -LATEX_BATCHMODE = NO - -# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the -# index chapters (such as File Index, Compound Index, etc.) in the output. -# The default value is: NO. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -LATEX_HIDE_INDICES = NO - -# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source -# code with syntax highlighting in the LaTeX output. -# -# Note that which sources are shown also depends on other settings such as -# SOURCE_BROWSER. -# The default value is: NO. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -LATEX_SOURCE_CODE = NO - -# The LATEX_BIB_STYLE tag can be used to specify the style to use for the -# bibliography, e.g. plainnat, or ieeetr. See -# http://en.wikipedia.org/wiki/BibTeX and \cite for more info. -# The default value is: plain. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -LATEX_BIB_STYLE = plain - -#--------------------------------------------------------------------------- -# Configuration options related to the RTF output -#--------------------------------------------------------------------------- - -# If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The -# RTF output is optimized for Word 97 and may not look too pretty with other RTF -# readers/editors. -# The default value is: NO. - -GENERATE_RTF = NO - -# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a -# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of -# it. -# The default directory is: rtf. -# This tag requires that the tag GENERATE_RTF is set to YES. - -RTF_OUTPUT = rtf - -# If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF -# documents. This may be useful for small projects and may help to save some -# trees in general. -# The default value is: NO. -# This tag requires that the tag GENERATE_RTF is set to YES. - -COMPACT_RTF = NO - -# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will -# contain hyperlink fields. The RTF file will contain links (just like the HTML -# output) instead of page references. This makes the output suitable for online -# browsing using Word or some other Word compatible readers that support those -# fields. -# -# Note: WordPad (write) and others do not support links. -# The default value is: NO. -# This tag requires that the tag GENERATE_RTF is set to YES. - -RTF_HYPERLINKS = NO - -# Load stylesheet definitions from file. Syntax is similar to doxygen's config -# file, i.e. a series of assignments. You only have to provide replacements, -# missing definitions are set to their default value. -# -# See also section "Doxygen usage" for information on how to generate the -# default style sheet that doxygen normally uses. -# This tag requires that the tag GENERATE_RTF is set to YES. - -RTF_STYLESHEET_FILE = - -# Set optional variables used in the generation of an RTF document. Syntax is -# similar to doxygen's config file. A template extensions file can be generated -# using doxygen -e rtf extensionFile. -# This tag requires that the tag GENERATE_RTF is set to YES. - -RTF_EXTENSIONS_FILE = - -#--------------------------------------------------------------------------- -# Configuration options related to the man page output -#--------------------------------------------------------------------------- - -# If the GENERATE_MAN tag is set to YES doxygen will generate man pages for -# classes and files. -# The default value is: NO. - -GENERATE_MAN = NO - -# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a -# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of -# it. A directory man3 will be created inside the directory specified by -# MAN_OUTPUT. -# The default directory is: man. -# This tag requires that the tag GENERATE_MAN is set to YES. - -MAN_OUTPUT = man - -# The MAN_EXTENSION tag determines the extension that is added to the generated -# man pages. In case the manual section does not start with a number, the number -# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is -# optional. -# The default value is: .3. -# This tag requires that the tag GENERATE_MAN is set to YES. - -MAN_EXTENSION = .3 - -# The MAN_SUBDIR tag determines the name of the directory created within -# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by -# MAN_EXTENSION with the initial . removed. -# This tag requires that the tag GENERATE_MAN is set to YES. - -MAN_SUBDIR = - -# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it -# will generate one additional man file for each entity documented in the real -# man page(s). These additional files only source the real man page, but without -# them the man command would be unable to find the correct page. -# The default value is: NO. -# This tag requires that the tag GENERATE_MAN is set to YES. - -MAN_LINKS = NO - -#--------------------------------------------------------------------------- -# Configuration options related to the XML output -#--------------------------------------------------------------------------- - -# If the GENERATE_XML tag is set to YES doxygen will generate an XML file that -# captures the structure of the code including all documentation. -# The default value is: NO. - -GENERATE_XML = NO - -# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a -# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of -# it. -# The default directory is: xml. -# This tag requires that the tag GENERATE_XML is set to YES. - -XML_OUTPUT = xml - -# If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program -# listings (including syntax highlighting and cross-referencing information) to -# the XML output. Note that enabling this will significantly increase the size -# of the XML output. -# The default value is: YES. -# This tag requires that the tag GENERATE_XML is set to YES. - -XML_PROGRAMLISTING = YES - -#--------------------------------------------------------------------------- -# Configuration options related to the DOCBOOK output -#--------------------------------------------------------------------------- - -# If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files -# that can be used to generate PDF. -# The default value is: NO. - -GENERATE_DOCBOOK = NO - -# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in -# front of it. -# The default directory is: docbook. -# This tag requires that the tag GENERATE_DOCBOOK is set to YES. - -DOCBOOK_OUTPUT = docbook - -# If the DOCBOOK_PROGRAMLISTING tag is set to YES doxygen will include the -# program listings (including syntax highlighting and cross-referencing -# information) to the DOCBOOK output. Note that enabling this will significantly -# increase the size of the DOCBOOK output. -# The default value is: NO. -# This tag requires that the tag GENERATE_DOCBOOK is set to YES. - -DOCBOOK_PROGRAMLISTING = NO - -#--------------------------------------------------------------------------- -# Configuration options for the AutoGen Definitions output -#--------------------------------------------------------------------------- - -# If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen -# Definitions (see http://autogen.sf.net) file that captures the structure of -# the code including all documentation. Note that this feature is still -# experimental and incomplete at the moment. -# The default value is: NO. - -GENERATE_AUTOGEN_DEF = NO - -#--------------------------------------------------------------------------- -# Configuration options related to the Perl module output -#--------------------------------------------------------------------------- - -# If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module -# file that captures the structure of the code including all documentation. -# -# Note that this feature is still experimental and incomplete at the moment. -# The default value is: NO. - -GENERATE_PERLMOD = NO - -# If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary -# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI -# output from the Perl module output. -# The default value is: NO. -# This tag requires that the tag GENERATE_PERLMOD is set to YES. - -PERLMOD_LATEX = NO - -# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely -# formatted so it can be parsed by a human reader. This is useful if you want to -# understand what is going on. On the other hand, if this tag is set to NO the -# size of the Perl module output will be much smaller and Perl will parse it -# just the same. -# The default value is: YES. -# This tag requires that the tag GENERATE_PERLMOD is set to YES. - -PERLMOD_PRETTY = YES - -# The names of the make variables in the generated doxyrules.make file are -# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful -# so different doxyrules.make files included by the same Makefile don't -# overwrite each other's variables. -# This tag requires that the tag GENERATE_PERLMOD is set to YES. - -PERLMOD_MAKEVAR_PREFIX = - -#--------------------------------------------------------------------------- -# Configuration options related to the preprocessor -#--------------------------------------------------------------------------- - -# If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all -# C-preprocessor directives found in the sources and include files. -# The default value is: YES. - -ENABLE_PREPROCESSING = YES - -# If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names -# in the source code. If set to NO only conditional compilation will be -# performed. Macro expansion can be done in a controlled way by setting -# EXPAND_ONLY_PREDEF to YES. -# The default value is: NO. -# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. - -MACRO_EXPANSION = YES - -# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then -# the macro expansion is limited to the macros specified with the PREDEFINED and -# EXPAND_AS_DEFINED tags. -# The default value is: NO. -# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. - -EXPAND_ONLY_PREDEF = YES - -# If the SEARCH_INCLUDES tag is set to YES the includes files in the -# INCLUDE_PATH will be searched if a #include is found. -# The default value is: YES. -# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. - -SEARCH_INCLUDES = YES - -# The INCLUDE_PATH tag can be used to specify one or more directories that -# contain include files that are not input files but should be processed by the -# preprocessor. -# This tag requires that the tag SEARCH_INCLUDES is set to YES. - -INCLUDE_PATH = - -# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard -# patterns (like *.h and *.hpp) to filter out the header-files in the -# directories. If left blank, the patterns specified with FILE_PATTERNS will be -# used. -# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. - -INCLUDE_FILE_PATTERNS = - -# The PREDEFINED tag can be used to specify one or more macro names that are -# defined before the preprocessor is started (similar to the -D option of e.g. -# gcc). The argument of the tag is a list of macros of the form: name or -# name=definition (no spaces). If the definition and the "=" are omitted, "=1" -# is assumed. To prevent a macro definition from being undefined via #undef or -# recursively expanded use the := operator instead of the = operator. -# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. - -PREDEFINED = __DOXYGEN__ \ - PROGMEM - -# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this -# tag can be used to specify a list of macro names that should be expanded. The -# macro definition that is found in the sources will be used. Use the PREDEFINED -# tag if you want to use a different macro definition that overrules the -# definition found in the source code. -# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. - -EXPAND_AS_DEFINED = - -# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will -# remove all references to function-like macros that are alone on a line, have -# an all uppercase name, and do not end with a semicolon. Such function macros -# are typically used for boiler-plate code, and will confuse the parser if not -# removed. -# The default value is: YES. -# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. - -SKIP_FUNCTION_MACROS = YES - -#--------------------------------------------------------------------------- -# Configuration options related to external references -#--------------------------------------------------------------------------- - -# The TAGFILES tag can be used to specify one or more tag files. For each tag -# file the location of the external documentation should be added. The format of -# a tag file without this location is as follows: -# TAGFILES = file1 file2 ... -# Adding location for the tag files is done as follows: -# TAGFILES = file1=loc1 "file2 = loc2" ... -# where loc1 and loc2 can be relative or absolute paths or URLs. See the -# section "Linking to external documentation" for more information about the use -# of tag files. -# Note: Each tag file must have a unique name (where the name does NOT include -# the path). If a tag file is not located in the directory in which doxygen is -# run, you must also specify the path to the tagfile here. - -TAGFILES = - -# When a file name is specified after GENERATE_TAGFILE, doxygen will create a -# tag file that is based on the input files it reads. See section "Linking to -# external documentation" for more information about the usage of tag files. - -GENERATE_TAGFILE = - -# If the ALLEXTERNALS tag is set to YES all external class will be listed in the -# class index. If set to NO only the inherited external classes will be listed. -# The default value is: NO. - -ALLEXTERNALS = NO - -# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in -# the modules index. If set to NO, only the current project's groups will be -# listed. -# The default value is: YES. - -EXTERNAL_GROUPS = YES - -# If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in -# the related pages index. If set to NO, only the current project's pages will -# be listed. -# The default value is: YES. - -EXTERNAL_PAGES = YES - -# The PERL_PATH should be the absolute path and name of the perl script -# interpreter (i.e. the result of 'which perl'). -# The default file (with absolute path) is: /usr/bin/perl. - -PERL_PATH = /usr/bin/perl - -#--------------------------------------------------------------------------- -# Configuration options related to the dot tool -#--------------------------------------------------------------------------- - -# If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram -# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to -# NO turns the diagrams off. Note that this option also works with HAVE_DOT -# disabled, but it is recommended to install and use dot, since it yields more -# powerful graphs. -# The default value is: YES. - -CLASS_DIAGRAMS = NO - -# You can define message sequence charts within doxygen comments using the \msc -# command. Doxygen will then run the mscgen tool (see: -# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the -# documentation. The MSCGEN_PATH tag allows you to specify the directory where -# the mscgen tool resides. If left empty the tool is assumed to be found in the -# default search path. - -MSCGEN_PATH = - -# You can include diagrams made with dia in doxygen documentation. Doxygen will -# then run dia to produce the diagram and insert it in the documentation. The -# DIA_PATH tag allows you to specify the directory where the dia binary resides. -# If left empty dia is assumed to be found in the default search path. - -DIA_PATH = - -# If set to YES, the inheritance and collaboration graphs will hide inheritance -# and usage relations if the target is undocumented or is not a class. -# The default value is: YES. - -HIDE_UNDOC_RELATIONS = YES - -# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is -# available from the path. This tool is part of Graphviz (see: -# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent -# Bell Labs. The other options in this section have no effect if this option is -# set to NO -# The default value is: NO. - -HAVE_DOT = NO - -# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed -# to run in parallel. When set to 0 doxygen will base this on the number of -# processors available in the system. You can set it explicitly to a value -# larger than 0 to get control over the balance between CPU load and processing -# speed. -# Minimum value: 0, maximum value: 32, default value: 0. -# This tag requires that the tag HAVE_DOT is set to YES. - -DOT_NUM_THREADS = 0 - -# When you want a differently looking font in the dot files that doxygen -# generates you can specify the font name using DOT_FONTNAME. You need to make -# sure dot is able to find the font, which can be done by putting it in a -# standard location or by setting the DOTFONTPATH environment variable or by -# setting DOT_FONTPATH to the directory containing the font. -# The default value is: Helvetica. -# This tag requires that the tag HAVE_DOT is set to YES. - -DOT_FONTNAME = - -# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of -# dot graphs. -# Minimum value: 4, maximum value: 24, default value: 10. -# This tag requires that the tag HAVE_DOT is set to YES. - -DOT_FONTSIZE = 10 - -# By default doxygen will tell dot to use the default font as specified with -# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set -# the path where dot can find it using this tag. -# This tag requires that the tag HAVE_DOT is set to YES. - -DOT_FONTPATH = - -# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for -# each documented class showing the direct and indirect inheritance relations. -# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO. -# The default value is: YES. -# This tag requires that the tag HAVE_DOT is set to YES. - -CLASS_GRAPH = NO - -# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a -# graph for each documented class showing the direct and indirect implementation -# dependencies (inheritance, containment, and class references variables) of the -# class with other documented classes. -# The default value is: YES. -# This tag requires that the tag HAVE_DOT is set to YES. - -COLLABORATION_GRAPH = NO - -# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for -# groups, showing the direct groups dependencies. -# The default value is: YES. -# This tag requires that the tag HAVE_DOT is set to YES. - -GROUP_GRAPHS = NO - -# If the UML_LOOK tag is set to YES doxygen will generate inheritance and -# collaboration diagrams in a style similar to the OMG's Unified Modeling -# Language. -# The default value is: NO. -# This tag requires that the tag HAVE_DOT is set to YES. - -UML_LOOK = NO - -# If the UML_LOOK tag is enabled, the fields and methods are shown inside the -# class node. If there are many fields or methods and many nodes the graph may -# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the -# number of items for each type to make the size more manageable. Set this to 0 -# for no limit. Note that the threshold may be exceeded by 50% before the limit -# is enforced. So when you set the threshold to 10, up to 15 fields may appear, -# but if the number exceeds 15, the total amount of fields shown is limited to -# 10. -# Minimum value: 0, maximum value: 100, default value: 10. -# This tag requires that the tag HAVE_DOT is set to YES. - -UML_LIMIT_NUM_FIELDS = 10 - -# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and -# collaboration graphs will show the relations between templates and their -# instances. -# The default value is: NO. -# This tag requires that the tag HAVE_DOT is set to YES. - -TEMPLATE_RELATIONS = NO - -# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to -# YES then doxygen will generate a graph for each documented file showing the -# direct and indirect include dependencies of the file with other documented -# files. -# The default value is: YES. -# This tag requires that the tag HAVE_DOT is set to YES. - -INCLUDE_GRAPH = NO - -# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are -# set to YES then doxygen will generate a graph for each documented file showing -# the direct and indirect include dependencies of the file with other documented -# files. -# The default value is: YES. -# This tag requires that the tag HAVE_DOT is set to YES. - -INCLUDED_BY_GRAPH = NO - -# If the CALL_GRAPH tag is set to YES then doxygen will generate a call -# dependency graph for every global function or class method. -# -# Note that enabling this option will significantly increase the time of a run. -# So in most cases it will be better to enable call graphs for selected -# functions only using the \callgraph command. -# The default value is: NO. -# This tag requires that the tag HAVE_DOT is set to YES. - -CALL_GRAPH = NO - -# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller -# dependency graph for every global function or class method. -# -# Note that enabling this option will significantly increase the time of a run. -# So in most cases it will be better to enable caller graphs for selected -# functions only using the \callergraph command. -# The default value is: NO. -# This tag requires that the tag HAVE_DOT is set to YES. - -CALLER_GRAPH = NO - -# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical -# hierarchy of all classes instead of a textual one. -# The default value is: YES. -# This tag requires that the tag HAVE_DOT is set to YES. - -GRAPHICAL_HIERARCHY = NO - -# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the -# dependencies a directory has on other directories in a graphical way. The -# dependency relations are determined by the #include relations between the -# files in the directories. -# The default value is: YES. -# This tag requires that the tag HAVE_DOT is set to YES. - -DIRECTORY_GRAPH = NO - -# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images -# generated by dot. -# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order -# to make the SVG files visible in IE 9+ (other browsers do not have this -# requirement). -# Possible values are: png, jpg, gif and svg. -# The default value is: png. -# This tag requires that the tag HAVE_DOT is set to YES. - -DOT_IMAGE_FORMAT = png - -# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to -# enable generation of interactive SVG images that allow zooming and panning. -# -# Note that this requires a modern browser other than Internet Explorer. Tested -# and working are Firefox, Chrome, Safari, and Opera. -# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make -# the SVG files visible. Older versions of IE do not have SVG support. -# The default value is: NO. -# This tag requires that the tag HAVE_DOT is set to YES. - -INTERACTIVE_SVG = NO - -# The DOT_PATH tag can be used to specify the path where the dot tool can be -# found. If left blank, it is assumed the dot tool can be found in the path. -# This tag requires that the tag HAVE_DOT is set to YES. - -DOT_PATH = - -# The DOTFILE_DIRS tag can be used to specify one or more directories that -# contain dot files that are included in the documentation (see the \dotfile -# command). -# This tag requires that the tag HAVE_DOT is set to YES. - -DOTFILE_DIRS = - -# The MSCFILE_DIRS tag can be used to specify one or more directories that -# contain msc files that are included in the documentation (see the \mscfile -# command). - -MSCFILE_DIRS = - -# The DIAFILE_DIRS tag can be used to specify one or more directories that -# contain dia files that are included in the documentation (see the \diafile -# command). - -DIAFILE_DIRS = - -# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the -# path where java can find the plantuml.jar file. If left blank, it is assumed -# PlantUML is not used or called during a preprocessing step. Doxygen will -# generate a warning when it encounters a \startuml command in this case and -# will not generate output for the diagram. -# This tag requires that the tag HAVE_DOT is set to YES. - -PLANTUML_JAR_PATH = - -# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes -# that will be shown in the graph. If the number of nodes in a graph becomes -# larger than this value, doxygen will truncate the graph, which is visualized -# by representing a node as a red box. Note that doxygen if the number of direct -# children of the root node in a graph is already larger than -# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that -# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. -# Minimum value: 0, maximum value: 10000, default value: 50. -# This tag requires that the tag HAVE_DOT is set to YES. - -DOT_GRAPH_MAX_NODES = 15 - -# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs -# generated by dot. A depth value of 3 means that only nodes reachable from the -# root by following a path via at most 3 edges will be shown. Nodes that lay -# further from the root node will be omitted. Note that setting this option to 1 -# or 2 may greatly reduce the computation time needed for large code bases. Also -# note that the size of a graph can be further restricted by -# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. -# Minimum value: 0, maximum value: 1000, default value: 0. -# This tag requires that the tag HAVE_DOT is set to YES. - -MAX_DOT_GRAPH_DEPTH = 2 - -# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent -# background. This is disabled by default, because dot on Windows does not seem -# to support this out of the box. -# -# Warning: Depending on the platform used, enabling this option may lead to -# badly anti-aliased labels on the edges of a graph (i.e. they become hard to -# read). -# The default value is: NO. -# This tag requires that the tag HAVE_DOT is set to YES. - -DOT_TRANSPARENT = YES - -# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output -# files in one run (i.e. multiple -o and -T options on the command line). This -# makes dot run faster, but since only newer versions of dot (>1.8.10) support -# this, this feature is disabled by default. -# The default value is: NO. -# This tag requires that the tag HAVE_DOT is set to YES. - -DOT_MULTI_TARGETS = NO - -# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page -# explaining the meaning of the various boxes and arrows in the dot generated -# graphs. -# The default value is: YES. -# This tag requires that the tag HAVE_DOT is set to YES. - -GENERATE_LEGEND = YES - -# If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot -# files that are used to generate the various graphs. -# The default value is: YES. -# This tag requires that the tag HAVE_DOT is set to YES. - -DOT_CLEANUP = YES diff --git a/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/makefile b/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/makefile deleted file mode 100644 index 7d16d4268..000000000 --- a/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/makefile +++ /dev/null @@ -1,39 +0,0 @@ -# -# LUFA Library -# Copyright (C) Dean Camera, 2014. -# -# dean [at] fourwalledcubicle [dot] com -# www.lufa-lib.org -# -# -------------------------------------- -# LUFA Project Makefile. -# -------------------------------------- - -# Run "make help" for target help. - -MCU = at90usb1287 -ARCH = AVR8 -BOARD = USBKEY -F_CPU = 8000000 -F_USB = $(F_CPU) -OPTIMIZATION = s -TARGET = RNDISEthernet -SRC = $(TARGET).c Descriptors.c Lib/Ethernet.c Lib/ProtocolDecoders.c Lib/ICMP.c Lib/TCP.c Lib/UDP.c Lib/DHCP.c Lib/ARP.c \ - Lib/IP.c Lib/Webserver.c $(LUFA_SRC_USB) $(LUFA_SRC_USBCLASS) $(LUFA_SRC_SERIAL) -LUFA_PATH = ../../../../LUFA -CC_FLAGS = -DUSE_LUFA_CONFIG_HEADER -IConfig/ -LD_FLAGS = - -# Default target -all: - -# Include LUFA build script makefiles -include $(LUFA_PATH)/Build/lufa_core.mk -include $(LUFA_PATH)/Build/lufa_sources.mk -include $(LUFA_PATH)/Build/lufa_build.mk -include $(LUFA_PATH)/Build/lufa_cppcheck.mk -include $(LUFA_PATH)/Build/lufa_doxygen.mk -include $(LUFA_PATH)/Build/lufa_dfu.mk -include $(LUFA_PATH)/Build/lufa_hid.mk -include $(LUFA_PATH)/Build/lufa_avrdude.mk -include $(LUFA_PATH)/Build/lufa_atprogram.mk |