From patchwork Mon Mar 23 23:33:53 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Kun Yi X-Patchwork-Id: 11454225 Return-Path: Received: from mail.kernel.org (pdx-korg-mail-1.web.codeaurora.org [172.30.200.123]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id D1B6E139A for ; Mon, 23 Mar 2020 23:34:24 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id B2CF120719 for ; Mon, 23 Mar 2020 23:34:24 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b="QbtMCVGG" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1727122AbgCWXeR (ORCPT ); Mon, 23 Mar 2020 19:34:17 -0400 Received: from mail-ua1-f74.google.com ([209.85.222.74]:38526 "EHLO mail-ua1-f74.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1727117AbgCWXeQ (ORCPT ); Mon, 23 Mar 2020 19:34:16 -0400 Received: by mail-ua1-f74.google.com with SMTP id t10so5636690uaj.5 for ; Mon, 23 Mar 2020 16:34:14 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20161025; h=date:in-reply-to:message-id:mime-version:references:subject:from:to :cc; bh=tXPEW76sKJjaPQGOZOimHJEP26LY2RMe5WtADrdJadU=; b=QbtMCVGGHfrzaPRSTOG6hYYZxOLOAJUOS7nSkIWYeuCBEGvFanrgs59bjGOXXPxZBJ bHAuvMI19M1Cl8fmZDd1Zl5BJSmfSmgYX7voMEM64BkT+OmECDkwOmb5kGuBbx326ZYV 5Xad/Ole1WKEk3xofvjvHLRACG9gqI51bzRUCvXrL+4s3WuorbsJSEoncubX7m7qi6zJ oqDheiFmlN5YvzOMowlMkH99wT6l4OvlG+o9VPjh/glIu+slaTwYugVRK6WT45ZghgJX ePNxq4qTsD8RWuWw1KNJBVFK+USe9+6bexHrzChg7Mr2MCoGBx4kmV4Mg8whJaBF6qkZ YQRQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:date:in-reply-to:message-id:mime-version :references:subject:from:to:cc; bh=tXPEW76sKJjaPQGOZOimHJEP26LY2RMe5WtADrdJadU=; b=ObWQOR+wvgUYbFLfd8T5QMcNRb53qxJcHZ1qJKXuDoA/RdTv/0VSBoI2a2gqV1ucSx R8WTW5quo10CMGksd3uz4EWgZ8e5nWzGgciUB1QZ8XKXkpG8XzuUHwdLXHyT2/FoFZCQ nk+eSZTgIBAyIm6BaFLyqkOSv2VllIovp1rVmkVZn10xFIoxa0azsNhiD7ST7EUBK23y z1DTl5BMIybon9fNCeSPe9L2zwMo0RHG7uRrtGhgbdnlqVvq2GcedIZZfOx4DeU76+Cg VyNc71iObPoEnSOH6XxuIJmPmHIOh6VqYySMJfXaQAbybjBIbT7Tyh+2XwoBWEw95Fee WyCw== X-Gm-Message-State: ANhLgQ3/auikJwva7hANxnU7tmKLh3GwWsODL7gXbn9ZSWIKmXiV+4QV EMT0EbADuUJiOMT55ug2+VzTrL9pTg== X-Google-Smtp-Source: ADFU+vuLxlD+2uO92bRrRaRHd0gjs4zp+jDXUXilAFiN/Eux1EFzVf5TdgZWCwGXv1Yhg1tiwl6PAvstYA== X-Received: by 2002:ab0:698e:: with SMTP id t14mr16110287uaq.53.1585006453359; Mon, 23 Mar 2020 16:34:13 -0700 (PDT) Date: Mon, 23 Mar 2020 16:33:53 -0700 In-Reply-To: <20200323233354.239365-1-kunyi@google.com> Message-Id: <20200323233354.239365-3-kunyi@google.com> Mime-Version: 1.0 References: <20200323233354.239365-1-kunyi@google.com> X-Mailer: git-send-email 2.25.1.696.g5e7596f4ac-goog Subject: [PATCH linux hwmon-next v2 2/3] hwmon: (sbtsi) Add documentation From: Kun Yi To: jdelvare@suse.com, linux@roeck-us.net, robh+dt@kernel.org, mark.rutland@arm.com Cc: Kun Yi , openbmc@lists.ozlabs.org, joel@jms.id.au, linux-hwmon@vger.kernel.org, devicetree@vger.kernel.org, linux-kernel@vger.kernel.org Sender: linux-hwmon-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-hwmon@vger.kernel.org Document the SB-TSI sensor interface driver. Signed-off-by: Kun Yi Change-Id: I4b086a124d1d94a516386b0d2ff1cd7180b1dac1 --- Documentation/hwmon/sbtsi_temp.rst | 40 ++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 Documentation/hwmon/sbtsi_temp.rst diff --git a/Documentation/hwmon/sbtsi_temp.rst b/Documentation/hwmon/sbtsi_temp.rst new file mode 100644 index 000000000000..9f0f197c8aa2 --- /dev/null +++ b/Documentation/hwmon/sbtsi_temp.rst @@ -0,0 +1,40 @@ +Kernel driver sbtsi_temp +================== + +Supported hardware: + + * Sideband interface (SBI) Temperature Sensor Interface (SB-TSI) + compliant AMD SoC temperature device. + + Prefix: 'sbtsi_temp' + + Addresses scanned: This driver doesn't support address scanning. + + To instantiate this driver on an AMD CPU with SB-TSI + support, the i2c bus number would be the bus connected from the board + management controller (BMC) to the CPU. The i2c address is specified in + Section 6.3.1 of the SoC register reference: The SB-TSI address is normally + 98h for socket 0 and 90h for socket 1, but it could vary based on hardware + address select pins. + + Datasheet: The SB-TSI interface and protocol is available as part of + the open source SoC register reference at: + + https://www.amd.com/system/files/TechDocs/56255_OSRR.pdf + + The Advanced Platform Management Link (APML) Specification is + available at: + + http://developer.amd.com/wordpress/media/2012/10/41918.pdf + +Author: Kun Yi + +Description +----------- + +The SBI temperature sensor interface (SB-TSI) is an emulation of the software +and physical interface of a typical 8-pin remote temperature sensor (RTS) on +AMD SoCs. It implements one temperature sensor with readings and limit +registers encode the temperature in increments of 0.125 from 0 to 255.875. +Limits can be set through the writable thresholds, and if reached will trigger +corresponding alert signals.