[EHL] Enable ISHTP

[Chao Qin]

Description
This driver enables the OS to talk to eclite firmware on a dedicated
low power chip over ISH Transport Protocol (ISHTP)

Hardware: Elkhart Lake

Target Release: 21.04
Target Kernel: TBD

External links:
https://github.com/intel/linux-intel-quilt/tree/mainline-tracking-v5.11-yocto-210223T083754Z

[Chao Qin (chaoqin)]

Please find the following patches in the above external link

0001-ishtp-Add-support-for-Intel-ishtp-eclite-driver.ishtp
0002-ishtp-ACPI-ID-change-for-Intel-ishtp-eclite-driver.ishtp
0003-ishtp-Add-timeout-for-ACPI-requests-to-eclite.ishtp
0004-ishtp-Add-PM-calls-to-prevent-eclite-events.ishtp
0005-ishtp-eclite-Fix-for-ACPI-errors-during-suspend-and-.ishtp

[Brad Figg (brad-figg)]

All requested patches have been committed to focal:linux-intel intel-5.13-next.

[Kent Lin (kent-jclin)]

@Qin,

Could you please advise how could we test this?

[Chao Qin (chaoqin)]

@Kent I am confirming with the feature owner and will update later

[Kent Lin (kent-jclin)]

Document provided by Intel:
https://www.kernel.org/doc/html/latest/hid/intel-ish-hid.html

Base on the document: the test steps will be:
1. Install tree:
sudo apt-get install tree
2. sudo tree -l /sys/bus/iio/devices/
3. Check if devices exited.

Example on AAEON's EHL board: https://certification.canonical.com/hardware/202109-29492/
u@linux:~$ sudo tree -l /sys/bus/iio/devices/
/sys/bus/iio/devices/
└── iio:device0 -> ../../../devices/pci0000:00/0000:00:1e.2/pxa2xx-spi.10/spi_master/spi0/spi-AANT1280:00/iio:device0
    ├── in_voltage0_raw
    ├── in_voltage1_raw
    ├── in_voltage2_raw
    ├── in_voltage3_raw
    ├── in_voltage_scale
    ├── power
    │   ├── async
    │   ├── autosuspend_delay_ms
    │   ├── control
    │   ├── runtime_active_kids
    │   ├── runtime_active_time
    │   ├── runtime_enabled
    │   ├── runtime_status
    │   ├── runtime_suspended_time
    │   └── runtime_usage
    ├── subsystem -> ../../../../../../../../bus/iio
    │   ├── devices
    │   │   └── iio:device0 -> ../../../devices/pci0000:00/0000:00:1e.2/pxa2xx-spi.10/spi_master/spi0/spi-AANT1280:00/iio:device0 [recursive, not followed]
    │   ├── drivers
    │   ├── drivers_autoprobe
    │   ├── drivers_probe
    │   └── uevent
    └── uevent

[Marcelo Cerri (mhcerri)]

Hi, Chao.

For the 5.15 kernel can we use the upstream version that landed in 5.16?

bf9167a8b40c HID: intel-ish-hid: fix module device-id handling
64355db3caf6 mod_devicetable: fix kdocs for ishtp_device_id
fa443bc3c1e4 HID: intel-ish-hid: add support for MODULE_DEVICE_TABLE()
f155dfeaa4ee platform/x86: isthp_eclite: only load for matching devices
7b6bf51de974 platform/x86: Add Intel ishtp eclite driver

[Chao Qin (chaoqin)]

Yes, please use the upstream version.

[Marcelo Cerri (mhcerri)]

Ok, I'm including the patches above. Thank you, Chao

[Ubuntu Kernel Bot (ubuntu-kernel-bot)]

This bug is awaiting verification that the linux-intel-iotg-5.15/5.15.0-1002.4~20.04.2 kernel in -proposed solves the problem. Please test the kernel and update this bug with the results. If the problem is solved, change the tag 'verification-needed-focal' to 'verification-done-focal'. If the problem still exists, change the tag 'verification-needed-focal' to 'verification-failed-focal'.

If verification is not done by 5 working days from today, this fix will be dropped from the source code, and this bug will be closed.

See https://wiki.ubuntu.com/Testing/EnableProposed for documentation how to enable and use -proposed. Thank you!

[Chao Qin (chaoqin)]

v5.15 updates are as following

https://github.com/intel/linux-intel-quilt/tree/lts-v5.15.21-linux-220222T001242Z-1
0001-hid-intel-ish-hid-add-RTD3-support-for-EHL-platform.patch
0002-hid-intel-ish-hid-ipc-remove-call-pm-api-in-interrup.patch
0003-hid-intel-ish-hid-ipc-add-return-value-check-for-wai.patch
0004-hid-intel-ish-hid-ipc-fix-S0ix-cannot-wakeup-issue.patch
0005-hid-intel-ish-hid-Use-different-pm-callbacks-for-ish.patch
0001-platform-eclite-Fix-for-unwanted-event-sent-during-e.patch
0001-hid-intel-ish-hid-fix-a-driver-status-un-sync-issue.patch

[Sachin Mokashi (sachinmokashi)]

@Kent,

The ECLite driver communication over ISHTP can be tested as follows:

a) "cat /sys/class/thermal/thermal_zone0/temp" - for reading temperature from EC-Lite.

Note 1: "cat /sys/class/thermal/thermal_zone0/type" should read "acpitz" - This is EC-Lite's thermal zone

Note 2: You can stress the CPU and read temp again to see a change. For stressing the CPU, you can use Checkbox itself.
Eg Checkbox command: cdts.checkbox-cli run com.canonical.certification::stress/cpu_stress_ng_test

If a battery is connected -
              - /sys/class/power_supply/BAT0 will be populated.
eg.
cat /sys/class/power_supply/BAT0/present
1
cat /sys/class/power_supply/BAT0/status
Discharging

You can try to turn on/off FAN manually as well – Commands attached