Message-ID: <542f9495-0216-a26e-3b53-5ccf419c8862@intel.com>
Date:   Tue, 7 Mar 2023 17:17:33 -0800
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:102.0) Gecko/20100101
 Firefox/102.0 Thunderbird/102.4.2
Subject: Re: [PATCH v3] firmware_loader: Add debug message with checksum for
 FW file
Content-Language: en-US
To:     =?UTF-8?Q?Amadeusz_S=c5=82awi=c5=84ski?= 
        <amadeuszx.slawinski@linux.intel.com>,
        Luis Chamberlain <mcgrof@kernel.org>,
        Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
        <linux-kernel@vger.kernel.org>
CC:     Cezary Rojewski <cezary.rojewski@intel.com>,
        "Rafael J . Wysocki" <rafael.j.wysocki@intel.com>
References: <20230302184651.2028184-1-amadeuszx.slawinski@linux.intel.com>
From:   Russ Weight <russell.h.weight@intel.com>
In-Reply-To: <20230302184651.2028184-1-amadeuszx.slawinski@linux.intel.com>
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: 8bit
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?c2k3QU9wejdPMVFmcXFIVXBGUXBsZTRlM240aVZXUmNxbWMwVFlTWFhKTzNn?=
 =?utf-8?B?UG1XQTJwcmVLQWR1dXJmeVVOaUpWRmU3VEFGNWhxU0QrbHVFYk54REVuWWNO?=
 =?utf-8?B?N3E5ZmtKOTBIdnlmdm5ZZkJERDk4Y3A4c1FUUm82R3ZpNkl5S3NlZHc1bitX?=
 =?utf-8?B?NGc5MUdxZW4xVXFSUWpzc2xENWorcmxKWVVBb1dYMi9HbnRIRW41bDZWNFRw?=
 =?utf-8?B?MWlpLzVHWHNtb3lIK28wVTN1a21jNmRJNTdwNE1HblliTVhLb0R5eWw4WTI5?=
 =?utf-8?B?dS9BWjUvUk9UTWxmN3FlSzBPa2VmYW5VYWlxL3pHRnRSVC9Bb3VGRkhLZUc4?=
 =?utf-8?B?S0Y2cDdmQzJzZXBWRmlyUVpzVDFNOVJzcGNuZXhyVnNwcnhGdlU3TXIwOFVv?=
 =?utf-8?B?RmNHcERpY1BDVmRTSGJGUnFuMjdEZzlVRmVaQkJkeUlWd0hVZzBYVnMzNmZG?=
 =?utf-8?B?eXU0VDBqa2xLbjEwMDVqVXhPY3JvbXVJSVY5VGgrbGNhK3JzM1ZvOERob2Fz?=
 =?utf-8?B?dE1IQ1Ura1NZZzlibW1hcGFzbkNDRGJOYXhPSXlhYlByQkdSQmdrNHJPcU5j?=
 =?utf-8?B?SEI2QU9IWkIwRG1pcHBBMjdUN21ua3JIblYwUmJmRi9wQ1N5WGZ2dFBEbnZH?=
 =?utf-8?B?WkFLa0p1ck1nVVUwWjJhWCtWc0RNdEV0a20zVFR2MWk3OGN4NzNkYzBRNFJt?=
 =?utf-8?B?Z2swVVQrMWNXbHRhTHEzVGxnOUJUNC9ucHFHU2xjNUordkJZN3BtVUt5RHZz?=
 =?utf-8?B?aW12VkczK1RYMTVaUGp5NXRGbTg2bEJJcmltMzNkeVdSQmdjZFBNQWpHRS9t?=
 =?utf-8?B?cHAwcStlVUxURW82elBFdUN4UzdWMFJBNVhoVGIyQUtiUjAwcWhYMDk3N3h2?=
 =?utf-8?B?Z1g4dldkblZRaFU5bjFOa2pnWENTTW5tanVvdHgwTkpJODdudVNTVkZrdEh3?=
 =?utf-8?B?cTdYK1czTW5xS1dHbmhnUmVIUndwZ0grOWpjUURWWnVYeXhXWjNGZkJJNC96?=
 =?utf-8?B?d2lXb0JPWGU5R20wdHhMVkg3TTd2SjF3YXVOTmxUSXg3ektZKzZxblllazl0?=
 =?utf-8?B?ekg2SXIvM1M4U2RvR2x4Sk9CaElrbHQ2MUJCS09VbW9qeGx4QlhNV083dURY?=
 =?utf-8?B?Z3hsR01IN1R5N2lkdHpIcUxkc3d6bmpiRWhQb1RxcVRnZ1hnbXJFbVViZ04y?=
 =?utf-8?B?bGxnMUROZ2Z2TktXdGZlcXBkRHlHUjFvTlBWYlB2WjJJVThNWDFXNDFtRXpZ?=
 =?utf-8?B?VUVHNkNFYVdjemIzZXhucVhobTlCdWhFenJaWFdjZGhTbUprUC9nbUtTdnNK?=
 =?utf-8?B?T1JoWm0rVmkzWTJVWE4zM2NHcDJYMVBWelRrNE1rdnhvTHk4T0QwdkdscXI0?=
 =?utf-8?B?WlFRZi8yREVoMVJtVE02VXBCT0cwRkI1Yy94SEFrNzFidmVGUjk5RjdHYm14?=
 =?utf-8?B?NHB0MjRGbGcwY0NjRU9ON3dqc3VDSHRDRWRWOW5sUkQvNU8zMnROYnFPVkJW?=
 =?utf-8?B?RVNiRlA5amJnS0tQU1ZRNUlST1lVNDlDc05HU0dHeUQ0VWt5djV2Q0ZsQ2dO?=
 =?utf-8?B?VXpoYWFrdmtuOC9KclJVTDNXWWVNWmpzMzlHZWtXakJCVjdiOGFFZExxSnFK?=
 =?utf-8?B?VmhJcVpWR2dCZ2JKNWlBRlE3cnBiU0tyOFlUbjJXc1JJSHBGdTV6b2kxUnBH?=
 =?utf-8?B?T2ZpM3FtSWdmR2RWcDQ4ZGh3Q011dmdjQ2ZaZmRBRCtrb2lqTDBLcE10Sm95?=
 =?utf-8?B?ZGZaNDJYVmVkSGpwbVBHS3BNdnRBRWdxTUxIWFhXM0dWd0JXekIrYlZzSUMw?=
 =?utf-8?B?Mi9mWGdiTnUzV1pwMldWSzFueHdIV3J3cmF4aU9OQmZ0TWJwZzJSSytDZzY2?=
 =?utf-8?B?VllRa0JCQkVZTXp4Vi8rS2QwYmtnRGtVRzVMRmxqaUtRQk1Yd001QzhxU1dx?=
 =?utf-8?B?NmxrWWlBdUVWWk0ySDFaSzNjMWNaNkNWOENHN3M3QjVrVWNvTmtLcUxsa3F6?=
 =?utf-8?B?UlIzQUtFSWNISjNsZS9hRFZSeW5oTG5sYVVSeE1odDE2ZmdJMjlNWFFLU1px?=
 =?utf-8?B?aGlGdXhta1JNekpySnV5TllVc2Q3Mko2WHdFRXFkTHBTQXRtQ1RTZGVrWkp1?=
 =?utf-8?B?b2dmUzJFZXg1bmptNTErRlY3OFZmT28yQzl3dGlhc0ExM3dhamNBM3FoaXBK?=
 =?utf-8?B?dEE9PQ==?=
