Repository navigation
ASoC: SOF: add DAI clock driver #2932
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,153 @@ | ||
| // SPDX-License-Identifier: (GPL-2.0-only OR BSD-3-Clause) | ||
| // | ||
| // This file is provided under a dual BSD/GPLv2 license. When using or | ||
| // redistributing this file, you may do so under either license. | ||
| // | ||
| // Copyright(c) 2021 Intel Corporation. All rights reserved. | ||
| // | ||
| // Author: Brent Lu <brent.lu@intel.com> | ||
| // | ||
| // DAI clock layer to support explicit clock control in machine driver. | ||
| // | ||
|
|
||
| #include <linux/clk-provider.h> | ||
| #include <linux/clkdev.h> | ||
| #include <sound/sof/dai.h> | ||
| #include "sof-priv.h" | ||
| #include "sof-dai-clk.h" | ||
|
|
||
| struct sof_clk { | ||
| struct clk_hw hw; | ||
| struct snd_sof_dev *sdev; | ||
| struct sof_dai_clk *dai_clk; | ||
| }; | ||
|
|
||
| static int sof_clk_ctrl(struct snd_sof_dev *sdev, struct sof_dai_clk *dai_clk, int enable) | ||
| { | ||
| struct sof_ipc_dai_clkctrl clkctrl; | ||
| struct sof_ipc_reply reply; | ||
| int ret; | ||
|
|
||
| memset(&clkctrl, 0, sizeof(clkctrl)); | ||
|
|
||
| /* set IPC DAI clock control */ | ||
| clkctrl.hdr.size = sizeof(clkctrl); | ||
| clkctrl.hdr.cmd = SOF_IPC_GLB_DAI_MSG | SOF_IPC_DAI_CLKCTRL; | ||
|
|
||
| clkctrl.type = dai_clk->type; | ||
| clkctrl.dai_index = dai_clk->dai_index; | ||
|
|
||
| clkctrl.clk_en = enable ? 1 : 0; | ||
| clkctrl.clk_id = dai_clk->clk_id; | ||
|
|
||
| dev_dbg(sdev->dev, "clkctrl: SSP%d clk_en %d clk_id %d\n", | ||
|
Collaborator
There was a problem hiding this comment. is this clock SSP-only? If it is, it should be clear at the file / function level, if it isn't, it shouldn't be hard-coded here
Collaborator
There was a problem hiding this comment. It might be better to be human readable: |
||
| clkctrl.dai_index, clkctrl.clk_en, clkctrl.clk_id); | ||
|
|
||
| /* send IPC to the DSP */ | ||
| ret = sof_ipc_tx_message(sdev->ipc, clkctrl.hdr.cmd, &clkctrl, | ||
| sizeof(clkctrl), &reply, sizeof(reply)); | ||
|
|
||
| if (ret < 0) { | ||
| dev_err(sdev->dev, | ||
| "failed to control DAI clock for type %d index %d\n", | ||
| dai_clk->type, dai_clk->dai_index); | ||
| return ret; | ||
| } | ||
|
|
||
| return 0; | ||
| } | ||
|
|
||
| static int sof_clk_prepare(struct clk_hw *hw) | ||
| { | ||
| struct sof_clk *clkdev = container_of(hw, struct sof_clk, hw); | ||
| struct snd_sof_dev *sdev = clkdev->sdev; | ||
|
|
||
| return sof_clk_ctrl(sdev, clkdev->dai_clk, 1); | ||
| } | ||
|
|
||
| static void sof_clk_unprepare(struct clk_hw *hw) | ||
| { | ||
| struct sof_clk *clkdev = container_of(hw, struct sof_clk, hw); | ||
| struct snd_sof_dev *sdev = clkdev->sdev; | ||
|
|
||
| sof_clk_ctrl(sdev, clkdev->dai_clk, 0); | ||
| } | ||
|
|
||
| static const struct clk_ops sof_clk_ops = { | ||
| .prepare = sof_clk_prepare, | ||
| .unprepare = sof_clk_unprepare, | ||
| }; | ||
|
|
||
| int snd_sof_dai_clks_probe(struct snd_soc_component *component) | ||
| { | ||
| struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(component); | ||
| struct snd_sof_pdata *pdata = sdev->pdata; | ||
| struct device *dev = component->dev; | ||
| int i, ret; | ||
|
|
||
| sdev->num_clks = pdata->num_clks; | ||
|
|
||
| if (sdev->num_clks > SOF_DAI_CLKS) | ||
| sdev->num_clks = SOF_DAI_CLKS; | ||
|
|
||
| for (i = 0; i < sdev->num_clks; ++i) { | ||
| struct clk_init_data init = {}; | ||
| struct clk_lookup *dai_clk_lookup; | ||
| struct sof_clk *clkdev; | ||
|
|
||
| clkdev = devm_kzalloc(dev, sizeof(*clkdev), GFP_KERNEL); | ||
| if (!clkdev) { | ||
|
Collaborator
There was a problem hiding this comment. I think this operations should be platform specific. In IMX case we just have the clocks defined in the device tree file (dts) and then just get a reference to the clock here. Also, with the IMX we enable and configure IP clocks (not only DAI clocks) on the Host side.
Collaborator
There was a problem hiding this comment. @dbaluta, you are right, but it should also depend on firmware version. Do we have the clock support enabled in the firmware?
Collaborator
There was a problem hiding this comment. @ujfalusi for IMX there is little to zero support for IPs clocks in the firmware. 2 out of 3 IMX supported platforms have a dedicated M4 core that is running a firmware which handles the clocks. |
||
| ret = -ENOMEM; | ||
| goto err; | ||
| } | ||
|
|
||
| init.name = pdata->dai_clks[i].name; | ||
| init.ops = &sof_clk_ops; | ||
| init.flags = CLK_GET_RATE_NOCACHE | CLK_SET_RATE_GATE; | ||
|
Author
There was a problem hiding this comment. The problem here is I don't know the correct flag for the virtual clock. Need expert to comment the flag.
Collaborator
There was a problem hiding this comment. not an expert in the clock API, but how about 0? :-) So far this clock doesn't even change rate, so why cannot it be cached?
Collaborator
There was a problem hiding this comment. RATE_GATE might be valid for SCLK they tend to like being stopped in order to be changed, but are we ever going to allow that? |
||
| init.parent_names = NULL; | ||
| init.num_parents = 0; | ||
|
|
||
| clkdev->hw.init = &init; | ||
| clkdev->sdev = sdev; | ||
| clkdev->dai_clk = &pdata->dai_clks[i]; | ||
|
|
||
| ret = devm_clk_hw_register(dev, &clkdev->hw); | ||
| if (ret) { | ||
| dev_warn(dev, "failed to register %s: %d\n", | ||
| init.name, ret); | ||
| goto err; | ||
| } | ||
|
|
||
| dai_clk_lookup = clkdev_hw_create(&clkdev->hw, init.name, | ||
| NULL); | ||
|
Collaborator
There was a problem hiding this comment.
|
||
| if (!dai_clk_lookup) { | ||
| dev_warn(dev, "failed to create %s: %d\n", | ||
| init.name, ret); | ||
| ret = -ENOMEM; | ||
| goto err; | ||
| } | ||
|
|
||
| sdev->dai_clks_lookup[i] = dai_clk_lookup; | ||
| } | ||
|
|
||
| return 0; | ||
|
|
||
| err: | ||
| do { | ||
| if (sdev->dai_clks_lookup[i]) | ||
| clkdev_drop(sdev->dai_clks_lookup[i]); | ||
| } while (i-- > 0); | ||
|
Collaborator
There was a problem hiding this comment. you can simplify this: from your above code whenever on iteration or similar |
||
|
|
||
| return ret; | ||
| } | ||
|
|
||
| void snd_sof_dai_clks_remove(struct snd_soc_component *component) | ||
| { | ||
| struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(component); | ||
| int i; | ||
|
|
||
| for (i = sdev->num_clks - 1; i >= 0; --i) { | ||
|
Collaborator
There was a problem hiding this comment. just curious - any specific reason to run this in reverse order? |
||
| if (sdev->dai_clks_lookup[i]) | ||
| clkdev_drop(sdev->dai_clks_lookup[i]); | ||
| } | ||
|
Collaborator
There was a problem hiding this comment. same here: I assume, this is only called if |
||
| } | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| /* SPDX-License-Identifier: (GPL-2.0-only OR BSD-3-Clause) */ | ||
| /* | ||
| * This file is provided under a dual BSD/GPLv2 license. When using or | ||
| * redistributing this file, you may do so under either license. | ||
| * | ||
| * Copyright(c) 2021 Intel Corporation. All rights reserved. | ||
| */ | ||
|
|
||
| #ifndef __SOUND_SOC_SOF_DAI_CLK_H | ||
| #define __SOUND_SOC_SOF_DAI_CLK_H | ||
|
|
||
| struct sof_dai_clk { | ||
| const char *name; | ||
| int type; | ||
| int dai_index; | ||
| int clk_id; | ||
| }; | ||
|
|
||
| #endif |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
how sure are we that this is all we'll ever need? Can it be that at some point we'll also need to send a rate down? Or maybe even the duty cycle (ok, maybe not this one)?