home *** CD-ROM | disk | FTP | other *** search
/ HAM Radio 1 / HamRadio.cdr / packet / bpq405 / ports.doc < prev    next >
Text File  |  1992-03-21  |  13KB  |  535 lines
  1. Configuration file - BPQCFG.TXT
  2.  
  3.  
  4.  
  5. PORTS Section.
  6.  
  7.  
  8. This section of the configuration file defines the links from the switch
  9. to the outside world. These will normally be Radio links, but could also
  10. be a link to another computer running another copy of the switch, or similar
  11. software (eg NOS).
  12.  
  13. Please note that there is no relationship between the 'Virtual' COM ports
  14. defined in the TNCPORT section, which are used by the BBS or other program
  15. running abouve the switch, and these external links. You may use your 
  16. 'real' COM1 port to connect to a KISS TNC, even if you have defined a 
  17. 'Virtual' COM1 in the TNCPORT section. 
  18.  
  19.  
  20. There are two basic classes of links supported by the switch. One uses 
  21. normal ASYNC ports to communicate with TNCs running in KISS mode, and the
  22. other uses special HDLC cards which fit inside the PC, and interface to
  23. the radio via either an inbuilt or external  modem. Those currently supported
  24. are the PacCom PC120, DRSI PC-PA, Thor RLC100, and Baycom USCC-Karte.
  25.  
  26.  
  27. Interrupt levels may be shared by any cards with suitable hardware.
  28. Examples are all but the earliest DRSI cards, and a MS400 ASYNC card 
  29. modified as described by AA4RE in his MBBIOS documentation. However
  30. there is a significant overhead in using the shared interrupt feature
  31. - try to use it on relatively low speed links, and watch out for TX
  32. underruns/RX overuns.
  33.  
  34.  
  35. Each port is defined by a set of statements of the form:
  36.  
  37.  
  38. PORT
  39.  
  40.     PARAM=VALUE
  41.     ..
  42.     ..
  43.  
  44. ENDPORT
  45.  
  46.  
  47. Samples of various configurations are given later, but the full list
  48. of PARAM values supported is given below
  49.  
  50.  
  51. PORTNUM=n    
  52.  
  53.     Number for use in PORTS display, connects, etc. Default is next
  54.     sequential number.
  55.  
  56. ID=text string *
  57.  
  58.     Up to 30 chars, appears on PORTS display
  59.  
  60. TYPE=ASYNC/DRSI/PC120/RLC100/QUAD/INTERNAL/EXTERNAL/BAYCOM *
  61.  
  62.     Hardware type.
  63.  
  64.     ASYNC is for a normal ASYNC card, or a shared interrupt card 
  65.     such as the MS400
  66.  
  67.     PC120, DRSI, RLC100 BAYCOM are the internal HDLC cards,    the first
  68.     two support up to two channels, the others up to 4.
  69.  
  70.     QUAD is the Quadram Quadport, which allows up to 5 async links.
  71.     This version only supports a single Quadport. See later section
  72.     for setup details.
  73.  
  74.     INTERNAL defines a 'loopback' port - anything sent on it will be
  75.     received. Intended to allow KISS applications (eg TCP/IP) to talk
  76.     to the switch.
  77.  
  78.     EXTERNAL defines a user-supplied hardware driver.
  79.  
  80.  
  81. PROTOCOL=HDLC/KISS/NETROM *
  82.  
  83.     Protocol to be used on the link.
  84.  
  85.     NETROM is to connect to the async port of a real NETROM  
  86.     KISS is to connect to a KISS TNC
  87.  
  88.  
  89. IOADDR=xxxH *
  90.  
  91.     The base I/O address for the card. In hex, H is needed
  92.  
  93.  
  94. INTLEVEL=n *
  95.  
  96.     The interrupt level to be used. Any spare level may be used, up to
  97.     7 on an 8 bit machine, or 15 on a 16 bit machine. More than one card
  98.     may share a level if the hardware has the necessary logic.
  99.  
  100.  
  101. SPEED=nnnn *
  102.  
  103.     The radio speed for HDLC cards, or the async link speed for KISS
  104.     and NETROM links. If set to zero, the modem must supply a 1x clock. 
  105.     (TXC on RTXC pin, RXC on TRXC pin.)
  106.  
  107.  
  108. CHANNEL=A/B/..*
  109.  
  110.     Selects port on HDLC cards, dual port KISS (eg KPC4) or Multidropped KISS
  111.  
  112.  
  113. BBSFLAG=NOBBS
  114.  
  115.     Stops direct connects to the BBS on this port.
  116.  
  117.  
  118. QUALITY=nnn *
  119.  
  120.     Default quality for nodes heard on this port. Set to zero to suppress
  121.     all level 3/4 activity (including NODES broadcasts) on this port.
  122.  
  123.  
  124. MAXFRAME=n *
  125.  
  126.     Maximum outstanding frames. 
  127.  
  128.  
  129. TXDELAY=nnn *
  130.  
  131.     TX Keyup delay in milliseconds
  132.  
  133.  
  134. SLOTTIME=100 *
  135.  
  136.     CSMA interval timer (milliseconds)
  137.  
  138.  
  139. PERSIST=nnn *
  140.  
  141.     'Probability to transmit' value (1-255)
  142.  
  143.  
  144. FULLDUP=0/1
  145.  
  146.     Passed on to TNC if using KISS. Used to allow transmission whilst DCD
  147.     is active on HDLC cards, and to allow connection of a NETROM cluster
  148.     via a diode matrix.
  149.  
  150.  
  151. SOFTDCD=0/1
  152.  
  153.     If set to 1, system uses the detection of a valid frame to indicate that
  154.     the channel is busy, rather than the DCD signal from the modem. Used
  155.     only for HDLC cards.
  156.  
  157.  
  158. TXTAIL=nnnn
  159.  
  160.     TXTAIL timer in ms. Used only by KISS TNCs. If running on HF at 300 baud,
  161.     the default is probably too short. If others have trouble copying your
  162.     frames, try a value of 50 - 100.
  163.  
  164.  
  165. FRACK=nnnn *
  166.  
  167.     Level 2 timout in milliseconds
  168.  
  169.  
  170. RESPTIME=nnnn *
  171.  
  172.     Level 2 delayed ack timer in milliseconds
  173.  
  174.  
  175. RETRIES=n *
  176.  
  177.     Level 2 maximum retry value
  178.  
  179.  
  180. PACLEN=nnn *
  181.  
  182.     Default maximum packet length for this port
  183.  
  184.  
  185. CWID=CALL
  186.  
  187.    Only used on HDLC cards. CWID is sent every 29 mins.
  188.  
  189.  
  190. PORTCALL=CALL
  191. PORTALIAS=ALIAS
  192.  
  193.     Additional callsign/alias for level 2 connects to the node for this port.
  194.     Should not be the same as BBSCALL
  195.  
  196.  
  197. ALIAS_IS_BBS=0/1
  198.  
  199.     If set then PORTCALL and PORTALIAS access the BBS instead of the node. 
  200.  
  201.  
  202. VALIDCALLS=CALLS
  203.  
  204.     Up to about 40 callsigns, separated by single commas. If present, only
  205.     stations in the list will be allowed to connect to you on this port.
  206.     The SSID should not be specified, and multiple VALIDCALLS lines may be 
  207.     included. End all but the last line with commas. The total length of the
  208.     list, including commas, is 256 bytes.
  209.  
  210.  
  211. QUALADJUST=NNN
  212.  
  213.     Percentage to reduce the quality of a NODE in the NODES broadcast, if
  214.     the best neighbour is on the same port as the broadcast. Designed to
  215.     improve throughput if more than one channel is available, by discouraging
  216.     routes which cause a node to send a packet on the same port that it
  217.     received it on.
  218.  
  219.  
  220. DIGIFLAG=0/1/255
  221.  
  222.     Digipeat control flag for this port. 0 = dont digi, 1 = digi everything,
  223.     255 = digi UI frames only
  224.  
  225.  
  226. DIGIPORT=N
  227.  
  228.     Port to send digied frames on. Zero means the port it was received on,
  229.     any other number means send on that port. This is intended mainly to
  230.     allow a BBS on another machine, connected via a wire link, to send out
  231.     'MAIL FOR' messages.
  232.  
  233.  
  234. USERS=N
  235.  
  236.     This limits the number of L2 sessions to the supplied number. Zero means
  237.     no limit. The limit applies to all L2 sessions (even those with other
  238.     nodes), but is only checked for incoming connects (ie you can make
  239.     outgoing connects even when the limit is reached). Intended mainly to
  240.     control the number of users on busy user access ports (especially 2m).
  241.  
  242.  
  243. UNPROTO=
  244.  
  245.     Unproto destination and digi string for this port. Use commas between
  246.     calls, and dont include the VIA.
  247.  
  248.  
  249. L3ONLY=0/1
  250.  
  251.     If set, will stop users (but not HOST sessions) issuing downlink
  252.     connects on this port. 
  253.  
  254.  
  255. INTERLOCK=n
  256.  
  257.     Allows groups of ports to be defined which will not transmit at the same
  258.     time. A value of zero indicates no locking, if any other value is specifed
  259.     the code will make sure that no two ports with the same value can transmit
  260.     at the same time.
  261.  
  262.  
  263. TXPORT=n    
  264.  
  265.     Allows frames for this port to be transmitted on a different port.
  266.     This is for use when you are operating a central node, with a single
  267.     transmitter, and a number of receivers.
  268.  
  269.  
  270. MHEARD=Y/N
  271.  
  272.     Enables or disables the MHEARD function on this port. There is a slight
  273.     overhead in maintaining the MHEARD list, so if it is not needed (eg on
  274.     an internode port) it may be disabled. Default is enabled.
  275.  
  276.  
  277. KISSOPTIONS=POLLED,CHECKSUM,ACKMODE,SLAVE
  278.  
  279.     These select my extended KISS mode.
  280.     
  281.     These extended KISS options are supported by my BPQKISS EPROM for
  282.     the TNC2 and clones, and by special EPROMS for the KPC2, KPC4 and
  283.     KAM, available from Kantronics.
  284.  
  285.     POLLED selects multi-dropped mode, where the TNC only
  286.     transmits when requested (Polled) by the PC. This allows
  287.     several TNCs to share an async port without any risk of
  288.     collisions.
  289.     
  290.     CHECKSUM selects a mode where a checksum byte is appended
  291.     to each data message, and checked by the other end. This
  292.     reduces the risk of data corruption if errors occur on the
  293.     link from PC to TNCs. It may be used on its own, but should
  294.     always be used if POLLED mode is selected.
  295.     
  296.     ACKMODE enables the transmission of 'ACK required' frames.
  297.     There cause the TNC to send a reply when the frame has been
  298.     transmitted. This will improve link performance by avoiding
  299.     the possibility of a retry being sent before the original
  300.     frame has even left the TNC. This mode should always be used
  301.     if the TNC support it.
  302.     
  303.     SLAVE allows a PC to be multidropped along with one or more
  304.     KISS TNCs on a multidropped link. If you use SLAVE, you shouldnt
  305.     set POLLED, and you shouldnt use ACKMODE on either end. 
  306.  
  307.  
  308.  
  309. Parameters marked with a * must be included, the rest are optional. The 
  310. validation is not good, and defaults are generally zero, so if you miss 
  311. out any of the essential ones, odd things may well happen!
  312.  
  313.  
  314.  
  315. Sample PORT Configurations:
  316.  
  317.  
  318. 1. 2 Port DRSI card set for IO addr = 300h, int level 5
  319.  
  320.  
  321. PORT
  322.     ID=144.650 MHz 1200 Baud
  323.     TYPE=DRSI
  324.     PROTOCOL=HDLC
  325.     IOADDR=300H
  326.     INTLEVEL=5
  327.     SPEED=1200
  328.     CHANNEL=A
  329.     QUALITY=10
  330.     MAXFRAME=1
  331.     TXDELAY=500
  332.     SLOTTIME=100
  333.     PERSIST=64
  334.     FULLDUP=0
  335.     SOFTDCD=0
  336.     FRACK=7000
  337.     RESPTIME=2000
  338.     RETRIES=10
  339.     PACLEN=120
  340.     CWID=G8BPQ
  341.  
  342. ENDPORT
  343. ;
  344. PORT
  345.     ID=432.675 MHz 1200 Baud
  346.     TYPE=DRSI
  347.     PROTOCOL=HDLC
  348.     IOADDR=300H
  349.     INTLEVEL=5
  350.     SPEED=1200
  351.     CHANNEL=B
  352.     BBSFLAG=NOBBS            ; IF MY BBS LICENCE IS ONLY FOR 2M
  353.     QUALITY=10
  354.     MAXFRAME=1
  355.     TXDELAY=500
  356.     SLOTTIME=100
  357.     PERSIST=64
  358.     FULLDUP=0
  359.     SOFTDCD=0
  360.     FRACK=6000
  361.     RESPTIME=1500
  362.     RETRIES=10
  363.     PACLEN=120
  364.     CWID=G8BPQ
  365.     PORTCALL=G8BPQ
  366.     PORTALIAS=NOTTM
  367. ;
  368. ENDPORT
  369.  
  370.  
  371. 2. Standard KISS TNC on primary ASYNC card. (COM1). To use the secondary
  372.    ASYNC card (COM2), change IOADDR to 2F8H, and the INTLEVEL to 3.  
  373.  
  374.  
  375. PORT
  376.     ID=144.650 Mhz 1200 Baud
  377.     TYPE=ASYNC
  378.     PROTOCOL=KISS
  379.     IOADDR=3F8H
  380.     INTLEVEL=4
  381.     SPEED=9600
  382.     CHANNEL=A
  383.     QUALITY=10
  384.     MAXFRAME=2
  385.     TXDELAY=500
  386.     SLOTTIME=100
  387.     PERSIST=64
  388.     FULLDUP=0
  389.     FRACK=7000
  390.     RESPTIME=2000
  391.     RETRIES=10
  392.     PACLEN=120
  393.  
  394. ENDPORT
  395.  
  396. The second port of a multiport TNC (Such as the KAM or KPC 4) is defined as
  397. follows:
  398.  
  399.     ID=432.675 Mhz 1200 baud
  400.     TYPE=ASYNC
  401.     PROTOCOL=KISS
  402.     IOADDR=3F8H
  403.     INTLEVEL=4
  404.     SPEED=2400
  405.     CHANNEL=B
  406.     QUALITY=10
  407.     MAXFRAME=2
  408.     TXDELAY=500
  409.     SLOTTIME=100
  410.     PERSIST=64
  411.     FULLDUP=0
  412.     FRACK=7000
  413.     RESPTIME=2000
  414.     RETRIES=10
  415.     PACLEN=120
  416.     QUALADJUST=5
  417.  
  418. ENDPORT
  419.  
  420.  
  421.  
  422. 3. Quadram Quadport.
  423.  
  424. The Quadram Quadport card supports up to 5 (yes I know it says quadport!!)
  425. async ports. This version only supports one card - if anyone needs more,
  426. let me know. You do not need to define all ports, but you must start with
  427. the first, and not leave any gaps.
  428.  
  429. The card should be configured with first port at 280h, and software 
  430. selectable interrupts (3 or 4 may be used)
  431.  
  432. The card will support KISS TNCS (either normal, or KPC4 type dual port), or
  433. NETROM links (or a combination of both). 
  434.  
  435.  
  436. The following sample config file is for a Dual Port KPC4 on channel 1,
  437. a normal KISS TNC on channel 2, and a NETROM async link on channel 3.
  438.  
  439.  
  440. PORT
  441.     ID=KPC4 PORT 1
  442.     TYPE=QUAD
  443.     PROTOCOL=KISS
  444.     IOADDR=280H
  445.     INTLEVEL=3
  446.     SPEED=2400
  447.     CHANNEL=A
  448.     QUALITY=10
  449.     MAXFRAME=2
  450.     TXDELAY=500
  451.     SLOTTIME=100
  452.     PERSIST=64
  453.     FULLDUP=0
  454.     FRACK=7000
  455.     RESPTIME=2000
  456.     RETRIES=10
  457.     PACLEN=120
  458.  
  459. ENDPORT
  460.  
  461. PORT
  462.     ID=KPC4 PORT 2
  463.     TYPE=QUAD
  464.     PROTOCOL=KISS
  465.     IOADDR=280H
  466.     INTLEVEL=3
  467.     SPEED=2400
  468.     CHANNEL=B
  469.     QUALITY=10
  470.     MAXFRAME=2
  471.     TXDELAY=500
  472.     SLOTTIME=100
  473.     PERSIST=64
  474.     FULLDUP=0
  475.     FRACK=7000
  476.     RESPTIME=2000
  477.     RETRIES=10
  478.     PACLEN=120
  479.  
  480. ENDPORT
  481.  
  482. PORT
  483.     ID=NORMAL KISS
  484.     TYPE=QUAD
  485.     PROTOCOL=KISS
  486.     IOADDR=290H
  487.     INTLEVEL=3
  488.     SPEED=2400
  489.     CHANNEL=A
  490.     QUALITY=10
  491.     MAXFRAME=2
  492.     TXDELAY=500
  493.     SLOTTIME=100
  494.     PERSIST=64
  495.     FULLDUP=0
  496.     FRACK=7000
  497.     RESPTIME=2000
  498.     RETRIES=10
  499.     PACLEN=120
  500.  
  501. ENDPORT
  502.  
  503. PORT
  504.     ID=NETROM BACKEND
  505.     TYPE=QUAD
  506.     PROTOCOL=NETROM
  507.     IOADDR=2A0H
  508.     INTLEVEL=3
  509.     SPEED=2400
  510.     CHANNEL=A
  511.     QUALITY=10
  512.     MAXFRAME=2
  513.     TXDELAY=500        ; THESE AREN'T USED, BUT I SUGGEST  
  514.     SLOTTIME=100        ; YOU PUT THEM IN IN CASE ONE DAY
  515.     PERSIST=64        ; THEY ARE!
  516.     FULLDUP=1        ; THIS IS NOW NEEDED FOR A SINGLE NETROM
  517.                 ; TNC. SET TO 0 IF USING A DIODE MATRIX.
  518.     SOFTDCD=0
  519.     FRACK=7000
  520.     RESPTIME=2000
  521.     RETRIES=10
  522.     PACLEN=120
  523.  
  524. ENDPORT
  525.  
  526.  
  527. 4. Baycom USCC.
  528.  
  529. This card has 4 ports, two running at 1200 (Ports A and B), one
  530. TTL port (Port C), and one G3RUH compatible 9600 bps port (Port D).
  531. The configuration is similar to the DRSI, except that port D should
  532. have SPEED=0 (Not SPEED=9600). 
  533.  
  534.  
  535.