Background of the Invention
This invention relates to interfaces between multi-protocol network host computers and printers on the network. The invention is disclosed particularly in relation to a network adapter circuit having a first physical connection to the multi-protocol computer network, a second physical connection to a printer controller, and an intermediate portion for separately processing print job information and priority information presented in each different network protocol.
In accordance with the embodiment of the invention to be described, a network adapter interfaces between a network of host computers and a printer to communicate priority information in accordance with the Network Printer Alliance Protocol. The published Network Printer Alliance Protocol (NPAP) defines a bi-directional means for communication between a host computer and a printer. The NPAP compliant data and commands are transported under the various network protocols such as TCP/IP.
The details of the NPAP am contained in the NPAP Specification Level 1, Revision N, Feb. 1, 1994. This NPAP Specification is incorporated herein by reference. Copies of the specification are, for example, presently available via anonymous FTP from ftp.lexmark.com [192.146.101.4]. The employment of the NPAP means of communication is described in a number of examples for a single protocol network adapter interface in a commonly assigned U.S. patent application Ser. No. 08/350,860, now U.S. Pat. No. 5,550,957, entitled MULTIPLE VIRTUAL PRINTER NETWORK INTERFACE, filed Dec. 7, 1994, which is also incorporated herein by reference.
In the embodiment to be described hereinafter, the network adapter supports four network protocols: LexLink, Novell NetWare, Apple Talk and TCP/IP. The adapter may receive data from each of these protocols simultaneously, but only one of the protocols may have access to the printer at any one time. This access is called capturing the printer. When one protocol captures the printer (for a print job) the others are buffered until they get their turn. This poses a problem for the timely processing of priority inquiries utilizing NPAP. If these priority requests are processed in the same fashion as print data, the response from the printer may be delayed significantly.
In accordance with one aspect of the invention, the solution to this problem entails having an alternate channel through the network adapter and in the printer that will allow N PAP queries to bypass the print job information. The alternate channel must function so that NPAP priority information can bypass print data whether the print data is from that network protocol or another network protocol so that the priority information can be processed immediately. In practice, an alternate channel of communication is provided through each module of network protocol code employed by the network adapter.
Brief Description of the Drawings
FIG. 1 is a functional diagram of the software of a network adapter in accordance with the present invention;
FIG. 2 is a flowchart of the operation of the Printer Device software of FIG. 1 for sending data from a Protocol module of code to a printer;
FIG. 3 is a flowchart of the operation of the Printer Device software of FIG. 1 for sending data from the printer to a Protocol module of code;
FIG. 4 is a flowchart of the relevant function of an illustrative Protocol of FIG. 1 for sending data from the Media Access Control code to the Printer Device code; and
FIG. 5 is a flowchart of the operation of the exemplary Protocol of FIG. 4 for sending data from the Printer Device code to the Media Access Control code.
Detailed Description
In the above-identified co-pending commonly assigned patent application, there is a description of the operation of a network adapter utilizing a single network protocol (Novell NetWare) and describing the operation of a network adapter, or interface, which includes a microprocessor and an application specific integrated circuit (ASIC) for assisting in data transfer. In that description, the operation of the transfer of data from the network adapter to the network and from the network adapter to an attached printer is described in terms of a single software structure for the illustrative single protocol, in that case Novell NetWare. In the present interface arrangement, the network adapter performs the same functions at the interfaces by employing Media Access Control (MAC) code and Printer Device code, each module interfacing with all of the Protocol modules of code. The present network adapter supports an exemplary four network protocols by including a Protocol module of code for each network protocol.
With reference to FIG. 1, the code executed by the network adapter microprocessor is organized with a MAC portion 11 interfacing with the network 12, and with a Printer Device portion 13 interfacing with the controller of the printer 14. The MAC code 11 receives data from the multi-protocol network and routes it to the proper Protocol. The Printer Device code 13 is "captured" by a Protocol and takes data from the Protocol and sends it to the printer 14. In the illustrated network adapter, the Protocol 16 is for LexLink, the Protocol 17 is for Novell NetWare, the Protocol 18 is for Apple Talk and the Protocol 19 is for TCP/IP.
The network adapter can receive data in each of these network protocols simultaneously, but only one of the Protocol modules may have access to the printer at any one time. This access is called capturing the printer. When one Protocol captures the printer (for a print job), the data routed to other Protocols is buffered until that Protocol can capture the printer. This poses a problem for the timely processing of priority information such as exchanges of printer status information, since a priority printer status query may be received in one Protocol while another Protocol has captured the printer for a print job. If the print job is allowed to complete before the priority information is passed to the printer, then a response from the printer will be significantly delayed.
In accordance with the present invention, an alternate channel of communication through each Protocol is provided so that priority information can bypass print data from its own and other Protocols and be processed immediately. As described in the above-mentioned co-pending commonly assigned patent application, the communication with the printer, and with appropriate hosts on the network, is in the present instance established by the use of commands and data conforming to the NPAP specification. The NPAP is used herein to provide a means for returning printer status information to a host computer from a printer and for sending queries from a host computer to a printer for status information. Such priority information and queries conforming to the NPAP, as well as print job information contained in NPAP "wrappers", are communicated through the network adapter.
In the above-identified co-pending patent application, such priority printer status messages and inquiries are handled in a single network protocol network adapter separately from the processing of print job data. This permits asynchronous communication between the printer and each host utilizing the printer regardless of a "busy" condition at the printer while the printer is receiving print jobs. In the system to be described hereinafter, a multiple protocol network adapter permits asynchronous communication of priority information between the NPAP-compliant printer and each NPAP-compliant host in a multiple protocol network environment.
In order to implement the provision of an alternate communication channel to the printer in the network adapter, each Protocol is provided with an alternate path through itself from the MAC to the Printer Device, and the Printer Device has an alternate path to the printer.
To create the alternate channel to communicate priority information between the printer 14 and the Printer Device code 13, multiple modes of communication over the connection between the printer and the network adapter are used. These modes include data mode for normal print jobs, NPAP status mode for NPAP queries and responses, and Device Status Alert (DSA) mode for asynchronous device status alerts from the printer. The details of communication between Printer Device 13 and the printer 14 are as described in the above-identified co-pending patent application, except that in the present multi-protocol situation, the Printer Device code performs the communication functions for all of the Protocols rather than a single Protocol.
With further reference to FIG. 1, when a Protocol such as the Protocol 16 for LexLink has a print job, it captures the Printer Device 13 and sends it the print job. The Printer Device sends the print job data to the printer in data mode. If an NPAP query comes in to this Protocol (or another Protocol), that Protocol sends the query to the Printer Device 13 in a different way, or on an "alternate channel". This causes the Printer Device 13 to interrupt data mode communication with the printer 14 and enter NPAP status mode. When in this mode, the Printer Device 13 sends the NPAP query to the printer and waits for the response. It then sends the response back to the Protocol, such as 16, which sent the query and returns to data mode communication with the printer 14 to continue the print job.
When the printer 14 has an event occur calling for a priority alert communication to host computers on the network, it sends a Device Status Alert (DSA) to the adapter. The printer interrupts data mode, if necessary, to enter DSA mode, and in this mode the printer 14 sends the DSA to Printer Device 13 and then returns to data mode. Printer Device 13 then sends the DSA to each Protocol module on the alternate channel for that Protocol.
LexLink is a print protocol based on the IEEE 802.2 standard. The LexLink protocol is used to implement printing in the Windows NT Advanced Server, OS/2 Lan Manager and OS/2 Lan Server network operating system environments. When NPAP data is delivered to and from the network adapter in the LexLink protocol, it is encapsulated within a LexLink packet, which consists of a header and data. The details of the LexLink protocol are not pertinent to the present invention and will not be described herein.
In practice, bit seven of the second byte of a LexLink header is set (="1") to indicate an NPAP packet, and bit six of the second byte of the LexLink header is set to designate "alternate channel", or priority, NPAP data. For the LexLink protocol, a network packet is addressed as being for the alternate channel by setting the alternate channel bit in the LexLink header. Whenever a packet is received by the Protocol module 16 for LexLink with this bit set, the packet is immediately sent to the Printer Device 13 on the alternate channel. When the Printer Device 13 sends the LexLink Protocol module a packet on the alternate channel (an NPAP query response or a DSA), the LexLink Protocol module sets the alternate channel bit in the LexLink header of the packet and sends it to the host through the MAC 11.
With reference now to FIG. 2, the operation of the Printer Device 13 code in receiving data from a Protocol module 16-19 is described. The Printer Device receives data (21) from one of the Protocols and determines if it is alternate channel data (22). If it is alternate channel data to be communicated immediately to the printer, Printer Device sends the data (23) to the printer in NPAP status mode and returns (30). If the data is not alternate channel data, the Printer Device determines if it is a capture of the printer (24).
If this data is a capture of the printer, the Printer Device captures the printer (25)and returns (30). If the data is not a capture of the printer, it is determined if this is a release (26) of the printer; and if it is a release of the printer, the printer is released (27) and the Printer Device returns (30). This would indicate the completion of a print job.
If the data is not a release of the printer, the Printer Device determines if the printer 14 is currently captured by the sending Protocol (28). If so, the data is sent to the printer in data mode (29) and the Printer Device returns (30). If the printer 14 is not currently captured by the Protocol sending the data, Printer Device merely returns (30).
Turning now to FIG. 3, the operation of the Printer Device code for receiving data from the printer 14 is described. Printer Device receives data from the printer (31) and determines if the data is received in DSA mode (32). If so, the Printer Device sends the device status alert to each protocol on the alternate channel for that protocol (33) and returns (37). If the data was not received in DSA mode, Printer Device determines if the data was received in NPAP status mode (34). If so, the data is sent to the Protocol which was the source of the status request as an NPAP response on the alternate channel for that Protocol (35), and Printer Device returns (37).
If the data was not received in NPAP status mode, the Printer Device sends the data to the Protocol currently capturing the printer on the normal channel (36). The Printer Device then returns (37).
With reference now to FIG. 4, handling of data by an exemplary Protocol module, in this case the LexLink Protocol module, as that data is received from the MAC is described. After a packet is received from the MAC (41), the LexLink Protocol determines if the alternate channel bit is set in that packet (42). If so, the packet is sent to Printer Device on the alternate channel (43), and the Protocol returns (45). If the alternate channel bit is not set, the LexLink Protocol processes the data normally to send print job data to the Printer Device (44). The LexLink Protocol then returns (45).
In FIG. 5, the operation of the LexLink Protocol module in handling data received from the printer is described. After data is received from the Printer Device (46), the LexLink Protocol determines if it is an alternate channel DSA (47). If so, the protocol sends the DSA to one or more host computers through the MAC with the alternate channel bit set in the LexLink header and with the packet marked as a DSA (48). The Protocol then returns (52). If the data is not an alternate channel DSA, the LexLink Protocol then determines if the data is an alternate channel NPAP response (49). If so, the Protocol sends the data to the requesting host through the MAC with the alternate channel bit set in the LexLink header and with the packet marked as an NPAP response (50). The Protocol then returns (52). If the data is not an alternate channel NPAP response, the LexLink Protocol handles the data, such as to send a non-NPAP communication to a host (51). The protocol then returns (52).
With regard to the NetWare Protocol 17, after a packet is received from the MAC 11, the Protocol 17 inspects the Internetwork Packet
Exchange (IPX) header. The Source Socket value in the IPX Source Address field uniquely identifies the type of data contained in the packet. Therefore, the Protocol 17 does not need to inspect the NPAP data section of the packet. If the Source Socket specifies an NPAP command, the Protocol 17 sends the data to the NPAP command processor, or alternate channel, of the printer port and returns. If the Socket specifies print data, the Protocol 17 sends the data to the print processor, or regular channel, of the printer port and returns.
The Protocol 17 handles both Device Status Alerts (DSAs) and NPAP command replies with a single sending process. After data is received from the Printer Device, it is encapsulated in an IPX datagram and sent to one or more workstations. The Destination Socket field of the IPX Destination Address field is used to differentiate between DSA and NPAP command replies. The value used for the Destination Socket in the reply is defined by the user when the NPAP command is issued. Note that the user registers for DSA's via an NPAP command. Therefore, DSA's are received by the user on Socket "X", and NPAP replies are received by the user on Socket "Y". Values for X and Y are user defined but must not be equal. After sending the DSA or NPAP reply, the sending process returns.
With regard to the operation of the Apple Talk Protocol 18, to handle NPAP priority information within the Apple Talk Protocol, an NPAP listening and responding entity, separate from the printing entity, is created through the Apple Name Binding Protocol (NBP). In effect, the MAC code 11 communicates with different entities within the Apple Talk Protocol 18 for NPAP priority information and for print job information.
A unique address within the Apple Talk Protocol 18 is provided to communicate with hosts on the network wishing to use the "alternate channel". The entity in the Apple Talk Protocol is referred to as "NPA Responder". NPA Responder replies to all NBP-compliant queries that use the Apple Talk type field "NPA Responded". Print job information would normally be communicated to a second, separate, entity within the Apple Talk Protocol 18.
All priority NPAP requests and responses are communicated in packets using the Apple Talk Transport Protocol (ATP). ATP provides loss-free delivery of packets from a source to a destination. ATP packets include a header that has a four-byte user-definable area and a 0 to 578 byte data block. The priority NPAP requests and responses are differentiated from one another through the use of the four "user bytes". Since the NPA Responder entity in the Apple Talk Protocol 18 is separate from the Apple Talk Protocol printing entity, there is no need to parse incoming packets to separate priority NPAP packets from print data packets within the Protocol.
Considering the ATP packet header in more detail, byte zero in the user-byte area is a command byte, in which bit seven is a reply indicator. If the bit seven is a "one", this indicates that the message is a command reply, and if the bit seven is a zero, this indicates that the message is a command or an Alert. The remaining bits of the command byte are used to indicate a command type. A hexadecimal one indicates an NPAP request, and a hexadecimal two indicates a Device Status Alert. In the present form of the Protocol, byte one of the user-byte area is unused, and bytes two and three are used for sequence numbers for multiple packet responses. The NPAP packet data is contained in the 0 to 578 byte data block.
The TCP/IP Protocol 19 uses a UDP port (9300) for its alternate channel. When the Protocol 19 receives an NPAP request through the MAC, the source IP address and source UDP port of the request is saved. The NPAP reply from the Printer 14 through Printer Device 13 is sent to this saved address and saved UDP port. Packets received by the Protocol 19 on UDP port 9300 are screened to ensure that they are NPAP packets and then sent through the Printer Device to the printer's alternate channel.
The Protocol 19 prepends a header to an NPAP response or NPAP Device Status Alert (DSA) which includes an acknowledgement number and sequence numbering information (if the NPAP response had to be fragmented when sent over the network). The host acknowledges a DSA by sending the DSA's acknowledgement number to the Protocol's UDP port 9301. If an acknowledgement is not received, the Protocol will retransmit the DSA up to six times at 10 second intervals until acknowledged.