home *** CD-ROM | disk | FTP | other *** search
/ Current Shareware 1994 January / SHAR194.ISO / networks / pe3ai50.zip / PE3AI50.DOC < prev   
Text File  |  1993-08-09  |  16KB  |  446 lines
  1.    AI-LANBIOS Low-Level Driver For XIRCOM Pocket Ethernet Adapter III
  2.                              (PE3AI50.DOC)
  3.           -----------------------------------------------------
  4.                     (C) Copyright 1991 ARTISOFT, Inc.
  5.                            (Revised 6/26/93)
  6.                  Portions (C) Copyright 1993 Xircom, Inc.
  7.  
  8. INTRODUCTION
  9. ============
  10.  
  11. The PE3AI50.COM low-level AI-LANBIOS driver allows you to use your Xircom
  12. Pocket Ethernet Adapter III in a LANtastic 5.x network.  The driver interfaces
  13. with the following models:
  14.  
  15.         PE3-10B2   Thin Ethernet adapter
  16.         PE3-10BT   Twisted Pair Ethernet adapter
  17.  
  18. In order for the Xircom adapter to operate with the LANtastic Network
  19. Operating System (NOS), you must first install the adapter as instructed in
  20. the Xircom installation guide, then run the supporting software (PE3AI50.COM
  21. and AILANBIO.EXE).  PE3AI50.COM communicates with the Xircom adapter, while
  22. AILANBIO.EXE provides high-level communications across the local area
  23. network.  Because of this, you cannot run any network software until after
  24. you load PE3AI50.COM and AILANBIO.EXE.  (Note: For information on running
  25. AILANBIO.EXE, refer to your LANtastic manuals.)
  26.  
  27. There are command line switches that you can use when you run PE3AI50.COM and
  28. AILANBIO.EXE.  These switches allow you greater flexibility in using these
  29. programs.  For information on the AILANBIO.EXE command line options refer
  30. to SWITCHES.DOC in your LANtastic installation directory.  For information
  31. on PE3AI50.COM command line switches, refer to "PE3AI50.COM COMMAND LINE
  32. OPTIONS" in this file.
  33.  
  34.  
  35. RUNNING PE3AI50.COM
  36. ===================
  37.  
  38. The syntax for running PE3AI50.COM is
  39.  
  40.      PE3AI50[switches . . . ] [ ; comment]
  41.  
  42. where "switches" denotes any optional command line switches.  If you are
  43. using more than one switch in a command line, use a space or a forward
  44. slash (/) to separate the arguments.  If a switch takes a value (such as
  45. when you designate the DOS multiplex number with the MPX= switch) the
  46. switch must be followed by an equal sign (=) or a colon (:).  All switch
  47. values are checked to make sure they are valid.  Illegal values produce
  48. error messages.
  49.  
  50. These are valid switch formats:
  51.  
  52.         SWITCH
  53.         /SWITCH
  54.         SWITCH:VALUE
  55.         /SWITCH=VALUE
  56.  
  57. You would use one of the first two formats for a switch that does not take
  58. a value.  For example:
  59.  
  60.         PE3AI50/HELP
  61.  
  62. You would use the third or fourth formats for a switch that takes a value.
  63. Such as:
  64.  
  65.         PE3AI50/MPX=D7
  66.  
  67.  
  68. PE3AI50.COM COMMAND LINE OPTIONS
  69. ================================
  70.  
  71. The valid PE3AI50.COM switches appear below.  The letters "ddd" denote that
  72. you must provide a decimal number.  The letters "hh" denote a required
  73. hexadecimal value.  Values enclosed in brackets "[]" indicate default
  74. values if the switch is omitted.  Values after the brackets denote the
  75. valid range of variables for the switch.
  76.  
  77. ----------
  78.     @switch-file
  79.  
  80. This option specifies that further switches are to be taken from a
  81. switch file.  Any switches after the @switch-file name on the command line
  82. will be used, and those switch settings take precedence over any settings
  83. in the switch file.  You may invoke switch files from within switch files
  84. as often as you wish.  The file should contain valid switches and may contain
  85. comment characters (;) at the beginning of each line or after switches.
  86.  
  87. For example,
  88.  
  89.      PE3AI50 @setup
  90.  
  91. The file SETUP contains
  92.  
  93.      ; PE3AI50.COM AI-LANBIOS driver setup file
  94.      ;
  95.      MPX=D7            ; Use Multiplex number D7
  96.      IRQ=5             ; Use interrupt request 5
  97.      VERBOSE           ; Display verbose information
  98.  
  99. ----------
  100.      HELP or ?
  101.  
  102. This switch instructs PE3AI50.COM to display information about the valid
  103. command line switches, but does not install the PE3AI50.COM driver.  For
  104. example,
  105.  
  106.      PE3AI50/help
  107.      PE3AI50 ?
  108.  
  109. See the messages section for a detailed description of the HELP display
  110. output.
  111.  
  112. ---------
  113.      IEEE
  114.  
  115. This switch causes all transmitted packets to be in the IEEE 802.3 standard
  116. format instead of the default XEROX format.  When using this switch
  117. PE3AI50.COM will receive both XEROX and IEEE 802.3 packets.
  118.  
  119. ----------
  120.      IRQ=d [auto] Range 5 to 7
  121.  
  122. This switch specifies the interrupt request (IRQ) level used by the parallel
  123. port.  Normally this switch is not required, since by default the driver
  124. automatically determines the IRQ level of the port.  However, in certain
  125. cases, such as having devices connected to more than one parallel port, a
  126. unique IRQ must be specified.  The IRQ switch value must match the IRQ of
  127. the parallel port used by the adapter.
  128.  
  129. ----------
  130.      LINKDISABLE
  131.  
  132. This switch, only applicable to the PE3-10BT model, tells the adapter to not
  133. check for link integrity upon reception or transmission of a packet.  It
  134. should only be used if a PE3-10BT adapter is connected to older 10-BaseT
  135. hardware that does not support link integrity.
  136.  
  137. ----------
  138.      LPT=d [auto] Range 1 to 3
  139.  
  140. This switch allows you to specify the parallel port where the Pocket Ethernet
  141. Adapter III is installed.  Normally this switch is not required, since by
  142. default the driver automatically determines the LPT number of the port in
  143. use.  However, if the automatic process adversely affects a device on another
  144. parallel port or fails to detect the adapter, you will need to use this switch
  145. to specify a port.
  146.  
  147. ----------
  148.      MPX=hh [C7] C0-FF
  149.  
  150. This switch specifies the DOS multiplex (MPX) number to use for
  151. communication with AILANBIO.EXE.  You will need to change this value only
  152. if the default MPX number is in use by another application or NETBIOS.
  153. Multiplex numbers 00 through BF are reserved for DOS use; therefore, you
  154. must use a multiplex number between C0 and FF.
  155.  
  156. ----------
  157.      NON
  158.  
  159. This switch forces the driver to operate in non-bidirectional parallel port
  160. mode.  Normally this switch should not be used, since the driver automatically
  161. tests the parallel port and determines the optimum mode for that port.
  162. However, you may wish to try the NON switch if improper operation is
  163. encountered with the automatically selected mode.
  164.  
  165. ----------
  166.      PACKET_SIZE=dddd [1500] 600-1500
  167.  
  168. This switch specifies the maximum size of transmitted IEEE 802.3 or
  169. XEROX-type packets.  You may need to change this value when using certain
  170. bridges that do not support the full 1500-byte packet size.  Even when you
  171. reduce the packet size, the low-level driver can still receive larger packets.
  172.  
  173. ----------
  174.     REMOVE
  175.  
  176. This switch removes PE3AI50.COM from memory.  You must remove TSR programs in
  177. the opposite order they were loaded.  For example, if you loaded PE3AI50.COM
  178. and then AILANBIO, you must remove AILANBIO before PE3AI50.COM.
  179.  
  180. ----------
  181.      VERBOSE
  182.  
  183. This switch causes the PE3AI50.COM driver to be installed and detailed
  184. information about the configuration of the PE3AI50.COM driver to be displayed.
  185. See the messages section for a detailed description of the VERBOSE output.
  186.  
  187. ---------
  188.      XEROX
  189.  
  190. This switch causes all transmitted packets to be in the XEROX format.  This
  191. switch isn't necessary since by default the XEROX format is used.  When using
  192. the XEROX format, PE3AI50.COM will receive both XEROX and IEEE 802.3 packets.
  193.  
  194.  
  195. PE3AI50.COM MESSAGES
  196. ====================
  197.  
  198. The PE3AI50.COM driver produces two types of messages: Informative and Error.
  199. All error messages are preceded by the text "ERROR:" and in those cases
  200. the PE3AI50.COM driver is not installed.
  201.  
  202. --------
  203. MESSAGE:
  204.  
  205. Xircom Pocket Ethernet Adapter III
  206. PE3AI50 AI-LANBIOS(R) V4.05 Compatible Driver (Vx.xx)
  207. (C) Copyright 1993 by ARTISOFT Inc.   Portions (C) Copyright 1993 Xircom, Inc.
  208.  
  209.  
  210. This message appears each time the low-level driver is invoked.
  211.  
  212. --------
  213. MESSAGE:
  214.  
  215. Hardware Configuration     LPT1:, IRQ7, Bidirectional
  216.          ---- PE3AI50 AI-LANBIOS(R)-Compatible Driver Installed ----
  217.  
  218.  
  219. This or a similar message appears after the low-level driver is
  220. successfully installed.
  221.  
  222. --------
  223. MESSAGE:
  224.        ---- PE3AI50 AI-LANBIOS(R)-Compatible Driver NOT Installed ----
  225.  
  226.  
  227. This message appears if the low-level driver is not installed.  The driver
  228. will not be installed if HELP information is displayed or an error occurred.
  229.  
  230. --------
  231. MESSAGE:
  232.  
  233. Command line              /verbose
  234. IEEE 802.3 node address   0080C7OC69AE          MPX interface number   C7
  235. Network packet size       1500                  Bytes of memory used   9968
  236. Packet type               XEROX
  237. Hardware Configuration    LPT1:, IRQ7, Bidirectional
  238.  
  239.  
  240. This message appears if the VERBOSE switch is specified.  The values
  241. displayed specify how the low-level driver is configured.
  242.  
  243. --------
  244. MESSAGE:
  245.  
  246. Valid command line switches:
  247.    @<filename>   Read command line switches from file
  248.    HELP or ?     Display this help information
  249.    REMOVE        Unload driver from memory
  250.    VERBOSE       Display detailed configuration information
  251.    MPX           MPX interface number in hex  (C0 - FF,  default C7)
  252.    PACKET_SIZE   Maximum packet size in decimal  (600 - 1500,  default 1500)
  253.    XEROX         Set the packet type to XEROX  (Default)
  254.    IEEE          Set the packet type to IEEE 802.3
  255.    IRQ           Interrupt used by the adapter
  256.    LPT           LPT port number  (1, 2, or 3)
  257.    NON           Force non-bidirectional parallel port mode
  258.    LINKDISABLE   Disable link integrity
  259.  
  260. Note:  The parallel port number, interrupt, and optimum mode are determined
  261.        automatically unless overridden with the LPT, IRQ, and NON switches.
  262.  
  263.  
  264. This message is displayed when the HELP or ? switch is used.  Each valid
  265. switch is listed with the acceptable range of values (if any) and the base
  266. (hex or decimal) that the numbers must be entered in.  The low-level driver
  267. is not installed when this switch is used.
  268.  
  269. -------
  270. MESSAGE:
  271.  
  272.           ---- PE3AI50 AI-LANBIOS(R)-Compatible Driver REMOVED ----
  273.  
  274.  
  275. The PE3AI50.COM driver has been removed from memory.
  276.  
  277. --------
  278. ERROR:   Can't REMOVE -- PE3AI50 AI-LANBIOS(R)-Compatible Driver is not loaded
  279.  
  280. Meaning: You have issued the PE3AI50/REMOVE command and do not have
  281.          PE3AI50.COM loaded into memory.
  282.  
  283. Remedy:  Only issue this command after the program is loaded.
  284.  
  285. --------
  286. ERROR:   Can't REMOVE -- AI-LANBIOS(R) still installed
  287.  
  288. Meaning: You have issued the PE3AI50/REMOVE command while AILANBIO.EXE
  289.          is still in memory.
  290.  
  291. Remedy:  Remove AILANBIO.EXE before removing PE3AI50.COM.
  292.  
  293. -------
  294. ERROR:   Can't REMOVE -- interrupts re-hooked
  295.  
  296. Meaning: You have attempted to remove PE3AI50.COM and the interrupts are in
  297.          use by another TSR, or PE3AI50.COM was not the last TSR loaded.
  298.  
  299. Remedy:  Remove any TSRs loaded after PE3AI50.COM.  For example, if you load
  300.          PE3AI50.COM then AILANBIO.EXE, you must first remove AILANBIO.EXE,
  301.          then you can remove PE3AI50.COM.
  302.  
  303. ------
  304. ERROR:   Cannot open switch file - @file
  305.  
  306. Meaning: The file "file" cannot be opened as an indirect switch file.
  307.  
  308. Remedy:  The file must exist before it can be used as an indirect file.
  309.  
  310. -------
  311. ERROR:   Installed PE3AI50 is different version
  312.  
  313. Meaning: You have loaded a version of the PE3AI50.COM program and attempted to
  314.          remove it from memory with the /REMOVE switch.  The version with
  315.          which you are attempting to remove PE3AI50.COM is not the same
  316.          version that was loaded.
  317.  
  318. Remedy:  Remove PE3AI50.COM with the same version of the program that was
  319.          loaded.
  320.  
  321. ------
  322. ERROR:   Illegal switch - ??????=nnnn
  323.  
  324. Meaning: The switch ??????=nnnn is not a recognized switch.
  325.  
  326. Remedy:  You may only specify legal switches on the command line.
  327.  
  328. ------
  329. ERROR:   Illegal character after switch name - ??????xnnnn
  330.  
  331. Meaning: The switch ?????? is followed by a character other than "=" or ":",
  332.          or the switch does not take a value.
  333.  
  334. Remedy:  Only use the characters "=" or ":" to specify switch values and
  335.          do not place characters after switches that do not take values.
  336.  
  337. ------
  338. ERROR:   Illegal digit in switch value - ??????=nnnn
  339.  
  340. Meaning: An illegal digit (character) occurrred in the numeric
  341.          switch value.
  342.  
  343. Remedy:  You must restrict numeric decimal values to the numbers 0-9. 
  344.          You must restrict hexadecimal values to the numbers 0-9 and the
  345.          letters A-F.
  346.  
  347. ------
  348. ERROR:   Switch value not in range - ??????=nnnn
  349.          Valid range is ssss to eeee
  350.  
  351. Meaning: The value nnnn is not in proper range.  The value "ssss"
  352.          represents the lowest acceptable value and the value "eeee"
  353.          represents the highest acceptable value.
  354.  
  355. Remedy:  Limit your range of values to the acceptable range.
  356.  
  357. ------
  358. ERROR:   MPX number hh is already in use - Try another number
  359.  
  360. Meaning: The multiplex (MPX) interrupt number hh is being used by another
  361.          application or low-level driver.
  362.  
  363. Remedy:  Try another MPX number.
  364.  
  365. ------
  366. ERROR:   A Pocket LAN Adapter could not be found
  367.  
  368. Meaning: PE3AI50.COM was unable to communicate with the Pocket Ethernet
  369.          Adapter III.
  370.  
  371. Remedy:  Make sure the adapter is connected to your computer and powered up.
  372.          Also be sure any command line switches match the hardware
  373.          configuration.  If the error persists, contact Xircom Technical
  374.          Support.
  375.  
  376. ------
  377. ERROR:   A Pocket LAN Adapter driver is already loaded
  378.  
  379. Meaning: You have attempted to load a second copy of PE3AI50.COM into the same
  380.          adapter.
  381.  
  382. Remedy:  Load only one copy of PE3AI50.COM per adapter.
  383.  
  384. ------
  385. ERROR:   Pocket Ethernet Adapter III Address EEPROM unreadable.
  386.  
  387. Meaning: PE3AI50.COM was unable to read the node address in the adapter EEPROM
  388.          chip.
  389.  
  390. Remedy:  Contact Xircom Technical Support.
  391.  
  392. ------
  393. ERROR:   Pocket Ethernet Adapter III failed initialization.
  394.  
  395. Meaning: PE3AI50.COM was unable to reset the adapter's NIC chip.
  396.  
  397. Remedy:  Try loading the program with the NON switch.  If that doesn't work,
  398.          contact Xircom Technical Support.
  399.  
  400. ------
  401. ERROR:   Pocket Ethernet Adapter III failed memory test.
  402.  
  403. Meaning: PE3AI50.COM was unable to read or write properly to the adapter's
  404.          on-board RAM.
  405.  
  406. Remedy:  Try loading the program with the NON switch.  If that doesn't work,
  407.          contact Xircom Technical Support.
  408.  
  409. ------
  410. ERROR:   The selected hardware configuration is not supported
  411.  
  412. Meaning: PE3AI50.COM was unable to operate properly using the selected
  413.          LPT, IRQ, and parallel port mode.
  414.  
  415. Remedy:  Be sure any values you specify for LPT and IRQ match those used by
  416.          the parallel port.  If this message appears when using the default
  417.          auto-configuration, try specifying the NON switch.
  418.  
  419. ------
  420. ERROR:   This driver does not support the currently connected adapter
  421.  
  422. Meaning: The installed adapter is not a Xircom Pocket Ethernet Adapter III.
  423.  
  424. Remedy:  This driver only supports the Xircom Pocket Ethernet Adapter III.
  425.          If your Xircom adapter is a different model, contact Xircom Technical
  426.          Support for a driver that supports that model.
  427.  
  428.  
  429. TESTING PE3AI50.COM RETURN CODES (ERROR LEVEL)
  430. ==============================================
  431.  
  432. You may test the PE3AI50.COM return code or error level in a batch file by
  433. using the IF ERRORLEVEL command.  The following error levels are returned:
  434.  
  435.      0     No errors.  PE3AI50.COM driver installed or removed successfully,
  436.            or Help requested.
  437.      1     MPX number already in use
  438.      2     Switch error
  439.      3     Adapter not found or hardware error
  440.      4     Cannot remove - PE3AI50.COM not loaded
  441.      5     Cannot remove - Different PE3AI50.COM version loaded
  442.      6     Cannot remove - Interrupts rehooked
  443.      7     Cannot remove - AILANBIO.EXE still installed
  444. ------------------
  445.  
  446.