[deliverable/linux.git] / sound / soc / sh / rcar / rsnd.h

/*
 * Renesas R-Car
 *
 * Copyright (C) 2013 Renesas Solutions Corp.
 * Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 */
#ifndef RSND_H
#define RSND_H

#include <linux/clk.h>
#include <linux/device.h>
#include <linux/dma-mapping.h>
#include <linux/io.h>
#include <linux/list.h>
#include <linux/module.h>
#include <linux/sh_dma.h>
#include <linux/workqueue.h>
#include <sound/rcar_snd.h>
#include <sound/soc.h>
#include <sound/pcm_params.h>

/*
 *	pseudo register
 *
 * The register address offsets SRU/SCU/SSIU on Gen1/Gen2 are very different.
 * This driver uses pseudo register in order to hide it.
 * see gen1/gen2 for detail
 */
enum rsnd_reg {
	/* SRU/SCU */
	RSND_REG_SRC_ROUTE_SEL,
	RSND_REG_SRC_TMG_SEL0,
	RSND_REG_SRC_TMG_SEL1,
	RSND_REG_SRC_TMG_SEL2,
	RSND_REG_SRC_CTRL,
	RSND_REG_SSI_MODE0,
	RSND_REG_SSI_MODE1,
	RSND_REG_BUSIF_MODE,
	RSND_REG_BUSIF_ADINR,

	/* ADG */
	RSND_REG_BRRA,
	RSND_REG_BRRB,
	RSND_REG_SSICKR,
	RSND_REG_AUDIO_CLK_SEL0,
	RSND_REG_AUDIO_CLK_SEL1,
	RSND_REG_AUDIO_CLK_SEL2,

	/* SSI */
	RSND_REG_SSICR,
	RSND_REG_SSISR,
	RSND_REG_SSITDR,
	RSND_REG_SSIRDR,
	RSND_REG_SSIWSR,

	RSND_REG_MAX,
};

struct rsnd_priv;
struct rsnd_mod;
struct rsnd_dai;
struct rsnd_dai_stream;

/*
 *	R-Car basic functions
 */
