home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 14 Text / 14-Text.zip / comscp.zip / COMSCOPE.TXT
Text File  |  1994-12-08  |  10KB  |  171 lines
  1.                             OS/tools Incorporated
  2.       COMscope Serial Communications Monitor and Controller
  3.                              Product Description
  4.  
  5. Overview
  6.   COMscope is a Presentation Manager program that allows monitoring and control
  7.   of OS/2 COM devices, without interfering with any application accessing any
  8.   device being monitored.  COMscope can take the place of a stand alone
  9.   protocol analyzer to aid in troubleshooting communications sessions and to
  10.   help debug communications applications.  COMscope takes advantage of
  11.   extensions to the COMi device driver to allow a user to have complete control
  12.   of communications devices and processes on their OS/2 machines.
  13.  
  14. COMscope Device Monitoring and Display Capabilities:
  15.   +  Traces the serial stream as written to, and read from, the hardware, by
  16.      any communications application accessing the port.  There are two
  17.      display modes: Lexical and Time-relational.
  18.   +  Displays device driver transmit and receive buffer utilization by
  19.      showing the number of characters currently in a buffer and the ratio of
  20.      content to size (in percent).
  21.   +  All modem input signal states; CTS, DTR, CD, and RI.
  22.   +  Modem output signal states; RTS and DTR, as set by an application, the
  23.      COMi device driver, and/or COMscope.
  24.   + The "COM Event'' word, as seen by an application.  The "COM Event''
  25.      word is normally cleared whenever an application reads its contents.
  26.      COMscope gives you the choice of either clearing the device driver
  27.      variable or leaving it for an application to read and clear.
  28.   +  The "COM Error'' word, as seen by an application.  As with the 
  29.       "COM Event'' word, the user can choose to clear, or not clear, this
  30.       device  driver variable, as a query by an application would.
  31.   +  The "COM status'' byte, as seen by an application.
  32.   +  The ``Transmit Status'' byte, as seen by an application.
  33.   +  The current device setup, as selected by an application accessing a
  34.      device, or by COMscope.
  35.  
  36. COMscope Device Control Capabilities:
  37.   +  Can set all device driver parameters an application is able to set;
  38.      including baud rate, line characteristics, read/write time-out
  39.      processing, handshaking, stream filters, and FIFO function.
  40.   +  Can cause the receive and/or transmit device driver buffers to be
  41.      flushed.
  42.   +  Is able to place the UART into the break state, and return it to normal.
  43.   +  Can force the defined Xoff or Xon characters to be transmitted on
  44.      command.
  45.   +  Is able to force the device driver to act like an Xoff, or Xon, has been
  46.      received.
  47.   +  Will transmit any keystroke, or bit pattern as requested.
  48.   +  Is able to change the state of the OUT1 modem control register signal.
  49.   +  Controls all of the UART's output and diagnostic signals; including DSR,
  50.      RTS, OUT1, and LOOP.
  51.  
  52. Serial Stream Trace Details
  53.   COMscope will capture and/or display the entire data stream for the device it
  54.   is monitoring.  The captured data can be written to disk for later review and
  55.   processing.  Up to one million characters can be saved and reviewed in RAM.
  56.   The buffer trace can be set to either wrap around for a continuous trace, to
  57.   stop capturing when the buffer is completely filled, or write the buffer to
  58.   one of a series of files on disk each time the buffer becomes full.
  59.  
  60.   The trace data can be displayed as either ASCII characters or as eight bit
  61.   Hexadecimal numbers.  The receive and transmit streams can be displayed
  62.   either lexically, in two vertical columns, or time-relationally in
  63.   alternating rows.  Foreground and background colors for each display panel
  64.   are user selectable.
  65.  
  66.   In the time-relational mode the display can be set to highlight any
  67.   transmitted and/or received Xon/Xoff characters when Xon/Xoff handshaking has
  68.   been enabled in the device driver.  The stream can be displayed compressed or
  69.   expanded.
  70.  
  71.   In the lexical mode the user can select various filters and processing
  72.   options including: column synchronization, "new-line'' character detection,
  73.   line wrap, character bit mask, and character type filters.
  74.  
  75. Device Driver State Monitoring Details
  76.   Communications applications can query the device driver to determine the
  77.   state of the device and device driver it is accessing.  The application can
  78.   use the information received to make decisions for its own processing.
  79.  
  80.   Applications can get information on the number of characters in the receive
  81.   buffer and the number of characters in the transmit buffer.  In addition, the
  82.   functions that return the number of characters in the buffers, also return
  83.   the actual size of the buffer.  COMscope can display the count of characters
  84.   in a buffer and the ratio of character count to size for each buffer.
  85.  
  86.   An application can request information on errors detected by the UART and
  87.   device driver (COM Errors).  The errors reported include framing, parity,
  88.   hardware overrun, and device driver buffer overrun.  COMscope displays the
  89.   current states of this error information and gives the user the ability to
  90.   clear the field stored in the device driver instead of leaving it for an
  91.   application to read and clear.
  92.  
  93.   Communications processes can request information about various events
  94.   detected, and actions taken by the device driver and hardware.  All of the
  95.   information an application can access is available to the user in small
  96.   movable windows that can be placed anywhere on the screen.  Each of the four
  97.   fields, COM Event, COM Error, Transmit Status, and COM Status are represented
  98.   as hexadecimal numbers.  The user can easily get an explanation of what each
  99.   bit in each field represents by selecting that field.
  100.  
  101.   Normally the COM Event and COM Error words are cleared by the device driver
  102.   whenever an application requests them.  COMscope will clear either of these
  103.   two fields only at the users request.
  104.  
  105.   Applications can query the device driver for the current input and output
  106.   modem signals.  The states of these signals are also made available to the
  107.   COMscope user.
  108.  
  109.   The refresh rate for these monitored variables is adjustable.
  110.  
  111. Device Driver Control Function Details
  112.   Any device or device driver parameter an application can affect, can also be
  113.   controlled by COMscope.  A COMscope operator may change the baud rate,
  114.   protocol, read/write time-out processing, or any other function or operating
  115.   parameter of a device, without an application being aware of the changes.
  116.  
  117.   An application can flush the receive and transmit device driver buffers; as
  118.   can COMscope.
  119.  
  120.   Applications and COMscope can force the device driver to enter or exit the
  121.   transmit Xon or transmit Xoff state. When transmit Xon/Xoff processing is
  122.   enabled the device driver will stop transmitting when it receives the Xoff
  123.   character and begin transmitting again only after receiving the Xon
  124.   character.  When an application detects that transmitting has stopped because
  125.   an Xoff character has been received (by querying the Transmit Status byte),
  126.   it can force the device driver to begin transmitting again, without further
  127.   waiting for an Xon character to be received. An application can also force
  128.   the device driver to act like an Xoff has been received, causing the device
  129.   driver to stop transmitting until an Xon character is received.
  130.  
  131.   COMscope can transmit an Xon or Xoff on command, forcing the "far-end'' to
  132.   begin transmitting data again after it has stopped transmitting because it
  133.   has received an Xoff from the "near-end'' (this device driver), or stop
  134.   transmitting (assuming Xon/Xoff handshaking is enabled).  COMscope can
  135.   transmit any single byte value, put the UART in the break state, and take it
  136.   out of the break state, and can enable or disable the OUT1 modem control
  137.   register signal.
  138.  
  139. COMscope to Configure the COMi Device Driver
  140.  
  141.   The COMi device driver can be configured to start-up in any state the user
  142.   requires.  All of the protocol parameter defaults (baud rate, line
  143.   characteristics, handshaking, and stream filtering), 16550 UART FIFO
  144.   processing defaults, receive and transmit time-out processing defaults,
  145.   receive and transmit buffer sizes, extended modem control processing, the DOS
  146.   device name (COMx),  and other operating parameters for the device driver are
  147.   programmable by COMscope.
  148.  
  149.   COMscope can be used to query the device driver and initialization files for
  150.   all device driver run-time variables, as well as all of the device driver
  151.   default (start-up) variables.  With COMscope you can specify any DOS device
  152.   name for each port from COM1 through COM99.
  153.  
  154.   COMscope also makes it easy to set up COMi for ISA systems that are using
  155.   specific adapters that allow interrupt sharing.  The user simply selects the
  156.   type (brand/model) and fills any required fields that are required by the
  157.   adapter they are using, and COMscope does the rest.
  158.  
  159. The Future of COMscope
  160.   We have developed COMscope over the last four years.  It started as a simple
  161.   program to help us, and our beta customers, debug the first versions of our
  162.   COMi serial device driver.  COMscope has been evolving continuously as our
  163.   customer base has expanded and eventually matured into the current product.
  164.   We expect to continue this evolution as we apply the many suggestions our
  165.   customers have passed along to us.  Thank you for your interest,  We hope you
  166.   will find COMscope to be as useful as we have.
  167.  
  168. COMi, COMscope, and OS/tools are trademarks of OS/tools Incorporated.
  169.  
  170. OS/2 is a trademark of International Business Machines, Incoroporated.
  171.