~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

TOMOYO Linux Cross Reference
Linux/Documentation/leds/ledtrig-oneshot.rst

Version: ~ [ linux-6.12-rc7 ] ~ [ linux-6.11.7 ] ~ [ linux-6.10.14 ] ~ [ linux-6.9.12 ] ~ [ linux-6.8.12 ] ~ [ linux-6.7.12 ] ~ [ linux-6.6.60 ] ~ [ linux-6.5.13 ] ~ [ linux-6.4.16 ] ~ [ linux-6.3.13 ] ~ [ linux-6.2.16 ] ~ [ linux-6.1.116 ] ~ [ linux-6.0.19 ] ~ [ linux-5.19.17 ] ~ [ linux-5.18.19 ] ~ [ linux-5.17.15 ] ~ [ linux-5.16.20 ] ~ [ linux-5.15.171 ] ~ [ linux-5.14.21 ] ~ [ linux-5.13.19 ] ~ [ linux-5.12.19 ] ~ [ linux-5.11.22 ] ~ [ linux-5.10.229 ] ~ [ linux-5.9.16 ] ~ [ linux-5.8.18 ] ~ [ linux-5.7.19 ] ~ [ linux-5.6.19 ] ~ [ linux-5.5.19 ] ~ [ linux-5.4.285 ] ~ [ linux-5.3.18 ] ~ [ linux-5.2.21 ] ~ [ linux-5.1.21 ] ~ [ linux-5.0.21 ] ~ [ linux-4.20.17 ] ~ [ linux-4.19.323 ] ~ [ linux-4.18.20 ] ~ [ linux-4.17.19 ] ~ [ linux-4.16.18 ] ~ [ linux-4.15.18 ] ~ [ linux-4.14.336 ] ~ [ linux-4.13.16 ] ~ [ linux-4.12.14 ] ~ [ linux-4.11.12 ] ~ [ linux-4.10.17 ] ~ [ linux-4.9.337 ] ~ [ linux-4.4.302 ] ~ [ linux-3.10.108 ] ~ [ linux-2.6.32.71 ] ~ [ linux-2.6.0 ] ~ [ linux-2.4.37.11 ] ~ [ unix-v6-master ] ~ [ ccs-tools-1.8.12 ] ~ [ policy-sample ] ~
Architecture: ~ [ i386 ] ~ [ alpha ] ~ [ m68k ] ~ [ mips ] ~ [ ppc ] ~ [ sparc ] ~ [ sparc64 ] ~

  1 ====================
  2 One-shot LED Trigger
  3 ====================
  4 
  5 This is a LED trigger useful for signaling the user of an event where there are
  6 no clear trap points to put standard led-on and led-off settings.  Using this
  7 trigger, the application needs only to signal the trigger when an event has
  8 happened, then the trigger turns the LED on and then keeps it off for a
  9 specified amount of time.
 10 
 11 This trigger is meant to be usable both for sporadic and dense events.  In the
 12 first case, the trigger produces a clear single controlled blink for each
 13 event, while in the latter it keeps blinking at constant rate, as to signal
 14 that the events are arriving continuously.
 15 
 16 A one-shot LED only stays in a constant state when there are no events.  An
 17 additional "invert" property specifies if the LED has to stay off (normal) or
 18 on (inverted) when not rearmed.
 19 
 20 The trigger can be activated from user space on led class devices as shown
 21 below::
 22 
 23   echo oneshot > trigger
 24 
 25 This adds sysfs attributes to the LED that are documented in:
 26 Documentation/ABI/testing/sysfs-class-led-trigger-oneshot
 27 
 28 Example use-case: network devices, initialization::
 29 
 30   echo oneshot > trigger # set trigger for this led
 31   echo 33 > delay_on     # blink at 1 / (33 + 33) Hz on continuous traffic
 32   echo 33 > delay_off
 33 
 34 interface goes up::
 35 
 36   echo 1 > invert # set led as normally-on, turn the led on
 37 
 38 packet received/transmitted::
 39 
 40   echo 1 > shot # led starts blinking, ignored if already blinking
 41 
 42 interface goes down::
 43 
 44   echo 0 > invert # set led as normally-off, turn the led off

~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

kernel.org | git.kernel.org | LWN.net | Project Home | SVN repository | Mail admin

Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.

sflogo.php