forked from mfulz_github/qmk_firmware
5e46801096
Correct CDC Host Class driver token handling for sending data on bidirectional data endpoints.
258 lines
14 KiB
C
258 lines
14 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.
|
|
*/
|
|
|
|
/** \ingroup Group_USBClassRNDIS
|
|
* @defgroup Group_USBClassRNDISHost RNDIS Class Host Mode Driver
|
|
*
|
|
* \section Sec_Dependencies Module Source Dependencies
|
|
* The following files must be built with any user project that uses this module:
|
|
* - LUFA/Drivers/USB/Class/Host/RNDIS.c
|
|
*
|
|
* \section Module Description
|
|
* Host Mode USB Class driver framework interface, for the Microsoft RNDIS Ethernet
|
|
* USB Class driver.
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
#ifndef __RNDIS_CLASS_HOST_H__
|
|
#define __RNDIS_CLASS_HOST_H__
|
|
|
|
/* Includes: */
|
|
#include "../../USB.h"
|
|
#include "../Common/RNDIS.h"
|
|
|
|
#include <stdio.h>
|
|
#include <string.h>
|
|
|
|
/* Enable C linkage for C++ Compilers: */
|
|
#if defined(__cplusplus)
|
|
extern "C" {
|
|
#endif
|
|
|
|
/* Public Interface - May be used in end-application: */
|
|
/* Type Defines: */
|
|
/** Class state structure. An instance of this structure should be made within the user application,
|
|
* and passed to each of the RNDIS class driver functions as the RNDISInterfaceInfo parameter. This
|
|
* stores each RNDIS interface's configuration and state information.
|
|
*/
|
|
typedef struct
|
|
{
|
|
const struct
|
|
{
|
|
uint8_t DataINPipeNumber; /**< Pipe number of the RNDIS interface's IN data pipe */
|
|
bool DataINPipeDoubleBank; /** Indicates if the RNDIS interface's IN data pipe should use double banking */
|
|
|
|
uint8_t DataOUTPipeNumber; /**< Pipe number of the RNDIS interface's OUT data pipe */
|
|
bool DataOUTPipeDoubleBank; /** Indicates if the RNDIS interface's OUT data pipe should use double banking */
|
|
|
|
uint8_t NotificationPipeNumber; /**< Pipe number of the RNDIS interface's IN notification endpoint, if used */
|
|
bool NotificationPipeDoubleBank; /** Indicates if the RNDIS interface's notification pipe should use double banking */
|
|
|
|
uint32_t HostMaxPacketSize; /**< Maximum size of a packet which can be buffered by the host */
|
|
} Config; /**< Config data for the USB class interface within the device. All elements in this section
|
|
* <b>must</b> be set or the interface will fail to enumerate and operate correctly.
|
|
*/
|
|
struct
|
|
{
|
|
bool IsActive; /**< Indicates if the current interface instance is connected to an attached device, valid
|
|
* after \ref RNDIS_Host_ConfigurePipes() is called and the Host state machine is in the
|
|
* Configured state
|
|
*/
|
|
uint8_t ControlInterfaceNumber; /**< Interface index of the RNDIS control interface within the attached device */
|
|
|
|
uint16_t DataINPipeSize; /**< Size in bytes of the RNDIS interface's IN data pipe */
|
|
uint16_t DataOUTPipeSize; /**< Size in bytes of the RNDIS interface's OUT data pipe */
|
|
uint16_t NotificationPipeSize; /**< Size in bytes of the RNDIS interface's IN notification pipe, if used */
|
|
|
|
bool BidirectionalDataEndpoints; /**< Indicates if the attached RNDIS interface uses bidirectional data endpoints,
|
|
* and this has only the IN pipe configured (with \ref Pipe_SetPipeToken()
|
|
* used to switch the pipe's direction)
|
|
*/
|
|
uint32_t DeviceMaxPacketSize; /**< Maximum size of a packet which can be buffered by the attached RNDIS device */
|
|
|
|
uint32_t RequestID; /**< Request ID counter to give a unique ID for each command/response pair */
|
|
} State; /**< State data for the USB class interface within the device. All elements in this section
|
|
* <b>may</b> be set to initial values, but may also be ignored to default to sane values when
|
|
* the interface is enumerated.
|
|
*/
|
|
} USB_ClassInfo_RNDIS_Host_t;
|
|
|
|
/* Enums: */
|
|
/** Enum for the possible error codes returned by the \ref RNDIS_Host_ConfigurePipes() function. */
|
|
enum RNDISHost_EnumerationFailure_ErrorCodes_t
|
|
{
|
|
RNDIS_ENUMERROR_NoError = 0, /**< Configuration Descriptor was processed successfully */
|
|
RNDIS_ENUMERROR_InvalidConfigDescriptor = 1, /**< The device returned an invalid Configuration Descriptor */
|
|
RNDIS_ENUMERROR_NoRNDISInterfaceFound = 2, /**< A compatible RNDIS interface was not found in the device's Configuration Descriptor */
|
|
RNDIS_ENUMERROR_EndpointsNotFound = 3, /**< Compatible RNDIS endpoints were not found in the device's RNDIS interface */
|
|
};
|
|
|
|
/* Macros: */
|
|
/** Additional error code for RNDIS functions when a device returns a logical command failure */
|
|
#define RNDIS_COMMAND_FAILED 0xC0
|
|
|
|
/* Function Prototypes: */
|
|
/** General management task for a given RNDIS host class interface, required for the correct operation of the interface. This should
|
|
* be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().
|
|
*
|
|
* \param[in,out] RNDISInterfaceInfo Pointer to a structure containing an RNDIS Class host configuration and state
|
|
*/
|
|
void RNDIS_Host_USBTask(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
|
|
|
|
/** Host interface configuration routine, to configure a given RNDIS host interface instance using the Configuration
|
|
* Descriptor read from an attached USB device. This function automatically updates the given RNDIS Host instance's
|
|
* state values and configures the pipes required to communicate with the interface if it is found within the device.
|
|
* This should be called once after the stack has enumerated the attached device, while the host state machine is in
|
|
* the Addressed state.
|
|
*
|
|
* \param[in,out] RNDISInterfaceInfo Pointer to a structure containing an RNDIS Class host configuration and state
|
|
* \param[in] ConfigDescriptorSize Length of the attached device's Configuration Descriptor
|
|
* \param[in] DeviceConfigDescriptor Pointer to a buffer containing the attached device's Configuration Descriptor
|
|
*
|
|
* \return A value from the \ref RNDISHost_EnumerationFailure_ErrorCodes_t enum
|
|
*/
|
|
uint8_t RNDIS_Host_ConfigurePipes(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo, uint16_t ConfigDescriptorSize,
|
|
void* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);
|
|
|
|
/** Sends a RNDIS KEEPALIVE command to the device, to ensure that it does not enter standby mode after periods
|
|
* of long inactivity.
|
|
*
|
|
* \param[in,out] RNDISInterfaceInfo Pointer to a structure containing an RNDIS Class host configuration and state
|
|
*
|
|
* \return A value from the USB_Host_SendControlErrorCodes_t enum or RNDIS_COMMAND_FAILED if the device returned a
|
|
* logical command failure
|
|
*/
|
|
uint8_t RNDIS_Host_SendKeepAlive(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
|
|
|
|
/** Initializes the attached RNDIS device's RNDIS interface. This should be called after the device's pipes have been
|
|
* configured via the call to \ref RNDIS_Host_ConfigurePipes().
|
|
*
|
|
* \param[in,out] RNDISInterfaceInfo Pointer to a structure containing an RNDIS Class host configuration and state
|
|
*
|
|
* \return A value from the USB_Host_SendControlErrorCodes_t enum or RNDIS_COMMAND_FAILED if the device returned a
|
|
* logical command failure
|
|
*/
|
|
uint8_t RNDIS_Host_InitializeDevice(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
|
|
|
|
/** Sets a given RNDIS property of an attached RNDIS device.
|
|
*
|
|
* \param[in,out] RNDISInterfaceInfo Pointer to a structure containing an RNDIS Class host configuration and state
|
|
* \param[in] Oid OID number of the parameter to set
|
|
* \param[in] Buffer Pointer to where the property data is to be sourced from
|
|
* \param[in] Length Length in bytes of the property data to sent to the device
|
|
*
|
|
* \return A value from the USB_Host_SendControlErrorCodes_t enum or RNDIS_COMMAND_FAILED if the device returned a
|
|
* logical command failure
|
|
*/
|
|
uint8_t RNDIS_Host_SetRNDISProperty(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo, uint32_t Oid, void* Buffer,
|
|
uint16_t Length) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);
|
|
|
|
/** Gets a given RNDIS property of an attached RNDIS device.
|
|
*
|
|
* \param[in,out] RNDISInterfaceInfo Pointer to a structure containing an RNDIS Class host configuration and state
|
|
* \param[in] Oid OID number of the parameter to get
|
|
* \param[in] Buffer Pointer to where the property data is to be written to
|
|
* \param[in] MaxLength Length in bytes of the destination buffer size
|
|
*
|
|
* \return A value from the USB_Host_SendControlErrorCodes_t enum or RNDIS_COMMAND_FAILED if the device returned a
|
|
* logical command failure
|
|
*/
|
|
uint8_t RNDIS_Host_QueryRNDISProperty(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo, uint32_t Oid, void* Buffer,
|
|
uint16_t MaxLength) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);
|
|
|
|
/** Determines if a packet is currently waiting for the host to read in and process.
|
|
*
|
|
* \param[in,out] RNDISInterfaceInfo Pointer to a structure containing an RNDIS Class host configuration and state
|
|
*
|
|
* \return Boolean true if a packet is waiting to be read in by the host, false otherwise
|
|
*/
|
|
|
|
bool RNDIS_Host_IsPacketReceived(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo);
|
|
|
|
/** Retrieves the next pending packet from the device, discarding the remainder of the RNDIS packet header to leave
|
|
* only the packet contents for processing by the host in the nominated buffer.
|
|
*
|
|
* \param[in,out] RNDISInterfaceInfo Pointer to a structure containing an RNDIS Class host configuration and state
|
|
* \param[out] Buffer Pointer to a buffer where the packer data is to be written to
|
|
* \param[out] PacketLength Pointer to where the length in bytes of the read packet is to be stored
|
|
*
|
|
* \return A value from the Pipe_Stream_RW_ErrorCodes_t enum
|
|
*/
|
|
uint8_t RNDIS_Host_ReadPacket(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo, void* Buffer, uint16_t* PacketLength)
|
|
ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2) ATTR_NON_NULL_PTR_ARG(3);
|
|
|
|
/** Sends the given packet to the attached RNDIS device, after adding a RNDIS packet message header.
|
|
*
|
|
* \param[in,out] RNDISInterfaceInfo Pointer to a structure containing an RNDIS Class host configuration and state
|
|
* \param[in] Buffer Pointer to a buffer where the packer data is to be read from
|
|
* \param[in] PacketLength Length in bytes of the packet to send
|
|
*
|
|
* \return A value from the Pipe_Stream_RW_ErrorCodes_t enum
|
|
*/
|
|
uint8_t RNDIS_Host_SendPacket(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo, void* Buffer, uint16_t PacketLength)
|
|
ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
|
|
|
|
/* Private Interface - For use in library only: */
|
|
#if !defined(__DOXYGEN__)
|
|
/* Macros: */
|
|
#define RNDIS_CONTROL_CLASS 0x02
|
|
#define RNDIS_CONTROL_SUBCLASS 0x02
|
|
#define RNDIS_CONTROL_PROTOCOL 0xFF
|
|
#define RNDIS_DATA_CLASS 0x0A
|
|
#define RNDIS_DATA_SUBCLASS 0x00
|
|
#define RNDIS_DATA_PROTOCOL 0x00
|
|
|
|
#define RNDIS_FOUND_DATAPIPE_IN (1 << 0)
|
|
#define RNDIS_FOUND_DATAPIPE_OUT (1 << 1)
|
|
#define RNDIS_FOUND_NOTIFICATION_IN (1 << 2)
|
|
|
|
/* Function Prototypes: */
|
|
#if defined(INCLUDE_FROM_RNDIS_CLASS_HOST_C)
|
|
static uint8_t RNDIS_SendEncapsulatedCommand(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo,
|
|
void* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);
|
|
static uint8_t RNDIS_GetEncapsulatedResponse(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo,
|
|
void* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);
|
|
|
|
static uint8_t DComp_RNDIS_Host_NextRNDISControlInterface(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);
|
|
static uint8_t DComp_RNDIS_Host_NextRNDISDataInterface(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);
|
|
static uint8_t DComp_RNDIS_Host_NextRNDISInterfaceEndpoint(void* const CurrentDescriptor);
|
|
#endif
|
|
#endif
|
|
|
|
/* Disable C linkage for C++ Compilers: */
|
|
#if defined(__cplusplus)
|
|
}
|
|
#endif
|
|
|
|
#endif
|
|
|
|
/** @} */
|