|
|
|
/*
|
|
|
|
LUFA Library
|
|
|
|
Copyright (C) Dean Camera, 2010.
|
|
|
|
|
|
|
|
dean [at] fourwalledcubicle [dot] com
|
|
|
|
www.fourwalledcubicle.com
|
|
|
|
*/
|
|
|
|
|
|
|
|
/*
|
|
|
|
Copyright 2010 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 disclaim all warranties with regard to this
|
|
|
|
software, including all implied warranties of merchantability
|
|
|
|
and fitness. In no event shall the author be liable for any
|
|
|
|
special, indirect or consequential damages or any damages
|
|
|
|
whatsoever resulting from loss of use, data or profits, whether
|
|
|
|
in an action of contract, negligence or other tortious action,
|
|
|
|
arising out of or in connection with the use or performance of
|
|
|
|
this software.
|
|
|
|
*/
|
|
|
|
|
|
|
|
/** \file
|
|
|
|
*
|
|
|
|
* Header file for RNDISCommands.c.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef _RNDIS_COMMANDS_H_
|
|
|
|
#define _RNDIS_COMMANDS_H_
|
|
|
|
|
|
|
|
/* Includes: */
|
|
|
|
#include <avr/io.h>
|
|
|
|
#include <stdio.h>
|
|
|
|
#include <string.h>
|
|
|
|
|
|
|
|
#include <LUFA/Drivers/USB/USB.h>
|
|
|
|
|
|
|
|
#include "RNDISConstants.h"
|
|
|
|
|
|
|
|
/* Type Defines: */
|
|
|
|
/** 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 */
|
|
|
|
typedef struct
|
|
|
|
{
|
|
|
|
uint32_t MessageType;
|
|
|
|
uint32_t MessageLength;
|
|
|
|
uint32_t DataOffset;
|
|
|
|
uint32_t DataLength;
|
|
|
|
uint32_t OOBDataOffset;
|
|
|
|
uint32_t OOBDataLength;
|
|
|
|
uint32_t NumOOBDataElements;
|
|
|
|
uint32_t PerPacketInfoOffset;
|
|
|
|
uint32_t PerPacketInfoLength;
|
|
|
|
uint32_t VcHandle;
|
|
|
|
uint32_t Reserved;
|
|
|
|
} RNDIS_Packet_Message_t;
|
|
|
|
|
|
|
|
/** 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 */
|
|
|
|
typedef struct
|
|
|
|
{
|
|
|
|
uint32_t MessageType;
|
|
|
|
uint32_t MessageLength;
|
|
|
|
uint32_t RequestId;
|
|
|
|
uint32_t Status;
|
|
|
|
|
|
|
|
uint32_t MajorVersion;
|
|
|
|
uint32_t MinorVersion;
|
|
|
|
uint32_t DeviceFlags;
|
|
|
|
uint32_t Medium;
|
|
|
|
uint32_t MaxPacketsPerTransfer;
|
|
|
|
uint32_t MaxTransferSize;
|
|
|
|
uint32_t PacketAlignmentFactor;
|
|
|
|
uint32_t AFListOffset;
|
|
|
|
uint32_t AFListSize;
|
|
|
|
} RNDIS_Initialize_Complete_t;
|
|
|
|
|
|
|
|
/** Type define for a RNDIS Keepalive command message */
|
|
|
|
typedef struct
|
|
|
|
{
|
|
|
|
uint32_t MessageType;
|
|
|
|
uint32_t MessageLength;
|
|
|
|
uint32_t RequestId;
|
|
|
|
} RNDIS_KeepAlive_Message_t;
|
|
|
|
|
|
|
|
/** Type define for a RNDIS Keepalive complete message */
|
|
|
|
typedef struct
|
|
|
|
{
|
|
|
|
uint32_t MessageType;
|
|
|
|
uint32_t MessageLength;
|
|
|
|
uint32_t RequestId;
|
|
|
|
uint32_t Status;
|
|
|
|
} RNDIS_KeepAlive_Complete_t;
|
|
|
|
|
|
|
|
/** Type define for a RNDIS Reset complete message */
|
|
|
|
typedef struct
|
|
|
|
{
|
|
|
|
uint32_t MessageType;
|
|
|
|
uint32_t MessageLength;
|
|
|
|
uint32_t Status;
|
|
|
|
|
|
|
|
uint32_t AddressingReset;
|
|
|
|
} RNDIS_Reset_Complete_t;
|
|
|
|
|
|
|
|
/** 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 */
|
|
|
|
typedef struct
|
|
|
|
{
|
|
|
|
uint32_t MessageType;
|
|
|
|
uint32_t MessageLength;
|
|
|
|
uint32_t RequestId;
|
|
|
|
uint32_t Status;
|
|
|
|
} RNDIS_Set_Complete_t;
|
|
|
|
|
|
|
|
/** 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 */
|
|
|
|
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 */
|
|
|
|
#define REQ_SendEncapsulatedCommand 0x00
|
|
|
|
|
|
|
|
/** RNDIS request to issue a device-to-host NDIS response */
|
|
|
|
#define REQ_GetEncapsulatedResponse 0x01
|
|
|
|
|
|
|
|
/** Implemented RNDIS Version Major */
|
|
|
|
#define REMOTE_NDIS_VERSION_MAJOR 0x01
|
|
|
|
|
|
|
|
/** 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 */
|
|
|
|
#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_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_GetPacketLength(uint16_t* const PacketLength);
|
|
|
|
|
|
|
|
#endif
|