mmp-sspa.c

Go to the documentation of this file.

/*
 * linux/sound/soc/pxa/mmp-sspa.c
 * Base on pxa2xx-ssp.c
 *
 * Copyright (C) 2011 Marvell International Ltd.
 *
 * 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.
 *
 * 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.
 *
 * 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */
#include <linux/init.h>
#include <linux/module.h>
#include <linux/platform_device.h>
#include <linux/delay.h>
#include <linux/clk.h>
#include <linux/slab.h>
#include <linux/pxa2xx_ssp.h>
#include <linux/io.h>
#include <sound/core.h>
#include <sound/pcm.h>
#include <sound/initval.h>
#include <sound/pcm_params.h>
#include <sound/soc.h>
#include <sound/pxa2xx-lib.h>
#include "mmp-sspa.h"

/*
 * SSPA audio private data
 */
struct sspa_priv {
    struct ssp_device *sspa;
    struct pxa2xx_pcm_dma_params *dma_params;
    struct clk *audio_clk;
    struct clk *sysclk;
    int dai_fmt;
    int running_cnt;
};

static void mmp_sspa_write_reg(struct ssp_device *sspa, u32 reg, u32 val)
{
    __raw_writel(val, sspa->mmio_base + reg);
}

static u32 mmp_sspa_read_reg(struct ssp_device *sspa, u32 reg)
{
    return __raw_readl(sspa->mmio_base + reg);
}

static void mmp_sspa_tx_enable(struct ssp_device *sspa)
{
    unsigned int sspa_sp;

    sspa_sp = mmp_sspa_read_reg(sspa, SSPA_TXSP);
    sspa_sp |= SSPA_SP_S_EN;
    sspa_sp |= SSPA_SP_WEN;
    mmp_sspa_write_reg(sspa, SSPA_TXSP, sspa_sp);
}

static void mmp_sspa_tx_disable(struct ssp_device *sspa)
{
    unsigned int sspa_sp;

    sspa_sp = mmp_sspa_read_reg(sspa, SSPA_TXSP);
    sspa_sp &= ~SSPA_SP_S_EN;
    sspa_sp |= SSPA_SP_WEN;
    mmp_sspa_write_reg(sspa, SSPA_TXSP, sspa_sp);
}

static void mmp_sspa_rx_enable(struct ssp_device *sspa)
{
    unsigned int sspa_sp;

    sspa_sp = mmp_sspa_read_reg(sspa, SSPA_RXSP);
    sspa_sp |= SSPA_SP_S_EN;
    sspa_sp |= SSPA_SP_WEN;
    mmp_sspa_write_reg(sspa, SSPA_RXSP, sspa_sp);
}

static void mmp_sspa_rx_disable(struct ssp_device *sspa)
{
    unsigned int sspa_sp;

    sspa_sp = mmp_sspa_read_reg(sspa, SSPA_RXSP);
    sspa_sp &= ~SSPA_SP_S_EN;
    sspa_sp |= SSPA_SP_WEN;
    mmp_sspa_write_reg(sspa, SSPA_RXSP, sspa_sp);
}

static int mmp_sspa_startup(struct snd_pcm_substream *substream,
    struct snd_soc_dai *dai)
{
    struct sspa_priv *priv = snd_soc_dai_get_drvdata(dai);

    clk_enable(priv->sysclk);
    clk_enable(priv->sspa->clk);

    return 0;
}

static void mmp_sspa_shutdown(struct snd_pcm_substream *substream,
    struct snd_soc_dai *dai)
{
    struct sspa_priv *priv = snd_soc_dai_get_drvdata(dai);

    clk_disable(priv->sspa->clk);
    clk_disable(priv->sysclk);

    return;
}

/*
 * Set the SSP ports SYSCLK.
 */
static int mmp_sspa_set_dai_sysclk(struct snd_soc_dai *cpu_dai,
                    int clk_id, unsigned int freq, int dir)
{
    struct sspa_priv *priv = snd_soc_dai_get_drvdata(cpu_dai);
    int ret = 0;

    switch (clk_id) {
    case MMP_SSPA_CLK_AUDIO:
        ret = clk_set_rate(priv->audio_clk, freq);
        if (ret)
            return ret;
        break;
    case MMP_SSPA_CLK_PLL:
    case MMP_SSPA_CLK_VCXO:
        /* not support yet */
        return -EINVAL;
    default:
        return -EINVAL;
    }

    return 0;
}

