[v3,0/8] misc: Add AMD side band interface(SBI) functionality

Message

Gupta, Akshay Aug. 14, 2024, 9:59 a.m. UTC

AMD's Advanced Platform Management Link (APML) interface provides system
management functionality accessed by the baseboard management controller (BMC).
sbrmi driver under hwmon subsystem, which is probed as an i2c driver and
reports power using APML specified protocol.
However, APML interface defines few other protocols to support
full system management functionality out-of-band.
Out-of-band management is term used for BMC talking to system management unit
(IP in the processor). AMD's documentation called this link as side band interface.

This patchset is an attempt to add all APML core functionality in one place
and provide hwmon and user space interface
1. Move the i2c client probe, hwmon sensors and sbrmi core functionality [Patch 1]
   from drivers/hwmon to drivers/misc/
2. Convert i2c to regmap which provides multiple benefits [Patch 2]
   over direct smbus APIs.
    a. i2c/i3c support and 
    b. 1 byte/2 byte RMI register size addressing
3. Register a misc device which provides [Patch 3, 4]
    a. An ioctl interface through node /dev/sbrmiX
    b. Register sets is common across APML protocols. IOCTL is providing
       synchronization among protocols as transactions may create
       race condition.
4. [Subsequent patches 5, 6 and 7] add support for AMD custom protocols
    a. CPUID
    b. MCAMSR
    c. Register xfer
5. AMD side band description document [Patch 8]

Open-sourced and widely used https://github.com/amd/esmi_oob_library
will continue to provide user-space programmable API.

Akshay Gupta (8):
  hwmon/misc: amd-sbi: Move core sbrmi from hwmon to misc
  misc: amd-sbi: Use regmap subsystem
  misc: amd-sbi: Add support for AMD_SBI IOCTL
  misc: amd-sbi: Add support for mailbox error codes
  misc: amd-sbi: Add support for CPUID protocol
  misc: amd-sbi: Add support for MCA register protocol
  misc: amd-sbi: Add supoort for register xfer
  misc: amd-sbi: Add document for AMD SB IOCTL description

 Documentation/misc-devices/amd-sbi.rst        | 121 +++++
 .../userspace-api/ioctl/ioctl-number.rst      |   2 +
 drivers/hwmon/Kconfig                         |  10 -
 drivers/hwmon/sbrmi.c                         | 357 -------------
 drivers/misc/Kconfig                          |   1 +
 drivers/misc/Makefile                         |   1 +
 drivers/misc/amd-sbi/Kconfig                  |   9 +
 drivers/misc/amd-sbi/Makefile                 |   3 +
 drivers/misc/amd-sbi/rmi-core.c               | 475 ++++++++++++++++++
 drivers/misc/amd-sbi/rmi-core.h               |  67 +++
 drivers/misc/amd-sbi/rmi-hwmon.c              | 122 +++++
 drivers/misc/amd-sbi/rmi-i2c.c                | 135 +++++
 include/uapi/misc/amd-apml.h                  |  74 +++
 13 files changed, 1010 insertions(+), 367 deletions(-)
 create mode 100644 Documentation/misc-devices/amd-sbi.rst
 delete mode 100644 drivers/hwmon/sbrmi.c
 create mode 100644 drivers/misc/amd-sbi/Kconfig
 create mode 100644 drivers/misc/amd-sbi/Makefile
 create mode 100644 drivers/misc/amd-sbi/rmi-core.c
 create mode 100644 drivers/misc/amd-sbi/rmi-core.h
 create mode 100644 drivers/misc/amd-sbi/rmi-hwmon.c
 create mode 100644 drivers/misc/amd-sbi/rmi-i2c.c
 create mode 100644 include/uapi/misc/amd-apml.h