jz4740-i2s.c

Go to the documentation of this file.

/*
 *  Copyright (C) 2010, Lars-Peter Clausen <[email protected]>
 *
 *  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.
 *
 *  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.,
 *  675 Mass Ave, Cambridge, MA 02139, USA.
 *
 */

#include <linux/init.h>
#include <linux/io.h>
#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/platform_device.h>
#include <linux/slab.h>

#include <linux/clk.h>
#include <linux/delay.h>

#include <linux/dma-mapping.h>

#include <sound/core.h>
#include <sound/pcm.h>
#include <sound/pcm_params.h>
#include <sound/soc.h>
#include <sound/initval.h>

#include "jz4740-i2s.h"
#include "jz4740-pcm.h"

#define JZ_REG_AIC_CONF     0x00
#define JZ_REG_AIC_CTRL     0x04
#define JZ_REG_AIC_I2S_FMT  0x10
#define JZ_REG_AIC_FIFO_STATUS  0x14
#define JZ_REG_AIC_I2S_STATUS   0x1c
#define JZ_REG_AIC_CLK_DIV  0x30
#define JZ_REG_AIC_FIFO     0x34

#define JZ_AIC_CONF_FIFO_RX_THRESHOLD_MASK (0xf << 12)
#define JZ_AIC_CONF_FIFO_TX_THRESHOLD_MASK (0xf <<  8)
#define JZ_AIC_CONF_OVERFLOW_PLAY_LAST BIT(6)
#define JZ_AIC_CONF_INTERNAL_CODEC BIT(5)
#define JZ_AIC_CONF_I2S BIT(4)
#define JZ_AIC_CONF_RESET BIT(3)
#define JZ_AIC_CONF_BIT_CLK_MASTER BIT(2)
#define JZ_AIC_CONF_SYNC_CLK_MASTER BIT(1)
#define JZ_AIC_CONF_ENABLE BIT(0)

#define JZ_AIC_CONF_FIFO_RX_THRESHOLD_OFFSET 12
#define JZ_AIC_CONF_FIFO_TX_THRESHOLD_OFFSET 8

#define JZ_AIC_CTRL_OUTPUT_SAMPLE_SIZE_MASK (0x7 << 19)
#define JZ_AIC_CTRL_INPUT_SAMPLE_SIZE_MASK (0x7 << 16)
#define JZ_AIC_CTRL_ENABLE_RX_DMA BIT(15)
#define JZ_AIC_CTRL_ENABLE_TX_DMA BIT(14)
#define JZ_AIC_CTRL_MONO_TO_STEREO BIT(11)
#define JZ_AIC_CTRL_SWITCH_ENDIANNESS BIT(10)
#define JZ_AIC_CTRL_SIGNED_TO_UNSIGNED BIT(9)
#define JZ_AIC_CTRL_FLUSH       BIT(8)
#define JZ_AIC_CTRL_ENABLE_ROR_INT BIT(6)
#define JZ_AIC_CTRL_ENABLE_TUR_INT BIT(5)
#define JZ_AIC_CTRL_ENABLE_RFS_INT BIT(4)
#define JZ_AIC_CTRL_ENABLE_TFS_INT BIT(3)
#define JZ_AIC_CTRL_ENABLE_LOOPBACK BIT(2)
#define JZ_AIC_CTRL_ENABLE_PLAYBACK BIT(1)
#define JZ_AIC_CTRL_ENABLE_CAPTURE BIT(0)

#define JZ_AIC_CTRL_OUTPUT_SAMPLE_SIZE_OFFSET 19
#define JZ_AIC_CTRL_INPUT_SAMPLE_SIZE_OFFSET  16

#define JZ_AIC_I2S_FMT_DISABLE_BIT_CLK BIT(12)
#define JZ_AIC_I2S_FMT_ENABLE_SYS_CLK BIT(4)
#define JZ_AIC_I2S_FMT_MSB BIT(0)

#define JZ_AIC_I2S_STATUS_BUSY BIT(2)

#define JZ_AIC_CLK_DIV_MASK 0xf

