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=-12.3 required=3.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS, INCLUDES_PATCH,MAILING_LIST_MULTI,NICE_REPLY_A,SIGNED_OFF_BY,SPF_HELO_NONE, SPF_PASS,URIBL_BLOCKED,USER_AGENT_SANE_1 autolearn=ham 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 E1133C388F7 for ; Wed, 28 Oct 2020 22:25:09 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 857B120704 for ; Wed, 28 Oct 2020 22:25:09 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (1024-bit key) header.d=redhat.com header.i=@redhat.com header.b="QJMfoN4o" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1732828AbgJ1WZI (ORCPT ); Wed, 28 Oct 2020 18:25:08 -0400 Received: from us-smtp-delivery-124.mimecast.com ([216.205.24.124]:49497 "EHLO us-smtp-delivery-124.mimecast.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1732806AbgJ1WZG (ORCPT ); Wed, 28 Oct 2020 18:25:06 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1603923903; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=sq1B8u8NLUEB8OJpFZ9ZPM/0L4/ZYp1FVYQZCWkCea0=; b=QJMfoN4oYHNnQCMpewagHKJbpwrphefKQ/4+CPvqMsnYceFMPgxNivIkuhjt1p1AYxLyfz y5Az/LxE7nNQIBdyvip6zZlyeKvxatq+Hf5B3uS2Hn35/ha8L+C2SSy3mMhH1SrrOC+6Tn F1BmyrQAoY2w332xVa7ix5BnRZDVSfU= Received: from mail-ed1-f70.google.com (mail-ed1-f70.google.com [209.85.208.70]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-259-J1ZLOiKJMaekqUyjKCDCUQ-1; Wed, 28 Oct 2020 13:23:16 -0400 X-MC-Unique: J1ZLOiKJMaekqUyjKCDCUQ-1 Received: by mail-ed1-f70.google.com with SMTP id b16so67431edn.6 for ; Wed, 28 Oct 2020 10:23:16 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:subject:to:cc:references:from:message-id:date :user-agent:mime-version:in-reply-to:content-language :content-transfer-encoding; bh=sq1B8u8NLUEB8OJpFZ9ZPM/0L4/ZYp1FVYQZCWkCea0=; b=a3ZIp9eojQAFzFB1EgczrKdjvQyiZArRCs+cfxw3EBHovd3EfJ34EyKKPsk5Q6/gNo oUld8xCRKFAvFVVKI62mDANpZBBew9xuRmfQDgv/w/guHXa3FuwmvzvvpHs6x3WudBsM VpdF4ZueWjtAP1smvN943xOH8iajv2Qvfsm6D4AiHxMuuajN0EMrP/B+oXgJNrMi/yb4 hUmYbcGF6rbrEw0fMGMCqWBdYVLZYVbOTrd6lfhwQ0SFeowjWuwtepmDZ3rJO/RkacUv WLVUlEWoir7Id0JiER2B7VQRXDyS2AARn8ygrSrnX4+UlyQlx58LoT8fn2DG0vLqV7E4 4hPQ== X-Gm-Message-State: AOAM533lvELcFWbLPcf2wsS2Q2pl+hqsspWx5copsFk5Sc7PShn2X2HD 7i6m/5LpN4yr0492QmtfKxnc7t5CWJy2BLR+KnQO23V09causKftyUWc+hhaRn5JSV1UEYz40II xbrg1YDSqkdb2VxRNKFM= X-Received: by 2002:a17:906:6453:: with SMTP id l19mr125877ejn.366.1603905794988; Wed, 28 Oct 2020 10:23:14 -0700 (PDT) X-Google-Smtp-Source: ABdhPJzREE5X9JMuMW0uT+945/sNIo/Jw2GIPaYjye6jFS3w2G6zpJDNsvl2GTmVFhYI71fL0HiW4A== X-Received: by 2002:a17:906:6453:: with SMTP id l19mr125853ejn.366.1603905794640; Wed, 28 Oct 2020 10:23:14 -0700 (PDT) Received: from x1.localdomain (2001-1c00-0c0c-fe00-6c10-fbf3-14c4-884c.cable.dynamic.v6.ziggo.nl. [2001:1c00:c0c:fe00:6c10:fbf3:14c4:884c]) by smtp.gmail.com with ESMTPSA id l17sm112230eji.14.2020.10.28.10.23.13 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Wed, 28 Oct 2020 10:23:13 -0700 (PDT) Subject: Re: [PATCH] Documentation: Add documentation for new platform_profile sysfs attribute To: Bastien Nocera , Mark Pearson Cc: dvhart@infradead.org, mgross@linux.intel.com, mario.limonciello@dell.com, eliadevito@gmail.com, bberg@redhat.com, linux-pm@vger.kernel.org, linux-acpi@vger.kernel.org, platform-driver-x86@vger.kernel.org, linux-kernel@vger.kernel.org References: <20201027164219.868839-1-markpearson@lenovo.com> <5ca1ae238b23a611b8a490c244fd93cdcc36ef79.camel@hadess.net> From: Hans de Goede Message-ID: Date: Wed, 28 Oct 2020 18:23:13 +0100 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101 Thunderbird/78.3.1 MIME-Version: 1.0 In-Reply-To: <5ca1ae238b23a611b8a490c244fd93cdcc36ef79.camel@hadess.net> Content-Type: text/plain; charset=utf-8 Content-Language: en-US Content-Transfer-Encoding: 8bit Precedence: bulk List-ID: X-Mailing-List: linux-pm@vger.kernel.org Hi, On 10/28/20 2:45 PM, Bastien Nocera wrote: > Hey Hans, Mark, > > On Tue, 2020-10-27 at 12:42 -0400, Mark Pearson wrote: >> From: Hans de Goede >> >> On modern systems the platform performance, temperature, fan and >> other >> hardware related characteristics are often dynamically configurable. >> The >> profile is often automatically adjusted to the load by somei >> automatic-mechanism (which may very well live outside the kernel). >> >> These auto platform-adjustment mechanisms often can be configured >> with >> one of several 'platform-profiles', with either a bias towards low- >> power > > Can you please make sure to quote 'platform-profile' and 'profile-name' > this way all through the document? They're not existing words, and > quoting them shows that they're attribute names, rather than English. > >> consumption or towards performance (and higher power consumption and >> thermals). > > s/thermal/temperature/ > > "A thermal" is something else (it's seasonal underwear for me ;) > >> Introduce a new platform_profile sysfs API which offers a generic API >> for >> selecting the performance-profile of these automatic-mechanisms. >> >> Co-developed-by: Mark Pearson >> Signed-off-by: Mark Pearson >> Signed-off-by: Hans de Goede >> --- >> Changes in V1: >>  - Moved from RFC to proposed patch >>  - Added cool profile as requested >>  - removed extra-profiles as no longer relevant >> >>  .../ABI/testing/sysfs-platform_profile        | 66 >> +++++++++++++++++++ >>  1 file changed, 66 insertions(+) >>  create mode 100644 Documentation/ABI/testing/sysfs-platform_profile >> >> diff --git a/Documentation/ABI/testing/sysfs-platform_profile >> b/Documentation/ABI/testing/sysfs-platform_profile >> new file mode 100644 >> index 000000000000..240bd3d7532b >> --- /dev/null >> +++ b/Documentation/ABI/testing/sysfs-platform_profile >> @@ -0,0 +1,66 @@ >> +Platform-profile selection (e.g. >> /sys/firmware/acpi/platform_profile) >> + >> +On modern systems the platform performance, temperature, fan and >> other >> +hardware related characteristics are often dynamically configurable. >> The >> +profile is often automatically adjusted to the load by some >> +automatic-mechanism (which may very well live outside the kernel). >> + >> +These auto platform-adjustment mechanisms often can be configured >> with >> +one of several 'platform-profiles', with either a bias towards low- >> power >> +consumption or towards performance (and higher power consumption and >> +thermals). >> + >> +The purpose of the platform_profile attribute is to offer a generic >> sysfs >> +API for selecting the platform-profile of these automatic- >> mechanisms. >> + >> +Note that this API is only for selecting the platform-profile, it is >> +NOT a goal of this API to allow monitoring the resulting performance >> +characteristics. Monitoring performance is best done with >> device/vendor >> +specific tools such as e.g. turbostat. >> + >> +Specifically when selecting a high-performance profile the actual >> achieved >> +performance may be limited by various factors such as: the heat >> generated >> +by other components, room temperature, free air flow at the bottom >> of a >> +laptop, etc. It is explicitly NOT a goal of this API to let >> userspace know >> +about any sub-optimal conditions which are impeding reaching the >> requested >> +performance level. >> + >> +Since numbers are a rather meaningless way to describe platform- >> profiles > > It's not meaningless, but rather ambiguous. For a range of 1 to 5, is 1 > high performance, and 5 low power, or vice-versa? It is meaningless because the space we are trying to describe with the profile-names is not 1 dimensional. E.g. as discussed before cool and low-power are not necessarily the same thing. If you have a better way to word this I'm definitely in favor of improving the text here. > >> +this API uses strings to describe the various profiles. To make sure >> that >> +userspace gets a consistent experience when using this API this API > > you can remove "when using this API". > >> +document defines a fixed set of profile-names. Drivers *must* map >> their >> +internal profile representation/names onto this fixed set. >> + >> +If for some reason there is no good match when mapping then a new >> profile-name >> +may be added. > > "for some reason" can be removed. > >> Drivers which wish to introduce new profile-names must: >> +1. Have very good reasons to do so. > > "1. Explain why the existing 'profile-names' cannot be used" > >> +2. Add the new profile-name to this document, so that future drivers >> which also >> +   have a similar problem can use the same name. > > "2. Add the new 'profile-name' to the documentation so that other > drivers can use it, as well as user-space knowing clearly what > behaviour the 'profile-name' corresponds to" > >> + >> +What:          /sys/firmware/acpi/platform_profile_choices >> +Date:          October 2020 >> +Contact:       Hans de Goede >> +Description: >> +               Reading this file gives a space separated list of >> profiles >> +               supported for this device. > > "This file contains a space-separated list of profiles..." > >> + >> +               Drivers must use the following standard profile- >> names: >> + >> +               low-power:              Emphasises low power >> consumption >> +               cool:                   Emphasises cooler operation >> +               quiet:                  Emphasises quieter operation >> +               balanced:               Balance between low power >> consumption >> +                                       and performance >> +               performance:            Emphasises performance (and >> may lead to >> +                                       higher temperatures and fan >> speeds) > > I'd replace "Emphasises" with either "Focus on" or the US English > spelling of "Emphasizes". > >> +               Userspace may expect drivers to offer at least >> several of these >> +               standard profile-names. > > Replce "at least several" with "more than one". > >> + >> +What:          /sys/firmware/acpi/platform_profile >> +Date:          October 2020 >> +Contact:       Hans de Goede >> +Description: >> +               Reading this file gives the current selected profile >> for this >> +               device. Writing this file with one of the strings >> from >> +               available_profiles changes the profile to the new >> value. > > Is there another file which explains whether those sysfs value will > contain a trailing linefeed? sysfs APIs are typically created so that they can be used from the shell, so on read a newline will be added. On write a newline at the end typically is allowed, but ignored. There are even special helper functions to deal with properly ignoring the newline on write. Regards, Hans