Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Message-ID: <b3304913-e6f4-3f87-e4f9-b31374682d2a@amd.com>
Date:   Wed, 4 Jan 2023 23:23:25 -0600
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:102.0) Gecko/20100101
 Thunderbird/102.5.1
Subject: Re: [PATCH v6 05/45] drm/amd: Add a new helper for loading/validating
 microcode
To:     "Lazar, Lijo" <lijo.lazar@amd.com>,
        Alex Deucher <alexander.deucher@amd.com>,
        linux-kernel@vger.kernel.org
Cc:     Javier Martinez Canillas <javierm@redhat.com>,
        Carlos Soriano Sanchez <csoriano@redhat.com>,
        amd-gfx@lists.freedesktop.org, dri-devel@lists.freedesktop.org,
        David Airlie <airlied@gmail.com>,
        Daniel Vetter <daniel@ffwll.ch>, christian.koenig@amd.com,
        "Pan, Xinhui" <Xinhui.Pan@amd.com>
References: <20230105034327.1439-1-mario.limonciello@amd.com>
 <20230105034327.1439-6-mario.limonciello@amd.com>
 <804491f0-6e83-dae5-f108-f80950838a52@amd.com>
Content-Language: en-US
From:   Mario Limonciello <mario.limonciello@amd.com>
In-Reply-To: <804491f0-6e83-dae5-f108-f80950838a52@amd.com>
Content-Type: text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding: 8bit
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?VERoQlRmR2QxZGo2SFFoS244cHBFOXIwQmU4WDZwd1NpTzVuL3lpVEJ3Qm1m?=
 =?utf-8?B?QjJGeVdHcHNnd1pGOExDeU1DZHlxMzZwRW5jZVV3dzZyV2JrOWJlQlkxTnBG?=
 =?utf-8?B?eCtLRmxmbUtJdDBqVnppSG5vQ25nUVB2V2V1N09MN0xzSVE1Zlh1b0V6YTBB?=
 =?utf-8?B?c2FHc1BGdTVyaGR0ZEllOFRxU3RETlhrRVdhMnlqUWE1N1lKYzNOMm55ZkhV?=
 =?utf-8?B?TnBuSTdjOW9Hb0MwVEx3STRTWWs2RUhvSHRQcVBqSE1mU2ZkQTJObEh2c2VN?=
 =?utf-8?B?UUdUK0R3Tkcrb1JLRWovKzY1V0UwOW5BTUZvRVlJRGoyQ2R5QkoxR2JaUUxl?=
 =?utf-8?B?eld0Nk52SVpPOVJaeWZ5VGhuYzI5ZDNTVktiaXhzUEZjODV1NUQ3T3d0UnRH?=
 =?utf-8?B?ZHExQURMc2QzRXZNcXNjRDBNeTQ3dHNOWXhTcnEvdjlJTWxHYVNHcmwrN2xS?=
 =?utf-8?B?QWxVdmlRRWF4dysycWNQYlM2K3FnUjR2cVVieDB6eEd4SFFXRDhHVFFRRmZJ?=
 =?utf-8?B?WTV3dFBEMnRMeXVRQklRUkhreFk4UUhhK1JmM3FQRnpGZnZKT0JmN1JZODJU?=
 =?utf-8?B?UGlUQlF1WjNkSmw5SXdtcEQ2NmVQcS9rcU02aUkxZVFvUG1xQkxkd3VDUUQz?=
 =?utf-8?B?anVQb2tnWnBHSkZROWJZWUxZMUNzUW15Q0IvejNNSXhHVlNpaURoZWM3T21o?=
 =?utf-8?B?MlA1ZWNXZEdvYVZ5aGxUcDBsS2hQb056RXF4eGVGS1dLWCtFdHVHdGlQL2ta?=
 =?utf-8?B?ZnFiYjZWQkpPb3VETzVFRmRtVmJJbUtMc2hsY0p4SDRjck5nZ3B4NnRha1M4?=
 =?utf-8?B?VWpDcjFqanVGOG5MdGt4bFZzMU5jc3VTUk9PVWh4VDhBVHg2RlBQODFidVYv?=
 =?utf-8?B?azB3R09wcnBPMmtwQktGMHBMVFRpcGVHRCtrM3FOdlJicDFKR1A1RDFsOWc5?=
 =?utf-8?B?UnZoWm9jd1RndmI5b1BVZU5NK1dCWHVaRzJEWStTOExkVUJGek00WHdEbnZw?=
 =?utf-8?B?bDNxUVU2TW1RRmJObTN4SVZGS092THZQUmM4cHVqdUpvMUkydWpJWFMzUVZR?=
 =?utf-8?B?TGRJNkZXeGZiUjlCVlVJRXFGNlIzZGdVNzc1SFdKUW5KQVNwc3gvdFZtOUVS?=
 =?utf-8?B?T2tpUE9iSDkyajJ4aTBsQlFIdEt5cEZyRXMvYk8zQzdLSkZZYzB1N05PQ2lK?=
 =?utf-8?B?UHJSMjZZOE1PS0tqQ1pYbkRTTk9vanJrOWpERzlkTVlocWdNVFc3UVkzZjJz?=
 =?utf-8?B?S3h3RU9oWGdrV3FlRUFIdFZKakpPZjJpSFo0eUZvcXlISDhwSHNUVjJ0MHhp?=
 =?utf-8?B?K3JhVUI4aEhKL1dCQzdwc3BpNEJwb1dDTkVDODNPY0YxNmltSEhkVTRlMGpw?=
 =?utf-8?B?dXJjL1RzU1Z5TmVUSFh2bjZjb01abnFJS1lBUFFjd0taaXl5UGswWmhmUUVt?=
 =?utf-8?B?bm9kdjVXenVZd3VGS0JuTVdBcGxNdEN0aGI0K1ZFbmp2QjJyNFhNK3RKaHFi?=
 =?utf-8?B?Q0FmMW9xT2tVc2JSdU4xaHFLZ2hvcEl3UUxUK01sTTRwc2RxMHI1UDExSTdy?=
 =?utf-8?B?N2g4dzJEUHozcDBnREtsUWgyYkRIcHlFUUtkNFJBSDZlMUJ5L29YVTRsMVdE?=
 =?utf-8?B?SWlmdVVsUkZuaHhTVXlSVGZtalo1ZkFVUXBZZ0R5MUtRZjFtQ29ncWpZVFdQ?=
 =?utf-8?B?LzVGYUtVNlhrWCtqNVZwdmNhdG5GMEh6N2hMdWlyOHludXd2Sk5XUkJhNW5o?=
 =?utf-8?B?b2w4Mkh6RUFSVm1paFl3ZXhHRzd0aTFMZlR3Zk9lTkRpcmlBc3QwOVZ1Y2NG?=
 =?utf-8?B?SFAvdTdhNG9GK1BzZlVxSWQ2Ym91UVBHV0pkcm9qWDRiMGFOSUN0M0hMaVdy?=
 =?utf-8?B?cHN6UjFwaytPZEhUYU1RY1p4OS9WdlY1Tmp6MzFlallKTHNSWGRLRzdaN1Bn?=
 =?utf-8?B?cldsRFkxM3JkM0xqbVdhenFPK2s4bGh6WllIWTJEcXBqNjdCdlpoUUNzVHFh?=
 =?utf-8?B?eTZxSlB3d0tSSkxCSVQzTTJXcjVQUXRkWnNJbDJGUVdUcy9PVXB5ZjR6c2pr?=
 =?utf-8?B?RURDd01WUU5LUHpaN3Zuc3VGb0VEQzVYSnhhZU1UeFQ4TGRBWHlpYWtvYTNF?=
 =?utf-8?B?dHBpazdCUk1LbzlhSVRGUkRsd09Fb1ZYeW1PSUpDTDJCRkFHMlVzTXdaYjBm?=
 =?utf-8?Q?43hIvQ/BB7gmKnP5uA8tcW7SZ31nUeeDSMIJyOI+Mg4N?=
