Keithley IE-488 User manual

IE-488
Keithley MetraByte Corporation

*****

IE-488 Manual
Part Number: 24820
Revision A
Last Edit: June, 1984
Copyright @1984
KEITHLEY METAASYTEIASYSTIDAC
440 Myles Standish Boulevard
Taunton. Massachusetts 02780
Telephone [phone]
FAX [phone]

WARRANTY INFORMATION
All products manufactured by Keithley MetraByte are warranted against defective materials
and worksmanship for a period of one year from the date of delivery to the original
purchaser. Any product that is found to be defective wlthin the warranty period will. at the
option of Keithley MetraByte, be repaired or replaced. This warranty does not apply to
products damaged by improper use.

WARNING
Keithley MetraByte assumes no liability for damages consequent to the
u8e of this product. This product is not designed with components of a
level of reliability suitable for use in life support or crltical applications.
Information furnished by Keithley MetraEiyte is believed to be accurate and reliable.
However, the Keithley MetraByte Corporation assumes no responsibility for the use of such
information nor for any infringements of patents or other rights of third parties that may
result from its use. No license is granted by implication or otherwise under any patent
rights of Keithley MetraByte Corporation.
Keithley MetraByte/Asyst/DAC is also referred to here-in as Keith& MetmByte.
BasicTM is a trademark of Dartmouth College.
IBM@ is a registered trademark of International Business Machines Corporation.
PC, XT. AT, PS/2. and Micro Channel Architecture@ (MCA) are trademarks of
International Business Machines Corporation.
Microsoft@ is a registered trademark of Microsoft Corporation.
Turbo C@is a registered trademark of Borland International.

TABLE OF CONTENTS
CHAPTER 1
1.0 IEEE-488 GENERAL DESCRIPTION
1.1 IEEE-488 SYSTEM BUS OPERATIONS
CHAPTER 2
2.0 HARDWAREINSTALLATION
CHAPTER 3
3.0 MODESOF OPERATION
3.1 IMAGE SPECIFIERS
3.2 IMAGE TERMINATORS
3.3 FLAG RETURN CODES
CHAPTER 4
4.0 USER COMMANDS
ABORT 15
CLEAR 16
CONFIG 17
ENTER 18
EOI 19
LOCAL 20
LOCKOUT 21
OUTPUT 22
PARPOL 23
PASCTL 24
PPCONF 25
PPUNCF 26
REMOTE 27
REQUEST 28
RXCTL 29
STATUS 30
SYSCON 31
TRIGGER 32
3
4
9
11
12
13
14
Page 1

TABLE OF CONTENTS
CHAPTER 5
5.0 8086/8088 ASSEMBLY LANGUAGECALL FORMAT
5.1 ROM/RAM MEMORYMAP
5.2 STACK SEGMENTMAP
5.3 RETURN FLAG CODES
APPENDIX A DMA (Direct Memory Access) DATA TRANSFERS 36
APPENDIX B RUNNING COMPILED PROGRAMS 38
APPENDIX C MAIN IEEE488 (GPIB) BUS CONNECTIONS 40
APPENDIX D C88-01 CONNECTORCABLE 41
APPENDIX E INSTALLING IE-488 BOARD # 2 42
APPENDIX F EXAMPLE OF PROGRAMMING 43
REFERENCES 46
33
35
35
35
Page 2