#define rsnd_mod_read(m, r) \
	rsnd_read(rsnd_mod_to_priv(m), m, RSND_REG_##r)
#define rsnd_mod_write(m, r, d) \
	rsnd_write(rsnd_mod_to_priv(m), m, RSND_REG_##r, d)
#define rsnd_mod_bset(m, r, s, d) \
	rsnd_bset(rsnd_mod_to_priv(m), m, RSND_REG_##r, s, d)

u32 rsnd_read(struct rsnd_priv *priv, struct rsnd_mod *mod, enum rsnd_reg reg);
void rsnd_write(struct rsnd_priv *priv, struct rsnd_mod *mod,
		enum rsnd_reg reg, u32 data);
void rsnd_bset(struct rsnd_priv *priv, struct rsnd_mod *mod, enum rsnd_reg reg,
		    u32 mask, u32 data);

/*
 *	R-Car DMA
 */
struct rsnd_dma {
	struct rsnd_priv	*priv;
	struct sh_dmae_slave	slave;
	struct work_struct	work;
	struct dma_chan		*chan;
	enum dma_data_direction dir;
	int (*inquiry)(struct rsnd_dma *dma, dma_addr_t *buf, int *len);
	int (*complete)(struct rsnd_dma *dma);

	int submit_loop;
};

void rsnd_dma_start(struct rsnd_dma *dma);
void rsnd_dma_stop(struct rsnd_dma *dma);
int rsnd_dma_available(struct rsnd_dma *dma);
int rsnd_dma_init(struct rsnd_priv *priv, struct rsnd_dma *dma,
	int is_play, int id,
	int (*inquiry)(struct rsnd_dma *dma, dma_addr_t *buf, int *len),
	int (*complete)(struct rsnd_dma *dma));
void  rsnd_dma_quit(struct rsnd_priv *priv,
		    struct rsnd_dma *dma);


/*
 *	R-Car sound mod
 */

struct rsnd_mod_ops {
	char *name;
	int (*init)(struct rsnd_mod *mod,
		    struct rsnd_dai *rdai,
		    struct rsnd_dai_stream *io);
	int (*quit)(struct rsnd_mod *mod,
		    struct rsnd_dai *rdai,
		    struct rsnd_dai_stream *io);
	int (*start)(struct rsnd_mod *mod,
		     struct rsnd_dai *rdai,
		     struct rsnd_dai_stream *io);
	int (*stop)(struct rsnd_mod *mod,
		    struct rsnd_dai *rdai,
		    struct rsnd_dai_stream *io);
};

struct rsnd_mod {
	int id;
	struct rsnd_priv *priv;
	struct rsnd_mod_ops *ops;
	struct list_head list; /* connect to rsnd_dai playback/capture */
	struct rsnd_dma dma;
};

#define rsnd_mod_to_priv(mod) ((mod)->priv)
#define rsnd_mod_to_dma(mod) (&(mod)->dma)
#define rsnd_dma_to_mod(_dma) container_of((_dma), struct rsnd_mod, dma)
#define rsnd_mod_id(mod) ((mod)->id)
#define for_each_rsnd_mod(pos, n, io)	\
	list_for_each_entry_safe(pos, n, &(io)->head, list)
#define rsnd_mod_call(mod, func, rdai, io)	\
	(!(mod) ? -ENODEV :			\
	 !((mod)->ops->func) ? 0 :		\
	 (mod)->ops->func(mod, rdai, io))

void rsnd_mod_init(struct rsnd_priv *priv,
		   struct rsnd_mod *mod,
		   struct rsnd_mod_ops *ops,
		   int id);
char *rsnd_mod_name(struct rsnd_mod *mod);

/*
 *	R-Car sound DAI
 */
#define RSND_DAI_NAME_SIZE	16
struct rsnd_dai_stream {
	struct list_head head; /* head of rsnd_mod list */
	struct snd_pcm_substream *substream;
	int byte_pos;
	int period_pos;
	int byte_per_period;
	int next_period_byte;
};

struct rsnd_dai {
	char name[RSND_DAI_NAME_SIZE];
	struct rsnd_dai_platform_info *info; /* rcar_snd.h */
	struct rsnd_dai_stream playback;
	struct rsnd_dai_stream capture;

	unsigned int clk_master:1;
	unsigned int bit_clk_inv:1;
	unsigned int frm_clk_inv:1;
	unsigned int sys_delay:1;
	unsigned int data_alignment:1;
};

#define rsnd_dai_nr(priv) ((priv)->dai_nr)
#define for_each_rsnd_dai(rdai, priv, i)		\
	for (i = 0, (rdai) = rsnd_dai_get(priv, i);	\
	     i < rsnd_dai_nr(priv);			\
	     i++, (rdai) = rsnd_dai_get(priv, i))

struct rsnd_dai *rsnd_dai_get(struct rsnd_priv *priv, int id);
int rsnd_dai_disconnect(struct rsnd_mod *mod);
int rsnd_dai_connect(struct rsnd_dai *rdai, struct rsnd_mod *mod,
		     struct rsnd_dai_stream *io);
int rsnd_dai_is_play(struct rsnd_dai *rdai, struct rsnd_dai_stream *io);
int rsnd_dai_id(struct rsnd_priv *priv, struct rsnd_dai *rdai);
#define rsnd_dai_get_platform_info(rdai) ((rdai)->info)
#define rsnd_io_to_runtime(io) ((io)->substream->runtime)

void rsnd_dai_pointer_update(struct rsnd_dai_stream *io, int cnt);
int rsnd_dai_pointer_offset(struct rsnd_dai_stream *io, int additional);

/*
 *	R-Car Gen1/Gen2
 */
int rsnd_gen_probe(struct platform_device *pdev,
		   struct rcar_snd_info *info,
		   struct rsnd_priv *priv);
void rsnd_gen_remove(struct platform_device *pdev,
		     struct rsnd_priv *priv);
int rsnd_gen_path_init(struct rsnd_priv *priv,
		       struct rsnd_dai *rdai,
		       struct rsnd_dai_stream *io);
int rsnd_gen_path_exit(struct rsnd_priv *priv,
		       struct rsnd_dai *rdai,
		       struct rsnd_dai_stream *io);
void __iomem *rsnd_gen_reg_get(struct rsnd_priv *priv,
			       struct rsnd_mod *mod,
			       enum rsnd_reg reg);
#define rsnd_is_gen1(s)		(((s)->info->flags & RSND_GEN_MASK) == RSND_GEN1)
#define rsnd_is_gen2(s)		(((s)->info->flags & RSND_GEN_MASK) == RSND_GEN2)

/*
 *	R-Car ADG
 */
int rsnd_adg_ssi_clk_stop(struct rsnd_mod *mod);
int rsnd_adg_ssi_clk_try_start(struct rsnd_mod *mod, unsigned int rate);
int rsnd_adg_probe(struct platform_device *pdev,
		   struct rcar_snd_info *info,
		   struct rsnd_priv *priv);
void rsnd_adg_remove(struct platform_device *pdev,
		   struct rsnd_priv *priv);

/*
 *	R-Car sound priv
 */
struct rsnd_priv {

	struct device *dev;
	struct rcar_snd_info *info;
	spinlock_t lock;

	/*
	 * below value will be filled on rsnd_gen_probe()
	 */
	void *gen;

	/*
	 * below value will be filled on rsnd_scu_probe()
	 */
	void *scu;
	int scu_nr;

	/*
	 * below value will be filled on rsnd_adg_probe()
	 */
	void *adg;

	/*
	 * below value will be filled on rsnd_ssi_probe()
	 */
	void *ssiu;

	/*
	 * below value will be filled on rsnd_dai_probe()
	 */
	struct snd_soc_dai_driver *daidrv;
	struct rsnd_dai *rdai;
	int dai_nr;
};

#define rsnd_priv_to_dev(priv)	((priv)->dev)
#define rsnd_lock(priv, flags) spin_lock_irqsave(&priv->lock, flags)
#define rsnd_unlock(priv, flags) spin_unlock_irqrestore(&priv->lock, flags)

/*
 *	R-Car SCU
 */
int rsnd_scu_probe(struct platform_device *pdev,
		   struct rcar_snd_info *info,
		   struct rsnd_priv *priv);
void rsnd_scu_remove(struct platform_device *pdev,
		     struct rsnd_priv *priv);
struct rsnd_mod *rsnd_scu_mod_get(struct rsnd_priv *priv, int id);
bool rsnd_scu_hpbif_is_enable(struct rsnd_mod *mod);
#define rsnd_scu_nr(priv) ((priv)->scu_nr)

/*
 *	R-Car SSI
 */
int rsnd_ssi_probe(struct platform_device *pdev,
		   struct rcar_snd_info *info,
		   struct rsnd_priv *priv);
void rsnd_ssi_remove(struct platform_device *pdev,
		   struct rsnd_priv *priv);
struct rsnd_mod *rsnd_ssi_mod_get(struct rsnd_priv *priv, int id);
struct rsnd_mod *rsnd_ssi_mod_get_frm_dai(struct rsnd_priv *priv,
					  int dai_id, int is_play);

#endif
Commit	Line	Data
1536a968 KM	1	/*
	2	* Renesas R-Car
	3	*
	4	* Copyright (C) 2013 Renesas Solutions Corp.
	5	* Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
	6	*
	7	* This program is free software; you can redistribute it and/or modify
	8	* it under the terms of the GNU General Public License version 2 as
	9	* published by the Free Software Foundation.
	10	*/
	11	#ifndef RSND_H
	12	#define RSND_H
	13
	14	#include <linux/clk.h>
	15	#include <linux/device.h>
0a4d94c0	16	#include <linux/dma-mapping.h>
1536a968 KM	17	#include <linux/io.h>
	18	#include <linux/list.h>
	19	#include <linux/module.h>
0a4d94c0 KM	20	#include <linux/sh_dma.h>
0a4d94c0 KM	21	#include <linux/workqueue.h>
1536a968 KM	22	#include <sound/rcar_snd.h>
	23	#include <sound/soc.h>
	24	#include <sound/pcm_params.h>
	25
	26	/*
	27	* pseudo register
	28	*
	29	* The register address offsets SRU/SCU/SSIU on Gen1/Gen2 are very different.
	30	* This driver uses pseudo register in order to hide it.
	31	* see gen1/gen2 for detail
	32	*/
3337744a	33	enum rsnd_reg {
07539c1d	34	/* SRU/SCU */
374a5281 KM	35	RSND_REG_SRC_ROUTE_SEL,
	36	RSND_REG_SRC_TMG_SEL0,
	37	RSND_REG_SRC_TMG_SEL1,
	38	RSND_REG_SRC_TMG_SEL2,
	39	RSND_REG_SRC_CTRL,
07539c1d KM	40	RSND_REG_SSI_MODE0,
07539c1d KM	41	RSND_REG_SSI_MODE1,
374a5281 KM	42	RSND_REG_BUSIF_MODE,
374a5281 KM	43	RSND_REG_BUSIF_ADINR,
07539c1d	44
dfc9403b KM	45	/* ADG */
	46	RSND_REG_BRRA,
	47	RSND_REG_BRRB,
	48	RSND_REG_SSICKR,
	49	RSND_REG_AUDIO_CLK_SEL0,
	50	RSND_REG_AUDIO_CLK_SEL1,
	51	RSND_REG_AUDIO_CLK_SEL2,
dfc9403b	52
ae5c3223 KM	53	/* SSI */
	54	RSND_REG_SSICR,
	55	RSND_REG_SSISR,
	56	RSND_REG_SSITDR,
	57	RSND_REG_SSIRDR,
	58	RSND_REG_SSIWSR,
	59
3337744a KM	60	RSND_REG_MAX,
	61	};
	62
1536a968	63	struct rsnd_priv;
cdaa3cdf	64	struct rsnd_mod;
1536a968 KM	65	struct rsnd_dai;
	66	struct rsnd_dai_stream;
	67
3337744a KM	68	/*
	69	* R-Car basic functions
	70	*/
	71	#define rsnd_mod_read(m, r) \
	72	rsnd_read(rsnd_mod_to_priv(m), m, RSND_REG_##r)
	73	#define rsnd_mod_write(m, r, d) \
	74	rsnd_write(rsnd_mod_to_priv(m), m, RSND_REG_##r, d)
	75	#define rsnd_mod_bset(m, r, s, d) \
	76	rsnd_bset(rsnd_mod_to_priv(m), m, RSND_REG_##r, s, d)
	77
3337744a KM	78	u32 rsnd_read(struct rsnd_priv priv, struct rsnd_mod mod, enum rsnd_reg reg);
	79	void rsnd_write(struct rsnd_priv priv, struct rsnd_mod mod,
	80	enum rsnd_reg reg, u32 data);
	81	void rsnd_bset(struct rsnd_priv priv, struct rsnd_mod mod, enum rsnd_reg reg,
	82	u32 mask, u32 data);
	83
0a4d94c0 KM	84	/*
	85	* R-Car DMA
	86	*/
	87	struct rsnd_dma {
	88	struct rsnd_priv *priv;
	89	struct sh_dmae_slave slave;
	90	struct work_struct work;
	91	struct dma_chan *chan;
	92	enum dma_data_direction dir;
	93	int (inquiry)(struct rsnd_dma dma, dma_addr_t buf, int len);
	94	int (complete)(struct rsnd_dma dma);
	95
	96	int submit_loop;
	97	};
	98
	99	void rsnd_dma_start(struct rsnd_dma *dma);
	100	void rsnd_dma_stop(struct rsnd_dma *dma);
	101	int rsnd_dma_available(struct rsnd_dma *dma);
	102	int rsnd_dma_init(struct rsnd_priv priv, struct rsnd_dma dma,
	103	int is_play, int id,
	104	int (inquiry)(struct rsnd_dma dma, dma_addr_t buf, int len),
	105	int (complete)(struct rsnd_dma dma));
	106	void rsnd_dma_quit(struct rsnd_priv *priv,
	107	struct rsnd_dma *dma);
	108
	109
cdaa3cdf KM	110	/*
	111	* R-Car sound mod
	112	*/
	113
	114	struct rsnd_mod_ops {
	115	char *name;
	116	int (init)(struct rsnd_mod mod,
	117	struct rsnd_dai *rdai,
	118	struct rsnd_dai_stream *io);
	119	int (quit)(struct rsnd_mod mod,
	120	struct rsnd_dai *rdai,
	121	struct rsnd_dai_stream *io);
	122	int (start)(struct rsnd_mod mod,
	123	struct rsnd_dai *rdai,
	124	struct rsnd_dai_stream *io);
	125	int (stop)(struct rsnd_mod mod,
	126	struct rsnd_dai *rdai,
	127	struct rsnd_dai_stream *io);
	128	};
	129
	130	struct rsnd_mod {
	131	int id;
	132	struct rsnd_priv *priv;
	133	struct rsnd_mod_ops *ops;
	134	struct list_head list; /* connect to rsnd_dai playback/capture */
0a4d94c0	135	struct rsnd_dma dma;
cdaa3cdf KM	136	};
	137
	138	#define rsnd_mod_to_priv(mod) ((mod)->priv)
0a4d94c0 KM	139	#define rsnd_mod_to_dma(mod) (&(mod)->dma)
0a4d94c0 KM	140	#define rsnd_dma_to_mod(_dma) container_of((_dma), struct rsnd_mod, dma)
cdaa3cdf KM	141	#define rsnd_mod_id(mod) ((mod)->id)
	142	#define for_each_rsnd_mod(pos, n, io) \
	143	list_for_each_entry_safe(pos, n, &(io)->head, list)
	144	#define rsnd_mod_call(mod, func, rdai, io) \
	145	(!(mod) ? -ENODEV : \
	146	!((mod)->ops->func) ? 0 : \
	147	(mod)->ops->func(mod, rdai, io))
	148
	149	void rsnd_mod_init(struct rsnd_priv *priv,
	150	struct rsnd_mod *mod,
	151	struct rsnd_mod_ops *ops,
	152	int id);
	153	char rsnd_mod_name(struct rsnd_mod mod);
	154
1536a968 KM	155	/*
	156	* R-Car sound DAI
	157	*/
	158	#define RSND_DAI_NAME_SIZE 16
	159	struct rsnd_dai_stream {
	160	struct list_head head; /* head of rsnd_mod list */
	161	struct snd_pcm_substream *substream;
	162	int byte_pos;
	163	int period_pos;
	164	int byte_per_period;
	165	int next_period_byte;
	166	};
	167
	168	struct rsnd_dai {
	169	char name[RSND_DAI_NAME_SIZE];
	170	struct rsnd_dai_platform_info info; / rcar_snd.h */
	171	struct rsnd_dai_stream playback;
	172	struct rsnd_dai_stream capture;
	173
a3737731 DC	174	unsigned int clk_master:1;
	175	unsigned int bit_clk_inv:1;
	176	unsigned int frm_clk_inv:1;
	177	unsigned int sys_delay:1;
	178	unsigned int data_alignment:1;
1536a968 KM	179	};
	180
	181	#define rsnd_dai_nr(priv) ((priv)->dai_nr)
	182	#define for_each_rsnd_dai(rdai, priv, i) \
	183	for (i = 0, (rdai) = rsnd_dai_get(priv, i); \
	184	i < rsnd_dai_nr(priv); \
	185	i++, (rdai) = rsnd_dai_get(priv, i))
	186
	187	struct rsnd_dai rsnd_dai_get(struct rsnd_priv priv, int id);
cdaa3cdf KM	188	int rsnd_dai_disconnect(struct rsnd_mod *mod);
	189	int rsnd_dai_connect(struct rsnd_dai rdai, struct rsnd_mod mod,
	190	struct rsnd_dai_stream *io);
1536a968	191	int rsnd_dai_is_play(struct rsnd_dai rdai, struct rsnd_dai_stream io);
4b4dab82	192	int rsnd_dai_id(struct rsnd_priv priv, struct rsnd_dai rdai);
1536a968	193	#define rsnd_dai_get_platform_info(rdai) ((rdai)->info)
ae5c3223	194	#define rsnd_io_to_runtime(io) ((io)->substream->runtime)
1536a968 KM	195
	196	void rsnd_dai_pointer_update(struct rsnd_dai_stream *io, int cnt);
	197	int rsnd_dai_pointer_offset(struct rsnd_dai_stream *io, int additional);
	198
3337744a KM	199	/*
	200	* R-Car Gen1/Gen2
	201	*/
	202	int rsnd_gen_probe(struct platform_device *pdev,
	203	struct rcar_snd_info *info,
	204	struct rsnd_priv *priv);
	205	void rsnd_gen_remove(struct platform_device *pdev,
	206	struct rsnd_priv *priv);
	207	int rsnd_gen_path_init(struct rsnd_priv *priv,
	208	struct rsnd_dai *rdai,
	209	struct rsnd_dai_stream *io);
	210	int rsnd_gen_path_exit(struct rsnd_priv *priv,
	211	struct rsnd_dai *rdai,
	212	struct rsnd_dai_stream *io);
	213	void __iomem rsnd_gen_reg_get(struct rsnd_priv priv,
	214	struct rsnd_mod *mod,
	215	enum rsnd_reg reg);
c5d5a58d KM	216	#define rsnd_is_gen1(s) (((s)->info->flags & RSND_GEN_MASK) == RSND_GEN1)
c5d5a58d KM	217	#define rsnd_is_gen2(s) (((s)->info->flags & RSND_GEN_MASK) == RSND_GEN2)
3337744a	218
dfc9403b KM	219	/*
	220	* R-Car ADG
	221	*/
	222	int rsnd_adg_ssi_clk_stop(struct rsnd_mod *mod);
	223	int rsnd_adg_ssi_clk_try_start(struct rsnd_mod *mod, unsigned int rate);
	224	int rsnd_adg_probe(struct platform_device *pdev,
	225	struct rcar_snd_info *info,
	226	struct rsnd_priv *priv);
	227	void rsnd_adg_remove(struct platform_device *pdev,
	228	struct rsnd_priv *priv);
	229
1536a968 KM	230	/*
	231	* R-Car sound priv
	232	*/
	233	struct rsnd_priv {
	234
	235	struct device *dev;
	236	struct rcar_snd_info *info;
	237	spinlock_t lock;
	238
3337744a KM	239	/*
	240	* below value will be filled on rsnd_gen_probe()
	241	*/
	242	void *gen;
	243
07539c1d KM	244	/*
	245	* below value will be filled on rsnd_scu_probe()
	246	*/
	247	void *scu;
	248	int scu_nr;
	249
dfc9403b KM	250	/*
	251	* below value will be filled on rsnd_adg_probe()
	252	*/
	253	void *adg;
	254
ae5c3223 KM	255	/*
	256	* below value will be filled on rsnd_ssi_probe()
	257	*/
	258	void *ssiu;
	259
1536a968 KM	260	/*
	261	* below value will be filled on rsnd_dai_probe()
	262	*/
	263	struct snd_soc_dai_driver *daidrv;
	264	struct rsnd_dai *rdai;
	265	int dai_nr;
	266	};
	267
	268	#define rsnd_priv_to_dev(priv) ((priv)->dev)
	269	#define rsnd_lock(priv, flags) spin_lock_irqsave(&priv->lock, flags)
	270	#define rsnd_unlock(priv, flags) spin_unlock_irqrestore(&priv->lock, flags)
	271
07539c1d KM	272	/*
	273	* R-Car SCU
	274	*/
	275	int rsnd_scu_probe(struct platform_device *pdev,
	276	struct rcar_snd_info *info,
	277	struct rsnd_priv *priv);
	278	void rsnd_scu_remove(struct platform_device *pdev,
	279	struct rsnd_priv *priv);
	280	struct rsnd_mod rsnd_scu_mod_get(struct rsnd_priv priv, int id);
cdcfcac9	281	bool rsnd_scu_hpbif_is_enable(struct rsnd_mod *mod);
07539c1d KM	282	#define rsnd_scu_nr(priv) ((priv)->scu_nr)
07539c1d KM	283
ae5c3223 KM	284	/*
	285	* R-Car SSI
	286	*/
	287	int rsnd_ssi_probe(struct platform_device *pdev,
	288	struct rcar_snd_info *info,
	289	struct rsnd_priv *priv);
	290	void rsnd_ssi_remove(struct platform_device *pdev,
	291	struct rsnd_priv *priv);
	292	struct rsnd_mod rsnd_ssi_mod_get(struct rsnd_priv priv, int id);
4b4dab82 KM	293	struct rsnd_mod rsnd_ssi_mod_get_frm_dai(struct rsnd_priv priv,
4b4dab82 KM	294	int dai_id, int is_play);
ae5c3223	295
1536a968	296	#endif