home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 4 Drivers / 04-Drivers.zip / 594p.zip / PROGINFO / SPEW.DOC < prev    next >
Text File  |  1993-06-21  |  4KB  |  102 lines
  1. SPEW.DOC
  2.  
  3. Overview:
  4.  
  5.     SPEW is a simple little test program to verify existence and basic
  6.     functionality of Async Serial Communications devices.  Though designed
  7.     to work with any Async device that complies with the OS/2 API, it is
  8.     provided -- allong with full source code -- as a test tool for DigiBoard
  9.     hardware and device drivers.  It is text-only program designed to run in
  10.     in a "OS/2 Full Screen" environment.
  11.  
  12.     Depending on command line arguments, SPEW can individually or collectively
  13.     test device behavior with regard to Modem Signals, data throughput, and
  14.     machine resource utilization.  It is a very simple program and is not
  15.     intended to be a serious device performance testing or benchmarking
  16.     tool.  
  17.  
  18.     The full test suite will require a "loopback" connector on the port
  19.     being tested.  This connector should jumper the RS-232 signals together
  20.     thus:
  21.  
  22.          Tx--Rx        DTR--CD--RI        RTS--CTS
  23.         
  24. Functions:
  25.  
  26.     MODEM SIGNALS:
  27.         When SPEW tests modem signal behaviour, it is simply issuing OS/2
  28.     API DosDevIOCtl() command to the device.  It first retrieves the
  29.     current signal, then raises both DTR,RTS, then drops just RTS, then
  30.     drops just DTR, then drops both.  At each stage it makes further
  31.     DosDevIOCtl calls to retrieve the the results of the above changes
  32.     and reports them.  As the DTR and RTS signals are altered, you should
  33.     at the very minimum see the DTR,RTS signals obey the changes.  Also,
  34.     depending on the kind of cabling you have connected to the device,
  35.     other signals (DSR,CD,CTS,RI) should follow the line they are tied to.
  36.  
  37.     If you wish to bypass the modem signal testing phase, specify the
  38.     '-s' (NO-SIGNALS) flag on the comman line.
  39.  
  40.     DATA THROUGHPUT:
  41.         SPEW by default will assume that a "loopback" is connected to the
  42.     device such that all data that is transmitted is automatically
  43.     looped-back to the same device.  This is to permit the testing of
  44.     both DosRead and DosWrite system calls on the device without having
  45.     to provide an external source of data to Read.  In this case, SPEW
  46.     will attempt to Read back all the test data that it has transmitted
  47.     and will do some cursory verification of that data.
  48.  
  49.     Without a looback connector, SPEW can still perform Transmit-only
  50.     testing though no verification of the output is possible.  This can
  51.     be useful to test the basic accessibility of the device name(s) to
  52.     application programs.
  53.  
  54.     If you do not have a loopback connector or would like to bypass the
  55.     Read/Verify phase of SPEW, specify the '-l' (NO-LOOPBACK) flag on the
  56.     command line.
  57.  
  58.  
  59.     CPU UTILIZATION:
  60.         SPEW by default will attempt to give an idea of how much of the
  61.     machine resources available to it are consumed by sustaining the
  62.     level of throughput specified.  Ofcourse doing loopback simultaneous
  63.     transmit and receive (Full Duplex) tests will result in lower
  64.     throughput numbers and more computer resources (CPU) utilized.
  65.     SPEW takes a guess at this by running a background thread at lo
  66.     priority that simply does iterations of integer calculations.
  67.     Note that this background thread is designed to run at every idle
  68.     opportunity so OTHER processes (eg. BonAmi CPU MONITOR) that are
  69.     attempting comperable monitoring tasks will report that close to
  70.     100% of the CPU is in use.
  71.  
  72.     If you do not wish to have this background thread thus calculate CPU
  73.     utilization for you, specify the '-c' (NO-CPU) option on the
  74.     command line.
  75.  
  76.  
  77. Examples:
  78.  
  79. >spew com1
  80.  
  81. ## this will assume a loopback connector on COM1 and run modem signal tests
  82. ## followed by full duplex data throughput tests with CPU utilization reports
  83.  
  84. >spew com 1,8
  85.  
  86. ## this will assume a loopback connector on ALL the devices: COM1,COM2...COM8
  87. ## and run modem signal tests on EACH one in turn (one at at time); followed 
  88. ## by full duplex data throughput tests with CPU utilization reports on all 
  89. ## ports in PARALLEL  (one data throughput thread per channel)
  90.  
  91. >spew -sl com 1,8
  92.  
  93. ## this will skip the modem-signal and loopback Read tests and perform
  94. ## pure transmit tests on all devices COM1,COM2...COM8 in parallel, reporting
  95. ## performance and CPU utilization statistics.
  96.  
  97. >spew -cl com 7,8
  98.  
  99. ## this will skip the loopback Read tests and perform (one device at a time)
  100. ## modem signal tests followed by transmit-only tests of the port but no
  101. ## CPU utilization information will be generated.
  102.