| Message ID | 20240521-qcom-firmware-name-v1-1-99a6d32b1e5e@linaro.org (mailing list archive) |
|---|---|
| State | Deferred |
| Delegated to: | Kalle Valo |
| Headers | show |
| Series | arm64: qcom: autodetect firmware paths | expand |
On 21/05/2024 11:45, Dmitry Baryshkov wrote: > Qualcomm platforms have different sets of the firmware files, which > differ from platform to platform (and from board to board, due to the > embedded signatures). Rather than listing all the firmware files, > including full paths, in the DT, provide a way to determine firmware > path based on the root DT node compatible. Ok this looks quite over-engineered but necessary to handle the legacy, but I really think we should add a way to look for a board-specific path first and fallback to those SoC specific paths. Neil > > Suggested-by: Arnd Bergmann <arnd@arndb.de> > Signed-off-by: Dmitry Baryshkov <dmitry.baryshkov@linaro.org> > --- > drivers/soc/qcom/Kconfig | 5 +++ > drivers/soc/qcom/Makefile | 1 + > drivers/soc/qcom/qcom_fw_helper.c | 86 ++++++++++++++++++++++++++++++++++++++ > include/linux/soc/qcom/fw_helper.h | 10 +++++ > 4 files changed, 102 insertions(+) > > diff --git a/drivers/soc/qcom/Kconfig b/drivers/soc/qcom/Kconfig > index 5af33b0e3470..b663774d65f8 100644 > --- a/drivers/soc/qcom/Kconfig > +++ b/drivers/soc/qcom/Kconfig > @@ -62,6 +62,11 @@ config QCOM_MDT_LOADER > tristate > select QCOM_SCM > > +config QCOM_FW_HELPER > + tristate "NONE FW HELPER" > + help > + Helpers to return platform-specific location for the firmware files. > + > config QCOM_OCMEM > tristate "Qualcomm On Chip Memory (OCMEM) driver" > depends on ARCH_QCOM > diff --git a/drivers/soc/qcom/Makefile b/drivers/soc/qcom/Makefile > index ca0bece0dfff..e612bee5b955 100644 > --- a/drivers/soc/qcom/Makefile > +++ b/drivers/soc/qcom/Makefile > @@ -6,6 +6,7 @@ obj-$(CONFIG_QCOM_GENI_SE) += qcom-geni-se.o > obj-$(CONFIG_QCOM_COMMAND_DB) += cmd-db.o > obj-$(CONFIG_QCOM_GSBI) += qcom_gsbi.o > obj-$(CONFIG_QCOM_MDT_LOADER) += mdt_loader.o > +obj-$(CONFIG_QCOM_FW_HELPER) += qcom_fw_helper.o > obj-$(CONFIG_QCOM_OCMEM) += ocmem.o > obj-$(CONFIG_QCOM_PDR_HELPERS) += pdr_interface.o > obj-$(CONFIG_QCOM_PMIC_GLINK) += pmic_glink.o > diff --git a/drivers/soc/qcom/qcom_fw_helper.c b/drivers/soc/qcom/qcom_fw_helper.c > new file mode 100644 > index 000000000000..13123c2514b8 > --- /dev/null > +++ b/drivers/soc/qcom/qcom_fw_helper.c > @@ -0,0 +1,86 @@ > +// SPDX-License-Identifier: GPL-2.0-only > +/* > + * Qualcomm Firmware loading data > + * > + * Copyright (C) 2024 Linaro Ltd > + */ > + > +#include <linux/cleanup.h> > +#include <linux/device.h> > +#include <linux/mutex.h> > +#include <linux/of.h> > +#include <linux/soc/qcom/fw_helper.h> > + > +static DEFINE_MUTEX(qcom_fw_mutex); > +static const char *fw_path; > + > +static const struct of_device_id qcom_fw_paths[] = { > + /* device-specific entries */ > + { .compatible = "thundercomm,db845c", .data = "qcom/sdm845/Thundercomm/db845c", }, > + { .compatible = "qcom,qrb5165-rb5", .data = "qcom/sm8250/Thundercomm/RB5", }, > + /* SoC default entries */ > + { .compatible = "qcom,apq8016", .data = "qcom/apq8016", }, > + { .compatible = "qcom,apq8096", .data = "qcom/apq8096", }, > + { .compatible = "qcom,sdm845", .data = "qcom/sdm845", }, > + { .compatible = "qcom,sm8250", .data = "qcom/sm8250", }, > + { .compatible = "qcom,sm8350", .data = "qcom/sm8350", }, > + { .compatible = "qcom,sm8450", .data = "qcom/sm8450", }, > + { .compatible = "qcom,sm8550", .data = "qcom/sm8550", }, > + { .compatible = "qcom,sm8650", .data = "qcom/sm8650", }, > + {}, > +}; > + > +static int qcom_fw_ensure_init(void) > +{ > + const struct of_device_id *match; > + struct device_node *root; > + > + if (fw_path) > + return 0; > + > + root = of_find_node_by_path("/"); > + if (!root) > + return -ENODEV; > + > + match = of_match_node(qcom_fw_paths, root); > + of_node_put(root); > + if (!match || !match->data) { > + pr_notice("Platform not supported by qcom_fw_helper\n"); > + return -ENODEV; > + } > + > + fw_path = match->data; > + > + return 0; > +} > + > +const char *qcom_get_board_fw(const char *firmware) > +{ > + if (strchr(firmware, '/')) > + return kstrdup(firmware, GFP_KERNEL); > + > + scoped_guard(mutex, &qcom_fw_mutex) { > + if (!qcom_fw_ensure_init()) > + return kasprintf(GFP_KERNEL, "%s/%s", fw_path, firmware); > + } > + > + return kstrdup(firmware, GFP_KERNEL); > +} > +EXPORT_SYMBOL_GPL(qcom_get_board_fw); > + > +const char *devm_qcom_get_board_fw(struct device *dev, const char *firmware) > +{ > + if (strchr(firmware, '/')) > + return devm_kstrdup(dev, firmware, GFP_KERNEL); > + > + scoped_guard(mutex, &qcom_fw_mutex) { > + if (!qcom_fw_ensure_init()) > + return devm_kasprintf(dev, GFP_KERNEL, "%s/%s", fw_path, firmware); > + } > + > + return devm_kstrdup(dev, firmware, GFP_KERNEL); > +} > +EXPORT_SYMBOL_GPL(devm_qcom_get_board_fw); > + > +MODULE_DESCRIPTION("Firmware helpers for Qualcomm devices"); > +MODULE_LICENSE("GPL"); > diff --git a/include/linux/soc/qcom/fw_helper.h b/include/linux/soc/qcom/fw_helper.h > new file mode 100644 > index 000000000000..755645386bba > --- /dev/null > +++ b/include/linux/soc/qcom/fw_helper.h > @@ -0,0 +1,10 @@ > +/* SPDX-License-Identifier: GPL-2.0 */ > +#ifndef __QCOM_FW_HELPER_H__ > +#define __QCOM_FW_HELPER_H__ > + > +struct device; > + > +const char *qcom_get_board_fw(const char *firmware); > +const char *devm_qcom_get_board_fw(struct device *dev, const char *firmware); > + > +#endif >
On Tue, 21 May 2024 at 12:52, <neil.armstrong@linaro.org> wrote: > > On 21/05/2024 11:45, Dmitry Baryshkov wrote: > > Qualcomm platforms have different sets of the firmware files, which > > differ from platform to platform (and from board to board, due to the > > embedded signatures). Rather than listing all the firmware files, > > including full paths, in the DT, provide a way to determine firmware > > path based on the root DT node compatible. > > Ok this looks quite over-engineered but necessary to handle the legacy, > but I really think we should add a way to look for a board-specific path > first and fallback to those SoC specific paths. Again, CONFIG_FW_LOADER_USER_HELPER => delays. > > Neil > > > > > Suggested-by: Arnd Bergmann <arnd@arndb.de> > > Signed-off-by: Dmitry Baryshkov <dmitry.baryshkov@linaro.org> > > --- > > drivers/soc/qcom/Kconfig | 5 +++ > > drivers/soc/qcom/Makefile | 1 + > > drivers/soc/qcom/qcom_fw_helper.c | 86 ++++++++++++++++++++++++++++++++++++++ > > include/linux/soc/qcom/fw_helper.h | 10 +++++ > > 4 files changed, 102 insertions(+) > > > > diff --git a/drivers/soc/qcom/Kconfig b/drivers/soc/qcom/Kconfig > > index 5af33b0e3470..b663774d65f8 100644 > > --- a/drivers/soc/qcom/Kconfig > > +++ b/drivers/soc/qcom/Kconfig > > @@ -62,6 +62,11 @@ config QCOM_MDT_LOADER > > tristate > > select QCOM_SCM > > > > +config QCOM_FW_HELPER > > + tristate "NONE FW HELPER" > > + help > > + Helpers to return platform-specific location for the firmware files. > > + > > config QCOM_OCMEM > > tristate "Qualcomm On Chip Memory (OCMEM) driver" > > depends on ARCH_QCOM > > diff --git a/drivers/soc/qcom/Makefile b/drivers/soc/qcom/Makefile > > index ca0bece0dfff..e612bee5b955 100644 > > --- a/drivers/soc/qcom/Makefile > > +++ b/drivers/soc/qcom/Makefile > > @@ -6,6 +6,7 @@ obj-$(CONFIG_QCOM_GENI_SE) += qcom-geni-se.o > > obj-$(CONFIG_QCOM_COMMAND_DB) += cmd-db.o > > obj-$(CONFIG_QCOM_GSBI) += qcom_gsbi.o > > obj-$(CONFIG_QCOM_MDT_LOADER) += mdt_loader.o > > +obj-$(CONFIG_QCOM_FW_HELPER) += qcom_fw_helper.o > > obj-$(CONFIG_QCOM_OCMEM) += ocmem.o > > obj-$(CONFIG_QCOM_PDR_HELPERS) += pdr_interface.o > > obj-$(CONFIG_QCOM_PMIC_GLINK) += pmic_glink.o > > diff --git a/drivers/soc/qcom/qcom_fw_helper.c b/drivers/soc/qcom/qcom_fw_helper.c > > new file mode 100644 > > index 000000000000..13123c2514b8 > > --- /dev/null > > +++ b/drivers/soc/qcom/qcom_fw_helper.c > > @@ -0,0 +1,86 @@ > > +// SPDX-License-Identifier: GPL-2.0-only > > +/* > > + * Qualcomm Firmware loading data > > + * > > + * Copyright (C) 2024 Linaro Ltd > > + */ > > + > > +#include <linux/cleanup.h> > > +#include <linux/device.h> > > +#include <linux/mutex.h> > > +#include <linux/of.h> > > +#include <linux/soc/qcom/fw_helper.h> > > + > > +static DEFINE_MUTEX(qcom_fw_mutex); > > +static const char *fw_path; > > + > > +static const struct of_device_id qcom_fw_paths[] = { > > + /* device-specific entries */ > > + { .compatible = "thundercomm,db845c", .data = "qcom/sdm845/Thundercomm/db845c", }, > > + { .compatible = "qcom,qrb5165-rb5", .data = "qcom/sm8250/Thundercomm/RB5", }, > > + /* SoC default entries */ > > + { .compatible = "qcom,apq8016", .data = "qcom/apq8016", }, > > + { .compatible = "qcom,apq8096", .data = "qcom/apq8096", }, > > + { .compatible = "qcom,sdm845", .data = "qcom/sdm845", }, > > + { .compatible = "qcom,sm8250", .data = "qcom/sm8250", }, > > + { .compatible = "qcom,sm8350", .data = "qcom/sm8350", }, > > + { .compatible = "qcom,sm8450", .data = "qcom/sm8450", }, > > + { .compatible = "qcom,sm8550", .data = "qcom/sm8550", }, > > + { .compatible = "qcom,sm8650", .data = "qcom/sm8650", }, > > + {}, > > +}; > > + > > +static int qcom_fw_ensure_init(void) > > +{ > > + const struct of_device_id *match; > > + struct device_node *root; > > + > > + if (fw_path) > > + return 0; > > + > > + root = of_find_node_by_path("/"); > > + if (!root) > > + return -ENODEV; > > + > > + match = of_match_node(qcom_fw_paths, root); > > + of_node_put(root); > > + if (!match || !match->data) { > > + pr_notice("Platform not supported by qcom_fw_helper\n"); > > + return -ENODEV; > > + } > > + > > + fw_path = match->data; > > + > > + return 0; > > +} > > + > > +const char *qcom_get_board_fw(const char *firmware) > > +{ > > + if (strchr(firmware, '/')) > > + return kstrdup(firmware, GFP_KERNEL); > > + > > + scoped_guard(mutex, &qcom_fw_mutex) { > > + if (!qcom_fw_ensure_init()) > > + return kasprintf(GFP_KERNEL, "%s/%s", fw_path, firmware); > > + } > > + > > + return kstrdup(firmware, GFP_KERNEL); > > +} > > +EXPORT_SYMBOL_GPL(qcom_get_board_fw); > > + > > +const char *devm_qcom_get_board_fw(struct device *dev, const char *firmware) > > +{ > > + if (strchr(firmware, '/')) > > + return devm_kstrdup(dev, firmware, GFP_KERNEL); > > + > > + scoped_guard(mutex, &qcom_fw_mutex) { > > + if (!qcom_fw_ensure_init()) > > + return devm_kasprintf(dev, GFP_KERNEL, "%s/%s", fw_path, firmware); > > + } > > + > > + return devm_kstrdup(dev, firmware, GFP_KERNEL); > > +} > > +EXPORT_SYMBOL_GPL(devm_qcom_get_board_fw); > > + > > +MODULE_DESCRIPTION("Firmware helpers for Qualcomm devices"); > > +MODULE_LICENSE("GPL"); > > diff --git a/include/linux/soc/qcom/fw_helper.h b/include/linux/soc/qcom/fw_helper.h > > new file mode 100644 > > index 000000000000..755645386bba > > --- /dev/null > > +++ b/include/linux/soc/qcom/fw_helper.h > > @@ -0,0 +1,10 @@ > > +/* SPDX-License-Identifier: GPL-2.0 */ > > +#ifndef __QCOM_FW_HELPER_H__ > > +#define __QCOM_FW_HELPER_H__ > > + > > +struct device; > > + > > +const char *qcom_get_board_fw(const char *firmware); > > +const char *devm_qcom_get_board_fw(struct device *dev, const char *firmware); > > + > > +#endif > > >
Dmitry Baryshkov <dmitry.baryshkov@linaro.org> writes: > On Tue, 21 May 2024 at 12:52, <neil.armstrong@linaro.org> wrote: >> >> On 21/05/2024 11:45, Dmitry Baryshkov wrote: >> > Qualcomm platforms have different sets of the firmware files, which >> > differ from platform to platform (and from board to board, due to the >> > embedded signatures). Rather than listing all the firmware files, >> > including full paths, in the DT, provide a way to determine firmware >> > path based on the root DT node compatible. >> >> Ok this looks quite over-engineered but necessary to handle the legacy, >> but I really think we should add a way to look for a board-specific path >> first and fallback to those SoC specific paths. > > Again, CONFIG_FW_LOADER_USER_HELPER => delays. To me this also looks like very over-engineered, can you elaborate more why this is needed? Concrete examples would help to understand better.
On Tue, 21 May 2024 at 13:20, Kalle Valo <kvalo@kernel.org> wrote: > > Dmitry Baryshkov <dmitry.baryshkov@linaro.org> writes: > > > On Tue, 21 May 2024 at 12:52, <neil.armstrong@linaro.org> wrote: > >> > >> On 21/05/2024 11:45, Dmitry Baryshkov wrote: > >> > Qualcomm platforms have different sets of the firmware files, which > >> > differ from platform to platform (and from board to board, due to the > >> > embedded signatures). Rather than listing all the firmware files, > >> > including full paths, in the DT, provide a way to determine firmware > >> > path based on the root DT node compatible. > >> > >> Ok this looks quite over-engineered but necessary to handle the legacy, > >> but I really think we should add a way to look for a board-specific path > >> first and fallback to those SoC specific paths. > > > > Again, CONFIG_FW_LOADER_USER_HELPER => delays. > > To me this also looks like very over-engineered, can you elaborate more > why this is needed? Concrete examples would help to understand better. Sure. During the meeting last week Arnd suggested evaluating if we can drop firmware-name from the board DT files. Several reasons for that: - DT should describe the hardware, not the Linux-firmware locations - having firmware name in DT complicates updating the tree to use different firmware API (think of mbn vs mdt vs any other format) - If the DT gets supplied by the vendor (e.g. for SystemReady-certified devices), there should be a sync between the vendor's DT, linux kernel and the rootfs. Dropping firmware names from DT solves that by removing one piece of the equation Now for the complexity of the solution. Each SoC family has their own firmware set. This includes firmware for the DSPs, for modem, WiFi bits, GPU shader, etc. For the development boards these devices are signed by the testing key and the actual signature is not validated against the root of trust certificate. For the end-user devices the signature is actually validated against the bits fused to the SoC during manufacturing process. CA certificate (and thus the fuses) differ from vendor to vendor (and from the device to device) Not all of the firmware files are a part of the public linux-firmware tree. However we need to support the rootfs bundled with the firmware for different platforms (both public and vendor). The non-signed files come from the Adreno GPU and can be shared between platforms. All other files are SoC-specific and in some cases device-specific. So for example the SDM845 db845c (open device) loads following firmware files: Not signed: - qcom/a630_sqe.fw - qcom/a630_gmu.bin Signed, will work for any non-secured sdm845 device: - qcom/sdm845/a630_zap.mbn - qcom/sdm845/adsp.mbn - qcom/sdm845/cdsp.mbn - qcom/sdm485/mba.mbn - qcom/sdm845/modem.mbn - qcom/sdm845/wlanmdsp.mbn (loaded via TQFTP) - qcom/venus-5.2/venus.mbn Signed, works only for DB845c. - qcom/sdm845/Thundercomm/db845c/slpi.mbn In comparison, the SDM845 Pixel-3 phone (aka blueline) should load the following firmware files: - qcom/a630_sqe.fw (the same, non-signed file) - qcom/a630_gmu.bin (the same, non-signed file) - qcom/sdm845/Google/blueline/a630_zap.mbn - qcom/sdm845/Google/blueline/adsp.mbn - qcom/sdm845/Google/blueline/cdsp.mbn - qcom/sdm845/Google/blueline/ipa_fws.mbn - qcom/sdm845/Google/blueline/mba.mbn - qcom/sdm845/Google/blueline/modem.mbn - qcom/sdm845/Google/blueline/venus.mbn - qcom/sdm845/Google/blueline/wlanmdsp.mbn - qcom/sdm845/Google/blueline/slpi.mbn The Lenovo Yoga C630 WoS laptop (SDM850 is a variant of SDM845) uses another set of files: - qcom/a630_sqe.fw (the same, non-signed file) - qcom/a630_gmu.bin (the same, non-signed file) - qcom/sdm850/LENOVO/81JL/qcdxkmsuc850.mbn - qcom/sdm850/LENOVO/81JL/qcadsp850.mbn - qcom/sdm850/LENOVO/81JL/qccdsp850.mbn - qcom/sdm850/LENOVO/81JL/ipa_fws.elf - qcom/sdm850/LENOVO/81JL/qcdsp1v2850.mbn - qcom/sdm850/LENOVO/81JL/qcdsp2850.mbn - qcom/sdm850/LENOVO/81JL/qcvss850.mbn - qcom/sdm850/LENOVO/81JL/wlanmdsp.mbn - qcom/sdm850/LENOVO/81JL/qcslpi850.mbn If we look at one of the recent platforms, e.g. SM8650-QRD, this list also grows up: - qcom/gen70900_sqe.fw (generic, non-signed) - qcom/gmu_gen70900.bin (generic, non-signed) - qcom/sm8650/gen70900_zap.mbn - qcom/sm8650/adsp.mbn - qcom/sm8650/adsp_dtb.mbn - qcom/sm8650/cdsp.mbn - qcom/sm8650/cdsp_dtb.mbn - qcom/sm8650/ipa_fws.mbn - qcom/sm8650/modem.mbn - qcom/sm8650/modem_dtb.mbn - qcom/sm8650/vpu33_4v.mbn (or maybe qcom/vpu-33/vpu_4v.mbn)
On Tue, May 21, 2024 at 03:08:31PM +0200, Dmitry Baryshkov wrote: > On Tue, 21 May 2024 at 13:20, Kalle Valo <kvalo@kernel.org> wrote: > > > > Dmitry Baryshkov <dmitry.baryshkov@linaro.org> writes: > > > > > On Tue, 21 May 2024 at 12:52, <neil.armstrong@linaro.org> wrote: > > >> > > >> On 21/05/2024 11:45, Dmitry Baryshkov wrote: > > >> > Qualcomm platforms have different sets of the firmware files, which > > >> > differ from platform to platform (and from board to board, due to the > > >> > embedded signatures). Rather than listing all the firmware files, > > >> > including full paths, in the DT, provide a way to determine firmware > > >> > path based on the root DT node compatible. > > >> > > >> Ok this looks quite over-engineered but necessary to handle the legacy, > > >> but I really think we should add a way to look for a board-specific path > > >> first and fallback to those SoC specific paths. > > > > > > Again, CONFIG_FW_LOADER_USER_HELPER => delays. > > > > To me this also looks like very over-engineered, can you elaborate more > > why this is needed? Concrete examples would help to understand better. > > Sure. During the meeting last week Arnd suggested evaluating if we can > drop firmware-name from the board DT files. Several reasons for that: > - DT should describe the hardware, not the Linux-firmware locations > - having firmware name in DT complicates updating the tree to use > different firmware API (think of mbn vs mdt vs any other format) > - If the DT gets supplied by the vendor (e.g. for > SystemReady-certified devices), there should be a sync between the > vendor's DT, linux kernel and the rootfs. Dropping firmware names from > DT solves that by removing one piece of the equation > > Now for the complexity of the solution. Each SoC family has their own > firmware set. This includes firmware for the DSPs, for modem, WiFi > bits, GPU shader, etc. > For the development boards these devices are signed by the testing key > and the actual signature is not validated against the root of trust > certificate. > For the end-user devices the signature is actually validated against > the bits fused to the SoC during manufacturing process. CA certificate > (and thus the fuses) differ from vendor to vendor (and from the device > to device) > > Not all of the firmware files are a part of the public linux-firmware > tree. However we need to support the rootfs bundled with the firmware > for different platforms (both public and vendor). The non-signed files > come from the Adreno GPU and can be shared between platforms. All > other files are SoC-specific and in some cases device-specific. > > So for example the SDM845 db845c (open device) loads following firmware files: > Not signed: > - qcom/a630_sqe.fw > - qcom/a630_gmu.bin > > Signed, will work for any non-secured sdm845 device: > - qcom/sdm845/a630_zap.mbn > - qcom/sdm845/adsp.mbn > - qcom/sdm845/cdsp.mbn > - qcom/sdm485/mba.mbn > - qcom/sdm845/modem.mbn > - qcom/sdm845/wlanmdsp.mbn (loaded via TQFTP) > - qcom/venus-5.2/venus.mbn > > Signed, works only for DB845c. > - qcom/sdm845/Thundercomm/db845c/slpi.mbn > > In comparison, the SDM845 Pixel-3 phone (aka blueline) should load the > following firmware files: > - qcom/a630_sqe.fw (the same, non-signed file) > - qcom/a630_gmu.bin (the same, non-signed file) > - qcom/sdm845/Google/blueline/a630_zap.mbn How do you get from "a630_zap.mbn" to this? By extending the lookup table for every target, or what am I missing? Regards, Bjorn > - qcom/sdm845/Google/blueline/adsp.mbn > - qcom/sdm845/Google/blueline/cdsp.mbn > - qcom/sdm845/Google/blueline/ipa_fws.mbn > - qcom/sdm845/Google/blueline/mba.mbn > - qcom/sdm845/Google/blueline/modem.mbn > - qcom/sdm845/Google/blueline/venus.mbn > - qcom/sdm845/Google/blueline/wlanmdsp.mbn > - qcom/sdm845/Google/blueline/slpi.mbn > > The Lenovo Yoga C630 WoS laptop (SDM850 is a variant of SDM845) uses > another set of files: > - qcom/a630_sqe.fw (the same, non-signed file) > - qcom/a630_gmu.bin (the same, non-signed file) > - qcom/sdm850/LENOVO/81JL/qcdxkmsuc850.mbn > - qcom/sdm850/LENOVO/81JL/qcadsp850.mbn > - qcom/sdm850/LENOVO/81JL/qccdsp850.mbn > - qcom/sdm850/LENOVO/81JL/ipa_fws.elf > - qcom/sdm850/LENOVO/81JL/qcdsp1v2850.mbn > - qcom/sdm850/LENOVO/81JL/qcdsp2850.mbn > - qcom/sdm850/LENOVO/81JL/qcvss850.mbn > - qcom/sdm850/LENOVO/81JL/wlanmdsp.mbn > - qcom/sdm850/LENOVO/81JL/qcslpi850.mbn > > If we look at one of the recent platforms, e.g. SM8650-QRD, this list > also grows up: > - qcom/gen70900_sqe.fw (generic, non-signed) > - qcom/gmu_gen70900.bin (generic, non-signed) > - qcom/sm8650/gen70900_zap.mbn > - qcom/sm8650/adsp.mbn > - qcom/sm8650/adsp_dtb.mbn > - qcom/sm8650/cdsp.mbn > - qcom/sm8650/cdsp_dtb.mbn > - qcom/sm8650/ipa_fws.mbn > - qcom/sm8650/modem.mbn > - qcom/sm8650/modem_dtb.mbn > - qcom/sm8650/vpu33_4v.mbn (or maybe qcom/vpu-33/vpu_4v.mbn) > > -- > With best wishes > Dmitry > > > > > > > > >
On Thu, 23 May 2024 at 01:48, Bjorn Andersson <quic_bjorande@quicinc.com> wrote: > > On Tue, May 21, 2024 at 03:08:31PM +0200, Dmitry Baryshkov wrote: > > On Tue, 21 May 2024 at 13:20, Kalle Valo <kvalo@kernel.org> wrote: > > > > > > Dmitry Baryshkov <dmitry.baryshkov@linaro.org> writes: > > > > > > > On Tue, 21 May 2024 at 12:52, <neil.armstrong@linaro.org> wrote: > > > >> > > > >> On 21/05/2024 11:45, Dmitry Baryshkov wrote: > > > >> > Qualcomm platforms have different sets of the firmware files, which > > > >> > differ from platform to platform (and from board to board, due to the > > > >> > embedded signatures). Rather than listing all the firmware files, > > > >> > including full paths, in the DT, provide a way to determine firmware > > > >> > path based on the root DT node compatible. > > > >> > > > >> Ok this looks quite over-engineered but necessary to handle the legacy, > > > >> but I really think we should add a way to look for a board-specific path > > > >> first and fallback to those SoC specific paths. > > > > > > > > Again, CONFIG_FW_LOADER_USER_HELPER => delays. > > > > > > To me this also looks like very over-engineered, can you elaborate more > > > why this is needed? Concrete examples would help to understand better. > > > > Sure. During the meeting last week Arnd suggested evaluating if we can > > drop firmware-name from the board DT files. Several reasons for that: > > - DT should describe the hardware, not the Linux-firmware locations > > - having firmware name in DT complicates updating the tree to use > > different firmware API (think of mbn vs mdt vs any other format) > > - If the DT gets supplied by the vendor (e.g. for > > SystemReady-certified devices), there should be a sync between the > > vendor's DT, linux kernel and the rootfs. Dropping firmware names from > > DT solves that by removing one piece of the equation > > > > Now for the complexity of the solution. Each SoC family has their own > > firmware set. This includes firmware for the DSPs, for modem, WiFi > > bits, GPU shader, etc. > > For the development boards these devices are signed by the testing key > > and the actual signature is not validated against the root of trust > > certificate. > > For the end-user devices the signature is actually validated against > > the bits fused to the SoC during manufacturing process. CA certificate > > (and thus the fuses) differ from vendor to vendor (and from the device > > to device) > > > > Not all of the firmware files are a part of the public linux-firmware > > tree. However we need to support the rootfs bundled with the firmware > > for different platforms (both public and vendor). The non-signed files > > come from the Adreno GPU and can be shared between platforms. All > > other files are SoC-specific and in some cases device-specific. > > > > So for example the SDM845 db845c (open device) loads following firmware files: > > Not signed: > > - qcom/a630_sqe.fw > > - qcom/a630_gmu.bin > > > > Signed, will work for any non-secured sdm845 device: > > - qcom/sdm845/a630_zap.mbn > > - qcom/sdm845/adsp.mbn > > - qcom/sdm845/cdsp.mbn > > - qcom/sdm485/mba.mbn > > - qcom/sdm845/modem.mbn > > - qcom/sdm845/wlanmdsp.mbn (loaded via TQFTP) > > - qcom/venus-5.2/venus.mbn > > > > Signed, works only for DB845c. > > - qcom/sdm845/Thundercomm/db845c/slpi.mbn > > > > In comparison, the SDM845 Pixel-3 phone (aka blueline) should load the > > following firmware files: > > - qcom/a630_sqe.fw (the same, non-signed file) > > - qcom/a630_gmu.bin (the same, non-signed file) > > - qcom/sdm845/Google/blueline/a630_zap.mbn > > How do you get from "a630_zap.mbn" to this? By extending the lookup > table for every target, or what am I missing? More or less so. Matching the root OF node gives us the firmware location, then it gets prepended to all firmware targets. Not an ideal solution, as there is no fallback support, but at least it gives us some points to discuss (and to decide whether to move to some particular direction or to abandon the idea completely, making Arnd unhappy again). > > Regards, > Bjorn > > > - qcom/sdm845/Google/blueline/adsp.mbn > > - qcom/sdm845/Google/blueline/cdsp.mbn > > - qcom/sdm845/Google/blueline/ipa_fws.mbn > > - qcom/sdm845/Google/blueline/mba.mbn > > - qcom/sdm845/Google/blueline/modem.mbn > > - qcom/sdm845/Google/blueline/venus.mbn > > - qcom/sdm845/Google/blueline/wlanmdsp.mbn > > - qcom/sdm845/Google/blueline/slpi.mbn > > > > The Lenovo Yoga C630 WoS laptop (SDM850 is a variant of SDM845) uses > > another set of files: > > - qcom/a630_sqe.fw (the same, non-signed file) > > - qcom/a630_gmu.bin (the same, non-signed file) > > - qcom/sdm850/LENOVO/81JL/qcdxkmsuc850.mbn > > - qcom/sdm850/LENOVO/81JL/qcadsp850.mbn > > - qcom/sdm850/LENOVO/81JL/qccdsp850.mbn > > - qcom/sdm850/LENOVO/81JL/ipa_fws.elf > > - qcom/sdm850/LENOVO/81JL/qcdsp1v2850.mbn > > - qcom/sdm850/LENOVO/81JL/qcdsp2850.mbn > > - qcom/sdm850/LENOVO/81JL/qcvss850.mbn > > - qcom/sdm850/LENOVO/81JL/wlanmdsp.mbn > > - qcom/sdm850/LENOVO/81JL/qcslpi850.mbn > > > > If we look at one of the recent platforms, e.g. SM8650-QRD, this list > > also grows up: > > - qcom/gen70900_sqe.fw (generic, non-signed) > > - qcom/gmu_gen70900.bin (generic, non-signed) > > - qcom/sm8650/gen70900_zap.mbn > > - qcom/sm8650/adsp.mbn > > - qcom/sm8650/adsp_dtb.mbn > > - qcom/sm8650/cdsp.mbn > > - qcom/sm8650/cdsp_dtb.mbn > > - qcom/sm8650/ipa_fws.mbn > > - qcom/sm8650/modem.mbn > > - qcom/sm8650/modem_dtb.mbn > > - qcom/sm8650/vpu33_4v.mbn (or maybe qcom/vpu-33/vpu_4v.mbn) > > > > -- > > With best wishes > > Dmitry > > > > > > > > > > > > > > > > > >
On Mon, May 27, 2024 at 02:42:44PM GMT, Dmitry Baryshkov wrote: > On Thu, 23 May 2024 at 01:48, Bjorn Andersson <quic_bjorande@quicinc.com> wrote: > > > > On Tue, May 21, 2024 at 03:08:31PM +0200, Dmitry Baryshkov wrote: > > > On Tue, 21 May 2024 at 13:20, Kalle Valo <kvalo@kernel.org> wrote: > > > > > > > > Dmitry Baryshkov <dmitry.baryshkov@linaro.org> writes: > > > > > > > > > On Tue, 21 May 2024 at 12:52, <neil.armstrong@linaro.org> wrote: > > > > >> > > > > >> On 21/05/2024 11:45, Dmitry Baryshkov wrote: > > > > >> > Qualcomm platforms have different sets of the firmware files, which > > > > >> > differ from platform to platform (and from board to board, due to the > > > > >> > embedded signatures). Rather than listing all the firmware files, > > > > >> > including full paths, in the DT, provide a way to determine firmware > > > > >> > path based on the root DT node compatible. > > > > >> > > > > >> Ok this looks quite over-engineered but necessary to handle the legacy, > > > > >> but I really think we should add a way to look for a board-specific path > > > > >> first and fallback to those SoC specific paths. > > > > > > > > > > Again, CONFIG_FW_LOADER_USER_HELPER => delays. > > > > > > > > To me this also looks like very over-engineered, can you elaborate more > > > > why this is needed? Concrete examples would help to understand better. > > > > > > Sure. During the meeting last week Arnd suggested evaluating if we can > > > drop firmware-name from the board DT files. Several reasons for that: > > > - DT should describe the hardware, not the Linux-firmware locations > > > - having firmware name in DT complicates updating the tree to use > > > different firmware API (think of mbn vs mdt vs any other format) > > > - If the DT gets supplied by the vendor (e.g. for > > > SystemReady-certified devices), there should be a sync between the > > > vendor's DT, linux kernel and the rootfs. Dropping firmware names from > > > DT solves that by removing one piece of the equation > > > > > > Now for the complexity of the solution. Each SoC family has their own > > > firmware set. This includes firmware for the DSPs, for modem, WiFi > > > bits, GPU shader, etc. > > > For the development boards these devices are signed by the testing key > > > and the actual signature is not validated against the root of trust > > > certificate. > > > For the end-user devices the signature is actually validated against > > > the bits fused to the SoC during manufacturing process. CA certificate > > > (and thus the fuses) differ from vendor to vendor (and from the device > > > to device) > > > > > > Not all of the firmware files are a part of the public linux-firmware > > > tree. However we need to support the rootfs bundled with the firmware > > > for different platforms (both public and vendor). The non-signed files > > > come from the Adreno GPU and can be shared between platforms. All > > > other files are SoC-specific and in some cases device-specific. > > > > > > So for example the SDM845 db845c (open device) loads following firmware files: > > > Not signed: > > > - qcom/a630_sqe.fw > > > - qcom/a630_gmu.bin > > > > > > Signed, will work for any non-secured sdm845 device: > > > - qcom/sdm845/a630_zap.mbn > > > - qcom/sdm845/adsp.mbn > > > - qcom/sdm845/cdsp.mbn > > > - qcom/sdm485/mba.mbn > > > - qcom/sdm845/modem.mbn > > > - qcom/sdm845/wlanmdsp.mbn (loaded via TQFTP) > > > - qcom/venus-5.2/venus.mbn > > > > > > Signed, works only for DB845c. > > > - qcom/sdm845/Thundercomm/db845c/slpi.mbn > > > > > > In comparison, the SDM845 Pixel-3 phone (aka blueline) should load the > > > following firmware files: > > > - qcom/a630_sqe.fw (the same, non-signed file) > > > - qcom/a630_gmu.bin (the same, non-signed file) > > > - qcom/sdm845/Google/blueline/a630_zap.mbn > > > > How do you get from "a630_zap.mbn" to this? By extending the lookup > > table for every target, or what am I missing? > > More or less so. Matching the root OF node gives us the firmware > location, then it gets prepended to all firmware targets. Not an ideal > solution, as there is no fallback support, but at least it gives us > some points to discuss (and to decide whether to move to some > particular direction or to abandon the idea completely, making Arnd > unhappy again). > I understand the desire to not put linux-firmware-specific paths in the DeviceTree, but I think I'm less keen on having a big lookup table in the kernel... Regards, Bjorn
Bjorn Andersson <andersson@kernel.org> writes: > On Mon, May 27, 2024 at 02:42:44PM GMT, Dmitry Baryshkov wrote: > >> On Thu, 23 May 2024 at 01:48, Bjorn Andersson <quic_bjorande@quicinc.com> wrote: >> > >> > On Tue, May 21, 2024 at 03:08:31PM +0200, Dmitry Baryshkov wrote: >> > > On Tue, 21 May 2024 at 13:20, Kalle Valo <kvalo@kernel.org> wrote: >> > > > >> > > > Dmitry Baryshkov <dmitry.baryshkov@linaro.org> writes: >> > > > >> > > > > On Tue, 21 May 2024 at 12:52, <neil.armstrong@linaro.org> wrote: >> > > > >> >> > > > >> On 21/05/2024 11:45, Dmitry Baryshkov wrote: >> > > > >> > Qualcomm platforms have different sets of the firmware files, which >> > > > >> > differ from platform to platform (and from board to board, due to the >> > > > >> > embedded signatures). Rather than listing all the firmware files, >> > > > >> > including full paths, in the DT, provide a way to determine firmware >> > > > >> > path based on the root DT node compatible. >> > > > >> >> > > > >> Ok this looks quite over-engineered but necessary to handle the legacy, >> > > > >> but I really think we should add a way to look for a board-specific path >> > > > >> first and fallback to those SoC specific paths. >> > > > > >> > > > > Again, CONFIG_FW_LOADER_USER_HELPER => delays. >> > > > >> > > > To me this also looks like very over-engineered, can you elaborate more >> > > > why this is needed? Concrete examples would help to understand better. >> > > >> > > Sure. During the meeting last week Arnd suggested evaluating if we can >> > > drop firmware-name from the board DT files. Several reasons for that: >> > > - DT should describe the hardware, not the Linux-firmware locations >> > > - having firmware name in DT complicates updating the tree to use >> > > different firmware API (think of mbn vs mdt vs any other format) >> > > - If the DT gets supplied by the vendor (e.g. for >> > > SystemReady-certified devices), there should be a sync between the >> > > vendor's DT, linux kernel and the rootfs. Dropping firmware names from >> > > DT solves that by removing one piece of the equation >> > > >> > > Now for the complexity of the solution. Each SoC family has their own >> > > firmware set. This includes firmware for the DSPs, for modem, WiFi >> > > bits, GPU shader, etc. >> > > For the development boards these devices are signed by the testing key >> > > and the actual signature is not validated against the root of trust >> > > certificate. >> > > For the end-user devices the signature is actually validated against >> > > the bits fused to the SoC during manufacturing process. CA certificate >> > > (and thus the fuses) differ from vendor to vendor (and from the device >> > > to device) >> > > >> > > Not all of the firmware files are a part of the public linux-firmware >> > > tree. However we need to support the rootfs bundled with the firmware >> > > for different platforms (both public and vendor). The non-signed files >> > > come from the Adreno GPU and can be shared between platforms. All >> > > other files are SoC-specific and in some cases device-specific. >> > > >> > > So for example the SDM845 db845c (open device) loads following firmware files: >> > > Not signed: >> > > - qcom/a630_sqe.fw >> > > - qcom/a630_gmu.bin >> > > >> > > Signed, will work for any non-secured sdm845 device: >> > > - qcom/sdm845/a630_zap.mbn >> > > - qcom/sdm845/adsp.mbn >> > > - qcom/sdm845/cdsp.mbn >> > > - qcom/sdm485/mba.mbn >> > > - qcom/sdm845/modem.mbn >> > > - qcom/sdm845/wlanmdsp.mbn (loaded via TQFTP) >> > > - qcom/venus-5.2/venus.mbn >> > > >> > > Signed, works only for DB845c. >> > > - qcom/sdm845/Thundercomm/db845c/slpi.mbn >> > > >> > > In comparison, the SDM845 Pixel-3 phone (aka blueline) should load the >> > > following firmware files: >> > > - qcom/a630_sqe.fw (the same, non-signed file) >> > > - qcom/a630_gmu.bin (the same, non-signed file) >> > > - qcom/sdm845/Google/blueline/a630_zap.mbn >> > >> > How do you get from "a630_zap.mbn" to this? By extending the lookup >> > table for every target, or what am I missing? >> >> More or less so. Matching the root OF node gives us the firmware >> location, then it gets prepended to all firmware targets. Not an ideal >> solution, as there is no fallback support, but at least it gives us >> some points to discuss (and to decide whether to move to some >> particular direction or to abandon the idea completely, making Arnd >> unhappy again). >> > > I understand the desire to not put linux-firmware-specific paths in the > DeviceTree Me too. > but I think I'm less keen on having a big lookup table in the > kernel... Yeah, also for me this feels wrong. But on the other hand I don't have anything better to suggest either...
diff --git a/drivers/soc/qcom/Kconfig b/drivers/soc/qcom/Kconfig index 5af33b0e3470..b663774d65f8 100644 --- a/drivers/soc/qcom/Kconfig +++ b/drivers/soc/qcom/Kconfig @@ -62,6 +62,11 @@ config QCOM_MDT_LOADER tristate select QCOM_SCM +config QCOM_FW_HELPER + tristate "NONE FW HELPER" + help + Helpers to return platform-specific location for the firmware files. + config QCOM_OCMEM tristate "Qualcomm On Chip Memory (OCMEM) driver" depends on ARCH_QCOM diff --git a/drivers/soc/qcom/Makefile b/drivers/soc/qcom/Makefile index ca0bece0dfff..e612bee5b955 100644 --- a/drivers/soc/qcom/Makefile +++ b/drivers/soc/qcom/Makefile @@ -6,6 +6,7 @@ obj-$(CONFIG_QCOM_GENI_SE) += qcom-geni-se.o obj-$(CONFIG_QCOM_COMMAND_DB) += cmd-db.o obj-$(CONFIG_QCOM_GSBI) += qcom_gsbi.o obj-$(CONFIG_QCOM_MDT_LOADER) += mdt_loader.o +obj-$(CONFIG_QCOM_FW_HELPER) += qcom_fw_helper.o obj-$(CONFIG_QCOM_OCMEM) += ocmem.o obj-$(CONFIG_QCOM_PDR_HELPERS) += pdr_interface.o obj-$(CONFIG_QCOM_PMIC_GLINK) += pmic_glink.o diff --git a/drivers/soc/qcom/qcom_fw_helper.c b/drivers/soc/qcom/qcom_fw_helper.c new file mode 100644 index 000000000000..13123c2514b8 --- /dev/null +++ b/drivers/soc/qcom/qcom_fw_helper.c @@ -0,0 +1,86 @@ +// SPDX-License-Identifier: GPL-2.0-only +/* + * Qualcomm Firmware loading data + * + * Copyright (C) 2024 Linaro Ltd + */ + +#include <linux/cleanup.h> +#include <linux/device.h> +#include <linux/mutex.h> +#include <linux/of.h> +#include <linux/soc/qcom/fw_helper.h> + +static DEFINE_MUTEX(qcom_fw_mutex); +static const char *fw_path; + +static const struct of_device_id qcom_fw_paths[] = { + /* device-specific entries */ + { .compatible = "thundercomm,db845c", .data = "qcom/sdm845/Thundercomm/db845c", }, + { .compatible = "qcom,qrb5165-rb5", .data = "qcom/sm8250/Thundercomm/RB5", }, + /* SoC default entries */ + { .compatible = "qcom,apq8016", .data = "qcom/apq8016", }, + { .compatible = "qcom,apq8096", .data = "qcom/apq8096", }, + { .compatible = "qcom,sdm845", .data = "qcom/sdm845", }, + { .compatible = "qcom,sm8250", .data = "qcom/sm8250", }, + { .compatible = "qcom,sm8350", .data = "qcom/sm8350", }, + { .compatible = "qcom,sm8450", .data = "qcom/sm8450", }, + { .compatible = "qcom,sm8550", .data = "qcom/sm8550", }, + { .compatible = "qcom,sm8650", .data = "qcom/sm8650", }, + {}, +}; + +static int qcom_fw_ensure_init(void) +{ + const struct of_device_id *match; + struct device_node *root; + + if (fw_path) + return 0; + + root = of_find_node_by_path("/"); + if (!root) + return -ENODEV; + + match = of_match_node(qcom_fw_paths, root); + of_node_put(root); + if (!match || !match->data) { + pr_notice("Platform not supported by qcom_fw_helper\n"); + return -ENODEV; + } + + fw_path = match->data; + + return 0; +} + +const char *qcom_get_board_fw(const char *firmware) +{ + if (strchr(firmware, '/')) + return kstrdup(firmware, GFP_KERNEL); + + scoped_guard(mutex, &qcom_fw_mutex) { + if (!qcom_fw_ensure_init()) + return kasprintf(GFP_KERNEL, "%s/%s", fw_path, firmware); + } + + return kstrdup(firmware, GFP_KERNEL); +} +EXPORT_SYMBOL_GPL(qcom_get_board_fw); + +const char *devm_qcom_get_board_fw(struct device *dev, const char *firmware) +{ + if (strchr(firmware, '/')) + return devm_kstrdup(dev, firmware, GFP_KERNEL); + + scoped_guard(mutex, &qcom_fw_mutex) { + if (!qcom_fw_ensure_init()) + return devm_kasprintf(dev, GFP_KERNEL, "%s/%s", fw_path, firmware); + } + + return devm_kstrdup(dev, firmware, GFP_KERNEL); +} +EXPORT_SYMBOL_GPL(devm_qcom_get_board_fw); + +MODULE_DESCRIPTION("Firmware helpers for Qualcomm devices"); +MODULE_LICENSE("GPL"); diff --git a/include/linux/soc/qcom/fw_helper.h b/include/linux/soc/qcom/fw_helper.h new file mode 100644 index 000000000000..755645386bba --- /dev/null +++ b/include/linux/soc/qcom/fw_helper.h @@ -0,0 +1,10 @@ +/* SPDX-License-Identifier: GPL-2.0 */ +#ifndef __QCOM_FW_HELPER_H__ +#define __QCOM_FW_HELPER_H__ + +struct device; + +const char *qcom_get_board_fw(const char *firmware); +const char *devm_qcom_get_board_fw(struct device *dev, const char *firmware); + +#endif
Qualcomm platforms have different sets of the firmware files, which differ from platform to platform (and from board to board, due to the embedded signatures). Rather than listing all the firmware files, including full paths, in the DT, provide a way to determine firmware path based on the root DT node compatible. Suggested-by: Arnd Bergmann <arnd@arndb.de> Signed-off-by: Dmitry Baryshkov <dmitry.baryshkov@linaro.org> --- drivers/soc/qcom/Kconfig | 5 +++ drivers/soc/qcom/Makefile | 1 + drivers/soc/qcom/qcom_fw_helper.c | 86 ++++++++++++++++++++++++++++++++++++++ include/linux/soc/qcom/fw_helper.h | 10 +++++ 4 files changed, 102 insertions(+)