mirror of
https://github.com/mfulz/qmk_firmware.git
synced 2025-10-31 21:32:31 +01:00
227 lines
6.6 KiB
C
227 lines
6.6 KiB
C
/*
|
|
LUFA Library
|
|
Copyright (C) Dean Camera, 2009.
|
|
|
|
dean [at] fourwalledcubicle [dot] com
|
|
www.fourwalledcubicle.com
|
|
*/
|
|
|
|
/*
|
|
Copyright 2009 Dean Camera (dean [at] fourwalledcubicle [dot] com)
|
|
|
|
Permission to use, copy, modify, and distribute this software
|
|
and its documentation for any purpose and without fee is hereby
|
|
granted, provided that the above copyright notice appear in all
|
|
copies and that both that the copyright notice and this
|
|
permission notice and warranty disclaimer appear in supporting
|
|
documentation, and that the name of the author not be used in
|
|
advertising or publicity pertaining to distribution of the
|
|
software without specific, written prior permission.
|
|
|
|
The author disclaim all warranties with regard to this
|
|
software, including all implied warranties of merchantability
|
|
and fitness. In no event shall the author be liable for any
|
|
special, indirect or consequential damages or any damages
|
|
whatsoever resulting from loss of use, data or profits, whether
|
|
in an action of contract, negligence or other tortious action,
|
|
arising out of or in connection with the use or performance of
|
|
this software.
|
|
*/
|
|
|
|
/** \file
|
|
*
|
|
* Header file for RNDIS.c.
|
|
*/
|
|
|
|
#ifndef _RNDIS_H_
|
|
#define _RNDIS_H_
|
|
|
|
/* Includes: */
|
|
#include <avr/io.h>
|
|
#include <stdbool.h>
|
|
|
|
#include "RNDISEthernet.h"
|
|
#include "RNDISConstants.h"
|
|
#include "Ethernet.h"
|
|
|
|
/* Macros: */
|
|
/** Physical MAC Address of the USB network adapter */
|
|
#define ADAPTER_MAC_ADDRESS {0x02, 0x00, 0x02, 0x00, 0x02, 0x00}
|
|
|
|
/** Implemented RNDIS Version Major */
|
|
#define REMOTE_NDIS_VERSION_MAJOR 0x01
|
|
|
|
/** Implemented RNDIS Version Minor */
|
|
#define REMOTE_NDIS_VERSION_MINOR 0x00
|
|
|
|
/** 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
|
|
|
|
/* Enums: */
|
|
/** Enum for the possible NDIS adapter states. */
|
|
enum RNDIS_States_t
|
|
{
|
|
RNDIS_Uninitialized = 0, /**< Adapter currently uninitialized */
|
|
RNDIS_Initialized = 1, /**< Adapter currently initialized but not ready for data transfers */
|
|
RNDIS_Data_Initialized = 2, /**< Adapter currently initialized and ready for data transfers */
|
|
};
|
|
|
|
/** Enum for the NDIS hardware states */
|
|
enum NDIS_Hardware_Status_t
|
|
{
|
|
NdisHardwareStatusReady, /**< Hardware Ready to accept commands from the host */
|
|
NdisHardwareStatusInitializing, /**< Hardware busy initializing */
|
|
NdisHardwareStatusReset, /**< Hardware reset */
|
|
NdisHardwareStatusClosing, /**< Hardware currently closing */
|
|
NdisHardwareStatusNotReady /**< Hardware not ready to accept commands from the host */
|
|
};
|
|
|
|
/* 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_MSG_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_MSG_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_CMPLT_t;
|
|
|
|
/** Type define for a RNDIS Keepalive command message */
|
|
typedef struct
|
|
{
|
|
uint32_t MessageType;
|
|
uint32_t MessageLength;
|
|
uint32_t RequestId;
|
|
} RNDIS_KEEPALIVE_MSG_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_CMPLT_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_CMPLT_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_MSG_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_CMPLT_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_MSG_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_CMPLT_t;
|
|
|
|
/* External Variables: */
|
|
extern uint8_t RNDISMessageBuffer[];
|
|
extern RNDIS_Message_Header_t* MessageHeader;
|
|
extern bool ResponseReady;
|
|
extern uint8_t CurrRNDISState;
|
|
|
|
/* Function Prototypes: */
|
|
void ProcessRNDISControlMessage(void);
|
|
|
|
#if defined(INCLUDE_FROM_RNDIS_C)
|
|
static bool ProcessNDISQuery(uint32_t OId, void* QueryData, uint16_t QuerySize,
|
|
void* ResponseData, uint16_t* ResponseSize);
|
|
static bool ProcessNDISSet(uint32_t OId, void* SetData, uint16_t SetSize);
|
|
#endif
|
|
|
|
#endif
|