static int mmp_sspa_set_dai_pll(struct snd_soc_dai *cpu_dai, int pll_id,
                 int source, unsigned int freq_in,
                 unsigned int freq_out)
{
    struct sspa_priv *priv = snd_soc_dai_get_drvdata(cpu_dai);
    int ret = 0;

    switch (pll_id) {
    case MMP_SYSCLK:
        ret = clk_set_rate(priv->sysclk, freq_out);
        if (ret)
            return ret;
        break;
    case MMP_SSPA_CLK:
        ret = clk_set_rate(priv->sspa->clk, freq_out);
        if (ret)
            return ret;
        break;
    default:
        return -ENODEV;
    }

    return 0;
}

/*
 * Set up the sspa dai format. The sspa port must be inactive
 * before calling this function as the physical
 * interface format is changed.
 */
static int mmp_sspa_set_dai_fmt(struct snd_soc_dai *cpu_dai,
                 unsigned int fmt)
{
    struct sspa_priv *sspa_priv = snd_soc_dai_get_drvdata(cpu_dai);
    struct ssp_device *sspa = sspa_priv->sspa;
    u32 sspa_sp, sspa_ctrl;

    /* check if we need to change anything at all */
    if (sspa_priv->dai_fmt == fmt)
        return 0;

    /* we can only change the settings if the port is not in use */
    if ((mmp_sspa_read_reg(sspa, SSPA_TXSP) & SSPA_SP_S_EN) ||
        (mmp_sspa_read_reg(sspa, SSPA_RXSP) & SSPA_SP_S_EN)) {
        dev_err(&sspa->pdev->dev,
            "can't change hardware dai format: stream is in use\n");
        return -EINVAL;
    }

    /* reset port settings */
    sspa_sp   = SSPA_SP_WEN | SSPA_SP_S_RST | SSPA_SP_FFLUSH;
    sspa_ctrl = 0;

    switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
    case SND_SOC_DAIFMT_CBS_CFS:
        sspa_sp |= SSPA_SP_MSL;
        break;
    case SND_SOC_DAIFMT_CBM_CFM:
        break;
    default:
        return -EINVAL;
    }

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

    switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
    case SND_SOC_DAIFMT_I2S:
        sspa_sp |= SSPA_TXSP_FPER(63);
        sspa_sp |= SSPA_SP_FWID(31);
        sspa_ctrl |= SSPA_CTL_XDATDLY(1);
        break;
    default:
        return -EINVAL;
    }

    mmp_sspa_write_reg(sspa, SSPA_TXSP, sspa_sp);
    mmp_sspa_write_reg(sspa, SSPA_RXSP, sspa_sp);

    sspa_sp &= ~(SSPA_SP_S_RST | SSPA_SP_FFLUSH);
    mmp_sspa_write_reg(sspa, SSPA_TXSP, sspa_sp);
    mmp_sspa_write_reg(sspa, SSPA_RXSP, sspa_sp);

    /*
     * FIXME: hw issue, for the tx serial port,
     * can not config the master/slave mode;
     * so must clean this bit.
     * The master/slave mode has been set in the
     * rx port.
     */
    sspa_sp &= ~SSPA_SP_MSL;
    mmp_sspa_write_reg(sspa, SSPA_TXSP, sspa_sp);

    mmp_sspa_write_reg(sspa, SSPA_TXCTL, sspa_ctrl);
    mmp_sspa_write_reg(sspa, SSPA_RXCTL, sspa_ctrl);

    /* Since we are configuring the timings for the format by hand
     * we have to defer some things until hw_params() where we
     * know parameters like the sample size.
     */
    sspa_priv->dai_fmt = fmt;
    return 0;
}

/*
 * Set the SSPA audio DMA parameters and sample size.
 * Can be called multiple times by oss emulation.
 */
