Remote Network Driver Interface Specification. More...

#include <stdint.h>
#include <ipxe/netdevice.h>
#include <ipxe/iobuf.h>

Data Structures
struct	rndis_header
	RNDIS message header. More...
struct	rndis_initialise_message
	RNDIS initialise message. More...
struct	rndis_initialise_completion
	RNDIS initialise completion. More...
struct	rndis_halt_message
	RNDIS halt message. More...
struct	rndis_oid_message
	RNDIS query or set OID message. More...
struct	rndis_query_completion
	RNDIS query OID completion. More...
struct	rndis_set_completion
	RNDIS set OID completion. More...
struct	rndis_reset_message
	RNDIS reset message. More...
struct	rndis_reset_completion
	RNDIS reset completion. More...
struct	rndis_diagnostic_info
	RNDIS diagnostic information. More...
struct	rndis_indicate_status_message
	RNDIS indicate status message. More...
struct	rndis_keepalive_message
	RNDIS keepalive message. More...
struct	rndis_keepalive_completion
	RNDIS keepalive completion. More...
struct	rndis_packet_field
	RNDIS packet field. More...
struct	rndis_packet_message
	RNDIS packet message. More...
struct	rndis_packet_record
	RNDIS packet record. More...
struct	rndis_operations
	RNDIS device operations. More...
struct	rndis_device
	An RNDIS device. More...

Macros
#define	RNDIS_MAX_WAIT_MS 1000
	Maximum time to wait for a transaction to complete.
#define	RNDIS_INITIALISE_MSG 0x00000002UL
	RNDIS initialise message.
#define	RNDIS_INIT_ID 0xe110e110UL
	Request ID used for initialisation.
#define	RNDIS_VERSION_MAJOR 1
	RNDIS major version.
#define	RNDIS_VERSION_MINOR 0
	RNDIS minor version.
#define	RNDIS_MTU 2048
	RNDIS maximum transfer size.
#define	RNDIS_INITIALISE_CMPLT 0x80000002UL
	RNDIS initialise completion.
#define	RNDIS_HALT_MSG 0x00000003UL
	RNDIS halt message.
#define	RNDIS_QUERY_MSG 0x00000004UL
	RNDIS query OID message.
#define	RNDIS_SET_MSG 0x00000005UL
	RNDIS set OID message.
#define	RNDIS_QUERY_CMPLT 0x80000004UL
	RNDIS query OID completion.
#define	RNDIS_SET_CMPLT 0x80000005UL
	RNDIS set OID completion.
#define	RNDIS_RESET_MSG 0x00000006UL
	RNDIS reset message.
#define	RNDIS_RESET_CMPLT 0x80000006UL
	RNDIS reset completion.
#define	RNDIS_INDICATE_STATUS_MSG 0x00000007UL
	RNDIS indicate status message.
#define	RNDIS_KEEPALIVE_MSG 0x00000008UL
	RNDIS keepalive message.
#define	RNDIS_KEEPALIVE_CMPLT 0x80000008UL
	RNDIS keepalive completion.
#define	RNDIS_PACKET_MSG 0x00000001UL
	RNDIS packet message.
#define	RNDIS_OID_GEN_CURRENT_PACKET_FILTER 0x0001010eUL
	OID for packet filter.
#define	RNDIS_OID_GEN_MEDIA_CONNECT_STATUS 0x00010114UL
	OID for media status.
#define	RNDIS_OID_802_3_PERMANENT_ADDRESS 0x01010101UL
	OID for permanent MAC address.
#define	RNDIS_OID_802_3_CURRENT_ADDRESS 0x01010102UL
	OID for current MAC address.

Enumerations
enum	rndis_status { RNDIS_STATUS_MEDIA_CONNECT = 0x4001000bUL , RNDIS_STATUS_MEDIA_DISCONNECT = 0x4001000cUL , RNDIS_STATUS_WTF_WORLD = 0x40020006UL }
	RNDIS status codes. More...
