AHP® XC Correlators API
AHP XC Correlators
Loading...
Searching...
No Matches
Classes | Enumerations

Classes

struct  ahp_xc_correlation
 Correlations structure. More...
 
struct  ahp_xc_sample
 Sample structure. More...
 
struct  ahp_xc_packet
 Packet structure. More...
 

Enumerations

enum  xc_header_flags { HAS_CROSSCORRELATOR = 1 , HAS_LEDS = 2 , HAS_PSU = 4 , HAS_CUMULATIVE_ONLY = 8 }
 AHP XC header flags. More...
 
enum  baud_rate
 Baud rate multipliers.
 
enum  xc_cmd {
  CLEAR = 0 , SET_INDEX = 1 , SET_LEDS = 2 , SET_BAUD_RATE = 3 ,
  SET_VOLTAGE = 4 , SET_DELAY = 8 , ENABLE_TEST = 12 , ENABLE_CAPTURE = 13
}
 The XC firmare commands. More...
 
enum  xc_capture_flags {
  CAP_NONE = 0 , CAP_ENABLE = 1 , CAP_EXT_CLK = 2 , CAP_RESET_TIMESTAMP = 4 ,
  CAP_EXTRA_CMD = 8 , CAP_ALL = 0xf
}
 The XC capture flags. More...
 
enum  xc_test_flags {
  TEST_NONE = 0 , SCAN_AUTO = 1<<1 , SCAN_CROSS = 1<<2 , TEST_BCM = 1<<3 ,
  TEST_STEP = 7<<5 , TEST_ALL = 0xf
}
 The XC firmware commands. More...
 

Detailed Description

Enumeration Type Documentation

◆ xc_capture_flags

Enumerator
CAP_NONE 

No extra signals or functions.

CAP_ENABLE 

Enable capture.

CAP_EXT_CLK 

Enable external clock.

CAP_RESET_TIMESTAMP 

Reset timestamp.

CAP_EXTRA_CMD 

Enable extra commands.

CAP_ALL 

All flags enabled.

◆ xc_cmd

enum xc_cmd
Enumerator
CLEAR 

Clear autocorrelation and crosscorrelation delays.

SET_INDEX 

Set the current input line index for following commands.

SET_LEDS 

Set on or off current line leds, requires HAS_LEDS.

SET_BAUD_RATE 

Set the readout and command baud rate.

SET_VOLTAGE 

Set the indexed input voltage, requires HAS_PSU in header.

SET_DELAY 

Set the autocorrelator or crosscorrelator delay.

ENABLE_TEST 

Enables tests on current input.

ENABLE_CAPTURE 

Enable capture flags.

◆ xc_header_flags

Enumerator
HAS_CROSSCORRELATOR 

Indicates that the correlator can cross-correlate its inputs.

HAS_LEDS 

Indicates if the correlator has led lines available to drive.

HAS_PSU 

Indicates that the correlator has an internal PSU PWM driver on 2nd flag bit.

HAS_CUMULATIVE_ONLY 

Indicates that the correlator has cumulative correlators only.

◆ xc_test_flags

Enumerator
TEST_NONE 

No extra signals or functions.

SCAN_AUTO 

Autocorrelator continuum scan.

SCAN_CROSS 

Crosscorrelator continuum scan.

TEST_BCM 

BCM modulation on voltage led.

TEST_STEP 

Set channel scan step.

TEST_ALL 

All tests enabled.