From patchwork Wed Sep 11 18:01:08 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Dan Murphy X-Patchwork-Id: 173630 Delivered-To: patch@linaro.org Received: by 2002:ac9:19ad:0:0:0:0:0 with SMTP id d45csp1102355oce; Wed, 11 Sep 2019 11:01:36 -0700 (PDT) X-Google-Smtp-Source: APXvYqygzo5gincfEJllknMqE5r0FZfD0pIoyxS0YJMDc1UdLqTky9ZfVGe87cy9kBS3voycrijJ X-Received: by 2002:a50:d68a:: with SMTP id r10mr38147835edi.151.1568224896876; Wed, 11 Sep 2019 11:01:36 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1568224896; cv=none; d=google.com; s=arc-20160816; b=O65flj+/EBsLKqm76pyHCKZqJFt1TMV0THqejNuzqHEO7mg6On670B9JCcnnrzFyVx KicyK3DQy2DjngpyuyPUsUJ9GTcGM9yGp8AEFnjOAD8s1G9L5m4j3z6l+Jk719Ofu4RR vu26uHtUXzNibHHLPK/l51v/sArd4Og7M90rK14BrguGOQnN+nUPmk4SN5Q93gsiWYmJ 7zflQelQO7pfn+shWk49K9ySDyYK6mTGYTaznwXr0mrzCqYVwUoi1SN+AQOY8rWCOTsx RhfSfEQUkHo4bbzGuz32mEdHYMAQ+YEmSEX+MJlGVlhqOOo4DQf/NZ/vden/SajInTO1 wSQQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:sender:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=S8BtTodIkwTN2xYbwppqWLNg7DkbMnBekNn+USRsSks=; b=q40rJv0rVTvKv3GB/DZ3lfHQVaWaPoI9yPZd1xFf5e+a2TkPMr2tcKrW2MaJ8UTfVz q4pgNktm42W57P5031LWKexeiQayRAOPr+SLNyrL+tiGPDOBbvS9IzVNyv9DndzxNYQt 39BFfs40hDfhPS7zKw6S9XCTADUODGEjCUxeqNnyr0scw5YPedJe2Q7HNh3sW4D05jZp 9CDR3EVXWkHeX0hgratcJGr+GjFK/lpBsAbmk3n6bqW/7jxN3ibtL4+c+OUSjXqpXMBx 3UCN4Q7P3y1vQq6NRPOs3blV/vTB3H0/d4g/qKMazgJwBTt+9pNH9GfGi8xFLbdHMXqC YXiQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@ti.com header.s=ti-com-17Q1 header.b=OMWrhrtZ; spf=pass (google.com: best guess record for domain of linux-leds-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-leds-owner@vger.kernel.org; dmarc=pass (p=QUARANTINE sp=NONE dis=NONE) header.from=ti.com Return-Path: Received: from vger.kernel.org (vger.kernel.org. [209.132.180.67]) by mx.google.com with ESMTP id t10si7434074eds.369.2019.09.11.11.01.36; Wed, 11 Sep 2019 11:01:36 -0700 (PDT) Received-SPF: pass (google.com: best guess record for domain of linux-leds-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67; Authentication-Results: mx.google.com; dkim=pass header.i=@ti.com header.s=ti-com-17Q1 header.b=OMWrhrtZ; spf=pass (google.com: best guess record for domain of linux-leds-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-leds-owner@vger.kernel.org; dmarc=pass (p=QUARANTINE sp=NONE dis=NONE) header.from=ti.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1729934AbfIKSBg (ORCPT + 1 other); Wed, 11 Sep 2019 14:01:36 -0400 Received: from fllv0015.ext.ti.com ([198.47.19.141]:55976 "EHLO fllv0015.ext.ti.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1729729AbfIKSBX (ORCPT ); Wed, 11 Sep 2019 14:01:23 -0400 Received: from fllv0034.itg.ti.com ([10.64.40.246]) by fllv0015.ext.ti.com (8.15.2/8.15.2) with ESMTP id x8BI1Hce000896; Wed, 11 Sep 2019 13:01:17 -0500 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=ti.com; s=ti-com-17Q1; t=1568224877; bh=S8BtTodIkwTN2xYbwppqWLNg7DkbMnBekNn+USRsSks=; h=From:To:CC:Subject:Date:In-Reply-To:References; b=OMWrhrtZwk9VJEOtsN8gA8chauwX/Pbfdp5YfghNlWeWSsVxRwLMBg4OdwWJMhxGD PArtS/V1bd+XK1BpqRcGDhD1SZOhM7PSaFPPh0SLG1pIQqkABlPIcBb8kdRBn3e2H4 IEG8rVYrD0O+XRrAF1/o4hcT9O2Dq5e5QAzicW7E= Received: from DLEE112.ent.ti.com (dlee112.ent.ti.com [157.170.170.23]) by fllv0034.itg.ti.com (8.15.2/8.15.2) with ESMTPS id x8BI1HCV007240 (version=TLSv1.2 cipher=AES256-GCM-SHA384 bits=256 verify=FAIL); Wed, 11 Sep 2019 13:01:17 -0500 Received: from DLEE115.ent.ti.com (157.170.170.26) by DLEE112.ent.ti.com (157.170.170.23) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256_P256) id 15.1.1713.5; Wed, 11 Sep 2019 13:01:17 -0500 Received: from lelv0326.itg.ti.com (10.180.67.84) by DLEE115.ent.ti.com (157.170.170.26) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256_P256) id 15.1.1713.5 via Frontend Transport; Wed, 11 Sep 2019 13:01:17 -0500 Received: from localhost (ileax41-snat.itg.ti.com [10.172.224.153]) by lelv0326.itg.ti.com (8.15.2/8.15.2) with ESMTP id x8BI1HMi063840; Wed, 11 Sep 2019 13:01:17 -0500 From: Dan Murphy To: , CC: , , , Dan Murphy Subject: [PATCH v5 2/9] documention: leds: Add multicolor class documentation Date: Wed, 11 Sep 2019 13:01:08 -0500 Message-ID: <20190911180115.21035-3-dmurphy@ti.com> X-Mailer: git-send-email 2.22.0.214.g8dca754b1e In-Reply-To: <20190911180115.21035-1-dmurphy@ti.com> References: <20190911180115.21035-1-dmurphy@ti.com> MIME-Version: 1.0 X-EXCLAIMER-MD-CONFIG: e1e8a2fd-e40a-4ac6-ac9b-f7e9cc9ee180 Sender: linux-leds-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-leds@vger.kernel.org Add the support documentation on the multicolor LED framework. This document defines the directores and file generated by the multicolor framework. It also documents usage. Signed-off-by: Dan Murphy --- Documentation/leds/index.rst | 1 + Documentation/leds/leds-class-multicolor.rst | 149 +++++++++++++++++++ 2 files changed, 150 insertions(+) create mode 100644 Documentation/leds/leds-class-multicolor.rst -- 2.22.0.214.g8dca754b1e diff --git a/Documentation/leds/index.rst b/Documentation/leds/index.rst index 060f4e485897..bc70c6aa7138 100644 --- a/Documentation/leds/index.rst +++ b/Documentation/leds/index.rst @@ -9,6 +9,7 @@ LEDs leds-class leds-class-flash + leds-class-multicolor ledtrig-oneshot ledtrig-transient ledtrig-usbport diff --git a/Documentation/leds/leds-class-multicolor.rst b/Documentation/leds/leds-class-multicolor.rst new file mode 100644 index 000000000000..0b40c85f417a --- /dev/null +++ b/Documentation/leds/leds-class-multicolor.rst @@ -0,0 +1,149 @@ +==================================== +Multi Color LED handling under Linux +==================================== + +Description +=========== +There are varying monochrome LED colors available for application. These +LEDs can be used as a single use case LED or can be mixed with other color +LEDs to produce the full spectrum of color. Color LEDs that are grouped +can be presented under a single LED node with individual color control. +The multicolor class groups these LEDs and allows dynamically setting the value +of a single LED or setting the intensity values of the LEDs in the group and +updating the LEDs virtually simultaneously. + +Multicolor Class Control +======================== +The multicolor class presents the LED groups under a directory called "colors". +This directory is a child under the LED parent node created by the led_class +framework. The led_class framework is documented in led-class.rst within this +documentation directory. + +Each colored LED is given its own directory. These directories will be one of +LED_COLOR_ID_* definitions from the header include/dt-bindings/leds/common.h. +Under these directories the intensity and max_intensity files are presented for +each LED. + +Directory Layout Example +======================== +root:/sys/class/leds/rgb:grouped_leds# ls -lR colors/ +colors/: +drwxr-xr-x 2 root root 0 Jun 28 20:21 blue +drwxr-xr-x 2 root root 0 Jun 28 20:21 green +drwxr-xr-x 2 root root 0 Jun 28 20:21 red +-rw------- 1 root root 4096 Jun 28 20:21 color_mix + +colors/blue: +-rw------- 1 root root 4096 Jun 28 20:21 intensity +-r-------- 1 root root 4096 Jun 28 20:27 max_intensity +-r-------- 1 root root 4096 Jun 28 20:21 color_id + +colors/green: +-rw------- 1 root root 4096 Jun 28 20:22 intensity +-r-------- 1 root root 4096 Jun 28 20:27 max_intensity +-r-------- 1 root root 4096 Jun 28 20:21 color_id + +colors/red: +-rw------- 1 root root 4096 Jun 28 20:21 intensity +-r-------- 1 root root 4096 Jun 28 20:27 max_intensity +-r-------- 1 root root 4096 Jun 28 20:21 color_id + +Multicolor Color Mixing +======================= +Multicolor monochrome LEDs intensity can be modified and mixed to produce a +varying array of colors. The color_mix file gives the user the ability to write +all the monochrome LEDs registered in the directory with a single call. +To create a specific color from monochrome LEDs the color_mix file needs to be +written with each color's intensity. The order in which the monochrome LEDs +should be written is based on the colors color_id. The LEDs brightness will be +updated on the next call to the parent brightness file. + +For example: +cat /sys/class/leds/rgb:grouped_leds/red/color_id +0 +cat /sys/class/leds/rgb:grouped_leds/green/color_id +1 +cat /sys/class/leds/rgb:grouped_leds/blue/color_id +2 + +red - color_id = 0 +green - color_id = 1 +blue - color_id = 2 + +These id's are the order in which to write the color_mix file. + +echo " " > color_mix + +echo "80 00 80" > color_mix + +The order of the monochrome LEDs are determined during multicolor class +registration and will not change unless unregistered and re-registered. + +Other example with amber monochrome LED: +blue - color_id = 0 +amber - color_id = 1 + +In this example blue is at ID 0 and amber ID is 1 so the user would write +echo " " > color_mix + +echo "38 80" > color_mix + +If a single monochrome LED needs to be modified then the user would write the +colors//intensity file. + + +Multicolor Class Brightness Control +=================================== +The multiclor class framework will calculate each monochrome LEDs intensity. + +The brightness level for each LED is calculated based on the color LED +intensity setting divided by the color LED max intensity setting multiplied by +the requested value. + +led_brightness = requested_value * led_color_intensity/led_color_max_intensity + +Example: +Three LEDs are present in the group as defined in "Directory Layout Example" +within this document. + +A user first writes the color LED brightness file with the brightness level that +is necessary to achieve a blueish violet output from the RGB LED group. + +echo 138 > /sys/class/leds/rgb:grouped_leds/red/intensity +echo 43 > /sys/class/leds/rgb:grouped_leds/green/intensity +echo 226 > /sys/class/leds/rgb:grouped_leds/blue/intensity + +red - + intensity = 138 + max_intensity = 255 +green - + intensity = 43 + max_intensity = 255 +blue - + intensity = 226 + max_intensity = 255 + +The user can control the brightness of that RGB group by writing the parent +'brightness' control. Assuming a parent max_brightness of 255 the user may want +to dim the LED color group to half. The user would write a value of 128 to the +parent brightness file then the values written to each LED will be adjusted +base on this value + +cat /sys/class/leds/rgb:grouped_leds/max_brightness +255 +echo 128 > /sys/class/leds/rgb:grouped_leds/brightness + +adjusted_red_value = 128 * 138/255 = 69 +adjusted_green_value = 128 * 43/255 = 21 +adjusted_blue_value = 128 * 226/255 = 113 + +Reading the parent brightness file will return the current brightness value of +the color LED group. + +cat /sys/class/leds/rgb:grouped_leds/max_brightness +255 + +echo 128 > /sys/class/leds/rgb:grouped_leds/brightness + +cat /sys/class/leds/rgb:grouped_leds/max_brightness +128 From patchwork Wed Sep 11 18:01:11 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Dan Murphy X-Patchwork-Id: 173625 Delivered-To: patch@linaro.org Received: by 2002:ac9:19ad:0:0:0:0:0 with SMTP id d45csp1102052oce; Wed, 11 Sep 2019 11:01:23 -0700 (PDT) X-Google-Smtp-Source: APXvYqxlq4F6KO7ZOGcIfloXCfSRLm9UFz7Kn3dyk5SnF5clAy68S4s7XLaensrv22SR067KsUUP X-Received: by 2002:a17:906:804d:: with SMTP id x13mr30533804ejw.134.1568224883445; Wed, 11 Sep 2019 11:01:23 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1568224883; cv=none; d=google.com; s=arc-20160816; b=l88/TGd/m3QkUKnI+kVouXcSIv3WDWMT6jop+8DuAc3kfV76UgIWlw6tPTo1f1U8m5 0FqwiEFh3enGcbGGniO033QtwREkcFJelE/EjbDzE9/Ry6LfFmntDATksgtfluPFR7Mn zBgaLPZD1xXJbtDf/R0DZXCQypDwW95JJpBLHDlhe5dq3wRZ5b+EQVk2DG+1YiAPKpAW CoRYDf6thbvAMjhvc7uLWwFuRqcq947Mn+B4v/0fLIfo/t8p9Iqe24Ej3IpeGCd61KDN 65GZxnbcOGJyJg+WYN6hANJAxR2SBaivy8L3CKnszq5j0gVU8ROQoeYwxQP5+E3eAnJV DjQQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:sender:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=vNLixCA7rV3r89geVpDyZT2afzJln66pkNhtKdigswM=; b=0OXp7UbNeFNwwIf/SkwEU1wvh/QOvZ+65UTWbh/cvuGcfRUBtS9wC7wAot3wYgBmsm JrH/CoIZlcjUabeIGVj4CLxYIagk90C6NZfrbFFoc80m8n74R9qRyUDQvt7qd0eTuudS gqCxGm1glfa5sTs5I8XMqJJApJz9uFns4d9TCVz0oNXgEGf3AfR3b0uKR0eFmG6CXM4i p2xPAYn+6ge9ztUtqeqonmav04+IYgUM17yGsK3caqJasTCQzBVb+4RTcWdqYHj08t/s WbCAe8gwv3xEgu4oCA73hxVf5obMrnvQEOOaibobwXBou69CnzdOzikB6hiwMCj1ZiWQ Hx9w== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@ti.com header.s=ti-com-17Q1 header.b=fT4ovEkL; spf=pass (google.com: best guess record for domain of linux-leds-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-leds-owner@vger.kernel.org; dmarc=pass (p=QUARANTINE sp=NONE dis=NONE) header.from=ti.com Return-Path: Received: from vger.kernel.org (vger.kernel.org. [209.132.180.67]) by mx.google.com with ESMTP id o46si14296339edc.124.2019.09.11.11.01.23; Wed, 11 Sep 2019 11:01:23 -0700 (PDT) Received-SPF: pass (google.com: best guess record for domain of linux-leds-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67; Authentication-Results: mx.google.com; dkim=pass header.i=@ti.com header.s=ti-com-17Q1 header.b=fT4ovEkL; spf=pass (google.com: best guess record for domain of linux-leds-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-leds-owner@vger.kernel.org; dmarc=pass (p=QUARANTINE sp=NONE dis=NONE) header.from=ti.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1729828AbfIKSBW (ORCPT + 1 other); Wed, 11 Sep 2019 14:01:22 -0400 Received: from lelv0143.ext.ti.com ([198.47.23.248]:36752 "EHLO lelv0143.ext.ti.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1729730AbfIKSBW (ORCPT ); Wed, 11 Sep 2019 14:01:22 -0400 Received: from lelv0265.itg.ti.com ([10.180.67.224]) by lelv0143.ext.ti.com (8.15.2/8.15.2) with ESMTP id x8BI1Ieo040457; Wed, 11 Sep 2019 13:01:18 -0500 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=ti.com; s=ti-com-17Q1; t=1568224878; bh=vNLixCA7rV3r89geVpDyZT2afzJln66pkNhtKdigswM=; h=From:To:CC:Subject:Date:In-Reply-To:References; b=fT4ovEkLclgrgoZ1v34Cs0sapi+6kmlm9zz3FeQZgpLyWLPeUBZCH0tUF18vksrwH F2XUbr3fcIWdCB2hfz1vSaji6J+DcWt7Rf+L4SUZ9IiMfoND3mkM/JY8avMyaYWtIE zXn6LwrD5TBy5rWYkf/pe3/olIyjVMVrWFuxrHaI= Received: from DLEE108.ent.ti.com (dlee108.ent.ti.com [157.170.170.38]) by lelv0265.itg.ti.com (8.15.2/8.15.2) with ESMTPS id x8BI1Iq3043770 (version=TLSv1.2 cipher=AES256-GCM-SHA384 bits=256 verify=FAIL); Wed, 11 Sep 2019 13:01:18 -0500 Received: from DLEE105.ent.ti.com (157.170.170.35) by DLEE108.ent.ti.com (157.170.170.38) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256_P256) id 15.1.1713.5; Wed, 11 Sep 2019 13:01:17 -0500 Received: from lelv0327.itg.ti.com (10.180.67.183) by DLEE105.ent.ti.com (157.170.170.35) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256_P256) id 15.1.1713.5 via Frontend Transport; Wed, 11 Sep 2019 13:01:17 -0500 Received: from localhost (ileax41-snat.itg.ti.com [10.172.224.153]) by lelv0327.itg.ti.com (8.15.2/8.15.2) with ESMTP id x8BI1HnF052616; Wed, 11 Sep 2019 13:01:17 -0500 From: Dan Murphy To: , CC: , , , Dan Murphy Subject: [PATCH v5 5/9] leds: Add multicolor ID to the color ID list Date: Wed, 11 Sep 2019 13:01:11 -0500 Message-ID: <20190911180115.21035-6-dmurphy@ti.com> X-Mailer: git-send-email 2.22.0.214.g8dca754b1e In-Reply-To: <20190911180115.21035-1-dmurphy@ti.com> References: <20190911180115.21035-1-dmurphy@ti.com> MIME-Version: 1.0 X-EXCLAIMER-MD-CONFIG: e1e8a2fd-e40a-4ac6-ac9b-f7e9cc9ee180 Sender: linux-leds-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-leds@vger.kernel.org Add a new color ID that is declared as MULTICOLOR as with the multicolor framework declaring a definitive color is not accurate as the node can contain multiple colors. Signed-off-by: Dan Murphy --- drivers/leds/led-core.c | 1 + 1 file changed, 1 insertion(+) -- 2.22.0.214.g8dca754b1e diff --git a/drivers/leds/led-core.c b/drivers/leds/led-core.c index f1f718dbe0f8..846248a0693d 100644 --- a/drivers/leds/led-core.c +++ b/drivers/leds/led-core.c @@ -34,6 +34,7 @@ const char * const led_colors[LED_COLOR_ID_MAX] = { [LED_COLOR_ID_VIOLET] = "violet", [LED_COLOR_ID_YELLOW] = "yellow", [LED_COLOR_ID_IR] = "ir", + [LED_COLOR_ID_MULTI] = "multicolor", }; EXPORT_SYMBOL_GPL(led_colors); From patchwork Wed Sep 11 18:01:12 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Dan Murphy X-Patchwork-Id: 173628 Delivered-To: patch@linaro.org Received: by 2002:ac9:19ad:0:0:0:0:0 with SMTP id d45csp1102191oce; Wed, 11 Sep 2019 11:01:30 -0700 (PDT) X-Google-Smtp-Source: APXvYqwfKyv/13lq2f64iFIm3kxQbBZ64WXWNR8KId2QAmCAJhcmNv5pHcSm865EYIeXrNRLd26E X-Received: by 2002:a17:906:139b:: with SMTP id f27mr31360504ejc.273.1568224890300; Wed, 11 Sep 2019 11:01:30 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1568224890; cv=none; d=google.com; s=arc-20160816; b=RmmEq7f+S8sjDbh+UnAy9Fmk2FTTryyncsuWEq3VtnXsp1NnyuMATIqEygLC01Sbt+ YHAucN+sTvSREpZSHqhdPk0KwzgAV19WhdCBhO31fNszmRl2lc4ce6/tjfqjJZ5Q5vO0 2HKfK2FmY4E8MO6ZwbARm4/RnBFFnneWH/TO1JHNnmOYKF4fH8i8ZzmirKkAJtgy7IR4 EHJmsIZZdOgy5Kng4FTOlAVo+pHdM1nUJhZ7EHRd4GLNytv9/9gsKmazVLbl9cnjD/m1 DXmzNVZ7p59naOEPdY95+QSdZINwL/8D8MSlEyvVKSCkJIaM7Mg/P2Wt2zfRNwuAbu35 jLrw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:sender:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=gbt7ozbbGnCdkX6il3mG8T3E0GQwuS7v5xednttm79E=; b=HWMsRSzUA6oxq2XqeZEv86KHmEpv89IwY++M27XXMTJonVJn4pOiWQss8wQKJqQaIJ fUU1iGyjY6H0cG3t7Ui33VUcjqRNvWA3tdfYaBucD+aJyPeKYzuzohl5FRnCum+PDVJA ep8Mh+v/LcNaNx7FLu2KZxJ+dBcCVyH+6nsvMetMDUEjYXV9AEcabQDyMwFViFVs8VLc a507BWptxSBdCx140re0rS3jef1VuCAWEIpe/ej+M9PEeBz1NEllYSYqtYRDKSBPN9O3 FuqdyLZiwW3Ch771pkdKno9aPwjR0B488JuGgiTnPMzofDixlbvQbs3h+ompggAyy64T AbKA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@ti.com header.s=ti-com-17Q1 header.b="roSl/G/r"; spf=pass (google.com: best guess record for domain of linux-leds-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-leds-owner@vger.kernel.org; dmarc=pass (p=QUARANTINE sp=NONE dis=NONE) header.from=ti.com Return-Path: Received: from vger.kernel.org (vger.kernel.org. [209.132.180.67]) by mx.google.com with ESMTP id gy24si11079999ejb.166.2019.09.11.11.01.30; Wed, 11 Sep 2019 11:01:30 -0700 (PDT) Received-SPF: pass (google.com: best guess record for domain of linux-leds-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67; Authentication-Results: mx.google.com; dkim=pass header.i=@ti.com header.s=ti-com-17Q1 header.b="roSl/G/r"; spf=pass (google.com: best guess record for domain of linux-leds-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-leds-owner@vger.kernel.org; dmarc=pass (p=QUARANTINE sp=NONE dis=NONE) header.from=ti.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1729913AbfIKSB3 (ORCPT + 1 other); Wed, 11 Sep 2019 14:01:29 -0400 Received: from lelv0142.ext.ti.com ([198.47.23.249]:33066 "EHLO lelv0142.ext.ti.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1729827AbfIKSBY (ORCPT ); Wed, 11 Sep 2019 14:01:24 -0400 Received: from lelv0266.itg.ti.com ([10.180.67.225]) by lelv0142.ext.ti.com (8.15.2/8.15.2) with ESMTP id x8BI1I3h006890; Wed, 11 Sep 2019 13:01:18 -0500 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=ti.com; s=ti-com-17Q1; t=1568224878; bh=gbt7ozbbGnCdkX6il3mG8T3E0GQwuS7v5xednttm79E=; h=From:To:CC:Subject:Date:In-Reply-To:References; b=roSl/G/rrPG6dLSW0d9wJFRRX6IwahI/qbbEvGSWTk8//sL1saUgLvIJrtWjnwAFQ ipR9vgRByJDQHQRIyPbzWQwpcs2Tv/90p9VFdQ5SjoKTZQmLQSCbu4wdoTtPi3766J j87XrIssMJ50Er1bvYqo6Mt8fPumR/uuRbjwfex4= Received: from DFLE114.ent.ti.com (dfle114.ent.ti.com [10.64.6.35]) by lelv0266.itg.ti.com (8.15.2/8.15.2) with ESMTPS id x8BI1IsP009361 (version=TLSv1.2 cipher=AES256-GCM-SHA384 bits=256 verify=FAIL); Wed, 11 Sep 2019 13:01:18 -0500 Received: from DFLE100.ent.ti.com (10.64.6.21) by DFLE114.ent.ti.com (10.64.6.35) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256_P256) id 15.1.1713.5; Wed, 11 Sep 2019 13:01:18 -0500 Received: from lelv0327.itg.ti.com (10.180.67.183) by DFLE100.ent.ti.com (10.64.6.21) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256_P256) id 15.1.1713.5 via Frontend Transport; Wed, 11 Sep 2019 13:01:18 -0500 Received: from localhost (ileax41-snat.itg.ti.com [10.172.224.153]) by lelv0327.itg.ti.com (8.15.2/8.15.2) with ESMTP id x8BI1IQk052623; Wed, 11 Sep 2019 13:01:18 -0500 From: Dan Murphy To: , CC: , , , Dan Murphy Subject: [PATCH v5 6/9] leds: multicolor: Introduce a multicolor class definition Date: Wed, 11 Sep 2019 13:01:12 -0500 Message-ID: <20190911180115.21035-7-dmurphy@ti.com> X-Mailer: git-send-email 2.22.0.214.g8dca754b1e In-Reply-To: <20190911180115.21035-1-dmurphy@ti.com> References: <20190911180115.21035-1-dmurphy@ti.com> MIME-Version: 1.0 X-EXCLAIMER-MD-CONFIG: e1e8a2fd-e40a-4ac6-ac9b-f7e9cc9ee180 Sender: linux-leds-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-leds@vger.kernel.org Introduce a multicolor class that groups colored LEDs within a LED node. The framework allows for dynamically setting individual LEDs or setting brightness levels of LEDs and updating them virtually simultaneously. Signed-off-by: Dan Murphy --- drivers/leds/Kconfig | 10 + drivers/leds/Makefile | 1 + drivers/leds/led-class-multicolor.c | 387 +++++++++++++++++++++++++++ include/linux/led-class-multicolor.h | 96 +++++++ 4 files changed, 494 insertions(+) create mode 100644 drivers/leds/led-class-multicolor.c create mode 100644 include/linux/led-class-multicolor.h -- 2.22.0.214.g8dca754b1e diff --git a/drivers/leds/Kconfig b/drivers/leds/Kconfig index 1988de1d64c0..71e7fd4f6f15 100644 --- a/drivers/leds/Kconfig +++ b/drivers/leds/Kconfig @@ -30,6 +30,16 @@ config LEDS_CLASS_FLASH for the flash related features of a LED device. It can be built as a module. +config LEDS_CLASS_MULTI_COLOR + tristate "LED Mulit Color LED Class Support" + depends on LEDS_CLASS + help + This option enables the multicolor LED sysfs class in /sys/class/leds. + It wraps LED class and adds multicolor LED specific sysfs attributes + and kernel internal API to it. You'll need this to provide support + for multicolor LEDs that are grouped together. This class is not + intended for single color LEDs. It can be built as a module. + config LEDS_BRIGHTNESS_HW_CHANGED bool "LED Class brightness_hw_changed attribute support" depends on LEDS_CLASS diff --git a/drivers/leds/Makefile b/drivers/leds/Makefile index 41fb073a39c1..897b810257dd 100644 --- a/drivers/leds/Makefile +++ b/drivers/leds/Makefile @@ -4,6 +4,7 @@ obj-$(CONFIG_NEW_LEDS) += led-core.o obj-$(CONFIG_LEDS_CLASS) += led-class.o obj-$(CONFIG_LEDS_CLASS_FLASH) += led-class-flash.o +obj-$(CONFIG_LEDS_CLASS_MULTI_COLOR) += led-class-multicolor.o obj-$(CONFIG_LEDS_TRIGGERS) += led-triggers.o # LED Platform Drivers diff --git a/drivers/leds/led-class-multicolor.c b/drivers/leds/led-class-multicolor.c new file mode 100644 index 000000000000..c733192b31fa --- /dev/null +++ b/drivers/leds/led-class-multicolor.c @@ -0,0 +1,387 @@ +// SPDX-License-Identifier: GPL-2.0 +// LED Multi Color class interface +// Copyright (C) 2019 Texas Instruments Incorporated - http://www.ti.com/ + +#include +#include +#include +#include +#include +#include + +#include "leds.h" + +struct led_classdev_mc_priv { + struct led_classdev_mc *mcled_cdev; + + struct device_attribute max_intensity_attr; + struct device_attribute intensity_attr; + struct device_attribute color_index_attr; + + enum led_brightness max_intensity; + enum led_brightness intensity; + + struct list_head list; + + int led_color_id; + int color_seq_pos; +}; + +static int led_mc_calculate_brightness(int brightness, int intensity, + int max_intensity) +{ + if (brightness && intensity && max_intensity) + return brightness * intensity / max_intensity; + + return LED_OFF; +} + +void led_mc_set_cluster_brightness(struct led_classdev_mc *mcled_cdev, + enum led_brightness brightness, int adj_value[]) +{ + struct led_classdev_mc_data *data = mcled_cdev->data; + struct led_classdev_mc_priv *priv; + int i = 0; + + list_for_each_entry(priv, &data->color_list, list) { + adj_value[i] = led_mc_calculate_brightness(brightness, + priv->intensity, + priv->max_intensity); + i++; + } + + data->cluster_brightness = brightness; +} + +void led_mc_get_cluster_brightness(struct led_classdev_mc *mcled_cdev, + int brightness_val[]) +{ + struct led_classdev_mc_data *data = mcled_cdev->data; + struct led_classdev_mc_priv *priv; + int i = 0; + + list_for_each_entry(priv, &data->color_list, list) { + brightness_val[i] = priv->intensity; + i++; + } +} + +static ssize_t color_index_show(struct device *dev, + struct device_attribute *color_index_attr, + char *buf) +{ + struct led_classdev_mc_priv *priv = container_of(color_index_attr, + struct led_classdev_mc_priv, + color_index_attr); + + return sprintf(buf, "%d\n", priv->led_color_id); +} + +static ssize_t color_mix_store(struct device *dev, + struct device_attribute *color_mix_attr, + const char *buf, size_t size) +{ + struct led_classdev_mc_data *data = container_of(color_mix_attr, + struct led_classdev_mc_data, + color_mix_attr); + struct led_classdev_mc *mcled_cdev = data->mcled_cdev; + struct led_classdev_mc_priv *priv; + unsigned int value[LED_COLOR_ID_MAX]; + int nrchars, offset = 0; + unsigned int i; + int ret; + + for (i = 0; i < mcled_cdev->num_leds; i++) { + ret = sscanf(buf + offset, "%i%n", &value[i], &nrchars); + if (ret != 1) + break; + + offset += nrchars; + } + + if (i != mcled_cdev->num_leds) { + dev_err(dev, "Wrong number of LEDs defined %i, need %i\n", + i, mcled_cdev->num_leds); + return -EINVAL; + } + + list_for_each_entry(priv, &data->color_list, list) { + priv->intensity = value[priv->color_seq_pos]; + if (mcled_cdev->ops) { + ret = mcled_cdev->ops->set_color_brightness(mcled_cdev, + priv->led_color_id, + priv->intensity); + if (ret) + goto out; + } + } +out: + return size; +} + +static ssize_t intensity_store(struct device *dev, + struct device_attribute *intensity_attr, + const char *buf, size_t size) +{ + struct led_classdev_mc_priv *priv = container_of(intensity_attr, + struct led_classdev_mc_priv, + intensity_attr); + struct led_classdev_mc_data *data = priv->mcled_cdev->data; + struct led_classdev_mc *mcled_cdev = data->mcled_cdev; + struct led_classdev *led_cdev = priv->mcled_cdev->led_cdev; + unsigned long value; + ssize_t ret; + + mutex_lock(&led_cdev->led_access); + + ret = kstrtoul(buf, 10, &value); + if (ret) + goto unlock; + + if (value > priv->max_intensity) { + ret = -EINVAL; + goto unlock; + } + + priv->intensity = value; + + if (mcled_cdev->ops) { + ret = mcled_cdev->ops->set_color_brightness(mcled_cdev, + priv->led_color_id, + priv->intensity); + if (ret) + goto unlock; + } + + ret = size; + +unlock: + mutex_unlock(&led_cdev->led_access); + return ret; +} + +static ssize_t intensity_show(struct device *dev, + struct device_attribute *intensity_attr, + char *buf) +{ + struct led_classdev_mc_priv *priv = container_of(intensity_attr, + struct led_classdev_mc_priv, + intensity_attr); + const struct led_multicolor_ops *ops = priv->mcled_cdev->ops; + int value = 0; + + if (ops->get_color_brightness) { + value = ops->get_color_brightness(priv->mcled_cdev, + priv->led_color_id); + priv->intensity = value; + } else { + value = priv->intensity; + } + + return sprintf(buf, "%d\n", value); +} + +static ssize_t max_intensity_show(struct device *dev, + struct device_attribute *max_intensity_attr, + char *buf) +{ + struct led_classdev_mc_priv *priv = container_of(max_intensity_attr, + struct led_classdev_mc_priv, + max_intensity_attr); + + return sprintf(buf, "%d\n", priv->max_intensity); +} + +static int led_multicolor_init_color(struct led_classdev_mc_data *data, + struct led_classdev_mc *mcled_cdev, + int color_id, int color_index) +{ + struct led_classdev *led_cdev = mcled_cdev->led_cdev; + struct led_classdev_mc_priv *mc_priv; + int ret; + + mc_priv = devm_kzalloc(led_cdev->dev, sizeof(*mc_priv), GFP_KERNEL); + if (!mc_priv) + return -ENOMEM; + + mc_priv->led_color_id = color_id; + mc_priv->mcled_cdev = mcled_cdev; + + data->led_kobj = kobject_create_and_add(led_colors[color_id], + data->color_kobj); + if (!data->led_kobj) + return -EINVAL; + + sysfs_attr_init(&mc_priv->intensity_attr.attr); + mc_priv->intensity_attr.attr.name = "intensity"; + mc_priv->intensity_attr.attr.mode = S_IRUGO | S_IWUGO; + mc_priv->intensity_attr.store = intensity_store; + mc_priv->intensity_attr.show = intensity_show; + ret = sysfs_create_file(data->led_kobj, + &mc_priv->intensity_attr.attr); + if (ret) + goto err_out; + + sysfs_attr_init(&mc_priv->max_intensity_attr.attr); + mc_priv->max_intensity_attr.attr.name = "max_intensity"; + mc_priv->max_intensity_attr.attr.mode = S_IRUGO; + mc_priv->max_intensity_attr.show = max_intensity_show; + ret = sysfs_create_file(data->led_kobj, + &mc_priv->max_intensity_attr.attr); + if (ret) + goto err_out; + + sysfs_attr_init(&mc_priv->color_index_attr.attr); + mc_priv->color_index_attr.attr.name = "color_id"; + mc_priv->color_index_attr.attr.mode = S_IRUGO; + mc_priv->color_index_attr.show = color_index_show; + ret = sysfs_create_file(data->led_kobj, + &mc_priv->color_index_attr.attr); + if (ret) + goto err_out; + + mc_priv->max_intensity = LED_FULL; + mc_priv->color_seq_pos = color_index; + list_add_tail(&mc_priv->list, &data->color_list); + +err_out: + return ret; +} + +static int led_multicolor_init_color_dir(struct led_classdev_mc_data *data, + struct led_classdev_mc *mcled_cdev) +{ + struct led_classdev *led_cdev = mcled_cdev->led_cdev; + u32 color_id; + int ret; + int i, j = 0; + + data->color_kobj = kobject_create_and_add("colors", + &led_cdev->dev->kobj); + if (!data->color_kobj) + return -EINVAL; + + data->mcled_cdev = mcled_cdev; + + for (i = 0; i < LED_COLOR_ID_MAX; i++) { + color_id = (mcled_cdev->available_colors & (1 << i)); + if (color_id) { + ret = led_multicolor_init_color(data, mcled_cdev, i, j); + if (ret) + break; + + j++; + } + } + + sysfs_attr_init(&data->color_mix_attr.attr); + data->color_mix_attr.attr.name = "color_mix"; + data->color_mix_attr.attr.mode = S_IRUGO | S_IWUGO; + data->color_mix_attr.store = color_mix_store; + ret = sysfs_create_file(data->color_kobj, + &data->color_mix_attr.attr); + + return ret; +} + +int led_classdev_multicolor_register_ext(struct device *parent, + struct led_classdev_mc *mcled_cdev, + struct led_init_data *init_data) +{ + struct led_classdev *led_cdev; + struct led_classdev_mc_data *data; + int ret; + + if (!mcled_cdev) + return -EINVAL; + + data = kzalloc(sizeof(*data), GFP_KERNEL); + if (!data) + return -ENOMEM; + + mcled_cdev->data = data; + led_cdev = mcled_cdev->led_cdev; + INIT_LIST_HEAD(&data->color_list); + + /* Register led class device */ + ret = led_classdev_register_ext(parent, led_cdev, init_data); + if (ret) + return ret; + + return led_multicolor_init_color_dir(data, mcled_cdev); +} +EXPORT_SYMBOL_GPL(led_classdev_multicolor_register_ext); + +void led_classdev_multicolor_unregister(struct led_classdev_mc *mcled_cdev) +{ + if (!mcled_cdev) + return; + + led_classdev_unregister(mcled_cdev->led_cdev); +} +EXPORT_SYMBOL_GPL(led_classdev_multicolor_unregister); + +static void devm_led_classdev_multicolor_release(struct device *dev, void *res) +{ + led_classdev_multicolor_unregister(*(struct led_classdev_mc **)res); +} + +/** + * devm_of_led_classdev_register - resource managed led_classdev_register() + * + * @parent: parent of LED device + * @led_cdev: the led_classdev structure for this device. + */ +int devm_led_classdev_multicolor_register(struct device *parent, + struct led_classdev_mc *mcled_cdev) +{ + struct led_classdev_mc **dr; + int ret; + + dr = devres_alloc(devm_led_classdev_multicolor_release, + sizeof(*dr), GFP_KERNEL); + if (!dr) + return -ENOMEM; + + ret = led_classdev_multicolor_register(parent, mcled_cdev); + if (ret) { + devres_free(dr); + return ret; + } + + *dr = mcled_cdev; + devres_add(parent, dr); + + return 0; +} +EXPORT_SYMBOL_GPL(devm_led_classdev_multicolor_register); + +static int devm_led_classdev_multicolor_match(struct device *dev, + void *res, void *data) +{ + struct mcled_cdev **p = res; + + if (WARN_ON(!p || !*p)) + return 0; + + return *p == data; +} + +/** + * devm_led_classdev_multicolor_unregister() - resource managed + * led_classdev_multicolor_unregister() + * @parent: The device to unregister. + * @mcled_cdev: the led_classdev_mc structure for this device. + */ +void devm_led_classdev_multicolor_unregister(struct device *dev, + struct led_classdev_mc *mcled_cdev) +{ + WARN_ON(devres_release(dev, + devm_led_classdev_multicolor_release, + devm_led_classdev_multicolor_match, mcled_cdev)); +} +EXPORT_SYMBOL_GPL(devm_led_classdev_multicolor_unregister); + +MODULE_AUTHOR("Dan Murphy "); +MODULE_DESCRIPTION("Multi Color LED class interface"); +MODULE_LICENSE("GPL v2"); diff --git a/include/linux/led-class-multicolor.h b/include/linux/led-class-multicolor.h new file mode 100644 index 000000000000..193ba0e46042 --- /dev/null +++ b/include/linux/led-class-multicolor.h @@ -0,0 +1,96 @@ +/* SPDX-License-Identifier: GPL-2.0 */ +/* LED Multicolor class interface + * Copyright (C) 2019 Texas Instruments Incorporated - http://www.ti.com/ + */ + +#ifndef __LINUX_MULTICOLOR_LEDS_H_INCLUDED +#define __LINUX_MULTICOLOR_LEDS_H_INCLUDED + +#include +#include + +struct led_classdev_mc; + +struct led_classdev_mc_data { + struct led_classdev_mc *mcled_cdev; + + struct kobject *color_kobj; + struct kobject *led_kobj; + + struct device_attribute color_mix_attr; + + struct list_head color_list; + + enum led_brightness cluster_brightness; +}; + +struct led_multicolor_ops { + /* Set brightness for a specific color id */ + int (*set_color_brightness)(struct led_classdev_mc *mcled_cdev, + int color_id, int value); + /* Read current color setting */ + int (*get_color_brightness)(struct led_classdev_mc *mcled_cdev, + int color_id); +}; + +struct led_classdev_mc { + /* led class device */ + struct led_classdev *led_cdev; + + /* multicolor led specific ops */ + struct led_multicolor_ops *ops; + + struct led_classdev_mc_data *data; + + unsigned long available_colors; + int num_leds; +}; + +static inline struct led_classdev_mc *lcdev_to_mccdev( + struct led_classdev *lcdev) +{ + return container_of(lcdev, struct led_classdev_mc, led_cdev); +} + +/** + * led_classdev_multicolor_register_ext - register a new object of led_classdev + * class with support for multicolor LEDs + * @parent: the multicolor LED to register + * @mcled_cdev: the led_classdev_mc structure for this device + * @init_data: the LED class Multi color device initialization data + * + * Returns: 0 on success or negative error value on failure + */ +extern int led_classdev_multicolor_register_ext(struct device *parent, + struct led_classdev_mc *mcled_cdev, + struct led_init_data *init_data); + +#define led_classdev_multicolor_register(parent, mcled_cdev) \ + led_classdev_multicolor_register_ext(parent, mcled_cdev, NULL) + +/** + * led_classdev_multicolor_unregister - unregisters an object of led_classdev + * class with support for multicolor LEDs + * @mcled_cdev: the multicolor LED to unregister + * + * Unregister a previously registered via led_classdev_multicolor_register + * object + */ +extern void led_classdev_multicolor_unregister(struct led_classdev_mc *mcled_cdev); + +extern int devm_led_classdev_multicolor_register(struct device *parent, + struct led_classdev_mc *mcled_cdev); + +extern void devm_led_classdev_multicolor_unregister(struct device *parent, + struct led_classdev_mc *mcled_cdev); + +/* Set brightness for the monochrome LED cluster */ +extern void led_mc_set_cluster_brightness(struct led_classdev_mc *mcled_cdev, + enum led_brightness brightness, + int adj_value[]); + +/* Read current cluster brightness */ +extern void led_mc_get_cluster_brightness(struct led_classdev_mc *mcled_cdev, + int brightness_val[]); + +#endif /* __LINUX_MULTICOLOR_LEDS_H_INCLUDED */