[deliverable/linux.git] / include / sound / cs46xx_dsp_spos.h

/*
 *  The driver for the Cirrus Logic's Sound Fusion CS46XX based soundcards
 *  Copyright (c) by Jaroslav Kysela <perex@perex.cz>
 *
 *
 *   This program is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation; either version 2 of the License, or
 *   (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program; if not, write to the Free Software
 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
 *
 */

#ifndef __CS46XX_DSP_SPOS_H__
#define __CS46XX_DSP_SPOS_H__

#include "cs46xx_dsp_scb_types.h"
#include "cs46xx_dsp_task_types.h"

#define SYMBOL_CONSTANT  0x0
#define SYMBOL_SAMPLE    0x1
#define SYMBOL_PARAMETER 0x2
#define SYMBOL_CODE      0x3

#define SEGTYPE_SP_PROGRAM              0x00000001
#define SEGTYPE_SP_PARAMETER            0x00000002
#define SEGTYPE_SP_SAMPLE               0x00000003
#define SEGTYPE_SP_COEFFICIENT          0x00000004

#define DSP_SPOS_UU      0x0deadul     /* unused */
#define DSP_SPOS_DC      0x0badul      /* don't care */
#define DSP_SPOS_DC_DC   0x0bad0badul  /* don't care */
#define DSP_SPOS_UUUU    0xdeadc0edul  /* unused */
#define DSP_SPOS_UUHI    0xdeadul
#define DSP_SPOS_UULO    0xc0edul
#define DSP_SPOS_DCDC    0x0badf1d0ul  /* don't care */
#define DSP_SPOS_DCDCHI  0x0badul
#define DSP_SPOS_DCDCLO  0xf1d0ul

#define DSP_MAX_TASK_NAME   60
#define DSP_MAX_SYMBOL_NAME 100
#define DSP_MAX_SCB_NAME    60
#define DSP_MAX_SCB_DESC    200
#define DSP_MAX_TASK_DESC   50

#define DSP_MAX_PCM_CHANNELS 32
#define DSP_MAX_SRC_NR       14

#define DSP_PCM_MAIN_CHANNEL        1
#define DSP_PCM_REAR_CHANNEL        2
#define DSP_PCM_CENTER_LFE_CHANNEL  3
#define DSP_PCM_S71_CHANNEL         4 /* surround 7.1 */
#define DSP_IEC958_CHANNEL          5

#define DSP_SPDIF_STATUS_OUTPUT_ENABLED       1
#define DSP_SPDIF_STATUS_PLAYBACK_OPEN        2
#define DSP_SPDIF_STATUS_HW_ENABLED           4
#define DSP_SPDIF_STATUS_INPUT_CTRL_ENABLED   8

struct dsp_symbol_entry {
	u32 address;
	char symbol_name[DSP_MAX_SYMBOL_NAME];
	int symbol_type;

	/* initialized by driver */
	struct dsp_module_desc * module;
	int deleted;
};

struct dsp_symbol_desc {
	int nsymbols;

	struct dsp_symbol_entry *symbols;

	/* initialized by driver */
	int highest_frag_index;
};

struct dsp_segment_desc {
	int segment_type;
	u32 offset;
	u32 size;
	u32 * data;
};

struct dsp_module_desc {
	char * module_name;
	struct dsp_symbol_desc symbol_table;
	int nsegments;
	struct dsp_segment_desc * segments;

	/* initialized by driver */
	u32 overlay_begin_address;
	u32 load_address;
	int nfixups;
};

struct dsp_scb_descriptor {
	char scb_name[DSP_MAX_SCB_NAME];
	u32 address;
	int index;
	u32 *data;

	struct dsp_scb_descriptor * sub_list_ptr;
	struct dsp_scb_descriptor * next_scb_ptr;
	struct dsp_scb_descriptor * parent_scb_ptr;

	struct dsp_symbol_entry * task_entry;
	struct dsp_symbol_entry * scb_symbol;

	struct snd_info_entry *proc_info;
	int ref_count;
	spinlock_t lock;

	int deleted;
};

struct dsp_task_descriptor {
	char task_name[DSP_MAX_TASK_NAME];
	int size;
	u32 address;
	int index;
	u32 *data;
};

struct dsp_pcm_channel_descriptor {
	int active;
	int src_slot;
	int pcm_slot;
	u32 sample_rate;
	u32 unlinked;
	struct dsp_scb_descriptor * pcm_reader_scb;
	struct dsp_scb_descriptor * src_scb;
	struct dsp_scb_descriptor * mixer_scb;

	void * private_data;
};

struct dsp_spos_instance {
	struct dsp_symbol_desc symbol_table; /* currently availble loaded symbols in SP */

