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;
From:   Quan Nguyen <quan@os.amperecomputing.com>
To:     macro@orcam.me.uk, Lee Jones <lee@kernel.org>,
        Bagas Sanjaya <bagasdotme@gmail.com>,
        Rob Herring <robh+dt@kernel.org>,
        Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>,
        Jean Delvare <jdelvare@suse.com>,
        Guenter Roeck <linux@roeck-us.net>,
        Jonathan Corbet <corbet@lwn.net>,
        Derek Kiernan <derek.kiernan@xilinx.com>,
        Dragan Cvetic <dragan.cvetic@xilinx.com>,
        Arnd Bergmann <arnd@arndb.de>,
        Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
        Quan Nguyen <quan@os.amperecomputing.com>,
        Thu Nguyen <thu@os.amperecomputing.com>,
        linux-kernel@vger.kernel.org, devicetree@vger.kernel.org,
        linux-hwmon@vger.kernel.org, linux-doc@vger.kernel.org,
        OpenBMC Maillist <openbmc@lists.ozlabs.org>,
        Open Source Submission <patches@amperecomputing.com>
Cc:     Phong Vo <phong@os.amperecomputing.com>,
        thang@os.amperecomputing.com
Subject: [PATCH v9 0/9] Add Ampere's Altra SMPro MFD and its child drivers
Date:   Thu, 29 Sep 2022 16:43:12 +0700
Message-Id: <20220929094321.770125-1-quan@os.amperecomputing.com>
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?MmvqyXG/fhWvdLY8xeeQhtFLPIKPqvOqWL/TYLEc7ysaOTu6SJ5coOGCh513?=
 =?us-ascii?Q?+Z9EeFQTo6SECe0uOO9RweY1X90cufGOSmjIKHPlhhjIAEp/UDu/6eVJIT/A?=
 =?us-ascii?Q?Va75vZX6JwhadimVJqG1R3uws1/bFoUCGKDN3WqFniruLZY2R7ru3Wmiq/YH?=
 =?us-ascii?Q?ZRh7wcCQ2NRn7bwtImrgc4pv81Pt7BA0wCBjFa7agTNe1COhp2bVdihvoitq?=
 =?us-ascii?Q?wUjKiFk6RKI2d5pR2P+F1kumDWz4hFcmttBBNbfEUpk91VxwPXX0mJH6n7Ej?=
 =?us-ascii?Q?OQmJtw4nuE8zpUINMWSXt+/20mkzqg+mEPlYo+Z1udDHhj9QfaPwkSqU3dDv?=
 =?us-ascii?Q?fJ+jDWSe0HyCCba5j5JWMEnWJvPYvzps2b7Qjbh4fe9voWNEZ1i7+EtUxvbt?=
 =?us-ascii?Q?Klsd4/B2UVdUo3eo+RkdJ5YfNkEPTtbxhInLXmLFXATCpwJPJs7n1jSXsjCT?=
 =?us-ascii?Q?VLCaKGUQAdcnUnr4iVJzze/+sH8iUobPc4gRwfcGzJrSG0mgBgGz7RrXpl96?=
 =?us-ascii?Q?oFTW8A7LNyWViFKEIbf9DsmCaF65vsobosFTOrYcBG7fR1IpoCXfYwG4blfA?=
 =?us-ascii?Q?LbWU2jKN/eh5HE66wWziik8+6aSEAgcOxE/sGfMOnza3Oa6zePGq6L47o3jm?=
 =?us-ascii?Q?tvgDjNbhFXoePa/5v9g3wKYAOQoSqswRZOiQ7z/hMbi8h56EuQjsBgP/xV6W?=
 =?us-ascii?Q?gTT+fHPQeLrDxgRJDB6b6OtFTLs39eEPi1nVn0wIFW66us3IQGLQxIB3aOUZ?=
 =?us-ascii?Q?/i3DBi3mMYCc0w81s753Cm7pk3qZZnDVZpRdGCNSHbvNmRwVgzwXbeaxl+Rd?=
 =?us-ascii?Q?pDDP024S/zW9cFVwLdqfDWi/iATxhFmlS8zQgLaRrFKWxnZeL1ZFcrSwtC20?=
 =?us-ascii?Q?mPdh2JPsdcAWf8BoeTYZXhV/+FroNn8LcQWdtrJWqo4JezlSETtF1ZmHg6nn?=
 =?us-ascii?Q?stZ+Ou8YcvtwdmWBXg++pgUWPa62CTnASBzWhNhKaGolt4Pb2S6lDX4Capop?=
 =?us-ascii?Q?l0KTFQdM0frFX5F1DVB258HPPDylA4svwyptRFefI2phb7gm6QMp1yBDz47X?=
 =?us-ascii?Q?SEJ1ydEhRMlS6QCV2Vt/BoexrpFui+9LGwAeoNVju/czHkz+dWC5tfVINdaL?=
 =?us-ascii?Q?1SiYaCe+b1/uWis+179/Ul4d6rHYSishxvTvrGILDpwd3vX9pSJwnODfGY5B?=
 =?us-ascii?Q?71fH4Io9AGxxDJhwDrQD32DtYWBXT9TDvHumBQZhvcK79FvlhwheNSWiNdwg?=
 =?us-ascii?Q?krf5LnOM42MUu1Qp5zZLpkYoRRInToVDbLscjkNovHv9F6361X22TBpq70PL?=
 =?us-ascii?Q?7MgJbnD8n1JH/IPxvb4DRB6z9qbacr74HuARlDepdn9uVJYwTuWDfmB5qaJs?=
 =?us-ascii?Q?8+4cYf0pBoyoZohJ/fVZzn1oEN6JqBLpfRnJ3nC2U4jDo2pTfznKHmgBHjrC?=
 =?us-ascii?Q?BL2yNYZGphfIEbQUalx6Pi2fJzeMv2WRIfvOq23xcO5YMYaKogDXtheOXjw3?=
 =?us-ascii?Q?8t9SPTruRYUDEvLqBFWG9Qb0F+W4qh70vgo17Iy2Vo9uOAaRR5Ip6KNVRNrM?=
 =?us-ascii?Q?fxatRF24e7dKuynq7gwGVs3RaC/kajOIpX003+DIfSWc9Nu3fTvlzOqeF26z?=
 =?us-ascii?Q?3lZDjH2JSh+1AhZpk2HXWaY=3D?=
