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