enum	rndis_packet_filter { RNDIS_FILTER_UNICAST = 0x00000001UL , RNDIS_FILTER_MULTICAST = 0x00000002UL , RNDIS_FILTER_ALL_MULTICAST = 0x00000004UL , RNDIS_FILTER_BROADCAST = 0x00000008UL , RNDIS_FILTER_PROMISCUOUS = 0x00000020UL }
	Packet filter bits. More...

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	FILE_SECBOOT (PERMITTED)
static void	rndis_init (struct rndis_device rndis, struct rndis_operations op)
	Initialise an RNDIS device.
void	rndis_tx_complete_err (struct rndis_device rndis, struct io_buffer iobuf, int rc)
	Complete message transmission.
int	rndis_tx_defer (struct rndis_device rndis, struct io_buffer iobuf)
	Defer transmitted packet.
void	rndis_rx (struct rndis_device rndis, struct io_buffer iobuf)
	Receive packet from underlying transport layer.
void	rndis_rx_err (struct rndis_device rndis, struct io_buffer iobuf, int rc)
	Discard packet from underlying transport layer.
struct rndis_device *	alloc_rndis (size_t priv_len)
	Allocate RNDIS device.
int	register_rndis (struct rndis_device *rndis)
	Register RNDIS device.
void	unregister_rndis (struct rndis_device *rndis)
	Unregister RNDIS device.
void	free_rndis (struct rndis_device *rndis)
	Free RNDIS device.
static void	rndis_tx_complete (struct rndis_device rndis, struct io_buffer iobuf)
	Complete message transmission.

Detailed Description

Remote Network Driver Interface Specification.

Definition in file rndis.h.

Macro Definition Documentation

◆ RNDIS_MAX_WAIT_MS

#define RNDIS_MAX_WAIT_MS 1000

Maximum time to wait for a transaction to complete.

This is a policy decision.

Definition at line 21 of file rndis.h.

Referenced by rndis_wait().

◆ RNDIS_INITIALISE_MSG

#define RNDIS_INITIALISE_MSG 0x00000002UL

RNDIS initialise message.

Definition at line 32 of file rndis.h.

Referenced by rndis_tx_initialise().

◆ RNDIS_INIT_ID

#define RNDIS_INIT_ID 0xe110e110UL

Request ID used for initialisation.

This is a policy decision.

Definition at line 50 of file rndis.h.

Referenced by rndis_initialise().

◆ RNDIS_VERSION_MAJOR

#define RNDIS_VERSION_MAJOR 1

RNDIS major version.

Definition at line 53 of file rndis.h.

Referenced by rndis_tx_initialise().

◆ RNDIS_VERSION_MINOR

#define RNDIS_VERSION_MINOR 0

RNDIS minor version.

Definition at line 56 of file rndis.h.

Referenced by rndis_tx_initialise().

◆ RNDIS_MTU

#define RNDIS_MTU 2048

RNDIS maximum transfer size.

This is a policy decision.

Definition at line 62 of file rndis.h.

Referenced by rndis_tx_initialise().

◆ RNDIS_INITIALISE_CMPLT

#define RNDIS_INITIALISE_CMPLT 0x80000002UL

RNDIS initialise completion.

Definition at line 65 of file rndis.h.

Referenced by rndis_rx_message().

◆ RNDIS_HALT_MSG

#define RNDIS_HALT_MSG 0x00000003UL

RNDIS halt message.

Definition at line 92 of file rndis.h.

Referenced by rndis_tx_halt().

◆ RNDIS_QUERY_MSG

#define RNDIS_QUERY_MSG 0x00000004UL

RNDIS query OID message.

Definition at line 101 of file rndis.h.

Referenced by rndis_tx_oid().

◆ RNDIS_SET_MSG

#define RNDIS_SET_MSG 0x00000005UL

RNDIS set OID message.

Definition at line 104 of file rndis.h.

Referenced by rndis_tx_oid().

◆ RNDIS_QUERY_CMPLT

#define RNDIS_QUERY_CMPLT 0x80000004UL

