[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/io.h>
#include <linux/list.h>
#include <linux/module.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_SSI_MODE0,
	RSND_REG_SSI_MODE1,

	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)

#define rsnd_priv_read(p, r)		rsnd_read(p, NULL, RSND_REG_##r)
#define rsnd_priv_write(p, r, d)	rsnd_write(p, NULL, RSND_REG_##r, d)
#define rsnd_priv_bset(p, r, s, d)	rsnd_bset(p, NULL, 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 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 */
};

#define rsnd_mod_to_priv(mod) ((mod)->priv)
#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;

	int clk_master:1;
	int bit_clk_inv:1;
	int frm_clk_inv:1;
	int sys_delay:1;
	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);
#define rsnd_dai_get_platform_info(rdai) ((rdai)->info)

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);

/*
 *	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_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);
#define rsnd_scu_nr(priv) ((priv)->scu_nr)

#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>
	16	#include <linux/io.h>
	17	#include <linux/list.h>
	18	#include <linux/module.h>
	19	#include <sound/rcar_snd.h>
	20	#include <sound/soc.h>
	21	#include <sound/pcm_params.h>
	22
	23	/*
	24	* pseudo register
	25	*
	26	* The register address offsets SRU/SCU/SSIU on Gen1/Gen2 are very different.
	27	* This driver uses pseudo register in order to hide it.
	28	* see gen1/gen2 for detail
	29	*/
3337744a	30	enum rsnd_reg {
07539c1d KM	31	/* SRU/SCU */
	32	RSND_REG_SSI_MODE0,
	33	RSND_REG_SSI_MODE1,
	34
3337744a KM	35	RSND_REG_MAX,
	36	};
	37
1536a968	38	struct rsnd_priv;
cdaa3cdf	39	struct rsnd_mod;
1536a968 KM	40	struct rsnd_dai;
	41	struct rsnd_dai_stream;
	42
