usr.sbin/digictl/digictl.8

   1 .\" $FreeBSD$
   2 .Dd June 20, 2001
   3 .Dt DIGICTL 8
   4 .Os
   5 .Sh NAME
   6 .Nm digictl
   7 .Nd control
   8 .Tn Digiboard
   9 devices
  10 .Sh SYNOPSIS
  11 .Nm
  12 .Fl a
  13 .Cm disable | enable | query
  14 .Ar device ...
  15 .Nm
  16 .Op Fl d Ar debug
  17 .Op Fl ir
  18 .Ar ctrl-device ...
  19 .Sh DESCRIPTION
  20 The
  21 .Nm
  22 utility provides control of the
  23 .Tn Digiboard
  24 installed with the given
  25 .Ar ctrl-device
  26 name and provides control of individual digiboard
  27 .Ar devices .
  28 A digiboard
  29 .Ar ctrl-device
  30 is usually of the form
  31 .Sm off
  32 .Pa /dev/digi Ar N Pa .ctl
  33 .Sm on
  34 where
  35 .Ar N
  36 is the card number and starts at
  37 .Dq 0
  38 for the first attached card.
  39 A digiboard
  40 .Ar device
  41 is usually of the form
  42 .Sm off
  43 .Pa /dev/cua Oo Pa il Oc Pa D Ar N Pa \&. Ar P
  44 .Sm on
  45 or
  46 .Sm off
  47 .Pa /dev/tty Oo Pa il Oc Pa D Ar N Pa \&. Ar P
  48 .Sm on
  49 where
  50 .Ar N
  51 is the card number and
  52 .Ar P
  53 is the port number.
  54 .Pp
  55 The following flags are recognized:
  56 .Bl -tag -width 10n
  57 .It Fl a Cm disable | enable | query
  58 Disable, enable or query the
  59 .Em ALTPIN
  60 settings for the given port(s).
  61 .Pp
  62 When ALTPIN is enabled, the CD and DSR lines are logically reversed.
  63 This is useful when wiring serial ports to an 8 way RJ45 cable (full
  64 10 way RJ45 cables are quite rare).
  65 .Pp
  66 A single ALTPIN setting applies to both of the callout and callin devices.
  67 .It Fl d Ar debug
  68 If the driver has been compiled with
  69 .Dv DEBUG
  70 defined, the following bits from the
  71 .Ar debug
  72 variable are used to enable diagnostics in the digiboard driver:
  73 .Bl -tag -width ".No 1024 ( Em MODEM )"
  74 .It 1 ( Em INIT )
  75 Diagnostics during card attach, detach and initialization.
  76 .It 2 ( Em OPEN )
  77 Diagnostics when opening a port.
  78 .It 4 ( Em CLOSE )
  79 Diagnostics when closing a port.
  80 .It 8 ( Em SET )
  81 Diagnostics when setting tty device flags.
  82 .It 16 ( Em INT )
  83 Diagnostics when processing card events.
  84 .It 32 ( Em READ )
  85 Reports return values from port reads.
  86 .It 64 ( Em WRITE )
  87 Reports return values from port writes.
  88 .It 128 ( Em RX )
  89 Reports receive queue flow control.
  90 .It 256 ( Em TX )
  91 Reports transmit queue flow control.
  92 .It 512 ( Em IRQ )
  93 Diagnostics during interrupts (enable these with care).
  94 .It 1024 ( Em MODEM )
  95 Diagnostics when setting modem status flags.
  96 .It 2048 ( Em RI )
  97 Reports when a RING is received.
  98 .El
  99 .It Fl i
 100 Display the card identification string and type ID.
 101 .It Fl r
 102 Reinitialize the card.
 103 For boards with external port modules, it is possible to add or remove
 104 modules and dynamically reprobe the number of ports using this switch.
 105 All ports on the card must be closed in order to reinitialize the card.
 106 .Pp
 107 It is preferable to reinitialize the card rather than reload the entire
 108 digi module as reinitialization only affects the specified board rather
 109 than affecting all attached boards.
 110 .El
 111 .Sh HISTORY
 112 The
 113 .Nm
 114 utility first appeared in
 115 .Fx 5.0 .
 116 .Sh BUGS
 117 It should be possible to reinitialize a board without closing all of the
 118 existing ports.