Skip to contentSkip to conversation

ASoC: Intel: Move extended fw base and size fields in struct sst_pdata

PATCH Applied Jarkko Nikula 3 participants 8 messages Feb 18, 2014 – Feb 19, 2014

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

PATCH 1/2 ASoC: Intel: Move extended fw base and size fields in struct sst_pdata

Move fw_base and fw_size fields in struct sst_pdata under ACPI data for clarifying that these are not related to firmware file but for platform specific extended firmware area reserved by the BIOS.

---
 sound/soc/intel/sst-dsp.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
sound/soc/intel/sst-dsp.h +2 -2
index 0ce5c8d91794..d134359fecac 100644
@@ -147,12 +147,12 @@ struct sst_pdata {
 	u32 lpe_size;
 	u32 pcicfg_base;
 	u32 pcicfg_size;
+	u32 fw_base;
+	u32 fw_size;
 	int irq;
 
 	/* Firmware */
 	const char *fw_filename;
-	u32 fw_base;
-	u32 fw_size;
 
 	/* DMA */
 	u32 dma_base;
Signature · 1 line
1.8.5.3
#1 lore raw

PATCH 2/2 ASoC: Intel: sst-acpi: Request firmware before SST platform driver probing

We originally thought to request SST audio DSP firmware during the SST platform driver initialization. However plain request_firmware doesn't work in driver probe paths if userspace is not ready to handle it. For instance when drivers are built-in.

Implementing asynchronous firmware request in SST platform driver initialization complicates code needlessly since it anyway will fail if firmware is missing.

This is more simple to handle by requesting firmware asynchronously in sst_acpi_probe() and register SST platform only after firmware is loaded.

---
 sound/soc/intel/sst-acpi.c | 54 ++++++++++++++++++++++++++++++----------------
 sound/soc/intel/sst-dsp.h  |  2 +-
 2 files changed, 36 insertions(+), 20 deletions(-)
sound/soc/intel/sst-acpi.c +35 -19
index aba73ca8a923..b76d9d9f15c0 100644
@@ -16,6 +16,7 @@
 
 #include <linux/acpi.h>
 #include <linux/device.h>
+#include <linux/firmware.h>
 #include <linux/module.h>
 #include <linux/platform_device.h>
 
@@ -56,6 +57,32 @@ struct sst_acpi_priv {
 	struct sst_acpi_desc *desc;
 };
 
+static void sst_acpi_fw_cb(const struct firmware *fw, void *context)
+{
+	struct platform_device *pdev = context;
+	struct device *dev = &pdev->dev;
+	struct sst_acpi_priv *sst_acpi = platform_get_drvdata(pdev);
+	struct sst_pdata *sst_pdata = &sst_acpi->sst_pdata;
+	struct sst_acpi_desc *desc = sst_acpi->desc;
+
+	sst_pdata->fw = fw;
+	if (!fw) {
+		dev_err(dev, "Cannot load firmware %s\n", desc->fw_filename);
+		return;
+	}
+
+	/* register PCM and DAI driver */
+	sst_acpi->pdev_pcm =
+		platform_device_register_data(dev, desc->drv_name, -1,
+					      sst_pdata, sizeof(*sst_pdata));
+	if (IS_ERR(sst_acpi->pdev_pcm)) {
+		dev_err(dev, "Cannot register device %s. Error %d\n",
+			desc->drv_name, (int)PTR_ERR(sst_acpi->pdev_pcm));
+	}
+
+	return;
+}
+
 static int sst_acpi_probe(struct platform_device *pdev)
 {
 	const struct acpi_device_id *id;
@@ -65,7 +92,6 @@ static int sst_acpi_probe(struct platform_device *pdev)
 	struct sst_acpi_mach *mach;
 	struct sst_acpi_desc *desc;
 	struct resource *mmio;
-	int ret = 0;
 
 	sst_acpi = devm_kzalloc(dev, sizeof(*sst_acpi), GFP_KERNEL);
 	if (sst_acpi == NULL)
@@ -79,7 +105,6 @@ static int sst_acpi_probe(struct platform_device *pdev)
 	desc = mach->res_desc;
 	sst_pdata = &sst_acpi->sst_pdata;
 	sst_pdata->id = desc->sst_id;
-	sst_pdata->fw_filename = desc->fw_filename;
 	sst_acpi->desc = desc;
 
 	if (desc->resindex_dma_base >= 0) {
@@ -118,37 +143,28 @@ static int sst_acpi_probe(struct platform_device *pdev)
 		}
 	}
 
-	/* register PCM and DAI driver */
-	sst_acpi->pdev_pcm =
-		platform_device_register_data(dev, desc->drv_name, -1,
-					      sst_pdata, sizeof(*sst_pdata));
-	if (IS_ERR(sst_acpi->pdev_pcm))
-		return PTR_ERR(sst_acpi->pdev_pcm);
-
-	/* register machine driver */
 	platform_set_drvdata(pdev, sst_acpi);
 
+	/* register machine driver */
 	sst_acpi->pdev_mach =
 		platform_device_register_data(dev, mach->drv_name, -1,
 					      sst_pdata, sizeof(*sst_pdata));
-	if (IS_ERR(sst_acpi->pdev_mach)) {
-		ret = PTR_ERR(sst_acpi->pdev_mach);
-		goto sst_err;
-	}
-
-	return ret;
+	if (IS_ERR(sst_acpi->pdev_mach))
+		return PTR_ERR(sst_acpi->pdev_mach);
 
-sst_err:
-	platform_device_unregister(sst_acpi->pdev_pcm);
-	return ret;
+	/* continue SST probing after firmware is loaded */
+	return request_firmware_nowait(THIS_MODULE, true, desc->fw_filename,
+				       dev, GFP_KERNEL, pdev, sst_acpi_fw_cb);
 }
 
 static int sst_acpi_remove(struct platform_device *pdev)
 {
 	struct sst_acpi_priv *sst_acpi = platform_get_drvdata(pdev);
+	struct sst_pdata *sst_pdata = &sst_acpi->sst_pdata;
 
 	platform_device_unregister(sst_acpi->pdev_mach);
 	platform_device_unregister(sst_acpi->pdev_pcm);
+	release_firmware(sst_pdata->fw);
 
 	return 0;
 }
