Help: ICE_KEYS



This file covers all of the keyed parameters that one can set or get using the
pic_getKey() and pic_setKey() routines.  Unless specifically noted, all keys
are of type int_4.  

From Midas these can be called with
  PICDRIVER GET <alias> <key> <label>
and 
  PICDRIVER SET <alias> <key> <value>

From C, Fortran, or Java code, the include file key name defines are formed by 
prepending KEY_ to the name of the key.

When an index field is required, it is infered from the /PORT=xxx switch or PORT=xxx
flag in the card alias. If the PORT is not specified, the /DMAC=n switch provides the 
index.  For an index that does not relate to a DMA channel, such as the TEMP key, use 
the negative of the index. This bypasses the DMA channel lookup for a port index.

Many of these functions are also supported as flags in the configuration string
or /FLAGS=(string) switch.  See PIC HELP FLAGS.

The currently supported keys are:

  RATE - Input sample rate in Hz
  FREQ - Tuned frequency/nyquist (double)
  NFREQ - Return the nearest actual tuned frequency/nyquist available.
  DFREQ - Channel spacing for tuner banks frequency/nyquist (double)
  DEC - Tuner decimation (or frame decimation 1-1024)
  NDEC - Return the nearest actual tuner decimation available
  GAIN - Tuner gain in dB (must be set after loading user filter coefficients)
  EMT - Envelope Measure and Track
  MGAIN - Module gain in dB when module has adjustable gain block (typically analog)
  MFREQ - Module center frequency in Hz when module is able to perform a real-to-complex conversion and shift
  OVSR - Tuner over-sampling rate
  RATIO - Tuner resampler ratio (resamplerOutputRate/tunerOutputRate) (double)
  NRATIO - Return the nearest actual tuner resampler ratio available (double)
  FRAME - Frame size (32 <= 2**N <= 512K) for IOC framed decimation (PIC3 and earlier)
  PKTLEN - Packet length for tuner bank frames in bytes
  CHAIN - Set DMA chain pointer to specified index (or address)
  ACTIVE - Reports number of active DMA channels on card, -1 if not reset, -2 if locked
  DELAY - Delay in some applications (in samples)
  TCMODE - TimeCode Mode index (debug)
  TCOFF - TimeCode offset in Seconds Of Year for applicable output modules.

  RFFREQ - RF Module frequency in MHz (double)
  RFBW - RF Module bandwidth in MHz (double)
  RFATTN - RF Module attenuation in dB
  RFGAIN - RF Module gain in dB
  RFOPTS - RF Module options mask (See FLAGS)
  RFPWR - RF Module input power measurement in dB

  FLGBSET - Set specified bits in the common flags
  FLGBCLR - Clear specified bits in the common flags
  TFLGBSET - Set specified bits in the tuner flags
  TFLGBCLR - Clear specified bits in the tuner flags

  IPVLAN - Set the IP VLAN address of an ethernet module
  IPADDR - Set the IP address of an ethernet module
  IPCONN - Connect to a particular IP multicast port
  IPDISC - Disconnect from a particular IP multicast port
  PKTHDR - Return the contents of the last ICE/SDDS packet header.
  SEQERR - Return the running count of SDDS sequence gaps
  SEQFILL - Return the running count of SDDS sequence gaps filled by I/O processor.

  ALG - Active algorithm (by index)
  ARGS - Algorithm arguments offset

  CLKI - Invert the clock
  MSBI - Invert the Most Significant Bit
  BIT - Bit# for bit serial acquisition (0,1,4,15)
  BITS - Number of bits for acquisition (1,8,16)

  CTYPE - Card type (2=PIC2 3=PIC3 4=PIC4 8=MBT2 9=MBT3 12=SLIC3)
  PTYPE - Port type (1=SERIAL 2=LINK 3=MODULE 4=TUNER)
  PINDEX - Port index 1,2,3,4...
  MTYPE - IO module type (-1=A2D 1=D2A -2=E2D 2=D2E etc..
  MTYPE1 - IO module#1 type
  MTYPE2 - IO module#2 type
  PMTYPE - Processor module type (1=DTDM 2=DTDMX etc..
  PMTYPE1 - Processor module#1 type
  PMTYPE2 - Processor module#2 type
  PMINDEX - Processor module index (active selection) 0=PIC 1=PM1 2=PM2
  MCHNS - Maximum number of tuner channels on board 0-24
  CHNS - Number of usable tuner channels 0-24 (uses CPC setting)
  CHAN - Select channel in a tuner bank
  CPC - Channels per chip to use 1|2|4 (graychips only)
  TCINC - Adjacent tuner channel increment (to next tuner on same side)
  IOCTYPE - Type of current IOC load module (i.e
  CBUFSZ - Default buffer size on card for specified port
  STATUS - Current card DMA, ROUTE, and SYSTEM status
  ROUTE - Current FPGA routing register
  DETECT - Auto detect the current card configuration where the dmac argument is the device number or -1 for all.

  PRCCLK - PRoCessor clock rate
  IOCCLK - IO Controller chip clock rate
  ICLK - IOC Internal divide clock rate (MUXCLK=I)
  PCLK - Programmable clock (MUXCLK=P)
  CCLK - Motherboard socketed crystal rate (MUXCLK=C)
  MCLK - Measurement of clock rate of the specified clock configuration

  PCICLK - PCI clock rate (33|66|100|133) MHz
  PCIBUS - PCI bus width (32|64) bits
  PCIBW - PCI bus bandwidth in Mby/s (theoretical)
  PCIREV - PCI controller chip EPROM rev
  DRIVER - ICE driver version running on this machine
  VERSION - ICE software version loaded on this card
  FPGAREV - ICE FPGA firmware versions loaded on this card
  FPGASIG - ICE FPGA firmware signature loaded on this card
  RSTIME - Time of last card reset (index=0) or I/O port reset (index=1|2) in J1950 seconds.
  PFIFO - PCI Side FiFo (debug)
  AFIFO - Card/Adon Side FiFo (debug)

  IOC - IOC registers
  IOCIOM - IOC IO Module control register
  IOCALG - IOC algorithm register offset
  IOCRAM - IOC RAM register offset

  MOD - IO Module register offset

  CORE - Processing core register offset

  APP - Application register offset

  TEMP - Get temperature measurements from port.
  SYSMON - Get temperature/voltage measurements from port.
  TPOE - Test port output enable on series 5+ cards
  TPD - Test port data
  TPDX - Test port data change
  TPSR - Test port status register
  JTAGPORT - JTAG cable debug port assignment on series 5+ cards
  MPCIO - Multi-Purpose Chip I/O register.
  CUID - get the UID Chip 8-byte value
  GPS - get the time and position from an ICE-GPS IO Module