VxWorks

Network Programmer's Guide

5.5

[Copyright][Online Manuals]

Contents

1 Overview

1.1 Introduction
1.2 Chapter Overviews
1.3 UML Notation
1.4 Recommended Reading

2 The VxWorks Network Stack

2.1 Introduction
2.2 Supported Protocols and Utilities
2.3 Setting Task Priorities Relative to the Networking Task

3 Data Link Layer Components

3.1 Introduction
3.2 Ethernet Driver Support
3.2.1 BPF, the BSD Packet Filter
3.2.2 Additional Filter Syntax
3.3 The Shared-Memory Backplane Network Driver
3.3.1 The Backplane Shared-Memory Region
Backplane Processor Numbers
The Shared-Memory Network Master
The Shared-Memory Anchor
The Shared-Memory Backplane Network Heartbeat
Shared-Memory Location
Shared Memory Size
Test-and-Set to Shared Memory
3.3.2 Interprocessor Interrupts
3.3.3 Sequential Addressing
3.3.4 Shared-Memory Backplane Network Configuration
Example Configuration
Troubleshooting
3.4 Custom Interfaces

4 Configuring the Network Stack

4.1 Introduction
4.2 Summary of Configuration Settings
4.3 Configuring the Network Stack at Build Time
4.3.1 Network Protocol Scalability
4.3.2 Configuring the ARP, IP, TCP, UDP, IGMP, and ICMP Protocols
TCP Window Sizes
4.3.3 Network Memory Pool Configuration
Setting the Number of Clusters
4.3.4 Testing Network Connections
4.3.5 Supporting Multiple Network Interface Drivers
Configuring VxWorks for Multiple Drivers
4.4 Overview of TCP/IP
4.5 Configuring the IP-to-Link Layer Interface
4.5.1 Binding IP to the MUX (Link Layer)
4.5.2 Assigning an IP Address and Network Mask to an Interface
Interfaces Configured from the Boot Line
Assigning the Net Mask to a Network Interface
Assigning the Internet Address for a Network Interface
Manually Starting Additional Network Interfaces at Run-Time
4.5.3 Configuring IP Broadcast Addresses
4.6 IGMP under VxWorks
4.6.1 Including IGMPv2
4.6.2 IGMPv2 APIs
IGMPv2 Host Initialization
IGMPv2 Router Initialization and Termination
IGMPv2 Router Control
Working with VIFs (Ports) and ifnet Structure Pointers
4.7 Manually Editing the Routing Table
4.7.1 Adding Gateways (Routers) to a Network
4.8 Proxy ARP for Transparent Subnets
4.8.1 Proxy ARP Protocol Overview
4.8.2 Routing and the Proxy ARP Server
4.8.3 Proxy ARP and Broadcast Datagrams
4.8.4 Proxy ARP Configuration
Proxy ARP not Limited To a Shared Memory Network
Proxy ARP with Shared Memory and IP Routing
Setting Up Boot Parameters and Booting
Creating Network Connections
Routing Configuration for Multi-Homed Proxy Clients
Broadcasts Configuration for Multi-Homed Proxy Clients
4.9 Using Unnumbered Interfaces
4.10 Network Byte Order
4.11 Assigning Host Names to IP Addresses

5 Network Configuration Protocols

5.1 Introduction
5.2 BOOTP, Bootstrap Protocol
5.2.1 BOOTP Configuration
The BOOTP Database
Editing the BOOTP Database to Register a Target
5.3 DHCP, Dynamic Host Configuration Protocol
5.3.1 Including DHCP Components in an Image
5.3.2 Configuring the DHCP Client
5.3.3 Configuring DHCP Servers
Configuring the Supported DHCP Server
Adding Entries to the Database of a Running DHCP Server
Storing and Retrieving Active Network Configurations
Configuring the Unsupported DHCP Server
5.3.4 Configuring the Supported DHCP Relay Agent
5.3.5 DHCP within an Application
5.4 Boot Parameters for DHCP, BOOTP, and Network Initialization
5.4.1 Boot Parameters Returned from DHCP or BOOTP
5.5 SNMP, Simple Network Management Protocol
SNMP is a Separately Purchasable Option

6 Dynamic Routing Protocols

6.1 Introduction
6.2 RIP, Routing Information Protocol
6.2.1 VxWorks Debugging Routines for RIP
6.2.2 Configuring RIP
6.2.3 Creating an Interface Exclusion List for RIP

7 Sockets under VxWorks

7.1 Introduction
7.2 BSD Sockets
7.2.1 VxWorks-Specific Socket Dependencies
7.2.2 Datagram Sockets (UDP)
Using a Datagram (UDP) Socket to Access IP Multicasting
7.2.3 Stream Sockets (TCP)
7.3 Zbuf Sockets
7.3.1 Zbuf Sockets and Protection Domains
7.3.2 Zbuf Calls to Send Existing Data Buffers
7.3.3 Manipulating the Zbuf Data Structure
Zbuf Byte Locations
Creating and Destroying Zbufs
Getting Data In and Out of Zbufs
Operations on Zbufs
Segments of Zbufs
Example: Manipulating Zbuf Structure
Limitations of the Zbuf Implementation
7.3.4 Zbuf Socket Calls
Standard Socket Calls and Zbuf Socket Calls

8 Remote Access Applications