struct jz4740_i2s {
    struct resource *mem;
    void __iomem *base;
    dma_addr_t phys_base;

    struct clk *clk_aic;
    struct clk *clk_i2s;

    struct jz4740_pcm_config pcm_config_playback;
    struct jz4740_pcm_config pcm_config_capture;
};

static inline uint32_t jz4740_i2s_read(const struct jz4740_i2s *i2s,
    unsigned int reg)
{
    return readl(i2s->base + reg);
}

static inline void jz4740_i2s_write(const struct jz4740_i2s *i2s,
    unsigned int reg, uint32_t value)
{
    writel(value, i2s->base + reg);
}

static int jz4740_i2s_startup(struct snd_pcm_substream *substream,
    struct snd_soc_dai *dai)
{
    struct jz4740_i2s *i2s = snd_soc_dai_get_drvdata(dai);
    uint32_t conf, ctrl;

    if (dai->active)
        return 0;

    ctrl = jz4740_i2s_read(i2s, JZ_REG_AIC_CTRL);
    ctrl |= JZ_AIC_CTRL_FLUSH;
    jz4740_i2s_write(i2s, JZ_REG_AIC_CTRL, ctrl);

    clk_enable(i2s->clk_i2s);

    conf = jz4740_i2s_read(i2s, JZ_REG_AIC_CONF);
    conf |= JZ_AIC_CONF_ENABLE;
    jz4740_i2s_write(i2s, JZ_REG_AIC_CONF, conf);

    return 0;
}

static void jz4740_i2s_shutdown(struct snd_pcm_substream *substream,
    struct snd_soc_dai *dai)
{
    struct jz4740_i2s *i2s = snd_soc_dai_get_drvdata(dai);
    uint32_t conf;

    if (dai->active)
        return;

    conf = jz4740_i2s_read(i2s, JZ_REG_AIC_CONF);
    conf &= ~JZ_AIC_CONF_ENABLE;
    jz4740_i2s_write(i2s, JZ_REG_AIC_CONF, conf);

    clk_disable(i2s->clk_i2s);
}

static int jz4740_i2s_trigger(struct snd_pcm_substream *substream, int cmd,
    struct snd_soc_dai *dai)
{
    struct jz4740_i2s *i2s = snd_soc_dai_get_drvdata(dai);

    uint32_t ctrl;
    uint32_t mask;

    if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
        mask = JZ_AIC_CTRL_ENABLE_PLAYBACK | JZ_AIC_CTRL_ENABLE_TX_DMA;
    else
        mask = JZ_AIC_CTRL_ENABLE_CAPTURE | JZ_AIC_CTRL_ENABLE_RX_DMA;

    ctrl = jz4740_i2s_read(i2s, JZ_REG_AIC_CTRL);

    switch (cmd) {
    case SNDRV_PCM_TRIGGER_START:
    case SNDRV_PCM_TRIGGER_RESUME:
    case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
        ctrl |= mask;
        break;
    case SNDRV_PCM_TRIGGER_STOP:
    case SNDRV_PCM_TRIGGER_SUSPEND:
    case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
        ctrl &= ~mask;
        break;
    default:
        return -EINVAL;
    }

    jz4740_i2s_write(i2s, JZ_REG_AIC_CTRL, ctrl);

    return 0;
}

