[deliverable/linux.git] / sound / soc / intel / sst-mfld-platform.h

/*
 *  sst_mfld_platform.h - Intel MID Platform driver header file
 *
 *  Copyright (C) 2010 Intel Corp
 *  Author: Vinod Koul <vinod.koul@intel.com>
 *  Author: Harsha Priya <priya.harsha@intel.com>
 *  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 *
 *  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; version 2 of the License.
 *
 *  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.
 *
 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 */

#ifndef __SST_PLATFORMDRV_H__
#define __SST_PLATFORMDRV_H__

#include "sst-mfld-dsp.h"

extern struct sst_device *sst;

#define SST_MONO		1
#define SST_STEREO		2
#define SST_MAX_CAP		5

#define SST_MAX_BUFFER		(800*1024)
#define SST_MIN_BUFFER		(800*1024)
#define SST_MIN_PERIOD_BYTES	32
#define SST_MAX_PERIOD_BYTES	SST_MAX_BUFFER
#define SST_MIN_PERIODS		2
#define SST_MAX_PERIODS		(1024*2)
#define SST_FIFO_SIZE		0

struct pcm_stream_info {
	int str_id;
	void *arg;
	void (*period_elapsed) (void *arg);
	unsigned long long buffer_ptr;
	unsigned long long pcm_delay;
	int sfreq;
};

enum sst_drv_status {
	SST_PLATFORM_INIT = 1,
	SST_PLATFORM_STARTED,
	SST_PLATFORM_RUNNING,
	SST_PLATFORM_PAUSED,
	SST_PLATFORM_DROPPED,
};

enum sst_controls {
	SST_SND_ALLOC =			0x00,
	SST_SND_PAUSE =			0x01,
	SST_SND_RESUME =		0x02,
	SST_SND_DROP =			0x03,
	SST_SND_FREE =			0x04,
	SST_SND_BUFFER_POINTER =	0x05,
	SST_SND_STREAM_INIT =		0x06,
	SST_SND_START	 =		0x07,
	SST_SET_BYTE_STREAM =           0x100A,
	SST_GET_BYTE_STREAM =           0x100B,
	SST_MAX_CONTROLS = SST_GET_BYTE_STREAM,
};

enum sst_stream_ops {
	STREAM_OPS_PLAYBACK = 0,
	STREAM_OPS_CAPTURE,
};

enum sst_audio_device_type {
	SND_SST_DEVICE_HEADSET = 1,
	SND_SST_DEVICE_IHF,
	SND_SST_DEVICE_VIBRA,
	SND_SST_DEVICE_HAPTIC,
	SND_SST_DEVICE_CAPTURE,
	SND_SST_DEVICE_COMPRESS,
};

/* PCM Parameters */
struct sst_pcm_params {
	u16 codec;	/* codec type */
	u8 num_chan;	/* 1=Mono, 2=Stereo */
	u8 pcm_wd_sz;	/* 16/24 - bit*/
	u32 reserved;	/* Bitrate in bits per second */
	u32 sfreq;	/* Sampling rate in Hz */
	u32 ring_buffer_size;
	u32 period_count;	/* period elapsed in samples*/
	u32 ring_buffer_addr;
};

struct sst_stream_params {
	u32 result;
	u32 stream_id;
	u8 codec;
	u8 ops;
	u8 stream_type;
	u8 device_type;
	struct sst_pcm_params sparams;
};

struct sst_compress_cb {
	void *param;
	void (*compr_cb)(void *param);
	void *drain_cb_param;
	void (*drain_notify)(void *param);
};

struct compress_sst_ops {
	const char *name;
	int (*open) (struct snd_sst_params *str_params,
			struct sst_compress_cb *cb);
	int (*control) (unsigned int cmd, unsigned int str_id);
	int (*tstamp) (unsigned int str_id, struct snd_compr_tstamp *tstamp);
	int (*ack) (unsigned int str_id, unsigned long bytes);
	int (*close) (unsigned int str_id);
	int (*get_caps) (struct snd_compr_caps *caps);
	int (*get_codec_caps) (struct snd_compr_codec_caps *codec);
	int (*set_metadata) (unsigned int str_id,
			struct snd_compr_metadata *mdata);

};

struct sst_ops {
	int (*open) (struct snd_sst_params *str_param);
	int (*device_control) (int cmd, void *arg);
	int (*set_generic_params)(enum sst_controls cmd, void *arg);
	int (*close) (unsigned int str_id);
};