static int mmp_sspa_hw_params(struct snd_pcm_substream *substream,
                   struct snd_pcm_hw_params *params,
                   struct snd_soc_dai *dai)
{
    struct snd_soc_pcm_runtime *rtd = substream->private_data;
    struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
    struct sspa_priv *sspa_priv = snd_soc_dai_get_drvdata(dai);
    struct ssp_device *sspa = sspa_priv->sspa;
    struct pxa2xx_pcm_dma_params *dma_params;
    u32 sspa_ctrl;

    if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
        sspa_ctrl = mmp_sspa_read_reg(sspa, SSPA_TXCTL);
    else
        sspa_ctrl = mmp_sspa_read_reg(sspa, SSPA_RXCTL);

    sspa_ctrl &= ~SSPA_CTL_XFRLEN1_MASK;
    sspa_ctrl |= SSPA_CTL_XFRLEN1(params_channels(params) - 1);
    sspa_ctrl &= ~SSPA_CTL_XWDLEN1_MASK;
    sspa_ctrl |= SSPA_CTL_XWDLEN1(SSPA_CTL_32_BITS);
    sspa_ctrl &= ~SSPA_CTL_XSSZ1_MASK;

    switch (params_format(params)) {
    case SNDRV_PCM_FORMAT_S8:
        sspa_ctrl |= SSPA_CTL_XSSZ1(SSPA_CTL_8_BITS);
        break;
    case SNDRV_PCM_FORMAT_S16_LE:
        sspa_ctrl |= SSPA_CTL_XSSZ1(SSPA_CTL_16_BITS);
        break;
    case SNDRV_PCM_FORMAT_S20_3LE:
        sspa_ctrl |= SSPA_CTL_XSSZ1(SSPA_CTL_20_BITS);
        break;
    case SNDRV_PCM_FORMAT_S24_3LE:
        sspa_ctrl |= SSPA_CTL_XSSZ1(SSPA_CTL_24_BITS);
        break;
    case SNDRV_PCM_FORMAT_S32_LE:
        sspa_ctrl |= SSPA_CTL_XSSZ1(SSPA_CTL_32_BITS);
        break;
    default:
        return -EINVAL;
    }

    if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK) {
        mmp_sspa_write_reg(sspa, SSPA_TXCTL, sspa_ctrl);
        mmp_sspa_write_reg(sspa, SSPA_TXFIFO_LL, 0x1);
    } else {
        mmp_sspa_write_reg(sspa, SSPA_RXCTL, sspa_ctrl);
        mmp_sspa_write_reg(sspa, SSPA_RXFIFO_UL, 0x0);
    }

    dma_params = &sspa_priv->dma_params[substream->stream];
    dma_params->dev_addr = substream->stream == SNDRV_PCM_STREAM_PLAYBACK ?
                (sspa->phys_base + SSPA_TXD) :
                (sspa->phys_base + SSPA_RXD);
    snd_soc_dai_set_dma_data(cpu_dai, substream, dma_params);
    return 0;
}

static int mmp_sspa_trigger(struct snd_pcm_substream *substream, int cmd,
                 struct snd_soc_dai *dai)
{
    struct sspa_priv *sspa_priv = snd_soc_dai_get_drvdata(dai);
    struct ssp_device *sspa = sspa_priv->sspa;
    int ret = 0;

    switch (cmd) {
    case SNDRV_PCM_TRIGGER_START:
    case SNDRV_PCM_TRIGGER_RESUME:
    case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
        /*
         * whatever playback or capture, must enable rx.
         * this is a hw issue, so need check if rx has been
         * enabled or not; if has been enabled by another
         * stream, do not enable again.
         */
        if (!sspa_priv->running_cnt)
            mmp_sspa_rx_enable(sspa);

        if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
            mmp_sspa_tx_enable(sspa);

        sspa_priv->running_cnt++;
        break;

    case SNDRV_PCM_TRIGGER_STOP:
    case SNDRV_PCM_TRIGGER_SUSPEND:
    case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
        sspa_priv->running_cnt--;

        if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
            mmp_sspa_tx_disable(sspa);

        /* have no capture stream, disable rx port */
        if (!sspa_priv->running_cnt)
            mmp_sspa_rx_disable(sspa);
        break;

    default:
        ret = -EINVAL;
    }

    return ret;
}

static int mmp_sspa_probe(struct snd_soc_dai *dai)
{
    struct sspa_priv *priv = dev_get_drvdata(dai->dev);

    snd_soc_dai_set_drvdata(dai, priv);
    return 0;

}