3337744a KM	43	/*
	44	* R-Car basic functions
	45	*/
	46	#define rsnd_mod_read(m, r) \
	47	rsnd_read(rsnd_mod_to_priv(m), m, RSND_REG_##r)
	48	#define rsnd_mod_write(m, r, d) \
	49	rsnd_write(rsnd_mod_to_priv(m), m, RSND_REG_##r, d)
	50	#define rsnd_mod_bset(m, r, s, d) \
	51	rsnd_bset(rsnd_mod_to_priv(m), m, RSND_REG_##r, s, d)
	52
	53	#define rsnd_priv_read(p, r) rsnd_read(p, NULL, RSND_REG_##r)
	54	#define rsnd_priv_write(p, r, d) rsnd_write(p, NULL, RSND_REG_##r, d)
	55	#define rsnd_priv_bset(p, r, s, d) rsnd_bset(p, NULL, RSND_REG_##r, s, d)
	56
	57	u32 rsnd_read(struct rsnd_priv priv, struct rsnd_mod mod, enum rsnd_reg reg);
	58	void rsnd_write(struct rsnd_priv priv, struct rsnd_mod mod,
	59	enum rsnd_reg reg, u32 data);
	60	void rsnd_bset(struct rsnd_priv priv, struct rsnd_mod mod, enum rsnd_reg reg,
	61	u32 mask, u32 data);
	62
cdaa3cdf KM	63	/*
	64	* R-Car sound mod
	65	*/
	66
	67	struct rsnd_mod_ops {
	68	char *name;
	69	int (init)(struct rsnd_mod mod,
	70	struct rsnd_dai *rdai,
	71	struct rsnd_dai_stream *io);
	72	int (quit)(struct rsnd_mod mod,
	73	struct rsnd_dai *rdai,
	74	struct rsnd_dai_stream *io);
	75	int (start)(struct rsnd_mod mod,
	76	struct rsnd_dai *rdai,
	77	struct rsnd_dai_stream *io);
	78	int (stop)(struct rsnd_mod mod,
	79	struct rsnd_dai *rdai,
	80	struct rsnd_dai_stream *io);
	81	};
	82
	83	struct rsnd_mod {
	84	int id;
	85	struct rsnd_priv *priv;
	86	struct rsnd_mod_ops *ops;
	87	struct list_head list; /* connect to rsnd_dai playback/capture */
	88	};
	89
	90	#define rsnd_mod_to_priv(mod) ((mod)->priv)
	91	#define rsnd_mod_id(mod) ((mod)->id)
	92	#define for_each_rsnd_mod(pos, n, io) \
	93	list_for_each_entry_safe(pos, n, &(io)->head, list)
	94	#define rsnd_mod_call(mod, func, rdai, io) \
	95	(!(mod) ? -ENODEV : \
	96	!((mod)->ops->func) ? 0 : \
	97	(mod)->ops->func(mod, rdai, io))
	98
	99	void rsnd_mod_init(struct rsnd_priv *priv,
	100	struct rsnd_mod *mod,
	101	struct rsnd_mod_ops *ops,
	102	int id);
	103	char rsnd_mod_name(struct rsnd_mod mod);
	104
1536a968 KM	105	/*
	106	* R-Car sound DAI
	107	*/
	108	#define RSND_DAI_NAME_SIZE 16
	109	struct rsnd_dai_stream {
	110	struct list_head head; /* head of rsnd_mod list */
	111	struct snd_pcm_substream *substream;
	112	int byte_pos;
	113	int period_pos;
	114	int byte_per_period;
	115	int next_period_byte;
	116	};
	117
	118	struct rsnd_dai {
	119	char name[RSND_DAI_NAME_SIZE];
	120	struct rsnd_dai_platform_info info; / rcar_snd.h */
	121	struct rsnd_dai_stream playback;
	122	struct rsnd_dai_stream capture;
	123
	124	int clk_master:1;
	125	int bit_clk_inv:1;
	126	int frm_clk_inv:1;
	127	int sys_delay:1;
	128	int data_alignment:1;
	129	};
	130
	131	#define rsnd_dai_nr(priv) ((priv)->dai_nr)
	132	#define for_each_rsnd_dai(rdai, priv, i) \
	133	for (i = 0, (rdai) = rsnd_dai_get(priv, i); \
	134	i < rsnd_dai_nr(priv); \
	135	i++, (rdai) = rsnd_dai_get(priv, i))
	136
	137	struct rsnd_dai rsnd_dai_get(struct rsnd_priv priv, int id);
cdaa3cdf KM	138	int rsnd_dai_disconnect(struct rsnd_mod *mod);
	139	int rsnd_dai_connect(struct rsnd_dai rdai, struct rsnd_mod mod,
	140	struct rsnd_dai_stream *io);
1536a968 KM	141	int rsnd_dai_is_play(struct rsnd_dai rdai, struct rsnd_dai_stream io);
	142	#define rsnd_dai_get_platform_info(rdai) ((rdai)->info)
	143
	144	void rsnd_dai_pointer_update(struct rsnd_dai_stream *io, int cnt);
	145	int rsnd_dai_pointer_offset(struct rsnd_dai_stream *io, int additional);
	146
3337744a KM	147	/*
	148	* R-Car Gen1/Gen2
	149	*/
	150	int rsnd_gen_probe(struct platform_device *pdev,
	151	struct rcar_snd_info *info,
	152	struct rsnd_priv *priv);
	153	void rsnd_gen_remove(struct platform_device *pdev,
	154	struct rsnd_priv *priv);
	155	int rsnd_gen_path_init(struct rsnd_priv *priv,
	156	struct rsnd_dai *rdai,
	157	struct rsnd_dai_stream *io);
	158	int rsnd_gen_path_exit(struct rsnd_priv *priv,
	159	struct rsnd_dai *rdai,
	160	struct rsnd_dai_stream *io);
	161	void __iomem rsnd_gen_reg_get(struct rsnd_priv priv,
	162	struct rsnd_mod *mod,
	163	enum rsnd_reg reg);
	164
1536a968 KM	165	/*
	166	* R-Car sound priv
	167	*/
	168	struct rsnd_priv {
	169
	170	struct device *dev;
	171	struct rcar_snd_info *info;
	172	spinlock_t lock;
	173
3337744a KM	174	/*
	175	* below value will be filled on rsnd_gen_probe()
	176	*/
	177	void *gen;
	178
07539c1d KM	179	/*
	180	* below value will be filled on rsnd_scu_probe()
	181	*/
	182	void *scu;
	183	int scu_nr;
	184
1536a968 KM	185	/*
	186	* below value will be filled on rsnd_dai_probe()
	187	*/
	188	struct snd_soc_dai_driver *daidrv;
	189	struct rsnd_dai *rdai;
	190	int dai_nr;
	191	};
	192
	193	#define rsnd_priv_to_dev(priv) ((priv)->dev)
	194	#define rsnd_lock(priv, flags) spin_lock_irqsave(&priv->lock, flags)
	195	#define rsnd_unlock(priv, flags) spin_unlock_irqrestore(&priv->lock, flags)
	196
07539c1d KM	197	/*
	198	* R-Car SCU
	199	*/
	200	int rsnd_scu_probe(struct platform_device *pdev,
	201	struct rcar_snd_info *info,
	202	struct rsnd_priv *priv);
	203	void rsnd_scu_remove(struct platform_device *pdev,
	204	struct rsnd_priv *priv);
	205	struct rsnd_mod rsnd_scu_mod_get(struct rsnd_priv priv, int id);
	206	#define rsnd_scu_nr(priv) ((priv)->scu_nr)
	207
1536a968	208	#endif