home *** CD-ROM | disk | FTP | other *** search
/ HAM Radio 1 / HamRadio.cdr / misc / bpq403a / ports.doc < prev    next >
Encoding:
Text File  |  1991-03-07  |  10.8 KB  |  417 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, and Thor RLC100.
  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    ; Number for use in PORTS display, connects, etc.
  52.         ; Default is next sequential number.
  53.  
  54. ID=text string *; Up to 30 chars, appears on PORTS display
  55.  
  56. TYPE=ASYNC/DRSI/PC120/RLC100/QUAD/INTERNAL *
  57.  
  58.         ; ASYNC is for a normal ASYNC card, or a shared interrupt card 
  59.         ; such as the MS400
  60.  
  61.         ; PC120, DRSI and RLC100 are the internal HDLC cards - and
  62.         ; support 2 channels.
  63.  
  64.         ; QUAD is the Quadram Quadport, which allows up to 5 async
  65.         ; links. This version only supports a single Quadport. See
  66.         ; later section for setup details.
  67.  
  68.         ; INTERNAL defines a 'loopback' port - anything
  69.         ; sent on it will be received.Intended to allow KISS
  70.         ; applications (eg TCP/IP) to talk to the switch.
  71.  
  72. PROTOCOL=HDLC/KISS/NETROM *
  73.  
  74.         ; NETROM is to connect to the async port of a real NETROM  
  75.  
  76. IOADDR=xxxH *    ; in hex, H is needed
  77.  
  78. INTLEVEL=n *    ; 2,3,4,5 or 7 - supports shared interrupt cards
  79.  
  80. SPEED=nnnn *    ; Radio speed for DRSI, etc, async link speed for KISS
  81.         ; If set to zero, the modem must supply a 1x clock. 
  82.         ; (TXC on RTXC pin, RXC on TRXC pin.)
  83.  
  84. CHANNEL=A/B/..*    ; Selects port on DRSI/PC120, dual port KISS (eg KPC4) or
  85.         ; Multidropped KISS
  86.  
  87. BBSFLAG=NOBBS    ; Stops direct connects to the BBS on this port.
  88.  
  89. QUALITY=nnn *    ; Default quality for nodes heard on this port. Set to zero
  90.         ; to suppress all level 3/4 activity (including NODES
  91.         ; broadcasts) on this port.
  92.  
  93. MAXFRAME=n *    ; Maximum outstanding frames
  94.  
  95. TXDELAY=nnn *    ; TX Keyup delay in milliseconds
  96.  
  97. SLOTTIME=100 *    ; CSMA interval timer (milliseconds)
  98.  
  99. PERSIST=nnn *    ; 'Probability to transmit' value (1-255)
  100.  
  101. FULLDUP=0/1    ; Passed on to TNC if using KISS. Used to allow transmission
  102.         ; whilst DCD is active on HDLC cards, and to allow connection
  103.         ; of a NETROM cluster via a diode matrix.
  104.  
  105. SOFTDCD=0/1    ; not yet supported
  106.  
  107. TXTAIL=nnnn    ; TXTAIL timer in ms. Used only by KISS TNCs. If running on
  108.         ; HF at 300 baud, the default is probably too short. If others
  109.         ; have trouble copying your frames, try a value of 50 - 100.
  110.  
  111. FRACK=nnnn *    ; Level 2 timout in milliseconds
  112.  
  113. RESPTIME=nnnn *    ; Level 2 delayed ack timer in milliseconds
  114.  
  115. RETRIES=n *    ; Level 2 maximum retry value
  116.  
  117. PACLEN=nnn *    ; default maximum packet length for this port
  118.  
  119. CWID=CALL    ; Currently only supported on DRSI/PC120/RLC100 
  120.  
  121. PORTCALL=CALL    ; Additional callsign/alias for level 2 connects to the
  122. PORTALIAS=ALIAS ; node for this port. Should not be the same as BBSCALL
  123.  
  124. ALIAS_IS_BBS=0/1; If set then PORTCALL and PORTALIAS give access to the BBS
  125.         ; rather than the node. 
  126.  
  127. VALIDCALLS=CALLS; Up to about 40 callsigns, separated by single commas.
  128.         ; If present, only stations in the list will be allowed
  129.         ; to connect to you on this port. The SSID should not 
  130.         ; be specified, and multiple VALIDCALLS lines may be 
  131.         ; included. End all but the last line with commas. The
  132.         ; total length of the list, including commas, is 256 bytes.
  133.  
  134. QUALADJUST=NNN    ; Percentage to reduce the quality of a NODE in the NODES 
  135.         ; broadcast, if the best neighbour is on the same port as
  136.         ; the broadcast. Designed to improve throughput if more than
  137.         ; one channel is available, by discouraging routes which 
  138.         ; cause a node to send a packet on the same port that it
  139.         ; received it on.
  140.  
  141.  
  142. DIGIFLAG=0/1/255; Digipeat control flag for this port
  143.         ; 0 = dont digi, 1 = digi everything, 255 = digi UI frames only
  144.  
  145.  
  146. DIGIPORT=N    ; Port to send digied frames on. Zero means the port it was
  147.         ; received on, any other number means send on that port. 
  148.         ; This is intended mainly to allow a BBS on another machine,
  149.         ; connected via a wire link, to send out 'MAIL FOR' messages.
  150.  
  151.  
  152. USERS=N        ; This limits the number of L2 sessions to the supplied 
  153.         ; number. Zero means no limit. The limit applies to all
  154.         ; L2 sessions (even those with other nodes), but is only
  155.         ; checked for incoming connects (ie you can make outgoing
  156.         ; connects even when the limit is reached). Intended mainly
  157.         ; to control the number of users on busy user access ports
  158.         ; (especially 2m)
  159.  
  160.  
  161. UNPROTO=    ; Unproto destination and digi string for this port. 
  162.         ; Use commas between calls, and dont include the VIA.
  163.  
  164. L3ONLY=0/1    ; If set, will stop users (but not HOST sessions) issuing
  165.         ; downlink connects on this port. 
  166.  
  167. INTERLOCK=n    ; Allows groups of ports to be defined which will not transmit
  168.         ; at the same time. A value of zero indicates no locking, if
  169.         ; any other value is specifed the code will make sure that no
  170.         ; two ports with the same value can transmit at the same time.
  171.  
  172. KISSOPTIONS=POLLED,CHECKSUM,ACKMODE
  173.  
  174.     These select my extended KISS mode.
  175.     
  176.     These extended KISS options are supported by my BPQKISS EPROM for
  177.     the TNC2 and clones, and by special EPROMS for the KPC2, KPC4 and
  178.     KAM, available from Kantronics.
  179.  
  180.     POLLED selects multi-dropped mode, where the TNC only
  181.     transmits when requested (Polled) by the PC. This allows
  182.     several TNCs to share an async port without any risk of
  183.     collisions.
  184.     
  185.     CHECKSUM selects a mode where a checksum byte is appended
  186.     to each data message, and checked by the other end. This
  187.     reduces the risk of data corruption if errors occur on the
  188.     link from PC to TNCs. It may be used on its own, but should
  189.     always be used if POLLED mode is selected.
  190.     
  191.     ACKMODE enables the transmission of 'ACK required' frames.
  192.     There cause the TNC to send a reply when the frame has been
  193.     transmitted. This will improve link performance by avoiding
  194.     the possibility of a retry being sent before the original
  195.     frame has even left the TNC. This mode should always be used
  196.     if the TNC support it.
  197.     
  198.     
  199.  
  200.  
  201. Parameters marked with a * must be included, the rest are optional. The 
  202. validation is not good, and defaults are generally zero, so if you miss 
  203. out any of the essential ones, odd things may well happen!
  204.  
  205.  
  206.  
  207. Sample PORT Configurations:
  208.  
  209.  
  210. 1. 2 Port DRSI card set for IO addr = 300h, int level 5
  211.  
  212.  
  213. PORT
  214.     ID=144.650 MHz 1200 Baud
  215.     TYPE=DRSI
  216.     PROTOCOL=HDLC
  217.     IOADDR=300H
  218.     INTLEVEL=5
  219.     SPEED=1200
  220.     CHANNEL=A
  221.     QUALITY=10
  222.     MAXFRAME=1
  223.     TXDELAY=500
  224.     SLOTTIME=100
  225.     PERSIST=64
  226.     FULLDUP=0
  227.     SOFTDCD=0
  228.     FRACK=7000
  229.     RESPTIME=2000
  230.     RETRIES=10
  231.     PACLEN=120
  232.     CWID=G8BPQ
  233.  
  234. ENDPORT
  235. ;
  236. PORT
  237.     ID=432.675 MHz 1200 Baud
  238.     TYPE=DRSI
  239.     PROTOCOL=HDLC
  240.     IOADDR=300H
  241.     INTLEVEL=5
  242.     SPEED=1200
  243.     CHANNEL=B
  244.     BBSFLAG=NOBBS            ; IF MY BBS LICENCE IS ONLY FOR 2M
  245.     QUALITY=10
  246.     MAXFRAME=1
  247.     TXDELAY=500
  248.     SLOTTIME=100
  249.     PERSIST=64
  250.     FULLDUP=0
  251.     SOFTDCD=0
  252.     FRACK=6000
  253.     RESPTIME=1500
  254.     RETRIES=10
  255.     PACLEN=120
  256.     CWID=G8BPQ
  257.     PORTCALL=G8BPQ
  258.     PORTALIAS=NOTTM
  259. ;
  260. ENDPORT
  261.  
  262.  
  263. 2. Standard KISS TNC on primary ASYNC card. (COM1). To use the secondary
  264.    ASYNC card (COM2), change IOADDR to 2F8H, and the INTLEVEL to 3.  
  265.  
  266.  
  267. PORT
  268.     ID=144.650 Mhz 1200 Baud
  269.     TYPE=ASYNC
  270.     PROTOCOL=KISS
  271.     IOADDR=3F8H
  272.     INTLEVEL=4
  273.     SPEED=9600
  274.     CHANNEL=A
  275.     QUALITY=10
  276.     MAXFRAME=2
  277.     TXDELAY=500
  278.     SLOTTIME=100
  279.     PERSIST=64
  280.     FULLDUP=0
  281.     FRACK=7000
  282.     RESPTIME=2000
  283.     RETRIES=10
  284.     PACLEN=120
  285.  
  286. ENDPORT
  287.  
  288. The second port of a multiport TNC (Such as the KAM or KPC 4) is defined as
  289. follows:
  290.  
  291.     ID=432.675 Mhz 1200 baud
  292.     TYPE=ASYNC
  293.     PROTOCOL=KISS
  294.     IOADDR=3F8H
  295.     INTLEVEL=4
  296.     SPEED=2400
  297.     CHANNEL=B
  298.     QUALITY=10
  299.     MAXFRAME=2
  300.     TXDELAY=500
  301.     SLOTTIME=100
  302.     PERSIST=64
  303.     FULLDUP=0
  304.     FRACK=7000
  305.     RESPTIME=2000
  306.     RETRIES=10
  307.     PACLEN=120
  308.     QUALADJUST=5
  309.  
  310. ENDPORT
  311.  
  312.  
  313.  
  314. 3. Quadram Quadport.
  315.  
  316. The Quadram Quadport card supports up to 5 (yes I know it says quadport!!)
  317. async ports. This version only supports one card - if anyone needs more,
  318. let me know. You do not need to define all ports, but you must start with
  319. the first, and not leave any gaps.
  320.  
  321. The card should be configured with first port at 280h, and software 
  322. selectable interrupts (3 or 4 may be used)
  323.  
  324. The card will support KISS TNCS (either normal, or KPC4 type dual port), or
  325. NETROM links (or a combination of both). 
  326.  
  327.  
  328. The following sample config file is for a Dual Port KPC4 on channel 1,
  329. a normal KISS TNC on channel 2, and a NETROM async link on channel 3.
  330.  
  331.  
  332. PORT
  333.     ID=KPC4 PORT 1
  334.     TYPE=QUAD
  335.     PROTOCOL=KISS
  336.     IOADDR=280H
  337.     INTLEVEL=3
  338.     SPEED=2400
  339.     CHANNEL=A
  340.     QUALITY=10
  341.     MAXFRAME=2
  342.     TXDELAY=500
  343.     SLOTTIME=100
  344.     PERSIST=64
  345.     FULLDUP=0
  346.     FRACK=7000
  347.     RESPTIME=2000
  348.     RETRIES=10
  349.     PACLEN=120
  350.  
  351. ENDPORT
  352.  
  353. PORT
  354.     ID=KPC4 PORT 2
  355.     TYPE=QUAD
  356.     PROTOCOL=KISS
  357.     IOADDR=280H
  358.     INTLEVEL=3
  359.     SPEED=2400
  360.     CHANNEL=B
  361.     QUALITY=10
  362.     MAXFRAME=2
  363.     TXDELAY=500
  364.     SLOTTIME=100
  365.     PERSIST=64
  366.     FULLDUP=0
  367.     FRACK=7000
  368.     RESPTIME=2000
  369.     RETRIES=10
  370.     PACLEN=120
  371.  
  372. ENDPORT
  373.  
  374. PORT
  375.     ID=NORMAL KISS
  376.     TYPE=QUAD
  377.     PROTOCOL=KISS
  378.     IOADDR=290H
  379.     INTLEVEL=3
  380.     SPEED=2400
  381.     CHANNEL=A
  382.     QUALITY=10
  383.     MAXFRAME=2
  384.     TXDELAY=500
  385.     SLOTTIME=100
  386.     PERSIST=64
  387.     FULLDUP=0
  388.     FRACK=7000
  389.     RESPTIME=2000
  390.     RETRIES=10
  391.     PACLEN=120
  392.  
  393. ENDPORT
  394.  
  395. PORT
  396.     ID=NETROM BACKEND
  397.     TYPE=QUAD
  398.     PROTOCOL=NETROM
  399.     IOADDR=2A0H
  400.     INTLEVEL=3
  401.     SPEED=2400
  402.     CHANNEL=A
  403.     QUALITY=10
  404.     MAXFRAME=2
  405.     TXDELAY=500        ; THESE AREN'T USED, BUT I SUGGEST  
  406.     SLOTTIME=100        ; YOU PUT THEM IN IN CASE ONE DAY
  407.     PERSIST=64        ; THEY ARE!
  408.     FULLDUP=1        ; THIS IS NOW NEEDED FOR A SINGLE NETROM
  409.                 ; TNC. SET TO 0 IF USING A DIODE MATRIX.
  410.     SOFTDCD=0
  411.     FRACK=7000
  412.     RESPTIME=2000
  413.     RETRIES=10
  414.     PACLEN=120
  415.  
  416. ENDPORT
  417.