Message-ID: <a6f3d850-7cd6-2834-48e6-8ecaa445122a@intel.com>
Date:   Fri, 10 Mar 2023 09:30:50 -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 v4] 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: <20230310140459.2972793-1-amadeuszx.slawinski@linux.intel.com>
From:   Russ Weight <russell.h.weight@intel.com>
In-Reply-To: <20230310140459.2972793-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?R1orZDVPZXF1RzU0MTR3TlFmdHdNQnpCcFJNN25TSU1TZGppWTdxQjQxRXBv?=
 =?utf-8?B?QjBGNy9nU0VYYnBQRkpNVk1HQWRBVk9oVmNFVlNMQ0U4NUNKdVM2ZG9aR0sv?=
 =?utf-8?B?OUF3Sm8yamoweUJ1alREeTNsQW82aTJVVXpyMXdyRmt1UTJCZWJQSWpYZElk?=
 =?utf-8?B?THM3UlVWajNFN1NqREdaVVozMHdpbkUycjlGeTJCdU4rK3VkdGpENE4yMXR1?=
 =?utf-8?B?V3VQWXRzbHExSndobFhIb3IvR2lGMVRGOGxUT0c5ZTNJMFhRbjg1bmlxL3Zr?=
 =?utf-8?B?QS81a0dpSlhwYTkwUmJhWE9sZWlxVzRrSkpNSkd2QzcvNWhmdGhQcGJiNWRT?=
 =?utf-8?B?Njc3SE50TjZES2UwSEl6WXJCc1pIT1JYU3BTMVFWckdMbkhVeHJVNmZFdHE4?=
 =?utf-8?B?b3VVNGZGSGkyclpvbTgrNllyMEdrVURXVU9keklpUEZuSW56M0p6RUtRNHdk?=
 =?utf-8?B?Wm1waFI2cUxMVWU2UjJxZjFYQXh5VlFVdDlPRHZpRUM2K21XZXFydk8rZGI1?=
 =?utf-8?B?RjEvQ1ZwaUlyV3lNTmNpN2dPSE94bTI4V1FobTBocC81a3NXTkJCYlppN0xq?=
 =?utf-8?B?bE5VSld5NGNSNE1seFVYNzFQZXNNUkdIWVpjeEZBSVhjSUxvSXo4aHZ2QjZn?=
 =?utf-8?B?TWhyRW14ZVFTd0VlN0RDcFUyU21pYlBpWjl2aE9rd3MrNnR3Skd3N0R4S1Jv?=
 =?utf-8?B?MDRjL3dNYWFqRDZvOGVaVi9YVVp6dW9JdEZ2YmFhUFY4ZTE3Y0lsZkUyTW5n?=
 =?utf-8?B?dGlobnF3VlVUZHNFWE04c1FqMS9ub0NUS2ZvMFVnY20xRU9ib01DSlhqQU1r?=
 =?utf-8?B?WHM1OUNWNDZsY2crOE82OW9kRnYrbUcweHhLWm5tWmRDay8vcE5seUhYL1l4?=
 =?utf-8?B?dXZSbWhOWThjL2EzRU9NbjZCWHR4eUQvNGUzbzhWVlZ3eGR6S1cvREZ3T1F1?=
 =?utf-8?B?SFpmUU53cXJ0bk5hOHFPYXlIb0g4a3k2emt2UzRzMldVUnNkY1dFeER4bEJO?=
 =?utf-8?B?TFJFeXFvOUpBVExHRjBhRVFqci96eTdmSUNZdGRoSjAwYmZ5TmpRYVJrYldE?=
 =?utf-8?B?WVRITUVyeWJCV0k3WUVxQjZqSkpROTlTaDN0c0phWEpBdlNIdVdRK2dneGxF?=
 =?utf-8?B?NXQwOHJpT0VsLzBIb3NRKzkvTVJpUjV6dXUyM0F3MEtOMWh2OTNIaHFqOVh3?=
 =?utf-8?B?OHFzQ3F1NHluN1podWoxdkpHOGVIV1FRSkFJWWswVkdJVkh4akRNNzVFTFYr?=
 =?utf-8?B?Rnh0aEYxbWdMODdJYzJISThJK1ZNSkRxd0l5Rko5V0VFL01oV2p4L0t0UTFm?=
 =?utf-8?B?VUE4WEcxbG1UZlMrQnBwQ3EwampPTUxHMUNEeW9uWGF2ZUF1bytDaDg0NXhV?=
 =?utf-8?B?VXc2amNKTjE5a3ZmdW5yNEZvSSt6bnA3Q1EzejUybVUvZFErZURISXBDRWx0?=
 =?utf-8?B?cC96OHFHeEIvK3dnNXg2V21lV056c0RDUEp0U2ZjM2NLRHZ4ZWx4RzdSRjdw?=
 =?utf-8?B?QkxHc0hwZ241a1JvMUNFRlpDd2xYZk9EaFovVVpNcFpRU3ExYzhUUU9oMmxP?=
 =?utf-8?B?VzByS2FqU2hMdFVHVVBlMXdjdDlLUW1QNVZ6RGNaNmdseldrK2UzcHhneHVm?=
 =?utf-8?B?ZDJTNFgrd2VKZmZJQ2FVamRaM1JvWHVCT0hQbXZ3TU90VHVUTHR1QklSWWJv?=
 =?utf-8?B?OHoraTJvU2R6WlVjT0FZdjBVMnZTWVp1MHdXTE5QaXJQRFFvc0hTSEhuVjRh?=
 =?utf-8?B?eExHMVh4alJGSVU0NTByNEkrdTNiVjk5c214ajNocXkrcVlrNUlIRTArUXBE?=
 =?utf-8?B?NDVYTU9ndlFtUUpvY2dEQThVS05CUGJXL3NzOXFQWGp2V1RqazZENFdUa3pk?=
 =?utf-8?B?dENKSWZFRGNoTkpiYWEyWE5obkdBK1BYVUxFUndxY012SjhRUDduYXZtV2Y3?=
 =?utf-8?B?QnpXL2x4OEUxSXUzMGJZbVpscXE5OFpIeGxRb0hBVlJsTHFQWnJicGdRM01i?=
 =?utf-8?B?OW9IbGZ0cE5GREloV09NV1BnMXpEdGUwMEtHcTN1OFJJa0pYeTdHTFRnWkY3?=
 =?utf-8?B?dTVZMmFQMzQxYmpDRDczV2Nwc1V6aFh5TmVZTmhiQ05rQUZUOUMwLzBXa29n?=
 =?utf-8?B?c3dZQktPUm15TUltZ3MxL1pxQkZtN2txSHBEZWd5WG1yV2VYNldXNXhzbEFO?=
 =?utf-8?B?bkE9PQ==?=
