[Deepin-Kernel-SIG] [linux 6.6-y] [Upstream] [Intel] Intel: support In Field Scan(IFS) SAF & Array BIST on GNR & SRF

[Avenger-285714]

bugzilla: https://bugzilla.openanolis.cn/show_bug.cgi?id=8013

Intel In Field Scan (IFS) is a hardware feature to run circuit level tests on a CPU core to detect problems that are not caught by parity or ECC checks.

This PR is to support In Field Scan(IFS) SAF & Array BIST on GNR & SRF platforms.
It is upstreamed in v6.7-rc1:
https://lore.kernel.org/all/20231005195137.3117166-1-jithu.joseph@intel.com/

Upstream commits from v6.7-rc1:
06d65b2 platform/x86/intel/ifs: ARRAY BIST for Sierra Forest
b9aa9e4 platform/x86/intel/ifs: Add new error code
e6483a0 platform/x86/intel/ifs: Add new CPU support
60d2e1b platform/x86/intel/ifs: Metadata validation for start_chunk
25a76db platform/x86/intel/ifs: Validate image size
72b96ee platform/x86/intel/ifs: Gen2 Scan test support
07f47c0 platform/x86/intel/ifs: Gen2 scan image loading
a138ac2 platform/x86/intel/ifs: Refactor image loading code
97a5e80 platform/x86/intel/ifs: Store IFS generation number

(deepin: Drop 25a76db ("platform/x86/intel/ifs: Validate image size")、72b96ee29ed6f7670bbb180ba694816e33d361d1 ("platform/x86/intel/ifs: Gen2 Scan test support") and 97a5e80 ("platform/x86/intel/ifs: Store IFS generation number") because of merged before.)

Fix commit from upstream v6.7.2:
e8931eb platform/x86/intel/ifs: Call release_firmware() when handling errors.

(deepin: Droped because of merged before.)

One commit is to add kernel config for IFS:
51d84a97546446c55203a0961cce317b7e70937e x86: configs: Add Intel In Field Scan(IFS) kernel config

(deepin: Skiped.)

Test
Built and run the kernel successfully.
Test is PASS on GNR & SRF platforms.

Configs
CONFIG_INTEL_IFS = m

Link: https://gitee.com/anolis/cloud-kernel/pulls/2688

Summary by Sourcery

Support Intel In Field Scan (IFS) SAF and Array BIST on Granite Rapids and Sierra Forest platforms by upstreaming Gen2 scan test logic, adding stride-aware chunk handling, new MSR definitions, enhanced error reporting, and generation-based CPU model integration.

New Features:

• Support Gen2 In Field Scan (IFS) SAF with stride-aware chunk authentication and metadata validation
• Implement array self-test (Array BIST) for both Gen0 and Gen1 platforms via MSR triggers and status checks
• Introduce detailed error messaging and extended error codes for hash copy, authentication, and scan execution

Enhancements:

• Validate starting chunk alignment against chunks_per_stride in metadata
• Track loaded_version and generation to optimize hash copy operations
• Extend ifs_data struct with chunk_size and array_gen and update CPU ID matching to enable generation-specific test flows

[sourcery-ai]

Reviewer's Guide

This pull request extends In Field Scan (IFS) support on Granite Rapids (GNR) and Sierra Forest (SRF) platforms by modularizing error reporting, implementing generation-2 scan hash copy/authentication, adding Array BIST support, enforcing metadata alignment checks, and updating CPU match tables with new MSR and data-structure definitions.

Sequence Diagram for IFS Gen2 Image Loading and Authentication

