dss_isr.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.
* ********************************************************* */
/*
 * API for generic DSS interrupt handler. This API allows a wide variety
 * of audio codecs to support either PIP or SIO drivers. The intent is
 * to isolate the mechanics of data movement from the mechanics of
 * buffer management. This API handles the data movement in a
 * buffer-management-agnostic way. When a tx buffer is full or an rx
 * buffer is empty, an SWI callback is posted. This could either driver
 * PIPs or SIOs.
 * */

/*
 * Initialize the hardware but do not yet enable interrupts. I imagine
 * that sample rate and data format parameters would naturally be added
 * here. The internal state of the isr is intialized such that interrupts
 * may be enabled even if buffers have not been allocated.
 * */
void dss_isr_init();
void dss_isr_init_platform();

/*
 * Enable interrupts, starting the flow of data. 
 * */
void dss_isr_start();
void dss_isr_start_platform();

/*
 * Disable interrupts, halting the flow of data without disturbing the
 * internal state.
 * */
void dss_isr_stop();
void dss_isr_stop_platform();

/*
 * Set and get the tx and rx buffers.
 * */
void dss_isr_set_rxBuf(Uns *ptr, int size);
Uns *dss_isr_get_rxBuf(void);
void dss_isr_set_txBuf(Uns *ptr, int size);
Uns *dss_isr_get_txBuf(void);

/* These are for multi-chanel devices */
void dss_isr_set_rxBuf_n(unsigned short *ptr, int size, int chan);
unsigned short *dss_isr_get_rxBuf_n(int chan);
void dss_isr_set_txBuf_n(unsigned short *ptr, int size, int chan);
unsigned short *dss_isr_get_txBuf_n(int chan);

/* Get the number of words left to send */
int dss_isr_get_rxCnt(void);
int dss_isr_get_txCnt(void);
int dss_isr_get_rxCnt_n(int chan);
int dss_isr_get_txCnt_n(int chan);

#define DSS_ISR_TX_0_FLAG 1
#define DSS_ISR_TX_1_FLAG 2
#define DSS_ISR_RX_0_FLAG 4
#define DSS_ISR_RX_1_FLAG 8
#define DSS_ISR_HWI_FLAG  0x10 /* says the HWI posted vs. software */

/*
 * Set the SWI callback. The SWI's mailbox will be set with DSS_ISR_TX_FLAG
 * and/or DSS_ISR_RX_FLAG set to indicate status.
 * */
void dss_isr_set_swi(SWI_Obj *swi);
void dss_isr_set_swi_n(SWI_Obj *swi, int chan);