From patchwork Mon Jan 21 11:17:21 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Quentin Perret X-Patchwork-Id: 10773653 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 303E2746 for ; Mon, 21 Jan 2019 11:17:33 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 1318A296C2 for ; Mon, 21 Jan 2019 11:17:33 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 0640429C77; Mon, 21 Jan 2019 11:17:33 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-7.9 required=2.0 tests=BAYES_00,MAILING_LIST_MULTI, RCVD_IN_DNSWL_HI autolearn=ham version=3.3.1 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 7FC8D296C2 for ; Mon, 21 Jan 2019 11:17:32 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1727855AbfAULRb (ORCPT ); Mon, 21 Jan 2019 06:17:31 -0500 Received: from usa-sjc-mx-foss1.foss.arm.com ([217.140.101.70]:59762 "EHLO foss.arm.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726165AbfAULRb (ORCPT ); Mon, 21 Jan 2019 06:17:31 -0500 Received: from usa-sjc-imap-foss1.foss.arm.com (unknown [10.72.51.249]) by usa-sjc-mx-foss1.foss.arm.com (Postfix) with ESMTP id 19434EBD; Mon, 21 Jan 2019 03:17:31 -0800 (PST) Received: from queper01-lin.cambridge.arm.com (queper01-lin.cambridge.arm.com [10.1.195.48]) by usa-sjc-imap-foss1.foss.arm.com (Postfix) with ESMTPSA id 046553F5C1; Mon, 21 Jan 2019 03:17:28 -0800 (PST) From: Quentin Perret To: corbet@lwn.net, peterz@infradead.org, rjw@rjwysocki.net, juri.lelli@redhat.com Cc: mingo@redhat.com, morten.rasmussen@arm.com, qais.yousef@arm.com, patrick.bellasi@arm.com, dietmar.eggemann@arm.com, linux-doc@vger.kernel.org, linux-pm@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH v2 0/3] Documentation: Explain EAS and EM Date: Mon, 21 Jan 2019 11:17:21 +0000 Message-Id: <20190121111724.18234-1-quentin.perret@arm.com> X-Mailer: git-send-email 2.20.1 MIME-Version: 1.0 Sender: linux-pm-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-pm@vger.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP The recently introduced Energy Aware Scheduling (EAS) feature relies on a large set of concepts, assumptions, and design choices that are probably not obvious for an outsider. Moreover, enabling EAS on a particular platform isn't straightforward because of all its dependencies. This series tries to address this by introducing proper documentation files for the scheduler's part of EAS and for the newly introduced Energy Model (EM) framework. These are meant to explain not only the design choices of EAS but also to list its dependencies in a human-readable location. Changes in v2: - Fixed typos and style in sched-energy.txt (Juri) - Moved EM doc under Documentation/driver-api/pm/ (Rafael) - Translated EM doc into .rst (Rafael) - Fixed EM kerneldoc comments to avoid htmldoc build errors Quentin Perret (3): PM / EM: Fix broken kerneldoc PM / EM: Document the Energy Model framework sched: Document Energy Aware Scheduling Documentation/driver-api/pm/energy-model.rst | 150 +++++++ Documentation/driver-api/pm/index.rst | 1 + Documentation/scheduler/sched-energy.txt | 431 +++++++++++++++++++ include/linux/energy_model.h | 4 +- kernel/power/energy_model.c | 2 +- 5 files changed, 585 insertions(+), 3 deletions(-) create mode 100644 Documentation/driver-api/pm/energy-model.rst create mode 100644 Documentation/scheduler/sched-energy.txt