Agilent Technologies Network Card E1439 User Manual

Module #1 - “Front master,

phase locked to external

reference” on page 81

Module #2 - “Front slave,

internal reference” on page

Backplane

10 MHz

frequency

reference

Internal clock and SYNC distribution

using VXI backplane ECL trigger lines.

External reference and SYNC distribution

using VXI backplane ECL trigger lines.

Module #1 - “Front master,

Module #2 - “Front slave,

Module #1 - “Front master,

phase locked to external

reference” on page 81

Module #2 - “Front slave,

10 MHz

frequency

reference

Internal clock and SYNC distribution using

front panel SMB clock and SYNC

extender connections.

External reference and SYNC distribution using

front panel SMB clock and SYNC

extender connections.

Download from Www.Somanuals.com. All Manuals Search And Download.

Using the Agilent E1439

Managing multiple modules

Module #1 - “Front slave,

internal reference” on page

Module #2 - “Front master,

Module # 3 - “Front slave,

Module #4 - “Front slave,

Sharing clock and SYNC among several

modules via front panel distribution.

Managing multi-mainframe systems

Module #1 - “Front slave,

internal reference” on page 80 phase locked to master” on

Module #2 - “Front master,

Module #3 - “Front slave,

Module #4 - “Front slave,

VXI Mainframe A

VXI Mainframe B

Clock and SYNC distribution using front panel

extender connections within and between mainframes.

Download from Www.Somanuals.com. All Manuals Search And Download.

Using the Agilent E1439

Managing multiple modules

Module #1 - “Front slave,

Module #2 - “Send sync to

slave” on page 84

Module # 3 - “Receive sync

from master” on page 85

Module #4 - “Front slave,

See “Delay and phase in triggered measurements” on page 25.

Backplane

VXI Mainframe A

VXI Mainframe B

Clock and SYNC distribution using front panel

extender connections between mainframes and

VXI backplane connections within mainframes.

Download from Www.Somanuals.com. All Manuals Search And Download.

Using the Agilent E1439

Managing multiple modules

Using an external sample clock

All modules “Front sync, external sample clock, wired-OR sync” on page 83

Splitter

User generated

External sample clock

external sync pulse

Sharing clock and SYNC among several

modules using external sample. Front panel distribution.

Download from Www.Somanuals.com. All Manuals Search And Download.

Using the Agilent E1439

Managing multiple modules

All modules “Rear sync, external sample clock, wired-OR sync” on page 84

Splitter

User generated

External sample clock

external sync pulse

Sharing clock and SYNC among several

modules using external sample. Rear panel distribution.

Download from Www.Somanuals.com. All Manuals Search And Download.

Using the Agilent E1439

Managing multiple modules

Synchronizing changes in multi-module systems

Multi-module systems require special treatment with respect to timing of frequency and filter

changes. Center frequency changes may involve synchronizing the local oscillators of all modules

in a system. Digital filter changes in multi-module systems require that the decimation counters

be synchronized.

Calling the following functions voids synchronized multi-module setups:

age1439_clock_setup and related low-level clock setup functions

age1439_clock_recover

age1439_input_autozero

age1439_input_range_auto

age1439_self_test

age1439_state_recall

Special considerations apply to the measurement loop. See “The measurement loop in multi-

module systems” on page 24.

Synchronous digital filter changes

In multi-module systems where synchronous sampling is required, the decimation counters in all

the modules must be synchronous with each other. This condition can be forced by preparing each

module in the system in advance. Any measurement in progress is terminated at this time and the

module is placed in the Idle state. After each module is prepared, the next sync line transition

causes the digital decimation counter to be reset and started at the same time. Once this is done,

the decimation counters stay synchronized as long as the same ADC clock is used.

If you also intend to change the center frequency along with the digital filters, you should

synchronize the digital filters first. Otherwise, the center frequency phase becomes

unsynchronized when the digital filters are changed.

Synchronous center frequency changes

In multi-module systems you may prepare each module in advance of a frequency change, then

perform the change synchronously by asserting the Sync line. This preserves the phase

relationship of the local oscillators for all modules in the system. Certain special considerations

apply to multi-module frequency changes:

•

If all modules in a system are in the Idle state when the Sync line transition occurs, the LO

frequency is updated and the next measurement is armed.

If all modules are in the measurement state in continuous mode when the Sync line transition

occurs, the LO frequency is synchronously updated, and the measurement continues.

In continuous mode, care must be taken to assure that all modules are in the same state, either

the Idle state or the Measure state, before the Sync line transition occurs, otherwise some

modules re-arm while others continue the current measurement.

•

In block mode, it is simplest to keep Forced Idle asserted during the Sync line transitions to

keep all the modules in the Idle state.

If you also intend to change the digital filters along with the center frequency, you should

synchronize the digital filters first. Otherwise, the center frequency phase becomes non-

synchronized when the digital filters are changed.

Download from Www.Somanuals.com. All Manuals Search And Download.

Using the Agilent E1439

Managing multiple modules

Trigger and phase in multi-module systems

When you use triggering in multiple modules, you do not need to measure phase differences

between two or more channels if the channels are set up identically in terms of digital filtering and

LO frequency, and the digital filters and LOs are correctly synchronized. Since the filters and LOs

are synced together, their actual trigger delays and LO phases are identical and will cancel out of

relative phase measurements. Any remaining delay should be less than 10ns between two

modules in the same mainframe.

Only the module that generates the trigger has knowledge of the delay between the trigger event

and the start of data collection. Therefore, if you need the actual delay from the trigger, you

should use the trigger delay correction from the module that generated the trigger. Likewise, you

should obtain the LO phase at the time of the trigger from the module that generated the trigger.

External sample synchronization in multi-module systems

There are two general instances where you might want to use an external sample clock in a system

with multiple E1439s:

•

You wish to have the ADC's sample at a rate other than the 95 MHz clock supplied with the

E1439.

•

You wish more precise simultaneous sampling than can be provided by the normal scheme

that uses the internal VCXOs within the modules locked together by a 2.5 MHz reference that

is distributed from module to module. By exercising care in matching the skew of the sample

clocks fed into each module, channel-to-channel group delays at low frequencies can be well

below a nanosecond.

Note

External sample is specified only for use with baseband path.

To use external sample clocks with multiple modules and still perform synced measurements, you

need to use either the AGE1439_FRNT_SYNC_EXT_SAMP or AGE1439_REAR_SYNC_

EXT_SAMP clock setups (see “age1439_clock_setup” on page 78). These setups use the signal

that you feed into the Ext Clock/Ref BNC input of the E1439 as a sample clock for the ADC. A

counter within the E1439 generates two lower frequency clocks, one for the DSP circuitry and

one to clock the measurement SYNC signal between multiple modules. Since these clocks are

generated independently within each module, the counters in each module must be synced

together with a common externally generated signal in order to make properly synced and

triggered measurements involving multiple channels. You feed this "external sample sync" signal

into the External Trigger BNC and the module uses the signal to reset the counters to a known

phase.

The external sample sync signal should be generated on the falling edge of the external sample

clock, and fed into each module in the system by an identical length coax cable. Likewise, the

sample clock should be fed into each Ext Clock/Ref BNC by an identical length coax cable from a

common driver.

Download from Www.Somanuals.com. All Manuals Search And Download.

Using the Agilent E1439

Managing multiple modules

Here is the sequence of operations:

1. Put all modules into either the AGE1439_REAR_SYNC_EXT_SAMP mode or the

AGE1439_FRNT_SYNC_EXT_SAMP mode with the age1439_clock_setup command.

2. Issue the age1439_ext_sample_sync (AGE1439_EXT_SAMPLE_SYNC_ENABLE)

command to reset the counters within all the E1439s.

3. Generate the external sample sync pulse simultaneously into all modules. One way to do

this is to use one of the VXI TTLTRG lines and reclock the signal with the falling edge of

the sample clock. Note: If you are using an E1439A module with a serial number lower

than US41140000, you will need some user supplied hardware to convert TTLTRG to

ECL because older E1439As do not support TTL trigger.

4. Issue the age1439_clock_recover command to all modules since the DSP clock was

interrupted between the age1439_ext_sample_sync command and the external sync

signal on the Trigger input.

5. Sync the digital filters:

•

Force all modules to idle (age1439_meas_control).

Send the age1439_filter_sync command to all modules.

Assert and release the sync line from the master module (age1439_meas_control).

Release all modules from idle (age1439_meas_control).

6. Sync the digital local oscillators:

•

Force all modules to idle (age1439_meas_control).

Set all module frequencies to zero (age1439_frequency_center).

Assert and release system Sync (age1439_meas_control).

Set the LO frequencies to the desired ones (age1439_frequency_center).

Toggle system Sync again to synchronously set the LO frequencies (age1439_meas_

control).

•

Finally release all modules from idle (age1439_meas_control).

7. Now you may take a measurement:

•

Issue an age1439_meas_start.

Retrieve data from the modules when valid.

In the event that you do not supply a synchronizing signal in a reasonable length of time (or you

change your mind about it), the DSP clock can be restored by issuing age1439_ext_sample_sync

(AGE1439_EXT_SAMP_SYNC_CANCEL) followed by an age1439_clock_recover.

You should not need to perform the external sample sync operation again unless the external

clocks are interrupted or the clock setup changed.

See also the diagrams earlier in this section that show the physical setup. All the functions

mentioned above are described in “Functions listed alphabetically” in chapter 4.

Download from Www.Somanuals.com. All Manuals Search And Download.

Using the Agilent E1439

Transferring data

You can transfer data from the Agilent E1439C or D via the VMEbus. With the Agilent E1439D

you can also transfer data via the Local Bus and via a fiber optic interface.

•

The VMEbus is the universal data bus for VXI architecture. It provides flexibility and

versatility in transferring data. Transfers over the VMEbus are 16 bits or 32 bits wide.

•

The Local Bus on the Agilent E1439D supports faster transfer rates than the VMEbus. For

example, if you are transferring data from the Agilent E1439D to the Agilent E9821, the

Local Bus provides a direct pipeline to the Agilent E9821’s DSPs.

Using the Local Bus, you can transfer data in the background while processing data in a

signal-processing module. All Local Bus data transfers originate in the Agilent E1439D and

move towards a signal processing module to the right of the Agilent E1439D. If other

modules generate data to the left of the input module, the Agilent E1439D passes the data to

its right and inserts or appends its own data at the beginning or end of the frame.

•

The fiber optic interface, available on the Agilent E1439D, provides data rates greater than

200 Mbytes/second. It can transmit filtered or unfiltered data, copy data from its receiver to its

transmitter, or append data to copied data.

Download from Www.Somanuals.com. All Manuals Search And Download.

Using the Agilent E1439

Fiber Optic Interface

The E1439D provides a fiber optic interface that can transmit continuous full bandwidth data

from the internal A/D converter. In addition, it can stream data from multiple synchronized

modules operating at lower bandwidths onto a single fiber optic channel. An optical receiver can

then simultaneously analyze data collected at different frequencies and bandwidths.

The E1439D fiber optic interface uses a serial data stream protocol providing high data

throughput and low latency characteristics. This protocol is intended to be compatible with the

Serial Front Panel Data Port Draft Standard (VITA 17.1, draft 0.5 dated February 26, 2001)