X-OriginatorOrg: os.amperecomputing.com
X-MS-Exchange-CrossTenant-Network-Message-Id: c7125ce7-0f50-4644-c0d2-08daa1ff1939
X-MS-Exchange-CrossTenant-AuthSource: SJ0PR01MB7282.prod.exchangelabs.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 29 Sep 2022 09:43:44.3137
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 3bc2b170-fd94-476d-b0ce-4229bdc904a7
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: bfHW6PWSrAyFi9RQ/X2Ta7+5LJv5OFwGr0KwXF6JGkuH91vCvMsy2A24noDrkTII0oBq/7b8Trg3nJ9THsvb8AtMtuN9ME1Vbotcog2Gj3o=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: BN8PR01MB5682
X-Spam-Status: No, score=-2.0 required=5.0 tests=BAYES_00,DKIM_SIGNED,
        DKIM_VALID,DKIM_VALID_AU,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

The SMpro co-processor on Ampere Altra processor family is to monitor
and report various data included hwmon-related info, RAS errors, and
other miscellaneous information. The SMPro MFD driver initializes the
register map and instantiates all sub-devices. All the specifics will
be handled in the child drivers.

This patch set includes support for Ampere SMpro hwmon, errmon, and
misc as the child drivers. The hwmon driver supports accessing various
CPU sensors provided by the SMpro co-processor including temperature,
power, voltages, and current found on Ampere Altra processor family.
The errmon driver supports monitoring and reporting RAS-related errors.
The misc driver is to support reporting boot progress and other
miscellaneous information.

Discussion for v8:
https://lore.kernel.org/all/20220422024653.2199489-1-quan@os.amperecomputing.com/

v9:
  + Fix issue when building htmldocs                           [Bagas]
  + Insert 'break;' to avoid fall-through          [kernel test robot]
  + Update SPDX license                                         [Greg]
  + Fix messy goto                                              [Greg]
  + Use ATTRIBUTE_GROUPS()                                      [Greg]
  + Use dev_groups instead of sysfs_create_group() to avoid
  user space racing issue                                       [Greg]
  + Fix ugly static struct define                               [Greg]
  + Rename smpro-mfd.c to smpro-core.c                     [Lee Jones]
  + Fix include files in alphabetical order                [Lee Jones]
  + Add defines to avoid using magic numbers               [Lee Jones]
  + Return -EINVAL if device does not match                [Lee Jones]
  + Remove unnecessary comment                             [Lee Jones]
  + Remove unnecessary channel info for VRD and DIMM event      [Quan]
  + Separate error_[smpro|pmpro] to error_* and warn_*          [Quan]
  + Add minor refactor code                                     [Quan]

v8:
  + Insert 'break;' to avoid fall-through          [kernel test robot]
  + Avoid uninitialized variable use               [kernel test robot]
  + Remove unused #*_cells                                 [Krzysztof]
  + Switch to use sysfs_emit()                                  [Greg]
  + Sysfs to return single value only                           [Greg]
  + Fix KernelVerion field in Documentation/ABI/testing doc     [Greg]
  + Change errors_* sysfs to error_*                            [Quan]
  + Add overflow_[core|mem|pcie|other]_[ce|ue] sysfs to report
  overflow status of each type of HW errors                     [Quan]
  + Update wording in Kconfig for smpro-errmon and smpro-misc   [Quan]
  + Masks reserved bit when read 10-bit power value             [Quan]
  + Add some minor refactor                                     [Quan]

v7:
  + Add docs to Documentation/ABI/testing                       [Greg]
  + Re-order patches to avoid compile dependency           [Lee Jones]
  + Remove regmap_acquire/release_lock()                        [Quan]
  + Install regmap bus->read/write() to handle multiple types of bus
    access                                                      [Quan]
  + Replace i2c block read by regmap_noinc_read()               [Quan]
  + Fix wrong return type of *show/store()         [kernel test robot]
  + Update GPL version                                          [Quan]
  + Add some others minor code refactor                         [Quan]

