From patchwork Mon Aug 6 12:05:59 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "\(Exiting\) Baolin Wang" X-Patchwork-Id: 143501 Delivered-To: patch@linaro.org Received: by 2002:a2e:9754:0:0:0:0:0 with SMTP id f20-v6csp3207163ljj; Mon, 6 Aug 2018 05:06:20 -0700 (PDT) X-Google-Smtp-Source: AAOMgpcQqAUABPCzClQBrR9PYAVjF2eKa43R3yjhwOBAx15HYSX948GjIVnBDpJFIUY6ejaoTUy4 X-Received: by 2002:a63:380d:: with SMTP id f13-v6mr14378090pga.124.1533557180516; Mon, 06 Aug 2018 05:06:20 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1533557180; cv=none; d=google.com; s=arc-20160816; b=bLZ6AYO9uJmE0QsDeJhhjvWMkYSsDbtNhpYdeZBQb6qau58W4FxYSJ4Mi1lnWTzPCk ezsE/QoQUAEVWJnOkYYcasHlNXmBgrpAunLBXMP94G9kYovsaOirnVs5X0sjS7Ik5/bH az6+yOHzSJZy7odnJ74hZE5PauctGmQeAyEtyQnmRaofH9MnRdTpZi4vNddtSxqq4o7s zCH8Hw/P0CkV60Zfz3TGZXGTrovJH4WWZJwyy3EVNV+n3sv97LxQc3Lo2aGQjmOirWYK fFlj/QCrT25+k+P3i4u0S7noR/EVawbiijDkdY9ED/zexWeVAvcy5Yuvc5QNMSASKrBG DLPg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:sender:message-id:date:subject:cc:to:from :dkim-signature:arc-authentication-results; bh=iZOnLgLc67pe/Iw20tYvDJk3u/CQDi3qRyi6K/gb9W0=; b=eK6DZ4CM7LcEBThONSYz7xgHabcJETw0aX1bKeWsSwyp7XCvGUnUiqzDW2GAUOyHmV 1yVmvwIm/fbXoqdfey3I7ARy2ITrZqeczxpaMHM/VKktKt3Qd2SZz3bdIz3n/y+ji5M8 Z+IqIHE5LUL1TECargYeXFt5VX62pDvbtYITuSD84TfFguQONy/yj3hhgP6sC2MvIBYD 4ZqN9rJrsGlFnhK3J0NwIsE4Ql7rOVfd8tT2g5XhvERA6Sj0e4k7jLct4ESBG+0ewy0S 7b8bzl9hwegaHO7uKqYaV04ujkhRyW10YzYM68/VaeqBu07C1RO8ON2dXtGcxhmljY77 9C7Q== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=Kt+uURGK; 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=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from vger.kernel.org (vger.kernel.org. [209.132.180.67]) by mx.google.com with ESMTP id z127-v6si13632062pgb.455.2018.08.06.05.06.20; Mon, 06 Aug 2018 05:06:20 -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=@linaro.org header.s=google header.b=Kt+uURGK; 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=NONE sp=NONE dis=NONE) header.from=linaro.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1731324AbeHFOPH (ORCPT + 1 other); Mon, 6 Aug 2018 10:15:07 -0400 Received: from mail-pl0-f66.google.com ([209.85.160.66]:34698 "EHLO mail-pl0-f66.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1731219AbeHFOPH (ORCPT ); Mon, 6 Aug 2018 10:15:07 -0400 Received: by mail-pl0-f66.google.com with SMTP id f6-v6so5574789plo.1 for ; Mon, 06 Aug 2018 05:06:19 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id; bh=iZOnLgLc67pe/Iw20tYvDJk3u/CQDi3qRyi6K/gb9W0=; b=Kt+uURGKAbrkEPvwIEugJy0HuVGT8QGLlIt3Sv9HxdD9Vk3PCLywWXPswxzYpRJWcj cl4CCB9HGnI8+LU3DWyKLUmnQOuPEgztKAWRzYJP/Muj90ULwPhxd9x+OLuEUtYp0/kr N5kUBny6tuDj4osfatDj6r6jsSAFezaiCA0g8= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id; bh=iZOnLgLc67pe/Iw20tYvDJk3u/CQDi3qRyi6K/gb9W0=; b=BkpXbxgMbBYocPbMNpVesx0eqkPPnxwEOIojuRowMl47BA12W//Zx+K1OHcCUlNWHF rbnnGVcB+v1w0XbF0+//wxVnohQyBrP4sS+MdO00rqZFVLpaEL/u6obPsLFv5AbviDZr YvqobRPxRuM/LPO5DZh835SXOvAZcIlUcuCmR7O2ZdRj7VunNahg53fwmJ45UL0S4/m6 QZSG+YasfWr4cq+GBYcTAHyK2CFeKo9mOY8jM6vgdYmOwh+zXrB/uoJZEXqrJXabHVm3 pN0Zdw4Ji83+8X4N7CL2HAvMzL18QQG+RrkXHwrf2sBLk4vUnzm/hKsOtBI0BLQt4cPF ZBEA== X-Gm-Message-State: AOUpUlEYg8zKPH6Yq95JrnLIGZhF/GPo/40ZGNYWK2lXAL9OYNraju5v ksQGRiv8la0WvLbo1Tw8yy7Vow== X-Received: by 2002:a17:902:7b83:: with SMTP id w3-v6mr13661403pll.192.1533557178805; Mon, 06 Aug 2018 05:06:18 -0700 (PDT) Received: from baolinwangubtpc.spreadtrum.com ([117.18.48.102]) by smtp.gmail.com with ESMTPSA id 21-v6sm16592354pgx.20.2018.08.06.05.06.15 (version=TLS1 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Mon, 06 Aug 2018 05:06:18 -0700 (PDT) From: Baolin Wang To: jacek.anaszewski@gmail.com, pavel@ucw.cz Cc: rteysseyre@gmail.com, bjorn.andersson@linaro.org, baolin.wang@linaro.org, broonie@kernel.org, linux-leds@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH v5 1/2] leds: core: Introduce LED pattern trigger Date: Mon, 6 Aug 2018 20:05:59 +0800 Message-Id: <1dc5d394324b2bf1ffe229b8e42691fab6d749e0.1533556992.git.baolin.wang@linaro.org> X-Mailer: git-send-email 1.7.9.5 Sender: linux-leds-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-leds@vger.kernel.org Some LED controllers have support for autonomously controlling brightness over time, according to some preprogrammed pattern or function. This patch adds pattern trigger that LED device can configure the pattern and trigger it. Signed-off-by: Raphael Teysseyre Signed-off-by: Baolin Wang --- Changes from v4: - Change the repeat file to return the originally written number. - Improve comments. - Fix some build warnings. Changes from v3: - Reset pattern number to 0 if user provides incorrect pattern string. - Support one pattern. Changes from v2: - Remove hardware_pattern boolen. - Chnage the pattern string format. Changes from v1: - Use ATTRIBUTE_GROUPS() to define attributes. - Introduce hardware_pattern flag to determine if software pattern or hardware pattern. - Re-implement pattern_trig_store_pattern() function. - Remove pattern_get() interface. - Improve comments. - Other small optimization. --- .../ABI/testing/sysfs-class-led-trigger-pattern | 24 ++ drivers/leds/trigger/Kconfig | 7 + drivers/leds/trigger/Makefile | 1 + drivers/leds/trigger/ledtrig-pattern.c | 266 ++++++++++++++++++++ include/linux/leds.h | 16 ++ 5 files changed, 314 insertions(+) create mode 100644 Documentation/ABI/testing/sysfs-class-led-trigger-pattern create mode 100644 drivers/leds/trigger/ledtrig-pattern.c -- 1.7.9.5 diff --git a/Documentation/ABI/testing/sysfs-class-led-trigger-pattern b/Documentation/ABI/testing/sysfs-class-led-trigger-pattern new file mode 100644 index 0000000..bc7475f --- /dev/null +++ b/Documentation/ABI/testing/sysfs-class-led-trigger-pattern @@ -0,0 +1,24 @@ +What: /sys/class/leds//pattern +Date: August 2018 +KernelVersion: 4.19 +Description: + Specify a pattern for the LED, for LED hardware that support + altering the brightness as a function of time. + + The pattern is given by a series of tuples, of brightness and + duration (ms). The LED is expected to traverse the series and + each brightness value for the specified duration. Duration of + 0 means brightness should immediately change to new value. + + The format of the pattern values should be: + "brightness_1 duration_1 brightness_2 duration_2 brightness_3 + duration_3 ...". + +What: /sys/class/leds//repeat +Date: August 2018 +KernelVersion: 4.19 +Description: + Specify a pattern repeat number. 0 means repeat indefinitely. + + This file will always return the originally written repeat + number. diff --git a/drivers/leds/trigger/Kconfig b/drivers/leds/trigger/Kconfig index 4018af7..b76fc3c 100644 --- a/drivers/leds/trigger/Kconfig +++ b/drivers/leds/trigger/Kconfig @@ -129,4 +129,11 @@ config LEDS_TRIGGER_NETDEV This allows LEDs to be controlled by network device activity. If unsure, say Y. +config LEDS_TRIGGER_PATTERN + tristate "LED Pattern Trigger" + help + This allows LEDs to be controlled by a software or hardware pattern + which is a series of tuples, of brightness and duration (ms). + If unsure, say N + endif # LEDS_TRIGGERS diff --git a/drivers/leds/trigger/Makefile b/drivers/leds/trigger/Makefile index f3cfe19..9bcb64e 100644 --- a/drivers/leds/trigger/Makefile +++ b/drivers/leds/trigger/Makefile @@ -13,3 +13,4 @@ obj-$(CONFIG_LEDS_TRIGGER_TRANSIENT) += ledtrig-transient.o obj-$(CONFIG_LEDS_TRIGGER_CAMERA) += ledtrig-camera.o obj-$(CONFIG_LEDS_TRIGGER_PANIC) += ledtrig-panic.o obj-$(CONFIG_LEDS_TRIGGER_NETDEV) += ledtrig-netdev.o +obj-$(CONFIG_LEDS_TRIGGER_PATTERN) += ledtrig-pattern.o diff --git a/drivers/leds/trigger/ledtrig-pattern.c b/drivers/leds/trigger/ledtrig-pattern.c new file mode 100644 index 0000000..63b94a2 --- /dev/null +++ b/drivers/leds/trigger/ledtrig-pattern.c @@ -0,0 +1,266 @@ +// SPDX-License-Identifier: GPL-2.0 + +/* + * LED pattern trigger + * + * Idea discussed with Pavel Machek. Raphael Teysseyre implemented + * the first version, Baolin Wang simplified and improved the approach. + */ + +#include +#include +#include +#include +#include +#include + +#define MAX_PATTERNS 1024 + +struct pattern_trig_data { + struct led_classdev *led_cdev; + struct led_pattern patterns[MAX_PATTERNS]; + struct led_pattern *curr; + struct led_pattern *next; + struct mutex lock; + u32 npatterns; + u32 repeat; + u32 last_repeat; + bool is_indefinite; + struct timer_list timer; +}; + +static void pattern_trig_update_patterns(struct pattern_trig_data *data) +{ + data->curr = data->next; + if (!data->is_indefinite && data->curr == data->patterns) + data->repeat--; + + if (data->next == data->patterns + data->npatterns - 1) + data->next = data->patterns; + else + data->next++; +} + +static void pattern_trig_timer_function(struct timer_list *t) +{ + struct pattern_trig_data *data = from_timer(data, t, timer); + + mutex_lock(&data->lock); + + if (!data->is_indefinite && !data->repeat) { + mutex_unlock(&data->lock); + return; + } + + led_set_brightness(data->led_cdev, data->curr->brightness); + mod_timer(&data->timer, jiffies + msecs_to_jiffies(data->curr->delta_t)); + pattern_trig_update_patterns(data); + + mutex_unlock(&data->lock); +} + +static int pattern_trig_start_pattern(struct pattern_trig_data *data, + struct led_classdev *led_cdev) +{ + if (!data->npatterns) + return 0; + + if (led_cdev->pattern_set) { + return led_cdev->pattern_set(led_cdev, data->patterns, + data->npatterns, data->repeat); + } + + data->curr = data->patterns; + data->next = data->npatterns > 1 ? data->patterns + 1 : data->patterns; + data->timer.expires = jiffies; + add_timer(&data->timer); + + return 0; +} + +static ssize_t repeat_show(struct device *dev, struct device_attribute *attr, + char *buf) +{ + struct led_classdev *led_cdev = dev_get_drvdata(dev); + struct pattern_trig_data *data = led_cdev->trigger_data; + u32 repeat; + + mutex_lock(&data->lock); + + repeat = data->last_repeat; + + mutex_unlock(&data->lock); + + return scnprintf(buf, PAGE_SIZE, "%u\n", repeat); +} + +static ssize_t repeat_store(struct device *dev, struct device_attribute *attr, + const char *buf, size_t count) +{ + struct led_classdev *led_cdev = dev_get_drvdata(dev); + struct pattern_trig_data *data = led_cdev->trigger_data; + unsigned long res; + int err; + + err = kstrtoul(buf, 10, &res); + if (err) + return err; + + if (!led_cdev->pattern_set) + del_timer_sync(&data->timer); + + mutex_lock(&data->lock); + + data->last_repeat = data->repeat = res; + + /* 0 means repeat indefinitely */ + if (!data->repeat) + data->is_indefinite = true; + else + data->is_indefinite = false; + + err = pattern_trig_start_pattern(data, led_cdev); + + mutex_unlock(&data->lock); + return err < 0 ? err : count; +} + +static DEVICE_ATTR_RW(repeat); + +static ssize_t pattern_show(struct device *dev, struct device_attribute *attr, + char *buf) +{ + struct led_classdev *led_cdev = dev_get_drvdata(dev); + struct pattern_trig_data *data = led_cdev->trigger_data; + ssize_t count = 0; + int i; + + mutex_lock(&data->lock); + + if (!data->npatterns) + goto out; + + for (i = 0; i < data->npatterns; i++) { + count += scnprintf(buf + count, PAGE_SIZE - count, + "%d %d ", + data->patterns[i].brightness, + data->patterns[i].delta_t); + } + + buf[count - 1] = '\n'; + +out: + mutex_unlock(&data->lock); + return count; +} + +static ssize_t pattern_store(struct device *dev, struct device_attribute *attr, + const char *buf, size_t count) +{ + struct led_classdev *led_cdev = dev_get_drvdata(dev); + struct pattern_trig_data *data = led_cdev->trigger_data; + int ccount, cr, offset = 0, err = 0; + + if (!led_cdev->pattern_set) + del_timer_sync(&data->timer); + + mutex_lock(&data->lock); + + data->npatterns = 0; + while (offset < count - 1 && data->npatterns < MAX_PATTERNS) { + cr = 0; + ccount = sscanf(buf + offset, "%d %d %n", + &data->patterns[data->npatterns].brightness, + &data->patterns[data->npatterns].delta_t, &cr); + if (ccount != 2) { + data->npatterns = 0; + err = -EINVAL; + goto out; + } + + offset += cr; + data->npatterns++; + } + + err = pattern_trig_start_pattern(data, led_cdev); + +out: + mutex_unlock(&data->lock); + return err < 0 ? err : count; +} + +static DEVICE_ATTR_RW(pattern); + +static struct attribute *pattern_trig_attrs[] = { + &dev_attr_pattern.attr, + &dev_attr_repeat.attr, + NULL +}; +ATTRIBUTE_GROUPS(pattern_trig); + +static int pattern_trig_activate(struct led_classdev *led_cdev) +{ + struct pattern_trig_data *data; + + data = kzalloc(sizeof(*data), GFP_KERNEL); + if (!data) + return -ENOMEM; + + if (!!led_cdev->pattern_set ^ !!led_cdev->pattern_clear) { + dev_warn(led_cdev->dev, + "Hardware pattern ops validation failed\n"); + led_cdev->pattern_set = NULL; + led_cdev->pattern_clear = NULL; + } + + data->is_indefinite = true; + mutex_init(&data->lock); + data->led_cdev = led_cdev; + led_set_trigger_data(led_cdev, data); + timer_setup(&data->timer, pattern_trig_timer_function, 0); + led_cdev->activated = true; + + return 0; +} + +static void pattern_trig_deactivate(struct led_classdev *led_cdev) +{ + struct pattern_trig_data *data = led_cdev->trigger_data; + + if (!led_cdev->activated) + return; + + if (led_cdev->pattern_clear) + led_cdev->pattern_clear(led_cdev); + else + del_timer_sync(&data->timer); + + led_set_brightness(led_cdev, LED_OFF); + kfree(data); + led_cdev->activated = false; +} + +static struct led_trigger pattern_led_trigger = { + .name = "pattern", + .activate = pattern_trig_activate, + .deactivate = pattern_trig_deactivate, + .groups = pattern_trig_groups, +}; + +static int __init pattern_trig_init(void) +{ + return led_trigger_register(&pattern_led_trigger); +} + +static void __exit pattern_trig_exit(void) +{ + led_trigger_unregister(&pattern_led_trigger); +} + +module_init(pattern_trig_init); +module_exit(pattern_trig_exit); + +MODULE_AUTHOR("Raphael Teysseyre struct device; +struct led_pattern; /* * LED Core */ @@ -88,6 +89,11 @@ struct led_classdev { unsigned long *delay_on, unsigned long *delay_off); + int (*pattern_set)(struct led_classdev *led_cdev, + struct led_pattern *pattern, int len, + unsigned int repeat); + int (*pattern_clear)(struct led_classdev *led_cdev); + struct device *dev; const struct attribute_group **groups; @@ -472,4 +478,14 @@ static inline void led_classdev_notify_brightness_hw_changed( struct led_classdev *led_cdev, enum led_brightness brightness) { } #endif +/** + * struct led_pattern - pattern interval settings + * @delta_t: pattern interval delay, in milliseconds + * @brightness: pattern interval brightness + */ +struct led_pattern { + int delta_t; + int brightness; +}; + #endif /* __LINUX_LEDS_H_INCLUDED */