2 * Freescale MPC8610HPCD ALSA SoC Machine driver
4 * Author: Timur Tabi <timur@freescale.com>
6 * Copyright 2007-2010 Freescale Semiconductor, Inc.
8 * This file is licensed under the terms of the GNU General Public License
9 * version 2. This program is licensed "as is" without any warranty of any
10 * kind, whether express or implied.
13 #include <linux/module.h>
14 #include <linux/interrupt.h>
15 #include <linux/of_device.h>
16 #include <linux/slab.h>
17 #include <linux/of_i2c.h>
18 #include <sound/soc.h>
19 #include <asm/fsl_guts.h>
24 /* There's only one global utilities register */
25 static phys_addr_t guts_phys;
27 #define DAI_NAME_SIZE 32
30 * mpc8610_hpcd_data: machine-specific ASoC device data
32 * This structure contains data for a single sound platform device on an
33 * MPC8610 HPCD. Some of the data is taken from the device tree.
35 struct mpc8610_hpcd_data {
36 struct snd_soc_dai_link dai[2];
37 struct snd_soc_card card;
38 unsigned int dai_format;
39 unsigned int codec_clk_direction;
40 unsigned int cpu_clk_direction;
41 unsigned int clk_frequency;
42 unsigned int ssi_id; /* 0 = SSI1, 1 = SSI2, etc */
43 unsigned int dma_id[2]; /* 0 = DMA1, 1 = DMA2, etc */
44 unsigned int dma_channel_id[2]; /* 0 = ch 0, 1 = ch 1, etc*/
45 char codec_dai_name[DAI_NAME_SIZE];
46 char codec_name[DAI_NAME_SIZE];
47 char platform_name[2][DAI_NAME_SIZE]; /* One for each DMA channel */
51 * mpc8610_hpcd_machine_probe: initialize the board
53 * This function is used to initialize the board-specific hardware.
55 * Here we program the DMACR and PMUXCR registers.
57 static int mpc8610_hpcd_machine_probe(struct snd_soc_card *card)
59 struct mpc8610_hpcd_data *machine_data =
60 container_of(card, struct mpc8610_hpcd_data, card);
61 struct ccsr_guts __iomem *guts;
63 guts = ioremap(guts_phys, sizeof(struct ccsr_guts));
65 dev_err(card->dev, "could not map global utilities\n");
69 /* Program the signal routing between the SSI and the DMA */
70 guts_set_dmacr(guts, machine_data->dma_id[0],
71 machine_data->dma_channel_id[0],
72 CCSR_GUTS_DMACR_DEV_SSI);
73 guts_set_dmacr(guts, machine_data->dma_id[1],
74 machine_data->dma_channel_id[1],
75 CCSR_GUTS_DMACR_DEV_SSI);
77 guts_set_pmuxcr_dma(guts, machine_data->dma_id[0],
78 machine_data->dma_channel_id[0], 0);
79 guts_set_pmuxcr_dma(guts, machine_data->dma_id[1],
80 machine_data->dma_channel_id[1], 0);
82 switch (machine_data->ssi_id) {
84 clrsetbits_be32(&guts->pmuxcr,
85 CCSR_GUTS_PMUXCR_SSI1_MASK, CCSR_GUTS_PMUXCR_SSI1_SSI);
88 clrsetbits_be32(&guts->pmuxcr,
89 CCSR_GUTS_PMUXCR_SSI2_MASK, CCSR_GUTS_PMUXCR_SSI2_SSI);
99 * mpc8610_hpcd_startup: program the board with various hardware parameters
101 * This function takes board-specific information, like clock frequencies
102 * and serial data formats, and passes that information to the codec and
105 static int mpc8610_hpcd_startup(struct snd_pcm_substream *substream)
107 struct snd_soc_pcm_runtime *rtd = substream->private_data;
108 struct mpc8610_hpcd_data *machine_data =
109 container_of(rtd->card, struct mpc8610_hpcd_data, card);
110 struct device *dev = rtd->card->dev;
113 /* Tell the codec driver what the serial protocol is. */
114 ret = snd_soc_dai_set_fmt(rtd->codec_dai, machine_data->dai_format);
116 dev_err(dev, "could not set codec driver audio format\n");
121 * Tell the codec driver what the MCLK frequency is, and whether it's
124 ret = snd_soc_dai_set_sysclk(rtd->codec_dai, 0,
125 machine_data->clk_frequency,
126 machine_data->codec_clk_direction);
128 dev_err(dev, "could not set codec driver clock params\n");
136 * mpc8610_hpcd_machine_remove: Remove the sound device
138 * This function is called to remove the sound device for one SSI. We
139 * de-program the DMACR and PMUXCR register.
141 static int mpc8610_hpcd_machine_remove(struct snd_soc_card *card)
143 struct mpc8610_hpcd_data *machine_data =
144 container_of(card, struct mpc8610_hpcd_data, card);
145 struct ccsr_guts __iomem *guts;
147 guts = ioremap(guts_phys, sizeof(struct ccsr_guts));
149 dev_err(card->dev, "could not map global utilities\n");
153 /* Restore the signal routing */
155 guts_set_dmacr(guts, machine_data->dma_id[0],
156 machine_data->dma_channel_id[0], 0);
157 guts_set_dmacr(guts, machine_data->dma_id[1],
158 machine_data->dma_channel_id[1], 0);
160 switch (machine_data->ssi_id) {
162 clrsetbits_be32(&guts->pmuxcr,
163 CCSR_GUTS_PMUXCR_SSI1_MASK, CCSR_GUTS_PMUXCR_SSI1_LA);
166 clrsetbits_be32(&guts->pmuxcr,
167 CCSR_GUTS_PMUXCR_SSI2_MASK, CCSR_GUTS_PMUXCR_SSI2_LA);
177 * mpc8610_hpcd_ops: ASoC machine driver operations
179 static struct snd_soc_ops mpc8610_hpcd_ops = {
180 .startup = mpc8610_hpcd_startup,
184 * get_node_by_phandle_name - get a node by its phandle name
186 * This function takes a node, the name of a property in that node, and a
187 * compatible string. Assuming the property is a phandle to another node,
188 * it returns that node, (optionally) if that node is compatible.
190 * If the property is not a phandle, or the node it points to is not compatible
191 * with the specific string, then NULL is returned.
193 static struct device_node *get_node_by_phandle_name(struct device_node *np,
195 const char *compatible)
200 ph = of_get_property(np, name, &len);
201 if (!ph || (len != sizeof(phandle)))
204 np = of_find_node_by_phandle(*ph);
208 if (compatible && !of_device_is_compatible(np, compatible)) {
217 * get_parent_cell_index -- return the cell-index of the parent of a node
219 * Return the value of the cell-index property of the parent of the given
220 * node. This is used for DMA channel nodes that need to know the DMA ID
221 * of the controller they are on.
223 static int get_parent_cell_index(struct device_node *np)
225 struct device_node *parent = of_get_parent(np);
231 iprop = of_get_property(parent, "cell-index", NULL);
237 return be32_to_cpup(iprop);
241 * codec_node_dev_name - determine the dev_name for a codec node
243 * This function determines the dev_name for an I2C node. This is the name
244 * that would be returned by dev_name() if this device_node were part of a
245 * 'struct device' It's ugly and hackish, but it works.
247 * The dev_name for such devices include the bus number and I2C address. For
248 * example, "cs4270.0-004f".
250 static int codec_node_dev_name(struct device_node *np, char *buf, size_t len)
254 char temp[DAI_NAME_SIZE];
255 struct i2c_client *i2c;
257 of_modalias_node(np, temp, DAI_NAME_SIZE);
259 iprop = of_get_property(np, "reg", NULL);
263 addr = be32_to_cpup(iprop);
265 /* We need the adapter number */
266 i2c = of_find_i2c_device_by_node(np);
270 snprintf(buf, len, "%s.%u-%04x", temp, i2c->adapter->nr, addr);
275 static int get_dma_channel(struct device_node *ssi_np,
277 struct snd_soc_dai_link *dai,
278 unsigned int *dma_channel_id,
279 unsigned int *dma_id)
282 struct device_node *dma_channel_np;
286 dma_channel_np = get_node_by_phandle_name(ssi_np, name,
287 "fsl,ssi-dma-channel");
291 /* Determine the dev_name for the device_node. This code mimics the
292 * behavior of of_device_make_bus_id(). We need this because ASoC uses
293 * the dev_name() of the device to match the platform (DMA) device with
294 * the CPU (SSI) device. It's all ugly and hackish, but it works (for
297 * dai->platform name should already point to an allocated buffer.
299 ret = of_address_to_resource(dma_channel_np, 0, &res);
302 snprintf((char *)dai->platform_name, DAI_NAME_SIZE, "%llx.%s",
303 (unsigned long long) res.start, dma_channel_np->name);
305 iprop = of_get_property(dma_channel_np, "cell-index", NULL);
307 of_node_put(dma_channel_np);
311 *dma_channel_id = be32_to_cpup(iprop);
312 *dma_id = get_parent_cell_index(dma_channel_np);
313 of_node_put(dma_channel_np);
319 * mpc8610_hpcd_probe: platform probe function for the machine driver
321 * Although this is a machine driver, the SSI node is the "master" node with
322 * respect to audio hardware connections. Therefore, we create a new ASoC
323 * device for each new SSI node that has a codec attached.
325 static int mpc8610_hpcd_probe(struct platform_device *pdev)
327 struct device *dev = pdev->dev.parent;
328 /* ssi_pdev is the platform device for the SSI node that probed us */
329 struct platform_device *ssi_pdev =
330 container_of(dev, struct platform_device, dev);
331 struct device_node *np = ssi_pdev->dev.of_node;
332 struct device_node *codec_np = NULL;
333 struct platform_device *sound_device = NULL;
334 struct mpc8610_hpcd_data *machine_data;
339 /* Find the codec node for this SSI. */
340 codec_np = of_parse_phandle(np, "codec-handle", 0);
342 dev_err(dev, "invalid codec node\n");
346 machine_data = kzalloc(sizeof(struct mpc8610_hpcd_data), GFP_KERNEL);
352 machine_data->dai[0].cpu_dai_name = dev_name(&ssi_pdev->dev);
353 machine_data->dai[0].ops = &mpc8610_hpcd_ops;
355 /* Determine the codec name, it will be used as the codec DAI name */
356 ret = codec_node_dev_name(codec_np, machine_data->codec_name,
359 dev_err(&pdev->dev, "invalid codec node %s\n",
360 codec_np->full_name);
364 machine_data->dai[0].codec_name = machine_data->codec_name;
366 /* The DAI name from the codec (snd_soc_dai_driver.name) */
367 machine_data->dai[0].codec_dai_name = "cs4270-hifi";
369 /* We register two DAIs per SSI, one for playback and the other for
370 * capture. Currently, we only support codecs that have one DAI for
371 * both playback and capture.
373 memcpy(&machine_data->dai[1], &machine_data->dai[0],
374 sizeof(struct snd_soc_dai_link));
376 /* Get the device ID */
377 iprop = of_get_property(np, "cell-index", NULL);
379 dev_err(&pdev->dev, "cell-index property not found\n");
383 machine_data->ssi_id = be32_to_cpup(iprop);
385 /* Get the serial format and clock direction. */
386 sprop = of_get_property(np, "fsl,mode", NULL);
388 dev_err(&pdev->dev, "fsl,mode property not found\n");
393 if (strcasecmp(sprop, "i2s-slave") == 0) {
394 machine_data->dai_format =
395 SND_SOC_DAIFMT_I2S | SND_SOC_DAIFMT_CBM_CFM;
396 machine_data->codec_clk_direction = SND_SOC_CLOCK_OUT;
397 machine_data->cpu_clk_direction = SND_SOC_CLOCK_IN;
399 /* In i2s-slave mode, the codec has its own clock source, so we
400 * need to get the frequency from the device tree and pass it to
403 iprop = of_get_property(codec_np, "clock-frequency", NULL);
404 if (!iprop || !*iprop) {
405 dev_err(&pdev->dev, "codec bus-frequency "
406 "property is missing or invalid\n");
410 machine_data->clk_frequency = be32_to_cpup(iprop);
411 } else if (strcasecmp(sprop, "i2s-master") == 0) {
412 machine_data->dai_format =
413 SND_SOC_DAIFMT_I2S | SND_SOC_DAIFMT_CBS_CFS;
414 machine_data->codec_clk_direction = SND_SOC_CLOCK_IN;
415 machine_data->cpu_clk_direction = SND_SOC_CLOCK_OUT;
416 } else if (strcasecmp(sprop, "lj-slave") == 0) {
417 machine_data->dai_format =
418 SND_SOC_DAIFMT_LEFT_J | SND_SOC_DAIFMT_CBM_CFM;
419 machine_data->codec_clk_direction = SND_SOC_CLOCK_OUT;
420 machine_data->cpu_clk_direction = SND_SOC_CLOCK_IN;
421 } else if (strcasecmp(sprop, "lj-master") == 0) {
422 machine_data->dai_format =
423 SND_SOC_DAIFMT_LEFT_J | SND_SOC_DAIFMT_CBS_CFS;
424 machine_data->codec_clk_direction = SND_SOC_CLOCK_IN;
425 machine_data->cpu_clk_direction = SND_SOC_CLOCK_OUT;
426 } else if (strcasecmp(sprop, "rj-slave") == 0) {
427 machine_data->dai_format =
428 SND_SOC_DAIFMT_RIGHT_J | SND_SOC_DAIFMT_CBM_CFM;
429 machine_data->codec_clk_direction = SND_SOC_CLOCK_OUT;
430 machine_data->cpu_clk_direction = SND_SOC_CLOCK_IN;
431 } else if (strcasecmp(sprop, "rj-master") == 0) {
432 machine_data->dai_format =
433 SND_SOC_DAIFMT_RIGHT_J | SND_SOC_DAIFMT_CBS_CFS;
434 machine_data->codec_clk_direction = SND_SOC_CLOCK_IN;
435 machine_data->cpu_clk_direction = SND_SOC_CLOCK_OUT;
436 } else if (strcasecmp(sprop, "ac97-slave") == 0) {
437 machine_data->dai_format =
438 SND_SOC_DAIFMT_AC97 | SND_SOC_DAIFMT_CBM_CFM;
439 machine_data->codec_clk_direction = SND_SOC_CLOCK_OUT;
440 machine_data->cpu_clk_direction = SND_SOC_CLOCK_IN;
441 } else if (strcasecmp(sprop, "ac97-master") == 0) {
442 machine_data->dai_format =
443 SND_SOC_DAIFMT_AC97 | SND_SOC_DAIFMT_CBS_CFS;
444 machine_data->codec_clk_direction = SND_SOC_CLOCK_IN;
445 machine_data->cpu_clk_direction = SND_SOC_CLOCK_OUT;
448 "unrecognized fsl,mode property '%s'\n", sprop);
453 if (!machine_data->clk_frequency) {
454 dev_err(&pdev->dev, "unknown clock frequency\n");
459 /* Find the playback DMA channel to use. */
460 machine_data->dai[0].platform_name = machine_data->platform_name[0];
461 ret = get_dma_channel(np, "fsl,playback-dma", &machine_data->dai[0],
462 &machine_data->dma_channel_id[0],
463 &machine_data->dma_id[0]);
465 dev_err(&pdev->dev, "missing/invalid playback DMA phandle\n");
469 /* Find the capture DMA channel to use. */
470 machine_data->dai[1].platform_name = machine_data->platform_name[1];
471 ret = get_dma_channel(np, "fsl,capture-dma", &machine_data->dai[1],
472 &machine_data->dma_channel_id[1],
473 &machine_data->dma_id[1]);
475 dev_err(&pdev->dev, "missing/invalid capture DMA phandle\n");
479 /* Initialize our DAI data structure. */
480 machine_data->dai[0].stream_name = "playback";
481 machine_data->dai[1].stream_name = "capture";
482 machine_data->dai[0].name = machine_data->dai[0].stream_name;
483 machine_data->dai[1].name = machine_data->dai[1].stream_name;
485 machine_data->card.probe = mpc8610_hpcd_machine_probe;
486 machine_data->card.remove = mpc8610_hpcd_machine_remove;
487 machine_data->card.name = pdev->name; /* The platform driver name */
488 machine_data->card.num_links = 2;
489 machine_data->card.dai_link = machine_data->dai;
491 /* Allocate a new audio platform device structure */
492 sound_device = platform_device_alloc("soc-audio", -1);
494 dev_err(&pdev->dev, "platform device alloc failed\n");
499 /* Associate the card data with the sound device */
500 platform_set_drvdata(sound_device, &machine_data->card);
502 /* Register with ASoC */
503 ret = platform_device_add(sound_device);
505 dev_err(&pdev->dev, "platform device add failed\n");
508 dev_set_drvdata(&pdev->dev, sound_device);
510 of_node_put(codec_np);
515 platform_device_put(sound_device);
519 of_node_put(codec_np);
524 * mpc8610_hpcd_remove: remove the platform device
526 * This function is called when the platform device is removed.
528 static int __devexit mpc8610_hpcd_remove(struct platform_device *pdev)
530 struct platform_device *sound_device = dev_get_drvdata(&pdev->dev);
531 struct snd_soc_card *card = platform_get_drvdata(sound_device);
532 struct mpc8610_hpcd_data *machine_data =
533 container_of(card, struct mpc8610_hpcd_data, card);
535 platform_device_unregister(sound_device);
538 sound_device->dev.platform_data = NULL;
540 dev_set_drvdata(&pdev->dev, NULL);
545 static struct platform_driver mpc8610_hpcd_driver = {
546 .probe = mpc8610_hpcd_probe,
547 .remove = __devexit_p(mpc8610_hpcd_remove),
549 /* The name must match 'compatible' property in the device tree,
550 * in lowercase letters.
552 .name = "snd-soc-mpc8610hpcd",
553 .owner = THIS_MODULE,
558 * mpc8610_hpcd_init: machine driver initialization.
560 * This function is called when this module is loaded.
562 static int __init mpc8610_hpcd_init(void)
564 struct device_node *guts_np;
567 pr_info("Freescale MPC8610 HPCD ALSA SoC machine driver\n");
569 /* Get the physical address of the global utilities registers */
570 guts_np = of_find_compatible_node(NULL, NULL, "fsl,mpc8610-guts");
571 if (of_address_to_resource(guts_np, 0, &res)) {
572 pr_err("mpc8610-hpcd: missing/invalid global utilities node\n");
575 guts_phys = res.start;
577 return platform_driver_register(&mpc8610_hpcd_driver);
581 * mpc8610_hpcd_exit: machine driver exit
583 * This function is called when this driver is unloaded.
585 static void __exit mpc8610_hpcd_exit(void)
587 platform_driver_unregister(&mpc8610_hpcd_driver);
590 module_init(mpc8610_hpcd_init);
591 module_exit(mpc8610_hpcd_exit);
593 MODULE_AUTHOR("Timur Tabi <timur@freescale.com>");
594 MODULE_DESCRIPTION("Freescale MPC8610 HPCD ALSA SoC machine driver");
595 MODULE_LICENSE("GPL v2");