8.1 Introduction
8.2 RSH, FTP, and netDrv
8.2.1 RSH
Configuring the Remote Host to Allow Access to an RSH User
8.2.2 FTP
8.2.3 Using netDrv
Using netDrv to Download Run-Time Images
8.3 NFS and nfsDrv
8.3.1 VxWorks NFS Clients
8.3.2 VxWorks NFS Servers
Initializing a File System for NFS Export
Exporting a File System through NFS
Limitations of the VxWorks NFS Server
About leofs
8.4 TFTP
8.4.1 Host TFTP Server
8.4.2 VxWorks TFTP Server
8.4.3 VxWorks TFTP Client
8.5 RPC Remote Procedure Calls
8.6 rlogin
8.7 telnet

9 DNS and SNTP

9.1 Introduction
9.2 DNS: Domain Name System
9.2.1 Domain Names
9.2.2 The VxWorks Resolver
Resolver Integration
Resolver Configuration
9.3 SNTP: A Time Protocol
9.3.1 Using the SNTP Client
9.3.2 Using the SNTP Server

10 Integrating a New Network Interface Driver

10.1 Introduction
10.1.1 The MUX and the OSI Network Model
10.1.2 The Protocol-to-MUX Interface
10.1.3 The Datalink-to-MUX Interface
10.1.4 How ENDs and NPT Drivers Differ
10.1.5 Managing Memory for Network Drivers and Services
10.1.6 Supporting Scatter-Gather in Your Driver
10.1.7 Early Link-Level Header Allocation in an NPT Driver
10.1.8 Buffer Alignment
10.2 END Implementation
10.2.1 END Operation
Adding an END to VxWorks
Launching the Driver
Binding to a Service
Receiving Frames in Interrupt Mode
10.2.2 The END Interface to the MUX
Data Structures Shared by the END and the MUX
END Entry Points Exported to the MUX
10.3 NPT Driver Implementation
10.3.1 NPT Driver Operation
Adding an NPT Driver to VxWorks
Launching the Driver
Responding to Network Service Bind Calls
Receiving Frames in Interrupt Mode
10.3.2 NPT Driver Interface to the MUX
Data Structures Used by the Driver
NPT Driver Entry Points Exported to the MUX
10.4 Porting a BSD Driver to the MUX
10.4.1 Remove Unit Number References
10.4.2 Create an END Object to Represent the Device
10.4.3 Implementing the Standard END or NPT Entry Points
Rewrite xxattach( ) to Use an npt/endLoad( ) Interface
The xxReceive( ) Routine Still Handles Task-Level Packets
Rewrite xxOutput( ) to Use an npt/endSend( ) Interface
The xxIoctl( ) Routine is the Basis of npt/endIoctl( )
Implement All Remaining Required END or NPT Entry Points
10.5 Supporting Multiple Network Interface Drivers
10.5.1 Configuring VxWorks for Multiple Drivers
10.5.2 Starting Additional Drivers at Run-Time
10.6 Avoiding Memory Leaks

11 Integrating a New Network Service

11.1 Introduction
11.2 Writing a Network Service Sublayer
11.2.1 Interface Initialization
11.2.2 Data Structures and Resources
11.2.3 Sublayer Routines
Sending Packets
Receiving Packets
Shutting Down an Interface
Error Reporting
Flow Control
Device Control
11.3 Interfacing with the MUX
11.3.1 Service Functions Registered Using muxTkBind( )
11.3.2 Service Functions Registered Using muxBind( )
11.4 Adding a Socket Interface to Your Service
Process Overview
11.4.1 Implementing a Socket Back End
The Socket Functional Interface
The sockLibAdd( ) Function
11.4.2 Enabling Zbuf Support Within a Socket Back End
11.4.3 Implementing Socket Functions
Implementation Recommendations for the Elements of a SOCK_FUNC Table
Socket Functions Passed to iosDrvInstall( )

A Using netBufLib

A.1 Introduction
A.2 How a netBufLib Pool Organizes Memory
A.3 Setting Up a Memory Pool
A.4 Storing and Using Data in Clusters
A.5 Freeing mBlks, clBlks, and Clusters
A.6 Macros for Buffer Manipulation
A.7 The netBufLib Library

B MUX/NPT Routines and Data Structures

B.1 Introduction
B.2 MUX Routines
B.2.1 muxAddrResFuncAdd( )
B.2.2 muxAddrResFuncDel( )
B.2.3 muxAddrResFuncGet( )
B.2.4 muxAddressForm( )
B.2.5 muxBind( )
B.2.6 muxDevExists( )
B.2.7 muxDevLoad( )
B.2.8 muxDevStart( )
B.2.9 muxDevStop( )
B.2.10 muxDevUnload( )
B.2.11 muxError( )
B.2.12 muxIoctl( )
B.2.13 muxMCastAddrAdd( )
B.2.14 muxMCastAddrDel( )
B.2.15 muxMCastAddrGet( )
B.2.16 muxTkBind( )
B.2.17 muxTkDrvCheck( )
B.2.18 muxTkPollReceive( )
B.2.19 muxTkPollSend( )
B.2.20 muxTkReceive( )
B.2.21 muxTkSend( )
B.2.22 muxTxRestart( )
B.2.23 muxUnbind( )
B.3 Data Structures
B.3.1 DEV_OBJ
B.3.2 END_ERR
B.3.3 END_OBJ
B.3.4 END_QUERY
B.3.5 LL_HDR_INFO
B.3.6 M2_INTERFACETBL and M2-ID
B.3.7 mBlk
B.3.8 MULTI_TABLE
B.3.9 NET_FUNCS

C Bundled PPP, SLIP, and CSLIP

C.1 Introduction
C.2 Serial Driver Support
C.2.1 SLIP and CSLIP Configuration
C.3 PPP, the Point-to-Point Protocol for Serial Line IP
C.3.1 PPP Configuration
C.3.2 Using PPP
C.3.3 Troubleshooting PPP
C.3.4 PPP Option Descriptions

Index