	int nmodules;
	struct dsp_module_desc * modules; /* modules loaded into SP */

	struct dsp_segment_desc code;

	/* Main PCM playback mixer */
	struct dsp_scb_descriptor * master_mix_scb;
	u16 dac_volume_right;
	u16 dac_volume_left;

	/* Rear/surround PCM playback mixer */
	struct dsp_scb_descriptor * rear_mix_scb;

	/* Center/LFE mixer */
	struct dsp_scb_descriptor * center_lfe_mix_scb;

	int npcm_channels;
	int nsrc_scb;
	struct dsp_pcm_channel_descriptor pcm_channels[DSP_MAX_PCM_CHANNELS];
	int src_scb_slots[DSP_MAX_SRC_NR];

	/* cache this symbols */
	struct dsp_symbol_entry * null_algorithm; /* used by PCMreaderSCB's */
	struct dsp_symbol_entry * s16_up;         /* used by SRCtaskSCB's */

	/* proc fs */  
	struct snd_card *snd_card;
	struct snd_info_entry * proc_dsp_dir;
	struct snd_info_entry * proc_sym_info_entry;
	struct snd_info_entry * proc_modules_info_entry;
	struct snd_info_entry * proc_parameter_dump_info_entry;
	struct snd_info_entry * proc_sample_dump_info_entry;

	/* SCB's descriptors */
	int nscb;
	int scb_highest_frag_index;
	struct dsp_scb_descriptor scbs[DSP_MAX_SCB_DESC];
	struct snd_info_entry * proc_scb_info_entry;
	struct dsp_scb_descriptor * the_null_scb;

	/* Task's descriptors */
	int ntask;
	struct dsp_task_descriptor tasks[DSP_MAX_TASK_DESC];
	struct snd_info_entry * proc_task_info_entry;

	/* SPDIF status */
	int spdif_status_out;
	int spdif_status_in;
	u16 spdif_input_volume_right;
	u16 spdif_input_volume_left;
	/* spdif channel status,
	   left right and user validity bits */
	unsigned int spdif_csuv_default;
	unsigned int spdif_csuv_stream;

	/* SPDIF input sample rate converter */
	struct dsp_scb_descriptor * spdif_in_src;
	/* SPDIF input asynch. receiver */
	struct dsp_scb_descriptor * asynch_rx_scb;

	/* Capture record mixer SCB */
	struct dsp_scb_descriptor * record_mixer_scb;
    
	/* CODEC input SCB */
	struct dsp_scb_descriptor * codec_in_scb;

	/* reference snooper */
	struct dsp_scb_descriptor * ref_snoop_scb;

	/* SPDIF output  PCM reference  */
	struct dsp_scb_descriptor * spdif_pcm_input_scb;

	/* asynch TX task */
	struct dsp_scb_descriptor * asynch_tx_scb;

	/* record sources */
	struct dsp_scb_descriptor * pcm_input;
	struct dsp_scb_descriptor * adc_input;

	int spdif_in_sample_rate;
};

#endif /* __DSP_SPOS_H__ */
Commit	Line	Data
1da177e4 LT	1	/*
1da177e4 LT	2	* The driver for the Cirrus Logic's Sound Fusion CS46XX based soundcards
c1017a4c	3	* Copyright (c) by Jaroslav Kysela <perex@perex.cz>
1da177e4 LT	4	*
	5	*
	6	* This program is free software; you can redistribute it and/or modify
	7	* it under the terms of the GNU General Public License as published by
	8	* the Free Software Foundation; either version 2 of the License, or
	9	* (at your option) any later version.
	10	*
	11	* This program is distributed in the hope that it will be useful,
	12	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	* GNU General Public License for more details.
	15	*
	16	* You should have received a copy of the GNU General Public License
	17	* along with this program; if not, write to the Free Software
	18	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	19	*
	20	*/
	21
	22	#ifndef __CS46XX_DSP_SPOS_H__
	23	#define __CS46XX_DSP_SPOS_H__
	24
	25	#include "cs46xx_dsp_scb_types.h"
	26	#include "cs46xx_dsp_task_types.h"
	27
	28	#define SYMBOL_CONSTANT 0x0
	29	#define SYMBOL_SAMPLE 0x1
	30	#define SYMBOL_PARAMETER 0x2
	31	#define SYMBOL_CODE 0x3
	32
	33	#define SEGTYPE_SP_PROGRAM 0x00000001
	34	#define SEGTYPE_SP_PARAMETER 0x00000002
	35	#define SEGTYPE_SP_SAMPLE 0x00000003
	36	#define SEGTYPE_SP_COEFFICIENT 0x00000004
	37
	38	#define DSP_SPOS_UU 0x0deadul /* unused */
	39	#define DSP_SPOS_DC 0x0badul /* don't care */
	40	#define DSP_SPOS_DC_DC 0x0bad0badul /* don't care */
	41	#define DSP_SPOS_UUUU 0xdeadc0edul /* unused */
	42	#define DSP_SPOS_UUHI 0xdeadul
	43	#define DSP_SPOS_UULO 0xc0edul
	44	#define DSP_SPOS_DCDC 0x0badf1d0ul /* don't care */
	45	#define DSP_SPOS_DCDCHI 0x0badul
	46	#define DSP_SPOS_DCDCLO 0xf1d0ul
	47
	48	#define DSP_MAX_TASK_NAME 60
	49	#define DSP_MAX_SYMBOL_NAME 100
	50	#define DSP_MAX_SCB_NAME 60
	51	#define DSP_MAX_SCB_DESC 200
	52	#define DSP_MAX_TASK_DESC 50
	53
	54	#define DSP_MAX_PCM_CHANNELS 32
	55	#define DSP_MAX_SRC_NR 14
	56
	57	#define DSP_PCM_MAIN_CHANNEL 1
	58	#define DSP_PCM_REAR_CHANNEL 2
	59	#define DSP_PCM_CENTER_LFE_CHANNEL 3
	60	#define DSP_PCM_S71_CHANNEL 4 /* surround 7.1 */
	61	#define DSP_IEC958_CHANNEL 5
	62
	63	#define DSP_SPDIF_STATUS_OUTPUT_ENABLED 1
	64	#define DSP_SPDIF_STATUS_PLAYBACK_OPEN 2
	65	#define DSP_SPDIF_STATUS_HW_ENABLED 4
	66	#define DSP_SPDIF_STATUS_INPUT_CTRL_ENABLED 8
	67
