From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 0C7ACEE4993 for ; Wed, 23 Aug 2023 11:08:58 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S234370AbjHWLI6 (ORCPT ); Wed, 23 Aug 2023 07:08:58 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:46578 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S234350AbjHWLIw (ORCPT ); Wed, 23 Aug 2023 07:08:52 -0400 Received: from mx0b-0031df01.pphosted.com (mx0b-0031df01.pphosted.com [205.220.180.131]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 2EE0EE40; Wed, 23 Aug 2023 04:08:41 -0700 (PDT) Received: from pps.filterd (m0279872.ppops.net [127.0.0.1]) by mx0a-0031df01.pphosted.com (8.17.1.19/8.17.1.19) with ESMTP id 37N7AkV7002526; Wed, 23 Aug 2023 11:08:37 GMT DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=quicinc.com; h=message-id : date : mime-version : subject : to : cc : references : from : in-reply-to : content-type : content-transfer-encoding; s=qcppdkim1; bh=vErC/zKUfnaKaCDp/Sf4axOl7wuVQNyzAbjDvt8l3tc=; b=g32ARRxDUtGgTKArPbzkx3DJPmdLhyOIdbynOdfMm+piFAfxWxofEdet8QyaaD+DW+qe M/+Y8aVzauiG7NiIoZDK4iaAXFNs95nferg1X1eeKErFI/Fvw42jEze+9366djiSsAG9 +GZwE7B+kTbaMKdQsGvYr1cYfXpvBDdBmrdstaUgiPbaBZSHyrU5/BpMR5PANYQZ/H8v 9dR9HRP1W7CQ8kf/0reLUjRDuTGYWMLDQdCWpTSLbTgmi+Zqihko2BNRYukVgPO73kx7 I+x72iwl6Pvm4Ogj6zy4lBSGsBVry5mt/bDgB+xmGLW+j5gGTxudLTODpXZZ8mGweVAr YA== Received: from nalasppmta03.qualcomm.com (Global_NAT1.qualcomm.com [129.46.96.20]) by mx0a-0031df01.pphosted.com (PPS) with ESMTPS id 3sn25k9rvx-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT); Wed, 23 Aug 2023 11:08:36 +0000 Received: from nalasex01c.na.qualcomm.com (nalasex01c.na.qualcomm.com [10.47.97.35]) by NALASPPMTA03.qualcomm.com (8.17.1.5/8.17.1.5) with ESMTPS id 37NB8ZPV030300 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT); Wed, 23 Aug 2023 11:08:35 GMT Received: from [10.50.32.23] (10.80.80.8) by nalasex01c.na.qualcomm.com (10.47.97.35) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.2.1118.30; Wed, 23 Aug 2023 04:08:30 -0700 Message-ID: Date: Wed, 23 Aug 2023 16:38:27 +0530 MIME-Version: 1.0 User-Agent: Mozilla Thunderbird Subject: Re: [RFC PATCH 1/1] soc: qcom: Add driver to read secondary bootloader (XBL) log Content-Language: en-US To: Bryan O'Donoghue , , , CC: , , , , , References: <20230822121512.8631-1-quic_ninanaik@quicinc.com> <20230822121512.8631-2-quic_ninanaik@quicinc.com> <39ce6d07-7692-7194-b153-e73ba7fb687c@linaro.org> From: Ninad Naik In-Reply-To: <39ce6d07-7692-7194-b153-e73ba7fb687c@linaro.org> Content-Type: text/plain; charset="UTF-8"; format=flowed Content-Transfer-Encoding: 8bit X-Originating-IP: [10.80.80.8] X-ClientProxiedBy: nasanex01b.na.qualcomm.com (10.46.141.250) To nalasex01c.na.qualcomm.com (10.47.97.35) X-QCInternal: smtphost X-Proofpoint-Virus-Version: vendor=nai engine=6200 definitions=5800 signatures=585085 X-Proofpoint-ORIG-GUID: LxI1T4HHHUZiIQaUTWQwWRJ34M8h4pOC X-Proofpoint-GUID: LxI1T4HHHUZiIQaUTWQwWRJ34M8h4pOC X-Proofpoint-Virus-Version: vendor=baseguard engine=ICAP:2.0.267,Aquarius:18.0.957,Hydra:6.0.601,FMLib:17.11.176.26 definitions=2023-08-23_06,2023-08-22_01,2023-05-22_02 X-Proofpoint-Spam-Details: rule=outbound_notspam policy=outbound score=0 priorityscore=1501 adultscore=0 spamscore=0 suspectscore=0 phishscore=0 clxscore=1011 lowpriorityscore=0 bulkscore=0 mlxlogscore=999 malwarescore=0 impostorscore=0 mlxscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.12.0-2308100000 definitions=main-2308230101 Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Hi Bryan, On 8/22/2023 6:13 PM, Bryan O'Donoghue wrote: > On 22/08/2023 13:15, Ninad Naik wrote: >> Qualcomm secondary bootloader (XBL) boot log holds information to >> identify various firmware configuration currently set on the SoC. >> The XBL log is stored in a predefined reserved memory region. >> >> This drivers provides a way to print XBL logs on the console. To >> do so, it provides a debugfs entry which captures the logs stored >> in this reserved memory region. This entry can now be used to read >> and print the XBL logs to console. >> >> User can use the below command to print XBL log to console: >>          cat /sys/kernel/debug/xbl_log >> >> Signed-off-by: Ninad Naik >> --- >>   drivers/soc/qcom/Kconfig        |  13 +++ >>   drivers/soc/qcom/Makefile       |   1 + >>   drivers/soc/qcom/dump_xbl_log.c | 139 ++++++++++++++++++++++++++++++++ >>   3 files changed, 153 insertions(+) >>   create mode 100644 drivers/soc/qcom/dump_xbl_log.c >> >> diff --git a/drivers/soc/qcom/Kconfig b/drivers/soc/qcom/Kconfig >> index 715348869d04..4489d37e924d 100644 >> --- a/drivers/soc/qcom/Kconfig >> +++ b/drivers/soc/qcom/Kconfig >> @@ -291,4 +291,17 @@ config QCOM_INLINE_CRYPTO_ENGINE >>       tristate >>       select QCOM_SCM >> +config QCOM_DUMP_XBL_LOG >> +    tristate "Qualcomm driver to print XBL logs on console from debugfs" >> +    help >> +      This driver is used to capture secondary bootloader (xbl) log >> +      from a reserved memory region and provide a debugfs entry to read >> +      logs captured from this memory region and print them on console. >> +      User can use below command to print the xbl log on console: >> + >> +                cat /sys/kernel/debug/xbl_log >> + >> +      These logs help to identify firmware configuration information on >> +      the SoC. The name of the built module will be dump_xbl_log >> + >>   endmenu >> diff --git a/drivers/soc/qcom/Makefile b/drivers/soc/qcom/Makefile >> index bbca2e1e55bb..aac088a1a0b6 100644 >> --- a/drivers/soc/qcom/Makefile >> +++ b/drivers/soc/qcom/Makefile >> @@ -32,3 +32,4 @@ obj-$(CONFIG_QCOM_KRYO_L2_ACCESSORS) += >> kryo-l2-accessors.o >>   obj-$(CONFIG_QCOM_ICC_BWMON)    += icc-bwmon.o >>   qcom_ice-objs            += ice.o >>   obj-$(CONFIG_QCOM_INLINE_CRYPTO_ENGINE)    += qcom_ice.o >> +obj-$(CONFIG_QCOM_DUMP_XBL_LOG)    += dump_xbl_log.o >> diff --git a/drivers/soc/qcom/dump_xbl_log.c >> b/drivers/soc/qcom/dump_xbl_log.c >> new file mode 100644 >> index 000000000000..ea335a5e660b >> --- /dev/null >> +++ b/drivers/soc/qcom/dump_xbl_log.c >> @@ -0,0 +1,139 @@ >> +// SPDX-License-Identifier: GPL-2.0-only >> +/* >> + * Copyright (c) 2021, The Linux Foundation. All rights reserved. >> + */ > > 2023 > >> + >> +#include >> +#include >> +#include >> +#include >> +#include >> +#include >> +#include >> +#include >> +#include > > It would be nice to alphetise this include list. > Ack. Sure, I'll make this fix. Thank you. >> +struct xbl_log_data { >> +    struct device *dev; >> +    size_t buf_size; >> +    void __iomem *xbl_buf; >> +    struct dentry *dbg_file; >> +    struct debugfs_blob_wrapper dbg_data; >> +}; >> + >> +static int map_addr_range(struct device_node **parent, const char *name, >> +              struct xbl_log_data *xbl_data) >> +{ >> +    struct device_node *node; >> +    struct resource res; >> +    int ret; >> + >> +    node = of_find_node_by_name(*parent, name); >> +    if (!node) >> +        return -ENODEV; >> + >> +    ret = of_address_to_resource(node, 0, &res); >> +    if (ret) { >> +        dev_err(xbl_data->dev, "Failed to parse memory region\n"); >> +        return ret; >> +    } >> +    of_node_put(node); >> + >> +    if (!resource_size(&res)) { >> +        dev_err(xbl_data->dev, "Failed to parse memory region size\n"); >> +        return -ENODEV; >> +    } >> + >> +    xbl_data->buf_size = resource_size(&res) - 1; >> +    xbl_data->xbl_buf = devm_memremap(xbl_data->dev, res.start, >> +                      xbl_data->buf_size, MEMREMAP_WB); >> +    if (!xbl_data->xbl_buf) { >> +        dev_err(xbl_data->dev, "%s: memory remap failed\n", name); >> +        return -ENOMEM; >> +    } >> + >> +    return 0; >> +} >> + >> +static int xbl_log_probe(struct platform_device *pdev) >> +{ >> +    struct device *dev = &pdev->dev; >> +    struct xbl_log_data *xbl_data; >> +    struct device_node *parent; >> +    int ret; >> + >> +    xbl_data = devm_kzalloc(dev, sizeof(*xbl_data), GFP_KERNEL); >> +    if (!xbl_data) >> +        return -ENOMEM; >> + >> +    xbl_data->dev = &pdev->dev; >> +    platform_set_drvdata(pdev, xbl_data); >> + >> +    parent = of_find_node_by_path("/reserved-memory"); >> +    if (!parent) { >> +        dev_err(xbl_data->dev, "reserved-memory node missing\n"); >> +        return -ENODEV; >> +    } >> + >> +    ret = map_addr_range(&parent, "uefi-log", xbl_data); >> +    if (ret) >> +        goto put_node; >> + >> +    xbl_data->dbg_data.data = xbl_data->xbl_buf; >> +    xbl_data->dbg_data.size = xbl_data->buf_size; >> +    xbl_data->dbg_file = debugfs_create_blob("xbl_log", 0400, NULL, >> +                         &xbl_data->dbg_data); >> +    if (IS_ERR(xbl_data->dbg_file)) { >> +        dev_err(xbl_data->dev, "failed to create debugfs entry\n"); >> +        ret = PTR_ERR(xbl_data->dbg_file); >> +    } >> + >> +put_node: >> +    of_node_put(parent); >> +    return ret; >> +} >> + >> +static int xbl_log_remove(struct platform_device *pdev) >> +{ >> +    struct xbl_log_data *xbl_data = platform_get_drvdata(pdev); >> + >> +    debugfs_remove_recursive(xbl_data->dbg_file); >> +    return 0; >> +} >> + >> +static struct platform_driver xbl_log_driver = { >> +    .probe = xbl_log_probe, >> +    .remove = xbl_log_remove, >> +    .driver = { >> +           .name = "xbl-log", >> +           }, > Is that indentation correct ? > No, the closing parenthesis should be fixed. Will correct this, thank you. >> +}; >> + >> +static struct platform_device xbl_log_device = { >> +    .name = "xbl-log", >> +}; >> + >> +static int __init xbl_log_init(void) >> +{ >> +    int ret = 0; >> + >> +    ret = platform_driver_register(&xbl_log_driver); >> +    if (!ret) { >> +        ret = platform_device_register(&xbl_log_device); >> +        if (ret) >> +            platform_driver_unregister(&xbl_log_driver); >> +    } >> +    return ret; >> +} >> + >> +static void __exit xbl_log_exit(void) >> +{ >> +    platform_device_unregister(&xbl_log_device); >> +    platform_driver_unregister(&xbl_log_driver); >> +} >> + >> +module_init(xbl_log_init); >> +module_exit(xbl_log_exit); >> + >> +MODULE_DESCRIPTION("Qualcomm Technologies, Inc. (QTI) XBL log driver"); >> +MODULE_LICENSE("GPL"); > > --- > bod Thanks, Ninad