| Message ID | 5eeeb46e9b3f61656a37cb77c2ad6a04e383c16d.1680874520.git.quic_schowdhu@quicinc.com |
|---|---|
| State | New |
| Headers | show |
| Series | soc: qcom: boot_stats: Add driver support for boot_stats | expand |
On 4/7/2023 9:11 PM, Bjorn Andersson wrote: > On Fri, Apr 07, 2023 at 07:34:36PM +0530, Souradeep Chowdhury wrote: >> All of Qualcomm's proprietary Android boot-loaders capture boot time >> stats, like the time when the bootloader started execution and at what >> point the bootloader handed over control to the kernel etc. in the IMEM >> region. This information is captured in a specific format by this driver >> by mapping a structure to the IMEM memory region and then accessing the >> members of the structure to print the information. This information is >> useful in verifying if the existing boot KPIs have regressed or not. >> A sample log in SM8450(waipio) device is as follows:- >> >> KPI: Pre ABL Time = 3s >> KPI: ABL Time = 14s > > Why are these in whole seconds? This is to give a granular view of time. > >> KPI: Kernel MPM timestamp = 890206 > > And why is this presented in cycles? This timestamp is used as an intermediate value for calculating one of the KPIs. Can be changed to seconds as well for consistency. > >> >> The Module Power Manager(MPM) sleep counter starts ticking at the PBL >> stage and the timestamp generated by the sleep counter is logged by >> the Qualcomm proprietary bootloader(ABL) at two points-> First when it >> starts execution which is logged here as "Pre ABL Time" and the second >> when it is about to load the kernel logged as "ABL Time". Both are >> logged in the unit of seconds. > > We have a policy to not taint the kernel log with "useless" information, > for kernel developers this seems to add no value and for end users > there's no benefit to this. > >> The current kernel timestamp is >> printed by the boot_stats driver as well. >> > > Why? Same as stated above. > >> Signed-off-by: Souradeep Chowdhury <quic_schowdhu@quicinc.com> >> --- >> drivers/soc/qcom/Kconfig | 7 ++++ >> drivers/soc/qcom/Makefile | 1 + >> drivers/soc/qcom/boot_stats.c | 95 +++++++++++++++++++++++++++++++++++++++++++ >> 3 files changed, 103 insertions(+) >> create mode 100644 drivers/soc/qcom/boot_stats.c >> >> diff --git a/drivers/soc/qcom/Kconfig b/drivers/soc/qcom/Kconfig >> index d11bda2..2cfdbb7 100644 >> --- a/drivers/soc/qcom/Kconfig >> +++ b/drivers/soc/qcom/Kconfig >> @@ -79,6 +79,13 @@ config QCOM_DCC >> driver provides interface to configure DCC block and read back >> captured data from DCC's internal SRAM. >> >> +config QCOM_BOOTSTAT >> + tristate "Qualcomm Technologies, Boot Stat driver" >> + depends on ARCH_QCOM || COMPILE_TEST >> + help >> + This option enables driver for boot stats. Boot stat driver prints >> + the kernel bootloader information by accessing the imem region. >> + >> config QCOM_KRYO_L2_ACCESSORS >> bool >> depends on ARCH_QCOM && ARM64 || COMPILE_TEST >> diff --git a/drivers/soc/qcom/Makefile b/drivers/soc/qcom/Makefile >> index 3b92c6c..8a9d995 100644 >> --- a/drivers/soc/qcom/Makefile >> +++ b/drivers/soc/qcom/Makefile >> @@ -5,6 +5,7 @@ obj-$(CONFIG_QCOM_GENI_SE) += qcom-geni-se.o >> obj-$(CONFIG_QCOM_COMMAND_DB) += cmd-db.o >> obj-$(CONFIG_QCOM_CPR) += cpr.o >> obj-$(CONFIG_QCOM_DCC) += dcc.o >> +obj-$(CONFIG_QCOM_BOOTSTAT) += boot_stats_new.o > > Most other entries here are sorted alphabetically. Ack > >> obj-$(CONFIG_QCOM_GSBI) += qcom_gsbi.o >> obj-$(CONFIG_QCOM_MDT_LOADER) += mdt_loader.o >> obj-$(CONFIG_QCOM_OCMEM) += ocmem.o >> diff --git a/drivers/soc/qcom/boot_stats.c b/drivers/soc/qcom/boot_stats.c >> new file mode 100644 >> index 0000000..080e820 >> --- /dev/null >> +++ b/drivers/soc/qcom/boot_stats.c >> @@ -0,0 +1,95 @@ >> +// SPDX-License-Identifier: GPL-2.0-only >> +/* >> + * Copyright (c) 2013-2019, 2021 The Linux Foundation. All rights reserved. >> + * Copyright (c) 2023 Qualcomm Innovation Center, Inc. All rights reserved. >> + */ >> + >> +#include <linux/err.h> >> +#include <linux/io.h> >> +#include <linux/init.h> >> +#include <linux/kernel.h> >> +#include <linux/module.h> >> +#include <linux/of.h> >> +#include <linux/of_address.h> >> +#include <linux/platform_device.h> >> + >> +#define MPM_COUNTER_FREQ 32768 >> + >> +/** >> + * struct boot_stats - timestamp information related to boot stats >> + * @bootloader_start: Time for the starting point of the abl bootloader >> + * @bootloader_end: Time when the kernel starts loading from abl bootloader >> + */ >> +struct boot_stats { >> + u32 bootloader_start; >> + u32 bootloader_end; > > bootloader != abl Ack. Will change these names based on abl. > >> +} __packed; >> + >> +struct boot_stats __iomem *boot_stats; >> +void __iomem *mpm_counter_base; > > Why are these non-static global variables? This was removed as per the comment on version 1 of the patch. Will reinstate it. > >> + >> +static void print_boot_stats(void) >> +{ >> + u32 pre_abl_time = readl_relaxed(&boot_stats->bootloader_start) / MPM_COUNTER_FREQ; >> + u32 abl_time = readl_relaxed(&boot_stats->bootloader_end) / MPM_COUNTER_FREQ; >> + >> + pr_info("KPI: Pre ABL Time = %us\n", pre_abl_time); >> + pr_info("KPI: ABL Time = %us\n", abl_time); >> + pr_info("KPI: Kernel MPM timestamp = %u\n", readl_relaxed(mpm_counter_base)); > > This number is completely dependent on link order and other things in > happening in the kernel, so what trust do you give in this number going > up or down? > > As above, why is this presented in ticks? This is the sleep counter for module power manager unit which starts ticking from PBL stage, it will keep on ticking till the system shuts down. As mentioned above this timestamp value is used at an intermediate point for calculating one of the KPIs, we can change it to seconds for consistency. > >> +} >> + >> +static int boot_stats_probe(struct platform_device *pdev) >> +{ >> + struct device_node *np_mpm2; >> + struct device *boot_stat = &pdev->dev; >> + >> + boot_stats = of_iomap(boot_stat->of_node->child, 0); > > You can't just do ->child here, what if boot stats isn't the first item > in the list? Ack > >> + if (!boot_stats) >> + return dev_err_probe(&pdev->dev, -ENOMEM, >> + "failed to map imem region\n"); >> + >> + np_mpm2 = of_find_compatible_node(NULL, NULL, >> + "qcom,mpm2-sleep-counter"); >> + if (!np_mpm2) { >> + return dev_err_probe(&pdev->dev, -EINVAL, >> + "failed to get the counter node\n"); >> + } >> + >> + if (of_get_address(np_mpm2, 0, NULL, NULL)) { >> + mpm_counter_base = of_iomap(np_mpm2, 0); > > Isn't this region going to be also accessed by some sleep stats driver? Currently there is no sleep stat driver present for this upstream. > >> + if (!mpm_counter_base) { >> + return dev_err_probe(&pdev->dev, -ENOMEM, >> + "failed to map the counter\n"); >> + } >> + } >> + print_boot_stats(); > > You're done with your platform_device, and your two ioremap regions > here. But you're holding on to those 10kb of memory for the rest of the > systems runtime. Ack > >> + >> + return 0; >> +} >> + >> +static int boot_stats_remove(struct platform_device *pdev) >> +{ >> + iounmap(boot_stats); >> + iounmap(mpm_counter_base); >> + >> + return 0; >> +} >> + >> +static const struct of_device_id boot_stats_dt_match[] = { >> + { .compatible = "qcom,sm8450-imem" }, > > You're binding to the root imem node, rather than your boot stats child > node. Ack > > How about just exposing the boot stats imem region to userspace, through > debugfs or similar and then you can have a userspace tool that digs out > and reports this information when profiling is relevant? Ack. This can be exposed to user as a part of debugfs interface. > > Regards, > Bjorn > >> + { } >> +}; >> +MODULE_DEVICE_TABLE(of, boot_stats_dt_match); >> + >> +static struct platform_driver boot_stat_driver = { >> + .probe = boot_stats_probe, >> + .remove = boot_stats_remove, >> + .driver = { >> + .name = "qcom-boot-stats", >> + .of_match_table = boot_stats_dt_match, >> + }, >> +}; >> +module_platform_driver(boot_stat_driver); >> + >> +MODULE_DESCRIPTION("Qualcomm Technologies Inc. Boot Stat driver"); >> +MODULE_LICENSE("GPL"); >> -- >> 2.7.4 >>
On 4/12/2023 1:47 PM, Krzysztof Kozlowski wrote: > On 10/04/2023 08:48, Souradeep Chowdhury wrote: >> >> >> On 4/7/2023 9:11 PM, Bjorn Andersson wrote: >>> On Fri, Apr 07, 2023 at 07:34:36PM +0530, Souradeep Chowdhury wrote: >>>> All of Qualcomm's proprietary Android boot-loaders capture boot time >>>> stats, like the time when the bootloader started execution and at what >>>> point the bootloader handed over control to the kernel etc. in the IMEM >>>> region. This information is captured in a specific format by this driver >>>> by mapping a structure to the IMEM memory region and then accessing the >>>> members of the structure to print the information. This information is >>>> useful in verifying if the existing boot KPIs have regressed or not. >>>> A sample log in SM8450(waipio) device is as follows:- >>>> >>>> KPI: Pre ABL Time = 3s >>>> KPI: ABL Time = 14s >>> >>> Why are these in whole seconds? >> >> This is to give a granular view of time. >> >>> >>>> KPI: Kernel MPM timestamp = 890206 >>> >>> And why is this presented in cycles? >> >> This timestamp is used as an intermediate value for calculating one of >> the KPIs. Can be changed to seconds as well for consistency. >> >>> >>>> >>>> The Module Power Manager(MPM) sleep counter starts ticking at the PBL >>>> stage and the timestamp generated by the sleep counter is logged by >>>> the Qualcomm proprietary bootloader(ABL) at two points-> First when it >>>> starts execution which is logged here as "Pre ABL Time" and the second >>>> when it is about to load the kernel logged as "ABL Time". Both are >>>> logged in the unit of seconds. >>> >>> We have a policy to not taint the kernel log with "useless" information, >>> for kernel developers this seems to add no value and for end users >>> there's no benefit to this. >>> >>>> The current kernel timestamp is >>>> printed by the boot_stats driver as well. >>>> >>> >>> Why? >> >> Same as stated above. > > You did not answer. The question is "why do you think printing this > during boot is suitable for wide usage?". I don't find answer "give a > granular view of time" anyway related. > > Please come with rationale why such printing should be used in Linux > kernel at all, given that as Bjorn said - we do not print > debugging/profiling information. > > You should probably come with a debugfs interface for this. Ack. The debugfs interface for this will be present in the next version. > > Best regards, > Krzysztof >
On 4/12/2023 1:51 PM, Krzysztof Kozlowski wrote: > On 07/04/2023 16:04, Souradeep Chowdhury wrote: >> All of Qualcomm's proprietary Android boot-loaders capture boot time >> stats, like the time when the bootloader started execution and at what >> point the bootloader handed over control to the kernel etc. in the IMEM >> region. This information is captured in a specific format by this driver >> by mapping a structure to the IMEM memory region and then accessing the >> members of the structure to print the information. This information is >> useful in verifying if the existing boot KPIs have regressed or not. >> A sample log in SM8450(waipio) device is as follows:- >> > > >> + >> +static int boot_stats_probe(struct platform_device *pdev) >> +{ >> + struct device_node *np_mpm2; >> + struct device *boot_stat = &pdev->dev; >> + >> + boot_stats = of_iomap(boot_stat->of_node->child, 0); >> + if (!boot_stats) >> + return dev_err_probe(&pdev->dev, -ENOMEM, >> + "failed to map imem region\n"); >> + >> + np_mpm2 = of_find_compatible_node(NULL, NULL, >> + "qcom,mpm2-sleep-counter"); > > This is undocumented and non-existing compatible. No, we cannot take this. > > Also, referencing other nodes should be with phandles, not compatibles. Ack. This will be dropped in the next version as we are not printing the current kernel timestamp. > > > Best regards, > Krzysztof >
diff --git a/drivers/soc/qcom/Kconfig b/drivers/soc/qcom/Kconfig index d11bda2..2cfdbb7 100644 --- a/drivers/soc/qcom/Kconfig +++ b/drivers/soc/qcom/Kconfig @@ -79,6 +79,13 @@ config QCOM_DCC driver provides interface to configure DCC block and read back captured data from DCC's internal SRAM. +config QCOM_BOOTSTAT + tristate "Qualcomm Technologies, Boot Stat driver" + depends on ARCH_QCOM || COMPILE_TEST + help + This option enables driver for boot stats. Boot stat driver prints + the kernel bootloader information by accessing the imem region. + config QCOM_KRYO_L2_ACCESSORS bool depends on ARCH_QCOM && ARM64 || COMPILE_TEST diff --git a/drivers/soc/qcom/Makefile b/drivers/soc/qcom/Makefile index 3b92c6c..8a9d995 100644 --- a/drivers/soc/qcom/Makefile +++ b/drivers/soc/qcom/Makefile @@ -5,6 +5,7 @@ obj-$(CONFIG_QCOM_GENI_SE) += qcom-geni-se.o obj-$(CONFIG_QCOM_COMMAND_DB) += cmd-db.o obj-$(CONFIG_QCOM_CPR) += cpr.o obj-$(CONFIG_QCOM_DCC) += dcc.o +obj-$(CONFIG_QCOM_BOOTSTAT) += boot_stats_new.o obj-$(CONFIG_QCOM_GSBI) += qcom_gsbi.o obj-$(CONFIG_QCOM_MDT_LOADER) += mdt_loader.o obj-$(CONFIG_QCOM_OCMEM) += ocmem.o diff --git a/drivers/soc/qcom/boot_stats.c b/drivers/soc/qcom/boot_stats.c new file mode 100644 index 0000000..080e820 --- /dev/null +++ b/drivers/soc/qcom/boot_stats.c @@ -0,0 +1,95 @@ +// SPDX-License-Identifier: GPL-2.0-only +/* + * Copyright (c) 2013-2019, 2021 The Linux Foundation. All rights reserved. + * Copyright (c) 2023 Qualcomm Innovation Center, Inc. All rights reserved. + */ + +#include <linux/err.h> +#include <linux/io.h> +#include <linux/init.h> +#include <linux/kernel.h> +#include <linux/module.h> +#include <linux/of.h> +#include <linux/of_address.h> +#include <linux/platform_device.h> + +#define MPM_COUNTER_FREQ 32768 + +/** + * struct boot_stats - timestamp information related to boot stats + * @bootloader_start: Time for the starting point of the abl bootloader + * @bootloader_end: Time when the kernel starts loading from abl bootloader + */ +struct boot_stats { + u32 bootloader_start; + u32 bootloader_end; +} __packed; + +struct boot_stats __iomem *boot_stats; +void __iomem *mpm_counter_base; + +static void print_boot_stats(void) +{ + u32 pre_abl_time = readl_relaxed(&boot_stats->bootloader_start) / MPM_COUNTER_FREQ; + u32 abl_time = readl_relaxed(&boot_stats->bootloader_end) / MPM_COUNTER_FREQ; + + pr_info("KPI: Pre ABL Time = %us\n", pre_abl_time); + pr_info("KPI: ABL Time = %us\n", abl_time); + pr_info("KPI: Kernel MPM timestamp = %u\n", readl_relaxed(mpm_counter_base)); +} + +static int boot_stats_probe(struct platform_device *pdev) +{ + struct device_node *np_mpm2; + struct device *boot_stat = &pdev->dev; + + boot_stats = of_iomap(boot_stat->of_node->child, 0); + if (!boot_stats) + return dev_err_probe(&pdev->dev, -ENOMEM, + "failed to map imem region\n"); + + np_mpm2 = of_find_compatible_node(NULL, NULL, + "qcom,mpm2-sleep-counter"); + if (!np_mpm2) { + return dev_err_probe(&pdev->dev, -EINVAL, + "failed to get the counter node\n"); + } + + if (of_get_address(np_mpm2, 0, NULL, NULL)) { + mpm_counter_base = of_iomap(np_mpm2, 0); + if (!mpm_counter_base) { + return dev_err_probe(&pdev->dev, -ENOMEM, + "failed to map the counter\n"); + } + } + print_boot_stats(); + + return 0; +} + +static int boot_stats_remove(struct platform_device *pdev) +{ + iounmap(boot_stats); + iounmap(mpm_counter_base); + + return 0; +} + +static const struct of_device_id boot_stats_dt_match[] = { + { .compatible = "qcom,sm8450-imem" }, + { } +}; +MODULE_DEVICE_TABLE(of, boot_stats_dt_match); + +static struct platform_driver boot_stat_driver = { + .probe = boot_stats_probe, + .remove = boot_stats_remove, + .driver = { + .name = "qcom-boot-stats", + .of_match_table = boot_stats_dt_match, + }, +}; +module_platform_driver(boot_stat_driver); + +MODULE_DESCRIPTION("Qualcomm Technologies Inc. Boot Stat driver"); +MODULE_LICENSE("GPL");
All of Qualcomm's proprietary Android boot-loaders capture boot time stats, like the time when the bootloader started execution and at what point the bootloader handed over control to the kernel etc. in the IMEM region. This information is captured in a specific format by this driver by mapping a structure to the IMEM memory region and then accessing the members of the structure to print the information. This information is useful in verifying if the existing boot KPIs have regressed or not. A sample log in SM8450(waipio) device is as follows:- KPI: Pre ABL Time = 3s KPI: ABL Time = 14s KPI: Kernel MPM timestamp = 890206 The Module Power Manager(MPM) sleep counter starts ticking at the PBL stage and the timestamp generated by the sleep counter is logged by the Qualcomm proprietary bootloader(ABL) at two points-> First when it starts execution which is logged here as "Pre ABL Time" and the second when it is about to load the kernel logged as "ABL Time". Both are logged in the unit of seconds. The current kernel timestamp is printed by the boot_stats driver as well. Signed-off-by: Souradeep Chowdhury <quic_schowdhu@quicinc.com> --- drivers/soc/qcom/Kconfig | 7 ++++ drivers/soc/qcom/Makefile | 1 + drivers/soc/qcom/boot_stats.c | 95 +++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 103 insertions(+) create mode 100644 drivers/soc/qcom/boot_stats.c