X-MS-Exchange-CrossTenant-Network-Message-Id: 24d22b89-0973-4f2d-10b4-08db1f72e77e
X-MS-Exchange-CrossTenant-AuthSource: DM5PR11MB1899.namprd11.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 08 Mar 2023 01:17:37.5282
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 46c98d88-e344-4ed4-8496-4ed7712e255d
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: VrJJ/645jo6pZhgejD/JXsDOVnE4kelsCeJJdaOEGAmYhHS0P8yGRh0M1hlUWNrwntBmP//5nIrAvUQwoz4qUFLmzh4H/4T/XyzpJyUfyjA=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: CH0PR11MB5426
X-OriginatorOrg: intel.com
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org


On 3/2/23 10:46, Amadeusz Sławiński wrote:
> Enable dynamic-debug logging of firmware filenames and SHA256 checksums
> to clearly identify the firmware files that are loaded by the system.
>
> Example output:
> [   34.944619] firmware_class:_request_firmware: i915 0000:00:02.0: Loaded FW: i915/kbl_dmc_ver1_04.bin, sha256: 2cde41c3e5ad181423bcc3e98ff9c49f743c88f18646af4d0b3c3a9664b831a1
> [   48.155884] firmware_class:_request_firmware: snd_soc_avs 0000:00:1f.3: Loaded FW: intel/avs/cnl/dsp_basefw.bin, sha256: 43f6ac1b066e9bd0423d914960fbbdccb391af27d2b1da1085eee3ea8df0f357
> [   49.579540] firmware_class:_request_firmware: snd_soc_avs 0000:00:1f.3: Loaded FW: intel/avs/rt274-tplg.bin, sha256: 4b3580da96dc3d2c443ba20c6728d8b665fceb3ed57223c3a57582bbad8e2413
> [   49.798196] firmware_class:_request_firmware: snd_soc_avs 0000:00:1f.3: Loaded FW: intel/avs/hda-8086280c-tplg.bin, sha256: 5653172579b2be1b51fd69f5cf46e2bac8d63f2a1327924311c13b2f1fe6e601
> [   49.859627] firmware_class:_request_firmware: snd_soc_avs 0000:00:1f.3: Loaded FW: intel/avs/dmic-tplg.bin, sha256: 00fb7fbdb74683333400d7e46925dae60db448b88638efcca0b30215db9df63f
>
> Reviewed-by: Cezary Rojewski <cezary.rojewski@intel.com>
> Signed-off-by: Amadeusz Sławiński <amadeuszx.slawinski@linux.intel.com>
> ---
>
> Changes in v3:
>  * add DYNAMIC_DEBUG and FW_LOADER as dependencies before option can be
> enabled (kernel test robot)
>
> Changes in v2:
>  * allocate buffers (Greg)
>  * introduce CONFIG_ option to allow for CONFIG_CRYPTO and CONFIG_CRYPTO_SHA256
> dependencies without introducing circular dependency (Greg)
>  * add new line between includes and function name (Cezary)
>
> ---
>  drivers/base/firmware_loader/Kconfig | 12 +++++++
>  drivers/base/firmware_loader/main.c  | 48 +++++++++++++++++++++++++++-
>  2 files changed, 59 insertions(+), 1 deletion(-)
>
> diff --git a/drivers/base/firmware_loader/Kconfig b/drivers/base/firmware_loader/Kconfig
> index 5166b323a0f8..a2f8f75e0718 100644
> --- a/drivers/base/firmware_loader/Kconfig
> +++ b/drivers/base/firmware_loader/Kconfig
> @@ -3,6 +3,7 @@ menu "Firmware loader"
>  
>  config FW_LOADER
>  	tristate "Firmware loading facility" if EXPERT
> +	select FW_LOADER_DEBUG if DYNAMIC_DEBUG
>  	default y
>  	help
>  	  This enables the firmware loading facility in the kernel. The kernel
> @@ -24,6 +25,17 @@ config FW_LOADER
>  	  You also want to be sure to enable this built-in if you are going to
>  	  enable built-in firmware (CONFIG_EXTRA_FIRMWARE).
>  
> +config FW_LOADER_DEBUG
> +	bool "Additional debug logs"

