sergiotarxz/nuttx
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

drivers/usbdev: Add RNDIS-over-USB driver

Browse Source
This commit is contained in:
Sakari Kapanen 2017-09-24 07:24:34 -06:00 committed by Gregory Nutt
parent d0f72617ef
commit 67e9e1efb6
5 changed files with 2794 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
drivers/usbdev/Kconfig
View File

@ -659,3 +659,11 @@ config USBMSC_SCSI_STACKSIZE
is not tuned.
endif
menuconfig RNDIS
bool "RNDIS Ethernet-over-USB"
default n
---help---
References:
"MS-RNDIS: Remote Network Driver Interface Specification (RNDIS) Protocol"
"Remote NDIS To USB Mapping"

4
drivers/usbdev/Make.defs
View File

@ -57,6 +57,10 @@ ifeq ($(CONFIG_USBDEV_TRACE_STRINGS),y)
CSRCS += usbdev_strings.c
endif
ifeq ($(CONFIG_RNDIS),y)
CSRCS += rndis.c
endif
CSRCS += usbdev_trace.c usbdev_trprintf.c
# Include USB device build support

2481
drivers/usbdev/rndis.c Normal file
View File

File diff suppressed because it is too large Load Diff

215
drivers/usbdev/rndis_std.h Normal file
View File

@ -0,0 +1,215 @@
/****************************************************************************
* drivers/usbdev/rndis.c
*
* Copyright (C) 2011-2017 Gregory Nutt. All rights reserved.
* Authors: Sakari Kapanen <sakari.m.kapanen@gmail.com>,
* Petteri Aimonen <jpa@git.mail.kapsi.fi>
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* 3. Neither the name NuttX nor the names of its contributors may be
* used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
****************************************************************************/
#ifndef __NUTTX_DRIVERS_USBDEV_RNDIS_STD_H
#define __NUTTX_DRIVERS_USBDEV_RNDIS_STD_H
/****************************************************************************
* Pre-processor definitions
****************************************************************************/
/* Definitions for Microsoft RNDIS protocol.
* Documentation:
* https://docs.microsoft.com/en-us/windows-hardware/drivers/network/remote-ndis--rndis-2
* https://winprotocoldoc.blob.core.windows.net/productionwindowsarchives/WinArchive/[MS-RNDIS].pdf
*/
#define RNDIS_MAJOR_VERSION 1
#define RNDIS_MINOR_VERSION 0
#define RNDIS_DEVICEFLAGS 0x00000001
#define RNDIS_MEDIUM_802_3 0x00000000
/* Message types */
#define RNDIS_MSG_COMPLETE 0x80000000
#define RNDIS_PACKET_MSG 0x00000001
#define RNDIS_INITIALIZE_MSG 0x00000002
#define RNDIS_HALT_MSG 0x00000003
#define RNDIS_QUERY_MSG 0x00000004
#define RNDIS_SET_MSG 0x00000005
#define RNDIS_RESET_MSG 0x00000006
#define RNDIS_INDICATE_MSG 0x00000007
#define RNDIS_KEEPALIVE_MSG 0x00000008
/* Status codes */
#define RNDIS_STATUS_SUCCESS 0x00000000
#define RNDIS_STATUS_FAILURE 0xC0000001
#define RNDIS_STATUS_NOT_SUPPORTED 0xC00000BB
/* ObjectIDs for query commands */
#define RNDIS_OID_GEN_SUPPORTED_LIST 0x00010101
#define RNDIS_OID_GEN_HARDWARE_STATUS 0x00010102
#define RNDIS_OID_GEN_MEDIA_SUPPORTED 0x00010103
#define RNDIS_OID_GEN_MEDIA_IN_USE 0x00010104
#define RNDIS_OID_GEN_MAXIMUM_FRAME_SIZE 0x00010106
#define RNDIS_OID_GEN_LINK_SPEED 0x00010107
#define RNDIS_OID_GEN_TRANSMIT_BLOCK_SIZE 0x0001010A
#define RNDIS_OID_GEN_RECEIVE_BLOCK_SIZE 0x0001010B
#define RNDIS_OID_GEN_VENDOR_ID 0x0001010C
#define RNDIS_OID_GEN_VENDOR_DESCRIPTION 0x0001010D
#define RNDIS_OID_GEN_VENDOR_DRIVER_VERSION 0x00010116
#define RNDIS_OID_GEN_CURRENT_PACKET_FILTER 0x0001010E
#define RNDIS_OID_GEN_MAXIMUM_TOTAL_SIZE 0x00010111
#define RNDIS_OID_GEN_MEDIA_CONNECT_STATUS 0x00010114
#define RNDIS_OID_GEN_PHYSICAL_MEDIUM 0x00010202
#define RNDIS_OID_GEN_XMIT_OK 0x00020101
#define RNDIS_OID_GEN_RCV_OK 0x00020102
#define RNDIS_OID_GEN_XMIT_ERROR 0x00020103
#define RNDIS_OID_GEN_RCV_ERROR 0x00020104
#define RNDIS_OID_GEN_RCV_NO_BUFFER 0x00020105
#define RNDIS_OID_802_3_PERMANENT_ADDRESS 0x01010101
#define RNDIS_OID_802_3_CURRENT_ADDRESS 0x01010102
#define RNDIS_OID_802_3_MULTICAST_LIST 0x01010103
#define RNDIS_OID_802_3_MAXIMUM_LIST_SIZE 0x01010104
#define RNDIS_OID_802_3_MAC_OPTIONS 0x01010105
#define RNDIS_OID_802_3_RCV_ERROR_ALIGNMENT 0x01020101
#define RNDIS_OID_802_3_XMIT_ONE_COLLISION 0x01020102
#define RNDIS_OID_802_3_XMIT_MORE_COLLISION 0x01020103
#define RNDIS_SEND_ENCAPSULATED_COMMAND 0x00
#define RNDIS_GET_ENCAPSULATED_RESPONSE 0x01
#define RNDIS_NOTIFICATION_RESPONSE_AVAILABLE 0x01
/****************************************************************************
* Public types
****************************************************************************/
struct rndis_notification
{
uint32_t Notification;
uint32_t Reserved;
};
struct rndis_command_header
{
uint32_t MessageType;
uint32_t MessageLength;
uint32_t RequestID;
};
struct rndis_response_header
{
uint32_t MessageType;
uint32_t MessageLength;
uint32_t RequestID;
uint32_t Status;
};
struct rndis_initialize_msg
{
struct rndis_command_header hdr;
uint32_t MajorVersion;
uint32_t MinorVersion;
uint32_t MaxTransferSize;
};
struct rndis_initialize_cmplt
{
struct rndis_response_header hdr;
uint32_t MajorVersion;
uint32_t MinorVersion;
uint32_t DeviceFlags;
uint32_t Medium;
uint32_t MaxPacketsPerTransfer;
uint32_t MaxTransferSize;
uint32_t PacketAlignmentFactor;
uint32_t Reserved1;
uint32_t Reserved2;
};
struct rndis_query_msg
{
struct rndis_command_header hdr;
uint32_t ObjectID;
uint32_t InformationBufferLength;
uint32_t InformationBufferOffset;
uint32_t Reserved;
uint32_t Buffer[];
};
struct rndis_query_cmplt
{
struct rndis_response_header hdr;
uint32_t InformationBufferLength;
uint32_t InformationBufferOffset;
uint32_t Buffer[];
};
struct rndis_set_msg
{
struct rndis_command_header hdr;
uint32_t ObjectID;
uint32_t InformationBufferLength;
uint32_t InformationBufferOffset;
uint32_t Reserved;
uint32_t Buffer[];
};
struct rndis_reset_cmplt
{
struct rndis_response_header hdr;
uint32_t AddressingReset;
};
struct rndis_indicate_msg
{
uint32_t MessageType;
uint32_t MessageLength;
uint32_t Status;
uint32_t StatusBufferLength;
uint32_t StatusBufferOffset;
uint32_t Buffer[];
};
struct rndis_packet_msg
{
uint32_t MessageType;
uint32_t MessageLength;
uint32_t DataOffset;
uint32_t DataLength;
uint32_t OutOfBandDataOffset;
uint32_t OutOfBandDataLength;
uint32_t NumOutOfBandDataElements;
uint32_t PerPacketInfoOffset;
uint32_t PerPacketInfoLength;
};
#endif

