Configuration

This section shows how to include the RNDIS support into an eCos configuration, and how to configure it once installed.

Configuration Overview

The RNDIS driver is contained in a single eCos package CYGPKG_DEVS_ETH_USB_RNDIS. However, it depends on the services of a collection of other packages for complete functionality. Currently the RNDIS implementation is tightly bound with the generic Ethernet driver package CYGPKG_DEVS_ETH_GENERIC_DIRECT.

Incorporating the RNDIS driver into your application is straightforward. The essential starting point is to incorporate the RNDIS eCos package (CYGPKG_DEVS_ETH_USB_RNDIS) into your configuration.

This may be achieved directly using ecosconfig add on the command line, or the Build->Packages... menu item within the eCos Configuration Tool.

Configuring the RNDIS driver

Once added to the eCos configuration, the RNDIS package has a number of configuration options.

CYGPKG_DEVS_ETH_USB_RNDIS_VID

The device VendorID. The VendorID number space is managed by the USB organisation, www.usb.org, and a unique ID must be formally obtained.

In conjunction with the CYGPKG_DEVS_ETH_USB_RNDIS_PID value this is used to uniquely identify a specific peripheral product to the host O/S environment.

Note: The VID is normally expressed as a 16-bit hexadecimal number, but the eCos graphical configurarion tool will normally display the value as a decimal.

CYGPKG_DEVS_ETH_USB_RNDIS_PID

The device ProductID. The ProductID number space is managed by the vendor. This ID is sometimes used to uniquely identify specific devices as regards the host device driver needed to communicate with the target device. It is the responsibility of the developer to manage this internal (company) number space.

Note: The PID is normally expressed as a 16-bit hexadecimal number, but the eCos graphical configurarion tool will normally display the value as a decimal.

CYGPKG_DEVS_ETH_USB_RNDIS_MANUFACTURER

A human-readable device manufacturer identification string, that is returned as part of the device USB description. The string may be used by the host O/S in its description of the product presented to end-users.

CYGPKG_DEVS_ETH_USB_RNDIS_PRODUCT

A human-readable product identification string, that is returned as part of the device USB description. Like the manufacturer string this may be used on the host when presenting a device to the user.

CYGPKG_DEVS_ETH_USB_RNDIS_SERIAL_FIXED

Depending on the product requirements the serial number returned as part of the USB descriptor can either be supplied at run-time by the application HAL or defined by the CDL and fixed for a binary build.

The former approach relies on the HAL having a method of obtaining a unique identifier from the hardware from which to construct a unique serial number string. This is normally the preferred approach to providing per-device unique identification, and is used when this option is disabled. When this option is enabled the build uses the string defined by this option as the value returned in the device USB description. This latter approach is less flexible if different physical devices need a unique ID since the CDL will need to be modified and a unique binary constructed for each specific device. If the devices do not need to present a unique identity then the same serial number can be configured into the binary build with the same value being used across all target devices.

CYGPKG_DEVS_ETH_USB_RNDIS_POWERED

This option defines how the device declares its power state to the host, and should be configured to match the hardware implementation supporting the RNDIS target driver. When configured as Bus powered then a further configuration option is made available:

CYGPKG_DEVS_ETH_USB_RNDIS_MAXPOWER

When bus-powered this option specifies the maximum power consumption of the device.

CYGDBG_RNDIS_DIAGNOSTICS

When enabled this option allows diagnostic output to be generated for different subsystems within the RNDIS driver, and a set of further options are made available for configuration. This information is primarily for internal driver development, and is not normally needed when debugging applications using the USB RNDIS network driver. The debug output is sent to the diagnostic console channel as configured for the application.

2017-02-09
Documentation license for this page: eCosPro License