#include "License.h"

#ifndef _PRIVATE_H
#define _PRIVATE_H

#include "Registers.h"
#include "OssCompat.h"

/* Miscellaneous defines */

#define HDAC_DMA_ALIGNMENT		128
#define HDAC_CODEC_MAX			16

// xxx: check what these flags were for

#define HDAC_F_DMA_NOCACHE		0x00000001
#define HDAC_F_MSI				0x00000002

#define HDAC_UNSOLQ_MAX			64
#define HDAC_UNSOLQ_READY		0
#define HDAC_UNSOLQ_BUSY		1

/* Misc constants.. */

#define HDA_AMP_VOL_DEFAULT		(-1)
#define HDA_AMP_MUTE_DEFAULT	(0xffffffff)
#define HDA_AMP_MUTE_NONE		(0)
#define HDA_AMP_MUTE_LEFT		(1 << 0)
#define HDA_AMP_MUTE_RIGHT		(1 << 1)
#define HDA_AMP_MUTE_ALL		(HDA_AMP_MUTE_LEFT | HDA_AMP_MUTE_RIGHT)

#define HDA_AMP_LEFT_MUTED(v)	((v) & (HDA_AMP_MUTE_LEFT))
#define HDA_AMP_RIGHT_MUTED(v)	(((v) & HDA_AMP_MUTE_RIGHT) >> 1)

#define HDA_ADC_MONITOR			(1 << 0)

#define HDA_CTL_OUT				1
#define HDA_CTL_IN				2

/*********/

#define HDA_BDL_MIN				2
#define HDA_BDL_MAX				256
#define HDA_BDL_DEFAULT			HDA_BDL_MIN

#define HDA_BLK_MIN				HDAC_DMA_ALIGNMENT
#define HDA_BLK_ALIGN			(~(HDA_BLK_MIN - 1))

#define HDA_BUFSZ_MIN			4096
#define HDA_BUFSZ_MAX			65536
#define HDA_BUFSZ_DEFAULT		HDA_BUFSZ_MAX

#define HDA_PARSE_MAXDEPTH		10

#define HDAC_UNSOLTAG_EVENT_HP	0x00

/* Helper Macros */

#define HDAC_ISDCTL(n)			(_HDAC_ISDCTL((n), mInStreamsSup, mOutStreamsSup))
#define HDAC_ISDSTS(n)			(_HDAC_ISDSTS((n), mInStreamsSup, mOutStreamsSup))
#define HDAC_ISDPICB(n)			(_HDAC_ISDPICB((n), mInStreamsSup, mOutStreamsSup))
#define HDAC_ISDCBL(n)			(_HDAC_ISDCBL((n), mInStreamsSup, mOutStreamsSup))
#define HDAC_ISDLVI(n)			(_HDAC_ISDLVI((n), mInStreamsSup, mOutStreamsSup))
#define HDAC_ISDFIFOD(n)		(_HDAC_ISDFIFOD((n), mInStreamsSup, mOutStreamsSup))
#define HDAC_ISDFMT(n)			(_HDAC_ISDFMT((n), mInStreamsSup, mOutStreamsSup))
#define HDAC_ISDBDPL(n)			(_HDAC_ISDBDPL((n), mInStreamsSup, mOutStreamsSup))
#define HDAC_ISDBDPU(n)			(_HDAC_ISDBDPU((n), mInStreamsSup, mOutStreamsSup))

#define HDAC_OSDCTL(n)			(_HDAC_OSDCTL((n), mInStreamsSup, mOutStreamsSup))
#define HDAC_OSDSTS(n)			(_HDAC_OSDSTS((n), mInStreamsSup, mOutStreamsSup))
#define HDAC_OSDPICB(n)			(_HDAC_OSDPICB((n), mInStreamsSup, mOutStreamsSup))
#define HDAC_OSDCBL(n)			(_HDAC_OSDCBL((n), mInStreamsSup, mOutStreamsSup))
#define HDAC_OSDLVI(n)			(_HDAC_OSDLVI((n), mInStreamsSup, mOutStreamsSup))
#define HDAC_OSDFIFOD(n)		(_HDAC_OSDFIFOD((n), mInStreamsSup, mOutStreamsSup))
#define HDAC_OSDBDPL(n)			(_HDAC_OSDBDPL((n), mInStreamsSup, mOutStreamsSup))
#define HDAC_OSDBDPU(n)			(_HDAC_OSDBDPU((n), mInStreamsSup, mOutStreamsSup))