sequenceDiagram
    participant C as Caller
    participant F as copy_hashes_authenticate_chunks_gen2()
    participant D as Device dev
    participant MSR as MSRs
    participant IFS_D as ifs_data ifsd

    C->>F: Call(dev)
    F->>IFS_D: Get ifs_data
    F->>F: need_copy_scan_hashes(ifsd)?
    alt If hashes need copying or generation < IFS_GEN_STRIDE_AWARE
        F->>MSR: wrmsrl(MSR_COPY_SCAN_HASHES, ifs_hash_ptr)
        F->>MSR: rdmsrl(MSR_SCAN_HASHES_STATUS)
        F->>F: Store hashes_status (includes chunk_size, num_chunks, error_code)
        alt If hash copy error (hashes_status.valid is false)
            F->>D: hashcopy_err_message(dev, hashes_status.error_code)
            F-->>C: Return -EIO
        end
        F->>IFS_D: Update loaded_version, chunk_size
    else Else (hashes already copied for Gen2+)
        F->>IFS_D: Get num_chunks, chunk_size from ifsd
    end

    alt If ifsd.generation >= IFS_GEN_STRIDE_AWARE
        F->>MSR: wrmsrl(MSR_SAF_CTRL, INVALIDATE_STRIDE)
        F->>MSR: rdmsrl(MSR_CHUNKS_AUTHENTICATION_STATUS)
        F->>F: Store chunk_status
        alt If couldn't invalidate stride (chunk_status.valid_chunks != 0)
            F->>D: dev_err("Couldn't invalidate installed stride")
            F-->>C: Return -EIO
        end
    end

    F->>F: Find ifs_meta_data (for starting_chunk_nr)
    loop For each chunk (i from 0 to num_chunks-1)
        F->>F: Prepare chunk_table (starting_chunk_nr + i, linear_addr)
        loop Retry AUTH_INTERRUPTED_ERROR (max IFS_AUTH_RETRY_CT)
            F->>MSR: wrmsrl(MSR_AUTHENTICATE_AND_COPY_CHUNK, chunk_table)
            F->>MSR: rdmsrl(MSR_CHUNKS_AUTHENTICATION_STATUS)
            F->>F: Store chunk_status, err_code (chunk_status.error_code)
        end
        alt If authentication error (err_code is non-zero)
            F->>IFS_D: loading_error = true
            F->>D: auth_err_message(dev, err_code)
            F-->>C: Return -EIO
        end
    end

    F->>F: Check valid_chunks vs total_chunks from final chunk_status
    alt If valid_chunks != total_chunks
        F->>IFS_D: loading_error = true
        F->>D: dev_err("Couldn't authenticate all chunks")
        F-->>C: Return -EIO
    end
    F->>IFS_D: Update ifsd.valid_chunks
    F-->>C: Return 0 (Success)

Loading

Sequence Diagram for IFS Array BIST Gen1 Test Execution

sequenceDiagram
    participant C as Caller (do_core_test)
    participant F_MAIN as ifs_array_test_gen1()
    participant SCL as stop_core_cpuslocked()
    participant F_CORE as do_array_test_gen1() (on target CPU)
    participant MSR as MSRs
    participant IFS_D as ifs_data ifsd

    C->>F_MAIN: Call(cpu, dev)
    F_MAIN->>IFS_D: Get ifs_data
    F_MAIN->>SCL: Call stop_core_cpuslocked(cpu, do_array_test_gen1, &status_var)
    activate SCL
        SCL->>F_CORE: Execute on target CPU with &status_var
        activate F_CORE
            F_CORE->>F_CORE: cpu = smp_processor_id()
            F_CORE->>F_CORE: first_smt_thread = cpumask_first(cpu_smt_mask(cpu))
            alt If cpu == first_smt_thread
                F_CORE->>MSR: wrmsrl(MSR_ARRAY_TRIGGER, ARRAY_GEN1_TEST_ALL_ARRAYS)
                F_CORE->>MSR: rdmsrl(MSR_ARRAY_STATUS)
                F_CORE->>F_CORE: Update status_var with MSR value
            end
            F_CORE-->>SCL: Return 0
        deactivate F_CORE
    SCL-->>F_MAIN: Return (status_var contains result)
    deactivate SCL

    F_MAIN->>IFS_D: Update scan_details with status_var
    alt If status_var & ARRAY_GEN1_STATUS_FAIL
        F_MAIN->>IFS_D: status = SCAN_TEST_FAIL
    else Else
        F_MAIN->>IFS_D: status = SCAN_TEST_PASS
    end
    F_MAIN-->>C: Return

Loading

File-Level Changes