struct sst_runtime_stream {
	int     stream_status;
	unsigned int id;
	size_t bytes_written;
	struct pcm_stream_info stream_info;
	struct sst_ops *ops;
	struct compress_sst_ops *compr_ops;
	spinlock_t	status_lock;
};

struct sst_device {
	char *name;
	struct device *dev;
	struct sst_ops *ops;
	struct platform_device *pdev;
	struct compress_sst_ops *compr_ops;
};

struct sst_data;
void sst_set_stream_status(struct sst_runtime_stream *stream, int state);
int sst_fill_stream_params(void *substream, const struct sst_data *ctx,
			   struct snd_sst_params *str_params, bool is_compress);

struct sst_algo_int_control_v2 {
	struct soc_mixer_control mc;
	u16 module_id; /* module identifieer */
	u16 pipe_id; /* location info: pipe_id + instance_id */
	u16 instance_id;
	unsigned int value; /* Value received is stored here */
};
struct sst_data {
	struct platform_device *pdev;
	struct sst_platform_data *pdata;
	struct mutex lock;
};
int sst_register_dsp(struct sst_device *sst);
int sst_unregister_dsp(struct sst_device *sst);
#endif
Commit	Line	Data
d927fdae	1	/*
a4b12990	2	* sst_mfld_platform.h - Intel MID Platform driver header file
d927fdae VK	3	*
	4	* Copyright (C) 2010 Intel Corp
	5	* Author: Vinod Koul <vinod.koul@intel.com>
	6	* Author: Harsha Priya <priya.harsha@intel.com>
	7	* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	8	*
	9	* This program is free software; you can redistribute it and/or modify
	10	* it under the terms of the GNU General Public License as published by
	11	* the Free Software Foundation; version 2 of the License.
	12	*
	13	* This program is distributed in the hope that it will be useful, but
	14	* WITHOUT ANY WARRANTY; without even the implied warranty of
	15	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	16	* General Public License for more details.
	17	*
d927fdae	18	* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
d927fdae VK	19	*/
	20
	21	#ifndef __SST_PLATFORMDRV_H__
	22	#define __SST_PLATFORMDRV_H__
	23
a4b12990	24	#include "sst-mfld-dsp.h"
c514a911	25
4b68b4e1 VK	26	extern struct sst_device *sst;
4b68b4e1 VK	27
d927fdae VK	28	#define SST_MONO 1
	29	#define SST_STEREO 2
	30	#define SST_MAX_CAP 5
	31
d927fdae VK	32	#define SST_MAX_BUFFER (800*1024)
	33	#define SST_MIN_BUFFER (800*1024)
	34	#define SST_MIN_PERIOD_BYTES 32
	35	#define SST_MAX_PERIOD_BYTES SST_MAX_BUFFER
	36	#define SST_MIN_PERIODS 2
	37	#define SST_MAX_PERIODS (1024*2)
	38	#define SST_FIFO_SIZE 0
d927fdae	39
03c33042 VK	40	struct pcm_stream_info {
03c33042 VK	41	int str_id;
9daa5bd3 VK	42	void *arg;
9daa5bd3 VK	43	void (period_elapsed) (void arg);
03c33042	44	unsigned long long buffer_ptr;
2a635825	45	unsigned long long pcm_delay;
03c33042	46	int sfreq;
d927fdae VK	47	};
	48
	49	enum sst_drv_status {
	50	SST_PLATFORM_INIT = 1,
	51	SST_PLATFORM_STARTED,
	52	SST_PLATFORM_RUNNING,
	53	SST_PLATFORM_PAUSED,
	54	SST_PLATFORM_DROPPED,
	55	};
	56
