Racal Instruments 7064, Instruction Manual

Page: 171 / 179

DESCRIPTION: Package interface to run-time error module
An error descriptor is an unsigned integer composed of 4 bit fields:
field 1) Error severity field, 1 bit
field 2) Error type field, 2 bits
field 3) Line dump field, 1 bit
field 4) Error number, all remaining bits (2^12 for 16-bit unsigned ints)
The value of '0' is a reserved descriptor that denotes 'SUCCESS', i.e. no error condition.
In defining bit fields and macros associated with error descriptors, care must be taken to ensure
portability between host an target environments, since the size of an integer may not be the same.
NOTE! For backwards compatibility with old versions of VTX firmware:
1) Never delete an existing error descriptor.
2) Never redefine an existing error descriptor.
3) Always add new error descriptors to the end of the list.
4) Never define a 0-valued descriptor. 0 is a reserved descriptor.
PUBLIC MACROS:
errortype(ed) : returns error type
isfatal(ed) : TRUE i f error descriptor denotes a fatal error
iswarning(ed) : TRUE if error descriptor denotes a warning
issyntax(ed) : TRUE if error descriptor denotes a syntax error
isruntime(ed) : TRUE if error descriptor denotes a run-time error
isinternal(ed) : TRUE if error descriptor denotes an internal error
issuccess(ed) : TRUE if error descriptor denotes successful operation
iserror(ed) : TRUE if error descriptor denotes any kind of error
dolinedump(ed) : i f TRUE, dump current input line along/w error message
#ifndef ERROR_INCLUDE
#define ERROR_INCLUDE
#define E_NBITS (sizeof(unsigned)*8)
Error severity:
Error severity is considered either fatal or non-fatal. This
information is encoded into a 1-bit field.
C-3