Contents:
All
Ports Display
Single
Port Display
Running
easyadmw
Double-click the easyadm icon from the Control
Panel.
All
Ports Display
After double-clicking the easyadmw icon from
Control Panel, the 'All Ports Display' screen is displayed, as shown
below:
The window contains an entry for each port with
the following details:
Device The System name for the
port.
State There are five indicators showing
the current state of (from left to right): State of the Port: Open
(a green plus sign) or Closed (a red minus sign). State of RTS, CTS,
DTR, DCD: a red minus sign indicates that the signal is inactive and
a green plus sign indicates that the signal is active.
RxTot The total
number of characters received by the port since the system was started,
or the statistics were last cleared.
TxTot The total
number of characters transmitted by the port since the system was
started, or the statistics were last cleared.
Rx/s The rate
at which characters are being received in characters per second.
Tx/s The
rate at which characters are being transmitted in characters per second.
RxQ The number
of characters currently in the internal receive queue.
TxQ The number
of characters currently in the internal transmit queue.
Stallion ports found on the system but not mapped
onto system ports are displayed as COMXXX. On Windows NT un-mapped ports
can be mapped via Control panel > Network > Configure.
Double-clicking on a list box item displays
details about the selected port.
Other functions available from this screen are:
Clear Stats
Resets the slave statistics for the selected port to 0 (the slave
statistics include the counters displayed on this screen. If you have
not selected a port yet you will get a warning message. To select
a port just click on the associated row in the "All ports display"
listbox.
Legend Displays
the meaning of the state indicators.
Detail Displays
further details of the selected port via the Single Port Display.
Single
Port Display
The 'Detail' option on the 'All Ports Display'
screen displays the 'Single Port Display' screen in which more details
about the selected port is shown.
If you have not selected a port yet you will get a warning message.
To select a port, click on the associated row in the 'All ports display'
listbox.
The 'Single Port Display' screen is displayed:
The features of the Single
Port Display screen are described below:
Panel Panel
type as detected by the Stallion driver.
Port Windows
COM port name and Stallion driver port identification.
Comms Current
values for baud rate, number of bits per char (Data), number
of stop bits (Stop) and parity.
Hndshk Handshake
or flow controls settings.
Input Shows
a percentage of the effective transmitted throughput, considering
the baud rate and the total number of characters transmitted since
start-up or last Clear Stats.
Output Shows
a percentage of the effective received throughput considering the
baud rate and the total number of characters received since start-up
or last 'Clear Stats'.
Status Current
values for RXD, TXD, RTS, CTS, DTR, DCD, DSR and port state. A red
minus sign indicates that the signal is inactive and a green plus
sign indicates that the signal is active.
Further functions available from this screen
are described below:
Host
State
Shows per port information from the top-most
part of the Stallion driver, the part of the driver that interfaces
directly with the host Operating System. It displays information relevant
to that specific environment. For example, with Windows NT, it displays
IRP's related statistics. The information shown on the 'Host State'
screen is useful for support. It displays names and codes that relate
to the interface between the Stallion driver and the kernel. The information
presented predominately details the I/O Request packets (IRP) received
by the driver.
The data presented on the dialog box is explained
below:
Port This is the
COM name of the selected Stallion serial communications port. The
above example shows that COM4 is selected, this port should therefore
be accessed as '\\.\COM4'.
State This is an
indication of whether the selected Stallion serial communications
port is currently open or closed. Open indicates that an application
has connected to the port with a Win32 API call such as 'CreateFile()'.
Mask This is a hexadecimal
value showing the current event mask active on the selected serial
communications port UART. It is a value that needs to be decoded according
to the Win32 EV_xxxx flags.
Timeouts
RdInterv This is
the 'ReadIntervalTimeout' value specified in the COMMTIMEOUTS structure.
It specifies the maximum time, in milliseconds, allowed to elapse
between the arrival of two characters on the communications port.
During a ReadFile operation, the time period begins when the first
character is received. If the interval between the arrival of any
two characters exceeds this amount, the ReadFile operation is completed
and any buffered data is returned. A value of zero indicates that
interval timeouts are not used. A value of MAXDWORD, combined with
zero values for both the ReadTotalTimeoutConstant and ReadTotalTimeoutMultiplier
COMMTIMEOUTS members, specifies that the read operation is to return
immediately with the characters that have already been received, even
if no characters have been received.
RdTotMult This is
the 'ReadTotalTimeoutMultiplier' value specified in the COMMTIMEOUTS
structure. It specifies the multiplier, in milliseconds, used to calculate
the total time-out period for read operations. For each read operation,
this value is multiplied by the requested number of bytes to be read.
RdTotConst This is
the 'ReadTotalTimeoutConstant' value specified in the COMMTIMEOUTS
structure. It specifies the constant, in milliseconds, used to calculate
the total time-out period for read operations. For each read operation,
this value is added to the product of the ReadTotalTimeoutMultiplier
member and the requested number of bytes. A value of zero for both
the ReadTotalTimeoutMultiplier and ReadTotalTimeoutConstant members
indicates that total time-outs are not used for read operations.
WrTotMult This is
the 'WriteTotalTimeoutMultiplier' value specified in the COMMTIMEOUTS
structure. It specifies the multiplier, in milliseconds, used to calculate
the total time-out period for write operations. For each write operation,
this value is multiplied by the number of bytes to be written.
WrTotConst This is
the 'WriteTotalConstantTimeout' value specified in the COMMTIMEOUTS
structure. It specifies the constant, in milliseconds, used to calculate
the total time-out period for write operations. For each write operation,
this value is added to the product of the WriteTotalTimeoutMultiplier
member and the number of bytes to be written. A value of zero for
both the WriteTotalTimeoutMultiplier and WriteTotalTimeoutConstant
members indicates that total time-outs are not used for write operations.
Flush IRPs
Count This is a count
of the number of Flush IRPs (IRP_MJ_FLUSH_BUFFERS) that have been
received since the selected port driver was started.
Last Status This
is the NT_STATUS code of the last Flush IRP (IRP_MJ_FLUSH_BUFFERS)
completed by the driver. The actual code can be decoded from the NT
DDK file 'ntstatus.h', however any value except for STATUS_SUCCESS
(0x0) is usually considered an error.
Create IRPs
Count This is a count
of the number of Create IRPs (IRP_MJ_CREATE) that have been received
since the selected port driver was started.
Last Status This
is the NT_STATUS code of the last Create IRP (IRP_MJ_CREATE) completed
by the driver. The actual code can be decoded from the NT DDK file
'ntstatus.h', however any value except for STATUS_SUCCESS (0x0)
is usually considered an error.
Current? This is
an indication as to whether the Create IRP is still being processed
(ie. 'Yes' - is current, 'No' - is not current).
Cmd State This is
a hexadecimal value indicating the processing state (the IRP state-machine)
of the Create IRP being processed, or 0x0 if no IRP is current. It
is a value which needs to be decoded and is only of interest to Stallion
Technical Support.
Close IRPs
Count This is a count
of the number of Close IRPs (IRP_MJ_CLOSE) that have been received
since the selected port driver was started.
Last Status This
is the NT_STATUS code of the last Close IRP (IRP_MJ_CLOSE) completed
by the driver. The actual code can be decoded from the NT DDK file
'ntstatus.h', however any value except for STATUS_SUCCESS (0x0)
is usually considered an error.
Current? This is
an indication as to whether the Close IRP is still being processed.
(ie. 'Yes' - is current, 'No' - is not current).
Cmd State This is
a hexadecimal value indicating the processing state (the IRP state-machine)
of the Close IRP being processed, or 0x0 if no IRP is current. It
is a value which needs to be decoded and is only of interest to Stallion
Technical Support.
Control IRPs
Count This is a count
of the number of Control IRPs (IRP_MJ_DEVICE_CONTROL) that have been
received since the selected port driver was started.
Last Code This is
the last successfully completed control code data contained in the
I/O Request Packet's (IRP) current IRP stack pointer stack location
data structure, '->Parameters.DeviceIoControl.IoControlCode' field.
This is the value of the Device Control code. The actual code can
be decoded from the NT DDK file 'ntddser.h'
Last Status This
is the NT_STATUS code of the last Control IRP (IRP_MJ_DEVICE_CONTROL)
completed by the driver. The actual code can be decoded from the NT
DDK file 'ntstatus.h', however any value except for STATUS_SUCCESS
(0x0) is usually considered an error.
Last Info This is
the data contained in the I/O Request Packet (IRP) data structure
'irp->IoStatus.Information' field of the last Device Control IRP processed.
The data presented in this field depends upon the control IRP received,
more details can be found in the NT DDK file 'ntddser.h'.
Current? This is
an indication as to whether the Control IRP is still being processed.
(ie. 'Yes' - is current, 'No' - is not current).
Curr Code This is
the control code data contained in the I/O Request Packet's (IRP)
current IRP stack pointer stack location data structure '->Parameters.DeviceIoControl.IoControlCode'
field of the last Device Control IRP processed. This is the value
of the last Device Control code. The actual code can be decoded from
the NT DDK file 'ntddser.h'.
Cmd State This is
a hexadecimal value indicating the processing state (the IRP state-machine)
of the Device Control IRP being processed, or 0x0 if no IRP is current.
It is a value which needs to be decoded and is only of interest to
Stallion Technical Support.
Read IRPs
Count This is a count
of the number of Read IRPs (IRP_MJ_READ) that have been received since
the selected port driver was started.
Last Status This
is the NT_STATUS code of the last Read IRP (IRP_MJ_READ) completed
by the driver. The actual code can be decoded from the NT DDK file
'ntstatus.h', however any value except for STATUS_SUCCESS (0x0)
or STATUS_TIMEOUT (0x102) is usually considered an error.
Last Info This is
the data contained in the I/O Request Packet's (IRP) data structure
'irp->IoStatus.Information' field of the last Read IRP processed.
This value is the number of bytes returned in the last completed read
IRP.
Queue Size This is
the number if entries in the queue of Read IRPs (IRP_MJ_READ) awaiting
processing and/or completion.
Current? This is
an indication as to whether the Read IRP is still being processed.
(ie. 'Yes' - is current, 'No' - is not current).
Num Needed This is
the number of bytes the user mode application has requested from the
serial port with the 'ReadFile()' Win32 API call.
Count Last This is
the number of bytes that the driver has currently read from the UART
when attempting to satisfy a user mode application's 'ReadFile()'
Win32 API call, or one of the serial IRP completion flags (SERIAL_COMPLETE_READ_CANCEL(-1),
SERIAL_COMPLETE_READ_TOTAL(-2) or SERIAL_COMPLETE_READ_COMPLETE(-3)).
Write IRPs
Count This is a count
of the number of WRITE IRPs that have been received since the selected
port driver was started.
Last Status This
is the NT_STATUS code of the last Write IRP (IRP_MJ_WRITE) completed
by the driver. The actual code can be decoded from the NT DDK file
'ntstatus.h', however any value except STATUS_SUCCESS (0x0)
or STATUS_TIMEOUT (0x102) is usually considered an error.
Last Info This is
the data contained in the I/O Request Packet's (IRP) data structure
'irp->IoStatus.Information' field of the last Write IRP processed.
This value is the number of bytes sent in the last completed write
IRP.
Queue Size This is
the number if entries in the queue of Write IRPs (IRP_MJ_WRITE) awaiting
processing and/or completion.
Current? This is
an indication as to whether the Write IRP is still being processed.
(ie. 'Yes' - is current, 'No' - is not current).
Length This is the
number of bytes that the user mode application has requested the serial
port to transmit with the 'WriteFile()' Win32 API call.
Total Queue This
is the total number of bytes queued to the serial port from IRP_MJ_WRITE
IRPs.
Slave
State
The 'Slave State' screen shows per port information
from the bottom-most part of the Stallion driver. This is the part of
the driver that is closest to the serial hardware. The information presented
on the 'Slave State' screen relates to the functioning of the Stallion
driver, and may be useful for support. Selecting the "Slave" button
displays the Technical Information dialog.
The data presented on the dialog box is explained
below:
Port This is the
COM name of the port, the Board-x,Panel-y,Port-z text indicates the
physical Stallion board, panel and port (on the panel) that is being
viewed. In this case "Board-0, Panel-0, Port-1" indicates that the
physical port is the port marked as Port 01 on the first panel of
the first Stallion board initialized.
txringq This is the
number of characters currently buffered in the UART transmit ring
queue.
rxringq This is the
number of characters currently buffered in the UART receive ring queue.
txchars This is the
total number of characters transmitted on the selected port since
the selected Stallion port was last started, or since the 'Clear Stats'
button last pressed.
rxchars This is the
total number of characters received on the selected port since the
selected Stallion port was last started, or since the 'Clear Stats'
button last pressed.
opens This is the
number of opens the port has received since the selected Stallion
port was last started, or since the 'Clear Stats' button was last
pressed.
mints This is the
number of modem interrupts (eg. DCD transitions) that the selected
Stallion port has received since the port was last started, or since
the 'Clear Stats' button was last pressed.
state This is the
state of the port, it is a Stallion specific code indicating the current
processing state of the selected Stallion port and is useful to Stallion
Support personnel when isolating problems.
brks_out This is
the number of breaks the selected Stallion port has transmitted since
the port was last started, or since the 'Clear Stats' button was last
pressed.
brks_in This is the
number of breaks the selected Stallion port has received since the
port was last started, or since the 'Clear Stats' button was last
pressed.
ring over This is
the number of character overruns for the ring queue on the selected
Stallion port since the port was last started, or since the 'Clear
Stats' button was last pressed.
overruns This is
the number of receive character overruns to date on the selected Stallion
port since the port was last started, or since the 'Clear Stats' button
was last pressed.
framing This is the
number of receive framing errors to date on the selected Stallion
port since the port was last started, or since the 'Clear Stats' button
was last pressed.
parity This is the
number of receive parity errors to date on the selected Stallion port
since the port was last started, or since the 'Clear Stats' button
was last pressed.
flushes This is the
total number of hardware flushes that have been executed on the selected
Stallion port since the port was last started, or since the 'Clear
Stats' button was last pressed.
lost This is the
number of received characters lost to date, due to flow control problems
on the selected Stallion port. Data was lost due to characters arriving
when the ring queue was full and had to be flushed.
dcdcnt This is the
number of times that the DCD control line has been asserted on the
selected Stallion port since the port was last started, or since the
'Clear Stats' button was last pressed.
dtrcnt This is the
number of times that the DTR control line has been asserted on the
selected Stallion port since the port was last started, or since the
'Clear Stats' button was last pressed.
ctsoncnt This is
the number of times the CTS control line has been asserted on the
selected port since the port was last started, or since the 'Clear
Stats' button was last pressed.
ctsoffcnt This is
the number of times the CTS control line has been de-asserted on the
selected port since the port was last started, or since the 'Clear
Stats' button was last pressed.
rtsoncnt This is
the number of times that RTS has been asserted on the selected port
since the port was last started, or since the 'Clear Stats' button
was last pressed.
rtsoffcnt This is
the number of times the port has de-asserted RTS on the selected port
since the port was last started, or since the 'Clear Stats' button
was last pressed.
start_in This is
the number of Xon characters received on the selected serial communications
port since the port was last started, or since the 'Clear Stats' button
was last pressed.
stop_out This is the number
of Xoff characters received on the selected serial communications
port since the port was last started, or since the 'Clear Stats' button
was last pressed.
start_out This is the number
of Xon characters transmitted by the board software on the selected
port since the port was last started, or since the 'Clear Stats' button
was last pressed.
stop_out This is
the number of Xoff characters transmitted by the board software on
the selected port since the port was last started, or since the 'Clear
Stats' button was last pressed.
dcd This shows the
current assertion state of the DCD line. 1 means the control line
is asserted, 0 means the control line is not asserted.
cts This shows the
current assertion state of the CTS line. 1 means the control line
is asserted, 0 means the control line is not asserted.
dsr This shows the
current assertion state of the DSR line. 1 means the control line
is asserted, 0 means the control line is not asserted.
dtr This shows the
current assertion state of the DTR line. 1 means the control line
is asserted, 0 means the control line is not asserted.
rts This shows the
current assertion state of the RTS line. 1 means the control line
is asserted, 0 means the control line is not asserted.
ri This shows the
current assertion state of the RI line. 1 means the control line is
asserted, 0 means the control line is not asserted.
Clear Stats button
This button is used to reset the statistics being gathered and presented
on this dialog.
The remaining features of
the Single Port Display are described below:
Report.
Generates a support report for forwarding
to your distributor or Stallion Technologies. It should be used when
you have encountered a problem which cannot be solved. The report
contains all necessary information about the port. It is placed in
a file that can be e-mailed or faxed to support.
Send the complete report using the following
command:
Administrative Tools > Windows NT Diagnostics
> File > Save Report
to your distributor, or in the event that the distributor cannot be
reached, contact Stallion Technologies at www-support@stallion.com
Go to
Top of Page
