US 5,548,731 AGrant
System for Forwarding Data Packets With Different Formats to Different Software Entitles Respectively Based Upon Match Between Portion of Data Packet and Filter
Issue Date:1996-08-20
•2 Claims
•6 Drawing Sheets
Abstract
A common data link interface providing a framework for device drivers and data link providers. This interface allows multiple frameworks to coexist and share a single device driver. The common data link interface is framework independant and provides functions that are common to a plurality of frameworks. The common data link interface comprises three components, a network device driver, network demultiplexers, and network services. The network device driver provides a simple interface to network based devices that can be used by both the sockets IFNET and the streams DLPI data link layers. The network demultiplexor provides common data link receive functionality. Network services provides the remaining additional functionality required to bind the common data link interface together.
Metadata
Assignee
- International Business Machines Corporation
Inventors
- Kyusun Chang
- Lon E. Hall
- Gregory S. Joyce
- Paul D. Mazzurana
- Lance W. Russell
Application Information
Application Number:US 5161126
Filing Date:1995-08-17
Priority Date:1993-01-13
Art Unit:237
Classifications
IPC:
G06F 1300G06F 1314G06F 1202
Field of Search:
395821;280;650;800;500
Patent Drawings (6 sheets)
Description
TECHNICAL FIELD
This invention relates to data processing systems, and more particularly to a common interface for supporting a plurality of data frameworks.
BACKGROUND OF THE INVENTION
Various dissimilar data protocols have evolved in the data processing industry, each having various advantages/disadvantages in a particular application or use. For example, BSD provides networking code that uses a framework known as Sockets to implement a communication protocol compatible with Unix.sup.1 operating systems. Numerous communication protocols have been written which are based on the Sockets framework, most notably TCP/IP. A framework is essentially a programming interface, or set of libraries which can be called by an application program, that provides data communication functions independant from the underlying protocol used to transfer the data. As such, various versions of a particular framework could provide support for different underlying protocols. For example, Sockets could support TCP/IP, SNA or ArcNet. Frameworks and protocols are further described in the IBM publication "AIX Version 3.2 Communication Programming Concepts", publication number SC23-2206-03, dated September 1992, and hereby incorporated by reference as background material.
AT&T introduced Streams as a framework to develop a Unix communication protocol. This Streams framework addressed some of the Sockets framework's shortcomings,
Trademark of Unix System Laboratories, Inc. and has become popular in the data processing industry. Problems are encountered in that Sockets and Streams are completely independant frameworks. Thus, if a new communication protocol is desired to be added by an operating system provider, the provider must choose one or the other framework prior to the new protocol development. Providing support for multiple frameworks requires different hardware adapters and different device drivers corresponding to such hardware adapters.
This problem is further amplified when an operating system vendor is trying to provide a common operating system for a plurality of underlying data processing systems having differing processors, busses, etc. In this situation, the operating system provider would have dissimilar code support not only for the differing processors (e.g. an 80486, 68200 or RISC microprocessor), but for the differing frameworks and hardware adapters as well. This leads to larger development resource requirements, and an increase in hardware adapter requirements.
SUMMARY OF THE INVENTION
The Common Data Link Interface (CDLI) provides a framework for network device drivers and data link providers. This framework allows sockets and streams protocols to coexist and share a single device driver. The framework is socket/stream independent and only provides function that is common. General users interface indirectly to CDLI through sockets and DLPI (described below).
CDLI is composed of three components: Network Device Drivers, Network Demuxers, and Network Services. The Network Device Driver (NDD) model defines a lean, simple interface to network based devices that can be used by both the sockets IFNET and the streams Data Link Provider Interface (DLPI) data link layers. Common data link receive functionality is provided by a Network Demuxer. The demuxer specifies receive filters that will be used to distribute network packets. Network Services (NS) is a set of kernel functions that provides services to NDDs, Network Demuxers, and NS users(data links and protocols). NS is the glue that binds CDLI together.
In light of the foregoing, it is an object of the present invention to provide an improved data processing system.
It is a further object of the present invention to provide an improved data communication subsystem.
It is yet a further object of the present invention to provide a single hardware interface for supporting multiple communication frameworks.
It is still a further object of the present invention to provide a single driver interface to a hardware adapter which supports multiple communication frameworks.
These, and other, objects and features of the invention will become apparent from the following detailed description in which the preferred embodiment is set forth with reference to the accompanying drawing.
BRIEF DESCRIPTION OF THE DRAWING
FIG. 1 depicts a traditional framework providing data link, or network, services using a generic programming interface.
FIG. 2 depicts a traditional multi-user, multi-adapter configuration of that shown in FIG. 1.
FIG. 3 is a overall system block diagram of a common data link interface (CDLI).
FIG. 4 illustrates adding a network device driver to the CDLI system.
FIG. 5 illustrates allocating the use of a network device driver in the CDLI system.
FIG. 6 illustrates adding a receive filter for input packets in the CDLI system.
FIG. 7 illustrates using an allocated network device driver in the CDLI system.
FIG. 8 illustrates the data/code flow in the CDLI system.
DETAILED DESCRIPTION OF THE PREFERRED EMBODIMENT
FIG. 1 depicts a representative of a traditional generic data link control 11, or framework. The framework defines a generic interface definition that provides application 13 or kernel 15 users with a common set of commands to control a data link for the transfer of data. Users within the kernel at 15 have access to the communications memory buffers 21 and call the device driver (dd) entry points by way of the fp kernel services. Users above the kernel at 13 access the standard interface-to-kernel device drivers, and the file system calls the dd entry points. Data transfers generally require a move of data between user and kernel space. The application user 13 resides above the kernel as an application or access method. The kernel user 15 resides within the kernel as a kernel process of device manager. The file I/O subsystem 17 converts the file descriptor and file-pointer subroutines to file pointer(fp) accesses of a switch table (not shown). The DLC device manager 19 accesses the buffer pool in interfacing between the file I/O subsystem and the Comm I/O device driver. This device manager may support multiple user above, as well as multiple device drivers and adapters below. The buffer pool 21 provides data-buffer services for the communication subsystem. The Comm I/O device driver 23 controls hardware adapter I/O and DMA registers, and routes receive packets to the DLC device manager. The adapter 25 attaches to the communications media.
A multi-user, multi-adapter configuration 27 is shown in FIG. 2, comprising multiple application users 29 and kernel users 35, along with multiple communication I/O device drivers 31 with corresponding adapters 33. This traditional approach suffers from requiring multiple I/O device drivers for differing frameworks.
The following describes common functions and how they are accomplished using the common data link interface of this invention. The functions generally occur in the following order.
1--Adding a Network Demuxer
2--Adding a Network Device Driver
3--Allocating Use of a Network Device Driver
4--Adding a Receive Filter For Input Packets
5--Adding a Status Processing Function
6--Adding a Network Demuxer
Adding a Network Demuxer
Referring now to FIG. 3, Network demuxers 14 are responsible for routing both input packets and asynchronous status from a Network Device Driver (NDD) 12 to a NS user that has expressed interest (through ns.sub.-- add.sub.-- filter and ns.sub.-- add.sub.-- status). For instance, a demuxer for 802.2 LLC would use DSAP (and possibly ethertype) to determine which user will receive an input packet. The nd.sub.-- add.sub.-- filter and nd.sub.-- del.sub.-- filter (accessed through ns.sub.-- add.sub.-- filter and ns.sub.-- del.sub.-- filter) functions of a demuxer handle adding and removing receive filters. The demuxer 14 is responsible for keeping a list of filters and the associated users. After being configured, a Network Demuxer 14 makes itself available to the system by the ns.sub.-- add.sub.-- demux service.
The following table shows an example of a ns.sub.-- add.sub.-- demux service.
Adding a Network Device Driver
After a Network Device Driver has been configured, it needs to make itself available to NDD users. This is accomplished by the ns.sub.-- attach network service. This service adds the NDD to Network Service's list of available network device drivers. FIG. 4 illustrates this. As shown in the top block 30, an ndd structure 32 has the next ns.sub.-- nddnet value pointing to NULL. A new network device as addressed by &dd.ndd 34 is to be added. This new network device has a data structure 36. The device driver's NDD is added to the list of available network device drivers, as shown in the ndd data structure ndd struct 32 of lower block 40. Block 40 shows the resultant data structure interrelations after having added a network device driver.
The ns.sub.-- detach service is the opposite of ns.sub.-- attach; that is it removes the network device from the list of available devices.
Allocating Use of a Network Device Driver
After a device driver has made itself available to the system (using ns.sub.-- attach), it may be accessed by users. Device driver users gain access to a NDD through the ns.sub.-- alloc network service. This service allocates use of the NDD (through a ndd structure 42 of FIG. 5) and opens the NDD if necessary. Access to the device is relinquished through the ns.sub.-- free network service. The specific steps are shown and described in FIG. 5.
Adding a Receive Filter For Input Packets
In order to receive input packets (IP), a user must specify the type of packets in which it is interested in. For instance, IP would indicate that it would like ethertype 0.times.0800 packets. This registration is accomplished through the ns.sub.-- add.sub.-- filter network service. The Network Demuxer for the specified NDD will add the receive filter to it's list of filters and users. A filter is removed by the ns.sub.-- del.sub.-- filter service. The receive packet flow for an 802.3 local area network packet is shown and described in lower box 50 of FIG. 6. The filter structure is defined at 52, with the particular filter parameters for an 802.2 LAN shown at 60. The user is defined at 54.
Adding a Status Processing Function
If a user wishes to receive NDD status information it must register with the network demuxer. This registration is accomplished through the ns.sub.-- add.sub.-- status network service. The Network Demuxer for the specified NDD will add the status filter to it's list of filters and users. A status filter is removed by the ns.sub.-- del.sub.-- status service.
Using an Allocated Network Device Driver
Referring now to FIG. 7, after a NDD user has allocated a NDD with the ns.sub.-- alloc service, it may use the nd.sub.-- output 70 and ndd.sub.-- ctl 72 functions of the NDD. ndd.sub.-- output is used to transmit data to the associated device driver 74. Various device control and status functions for a particular hardware adapter are available through the ndd.sub.-- ctl function. Sample code for transmitting a packet and issuing a control function is shown in the lower portion of FIG. 7.
Functional Interactions
FIG. 8 depicts the interfaces and interplay between the network device driver 12, used to control physical device 26, and the network demuxer 14, network services 16, and a CDLI user 80. The CDLI user could be, for example, using the sockets framework 22 of FIG. 1, and thus the interface between the CDLI user 80 and network services 16 of FIG. 8 would be interface 41 of FIG. 1. Alternatively, the CDLI user could be using the streams framework 24 of FIG. 1, and thus the interface between the CDLI user 80 and network services of FIG. 8 would be interface 43 of FIG. 1. Each of the functions/routines shown in FIG. 8 will now be described.
Network Services Overview
The following routines provide various aspects of network services, as described by the definitions for the respective routines.
Network Services for users (sockets, DLPI)
ns.sub.-- alloc
Allocates use of the specified network device.
ns.sub.-- free
Relinquishes access to a network device.
ns.sub.-- add.sub.-- filter
Adds a receive filter that enables the reception of packets that match the filter.
ns.sub.-- del.sub.-- filter
Deletes a receive filter and disables reception of packets that match the filter.
ns.sub.-- add.sub.-- status
Adds a filter for routing of asynchronous status.
ns.sub.-- del.sub.-- status
Deletes a previously added status filter.
Network Services for network demuxers
ns.sub.-- add.sub.-- demux
Adds a demuxer for the specified type of network device.
ns.sub.-- del.sub.-- demux
Removes a demuxer for the specified type of network device.
Network Services for network device drivers
ns.sub.-- attach
Places a device into the available NS device chain.
ns.sub.-- detach
Removes a device from the available device chain.
The following provides detailed implementation information for implementing the above listed network service routines.
NAME
ns.sub.-- alloc
Allocates use of a network device driver.
PARAMETERS
nddname
The device name to be allocated.
nddpp
Address of pointer to a ndd structure.
DESCRIPTION
This network service will walk the NS device chain to find the device driver with the specified nddname. If a match is found, then the reference count for the specified device driver will be incremented. If the reference count is incremented to 1, then the ndd.sub.-- open() routine specified in the ndd structure is called to open the device driver.
EXAMPLES
struct ndd *nddp; error=ns.sub.-- alloc("enO", &nddp);
RETURN VALUE
If a match is found and the open to the device is successful, a pointer to the ndd structure for the specified device is stored in nddpp. If no match is found or the open of the device is unsuccessful, then a non zero value is returned.
0--The operation was successful.
ENODEV--Indicates an invalid network device.
ENOENT--No network demuxer available for this device.
Other return values from the open of the NDD.
FILES
net/ns.c
RELATED INFORMATION
Interfaces: ns.sub.-- free(), ndd.sub.-- open()
Network Device Drivers
NAME
ns.sub.-- free
Relinquishes access to a network device.
PARAMETERS
nddp
Specifies the ndd structure of the network device that is to be freed from use.
DESCRIPTION
This network service will decrement the reference count for the specified ndd structure. If the reference count becomes 0, then the ndd.sub.-- close() routine specified in the ndd structure is called.
EXAMPLES
struct ndd *nddp;
ns.sub.-- free(nddp);
RETURN VALUE
none
FILES
net/ns.c
RELATED INFORMATION
Interface: ns.sub.-- alloc()
Network Device Drivers
NAME
ns.sub.-- add.sub.-- filter
Registers a receive filter to enable the reception of packets.
PARAMETERS
nddp
Specifies the ndd that this add request is for.
filter
Pointer to the receive filter.
len
The length in bytes of the receive filter pointed to by the filter parameter.
ns.sub.-- user
Pointer to a ns.sub.-- user structure that defines the user.
DESCRIPTION
The ns.sub.-- add.sub.-- filter network service is called to register a receive filter for the reception of packets. This enables a network demuxer to route packets to the appropriate users. The add request is passed on to the nd.sub.-- add.sub.-- filter function of the demuxer for the specified NDD. The caller of ns.sub.-- add.sub.-- filter is responsible for relinquishing filters before calling ns.sub.-- free.
EXAMPLES
struct ns.sub.-- 8022 dl; /* filter for 802.2 LANS */
struct ns.sub.-- user ns.sub.-- user; /* describes the user */
dl.filtertype=NS.sub.-- LLC.sub.-- DSAP.sub.-- SNAP;
dl.dsap=Oxaa;
dl.orgcode[0]=0x0;
dl.orgcode[1]=0x0;
dl.orgcode[2]=0x0;
dl.ethertype=0x0800;
ns.sub.-- user.isr=ipintr;
ns.sub.-- user.protoq=&ipintrq;
ns.sub.-- user.netisr=NETISR.sub.-- IP;
ns.sub.-- user.pkt.sub.-- format=NS.sub.-- PROTO.sub.-- SNAP;
ns.sub.-- add.sub.-- filter(nddp, &dl, sizeof(dl), &ns.sub.-- user);
RETURN VALUE
0--The operation was successful.
ENODEV--Indicates an invalid network device.
ENOENT--No network demuxer available for this device.
Other return values from network demuxer.
FILES
net/ns.c
RELATED INFORMATION
Interfaces: ns.sub.-- del.sub.-- filter()
Network Demuxers
NAME
ns.sub.-- del.sub.-- filter
Deletes a receive filter.
PARAMETERS
nddp
Specifies the ndd that this delete request is for.
filter
Pointer to the receive filter.
len
The length in bytes of the receive filter.
DESCRIPTION
This network service will delete the receive filter from the corresponding network demuxer. This has the effect of disabling packet reception for packets that match the filter. The delete request is passed on to the nd.sub.-- del.sub.-- filter function of the demuxer for the specified NDD.
EXAMPLES
struct ns.sub.-- 8022 dl; /* filter for 802.2 LANS */
dl.filtertype=NS.sub.-- LLC.sub.-- DSAP.sub.-- SNAP;
dl.dsap=Oxaa;
dl.orgcode[0]=0x0;
dl.orgcode[1]=0x0;
dl.orgcode[2]=0x0;
dl.ethertype =0x0800;
ns.sub.-- del.sub.-- filter(nddp, &dl, size of(dl));
RETURN VALUE
0--The operation was successful.
ENODEV--Indicates an invalid network device.
Other return values from Network Demuxer.
FILES
net/ns.c
RELATED INFORMATION
Interfaces: ns.sub.-- add.sub.-- filter() and ns.sub.-- alloc()
NAME ns.sub.-- add.sub.-- status
Adds a status filter for the routing of asynchronous status.
PARAMETERS
nddp
Pointer to the ndd structure that this add request is for.
statfilter
Pointer the status filter.
len The length in bytes of statfilter.
ns.sub.-- statuser
Pointer to a ns.sub.-- statuser structure that defines this user.
DESCRIPTION
The ns.sub.-- add status network service is called to register a status filter. The add request is passed on to the nd.sub.-- add status function of the demuxer for the specified NDD. This enables the user to receive asynchronous status information from the specified device.
NOTES
The user's status processing function will be called by the Network Demuxer when asynchronous status becomes available. The user's status processing function will be called directly, the status processing function can not be a scheduled routine.
EXAMPLES
struct ns.sub.-- statuser user;
struct ns.sub.-- com.sub.-- status filter;
filter.mask=NDD.sub.-- HARD.sub.-- FAIL;
filter.sid=0;
user.isr=status.sub.-- fn;
user.isr.sub.-- data=whatever.sub.-- makes.sub.-- sense;
error=ns.sub.-- add.sub.-- status(nddp, &filter, sizeof(filter), &user);
RETURN VALUE 0--The operation was successful.
ENODEV--Indicates an invalid device.
Other return values from the network demuxer.
FILES
net/ns.c
RELATED INFORMATION
Interfaces: ns.sub.-- del.sub.-- status()
Network Demuxers
NAME
ns.sub.-- del.sub.-- status
Deletes a previously added status filter.
PARAMETERS
nddp
Pointer to the ndd structure that this delete request is for.
statfilter
Pointer to the status filter.
len
The length in bytes of statfilter.
DESCRIPTION
The ns.sub.-- del.sub.-- status network service is called to delete a previously added status filter from the corresponding network demuxer. The delete request is passed on to the nd.sub.-- del.sub.-- status function of the demuxer for the specified NDD. This has the effect of disabling asynchronous status notification from the specified device.
EXAMPLES
/* The filter parameter is the same as used in the ns.sub.-- add.sub.-- status call . */
error=ns.sub.-- add.sub.-- status(nddp. &filter. sizeof(filter));
RETURN VALUE
0--The operation was successful.
ENODEV--Indicates an invalid device.
EINVAL--Indicates an invalid parameter.
Other return values from the network demuxer.
FILES
net/ns.c
RELATED INFORMATION
Interfaces: ns.sub.-- add.sub.-- status()
Network Demuxers
NAME
ns.sub.-- add.sub.-- demux
adds a demuxer for the specified type of network interface.
PARAMETERS
ndd.sub.-- type
The interface type of the demuxer to be added.
demux
Pointer to a ns demux structure that defines the demuxer.
DESCRIPTION
This network service adds the specified demuxer to the list of available network demuxers. There can only be one demuxer per network interface type. An interface type describes a certain class of network devices that have the same characteristics (ie ethernet, tokne ring). The ndd.sub.-- type values listed in sys/ndd.h are the numbers defined by SNMP. If the desired type is not in ndd.h, the SNMP value should be used if it is defined. If not, any undefined type above NDD.sub.-- MAX.sub.-- TYPE may be used.
EXAMPLES
struct ns.sub.-- demux demuxer;
demuxer.add.sub.-- filter=eth.sub.-- add.sub.-- filter;
demuxer.del.sub.-- filter=eth.sub.-- del.sub.-- filter;
demuxer.add.sub.-- status=eth.sub.-- add.sub.-- status;
demuxer.del.sub.-- status=eth.sub.-- del.sub.-- status;
demuxer.receive=eth.sub.-- receive;
demuxer.status=eth.sub.-- status;
demuxer.response=eth.sub.-- response;
ns.sub.-- add.sub.-- demux(NDD.sub.-- IS088023, &demuxer);
RETURN VALUE
0--The operation was successful.
EEXIST--a demuxer already exists for the given type.
EINVAL--ndd.sub.-- type out of range
FILES
net/ns.c
RELATED INFORMATION
Network Demuxers, ns.sub.-- del.sub.-- demux()
NAME
ns.sub.-- del.sub.-- demux
deletes a demuxer for the specified type of network interface.
SYNOPSIS
#include <sys/ndd.h>int ns.sub.-- del.sub.-- demux (ndd.sub.-- type)
int ndd.sub.-- type;
PARAMETERS
ndd.sub.-- type
The network interface type of the demuxer that is to be deleted.
DESCRIPTION
If the demuxer is not currently in use, this network service will delete the specified demuxer from the list of available network demuxers. A demuxer is in use if a NDD is open for the demuxer.
EXAMPLES
ns.sub.-- del.sub.-- demux(NDD.sub.-- IS088023);
RETURN VALUE
0--The operation was successful.
ENOENT--The demux of the specified type does not exist.
EINVAL--ndd.sub.-- type out of range
EBUSY--The demuxer is currently in use.
FILES
net/ns.c
RELATED INFORMATION
Network Demuxers, ns.sub.-- add.sub.-- demux()
NAME
ns.sub.-- attach
Attaches a network device to the network subsystem.
SYNOPSIS
#include <sys/ndd.h>
int ns.sub.-- attach (nddp)
struct ndd *nddp;
PARAMETERS
nddp
A pointer to a ndd structure describing the device to be attached.
DESCRIPTION
This network service is called to place the device into the available NS device chain. The NDD should be prepared to be opened after ns.sub.-- attach is called.
NOTES
The ndd structure is allocated and initialized by the device. It should be pinned.
EXAMPLES
/* Example of adding a NDD during NDD configuration */
struct ndd ndd;
ndd.ndd.sub.-- name="en";
ndd.ndd.sub.-- unit=adap.sub.-- num;
ndd.ndd.sub.-- addrlen=6;
ndd.ndd.sub.-- hdrlen=14;
ndd.ndd.sub.-- mtu=ETHERMTU;
ndd.ndd.sub.-- mintu=60;
ndd.ndd.sub.-- type=NDD.sub.-- ETHER;
ndd.ndd.sub.-- flags=
NDD.sub.-- UP | NDD.sub.-- BROADCAST | NDD.sub.-- SIMPLEX;
ndd.ndd.sub.-- open=entopen;
ndd.ndd.sub.-- output=entwrite;
ndd,ndd.sub.-- ctl=entctl;
ndd.ndd.sub.-- close=entclose;
ns.sub.-- attach(&ndd);
RETURN VALUE
0--The operation was successful.
EEXIST--Indicates that the device is already in the available NS device chain.
FILES
net/ns.c
RELATED INFORMATION
Interfaces: ns.sub.-- detach()
NAME
ns.sub.-- detach
Removes a network device from the network subsystem.
SYNOPSIS
#include <sys/ndd.h>
int ns_detach (nddp)
struct ndd *nddp;
PARAMETERS
nddp
A pointer to a ndd structure describing the device to be detached.
DESCRIPTION
This service removes the ndd structure from the chain of available NS devices.
EXAMPLES
/* nddp is address of previously attached ndd structure */
ns.sub.-- detach(nddp);
RETURN VALUE
0--The operation was successful.
ENOENT--The specified ndd structure was not found.
FILES
net/ns.c
RELATED INFORMATION
Interface: ns.sub.-- attach()
Network Demuxer Overview
A network demuxer provides functions for the routing of receive data and status information to the appropriate user(s). The demuxer must be able to interpret and route the different types of receive data that may be received from the interface. For example, a network demuxer for a FDDI interface (NDD type NDD.sub.-- FDDI) would need to interpret MAC, SMT, implementor, and LLC frames. The FDDI demuxer would also be responsible for specifying the format of the receive filter (the criteria for demuxing input packets) that would be used in the ns.sub.-- add.sub.-- filter network service call.
A network demuxer registers with NS by means of the ns.sub.-- add.sub.-- demux network service.
There can only be one demuxer registered with NS per network interface type (as defined in <sys/ndd.h>).
A Network Demuxer consists of the following functions.
nd.sub.-- config()
This optional entry point provides configuration functions for the demuxer.
nd.sub.-- receive()
Routes received data to the appropriate NS user(s).
nd.sub.-- status()
Distributes asynchronous status to the appropriate NS user(s). nd.sub.-- add.sub.-- filter()
Adds a receive filter for the routing of received data.
nd.sub.-- del.sub.-- filter()
Deletes a previously specified receive filter.
nd.sub.-- add.sub.-- status()
Adds a filter for routing of asynchronous status.
nd.sub.-- del.sub.-- status()
Deletes a previously added status filter.
The following provides detailed implementation information for implementing the above listed network demuxer routines.
NAME
nd.sub.-- config()
Network Demuxer configuration
PARAMETERS
op
either SYSCONFIG.sub.-- CONFIGURE or SYSCONFIG.sub.-- UNCONFIGURE
indata
demuxer configuration information
indatalen
the length in bytes of indata
outdata
returned configuration information
outdatalen
the length in bytes of outdata
DESCRIPTION
This function provides configuration for Network Demuxers. SYSCONFIG.sub.-- CONFIGURE will configure the demuxer into the system. The demuxer is removed by SYSCONFIG.sub.-- UNCONFIGURE. The Network Demuxer type is contained in indata.
NOTES
SYSCONFIG.sub.-- CONFIGURE should call the ns.sub.-- add.sub.-- demux network service to add the demuxer for the specified type of network interface. SYSCONFIG.sub.-- UNCONFIGURE should call ns.sub.-- del .sub.-- demux to remove the demuxer.
RETURN VALUE
Return values of ns.sub.-- add.sub.-- demux and ns del demux
RELATED INFORMATION
Interfaces: ns.sub.-- add.sub.-- demux(), ns.sub.-- del.sub.-- demux() OSF/1 System Extension Guide.
NAME
nd.sub.-- receive()
Process receive data from a NDD.
PARAMETERS
nddp
The address of the ndd structure from which the receive data originated.
Pointer to a mbuf chain containing the received packet.
DESCRIPTION
This function will process the incoming data and route the data to the appropriate user. It must be capable of interpreting the different types of frames that may be received from the interface type. The network device driver passes all valid received frames (as indicated by the hardware) to the network demuxer receive function.
NOTES
The nd.sub.-- receive() function must be interrupt safe. The first mbuf in the mbuf chain must be of M.sub.-- PKTHDR format. The m.sub.-- pkthdr.len field must be set to the total length of the packet. Multiple input packets may be passed to a demuxer by chaining with the m.sub.-- nextpkt field of a mbuf. If the input packet(s) is not passed on to a user, the nd.sub.-- receive function is responsible for freeing the buffers.
RETURN VALUE
There is no return value for this function.
RELATED INFORMATION
Network Device Drivers, mbuf services
NAME
nd.sub.-- status()
Process status information from a NDD.
PARAMETERS
nddp
Specifies-the ndd structure for the device from which this status originated.
status
Pointer to a ndd.sub.-- stat.sub.-- t status block. The status block contains device specific information on the status event. The status block is defined in sys/ndd.h
DESCRIPTION
When a status event has occurred on a network device, the NDD builds the appropriate status block and calls the status function. This function is responsible for routing the status information to the appropriate user(s).
NOTES
The nd.sub.-- status() function must be interrupt safe. The status block is passed by reference and is valid only for the duration of the call.
RETURN VALUE
There is no return value for this function.
RELATED INFORMATION
Network Demuxers
NAME
nd.sub.-- add.sub.-- filter()
Adds a receive filter for the specified device.
PARAMETERS
nddp
Specifies the ndd structure of the device.
filter Points to the receive filter to be added. The format is demuxer dependent.
len
The length in bytes of the receive filter pointed to by the filter parameter. The demuxer must verify that the length is correct.
ns.sub.-- user
Pointer to a ns.sub.-- user structure describing this user.
DESCRIPTION
The nd.sub.-- add.sub.-- filter() function is called from the ns.sub.-- add.sub.-- filter network service call. The nd.sub.-- add.sub.-- filter() routine will add the specified receive filter to the list of possible receive patterns. Following this the NDD ndd.sub.-- ctl function will be called with the NDD.sub.-- ADD.sub.-- FILTER operation and the value specified in the filter parameter.
RETURN VALUE
0--The operation was successful.
EEXIST--Receive filter is already in use.
EINVAL--Receive filter is invalid.
Other demuxer dependent return values.
RELATED INFORMATION
Interfaces: ns.sub.-- add.sub.-- filter()
NAME
nd.sub.-- del.sub.-- filter()
Deletes a receive filter for the specified device.
PARAMETERS
nddp
Specifies the ndd structure of the device for this delete request.
filter
Points to the receive filter to be deleted. The format is demuxer dependent.
len
The length in bytes of the receive filter pointed to by the filter parameter. The demuxer must verify that the length is correct.
DESCRIPTION
The nd.sub.-- del.sub.-- filter() is called from the ns.sub.-- del.sub.-- filter network service call. The nd.sub.--del.sub.-- filter() routine will remove the specified receive filter from the list of possible receive patterns. Following this the NDD ndd.sub.-- ctl function will be called with the NDD.sub.-- DEL.sub.-- FILTER operation and the value specified in the filter parameter.
RETURN VALUE
0--The operation was successful.
EINVAL--Indicates an invalid receive filter.
Other demuxer dependent return values.
RELATED INFORMATION
Interfaces: ns.sub.-- del.sub.-- filter() and ns.sub.-- add.sub.-- demux()
NAME
nd.sub.-- add.sub.-- status()
Adds a status processing function for the specified device.
PARAMETERS
nddp Specifies the ndd structure of the device for this add request.
statfilter
Points to the status filter to be added. The format is demuxer dependent.
len
The length in bytes of the status filter pointed to by the statfilter parameter.
ns.sub.-- statuser
Pointer to a ns.sub.-- statuser structure describing this user.
DESCRIPTION
The nd.sub.-- add.sub.-- status() function is called from the ns.sub.-- add.sub.-- status network service call. The nd.sub.-- add.sub.-- status() routine will add the specified status filter to the list of status processing functions. Following this the NDD ndd.sub.-- ctl function will be called with the NDD.sub.-- ADD.sub.-- STATUS operation and the value specified in the filter parameter.
RETURN VALUE
0--The operation was successful.
EINVAL--Status filter is invalid.
Other demuxer dependent return values.
RELATED INFORMATION
Interfaces: ns.sub.-- add.sub.-- status()
NAME
nd.sub.-- del.sub.-- status()
Deletes a status filter for the specified device.
PARAMETERS
nddp
Specifies the ndd structure of the device for this add request.
statfilter
Points to the status filter to be added. The format is demuxer dependent.
len
The length in bytes of the status filter pointed to by the statfilter parameter.
DESCRIPTION
The nd.sub.-- del.sub.-- status() function is called from the ns.sub.-- del.sub.-- status network service call. The nd.sub.-- del.sub.-- status() routine will use the specified status filter to remove the caller's status processing function. Following this the NDD ndd.sub.-- ctl function will be called with the NDD.sub.-- DEL.sub.-- STATUS operation and the value specified in the filter parameter.
RETURN VALUE
0--The operation was successful.
EINVAL--Invalid parameter.
Other demuxer dependent return values.
RELATED INFORMATION
Interfaces: ns.sub.-- del.sub.-- status()
NAME
nd.sub.-- response()
Build and send a response frame for an 802.2 LLC XID or TEST request.
PARAMETERS
nddp
The address of the ndd structure that the response should be sent on.
Pointer to a mbuf chain containing the XID or TEST packet.
llcoffset Offset of start of 802.2 LLC header.
DESCRIPTION
This function will process the incoming XID or TEST request by doing and MAC level processing. For instance, an 802.3 demuxer would have to reverse the source and destination fields in the 802.3 header. The caller of this function must have already done any 802.2 XID/TEST processing. After processing the packet, this function should call the ndd.sub.-- output function of the specified NDD.
NOTES
The nd.sub.-- response() function must be interrupt safe. The first mbuf in the chain must be of M.sub.-- PKTHDR format. The m.sub.-- pkthdr.len field must be set to the total length of the packet. Multiple packets may not be passed to this function by chaining with the m.sub.-- nextpkt field of a mbuf. If an error occurs the mbuf is freed and no response frame is transmitted.
RETURN VALUE
There is no return value for this function.
RELATED INFORMATION
Network Device Drivers
Network Device Driver Overview
A Network Device Driver (NDD) provides functions for transmitting data to and receiving data from the physical hardware. User applications interface to network devices by way of sockets or streams. A NDD consists the following entry point and functions.
ndd.sub.-- config--provides configuration functions.
ndd.sub.-- open--allocates system resources and initializes the device for reading and writing of data.
ndd.sub.-- close--resets the device to a known state and frees system resources.
ndd.sub.-- output--provides the means for transmitting data.
ndd.sub.-- ctl--various functions for controlling the device.
A NDD also interfaces to a demuxer through the following functions.
nd.sub.-- rcv--this function conforms to the syntax of the
nd.sub.-- receive function of a network demuxer
nd.sub.-- stat--this function conforms to the syntax of the nd.sub.-- status function of a network demuxer.
At the completion of configuration, the ns.sub.-- attach network service is called to place the specified device into the available NS device chain. The call to ns.sub.-- attach may be deferred until the required microcode, routing table, or other information is loaded.
Before the completion of termination, the ns.sub.-- detach network service is called to remove the specified device from the available NS device chain.
The following provides detailed implementation information for implementing the above listed network device driver routines.
NAME
ndd.sub.-- open function
opens the specified device.
PARAMETERS
nddp
Pointer to the ndd structure of the device that this open request is for.
DESCRIPTION
When the ndd.sub.-- open() function is called, the device driver should allocate any necessary system resources and attach the device to the network. Only one open is supported per device. The Network Demuxer receive and status functions are placed in the ndd structure by NS prior to this call.
NOTES
Transmitting and receiving data using the device can only be performed after the ndd.sub.-- open() function has successfully completed. At open time Network Device Drivers (NDDs) will do any necessary initialization in order to attach to the network. The NDD will block for a "reasonable" amount of time waiting for initialization to complete. A reasonable amount of time is adapter specific. For ethernet it may be one second while token ring may be one minute. If this time limit is reached, the NDD will set the NDD.sub.-- UP flag and return success to the caller. When initialization finally completes, asynchronous status will be sent to indicate the open has completed. The NDD.sub.-- RUNNING flag will also be set in the ndd.sub.-- flags field of the ndd structure. Only hard open errors are returned. If the connection fails for an asynchronous open, the NDD.sub.-- UP flag is turned off. The ndd.sub.-- open function is only called from the ns.sub.-- alloc network service.
RETURN VALUE
0--The operation was successful.
EBUSY--Device is already open.
ENOMEM--Unable to allocate required memory.
ENODEV--Invalid device.
ENOCONNECT--Indicates that open failed, unable to connect to the network.
RELATED INFORMATION
ndd.sub.-- close() function
NAME
ndd.sub.-- close function
Closes the specified device.
PARAMETERS
nddp
Pointer to the ndd structure of the device to be closed.
DESCRIPTION
When the ndd.sub.-- close() function is called, the device driver detaches the specified device from the network and frees previously allocated system resources. The device will not be detached from the network until the device's transmit queue is allowed to drain. That is, ndd.sub.-- close() will not return until all packets have been transmitted. If the device is inoperable at the time of the close, the device's transmit queue does not have to be allowed to drain. The NDD is responsible for freeing any buffers that are in it's possession at the time of the ndd.sub.-- close(). This function resets the device to a known state.
NOTES
The ndd.sub.-- close function is only called from the ns.sub.-- free network service.
RETURN VALUE
0--The operation was successful.
RELATED INFORMATION
ndd.sub.-- open() function
NAME
ndd.sub.-- output function
Outputs data to the specified network device.
PARAMETERS
nddp
Address of the ndd structure of the device.
A mbuf pointer of the packet(s) to be transmitted.
DESCRIPTION
The ndd.sub.-- output() function is called by a NS user to transmit data onto the network. Transmit data is passed in mbufs. On successful write requests, the NDD is responsible for freeing all the buffers associated with the request. If the call to ndd.sub.-- output fails, the NDD will not free the mbuf. If any of the chained packets can be transmitted, the write is considered successful and the NDD is responsible for all mbufs in the chain.
NOTES
ndd.sub.-- output() must be interrupt safe and cannot block. The first mbuf in the mbuf chain must be of M.sub.-- PKTHDR format and the m.sub.-- pkthdr.len field must be set to the total length (in bytes) of the packet. Multiple packets may be chained by using the m.sub.-- nextpkt field of a mbuf.
RETURN VALUE
0--the transmit was successful
EAGAIN--The transmit queue is full.
ENETDOWN--The network is permanently down.
ENETUNREACH--Network is temporarily unreachable.
RELATED INFORMATION
ndd.sub.-- open() function, mbuf services
NAME
ndd.sub.-- ctl function
provides device control functions
PARAMETERS
nddp Address of the ndd structure of the device.
cmd
Specifies the control operation to be performed. The commands are described below.
arg
Specifies the address of the control parameter block. The format is command specific.
len
Length (in bytes) of the arg parameter.
DESCRIPTION
NDD.sub.-- GET.sub.-- STATS
Retrieves generic and device specific statistics. arg is the address of a buffer in which statistics will be returned.
NDD.sub.-- ENABLE.sub.-- ADDRESS
Enables reception of packets with an alternate address (e.g., multicast). arg points to the multicast address to be enabled. The format of arg is specific to a NDD type. The NDD.sub.-- ALTADDRS flag should be set in the ndd.sub.-- flags field.
NDD.sub.-- DISABLE
--ADDRESS
Disables the receipt of an alternate address. The arg parameter points to the address to be disabled. The format of arg is specific to a NDD type. The NDD.sub.-- ALTADDRS flag should be reset in the ndd.sub.-- flags field of the ndd structure if this is the last alternate address.
NDD.sub.-- PROMISCUOUS.sub.-- ON
Turns on promiscuous mode for devices that support it.
NDD.sub.-- PROMISCUOUS OFF
Terminates promiscuous mode.
NDD.sub.-- ADD.sub.-- FILTER
This command is for use by devices that support hardware level filtering. The arg parameter points to the receive filter (e.g., sap) to be added to the filter list. The format of the filter is device type specific. The format of arg is specific to a NDD type.
NDD.sub.-- DEL.sub.-- FILTER
Removes a previously added filter from the hardware filter list. The arg parameter points to the filter to be removed. The format of arg is specific to a NDD type.
NDD.sub.--MIB.sub.-- SET
Set MIB(s) on the specified device. The arg parameter specifies the address of the ndd.sub.-- mib.sub.-- acc structure which contains the following fields: length: total length in bytes of ndd.sub.-- mib.sub.-- set parameter.
ndd.sub.-- mib.sub.-- set
count--the number of MIB variables to set.
The following fields are repeated "count" times.
mib--the MIB variable to set.
status--return status from the set operation. Values are defined in sys/ndd.h.
mib.sub.-- len.sub.-- length in bytes of the mib.sub.-- value field.
mib.sub.-- value--value of the MIB variable to be set.
NDD.sub.-- MIB.sub.-- QUERY
Determines which device specific MIBs are supported. The arg parameter points to a ndd.sub.-- mib.sub.-- acc structure.
length
total length in bytes of ndd.sub.-- mib.sub.-- query
ndd.sub.-- mib.sub.-- query
Pointer to device specific MIB structure. This portion of the structure will be filled with flags indicating the level of support for each MIB variable. These flags are defined in sys/ndd.h.
NDD.sub.-- MIB.sub.-- GET
Retrieves the values of all MIBs on the specified device. The arg parameter points to a ndd.sub.-- mib.sub.-- acc structure.
length
total length in bytes of ndd.sub.-- mib.sub.-- get
ndd.sub.-- mib.sub.-- get
Pointer to device specific MIB structure.
NDD.sub.-- ENABLE.sub.-- MULTICAST
Enables reception of all multicast packets. The NDD.sub.-- MULTICAST flag should be set in the ndd.sub.-- flags
field of the ndd structure.
NDD.sub.-- DISABLE.sub.-- MULTICAST
Disables the receipt of all multicast packets. The
NDD.sub.-- MULTICAST flag should be reset in the ndd.sub.-- flags field of the ndd structure.
NOTES
All device drivers conforming to the NDD Interface must recognize, but not necessarily support, each of the above command operations. Additional control operations may be specified by the individual NDD as required.
The ndd.sub.-- ctl() function must be interrupt safe. It must also maintain reference counts on control operations that require it (ex set promiscuous).
Privilege checks are not required of this function. They are done at a higher level.
RETURN VALUE
0--success
EOPNOTSUPP--The cmd is not supported.
EINVAL--An invalid parameter was specified.
ENETUNREACH--The network is currently unreachable.
ENETDOWN--The network is permanently down.
Common Demuxer Services Overview
Common Demuxer Services provide common functions so that Network Demuxers may be created more easily. These services consists of the following functions.
dmx.sub.-- 8022.sub.-- receive()
Routes received 802.2 LLC data to the appropriate user(s).
dmx.sub.-- status()
Distributes asynchronous status to the appropriate user(s).
dmx.sub.-- 8022.sub.-- add.sub.-- filter()
Adds a 802.2 receive filter for the routing of received data.
dmx.sub.-- 8022.sub.-- del.sub.-- filter()
Deletes a previously specified 802.2 receive filter.
dmx.sub.-- add.sub.-- status()
Adds a filter for routing of asynchronous status.
dmx.sub.-- del.sub.-- status()
Deletes a previously added status filter.
The following provides detailed implementation information for implementing the above listed common demuxer service routines.
NAME
dmx.sub.-- 8022.sub.-- receive()
Process receive data from a NDD.
PARAMETERS
nddp
The address of the ndd structure from which the receive data originated.
Pointer to a mbuf chain containing the received packet.
llcoffset
Specifies the offset in bytes to the 802.2 LLC header.
DESCRIPTION
This function will process incoming 802.2 data and route the data to the appropriate user. Routing of data is accomplished by using 802.2 filters that have previously been added through the ns.sub.-- add.sub.-- filter and dmx.sub.-- 8022.sub.-- add filter Network Services.
NOTES
The dmx.sub.-- 8022.sub.-- receive() function must be interrupt safe. The first mbuf in the chain must be of M.sub.-- PKTHDR format. The m.sub.-- pkthdr.len field must be set to the total length of the packet. Multiple input packets may not be passed to a demuxer by chaining with the m.sub.-- nextpkt field of a mbuf. If the input packet(s) is not passed on to a user, the dmx.sub.-- 8022.sub.-- receive function will free the buffers.
RETURN VALUE
There is no return value for this function.
RELATED INFORMATION
Network Device Drivers
NAME
dmx.sub.-- status()
Process status information from a NDD.
PARAMETERS
nddp
Specifies the ndd structure for the device from which this status originated.
status
Pointer to a ndd statblk status block. The status block contains device specific information on the status event. The status block is defined in sys/ndd.h.
DESCRIPTION
The dmx.sub.-- status Network Service is called from a Network Demuxer's status function. It is responsible for routing the status information to the appropriate user(s).
NOTES
The dmx.sub.-- status() function must be interrupt safe. The status block is passed by reference and is valid only for the duration of the call.
RETURN VALUE
There is no return value for this function.
RELATED INFORMATION
Network Demuxers
NAME
dmx.sub.-- 8022.sub.-- add.sub.-- filter()
Adds an 802.2 receive filter for the specified device.
PARAMETERS
nddp
Specifies the ndd structure of the device.
filter
Points to the 802.2 receive filter to be added.
ns.sub.-- user
Pointer to a ns.sub.-- user structure describing this user.
DESCRIPTION
The dmx.sub.-- 8022.sub.-- add.sub.-- filter() function is called from a Network Demuxer's add filter function. The routine will add the specified 802.2 LLC receive filter to the list of possible receive patterns.
RETURN VALUE
0--The operation was successful.
ENOMEM--Unable to allocate the required resources.
EEXIST--Receive filter is already in use.
EINVAL--Receive filter is invalid.
RELATED INFORMATION
Interfaces: ns.sub.-- add.sub.-- filter()
NAME
dmx.sub.-- 8022.sub.-- del.sub.-- filter()
Deletes an 802.2 LLC receive filter for the specified device.
PARAMETERS
nddp
Specifies the ndd structure of the device for this delete request.
filter
Points to a ns.sub.-- 8022 structure that specifies the receive filter to be deleted.
DESCRIPTION
The dmx.sub.-- 8022.sub.-- del.sub.-- filter() service is called from a Network Demuxer's delete filter function. It will delete the specified 802.2 LLC receive filter from the list of possible receive patterns.
RETURN VALUE
0--The operation was successful.
ENOENT--The specified filter was not found.
EINVAL--Indicates an invalid receive filter.
RELATED INFORMATION
Interfaces: ns.sub.-- del.sub.-- filter()
NAME
dmx.sub.-- add.sub.-- status()
Adds a status processing function for the specified device.
PARAMETERS
nddp
Specifies the ndd structure of the device for this add request.
statfilter
Points to the status filter to be added.
ns.sub.-- statuser
Pointer to a ns statuser structure describing this user.
DESCRIPTION
The dmx.sub.-- add.sub.-- status() function is called from a Network Demuxer's add status function. It will add the specified ns.sub.-- com.sub.-- status filter to the list of status processing functions. The dmx.sub.-- status service will use the status filter when determining if a status user should be called to process a status event.
RETURN VALUE
0--The operation was successful.
ENOMEM--Unable to allocate required resources.
EINVAL--Status filter is invalid.
RELATED INFORMATION
Interfaces: ns.sub.-- add.sub.-- status()
NAME
dmx.sub.-- del.sub.-- status()
Deletes a status filter for the specified device.
PARAMETERS
nddp
Specifies the ndd structure of the device for this add request.
statfilter
Points to the status filter to be added.
DESCRIPTION
The dmx.sub.-- del.sub.-- status() function is called from a Network Demuxer's delete status function. It will delete the specified ns.sub.-- com.sub.-- status filter from the list of status processing functions. The sid field of the ns.sub.-- com.sub.-- status structure will be used to remove the proper status filter. Because of this users of the common status functions must save the status filter from the dmx.sub.-- add.sub.-- status call.
RETURN VALUE
0--The operation was successful.
ENOENT--The specified filter was not found.
EINVAL--Invalid parameter.
RELATED INFORMATION
Interfaces: ns.sub.-- del.sub.-- status()
The following data structure definitions are used in conjunction with the above described routines for enabling the common data link interface.
NAME
ndd--Defines a Network Device Driver
FIELDS
ndd.sub.-- next
A pointer to the next NDD in the available NDD chain. This field should only be modified by the ns.sub.-- attach and ns.sub.-- detach network services.
ndd.sub.-- refcnt
A counter of the number of outstanding ns.sub.-- alloc's for the NDD. The ns.sub.-- alloc network service will increment this counter while the ns.sub.-- free service will decrement it.
ndd.sub.-- name
The name of this NDD, e.g., "en".
ndd.sub.-- unit
Used to identify a specific device of the same type. An ethernet NDD could have a name of "en" and units of 0 and 1 if there are two adapters in the system. Users of the NDD would then reference the adapters with names of "en0" and "en1"
ndd.sub.-- flags
Describes device state and characteristics. All these flags are set by the NDD. NDD.sub.-- RUNNING, NDD.sub.-- DEAD, and NDD.sub.-- LIMBO are mutually exclusive.
NDD.sub.-- UP
Set when a NDD is successfully opened. If an asynchronous open later fails, this flag should be reset.
NDD.sub.-- RUNNING
The NDD has been opened and is operational.
NDD.sub.-- DEAD
The adapter is not operative.
5O
NDD.sub.--LIMBO
The NDD is attempting to recover from a device error.
NDD.sub.-- BROADCAST
This adapter has media broadcast capability.
NDD.sub.-- SIMPLEX
The adapter can not hear it's own transmissions.
NDD.sub.-- DEBUG
The NDD is operating in debug mode.
NDD.sub.-- PROMISC
The adapter is in promiscuous mode.
NDD.sub.-- ALTADDRS
Adapter is receiving alternate addresses (e.g., multicast).
NDD.sub.-- MULTICAST
Adapter is receiving all multicast addresses.
ndd.sub.-- correlator
The field can be used by a NDD to correlate to an internal control structure.
ndd.sub.-- open
The address of the open function of the NDD.
ndd.sub.-- close
The address of the close function of the NDD.
ndd.sub.-- output
The address of the packet transmit function of the NDD.
ndd.sub.-- ctl
The address of the device control function of the NDD.
ndd.sub.-- rcv
A pointer to a demuxer receive function. A NDD will call this function when a packet is received. This field is initialized by the ns.sub.-- alloc network service.
ndd.sub.-- star
A pointer to a demuxer status function. A NDD will call this function when asynchronous status is available. This field is initialized by the ns.sub.-- alloc network service.
ndd.sub.-- mtu
The maximum packet size that can be transmitted.
ndd.sub.-- mintu
The minimum packet size that can be transmitted.
ndd.sub.-- type
The media type of the NDD, (e.g., NDD.sub.-- FDDI for a FDDI NDD). If an ethernet NDD supports 802.3 it should use a type of NDD.sub.-- IS088023. Otherwise it should be NDD.sub.-- ETHER. See sys/ndd.h for a list of possible values.
ndd.sub.-- addrlen
This field contains the length in bytes of physical address. For example, this would be 6 for ethernet.
ndd.sub.-- hdrlen
The total length in bytes of media and link level headers for this NDD. If headers are of variable length, the maximum length should be specified.
ndd.sub.-- physaddr
A pointer to the physical address of this device.
ndd.sub.-- genstats
The ndd.sub.-- genstats structure contains simple counters that are common to all NDD types.
ndd.sub.-- specstats
A pointer to NDD specific counters, If there are no device specific counters this field may be NULL.
ndd.sub.-- speclen
Length of device specific statistics pointed to by ndd.sub.-- specstats,
ndd.sub.-- demuxer
This field points to the network demuxer (struct ns.sub.-- demuxer) associated with the NDD, If NULL at the time of the first ns.sub.-- alloc, this field is initialized by Network Services. Otherwise the specified demuxer is used,
ndd.sub.-- nsdemux
If common demuxer services are used by the demuxer associated with the NDD, this field points to a demuxer control structure, Network Services will initialize this field.
ndd.sub.-- specdemux
A demuxer may initialize and use this field to point to a per NDD demuxer structure.
DESCRIPTION
The ndd structure defines a Network Device Driver and provides a linkage between a NDD and it's users, Each network device will have a ndd structure associated with it,
NOTES
The ndd structure is allocated and owned by the NDD. It must be pinned
FILES
sys/ndd.h
NAME
ndd.sub.-- genstats
Defines common NDD statistics
FIELDS
ndd.sub.-- ipackets.sub.-- msw
Most significant word of the number of packets received on this NDD.
ndd.sub.-- ipackets.sub.-- lsw
Least significant word of the number of packets received on this NDD.
ndd.sub.-- ibytes.sub.-- msw
Most significant word of the total received bytes.
ndd.sub.-- ibytes.sub.-- lsw
Least significant word of the total received bytes.
ndd.sub.-- ierrors
Number of receive errors encountered.
ndd.sub.-- opackets.sub.-- msw
Most significant word of the number of packets transmitted on this NDD.
ndd.sub.-- opackets.sub.-- lsw
Least significant word of the number of packets transmitted on this NDD.
ndd.sub.-- obytes.sub.-- msw
Most significant word of the number of transmitted bytes.
ndd.sub.-- obytes.sub.-- lsw
Least significant word of the number of transmitted bytes.
ndd.sub.-- oerrors
Number of output errors for this NDD.
ndd.sub.-- xmitintr.sub.-- msw
Most significant word of the count of transmit complete interrupts.
ndd.sub.-- xmitintr.sub.-- lsw
Least significant word of the count of transmit complete interrupts.
ndd.sub.-- recvintr.sub.-- msw
Most significant word of the count of receive data interrupts.
ndd.sub.-- recvintr.sub.-- lsw
Least significant word of the count of receive data interrupts.
ndd.sub.-- nobufs
Number of times that buffers were not available.
ndd.sub.-- xmitque.sub.-- max
Maximum number of transmits ever queued.
ndd.sub.-- xmitque.sub.-- ovf
Number of transmit queue overflow errors.
DESCRIPTION
The ndd.sub.-- genstats structure is used to keep simple counters that are common to all NDD types.
NOTES
The ndd.sub.-- genstats structure is part of the ndd structure.
FILES
sys/ndd.h
NAME
ndd.sub.-- statblk
Network Device Driver status block.
FIELDS
code
Defines the type of status block. Possible code values are in sys/ndd.h
NDD.sub.-- HARD FAIL
A hardware failure has occurred
NDD.sub.-- LIMBO.sub.-- ENTER
Entered Network Recovery Mode
NDD.sub.-- LIMBO.sub.-- EXIT
Exited Network Recovery Mode
NDD.sub.-- STATUS
Various status and event info option
This field can contain reason codes and/or other information. The option field format is specified on a per code basis,
NDD.sub.-- ADAP.sub.-- CHECK
Adapter checkstop condition NDD.sub.-- BUS.sub.-- ERROR
Bus error
NDD.sub.-- CMD.sub.-- FAIL
A device command has failed NDD.sub.-- PIO.sub.-- FAIL
A PIO operation has failed NDD.sub.-- UCODE.sub.-- FAIL
Failure of device microcode NDD.sub.-- TX.sub.-- ERROR
A transmission error has occurred NDD.sub.-- TX.sub.-- TIMEOUT
Transmission timeout error NDD.sub.-- RCV.sub.-- ERROR
A receive error has occurred NDD.sub.-- AUTO.sub.-- RMV
Auto-remove error detected NDD.sub.-- CONNECTED
Device open successful NDD.sub.-- BAD.sub.-- PKTS
A bad packet was received
DESCRIPTION
This structure is used to convey asynchronous device status information to CDLI users.
FILES
sys/ndd.h
NAME
ns.sub.-- user
Describes user characteristics for delivering input packets.
FIELDS
isr
Address of a function that handles input packets. The function will be called when there is receive data available that matches a user specified filter.
isr.sub.-- data
If the protoq parameter is NULL, this field will be passed to isr as a parameter.
protoq
The address of an input ifqueue. If this field is non-NULL, input packets will enqueued and the isr will be scheduled with schednetisr(netisr). If it is NULL, the isr will called directly as such:
isr(nddp, m, macp, isr.sub.-- data);
where:
nddp is the ndd structure from which the data originated.
m is the input packet.
macp points to the start of the packet.
isr.sub.-- data is the value specified in the
ns.sub.-- add.sub.-- filter call.
pkt.sub.-- format
This field specifies the packet header presentation of input packets. Possible values are:
NS.sub.-- PROTO
Remove all link-level headers. SNAP is not used.
NS.sub.-- PROTO.sub.-- SNAP
Remove all link-level headers including SNAP.
NS.sub.-- INCLUDE.sub.-- LLC
Leave LLC headers in place.
NS.sub.-- INCLUDE.sub.-- MAC
Do not remove any headers.
NS.sub.-- HANDLE.sub.-- NON.sub.-- UI
Automatically handle XID and TEST frames.
netisr
This field indicates a netisr number that will be used to schedule the users isr function. If netisr is non-zero, then the protoq must all be specified and the user must call the netisr.sub.-- add service to register the netisr.
ifp
If the caller is an IFNET driver, this field should be set to the appropriate ifnet pointer. The field should be NULL if the caller is not an IFNET driver.
DESCRIPTION
This structure is used to describe how packets are to be delivered to a user of a demuxer. The user initializes this structure before calling the ns.sub.-- add.sub.-- filter service.
FILES
sys/cdli.h
NAME
ns.sub.-- statuser
Describes an asynchronous status user of a device.
FIELDS
isr
Address of a function that handles asynchronous status. The function will be called when an asynchronous status event occurs. The isr will called directly as such:
isr(nddp, status, isr..sub.-- data);
where:
nddp is the ndd structure from which the status originated.
status is a pointer to a ndd.sub.-- statblk structure.
isr.sub.-- data is the value specified in the ns.sub.-- add.sub.-- status call.
isr.sub.-- data
This field will be passed to isr as a parameter.
DESCRIPTION
This structure is used to describe a status user. It is used to present asynchronous status when it occurs.
FILES
sys/cdli.h
NAME
ns.sub.-- 8022
802.2 LLC receive filter used by common demuxer services.
FIELDS
filtertype
Specifies the type of receive filtering. One of:
NS.sub.-- 8022.sub.-- LLC.sub.-- DSAP
filter on 802.2 DSAP field
NS.sub.-- 8022.sub.-- LLC.sub.-- DSAP.sub.-- SNAP
filter on 802.2 with SNAP
NS.sub.-- TAP
Receive all network packets from a NDD.
NS.sub.-- TAP users cannot specify to have packets queued, they are called directly and must copy the packet if they are interested in it.
dsap
The 802.2 LLC DSAP on which to filter.
orgcode
Specifies the organization code in the 802.2 SNAP header. This field is only valid if filtertype is set to NS.sub.-- 8022.sub.-- LLC.sub.-- DSAP.sub.-- SNAP.
ethertype
Specifies the ethertype field in the 802.2 SNAP header. This field is only valid if filtertype is set to NS.sub.-- 8022.sub.-- LLC.sub.-- DSAP.sub.-- SNAP.
DESCRIPTION
This structure is the receive filter that is used by the Common Demuxer Services. It allows filtering on networks that use 802.2 LLC for protocol multiplexing.
FILES
sys/cdli.h
NAME
ns.sub.-- comstatus
Status filter for Common Demuxer Services
FIELDS
filtertype
Specifies the type of status filter. It should be set to NS.sub.-- STATUS.sub.-- MASK.
mask
The status code mask value. When an asynchronous event has occurred on a device, the Network Demuxer will logical AND the specified mask field with the status block's code field. If the result is non-zero the status block will be delivered to the user.
sid
This field holds the status id that is calculated by the ns.sub.-- add.sub.-- status service. The user must keep track of this value and provide it to the ns.sub.-- del.sub.-- status service.
DESCRIPTION
This structure is the status filter that is used by the Common Demuxer services. It provides a user with a means of specifying which status events are of interest.
FILES
sys/cdli.h
NAME
ifqueue
Network packet queue.
FIELDS
ifq.sub.-- head
Pointer to the first mbuf in the queue.
ifq.sub.-- tail
Pointer to the last mbuf in the queue.
ifq.sub.-- len
The number of packets in the queue.
ifq.sub.-- maxlen
Maximum number of packets than can be queued on this queue.
ifq.sub.-- drops
Number of packets dropped because the queue was full.
DESCRIPTION
This structure is used to queue network packets for CDLI users that have requested queued service. Macros for manipulating ifqueues may be found in net/if.h. Packets are enqueued FIFO. The m.sub.-- nextpkt field of a mbuf is used as the queueing mechanism. Packets may be removed one at a time by using the IF-DEQUEUE macro.
FILED
net/if.h
NAME
nd.sub.-- dmxstats
Network Demuxer statistics.
FIELDS
nd.sub.-- nofilter
The number of packets dropped due to no user.
nd.sub.-- nobufs
The number of packets dropped because buffers were unavailable.
nd.sub.-- bcast
Number of broadcast packets received.
nd.sub.-- mcast
Number of multicast packets received.
DESCRIPTION
This structure contains statistics that are independent of demuxer type. The statistics provide usage and diagnostic counters.
FILES
sys/cdli.h
NAME
ns.sub.-- demuxer
Defines a Network Demuxer.
FIELDS
inuse
Indicates if a demuxer is currently being used. This field is only set by network services. It is incremented for each ns.sub.-- alloc and decremented for each ns.sub.-- free.
use.sub.-- nsdmx
This field is a boolean variable that should be set to TRUE if the demuxer is going to use the common demuxer services provided by CDLI. If the common services are not used, the valuse should be FALSE.
add.sub.-- filter
The address of the add filter function of the demuxer. This function will be called from the ns.sub.-- add.sub.-- filter network service.
del.sub.-- filter
The address of the delete filter function of the demuxer. This function will be called from the ns.sub.-- del.sub.-- filter network service,
add.sub.-- status
The address of the add status function of the demuxer. This function will be called from the ns.sub.-- add.sub.-- status network service.
del.sub.-- status
The address of the delete status function of the demuxer. This function will be called from the ns.sub.-- del status network service,
receive
The address of the packet input function of a demuxer. A NDD will call this function when receive data is available.
status
The address of the status processing function of a demuxer. A NDD will call this function when asynchronous status has occurred.
response
The address of a function that will be called when a XID or TEST frame response is required.
DESCRIPTION
This structure is used to register a Network Demuxer through the ns.sub.-- add.sub.-- demux service. It specifies the various entry points of a demuxer.
FILES
sys/cdli.h
NAME
nd.sub.-- config
Provides Network Demuxer configuration information.
FIELDS
version
The version number of the nd.sub.-- config structure. Set to ND.sub.-- CONFIG.sub.-- VERSION.sub.-- 1.
errcode
Return status from the demuxer configuration.
ndd.sub.-- type
Specifies the type of NDD this demuxer serves.
DESCRIPTION
This structure is used to convey configuration information to a Network Demuxer.
FILES
sys/cdli.h
To summarize, a uniform interface is provided that allows for enabling multiple data frameworks through the use of a single hardware adapter. This greatly simplifies operating system portability to various hardware platforms, as well as minimizing hardware adapter requirements to provide such multiple framework support.
It will be understood that the preferred embodiment herein presented is for illustrative purposes and, as such, will not be construed to place a limitation on the invention. Those skilled in the art will understand that changes in form and detail of the preferred embodiment herein disclosed may be made without departing from the spirit and scope of the claimed invention.
Claims
We claim:
1. A computer implemented method for exchanging data packets having end user data and protocol encapsulation data, between a plurality of software entities that send and receive the data packets in diverse formats, and at least one device of a particular device type, wherein the method is independent of operating system type and device type, comprising the steps of: (a) registering the device and a demuxer corresponding to the device with network services; (b) allocating use of the device by a first software entity with the network services; (c) returning by the network services a handle to the first software entity defining a path from the first software entity to the device, thereby defining the path for directly transmitting at least one data packet from the first software entity to the device; (d) registering by the first software entity a filter with the demuxer, the filter for identifying data packets belonging to the first software entity and received by the demuxer from the device; (e) repeating steps (a) through (d) for each of the plurality of software entities; (f) receiving at least one data packet by the demuxer from the device, whereby the demuxer forwards the received data packet from the device to the appropriate software entity without modifying the data packet based on a match of a portion of the data packet with the filter; and wherein the device comprises an adapter and a corresponding device driver; wherein the adapter comprises an ethernet, token ring, FDDI, FSC, SCSI, or ATM adapter; and wherein each of the software entities comprise TCP/IP, IPX, SPX, NetBios, OSI, SNA, or SCSI formats.
2. A computer system for exchanging at least one data packet having end user data and protocol encapsulation data between a plurality of software entities that send and receive the data packets in diverse formats, and at least one device of a particular device type, comprising: (a) network services for registering the device and a demuxer corresponding to the device; (b) the network services for allocating use of the device by a first software entity; (c) the network services for returning a handle to the first software entity defining a path from the first software entity to the device, thereby defining the path for directly transmitting at least one data packet from the first software entity to the device; (d) the first software entity for registering a filter with the demuxer, the filter for identifying data packets belonging to the first software entity and received by the demuxer from the device; (e) the demuxer for receiving at least one data packet from the device, whereby the demuxer forwards the received data packet from the device to the appropriate software entity without modifying the data packet based on a match of a portion of the data packet with the filter; and wherein the device comprises an adapter and a corresponding device driver; wherein the adapter comprises an ethernet, token ring, FDDI, FCS, SCSI, or ATM adapter; and wherein each of the software entities comprises TCP/IP, IPX, SPX, NetBios, OSI, SNA, or SCSI formats.
Patent Citations (14)
| Patent | Date | Inventor | Cited By |
|---|---|---|---|
| US4306289 | 1981-12-01 | Lumley | |
| US4330847 | 1982-05-01 | Kuseski | |
| US4400778 | 1983-08-01 | Vivian et al. | |
| US4706081 | 1987-11-01 | Hart et al. | |
| US5063494 | 1991-11-01 | Davidowski et al. | |
| US5084877 | 1992-01-01 | Netravali et al. | |
| US5088032 | 1992-02-01 | Bosack | |
| US5096480 | 1992-03-01 | Fenner | |
| US5202983 | 1993-04-01 | Orita et al. | |
| US5206951 | 1993-04-01 | Khoyi et al. | |
| US5249292 | 1993-09-01 | Chiappa | |
| US5265239 | 1993-11-01 | Ardolino | |
| US5278978 | 1994-01-01 | Demers et al. | |
| US5327544 | 1994-07-01 | Lee et al. |
Non-Patent Literature (5)
- "Dynamic Network Switch Tables", Ibm Technical Disclosure Bulletin, vol. 32, No. 10B, Mar. 1990, pp. 378-379.
- "BSD Socket-Based Message Queue IPC System Implementation", IBM Technical Disclosure Bulletin, vol. 34, No. 9, Feb. 1992, pp. 168-173.
- "Multiple Instances of a Device Driver in the Kernel", IBM Technical Disclosure Bulletin, vol. 32, No. 10B, Mar. 1990, pp. 382-383.
- "Synchronous and Asynchronous Driver Modes", IBM Technical Disclosure Bulletin, vol. 28, No. 11, Apr. 1986, pp. 5058-5059.
- Abstract of C. Torek, "A New Framework for Device Support in Berkeley Unix", UKUUG, UNIX--The Legend Evolves. Proceedings of the Summer 1990 UKUUG Conference, pp. 117-126.