3d19f804	68	struct dsp_symbol_entry {
1da177e4 LT	69	u32 address;
	70	char symbol_name[DSP_MAX_SYMBOL_NAME];
	71	int symbol_type;
	72
	73	/* initialized by driver */
3d19f804	74	struct dsp_module_desc * module;
1da177e4	75	int deleted;
3d19f804	76	};
1da177e4	77
3d19f804	78	struct dsp_symbol_desc {
1da177e4 LT	79	int nsymbols;
1da177e4 LT	80
3d19f804	81	struct dsp_symbol_entry *symbols;
1da177e4 LT	82
	83	/* initialized by driver */
	84	int highest_frag_index;
3d19f804	85	};
1da177e4	86
3d19f804	87	struct dsp_segment_desc {
1da177e4 LT	88	int segment_type;
	89	u32 offset;
	90	u32 size;
	91	u32 * data;
3d19f804	92	};
1da177e4	93
3d19f804	94	struct dsp_module_desc {
1da177e4	95	char * module_name;
3d19f804	96	struct dsp_symbol_desc symbol_table;
1da177e4	97	int nsegments;
3d19f804	98	struct dsp_segment_desc * segments;
1da177e4 LT	99
	100	/* initialized by driver */
	101	u32 overlay_begin_address;
	102	u32 load_address;
	103	int nfixups;
3d19f804	104	};
1da177e4	105
3d19f804	106	struct dsp_scb_descriptor {
1da177e4 LT	107	char scb_name[DSP_MAX_SCB_NAME];
	108	u32 address;
	109	int index;
89f157d9	110	u32 *data;
1da177e4	111
3d19f804 TI	112	struct dsp_scb_descriptor * sub_list_ptr;
	113	struct dsp_scb_descriptor * next_scb_ptr;
	114	struct dsp_scb_descriptor * parent_scb_ptr;
1da177e4	115
3d19f804 TI	116	struct dsp_symbol_entry * task_entry;
3d19f804 TI	117	struct dsp_symbol_entry * scb_symbol;
1da177e4	118
3d19f804	119	struct snd_info_entry *proc_info;
1da177e4 LT	120	int ref_count;
	121	spinlock_t lock;
	122
	123	int deleted;
3d19f804	124	};
1da177e4	125
3d19f804	126	struct dsp_task_descriptor {
1da177e4 LT	127	char task_name[DSP_MAX_TASK_NAME];
	128	int size;
	129	u32 address;
	130	int index;
89f157d9	131	u32 *data;
3d19f804	132	};
1da177e4	133
3d19f804	134	struct dsp_pcm_channel_descriptor {
1da177e4 LT	135	int active;
	136	int src_slot;
	137	int pcm_slot;
	138	u32 sample_rate;
	139	u32 unlinked;
3d19f804 TI	140	struct dsp_scb_descriptor * pcm_reader_scb;
	141	struct dsp_scb_descriptor * src_scb;
	142	struct dsp_scb_descriptor * mixer_scb;
1da177e4 LT	143
1da177e4 LT	144	void * private_data;
3d19f804	145	};
1da177e4	146
3d19f804 TI	147	struct dsp_spos_instance {
3d19f804 TI	148	struct dsp_symbol_desc symbol_table; /* currently availble loaded symbols in SP */
1da177e4 LT	149
1da177e4 LT	150	int nmodules;
3d19f804	151	struct dsp_module_desc * modules; /* modules loaded into SP */
1da177e4	152
3d19f804	153	struct dsp_segment_desc code;
1da177e4 LT	154
1da177e4 LT	155	/* Main PCM playback mixer */
3d19f804	156	struct dsp_scb_descriptor * master_mix_scb;
1da177e4 LT	157	u16 dac_volume_right;
	158	u16 dac_volume_left;
	159
	160	/* Rear/surround PCM playback mixer */
3d19f804	161	struct dsp_scb_descriptor * rear_mix_scb;
1da177e4 LT	162
1da177e4 LT	163	/* Center/LFE mixer */
3d19f804	164	struct dsp_scb_descriptor * center_lfe_mix_scb;
1da177e4 LT	165
	166	int npcm_channels;
	167	int nsrc_scb;
3d19f804	168	struct dsp_pcm_channel_descriptor pcm_channels[DSP_MAX_PCM_CHANNELS];
1da177e4 LT	169	int src_scb_slots[DSP_MAX_SRC_NR];
	170
	171	/* cache this symbols */
3d19f804 TI	172	struct dsp_symbol_entry * null_algorithm; /* used by PCMreaderSCB's */
3d19f804 TI	173	struct dsp_symbol_entry * s16_up; /* used by SRCtaskSCB's */
1da177e4 LT	174
1da177e4 LT	175	/* proc fs */
3d19f804 TI	176	struct snd_card *snd_card;
	177	struct snd_info_entry * proc_dsp_dir;
	178	struct snd_info_entry * proc_sym_info_entry;
	179	struct snd_info_entry * proc_modules_info_entry;
	180	struct snd_info_entry * proc_parameter_dump_info_entry;
	181	struct snd_info_entry * proc_sample_dump_info_entry;
1da177e4 LT	182
	183	/* SCB's descriptors */
	184	int nscb;
	185	int scb_highest_frag_index;
3d19f804 TI	186	struct dsp_scb_descriptor scbs[DSP_MAX_SCB_DESC];
	187	struct snd_info_entry * proc_scb_info_entry;
	188	struct dsp_scb_descriptor * the_null_scb;
1da177e4 LT	189
	190	/* Task's descriptors */
	191	int ntask;
3d19f804 TI	192	struct dsp_task_descriptor tasks[DSP_MAX_TASK_DESC];
3d19f804 TI	193	struct snd_info_entry * proc_task_info_entry;
1da177e4 LT	194
	195	/* SPDIF status */
	196	int spdif_status_out;
	197	int spdif_status_in;
	198	u16 spdif_input_volume_right;
	199	u16 spdif_input_volume_left;
	200	/* spdif channel status,
	201	left right and user validity bits */
	202	unsigned int spdif_csuv_default;
	203	unsigned int spdif_csuv_stream;
	204
	205	/* SPDIF input sample rate converter */
3d19f804	206	struct dsp_scb_descriptor * spdif_in_src;
1da177e4	207	/* SPDIF input asynch. receiver */
3d19f804	208	struct dsp_scb_descriptor * asynch_rx_scb;
1da177e4 LT	209
1da177e4 LT	210	/* Capture record mixer SCB */
3d19f804	211	struct dsp_scb_descriptor * record_mixer_scb;
1da177e4 LT	212
1da177e4 LT	213	/* CODEC input SCB */
3d19f804	214	struct dsp_scb_descriptor * codec_in_scb;
1da177e4 LT	215
1da177e4 LT	216	/* reference snooper */
3d19f804	217	struct dsp_scb_descriptor * ref_snoop_scb;
1da177e4 LT	218
1da177e4 LT	219	/* SPDIF output PCM reference */
3d19f804	220	struct dsp_scb_descriptor * spdif_pcm_input_scb;
1da177e4 LT	221
1da177e4 LT	222	/* asynch TX task */
3d19f804	223	struct dsp_scb_descriptor * asynch_tx_scb;
1da177e4 LT	224
1da177e4 LT	225	/* record sources */
3d19f804 TI	226	struct dsp_scb_descriptor * pcm_input;
3d19f804 TI	227	struct dsp_scb_descriptor * adc_input;
1da177e4 LT	228
1da177e4 LT	229	int spdif_in_sample_rate;
3d19f804	230	};
1da177e4 LT	231
1da177e4 LT	232	#endif /* __DSP_SPOS_H__ */