Help: ICE_ICELIB



This library contains routines to communicate with the ICE family
of DSP boards.  This includes PIC, MBT, and SLIC varieties.  All 
routines return an int status unless otherwise noted (by the last 
element in the argument list with the same name as the function).
Successful status are >= 0.  Errors are signaled by a status < 0.

Arguments that are structures or arrays are passed by reference.
All others are pass by value, unless otherwise noted. 

Fortran wrappers are provided by preceding the routine name with m$ .
All arguments to the wrappers are pass by reference.

  PIC_DETECT - Query the current system for ICE cards
  PIC_OPEN - Open a connection to an ICE-PIC device
  PIC_CLOSE - Close a connection to an ICE-PIC device
  PIC_RESET - Reset a device or device IO port
  PIC_TEST - Run a series of diagnostic tests
  PIC_SNIFF - Display contents of the device PCI/Processor registers
  PIC_READ - Read from a PCI or Processor address
  PIC_WRITE - Write to a PCI or Processor address
  PIC_WRITEM - Write to a PCI or Processor address with a mask
  PIC_RFIFO - Read a block of data from the PCI FIFO
  PIC_WFIFO - Write a block of data to the PCI FIFO
  PIC_RPM - Reads internal address space of a port/processor module
  PIC_WPM - Writes internal address space of a port/processor module
  PIC_SEND - Send a packet to a port/processor module
  PIC_RECV - Receives a packet from a port/processor module
  PIC_SENDRECV - Send a packet to a port/processor module and receive response with timeout
  PIC_MSG - Send a PKT_ACMD to a Port/Processor Module with optional response and timeout
  PIC_IOPORT - Set up an I/O Port for DMA transfer
  PIC_TUNER_FREQ - Returns the nearest supported down conversion freq
  PIC_TUNER_DEC - Returns the nearest supported decimation
  PIC_TUNER_OVSR - Sets the inputs over-sampling ratio (zero insertion)
  PIC_FILE - Deprecated use PIC_MAPFILE
  PIC_MAPFILE - Prepares a Midas file/buffer for DMA transfers
  PIC_MAP - Deprecated, use PIC_MAPMEM
  PIC_MAPMEM - Handles allocating/mapping a buffer for DMA transfers
  PIC_DMASETUP - Sets up HOST DMA handler
  PIC_DMA - Deprecated, use PIC_DMASETUP
  PIC_DMAFUNC - Starts, Stops, Polls, or Waits on a DMA transfer
  PIC_DMASTAT - Returns the current DMA index, cycle, and status
  PIC_DMAXFER - Transfers next available data to/from the host circular buffer
  PIC_DMAXPTR - Returns pointer to buffer with the next available DMA data
  PIC_DMACHAIN - Set up a DMA chain table entry
  PIC_LOADFILE - Loads code from file onto SHARC, PPC, IOC, etc.
  PIC_LOADSHARC - Deprecated, use PIC_LOADFILE
  PIC_LOADPPC - Deprecated, use PIC_LOADFILE
  PIC_LOADIOC - Deprecated, use PIC_LOADFILE
  PIC_LOADMOD - Deprecated, use PIC_LOADFILE
  PIC_LOADFC - Loads filter coefficients (FC's) from memory buffer onto tuner chip
  PIC_TIMER - Deprecated, use PIC_SETKEY with KEY_ICLK
  PIC_NVRAM - Reads/Writes/Converts NVRAM code for PCI-IF chip
  PIC_TC - Returns the timecode for a given sample
  PIC_TIMECODE - Deprecated, use PIC_TC
  PIC_GETINTFLAG - Gets an integer valued flag from the configuration string
  PIC_GETDBLFLAG - Gets an double valued flag from the configuration string
  PIC_STR2IP - Translates string name into a binary IP address

Single properties should be accessed through the SET/GET KEY routines:

  PIC_NAME2KEY - Translates string name into a key ID
  PIC_SETKEY - Sets a parameter by key/value pair
  PIC_SETKEYL - Sets a 4 byte integer parameter by key/value pair
  PIC_SETKEYD - Sets a double parameter by key/value pair
  PIC_GETKEY - Gets a parameter by key/value pair
  PIC_GETKEYL - Gets a 4-byte integer parameter by key/value pair
  PIC_GETKEYD - Gets a double parameter by key/value pair

Valid Keys Include: RATE,FREQ,DEC,GAIN,OVSR,FRAME,CHAIN,MOD,IOC,APP,IPADDR
See PIC HELP KEYS for a full list of keyed parameters.

All routines return a status that is 1 for success and -1 for failure unless
otherwise noted.

All routines have a FORTRAN callable wrapper.  The wrapper name is formed by
prepending an M$ and the arguments are all passed by reference.  Both C and
FORTRAN routines are lowercase.