static int jz4740_i2s_set_fmt(struct snd_soc_dai *dai, unsigned int fmt)
{
    struct jz4740_i2s *i2s = snd_soc_dai_get_drvdata(dai);

    uint32_t format = 0;
    uint32_t conf;

    conf = jz4740_i2s_read(i2s, JZ_REG_AIC_CONF);

    conf &= ~(JZ_AIC_CONF_BIT_CLK_MASTER | JZ_AIC_CONF_SYNC_CLK_MASTER);

    switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
    case SND_SOC_DAIFMT_CBS_CFS:
        conf |= JZ_AIC_CONF_BIT_CLK_MASTER | JZ_AIC_CONF_SYNC_CLK_MASTER;
        format |= JZ_AIC_I2S_FMT_ENABLE_SYS_CLK;
        break;
    case SND_SOC_DAIFMT_CBM_CFS:
        conf |= JZ_AIC_CONF_SYNC_CLK_MASTER;
        break;
    case SND_SOC_DAIFMT_CBS_CFM:
        conf |= JZ_AIC_CONF_BIT_CLK_MASTER;
        break;
    case SND_SOC_DAIFMT_CBM_CFM:
        break;
    default:
        return -EINVAL;
    }

    switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
    case SND_SOC_DAIFMT_MSB:
        format |= JZ_AIC_I2S_FMT_MSB;
        break;
    case SND_SOC_DAIFMT_I2S:
        break;
    default:
        return -EINVAL;
    }

    switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
    case SND_SOC_DAIFMT_NB_NF:
        break;
    default:
        return -EINVAL;
    }

    jz4740_i2s_write(i2s, JZ_REG_AIC_CONF, conf);
    jz4740_i2s_write(i2s, JZ_REG_AIC_I2S_FMT, format);

    return 0;
}

static int jz4740_i2s_hw_params(struct snd_pcm_substream *substream,
    struct snd_pcm_hw_params *params, struct snd_soc_dai *dai)
{
    struct jz4740_i2s *i2s = snd_soc_dai_get_drvdata(dai);
    enum jz4740_dma_width dma_width;
    struct jz4740_pcm_config *pcm_config;
    unsigned int sample_size;
    uint32_t ctrl;

    ctrl = jz4740_i2s_read(i2s, JZ_REG_AIC_CTRL);

    switch (params_format(params)) {
    case SNDRV_PCM_FORMAT_S8:
        sample_size = 0;
        dma_width = JZ4740_DMA_WIDTH_8BIT;
        break;
    case SNDRV_PCM_FORMAT_S16:
        sample_size = 1;
        dma_width = JZ4740_DMA_WIDTH_16BIT;
        break;
    default:
        return -EINVAL;
    }

    if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK) {
        ctrl &= ~JZ_AIC_CTRL_OUTPUT_SAMPLE_SIZE_MASK;
        ctrl |= sample_size << JZ_AIC_CTRL_OUTPUT_SAMPLE_SIZE_OFFSET;
        if (params_channels(params) == 1)
            ctrl |= JZ_AIC_CTRL_MONO_TO_STEREO;
        else
            ctrl &= ~JZ_AIC_CTRL_MONO_TO_STEREO;

        pcm_config = &i2s->pcm_config_playback;
        pcm_config->dma_config.dst_width = dma_width;

    } else {
        ctrl &= ~JZ_AIC_CTRL_INPUT_SAMPLE_SIZE_MASK;
        ctrl |= sample_size << JZ_AIC_CTRL_INPUT_SAMPLE_SIZE_OFFSET;

        pcm_config = &i2s->pcm_config_capture;
        pcm_config->dma_config.src_width = dma_width;
    }

    jz4740_i2s_write(i2s, JZ_REG_AIC_CTRL, ctrl);

    snd_soc_dai_set_dma_data(dai, substream, pcm_config);

    return 0;
}

static int jz4740_i2s_set_sysclk(struct snd_soc_dai *dai, int clk_id,
    unsigned int freq, int dir)
{
    struct jz4740_i2s *i2s = snd_soc_dai_get_drvdata(dai);
    struct clk *parent;
    int ret = 0;

    switch (clk_id) {
    case JZ4740_I2S_CLKSRC_EXT:
        parent = clk_get(NULL, "ext");
        clk_set_parent(i2s->clk_i2s, parent);
        break;
    case JZ4740_I2S_CLKSRC_PLL:
        parent = clk_get(NULL, "pll half");
        clk_set_parent(i2s->clk_i2s, parent);
        ret = clk_set_rate(i2s->clk_i2s, freq);
        break;
    default:
        return -EINVAL;
    }
    clk_put(parent);

    return ret;
}