RNDIS query OID completion.

Definition at line 121 of file rndis.h.

Referenced by rndis_rx_message().

◆ RNDIS_SET_CMPLT

#define RNDIS_SET_CMPLT 0x80000005UL

RNDIS set OID completion.

Definition at line 136 of file rndis.h.

Referenced by rndis_rx_message().

◆ RNDIS_RESET_MSG

#define RNDIS_RESET_MSG 0x00000006UL

RNDIS reset message.

Definition at line 147 of file rndis.h.

◆ RNDIS_RESET_CMPLT

#define RNDIS_RESET_CMPLT 0x80000006UL

RNDIS reset completion.

Definition at line 156 of file rndis.h.

◆ RNDIS_INDICATE_STATUS_MSG

#define RNDIS_INDICATE_STATUS_MSG 0x00000007UL

RNDIS indicate status message.

Definition at line 167 of file rndis.h.

Referenced by rndis_rx_message().

◆ RNDIS_KEEPALIVE_MSG

#define RNDIS_KEEPALIVE_MSG 0x00000008UL

RNDIS keepalive message.

Definition at line 200 of file rndis.h.

◆ RNDIS_KEEPALIVE_CMPLT

#define RNDIS_KEEPALIVE_CMPLT 0x80000008UL

RNDIS keepalive completion.

Definition at line 209 of file rndis.h.

◆ RNDIS_PACKET_MSG

#define RNDIS_PACKET_MSG 0x00000001UL

RNDIS packet message.

Definition at line 220 of file rndis.h.

Referenced by acm_transmit(), netvsc_transmit(), rndis_rx_message(), rndis_tx_complete_err(), rndis_tx_data(), and rndis_tx_defer().

◆ RNDIS_OID_GEN_CURRENT_PACKET_FILTER

#define RNDIS_OID_GEN_CURRENT_PACKET_FILTER 0x0001010eUL

OID for packet filter.

Definition at line 255 of file rndis.h.

Referenced by rndis_filter().

◆ RNDIS_OID_GEN_MEDIA_CONNECT_STATUS

#define RNDIS_OID_GEN_MEDIA_CONNECT_STATUS 0x00010114UL

OID for media status.

Definition at line 272 of file rndis.h.

Referenced by rndis_describe(), rndis_open(), and rndis_rx_query_oid().

◆ RNDIS_OID_802_3_PERMANENT_ADDRESS

#define RNDIS_OID_802_3_PERMANENT_ADDRESS 0x01010101UL

OID for permanent MAC address.

Definition at line 275 of file rndis.h.

Referenced by rndis_describe(), and rndis_rx_query_oid().

◆ RNDIS_OID_802_3_CURRENT_ADDRESS

#define RNDIS_OID_802_3_CURRENT_ADDRESS 0x01010102UL

OID for current MAC address.

Definition at line 278 of file rndis.h.

Referenced by rndis_describe(), and rndis_rx_query_oid().

Enumeration Type Documentation

◆ rndis_status

enum rndis_status

RNDIS status codes.

Enumerator
RNDIS_STATUS_MEDIA_CONNECT	Device is connected to a network medium.
RNDIS_STATUS_MEDIA_DISCONNECT	Device is disconnected from the medium.
RNDIS_STATUS_WTF_WORLD	Unknown start-of-day status code.

Definition at line 190 of file rndis.h.

                  {
        /** Device is connected to a network medium */
        RNDIS_STATUS_MEDIA_CONNECT = 0x4001000bUL,
        /** Device is disconnected from the medium */
        RNDIS_STATUS_MEDIA_DISCONNECT = 0x4001000cUL,
        /** Unknown start-of-day status code */
        RNDIS_STATUS_WTF_WORLD = 0x40020006UL,
};

◆ rndis_packet_filter

enum rndis_packet_filter

Packet filter bits.

Enumerator
RNDIS_FILTER_UNICAST	Unicast packets.
RNDIS_FILTER_MULTICAST	Multicast packets.
RNDIS_FILTER_ALL_MULTICAST	All multicast packets.
RNDIS_FILTER_BROADCAST	Broadcast packets.
RNDIS_FILTER_PROMISCUOUS	All packets.