v6:
  + Introduced smpro-errmon, smpro-misc as smpro-mfd sub-device [Quan]

v5:
  + Introduced the smpro-mfd driver and drop the use of
  simple-mfd-i2c driver to avoid DT node with no resource in child
  device DT nodes [Rob]
  + Removed the use of reg DT property in child driver [Quan]
  + Validated ManufactureID when probing smpro-mfd drivers [Quan]
  + As child devices are instantiated by SMPro MFD driver, drop the
  ManufacturerID checking in child driver, ie: smpro-hwmon [Quan]
  + Revised commit messages [Quan]

v4:
  + Revised commit message [Quan]
  + Fixed build issue found by kernel test robot [Guenter]
  + Returned regmap_read() error code [Guenter]

v3:
  + Supported list of compatible string [Rob]
  + Introduced reg property in DT to specify reg offset [Rob]
  + Updated description and other minor changes in yaml file [Rob]
  + Handled negative temperature value [Guenter]
  + Returned -ENODEV if Manufacturer ID is wrong [Guenter]
  + Refactored smpro_read_string() and smpro_temp_read() [Guenter]
  + Removed smpro_write() function [Guenter]
  + Added minor refactor changes [Quan]

v2:
  + Used 'struct of_device_id's .data attribute [Lee Jones]
  + Removed "virtual" sensors [Guenter]
  + Fixed typo "mili" to "milli", "nanoWatt" to "microWatt" [Guenter]
  + Reported SOC_TDP as "Socket TDP" using max attributes [Guenter]
  + Clarified "highest" meaning in documentation [Guenter]
  + Corrected return error code when host is turn off [Guenter]
  + Reported MEM HOT Threshold for all DIMMs as temp*_crit [Guenter]
  + Removed license info as SPDX-License-Identifier existed [Guenter]
  + Added is_visible() support [Guenter]
  + Used HWMON_CHANNEL_INFO() macro and LABEL attributes [Guenter]
  + Made is_valid_id() return boolean [Guenter]
  + Returned -EPROBE_DEFER when smpro reg inaccessible [Guenter]
  + Removed unnecessary error message when dev register fail [Guenter]
  + Removed Socket TDP sensor [Quan]
  + Changed "ampere,ac01-smpro" to "ampere,smpro" [Quan]
  + Included sensor type and channel in labels [Quan]
  + Refactorized code to fix checkpatch.pl --strict complaint [Quan]

Quan Nguyen (9):
  hwmon: smpro: Add Ampere's Altra smpro-hwmon driver
  docs: hwmon: (smpro-hwmon) Add documentation
  misc: smpro-errmon: Add Ampere's SMpro error monitor driver
  docs: misc-devices: (smpro-errmon) Add documentation
  misc: smpro-misc: Add Ampere's Altra SMpro misc driver
  docs: misc-devices: (smpro-misc) Add documentation
  dt-bindings: mfd: Add bindings for Ampere Altra SMPro MFD driver
  mfd: Add Ampere's Altra SMpro MFD driver
  docs: ABI: testing: Document the Ampere Altra Family's SMpro sysfs
    interfaces

 .../sysfs-bus-platform-devices-ampere-smpro   | 125 +++++
 .../devicetree/bindings/mfd/ampere,smpro.yaml |  42 ++
 Documentation/hwmon/index.rst                 |   1 +
 Documentation/hwmon/smpro-hwmon.rst           | 101 ++++
 Documentation/misc-devices/index.rst          |   2 +
 Documentation/misc-devices/smpro-errmon.rst   | 193 +++++++
 Documentation/misc-devices/smpro-misc.rst     |  82 +++
 drivers/hwmon/Kconfig                         |   8 +
 drivers/hwmon/Makefile                        |   1 +
 drivers/hwmon/smpro-hwmon.c                   | 463 +++++++++++++++
 drivers/mfd/Kconfig                           |  12 +
 drivers/mfd/Makefile                          |   1 +
 drivers/mfd/smpro-core.c                      | 138 +++++
 drivers/misc/Kconfig                          |  22 +
 drivers/misc/Makefile                         |   2 +
 drivers/misc/smpro-errmon.c                   | 529 ++++++++++++++++++
 drivers/misc/smpro-misc.c                     | 145 +++++
 17 files changed, 1867 insertions(+)
 create mode 100644 Documentation/ABI/testing/sysfs-bus-platform-devices-ampere-smpro
 create mode 100644 Documentation/devicetree/bindings/mfd/ampere,smpro.yaml
 create mode 100644 Documentation/hwmon/smpro-hwmon.rst
 create mode 100644 Documentation/misc-devices/smpro-errmon.rst
 create mode 100644 Documentation/misc-devices/smpro-misc.rst
 create mode 100644 drivers/hwmon/smpro-hwmon.c
 create mode 100644 drivers/mfd/smpro-core.c
 create mode 100644 drivers/misc/smpro-errmon.c
 create mode 100644 drivers/misc/smpro-misc.c

-- 
2.35.1