home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Current Shareware 1994 January
/
SHAR194.ISO
/
networks
/
pe3ai50.zip
/
PE3AI50.DOC
< prev
Wrap
Text File
|
1993-08-09
|
16KB
|
446 lines
AI-LANBIOS Low-Level Driver For XIRCOM Pocket Ethernet Adapter III
(PE3AI50.DOC)
-----------------------------------------------------
(C) Copyright 1991 ARTISOFT, Inc.
(Revised 6/26/93)
Portions (C) Copyright 1993 Xircom, Inc.
INTRODUCTION
============
The PE3AI50.COM low-level AI-LANBIOS driver allows you to use your Xircom
Pocket Ethernet Adapter III in a LANtastic 5.x network. The driver interfaces
with the following models:
PE3-10B2 Thin Ethernet adapter
PE3-10BT Twisted Pair Ethernet adapter
In order for the Xircom adapter to operate with the LANtastic Network
Operating System (NOS), you must first install the adapter as instructed in
the Xircom installation guide, then run the supporting software (PE3AI50.COM
and AILANBIO.EXE). PE3AI50.COM communicates with the Xircom adapter, while
AILANBIO.EXE provides high-level communications across the local area
network. Because of this, you cannot run any network software until after
you load PE3AI50.COM and AILANBIO.EXE. (Note: For information on running
AILANBIO.EXE, refer to your LANtastic manuals.)
There are command line switches that you can use when you run PE3AI50.COM and
AILANBIO.EXE. These switches allow you greater flexibility in using these
programs. For information on the AILANBIO.EXE command line options refer
to SWITCHES.DOC in your LANtastic installation directory. For information
on PE3AI50.COM command line switches, refer to "PE3AI50.COM COMMAND LINE
OPTIONS" in this file.
RUNNING PE3AI50.COM
===================
The syntax for running PE3AI50.COM is
PE3AI50[switches . . . ] [ ; comment]
where "switches" denotes any optional command line switches. If you are
using more than one switch in a command line, use a space or a forward
slash (/) to separate the arguments. If a switch takes a value (such as
when you designate the DOS multiplex number with the MPX= switch) the
switch must be followed by an equal sign (=) or a colon (:). All switch
values are checked to make sure they are valid. Illegal values produce
error messages.
These are valid switch formats:
SWITCH
/SWITCH
SWITCH:VALUE
/SWITCH=VALUE
You would use one of the first two formats for a switch that does not take
a value. For example:
PE3AI50/HELP
You would use the third or fourth formats for a switch that takes a value.
Such as:
PE3AI50/MPX=D7
PE3AI50.COM COMMAND LINE OPTIONS
================================
The valid PE3AI50.COM switches appear below. The letters "ddd" denote that
you must provide a decimal number. The letters "hh" denote a required
hexadecimal value. Values enclosed in brackets "[]" indicate default
values if the switch is omitted. Values after the brackets denote the
valid range of variables for the switch.
----------
@switch-file
This option specifies that further switches are to be taken from a
switch file. Any switches after the @switch-file name on the command line
will be used, and those switch settings take precedence over any settings
in the switch file. You may invoke switch files from within switch files
as often as you wish. The file should contain valid switches and may contain
comment characters (;) at the beginning of each line or after switches.
For example,
PE3AI50 @setup
The file SETUP contains
; PE3AI50.COM AI-LANBIOS driver setup file
;
MPX=D7 ; Use Multiplex number D7
IRQ=5 ; Use interrupt request 5
VERBOSE ; Display verbose information
----------
HELP or ?
This switch instructs PE3AI50.COM to display information about the valid
command line switches, but does not install the PE3AI50.COM driver. For
example,
PE3AI50/help
PE3AI50 ?
See the messages section for a detailed description of the HELP display
output.
---------
IEEE
This switch causes all transmitted packets to be in the IEEE 802.3 standard
format instead of the default XEROX format. When using this switch
PE3AI50.COM will receive both XEROX and IEEE 802.3 packets.
----------
IRQ=d [auto] Range 5 to 7
This switch specifies the interrupt request (IRQ) level used by the parallel
port. Normally this switch is not required, since by default the driver
automatically determines the IRQ level of the port. However, in certain
cases, such as having devices connected to more than one parallel port, a
unique IRQ must be specified. The IRQ switch value must match the IRQ of
the parallel port used by the adapter.
----------
LINKDISABLE
This switch, only applicable to the PE3-10BT model, tells the adapter to not
check for link integrity upon reception or transmission of a packet. It
should only be used if a PE3-10BT adapter is connected to older 10-BaseT
hardware that does not support link integrity.
----------
LPT=d [auto] Range 1 to 3
This switch allows you to specify the parallel port where the Pocket Ethernet
Adapter III is installed. Normally this switch is not required, since by
default the driver automatically determines the LPT number of the port in
use. However, if the automatic process adversely affects a device on another
parallel port or fails to detect the adapter, you will need to use this switch
to specify a port.
----------
MPX=hh [C7] C0-FF
This switch specifies the DOS multiplex (MPX) number to use for
communication with AILANBIO.EXE. You will need to change this value only
if the default MPX number is in use by another application or NETBIOS.
Multiplex numbers 00 through BF are reserved for DOS use; therefore, you
must use a multiplex number between C0 and FF.
----------
NON
This switch forces the driver to operate in non-bidirectional parallel port
mode. Normally this switch should not be used, since the driver automatically
tests the parallel port and determines the optimum mode for that port.
However, you may wish to try the NON switch if improper operation is
encountered with the automatically selected mode.
----------
PACKET_SIZE=dddd [1500] 600-1500
This switch specifies the maximum size of transmitted IEEE 802.3 or
XEROX-type packets. You may need to change this value when using certain
bridges that do not support the full 1500-byte packet size. Even when you
reduce the packet size, the low-level driver can still receive larger packets.
----------
REMOVE
This switch removes PE3AI50.COM from memory. You must remove TSR programs in
the opposite order they were loaded. For example, if you loaded PE3AI50.COM
and then AILANBIO, you must remove AILANBIO before PE3AI50.COM.
----------
VERBOSE
This switch causes the PE3AI50.COM driver to be installed and detailed
information about the configuration of the PE3AI50.COM driver to be displayed.
See the messages section for a detailed description of the VERBOSE output.
---------
XEROX
This switch causes all transmitted packets to be in the XEROX format. This
switch isn't necessary since by default the XEROX format is used. When using
the XEROX format, PE3AI50.COM will receive both XEROX and IEEE 802.3 packets.
PE3AI50.COM MESSAGES
====================
The PE3AI50.COM driver produces two types of messages: Informative and Error.
All error messages are preceded by the text "ERROR:" and in those cases
the PE3AI50.COM driver is not installed.
--------
MESSAGE:
Xircom Pocket Ethernet Adapter III
PE3AI50 AI-LANBIOS(R) V4.05 Compatible Driver (Vx.xx)
(C) Copyright 1993 by ARTISOFT Inc. Portions (C) Copyright 1993 Xircom, Inc.
This message appears each time the low-level driver is invoked.
--------
MESSAGE:
Hardware Configuration LPT1:, IRQ7, Bidirectional
---- PE3AI50 AI-LANBIOS(R)-Compatible Driver Installed ----
This or a similar message appears after the low-level driver is
successfully installed.
--------
MESSAGE:
---- PE3AI50 AI-LANBIOS(R)-Compatible Driver NOT Installed ----
This message appears if the low-level driver is not installed. The driver
will not be installed if HELP information is displayed or an error occurred.
--------
MESSAGE:
Command line /verbose
IEEE 802.3 node address 0080C7OC69AE MPX interface number C7
Network packet size 1500 Bytes of memory used 9968
Packet type XEROX
Hardware Configuration LPT1:, IRQ7, Bidirectional
This message appears if the VERBOSE switch is specified. The values
displayed specify how the low-level driver is configured.
--------
MESSAGE:
Valid command line switches:
@<filename> Read command line switches from file
HELP or ? Display this help information
REMOVE Unload driver from memory
VERBOSE Display detailed configuration information
MPX MPX interface number in hex (C0 - FF, default C7)
PACKET_SIZE Maximum packet size in decimal (600 - 1500, default 1500)
XEROX Set the packet type to XEROX (Default)
IEEE Set the packet type to IEEE 802.3
IRQ Interrupt used by the adapter
LPT LPT port number (1, 2, or 3)
NON Force non-bidirectional parallel port mode
LINKDISABLE Disable link integrity
Note: The parallel port number, interrupt, and optimum mode are determined
automatically unless overridden with the LPT, IRQ, and NON switches.
This message is displayed when the HELP or ? switch is used. Each valid
switch is listed with the acceptable range of values (if any) and the base
(hex or decimal) that the numbers must be entered in. The low-level driver
is not installed when this switch is used.
-------
MESSAGE:
---- PE3AI50 AI-LANBIOS(R)-Compatible Driver REMOVED ----
The PE3AI50.COM driver has been removed from memory.
--------
ERROR: Can't REMOVE -- PE3AI50 AI-LANBIOS(R)-Compatible Driver is not loaded
Meaning: You have issued the PE3AI50/REMOVE command and do not have
PE3AI50.COM loaded into memory.
Remedy: Only issue this command after the program is loaded.
--------
ERROR: Can't REMOVE -- AI-LANBIOS(R) still installed
Meaning: You have issued the PE3AI50/REMOVE command while AILANBIO.EXE
is still in memory.
Remedy: Remove AILANBIO.EXE before removing PE3AI50.COM.
-------
ERROR: Can't REMOVE -- interrupts re-hooked
Meaning: You have attempted to remove PE3AI50.COM and the interrupts are in
use by another TSR, or PE3AI50.COM was not the last TSR loaded.
Remedy: Remove any TSRs loaded after PE3AI50.COM. For example, if you load
PE3AI50.COM then AILANBIO.EXE, you must first remove AILANBIO.EXE,
then you can remove PE3AI50.COM.
------
ERROR: Cannot open switch file - @file
Meaning: The file "file" cannot be opened as an indirect switch file.
Remedy: The file must exist before it can be used as an indirect file.
-------
ERROR: Installed PE3AI50 is different version
Meaning: You have loaded a version of the PE3AI50.COM program and attempted to
remove it from memory with the /REMOVE switch. The version with
which you are attempting to remove PE3AI50.COM is not the same
version that was loaded.
Remedy: Remove PE3AI50.COM with the same version of the program that was
loaded.
------
ERROR: Illegal switch - ??????=nnnn
Meaning: The switch ??????=nnnn is not a recognized switch.
Remedy: You may only specify legal switches on the command line.
------
ERROR: Illegal character after switch name - ??????xnnnn
Meaning: The switch ?????? is followed by a character other than "=" or ":",
or the switch does not take a value.
Remedy: Only use the characters "=" or ":" to specify switch values and
do not place characters after switches that do not take values.
------
ERROR: Illegal digit in switch value - ??????=nnnn
Meaning: An illegal digit (character) occurrred in the numeric
switch value.
Remedy: You must restrict numeric decimal values to the numbers 0-9.
You must restrict hexadecimal values to the numbers 0-9 and the
letters A-F.
------
ERROR: Switch value not in range - ??????=nnnn
Valid range is ssss to eeee
Meaning: The value nnnn is not in proper range. The value "ssss"
represents the lowest acceptable value and the value "eeee"
represents the highest acceptable value.
Remedy: Limit your range of values to the acceptable range.
------
ERROR: MPX number hh is already in use - Try another number
Meaning: The multiplex (MPX) interrupt number hh is being used by another
application or low-level driver.
Remedy: Try another MPX number.
------
ERROR: A Pocket LAN Adapter could not be found
Meaning: PE3AI50.COM was unable to communicate with the Pocket Ethernet
Adapter III.
Remedy: Make sure the adapter is connected to your computer and powered up.
Also be sure any command line switches match the hardware
configuration. If the error persists, contact Xircom Technical
Support.
------
ERROR: A Pocket LAN Adapter driver is already loaded
Meaning: You have attempted to load a second copy of PE3AI50.COM into the same
adapter.
Remedy: Load only one copy of PE3AI50.COM per adapter.
------
ERROR: Pocket Ethernet Adapter III Address EEPROM unreadable.
Meaning: PE3AI50.COM was unable to read the node address in the adapter EEPROM
chip.
Remedy: Contact Xircom Technical Support.
------
ERROR: Pocket Ethernet Adapter III failed initialization.
Meaning: PE3AI50.COM was unable to reset the adapter's NIC chip.
Remedy: Try loading the program with the NON switch. If that doesn't work,
contact Xircom Technical Support.
------
ERROR: Pocket Ethernet Adapter III failed memory test.
Meaning: PE3AI50.COM was unable to read or write properly to the adapter's
on-board RAM.
Remedy: Try loading the program with the NON switch. If that doesn't work,
contact Xircom Technical Support.
------
ERROR: The selected hardware configuration is not supported
Meaning: PE3AI50.COM was unable to operate properly using the selected
LPT, IRQ, and parallel port mode.
Remedy: Be sure any values you specify for LPT and IRQ match those used by
the parallel port. If this message appears when using the default
auto-configuration, try specifying the NON switch.
------
ERROR: This driver does not support the currently connected adapter
Meaning: The installed adapter is not a Xircom Pocket Ethernet Adapter III.
Remedy: This driver only supports the Xircom Pocket Ethernet Adapter III.
If your Xircom adapter is a different model, contact Xircom Technical
Support for a driver that supports that model.
TESTING PE3AI50.COM RETURN CODES (ERROR LEVEL)
==============================================
You may test the PE3AI50.COM return code or error level in a batch file by
using the IF ERRORLEVEL command. The following error levels are returned:
0 No errors. PE3AI50.COM driver installed or removed successfully,
or Help requested.
1 MPX number already in use
2 Switch error
3 Adapter not found or hardware error
4 Cannot remove - PE3AI50.COM not loaded
5 Cannot remove - Different PE3AI50.COM version loaded
6 Cannot remove - Interrupts rehooked
7 Cannot remove - AILANBIO.EXE still installed
------------------