sound/soc/intel/sst-dsp.h +1 -1
index d134359fecac..3730fd324455 100644
@@ -152,7 +152,7 @@ struct sst_pdata {
 	int irq;
 
 	/* Firmware */
-	const char *fw_filename;
+	const struct firmware *fw;
 
 	/* DMA */
 	u32 dma_base;
Signature · 1 line
1.8.5.3
#2 lore raw

Re: [PATCH 2/2] ASoC: Intel: sst-acpi: Request firmware before SST platform driver probing

At Tue, 18 Feb 2014 16:42:03 +0200,

Quoted 104 lines · Jarkko Nikula

We originally thought to request SST audio DSP firmware during the SST platform driver initialization. However plain request_firmware doesn't work in driver probe paths if userspace is not ready to handle it. For instance when drivers are built-in.

Implementing asynchronous firmware request in SST platform driver initialization complicates code needlessly since it anyway will fail if firmware is missing.

This is more simple to handle by requesting firmware asynchronously in sst_acpi_probe() and register SST platform only after firmware is loaded.

---
 sound/soc/intel/sst-acpi.c | 54 ++++++++++++++++++++++++++++++----------------
 sound/soc/intel/sst-dsp.h  |  2 +-
 2 files changed, 36 insertions(+), 20 deletions(-)
sound/soc/intel/sst-acpi.c +28 -15
index aba73ca8a923..b76d9d9f15c0 100644
@@ -16,6 +16,7 @@
 
 #include <linux/acpi.h>
 #include <linux/device.h>
+#include <linux/firmware.h>
 #include <linux/module.h>
 #include <linux/platform_device.h>
 
@@ -56,6 +57,32 @@ struct sst_acpi_priv {
 	struct sst_acpi_desc *desc;
 };
 
+static void sst_acpi_fw_cb(const struct firmware *fw, void *context)
+{
+	struct platform_device *pdev = context;
+	struct device *dev = &pdev->dev;
+	struct sst_acpi_priv *sst_acpi = platform_get_drvdata(pdev);
+	struct sst_pdata *sst_pdata = &sst_acpi->sst_pdata;
+	struct sst_acpi_desc *desc = sst_acpi->desc;
+
+	sst_pdata->fw = fw;
+	if (!fw) {
+		dev_err(dev, "Cannot load firmware %s\n", desc->fw_filename);
+		return;
+	}
+
+	/* register PCM and DAI driver */
+	sst_acpi->pdev_pcm =
+		platform_device_register_data(dev, desc->drv_name, -1,
+					      sst_pdata, sizeof(*sst_pdata));
+	if (IS_ERR(sst_acpi->pdev_pcm)) {
+		dev_err(dev, "Cannot register device %s. Error %d\n",
+			desc->drv_name, (int)PTR_ERR(sst_acpi->pdev_pcm));
+	}
+
+	return;
+}
+
 static int sst_acpi_probe(struct platform_device *pdev)
 {
 	const struct acpi_device_id *id;
@@ -65,7 +92,6 @@ static int sst_acpi_probe(struct platform_device *pdev)
 	struct sst_acpi_mach *mach;
 	struct sst_acpi_desc *desc;
 	struct resource *mmio;
-	int ret = 0;
 
 	sst_acpi = devm_kzalloc(dev, sizeof(*sst_acpi), GFP_KERNEL);
 	if (sst_acpi == NULL)
@@ -79,7 +105,6 @@ static int sst_acpi_probe(struct platform_device *pdev)
 	desc = mach->res_desc;
 	sst_pdata = &sst_acpi->sst_pdata;
 	sst_pdata->id = desc->sst_id;
-	sst_pdata->fw_filename = desc->fw_filename;
 	sst_acpi->desc = desc;
 
 	if (desc->resindex_dma_base >= 0) {
@@ -118,37 +143,28 @@ static int sst_acpi_probe(struct platform_device *pdev)
 		}
 	}
 
-	/* register PCM and DAI driver */
-	sst_acpi->pdev_pcm =
-		platform_device_register_data(dev, desc->drv_name, -1,
-					      sst_pdata, sizeof(*sst_pdata));
-	if (IS_ERR(sst_acpi->pdev_pcm))
-		return PTR_ERR(sst_acpi->pdev_pcm);
-
-	/* register machine driver */
 	platform_set_drvdata(pdev, sst_acpi);
 
+	/* register machine driver */
 	sst_acpi->pdev_mach =
 		platform_device_register_data(dev, mach->drv_name, -1,
 					      sst_pdata, sizeof(*sst_pdata));
-	if (IS_ERR(sst_acpi->pdev_mach)) {
-		ret = PTR_ERR(sst_acpi->pdev_mach);
-		goto sst_err;
-	}
-

sound/soc/intel/sst-acpi.c static int sst_acpi_probe(struct platform_device *pdev) · line 157

Quoted 10 lines
sound/soc/intel/sst-acpi.c +5 -4
-	return ret;
+	if (IS_ERR(sst_acpi->pdev_mach))
+		return PTR_ERR(sst_acpi->pdev_mach);
 
-sst_err:
-	platform_device_unregister(sst_acpi->pdev_pcm);
-	return ret;
+	/* continue SST probing after firmware is loaded */
+	return request_firmware_nowait(THIS_MODULE, true, desc->fw_filename,
+				       dev, GFP_KERNEL, pdev, sst_acpi_fw_cb);

sst_acpi->pdev_mach still should be unregistered when request_firmware_nowait() returns an error.

sound/soc/intel/sst-acpi.c static int sst_acpi_probe(struct platform_device *pdev) · line 166

Quoted 9 lines
sound/soc/intel/sst-acpi.c +1 -0
 }
 
 static int sst_acpi_remove(struct platform_device *pdev)
 {
 	struct sst_acpi_priv *sst_acpi = platform_get_drvdata(pdev);
+	struct sst_pdata *sst_pdata = &sst_acpi->sst_pdata;
 
 	platform_device_unregister(sst_acpi->pdev_mach);
 	platform_device_unregister(sst_acpi->pdev_pcm);

With your patch, pdev_pcm isn't always a valid pointer. You can't pass it unconditionally any longer.

Takashi

Quoted 25 lines
sound/soc/intel/sst-acpi.c +1 -0
+	release_firmware(sst_pdata->fw);
 
 	return 0;
 }