This is the prompt that shows up when I do "make menuconfig". How about
something more descriptive?

"Log filenames and checksums for loaded firmware"

> +	depends on DYNAMIC_DEBUG
> +	depends on FW_LOADER
> +	depends on CRYPTO
> +	depends on CRYPTO_SHA256
> +	default FW_LOADER
> +	help
> +	  Select this if additional information about loaded firmware file in
> +	  form of sha256sum should be dumped.

How about:

"Select this option to log firmware filenames and SHA256 checksums to the
kernel log for each firmware file that is loaded."

Thanks,
- Russ

> +
>  if FW_LOADER
>  
>  config FW_LOADER_PAGED_BUF
> diff --git a/drivers/base/firmware_loader/main.c b/drivers/base/firmware_loader/main.c
> index 017c4cdb219e..b2c292ca95e8 100644
> --- a/drivers/base/firmware_loader/main.c
> +++ b/drivers/base/firmware_loader/main.c
> @@ -791,6 +791,50 @@ static void fw_abort_batch_reqs(struct firmware *fw)
>  	mutex_unlock(&fw_lock);
>  }
>  
> +#if defined(CONFIG_FW_LOADER_DEBUG)
> +#include <crypto/hash.h>
> +#include <crypto/sha2.h>
> +
> +static void fw_log_firmware_info(const struct firmware *fw, const char *name, struct device *device)
> +{
> +	struct shash_desc *shash;
> +	struct crypto_shash *alg;
> +	u8 *sha256buf;
> +	char *outbuf;
> +
> +	alg = crypto_alloc_shash("sha256", 0, 0);
> +	if (!alg)
> +		return;
> +
> +	sha256buf = kmalloc(SHA256_DIGEST_SIZE, GFP_KERNEL);
> +	outbuf = kmalloc(SHA256_BLOCK_SIZE + 1, GFP_KERNEL);
> +	shash = kmalloc(sizeof(*shash) + crypto_shash_descsize(alg), GFP_KERNEL);
> +	if (!sha256buf || !outbuf || !shash)
> +		goto out_free;
> +
> +	shash->tfm = alg;
> +
> +	if (crypto_shash_digest(shash, fw->data, fw->size, sha256buf) < 0)
> +		goto out_shash;
> +
> +	for (int i = 0; i < SHA256_DIGEST_SIZE; i++)
> +		sprintf(&outbuf[i * 2], "%02x", sha256buf[i]);
> +	outbuf[SHA256_BLOCK_SIZE] = 0;
> +	dev_dbg(device, "Loaded FW: %s, sha256: %s\n", name, outbuf);
> +
> +out_shash:
> +	crypto_free_shash(alg);
> +out_free:
> +	kfree(shash);
> +	kfree(outbuf);
> +	kfree(sha256buf);
> +}
> +#else
> +static void fw_log_firmware_info(const struct firmware *fw, const char *name,
> +				 struct device *device)
> +{}
> +#endif
> +
>  /* called from request_firmware() and request_firmware_work_func() */
>  static int
>  _request_firmware(const struct firmware **firmware_p, const char *name,
> @@ -861,11 +905,13 @@ _request_firmware(const struct firmware **firmware_p, const char *name,
>  	revert_creds(old_cred);
>  	put_cred(kern_cred);
>  
> - out:
> +out:
>  	if (ret < 0) {
>  		fw_abort_batch_reqs(fw);
>  		release_firmware(fw);
>  		fw = NULL;
> +	} else {
> +		fw_log_firmware_info(fw, name, device);
>  	}
>  
>  	*firmware_p = fw;