GPIB IEEE488 MANUAL
1.0 GPIB IEEE488 INTERFACE CARD GENERAL DESCRIPTION
MetraByte's IE-488 General Interface (GPIB) I/O expansion board
for the IBM-PC computer is designed to plug directly into one I/O
slot inside the IBM-PC.The IE-488 has a built in 12 KbyteROM
interpreter which handles all the required initialization and
protocol functions required to use the IEEE488 Interface. No disk
files with driver routines are needed and the interpreter allows
all commands to be programmed in conventional high level IEEE488
command syntax e.g. REMOTE, ENTER etc. The IE-488 complies with
the IEEE November 1978 standard. The Interpreter is a relocatable
16 Kbyte block of code which may be entered via a BASIC CALL
statement or via DOS interrupt commands using assembly language
programming. All commands are string coded for ease of use. The
GPIB will handle up to 14 other talker/listener devices. The
controller maybe the IBM or any other of the 14 devices, any one
of which control may also be transferred to or from. The IE488
interpreter includes a group of subroutines which may be used to
to condition the data before data transfer when using assembly
language programs. The IE488 interpreter is capable of
implementing all twelve of the interface messages which are as
follows:-
1. The Data Message ---------------- The actual data information
sent from the talker device
to one or more listening
devices on the GPIB.
2. The Trigger Message ------------- This messaoe causes the
listener device(s) to
perform a device dependent
action when addressed.
3. TheClear Message ---------------
4. The Remote Message --------------
5. The Local Message ---------------
6. The Local Lockout Message -------
This message causes the
addressed device or all the
devices on the GBIB to
return to their predefined
state.
Causes the addressed device
or devices to switch from
front panel to remote prog-
ram control.
Causes the Remote Message
to be cleared from the
addressed device(s).
Prevents an operator from
manually returning to local
via front panel controls.
Page 3

GPIB IEEE488 MANUAL
7. Clear Lockout (Local Message) ---
8. Service Request Message - - - - - - - - -
9. Status Byte Message -------------
10. The Status Bit Message ---------
11. The Pass Control Message -------
12. The Abort Message --------------
GENERAL
Clears all devices on the
GPIB and sets in local mode.
Any device may send this at
any time to request service
from the controller. This
is cleared by sending the
device's Status Byte Msg.
if the device no longer
requires service.
A data byte that represents
the status of one device
on the bus. Bit 6 is set if
the device sent a Service
Request Message, and the
remaining bits are unique,
to the selected device.
A byte which represents the
operational conditions of a
group of devices on the
bus. Each bit represents a
device on the bus. This is
typical response to a Para-
llel Poll operation.
This allows transfer of the
bus management duties to
another device on the bus.
The System controller takes
unconditional control of
the bus from the active
controller. The
message
terminates communications
with the bus and sends a
Clear All message.
********* IEEE488 GPIB FUNCTION CLASSIFICATION TABLE ************
T6 -- Basic Talker, Serial Poll, Unaddressed if MLA
TEO -- No extended talker function
II4 -- Basic Listener, Unaddressed if MTA
LEO -- No extended listener function
SHl -- Complete Source Handshake capability
AH1 -- Complete Acceptor Handshake capability
SRl -- Complete Service Request capability
PPl -- Parallel Poll Remote configuration capability
RLl -- Complete Remote / Local capability
DC1
-- Complete Device Clear capability
DTl -- Complete Device Trigger capability
Cl,C2,C3,C4,CS - CONTROLLERstates
Page 4

GPIB IEEE488 MANUAL
1.1 IEEE488 SYSTEM BUS OPERATIONS
The sequence of actions for all data transfer commands on the bus
is as follows:
OUTPUT INPUT
1. IBM-PC Talk Address 1. Device Talk Address
2. UNLISTEN 2. UNLISTEN
3. Device Listen Address 3. IBM-PC Listen Address
After the transfer of data is complete the bus remains in the
last programmed condition.
SECONDARY COHMANDS
When communicating to/from devices which use secondary
addressing, the devices extended address is specified by
separating the primary address with a ".11 (period). The use of
extended addressing or secondary commands (maximum level of five)
complies with the 1978 IEEE488 standard. The bus sequence for
secondary or extended addressing is as follows:
1. IBM-PC Talk Address
2. Unlisten
3. Device Primary Address
4. Secondary Commands/Address
5. Data
NOT IN CONTROL ADDRESSING
When the IBM-PC is not the active controller on the bus, no other
devices may be addressed by the IBM-PC (all controller commands).
The IBM-PC may still transfer data as a talker/listener if setup
by the controller in charge. During an ENTER command the IBM-PC
waits until the active talker transmits the data if the IBM-PC
was addressed by the talker/listener. If the address codes are
not satisfied, ah9000 will be returned in the FLG% variable. This
allows the user to perform a program wait loop for maximum
efficiency in error handling. The OUTPUT statement waits until
the controller addresses the IBM-PC to talk and the ENTER command
waits until the controller addresses the IBM-PC to listen. The
IBM-PC may assume control if the controller in charge sends the
Take Control Message after it programs the IBM-PC as a Talker.
During a DMA transfer the IBM will wait until addressed before
data is transferred. A time out code is returned if the data is
not accepted by the talker/listener. The programmer may use this
return code for a time out loop also.
Page 5

