Get Hardware Status                              

Input

Output

AX CBh 12h  Zero / -Error Code AX
BX         BX
CX         CX
DS:DX  Pointer to 128 byte Status Area     DX
  The Get Hardware Status function (12H) returns the status of the
  communication hardware.

  Caution:    The values and structure returned by this function are
              hardware-dependent and will vary according to type of
              hardware used to implement the CAS services.  It is
              recommended that you use the Get Current Event (10H) and
              Get Queue Status (11H) functions, or examine the Control
              File, instead of using this function.

  Returned Data Structure

  The format of the data area pointed to by DS:DX is as follows, depending on
  whether the hardware is an Intel SatisFAXtion board or an Intel Connection
  CoProcessor board.  (In the following description, bits that are "set" have
  a value of 1.)

  SatisFAXtion Board:

    Ofs  Len   Description

     0    1    Bit fields indicating the status of the connection:
Connection Status
Bit Dec Hex  Description
0 1 0001h  Data Modem in use
1 2 0002h  Resolution: 0 = 200X100
                  1 = 200X200
2 4 0004h  Data buffer dumped on receive
3 8 0008h  Data is in the buffer
4 16 0010h  File transfer mode
5 32 0020h  Request retransmit last page
6 64 0040h  No data available
7 128 0080h  Busy in T.30 CCITT Fax protocol
8 256 0100h  Not Used
9 512 0200h
10 1024 0400h
11 2048 0800h
12 4096 1000h
13 8192 2000h
14 16384 4000h
15 32768 8000h
     1    1    Board State
Board State
Bit Dec Hex  Description
0 1 01h  CCITT protocol state
1 2 02h
2 4 04h
3 8 08h  Current bit rate
4 16 10h
5 32 20h
6 64 40h  Handset Jack Active
7 128 80h  Reserved
     CCITT Protocol State:

        2 1 0  Action          State
        0 0 0  Idle            None
        0 0 1  Dialing         A
        0 1 0  Answering       A
        0 1 1  Transmitting    C
        1 0 0  Receiving       C
        1 0 1  Pre-message     B
        1 1 0  Post-message    D
        1 1 1  Disconnect      E

     Current bit rate:

        5 4 3  Bit Rate   Modem Mode
        0 0 0  300 bps    V.21 (HDLC)
        1 0 0  2400 bps   V.27 ter
        1 0 1  4800 bps   V.27 ter
        1 1 0  7200 bps   V.29
        1 1 1  9600 bps   V.29
        001-011 Reserved

     Handset Jack Active (off-hook):

        When this bit is set to 1, neither the fax image modem nor the data
        modem can be used (except for the current connection send or
        receive) until the device connected to the handset jack has been
        placed back on-hook.

     2    1    Number of KBytes free in the buffer.

     3    1    Number of pages or files in the buffer

     4    1    Number of retries left to dial this number.  The user sets
               the initial retry value in the SatisFAXtion SETUP program.
               The value is then automatically decremented each time a
               call is attempted.

     5    1    Fax page number to retransmit.  Used in conjunction with the
               "request for retransmit of last page" flag (offset 0, bit 5).

     6    1    Current block transfer page or file.  Number of the current
               page or file that is being transferred between the
               resident manager and the board (not necessarily the page
               or file that is currently being transmitted over the phone
               line).

     7    1    Number of rings detected when receiving a call.  Rings are
               counted only if auto-answer is enabled.

     8    2    Error count.  A 16 bit unsigned integer (byte 9 is most
               significant byte) that indicates the number of errors that
               have occurred during the connection.

     10   4    Length of file being transferred in file transfer mode.

     14   6    Reserved

     20   1    The character "B" if the SatisFAXtion board is present.

     21   13   Transfer agent name; ASCII string, null terminated.

     34   5    Transfer agent version number; ASCII string, null
               terminated.

     39   13   Resident loader name; ASCII string; null terminated.

     52   5    Resident loader version number; ASCII string, null
               terminated.

     57   21   Remote CSID; ASCII string, null terminated.

     78   13   Resident manager name; ASCII string, null terminated.

     91   5    Resident manager version number; ASCII string, null
               terminated.

     96   32   Reserved.

  Connection CoProcessor Board:

    Ofs  Len   Description

     0    1    Bit fields indicating the status of the transmission:
Status of Transmission
Bit Dec Hex  Description
0 1 01h  Reserved
1 2 02h
2 4 04h
3 8 08h  File Transfer Mode
4 16 10h  Reserved
5 32 20h
6 64 40h
7 128 80h  Busy Sending / Receiving
     1    2    Reserved

     3    1    Number of retries left to dial this number.  The user sets
               the initial retry value in the Connection CoProcessor's
               INSTALL or SETUPCC programs.

     4    1    Reserved

     5    1    Bit fields indicating the phone line status:
Phone Line Status
Bit Dec Hex  Description
0 1 01h  Phone Line Status
1 2 02h
2 4 04h
3 8 08h  Buffer Dumped on Receive
4 16 10h  Ring Detected, and Auto-Answer state
5 32 20h  Off hook (on line)
6 64 40h  Will be Sending Data
7 128 80h  Reserved
     Phone Line Status:

        0 0 0  Idle
        0 0 1  Dial
        0 1 0  Answer
        0 1 1  Transmit
        1 0 0  Receive
        1 0 1  Pre-message
        1 1 0  Post-message
        1 1 1  Disconnect

     6    1    Bit fields indicating the baud rate status:
Baud Rate Status
Bit Dec Hex  Description
0 1 01h  Reserved
1 2 02h
2 4 04h
3 8 08h
4 16 10h  Bit Rate
5 32 20h
6 64 40h
7 128 80h  Reserved
     Bit Rate:

        6 5 4  Bit Rate   Modem Mode
        0 0 0  300 baud   V.21 (HDLC)
        1 0 0  2400 baud  V.27 ter
        1 0 1  4800 baud  V.27 ter
        1 1 0  7200 baud  V.29
        1 1 1  9600 baud  V.29

     7    3    Reserved

     10   1    Bit fields indicating additional hardware status:
Additional Hardware Status
Bit Dec Hex  Description
0 1 01h  Line length compensation bit 0
1 2 02h  Line length compensation bit 1
2 4 04h  DMA Channel: 0=Channel 3
                     1=Channel 1
3 8 08h  Reserved
4 16 10h  Ring detect
5 32 20h  Off hook
6 64 40h  CCP has control of DAA
7 128 80h  Modem Option installed
     11   1    Bit fields indicating configuration of COM ports,
               Interrupts, and I/O ports:
Configuration Bit Fields
Bit Dec Hex  Description
0 1 01h  COM Port
1 2 02h
2 4 04h
3 8 08h  Reserved
4 16 10h
5 32 20h
6 64 40h
7 128 80h
     COM Port:

        2 1 0  COM Port  IRQ   I/O port
        0 0 1  COM 1    IRQ 4  I/O ports 3F8h - 3FFh
        0 0 0  COM 2    IRQ 3  I/O ports 2F8h - 2FFh
        0 1 1  COM 3    IRQ 4  I/O ports 3E8h - 3EFh
        0 1 0  COM 4    IRQ 3  I/O ports 2E8h - 2EFh
        1 1 1  COM 3    IRQ 5  I/O ports 3E8h - 3EFh
        1 1 0  COM 4    IRQ 2  I/O ports 2E8h - 2EFh

     12   1    Bit fields indicating additional hardware status:
Hardware Status
Bit Dec Hex  Description
0 1 01h  2400 BPS enabled
1 2 02h  4800 BPS enabled
2