/*
 *  Copyright 2002 by Texas Instruments Incorporated.
 *  All rights reserved. Property of Texas Instruments Incorporated.
 *  Restricted rights to use, duplicate or disclose this code are
 *  granted through contract.
 *  
 */
/* "@(#) DSP/BIOS 4.80.208 12-06-02 (barracuda-l19)" */
/*
 *  ======== dss.h ========
 */

#ifndef DSS_
#define DSS_

#include <pip.h>

#ifdef _EVM5510_
#define far
#endif

typedef struct {
    Bool	enable;	
} DSS_Obj;


/*
 *  ======== DSS Error flags ========
 *  Warning: these must match assembly constants in dss.h*
 */
#define DSS_RXERR   0x1
#define DSS_TXERR   0x2

/*
 *  ======== DSS_error ========
 *  Error mask.  This bit mask is initilized to 0.  Whenever the DSS
 *  driver detects a buffer underflow/overflow condition, it sets a
 *  bit in this mask to indicate the error:
 *
 *	DSS_TXERR  - transmit underflow error; serial port transmit buffer
 *		     is ready to transmit but no output data is available.
 *
 *	DSS_RXERR  - receive overflow error; serial port receive buffer has
 *		     data but no input buffer is available to hold the data.
 */
extern far Int DSS_error;

/*
 *  ======== DSS_init ========
 *  Module initialization function.  This function must be called prior
 *  to using DSS.  This includes any references to DSS global data; e.g.,
 *  DSS_error, DSS_txPipe, etc.
 */
extern far Void DSS_init(Void);

/*
 *  ======== DSS_rxPipe ========
 *  Receive pipe.  The client may configure the notifyReader() function
 *  and the associated arguments (nrarg0, nrarg1), the buffer size,
 *  number of buffers, and any monitor option.
 *
 *  The client must *not* configure the notifyWriter() function or any 
 *  of its arguments (nwarg0, nwarg1).
 */
extern far PIP_Obj DSS_rxPipe;

/*
 *  ======== DSS_txPipe ========
 *  Transmit pipe.  The client may configure the notifyWriter() function
 *  and the associated arguments (nwarg0, nwarg1), the buffer size,
 *  number of buffers, and any monitor option.
 *
 *  The client must *not* configure the notifyReader() function or any 
 *  of its arguments (nrarg0, nrarg1).
 */
extern far PIP_Obj DSS_txPipe;

#endif