xref: /openbmc/linux/sound/soc/xtensa/xtfpga-i2s.c (revision 1ac731c529cd4d6adbce134754b51ff7d822b145)
1d2912cb1SThomas Gleixner // SPDX-License-Identifier: GPL-2.0-only
257b7068dSMax Filippov /*
357b7068dSMax Filippov  * Xtfpga I2S controller driver
457b7068dSMax Filippov  *
557b7068dSMax Filippov  * Copyright (c) 2014 Cadence Design Systems Inc.
657b7068dSMax Filippov  */
757b7068dSMax Filippov 
857b7068dSMax Filippov #include <linux/clk.h>
957b7068dSMax Filippov #include <linux/io.h>
1057b7068dSMax Filippov #include <linux/module.h>
1157b7068dSMax Filippov #include <linux/of.h>
1257b7068dSMax Filippov #include <linux/platform_device.h>
1357b7068dSMax Filippov #include <linux/pm_runtime.h>
1457b7068dSMax Filippov #include <sound/pcm_params.h>
1557b7068dSMax Filippov #include <sound/soc.h>
1657b7068dSMax Filippov 
1757b7068dSMax Filippov #define DRV_NAME	"xtfpga-i2s"
1857b7068dSMax Filippov 
1957b7068dSMax Filippov #define XTFPGA_I2S_VERSION	0x00
2057b7068dSMax Filippov #define XTFPGA_I2S_CONFIG	0x04
2157b7068dSMax Filippov #define XTFPGA_I2S_INT_MASK	0x08
2257b7068dSMax Filippov #define XTFPGA_I2S_INT_STATUS	0x0c
2357b7068dSMax Filippov #define XTFPGA_I2S_CHAN0_DATA	0x10
2457b7068dSMax Filippov #define XTFPGA_I2S_CHAN1_DATA	0x14
2557b7068dSMax Filippov #define XTFPGA_I2S_CHAN2_DATA	0x18
2657b7068dSMax Filippov #define XTFPGA_I2S_CHAN3_DATA	0x1c
2757b7068dSMax Filippov 
2857b7068dSMax Filippov #define XTFPGA_I2S_CONFIG_TX_ENABLE	0x1
2957b7068dSMax Filippov #define XTFPGA_I2S_CONFIG_INT_ENABLE	0x2
3057b7068dSMax Filippov #define XTFPGA_I2S_CONFIG_LEFT		0x4
3157b7068dSMax Filippov #define XTFPGA_I2S_CONFIG_RATIO_BASE	8
3257b7068dSMax Filippov #define XTFPGA_I2S_CONFIG_RATIO_MASK	0x0000ff00
3357b7068dSMax Filippov #define XTFPGA_I2S_CONFIG_RES_BASE	16
3457b7068dSMax Filippov #define XTFPGA_I2S_CONFIG_RES_MASK	0x003f0000
3557b7068dSMax Filippov #define XTFPGA_I2S_CONFIG_LEVEL_BASE	24
3657b7068dSMax Filippov #define XTFPGA_I2S_CONFIG_LEVEL_MASK	0x0f000000
3757b7068dSMax Filippov #define XTFPGA_I2S_CONFIG_CHANNEL_BASE	28
3857b7068dSMax Filippov 
3957b7068dSMax Filippov #define XTFPGA_I2S_INT_UNDERRUN		0x1
4057b7068dSMax Filippov #define XTFPGA_I2S_INT_LEVEL		0x2
4157b7068dSMax Filippov #define XTFPGA_I2S_INT_VALID		0x3
4257b7068dSMax Filippov 
4357b7068dSMax Filippov #define XTFPGA_I2S_FIFO_SIZE		8192
4457b7068dSMax Filippov 
4557b7068dSMax Filippov /*
4657b7068dSMax Filippov  * I2S controller operation:
4757b7068dSMax Filippov  *
4857b7068dSMax Filippov  * Enabling TX: output 1 period of zeros (starting with left channel)
4957b7068dSMax Filippov  * and then queued data.
5057b7068dSMax Filippov  *
5157b7068dSMax Filippov  * Level status and interrupt: whenever FIFO level is below FIFO trigger,
5257b7068dSMax Filippov  * level status is 1 and an IRQ is asserted (if enabled).
5357b7068dSMax Filippov  *
5457b7068dSMax Filippov  * Underrun status and interrupt: whenever FIFO is empty, underrun status
5557b7068dSMax Filippov  * is 1 and an IRQ is asserted (if enabled).
5657b7068dSMax Filippov  */
5757b7068dSMax Filippov struct xtfpga_i2s {
5857b7068dSMax Filippov 	struct device *dev;
5957b7068dSMax Filippov 	struct clk *clk;
6057b7068dSMax Filippov 	struct regmap *regmap;
6157b7068dSMax Filippov 	void __iomem *regs;
6257b7068dSMax Filippov 
6357b7068dSMax Filippov 	/* current playback substream. NULL if not playing.
6457b7068dSMax Filippov 	 *
6557b7068dSMax Filippov 	 * Access to that field is synchronized between the interrupt handler
6657b7068dSMax Filippov 	 * and userspace through RCU.
6757b7068dSMax Filippov 	 *
6857b7068dSMax Filippov 	 * Interrupt handler (threaded part) does PIO on substream data in RCU
6957b7068dSMax Filippov 	 * read-side critical section. Trigger callback sets and clears the
7057b7068dSMax Filippov 	 * pointer when the playback is started and stopped with
7157b7068dSMax Filippov 	 * rcu_assign_pointer. When userspace is about to free the playback
7257b7068dSMax Filippov 	 * stream in the pcm_close callback it synchronizes with the interrupt
7357b7068dSMax Filippov 	 * handler by means of synchronize_rcu call.
7457b7068dSMax Filippov 	 */
75d32e03f0SLars-Peter Clausen 	struct snd_pcm_substream __rcu *tx_substream;
7657b7068dSMax Filippov 	unsigned (*tx_fn)(struct xtfpga_i2s *i2s,
7757b7068dSMax Filippov 			  struct snd_pcm_runtime *runtime,
7857b7068dSMax Filippov 			  unsigned tx_ptr);
7957b7068dSMax Filippov 	unsigned tx_ptr; /* next frame index in the sample buffer */
8057b7068dSMax Filippov 
8157b7068dSMax Filippov 	/* current fifo level estimate.
8257b7068dSMax Filippov 	 * Doesn't have to be perfectly accurate, but must be not less than
8357b7068dSMax Filippov 	 * the actual FIFO level in order to avoid stall on push attempt.
8457b7068dSMax Filippov 	 */
8557b7068dSMax Filippov 	unsigned tx_fifo_level;
8657b7068dSMax Filippov 
8757b7068dSMax Filippov 	/* FIFO level at which level interrupt occurs */
8857b7068dSMax Filippov 	unsigned tx_fifo_low;
8957b7068dSMax Filippov 
9057b7068dSMax Filippov 	/* maximal FIFO level */
9157b7068dSMax Filippov 	unsigned tx_fifo_high;
9257b7068dSMax Filippov };
9357b7068dSMax Filippov 
xtfpga_i2s_wr_reg(struct device * dev,unsigned int reg)9457b7068dSMax Filippov static bool xtfpga_i2s_wr_reg(struct device *dev, unsigned int reg)
9557b7068dSMax Filippov {
9657b7068dSMax Filippov 	return reg >= XTFPGA_I2S_CONFIG;
9757b7068dSMax Filippov }
9857b7068dSMax Filippov 
xtfpga_i2s_rd_reg(struct device * dev,unsigned int reg)9957b7068dSMax Filippov static bool xtfpga_i2s_rd_reg(struct device *dev, unsigned int reg)
10057b7068dSMax Filippov {
10157b7068dSMax Filippov 	return reg < XTFPGA_I2S_CHAN0_DATA;
10257b7068dSMax Filippov }
10357b7068dSMax Filippov 
xtfpga_i2s_volatile_reg(struct device * dev,unsigned int reg)10457b7068dSMax Filippov static bool xtfpga_i2s_volatile_reg(struct device *dev, unsigned int reg)
10557b7068dSMax Filippov {
10657b7068dSMax Filippov 	return reg == XTFPGA_I2S_INT_STATUS;
10757b7068dSMax Filippov }
10857b7068dSMax Filippov 
10957b7068dSMax Filippov static const struct regmap_config xtfpga_i2s_regmap_config = {
11057b7068dSMax Filippov 	.reg_bits = 32,
11157b7068dSMax Filippov 	.reg_stride = 4,
11257b7068dSMax Filippov 	.val_bits = 32,
11357b7068dSMax Filippov 	.max_register = XTFPGA_I2S_CHAN3_DATA,
11457b7068dSMax Filippov 	.writeable_reg = xtfpga_i2s_wr_reg,
11557b7068dSMax Filippov 	.readable_reg = xtfpga_i2s_rd_reg,
11657b7068dSMax Filippov 	.volatile_reg = xtfpga_i2s_volatile_reg,
11757b7068dSMax Filippov 	.cache_type = REGCACHE_FLAT,
11857b7068dSMax Filippov };
11957b7068dSMax Filippov 
12057b7068dSMax Filippov /* Generate functions that do PIO from TX DMA area to FIFO for all supported
12157b7068dSMax Filippov  * stream formats.
12257b7068dSMax Filippov  * Functions will be called xtfpga_pcm_tx_<channels>x<sample bits>, e.g.
12357b7068dSMax Filippov  * xtfpga_pcm_tx_2x16 for 16-bit stereo.
12457b7068dSMax Filippov  *
12557b7068dSMax Filippov  * FIFO consists of 32-bit words, one word per channel, always 2 channels.
12657b7068dSMax Filippov  * If I2S interface is configured with smaller sample resolution, only
12757b7068dSMax Filippov  * the LSB of each word is used.
12857b7068dSMax Filippov  */
12957b7068dSMax Filippov #define xtfpga_pcm_tx_fn(channels, sample_bits) \
13057b7068dSMax Filippov static unsigned xtfpga_pcm_tx_##channels##x##sample_bits( \
13157b7068dSMax Filippov 	struct xtfpga_i2s *i2s, struct snd_pcm_runtime *runtime, \
13257b7068dSMax Filippov 	unsigned tx_ptr) \
13357b7068dSMax Filippov { \
13457b7068dSMax Filippov 	const u##sample_bits (*p)[channels] = \
13557b7068dSMax Filippov 		(void *)runtime->dma_area; \
13657b7068dSMax Filippov \
13757b7068dSMax Filippov 	for (; i2s->tx_fifo_level < i2s->tx_fifo_high; \
13857b7068dSMax Filippov 	     i2s->tx_fifo_level += 2) { \
13957b7068dSMax Filippov 		iowrite32(p[tx_ptr][0], \
14057b7068dSMax Filippov 			  i2s->regs + XTFPGA_I2S_CHAN0_DATA); \
14157b7068dSMax Filippov 		iowrite32(p[tx_ptr][channels - 1], \
14257b7068dSMax Filippov 			  i2s->regs + XTFPGA_I2S_CHAN0_DATA); \
14357b7068dSMax Filippov 		if (++tx_ptr >= runtime->buffer_size) \
14457b7068dSMax Filippov 			tx_ptr = 0; \
14557b7068dSMax Filippov 	} \
14657b7068dSMax Filippov 	return tx_ptr; \
14757b7068dSMax Filippov }
14857b7068dSMax Filippov 
14957b7068dSMax Filippov xtfpga_pcm_tx_fn(1, 16)
15057b7068dSMax Filippov xtfpga_pcm_tx_fn(2, 16)
15157b7068dSMax Filippov xtfpga_pcm_tx_fn(1, 32)
15257b7068dSMax Filippov xtfpga_pcm_tx_fn(2, 32)
15357b7068dSMax Filippov 
15457b7068dSMax Filippov #undef xtfpga_pcm_tx_fn
15557b7068dSMax Filippov 
xtfpga_pcm_push_tx(struct xtfpga_i2s * i2s)15657b7068dSMax Filippov static bool xtfpga_pcm_push_tx(struct xtfpga_i2s *i2s)
15757b7068dSMax Filippov {
15857b7068dSMax Filippov 	struct snd_pcm_substream *tx_substream;
15957b7068dSMax Filippov 	bool tx_active;
16057b7068dSMax Filippov 
16157b7068dSMax Filippov 	rcu_read_lock();
16257b7068dSMax Filippov 	tx_substream = rcu_dereference(i2s->tx_substream);
16357b7068dSMax Filippov 	tx_active = tx_substream && snd_pcm_running(tx_substream);
16457b7068dSMax Filippov 	if (tx_active) {
1656aa7de05SMark Rutland 		unsigned tx_ptr = READ_ONCE(i2s->tx_ptr);
16657b7068dSMax Filippov 		unsigned new_tx_ptr = i2s->tx_fn(i2s, tx_substream->runtime,
16757b7068dSMax Filippov 						 tx_ptr);
16857b7068dSMax Filippov 
16957b7068dSMax Filippov 		cmpxchg(&i2s->tx_ptr, tx_ptr, new_tx_ptr);
17057b7068dSMax Filippov 	}
17157b7068dSMax Filippov 	rcu_read_unlock();
17257b7068dSMax Filippov 
17357b7068dSMax Filippov 	return tx_active;
17457b7068dSMax Filippov }
17557b7068dSMax Filippov 
xtfpga_pcm_refill_fifo(struct xtfpga_i2s * i2s)17657b7068dSMax Filippov static void xtfpga_pcm_refill_fifo(struct xtfpga_i2s *i2s)
17757b7068dSMax Filippov {
17857b7068dSMax Filippov 	unsigned int_status;
17957b7068dSMax Filippov 	unsigned i;
18057b7068dSMax Filippov 
18157b7068dSMax Filippov 	regmap_read(i2s->regmap, XTFPGA_I2S_INT_STATUS,
18257b7068dSMax Filippov 		    &int_status);
18357b7068dSMax Filippov 
18457b7068dSMax Filippov 	for (i = 0; i < 2; ++i) {
18557b7068dSMax Filippov 		bool tx_active = xtfpga_pcm_push_tx(i2s);
18657b7068dSMax Filippov 
18757b7068dSMax Filippov 		regmap_write(i2s->regmap, XTFPGA_I2S_INT_STATUS,
18857b7068dSMax Filippov 			     XTFPGA_I2S_INT_VALID);
18957b7068dSMax Filippov 		if (tx_active)
19057b7068dSMax Filippov 			regmap_read(i2s->regmap, XTFPGA_I2S_INT_STATUS,
19157b7068dSMax Filippov 				    &int_status);
19257b7068dSMax Filippov 
19357b7068dSMax Filippov 		if (!tx_active ||
19457b7068dSMax Filippov 		    !(int_status & XTFPGA_I2S_INT_LEVEL))
19557b7068dSMax Filippov 			break;
19657b7068dSMax Filippov 
19757b7068dSMax Filippov 		/* After the push the level IRQ is still asserted,
19857b7068dSMax Filippov 		 * means FIFO level is below tx_fifo_low. Estimate
19957b7068dSMax Filippov 		 * it as tx_fifo_low.
20057b7068dSMax Filippov 		 */
20157b7068dSMax Filippov 		i2s->tx_fifo_level = i2s->tx_fifo_low;
20257b7068dSMax Filippov 	}
20357b7068dSMax Filippov 
20457b7068dSMax Filippov 	if (!(int_status & XTFPGA_I2S_INT_LEVEL))
20557b7068dSMax Filippov 		regmap_write(i2s->regmap, XTFPGA_I2S_INT_MASK,
20657b7068dSMax Filippov 			     XTFPGA_I2S_INT_VALID);
20757b7068dSMax Filippov 	else if (!(int_status & XTFPGA_I2S_INT_UNDERRUN))
20857b7068dSMax Filippov 		regmap_write(i2s->regmap, XTFPGA_I2S_INT_MASK,
20957b7068dSMax Filippov 			     XTFPGA_I2S_INT_UNDERRUN);
21057b7068dSMax Filippov 
21157b7068dSMax Filippov 	if (!(int_status & XTFPGA_I2S_INT_UNDERRUN))
21257b7068dSMax Filippov 		regmap_update_bits(i2s->regmap, XTFPGA_I2S_CONFIG,
21357b7068dSMax Filippov 				   XTFPGA_I2S_CONFIG_INT_ENABLE |
21457b7068dSMax Filippov 				   XTFPGA_I2S_CONFIG_TX_ENABLE,
21557b7068dSMax Filippov 				   XTFPGA_I2S_CONFIG_INT_ENABLE |
21657b7068dSMax Filippov 				   XTFPGA_I2S_CONFIG_TX_ENABLE);
21757b7068dSMax Filippov 	else
21857b7068dSMax Filippov 		regmap_update_bits(i2s->regmap, XTFPGA_I2S_CONFIG,
21957b7068dSMax Filippov 				   XTFPGA_I2S_CONFIG_INT_ENABLE |
22057b7068dSMax Filippov 				   XTFPGA_I2S_CONFIG_TX_ENABLE, 0);
22157b7068dSMax Filippov }
22257b7068dSMax Filippov 
xtfpga_i2s_threaded_irq_handler(int irq,void * dev_id)22357b7068dSMax Filippov static irqreturn_t xtfpga_i2s_threaded_irq_handler(int irq, void *dev_id)
22457b7068dSMax Filippov {
22557b7068dSMax Filippov 	struct xtfpga_i2s *i2s = dev_id;
22657b7068dSMax Filippov 	struct snd_pcm_substream *tx_substream;
22757b7068dSMax Filippov 	unsigned config, int_status, int_mask;
22857b7068dSMax Filippov 
22957b7068dSMax Filippov 	regmap_read(i2s->regmap, XTFPGA_I2S_CONFIG, &config);
23057b7068dSMax Filippov 	regmap_read(i2s->regmap, XTFPGA_I2S_INT_MASK, &int_mask);
23157b7068dSMax Filippov 	regmap_read(i2s->regmap, XTFPGA_I2S_INT_STATUS, &int_status);
23257b7068dSMax Filippov 
23357b7068dSMax Filippov 	if (!(config & XTFPGA_I2S_CONFIG_INT_ENABLE) ||
23457b7068dSMax Filippov 	    !(int_status & int_mask & XTFPGA_I2S_INT_VALID))
23557b7068dSMax Filippov 		return IRQ_NONE;
23657b7068dSMax Filippov 
23757b7068dSMax Filippov 	/* Update FIFO level estimate in accordance with interrupt status
23857b7068dSMax Filippov 	 * register.
23957b7068dSMax Filippov 	 */
24057b7068dSMax Filippov 	if (int_status & XTFPGA_I2S_INT_UNDERRUN) {
24157b7068dSMax Filippov 		i2s->tx_fifo_level = 0;
24257b7068dSMax Filippov 		regmap_update_bits(i2s->regmap, XTFPGA_I2S_CONFIG,
24357b7068dSMax Filippov 				   XTFPGA_I2S_CONFIG_TX_ENABLE, 0);
24457b7068dSMax Filippov 	} else {
24557b7068dSMax Filippov 		/* The FIFO isn't empty, but is below tx_fifo_low. Estimate
24657b7068dSMax Filippov 		 * it as tx_fifo_low.
24757b7068dSMax Filippov 		 */
24857b7068dSMax Filippov 		i2s->tx_fifo_level = i2s->tx_fifo_low;
24957b7068dSMax Filippov 	}
25057b7068dSMax Filippov 
25157b7068dSMax Filippov 	rcu_read_lock();
25257b7068dSMax Filippov 	tx_substream = rcu_dereference(i2s->tx_substream);
25357b7068dSMax Filippov 
25457b7068dSMax Filippov 	if (tx_substream && snd_pcm_running(tx_substream)) {
25557b7068dSMax Filippov 		snd_pcm_period_elapsed(tx_substream);
25657b7068dSMax Filippov 		if (int_status & XTFPGA_I2S_INT_UNDERRUN)
25757b7068dSMax Filippov 			dev_dbg_ratelimited(i2s->dev, "%s: underrun\n",
25857b7068dSMax Filippov 					    __func__);
25957b7068dSMax Filippov 	}
26057b7068dSMax Filippov 	rcu_read_unlock();
26157b7068dSMax Filippov 
26257b7068dSMax Filippov 	/* Refill FIFO, update allowed IRQ reasons, enable IRQ if FIFO is
26357b7068dSMax Filippov 	 * not empty.
26457b7068dSMax Filippov 	 */
26557b7068dSMax Filippov 	xtfpga_pcm_refill_fifo(i2s);
26657b7068dSMax Filippov 
26757b7068dSMax Filippov 	return IRQ_HANDLED;
26857b7068dSMax Filippov }
26957b7068dSMax Filippov 
xtfpga_i2s_startup(struct snd_pcm_substream * substream,struct snd_soc_dai * dai)27057b7068dSMax Filippov static int xtfpga_i2s_startup(struct snd_pcm_substream *substream,
27157b7068dSMax Filippov 			      struct snd_soc_dai *dai)
27257b7068dSMax Filippov {
27357b7068dSMax Filippov 	struct xtfpga_i2s *i2s = snd_soc_dai_get_drvdata(dai);
27457b7068dSMax Filippov 
27557b7068dSMax Filippov 	snd_soc_dai_set_dma_data(dai, substream, i2s);
27657b7068dSMax Filippov 	return 0;
27757b7068dSMax Filippov }
27857b7068dSMax Filippov 
xtfpga_i2s_hw_params(struct snd_pcm_substream * substream,struct snd_pcm_hw_params * params,struct snd_soc_dai * dai)27957b7068dSMax Filippov static int xtfpga_i2s_hw_params(struct snd_pcm_substream *substream,
28057b7068dSMax Filippov 				struct snd_pcm_hw_params *params,
28157b7068dSMax Filippov 				struct snd_soc_dai *dai)
28257b7068dSMax Filippov {
28357b7068dSMax Filippov 	struct xtfpga_i2s *i2s = snd_soc_dai_get_drvdata(dai);
28457b7068dSMax Filippov 	unsigned srate = params_rate(params);
28557b7068dSMax Filippov 	unsigned channels = params_channels(params);
28657b7068dSMax Filippov 	unsigned period_size = params_period_size(params);
28757b7068dSMax Filippov 	unsigned sample_size = snd_pcm_format_width(params_format(params));
28857b7068dSMax Filippov 	unsigned freq, ratio, level;
28957b7068dSMax Filippov 	int err;
29057b7068dSMax Filippov 
29157b7068dSMax Filippov 	regmap_update_bits(i2s->regmap, XTFPGA_I2S_CONFIG,
29257b7068dSMax Filippov 			   XTFPGA_I2S_CONFIG_RES_MASK,
29357b7068dSMax Filippov 			   sample_size << XTFPGA_I2S_CONFIG_RES_BASE);
29457b7068dSMax Filippov 
29557b7068dSMax Filippov 	freq = 256 * srate;
29657b7068dSMax Filippov 	err = clk_set_rate(i2s->clk, freq);
29757b7068dSMax Filippov 	if (err < 0)
29857b7068dSMax Filippov 		return err;
29957b7068dSMax Filippov 
30057b7068dSMax Filippov 	/* ratio field of the config register controls MCLK->I2S clock
30157b7068dSMax Filippov 	 * derivation: I2S clock = MCLK / (2 * (ratio + 2)).
30257b7068dSMax Filippov 	 *
30357b7068dSMax Filippov 	 * So with MCLK = 256 * sample rate ratio is 0 for 32 bit stereo
30457b7068dSMax Filippov 	 * and 2 for 16 bit stereo.
30557b7068dSMax Filippov 	 */
30657b7068dSMax Filippov 	ratio = (freq - (srate * sample_size * 8)) /
30757b7068dSMax Filippov 		(srate * sample_size * 4);
30857b7068dSMax Filippov 
30957b7068dSMax Filippov 	regmap_update_bits(i2s->regmap, XTFPGA_I2S_CONFIG,
31057b7068dSMax Filippov 			   XTFPGA_I2S_CONFIG_RATIO_MASK,
31157b7068dSMax Filippov 			   ratio << XTFPGA_I2S_CONFIG_RATIO_BASE);
31257b7068dSMax Filippov 
31357b7068dSMax Filippov 	i2s->tx_fifo_low = XTFPGA_I2S_FIFO_SIZE / 2;
31457b7068dSMax Filippov 
31557b7068dSMax Filippov 	/* period_size * 2: FIFO always gets 2 samples per frame */
31657b7068dSMax Filippov 	for (level = 1;
31757b7068dSMax Filippov 	     i2s->tx_fifo_low / 2 >= period_size * 2 &&
31857b7068dSMax Filippov 	     level < (XTFPGA_I2S_CONFIG_LEVEL_MASK >>
31957b7068dSMax Filippov 		      XTFPGA_I2S_CONFIG_LEVEL_BASE); ++level)
32057b7068dSMax Filippov 		i2s->tx_fifo_low /= 2;
32157b7068dSMax Filippov 
32257b7068dSMax Filippov 	i2s->tx_fifo_high = 2 * i2s->tx_fifo_low;
32357b7068dSMax Filippov 
32457b7068dSMax Filippov 	regmap_update_bits(i2s->regmap, XTFPGA_I2S_CONFIG,
32557b7068dSMax Filippov 			   XTFPGA_I2S_CONFIG_LEVEL_MASK,
32657b7068dSMax Filippov 			   level << XTFPGA_I2S_CONFIG_LEVEL_BASE);
32757b7068dSMax Filippov 
32857b7068dSMax Filippov 	dev_dbg(i2s->dev,
32957b7068dSMax Filippov 		"%s srate: %u, channels: %u, sample_size: %u, period_size: %u\n",
33057b7068dSMax Filippov 		__func__, srate, channels, sample_size, period_size);
33157b7068dSMax Filippov 	dev_dbg(i2s->dev, "%s freq: %u, ratio: %u, level: %u\n",
33257b7068dSMax Filippov 		__func__, freq, ratio, level);
33357b7068dSMax Filippov 
33457b7068dSMax Filippov 	return 0;
33557b7068dSMax Filippov }
33657b7068dSMax Filippov 
xtfpga_i2s_set_fmt(struct snd_soc_dai * cpu_dai,unsigned int fmt)33757b7068dSMax Filippov static int xtfpga_i2s_set_fmt(struct snd_soc_dai *cpu_dai,
33857b7068dSMax Filippov 			      unsigned int fmt)
33957b7068dSMax Filippov {
34057b7068dSMax Filippov 	if ((fmt & SND_SOC_DAIFMT_INV_MASK) != SND_SOC_DAIFMT_NB_NF)
34157b7068dSMax Filippov 		return -EINVAL;
342e945206aSCharles Keepax 	if ((fmt & SND_SOC_DAIFMT_CLOCK_PROVIDER_MASK) != SND_SOC_DAIFMT_BP_FP)
34357b7068dSMax Filippov 		return -EINVAL;
34457b7068dSMax Filippov 	if ((fmt & SND_SOC_DAIFMT_FORMAT_MASK) != SND_SOC_DAIFMT_I2S)
34557b7068dSMax Filippov 		return -EINVAL;
34657b7068dSMax Filippov 
34757b7068dSMax Filippov 	return 0;
34857b7068dSMax Filippov }
34957b7068dSMax Filippov 
35057b7068dSMax Filippov /* PCM */
35157b7068dSMax Filippov 
35257b7068dSMax Filippov static const struct snd_pcm_hardware xtfpga_pcm_hardware = {
35357b7068dSMax Filippov 	.info = SNDRV_PCM_INFO_INTERLEAVED |
35457b7068dSMax Filippov 		SNDRV_PCM_INFO_MMAP_VALID |
35557b7068dSMax Filippov 		SNDRV_PCM_INFO_BLOCK_TRANSFER,
35657b7068dSMax Filippov 	.formats		= SNDRV_PCM_FMTBIT_S16_LE |
35757b7068dSMax Filippov 				  SNDRV_PCM_FMTBIT_S32_LE,
35857b7068dSMax Filippov 	.channels_min		= 1,
35957b7068dSMax Filippov 	.channels_max		= 2,
36057b7068dSMax Filippov 	.period_bytes_min	= 2,
36157b7068dSMax Filippov 	.period_bytes_max	= XTFPGA_I2S_FIFO_SIZE / 2 * 8,
36257b7068dSMax Filippov 	.periods_min		= 2,
36357b7068dSMax Filippov 	.periods_max		= XTFPGA_I2S_FIFO_SIZE * 8 / 2,
36457b7068dSMax Filippov 	.buffer_bytes_max	= XTFPGA_I2S_FIFO_SIZE * 8,
36557b7068dSMax Filippov 	.fifo_size		= 16,
36657b7068dSMax Filippov };
36757b7068dSMax Filippov 
xtfpga_pcm_open(struct snd_soc_component * component,struct snd_pcm_substream * substream)36817d48a31SKuninori Morimoto static int xtfpga_pcm_open(struct snd_soc_component *component,
36917d48a31SKuninori Morimoto 			   struct snd_pcm_substream *substream)
37057b7068dSMax Filippov {
37157b7068dSMax Filippov 	struct snd_pcm_runtime *runtime = substream->runtime;
3728d08d9b0SKuninori Morimoto 	struct snd_soc_pcm_runtime *rtd = asoc_substream_to_rtd(substream);
37357b7068dSMax Filippov 	void *p;
37457b7068dSMax Filippov 
37557b7068dSMax Filippov 	snd_soc_set_runtime_hwparams(substream, &xtfpga_pcm_hardware);
376aafa4ef5SKuninori Morimoto 	p = snd_soc_dai_get_dma_data(asoc_rtd_to_cpu(rtd, 0), substream);
37757b7068dSMax Filippov 	runtime->private_data = p;
37857b7068dSMax Filippov 
37957b7068dSMax Filippov 	return 0;
38057b7068dSMax Filippov }
38157b7068dSMax Filippov 
xtfpga_pcm_close(struct snd_soc_component * component,struct snd_pcm_substream * substream)38217d48a31SKuninori Morimoto static int xtfpga_pcm_close(struct snd_soc_component *component,
38317d48a31SKuninori Morimoto 			    struct snd_pcm_substream *substream)
38457b7068dSMax Filippov {
38557b7068dSMax Filippov 	synchronize_rcu();
38657b7068dSMax Filippov 	return 0;
38757b7068dSMax Filippov }
38857b7068dSMax Filippov 
xtfpga_pcm_hw_params(struct snd_soc_component * component,struct snd_pcm_substream * substream,struct snd_pcm_hw_params * hw_params)38917d48a31SKuninori Morimoto static int xtfpga_pcm_hw_params(struct snd_soc_component *component,
39017d48a31SKuninori Morimoto 				struct snd_pcm_substream *substream,
39157b7068dSMax Filippov 				struct snd_pcm_hw_params *hw_params)
39257b7068dSMax Filippov {
39357b7068dSMax Filippov 	struct snd_pcm_runtime *runtime = substream->runtime;
39457b7068dSMax Filippov 	struct xtfpga_i2s *i2s = runtime->private_data;
39557b7068dSMax Filippov 	unsigned channels = params_channels(hw_params);
39657b7068dSMax Filippov 
39757b7068dSMax Filippov 	switch (channels) {
39857b7068dSMax Filippov 	case 1:
39957b7068dSMax Filippov 	case 2:
40057b7068dSMax Filippov 		break;
40157b7068dSMax Filippov 
40257b7068dSMax Filippov 	default:
40357b7068dSMax Filippov 		return -EINVAL;
40457b7068dSMax Filippov 
40557b7068dSMax Filippov 	}
40657b7068dSMax Filippov 
40757b7068dSMax Filippov 	switch (params_format(hw_params)) {
40857b7068dSMax Filippov 	case SNDRV_PCM_FORMAT_S16_LE:
40957b7068dSMax Filippov 		i2s->tx_fn = (channels == 1) ?
41057b7068dSMax Filippov 			xtfpga_pcm_tx_1x16 :
41157b7068dSMax Filippov 			xtfpga_pcm_tx_2x16;
41257b7068dSMax Filippov 		break;
41357b7068dSMax Filippov 
41457b7068dSMax Filippov 	case SNDRV_PCM_FORMAT_S32_LE:
41557b7068dSMax Filippov 		i2s->tx_fn = (channels == 1) ?
41657b7068dSMax Filippov 			xtfpga_pcm_tx_1x32 :
41757b7068dSMax Filippov 			xtfpga_pcm_tx_2x32;
41857b7068dSMax Filippov 		break;
41957b7068dSMax Filippov 
42057b7068dSMax Filippov 	default:
42157b7068dSMax Filippov 		return -EINVAL;
42257b7068dSMax Filippov 	}
42357b7068dSMax Filippov 
424bfddcaffSTakashi Iwai 	return 0;
42557b7068dSMax Filippov }
42657b7068dSMax Filippov 
xtfpga_pcm_trigger(struct snd_soc_component * component,struct snd_pcm_substream * substream,int cmd)42717d48a31SKuninori Morimoto static int xtfpga_pcm_trigger(struct snd_soc_component *component,
42817d48a31SKuninori Morimoto 			      struct snd_pcm_substream *substream, int cmd)
42957b7068dSMax Filippov {
43057b7068dSMax Filippov 	int ret = 0;
43157b7068dSMax Filippov 	struct snd_pcm_runtime *runtime = substream->runtime;
43257b7068dSMax Filippov 	struct xtfpga_i2s *i2s = runtime->private_data;
43357b7068dSMax Filippov 
43457b7068dSMax Filippov 	switch (cmd) {
43557b7068dSMax Filippov 	case SNDRV_PCM_TRIGGER_START:
43657b7068dSMax Filippov 	case SNDRV_PCM_TRIGGER_RESUME:
43757b7068dSMax Filippov 	case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
4386aa7de05SMark Rutland 		WRITE_ONCE(i2s->tx_ptr, 0);
43957b7068dSMax Filippov 		rcu_assign_pointer(i2s->tx_substream, substream);
44057b7068dSMax Filippov 		xtfpga_pcm_refill_fifo(i2s);
44157b7068dSMax Filippov 		break;
44257b7068dSMax Filippov 
44357b7068dSMax Filippov 	case SNDRV_PCM_TRIGGER_STOP:
44457b7068dSMax Filippov 	case SNDRV_PCM_TRIGGER_SUSPEND:
44557b7068dSMax Filippov 	case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
44657b7068dSMax Filippov 		rcu_assign_pointer(i2s->tx_substream, NULL);
44757b7068dSMax Filippov 		break;
44857b7068dSMax Filippov 
44957b7068dSMax Filippov 	default:
45057b7068dSMax Filippov 		ret = -EINVAL;
45157b7068dSMax Filippov 		break;
45257b7068dSMax Filippov 	}
45357b7068dSMax Filippov 	return ret;
45457b7068dSMax Filippov }
45557b7068dSMax Filippov 
xtfpga_pcm_pointer(struct snd_soc_component * component,struct snd_pcm_substream * substream)45617d48a31SKuninori Morimoto static snd_pcm_uframes_t xtfpga_pcm_pointer(struct snd_soc_component *component,
45717d48a31SKuninori Morimoto 					    struct snd_pcm_substream *substream)
45857b7068dSMax Filippov {
45957b7068dSMax Filippov 	struct snd_pcm_runtime *runtime = substream->runtime;
46057b7068dSMax Filippov 	struct xtfpga_i2s *i2s = runtime->private_data;
4616aa7de05SMark Rutland 	snd_pcm_uframes_t pos = READ_ONCE(i2s->tx_ptr);
46257b7068dSMax Filippov 
46357b7068dSMax Filippov 	return pos < runtime->buffer_size ? pos : 0;
46457b7068dSMax Filippov }
46557b7068dSMax Filippov 
xtfpga_pcm_new(struct snd_soc_component * component,struct snd_soc_pcm_runtime * rtd)46617d48a31SKuninori Morimoto static int xtfpga_pcm_new(struct snd_soc_component *component,
46717d48a31SKuninori Morimoto 			  struct snd_soc_pcm_runtime *rtd)
46857b7068dSMax Filippov {
46957b7068dSMax Filippov 	struct snd_card *card = rtd->card->snd_card;
47057b7068dSMax Filippov 	size_t size = xtfpga_pcm_hardware.buffer_bytes_max;
47157b7068dSMax Filippov 
472bfddcaffSTakashi Iwai 	snd_pcm_set_managed_buffer_all(rtd->pcm, SNDRV_DMA_TYPE_DEV,
47357b7068dSMax Filippov 				       card->dev, size, size);
4748eea18f6STakashi Iwai 	return 0;
47557b7068dSMax Filippov }
47657b7068dSMax Filippov 
47717d48a31SKuninori Morimoto static const struct snd_soc_component_driver xtfpga_i2s_component = {
47817d48a31SKuninori Morimoto 	.name			= DRV_NAME,
47957b7068dSMax Filippov 	.open			= xtfpga_pcm_open,
48057b7068dSMax Filippov 	.close			= xtfpga_pcm_close,
48157b7068dSMax Filippov 	.hw_params		= xtfpga_pcm_hw_params,
48257b7068dSMax Filippov 	.trigger		= xtfpga_pcm_trigger,
48357b7068dSMax Filippov 	.pointer		= xtfpga_pcm_pointer,
48417d48a31SKuninori Morimoto 	.pcm_construct		= xtfpga_pcm_new,
485f257dea1SCharles Keepax 	.legacy_dai_naming	= 1,
48657b7068dSMax Filippov };
48757b7068dSMax Filippov 
48857b7068dSMax Filippov static const struct snd_soc_dai_ops xtfpga_i2s_dai_ops = {
48957b7068dSMax Filippov 	.startup	= xtfpga_i2s_startup,
49057b7068dSMax Filippov 	.hw_params      = xtfpga_i2s_hw_params,
49158e23e21SCharles Keepax 	.set_fmt	= xtfpga_i2s_set_fmt,
49257b7068dSMax Filippov };
49357b7068dSMax Filippov 
49457b7068dSMax Filippov static struct snd_soc_dai_driver xtfpga_i2s_dai[] = {
49557b7068dSMax Filippov 	{
49657b7068dSMax Filippov 		.name = "xtfpga-i2s",
49757b7068dSMax Filippov 		.id = 0,
49857b7068dSMax Filippov 		.playback = {
49957b7068dSMax Filippov 			.channels_min = 1,
50057b7068dSMax Filippov 			.channels_max = 2,
50157b7068dSMax Filippov 			.rates = SNDRV_PCM_RATE_8000_96000,
50257b7068dSMax Filippov 			.formats = SNDRV_PCM_FMTBIT_S16_LE |
50357b7068dSMax Filippov 				   SNDRV_PCM_FMTBIT_S32_LE,
50457b7068dSMax Filippov 		},
50557b7068dSMax Filippov 		.ops = &xtfpga_i2s_dai_ops,
50657b7068dSMax Filippov 	},
50757b7068dSMax Filippov };
50857b7068dSMax Filippov 
xtfpga_i2s_runtime_suspend(struct device * dev)50957b7068dSMax Filippov static int xtfpga_i2s_runtime_suspend(struct device *dev)
51057b7068dSMax Filippov {
51157b7068dSMax Filippov 	struct xtfpga_i2s *i2s = dev_get_drvdata(dev);
51257b7068dSMax Filippov 
51357b7068dSMax Filippov 	clk_disable_unprepare(i2s->clk);
51457b7068dSMax Filippov 	return 0;
51557b7068dSMax Filippov }
51657b7068dSMax Filippov 
xtfpga_i2s_runtime_resume(struct device * dev)51757b7068dSMax Filippov static int xtfpga_i2s_runtime_resume(struct device *dev)
51857b7068dSMax Filippov {
51957b7068dSMax Filippov 	struct xtfpga_i2s *i2s = dev_get_drvdata(dev);
52057b7068dSMax Filippov 	int ret;
52157b7068dSMax Filippov 
52257b7068dSMax Filippov 	ret = clk_prepare_enable(i2s->clk);
52357b7068dSMax Filippov 	if (ret) {
52457b7068dSMax Filippov 		dev_err(dev, "clk_prepare_enable failed: %d\n", ret);
52557b7068dSMax Filippov 		return ret;
52657b7068dSMax Filippov 	}
52757b7068dSMax Filippov 	return 0;
52857b7068dSMax Filippov }
52957b7068dSMax Filippov 
xtfpga_i2s_probe(struct platform_device * pdev)53057b7068dSMax Filippov static int xtfpga_i2s_probe(struct platform_device *pdev)
53157b7068dSMax Filippov {
53257b7068dSMax Filippov 	struct xtfpga_i2s *i2s;
53357b7068dSMax Filippov 	int err, irq;
53457b7068dSMax Filippov 
53557b7068dSMax Filippov 	i2s = devm_kzalloc(&pdev->dev, sizeof(*i2s), GFP_KERNEL);
53657b7068dSMax Filippov 	if (!i2s) {
53757b7068dSMax Filippov 		err = -ENOMEM;
53857b7068dSMax Filippov 		goto err;
53957b7068dSMax Filippov 	}
54057b7068dSMax Filippov 	platform_set_drvdata(pdev, i2s);
54157b7068dSMax Filippov 	i2s->dev = &pdev->dev;
54257b7068dSMax Filippov 	dev_dbg(&pdev->dev, "dev: %p, i2s: %p\n", &pdev->dev, i2s);
54357b7068dSMax Filippov 
544ebdd7be5SYueHaibing 	i2s->regs = devm_platform_ioremap_resource(pdev, 0);
54557b7068dSMax Filippov 	if (IS_ERR(i2s->regs)) {
54657b7068dSMax Filippov 		err = PTR_ERR(i2s->regs);
54757b7068dSMax Filippov 		goto err;
54857b7068dSMax Filippov 	}
54957b7068dSMax Filippov 
55057b7068dSMax Filippov 	i2s->regmap = devm_regmap_init_mmio(&pdev->dev, i2s->regs,
55157b7068dSMax Filippov 					    &xtfpga_i2s_regmap_config);
55257b7068dSMax Filippov 	if (IS_ERR(i2s->regmap)) {
55357b7068dSMax Filippov 		dev_err(&pdev->dev, "regmap init failed\n");
55457b7068dSMax Filippov 		err = PTR_ERR(i2s->regmap);
55557b7068dSMax Filippov 		goto err;
55657b7068dSMax Filippov 	}
55757b7068dSMax Filippov 
55857b7068dSMax Filippov 	i2s->clk = devm_clk_get(&pdev->dev, NULL);
55957b7068dSMax Filippov 	if (IS_ERR(i2s->clk)) {
56057b7068dSMax Filippov 		dev_err(&pdev->dev, "couldn't get clock\n");
56157b7068dSMax Filippov 		err = PTR_ERR(i2s->clk);
56257b7068dSMax Filippov 		goto err;
56357b7068dSMax Filippov 	}
56457b7068dSMax Filippov 
56557b7068dSMax Filippov 	regmap_write(i2s->regmap, XTFPGA_I2S_CONFIG,
56657b7068dSMax Filippov 		     (0x1 << XTFPGA_I2S_CONFIG_CHANNEL_BASE));
56757b7068dSMax Filippov 	regmap_write(i2s->regmap, XTFPGA_I2S_INT_STATUS, XTFPGA_I2S_INT_VALID);
56857b7068dSMax Filippov 	regmap_write(i2s->regmap, XTFPGA_I2S_INT_MASK, XTFPGA_I2S_INT_UNDERRUN);
56957b7068dSMax Filippov 
57057b7068dSMax Filippov 	irq = platform_get_irq(pdev, 0);
57157b7068dSMax Filippov 	if (irq < 0) {
57257b7068dSMax Filippov 		err = irq;
57357b7068dSMax Filippov 		goto err;
57457b7068dSMax Filippov 	}
57557b7068dSMax Filippov 	err = devm_request_threaded_irq(&pdev->dev, irq, NULL,
57657b7068dSMax Filippov 					xtfpga_i2s_threaded_irq_handler,
57757b7068dSMax Filippov 					IRQF_SHARED | IRQF_ONESHOT,
57857b7068dSMax Filippov 					pdev->name, i2s);
57957b7068dSMax Filippov 	if (err < 0) {
58057b7068dSMax Filippov 		dev_err(&pdev->dev, "request_irq failed\n");
58157b7068dSMax Filippov 		goto err;
58257b7068dSMax Filippov 	}
58357b7068dSMax Filippov 
58457b7068dSMax Filippov 	err = devm_snd_soc_register_component(&pdev->dev,
58557b7068dSMax Filippov 					      &xtfpga_i2s_component,
58657b7068dSMax Filippov 					      xtfpga_i2s_dai,
58757b7068dSMax Filippov 					      ARRAY_SIZE(xtfpga_i2s_dai));
58857b7068dSMax Filippov 	if (err < 0) {
58957b7068dSMax Filippov 		dev_err(&pdev->dev, "couldn't register component\n");
59080f23c29SKuninori Morimoto 		goto err;
59157b7068dSMax Filippov 	}
59257b7068dSMax Filippov 
59357b7068dSMax Filippov 	pm_runtime_enable(&pdev->dev);
59457b7068dSMax Filippov 	if (!pm_runtime_enabled(&pdev->dev)) {
59557b7068dSMax Filippov 		err = xtfpga_i2s_runtime_resume(&pdev->dev);
59657b7068dSMax Filippov 		if (err)
59757b7068dSMax Filippov 			goto err_pm_disable;
59857b7068dSMax Filippov 	}
59957b7068dSMax Filippov 	return 0;
60057b7068dSMax Filippov 
60157b7068dSMax Filippov err_pm_disable:
60257b7068dSMax Filippov 	pm_runtime_disable(&pdev->dev);
60357b7068dSMax Filippov err:
60457b7068dSMax Filippov 	dev_err(&pdev->dev, "%s: err = %d\n", __func__, err);
60557b7068dSMax Filippov 	return err;
60657b7068dSMax Filippov }
60757b7068dSMax Filippov 
xtfpga_i2s_remove(struct platform_device * pdev)608*cbde81bcSUwe Kleine-König static void xtfpga_i2s_remove(struct platform_device *pdev)
60957b7068dSMax Filippov {
61057b7068dSMax Filippov 	struct xtfpga_i2s *i2s = dev_get_drvdata(&pdev->dev);
61157b7068dSMax Filippov 
61257b7068dSMax Filippov 	if (i2s->regmap && !IS_ERR(i2s->regmap)) {
61357b7068dSMax Filippov 		regmap_write(i2s->regmap, XTFPGA_I2S_CONFIG, 0);
61457b7068dSMax Filippov 		regmap_write(i2s->regmap, XTFPGA_I2S_INT_MASK, 0);
61557b7068dSMax Filippov 		regmap_write(i2s->regmap, XTFPGA_I2S_INT_STATUS,
61657b7068dSMax Filippov 			     XTFPGA_I2S_INT_VALID);
61757b7068dSMax Filippov 	}
61857b7068dSMax Filippov 	pm_runtime_disable(&pdev->dev);
61957b7068dSMax Filippov 	if (!pm_runtime_status_suspended(&pdev->dev))
62057b7068dSMax Filippov 		xtfpga_i2s_runtime_suspend(&pdev->dev);
62157b7068dSMax Filippov }
62257b7068dSMax Filippov 
62357b7068dSMax Filippov #ifdef CONFIG_OF
62457b7068dSMax Filippov static const struct of_device_id xtfpga_i2s_of_match[] = {
62557b7068dSMax Filippov 	{ .compatible = "cdns,xtfpga-i2s", },
62657b7068dSMax Filippov 	{},
62757b7068dSMax Filippov };
62857b7068dSMax Filippov MODULE_DEVICE_TABLE(of, xtfpga_i2s_of_match);
62957b7068dSMax Filippov #endif
63057b7068dSMax Filippov 
63157b7068dSMax Filippov static const struct dev_pm_ops xtfpga_i2s_pm_ops = {
63257b7068dSMax Filippov 	SET_RUNTIME_PM_OPS(xtfpga_i2s_runtime_suspend,
63357b7068dSMax Filippov 			   xtfpga_i2s_runtime_resume, NULL)
63457b7068dSMax Filippov };
63557b7068dSMax Filippov 
63657b7068dSMax Filippov static struct platform_driver xtfpga_i2s_driver = {
63757b7068dSMax Filippov 	.probe   = xtfpga_i2s_probe,
638*cbde81bcSUwe Kleine-König 	.remove_new = xtfpga_i2s_remove,
63957b7068dSMax Filippov 	.driver  = {
64057b7068dSMax Filippov 		.name = "xtfpga-i2s",
64157b7068dSMax Filippov 		.of_match_table = of_match_ptr(xtfpga_i2s_of_match),
64257b7068dSMax Filippov 		.pm = &xtfpga_i2s_pm_ops,
64357b7068dSMax Filippov 	},
64457b7068dSMax Filippov };
64557b7068dSMax Filippov 
64657b7068dSMax Filippov module_platform_driver(xtfpga_i2s_driver);
64757b7068dSMax Filippov 
64857b7068dSMax Filippov MODULE_AUTHOR("Max Filippov <jcmvbkbc@gmail.com>");
64957b7068dSMax Filippov MODULE_DESCRIPTION("xtfpga I2S controller driver");
65057b7068dSMax Filippov MODULE_LICENSE("GPL v2");
651