X-MS-Exchange-CrossTenant-Network-Message-Id: d2c63c5d-34c7-442d-3e55-08db218d3417
X-MS-Exchange-CrossTenant-AuthSource: DM5PR11MB1899.namprd11.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 10 Mar 2023 17:30:55.2940
 (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: gk2s9kDKfp2g6pfH4RFsWlI6wj24cI36kQ9PQC8vXo/uxWocMJBcj0oNG7KRmZ+wMHQQO4rm3OvsBASw1Aygbd8nv0LmUqx4VrKEzlJsKCY=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: CY5PR11MB6308
X-OriginatorOrg: intel.com
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org


On 3/10/23 06:04, 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>

Reviewed-by: Russ Weight <russell.h.weight@intel.com>
> Signed-off-by: Amadeusz Sławiński <amadeuszx.slawinski@linux.intel.com>
> ---
>
> Changes in v4:
>  * update menuconfig prompt and help message (Russ)
>
> 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 | 13 ++++++++
>  drivers/base/firmware_loader/main.c  | 48 +++++++++++++++++++++++++++-
>  2 files changed, 60 insertions(+), 1 deletion(-)
>
> diff --git a/drivers/base/firmware_loader/Kconfig b/drivers/base/firmware_loader/Kconfig
> index 5166b323a0f8..6520e8c9cb38 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,18 @@ 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 "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 option to use dynamic debug to log firmware filenames and
> +	  SHA256 checksums to the kernel log for each firmware file that is
> +	  loaded.
> +
>  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;