Subject: [PATCH V2] Sound: sgtl5000 Allow codec clock frequency to be set.

From: [email-masked] (Martin Fuzzey)
Date: Fri, 22 Mar 2013 10:33:44 +0100

Currently the sgtl5000 driver allows its clock to be
specified either as a raw frequency using "clock-frequency"
in the device tree (the original method) or, since commit
81e8e49 "ASoC: fsl: add sgtl5000 clock support for imx-sgtl5000",
as a preconfigured clock from the device tree.

This patch adds, in addition to the existing methods,
the possibility to use a rate configurable clock from the
device tree and actually set its rate.

This is done by specifiying both clocks and clock-frequency
in the driver's DT node.

This is useful when a programmable clock is used as the codec clock.

Signed-off-by: Martin Fuzzey <[email-masked]>
---
Changelog:
V2 - Improved binding document and patch description following
remarks from Timur Tabi.
---
 .../devicetree/bindings/sound/sgtl5000.txt         |   59 ++++++++++++++++++++
 sound/soc/fsl/imx-sgtl5000.c                       |   20 +++++--
 2 files changed, 75 insertions(+), 4 deletions(-)

diff --git a/Documentation/devicetree/bindings/sound/sgtl5000.txt b/Documentation/devicetree/bindings/sound/sgtl5000.txt
index 9cc4444..f586ba7 100644
--- a/Documentation/devicetree/bindings/sound/sgtl5000.txt
+++ b/Documentation/devicetree/bindings/sound/sgtl5000.txt
@@ -5,9 +5,68 @@ Required properties:
 
 - reg : the I2C address of the device
 
+Optional properties:
+- clocks:		phandle to of codec clock
+- clock-frequency:	clock frequency to set or use (see below)
+
+If a clock is provided, clock-frequency is optional
+
+If no clock is provided clock-frequency is required (this represents the codec
+being clocked by an external signal not present in the clock tree)
+
+If both a clock and clock-frequency are provided clock must support
+the set_rate operation and its frequency will be set to the value specified
+by clock-frequency
+
+
+Hence the possible configurations and their use cases are:
+
+1) only 'clocks' specified
+clock points to a clock specified in the DT which already has an
+appropriate frequency and is configured by some other means external to the
+sgtl5000 driver (bootloader, board setup code, or just a fixed rate clock)
+
+Example:
+clocks {
+	audioclk: ext20Mz {
+		compatible = "fixed-clock";
+		clock-frequency = <20000000>;
+	};
+};
+
+codec: sgtl5000 at 0a {
+	compatible = "fsl,sgtl5000";
+	reg = <0x0a>;
+	clocks = <&audioclk>; /* cko1 */
+};
+
+
+2) only 'clock-frequency' specified
+The chip is assumed to be clocked by a signal having the given
+frequency, which may even be generated by a clock unknown to linux.
+This could actually be represented as a special case of 1) by defining a
+fixed-rate clock in the DT.
+
+Example:
+
+codec: sgtl5000 at 0a {
+	compatible = "fsl,sgtl5000";
+	reg = <0x0a>;
+	clock-frequency = <20000000>;
+};
+
+
+3) Both 'clocks' and 'clock-frequency' specified
+The chip is assumed to be clocked by a rate programmable clock defined
+in the clock tree.
+clk_set_rate() will be called for this clock to set its rate to that
+specified by clock-frequency
+
 Example:
 
 codec: sgtl5000 at 0a {
 	compatible = "fsl,sgtl5000";
 	reg = <0x0a>;
+	clocks = <&clks 162>; /* cko1 */
+	clock-frequency = <20000000>;
 };
diff --git a/sound/soc/fsl/imx-sgtl5000.c b/sound/soc/fsl/imx-sgtl5000.c
index 424347e..71ce1f6 100644
--- a/sound/soc/fsl/imx-sgtl5000.c
+++ b/sound/soc/fsl/imx-sgtl5000.c
@@ -128,18 +128,30 @@ static int imx_sgtl5000_probe(struct platform_device *pdev)
 		goto fail;
 	}
 
+	ret = of_property_read_u32(codec_np, "clock-frequency",
+					&data->clk_frequency);
 	data->codec_clk = clk_get(&codec_dev->dev, NULL);
+
 	if (IS_ERR(data->codec_clk)) {
-		/* assuming clock enabled by default */
+		/* assuming clock enabled by default (frequency required) */
 		data->codec_clk = NULL;
-		ret = of_property_read_u32(codec_np, "clock-frequency",
-					&data->clk_frequency);
-		if (ret) {
+		if (!data->clk_frequency) {
 			dev_err(&codec_dev->dev,
 				"clock-frequency missing or invalid\n");
 			goto fail;
 		}
 	} else {
+		if (data->clk_frequency) {
+			ret = clk_set_rate(
+					data->codec_clk, data->clk_frequency);
+			if (ret) {
+				dev_err(&codec_dev->dev,
+					"failed to set clock-frequency to %u\n",
+					data->clk_frequency);
+				goto fail;
+			}
+		}
+
 		data->clk_frequency = clk_get_rate(data->codec_clk);
 		clk_prepare_enable(data->codec_clk);
 	}