X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/071e02c6b6b4837fa9cf0b6d4c749994e02638d7..31daf04c6a4d6ff9813b04abd131cde57ed7cdde:/Demos/Host/LowLevel/RNDISEthernetHost/Lib/RNDISCommands.h diff --git a/Demos/Host/LowLevel/RNDISEthernetHost/Lib/RNDISCommands.h b/Demos/Host/LowLevel/RNDISEthernetHost/Lib/RNDISCommands.h index 62d1c0893..f474c9bd8 100644 --- a/Demos/Host/LowLevel/RNDISEthernetHost/Lib/RNDISCommands.h +++ b/Demos/Host/LowLevel/RNDISEthernetHost/Lib/RNDISCommands.h @@ -1,7 +1,7 @@ /* LUFA Library Copyright (C) Dean Camera, 2010. - + dean [at] fourwalledcubicle [dot] com www.fourwalledcubicle.com */ @@ -9,13 +9,13 @@ /* Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com) - Permission to use, copy, modify, distribute, and sell this + 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 + 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 + permission notice and warranty disclaimer appear in supporting + documentation, and that the name of the author not be used in + advertising or publicity pertaining to distribution of the software without specific, written prior permission. The author disclaim all warranties with regard to this @@ -40,20 +40,21 @@ #include #include #include - + #include - + #include "RNDISConstants.h" + #include "../RNDISEthernetHost.h" /* Type Defines: */ - /** Type define for a RNDIS message header, sent before RNDIS messages */ + /** Type define for a RNDIS message header, sent before RNDIS messages. */ typedef struct { uint32_t MessageType; /**< RNDIS message type, a REMOTE_NDIS_*_MSG constant */ uint32_t MessageLength; /**< Total length of the RNDIS message, in bytes */ } RNDIS_Message_Header_t; - /** Type define for a RNDIS packet message, used to encapsulate Ethernet packets sent to and from the adapter */ + /** Type define for a RNDIS packet message, used to encapsulate Ethernet packets sent to and from the adapter. */ typedef struct { uint32_t MessageType; @@ -68,27 +69,27 @@ uint32_t VcHandle; uint32_t Reserved; } RNDIS_Packet_Message_t; - - /** Type define for a RNDIS Initialize command message */ + + /** Type define for a RNDIS Initialize command message. */ typedef struct { uint32_t MessageType; uint32_t MessageLength; uint32_t RequestId; - + uint32_t MajorVersion; uint32_t MinorVersion; uint32_t MaxTransferSize; } RNDIS_Initialize_Message_t; - - /** Type define for a RNDIS Initialize complete response message */ + + /** Type define for a RNDIS Initialize complete response message. */ typedef struct { uint32_t MessageType; uint32_t MessageLength; uint32_t RequestId; uint32_t Status; - + uint32_t MajorVersion; uint32_t MinorVersion; uint32_t DeviceFlags; @@ -99,8 +100,8 @@ uint32_t AFListOffset; uint32_t AFListSize; } RNDIS_Initialize_Complete_t; - - /** Type define for a RNDIS Keepalive command message */ + + /** Type define for a RNDIS Keep-alive command message. */ typedef struct { uint32_t MessageType; @@ -108,7 +109,7 @@ uint32_t RequestId; } RNDIS_KeepAlive_Message_t; - /** Type define for a RNDIS Keepalive complete message */ + /** Type define for a RNDIS Keep-alive complete message. */ typedef struct { uint32_t MessageType; @@ -117,7 +118,7 @@ uint32_t Status; } RNDIS_KeepAlive_Complete_t; - /** Type define for a RNDIS Reset complete message */ + /** Type define for a RNDIS Reset complete message. */ typedef struct { uint32_t MessageType; @@ -126,21 +127,21 @@ uint32_t AddressingReset; } RNDIS_Reset_Complete_t; - - /** Type define for a RNDIS Set command message */ + + /** Type define for a RNDIS Set command message. */ typedef struct { uint32_t MessageType; uint32_t MessageLength; uint32_t RequestId; - + uint32_t Oid; uint32_t InformationBufferLength; uint32_t InformationBufferOffset; uint32_t DeviceVcHandle; } RNDIS_Set_Message_t; - /** Type define for a RNDIS Set complete response message */ + /** Type define for a RNDIS Set complete response message. */ typedef struct { uint32_t MessageType; @@ -148,65 +149,64 @@ uint32_t RequestId; uint32_t Status; } RNDIS_Set_Complete_t; - - /** Type define for a RNDIS Query command message */ + + /** Type define for a RNDIS Query command message. */ typedef struct { uint32_t MessageType; uint32_t MessageLength; uint32_t RequestId; - + uint32_t Oid; uint32_t InformationBufferLength; uint32_t InformationBufferOffset; uint32_t DeviceVcHandle; } RNDIS_Query_Message_t; - - /** Type define for a RNDIS Query complete response message */ + + /** Type define for a RNDIS Query complete response message. */ typedef struct { uint32_t MessageType; uint32_t MessageLength; uint32_t RequestId; uint32_t Status; - + uint32_t InformationBufferLength; uint32_t InformationBufferOffset; } RNDIS_Query_Complete_t; /* Macros: */ - /** RNDIS request to issue a host-to-device NDIS command */ + /** RNDIS request to issue a host-to-device NDIS command. */ #define REQ_SendEncapsulatedCommand 0x00 - /** RNDIS request to issue a device-to-host NDIS response */ + /** RNDIS request to issue a device-to-host NDIS response. */ #define REQ_GetEncapsulatedResponse 0x01 - /** Implemented RNDIS Version Major */ + /** Implemented RNDIS Version Major. */ #define REMOTE_NDIS_VERSION_MAJOR 0x01 - /** Implemented RNDIS Version Minor */ + /** Implemented RNDIS Version Minor. */ #define REMOTE_NDIS_VERSION_MINOR 0x00 - /** Pipe number for the RNDIS data IN pipe */ - #define RNDIS_DATAPIPE_IN 1 - - /** Pipe number for the RNDIS data OUT pipe */ - #define RNDIS_DATAPIPE_OUT 2 - - /** Pipe number for the RNDIS notification pipe */ - #define RNDIS_NOTIFICATIONPIPE 3 - - /** Additional error code for RNDIS functions when a device returns a logical command failure */ + /** Additional error code for RNDIS functions when a device returns a logical command failure. */ #define RNDIS_COMMAND_FAILED 0xC0 /* Function Prototypes: */ - uint8_t RNDIS_SendEncapsulatedCommand(void* const Buffer, const uint16_t Length); - uint8_t RNDIS_GetEncapsulatedResponse(void* const Buffer, const uint16_t Length); + uint8_t RNDIS_SendEncapsulatedCommand(void* const Buffer, + const uint16_t Length); + uint8_t RNDIS_GetEncapsulatedResponse(void* const Buffer, + const uint16_t Length); uint8_t RNDIS_SendKeepAlive(void); - uint8_t RNDIS_InitializeDevice(const uint16_t HostMaxPacketSize, uint16_t* const DeviceMaxPacketSize); - uint8_t RNDIS_SetRNDISProperty(const uint32_t Oid, void* Buffer, const uint16_t Length); - uint8_t RNDIS_QueryRNDISProperty(const uint32_t Oid, void* Buffer, const uint16_t MaxLength); + uint8_t RNDIS_InitializeDevice(const uint16_t HostMaxPacketSize, + uint16_t* const DeviceMaxPacketSize); + uint8_t RNDIS_SetRNDISProperty(const uint32_t Oid, + void* Buffer, + const uint16_t Length); + uint8_t RNDIS_QueryRNDISProperty(const uint32_t Oid, + void* Buffer, + const uint16_t MaxLength); uint8_t RNDIS_GetPacketLength(uint16_t* const PacketLength); #endif +