Definition at line 258 of file rndis.h.

                         {
        /** Unicast packets */
        RNDIS_FILTER_UNICAST = 0x00000001UL,
        /** Multicast packets */
        RNDIS_FILTER_MULTICAST = 0x00000002UL,
        /** All multicast packets */
        RNDIS_FILTER_ALL_MULTICAST = 0x00000004UL,
        /** Broadcast packets */
        RNDIS_FILTER_BROADCAST = 0x00000008UL,
        /** All packets */
        RNDIS_FILTER_PROMISCUOUS = 0x00000020UL
};

Function Documentation

◆ FILE_LICENCE()

FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL )

◆ FILE_SECBOOT()

FILE_SECBOOT ( PERMITTED )

◆ rndis_init()

void rndis_init	(	struct rndis_device *	rndis,
		struct rndis_operations *	op )

inlinestatic

Initialise an RNDIS device.

Parameters

rndis	RNDIS device
op	RNDIS device operations

Definition at line 340 of file rndis.h.

                                                              {
 
        rndis->op = op;
}

References op, and rndis_device::op.

Referenced by acm_probe(), and netvsc_probe().

◆ rndis_tx_complete_err()

void rndis_tx_complete_err	(	struct rndis_device *	rndis,
		struct io_buffer *	iobuf,
		int	rc )

extern

Complete message transmission.

Parameters

rndis	RNDIS device
iobuf	I/O buffer
rc	Packet status code

Definition at line 128 of file rndis.c.

                                                               {
        struct net_device *netdev = rndis->netdev;
        struct rndis_header *header;
        size_t len = iob_len ( iobuf );
 
        /* Sanity check */
        if ( len < sizeof ( *header ) ) {
                DBGC ( rndis, "RNDIS %s completed underlength transmission:\n",
                       rndis->name );
                DBGC_HDA ( rndis, 0, iobuf->data, len );
                netdev_tx_err ( netdev, NULL, -EINVAL );
                return;
        }
        header = iobuf->data;
 
        /* Complete buffer */
        if ( header->type == cpu_to_le32 ( RNDIS_PACKET_MSG ) ) {
                netdev_tx_complete_err ( netdev, iobuf, rc );
        } else {
                free_iob ( iobuf );
        }
}

References cpu_to_le32, io_buffer::data, DBGC, DBGC_HDA, EINVAL, free_iob(), header, iob_len(), len, rndis_device::name, netdev, rndis_device::netdev, netdev_tx_complete_err(), netdev_tx_err(), NULL, rc, and RNDIS_PACKET_MSG.

Referenced by acm_out_complete(), netvsc_cancel_transmit(), and rndis_tx_complete().

◆ rndis_tx_defer()

int rndis_tx_defer	(	struct rndis_device *	rndis,
		struct io_buffer *	iobuf )

extern

Defer transmitted packet.

Parameters

rndis	RNDIS device
iobuf	I/O buffer

Return values

rc	Return status code

As with netdev_tx_defer(), the caller must ensure that space in the transmit descriptor ring is freed up before calling rndis_tx_complete().

Unlike netdev_tx_defer(), this call may fail.

Definition at line 191 of file rndis.c.

                                                                           {
        struct net_device *netdev = rndis->netdev;
        struct rndis_header *header;
        struct rndis_packet_message *msg;
 
        /* Fail unless this was a packet message.  Only packet
         * messages correspond to I/O buffers in the network device's
         * TX queue; other messages cannot be deferred in this way.
         */
        assert ( iob_len ( iobuf ) >= sizeof ( *header ) );
        header = iobuf->data;
        if ( header->type != cpu_to_le32 ( RNDIS_PACKET_MSG ) )
                return -ENOTSUP;
 
        /* Strip RNDIS header and packet message header, to return
         * this packet to the state in which we received it.
         */
        iob_pull ( iobuf, ( sizeof ( *header ) + sizeof ( *msg ) ) );
 
        /* Defer packet */
        netdev_tx_defer ( netdev, iobuf );
 
        return 0;
}