currently under development by the VITA Standards Organization (http://www.vita.com). VITA

17.1 is not yet approved and manufacturers are not yet permitted to claim conformance to the

draft standard. However, laboratory testing at Agilent Technologies has demonstrated

interoperability of the E1439D with fiber optic products from other manufacturers that also intend

to support the draft standard. These products include Systran Simplex Link Protocol products,

such as the SL100 and SL240, and Mercury Computer products, such as the RINOJ-F RACEway

I/O daughter card.

The following overview supplies the basic concepts required to use all the supported features. For

details, see the descriptions of the API functions.

Download from Www.Somanuals.com. All Manuals Search And Download.

Using the Agilent E1439

Fiber Optic Interface

Fiber Frames

Data is transmitted over the fiber interface in a series of fiber frames. Each fiber frame is

composed of a series of 32-bit values, which encode to 40 bits. Each 32-bit value can either be

data or an ordered set. Data and ordered sets are strung together to make the three types of fiber

frames—Data Frame, BOF, and EOE. The Data Frame transmits 0 to 512 32-bit data words. The

exact amount of data that is sent depends on the amount of data that is available when the fiber

interface is ready to send the Data Frame. BOF (Beginning Of Frame) is a synchronizing event

that can be sent just prior to the start of data transmission. EOE (End Of Epoch) is a synchronizing

event that contains the last 4 data bytes in an epoch. An epoch is composed of one or more Data

Frames followed by an EOE. The following shows the ordered sets and data that make up the

three fiber frames:

Data Frame (Normal Data Fiber Frame)

IDLE

SOF

0 to 512 data words

CRC

FEOF

SEOF

GO/STOP

BOF (Sync Without Data Fiber Frame)

No data

MEOF

IDLE

SOF

CRC

SEOF

EOE (Sync with Data Fiber Frame)

SWDV

Last 4 data bytes in epoch

SOF

MEOF

1. Pad for Data Frame or BOF

2. Start Of Frame, framing event that embeds PIO1, PIO2, and DIR

3. 32 bit or 4 Byte words, maximum 2048 Bytes

4. Cyclic Redundancy Check, optional

5. Frame End Of Frame, end of Data Frame

6. Status End Of Frame, embeds FIFO OV and NRDY

7. Flow controls

8. Mark End Of Frame, end of BOF and EOE

9. Sync With Data Valid, start of EOE

10.4 bytes, exactly

Control Signals

PIO1, PIO2, DIR, and NRDY are FPDP (front panel data port) control signals. These signals can

be defined by another product or you can define their meaning and application.

When an overflow condition in the transmit FIFO occurs, the E1439D asserts FIFO OV indicating

a loss of data. This may occur in Append fiber mode if the available fiber bandwidth capability is

exceeded.

If flow control is enabled, the E1439D responds to the STOP and GO signals. See “Generate” on

page 48 for details.

Download from Www.Somanuals.com. All Manuals Search And Download.

Using the Agilent E1439

Fiber Optic Interface

Fiber Modes

The E1439D’s fiber interface can operate in five different modes:

•

“Off” on page 45

“Copy” on page 46

“Raw” on page 47

“Generate” on page 48

“Append” on page 50

Off

The Off fiber mode disables the fiber transmitter but allows the fiber receiver to read control

signals. Normal data collection and filtering continues, and the data port selection determines

whether data is sent to the local bus (Agilent E1439D only) or read from the FIFO via the VME

bus. See the following illustration.

E1438D / E1439D

Fiber RX

ADC

Fiber TX

DIGITAL

FILTERS

FIFO

VME BUS

LBUS

Fiber Interface Setup

Fiber Mode

Rate

Off

setting ignored

BOF

CRC

Flow Control

Epoch Generate setting ignored

Epoch Size setting ignored

Note

Setting the data port to Fiber while in the Off fiber mode causes the data FIFO to fill up with

filtered ADC data, which then causes data collection to stop.

Download from Www.Somanuals.com. All Manuals Search And Download.

Using the Agilent E1439

Fiber Optic Interface

Copy

The Copy fiber mode copies optical data from its fiber receiver to its fiber transmitter without

adding any data. Normal data collection and filtering continues, and the data port selection

determines whether data is sent to the local bus (Agilent E1439D only) or read from the FIFO via

the VME bus. Copy is the default fiber mode after power-on or reset. See the following

illustration.

E1438D / E1439D

1 KB

FIFO

Fiber RX

ADC

Fiber TX

DIGITAL

FILTERS

FIFO

VME BUS

LBUS

Fiber Interface Setup

Fiber Mode

Rate

Copy

106 or 250 MBs

setting ignored

BOF

CRC

must match incoming signal

setting ignored

Flow Control

Epoch Generate setting ignored

Epoch Size setting ignored

Note

Setting the data port to Fiber while in the Copy fiber mode results in an invalid instrument state.

Download from Www.Somanuals.com. All Manuals Search And Download.

Using the Agilent E1439

Fiber Optic Interface

Raw

The Raw fiber mode transmits raw (i.e., unprocessed, full bandwidth) ADC data over the fiber

interface. At the same time that the raw data is transmitted over the fiber interface, filtered ADC

data can be sent over the local bus (Agilent E1439D only) or read from the FIFO via the VME

bus. After selecting Raw, optical data transmission starts at the trigger event and is not affected by

trigger delays or data delays. The raw data transmission continues even after the measurement is

complete. Changing the fiber mode stops data transmission. See the following illustration.

E1438D / E1439D

1 KB

FIFO

Fiber RX

ADC

Fiber TX

DIGITAL

FILTERS

FIFO

VME BUS

LBUS

Fiber Interface Setup

Fiber Mode

Rate

Raw

106 or 250 MBs

BOF

CRC

Optional

Flow Control

Optional

Epoch Generate Optional

Epoch Size Divisible by 4

1. Only with external sam-

ple. Internal sample gen-

erates data too fast for

this rate.

2. Some receivers may

require CRC to be off

for compatibility

Note

Setting the data port to Fiber while in the Raw fiber mode results in an invalid instrument state

because raw and filtered data cannot both be sent over the fiber interface at the same time.

Download from Www.Somanuals.com. All Manuals Search And Download.

Using the Agilent E1439

Fiber Optic Interface

Generate

If flow control is off, Generate fiber mode transmits filtered ADC data over the fiber interface as

soon as data is available. ADC data is not available via any other data port and received optical

data is ignored. The following illustration shows an E1439D transmitting data when flow control

is turned off.

E1438D / E1439D

Fiber RX

Fiber TX

1 KB

FIFO

DIGITAL

FILTERS

ADC

FIFO

VME BUS

LBUS

Fiber Interface Setup

Fiber Mode

Rate

Generate

106 or 250 MBs

Optional

BOF

CRC

Flow Control

OFF

Epoch Generate Optional

Epoch Size Divisible by 4

1. Some receivers may

require CRC to be off

for compatibility

Download from Www.Somanuals.com. All Manuals Search And Download.

Using the Agilent E1439

Fiber Optic Interface

If flow control is on and the fiber receiver is capable of generating flow control signals, Generate

fiber mode transmits filtered ADC data after the fiber receiver indicates that it is ready and a

complete data block is ready to be transmitted. ADC data is not available via any other data port

and received optical data, other than the flow control signals, is ignored. The following

illustration shows an E1439D transmitting data to a fiber receiver when flow control is on.

E1438D / E1439D

Fiber Receiver

Fiber

Fiber RX

Fiber TX

1 KB

FIFO

FLOW

CONTROL

DATA

DIGITAL

FIFO

ADC

FILTERS

Processing

VME BUS

LBUS

Fiber Interface Setup

Mode

Generate

106 or 250 MBs

Rate

BOF

Optional

CRC

Flow Control

No Copy

Epoch Generate Optional

Epoch Size Divisible by 4

Download from Www.Somanuals.com. All Manuals Search And Download.

Using the Agilent E1439

Fiber Optic Interface

Append

The Append fiber mode copies optical data from its fiber receiver to its fiber transmitter and

appends its own filtered ADC data. This mode is required in an optical fiber append chain. For

the first module in an append chain, set the fiber mode to Generate, BOF to ON, and Epoch

Generate to ON. The module generates data epochs in the standard fashion and a BOF is sent after

each epoch. For all modules after the first, set fiber mode to Append, BOF to ON, and Epoch

Generate to ON. Each module copies received data to its transmitter output until a BOF is

received. The module then sends one epoch of filtered data from its ADC (if at least one block is

available), followed by a BOF.

In block data mode, the data from a single trigger is transmitted. Subsequent triggers should not

be generated faster than the data can be transmitted.

In continuous data mode, the generated data must not exceed the available fiber bandwidth,

allowing the data to be merged without data loss from a FIFO overrun. Therefore, you must

reduce the generated sample rate using either an external sample clock operating at a slower rate

or data decimation. If you use an external sample clock operating at a slower rate, epoch size must

be 1024 bytes (a larger epoch size causes a FIFO overrun resulting in a loss of data, and a smaller

epoch size increases overhead reducing the available bandwidth). The available bandwidth is then

about 101 MBytes/second or 238 MBytes/second. If you use data decimation, an epoch size of

approximately 2048 bytes provides the maximum available bandwidth.

Note

Epoch size and block size must be equal (in bytes). Since block size is in samples, you can

multiply block size by the number of bytes per sample to determine the equivalent epoch size.

Conversely, you can divide the epoch size by the number of bytes per sample to determine the

equivalent block size. Real 12-bit data contains 2 bytes per sample, complex 12-bit data and real

24-bit data contains 4 bytes per sample, and complex 24-bit data contains 8 bytes per sample.

Download from Www.Somanuals.com. All Manuals Search And Download.

Using the Agilent E1439

Fiber Optic Interface

The following shows two E1439D modules in an append chain transmitting data to a fiber

receiver when flow control is off.

E1438D / E1439D

Fiber Receiver

Fiber

1 KB

FIFO

Fiber RX

Fiber TX

Fiber RX

Fiber TX

1 KB

FIFO

1 KB

FIFO

DATA

DIGITAL

FIFO

DIGITAL

FIFO

ADC

FILTERS

Processing

VME BUS

LBUS

VME BUS

LBUS

Fiber Interface Setup

First E1439D in chain

Next E1439D in chain

Mode

Rate

BOF

Generate

Mode

Rate

BOF

Append

106 or 250 MBs

same as module to left

CRC

Flow Control

OFF

Flow Control

OFF

Epoch Generate ON

Epoch Size Divisible by 4; must match blocksize

Epoch Generate ON

Epoch Size Divisible by 4; must match blocksize

1. The final module in an append chain may require BOF to be Off for compat-

ibility with data receivers that cannot process BOFs.

Download from Www.Somanuals.com. All Manuals Search And Download.

Using the Agilent E1439

Fiber Optic Interface

The following shows two E1439D modules in an append chain transmitting data to a fiber

receiver when flow control is on.

E1438D / E1439D

Fiber Receiver

Fiber

1 KB

FIFO

Fiber RX

Fiber TX

Fiber RX

Fiber TX

1 KB

FIFO

1 KB

FIFO

DATA

DIGITAL

FIFO

DIGITAL

FIFO

ADC

FILTERS

Processing

VME BUS

LBUS

VME BUS

LBUS

Fiber Interface Setup

First E1439D in chain

Next E1439D in chain

Mode

Rate

BOF

Generate

106 or 250 MBs

Mode

Rate

BOF

Append

same as module to left

CRC

Flow Control

Copy

Flow Control

No Copy

Epoch Generate ON

Epoch Size Divisible by 4; must match blocksize

Epoch Generate ON

Epoch Size Divisible by 4; must match blocksize

1. The final module in an append chain may require BOF to be Off for compat-

ibility with data receivers that cannot process BOFs.

2. Set intermediate modules to Copy and the last module to No Copy.

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Introduction

The programmer’s reference is presented as a set of VXIplug&play functions since this is the

primary targeted environment. However, when you performed the setup for the Agilent E1439,

drivers were installed to support various programming environments as described in

“Programming the Agilent E1439” in chapter 3.

The function descriptions in the programmer’s reference are valid for all environments. Be sure to

follow the instructions in “Getting Started and Introduction” in chapter 2 to assure proper

installation and to become familiar with the capabilities of your Agilent E1439 software in

various programming environments. You should find the example programs particularly helpful

for programming in various environments.

Many of the function descriptions in the programming reference include several related functions.

You may use the primary function to set all related parameters or you may use the other functions

within the group to set or query a single parameter.

Parameter variables are presented as alphanumeric values which are descriptive and easy to

remember. However, for faster programming you may use the numeric equivalents for the

parameter variables listed at the end of this section.

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed by class

Component

Capability

Subclass

Function Name

INITIALIZE & CLOSE

age1439_init (on page 132)

age1439_close (on page 86)

MEASURE

READ

INITIATE

age1439_meas_control (on page 151)

age1439_meas_init (on page 154)

age1439_meas_start (on page 155)

age1439_meas_status_get (on page 156)

age1439_wait (on page 189)

MEASURE

READ

FETCH

age1439_read (on page 159)

age1439_read64 (on page 159)

age1439_read_raw (on page 162)

age1439_clock_fs (on page 76)

CONFIGURE

age1439_clock_fs_get (on page 76)

age1439_clock_recover (on page 77)

age1439_clock_setup (on page 78)

age1439_clock_setup_get (on page 78)

age1439_combo_setup (on page 87)

age1439_data_memsize_get (on page 88)

age1439_data_scale_get (on page 89)

age1439_data_setup (on page 90)

age1439_ext_sample_sync (on page 1 0 4)

age1439_ext_sample_sync_get (on page 1 0 4)

age1439_filter_setup (on page 120)

age1439_frequency_setup (on page 128)

age1439_input_autozero (on page 134)

age1439_input_range_auto (on page 137)

age1439_input_setup (on page 141)

age1439_input_range_convert (on page 138)6

age1439_trigger_setup (on page 183)

age1439_adc_clock (on page 72)

MEASURE

CONFIGURE

LOW LEVEL

age1439_adc_clock_get (on page 72)

age1439_adc_divider (on page 73)

age1439_adc_divider_get (on page 73)

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed by class

Component

Capability

Subclass

Function Name

age1439_data_blocksize (on page 90)

age1439_data_blocksize_get (on page 90)

age1439_data_delay (on page 90)

age1439_data_delay_get (on page 90)

age1439_data_mode (on page 90)

age1439_data_mode_get (on page 90)

age1439_data_port (on page 90)

age1439_data_port_get (on page 90)

age1439_data_resolution (on page 90)

age1439_data_resolution_get (on page 90)

age1439_data_spectral_order (on page 90)

age1439_data_spectral_order_get (on page 90)

age1439_data_type (on page 90)

age1439_data_type_get (on page 90)

age1439_data_xfersize (on page 96)

age1439_data_xfersize_get (on page 96)

age1439_filter_bw (on page 120)

age1439_filter_bw_get (on page 120)

age1439_filter_decimate (on page 120)

age1439_filter_decimate_get (on page 120)

age1439_filter_sync (on page 123)

age1439_frequency_center (on page 128)

age1439_frequency_center_get (on page 128)

age1439_frequency_center_raw (on page 125)

age1439_frequency_center_raw_compute (on

page 127)

age1439_frequency_center_raw_get (on page 125)

age1439_frequency_cmplxdc (on page 128)

age1439_frequency_cmplxdc_get (on page 128)

age1439_frequency_sync (on page 128)

age1439_frequency_sync_get (on page 128)

age1439_front_panel_clock_input (on page 131)

age1439_front_panel_clock_input_get (on page 131)

age1439_input_alias_filter (on page 141)

age1439_input_alias_filter_get (on page 141)

age1439_input_autozero (on page 134)

age1439_input_coupling (on page 141)

age1439_input_coupling_get (on page 141)

age1439_input_offset (on page 135)

age1439_input_offset_get (on page 135)

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed by class

Component

Capability

Subclass

Function Name

age1439_input_offset_save (on page 136)

age1439_input_range (on page 141)

age1439_input_range_get (on page 141)

age1439_input_signal (on page 141)

age1439_input_signal_get (on page 141)

age1439_input_signal_path (on page 141)

age1439_input_signal_path_get (on page 141)

age1439_reference_clock (on page 165)

age1439_reference_clock_get (on page 165)

age1439_reference_prescaler (on page 166)

age1439_reference_prescaler_get (on page 166)

age1439_smb_clock_output (on page 173)

age1439_smb_clock_output_get (on page 173)

age1439_sync_clock (on page 178)

age1439_sync_clock_get (on page 178)

age1439_sync_direction (on page 179)

age1439_sync_direction_get (on page 179)

age1439_sync_output (on page 180)

age1439_sync_output_get (on page 180)

age1439_trigger_adclevel (on page 183)

age1439_trigger_adclevel_get (on page 183)

age1439_trigger_delay (on page 183)

age1439_trigger_delay_get (on page 183)

age1439_trigger_delay_actual_get (on page 181)

age1439_trigger_gen (on page 183)

age1439_trigger_gen_get (on page 183)

age1439_trigger_magdwell (on page 183)

age1439_trigger_magdwell_get (on page 183)

age1439_trigger_maglevel (on page 183)

age1439_trigger_maglevel_get (on page 183)

age1439_trigger_phase_actual_get (on page 182)

age1439_trigger_slope (on page 183)

age1439_trigger_slope_get (on page 183)

age1439_trigger_type (on page 183)

age1439_trigger_type_get (on page 183)

age1439_vcxo (on page 187)

age1439_vcxo_get (on page 187)

age1439_vxi_clock_output (on page 188)

age1439_vxi_clock_output_get (on page 188)

age1439_epoch_setup (on page 98)

ROUTE

CONFIGURE

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed by class

Component

Capability

Subclass

Function Name

age1439_fiber_setup (on page 1 1 2)

age1439_lbus_mode (on page 148)

age1439_lbus_mode_get (on page 148)

age1439_lbus_reset (on page 150)

age1439_lbus_reset_get (on page 150)

age1439_fiber_BOF (on page 1 1 2)

ROUTE

CONFIGURE

LOW LEVEL

age1439_fiber_BOF_get (on page 1 1 3)

age1439_fiber_crc (on page 1 1 3)

age1439_fiber_crc_get (on page 1 1 3)

age1439_fiber_flow_control (on page 1 1 4)

age1439_fiber_flow_control_get (on page 1 1 4)

age1439_fiber_mode (on page 1 1 3)

age1439_fiber_mode_get (on page 1 1 4)

age1439_fiber_transfer_rate (on page 1 1 4)

age1439_fiber_transfer_rate_get (on page 1 1 4)

age1439_epoch_generate (on page 98)

age1439_epoch_generate_get (on page 98)

age1439_header (on page 99)

age1439_epoch_header_get (on page 1 0 0)

age1439_epoch_header_enable (on page 99)

age1439_epoch_header_enable_get (on page 99)

age1439_epoch_size (on page 98)

age1439_epoch_size_get (on page 99)

age1439_fiber_clear (on page 1 0 6)

ROUTE

CONTROL

age1439_fiber_error_clear (on page 1 0 7)

age1439_fiber_LED_get (on page 1 1 0 )

age1439_fiber_rcv_signals_get (on page 1 1 1 )

age1439_fiber_signal_get (on page 1 1 5)

age1439_fiber_verify (on page 1 1 6)

age1439_fiber_xmt_BOF (on page 1 1 7)

age1439_fiber_xmt_signals (on page 1 1 8)

age1439_fiber_xmt_signals_get (on page 1 1 8)

age1439_attrib_get (on page 74)

UTILITY

age1439_cal_get (on page 75)

age1439_driver_debug_level (on page 97)

age1439_driver_debug_level_get (on page 97)

age1439_error_message (on page 1 0 2)

age1439_error_query (on page 1 0 3)

age1439_interrupt_mask_get (on page 146)

age1439_interrupt_priority_get (on page 146)

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed by class

Component

Capability

Subclass

Function Name

age1439_interrupt_restore (on page 145)

age1439_interrupt_setup (on page 146)

age1439_options_get (on page 157)

age1439_product_id_get (on page 158)

age1439_reset (on page 167)

age1439_reset_hard (on page 168)

age1439_revision_query (on page 169)

age1439_self_test (on page 170)

age1439_serial_number (on page 172)

age1439_serial_number_get (on page 172)

age1439_state_save (on page 175)

age1439_state_recall (on page 174)

age1439_status_get (on page 176)

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed by functional group

This section lists the programing functions in groups of related functions. A brief description of

each group follows:

“Initializing and closing” on page 61: You must initialize the I/O driver and set up each module

before using any other functions.

“Identification” on page 64: These functions identify the module, serial number and options.

“Analog setup” on page 61: These functions determine how the analog input section is

configured.

“Data format” on page 61: An Agilent E1439 can collect either real or complex data in 12-bit or

24-bit format. It can collect data into various blocksizes or in a continuous mode. This data can be

transferred either on the VXI backplane, the Local Bus or over the fiber interface.

“Digital processing” on page 62: The decimation filter provides bandpass filtering and decimation

capabilities. You may also select limited frequency spans away from baseband.

“Measurement control” on page 64: These functions initiate or terminate the measurement loop.

“Timing” on page 64: The clock signals for the ADC sample clock can be set in a variety of ways.

One Agilent E1439 can be enabled to drive the sample clock line on the VXI backplane or front

panel to enable synchronization of multiple Agilent E1439 modules.

“Trigger” on page 65: These functions set all parameters associated with triggering the beginning

of data collection.

“Synchronization (controlling multiple modules)” on page 66: These functions support

synchronous operation among multiple Agilent E1439s by using shared ADC clock and Sync

signals to drive all the modules in a system.

“Reading data” on page 65: The Agilent E1439 reads data from either the VME or the Local Bus

data port. This data can optionally be scaled and converted to floating point.

“Interrupts” on page 64: The Agilent E1439 can be programmed to interrupt via the VXI

backplane whenever certain status conditions are present.

“Debugging” on page 62: Allows you to identify program and hardware problems.

“Fiber Interface” on page 62: These functions are only available on E1439D.

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed by functional group

Initializing and closing

age1439_init (on page 132) −initializes the I/O driver for a module

age1439_close (on page 86) −closes the module's software connection

Analog setup

age1439_input_setup (on page 141) −sets all the analog input parameters

age1439_input_alias_filter (on page 141) −include/bypass the built-in analog anti-alias filter

age1439_input_alias_filter_get (on page 141) −gets the anti-alias filter state

age1439_input_autozero (on page 141) −nulls out the input dc offset in baseband mode

age1439_input_coupling (on page 141) −selects ac or dc input coupling

age1439_input_coupling_get (on page 141) −get the input coupling type

age1439_input_offset (on page 135) −sets the dc offset settings for the current range

age1439_input_offset_get (on page 135) −gets the dc offset settings

age1439_input_offset_save (on page 136) −saves the dc offset settings in NVRAM

age1439_input_range (on page 141) −sets the full scale input range

age1439_input_range_auto (on page 137) −performs auto-ranging

age1439_input_range_convert (on page 138) −converts input range to volts

age1439_input_range_get (on page 141) −gets the input range

age1439_input_signal_path (on page 141) −selects baseband or IF signal path

age1439_input_signal_path_get (on page 141) −gets the signal path state

age1439_input_signal (on page 141) −connect/disconnect the input signal to the input ampli-

fier

age1439_input_signal_get (on page 141) −gets the input buffer amplifier state

age1439_state_save (on page 175) −saves the current module state

age1439_state_recall (on page 174) −recalls a previous module state

Data format

age1439_data_setup (on page 90) −sets all format and data output flow parameters

age1439_data_blocksize (on page 90) −determines the size of the output data block

age1439_data_blocksize_get (on page 90) −gets the output data block size

age1439_data_delay (on page 90) −determines FIFO delay in continuous mode

age1439_data_delay_get (on page 90) −gets FIFO delay

age1439_data_memsize_get (on page 88) −returns module's memory size

age1439_data_mode (on page 90) −selects block mode or continuous mode

age1439_data_mode_get (on page 90) −gets the data mode

age1439_data_port (on page 90) −selects VME bus, local bus or fiber interface for output

transmission

age1439_data_port_get (on page 90) −gets the output port designation

age1439_data_resolution (on page 90) −selects 12 or 24 bits data resolution

age1439_data_resolution_get (on page 90) −gets the data resolution

age1439_data_scale_get (on page 89) −gets the data scale factor used to convert raw data to

volts

age1439_data_type (on page 90) −selects real or complex output data

age1439_data_type_get (on page 90) −gets output data type

age1439_data_spectral_order −specifies the spectral order of the output data.

age1439_data_spectral_order_get −gets the spectral order of the output data.

age1439_data_xfersize (on page 96) −allows a specified amount of data to be read before an

entire block has been acquired.

age1439_data_xfersize_get (on page 96) −gets the data transfer size

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed by functional group

age1439_lbus_mode (on page 148) −sets the transmission mode of the local bus

age1439_lbus_mode_get (on page 148) −gets the local bus transmission mode

age1439_lbus_reset (on page 150) −resets the local bus

age1439_lbus_reset_get (on page 150) −gets the local bus reset state

Debugging

age1439_cal_get (on page 75) −gets last calibration date of specified board

age1439_clock_recover (on page 77) −allows recovery from an out-of-spec external sample

clock

age1439_driver_debug_level (on page 97) −sets the debug level

age1439_driver_debug_level_get (on page 97) −gets the debug level

age1439_error_message (on page 102) −returns error information obtained from function

calls

age1439_error_query (on page 103) −queries the module for the most recent error

age1439_status_get (on page 176) −retrieves the module's status register information

age1439_meas_status_get (on page 156) - retrieves the current measurement status register

information

age1439_self_test (on page 170) −performs a self-test on the module and returns the result

Digital processing

age1439_combo_setup (on page 87) −a quick way to set blocksize, center frequency, and sig-

nal bandwidth with one function

age1439_filter_setup (on page 120) −sets the digital filter bandwidth and decimation filter

parameters

age1439_filter_bw (on page 120) −selects a signal filter bandwidth

age1439_filter_bw_get (on page 120) −gets the signal filter bandwidth

age1439_filter_decimate (on page 120) −enables/disables an extra factor of 2 decimation

age1439_filter_decimate_get (on page 120) −gets current state of extra decimation

age1439_filter_sync (on page 123) −synchronizes the decimation filter counter

age1439_frequency_setup (on page 128) −sets all zoom center frequency parameters

age1439_frequency_center (on page 128) −sets the center frequency

age1439_frequency_center_get (on page 128) −gets the current center frequency

age1439_frequency_center_raw (on page 125) −quickly sets the center frequency

age1439_frequency_center_raw_compute (on page 127) −quickly calculates the values for

age1439_frequency_center_raw

age1439_frequency_center_raw_get (on page 125) −gets the raw center frequency

age1439_frequency_cmplxdc (on page 128) −selects a complex baseband measurement

age1439_frequency_cmplxdc_get (on page 128) −gets the state of the baseband measurement

mode

age1439_frequency_sync (on page 128) −prepares the module for a synchronous frequency

change

age1439_frequency_sync_get (on page 128) −gets the state of the synchronous change mode

Fiber Interface

age1439_fiber_BOF (on page 112) −controls whether or not automatically generated

BOF events are transmitted

age1439_fiber_BOF_get (on page 112) −returns the current value of bofEnable

age1439_fiber_clear (on page 106) −clears all data from the fiber interface FIFO buffers

age1439_fiber_crc (on page 112) sets up the fiber interface to transmit and receive cyclic

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed by functional group

redundancy checks.

age1439_fiber_crc_get (on page 112) −returns the current status of the cyclic redundancy

check setting.

age1439_fiber_error_clear (on page 107)−clears fiber errors from the status register

age1439_fiber_error_get (on page 108) −returns the value of the fiber interface error reg-

ister.

age1439_fiber_flow_control (on page 112) −configures fiber flow control, enabling or

disabling transmitter flow control signals.

age1439_fiber_flow_control_get (on page 112) −returns the current status of the fiber

flow control function.

age1439_fiber_LED_get (on page 110) −returns a data register indicating the state of the

front panel XMT/RCV led’s.

age1439_fiber_mode (on page 112) −selects the fiber interface mode.

age1439_fiber_mode_get (on page 112) −gets the current mode of the fiber interface.

age1439_fiber_rcv_signals_get (on page 111) −displays the current value of PIO1, PIO2,

DIR and NRDY bits from the fiber receiver.

age1439_fiber_setup (on page 112) −sets the parameters associated with the fiber inter-

face.

age1439_fiber_signal_get (on page 115) −returns a value indicating whether or not an

optical signal is detected by the optical fiber interface receiver.

age1439_fiber_transfer_rate (on page 112) −selects the transfer rate for fiber optic data.

age1439_fiber_transfer_rate_get (on page 112) −gets the current selection of transfer

rate for fiber optic data.

age1439_fiber_verify (on page 116) −proforms a verification of the fiber interface using

either an internal of external signal path.

age1439_fiber_xmt_BOF (on page 117) −sends a BOF event used for synchronization

with other fiber interfaces before data acquisition begins.

age1439_fiber_xmt_signals (on page 118) −sets the transmitted values of any PIO1,

PIO2, DIR or, NRDY FPDP control signals on the fiber transmitter

age1439_fiber_xmt_signals_get (on page 118) −displays the current value of PIO1,

PIO2, DIR and NRDY bits from the fiber transmitter.

age1439_epoch_generate (on page 98) −controls whether or not data epochs are gener-

ated.

age1439_epoch_generate_get (on page 98) −gets the current value of epochGenerate

age1439_epoch_header (on page 98) −sets the value of the first 32 bits of the epoch

header. It can be used by the optical receiver to direct where to route and/or how to

process associated epoch data.

age1439_epoch_header_get (on page 98) −returns the header value and the value of the

increment count for the epoch header.

age1439_epoch_header_enable (on page 98) −controls whether or not epoch headers are

generated

age1439_epoch_header_enable_get (on page 98) −returns the current value of header

enable.

age1439_epoch_setup (on page 98) −sets the parameters relevant to the transmission of

data epochs on the fiber interface.

age1439_epoch_size (on page 98) −sets the size of data epochs in bytes.

age1439_epoch_size_get (on page 98) −returns the current size of data epochs on the fiber

interface

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed by functional group

Identification

age1439_product_id_get (on page 158) −returns the module’s product identification string

age1439_options_get (on page 157) −returns the module’s options

age1439_serial_number (on page 157) −sets the module’s serial number for product repair

purposes

age1439_serial_number_get (on page 157) −returns the module’s serial number

age1439_revision_query (on page 169) −returns strings that identify the date of the module’s

firmware revision

Interrupts

age1439_attrib_get (on page 74) −gets low-level attributes of current I/O library session

age1439_interrupt_setup (on page 146) −sets all interrupt parameters

age1439_interrupt_mask_get (on page 146) −gets the interrupt event mask

age1439_interrupt_priority_get (on page 146) −gets the VME interrupt line

age1439_interrupt_restore (on page 145) −restores the interrupt masks to the most recent set-

ting

Measurement control

age1439_meas_control (on page 151) −initiates and controls measurements in multi-module

systems

age1439_meas_init (on page 154) −initiates a measurement without first checking for valid

hardware setup

age1439_meas_start (on page 155) −checks for valid hardware setup and then initiates a mea-

surement

age1439_reset (on page 167) −places the module in a known state

age1439_reset_hard (on page 168) −resets the module hardware

Timing

age1439_clock_setup (on page 78) −sets all timing parameters for commonly used measure-

ment setups

age1439_clock_setup_get (on page 78) −gets the current clock setup

age1439_clock_fs (on page 76) −provides the frequency of an external sample clock

age1439_clock_fs_get (on page 76) −gets the current external sample clock frequency

age1439_adc_clock (on page 72) −specifies the ADC clock source

age1439_adc_clock_get (on page 72) −gets the ADC clock source

age1439_adc_divider (on page 73) −determines which divider is applied to the ADC clock

source

age1439_adc_divider_get (on page 73)−gets the module's current clock divider state

age1439_ext_sample_sync (on page 104) −enables and disables external sample sync

age1439_ext_sample_sync_get (on page 104) −gets the state of external sample sync

age1439_front_panel_clock_input (on page 131) −specifies the source for the front panel

clock

age1439_front_panel_clock_input_get (on page 131) −gets the front panel clock source

age1439_reference_clock (on page 165) −selects the source of the reference clock

age1439_reference_clock_get (on page 165) −gets the source of the reference clock

age1439_reference_prescaler (on page 166) −selects prescaling of the reference clock

age1439_reference_prescaler_get (on page 166) −gets prescaling of the reference clock

age1439_smb_clock_output (on page 173) −specifies which clock to output from the SMB

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed by functional group

clock connectors

age1439_smb_clock_output_get (on page 173) −gets which clock to output from the SMB

clock connectors

age1439_sync_clock (on page 178) −selects the source of the sync signal

age1439_sync_clock_get (on page 178) −gets the source of the sync signal

age1439_sync_direction (on page 179) −selects front or rear panel availability of the sync sig-

nal

age1439_sync_direction_get (on page 179) −gets the state of front or rear panel clock avail-

ability

age1439_sync_output (on page 180) −selects the output for the sync signal

age1439_sync_output_get (on page 180) −gets the output for the sync signal

age1439_vcxo (on page 187) −selects whether the module should use an internal clock source

age1439_vcxo_get (on page 187) −gets whether the internal clock source is on or off

age1439_vxi_clock_output (on page 188) −selects which clock drives the VXI clock

age1439_vxi_clock_output_get (on page 188) −gets which clock drives the VXI clock

Trigger

age1439_trigger_setup (on page 183) −sets all parameters associated with triggering the

beginning of data collection

age1439_trigger_adclevel (on page 183) −specifies the threshold for the ADC trigger

age1439_trigger_adclevel_get (on page 183) −gets the trigger threshold

age1439_trigger_delay (on page 183) −specifies a pre- or post-trigger delay time

age1439_trigger_delay_get (on page 183) −gets the trigger delay time

age1439_trigger_delay_actual_get (on page 181) −gets the actual delay time from the most

recent trigger event

age1439_trigger_gen (on page 183) −determines whether a module can generate a trigger

age1439_trigger_gen_get (on page 183) −gets the trigger generation status

age1439_trigger_magdwell (on page 183) −specifies the dwell time (in samples) before a

magnitude trigger.

age1439_trigger_magdwell_get (on page 183) −gets the magnitude trigger dwell time.

age1439_trigger_maglevel (on page 183) −specifies the threshold for a magnitude trigger

age1439_trigger_maglevel_get (on page 183) −gets magnitude trigger threshold

age1439_trigger_phase_actual_get (on page 182) −returns a representation of the phase

value of the LO at the most recent trigger point

age1439_trigger_slope (on page 183) −selects a positive or negative trigger

age1439_trigger_slope_get (on page 183) −gets trigger slope

age1439_trigger_type (on page 183) −specifies the trigger type

age1439_trigger_type_get (on page 183) −gets trigger type

Reading data

age1439_data_scale_get (on page 89) −gets data scale factor

age1439_read (on page 159) −reads scaled 32-bit float data from FIFO

age1439_read64 (on page 159) −reads scaled 64-bit float data from FIFO, specifically for

VEE applications

age1439_read_raw (on page 162) −reads raw data from FIFO

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed by functional group

Synchronization (controlling multiple modules)

age1439_clock_setup (on page 78) −supplies commonly used clock and sync configurations

See “Timing” on page 64 for low level clock and sync setup commands

age1439_clock_setup_get (on page 78) −gets the current clock and sync setup

age1439_clock_fs (on page 76) −provides a clock frequency for external sample clock config-

urations

age1439_clock_fs_get (on page 76) −gets the external clock frequency

age1439_filter_sync (on page 123) −synchronizes the decimation filter counter

age1439_frequency_sync and age1439_frequency_center (on page 128) −prepare the mod-

ules for frequency change

age1439_meas_control (on page 151) −synchronizes arming and triggering in multi-module

systems

age1439_trigger_gen (on page 183) −determines whether a module can generate a trigger

age1439_trigger_gen_get (on page 183) −gets the trigger generation status

age1439_wait (on page 189) −facilitates the synchronization and control of multi-module sys-

tems

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_adc_clock (on page 72) −determines the ADC clock source

age1439_adc_clock_get (on page 72) −gets the ADC clock source

age1439_adc_divider (on page 73) −determines which divider is applied to the ADC

clock source

age1439_adc_divider_get (on page 73)−gets the module's current clock divider state

age1439_attrib_get (on page 74) −gets low-level attributes of current I/O library session.

age1439_cal_get (on page 75) −gets last calibration date of specified board

age1439_clock_fs (on page 76) −provides the module with the frequency of an external

sample clock

age1439_clock_fs_get (on page 76) −gets the current external sample clock frequency

age1439_clock_recover (on page 77) −allows recovery from an out-of-spec external sam-

ple clock

age1439_clock_setup (on page 78) −sets all timing parameters for commonly used mea-

surement setups

age1439_clock_setup_get (on page 78) −gets the current clock setup

age1439_close (on page 86) −closes the module's software connection

age1439_combo_setup (on page 87) −a quick way to set blocksize, center frequency, and

signal bandwidth with one function

age1439_data_blocksize (on page 90) −determines the size of the output data block

age1439_data_blocksize_get (on page 90) −gets the output data block size

age1439_data_delay (on page 90) −determines FIFO delay in continuous mode

age1439_data_delay_get (on page 90) −gets FIFO delay in continuous mode

age1439_data_memsize_get (on page 88) −returns module's memory size in megabytes

age1439_data_mode (on page 90) −selects block mode or continuous mode

age1439_data_mode_get (on page 90) −gets the data mode

age1439_data_port (on page 90) −selects VME bus, local bus or fiber interface for

output port transmission

age1439_data_port_get (on page 90) −gets the output port designation

age1439_data_resolution (on page 90) −selects 12 or 24 bits data resolution

age1439_data_resolution_get (on page 90) −gets the data resolution

age1439_data_scale_get (on page 89) −gets data scale factor used to convert raw data to

volts

age1439_data_setup (on page 90) −sets all format and data output flow parameters

age1439_data_spectral_order (on page 90) −specifies the spectral order of the output

data.

age1439_data_spectral_order_get (on page 90) −gets the spectral order of the output

data.

age1439_data_type (on page 90) −selects real or complex output data

age1439_data_type_get (on page 90) −gets output data type

age1439_data_xfersize (on page 96) −allows a specified amount of data to be read before

an entire block has been acquired

age1439_data_xfersize_get (on page 96) −gets the data transfer size

age1439_driver_debug_level (on page 97) −sets the debug level

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_driver_debug_level_get (on page 97) −gets the debug level

age1439_epoch_generate (on page 98) −controls whether or not data epochs are gener-

ated.

age1439_epoch_generate_get (on page 98) −gets the current value of epochGenerate

age1439_epoch_header (on page 98) −sets the value of the first 32 bits of the epoch

header. It can be used by the optical receiver to direct where to route and/or how to

process associated epoch data.

age1439_epoch_header_get (on page 98) −returns the header value and the value of the

increment count for the epoch header.

age1439_epoch_header_enable (on page 98) −controls whether or not epoch headers are

generated

age1439_epoch_header_enable_get (on page 98) −returns the current value of header

enable.

age1439_epoch_setup (on page 98) −sets the parameters relevant to the transmission of

data epochs on the fiber interface.

age1439_epoch_size (on page 98) −sets the size of data epochs in bytes.

age1439_epoch_size_get (on page 98) −returns the current size of data epochs.

age1439_error_message (on page 102) −returns error information obtained from function

calls.

age1439_error_query (on page 103) −queries the module for the most recent error.

age1439_ext_sample_sync (on page 104) −enables and disables sync to an external sam-

ple clock

age1439_ext_sample_sync_get (on page 104) −gets the state of external sample sync

age1439_fiber_BOF (on page 112) −controls whether or not automatically generated

BOF events are transmitted

age1439_fiber_BOF_get (on page 112) −returns the current value of bofEnable

age1439_fiber_clear (on page 106) −clears all data from the fiber interface FIFO buffers

age1439_fiber_crc (on page 112) sets up the fiber interface to transmit and receive cyclic

redundancy checks.

age1439_fiber_crc_get (on page 112) −returns the current status of the cyclic redundancy

check setting.

age1439_fiber_error_clear (on page 107) −clears fiber errors from the status register

age1439_fiber_error_get (on page 108) −returns the value of the fiber interface error reg-

ister.

age1439_fiber_flow_control (on page 112) −configures fiber flow control, enabling or

disabling transmitter flow control signals.

age1439_fiber_LED_get (on page 110) −returns a data register indicating the state of the

front panel XMT/RCV led’s.

age1439_fiber_mode (on page 112) −selects the fiber interface mode.

age1439_fiber_mode_get (on page 112) −gets the current mode of the fiber interface.

age1439_fiber_rcv_signal_get (on page 111) −displays the current value of PIO1, PIO2,

DIR and NRDY bits on the fiber receiver.

age1439_fiber_signal_get (on page 115) −returns a value indicating whether or not an

optical signal is detected by the optical fiber interface receiver.

age1439_fiber_setup (on page 112) −sets the parameters associated with the fiber inter-

face.

age1439_fiber_transfer_rate (on page 112) −selects the transfer rate for fiber optic data.

age1439_fiber_transfer_rate_get (on page 112) −gets the current selection of transfer

rate for fiber optic data.

age1439_fiber_verify (on page 116) −preforms a verification of the fiber interface using

either an internal of external signal path.

age1439_fiber_xmt_BOF (on page 117) −sends a BOF event used for synchronization

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

with other fiber interfaces before data acquisition begins.

age1439_fiber_xmt_signals (on page 118) −sets the transmitted values of any PIO1,

PIO2, DIR or, NRDY FPDP control signals on the fiber transmitter.

age1439_fiber_xmt_signals_get (on page 118) −displays the current value of PIO1,

PIO2, DIR and NRDY bits on the fiber transmitter.

age1439_filter_bw (on page 120) −selects a signal filter bandwidth

age1439_filter_bw_get (on page 120) −gets the signal filter bandwidth

age1439_filter_decimate (on page 120) −enables/disables and extra factor of 2 decima-

tion

age1439_filter_decimate_get (on page 120) −gets current state of extra decimation

age1439_filter_setup (on page 120) −sets the digital filter bandwidth and decimation fil-

ter parameters

age1439_filter_sync (on page 123) −synchronizes the decimation filter counter

age1439_frequency_center (on page 128) −sets the center frequency

age1439_frequency_center_get (on page 128) −gets the current center frequency

age1439_frequency_center_raw (on page 125) −quickly sets the center frequency

age1439_frequency_center_raw_compute (on page 127) −quickly calculates the values

for age1439_frequency_center_raw

age1439_frequency_center_raw_get (on page 125) −gets the raw center frequency

age1439_frequency_cmplxdc (on page 128) −selects a complex baseband measurement

age1439_frequency_cmplxdc_get (on page 128) −gets the state of the baseband measure-

ment mode

age1439_frequency_setup (on page 128) −sets all the zoom center frequency parameters

age1439_frequency_sync (on page 128) −prepares the module for a synchronous fre-

quency change

age1439_frequency_sync_get (on page 128) −gets the state of the synchronous change

mode

age1439_front_panel_clock_input (on page 131) −specifies the source of the front panel

clock

age1439_front_panel_clock_input_get (on page 131) −gets the front panel clock source

age1439_init (on page 132) −initializes the I/O driver for a module

age1439_input_alias_filter (on page 141) −include/bypass the built-in analog anti-alias

filter

age1439_input_alias_filter_get (on page 141) −gets the anti-alias filter state

age1439_input_autozero (on page 134) −nulls out the input dc offset in baseband mode

age1439_input_coupling (on page 141) −selects ac or dc input coupling

age1439_input_coupling_get (on page 141) −get the input coupling type

age1439_input_offset (on page 135) −sets the dc offset settings for the current range

age1439_input_offset_get (on page 135) −gets the dc offset settings

age1439_input_offset_save (on page 136) −saves the dc offset settings in NVRAM

age1439_input_range (on page 141) −sets the full scale range

age1439_input_range_auto (on page 137) −performs auto-ranging in baseband mode

age1439_input_range_convert (on page 138) −converts the input range to volts

age1439_input_range_get (on page 141) −gets the input range

age1439_input_setup (on page 141) −sets all the analog input parameters

age1439_input_signal (on page 141) −connect/disconnect the input signal to the input

amplifiers

age1439_input_signal_get (on page 141) −gets the input buffer amplifier state

age1439_input_signal_path (on page 141) −selects baseband or IF signal path

age1439_input_signal_path_get (on page 141) −gets the signal path state

age1439_interrupt_mask_get (on page 146) −gets the interrupt event mask

age1439_interrupt_priority_get (on page 146) −gets the VME interrupt line

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_interrupt_restore (on page 145) −restores the interrupt masks to the most recent

setting

age1439_interrupt_setup (on page 146) −sets both interrupt parameters

age1439_lbus_mode (on page 148) −sets the local bus transmission mode

age1439_lbus_mode_get (on page 148) −gets the local bus mode

age1439_lbus_reset (on page 150) −resets local bus

age1439_lbus_reset_get (on page 150) −gets the local bus mode reset state

age1439_meas_control (on page 151) −initiates and controls measurements in multi-

module systems

age1439_meas_init (on page 154) −initiates a measurement without first checking for

valid hardware setup

age1439_meas_start (on page 155) −checks for valid hardware setup and then initiates a

measurement

age1439_meas_status_get (on page 156) −returns the current measurement status.

age1439_options_get (on page 157) −returns the module’s options

age1439_product_id_get (on page 158) −returns the module’s product identification

string

age1439_read (on page 159) −reads scaled 32-bit float data from FIFO

age1439_read_raw (on page 162) −reads raw data from FIFO

age1439_read64 (on page 159) −reads scaled 64-bit float data from FIFO, specifically for

VEE applications

age1439_reference_clock (on page 165) −selects the source of the reference clock

age1439_reference_clock_get (on page 165) −gets the source of the reference clock

age1439_reference_prescaler (on page 166) −selects prescaling of the reference clock

age1439_reference_prescaler_get (on page 166) −gets prescaling of the reference clock

age1439_reset (on page 167) −places the module in a known state

age1439_reset_hard (on page 168) −resets the module hardware

age1439_revision_query (on page 169) −returns strings that identify the date of the firm-

ware revision.

age1439_self_test (on page 170) −performs a self-test on the module and returns the result

age1439_serial_number (on page 157) −sets the module’s serial number for product

repair purposes

age1439_serial_number_get (on page 157) −returns the module’s serial number

age1439_smb_clock_output (on page 173) −specifies which clock to output from the

SMB clock connectors

age1439_smb_clock_output_get (on page 173) −gets which clock to output from the

SMB clock connectors

age1439_state_save (on page 175) −saves the current module state

age1439_state_recall (on page 174) −recalls a saved module state

age1439_status_get (on page 176) −retrieves module's status register information

age1439_sync_clock (on page 178) −selects the source of the sync signal

age1439_sync_clock_get (on page 178) −gets the source of the sync signal

age1439_sync_direction (on page 179) −selects front or rear panel availability of the sync

signal

age1439_sync_direction_get (on page 179) −gets the state of front or rear panel clock

availability

age1439_sync_output (on page 180) −selects the output for the sync signal

age1439_sync_output_get (on page 180) −gets the output for the sync signal

age1439_trigger_adclevel (on page 183) −specifies the threshold for the ADC trigger

age1439_trigger_adclevel_get (on page 183) −gets the trigger threshold

age1439_trigger_delay (on page 183) −specifies a pre- or post-trigger delay time

age1439_trigger_delay_actual_get (on page 181) −gets the actual delay time from the

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

most recent trigger event

age1439_trigger_delay_get (on page 183) −gets the trigger delay time

age1439_trigger_gen (on page 183) −determines whether a module can generate a trigger

age1439_trigger_gen_get (on page 183) −gets the trigger generation status

age1439_trigger_magdwell (on page 183) −specifies the dwell time (in samples) before a

magnitude trigger

age1439_trigger_magdwell_get (on page 183) −gets the magnitude trigger dwell time in

samples

age1439_trigger_maglevel (on page 183) −specifies the threshold for a magnitude trigger

age1439_trigger_maglevel_get (on page 183) −gets magnitude trigger threshold

age1439_trigger_phase_actual_get (on page 182) −returns a representation of the phase

value of the LO at the most recent trigger point

age1439_trigger_setup (on page 183) −sets all parameters associated with triggering the

beginning of data collection

age1439_trigger_slope (on page 183) −selects a positive or negative trigger

age1439_trigger_slope_get (on page 183) −gets trigger slope

age1439_trigger_type (on page 183) −determines the trigger type

age1439_trigger_type_get (on page 183) −gets trigger type

age1439_vcxo (on page 187) −selects whether the module should use an internal clock

source

age1439_vcxo_get (on page 187) −gets whether the internal clock source is on or off

age1439_vxi_clock_output (on page 188) −selects which clock drives the VXI clock

age1439_vxi_clock_output_get (on page 188) −gets which clock drives the VXI clock

age1439_wait (on page 189) −facilitates the synchronization and control of multi-module

systems

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_adc_clock

Specifies the ADC clock source. This description also includes the query function:

age1439_adc_clock_get

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_adc_clock(ViSession id, ViInt16 adcClock);

ViStatus age1439_adc_clock_get(ViSession id, ViPInt16 adcClockPtr);

Note

This command should be used only for specialized custom clock requirements. Most useful clock

setups can be supplied by age1439_clock_setup.

Parameters

is the VXI instrument session pointer returned by the age1439_init function.

adcClock

AGE1439_VCXO_INTERNAL selects an internal oscillator within the module. age1439_vcxo_

freq determines which oscillator is used. age1439_vcxo determines whether the internal

oscillator is turned on. You must use all three of the functions to provide the desired internal clock

source.

AGE1439_VCXO_EXT_REF takes an external reference signal on the front panel and uses a

phase-locked loop to convert it to the ADC clock of the module. The ADC clock can be either 100

MHz or 102.4 MHz. The external reference used by the phase lock loop to synthesize the ADC

clock can be either a 10 MHz or 10.24 MHz signal.

AGE1439_EXT_SAMPLE_CLOCK uses an external sample clock selected by age1439_

reference_clock.

adcClockPtr

points to the value of the current adcClock.

Return Value

AGE1439_SUCCESS indicates that a function was successful.

Values other than AGE1439_SUCCESS indicate an error condition or other important status

condition. To determine the error message, pass the return value to “age1439_error_message” on

page 102.

“age1439_init” on page 132, “age1439_clock_setup” on page 78, “age1439_vcxo” on page 187,

“age1439_front_panel_clock_input” on page 131, “age1439_reference_clock” on page 165,

“Using clock and sync” in chapter 3

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_adc_divider

Determines which divider is applied to the ADC clock source. This description also includes the

query function:

age1439_adc_divider_get

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_adc_divider(ViSession id, ViInt16 adcDivider);

ViStatus age1439_adc_divider_get(ViSession id, ViPInt16 adcDividerPtr);

Note

This command should be used only for specialized custom clock requirements. Most useful clock

setups can be supplied by age1439_clock_setup.

Description

This function should generally be left in the default mode. The alternate mode applies to a

different model of the module.

Parameters

is the VXI instrument session pointer returned by the age1439_init function.

adcDivider

AGE1439_DIVIDE_BY_10 divides the ADC clock by 10.

AGE1439_DIVIDE_BY_38 divides the ADC clock by 38.

adcDividerPtr

points to the current value of adcDivider.

Return Value

AGE1439_SUCCESS indicates that a function was successful.

Values other than AGE1439_SUCCESS indicate an error condition or other important status

condition. To determine the error message, pass the return value to “age1439_error_message” on

page 102.

Comments

The Agilent E1439 normally runs its sample clock at 95 MHz. It divides that clock by 38 to

generate 2.5 MHz, which can be compared against a user-supplied 10Mhz reference that we

internally divide by 4 (age1439_reference_prescaler) which also generates a 2.5 MHz clock. In

the case of a multi module system without an external reference clock, the master module sends

its 2.5 MHz clock out on the VXI bus or front panel smbs for use by the other module's PLLs.

“Using clock and sync” in chapter 3

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_attrib_get

Gets low-level attributes of current I/O library session.

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_attrib_get(ViSession id, ViInt16 attribute, ViPint32 value);

Description

age1439_attrib_get is used primarily to manage the use of interrupts which requires making

direct VISA function calls. Since interrupts are a shared resource across all modules using the

VXI interface, it is not possible for the Agilent E1439 library, which governs single modules, to

provide the functions to properly manage interrupts.

This function is used to access either the I/O library handle or the mapped I/O base address of the

module. You should refer to the appropriate VISA documentation for descriptions of the I/O

library functions.

Parameters

is the VXI instrument session pointer returned by the age1439_init function.

attribute

designates the type of attribute to return.

AGE1439_IO_HANDLE accesses the I/O library handle.

AGE1439_IO_ADDRESS points to the mapped I/O base address of the module.

AGE1439_RM_HANDLE accesses the I/O library handle of the default resource manager.

AGE1439_D A T A _REGISTER points to the mapped address of the Agilent E1439 data register.

One or both of these parameters are used when calling I/O library functions directly.

value

is the value of the requested attribute. For the VISA I/O library the value of the handle attribute

corresponds to the vi parameter used by the majority of the I/O functions. The address attribute

points to the base of the mapped I/O address space.

Example

See the interrupt.c example program.

Return Value

AGE1439_SUCCESS indicates that a function was successful.

Values other than AGE1439_SUCCESS indicate an error condition or other important status

condition. To determine the error message, pass the return value to “age1439_error_message” on

page 102.

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_cal_get

Gets last calibration date of specified board.

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_cal_get(ViSession id, ViInt16 board, ViPInt32 datestampPtr);

Description

age1439_cal_get is used to read the date stamp of the last calibration.

Parameters

is the VXI instrument session pointer returned by the age1439_init function.

board

AGE1439_01_BOARD returns calibration information for the 01 (digital/ADC) board.

AGE1439_03_BOARD returns calibration information for the 03 (input) board.

datestampPtr

points to the return location for the timestamp of the most recent saved calibrations. Format is

YYYYMMDDin base 10 notation.

Return Value

AGE1439_SUCCESS indicates that a function was successful.

Values other than AGE1439_SUCCESS indicate an error condition or other important status

condition. To determine the error message, pass the return value to “age1439_error_message” on

page 102.

See Also

“age1439_front_panel_clock_input” on page 131, “age1439_ext_sample_sync” on page 104,

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_clock_fs

Provides the module with the frequency of an external sample clock. This description also

includes the query:

age1439_clock_fs_get

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_clock_fs(ViSession id, ViReal64 fs);

ViStatus age1439_clock_fs_get(ViSession id, ViPReal64 fsPtr);

Description

This command is applicable only when an external sample clock is used. It is an order-dependent

command and must be set after selecting the external sample clock.

When using an external sample clock or when a module is a non-master in a multi-module group,

the frequency of the ADC clock is unknown by the module. It is the responsibility of the

programmer to provide the correct frequency so that library functions dependent on fs operate

properly. This value has no effect if the module is not set up to use the external sample clock.

Parameters

is the VXI instrument session pointer returned by the age1439_init function.

provides the module with the frequency of an external sample clock (from 10,000,000 to

103,000,000) connected to the Ext Clk TTL connector.

AGE1439_FS_MIN supplies the minimum external sample clock frequency.

AGE1439_FS_MAX supplies the maximum external sample clock frequency.

fsPtr

points to the current value of the external sample clock frequency. If the Agilent E1439 is set to

the internal ADC clock, this query returns the value of that clock frequency. If the Agilent E1439

is set to the external clock, this query returns the last value entered via the age1439_clock_fs

function.

Return Value

AGE1439_SUCCESS indicates that a function was successful.

Values other than AGE1439_SUCCESS indicate an error condition or other important status

condition. To determine the error message, pass the return value to “age1439_error_message” on

page 102.

“Using clock and sync” in chapter 3

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_clock_recover

Allows recovery from an out-of-spec external sample clock.

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_clock_recover(ViSession id);

Description

This command is used to restore proper function if the module has received an out-of spec

external sample clock. An out-of-spec situation could occur if the external sample clock is

removed or changed during operation, or if it has glitches which don’t meet specs. In this case the

module would cease functioning and this command must be issued in order to resume proper

operation after restoring a valid clock.

Parameters

Return Value

AGE1439_SUCCESS indicates that a function was successful.

Values other than AGE1439_SUCCESS indicate an error condition or other important status

condition. To determine the error message, pass the return value to “age1439_error_message” on

page 102.

“age1439_ext_sample_sync” on page 104, “age1439_clock_setup” on page 78

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_clock_setup

Sets all timing parameters for commonly used measurement setups. This description also includes

a query:

age1439_clock_setup_get

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_clock_setup(ViSession id, ViInt16 clockSetup);

ViStatus age1439_clock_setup_get(ViSession id, ViPInt16 clockSetupPtr);

Description

age1439_clock_setup is used to select the source and distribution of clocking and

synchronization signals used by the Agilent E1439 module. The primary clock signal used by the

module is the ADC clock, for which the rising edges indicate the time for each sample of the

analog-to-digital converter.

This function changes the settings controlled by the following lower-level functions:

age1439_adc_clock

age1439_adc_divider

age1439_front_panel_clock_input

age1439_reference_clock

age1439_reference_prescaler

age1439_smb_clock_output

age1439_sync_clock

age1439_sync_direction

age1439_sync_output

age1439_vcxo

Note

Setups using the external sample clock require that you use age1439_clock_fs to supply the clock

frequency.

Parameters

is the VXI instrument session pointer returned by the age1439_init function.

clockSetup

This parameter provides a quick way to set up most of the timing parameters for several standard

clock configurations. The following setups are available:

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

Simple clock setups for stand-alone modules

Internal reference

AGE1439_SIMPLE_INT_REF

ADC_CLK

VCXO_INTERNAL

VCXO_ON

VCXO

ADC_DIVIDER

DIVIDE_BY_38

PRESCALE_BY_1

CLOCK_OFF

N/A

REFERENCE_PRESCALER

VXI_CLK_OUTPUT

REFERENCE_CLOCK

FRONT_PANEL_CLOCK

SMB_CLOCK_OUTPUT

SYNC_CLOCK

CLOCK_OFF

DIVIDED_ADC_CLOCK

SYNC_OUT_OFF

N/A

SYNC_OUTPUT

SYNC_DIRECTION

Phase locked to external reference

AGE1439_SIMPLE_EXT_REF

ADC_CLK

VCXO_EXT_REF

VCXO_ON

VCXO

ADC_DIVIDER

DIVIDE_BY_38

PRESCALE_BY_4

CLOCK_OFF

REFERENCE_PRESCALER

VXI_CLK_OUTPUT

REFERENCE_CLOCK

FRONT_PANEL_CLOCK

SMB_CLOCK_OUTPUT

SYNC_CLOCK

FRONT_PANEL_CLOCK

BNC_CLOCK

CLOCK_OFF

DIVIDED_ADC_CLOCK

SYNC_OUT_OFF

N/A

SYNC_OUTPUT

SYNC_DIRECTION

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

External sample clock (for use with baseband path only)

AGE1439_SIMPLE_EXT_SAMP

ADC_CLK

VCXO

EXT_SAMPLE_CLOCK

VCXO_OFF

ADC_DIVIDER

DIVIDE_BY_38

REFERENCE_PRESCALER

VXI_CLK_OUTPUT

REFERENCE_CLOCK

FRONT_PANEL_CLOCK

SMB_CLOCK_OUTPUT

SYNC_CLOCK

PRESCALE_BY_1

CLOCK_OFF

FRONT_PANEL_CLOCK

BNC_CLOCK

CLOCK_OFF

DIVIDED_ADC_CLOCK

SYNC_OUT_OFF

N/A

SYNC_OUTPUT

SYNC_DIRECTION

Front panel master-slave setups, one master per mainframe

Front master, internal reference

AGE1439_FRNT_MSTR_INT_REF

ADC_CLK

VCXO_INTERNAL

VCXO_ON

VCXO

ADC_DIVIDER

DIVIDE_BY_38

PRESCALE_BY_1

CLOCK_OFF

REFERENCE_PRESCALER

VXI_CLK_OUTPUT

REFERENCE_CLOCK

FRONT_PANEL_CLOCK

SMB_CLOCK_OUTPUT

SYNC_CLOCK

N/A

CLOCK_OFF

DIVIDED_ADC_CLOCK

SYNC_OUT_SMB

FRNT_TO_REAR

SYNC_OUTPUT

SYNC_DIRECTION

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

Front master, phase locked to external reference

AGE1439_FRNT_REAR_MSTR_EXT_REF

ADC_CLK

VCXO

VCXO_EXT_REF

VCXO_ON

ADC_DIVIDER

DIVIDE_BY_38

REFERENCE_PRESCALER

VXI_CLK_OUTPUT

REFERENCE_CLOCK

FRONT_PANEL_CLOCK

SMB_CLOCK_OUTPUT

SYNC_CLOCK

PRESCALE_BY_4

CLOCK_OFF

FRONT_PANEL_CLOCK

BNC_CLOCK

DIVIDED_ADC_CLOCK

SYNC_OUT_SMB

FRNT_TO_REAR

SYNC_OUTPUT

SYNC_DIRECTION

Front slave, phase locked to master

AGE1439_FRNT_REAR_SLAV_EXT_REF

ADC_CLK

VCXO_EXT_REF

VCXO_ON

VCXO

ADC_DIVIDER

DIVIDE_BY_38

PRESCALE_BY_1

CLOCK_OFF

REFERENCE_PRESCALER

VXI_CLK_OUTPUT

REFERENCE_CLOCK

FRONT_PANEL_CLOCK

SMB_CLOCK_OUTPUT

SYNC_CLOCK

FRONT_PANEL_CLOCK

SMB_CLK

CLOCK_OFF

SMB_CLOCK

SYNC_OUTPUT

SYNC_DIRECTION

SYNC_OUT_SMB

FRNT_TO_REAR

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

Rear panel master-slave setups, one master per mainframe

Rear master, internal reference

AGE1439_REAR_MSTR_INT_REF

ADC_CLK

VCXO_INTERNAL

VCXO_ON

VCXO

ADC_DIVIDER

DIVIDE_BY_38

PRESCALE_BY_1

DIVIDED_ADC_CLOCK

N/A

REFERENCE_PRESCALER

VXI_CLK_OUTPUT

REFERENCE_CLOCK

FRONT_PANEL_CLOCK

SMB_CLOCK_OUTPUT

SYNC_CLOCK

CLOCK_OFF

DIVIDED_ADC_CLOCK

SYNC_OUT_VXI

REAR_TO_FRNT

SYNC_OUTPUT

SYNC_DIRECTION

Rear master, phase locked to external reference

AGE1439_REAR_MSTR_EXT_REF

ADC_CLK

VCXO_EXT_REF

VCXO_ON

VCXO

ADC_DIVIDER

DIVIDE_BY_38

REFERENCE_PRESCALER

VXI_CLK_OUTPUT

REFERENCE_CLOCK

FRONT_PANEL_CLOCK

SMB_CLOCK_OUTPUT

SYNC_CLOCK

PRESCALE_BY_4

DIVIDED_ADC_CLOCK

FRONT_PANEL_CLOCK

BNC_CLOCK

CLOCK_OFF

DIVIDED_ADC_CLOCK

SYNC_OUT_VXI

REAR_TO_FRNT

SYNC_OUTPUT

SYNC_DIRECTION

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

Rear slave, phase locked to master

AGE1439_REAR_SLAV_EXT_REF

VCXO_EXT_REF

ADC_CLK

VCXO

VCXO_ON

ADC_DIVIDER

DIVIDE_BY_38

PRESCALE_BY_1

CLOCK_OFF

REFERENCE_PRESCALER

VXI_CLK_OUTPUT

REFERENCE_CLOCK

FRONT_PANEL_CLOCK

SMB_CLOCK_OUTPUT

SYNC_CLOCK

VXI_CLOCK

CLOCK_OFF

VXI_CLOCK

SYNC_OUTPUT

SYNC_DIRECTION

SYNC_OUT_VXI

REAR_TO_FRNT

Multi-module external sample setups, set all modules the same

Front sync, external sample clock, wired-OR sync

AGE1439_FRNT_SYNC_EXT_SAMP

ADC_CLK

EXT_SAMPLE_CLOCK

VCXO_OFF

VCXO

ADC_DIVIDER

DIVIDE_BY_38

REFERENCE_PRESCALER

VXI_CLK_OUTPUT

REFERENCE_CLOCK

FRONT_PANEL_CLOCK

SMB_CLOCK_OUTPUT

SYNC_CLOCK

PRESCALE_BY_1

CLOCK_OFF

FRONT_PANEL_CLOCK

BNC_CLOCK

CLOCK_OFF

DIVIDED_ADC_CLOCK

SYNC_OUT_SMB

FRNT_TO_REAR

SYNC_OUTPUT

SYNC_DIRECTION

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

Rear sync, external sample clock, wired-OR sync

AGE1439_REAR_SYNC_EXT_SAMP

ADC_CLK

VCXO

EXT_SAMPLE_CLOCK

VCXO_OFF

ADC_DIVIDER

DIVIDE_BY_38

REFERENCE_PRESCALER

VXI_CLK_OUTPUT

REFERENCE_CLOCK

FRONT_PANEL_CLOCK

SMB_CLOCK_OUTPUT

SYNC_CLOCK

PRESCALE_BY_1

CLOCK_OFF

FRONT_PANEL_CLOCK

BNC_CLOCK

CLOCK_OFF

DIVIDED_ADC_CLOCK

SYNC_OUT_VXI

REAR_TO_FRNT

SYNC_OUTPUT

SYNC_DIRECTION

Multiple mainframe setups

Send sync to slave

AGE1439_FRNT_MSTR_INT_REF

ADC_CLK

VCXO

VCXO_INTERNAL

VCXO_ON

ADC_DIVIDER

DIVIDE_BY_38

PRESCALE_BY_1

DIVIDED_ADC_CLOCK

N/A

REFERENCE_PRESCALER

VXI_CLK_OUTPUT

REFERENCE_CLOCK

FRONT_PANEL_CLOCK

SMB_CLOCK_OUTPUT

SYNC_CLOCK

CLOCK_OFF

DIVIDED_ADC_CLOCK

VXI_CLOCK

SYNC_OUTPUT

SYNC_OUT_BOTH

REAR_TO_FRONT

SYNC_DIRECTION

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

Receive sync from master

AGE1439_FRNT_REAR_SLAV_EXT_REF

ADC_CLK

VCXO_EXT_REF

VCXO

VCXO_ON

ADC_DIVIDER

DIVIDE_BY_38

PRESCALE_BY_1

FRONT_PANEL_CLOCK

SMB_CLOCK

REFERENCE_PRESCALER

VXI_CLK_OUTPUT

REFERENCE_CLOCK

FRONT_PANEL_CLOCK

SMB_CLOCK_OUTPUT

SYNC_CLOCK

CLOCK_OFF

SMB_CLOCK

SYNC_OUTPUT

SYNC_DIRECTION

SYNC_OUT_BOTH

FRONT_TO_REAR

clockSetupPtr

points to the current value of clockSetup.

AGE1439_CUSTOM_CLOCK_SETUP is returned from age1439_clock_setup_get when low-

level clock configuration functions are used to set up clocks to a non-standard configuration.

Example

The program multichan.exe example program provides an example of how to correctly set up a

multi-module system with synchronous clocks.

Return Value

AGE1439_SUCCESS indicates that a function was successful.

Values other than AGE1439_SUCCESS indicate an error condition or other important status

condition. To determine the error message, pass the return value to “age1439_error_message” on

page 102.

Effect on Active Measurement

age1439_clock_setup aborts any measurement in progress.

“age1439_init” on page 132, “age1439_clock_fs” on page 76, “age1439_clock_recover” on

page 77, “age1439_ext_sample_sync” on page 104, “Using clock and sync” in chapter 3,

“Managing multiple modules” in chapter 3

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_close

Closes the module's software connection.

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_close(ViSession id);

Description

age1439_close terminates the software connection to the module, deallocates system resources,

and places the module in the Idle state. After this function has been executed the specified id

identifier is no longer a valid parameter for function calls.

Parameters

is the VXI instrument session pointer returned by the age1439_init function.

Return Value

AGE1439_SUCCESS indicates that a function was successful.

Values other than AGE1439_SUCCESS indicate an error condition or other important status

condition. To determine the error message, pass the return value to “age1439_error_message” on

page 102.

See Also

“age1439_filter_setup” on page 120, “age1439_frequency_center_raw” on page 125, “age1439_

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_combo_setup

Combines often used setup commands from various functions.

age1439_combo_setup sets signal bandwidth, blocksize and center frequency.

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_combo_setup(ViSession id, ViInt16 sigBw, ViInt32 blocksize, ViInt32

phase, ViInt32 interpolate);

Description

age1439_combo_setup provides a faster way to set up parameters from several functions which

are often used together.

Parameters

is the VXI instrument session pointer returned by the age1439_init function.

See “age1439_data_setup” on page 90 for a description of the blocksize parameter.

See “age1439_frequency_center_raw” on page 125 for a description of the interpolate parameter.

See “age1439_frequency_center_raw” on page 125 for a description of the phase parameter.

See “age1439_filter_setup” on page 120 for a description of the sigBw parameter.

blocksize

interpolate

phase

sigBw

Comments

This command halts the current measurement which also releases the forced Idle state. If you use

this command in multi-module systems to synchronously change the center frequency while the

modules are forced to Idle, then you should subsquently call age1439_meas_control to re-assert

the forced Idle condition.

Return Value

AGE1439_SUCCESS indicates that a function was successful.

Values other than AGE1439_SUCCESS indicate an error condition or other important status

condition. To determine the error message, pass the return value to “age1439_error_message” on

page 102.

data_setup” on page 90, “age1439_meas_control” on page 151

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_data_memsize_get

Returns the module's memory size in megabytes.

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_data_memsize_get(ViSession id, ViPInt16 memSizePtr);

Description

This command allows you to determine whether your module contains standard memory of 18

Mbytes or a larger memory option.

Parameters

is the VXI instrument session pointer returned by the age1439_init function.

points to the memory size in number of Megabytes.

memSizePtr

Return Value

AGE1439_SUCCESS indicates that a function was successful.

Values other than AGE1439_SUCCESS indicate an error condition or other important status

condition. To determine the error message, pass the return value to “age1439_error_message” on

page 102.

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_data_scale_get

Gets the data scale factor.

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_data_scale_get(ViSession id, ViPReal64 scalePtr);

Description

age1439_data_scale_get calculates the correct scale factor for raw data using the current data

resolution and input range. The factor returned by this function is used to multiply raw data to get

data in volts.

When the module is providing only the real part of complex data, the data is doubled to provide

consistent spectrum measurements. This occurs with either shift decimation or when the real part

of a zoomed signal with a non-zero center frequency is taken.

Parameters

is the VXI instrument session pointer returned by the age1439_init function.

points to the calculated scale factor with which to scale raw data to volts.

scalePtr

Return Value

AGE1439_SUCCESS indicates that a function was successful.

Values other than AGE1439_SUCCESS indicate an error condition or other important status

condition. To determine the error message, pass the return value to “age1439_error_message” on

page 102.

page 162, “age1439_input_range_auto” on page 137, “age1439_filter_setup” on page 120

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_data_setup

Sets all format and data output flow parameters. This description also includes information on the

following functions which set or query the format and flow parameters individually:

age1439_data_blocksize determines the size of the output data block.

age1439_data_blocksize_get gets the output data block size.

age1439_data_delay determines the FIFO delay in continuous mode.

age1439_data_delay_get gets the FIFO delay in continuous mode.

age1439_data_mode selects block mode or continuous mode.

age1439_data_mode_get gets the data mode.

age1439_data_port selects VME bus or local bus output port.

age1439_data_port_get gets the output port designation.

age1439_data_resolution selects 12 or 24 bits data resolution.

age1439_data_resolution_get gets the data resolution.

age1439_data_spectral_order specifies the spectral order of the output data.

age1439_data_spectral_order_get gets the spectral order of the output data.

age1439_data_type selects real or complex output data.

age1439_data_type_get gets output data type.

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_data_setup(ViSession id, ViInt16 dataType, ViInt16 resolution, ViInt16

mode, ViInt32 blocksize, ViInt32 dataDelay, ViInt16 spectralOrder, ViInt16 port);

ViStatus age1439_data_blocksize(ViSession id, ViInt32 blocksize);

ViStatus age1439_data_blocksize_get(ViSession id, ViPint32 blocksizePtr);

ViStatus age1439_data_delay(ViSession id, ViInt32 dataDelay);

ViStatus age1439_data_delay_get(ViSession id, ViPInt32 dataDelayPtr);

ViStatus age1439_data_mode(ViSession id, ViInt16 mode);

ViStatus age1439_data_mode_get(ViSession id, ViPInt16 modePtr);

ViStatus age1439_data_port(ViSession id, ViInt16 port);

ViStatus age1439_data_port_get(ViSession id, ViPInt16 portPtr);

ViStatus age1439_data_resolution(ViSession id, ViInt16 resolution);

ViStatus age1439_data_resolution_get(ViSession id, ViPInt16 resolutionPtr);

ViStatus age1439_data_spectral_order(ViSession id, ViInt16 spectralOrder);

ViStatus age1439_data_spectral_order_get(ViSession id, ViPInt16 spectralOrderPtr);

ViStatus age1439_data_type(ViSession id, ViInt16 dataType);

ViStatus age1439_data_type_get(ViSession id, ViPInt16 dataTypePtr);

Description

Note

The functions, age1439_data_delay, age1439_data_mode, age1439_data_resolution, and

age1439_data_type work the same for the fiber interface as they do for the other interfaces.

Parameters

is the VXI instrument session pointer returned by the age1439_init function.

blocksize

determines the number of sample points in each output data block.

AGE1439_BLOCKSIZE_MIN selects the minimum blocksize.

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

AGE1439_BLOCKSIZE_MAX selects the maximum blocksize.

AGE1439_BLOCKSIZE_DEF sets the default blocksize.

The range of available block sizes depends on the number of bytes required for each sample. The

command accepts any number between 2 and memory size (in bytes) × 2/3. If the requested block

size falls outside the range shown in the table the previous valid value is used and a status register

flag (bit 6) is set indicating a setup error. The blocksize is updated after the setup is changed to be

valid.

For real data blocksize is the number of real data values per data block. For complex data

blocksize is the number of complex data pairs per data block.

The following table summarizes the available block sizes for each setting of the dataType, and

resolution parameters.

max block size

in Msamples

(2 M*72 memory)¹

data type resolution

min. block size

real

complex

1. Parity memory is used in non-parity mode, so 2M× 72

bit memory yields 18 Mbytes of FIFO storage.

Note

Block size must be an even number. Considerably more samples may need to be taken in order to

set the block available status bit.

blocksizePtr

dataDelay

points to the current value of the blocksize parameter. The returned value is the closest valid value

to the requested block size.

is used to specify the minimum FIFO delay in number of samples. This parameter applies only in

continuous mode.

AGE1439_D A T A _DELAY_MAXsets the maximum allowable delay.

AGE1439_D A T A _DELAY_MIN sets the minimum allowable delay.

dataDelayPtr

dataType

points to the current value of the delay parameter.

determines whether the Agilent E1439 collects and returns real or complex data.

Setting this parameter to AGE1439_REAL causes only the real part of the data to be returned for

each sample

AGE1439_COMPLEX causes the real data followed by the imaginary data to be returned in each

sample.

Normally, if the center frequency set with the age1439_frequency_setup function is zero, the

type should be set to AGE1439_REAL since the imaginary component of each sample is zero

anyway. When non-zero center frequencies are used the type should normally be set to

AGE1439_COMPLEX, otherwise the imaginary component of the signal is lost.

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

when dataType is set to AGE1439_REAL and there is a non-zero center frequency the data scale

value is doubled for consistent spectrum measurements

dataTypePtr

mode

points to the current value of the dataType parameter.

selects whether the Agilent E1439's data collection operates in block mode or continuous mode.

AGE1439_BLOCK selects block transfer mode in which the measurement is halted after each

block of data. To start collection of the next data block the module must be armed and triggered

again. This mode is used whenever each block of data is to be associated with an individual

trigger event.

AGE1439_CONTINUOUS means that a single arm and trigger event starts a measurement which

runs continuously with no gaps between output data blocks. The measurement continues as long

as the data is read out fast enough to prevent overflow in the output FIFO. The continuous mode is

useful for continuous signal processing applications where data gaps are unacceptable.

modePtr

port

points to the current value of the mode parameter.

determines which output port is used to take data from the Agilent E1439 module.

Setting port to AGE1439_VME means the data is to be output using standard VME register reads.

This is the instrument default.

Setting port to AGE1439_LBUS means the data is to be output as a byte-serial data stream via the

VXI local bus (Agilent E1439D only) . When using the local bus port the module immediately to

the right of the Agilent E1439 must be capable of receiving the local bus byte sequence.

Setting port to AGE1439_FIBER means the filtered ADC data is to be transmitted as a serial data

stream over the fiber interface.

portPtr

points to the current value of the port parameter.

resolution

selects data resolution of either 12 or 24 bits by using resolution values of AGE1439_12BIT or

AGE1439_24BIT respectively. Choosing 12-bit precision allows for more samples in the FIFO

memory. Choosing 24 bits allows more dynamic range. Because of the broadband white noise

present on the input of the analog-to-digital converter, it is normally sufficient to use 12 bit

resolution whenever the age1439_filter_setup function specifies a signal bandwidth greater than

10 MHz. For narrower bandwidths much of the broadband white noise is filtered out, resulting in

lower noise in the output data. To take advantage of this lower noise, you should use the 24-bit

data resolution.

resolutionPtr

points to the current value of the resolution parameter.

Comments

The following table summarizes the output word or byte sequence for each combination of

dataType, resolution, and port parameters:

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

data

resolution

transfer

width

xfers¹

sequence²

R [11:0] |Z4

data type

port

real

12 bit

VME

16 bit

R [11:0] |Z4 ...

complex

real

VME

16 bit

R [11:0] |Z4

Q [11:0] |Z4

R [11:0] |Z4

Q [11:0] |Z4 ...

24 bit

R [23:8]

R [7:0] |Z8

R [23:8]

R [7:0] |Z8 ...

complex

R [23:8]

R [7:0] |Z8

Q [23:8]

Q [7:0] |Z8

R [23:8]

R [7:0] |Z8 ...

real

12 bit

LBUS

8 bit

R [11:4]

R [3:0] |Z4

R [11:4]

R [3:0] |Z4 ...

complex

R [11:4]

R [3:0] |Z4

Q [11:4]

Q [3:0] |Z4

R [11:4]

R [3:0] |Z4 ...

real

24 bit

LBUS

8 bit

R [23:16]

R [15:8]

R [7:0]

R [23:16]

R [15:8] ...

complex

R [23:16]

R [15:8],

R [7:0]

Z8,

Q [23:16]

Q [15:8]

Q [7:0]

R [23:16]

R [15:8] ...

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

data

resolution

transfer

width

xfers¹

sequence²

R [11:0] |Z4|R [11:0] |Z4

data type

port

real

12 bit

Fiber

32 bit

1/2

R [11:0] |Z4|R [11:0] |Z4,...

complex

real

12 bit

24 bit

Fiber

R [11:0] |Z4|Q [11:0] |Z4

R [11:0] |Z4|Q [11:0] |Z4 ...

R [23:0] |Z8

R [23:0] |Z8 ...

complex

R [23:0] |Z8

Q [23:0] |Z8 ...

R [23:0] |Z8 ...

1. That is, transfers required per measurement. A fraction indicates multi-

ple samples per transfer.

2. Sequence Notation:

R = real number transfer; Q = imaginary number transfer; Z4 = 4 zero

pad bits; Z8 = 8 zero pad bits (in the LSBs). Subscript denotes the sample

number. Bracketed indices show which sample bits are contained in the

transfer, MSB first. A vertical bar denotes bit-wise concatenation. Exam-

ple: For a 12-bit sample sent to the LBUS, R0[11:4] indicates the 8 MSBs

of the sample are transferred in the first byte. Then R0[3:0] | Z4 indicates

the 4 LSBs of the sample are padded with 4 zero bits and transferred in

the second byte.

The maximum rate at which data may be transferred to memory is determined by the ADC clock

rate: MaxBytes/s = 1.5 × (ADC clock rate). Divide MaxBytes/s by 1.5 to get the 12-bit sample

rate, and by 3 to get the 24-bit sample rate.

A limitation also applies to 32-bit, complex data transfers. Because this type of transfer cannot be

made at the full sample rate, a level of decimation must be added in order to reduce the sample

rate.

The following table summarizes the relationship between data parameter combinations,

decimation, filter bandwidth, precision, and whether the combination permits block or continuous

measurements:

Note

Continuous mode is only limited by maximum transfer rate of the selected interface.

sample rate BW fs=100

decimate

filterBW

12b real

24b real

12b complex 24b complex

(Msamples/s)

MHz

n/a

100

b,d

b,c,d

b,d

12.5

b,c,d

b,d

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

sample rate BW fs=100

decimate

filterBW

12b real

24b real

12b complex 24b complex

(Msamples/s)

MHz

12.5

6.25

2.5

b,c,d

b,d

b,c,d

1.25

b = block mode, continuos mode to fiber at the fiber transfer rate of 250 Mbytes per

second.

c = continuous mode to local bus

d = continuous mode to fiber at the fiber transfer rate of 106 Mbytes per second.

spectralOrder

This parameter is intended for use only with the IF signal path, providing efficient and transparent

compensation for the effect of down conversion on output data. It does not generate an error if it is

set in baseband mode though spectralOrder remains AGE1439_NORMAL.

AGE1439_NORMAL means that the spectrum of the output data will be in the same spectral

order as the input signal. That is, if the input signal increases in frequency from "right-to-left", so

does the spectrum of the output data.

AGE1439_REVERSED means that the spectrum of the output data will be in the reverse spectral

order from the input spectrum. That is, if the input signal increases in frequency from "right-to-

left", the spectrum of the output data decreases in frequency from "right-to-left".

Changing the spectral order in multiple-module systems causes the LO to lose synchronization

with the other modules. Thus, in multi-module systems, the LO’s need to be re-synchronized after

this parameter is changed. See age1439_filter_setup for more information on synchronizing the

LO.

spectralOrderPtr

points to the current value of the spectralOrder for the current signal path. In baseband mode the

returned value is always AGE1439_NORMAL.

Return Value

AGE1439_SUCCESS indicates that a function was successful.

Values other than AGE1439_SUCCESS indicate an error condition or other important status

condition. To determine the error message, pass the return value to “age1439_error_message” on

page 102.

“age1439_init” on page 132, “age1439_frequency_setup” on page 128, “age1439_filter_setup”

on page 120, “age1439_meas_control” on page 151, “age1439_clock_setup” on page 78

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_data_xfersize

Allows data to be read before an entire block had been acquired.

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_data_xfersize(ViSession id, ViInt32 xfersize);

ViStatus age1439_data_xfersize_get(ViSession id, ViPInt32 xfersizePtr);

Description

This command allows you to specify the allowable data transfer size in a situation where you

want to read a large block of data in increments before an entire block has been acquired.

Note

This function has no effect on the fiber output channel.

Parameters

is the VXI instrument session pointer returned by the age1439_init function.

xfersize

specifies the data transfer size in samples.

AGE1439_XFERSIZE_MIN selects the minimum allowable transfer size.

AGE1439_XFERSIZE_MAX selects the maximum allowable transfer size. xfersize must be a

sub-multiple of blocksize or an error is generated.

AGE1439_XFERSIZE_DEF sets the default transfer size.

Note

xfersize is reset by any subsequent change in the blocksize parameter and therefore must be

specified after blocksize. See “age1439_data_setup” on page 90.

xfersizePtr

points to the data transfer size in number of bytes.

Return Value

AGE1439_SUCCESS indicates that a function was successful.

Values other than AGE1439_SUCCESS indicate an error condition or other important status

condition. To determine the error message, pass the return value to “age1439_error_message” on

page 102.

“age1439_data_setup” on page 90

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_driver_debug_level

Sets and gets the debug level.

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_driver_debug_level(ViSession id, ViInt16 debugLevel);

ViStatus age1439_driver_debug_level_get(ViSession id, ViPInt16 debugLevelPtr);

Description

This command allows you to set and get debug levels. Debug messages are sent to the application

debugger using the Windows kernel function Output Debug String.

Note

This function only works under Windows.

This function only works with a debug build of the library.

Debug messages are received by the Microsoft Visual C++ debugger or can be received by the

dbmon example program that comes with Microsoft Visual C++.

You can compile a DEBUG build by opening age1439_32.dsw, the Visual C++ project for the

driver DLL, age1439_32.dll, and selecting the "age1439_32.dl-Win32 Debug" build

configuration.

Parameters

is the VXI instrument session pointer returned by the age1439_init function.

debugLevel

debugLevelPtr

is the debug level.

points to the value of debugLevel.

Debug levels are defined as follows:

Debug Level

Description

AGE1439_DEBUG_LEVEL_0

AGE1439_DEBUG_LEVEL_1

AGE1439_DEBUG_LEVEL_2

AGE1439_DEBUG_LEVEL_3

AGE1439_DEBUG_LEVEL_4

AGE1439_DEBUG_LEVEL_5

Only output errors and algorithmic results

Add output of setup function calls

Add output of measurement function calls

Add output of status query function calls

Reserved

Add output of diagnostic function calls

Return Value

AGE1439_SUCCESS indicates that a function was successful.

Values other than AGE1439_SUCCESS indicate an error condition or other important status

condition. To determine the error message, pass the return value to “age1439_error_message” on

page 102.

See Also

multi-module systems” in chapter 3.

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_epoch_setup

Sets the parameters relevant to the transmission of data epochs over the fiber interface. This

description also includes information on the following functions that set up or query the fiber

epoch parameters individually:

age1439_epoch_generate controls whether data epochs are generated or not.

age1439_epoch_generate_get gets the epoch generation status.

age1439_epoch_header sets the value of the first 32 bits of the epoch header.

age1439_epoch_header_get returns the header value.

age1439_epoch_header_enable controls whether epoch headers are generated or not.

age1439_epoch_header_enable_get gets the header status.

age1439_epoch_size sets the size of the data epoch in bytes.

age1439_epoch_size_get gets the size of the data epoch

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_epoch_setup(Visession id, ViInt16 epochGenerate, ViInt32 epochSize,

ViInt16 headerEnable, ViInt32 initialValue, ViInt32 incrementCount);

ViStatus age1439_epoch_generate(Visession id, ViInt16 epochGenterate);

ViStatus age1439_epoch_generate_get(Visession id, ViPInt16 epochGenteratePtr);

ViStatus age1439_epoch_header(Visession id, ViInt32 headerValue,

ViInt32 incrementCount);

ViStatus age1439_epoch_header_get(Visession id, ViPInt32 headerValuePtr,

ViPInt32 incrementCountPtr);

ViStatus age1439_epoch_header_enable(Visession id, ViInt16 headerEnable);

ViStatus age1439_epoch_header_enable_get(Visession id, ViPInt16 headerEnablePtr);

ViStatus age1439_epoch_size(Visession id, ViInt32 epochSize);

ViStatus age1439_epoch_size_get(Visession id, ViPInt32 epochSizePtr);

Parameters

is the VXI instrument session pointer returned by the age1439_init function.

epochGenerate

controls whether or not data epochs are generated.

AGE1439_EPOCH_GEN_ON enables data epoch generation.

AGE1439_EPOCH_GEN_OFF disables sending end of epoch and epoch headers and disables

generating data epochs.

When epochGenerate is off, EOE (End of Epoch) events and epoch headers are not sent however,

data still is. Generally, epochGenerate should be on and should only be disabled for purposes of

compatibility. This setting is ignored when the fiberMode is AGE1439_FIBER_COPY.

epochGeneratePtr

epochSize

points to the current value of epochGenerate

sets the size of data epochs in bytes.

AGE1439_EPOCH_SIZE_MIN selects the minimum data epoch size.

AGE1439_EPOCH_SIZE_DEF sets the data epoch size to the default.

AGE1439_EPOCH_SIZE_MAX selects the maximum data epoch size.

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

The units of epochSize are always in bytes and this value must be divisible by 4, with a minimum

value of 8 to a maximum value of 4,294,967,292 bytes.

Note

For maximum compatibility with other fiber optic components, values divisible by 8 are

recommended.

When the module is being used in a fiber append chain, epochSize must be set equal to blocksize

(in bytes). Since the function AGE1439_DATA_BLOCKSIZE sets the blocksize in samples, the

following table can be used to compute blocksize in bytes.

data type

resolution

bytes per sample

real

complex

real

complex

Note

You may set blocksize and epochSize independently for the other fiberMode settings.

points to the current value of epochSize

epochSizePtr

headerEnable

controls whether or not epoch headers are generated.

AGE1439_HEADER_ON enables epoch header generation

AGE1439_HEADER_OFF disables epoch header is generation.

The default setting is off. Epoch headers are enabled only when epoch generation is enabled.

Otherwise, epoch header settings are silently accepted. The epoch header setting must match the

configuration of the optical receiver.

headerEnablePtr

headerValue

points to the current value of headerEnable

sets the value of the first 32 bits of the epoch header.

AGE1439_HEADER_V A LUE_MIN selects the minimum value for the epoch header.

AGE1439_HEADER_V A LUE_MAX selects the maximum value for the epoch header.

AGE1439_HEADER_INDEX_MASK is used for setting the value of the headerIndex field.

AGE1439_HEADER_INCR_MIN selects the minimum value for the incrementCount.

AGE1439_HEADER_INCR_MAX selects the maximum value for the incrementCount.

Epoch headers are 64 bits long. Of these, the last 32 bits are not used and set to zero. The first 32

bits are available and can be set by the user. The 10 least significant bits of the 32 non-zero bits

contain a value that can be used by the optical receiver to direct where to route and/or how to

process the associated epoch data. These 10 bits are called the headerIndex and can be set from a

value of 0 to 1023. In addition the headerIndex can be sequentially incremented by 1 each time it

is transmitted. The number of increments that are applied before returning to the original value is

programmable by the user.

The headerValue sets the value of all 32 non-zero bits of epoch header, including the 10 least

significant bits that comprise the headerIndex bit field. The default headerValue is 0 and the

maximum value is (2^32 -1).

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

headerValuePtr

incrementCount

points to the current value of initalValue

specifies the number of automatic increments to the headerIndex bit field. The default

incrementCount is 0 and the maximum value is (2^10 -1).

Example

The following is a example of how the increment process works.

For headerValue = 0x12345678 and incrementCount = 0x2, the sequence of values for

headerValue and headerIndex are:

Increment headerValue

headerIndex

0x12345678

0x12345679

0x1234567A

0x12345678

0x12345679

0x1234567A

0x278

0x279

0x27A

0x278

0x279

0x27A

If an incremented header reaches a value where the headerIndex is 0x3FF, the next headerIndex

will be 0x000, and no carry will be generated to the upper 22 bits of the header.

Note

If the incrementCount is set to 0, incrementing the headerIndex field is disabled.

points to the current value of incrementCount

incrementCountPtr

The following table is a summary of valid fiber, epoch setups. Please note that the designation of

N/A means that this information is not applicable to this condition. In this case the setting is

accepted but ignored. The designation of OK means the setting is accepted and implemented. The

designation of NO means do not use this setting with this condition.

Copy¹

Option/fiberMode

Off

Raw

Generate

Append

BOF_OFF

N/A

BOF_ON

CRC_OFF

CRC_ON

FLOW_CONTROL_OFF

N/A

FLOW_CONTROL_COPY

FLOW_CONTROL_NO_COPY

EPOCH_GEN_OFF

N/A

EPOCH_GEN_ON

N/A

HEADER_OFF

HEADER_ON

1. Default instrument setting on power-up and reset.

2. Not applicable unless EPOCH _GEN_ON is enabled.

100

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

3. This is required if this is the first module in an append chain.

4. This is required unless this is the last module in an append chain.

5. CRC_ON or CRC_OFF must correspond to the setting of the

module supplying the data to the fiber interface.

6. This is required for all modules in an append chain.

Return Value

AGE1439_SUCCESS indicates that a function was successful.

Values other than AGE1439_SUCCESS indicate an error condition or other important status

condition. To determine the error message, pass the return value to “age1439_error_message” on

page 102.

page 102

101

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_error_message

Returns error information obtained from function calls.

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_error_message(ViSession id, ViStatus statusCode, ViChar

errorMessage[]);

Description

age1439_error_message takes an error return value generated by a function and translates it to a

readable string. This function includes host errors as well as firmware errors.

Parameters

is the VXI instrument session pointer returned by the age1439_init function.

represents the error message string up to 256 characters long.

errorMessage

Note

For this parameter you must allocate a character array of at least 256 characters AGE1439_STR_

LEN_MIN, including the null byte, prior to calling this function in any programming language.

statusCode

represents the instrument numeric error code.

Return Value

AGE1439_SUCCESS indicates that a function was successful.

Values other than AGE1439_SUCCESS indicate an unknown error condition or other important

status condition and may return VI_WARN_UNKNOWN_STATUS.

102

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_error_query

Queries the module for the first error in the queue.

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_error_query(ViSession id, ViPint32 errorCode, ViChar errorMessage[]);

Description

age1439_error_query queries the module for the oldest error and returns the corresponding error

message. This function does not report host errors that originate in the C library.

Parameters

is the VXI instrument session pointer returned by the age1439_init function.

points to the instrument numeric error code.

errorCode

errorMessage

points to the error message string up to 80 characters long. This message also indicates what

function call generated the error.

Note

For this parameter you must allocate a character array of at least 256 characters AGE1439_STR_

LEN_MIN, including the null byte, prior to calling this function in any programming language.

Return Value

AGE1439_SUCCESS indicates that a function was successful.

Values other than AGE1439_SUCCESS indicate an error condition or other important status

condition. To determine the error message, pass the return value to “age1439_error_message” on

page 102.

103

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_ext_sample_sync

Enables synchronization of multiple modules. This description also includes the query:

age1439_ext_sample_sync_get

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_ext_sample_sync(ViSession id, ViInt16 syncEnable);

ViStatus age1439_ext_sample_sync_get(ViSession id, ViPInt16 syncEnablePtr);

Note

This command should be used only for specialized custom clock requirements. Most useful clock

setups can be supplied by age1439_clock_setup.

Description

This command is used to provide precision sampling in multi-module systems by synchronizing

them to an external sample clock. The External Trigger BNC provides the input for a

synchronizing signal. A splitter and identical cables provide external sample clock and user

generated external sync pulse signals to each module. This command is only specified for

baseband path.

Note

This command requires specialized external hardware. “External sample synchronization in

Parameters

is the VXI instrument session pointer returned by the age1439_init function.

syncEnable

AGE1439_EXT_SAMP_SYNC_ENABLE is used after calling age1439_clock_setup to select a

multi-module external sample setup. A counter within the module is put into its reset state and the

two clocks within the module that are derived from the sample clock stop operating; this includes

the clock used by the DSP circuitry that runs at one-half the sample clock, and a clock running at

one thirty-eighth of the sample clock used for multi-module sync. As soon as a rising edge is

applied to the External Trigger input of the Agilent E1439, the counter resumes counting from a

known state and the two clocks mentioned above have a known phase. Since the clocks may be

interrupted for some time, it is a good idea to call age1439_clock_recover after the counter has

resumed counting.

AGE1439_EXT_SAMP_SYNC_CANCEL releases the module’s counter from its preset state and

the clocks resume. It is still advisable to call age1439_clock_recover.

syncEnablePtr

points to the value of syncEnable.

Return Value

AGE1439_SUCCESS indicates that a function was successful.

Values other than AGE1439_SUCCESS indicate an error condition or other important status

condition. To determine the error message, pass the return value to “age1439_error_message” on

page 102.

104

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

“age1439_filter_sync” on page 123, “age1439_clock_setup” on page 78, “Managing multiple

modules” in chapter 3, “Using clock and sync” in chapter 3, “External sample synchronization in

multi-module systems” in chapter 3

105

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_fiber_clear

This function clears all data from the fiber interface FIFO buffers.

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_fiber_clear(ViSession id);

Description

age1439_fiber_clear clears all data from the fiber interface FIFO buffers, and resets other

internal transient states such as, "reset to beginning of epoch" and "return to copy phase of

append".

Parameter

is the VXI instrument session pointer returned by the age1439_init function.

Return Value

AGE1439_SUCCESS indicates that a function was successful.

Values other than AGE1439_SUCCESS indicate an error condition or other important status

condition. To determine the error message, pass the return value to “age1439_error_message” on

page 102.

106

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_fiber_error_clear

This function clears the AGE1439_STATUS_FIBER_ERROR bit in the status register.

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_fiber_error_clear(ViSession id);

Description

age1439_fiber_error_clear clears the AGE1439_STATUS_FIBER_ERROR bit in the status

Parameter

is the VXI instrument session pointer returned by the age1439_init function.

Return Value

AGE1439_SUCCESS indicates that a function was successful.

Values other than AGE1439_SUCCESS indicate an error condition or other important status

condition. To determine the error message, pass the return value to “age1439_error_message” on

page 102.

See Also

page 103, “Error messages” on page 199

107

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_fiber_error_get

This function returns the value of the fiber interface error register when the AGE1439_STATUS_

FIBER_ERROR bit is set.

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_fiber_error_get(ViSession id, ViInt16 fiberErrorPtr);

Description

age1439_fiber_error_get returns the fiber interface errors.

Parameter

is the VXI instrument session pointer returned by the age1439_init function.

points to the value of the fiber interface error. The bits are defined below:

fiberErrorPtr

Numeric

Value

Status Bit

Definition

Description

FI_ERR_UNLOCKED

512

256

Indicates that the internal receive or transmit

clock is not properly locked. This could be

caused by a poor quality receive signal.

TX_ERR_OVERRUN

Indicates that data transmission is not

sustainable because the raw data bandwidth

has exceeded the available fiber capacity.

RX_ERR_FIFO_OVERFLOW

RX_ERR_SYNC_LOST

RX_ERR_DISPARITY

128

Indicates that data arriving on the fiber receive

port has been lost.

Indicates that the receiver did not detect the

synchronization signal.

Indicates an invalid stream of bits was

detected in the received data.

RX_ERR_CODE_VIOLATION

RX_ERR_ALIGNMENT

RX_ERR_BEGIN_DISPARITY

RX_ERR_CRC

Indicates an invalid stream of bits was

detected in the received data.

Indicates an invalid stream of bits was

detected in the received data.

Indicates an invalid stream of bits was

detected in the received data.

Indicates a cyclic redundancy check error has

occurred on the receiver of the fiber interface.

RX_ERR_SIGNAL LOST

Indicates the signal is no longer being received

on the fiber interface.

108

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

Return Value

AGE1439_SUCCESS indicates that a function was successful.

Values other than AGE1439_SUCCESS indicate an error condition or other important status

condition. To determine the error message, pass the return value to “age1439_error_message” on

page 102.

109

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_fiber_LED_get

Returns a data register indicating the state of the front panel XMT/RCV LEDs.

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_fiber_LED_get(ViSession id, ViPInt16 ledRegPtr);

Description

This function returns a register value that indicates the current state of the front panel XMT and

RCV LEDs.

Parameters

is the VXI instrument session pointer returned by the age1439_init function.

points to the current value of the LED register.

ledRegPtr

AGE1439_LED_RX_SIGNAL indicates an optical signal has been detected, the RCV LED is on

or blinking.

AGE1439_LED_RX_D A TA indicates data was received in approximately the last 500 ms, the

RCV LED is blinking.

AGE1439_LED_TX_ENABLED indicates that the transmitter in enabled, the XMT LED is on or

blinking.

AGE1439_LED_TX_D A TA indicates local data was transmitted in approximately the last 500

ms, the XMT LED is blinking.

Note

The AGE1439_ST A T US_FIBER_ACTIVE bit is set when either of or both the XMT or RCV

LEDs are blinking, indicating data is being received and/or being transmitted.

Return Value

AGE1439_SUCCESS indicates that a function was successful.

Values other than AGE1439_SUCCESS indicate an error condition or other important status

condition. To determine the error message, pass the return value to “age1439_error_message” on

page 102.

page 176

110

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_fiber_rcv_signals_get

Returns the current value of the PIO1, PIO2, DIR, or NRDY bits present on the fiber receiver.

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_fiber_rcv_signals_get(ViSession id, ViPInt16 pio1, ViPInt16 pio2,

ViPInt16 dir, ViPInt16 nrdy);

Description

These are embedded Serial FPDP signals. The use of these bits is optional. Serial FPDP does not

use these four signals directly, but simply transmits them from sender to receiver. This function

displays the value of recovered PIO1, PIO2, DIR and NRDY bits on the fiber receiver.

Note

This function will return AGE1439_FIBER_ERROR when a signal is present, but the fiber

receiver is not synced to the signal. (e.g., when the wrong interface speed has been selected). The

function will also return this error if it is selected and no signal is present.

Parameter

is the VXI instrument session pointer returned by the age1439_init function.

Programmable I/O bit on the fiber receiver for user defined purposes.

pio1

pio2

Note

The following are FPDP signals that are accommodated in the Serial FPDP protocol. For further

information on these signals refer to ANSI/VITA 17-1998, Front Panel Data Port Specifications.

dir

returns the dir FPDP control signal.

returns the nrdy FPDP control signal.

nrdy

Return Value

AGE1439_SUCCESS indicates that a function was successful.

AGE1439_FIBER_ERROR is returned if there is no optical energy detected on the RCV fiber

port.

Values other than AGE1439_SUCCESS indicate an error condition or other important status

condition. To determine the error message, pass the return value to “age1439_error_message” on

page 102.

on page 118.

111

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_fiber_setup

Sets the fiber interface parameters. This description also includes information on the following

functions which set up or query the fiber parameters individually:

age1439_fiber_BOF controls whether or not automatically generated BOF events are

transmitted.

age1439_fiber_BOF_get returns the current status of bofEnable.

age1439_fiber_crc sets up the fiber interface to transmit and receive cycle redundancy

checking to the same value.

age1439_fiber_crc_get gets the current status of crcEnable.

age1439_fiber_flow_control enables or disables transmitter flow control signals.

age1439_fiber_flow_control_get returns the value of flowControlMode.

age1439_fiber_mode is used to select the fiber mode.

age1439_fiber_mode_get returns the current value of fiberMode.

age1439_fiber_transfer_rate selects the transfer rate for fiber optical data.

age1439_fiber_transfer_rate_get returns the current value of transferRate.

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_fiber_setup(Visession id, ViInt16 mode, ViInt16 bofEnable, ViInt16

flowControlEnable, ViInt16 crcEnable, ViInt16 transferRate);

ViStatus age1439_fiber_BOF(Visession id, ViInt16 bofEnable);

ViStatus age1439_fiber_BOF_get(Visession id, ViPInt16 bofEnablePtr);

ViStatus age1439_fiber_crc(Visession id, ViInt16 crcEnable);

ViStatus age1439_fiber_crc_get(Visession id, ViPInt16 crcEnablePtr);

ViStatus age1439_fiber_flow_control(Visession id, ViInt16 flowControlMode);

ViStatus age1439_fiber_flow_control_get(Visession id, ViInt16 flowControlModePtr);

ViStatus age1439_fiber_mode(Visession id, ViInt16 fiberMode);

ViStatus age1439_fiber_mode_get(Visession id, ViPInt16 fiberModePtr);

ViStatus age1439_fiber_transfer_rate(Visession id, ViInt16 transferRate);

ViStatus age1439_fiber_transfer_rate_get(Visession id, ViPInt16 transferRatePtr);

Parameter

is the VXI instrument session pointer returned by the age1439_init function.

bofEnable

configures the automatic generation of BOF events. Generally, this is only used by modules in an

optical append chain.

AGE1439_BOF_ON is used in an optical append chain. When used in this manner, all but the last

module in the append chain should have BOF events enabled. The first module in the append

chain should also have fiberMode set to AGE1439_FIBER_MODE_GENER A T E. This will cause

it to generate a BOF event after every EOE event, in other words, at the end of every data epoch it

sends. All subsequent modules in an append chain should have fiberMode set to AGE1439_

FIBER_MODE_APPEND. In this case, the module re-transmits received data epochs without

modification. The reception of a BOF event alerts the module to the opportunity to insert a data

epoch of its own, if available, between the reception of EOE and BOF events. AGE1439_BOF_

ON is only available when epochGenerate is ON and fiberMode is either generate or append,

otherwise this setting is silently accepted and ignored.

112

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

AGE1439_BOF_OFF is the default setting. It blocks the transmission of all automatically

generated BOF events. However, programmatically generated BOF events such as age1439_

fiber_xmt_BOF,whichareusedinthesynchronizationoffiberinterfaces,arenotblocked.

bofEnablePtr

crcEnable

points to the current value of bofEnable.

determines whether or not cyclic redundancy checking (CRC) is performed on the fiber receiver

and whether or not that information will be transmitted. Generally, cyclic redundancy checking

should be enabled, but turning CRC off may solve compatibility problems with some fiber optic

receivers.

AGE1439_CRC_ON enables CRC checking.

AGE1439_CRC_OFF disables CRC checking.

crcEnablePtr

fiberMode

points to the current value of crcEnable.

is used to turn the fiber interface off, configure it to copy data from the receiver to the transmitter

port without adding data, configure the transmission of filtered ADC data, or configure appending

ADC data to received data.

AGE1439_FIBER_MODE_RAW allows the transmission of unfiltered full bandwidth ADC data

at the same time filtered ADC data is available to read on the VME bus or the local bus.

AGE1439_FIBER_MODE_OFF turns off both the fiber transmitter and receiver (although PIO1,

PIO2, NRDY and DIR bits are still received). Normal data collection and digital processing

continues.

Note

If age1439_data_port is set to fiber while the fiber interface is turned off, the data FIFO will fill

up with filtered ADC data and collection will stop. In this case, age1439_meas_status_get will

return the error, AGE1439_NO_D A T A _MEASUREMENT_PAUSED.

AGE1439_FIBER_MODE_COPY is the default fiberMode at power-on and reset. Data is copied

from the fiber interface receiver to the fiber interface transmitter while the module is performing

other measurements. For instance, filtered ADC data can be sent on the LBUS or read from the

FIFO over the VME bus in accordance with the current setting of the age1439_data_port

function, with this parameter set. However, selecting fiber as the data port while using this mode

will result in setting the AGE1439_STATUS_SETUP_ERROR bit in the status register. This

occurs because the fiber interface cannot perform both functions at the same time.

Note

The E1439D fiber receiver’s detect signal is used to activate the fiber transmitter. The E1439D

fiber interface is not a data receiver. The function of the receive port is limited to copying data to

the transmit port and to detecting FPDP control signals (e.g., PIO bits and flow control signals).

Since signal detect works on light energy alone, there does not need to be valid data on the fiber

receiver for there to be an output from the transmitter. If there is valid data present on the fiber

receiver, it is copied to the fiber transmitter. This preserves data transparency but not necessarily

protocol transparency. The outgoing protocol is always serial FPDP.

AGE1439_FIBER_MODE_RAW transmits unprocessed and unbuffered ADC data over the fiber

interface. After selection, optical data transmission begins when the first measurement is

triggered, and continues indefinitely after the measurement is complete. Transmission will

continue until the fiber mode is changed to something other than AGE1439_FIBER_MODE_

R A W or a fiber error occurs. While this raw data is being transmitted, filtered ADC data can still

be sent over the local bus, or read from the FIFO via the VME bus. Attempting to set AGE1439_

113

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

FIBER_MODE_RAW and the age1439_data_port to fiber will result in the AGE1439_

STATUS_SETUP_ERROR bit being set. This is because the fiber interface cannot send both raw

and filtered ADC data at the same time.

Note

Attempting to use the flow control while in AGE1439_FIBER_MODE_RAW fiber mode will

likely result in a TX_ERR_OVERRUN error. The transmit FIFO size is only1 Kbyte

AGE1439_FIBER_MODE_GENER A T E causes filtered ADC data to be transmitted over the

fiber interface when one block is available in the FIFO. When flow control is enabled in this

mode, an external optical receiver can send stop and go commands that cause the module to pause

or resume data transmission. Received optical data other than data flow control signals are

ignored.

AGE1439_FIBER_MODE_APPEND copies data from the fiber optic receiver to the fiber optic

transmitter and appends its own filtered ADC data, when available.

fibermodePtr

points to the current value of fiberMode.

flowControlMode

configures fiber flow control. When flow control is on, an external optic receiver can pause or

resume the fiber data transmission by sending a stop or go command. Received optical data other

than flow control signals and PIO bits are ignored.

AGE1439_FLOW_CONTROL_NO_COPY responds to received flow control signals GO and

STOP, and transmits GO.

AGE1439_FLOW_CONTROL_COPY responds to received flow control signals GO and STOP,

and transmits the received flow control signal values.

AGE1439_FLOW_CONTROL_OFF disables fiber flow control.

points to the current value of flowControlMode.

flowControlModePtr

transferRate

sets both the transmitter and receiver raw data rates.

AGE1439_106MBS transfers data at the legacy data rate of 106 Mbytes per second. This is the

default setting.

AGE1439_250MBS transfers data at 250 Mbytes per second. This is fast enough to support

continuous transmission of data at the highest sample rates and bit depths.

transferRatePtr

points to the current value of transferRate.

Return Value

AGE1439_SUCCESS indicates that a function was successful.

Values other than AGE1439_SUCCESS indicate an error condition or other important status

condition. To determine the error message, pass the return value to “age1439_error_message” on

page 102.

page 102

114

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_fiber_signal_get

Returns a value indicating whether or not an optical signal is detected by the optical fiber

interface receiver.

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_fiber_signal_get(ViSession id, ViPInt16 fiberSignalPtr);

Parameters

is the VXI instrument session pointer returned by the age1439_init function.

fiberSignalPtr

returns a value indicating whether or not an optical signal has been detected by the fiber interface

receiver.

AGE1439_NO_FIBER_SIGNAL indicates no optical signal has been detected by the fiber

interface receiver.

AGE1439_FIBER_SIGNAL_PRESENT indicates an optical signal has been detected by the fiber

interface receiver.

Return Value

AGE1439_SUCCESS indicates that a function was successful.

Values other than AGE1439_SUCCESS indicate an error condition or other important status

condition. To determine the error message, pass the return value to “age1439_error_message” on

page 102.

page 176

115

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_fiber_verify

This function verifies the operational condition of the fiber interface.

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_fiber_verify(ViSession id, ViInt16 verifyPath, ViInt16 sec);

Description

This function performs a verification of the fiber interface using either an internal or an external

signal path. The internal signal path cannot test the actual RX/TX ports but does test the internal

connections of the fiber interface to the rest of the module. The external signal path does test the

RX/TX ports but requires connecting an optical short between the RX and TX fiber ports.

Note

No fiber optic cables should be connected or disconnected during verification.

Parameter

is the VXI instrument session pointer returned by the age1439_init function.

indicates which path, internal or external, is being tested by age1439_fiber_verify.

verifyPath

AGE1439_FIBER_VERIFY_INTERNAL verifies the internal fiber interface connections to the

rest of the module.

Note

age1439_self_test performs five-second internal fiber verification.

AGE1439_FIBER_VERIFY_EXTERNAL verifies the operational condition of the RX and TX

fiber ports by connecting an optical short between them.

sec

sets the number of seconds the verification procedure will last based on this argument.

AGE1439_FIBER_VERIFY_MIN sets minimum fiber verification time in seconds.

AGE1439_FIBER_VERIFY_MAX sets maximum fiber verification time in seconds.

Return Value

AGE1439_SUCCESS indicates that a function was successful.

Values other than AGE1439_SUCCESS indicate an error condition or other important status

condition. To determine the error message, pass the return value to “age1439_error_message” on

page 102

116

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_fiber_xmt_BOF

This function sends a BOF event used for synchronization with other fiber interfaces before data

acquisition begins.

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_fiber_xmt_BOF(ViSession id);

Parameter

is the VXI instrument session pointer returned by the age1439_init function.

Return ValueAGE1439_SUCCESS indicates that a function was successful.

Values other than AGE1439_SUCCESS indicate an error condition or other important status

condition. To determine the error message, pass the return value to “age1439_error_message” on

page 102.

See Also

“age1439_init” on page 132, “age1439_input_setup” on page 141, “age1439_clock_setup” on

117

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_fiber_xmt_signals

Sets the transmitted values of PIO1, PIO2, DIR, and NRDY FPDP control signals on the fiber

transmitter.

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_fiber_xmt_signals(ViSession id, ViInt16 pio1, ViInt16 pio2, ViInt16

dir, ViInt16 nrdy);

Description

These are embedded Serial FPDP signals. The use of these bits is optional. Serial FPDP does not

use these four signals directly, but simply transmits them from sender to receiver. These functions

set the value of PIO1, PIO2, DIR and NRDY bits on the fiber transmitter. The default value of

these signals is 0.

Parameter

is the VXI instrument session pointer returned by the age1439_init function.

Programmable I/O bit on the fiber transmitter for user defined purposes.

pio1

pio2

Programmable I/O bit on the fiber transmitter for user defined purposes.

AGE1439_FIBER_SIG_ON FPDP control signals enabled.

AGE1439_FIBER_SIG_OFF FPDP control signals disabled. This is the default value for all

signals.

Note

The following are FPDP signals that are accommodated in the Serial FPDP protocol. For further

information on these signals refer to ANSI/VITA 17-1998, Front Panel Data Port Specifications.

dir

sets the dir FPDP control signal.

sets the nrdy FPDP control signal.

nrdy

Return Value

AGE1439_SUCCESS indicates that a function was successful.

Values other than AGE1439_SUCCESS indicate an error condition or other important status

condition. To determine the error message, pass the return value to “age1439_error_message” on

page 102.

get” on page 111

118

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_fiber_xmt_signals_get

Returns the current value of PIO1, PIO2, DIR, and NRDY bits present on the fiber transmitter.

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_fiber_xmt_signals_get(ViSession id, ViPInt16 pio1, ViPInt16 pio2,

ViPInt16 dir, ViPInt16 NRDY);

Description

These are embedded Serial FPDP signals. The use of these bits is optional. Serial FPDP does not

use these four signals directly, but simply transmits them from sender to receiver. These functions

display the value of recovered PIO1, PIO2, DIR and NRDY bits on the fiber transmitter.

Parameter

is the VXI instrument session pointer returned by the age1439_init function.

returns the current value of pio1.

pio1

pio2

returns the current value of pio2.

Note

The following are FPDP signals that are accommodated in the Serial FPDP protocol. For further

information on these signals refer to ANSI/VITA 17-1998, Front Panel Data Port Specifications.

dir

returns the current value of dir.

returns the current value of nrdy.

nrdy

Return Value

AGE1439_SUCCESS indicates that a function was successful.

Values other than AGE1439_SUCCESS indicate an error condition or other important status

condition. To determine the error message, pass the return value to “age1439_error_message” on

page 102.

get” on page 111.

119

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_filter_setup

Sets the digital filter bandwidth and decimation filter parameters. This description also includes

information on the following functions which set or query the decimation filter parameters

individually:

age1439_filter_decimate selects an extra factor of 2 decimation.

age1439_filter_decimate_get gets current state of extra decimation

age1439_filter_bw selects a signal filter bandwidth.

age1439_filter_bw_get gets the signal filter bandwidth

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_filter_setup(ViSession id, ViInt16 sigBw, ViInt16 decimate);

ViStatus age1439_filter_decimate(ViSession id, ViInt16 decimate);

ViStatus age1439_filter_decimate_get(ViSession id, ViPInt16 decimatePtr);

ViStatus age1439_filter_bw(ViSession id, ViInt16 sigBw);

ViStatus age1439_filter_bw_get(ViSession id, ViPInt16 sigBwPtr);

Parameters

is the VXI instrument session pointer returned by the age1439_init function.

decimate

selects the data output sample rate. When this parameter is set to AGE1439_DECIM A T E_OFF

the output sample rate is:

fs when sigBw=0, or

fs/2^(sigBw-1) when sigBw>0

When decimate is set to AGE1439_DECIM A T E_ON the output sample rate is reduced by an

additional factor of two by discarding alternate samples.

AGE1439_DECIM A T E_SHIFT is like AGE1439_DECIMATE_ON but additional processing is

performed that shifts the center frequency of zoomed data up by fs/4 and transforms the complex

data stream into a real data stream without losing phase information. For consistent spectrum

measurements the data scale value is doubled when using shift decimate.

decimatePtr

sigBw

points to the current value of the decimate parameter.

selects an alias protected signal filter bandwidth that is roughly fs/(2.56 × 2^(sigBw)) where fs is

the ADC sample frequency. In zoom applications, where the center frequency is generally not

zero, the zoom filter bandwidth is centered on the frequency programmed with the age1439_

frequency_setup function. For baseband measurements the filter may equivalently be considered

as a low pass filter of approximately bandwidth fs/(2.56 × 2^(sigBw)) since the negative

frequencies are generally of no interest. The valid range of sigBw is 0 through 18. When sigBw =

0, no digital filtering is applied to the signal and the module relies on the analog anti-alias filter to

limit the signal bandwidth to fs/2.56.

To more accurately calculate the bandwidth use the calculation fs × k/2^(sigBw) where:

k=.36 for .25 dB bandwidth

k=.44 for 3 dB bandwidth

k=.5 for 15 dB bandwidth

120

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

k=.62 for 110 dB bandwidth

AGE1439_SIG_BW_MAX sets sigBw to the maximum value and the filter bandwidth to the

minimum.

AGE1439_SIG_BW_MIN sets sigBw to the minimum value and filter bandwidth to the

maximum.

sigBwPtr

points to the current value of the sigBw parameter.

Caution

Selecting AGE1439_DECIMATE_ON when sigBw=0 results in aliasing (garbage data) due

to upper limit of the sampling frequency and, therefore, causes the SETUP_ERROR bit to

be set.

Selecting AGE1439_DECIMATE_SHIFT for non-zoomed data is not a useful configuration.

Comments

To ensure full alias-free operation the analog anti-alias filter (set by the age1439_input_alias_

filter function) should be ON unless the application inherently bandlimits the input signal to less

than fs/2. The analog anti-alias filter has a fixed bandwidth and thus is fully effective only when fs

≥ 100 MHz. If a slower external ADC clock is used, an additional analog filter of the appropriate

bandwidth may be required for full alias protection.

The decimation process used to reduce the output sample rate is driven from a "decimation

counter" which keeps track of which samples to save and which ones to discard for each of the

octave bandwidth reduction filter stages. In multi-module systems where synchronous sampling is

required, the decimation counters in all the modules must be synchronous with each other. This

condition can be forced by using the age1439_filter_sync function.

The following table lists parameter combinations (see also “age1439_data_setup” on page 90)

which result in invalid measurement conditions:

Invalid parameter combinations

resolution

(bits)

dataType

decimate

sigBw

12 or 24

REAL or COMPLEX

COMPLEX

OFF or SHIFT

ON or SHIFT

any

REAL or COMPLEX

COMPLEX

OFF

any

0 or 1

any

12 or 24

SHIFT

All other combinations are valid.

Example

Here are some bandwidth and sample rate results using the "k" calculation for bandwidth:

fs = 100 MHz default internal ADC clock (all data in MHz)

121

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

Signal Bandwidth

MHz

Sample Rate

Msamples

sigBw .25 dB 15 dB Decimate OFF Decimate ON

N/A

12.5

6.25

3.125

4.5

2.25

12.5

6.5

12.5

>4 Continue to decimate by factors of two

Return Value

AGE1439_SUCCESS indicates that a function was successful.

Values other than AGE1439_SUCCESS indicate an error condition or other important status

condition. To determine the error message, pass the return value to “age1439_error_message” on

page 102.

page 78, “age1439_frequency_setup” on page 128, “age1439_filter_sync” on page 123,

“age1439_data_setup” on page 90, “Frequency and filtering” in chapter 3

122

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_filter_sync

Synchronizes the decimation counter for multi-module systems.

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_filter_sync(ViSession id);

Description

This function causes the digital decimation counter to be reset by the next Sync line rising

transition. By calling age1439_filter_sync for every Agilent E1439 module using a shared ADC

clock, and then calling age1439_meas_control to cause a sync transition, the decimation counters

are prepared to start at the same time. Once this is done the decimation counters stay synchronized

as long as the same ADC clock is used. You do not need to resynchronize the decimation counters

when the digital filter bandwidths are changed.

Note

Resetting the decimation counter causes a transient in the digital filters. The transient takes about

30 decimated output sample periods to decay 100 dB. See the step response graphs in the

Technical Specifications for more detail.

Parameters

is the VXI instrument session pointer returned by the age1439_init function.

Comment

The correct procedure for using this command is:

1. Force all modules to idle using age1439_meas_control.

2. Call age1439_filter_sync for all modules.

3. Cause a sync transition with one module using age1439_meas_control without releasing

force to idle.

4. Release force to idle on all modules.

If you also want to synchronize frequency or phase see age1439_frequency_setup. This

procedure also applies to those commands for multi-module systems.

Example

The multichan.exe example program provides an example of how to correctly set up a multi-

module system with synchronous filters.

Return Value

AGE1439_SUCCESS indicates that a function was successful.

Values other than AGE1439_SUCCESS indicate an error condition or other important status

condition. To determine the error message, pass the return value to “age1439_error_message” on

page 102.

123

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

on page 128, “age1439_meas_control” on page 151, “Managing multiple modules” in chapter 3

124

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_frequency_center_raw

Provides a fast way to set the center frequency

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_frequency_center_raw(ViSession id, ViInt32 phase, ViInt32 interpolate);

ViStatus age1439_frequency_center_raw_get(ViSession id, ViPInt32 phasePtr, ViPInt32

interpolatePtr);

Description

age1439_frequency_center_raw sets the center frequency without relying on the internal

Agilent E1439 microprocessor to do floating point computations, since the internal

microprocessor does not have a floating point co-processor. The parameters may be easily

computed with age1439_frequency_center_raw_compute.

Parameters

is the VXI instrument session pointer returned by the age1439_init function.

specifies the phase part of the frequency.

specifies the interpolation part of the frequency.

points to the current actual value of phase.

points to the value of interpolate.

phase

interpolate

phasePtr

interpolatePtr

Comments

The following examples are provided in case you want to compute your own parameter values

rather than use the recommended age1439_frequency_center_raw_compute function.

The following C code segment shows how to compute these parameters, where freq is

(center frequency/sample rate):

static void rawFreq(double freq, long *phase, long *interpolate)

{

long ph, in;

freq *= -1048576.0;

ph = (long)fabs(freq);

in = (long)(((fabs(freq)-(double)ph)*37109375)+0.5);

if (freq < 0)

{

ph = -1 - ph;

if (in !=0);

in = 37109375 - in;

else;

ph = ph + 1;

}

*phase = ph;

125

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

*interpolate = in;

return;

}

The equivalent Visual Basic example follows:

Private Sub rawFreq(dblFreq as Double)

Dim dblFx As Double

Dim lngIn As Long

Dim lngPh As Long

dblFx = -1048576# * dblFreq

lngPh = Fix(Abs(dblFx))0

lngIn = Fix(((Abs(dblFx) - CDbl(lngPh)) * 37109375) + 0.5)

If (dblFx < 0) Then

lngPh = (-1) - lngPh

If (lngIn) Then

lngIn = 37109375 - lngIn

Else

lngPh = lngPh + 1

End If

Call age1439_frequency_center_raw(lngId, lngPh, lngIn)

End Sub

Example

An example of this in VB is included in the Front Panel code and can be activated by changing the

following declaration in frmMain of E1439.vbp.

Const constFreqCentRaw = False

’When TRUE, set center frequency with

’age1439_frequency_center_raw()instead of

’age1439_frequency_center()

Return Value

AGE1439_SUCCESS indicates that a function was successful.

Values other than AGE1439_SUCCESS indicate an error condition or other important status

condition. To determine the error message, pass the return value to “age1439_error_message” on

page 102.

center_raw_compute” on page 127

126

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_frequency_center_raw_compute

Computes the raw center frequency parameters

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_frequency_center_raw_compute(ViSession id, ViReal64 center, ViPInt32

phasePtr, ViPInt32 interpolatePtr);

Description

This function quickly computes the parameter values which you may use with age1439_

frequency_center_raw. This function also allows you to compute many values in advance to

facilitate quick frequency hopping.

Parameters

is the VXI instrument session pointer returned by the age1439_init function.

provides the center frequency normalized to clock fs.

points to the computed value of phase.

center

phasePtr

interpolatePtr

points to the computed value of interpolate.

Example

Here is a Visual Basic snippet showing how to use this function:

Call age1439_frequency_center_raw_compute(lngId, dblCenterFreq, lngPh, lngIn)

Call age1439_frequency_center_raw(lngId, lngPh, lngIn)

Return Value

AGE1439_SUCCESS indicates that a function was successful.

Values other than AGE1439_SUCCESS indicate an error condition or other important status

condition. To determine the error message, pass the return value to “age1439_error_message” on

page 102.

center_raw” on page 125, “age1439_combo_setup” on page 87

127

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_frequency_setup

Sets all the zoom center frequency parameters. This description also includes information on the

following functions which set or query frequency parameters individually:

age1439_frequency_center sets the center frequency

age1439_frequency_center_get gets the current center frequency

age1439_frequency_cmplxdc selects a complex baseband measurement

age1439_frequency_cmplxdc_get gets the state of the baseband measurement mode

age1439_frequency_sync prepares the module for a synchronous frequency change

age1439_frequency_sync_get gets the state of the synchronous change mode

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_frequency_setup(ViSession id, ViInt16 cmplxDC, ViInt16 sync, ViReal64

centerFreq);

ViStatus age1439_frequency_center(ViSession id, ViReal64 centerFreq);

ViStatus age1439_frequency_center_get(ViSession id, ViPReal64 centerFreqPtr);

ViStatus age1439_frequency_cmplxdc(ViSession id, ViInt16 cmplxDC);

ViStatus age1439_frequency_cmplxdc_get(ViSession id, ViPInt16 cmplxDCPtr);

ViStatus age1439_frequency_sync(ViSession id, ViInt16 sync);

ViStatus age1439_frequency_sync_get(ViSession id, ViPInt16 syncPtr);

Description

age1439_frequency_setup sets the center frequency of a zoomed measurement. The center of a

frequency band of interest is converted to dc with this function. The frequency transition is phase

continuous unless the center frequency is set to zero in which case the transition may be selected

either to be phase continuous or phase reset. This function may also be used to synchronously

change frequency in multiple-module systems.

Parameters

is the VXI instrument session pointer returned by the age1439_init function.

centerFreq

supplies the center frequency normalized to the sample frequency. It is a number between−0.5 and

+0.5, which is interpreted as a fraction of the sample frequency. centerFreq is the desired center

frequency divided by the ADC sample frequency. For example, selecting 0.25 with a sample

clock frequency of 100 MHz yields a center frequency of 25 MHz. When using the IF signal path,

the normal range is 0.547 to 0.926 corresponding to 52 to 88 MHz. Your applications should

update this parameter when you change signalPath. The ADC sample frequency is returned by

the age1439_clock_fs_get function. Negative frequencies select the negative image of the signal,

which is spectrally inverted from the input signal.

AGE1439_CENT_FREQ_MIN selects the minimum allowable center frequency.

AGE1439_CENT_FREQ_MAX selects the maximum allowable center frequency.

AGE1439_CENT_FREQ_DEF sets the default center frequency.

centerFreqPtr

cmplxDC

points to the current actual value of the center frequency (as a fraction of the sample clock

frequency).

selects either a phase continuous or phase reset transition when freq=0.

128

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

AGE1439_CMPLXDC_OFF, combined with a frequency change to zero, causes phase to be reset

to zero.

AGE1439_CMPLXDC_ON, combined with a frequency change to zero, does not reset the phase

thereby generating a complex dc measurement at baseband. The state of this parameter does not

affect any transition where freq is nonzero. Whether the real or complex data is saved and

ultimately sent to the output port is determined by the age1439_data_type function

cmplxDCPtr

sync

points to the current actual value of cmplxDC.

when set to AGE1439_SYNC_OFF allows an immediate frequency change in single-module

systems.

In multiple-module systems, setting this parameter to AGE1439_SYNC_ON prepares the

modules for a frequency change, but does not actually bring about the change until the next ADC

clock corresponding to the next assertion of the shared Sync signal. The Sync transition is

generated by calling the age1439_meas_control function. Note that returning sync to OFF before

the Sync signal transition has occurred forces an immediate asynchronous frequency change.

syncPtr

points to the value of sync.

Comments

Although the freq parameter is a double precision floating point number, its effective resolution is

1/(2^19 × 5^9 × 19). This allows exact specification of any multiple of 10 mHz when fs=95 MHz.

The actual frequency is set to the nearest available value. This value is returned by the age1439_

frequency_center_get function. In multi-module systems this value represents the pending value

rather than the current value when a frequency change is incomplete due to a pending Sync signal

transition.

In multiple-module systems it is often desirable to force the frequency change to occur

synchronously in order to preserve the phase relationship of the LOs. You may accomplish this by

setting the sync parameter to ON for all the modules which are to be changed.

In configurations involving synchronous operation of multiple Agilent E1439 modules, the

age1439_frequency_setup function provides a mechanism to force all LOs to the same phase.

You can do this by first setting the frequency to zero and then synchronously changing the

frequency to the desired value.

Example

The example program multichan.exe shows how to correctly perform synchronous frequency

changes in a multi-module system.

Return Value

AGE1439_SUCCESS indicates that a function was successful.

Values other than AGE1439_SUCCESS indicate an error condition or other important status

condition. To determine the error message, pass the return value to “age1439_error_message” on

page 102.

129

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

“age1439_data_setup” on page 90, “age1439_clock_fs” on page 76, “age1439_meas_control” on

page 151, “Frequency and filtering” in chapter 3, “Using clock and sync” in chapter 3, “Managing

multiple modules” in chapter 3

130

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_front_panel_clock_input

Specifies the source for the front panel clock. This description also includes the query function:

age1439_front_panel_clock_input_get

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_front_panel_clock_input(ViSession id, ViInt16 fpClock);

ViStatus age1439_front_panel_clock_input_get(ViSession id, ViPInt16 fpClockPtr);

Note

This command should be used only for specialized custom clock requirements. Most useful clock

setups can be supplied by age1439_clock_setup.

Description

This function selects a front panel clock source that is used to drive the analog to digital converter

(ADC) for single module operation or when a module is used as the master ADC clock source for

a multi-module system.

Parameters

is the VXI instrument session pointer returned by the age1439_init function.

AGE1439_CLOCK_OFF specifies no front panel source.

fpClock

AGE1439_SMB_CLOCK specifies clock input from the front panel Intermodule Clock/SMB

connectors.

AGE1439_BNC_CLOCK specifies clock input from the front panel Ext Clock/Ref BNC

connector.

fpClockPtr

returns a pointer to the current value of fpClock.

Return Value

AGE1439_SUCCESS indicates that a function was successful.

Values other than AGE1439_SUCCESS indicate an error condition or other important status

condition. To determine the error message, pass the return value to “age1439_error_message” on

page 102.

“age1439_init” on page 132, “age1439_clock_setup” on page 78, “Using clock and sync” in

chapter 3

131

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_init

Initializes the I/O driver for a module.

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_init(ViRsrc rsrcName, ViBoolean idQuery, ViBoolean resetInstr,

ViPSession id);

Description

age1439_init must be the first routine called when you use the Agilent E1439 library. It

establishes communication with the module and returns a module identification which is used

with all subsequent functions involving this module. This function performs whatever

initialization the I/O driver needs for the environment in which this library is running.

Parameters

is a pointer to the VXI instrument Session identifier returned by this function for the module. This

identifier is then used with all other functions which address this module. This value is not a

VISA id and so cannot be used with VISA functions. Use age1439_attrib_get to get the VISA id.

idQuery

set to AGE1439_MAG verifies the identity of the instrument by checking the manufacturer ID

and model number in the module's VXI register set.

If set to AGE1439_OFF the function does not verify the module's identity. It is helpful to disable

the id query if you want to use the driver with a similar module but do not need to modify the

driver source code.

resetInstr

rsrcName

places the module in the reset state when set to AGE1439_ON.

If set to AGE1439_OFF, the function disables the reset. Disabling the reset is useful for

debugging in cases where resetting would take the instrument out of the state you want to test.

specifies the interface and logical address. This descriptor varies depending on your I/O library.

An example of the descriptor form for the VISA I/O library is:

VXI[Board]::VXIlogical address [::INSTR]

Comments

If you receive a resource descriptor error, see your I/O library documentation to determine the

correct descriptor form.

Return Value

AGE1439_SUCCESS indicates that a function was successful.

Values other than AGE1439_SUCCESS indicate an error condition or other important status

condition. To determine the error message, pass the return value to “age1439_error_message” on

page 102.

132

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

“age1439_attrib_get” on page 74

133

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_input_autozero

Nulls out the input dc offset voltage (applies to baseband input configuration only).

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_input_autozero(ViSession id);

Description

age1439_input_autozero updates a table of dc offset corrections to be used with each signal

path. The applicable correction from this table is automatically added to the input offset parameter

to achieve the correct dc offset value. Because of the length of time needed to execute this

function, it is not automatically called when the module is reset. Thus, the user program is

responsible for explicitly initiating the auto zero. This function should be called at least once after

the temperature of the module has stabilized. The interval between calls after that depends on the

importance of dc accuracy in the user application. It is not necessary to call the auto zero function

for every change of input setup parameters since the correction table maintains values for all setup

conditions.

Note

Calling age1439_input_autozero aborts any measurement already in progress and eliminates LO

phase coherence and filter synchronization in a synchronous multi-module system. See the

age1439_filter_sync and age1439_frequency_sync functions for details on how to re-establish

LO phase coherence and filter synchronization.

Calling this function deletes any saved state and halts any measurement or fiber transfer.

Parameters

is the VXI instrument session pointer returned by the age1439_init function.

Return Value

AGE1439_SUCCESS indicates that a function was successful.

Values other than AGE1439_SUCCESS indicate an error condition or other important status

condition. To determine the error message, pass the return value to “age1439_error_message” on

page 102.

“age1439_input_setup” on page 141, “age1439_input_offset_save” on page 136, “age1439_

filter_sync” on page 123, “age1439_frequency_setup” on page 128

134

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_input_offset

Sets the dc offset DAC setting for the current range. This description also includes the query:

age1439_input_offset_get

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_input_offset(ViSession id, ViInt16 coarseDac, ViInt16 fineDac);

ViStatus age1439_input_offset_get(ViSession id, ViPInt16 coarseDacPtr, ViPInt16

fineDacPtr);

Description

These values are normally set by age1439_input_autozero so you generally would use this

command only for special situations. The resultant values can be saved to non-volatile RAM with

age1439_input_offset_save.

Each ac coupling range has a unique DAC setting. All dc coupling ranges use the same DAC

setting as the highest range setting for ac coupling. The scaling between the coarse and fine DACs

is approximately 100 to 1.

AGE1439_OFFS_DAC_MIN sets the minimum dc offset DAC setting.

AGE1439_OFFS_DAC_MAX sets the maximum dc offset DAC setting.

Parameters

is the VXI instrument session pointer returned by the age1439_init function.

sets values of 0 to 255.

coarseDac

fineDac

sets values of 0 to 255.

coarseDacPtr

fineDacPtr

returns a pointer to the current value of coarseDac

returns a pointer to the current value of fineDac

Return Value

AGE1439_SUCCESS indicates that a function was successful.

Values other than AGE1439_SUCCESS indicate an error condition or other important status

condition. To determine the error message, pass the return value to “age1439_error_message” on

page 102.

page 134, “age1439_input_offset_save” on page 136

135

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_input_offset_save

Saves all DAC offset settings to non-volatile RAM.

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_input_offset_save(ViSession id);

Description

Use this command if you want DAC offset settings to persist past power-down.

Parameters

is the VXI instrument session pointer returned by the age1439_init function.

Return Value

AGE1439_SUCCESS indicates that a function was successful.

Values other than AGE1439_SUCCESS indicate an error condition or other important status

condition. To determine the error message, pass the return value to “age1439_error_message” on

page 102.

page 135

136

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_input_range_auto

Performs auto-ranging.

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_input_range_auto(ViSession id, ViReal64 sec);

Description

age1439_input_range_auto sets the range of a Agilent E1439 to the lowest value that does not

cause an ADC overload to occur. The algorithm starts at the lowest range and moves up until there

is no ADC overload.

Note

The baseband signalPath cannot be auto-ranged because it has only one range (-21 dBm).

Calling this function deletes any saved state and halts any measurement or fiber transfer.

Parameters

is the VXI instrument session pointer returned by the age1439_init function.

sec

is the time in seconds to take data at each range to insure that an overload is detected. Setting this

parameter to 0.0 results in the time being set automatically according to an algorithm that depends

on block size and filter bandwidth.

AGE1439_RANGE_TIME_MIN selects the minimum autorange time.

AGE1439_RANGE_TIME_MAX selects the maximum autorange time.

Return Value

AGE1439_SUCCESS indicates that a function was successful.

Values other than AGE1439_SUCCESS indicate an error condition or other important status

condition. To determine the error message, pass the return value to “age1439_error_message” on

page 102.

“age1439_input_setup” on page 141

137

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_input_range_convert

Converts the input range to volts.

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_input_range_convert(ViSession id, ViInt16 range, ViPReal64

rangeVoltsPtr);

Description

age1439_input_range_convert converts the range of a Agilent E1439

Parameters

is the VXI instrument session pointer returned by the age1439_init function.

is the input range returned by age1439_input_range_get.

range

rangeVoltsPtr

is the range in Volts.

Conversion values are as follows.

Full Scale

(dBm)

Full Scale

Voltage (Vp)

Variable

Range Index

1.26

1.12

.891

.794

.708

.631

.562

.501

.447

.398

.355

.316

.282

.251

.224

.12

−1

−2

−3

−4

−5

−6

−7

.178

.159

.141

138

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

Full Scale

(dBm)

Full Scale

Voltage (Vp)

Variable

Range Index

−8

.126

.112

−9

−10

−11

.089

−12

−13

−14

−15

−16

−17

−18

−19

−20

−21

−22

−23

−24

−25

−26

−27

−28

−29

−30

−31

−32

−33

−34

−35

−36

.0794

.0708

.0631

.0562

.0501

.0447

.0398

.0355

.0316

.0282

.0251

.0224

.02

.0178

.0158

.0141

.0126

.0112

.01

.0089

.0079

.0071

.0063

.0056

.005

Note

These values are approximate. For more accuracy use age1439_data_scale_get.

Return Value

AGE1439_SUCCESS indicates that a function was successful.

Values other than AGE1439_SUCCESS indicate an error condition or other important status

condition. To determine the error message, pass the return value to “age1439_error_message” on

page 102.

139

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

page 89

140

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_input_setup

Sets all the analog input parameters. This description also includes information on the following

functions which set or query the input parameters individually:

age1439_input_alias_filter selects or bypasses the built-in analog anti-alias filter

age1439_input_alias_filter_get gets the anti-alias filter state

age1439_input_coupling selects ac or dc input coupling

age1439_input_coupling_get get the input coupling type

age1439_input_range sets the full scale range

age1439_input_range_get gets the input range

age1439_input_signal connect/disconnect the input signal to the input amplifier

age1439_input_signal_get gets the input buffer amplifier state

age1439_input_signal_path selects a baseband or IF signal path

age1439_input_signal_path_get gets the current signal path

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_input_setup(ViSession id, ViInt16 signalPath, ViInt16 range, ViInt16

coupling, ViInt16 antiAlias, ViInt16 signal);

ViStatus age1439_input_alias_filter(ViSession id, ViInt16 antiAlias);

ViStatus age1439_input_alias_filter_get(ViSession id, ViPInt16 antiAliasPtr);

ViStatus age1439_input_coupling(ViSession id, ViInt16 coupling);

ViStatus age1439_input_coupling_get(ViSession id, ViPInt16 couplingPtr);

ViStatus age1439_input_range(ViSession id, ViInt16 range);

ViStatus age1439_input_range_get(ViSession id, ViPInt16 rangePtr);

ViStatus age1439_input_signal(ViSession id, ViInt16 signal);

ViStatus age1439_input_signal_get(ViSession id, ViPInt16 signalPtr);

ViStatus age1439_input_signal_path(ViSession id, ViInt16 signalPath);

ViStatus age1439_input_signal_path_get(ViSession id, ViPInt16 signalPathPtr);

Parameters

is the VXI instrument session pointer returned by the age1439_init function.

antiAlias

determines whether or not to use the built-in analog anti-alias filter. This filter only applies to

baseband measurements. In IF mode the antialias filter is always turned on. The antialias

parameters always set the baseband anti-alias filter regardless of the signal path.

AGE1439_ANTIALIAS_ON inserts a sharp-cutoff 36 MHzlow-pass filter ahead of the analog-

to-digital converter. You should leave the filter on at all times to insure band-limited, anti-aliased

data.

AGE1439_ANTIALIAS_OFF bypasses the low-pass filter.

antiAliasPtr

coupling

points to the current value of the antiAlias parameter in the current signal path. Therefore, in IF

mode this function always returns AGE1439_ANTIALIAS_ON.

specifies the ac or dc coupling mode of the input. This parameter applies to the baseband input

configuration only.

AGE1439_DC connects the input directly to the 50 Ohm buffer amplifier. Although dc coupling

can be selected in both baseband and IF signalPath, it has no effect in the IF path because the

signal is ac coupled after the input section.

141

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

AGE1439_ADC inserts a 0.2 µF capacitor between the input connector and the 50 Ohm buffer

amplifier.

couplingPtr

range

points to the current value of the coupling parameter for an Agilent E1439 or group of

Agilent E1439s.

is a range index number which is transformed to a full scale voltage value. This function always

sets only the IF signal path range even if signalPath is set to AGE1439_BB_PATH. In baseband

mode the range is fixed at -21 dBm.

AGE1438_RANGE_MAX sets the range to the maximum allowable.

AGE1439_RANGE_MIN sets the range to the minimum allowable.

Signal inputs with an absolute value larger than full scale generate an ADC overflow error.

Range values are as follows.

Full Scale

(dBm)

Full Scale

Voltage (Vp)

Variable

Range Index

1.26

1.12

.891

.794

.708

.631

.562

.501

.447

.398

.355

.316

.282

.251

.224

.12

−1

−2

−3

−4

−5

−6

−7

−8

−9

−10

−11

−12

−13

−14

.178

.159

.141

.126

.112

.089

.0794

.0708

.0631

142

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

Full Scale

(dBm)

Full Scale

Voltage (Vp)

Variable

Range Index

−15

−16

−17

−18

−19

−20

−21

−22

−23

−24

−25

−26

−27

−28

−29

−30

−31

−32

−33

−34

−35

−36

.0562

.0501

.0447

.0398

.0355

.0316

.0282

.0251

.0224

.02

.0178

.0158

.0141

.0126

.0112

.01

.0089

.0079

.0071

.0063

.0056

.005

Note

These values are approximate. For more accuracy use age1439_data_scale_get.

rangePtr

points to the current value of the range parameter for the selected signalPath. For the AGE1439_

BB_PATH signalPath the returned range is always AGE1439_RANGE_15.

signal

determines whether or not the input signal is connected to the input amplifier.

AGE1439_SIGNAL_ON attaches the input signal to the 50 Ohm buffer amplifier.

AGE1439_SIGNAL_OFF redirects the input signal to a dummy 50 Ohm load, and feeds the

buffer amplifier from an internally grounded 50 Ohm source resistance. The signal OFF setting is

useful for making reference measurements without the signal applied. When using ac coupling the

0.2 µF capacitor remains between the input connector and its 50 Ohm termination.

signalPtr

points to the current value of the signal parameter.

signalPath

Selects baseband AGE1439_BB_P A T H or IF signal path AGE1439_IF_P A T H. The IF path passes

frequencies between 52 and 88 MHz. The range values above only apply to the IF signal path.

signalPathPtr

points to the current value of signalPath

143

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

Comments

To ensure full alias-free operation the analog anti-alias filter should be ON unless the application

inherently bandlimits the input signal to less than fs/2. The analog anti-alias filter has a fixed

bandwidth and thus is fully effective only when fs ≥ 100 MHz. If a slower external ADC clock is

used, an additional analog filter of the appropriate bandwidth may be required for full alias

protection.

When using the analog anti-alias filter, you may need to set the range parameter higher than the

actual range of the input signal. The reason for this is that step changes of input voltage cause an

overshoot and ringing response at the output of the anti-alias filter. The peak overshoot actually

exceeds the input voltage step by about 20%. The range setting must accommodate this overshoot

to avoid an ADC overflow.

Return Value

AGE1439_SUCCESS indicates that a function was successful.

Values other than AGE1439_SUCCESS indicate an error condition or other important status

condition. To determine the error message, pass the return value to “age1439_error_message” on

page 102.

auto” on page 137, “age1439_input_range_convert” on page 138, “age1439_data_scale_get” on

page 89

144

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_interrupt_restore

Restores the interrupt masks to the setting last programmed with age1439_interrupt_setup.

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_interrupt_restore(ViSession id);

Description

The interrupt masks set by the age1439_interrupt_setup function are cleared during the interrupt

acknowledge cycle. This function restores the cleared interrupt masks.

Parameters

is the VXI instrument session pointer returned by the age1439_init function.

Return Value

AGE1439_SUCCESS indicates that a function was successful.

Values other than AGE1439_SUCCESS indicate an error condition or other important status

condition. To determine the error message, pass the return value to “age1439_error_message” on

page 102.

145

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_interrupt_setup

Sets both interrupt parameters. This description also includes information on the following

functions which query the interrupt parameters individually:

age1439_interrupt_mask_get gets the interrupt event mask

age1439_interrupt_priority_get gets the VME interrupt line

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_interrupt_setup(ViSession id, ViInt16 intrNum, ViInt16 priority, ViInt16

mask);

ViStatus age1439_interrupt_mask_get(ViSession id, ViInt16 intrNum, ViPInt16 maskPtr);

ViStatus age1439_interrupt_priority_get(ViSession id, ViInt16 intrNum, ViPInt16

priorityPtr);

Description

An Agilent E1439 has two independent interrupt generators, each capable of interrupting on one

of the seven VME interrupt lines when a status condition specified by a mask occurs.

age1439_interrupt_setup sets the interrupt mask, priority and which of the two interrupt

generators on the Agilent E1439 is to be used. The remaining age1439_interrupt_ functions

query the mask and priority individually.

Parameters

is the VXI instrument session pointer returned by the age1439_init function.

is the number of the interrupt generator. The only values accepted are 0 and 1.

intrNum

mask

specifies the mask of events on which to interrupt. VXIbus specifications only allow the 8 most

significant bits in the status register, bits 8 to 15, to be set as interrupts. Because of this, the

desired mask value must be right shifted 8 positions. In the E1439, bits 14 and 15 of the status

generate interrupts.

priority

specifies which of the seven VME interrupt lines to use. The only legal values are 0 through 7.

Specifying 0 turns the interrupt off, while 7 is the highest priority.

maskPtr priorityPtr contain the current value of the interrupt mask and priority parameters.

Comments

Interrupt masks are cleared during the interrupt acknowledge cycle. Therefore, the command

must be sent again or restored with “age1439_interrupt_restore” on page 145 in order to generate

further interrupts.

Example

The program interrupt.exe described in the example programs provides an example of how to use

interrupts correctly.

146

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

Return Value

AGE1439_SUCCESS indicates that a function was successful.

Values other than AGE1439_SUCCESS indicate an error condition or other important status

condition. To determine the error message, pass the return value to “age1439_error_message” on

page 102.

“age1439_attrib_get” on page 74, “age1439_interrupt_restore” on page 145

147

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_lbus_mode

Sets the local bus transmission mode (Agilent E1439D only) . This description also includes the

query:

age1439_lbus_mode_get gets the current local bus mode.

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_lbus_mode(ViSession id, ViInt16 lbusMode);

ViStatus age1439_lbus_mode_get(ViSession id, ViPInt16 lbusModePtr);

Description

age1439_lbus_mode sets the local bus to either generate, append, insert or pipeline data. The data

port must be set to the local bus with the age1439_data_port function (See “age1439_data_

setup” on page 90) before these modes take effect.

Parameters

is the VXI instrument session pointer returned by the age1439_init function.

lbusMode

selects the transmission mode of the local bus when it is enabled by the age1439_data_port

function.

AGE1439_GENER A T E forces the module at id to generate data only, not passing through data

from other modules on the local bus.

AGE1439_APPEND causes the Agilent E1439 to pass data through from modules on its left and

append its data to the end.

AGE1439_INSERT causes the Agilent E1439 to place its data on the local bus and then pass data

through from modules on its left.

AGE1439_PIPELINE causes the Agilent E1439 to pipe data through from modules on its left

without appending or inserting its own data. The state of this parameter is unaffected by switching

back and forth between the local bus and the VME backplane with the age1439_data_port

function.

Module(s) to Left

E1438/E1439

Module to Right

GENERATE

INSERT

APPEND

PIPELINE

148

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

lbusModePtr

points to the current value of the lbusMode parameter.

Return Value

AGE1439_SUCCESS indicates that a function was successful.

Values other than AGE1439_SUCCESS indicate an error condition or other important status

condition. To determine the error message, pass the return value to “age1439_error_message” on

page 102.

149

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_lbus_reset

Resets the local bus (Agilent E1439D only) . This description also includes the query:

age1439_lbus_reset_get gets the current local bus reset state

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_lbus_reset(ViSession id, ViInt16 lbusReset);

ViStatus age1439_lbus_reset_get(ViSession id, ViPInt16 lbusResetPtr);

Description

In order to avoid glitches in the local bus data, the local bus interface has strict requirements as to

the order in which modules in a VXI mainframe have their local bus interface reset. Upon power-

up or whenever any single module in the mainframe is put into a reset state, all modules should be

placed into the reset state from left to right. Then all modules can be take out of reset from left to

right.

Parameters

is the VXI instrument session pointer returned by the age1439_init function.

puts the Agilent E1439's local bus into reset or takes it out of reset.

lbusReset

AGE1439_LBUS_RESET_ON puts the Agilent E1439's local bus into reset while AGE1439_

LBUS_RESET_OFF takes the Agilent E1439 out of reset.

lbusResetPtr

points to the current value of the lbusReset parameter.

Return Value

AGE1439_SUCCESS indicates that a function was successful.

Values other than AGE1439_SUCCESS indicate an error condition or other important status

condition. To determine the error message, pass the return value to “age1439_error_message” on

page 102.

150

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_meas_control

Initiates and controls measurements in multi-module systems.

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_meas_control(ViSession id, ViInt16 idle, ViInt16 sync);

Description

age1439_meas_control explicitly controls the measurement state.

Parameters

is the VXI instrument session pointer returned by the age1439_init function.

idle

selects the condition of the Idle state.

AGE1439_ASSERT holds the module in the Idle state.

AGE1439_RELEASE reverses a previous AGE1439_ASSERT or ensures that no forced Idle is

active.

sync

selects the state of the sync signal.

age1439_meas_control also changes the state of the Sync signal, which is used to arm or trigger

an Agilent E1439 module. In systems containing multiple Agilent E1439 modules the Sync signal

is used to arm or trigger all modules simultaneously, and also to synchronize decimation counters

and local oscillators among the Agilent E1439 modules.

AGE1439_ASSERT causes the module to assert the Sync signal.

AGE1439_RELEASE causes the module to release the Sync signal. When parameters of the

age1439_clock_setup function which enable sync output are selected the module shares the sync

signal with other Agilent E1439 modules. If any one of these modules asserts this shared Sync

signal it then becomes asserted for all of them. All modules must release it before the shared Sync

signal is released. Asserting then releasing the Sync line is used to start a measurement, load local

oscillator values, or take a digital filter out of reset. These situations require a Sync line transition

but do not require that the Sync line be held in a asserted state.

Note

When the Sync line is asserted, it remains asserted for an adequate number of ADC clock cycles

to ensure that the signal effect propagates to all the modules in the system. You can determine

when the command is completed by looking as the Sync/Idle Complete bit in the Status Register.

Any command that halts the current measurement (See “Commands which halt active

measurements” on page 198) also releases the forced Idle and Sync controls. If

you want to hold a module in Idle after one of these commands you must call

age1439_meas_control again after the command that halted the current measurement.

Comments

See “The measurement loop” in chapter 3 for details on how a measurement progresses through

the four states.

151

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

This function performs the following sequence:

1. Waits for both the AGE1439_STATUS_HARDWARE_SET and AGE1439_STATUS_

SYNC_COMPLETE bits to be set.

2. Returns AGE1439_STATUS_WAIT_TIMEOUT if more than three seconds elapses in

step 1.

3. Returns AGE1439_SETUP_ERROR if AGE1439_STATUS_SETUP_ERROR was

detected in step 1.

4. Writes data to the control register as prescribed by arguments to the function.

5. Clears the overload count maintained by the API. See “Comments on Overload” on

page 160

6. Waits for AGE1439_STATUS_SYNC_COMPLETE.

7. Returns AGE1439_SYNC_NOT_COMPLETE if more than three seconds elapse in step

6, otherwise it returns AGE1439_SUCCESS.

Special conditions prevail during the Measure state. If programmed for block mode operation in

the Measure state, the module asserts the Sync signal (regardless of the age1439_meas_control

sync parameter setting) until a complete block of data has been collected and is available to the

I/O port. When the shared Sync signal is released, indicating that all block mode data collection is

finished, all block mode modules move synchronously to the idle state. In continuous mode the

module releases the Sync signal immediately after moving into the measure state. This allows the

age1439_meas_control function to manipulate the Sync signal to cause synchronous changes to

LO frequency while a continuous measurement is in progress. In continuous mode a module

moves to the idle state only if explicitly programmed to do so or whenever the FIFO data buffer

overflows.

In addition to controlling the progression through the four module states, the Sync signal is used

to allow for synchronizing the decimation counters and local oscillators of multiple

Agilent E1439 modules and synchronizing the fs/10 clock during external sampling. This is done

by calling age1439_filter_sync and/or age1439_frequency_sync prior to asserting Sync with

age1439_meas_control. This is normally done with the module in the Idle state; however, the

center frequency can also be changed in the Measure state with age1439_frequency_sync if the

modules are all programmed for continuous (non-block mode) data collection.

If all modules in a multi-module system are in the Idle state when the age1439_meas_control

sync parameter is asserted, the LO frequency is updated and the next measurement is armed. If all

modules are in the measurement state in continuous mode, the LO frequency is synchronously

updated, and the measurement continues. In continuous mode you should ensure that all modules

are in the same state, either the Idle state or the Measure state, before using age1439_meas_

control to assert Sync. Otherwise some modules re-arm while others continue the current

measurement. In block mode the sync assertion is ignored unless all modules are in the Idle state.

The age1439_meas_control function assures that a single module is in a valid state by checking

that the hardware complete and sync valid bits in the status register are both true. In synchronous

multi-module systems you should use the age1439_wait function for each module to assure a

valid state in non-master modules within a synchronous group.

In the case of systems made up of multiple mainframes you must be aware that only modules in

the mainframe containing the master module, as defined by age1439_clock_setup, may assert

sync. Any sync asserted in other mainframes is ignored by modules in all mainframes. This is true

only for rear panel sync. Front panel sync is not sensitive to master mainframe designation.

152

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

Example

The program multichan.exe described in the example programs provides an example of how to

correctly set up a multi-module measurement using age1439_meas_control to initiate state

transitions.

Return Value

AGE1439_SUCCESS indicates that a function was successful.

Values other than AGE1439_SUCCESS indicate an error condition or other important status

condition. To determine the error message, pass the return value to “age1439_error_message” on

page 102.

“age1439_init” on page 132, “age1439_status_get” on page 176, “age1439_data_setup” on

page 90, “age1439_filter_sync” on page 123, “age1439_frequency_setup” on page 128,

“age1439_clock_setup” on page 78, “age1439_wait” on page 189, “age1439_read” on page 159,

“Managing multiple modules” in chapter 3, “The measurement loop” in chapter 3, “Using clock

and sync” in chapter 3

153

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_meas_init

Initiates a measurement without first checking for valid hardware setup.

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_meas_init(ViSession id);

Description

age1439_meas_init provides an easy way to initiate a measurement in a single module.

Note

This command is slightly faster and slightly less robust than age1439_meas_start.

Parameters

is the VXI instrument session pointer returned by the age1439_init function.

Comments

See “The measurement loop” in chapter 3 for details on how a measurement progresses through

the four states.

This function performs the following sequence:

1. Clears the overload count maintained by the API. See “Comments on Overload” on

page 160

2. Moves the module to the Idle state.

3. Generates a Sync transition which moves the module to the Arm state.

4. Always returns AGE1439_SUCCESS (no error conditions can be detected by this

function).

Return Value

This function always returns AGE1439_SUCCESS and does not return any error conditions.

“age1439_meas_start” on page 155, “age1439_meas_control” on page 151, “age1439_status_

get” on page 176, “age1439_read” on page 159

154

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_meas_start

Checks for valid hardware setup and then initiates a measurement.

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_meas_start(ViSession id);

Description

age1439_meas_start provides an easy way to initiate a measurement in a single module system.

This command waits for a valid hardware setup, then, if the instrument is in a valid state, performs

the equivalent of age1439_meas_init.

Parameters

is the VXI instrument session pointer returned by the age1439_init function.

Comments

See “The measurement loop” in chapter 3 for details on how a measurement progresses through

the four states.

This function performs the following sequence:

1. Waits for AGE1439_STATUS_HARDWARE_SET bit to be set.

2. Returns AGE1439_START_ERROR if more than three seconds elapses in step 1.

3. Returns AGE1439_SETUP_ERROR if AGE1439_STATUS_SETUP_ERROR was

detected in step 1.

4. Performs age1439_meas_init and returns AGE1439_SUCCESS.

Example

The program acvolts.exe described in the example programs provides an example of how to

initiate a very simple measurement using age1439_meas_start.

Return Value

AGE1439_SUCCESS indicates that a function was successful.

Values other than AGE1439_SUCCESS indicate an error condition or other important status

condition. To determine the error message, pass the return value to “age1439_error_message” on

page 102.

page 151, “age1439_meas_init” on page 154, “age1439_status_get” on page 176, “age1439_

read” on page 159, “The measurement loop” in chapter 3

155

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_meas_status_get

Returns the current measurement status.

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_meas_status_get(ViSession id, ViPInt16 readValid, ViPInt16 blockReady,

ViPInt16 overload);

Description

This function is useful in determining the measurement status of a module when using the fiber

interface. The advantage of using this function over age1439_status_get, is that this function

decodes the measurement-related status register bits. This function returns the current

measurement status, which is represented by one of the four following values that are encoded in

the bottom two bits of the status register:

Status Bit

Definition

Values

0-1

AGE1439_S T A T US_MEAS_ARM_WAIT

AGE1439_STATUS_MEAS_IDLE

AGE1439_STATUS_MEAS_IN_PROGRESS

AGE1439_S T A T US_MEAS_TRIG_WAIT

AGE1439_NO_DATA_WAITING_FOR_ARM

AGE1439_NO_DATA_MEASUREMENT_PAUSED

AGE1439_NO_DATA_MEASUREMENT_IN_PROGRESS

AGE1439_NO_DATA_WAITING_FOR_TRIGGER

Parameters

is the VXI instrument session pointer returned by the age1439_init function.

returns the state of the AGE1439_ST A T US_READ_V A LID status register bit.

returns the state of the AGE1439_ST A T US_BLOCK_READY status register bit.

returns the state of the AGE1439_ST A T US_OVERLOAD status register bit.

readValid

blockReady

overload

Return Value

The return value of this function is the current measurement status, as represented by one of four

numeric values that are encoded in the bottom two bits of the status register shown in the table

above.

on page 176, “age1439_read” on page 159, “The measurement loop” in chapter 3

156

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_options_get

Identifies module options.

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_options_get(ViSession id, ViChar options[]);

Description

Returns a list of options separated by commas.

Parameters

is the VXI instrument session pointer returned by the age1439_init function.

options

returns a string of up to 256 characters. For example "144" indicates option 144 (memory) is

installed.

Note

For this parameter you must allocate a character array of at least 256 characters AGE1439_STR_

LEN_MIN, including the null byte, prior to calling this function in any programming language.

Return Value

AGE1439_SUCCESS indicates that a function was successful.

Values other than AGE1439_SUCCESS indicate an error condition or other important status

condition. To determine the error message, pass the return value to “age1439_error_message” on

page 102.

See Also

157

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_product_id_get

Gets the module’s product identification string.

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_product_id_get(ViSession id, ViChar productId[]);

Parameters

is the VXI instrument session pointer returned by the age1439_init function.

returns the module ID such as E1439C or E1439D.

productId

Note

For this parameter you must allocate a character array of at least 256 characters AGE1439_STR_

LEN_MIN, including the null byte, prior to calling this function in any programming language.

Return Value

AGE1439_SUCCESS indicates that a function was successful.

Values other than AGE1439_SUCCESS indicate an error condition or other important status

condition. To determine the error message, pass the return value to “age1439_error_message” on

page 102.

See Also

page 155, “age1439_meas_init” on page 154, “age1439_meas_control” on page 151, “age1439_

158

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_read

Reads scaled 32-bit floating-point data from the VME backplane register. This description also

includes the following function:

age1439_read64 reads scaled 64-bit floating-point data, implemented specifically for

VEE applications.

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_read(ViSession id, ViReal32 data[], ViInt32 sampleCount, ViPInt16

overloadPtr);

ViStatus age1439_read64(ViSession id, ViReal64 data[], ViInt32 sampleCount, ViPInt16

overloadPtr);

Description

age1439_read returns a block of floating-point data from the Agilent E1439 that has been scaled

to be in volts. The function waits for a block of data to be ready before attempting to read the

block.

These functions can only read data from the VME backplane register. The data port of the

Agilent E1439 must be set to AGE1439_VME by the age1439_data_port function for these

functions to be effective.

Note

When using this function, INSTR_REAL32 should be defined when compiling C/C++ programs.

To do this, in the Microsoft Visual Development environment, go to Project Settings, select the

C/C++ tab, and add INSTR_REAL32 to the preprocessor definitions. In a makefile or on a

command line, supply the option "/D INSTR_REAL32" to cl.exe. See the acvolts.exe example

programs.

This function performs the following sequence:

1. Checks for AGE1439_STATUS_READ_BLOCK and AGE1439_STATUS_

OVERLOAD.

2. If a block of data is NOT ready:

A. The function immediately returns the current measurement state.

3. If a block of data IS ready:

A. Data is read from the module.

B. It is converted to a floating point number and scaled.

C. The function returns any errors that were encountered when reading the data.

D. The value of the overload argument is set to indicate whether any overloads have

occurred since the last successful read.

159

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

Parameters

is the VXI instrument session pointer returned by the age1439_init function.

data

is a pointer to the array into which the floating point data is to be placed. Be sure to allocate

sufficient storage space at this location to hold the full data record as determined by the

sampleCount parameter. Note that when the module is set to complex data type, the output data

record contains 2 × sampleCount floating point values. For real data the record contains

sampleCount floating point values.

sampleCount

for age1439_read sampleCount is the number of real or complex data values to read. Real data is

one 32-bit floating point value. Complex data is made up of two 32-bit floating point values

comprising the real and imaginary values.

for age1439_read64 sampleCount is the number of real or complex data values to read. Real data

is one 64-bit floating point value. Complex data is made up of two 64-bit floating point values

comprising the real and imaginary values.

This should never be set larger than the blocksize parameter set in the age1439_data_blocksize

function. In continuous data collection mode, sampleCount should be set equal to blocksize to

ensure that the entire data block is read out.

overloadPtr

returns an overload indicator. The way to properly use the overload argument for the age1439_

read or age1439_read64 function is this:

1. Set up the hardware.

2. Call age1439_meas_start.

3. Call age1439_read or age1439_read64.

If data is not available, the read function returns immediately with one of the following return values, and

the overload indication is AGE1439_OFF:

AGE1439_NO_DATA_MEASUREMENT_IN_PROGRESS

AGE1439_NO_DATA_MEASUREMENT_PAUSED

AGE1439_NO_DATA_WAITING_FOR_TRIGGER

AGE1439_NO_DATA_WAITING_FOR_ARM

When data is available, AGE1439_SUCCESS is returned and the overload value reflects whether an

overload was encountered for the given data block.

4. In continuous mode, subsequent data blocks can be read by calling a age1439_

read or age1439_read64 function again (age1439_meas_start should not be called

again).

5. When used in this way, an overload indication is given for each and every

data block read in block mode. In continuous mode the overload indicator

only means there was an overload sometime after calling age1439_meas_start.

Comments on Overload

Since reading the status register clears the overload bit, overloads are tracked at the API level.

In block mode, you receive the overload indication on a block-by block basis by calling age1439_

meas_start and age1439_read in sequence.

In continuous mode, depending on the effective sample rate of the instrument and how often data

is read, an overload indication returned by age1439_read may or may not correspond to the data

returned. The overload indication only means that an overload has occurred since the most recent

160

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

call to age1439_meas_init, age1439_meas_init, or age1439_read, whichever was issued last.

You should be aware that it is likely that the reported overload occurred in data which has been

acquired in the module, is waiting in the FIFO, but has not yet been read.

Return Value

AGE1439_SUCCESS

AGE1439_NO_DATA_MEASUREMENT_IN_PROGRESS

AGE1439_NO_DATA_MEASUREMENT_PAUSED

AGE1439_NO_DATA_WAITING_FOR_TRIGGER

AGE1439_NO_DATA_WAITING_FOR_ARM

status_get” on page 176, “The measurement loop” in chapter 3

161

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_read_raw

Reads raw, unscaled data from the VME backplane register.

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_read_raw(ViSession id, ViInt16 data[], ViInt32 wordCount, ViPInt16

overloadPtr);

Description

age1439_read_raw returns a block of raw, unscaled integer data from the FIFO.

This function can only read data from the VME backplane register. The data port of the

Agilent E1439 must be set to AGE1439_VME by the age1439_data_port function for this

function to be effective.

This function performs the following sequence:

1. Checks for AGE1439_STATUS_READ_BLOCK and AGE1439_STATUS_

OVERLOAD.

2. If there is an overload then the overload count maintained by the API is incremented.

3. If a block of data is NOT ready:

A. the function immediately returns the current measurement state and

B. the value of the overload argument is set to AGE1439_OFF.

4. If a block of date IS ready:

A. data is read from the module,

B. the function returns any errors that were encountered when reading the data,

C. the value of the overload argument is set to AGE1439_ON, and

D. the overload count maintained by the API is set to zero.

Parameters

is the VXI instrument session pointer returned by the age1439_init function.

data

is a pointer to the array into which the raw data record is to be placed. Be sure to allocate

sufficient storage space to hold the full data record as determined by the wordCount parameter.

wordCount

wordCount is the total number of data values to read into the data array from the Agilent E1439

output FIFO. The maximum wordCount depends on the blocksize, data type, and data resolution

parameter settings.

162

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

Resolution

(bits)

Data type

Words per sample

REAL

COMPLEX

In continuous data collection mode, wordCount should be set equal to the maximum possible

wordCount to ensure that the entire data block is read out.

overloadPtr

returns an overload indicator. See “Comments on Overload” on page 160. The way to properly

use the overload argument for the age1439_read_raw function is this:

1. Set up the hardware.

2. Call age1439_meas_start.

3. Call age1439_read_raw.

If data is not available, the read function returns immediately with one of the following return values, and

the overload indication is AGE1439_OFF:

AGE1439_NO_DATA_MEASUREMENT_IN_PROGRESS

AGE1439_NO_DATA_MEASUREMENT_PAUSED

AGE1439_NO_DATA_WAITING_FOR_TRIGGER

AGE1439_NO_DATA_WAITING_FOR_ARM

When data is available, AGE1439_SUCCESS is returned and the overload value reflects whether an

overload was encountered for the given data block.

4. In continuous mode, subsequent data blocks can be read by calling the

age1439_read_raw function again (age1439_meas_start should not be called

again).

5. When used in this way, an overload indication is given for each and every

data block read in block mode. In continuous mode the overload indicator

only means there was an overload sometime after calling age1439_meas_start.

Note

The primary purpose of the age1439_read_raw function is to provide the fastest possible way to

read blocks of data from the module. Since this command does not perform data scaling after

reading data it may save 10-20% of the overall age1439_read time, depending on the host

computer in use. The resulting data ordering is dependent on the data type and resolution. The

array may be cast as a long before reading the data to provide whole words.

Example

A declaration in the Front Panel example program can be changed to exercise age1439_read_

raw() in frmMain of e1439.vbp:

Const constFreqCentRaw = False ’when TRUE, use age1439_read_raw()

’instead of age1439_read

Return Value

AGE1439_SUCCESS

AGE1439_NO_DATA_MEASUREMENT_IN_PROGRESS

163

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

AGE1439_NO_DATA_MEASUREMENT_PAUSED

AGE1439_NO_DATA_WAITING_FOR_TRIGGER

AGE1439_NO_DATA_WAITING_FOR_ARM

“age1439_data_setup” on page 90, “The measurement loop” in chapter 3

164

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_reference_clock

Selects the source of the reference clock. This description also includes the query function:

age1439_reference_clock_get

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_reference_clock(ViSession id, ViInt16 refClock);

ViStatus age1439_reference_clock_get(ViSession id, ViPInt16 refClockPtr);

Note

This command should be used only for specialized custom clock requirements. Most useful clock

setups can be supplied by age1439_clock_setup.

Parameters

is the VXI instrument session pointer returned by the age1439_init function.

refClock

AGE1439_FRONT_PANEL_CLOCK specifies the front panel clock be used as the reference

clock. Use this in conjunction with age1439_front_panel_clock_input.

AGE1439_VXI_CLOCK specifies that the VXI (rear panel) clock be used as the reference clock.

Use this in conjunction with age1439_vxi_clock_output.

refClockPtr

Returns a pointer to the current value of refClock.

Return Value

AGE1439_SUCCESS indicates that a function was successful.

Values other than AGE1439_SUCCESS indicate an error condition or other important status

condition. To determine the error message, pass the return value to “age1439_error_message” on

page 102.

“age1439_front_panel_clock_input” on page 131, “age1439_vxi_clock_output” on page 188,

“age1439_reference_prescaler” on page 166, “Using clock and sync” in chapter 3

165

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_reference_prescaler

Selects prescaling of the reference clock. This description also includes the query function:

age1439_reference_prescaler_get

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_reference_prescaler(ViSession id, ViInt16 refPrescaler);

ViStatus age1439_reference_prescaler_get(ViSession id, ViPInt16 refPrescalerPtr);

Note

This command should be used only for specialized custom clock requirements. Most useful clock

setups can be supplied by age1439_clock_setup.

Description

This function should generally be left in the default mode. The alternate mode applies to a

different model of the module.

Parameters

is the VXI instrument session pointer returned by the age1439_init function.

refPrescaler

AGE1439_PRESCALE_BY_1 divides the reference clock by one.

AGE1439_PRESCALE_BY_4 divides the reference clock by four.

refPrescalerPtr

Returns a pointer to the current value of refPrescalerPtr.

Return Value

AGE1439_SUCCESS indicates that a function was successful.

Values other than AGE1439_SUCCESS indicate an error condition or other important status

condition. To determine the error message, pass the return value to “age1439_error_message” on

page 102.

“age1439_reference_clock” on page 165, “Using clock and sync” in chapter 3

166

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_reset

Places the module in a known state.

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_reset(ViSession id);

Description

age1439_reset returns the module’s internal data structures to the power-up state but does not

reset the hardware. This function can be called separately by this function, or may be selected in

conjunction with the age1439_init function.

Note

Calling this function halts any measurement or fiber transfer.

Parameters

is the VXI instrument session pointer returned by the age1439_init function.

Comments

The reset values are listed in “Default values” on page 201.

This command takes about 100 ms to complete.

Return Value

AGE1439_SUCCESS indicates that a function was successful.

Values other than AGE1439_SUCCESS indicate an error condition or other important status

condition. To determine the error message, pass the return value to “age1439_error_message” on

page 102.

“age1439_reset_hard” on page 168

167

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_reset_hard

Resets the module to the power-up state.

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_reset_hard(ViSession id);

Description

age1439_reset_hard resets the module’s firmware and hardware including the processor.

Parameters

is the VXI instrument session pointer returned by the age1439_init function.

Comments

The reset values are listed in “Default values” on page 201. In addition, the hardware registers,

including the save register, are reset to the power-up state.

This command takes about 15 seconds to complete.

Return Value

AGE1439_SUCCESS indicates that a function was successful.

Values other than AGE1439_SUCCESS indicate an error condition or other important status

condition. To determine the error message, pass the return value to “age1439_error_message” on

page 102.

“age1439_reset” on page 167

168

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_revision_query

Returns strings that identify the date of the firmware revision.

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_revision_query(ViSession id, ViChar driverRev[], ViChar instrRev[]);

Parameters

is the VXI instrument session pointer returned by the age1439_init function.

returns the date and time of the module's driver revision in the form:

driverRev

a.dd.dd OPERS Ddd Mmm Date hh:mm:ss YYYY where Ddd is the

abbreviated day of the week and Date is an integer from 1 to 31

instrRev

returns the date, time, and board number of the module's firmware revision in the form:

mm-dd-yyyy hh:mm 01Bd: xxxx; 02Bd:xxxx where xxxx is a

manufacturer’s date code used for service purposes.

Note

For this parameter you must allocate a character array of at least 256 characters AGE1439_STR_

LEN_MIN, including the null byte, prior to calling this function in any programming language.

Return Value

AGE1439_SUCCESS indicates that a function was successful.

Values other than AGE1439_SUCCESS indicate an error condition or other important status

condition. To determine the error message, pass the return value to “age1439_error_message” on

page 102.

See Also

169

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_self_test

Performs a self-test and returns the result of that self test.

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_self_test(ViSession id, ViPInt16 testResult, ViChar testMessage[]);

Description

The Agilent E1439 self test includes the following tests:

•

Digital: verifies the integrity of paths from LO chip through the filters to the memory

controller.

•

Serial: verifies the integrity of serial setup path for each board.

Memory: fills the entire DRAM then verifies that all the data is correct.

Analog: verifies that auto zero adjust is working and that the input is triggering.

Clock: verifies that the oscillator is working properly.

Fiber: performs five-second internal fiber verification.

Parameters

is the VXI instrument session pointer returned by the age1439_init function.

points to the self test status message string up to 256 characters long.

testMessage

Note

For this parameter you must allocate a character array of at least 256 characters AGE1439_STR_

LEN_MIN, including the null byte, prior to calling this function in any programming language.

testResult

points to the instrument numeric error code.

Possible test result values are:

Error

Message

Error Code

(hex)

Self Test

Status Message

AGE1439_ST_SUCCESS

0x000

0x001

0x002

0x004

0X008

0x020

0x040

0x080

self test successful

hardware failure

AGE1439_ST_HARDWARE_FAIL

AGE1439_ST_SERIAL1_FAIL

AGE1439_ST_SERIAL2_FAIL

AGE1439_ST_CLOCK_FAIL

AGE1439_ST_MEMORY_FAIL

AGE1439_ST_DIGITAL1_FAIL

AGE1439_ST_DIGITAL2_FAIL

serial 1 test failed

serial 2 test failed

95 MHz clock test failed

memory test failed

real data path failed

complex data path failed

170

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

Error

Error Code

Self Test

Message

(hex)

Status Message

AGE1439_ST_ANALOG_FAIL

AGE1439_ST_FIBER_FAIL

0x100

0x200

0x4000

analog test failed

fiber test failed

AGE1439_ST_EXECUTION_ERR

self-test execution error

Note

The required completion time for self-test is up to 25 seconds depending on the amount of

memory in the module.

Calling this function halts any measurement or fiber transfer.

Return Value

AGE1439_SUCCESS indicates that a function was successful.

Values other than AGE1439_SUCCESS indicate an error condition or other important status

condition. To determine the error message, pass the return value to “age1439_error_message” on

page 102.

171

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_serial_number

Sets the serial number of the module. This description also includes the query function:

age1439_serial_number_get

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_serial_number(ViSession id, ViChar serialNum[]);

ViStatus age1439_serial_number_get(ViSession id, ViChar serialNum[]);

Caution

This command is to be used for repair purposes only.

Description

This command is used to reassign a serial number after a module has been serviced.

Parameters

is the VXI instrument session pointer returned by the age1439_init function.

sends or gets a serial number of less than 16 characters

serialNum

Note

For this parameter you must allocate a character array of at least 256 characters AGE1439_STR_

LEN_MIN, including the null byte, prior to calling this function in any programming language.

Return Value

AGE1439_SUCCESS indicates that a function was successful.

Values other than AGE1439_SUCCESS indicate an error condition or other important status

condition. To determine the error message, pass the return value to “age1439_error_message” on

page 102.

See Also

“age1439_front_panel_clock_input” on page 131, “Using clock and sync” in chapter 3

172

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_smb_clock_output

Specifies which clock to output from the SMB clock connectors. This description also includes

the query function:

age1439_smb_clock_output_get

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_smb_clock_output(ViSession id, ViInt16 smbClock);

ViStatus age1439_smb_clock_output_get(ViSession id, ViPInt16 smbclockPtr);

Note

This command should be used only for specialized custom clock requirements. Most useful clock

setups can be supplied by age1439_clock_setup.

Description

This function selects the source of the output for the front panel SMB clock connectors.

Parameters

is the VXI instrument session pointer returned by the age1439_init function.

smbClock

AGE1439_BNC_CLOCK specifies that the BNC input be output from the SMB clock

connectors.

AGE1439_CLOCK_OFF specifies no output from the SMB clock connectors.

AGE1439_DIVIDED_ADC_CLOCK specifies that the divided ADC clock be output from the

SMB clock connectors.

AGE1439_VXI_CLOCK specifies that the VXI clock be output from the SMB clock connectors.

smbClockPtr

Returns a pointer to the current value of smbClock.

Return Value

AGE1439_SUCCESS indicates that a function was successful.

Values other than AGE1439_SUCCESS indicate an error condition or other important status

condition. To determine the error message, pass the return value to “age1439_error_message” on

page 102.

173

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_state_recall

Recalls a module’s previous instrument state.

age1439_state_recall

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_state_recall(ViSession id);

Description

This function aborts any active measurement and recalls the instrument state previously saved by

age1439_state_save. This function requires >100 ms to complete.

Parameters

is the VXI instrument session pointer returned by the age1439_init function.

Return Value

AGE1439_SUCCESS indicates that a function was successful.

Values other than AGE1439_SUCCESS indicate an error condition or other important status

condition. To determine the error message, pass the return value to “age1439_error_message” on

page 102.

“age1439_state_save” on page 175

174

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_state_save

Saves the module’s current instrument state.

age1439_state_save

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_state_save(ViSession id);

Description

This function may be used to save a state to which you want to return later. age1439_reset does

not change a saved state. The state is not saved to non-volatile RAM.

Note

The saved state is lost by issuing the following commands: age1439_input_range_auto, age1439_

input_autozero, age1439_self_test, and age1439_reset_hard.

Parameters

is the VXI instrument session pointer returned by the age1439_init function.

Return Value

AGE1439_SUCCESS indicates that a function was successful.

Values other than AGE1439_SUCCESS indicate an error condition or other important status

condition. To determine the error message, pass the return value to “age1439_error_message” on

page 102.

175

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_status_get

Reads status register information for the module.

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_status_get(ViSession id, ViPInt16 statusPtr);

Parameters

is the VXI instrument session pointer returned by the age1439_init function.

points to the status word. The bits are defined below:

statusPtr

Status Bit

Definition

Description

0-1

AGE1439_S T A T US_MEAS_ARM_WAIT These two bits indicate the current state of the

AGE1439_S T A T US_MEAS_IDLE

AGE1439_S T A T US_MEAS_IN_

PROGRESS

measurement loop. See “The measurement loop” in

chapter 3 and “age1439_meas_status_get” on page 156

for more information about these states

AGE1439_S T A T US_MEAS_TRIG_WAIT

AGE1439_S T A T US_PASSED

AGE1439_S T A T US_READY

Passed: This bit is always set to 1

This bit is set when the module is ready after power-on. See

the VXIbus Specifications for more information.

AGE1439_S T A T US_FIBER_ACTIVE

AGE1439_S T A T US_FIBER_ERROR

This bit is set internally whenever any data has been written

to the receive FIFO, or read from the transmit FIFO of the

fiber interface within the past 500 milliseconds,

approximately. The bit is cleared automatically when activity

ceases on the fiber interface

This bit is set internally whenever an error condition occurs

on the fiber interface. Reading the status register does not

clear this bit. To do this, the age1439_fiber_error_clear

function must be used explicitly. The function age1439_

fiber_error_get can be used to read the contents of the fiber

error register. If the error is continuously present, the bit will

not be cleared.

AGE1439_S T A T US_SETUP_ERROR

Setup error: An invalid parameter value was requested. If an

invalid block size was requested, the closest valid block size

is used until a change to an interrelated parameter makes the

requested block size valid. If a data resolution, data type,

filter bandwidth, trigger delay, or filter decimation parameter

was requested which would result in an inability to make a

measurement, the previous valid parameter is used until a

change to an interrelated parameter makes the requested

parameter valid

AGE1439_S T A T US_SYNC_COMPLETE

Sync/Idle Complete: This bit is set when the most recent

user-initiated Sync or Idle change has propagated through to

all modules in a system. The change is a result of asserting

Sync or forcing Idle via the Control Register or issuing a

meas_control command or function

176

Download from Www.Somanuals.com. All Manuals Search And Download.

Agilent E1439 Programmer's Reference

Functions listed alphabetically

Status Bit

Definition

Description

AGE1439_S T A T US_READ_VALID

This flag is set whenever there is at least one valid 16-bit

data word available to be read via the VME data register. Not

valid when using the local bus data port.

AGE1439_S T A T US_BLOCK_READY

This bit is set in continuous mode whenever the size of the

data in the FIFO is equal to or greater than the block size

block of data may be transferred without fear of running out

of data, thereby holding up the Local bus or VME bus. This bit

is set in block mode whenever the module has successfully

taken a block size number of samples since the most recent

trigger and is cleared when the block is read out, when force

to Idle is asserted, or when the module is armed for another

measurement.

AGE1439_S T A T US_ARMED

This bit is set whenever the module is in the Trigger state, or

is in the Arm state and has satisfied its pre-trigger

requirements. When this bit is set, the module releases the

VXI Sync line. Once all modules release the Sync line, then all

modules go to the Trigger state.

AGE1439_S T A T US_FIFO_OVERFLOW

AGE1439_S T A T US_OVERLOAD

FIFO Overflow: This bit set when the FIFO buffer overflows

in continuous mode

This bit is set whenever the ADC converts a sample that

exceeds the range of the ADC. The bit is cleared when the

Status register is read.

AGE1439_S T A T US_ERROR_QUEUE

AGE1439_S T A T US_MODID

This bit is set whenever there is an error in the error queue. It

is cleared when the error queue is empty

A (1) in this field indicates that the module is not selected via

the P2 MODID line. A (0) indicates that the module is

selected by a high state on the P2 MODID line

AGE1439_S T A T US_HARDWARE_SET

This bit is set when all commands are complete and the

hardware has been set

Return Value

AGE1439_SUCCESS indicates that a function was successful.

Values other than AGE1439_SUCCESS indicate an error condition or other important status

condition. To determine the error message, pass the return value to “age1439_error_message” on

page 102.

See Also