#define HDAC_BSDCTL(n)			(_HDAC_BSDCTL((n), mInStreamsSup, mOutStreamsSup))
#define HDAC_BSDSTS(n)			(_HDAC_BSDSTS((n), mInStreamsSup, mOutStreamsSup))
#define HDAC_BSDPICB(n)			(_HDAC_BSDPICB((n), mInStreamsSup, mOutStreamsSup))
#define HDAC_BSDCBL(n)			(_HDAC_BSDCBL((n), mInStreamsSup, mOutStreamsSup))
#define HDAC_BSDLVI(n)			(_HDAC_BSDLVI((n), mInStreamsSup, mOutStreamsSup))
#define HDAC_BSDFIFOD(n)		(_HDAC_BSDFIFOD((n), mInStreamsSup, mOutStreamsSup))
#define HDAC_BSDBDPL(n)			(_HDAC_BSDBDPL((n), mInStreamsSup, mOutStreamsSup))
#define HDAC_BSDBDPU(n)			(_HDAC_BSDBDPU((n), mInStreamsSup, mOutStreamsSup))

/*************************************************************************************/
/*************************************************************************************/

typedef int nid_t;

typedef struct _DmaMemory DmaMemory;

typedef struct _RirbResponse RirbResponse;
typedef struct _CommandList CommandList;
typedef struct _BdlEntry BdlEntry;

typedef struct _ChannelCaps ChannelCaps;

typedef struct _Widget Widget;
typedef struct _AudioControl AudioControl;
typedef struct _AudioAssoc AudioAssoc;
typedef struct _PcmDevice PcmDevice;
typedef struct _FunctionGroup FunctionGroup;
typedef struct _Channel Channel;
typedef struct _Codec Codec;

class IODMACommand;

typedef struct _DmaMemory {
	const char *description;
	IODMACommand *command;
	IOMemoryMap *map;
	UInt64 size;
	UInt64 physAddr;
	IOVirtualAddress virtAddr;
} DmaMemory;

/* Hold a response from a verb sent to a codec received via the rirb. */
typedef struct _RirbResponse {
	UInt32 response;
	UInt32 response_ex;
} RirbResponse;

#define HDAC_RIRB_RESPONSE_EX_SDATA_IN_MASK		0x0000000f
#define HDAC_RIRB_RESPONSE_EX_SDATA_IN_OFFSET	0
#define HDAC_RIRB_RESPONSE_EX_UNSOLICITED		0x00000010

#define HDAC_RIRB_RESPONSE_EX_SDATA_IN(response_ex)					\
		(((response_ex) & HDAC_RIRB_RESPONSE_EX_SDATA_IN_MASK) >>	\
		HDAC_RIRB_RESPONSE_EX_SDATA_IN_OFFSET)

/* This structure holds the list of verbs that are to be sent to the codec
 * via the corb and the responses received via the rirb. It's allocated by
 * the codec driver and is owned by it. */
typedef struct _CommandList {
	int numCommands;
	UInt32 *verbs;
	UInt32 *responses;
} CommandList;

typedef struct _BdlEntry {
	volatile UInt32 addrl;
	volatile UInt32 addrh;
	volatile UInt32 len;
	volatile UInt32 ioc;
} __attribute__((__packed__)) BdlEntry;

#define HDA_MAX_CONNS	32
#define HDA_MAX_NAMELEN	32