#define MMP_SSPA_RATES SNDRV_PCM_RATE_8000_192000
#define MMP_SSPA_FORMATS (SNDRV_PCM_FMTBIT_S8 | \
        SNDRV_PCM_FMTBIT_S16_LE | \
        SNDRV_PCM_FMTBIT_S24_LE | \
        SNDRV_PCM_FMTBIT_S24_LE | \
        SNDRV_PCM_FMTBIT_S32_LE)

static struct snd_soc_dai_ops mmp_sspa_dai_ops = {
    .startup    = mmp_sspa_startup,
    .shutdown   = mmp_sspa_shutdown,
    .trigger    = mmp_sspa_trigger,
    .hw_params  = mmp_sspa_hw_params,
    .set_sysclk = mmp_sspa_set_dai_sysclk,
    .set_pll    = mmp_sspa_set_dai_pll,
    .set_fmt    = mmp_sspa_set_dai_fmt,
};

struct snd_soc_dai_driver mmp_sspa_dai = {
    .probe = mmp_sspa_probe,
    .playback = {
        .channels_min = 1,
        .channels_max = 128,
        .rates = MMP_SSPA_RATES,
        .formats = MMP_SSPA_FORMATS,
    },
    .capture = {
        .channels_min = 1,
        .channels_max = 2,
        .rates = MMP_SSPA_RATES,
        .formats = MMP_SSPA_FORMATS,
    },
    .ops = &mmp_sspa_dai_ops,
};

static __devinit int asoc_mmp_sspa_probe(struct platform_device *pdev)
{
    struct sspa_priv *priv;
    struct resource *res;

    priv = devm_kzalloc(&pdev->dev,
                sizeof(struct sspa_priv), GFP_KERNEL);
    if (!priv)
        return -ENOMEM;

    priv->sspa = devm_kzalloc(&pdev->dev,
                sizeof(struct ssp_device), GFP_KERNEL);
    if (priv->sspa == NULL)
        return -ENOMEM;

    priv->dma_params = devm_kzalloc(&pdev->dev,
            2 * sizeof(struct pxa2xx_pcm_dma_params), GFP_KERNEL);
    if (priv->dma_params == NULL)
        return -ENOMEM;

    res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
    if (res == NULL)
        return -ENOMEM;

    priv->sspa->mmio_base = devm_request_and_ioremap(&pdev->dev, res);
    if (priv->sspa->mmio_base == NULL)
        return -ENODEV;

    priv->sspa->clk = devm_clk_get(&pdev->dev, NULL);
    if (IS_ERR(priv->sspa->clk))
        return PTR_ERR(priv->sspa->clk);

    priv->audio_clk = clk_get(NULL, "mmp-audio");
    if (IS_ERR(priv->audio_clk))
        return PTR_ERR(priv->audio_clk);

    priv->sysclk = clk_get(NULL, "mmp-sysclk");
    if (IS_ERR(priv->sysclk)) {
        clk_put(priv->audio_clk);
        return PTR_ERR(priv->sysclk);
    }
    clk_enable(priv->audio_clk);
    priv->dai_fmt = (unsigned int) -1;
    platform_set_drvdata(pdev, priv);

    return snd_soc_register_dai(&pdev->dev, &mmp_sspa_dai);
}

static int __devexit asoc_mmp_sspa_remove(struct platform_device *pdev)
{
    struct sspa_priv *priv = platform_get_drvdata(pdev);

    clk_disable(priv->audio_clk);
    clk_put(priv->audio_clk);
    clk_put(priv->sysclk);
    snd_soc_unregister_dai(&pdev->dev);
    return 0;
}

static struct platform_driver asoc_mmp_sspa_driver = {
    .driver = {
        .name = "mmp-sspa-dai",
        .owner = THIS_MODULE,
    },
    .probe = asoc_mmp_sspa_probe,
    .remove = __devexit_p(asoc_mmp_sspa_remove),
};

module_platform_driver(asoc_mmp_sspa_driver);

MODULE_AUTHOR("Leo Yan <[email protected]>");
MODULE_DESCRIPTION("MMP SSPA SoC Interface");
MODULE_LICENSE("GPL");