GPIB IEEE488 MANUAL GENERAL
2.0 HARDWARE INSTALLATION
TheIE488 board requires one slot in the IBM-PC and 16
consecutive address locations in I/O space. The board also
requires a free 16 K-byte block of memory for the on board 12K-
byte ROM interpreter and 4K-byte Static Ram. Some I/O address
locations will be occupied by internal I/O and your other
peripheral cards, so to provide flexibility in avoiding conflict
with thesedevices the IE488 I/O address can be set by the Base
Address D.I.P. switch to be on any 16 bit boundary in the IBM -
PC decoded I/O space. This also makes possible the use of a
second IE488 interface board in the same computer. The I/O map
for IBM's standard Internal/External peripherals is listed on
page 2-23 of the "IBM Technical Reference Manual".
Usually, a good choice is to put the IE488 at base address
&H300 or &H310 (Decimal 768,784). (Note if you are using the IBM
prototype interface board, it uses the hex 300 -3lF address space
and would be in conflict).
There are three groups of switches on the IE488 interface card.
The Base Address switch is located on the top left corner and
marked BASE ADDRESS. The switch settings are listed as follows:
DEVICE I/O ADDRESS BITS
(msb) (lsb)
A9 AS A7 A6 A5 A4 Example shows
address bits 11 0 0 0 0 ADDRESS = &H300
switch pos. dn dn up up up up
A switch in the up (on) position corresponds to a ZERO (0) in the
address bit. Similarly, a ONE (1) is set in the address bit when
the switch is in the down (off) position. The example switch
setting above shows the address switch selecting &H300 (768
decimal) for the Base I/O Address.
NO CRECK IS MADE ON THE BASE ADDRESS WHEN INITIALIZED, BE SURE
THAT THE BASE ADDRESS SELECTED DOES NOT CONFLICT WITH ANY OTHER
PERIPHERALS.
The next switch is the MEMORYADDRESS switch. This switch selects
the 16 Kbyte block of memory on an even 16 Kbyte boundary. The
addressing of the switches corresponds to the absolute20bit
address location in 16 Kbyte increments. The MEMORY ADDRESS
switch is located above the gold edge connector.
MEMORYADDRESS BIT
(msb)
A19 A18 Al7 Al6 Al5
address bits 1 1 0 0 0
s
(lsb)
Al4 Example for
0 MEMORY ADDRESS
Page 6