static int jz4740_i2s_suspend(struct snd_soc_dai *dai)
{
    struct jz4740_i2s *i2s = snd_soc_dai_get_drvdata(dai);
    uint32_t conf;

    if (dai->active) {
        conf = jz4740_i2s_read(i2s, JZ_REG_AIC_CONF);
        conf &= ~JZ_AIC_CONF_ENABLE;
        jz4740_i2s_write(i2s, JZ_REG_AIC_CONF, conf);

        clk_disable(i2s->clk_i2s);
    }

    clk_disable(i2s->clk_aic);

    return 0;
}

static int jz4740_i2s_resume(struct snd_soc_dai *dai)
{
    struct jz4740_i2s *i2s = snd_soc_dai_get_drvdata(dai);
    uint32_t conf;

    clk_enable(i2s->clk_aic);

    if (dai->active) {
        clk_enable(i2s->clk_i2s);

        conf = jz4740_i2s_read(i2s, JZ_REG_AIC_CONF);
        conf |= JZ_AIC_CONF_ENABLE;
        jz4740_i2s_write(i2s, JZ_REG_AIC_CONF, conf);
    }

    return 0;
}

static void jz4740_i2c_init_pcm_config(struct jz4740_i2s *i2s)
{
    struct jz4740_dma_config *dma_config;

    /* Playback */
    dma_config = &i2s->pcm_config_playback.dma_config;
    dma_config->src_width = JZ4740_DMA_WIDTH_32BIT;
    dma_config->transfer_size = JZ4740_DMA_TRANSFER_SIZE_16BYTE;
    dma_config->request_type = JZ4740_DMA_TYPE_AIC_TRANSMIT;
    dma_config->flags = JZ4740_DMA_SRC_AUTOINC;
    dma_config->mode = JZ4740_DMA_MODE_SINGLE;
    i2s->pcm_config_playback.fifo_addr = i2s->phys_base + JZ_REG_AIC_FIFO;

    /* Capture */
    dma_config = &i2s->pcm_config_capture.dma_config;
    dma_config->dst_width = JZ4740_DMA_WIDTH_32BIT;
    dma_config->transfer_size = JZ4740_DMA_TRANSFER_SIZE_16BYTE;
    dma_config->request_type = JZ4740_DMA_TYPE_AIC_RECEIVE;
    dma_config->flags = JZ4740_DMA_DST_AUTOINC;
    dma_config->mode = JZ4740_DMA_MODE_SINGLE;
    i2s->pcm_config_capture.fifo_addr = i2s->phys_base + JZ_REG_AIC_FIFO;
}

static int jz4740_i2s_dai_probe(struct snd_soc_dai *dai)
{
    struct jz4740_i2s *i2s = snd_soc_dai_get_drvdata(dai);
    uint32_t conf;

    clk_enable(i2s->clk_aic);

    jz4740_i2c_init_pcm_config(i2s);

    conf = (7 << JZ_AIC_CONF_FIFO_RX_THRESHOLD_OFFSET) |
        (8 << JZ_AIC_CONF_FIFO_TX_THRESHOLD_OFFSET) |
        JZ_AIC_CONF_OVERFLOW_PLAY_LAST |
        JZ_AIC_CONF_I2S |
        JZ_AIC_CONF_INTERNAL_CODEC;

    jz4740_i2s_write(i2s, JZ_REG_AIC_CONF, JZ_AIC_CONF_RESET);
    jz4740_i2s_write(i2s, JZ_REG_AIC_CONF, conf);

    return 0;
}

static int jz4740_i2s_dai_remove(struct snd_soc_dai *dai)
{
    struct jz4740_i2s *i2s = snd_soc_dai_get_drvdata(dai);

    clk_disable(i2s->clk_aic);
    return 0;
}

static const struct snd_soc_dai_ops jz4740_i2s_dai_ops = {
    .startup = jz4740_i2s_startup,
    .shutdown = jz4740_i2s_shutdown,
    .trigger = jz4740_i2s_trigger,
    .hw_params = jz4740_i2s_hw_params,
    .set_fmt = jz4740_i2s_set_fmt,
    .set_sysclk = jz4740_i2s_set_sysclk,
};

