Files
i2c-imc-skylake/.github/workflows/ci.yml
T
Simone 88a8b7eb27 i2c-imc-skylake: retract the CF8/CFC claim, harden the state machine
v2 said firmware filters CF8/CFC config writes to this function and that
the registers are reachable only through ECAM.  That was never tested; the
only evidence was the boot line "PCI: Using configuration type 1", which
names the accessor and says nothing about a write failing.

Measured on the board, driver unloaded:

  # setpci -s 16:1e.5 9c.L=20085002    # read SPD 0x50 register 0x02
  # setpci -s 16:1e.5 9c.L
  20005002                             # GO consumed by the engine
  # setpci -s 16:1e.5 a8.L
  0000500c                             # READ_DONE, no error
  # setpci -s 16:1e.5 b4.L
  0000000c                             # SPD byte 2, DDR4 type code

The command executes and returns correct data through the ordinary
accessors, and MSR_SMI_COUNT does not move across it.  So the driver now
uses pci_read_config_dword() and pci_write_config_dword(), the submission
is a single patch again, and nothing in it touches the PCI core.  The
cover letter retracts the claim explicitly rather than dropping it
quietly, because v2 was posted with it.

Correctness work in the same pass:

  - the completion bits are latched, so a command word that never reaches
    the register is indistinguishable from a completed transfer and the
    caller gets the previous transaction's data.  Read the command word
    back and require it to be the one just written; the engine only ever
    clears GO, which the measurement above shows directly;
  - compare the command registers after every transfer against what the
    driver left in them and fail with -EAGAIN on a mismatch.  The original
    iMC driver had this check and it is what makes an unarbitrated system
    detectable instead of silently wrong;
  - use the i2c core's suspended-adapter mechanism rather than a private
    flag and -EHOSTDOWN;
  - use devm_mutex_init(), drop the unnecessary pci_enable_device(), and
    return -ENODEV rather than -EPERM from the default-off gate, which was
    printing a driver-core error on every boot;
  - mask GO when restoring a saved command word.

An earlier version of the latched-DONE check required the GO bit to be
seen set or the status word to change.  That was wrong: repeated transfers
with the same outcome leave STATUS bit for bit identical, and GO is
consumed faster than a config read-back can observe it.  It produced false
positives on 3 of 15 smoke-test items before being replaced.

Add Documentation/i2c/busses/i2c-imc-skylake.rst, which every other PC
SMBus driver has and which was asked for on the 2020 iMC thread, and the
tools/ scripts for the hardware measurements: probe-cf8-write.sh and
probe-cf8-transaction.sh produced the result above, dump-pcu-config.sh is
the search for a TSOD polling control, watch-engine.sh is the firmware
activity measurement.

Smoke test on the X299 system with the current module: 15 checks, 0
failures, dmesg clean.
2026-07-26 19:51:44 +02:00

144 lines
4.6 KiB
YAML