X-OriginatorOrg: amd.com
X-MS-Exchange-CrossTenant-Network-Message-Id: cfde1117-b92c-458f-c241-08daeedcf9bd
X-MS-Exchange-CrossTenant-AuthSource: MN0PR12MB6101.namprd12.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 05 Jan 2023 05:23:27.7618
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 3dd8961f-e488-4e60-8e11-a82d994e183d
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: vOXqo1IStMxTfeDUkCu1yEaWX8QTL7+nsIka/A56PwgZiD2lKcVmAWv7oVMCtH8/Pr9zVnPIxe+cvuMJUDTy+A==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: DM4PR12MB5796
X-Spam-Status: No, score=-3.8 required=5.0 tests=BAYES_00,DKIM_SIGNED,
        DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,NICE_REPLY_A,RCVD_IN_DNSWL_NONE,
        RCVD_IN_MSPIKE_H2,SPF_HELO_PASS,SPF_PASS autolearn=ham
        autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on
        lindbergh.monkeyblade.net
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

On 1/4/23 23:07, Lazar, Lijo wrote:
> 
> 
> On 1/5/2023 9:12 AM, Mario Limonciello wrote:
>> All microcode runs a basic validation after it's been loaded. Each
>> IP block as part of init will run both.
>>
>> Introduce a wrapper for request_firmware and amdgpu_ucode_validate.
>> This wrapper will also remap any error codes from request_firmware
>> to -ENODEV.  This is so that early_init will fail if firmware couldn't
>> be loaded instead of the IP block being disabled.
>>
>> Signed-off-by: Mario Limonciello <mario.limonciello@amd.com>
>> ---
>> v5->v6:
>>   * Fix argument to be ** not *
>> ---
>>   drivers/gpu/drm/amd/amdgpu/amdgpu_ucode.c | 36 +++++++++++++++++++++++
>>   drivers/gpu/drm/amd/amdgpu/amdgpu_ucode.h |  3 ++
>>   2 files changed, 39 insertions(+)
>>
>> diff --git a/drivers/gpu/drm/amd/amdgpu/amdgpu_ucode.c 
>> b/drivers/gpu/drm/amd/amdgpu/amdgpu_ucode.c
>> index eafcddce58d3..8ebfec12da87 100644
>> --- a/drivers/gpu/drm/amd/amdgpu/amdgpu_ucode.c
>> +++ b/drivers/gpu/drm/amd/amdgpu/amdgpu_ucode.c
>> @@ -1312,3 +1312,39 @@ void amdgpu_ucode_ip_version_decode(struct 
>> amdgpu_device *adev, int block_type,
>>       snprintf(ucode_prefix, len, "%s_%d_%d_%d", ip_name, maj, min, rev);
>>   }
>> +
>> +/*
>> + * amdgpu_ucode_request - Fetch and validate amdgpu microcode
>> + *
>> + * @adev: amdgpu device
>> + * @fw: pointer to load firmware to
>> + * @fw_name: firmware to load
>> + *
>> + * This is a helper that will use request_firmware and 
>> amdgpu_ucode_validate
>> + * to load and run basic validation on firmware. If the load fails, 
>> remap
>> + * the error code to -ENODEV, so that early_init functions will fail 
>> to load.
>> + */
>> +int amdgpu_ucode_request(struct amdgpu_device *adev, const struct 
>> firmware **fw,
>> +             const char *fw_name)
>> +{
>> +    int err = request_firmware(fw, fw_name, adev->dev);
>> +
>> +    if (err)
>> +        return -ENODEV;
>> +    err = amdgpu_ucode_validate(*fw);
>> +    if (err)
>> +        dev_dbg(adev->dev, "\"%s\" failed to validate\n", fw_name);
>> +
> 
> Missed this earlier. If validate fails, shouldn't this undo the request 
> operation by calling release?

Actually that was original design, but there is one place in the 
codebase that expects that ucode validation can fail, and so leave the 
evaluate of error code and cleanup outside of helper.

> 
> Thanks,
> Lijo
> 
>> +    return err;
>> +}
>> +
>> +/*
>> + * amdgpu_ucode_release - Release firmware microcode
>> + *
>> + * @fw: pointer to firmware to release
>> + */
>> +void amdgpu_ucode_release(const struct firmware **fw)
>> +{
>> +    release_firmware(*fw);
>> +    *fw = NULL;
>> +}
>> diff --git a/drivers/gpu/drm/amd/amdgpu/amdgpu_ucode.h 
>> b/drivers/gpu/drm/amd/amdgpu/amdgpu_ucode.h
>> index 552e06929229..848579d4988b 100644
>> --- a/drivers/gpu/drm/amd/amdgpu/amdgpu_ucode.h
>> +++ b/drivers/gpu/drm/amd/amdgpu/amdgpu_ucode.h
>> @@ -544,6 +544,9 @@ void amdgpu_ucode_print_sdma_hdr(const struct 
>> common_firmware_header *hdr);
>>   void amdgpu_ucode_print_psp_hdr(const struct common_firmware_header 
>> *hdr);
>>   void amdgpu_ucode_print_gpu_info_hdr(const struct 
>> common_firmware_header *hdr);
>>   int amdgpu_ucode_validate(const struct firmware *fw);
>> +int amdgpu_ucode_request(struct amdgpu_device *adev, const struct 
>> firmware **fw,
>> +             const char *fw_name);
>> +void amdgpu_ucode_release(const struct firmware **fw);
>>   bool amdgpu_ucode_hdr_version(union amdgpu_firmware_header *hdr,
>>                   uint16_t hdr_major, uint16_t hdr_minor);