03c33042 VK	57	enum sst_controls {
	58	SST_SND_ALLOC = 0x00,
	59	SST_SND_PAUSE = 0x01,
	60	SST_SND_RESUME = 0x02,
	61	SST_SND_DROP = 0x03,
	62	SST_SND_FREE = 0x04,
	63	SST_SND_BUFFER_POINTER = 0x05,
	64	SST_SND_STREAM_INIT = 0x06,
	65	SST_SND_START = 0x07,
e310fb91 VK	66	SST_SET_BYTE_STREAM = 0x100A,
	67	SST_GET_BYTE_STREAM = 0x100B,
	68	SST_MAX_CONTROLS = SST_GET_BYTE_STREAM,
03c33042 VK	69	};
	70
	71	enum sst_stream_ops {
	72	STREAM_OPS_PLAYBACK = 0,
	73	STREAM_OPS_CAPTURE,
	74	};
	75
	76	enum sst_audio_device_type {
	77	SND_SST_DEVICE_HEADSET = 1,
	78	SND_SST_DEVICE_IHF,
	79	SND_SST_DEVICE_VIBRA,
	80	SND_SST_DEVICE_HAPTIC,
	81	SND_SST_DEVICE_CAPTURE,
c514a911	82	SND_SST_DEVICE_COMPRESS,
03c33042 VK	83	};
	84
	85	/* PCM Parameters */
	86	struct sst_pcm_params {
	87	u16 codec; /* codec type */
	88	u8 num_chan; /* 1=Mono, 2=Stereo */
	89	u8 pcm_wd_sz; /* 16/24 - bit*/
	90	u32 reserved; /* Bitrate in bits per second */
	91	u32 sfreq; /* Sampling rate in Hz */
	92	u32 ring_buffer_size;
	93	u32 period_count; /* period elapsed in samples*/
	94	u32 ring_buffer_addr;
	95	};
	96
	97	struct sst_stream_params {
	98	u32 result;
	99	u32 stream_id;
	100	u8 codec;
	101	u8 ops;
	102	u8 stream_type;
	103	u8 device_type;
	104	struct sst_pcm_params sparams;
	105	};
	106
c514a911 VK	107	struct sst_compress_cb {
	108	void *param;
	109	void (compr_cb)(void param);
bd17aa45 VK	110	void *drain_cb_param;
bd17aa45 VK	111	void (drain_notify)(void param);
c514a911 VK	112	};
	113
	114	struct compress_sst_ops {
	115	const char *name;
	116	int (open) (struct snd_sst_params str_params,
	117	struct sst_compress_cb *cb);
	118	int (*control) (unsigned int cmd, unsigned int str_id);
	119	int (tstamp) (unsigned int str_id, struct snd_compr_tstamp tstamp);
	120	int (*ack) (unsigned int str_id, unsigned long bytes);
	121	int (*close) (unsigned int str_id);
	122	int (get_caps) (struct snd_compr_caps caps);
	123	int (get_codec_caps) (struct snd_compr_codec_caps codec);
0cd5751a VK	124	int (*set_metadata) (unsigned int str_id,
0cd5751a VK	125	struct snd_compr_metadata *mdata);
c514a911 VK	126
	127	};
	128
03c33042	129	struct sst_ops {
a870cdce	130	int (open) (struct snd_sst_params str_param);
03c33042	131	int (device_control) (int cmd, void arg);
e310fb91	132	int (set_generic_params)(enum sst_controls cmd, void arg);
03c33042 VK	133	int (*close) (unsigned int str_id);
	134	};
	135
	136	struct sst_runtime_stream {
	137	int stream_status;
c514a911 VK	138	unsigned int id;
c514a911 VK	139	size_t bytes_written;
03c33042 VK	140	struct pcm_stream_info stream_info;
03c33042 VK	141	struct sst_ops *ops;
c514a911	142	struct compress_sst_ops *compr_ops;
03c33042 VK	143	spinlock_t status_lock;
	144	};
	145
	146	struct sst_device {
	147	char *name;
	148	struct device *dev;
	149	struct sst_ops *ops;
61b165ca	150	struct platform_device *pdev;
c514a911	151	struct compress_sst_ops *compr_ops;
03c33042 VK	152	};
03c33042 VK	153
61b165ca	154	struct sst_data;
4496ffab	155	void sst_set_stream_status(struct sst_runtime_stream *stream, int state);
0ec66fed VK	156	int sst_fill_stream_params(void substream, const struct sst_data ctx,
	157	struct snd_sst_params *str_params, bool is_compress);
	158
61b165ca VK	159	struct sst_algo_int_control_v2 {
	160	struct soc_mixer_control mc;
	161	u16 module_id; /* module identifieer */
	162	u16 pipe_id; /* location info: pipe_id + instance_id */
	163	u16 instance_id;
	164	unsigned int value; /* Value received is stored here */
	165	};
61b165ca VK	166	struct sst_data {
	167	struct platform_device *pdev;
	168	struct sst_platform_data *pdata;
	169	struct mutex lock;
	170	};
03c33042 VK	171	int sst_register_dsp(struct sst_device *sst);
03c33042 VK	172	int sst_unregister_dsp(struct sst_device *sst);
d927fdae	173	#endif