GPIB IEEE488 MANUAL INSTALLATION
switch settings dn dn up up up up = &HCOOOO
Refer to Section 2 of the IBM Technical Reference Manual for a
complete system memory map layout. The address chosen in the
above diagram is COO00 hex which is in the 192 Kbyte expansion
area after the display buffers. This is usually a clear area on
most IBM P.C.'s. Make a note of the MEMORY ADDRESS and the BASE
ADDRESS of the boards for initialization.
*****************et WARNING *******t*t****ttt*tt
NO CHECK IS MADE ON THE MEMORY ADDRESS, MAKE SURE THERE IS NO
OTHER MEMORY ASSIGNED TO THE SELECTED ADDRESS.
The next switch setting is for the interrupt vectors and DMA
channel selection. The IBM-PC has eight (8) interrupt vector
levels and two levels (0 & 1) are not accessible since they are
used by the operating system. The remaining 6 vectors are
available to the user. The IBM-PC interrupt vector map is as
shown below with the standard assignments of function made by
IBM.
LEVEL
VECTOR
0
1
---------------
---------------
3”
-----------____
---------------
4 ---------------
5 ---------------
6 ---------------
7 ---------------
FUNCTION
[TIMER - SYSTEM ONLY)
[KEYBOARD - SYSTEM ONLY)
USER OR LPT2:
COMM2: ADAPTER
COMMl: ADAPTER
FIXED DISK OR LPT3:
FLOPPY DISKETTE DRIVES
PRINTER #l (LPTl:)
The INTERRUPT LEVEL & DMA selector switch is located in the
bottom center of the board. The switch is marked INT (1 2 4) and
is set as follows:-
INTERRUPT
0
1
2
3
4
5
6
7
LEVEL SW(2)-1
2
2
::
d":
SW(3)-2
UP
::
dn
up
a":
dn
SW(4)-4
up RESERVED
UP RESERVED
UP
UP
dn
dn
dn
dn
The standard switch setting is vector level 5 and is shown in
bold print. It is the users responsibility to select an interrupt
level that does not conflict with the operating system hardware.
If the system is using a spooler for the printer then Interrupt
Level 7 will be in use. Note that the interrupts are only used
during DMAtransfers, therefore if DMA is notusedthe setting is
irrelevant.
Page 7

GPIB IEEE488 MANUAL INSTALLATION
The last switch setting is the selected DMA channel. The switch
is part of the bank of four switches used for the interrupts. The
switch is marked DMA (1 - 3), up is Channel 3, down is channel 1.
In IBM-PC's equipped with floppy disk(s) only, DMA level 3 should
be used. Hard disk equipped machines (XT models) force the user
to utilize DMA level 1. This is somewhat restrictive, since due
to the hardware design of the IBM-PC, DMA level 1 page register
is the same as DMA level 0 (memory refresh). For more information
see Appendix A.
The board is shipped with the following switch settings.
MEMORYADDRESS = COO00 hex
BASE ADDRESS = 300 hex
INTERRUPT # = 5
DMA CHANNEL = 3
Having made the switch settings, you can now install the IE-488
board. First
remove the board from its protective eIectrostatic
packaging. It is a good precaution to discharge any electrostatic
charge you may have accumulated by touching the metal frame of
your computer (you should have it grounded for safety). Next, if
you have not already done so, TURNOPPTHEPOWERonyour computer
and take off the case (see IBM "Guide to Operations" for
reference). Remove a vacant back plate by undoing the screw at
the top and press the card guide supplied with the IE-488 board
on the opposite side of the case (some models may not require
this). Slip the IE-488 board in and secure the backplate. That
completes the hardware installation.
One more precaution concerning storage and handling of the
IE-488 interface board. MetraByte recommends that you retain the
special electrostatically shielded package and use it for
protective storage of the board if for any reason it is removed
from your computer.
Page 8

