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=-13.1 required=3.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,INCLUDES_PATCH,MAILING_LIST_MULTI, SIGNED_OFF_BY,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED,USER_AGENT_GIT 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 3244FC4363A for ; Thu, 29 Oct 2020 01:01:18 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id DE7AC20790 for ; Thu, 29 Oct 2020 01:01:17 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1603933277; bh=BSLIz8E0JZ7idq+zhtY5XcS7wRuz1+joqryrudORZZ8=; h=From:To:Cc:Subject:Date:In-Reply-To:References:List-ID:From; b=LnOIc9G7qMSYzLtAiyZYRyeWhTxb2wPElnnKm5IAi2ggfDJh7jr6PRf/uVqbsLETd 5na7p60OSqPgoktWbSYun+rN3K49UXBK3c9UdhEvsc8hqmHE2EqID8YlomEgwNpsen HmlUS6oHJsa6Pc2aiAu1/uQ9HIFf/nBFoZa9KlsE= Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S2404062AbgJ2BBQ (ORCPT ); Wed, 28 Oct 2020 21:01:16 -0400 Received: from mail.kernel.org ([198.145.29.99]:60514 "EHLO mail.kernel.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1731526AbgJ1WR1 (ORCPT ); Wed, 28 Oct 2020 18:17:27 -0400 Received: from mail.kernel.org (ip5f5ad5b2.dynamic.kabel-deutschland.de [95.90.213.178]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPSA id 1BDDA247DB; Wed, 28 Oct 2020 14:23:36 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1603895016; bh=BSLIz8E0JZ7idq+zhtY5XcS7wRuz1+joqryrudORZZ8=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=LL4ovI/4qm0nZwmyaqsCoP00BXE7PgYw9sV9kCxAHePFVnnrw0C7FUpYRCOpLOS8V Ggha1JDCLfm3MQ53lRRwu2wfdTljqkmX7cHkSFqXVL76BW33ZLdglHXZN6EZOOBIco gHxh56CYwHMHTIvXJlSCMr0O5ufw1hb6kFT+wHbQ= Received: from mchehab by mail.kernel.org with local (Exim 4.94) (envelope-from ) id 1kXmMQ-003hmG-2B; Wed, 28 Oct 2020 15:23:34 +0100 From: Mauro Carvalho Chehab To: Linux Doc Mailing List , Greg Kroah-Hartman Cc: Mauro Carvalho Chehab , "Jonathan Corbet" , Dan Murphy , Jacek Anaszewski , Pavel Machek , linux-kernel@vger.kernel.org Subject: [PATCH 33/33] docs: ABI: unify /sys/class/leds//max_brightness documentation Date: Wed, 28 Oct 2020 15:23:31 +0100 Message-Id: <2c95a4d8d1b4be2f839464ebc63bfcee6b70276a.1603893146.git.mchehab+huawei@kernel.org> X-Mailer: git-send-email 2.26.2 In-Reply-To: References: MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Sender: Mauro Carvalho Chehab Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org This ABI is defined twice, one for normal leds and another one for multicolor ones. Ensure that just one definition is there at ABI. Signed-off-by: Mauro Carvalho Chehab --- Documentation/ABI/testing/sysfs-class-led | 25 ++++++++++++++++--- .../ABI/testing/sysfs-class-led-multicolor | 23 +++++------------ 2 files changed, 28 insertions(+), 20 deletions(-) diff --git a/Documentation/ABI/testing/sysfs-class-led b/Documentation/ABI/testing/sysfs-class-led index 0ed5c2629c6f..2e24ac3bd7ef 100644 --- a/Documentation/ABI/testing/sysfs-class-led +++ b/Documentation/ABI/testing/sysfs-class-led @@ -3,9 +3,26 @@ Date: March 2006 KernelVersion: 2.6.17 Contact: Richard Purdie Description: - Set the brightness of the LED. Most LEDs don't - have hardware brightness support, so will just be turned on for - non-zero brightness settings. The value is between 0 and + Set the brightness of the LED. + + Most LEDs don't have hardware brightness support, so will + just be turned on for non-zero brightness settings. + + .. Note:: + + For multicolor LEDs, writing to this file will update all + LEDs within the group to a calculated percentage of what + each color LED intensity is set to. + + The percentage is calculated for each grouped LED via + the equation below:: + + led_brightness = brightness * multi_intensity/max_brightness + + For additional details please refer to + Documentation/leds/leds-class-multicolor.rst. + + The value is between 0 and /sys/class/leds//max_brightness. Writing 0 to this file clears active trigger. @@ -13,6 +30,8 @@ Description: Writing non-zero to this file while trigger is active changes the top brightness trigger is going to use. + + What: /sys/class/leds//max_brightness Date: March 2006 KernelVersion: 2.6.17 diff --git a/Documentation/ABI/testing/sysfs-class-led-multicolor b/Documentation/ABI/testing/sysfs-class-led-multicolor index eeeddcbdbbe3..16fc827b10cb 100644 --- a/Documentation/ABI/testing/sysfs-class-led-multicolor +++ b/Documentation/ABI/testing/sysfs-class-led-multicolor @@ -1,20 +1,3 @@ -What: /sys/class/leds//brightness -Date: March 2020 -KernelVersion: 5.9 -Contact: Dan Murphy -Description: read/write - Writing to this file will update all LEDs within the group to a - calculated percentage of what each color LED intensity is set - to. The percentage is calculated for each grouped LED via the - equation below: - - led_brightness = brightness * multi_intensity/max_brightness - - For additional details please refer to - Documentation/leds/leds-class-multicolor.rst. - - The value of the LED is from 0 to - /sys/class/leds//max_brightness. What: /sys/class/leds//multi_index Date: March 2020 @@ -25,6 +8,9 @@ Description: read as an array of strings as they are indexed in the multi_intensity file. + For additional details please refer to + Documentation/leds/leds-class-multicolor.rst. + What: /sys/class/leds//multi_intensity Date: March 2020 KernelVersion: 5.9 @@ -33,3 +19,6 @@ Description: read/write This file contains array of integers. Order of components is described by the multi_index array. The maximum intensity should not exceed /sys/class/leds//max_brightness. + + For additional details please refer to + Documentation/leds/leds-class-multicolor.rst. -- 2.26.2