name: CI
on:
push:
branches:
- main
pull_request:
branches:
- main
workflow_dispatch:
permissions:
contents: read
concurrency:
group: ci-${{ github.ref }}
cancel-in-progress: true
env:
I2C_TREE: https://git.kernel.org/pub/scm/linux/kernel/git/andi.shyti/linux.git
SPARSE_REPOSITORY: https://git.kernel.org/pub/scm/devel/sparse/sparse.git
SPARSE_COMMIT: 00c4b8e75cbf92003bc4a695a223045092b173f3
jobs:
out-of-tree:
name: Out-of-tree (${{ matrix.compiler }})
runs-on: ubuntu-latest
timeout-minutes: 30
strategy:
fail-fast: false
matrix:
include:
- compiler: gcc
make_args: ""
- compiler: clang
make_args: LLVM=1
steps:
- uses: actions/checkout@v4
- name: Install build dependencies
run: |
sudo apt-get update
sudo apt-get install -y build-essential clang llvm linux-headers-$(uname -r)
- name: Build module
run: make W=1 KCFLAGS=-W ${{ matrix.make_args }}
- name: Run checkpatch
if: matrix.compiler == 'gcc'
run: make checkpatch
- name: Check shell scripts
if: matrix.compiler == 'gcc'
run: |
sudo apt-get install -y shellcheck
bash -n test-smoke.sh
for f in tools/*.sh; do bash -n "$f"; done
shellcheck -S warning test-smoke.sh tools/*.sh
- name: Upload artifact
if: matrix.compiler == 'gcc'
uses: actions/upload-artifact@v4
with:
name: i2c-imc-skylake-${{ github.ref_name }}
path: i2c-imc-skylake.ko
if-no-files-found: error
in-tree:
name: Current i2c-host integration
runs-on: ubuntu-latest
timeout-minutes: 45
steps:
- uses: actions/checkout@v4
- name: Install kernel build dependencies
run: |
sudo apt-get update
sudo apt-get install -y bc bison build-essential clang flex libelf-dev libssl-dev llvm
- name: Build pinned Sparse
run: |
git clone --filter=blob:none "$SPARSE_REPOSITORY" sparse
git -C sparse checkout "$SPARSE_COMMIT"
make -C sparse -j"$(nproc)"
echo "$PWD/sparse" >> "$GITHUB_PATH"
- name: Prepare current maintainer tree
run: |
git clone --depth=1 --branch i2c/i2c-host "$I2C_TREE" linux-i2c
cp i2c-imc-skylake.c linux-i2c/drivers/i2c/busses/
cat docs/submission/Kconfig.kernel >> linux-i2c/drivers/i2c/busses/Kconfig
printf '%s\n' 'obj-$(CONFIG_I2C_IMC_SKYLAKE) += i2c-imc-skylake.o' \
>> linux-i2c/drivers/i2c/busses/Makefile
git -C linux-i2c rev-parse HEAD
- name: Configure kernel
working-directory: linux-i2c
run: |
make O=../linux-out x86_64_defconfig
scripts/config --file ../linux-out/.config --enable I2C --module I2C_IMC_SKYLAKE
make O=../linux-out olddefconfig
grep '^CONFIG_I2C_IMC_SKYLAKE=m' ../linux-out/.config
- name: Build driver in-tree
working-directory: linux-i2c
run: make O=../linux-out W=1 drivers/i2c/busses/i2c-imc-skylake.o
- name: Build arm64 COMPILE_TEST with Clang
working-directory: linux-i2c
run: |
make O=../linux-out-arm64 ARCH=arm64 LLVM=1 defconfig
scripts/config --file ../linux-out-arm64/.config \
--enable COMPILE_TEST --enable PCI --enable I2C \
--module I2C_IMC_SKYLAKE
make O=../linux-out-arm64 ARCH=arm64 LLVM=1 olddefconfig
grep '^CONFIG_I2C_IMC_SKYLAKE=m' ../linux-out-arm64/.config
make O=../linux-out-arm64 ARCH=arm64 LLVM=1 W=1 \
drivers/i2c/busses/i2c-imc-skylake.o
- name: Run Sparse in-tree
working-directory: linux-i2c
run: |
make O=../linux-out C=2 CF=-D__CHECK_ENDIAN__ \
drivers/i2c/busses/i2c-imc-skylake.o
- name: Run current-tree checkpatch
working-directory: linux-i2c
run: |
scripts/checkpatch.pl --strict --no-tree -f \
drivers/i2c/busses/i2c-imc-skylake.c
- name: Build the documentation
working-directory: linux-i2c
run: |
sudo apt-get install -y python3-sphinx python3-sphinx-rtd-theme
cp ../docs/submission/i2c-imc-skylake.rst Documentation/i2c/busses/
sed -i 's|^ i2c-i801$| i2c-i801\n i2c-imc-skylake|' \
Documentation/i2c/busses/index.rst
grep -q i2c-imc-skylake Documentation/i2c/busses/index.rst
make O=../linux-out htmldocs SPHINXDIRS=i2c 2>&1 | tee doc.log | tail -20
! grep -Ei 'WARNING|ERROR' doc.log