typedef struct _Widget {
	nid_t nid;
	int type;
	int enable;
	int nconns, selconn;
	int waspin;
	UInt32 pflags;
	int bindAssoc;
	int bindSeqMask;
	int ossdev;
	UInt32 ossmask;
	nid_t conns[HDA_MAX_CONNS];
	UInt8 connsenable[HDA_MAX_CONNS];
	char name[HDA_MAX_NAMELEN];
	FunctionGroup *funcGroup;
	struct {
		UInt32 widgetCap;
		UInt32 outAmpCap;
		UInt32 inAmpCap;
		UInt32 supStreamFormats;
		UInt32 supPcmSizeRates;
		UInt32 eapdBtl;
	} params;
	struct {
		UInt32 config;
		UInt32 cap;
		UInt32 ctrl;
	} pin; /* wclass */
} Widget;

typedef struct _AudioControl {
	Widget *widget, *childWidget;
	int enable;
	int index, dir, ndir;
	int mute, step, size, offset;
	int left, right, forcemute;
	UInt32 muted;
	UInt32 ossmask, possmask;
} AudioControl;

/* Association is a group of pins bound for some special function. */
typedef struct _AudioAssoc {
	UInt8 enable;
	UInt8 index;
	UInt8 dir;
	UInt8 pincnt;
	UInt8 fakeredir;
	UInt8 digital;
	nid_t hpredir;
	nid_t pins[16];
	nid_t dacs[16];
	int chan;
} AudioAssoc;

typedef struct _PcmDevice {
	FunctionGroup *funcGroup;
	int index;
	bool registered;
	int playChanId, recChanId;
	UInt8 left[SOUND_MIXER_NRDEVICES];
	UInt8 right[SOUND_MIXER_NRDEVICES];
	UInt32 chanSize;
	UInt32 chanNumBlocks;
	UInt8 digital;
	UInt32 recDevMask, devMask;
} PcmDevice;

typedef struct _FunctionGroup {
	UInt8 nodeType;
	nid_t nid;
	nid_t startNode, endNode;
	int numNodes;
	Codec *codec;
	Widget *widgets;
	struct {
		UInt32 outAmpCap;
		UInt32 inAmpCap;
		UInt32 supStreamFormats;
		UInt32 supPcmSizeRates;
		int numControls, numAssocs;
		AudioControl *controls;
		AudioAssoc *assocs;
		UInt32 quirks;
		UInt32 gpio;
		PcmDevice *pcmDevices;
		int numPcmDevices;
	} audio; /* function */
	/* XXX undefined: modem, hdmi. */
} FunctionGroup;

#define HDAC_CHN_RUNNING	0x00000001
#define HDAC_CHN_SUSPEND	0x00000002

typedef struct _ChannelCaps {
	UInt32 minSpeed, maxSpeed;
	UInt32 *formats;
	UInt32 caps;
} ChannelCaps;

typedef struct _Channel {
	ChannelCaps caps;
	FunctionGroup *funcGroup;
	PcmDevice *pcmDevice;
	UInt32 speed, format;
	UInt32 formats[8], pcmRates[16];
	UInt32 supStreamFormats, supPcmSizeRates;
	UInt32 numBlocks, blockSize;
	UInt32 *dmaPos;
	UInt32 flags;
	int direction;
	int off;
	int streamId;
	int bit16, bit32;
	int assocNum;
	nid_t io[16]; // adc/dac nids
	DmaMemory *bdlMem;
	DmaMemory *buffer;
} Channel;

#define CODEC_ID(codec) ((((UInt32) (codec)->vendorId & 0xffff) << 16) | \
		((UInt32) (codec)->deviceId & 0xffff))

typedef struct _Codec {
	int	numVerbsSent;
	int	numRespReceived;
	nid_t cad;
	UInt16 vendorId;
	UInt16 deviceId;
	UInt8 revisionId;
	UInt8 steppingId;
	CommandList *commands;
	FunctionGroup *funcGroups;
	int	numFuncGroups;
} Codec;

#endif