References assert, cpu_to_le32, io_buffer::data, ENOTSUP, header, iob_len(), iob_pull, msg(), netdev, rndis_device::netdev, netdev_tx_defer(), and RNDIS_PACKET_MSG.

Referenced by netvsc_transmit().

◆ rndis_rx()

void rndis_rx	(	struct rndis_device *	rndis,
		struct io_buffer *	iobuf )

extern

Receive packet from underlying transport layer.

Parameters

rndis	RNDIS device
iobuf	I/O buffer

Definition at line 830 of file rndis.c.

                                                                      {
        struct net_device *netdev = rndis->netdev;
        struct rndis_header *header;
        unsigned int type;
        int rc;
 
        /* Sanity check */
        if ( iob_len ( iobuf ) < sizeof ( *header ) ) {
                DBGC ( rndis, "RNDIS %s received underlength packet:\n",
                       rndis->name );
                DBGC_HDA ( rndis, 0, iobuf->data, iob_len ( iobuf ) );
                rc = -EINVAL;
                goto drop;
        }
        header = iobuf->data;
 
        /* Parse and strip header */
        type = le32_to_cpu ( header->type );
        iob_pull ( iobuf, sizeof ( *header ) );
 
        /* Handle message */
        rndis_rx_message ( rndis, iob_disown ( iobuf ), type );
 
        return;
 
 drop:
        /* Record error */
        netdev_rx_err ( netdev, iob_disown ( iobuf ), rc );
}

References io_buffer::data, DBGC, DBGC_HDA, EINVAL, header, iob_disown, iob_len(), iob_pull, le32_to_cpu, rndis_device::name, netdev, rndis_device::netdev, netdev_rx_err(), rc, rndis_rx_message(), and type.

Referenced by acm_control_receive(), acm_in_complete(), and netvsc_recv_data().

◆ rndis_rx_err()

void rndis_rx_err	(	struct rndis_device *	rndis,
		struct io_buffer *	iobuf,
		int	rc )

extern

Discard packet from underlying transport layer.

Parameters

rndis	RNDIS device
iobuf	I/O buffer
rc	Packet status code

Definition at line 867 of file rndis.c.

                             {
        struct net_device *netdev = rndis->netdev;
 
        /* Record error */
        netdev_rx_err ( netdev, iob_disown ( iobuf ), rc );
}

References iob_disown, netdev, rndis_device::netdev, netdev_rx_err(), and rc.

Referenced by acm_in_complete(), acm_intr_complete(), and acm_poll().

◆ alloc_rndis()

struct rndis_device * alloc_rndis ( size_t priv_len )

extern

Allocate RNDIS device.

Parameters

priv_len Length of private data

Return values

rndis RNDIS device, or NULL on allocation failure

Definition at line 1001 of file rndis.c.

                                                      {
        struct net_device *netdev;
        struct rndis_device *rndis;
 
        /* Allocate and initialise structure */
        netdev = alloc_etherdev ( sizeof ( *rndis ) + priv_len );
        if ( ! netdev )
                return NULL;
        netdev_init ( netdev, &rndis_operations );
        rndis = netdev->priv;
        rndis->netdev = netdev;
        rndis->priv = ( ( ( void * ) rndis ) + sizeof ( *rndis ) );
 
        return rndis;
}

References alloc_etherdev(), netdev, rndis_device::netdev, netdev_init(), NULL, and rndis_device::priv.

Referenced by acm_probe(), and netvsc_probe().

◆ register_rndis()

int register_rndis ( struct rndis_device * rndis )

extern

Register RNDIS device.

Parameters

rndis RNDIS device

Return values

rc	Return status code

Note that this routine will open and use the RNDIS device in order to query the MAC address. The device must be immediately ready for use prior to registration.