86
include/nuttx/usb/rndis.h Normal file
View File

@ -0,0 +1,86 @@
/************************************************************************************
* include/nuttx/usb/rndis.h
*
* Copyright (C) 2011-2017 Gregory Nutt. All rights reserved.
* Authors: Sakari Kapanen <sakari.m.kapanen@gmail.com>,
Petteri Aimonen <jpa@git.mail.kapsi.fi>
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* 3. Neither the name NuttX nor the names of its contributors may be
* used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
************************************************************************************/
#ifndef __INCLUDE_NUTTX_USB_RNDIS_H
#define __INCLUDE_NUTTX_USB_RNDIS_H
/************************************************************************************
* Included Files
************************************************************************************/
#include <nuttx/config.h>
/************************************************************************************
* Public Data
************************************************************************************/
#undef EXTERN
#if defined(__cplusplus)
# define EXTERN extern "C"
extern "C"
{
#else
# define EXTERN extern
#endif
/************************************************************************************
* Public Functions
************************************************************************************/
/************************************************************************************
* Name: usbdev_rndis_initialize
*
* Description:
* Register RNDIS USB device interface. Register the corresponding network driver
* to NuttX and bring up the network.
*
* Parameters:
* mac_address: an array of 6 bytes which make the MAC address of the host side
* of the network.
*
* Returned Value:
* 0 on success; -errno on failure
*
************************************************************************************/
int usbdev_rndis_initialize(FAR const uint8_t *mac_address);
#undef EXTERN
#if defined(__cplusplus)
}
#endif
#endif /* __INCLUDE_NUTTX_USB_RNDIS_H */