?DEB Console Debugger Notes
Sangoma Technologies Inc.
===========================
The specific name of the debugger may be one of the following:
BDEB - BSC (BAPI)
FDEB - Frame Relay (FAPI)
HDEB - HDLC (HAPI)
NDEB - BSCV2 (NAPI)
XDEB - X.25 (XAPI)
ZDEB - Streaming (ZAPI)
SDEB - SDLC (SAPI)
The debugger herein will be referred to simply as DEB, as it functions
identically for all protocols.
Introduction
------------
DEB may be used for card-level debugging purposes, for direct interaction with
the hardware through I/O ports, or with the protocol code. This utility
operates through the protocol API DLL and SDLA driver. It is provided since
the DOS Debug utility cannot access real memory from within the virtual DOS
machine. The alternative to using DEB is to run DEBUG after booting the system
under MS-DOS, which may not be convenient.
The memory and ports that may be accessed by DEB are only the range registered
for use by the SDLA driver. The I/O base port and base memory is set using the
Configurator program.
You may choose to run DEB to enter commands manually through the shared memory
interface for experimentation purposes, without having to recompile your
application each time you want to try something different. You may also be
instructed to run DEB by our technical support staff to diagnose a problem.
The hard copy manual provided with the development package describes the
shared memory interface to the protocol.
Usage
-----
DEB will interact with only one logical card at a time, which is specified on
the command line:
Usage: DEB [<card_number>]
The default card number is 0. Run Card Usage to look at the available
configured cards.
It is recommended that DEB be run without any other applications running that
may be accessing the card, especially if you will be changing memory or
performing commands to the protocol code manually through the mailbox.
All memory references are offsets from within the 8K window, and so the valid
memory range is 0000-1FFF. The valid port range is 0-3 relative to the base
port address.
When DEB is started, it will register for the use of the card using the
?APIRegisterCard() function. The reasons for failure are described in the
?API32.HLP online reference under this function. You may have a problem
running XDEB under X.25 for the reasons mentioned in XAPI32.HLP.
ALWAYS EXIT DEB USING 'QUIT' COMMAND AND NOT BY USING CTRL-C or BREAK. If you
prematurely exit the program, the card will not be deregistered which will
prevent you from reloading the card. If you exit in this way by accident, it
is advisable that you make sure all other applications using this API are
terminated, and that you type at the DOS prompt:
NET STOP SDLA
NET START SDLA
This will reset the registration count to zero and will allow you to reload
the card if necessary.
Command Reference
-----------------
All commands may be abbreviated as long as they are recognized as distinct.
For example, 'quit' may be abbreviated to 'q' as no other commands start with
'q'. In fact, each command starts with a different letter and so all commands
may be abbreviated to their first letters.
help/?
------
Lists the usage of all commands.
enter <start-address> <data-byte> [up to 28 more data bytes...]
---------------------------------------------------------------
Use this to change memory contents. If for example you want to change
0120 01 02 03 04 05 06 07 - 08 09 0A 0B 0C 0D 0E 0F
to
0120 01 02 A0 A1 A2 A3 07 - 08 09 0A 0B 0C 0D 0E CC
then:
deb> enter 122 a0 a1 a2 a3
0122 A0 A1 A2 A3
deb> enter 12f cc
012F CC
Note that the affected memory is dumped after the change is made to confirm
the change. It also dumps the ASCII text beside it, which is not shown here.
show {standard_window | window | card}
--------------------------------------
show standard_window (abbrev. to 's s'):
This will display the hard-coded standard window number, which is usually 7.
show window (abbrev. to 's w'):
This displays the last set window number, either by using the 'window' command
or by directly writing to port offset 2. It assumes the window was set to the
standard window when the program was started.
show card (abbrev. to 's c'):
This displays the current registered card in use by DEB.
input <port-offset>
-------------------
Reads an I/O port.
output <port-offset> <value>
----------------------------
Writes a value to an I/O port. The window may be changed by writing the window
number to port-offset 2 for the 502 only. It is easier however to use the
'window' command.
dump [<start-address> [<end-address> [<append-filename>]]]
----------------------------------------------------------
Dumps a range of memory. The relative offset range that is valid is 0000-1FFF.
Any address beyond this range is rejected. If no start-address is specified,
it will dump the next 0x80 bytes following the end of the last dump.
You will need to manually switch the window to dump outside the standard
window if necessary. The standard window contains the mailbox for issuing
commands.
Pressing any key while dumping will pause it, at which point you may stop or
continue.
If you would like a memory range dumped to file, you must specify the specific
start and end addresses. For example, to dump 16b0-16ff to dump.out:
deb> d 16b0 16ff dump.out
The dump is appended to the file, and the dump will always save the current
window number for reference. You must create separate file dumps for each
window.
rdump <start-address> <end-address>
-----------------------------------
Repetitively dumps the same range of memory. This is useful for watching
memory contents change without having to manually type in the dump command
over and over again. This dump may be paused at any time.
window <new-window-number>
--------------------------
Changes the current 8K shared memory window. There are in most cases 8
windows, from 0 to 7. Use caution when changing the window as the API DLL will
not be aware of window changes, and may write to the wrong area of memory if
an application is running. Make sure you are always returned to the standard
window before leaving DEB. It will ask you when quitting if you want to switch
to the standard window if it believes you are in a different one.
This command performs the same function as writing the window number to I/O
port offset 2 for the 502 only.
type <502 | 503>
----------------
The default card type on startup is the S502/S502E. If you will be changing
the window or writing to ports, and the card is the S503, you must enter:
deb> type 503
to set the board type to S503.
quit
----
Exits DEB normally. Always use 'quit' if possible. It will ask you if you want
to switch to the standard window if it believes you are in a different one. It
is highly recommended that you exit with the proper window set. Otherwise,
applications accessing the card will not function.
Download Driver Pack
After your driver has been downloaded, follow these simple steps to install it.
Expand the archive file (if the download file is in zip or rar format).
If the expanded file has an .exe extension, double click it and follow the installation instructions.
Otherwise, open Device Manager by right-clicking the Start menu and selecting Device Manager.
Find the device and model you want to update in the device list.
Double-click on it to open the Properties dialog box.
From the Properties dialog box, select the Driver tab.
Click the Update Driver button, then follow the instructions.
Very important: You must reboot your system to ensure that any driver updates have taken effect.
For more help, visit our Driver Support section for step-by-step videos on how to install drivers for every file type.