ll2-api.h

Go to the documentation of this file.

/* ------------------------------------------------------------------------- */
/* file ll2-api.h                                                                 */
/* ------------------------------------------------------------------------- */
/*   Copyright (C) 2011 Peter Milne, D-TACQ Solutions Ltd
 *                      <Peter dot Milne at D hyphen TACQ dot com>
 *  Created on: Sep 14, 2011
 *      Author: pgm

    http://www.d-tacq.com

    This program is free software; you can redistribute it and/or modify
    it under the terms of Version 2 of the GNU General Public License
    as published by the Free Software Foundation;

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.                */
/* ------------------------------------------------------------------------- */

/** @file ll2-api.h  C API definition for LOWLATENCY2.
 *
 */

#ifndef LLC2_API_H_
#define LLC2_API_H_


#ifdef __cplusplus
extern "C" {
#endif

typedef enum  { OK, ERR=-1 } STATUS_OK;

/** instantiate system
 * @param config_file .xml file with system definition
 * @param argc  pass in argc argv for optional command line initialization set zero if not required
 * @param argv  optional command line argv array
 */
STATUS_OK RtSetup(
                const char* config_file, int argc, const char* argv[]);

/** arm the capture
 * @param ao_values initial ao values
 * @param do_values initial do_values
 */
STATUS_OK RtArm(
                const short* ao_values,
                const unsigned* do_values);

/** set next outputs, wait for and return next sample
 * @param ao_values next ao_values
 * @param do_values next do_values
 * @param ai_values latest ai sample
 * @param di_values latest di sample
 * @param status_values latest status values
 */
STATUS_OK RtIO(
                const short* ao_values,
                const unsigned* do_values,
                short* ai_values,
                unsigned* di_values,
                unsigned* status_values);

/** stop and cleanup. */
STATUS_OK RtDone(void);

#ifdef __cplusplus
} /* closing brace for extern "C" */
#endif

/** status offsets<br>
 *  [ 0] contents of MAIL BOX 0 */
#define LLC_SYNC2V_IN_MBOX0  LLCV2_STATUS_MBOX0
/** [ 1] contents of MAIL BOX 1 */
#define LLC_SYNC2V_IN_MBOX1  LLCV2_STATUS_MBOX1
/** [ 2] contents of MAIL BOX 2 */
#define LLC_SYNC2V_IN_MBOX2  LLCV2_STATUS_MBOX2
/** [ 3] contents of MAIL BOX 3 */
#define LLC_SYNC2V_IN_MBOX3  LLCV2_STATUS_MBOX3
/** [ 4] DIO6 value */
#define LLC_SYNC2V_IN_DIO6   LLCV2_STATUS_DIO
/** [ 5] Garbage for SYNC2V*/
#define LLC_SYNC2V_IN_TINST  LLCV2_STATUS_TINST
/** [ 6] HW TLATCH 11:0 */
#define LLC_SYNC2V_IN_TLATCH LLCV2_STATUS_TLATCH
/** [ 7] 0xdeadbeef */
#define LLC_SYNC2V_IN_BDR    LLCV2_STATUS_BDR
/** [ 8] Iteration */
#define LLC_SYNC2V_IN_ITER   (LLCV2_STATUS_BDR+1)
/** [ 9] DI32 values */
#define LLC_SYNC2V_IN_DI32   (LLCV2_STATUS_BDR+2)
/** [10] ITER last error */
#define LLC_SYNC2V_IN_LASTE  (LLCV2_STATUS_BDR+3)
/** [11] SW TLATCH 31:0 [OPT] lags one cycle */
#define LLC_SYNC2V_IN_TLAT32 (LLCV2_STATUS_BDR+4)
/** [12] Version ID */
#define LLC_SYNC2V_IN_VERID  (LLCV2_STATUS_BDR+5)
/** [13] Sample Count */
#define LLC_SYNC2V_IN_SCOUNT (LLCV2_STATUS_BDR+6)
/** [14] FIFSTAT fifo status register */
#define LLC_SYNC2V_IN_FIFSTA (LLCV2_STATUS_BDR+7)
/** [15] Last DO64 outval */
#define LLC_SYNC2V_IN_DO64   (LLCV2_STATUS_BDR+8)
#define LLC_SYNC2V_IN_LAST   (LLCV2_STATUS_MBOX0+15) /* [15] */
#define LLC_SYNC2V_IDLE_PAT 0x2f2fc0de       /* fills remainder */


#endif /* LLC2_API_H_ */