sound/soc/intel/sst-dsp.h +1 -1
index d134359fecac..3730fd324455 100644
@@ -152,7 +152,7 @@ struct sst_pdata {
 	int irq;
 
 	/* Firmware */
-	const char *fw_filename;
+	const struct firmware *fw;
 
 	/* DMA */
 	u32 dma_base;
Signature · 6 lines
1.8.5.3

_______________________________________________
Alsa-devel mailing list
[email protected]
http://mailman.alsa-project.org/mailman/listinfo/alsa-devel
#3 lore raw

Re: [PATCH 2/2] ASoC: Intel: sst-acpi: Request firmware before SST platform driver probing

Hi

Quoted 11 lines · Takashi Iwai

At Tue, 18 Feb 2014 16:42:03 +0200,

sound/soc/intel/sst-acpi.c static int sst_acpi_probe(struct platform_device *pdev) · line 157

Quoted 7 lines · Jarkko Nikula
sound/soc/intel/sst-acpi.c +3 -3
-sst_err:
-	platform_device_unregister(sst_acpi->pdev_pcm);
-	return ret;
+	/* continue SST probing after firmware is loaded */
+	return request_firmware_nowait(THIS_MODULE, true, desc->fw_filename,
+				       dev, GFP_KERNEL, pdev, sst_acpi_fw_cb);

sst_acpi->pdev_mach still should be unregistered when request_firmware_nowait() returns an error.

I was thinking to leave that for sst_acpi_remove but you are right, it doesn't make sense to leave it registered for instance if request_firmware_nowait fails because of -ENOMEM or some other fatal issue.

Quoted 7 lines
Quoted 7 lines
  }
  
  static int sst_acpi_remove(struct platform_device *pdev)
  {
  	struct sst_acpi_priv *sst_acpi = platform_get_drvdata(pdev);
(quoted diff) +1 -0
+	struct sst_pdata *sst_pdata = &sst_acpi->sst_pdata;
Quoted 5 lines
Quoted 2 lines
  	platform_device_unregister(sst_acpi->pdev_mach);
  	platform_device_unregister(sst_acpi->pdev_pcm);

With your patch, pdev_pcm isn't always a valid pointer. You can't pass it unconditionally any longer.

I felt it was needless to test NULL pointers here since release_firmware checks it directly and platform_device_unregister indirectly. Not in platform_device_unregister but when calling platform_device_del and platform_device_put there.

Signature · 1 line
Jarkko
#4 lore raw

Re: [PATCH 2/2] ASoC: Intel: sst-acpi: Request firmware before SST platform driver probing

Quoted 12 lines · Jarkko Nikula

Hi

Quoted 9 lines · Takashi Iwai

At Tue, 18 Feb 2014 16:42:03 +0200,

Quoted 7 lines · Jarkko Nikula

-sst_err:

sound/soc/intel/sst-acpi.c +2 -2
-    platform_device_unregister(sst_acpi->pdev_pcm);
-    return ret;
+    /* continue SST probing after firmware is loaded */
+    return request_firmware_nowait(THIS_MODULE, true, 

desc->fw_filename,
+ dev, GFP_KERNEL, pdev, sst_acpi_fw_cb);

Quoted 4 lines
Quoted 2 lines

sst_acpi->pdev_mach still should be unregistered when request_firmware_nowait() returns an error.

I was thinking to leave that for sst_acpi_remove but you are right, it doesn't make sense to leave it registered for instance if request_firmware_nowait fails because of -ENOMEM or some other fatal issue.

Answering myself after cup of coffee... Obviously probe function must free whatever it allocated when it returns with an error. In other words module loading fails and we won't ever call the remove function.

Signature · 1 line
Jarkko
#5 lore raw

Re: [PATCH 2/2] ASoC: Intel: sst-acpi: Request firmware before SST platform driver probing

In reply to Jarkko Nikula

At Wed, 19 Feb 2014 08:57:53 +0200,

Quoted 31 lines · Jarkko Nikula

Hi

Quoted 11 lines · Takashi Iwai

At Tue, 18 Feb 2014 16:42:03 +0200,

sound/soc/intel/sst-acpi.c static int sst_acpi_probe(struct platform_device *pdev) · line 157

Quoted 7 lines · Jarkko Nikula
sound/soc/intel/sst-acpi.c +3 -3
-sst_err:
-	platform_device_unregister(sst_acpi->pdev_pcm);
-	return ret;
+	/* continue SST probing after firmware is loaded */
+	return request_firmware_nowait(THIS_MODULE, true, desc->fw_filename,
+				       dev, GFP_KERNEL, pdev, sst_acpi_fw_cb);

sst_acpi->pdev_mach still should be unregistered when request_firmware_nowait() returns an error.

I was thinking to leave that for sst_acpi_remove but you are right, it doesn't make sense to leave it registered for instance if request_firmware_nowait fails because of -ENOMEM or some other fatal issue.

Quoted 7 lines
Quoted 7 lines
  }
  
  static int sst_acpi_remove(struct platform_device *pdev)
  {
  	struct sst_acpi_priv *sst_acpi = platform_get_drvdata(pdev);
(quoted diff) +1 -0
+	struct sst_pdata *sst_pdata = &sst_acpi->sst_pdata;
Quoted 5 lines
Quoted 2 lines
  	platform_device_unregister(sst_acpi->pdev_mach);
  	platform_device_unregister(sst_acpi->pdev_pcm);

With your patch, pdev_pcm isn't always a valid pointer. You can't pass it unconditionally any longer.

Quoted 4 lines

I felt it was needless to test NULL pointers here since release_firmware checks it directly and platform_device_unregister indirectly. Not in platform_device_unregister but when calling platform_device_del and platform_device_put there.

The problem is that it may contain ERR_PTR(xxx). You have to either clear to NULL in

	if (IS_ERR(sst_acpi->pdev_pcm)) {
		dev_err(dev, "Cannot register device %s. Error %d\n",
			desc->drv_name, (int)PTR_ERR(sst_acpi->pdev_pcm));
		sst_acpi->pdev_pcm = NULL;
	}

or check conditionally like

	if (!IS_ERR_OR_NULL(sst_acpi->pdev_pcm))
	 	platform_device_unregister(sst_acpi->pdev_pcm);

Maybe the former is better.

Takashi

#6 lore raw

Re: [PATCH 2/2] ASoC: Intel: sst-acpi: Request firmware before SST platform driver probing

Hi

Quoted 16 lines · Takashi Iwai

At Wed, 19 Feb 2014 08:57:53 +0200,

Quoted 5 lines · Jarkko Nikula

I felt it was needless to test NULL pointers here since release_firmware checks it directly and platform_device_unregister indirectly. Not in platform_device_unregister but when calling platform_device_del and platform_device_put there.

The problem is that it may contain ERR_PTR(xxx). You have to either clear to NULL in

	if (IS_ERR(sst_acpi->pdev_pcm)) {
		dev_err(dev, "Cannot register device %s. Error %d\n",
			desc->drv_name, (int)PTR_ERR(sst_acpi->pdev_pcm));
		sst_acpi->pdev_pcm = NULL;
	}
Quoted 7 lines

or check conditionally like

	if (!IS_ERR_OR_NULL(sst_acpi->pdev_pcm))
	 	platform_device_unregister(sst_acpi->pdev_pcm);

Maybe the former is better.

Oh yes and I'm even testing it with the IS_ERR and PTR_ERR. Why that knowledge did not carry to sst_acpi_remove... will fix.

Signature · 1 line
Jarkko
maintainer Applied
#7 lore raw
In reply to Jarkko Nikula
Quoted 3 lines · Jarkko Nikula

Move fw_base and fw_size fields in struct sst_pdata under ACPI data for clarifying that these are not related to firmware file but for platform specific extended firmware area reserved by the BIOS.

Applied, thanks.