/*---------------------------------------------------------------------------*
  Project:  Audio Interface (AI) Device driver and API
  File:     ai.h

  Copyright (C)1999-2011 Nintendo. All Rights Reserved.

  These coded instructions, statements, and computer programs contain
  proprietary information of Nintendo of America Inc. and/or Nintendo
  Company Ltd., and are protected by Federal copyright law.  They may
  not be disclosed to third parties or copied or duplicated in any form,
  in whole or in part, without the prior written consent of Nintendo.

 *---------------------------------------------------------------------------*

  Description
  -----------
  This is the public API definition file for the Audio Interface device
  driver. Applications or OS components which need access to the AI
  hardware must include this file.

 *---------------------------------------------------------------------------*/

#ifndef __AI_H__
#define __AI_H__

#ifdef __cplusplus
extern "C" {
#endif

/*---------------------------------------------------------------------------*
 * Includes
 *---------------------------------------------------------------------------*/
#include <types.h>

/*---------------------------------------------------------------------------*
 * Definitions
 *---------------------------------------------------------------------------*/
#define AI_SAMPLERATE_48KHZ  0x00000001   // SRC sample rates for DSP
#define AI_SAMPLERATE_32KHZ  0x00000000

/*---------------------------------------------------------------------------*
 * Types/Declarations
 *---------------------------------------------------------------------------*/
typedef void (*AIDCallback)(void);


typedef enum _AI_EXADDR_STATE {
    AI_EXADDR_NOT_SET = 0,
    AI_EXADDR_SET = 1,
    AI_EXADDR_INVALID =2
} AI_EXADDR_STATE;


typedef enum _AI_CHANNEL
{
    AI_CHANNEL_STEREO,
    AI_CHANNEL_MULTI_PCM,
    AI_CHANNEL_BITSTREAM
}AI_CHANNEL;

/*---------------------------------------------------------------------------*
 * Globals
 *---------------------------------------------------------------------------*/
extern AI_EXADDR_STATE ex_addr_reg_stat;

/*---------------------------------------------------------------------------*
 * Function Prototypes
 *---------------------------------------------------------------------------*/

// AI-FIFO DMA ---------------------------------------------------------------
AIDCallback AIRegisterDMACallback       (AIDCallback callback);
AIDCallback AIDRCRegisterDMACallback    (AIDCallback callback);

void        AIInitDMA                   (u32 start_addr, u32 length);
BOOL        AIGetDMAEnableFlag          (void);
void        AIStartDMA                  (void);
void        AIStopDMA                   (void);
void        AIQuit                      (void);
u32         AIGetDMABytesLeft           (void);

u32         AIGetDMAStartAddr           (void);
u32         AIDRCGetDMAStartAddr        (void);
u32         AIGetDMALength              (void);
u32         AIDRCGetDMALength           (void);

u32         AIGetDSPSampleRate          (void);
void        AISetDSPSampleRate          (u32 rate);

// General/initialization ------------------------------------------------------
void        AIInit                      (u8*  stack);

BOOL        AICheckInit                 (void);
void        AIReset                     (void);
void        AISetChannel                (AI_CHANNEL channel, BOOL stuffing);

u32 AIGetAudioFrameCount(void);
// Software workaround for extended dma memory support until A31
void AIGetDMARange( u32 start_addr, u32* addr_hi, u32* addr_low);

#ifdef __cplusplus
}
#endif

#endif // __AI_H__