lio.h

Using DSP/BIOS I/O in Multichannel Systems

/* ***********************************************************
* THIS PROGRAM IS PROVIDED "AS IS". TI MAKES NO WARRANTIES OR
* REPRESENTATIONS, EITHER EXPRESS, IMPLIED OR STATUTORY, 
* INCLUDING ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS 
* FOR A PARTICULAR PURPOSE, LACK OF VIRUSES, ACCURACY OR 
* COMPLETENESS OF RESPONSES, RESULTS AND LACK OF NEGLIGENCE. 
* TI DISCLAIMS ANY WARRANTY OF TITLE, QUIET ENJOYMENT, QUIET 
* POSSESSION, AND NON-INFRINGEMENT OF ANY THIRD PARTY 
* INTELLECTUAL PROPERTY RIGHTS WITH REGARD TO THE PROGRAM OR 
* YOUR USE OF THE PROGRAM.
*
* IN NO EVENT SHALL TI BE LIABLE FOR ANY SPECIAL, INCIDENTAL, 
* CONSEQUENTIAL OR INDIRECT DAMAGES, HOWEVER CAUSED, ON ANY 
* THEORY OF LIABILITY AND WHETHER OR NOT TI HAS BEEN ADVISED 
* OF THE POSSIBILITY OF SUCH DAMAGES, ARISING IN ANY WAY OUT 
* OF THIS AGREEMENT, THE PROGRAM, OR YOUR USE OF THE PROGRAM. 
* EXCLUDED DAMAGES INCLUDE, BUT ARE NOT LIMITED TO, COST OF 
* REMOVAL OR REINSTALLATION, COMPUTER TIME, LABOR COSTS, LOSS 
* OF GOODWILL, LOSS OF PROFITS, LOSS OF SAVINGS, OR LOSS OF 
* USE OR INTERRUPTION OF BUSINESS. IN NO EVENT WILL TI'S 
* AGGREGATE LIABILITY UNDER THIS AGREEMENT OR ARISING OUT OF 
* YOUR USE OF THE PROGRAM EXCEED FIVE HUNDRED DOLLARS 
* (U.S.$500).
*
* Unless otherwise stated, the Program written and copyrighted 
* by Texas Instruments is distributed as "freeware".  You may, 
* only under TI's copyright in the Program, use and modify the 
* Program without any charge or restriction.  You may 
* distribute to third parties, provided that you transfer a 
* copy of this license to the third party and the third party 
* agrees to these terms by its first use of the Program. You 
* must reproduce the copyright notice and any other legend of 
* ownership on each copy or partial copy, of the Program.
*
* You acknowledge and agree that the Program contains 
* copyrighted material, trade secrets and other TI proprietary 
* information and is protected by copyright laws, 
* international copyright treaties, and trade secret laws, as 
* well as other intellectual property laws.  To protect TI's 
* rights in the Program, you agree not to decompile, reverse 
* engineer, disassemble or otherwise translate any object code 
* versions of the Program to a human-readable form.  You agree 
* that in no event will you alter, remove or destroy any 
* copyright notice included in the Program.  TI reserves all 
* rights not specifically granted under this license. Except 
* as specifically provided herein, nothing in this agreement 
* shall be construed as conferring by implication, estoppel, 
* or otherwise, upon you, any license or other right under any 
* TI patents, copyrights or trade secrets.
*
* You may not use the Program in non-TI devices.
* ********************************************************* */

#ifndef LIO_
#define LIO_

typedef Int (*LIO_Tinit)(Uns chan, Ptr args);     /* Prepare driver to run */
typedef Void (*LIO_Tstart)(Uns chan);    /* Start the flow of data */
typedef Void (*LIO_Tstop)(Uns chan);     /* Stop the flow of data */
typedef Void (*LIO_Tclose)(Uns chan);    /* Stop and release all resources */

/* Return the next complete buffer, or NULL */
typedef Ptr (*LIO_TgetBuf)(Uns chan, Int *size, Int *dataSize);

/* Set new buffer. Returns 1 if room available in hardware queue, 0 if
 * no room in hardware queue. size is in bytes (MAUs). */
typedef Int (*LIO_TsetBuf)(Uns chan, Ptr buf, Uns size);

/* Return 1 if not buffer is being filled or drained. Used to determine
   if all outstanding transfers have occurred. */
typedef Int (*LIO_TisEmpty)(Uns chan);

/* Return 1 if a call to setBuf will succeed. */
typedef Int (*LIO_TisFull)(Uns chan);

/* Set callback function */
typedef Void (*LIO_TcallBack)(Uns chan, Arg arg);
typedef Void (*LIO_TsetCallBack)(Uns chan, LIO_TcallBack cb, Arg arg);

/* IOCTL for anything else */
typedef Int (*LIO_Tctrl)(Uns chan, Uns flag);

/* function table structure used for actual linkage with buffer manager */
typedef struct LIO_Fxns
{
    LIO_Tclose		close;
    LIO_Tctrl		ctrl;
    LIO_TgetBuf		getBuf;
    LIO_Tinit		init;
    LIO_TisEmpty	isEmpty;
    LIO_TisEmpty	isFull;
    LIO_TsetBuf		setBuf;
    LIO_TsetCallBack    setCallback;
    LIO_Tstart		start;
    LIO_Tstop		stop;
} LIO_Fxns;

#endif