Change	Details	Files
Modularize IFS error handling	Add hashcopy_err_message and auth_err_message helper functions Define new error codes in scan_hash_status and scan_authentication_status arrays Replace inline dev_err calls in load.c with the new helper functions	drivers/platform/x86/intel/ifs/load.c
Implement generation-2 scan hash copy and chunk authentication	Introduce ifs_scan_hashes_status_gen2 and ifs_chunks_auth_status_gen2 unions Add need_copy_scan_hashes and get_num_chunks utility functions Implement copy_hashes_authenticate_chunks_gen2 for stride-aware platforms Update scan_chunks_sanity_check to dispatch to gen2 path when appropriate	drivers/platform/x86/intel/ifs/load.c drivers/platform/x86/intel/ifs/ifs.h
Add Array BIST support for gen1 and gen2	Define MSR_ARRAY_TRIGGER, MSR_ARRAY_STATUS, MSR_SAF_CTRL and constants ARRAY_GEN0/1 Implement do_array_test_gen1 and ifs_array_test_gen1 routines Update do_core_test to select between SAF and Array BIST based on array_gen	drivers/platform/x86/intel/ifs/runtest.c drivers/platform/x86/intel/ifs/ifs.h
Enforce IFS metadata alignment	Include linux/sizes.h for SZ_1K macro Add a warning and validation in validate_ifs_metadata if starting_chunk misaligns with chunks_per_stride	drivers/platform/x86/intel/ifs/load.c
Extend CPU platform matching with array_gen support	Modify X86_MATCH macro to accept array_gen driver_data Add new CPU entries for Granite Rapids, Sierra Forest, and Crestmont with array_gen values Initialize ifs_data.array_gen from driver_data during ifs_init	drivers/platform/x86/intel/ifs/core.c

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[deepin-ci-robot]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from avenger-285714. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details

Needs approval from an approver in each of these files:

• deepin/OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[Copilot]

Pull Request Overview

This PR backports upstream support for Intel In Field Scan (IFS) SAF & Array BIST on GNR & SRF platforms.

• Adds new error codes and handling for array tests in runtest.c.
• Refactors scan hash authentication and error messaging in load.c, and expands hardware definitions in ifs.h.
• Updates the CPU matching macro and initialization in core.c to account for test generation (array_gen).

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

File	Description
drivers/platform/x86/intel/ifs/runtest.c	Introduces new error codes and extends the scan test branching for ARRAY_GEN1.
drivers/platform/x86/intel/ifs/load.c	Refactors error logging for hash copy and authentication, and adds gen2 scan chunk authentication logic.
drivers/platform/x86/intel/ifs/ifs.h	Adds new MSR definitions, union structures for gen2 data, and new ifs_data fields.
drivers/platform/x86/intel/ifs/core.c	Adjusts the CPU matching macro to include an array_gen parameter and assigns it during device initialization.

Comments suppressed due to low confidence (1)

drivers/platform/x86/intel/ifs/core.c:13

• [nitpick] Consider adding a brief comment to the updated X86_MATCH macro to explain the purpose and expected values of the new array_gen parameter for future maintainability.

#define X86_MATCH(model, array_gen) ...

[Copilot]

[nitpick] The assignment of ifsd->loaded_version occurs in two separate code paths (one in copy_hashes_authenticate_chunks_gen2 and again after cpus_read_unlock). Consider consolidating this update to ensure consistent firmware version tracking across all branches.

Suggested change

	return copy_hashes_authenticate_chunks_gen2(dev);
	ret = copy_hashes_authenticate_chunks_gen2(dev);
	goto update_version;

[sourcery-ai]

Hey @Avenger-285714 - I've reviewed your changes and they look great!

Here's what I looked at during the review

• 🟡 General issues: 1 issue found
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[sourcery-ai]

issue (bug_risk): Possible uninitialized use of chunk_status in copy_hashes_authenticate_chunks_gen2.

If num_chunks is zero, chunk_status may remain uninitialized. Please add explicit handling for the zero-chunk case.

[Avenger-285714]

当前我们的编译配置还未使能CONFIG_INTEL_IFS，经使用LLVM20手工测试，使能该配置项时可编译通过。