#define JZ4740_I2S_FMTS (SNDRV_PCM_FMTBIT_S8 | \
        SNDRV_PCM_FMTBIT_S16_LE)

static struct snd_soc_dai_driver jz4740_i2s_dai = {
    .probe = jz4740_i2s_dai_probe,
    .remove = jz4740_i2s_dai_remove,
    .playback = {
        .channels_min = 1,
        .channels_max = 2,
        .rates = SNDRV_PCM_RATE_8000_48000,
        .formats = JZ4740_I2S_FMTS,
    },
    .capture = {
        .channels_min = 2,
        .channels_max = 2,
        .rates = SNDRV_PCM_RATE_8000_48000,
        .formats = JZ4740_I2S_FMTS,
    },
    .symmetric_rates = 1,
    .ops = &jz4740_i2s_dai_ops,
    .suspend = jz4740_i2s_suspend,
    .resume = jz4740_i2s_resume,
};

static int __devinit jz4740_i2s_dev_probe(struct platform_device *pdev)
{
    struct jz4740_i2s *i2s;
    int ret;

    i2s = kzalloc(sizeof(*i2s), GFP_KERNEL);

    if (!i2s)
        return -ENOMEM;

    i2s->mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
    if (!i2s->mem) {
        ret = -ENOENT;
        goto err_free;
    }

    i2s->mem = request_mem_region(i2s->mem->start, resource_size(i2s->mem),
                pdev->name);
    if (!i2s->mem) {
        ret = -EBUSY;
        goto err_free;
    }

    i2s->base = ioremap_nocache(i2s->mem->start, resource_size(i2s->mem));
    if (!i2s->base) {
        ret = -EBUSY;
        goto err_release_mem_region;
    }

    i2s->phys_base = i2s->mem->start;

    i2s->clk_aic = clk_get(&pdev->dev, "aic");
    if (IS_ERR(i2s->clk_aic)) {
        ret = PTR_ERR(i2s->clk_aic);
        goto err_iounmap;
    }

    i2s->clk_i2s = clk_get(&pdev->dev, "i2s");
    if (IS_ERR(i2s->clk_i2s)) {
        ret = PTR_ERR(i2s->clk_i2s);
        goto err_clk_put_aic;
    }

    platform_set_drvdata(pdev, i2s);
    ret = snd_soc_register_dai(&pdev->dev, &jz4740_i2s_dai);

    if (ret) {
        dev_err(&pdev->dev, "Failed to register DAI\n");
        goto err_clk_put_i2s;
    }

    return 0;

err_clk_put_i2s:
    clk_put(i2s->clk_i2s);
err_clk_put_aic:
    clk_put(i2s->clk_aic);
err_iounmap:
    iounmap(i2s->base);
err_release_mem_region:
    release_mem_region(i2s->mem->start, resource_size(i2s->mem));
err_free:
    kfree(i2s);

    return ret;
}

static int __devexit jz4740_i2s_dev_remove(struct platform_device *pdev)
{
    struct jz4740_i2s *i2s = platform_get_drvdata(pdev);

    snd_soc_unregister_dai(&pdev->dev);

    clk_put(i2s->clk_i2s);
    clk_put(i2s->clk_aic);

    iounmap(i2s->base);
    release_mem_region(i2s->mem->start, resource_size(i2s->mem));

    platform_set_drvdata(pdev, NULL);
    kfree(i2s);

    return 0;
}

static struct platform_driver jz4740_i2s_driver = {
    .probe = jz4740_i2s_dev_probe,
    .remove = __devexit_p(jz4740_i2s_dev_remove),
    .driver = {
        .name = "jz4740-i2s",
        .owner = THIS_MODULE,
    },
};

module_platform_driver(jz4740_i2s_driver);

MODULE_AUTHOR("Lars-Peter Clausen, <[email protected]>");
MODULE_DESCRIPTION("Ingenic JZ4740 SoC I2S driver");
MODULE_LICENSE("GPL");
MODULE_ALIAS("platform:jz4740-i2s");