Definition at line 1027 of file rndis.c.

                                                  {
        struct net_device *netdev = rndis->netdev;
        int rc;
 
        /* Describe RNDIS device */
        if ( ( rc = rndis_describe ( rndis ) ) != 0 )
                goto err_describe;
 
        /* Register network device */
        if ( ( rc = register_netdev ( netdev ) ) != 0 ) {
                DBGC ( rndis, "RNDIS %s could not register: %s\n",
                       rndis->name, strerror ( rc ) );
                goto err_register;
        }
 
        return 0;
 
        unregister_netdev ( netdev );
 err_register:
 err_describe:
        return rc;
}

References DBGC, rndis_device::name, netdev, rndis_device::netdev, rc, register_netdev(), rndis_describe(), strerror(), and unregister_netdev().

Referenced by acm_probe(), and netvsc_probe().

◆ unregister_rndis()

void unregister_rndis ( struct rndis_device * rndis )

extern

Unregister RNDIS device.

Parameters

rndis RNDIS device

Definition at line 1055 of file rndis.c.

                                                     {
        struct net_device *netdev = rndis->netdev;
 
        /* Unregister network device */
        unregister_netdev ( netdev );
}

References netdev, rndis_device::netdev, and unregister_netdev().

Referenced by acm_probe(), acm_remove(), netvsc_probe(), and netvsc_remove().

◆ free_rndis()

void free_rndis ( struct rndis_device * rndis )

extern

Free RNDIS device.

Parameters

rndis RNDIS device

Definition at line 1067 of file rndis.c.

                                               {
        struct net_device *netdev = rndis->netdev;
 
        /* Free network device */
        netdev_nullify ( netdev );
        netdev_put ( netdev );
}

References netdev, rndis_device::netdev, netdev_nullify(), and netdev_put().

Referenced by acm_probe(), acm_remove(), netvsc_probe(), and netvsc_remove().

◆ rndis_tx_complete()

void rndis_tx_complete	(	struct rndis_device *	rndis,
		struct io_buffer *	iobuf )

inlinestatic

Complete message transmission.

Parameters

rndis	RNDIS device
iobuf	I/O buffer

Definition at line 365 of file rndis.h.

                                                                 {
 
        rndis_tx_complete_err ( rndis, iobuf, 0 );
}

References rndis_tx_complete_err().

Referenced by acm_control_transmit(), and netvsc_recv_completion().

Data Structures

Macros

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ RNDIS_MAX_WAIT_MS

◆ RNDIS_INITIALISE_MSG

◆ RNDIS_INIT_ID

◆ RNDIS_VERSION_MAJOR

◆ RNDIS_VERSION_MINOR

◆ RNDIS_MTU

◆ RNDIS_INITIALISE_CMPLT

◆ RNDIS_HALT_MSG

◆ RNDIS_QUERY_MSG

◆ RNDIS_SET_MSG

◆ RNDIS_QUERY_CMPLT

◆ RNDIS_SET_CMPLT

◆ RNDIS_RESET_MSG

◆ RNDIS_RESET_CMPLT

◆ RNDIS_INDICATE_STATUS_MSG

◆ RNDIS_KEEPALIVE_MSG

◆ RNDIS_KEEPALIVE_CMPLT

◆ RNDIS_PACKET_MSG

◆ RNDIS_OID_GEN_CURRENT_PACKET_FILTER

◆ RNDIS_OID_GEN_MEDIA_CONNECT_STATUS

◆ RNDIS_OID_802_3_PERMANENT_ADDRESS

◆ RNDIS_OID_802_3_CURRENT_ADDRESS

Enumeration Type Documentation

◆ rndis_status

◆ rndis_packet_filter

Function Documentation

◆ FILE_LICENCE()

◆ FILE_SECBOOT()

◆ rndis_init()

◆ rndis_tx_complete_err()

◆ rndis_tx_defer()

◆ rndis_rx()

◆ rndis_rx_err()

◆ alloc_rndis()

◆ register_rndis()

◆ unregister_rndis()

◆ free_rndis()

◆ rndis_tx_complete()