GPIB IEEE488 MANUAL COMMAND FORMAT
3.0 MODES OF OPERATION
In the interests of conciseness for the more experienced
programmer and user, this section has been written as a reference
and initially may be difficult to understand. If this is the
case, refer to Appendix F where a step by step real programming
example read together with this section provides an easier
introduction.
All modes of operation are determined by an ASCII
STRING in a command (COMMANDS or CMD$) referenced within a CALL
statement. The CALL statement format is:
XXX CALL IE488 ( COMMAND$, varf$I(%), FLAG%, BASADR% 1
where:
COWHANDS - is the COMMAND including device addresses or
secondary commands and [ image terminators 1. This
is always a STRINGandisdecodedbythe CommandLine
Interpreter in the IE-488 firmware (ROM). The
COMMANDis separated from the operands (devices etc.)
by one or more SPACES, any other delimiters will
cause a SYNTAX error in command line. The separator
for devices is always the comma "," andsecondary
address is always a period ".". The IMAGE string is
identified by brackets "[I". The Command Line
Interpreter is relatively tolerant of syntax error
identification and will send back the appropriate
error code to isolate the error. The format is:-
CMD$ = "COMMAND devl, dev2, . . . ..devn [image]"
The [image] specifier allows the user to specify the
variable field operations for the beginning and end
of the data transfer variable. The variable may be a
variable name, array identifier, numeric data value
or a string. The user must match the image to the
data type or an error will be generated in the data
transfer. No check is made in the match of the image
to the variable type, this is the responsibility of
the user. The [image] codings are explained in
section 3.1 (IMAGE SPECIFIERS).
varC$l(%) - isthe data variable OUTPUT/INPUT to be transferred
from/to. Datais transferred as specified by the
image terminator/specifier. If the image specifier
is not used the data is treated as an integer. The
data may be of String or Integer type.
FLAG% --- is the transfer status of the CALL statement. If an
error occurs FLAG% will contain a HEX number
representing the error condition. A set of error and
Page 9

GPIB IEEE488 MANUAL COMMANDFORMAT
transfer message codes are generated at the
completion of each CALL.
BASADR% -- is the address of the interface board being used.
BASADR% may be 0 or 1, or actual base address e.g. 768.
Page 10

GPIB IEEE488 MANUAL COMMANDFORMAT
3.1 IMAGE SPECIFIER
[S(p) (xl .m.zl - Input/Output the number of Bytes to/from the
variable string starting at position m and
ending at position z, with parity p (E=even,
O=odd, none). If m, z and p are omitted the
entire string will be output as in the string
variable$ as specified by the image terminator
(x) without parity. If no terminator is used
then the string will end with EOI.
[B(H/L) (x),m,zl- Input/Output the specified H/L number of Bytes
to or from the the specified integer variable
array starting at (m) array location and ending
at the (z) position. The data transferred will
not change the the other half of the 16 bit
integer, only the byte specified is changed on
an ENTER command. There is no change to the data
with the OUTPUT command. [BL#,2,101 will
transfer the low byte of position 2 thru
position 10 of the integer variable array. Note,
the number of bytes transferred is nine,
position two and ten are included. Transfer
termination is specified by the image
terminator. It is the user's responsibility to
insure that the array size and the type of array
are correct. No check is made on data types. The
values of m and z may be reversed which will
transfer data in the reverse order. If m and z
arethe same then only one word is transferred.
If mand z are omittedthenthe integer variable
is not considered an array and the variable is
transferred with or without an EOI depending on
the image terminator (x).
[M(x).m,sl - Input / Output the specified number of 16 bit
words to / from the specified integer variable
(array) starting with position (m) and ending
with position (2). The number of words
transferred is defined as [z - m + 13.
Termination is specified by the image
terminator. It is the user's responsibility to
insure that the array size and type of array are
correct. No check is made on data types. The
values of m and z may be reversed which will
transfer data in the reverse order. If m and z
are the same then only one word istransferred.
Ifm and s are omitted then the integer variable
is not considered an array and the variable is
transferredwith or without an EOI depending on
the image terminator (x).
Page 11

GPIB IEEE488 MANUAL COMMAND FORMAT
3.2
IMAGE TERMINATORS
%(t-1 The % image terminator cancels both the line
feed and EOI terminators during an OUTPUT command
execution. During an INPUT command the entry will
terminate when the array size or the input count
is reached (m + count = z) or EOI. The line feed
is entered as part of the array.
t(t)
+(t1
(t)
The # image terminator cancels the line feed
only. The data is terminated by an EOI during the
INPUT or OUTPUT command. The ENTER also
terminates if the last item in data list is
entered which sets the FLAG% variable with an
error code of &H0020.
The + image terminator cancels the line feedand
EOI during an OUTPUT command only. The INPUT
command is in the default mode (INPUT terminates
with EOI or last entry). If carriage return
and line feed are part of the data being
transferred they will be sent as normal data.
The transfer terminator t determines the type
of transfer the GPIB is to perform. The following
transfer codes are available. If this specifier
is not used the data transfer is under program
control.
D = Direct Memory Access (DMA) to the specified
array. The m and z specifiers must be used
with this type of transfer. Structure
programming must be used when this mode is
active. All variables must be assigned before
theCALLis executed and no new variables are
allowed to be introduced after the execution
of the CALL statement.See APPENDIX A for
details on DMA transfers.
Page 12

GPIB IEEE488 MANUAL COMMAND FORMAT
3.3
FLAG RETURN CODES
The following codes are returned in the FLAG% variable
upon completion of the CALL statement. The flag return codes are
grouped into 3 categories.
&HO000 = TRANSFERREDOK
&HO020 = NO INPUT EOI or LINE FEED
&HO030 = DEVICE TIME OUT
&HO040 = RESERVED
&HO050 = DMA CHANNEL BUSY
&HO060 = GPIB BUSY
&HO100 = HARDWAREFAILURE
&HO200 = TIME OUT ON DATA TRANSFER
&HO300 = DEVICE NOT ACTIVE CONTROLLER
&HO400 = IBM-PC ACTIVE CONTROLLER
&HO500 = SYSTEM NOT INITIALIZED
&HO600 = CONFIGURATION ERROR
&HlOOO
&HllOO
&H2000
&H3000
&H3100
&H3200
&H4000
&HSOOO
&H6000
&H7000
&H9000
UNDEFINED COMMAND
SYNTAX ERROR IN COMMANDLINE
UNDEFINED IMAGE
DEVICE RANGE ERROR
TOO MANY DEVICES
TALKER/LISTENER CONFLICT
COMMAND/DATAOUT OF RANGE
COMMANDREQUIRES DEVICE
UNDEFINED DEVICE CODE
INPUT ARRAY NOT INITIALIZED
IBM MUST BE TALKER or LISTENER
Page 13

GPIB IEEE488 MANUAL USER COMMANDS
4.0 USER COMMANDS
The following user commands are available. The string
variable COHHAND$ is the same string format as described in the
IBM-PC BASIC manual. A typical command string would be as
follows. Please note that all commands must be assigned in string
form before using the CALL statement.
COMMAND$=
"OUTPUT 03.13.20,05[WD#,2,201"
This command string would output integer words (16 bit) two thru
and including word 20 to device primary address 03 with secondary
addresses 13 and 20 and also to device primary address 05. The
data transfer uses the DMA (SEE APPENDIX A) mode for fast
access. The device codes must be in decimal within the range of
00 to 30. This allows the user a maximum of 31 device addresses
to choose from. However the maximum number of devices which may
physically be connected to the bus is 15.
The transfer of String data is limited to single element arrays
and must be initialized. The Maximum string size is 255 bytes as
defined in the IBM-PC Basic manual. The user may transfer a
string inside of an array such as VAR$(2,3), which would transfer
the string data contents of array element (2,3). An error code of
&H7000 will be returned in the FLAG% variable if the stringarray
element is not initialized.
EXAMPLES OF LEGAL STRING DATA TRANSFER:
xxx10 COMMANDS= "OUTPUT ll.Ol[$E+,9,22]"
xxx20 VAR$(2,8) ="THIS IS ARRAY ELEMENT 2,8"
xxx30 CALL IE488 (COMMANDS,VAR$(~,~), FLG%, BRD%)
This command will output the bytes "ARRAY ELEMENT" then return to
the user program.
xx100 VAR$(l) = "This is a single array element"
xx110 CALL IE488 (COMMANDS,VAR$(l), FLG%, BRD%)
This command will output the bytes ' single ar" then return to
the user program.
xx200 COMMANDS= "OUTPUT ll.Ol[$E,22,9]"
xx210 VAR$ = "THIS IS ALSO A SINGLE ARRAY TEST"
xx220 CALL IE488 (COMMANDS,VAR$, FLG%, BRD%)
This example will output the bytes "NIS A OSLA" i.e backwards,
then return to the user program.
Page 14