From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1753181AbbI1UoX (ORCPT ); Mon, 28 Sep 2015 16:44:23 -0400 Received: from mail-la0-f48.google.com ([209.85.215.48]:35198 "EHLO mail-la0-f48.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1752945AbbI1UoU (ORCPT ); Mon, 28 Sep 2015 16:44:20 -0400 From: Maciek Borzecki To: linux-kernel@vger.kernel.org, Richard Purdie , Jacek Anaszewski , linux-leds@vger.kernel.org, linux-doc@vger.kernel.org, Jonathan Corbet Cc: Maciek Borzecki Subject: [PATCH 3/3] Documentation: leds: document ledtrig-device trigger Date: Mon, 28 Sep 2015 22:43:05 +0200 Message-Id: <0253c438453b6d244acede5a151856ef9c0cb850.1443472356.git.maciek.borzecki@gmail.com> X-Mailer: git-send-email 2.5.3 In-Reply-To: References: In-Reply-To: References: Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org This patch adds documentation for ledtrig-device trigger. Signed-off-by: Maciek Borzecki --- Documentation/leds/00-INDEX | 3 +++ Documentation/leds/ledtrig-device.txt | 32 ++++++++++++++++++++++++++++++++ 2 files changed, 35 insertions(+) create mode 100644 Documentation/leds/ledtrig-device.txt diff --git a/Documentation/leds/00-INDEX b/Documentation/leds/00-INDEX index b4ef1f34e25faafe544971f619019d748538e4de..7f18adaadc04756a6b52157a71f86bd131dd915c 100644 --- a/Documentation/leds/00-INDEX +++ b/Documentation/leds/00-INDEX @@ -20,3 +20,6 @@ ledtrig-oneshot.txt - One-shot LED trigger for both sporadic and dense events. ledtrig-transient.txt - LED Transient Trigger, one shot timer activation. +ledtrig-device.txt + - LED Device Activity Trigger for indicating an activity + on a device \ No newline at end of file diff --git a/Documentation/leds/ledtrig-device.txt b/Documentation/leds/ledtrig-device.txt new file mode 100644 index 0000000000000000000000000000000000000000..b319d5da9df513a15b5c8094c6a5923682ff4579 --- /dev/null +++ b/Documentation/leds/ledtrig-device.txt @@ -0,0 +1,32 @@ +Device Activity LED Trigger +========================== + +This is a LED trigger useful for signaling an activity on a given +device identified by it's MKDEV(major, minor). A typical use case +would be debugging of a device or a driver on an embedded board, +patching up trivial electronic hardware design deficiencies in +software or just plain desire to indicate activity on a certain +device. + +Internally, a instance of a trigger is created and registered with LED +triggers for every device added via ledtrig_dev_add() call. The +triggers are named in the following manner: + + `dev-:` + +And can be selected from under /sys/class/leds/*/trigger. A device +activity is explicitly indicated by calling ledtrig_dev_activity() for +a registered device. + +The driver also creates a set of debugfs entries under +/sys/kernel/debug/ledtrig-dev, these are: + + devices - cat'ing will produce a list of currently registered + devices + + register - echo'ing : will create a trigger for this + device (note, you still need to add at least + ledtrig_dev_activity() hook) + + trigger - echo'ing : will fire the trigger for this + device -- 2.5.3