From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-26.2 required=3.0 tests=BAYES_00,DKIMWL_WL_MED, DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS, INCLUDES_CR_TRAILER,INCLUDES_PATCH,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS, URIBL_BLOCKED,USER_AGENT_GIT,USER_IN_DEF_DKIM_WL autolearn=unavailable autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id CB7F6C433FE for ; Fri, 11 Dec 2020 22:50:27 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 955912065D for ; Fri, 11 Dec 2020 22:50:27 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S2403786AbgLKV4d (ORCPT ); Fri, 11 Dec 2020 16:56:33 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:56980 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S2393341AbgLKVz4 (ORCPT ); Fri, 11 Dec 2020 16:55:56 -0500 Received: from mail-qv1-xf49.google.com (mail-qv1-xf49.google.com [IPv6:2607:f8b0:4864:20::f49]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 23910C0617A6 for ; Fri, 11 Dec 2020 13:54:40 -0800 (PST) Received: by mail-qv1-xf49.google.com with SMTP id j24so7390043qvg.8 for ; Fri, 11 Dec 2020 13:54:40 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20161025; h=sender:date:in-reply-to:message-id:mime-version:references:subject :from:to:cc; bh=NTgAB1mD14VMd3H1Bqnr5TwzQles0E7KUIMRK7pxIo4=; b=Ei3QYeJaw8u4bJidom09HkjHpuNV7TW9znoZOUb4X/jhtx5u9U56HbhV+e516TF4hb jMB34gJcOiEZVx+fMAoVtd2qcWnyt+PmV/MnDZvivzmRyULPhLwARgL284zy+Dv+Tho2 +/ABEs3efbNCRvq/WLBlQDJXGtffyi1nhN0kbgqpmzfot6OoYLqM+jKzg1gsGCz8AEza eZOhhV7W3kwLJcu2n31rHlOuZ+pre9AQx8+zb9NPvCnnIpv72c0zfQ+yJONXMVQO4FlB IneCRunuV8ftUt56bvXRXnF0OlJgLXClej/rWPmZ7ONQb3ekrOU4Qt9TiY7wyS3zIyrx 6EZg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:sender:date:in-reply-to:message-id:mime-version :references:subject:from:to:cc; bh=NTgAB1mD14VMd3H1Bqnr5TwzQles0E7KUIMRK7pxIo4=; b=gn+NOC7UrYa5+GGFL5e7NF0FMioUHcXA6YyLvl7pNlnTQ4D/IuGjdyACP/QBrEtQHT b9rcb185WmTwWvfFqn6ErtzFkIKlvBfBp4hDaJibSEtAfuhSVgRaW+fMBXOB0T7UfYq0 aAwBSssLrHQOnM9rWuvzUYey86E54n2ugpfzJb1OZNHlEoo597yxLTZVSshWOuU1IrXT sxPsv3JWdkzfXawRG58S8PlGPrJyTV5Hf3ychv66j0yRi49Q++2hcwXVIPKB8VfRMkKW xnNG4fnUj96FTIToOb5i0qR0A1OYV/a+GOiWKs3YH5V/BdqKzDnYHYf0owVSRgw14BLY tWAQ== X-Gm-Message-State: AOAM531/6GaOupcOOpRHvkZ1LRYSXy0q1KGrvYKXiQil8n1qzTOeqyiP L9KIFJzvT9WsAjVBOwWlSAMmAzq3fQ== X-Google-Smtp-Source: ABdhPJyVa+Y3FutrLWi8X1KGlRYrBlVNq40nJupQDbBYEPgST1GAmYH1QW4XMUiAfDuET0G/NH3iztLh+Q== Sender: "kunyi via sendgmr" X-Received: from kunyi0.svl.corp.google.com ([2620:15c:2c5:3:9657:a5ff:fef2:53bd]) (user=kunyi job=sendgmr) by 2002:a0c:bd2b:: with SMTP id m43mr17844211qvg.32.1607723679283; Fri, 11 Dec 2020 13:54:39 -0800 (PST) Date: Fri, 11 Dec 2020 13:54:26 -0800 In-Reply-To: <20201211215427.3281681-1-kunyi@google.com> Message-Id: <20201211215427.3281681-3-kunyi@google.com> Mime-Version: 1.0 References: <20201211215427.3281681-1-kunyi@google.com> X-Mailer: git-send-email 2.29.2.684.gfbc64c5ab5-goog Subject: [PATCH linux hwmon-next v5 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, supreeth.venkatesh@amd.com Cc: Kun Yi , openbmc@lists.ozlabs.org, linux-hwmon@vger.kernel.org, devicetree@vger.kernel.org, linux-kernel@vger.kernel.org Content-Type: text/plain; charset="UTF-8" Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Document the SB-TSI sensor interface driver. Signed-off-by: Kun Yi --- Documentation/hwmon/index.rst | 1 + Documentation/hwmon/sbtsi_temp.rst | 40 ++++++++++++++++++++++++++++++ 2 files changed, 41 insertions(+) create mode 100644 Documentation/hwmon/sbtsi_temp.rst diff --git a/Documentation/hwmon/index.rst b/Documentation/hwmon/index.rst index fd6fae46b99c..509fb3bcafb2 100644 --- a/Documentation/hwmon/index.rst +++ b/Documentation/hwmon/index.rst @@ -151,6 +151,7 @@ Hardware Monitoring Kernel Drivers pxe1610 pwm-fan raspberrypi-hwmon + sbtsi_temp sch5627 sch5636 scpi-hwmon 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. -- 2.29.2.684.gfbc64c5ab5-goog