€•S¸Œsphinx.addnodes”Œdocument”“”)”}”(Œ rawsource”Œ”Œchildren”]”(Œtranslations”Œ LanguagesNode”“”)”}”(hhh]”(hŒpending_xref”“”)”}”(hhh]”Œdocutils.nodes”ŒText”“”ŒChinese (Simplified)”…””}”Œparent”hsbaŒ attributes”}”(Œids”]”Œclasses”]”Œnames”]”Œdupnames”]”Œbackrefs”]”Œ refdomain”Œstd”Œreftype”Œdoc”Œ reftarget”Œ#/translations/zh_CN/leds/leds-class”Œmodname”NŒ classname”NŒrefexplicit”ˆuŒtagname”hhhubh)”}”(hhh]”hŒChinese (Traditional)”…””}”hh2sbah}”(h]”h ]”h"]”h$]”h&]”Œ refdomain”h)Œreftype”h+Œ reftarget”Œ#/translations/zh_TW/leds/leds-class”Œmodname”NŒ classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒItalian”…””}”hhFsbah}”(h]”h ]”h"]”h$]”h&]”Œ refdomain”h)Œreftype”h+Œ reftarget”Œ#/translations/it_IT/leds/leds-class”Œmodname”NŒ classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒJapanese”…””}”hhZsbah}”(h]”h ]”h"]”h$]”h&]”Œ refdomain”h)Œreftype”h+Œ reftarget”Œ#/translations/ja_JP/leds/leds-class”Œmodname”NŒ classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒKorean”…””}”hhnsbah}”(h]”h ]”h"]”h$]”h&]”Œ refdomain”h)Œreftype”h+Œ reftarget”Œ#/translations/ko_KR/leds/leds-class”Œmodname”NŒ classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒSpanish”…””}”hh‚sbah}”(h]”h ]”h"]”h$]”h&]”Œ refdomain”h)Œreftype”h+Œ reftarget”Œ#/translations/sp_SP/leds/leds-class”Œmodname”NŒ classname”NŒrefexplicit”ˆuh1hhhubeh}”(h]”h ]”h"]”h$]”h&]”Œcurrent_language”ŒEnglish”uh1h hhŒ _document”hŒsource”NŒline”NubhŒsection”“”)”}”(hhh]”(hŒtitle”“”)”}”(hŒLED handling under Linux”h]”hŒLED handling under Linux”…””}”(hh¨hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hh£hžhhŸŒ=/var/lib/git/docbuild/linux/Documentation/leds/leds-class.rst”h KubhŒ paragraph”“”)”}”(hX|In its simplest form, the LED class just allows control of LEDs from userspace. LEDs appear in /sys/class/leds/. The maximum brightness of the LED is defined in max_brightness file. The brightness file will set the brightness of the LED (taking a value 0-max_brightness). Most LEDs don't have hardware brightness support so will just be turned on for non-zero brightness settings.”h]”hX~In its simplest form, the LED class just allows control of LEDs from userspace. LEDs appear in /sys/class/leds/. The maximum brightness of the LED is defined in max_brightness file. The brightness file will set the brightness of the LED (taking a value 0-max_brightness). Most LEDs donâ€™t have hardware brightness support so will just be turned on for non-zero brightness settings.”…””}”(hh¹hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Khh£hžhubh¸)”}”(hXŒThe class also introduces the optional concept of an LED trigger. A trigger is a kernel based source of led events. Triggers can either be simple or complex. A simple trigger isn't configurable and is designed to slot into existing subsystems with minimal additional code. Examples are the disk-activity, nand-disk and sharpsl-charge triggers. With led triggers disabled, the code optimises away.”h]”hXŽThe class also introduces the optional concept of an LED trigger. A trigger is a kernel based source of led events. Triggers can either be simple or complex. A simple trigger isnâ€™t configurable and is designed to slot into existing subsystems with minimal additional code. Examples are the disk-activity, nand-disk and sharpsl-charge triggers. With led triggers disabled, the code optimises away.”…””}”(hhÇhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Khh£hžhubh¸)”}”(hXComplex triggers while available to all LEDs have LED specific parameters and work on a per LED basis. The timer trigger is an example. The timer trigger will periodically change the LED brightness between LED_OFF and the current brightness setting. The "on" and "off" time can be specified via /sys/class/leds//delay_{on,off} in milliseconds. You can change the brightness value of a LED independently of the timer trigger. However, if you set the brightness value to LED_OFF it will also disable the timer trigger.”h]”hXComplex triggers while available to all LEDs have LED specific parameters and work on a per LED basis. The timer trigger is an example. The timer trigger will periodically change the LED brightness between LED_OFF and the current brightness setting. The â€œonâ€ and â€œoffâ€ time can be specified via /sys/class/leds//delay_{on,off} in milliseconds. You can change the brightness value of a LED independently of the timer trigger. However, if you set the brightness value to LED_OFF it will also disable the timer trigger.”…””}”(hhÕhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Khh£hžhubh¸)”}”(hŒÝYou can change triggers in a similar manner to the way an IO scheduler is chosen (via /sys/class/leds//trigger). Trigger specific parameters can appear in /sys/class/leds/ once a given trigger is selected.”h]”hŒÝYou can change triggers in a similar manner to the way an IO scheduler is chosen (via /sys/class/leds//trigger). Trigger specific parameters can appear in /sys/class/leds/ once a given trigger is selected.”…””}”(hhãhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Khh£hžhubh¢)”}”(hhh]”(h§)”}”(hŒDesign Philosophy”h]”hŒDesign Philosophy”…””}”(hhôhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hhñhžhhŸh¶h K"ubh¸)”}”(hŒ×The underlying design philosophy is simplicity. LEDs are simple devices and the aim is to keep a small amount of code giving as much functionality as possible. Please keep this in mind when suggesting enhancements.”h]”hŒ×The underlying design philosophy is simplicity. LEDs are simple devices and the aim is to keep a small amount of code giving as much functionality as possible. Please keep this in mind when suggesting enhancements.”…””}”(hjhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K$hhñhžhubeh}”(h]”Œdesign-philosophy”ah ]”h"]”Œdesign philosophy”ah$]”h&]”uh1h¡hh£hžhhŸh¶h K"ubh¢)”}”(hhh]”(h§)”}”(hŒLED Device Naming”h]”hŒLED Device Naming”…””}”(hjhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hjhžhhŸh¶h K*ubh¸)”}”(hŒIs currently of the form:”h]”hŒIs currently of the form:”…””}”(hj)hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K,hjhžhubhŒblock_quote”“”)”}”(hŒ"devicename:color:function" ”h]”h¸)”}”(hŒ"devicename:color:function"”h]”hŒâ€œdevicename:color:functionâ€”…””}”(hj=hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K.hj9ubah}”(h]”h ]”h"]”h$]”h&]”uh1j7hŸh¶h K.hjhžhubhŒbullet_list”“”)”}”(hhh]”(hŒ list_item”“”)”}”(hXçdevicename: it should refer to a unique identifier created by the kernel, like e.g. phyN for network devices or inputN for input devices, rather than to the hardware; the information related to the product and the bus to which given device is hooked is available in sysfs and can be retrieved using get_led_device_info.sh script from tools/leds; generally this section is expected mostly for LEDs that are somehow associated with other devices. ”h]”hŒdefinition_list”“”)”}”(hhh]”hŒdefinition_list_item”“”)”}”(hX½devicename: it should refer to a unique identifier created by the kernel, like e.g. phyN for network devices or inputN for input devices, rather than to the hardware; the information related to the product and the bus to which given device is hooked is available in sysfs and can be retrieved using get_led_device_info.sh script from tools/leds; generally this section is expected mostly for LEDs that are somehow associated with other devices. ”h]”(hŒterm”“”)”}”(hŒdevicename:”h]”hŒdevicename:”…””}”(hjihžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jghŸh¶h K7hjcubhŒ definition”“”)”}”(hhh]”h¸)”}”(hX°it should refer to a unique identifier created by the kernel, like e.g. phyN for network devices or inputN for input devices, rather than to the hardware; the information related to the product and the bus to which given device is hooked is available in sysfs and can be retrieved using get_led_device_info.sh script from tools/leds; generally this section is expected mostly for LEDs that are somehow associated with other devices.”h]”hX°it should refer to a unique identifier created by the kernel, like e.g. phyN for network devices or inputN for input devices, rather than to the hardware; the information related to the product and the bus to which given device is hooked is available in sysfs and can be retrieved using get_led_device_info.sh script from tools/leds; generally this section is expected mostly for LEDs that are somehow associated with other devices.”…””}”(hj|hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K1hjyubah}”(h]”h ]”h"]”h$]”h&]”uh1jwhjcubeh}”(h]”h ]”h"]”h$]”h&]”uh1jahŸh¶h K7hj^ubah}”(h]”h ]”h"]”h$]”h&]”uh1j\hjXubah}”(h]”h ]”h"]”h$]”h&]”uh1jVhjShžhhŸNh NubjW)”}”(hŒhcolor: one of LED_COLOR_ID_* definitions from the header include/dt-bindings/leds/common.h. ”h]”j])”}”(hhh]”jb)”}”(hŒ\color: one of LED_COLOR_ID_* definitions from the header include/dt-bindings/leds/common.h. ”h]”(jh)”}”(hŒcolor:”h]”hŒcolor:”…””}”(hjhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jghŸh¶h K;hj©ubjx)”}”(hhh]”h¸)”}”(hŒTone of LED_COLOR_ID_* definitions from the header include/dt-bindings/leds/common.h.”h]”hŒTone of LED_COLOR_ID_* definitions from the header include/dt-bindings/leds/common.h.”…””}”(hj¾hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K:hj»ubah}”(h]”h ]”h"]”h$]”h&]”uh1jwhj©ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jahŸh¶h K;hj¦ubah}”(h]”h ]”h"]”h$]”h&]”uh1j\hj¢ubah}”(h]”h ]”h"]”h$]”h&]”uh1jVhjShžhhŸNh NubjW)”}”(hŒkfunction: one of LED_FUNCTION_* definitions from the header include/dt-bindings/leds/common.h. ”h]”j])”}”(hhh]”jb)”}”(hŒ_function: one of LED_FUNCTION_* definitions from the header include/dt-bindings/leds/common.h. ”h]”(jh)”}”(hŒ function:”h]”hŒ function:”…””}”(hjïhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jghŸh¶h K?hjëubjx)”}”(hhh]”h¸)”}”(hŒTone of LED_FUNCTION_* definitions from the header include/dt-bindings/leds/common.h.”h]”hŒTone of LED_FUNCTION_* definitions from the header include/dt-bindings/leds/common.h.”…””}”(hjhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K>hjýubah}”(h]”h ]”h"]”h$]”h&]”uh1jwhjëubeh}”(h]”h ]”h"]”h$]”h&]”uh1jahŸh¶h K?hjèubah}”(h]”h ]”h"]”h$]”h&]”uh1j\hjäubah}”(h]”h ]”h"]”h$]”h&]”uh1jVhjShžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”Œbullet”Œ-”uh1jQhŸh¶h K0hjhžhubh¸)”}”(hŒ^If required color or function is missing, please submit a patch to linux-leds@vger.kernel.org.”h]”(hŒCIf required color or function is missing, please submit a patch to ”…””}”(hj.hžhhŸNh NubhŒ reference”“”)”}”(hŒlinux-leds@vger.kernel.org”h]”hŒlinux-leds@vger.kernel.org”…””}”(hj8hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”Œrefuri”Œ!mailto:linux-leds@vger.kernel.org”uh1j6hj.ubhŒ.”…””}”(hj.hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KAhjhžhubh¸)”}”(hXÀIt is possible that more than one LED with the same color and function will be required for given platform, differing only with an ordinal number. In this case it is preferable to just concatenate the predefined LED_FUNCTION_* name with required "-N" suffix in the driver. fwnode based drivers can use function-enumerator property for that and then the concatenation will be handled automatically by the LED core upon LED class device registration.”h]”hXÄIt is possible that more than one LED with the same color and function will be required for given platform, differing only with an ordinal number. In this case it is preferable to just concatenate the predefined LED_FUNCTION_* name with required â€œ-Nâ€ suffix in the driver. fwnode based drivers can use function-enumerator property for that and then the concatenation will be handled automatically by the LED core upon LED class device registration.”…””}”(hjRhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KDhjhžhubh¸)”}”(hX)LED subsystem has also a protection against name clash, that may occur when LED class device is created by a driver of hot-pluggable device and it doesn't provide unique devicename section. In this case numerical suffix (e.g. "_1", "_2", "_3" etc.) is added to the requested LED class device name.”h]”hX7LED subsystem has also a protection against name clash, that may occur when LED class device is created by a driver of hot-pluggable device and it doesnâ€™t provide unique devicename section. In this case numerical suffix (e.g. â€œ_1â€, â€œ_2â€, â€œ_3â€ etc.) is added to the requested LED class device name.”…””}”(hj`hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KKhjhžhubh¸)”}”(hXThere might be still LED class drivers around using vendor or product name for devicename, but this approach is now deprecated as it doesn't convey any added value. Product information can be found in other places in sysfs (see tools/leds/get_led_device_info.sh).”h]”hX There might be still LED class drivers around using vendor or product name for devicename, but this approach is now deprecated as it doesnâ€™t convey any added value. Product information can be found in other places in sysfs (see tools/leds/get_led_device_info.sh).”…””}”(hjnhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KQhjhžhubh¸)”}”(hŒExamples of proper LED names:”h]”hŒExamples of proper LED names:”…””}”(hj|hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KVhjhžhubj8)”}”(hŒá- "red:disk" - "white:flash" - "red:indicator" - "phy1:green:wlan" - "phy3::wlan" - ":kbd_backlight" - "input5::kbd_backlight" - "input3::numlock" - "input3::scrolllock" - "input3::capslock" - "mmc1::status" - "white:status" ”h]”jR)”}”(hhh]”(jW)”}”(hŒ "red:disk"”h]”h¸)”}”(hj“h]”hŒâ€œred:diskâ€”…””}”(hj•hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KXhj‘ubah}”(h]”h ]”h"]”h$]”h&]”uh1jVhjŽubjW)”}”(hŒ "white:flash"”h]”h¸)”}”(hjªh]”hŒâ€œwhite:flashâ€”…””}”(hj¬hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KYhj¨ubah}”(h]”h ]”h"]”h$]”h&]”uh1jVhjŽubjW)”}”(hŒ"red:indicator"”h]”h¸)”}”(hjÁh]”hŒâ€œred:indicatorâ€”…””}”(hjÃhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KZhj¿ubah}”(h]”h ]”h"]”h$]”h&]”uh1jVhjŽubjW)”}”(hŒ"phy1:green:wlan"”h]”h¸)”}”(hjØh]”hŒâ€œphy1:green:wlanâ€”…””}”(hjÚhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K[hjÖubah}”(h]”h ]”h"]”h$]”h&]”uh1jVhjŽubjW)”}”(hŒ"phy3::wlan"”h]”h¸)”}”(hjïh]”hŒâ€œphy3::wlanâ€”…””}”(hjñhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K\hjíubah}”(h]”h ]”h"]”h$]”h&]”uh1jVhjŽubjW)”}”(hŒ":kbd_backlight"”h]”h¸)”}”(hjh]”hŒâ€œ:kbd_backlightâ€”…””}”(hjhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K]hjubah}”(h]”h ]”h"]”h$]”h&]”uh1jVhjŽubjW)”}”(hŒ"input5::kbd_backlight"”h]”h¸)”}”(hjh]”hŒâ€œinput5::kbd_backlightâ€”…””}”(hjhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K^hjubah}”(h]”h ]”h"]”h$]”h&]”uh1jVhjŽubjW)”}”(hŒ"input3::numlock"”h]”h¸)”}”(hj4h]”hŒâ€œinput3::numlockâ€”…””}”(hj6hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K_hj2ubah}”(h]”h ]”h"]”h$]”h&]”uh1jVhjŽubjW)”}”(hŒ"input3::scrolllock"”h]”h¸)”}”(hjKh]”hŒâ€œinput3::scrolllockâ€”…””}”(hjMhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K`hjIubah}”(h]”h ]”h"]”h$]”h&]”uh1jVhjŽubjW)”}”(hŒ"input3::capslock"”h]”h¸)”}”(hjbh]”hŒâ€œinput3::capslockâ€”…””}”(hjdhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Kahj`ubah}”(h]”h ]”h"]”h$]”h&]”uh1jVhjŽubjW)”}”(hŒ"mmc1::status"”h]”h¸)”}”(hjyh]”hŒâ€œmmc1::statusâ€”…””}”(hj{hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Kbhjwubah}”(h]”h ]”h"]”h$]”h&]”uh1jVhjŽubjW)”}”(hŒ"white:status" ”h]”h¸)”}”(hŒ"white:status"”h]”hŒâ€œwhite:statusâ€”…””}”(hj’hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KchjŽubah}”(h]”h ]”h"]”h$]”h&]”uh1jVhjŽubeh}”(h]”h ]”h"]”h$]”h&]”j,j-uh1jQhŸh¶h KXhjŠubah}”(h]”h ]”h"]”h$]”h&]”uh1j7hŸh¶h KXhjhžhubh¸)”}”(hXdget_led_device_info.sh script can be used for verifying if the LED name meets the requirements pointed out here. It performs validation of the LED class devicename sections and gives hints on expected value for a section in case the validation fails for it. So far the script supports validation of associations between LEDs and following types of devices:”h]”hXdget_led_device_info.sh script can be used for verifying if the LED name meets the requirements pointed out here. It performs validation of the LED class devicename sections and gives hints on expected value for a section in case the validation fails for it. So far the script supports validation of associations between LEDs and following types of devices:”…””}”(hj²hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Kehjhžhubj8)”}”(hŒ2- input devices - ieee80211 compliant USB devices ”h]”jR)”}”(hhh]”(jW)”}”(hŒ input devices”h]”h¸)”}”(hjÉh]”hŒ input devices”…””}”(hjËhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KkhjÇubah}”(h]”h ]”h"]”h$]”h&]”uh1jVhjÄubjW)”}”(hŒ ieee80211 compliant USB devices ”h]”h¸)”}”(hŒieee80211 compliant USB devices”h]”hŒieee80211 compliant USB devices”…””}”(hjâhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KlhjÞubah}”(h]”h ]”h"]”h$]”h&]”uh1jVhjÄubeh}”(h]”h ]”h"]”h$]”h&]”j,j-uh1jQhŸh¶h KkhjÀubah}”(h]”h ]”h"]”h$]”h&]”uh1j7hŸh¶h Kkhjhžhubh¸)”}”(hŒ!The script is open to extensions.”h]”hŒ!The script is open to extensions.”…””}”(hjhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Knhjhžhubh¸)”}”(hXdThere have been calls for LED properties such as color to be exported as individual led class attributes. As a solution which doesn't incur as much overhead, I suggest these become part of the device name. The naming scheme above leaves scope for further attributes should they be needed. If sections of the name don't apply, just leave that section blank.”h]”hXhThere have been calls for LED properties such as color to be exported as individual led class attributes. As a solution which doesnâ€™t incur as much overhead, I suggest these become part of the device name. The naming scheme above leaves scope for further attributes should they be needed. If sections of the name donâ€™t apply, just leave that section blank.”…””}”(hjhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Kphjhžhubeh}”(h]”Œled-device-naming”ah ]”h"]”Œled device naming”ah$]”h&]”uh1h¡hh£hžhhŸh¶h K*ubh¢)”}”(hhh]”(h§)”}”(hŒBrightness setting API”h]”hŒBrightness setting API”…””}”(hj)hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hj&hžhhŸh¶h Kxubh¸)”}”(hŒ@LED subsystem core exposes following API for setting brightness:”h]”hŒ@LED subsystem core exposes following API for setting brightness:”…””}”(hj7hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Kzhj&hžhubj8)”}”(hX¦- led_set_brightness: it is guaranteed not to sleep, passing LED_OFF stops blinking, - led_set_brightness_sync: for use cases when immediate effect is desired - it can block the caller for the time required for accessing device registers and can sleep, passing LED_OFF stops hardware blinking, returns -EBUSY if software blink fallback is enabled. ”h]”jR)”}”(hhh]”(jW)”}”(hŒgled_set_brightness: it is guaranteed not to sleep, passing LED_OFF stops blinking, ”h]”j])”}”(hhh]”jb)”}”(hŒSled_set_brightness: it is guaranteed not to sleep, passing LED_OFF stops blinking, ”h]”(jh)”}”(hŒled_set_brightness:”h]”hŒled_set_brightness:”…””}”(hjWhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jghŸh¶h K~hjSubjx)”}”(hhh]”h¸)”}”(hŒ>it is guaranteed not to sleep, passing LED_OFF stops blinking,”h]”hŒ>it is guaranteed not to sleep, passing LED_OFF stops blinking,”…””}”(hjhhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K}hjeubah}”(h]”h ]”h"]”h$]”h&]”uh1jwhjSubeh}”(h]”h ]”h"]”h$]”h&]”uh1jahŸh¶h K~hjPubah}”(h]”h ]”h"]”h$]”h&]”uh1j\hjLubah}”(h]”h ]”h"]”h$]”h&]”uh1jVhjIubjW)”}”(hX.led_set_brightness_sync: for use cases when immediate effect is desired - it can block the caller for the time required for accessing device registers and can sleep, passing LED_OFF stops hardware blinking, returns -EBUSY if software blink fallback is enabled. ”h]”j])”}”(hhh]”jb)”}”(hXled_set_brightness_sync: for use cases when immediate effect is desired - it can block the caller for the time required for accessing device registers and can sleep, passing LED_OFF stops hardware blinking, returns -EBUSY if software blink fallback is enabled. ”h]”(jh)”}”(hŒled_set_brightness_sync:”h]”hŒled_set_brightness_sync:”…””}”(hj™hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jghŸh¶h K…hj•ubjx)”}”(hhh]”h¸)”}”(hŒëfor use cases when immediate effect is desired - it can block the caller for the time required for accessing device registers and can sleep, passing LED_OFF stops hardware blinking, returns -EBUSY if software blink fallback is enabled.”h]”hŒëfor use cases when immediate effect is desired - it can block the caller for the time required for accessing device registers and can sleep, passing LED_OFF stops hardware blinking, returns -EBUSY if software blink fallback is enabled.”…””}”(hjªhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Khj§ubah}”(h]”h ]”h"]”h$]”h&]”uh1jwhj•ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jahŸh¶h K…hj’ubah}”(h]”h ]”h"]”h$]”h&]”uh1j\hjŽubah}”(h]”h ]”h"]”h$]”h&]”uh1jVhjIubeh}”(h]”h ]”h"]”h$]”h&]”j,j-uh1jQhŸh¶h K|hjEubah}”(h]”h ]”h"]”h$]”h&]”uh1j7hŸh¶h K|hj&hžhubeh}”(h]”Œbrightness-setting-api”ah ]”h"]”Œbrightness setting api”ah$]”h&]”uh1h¡hh£hžhhŸh¶h Kxubh¢)”}”(hhh]”(h§)”}”(hŒLED registration API”h]”hŒLED registration API”…””}”(hjçhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hjähžhhŸh¶h Kˆubh¸)”}”(hX>A driver wanting to register a LED classdev for use by other drivers / userspace needs to allocate and fill a led_classdev struct and then call `[devm_]led_classdev_register`. If the non devm version is used the driver must call led_classdev_unregister from its remove function before free-ing the led_classdev struct.”h]”(hŒA driver wanting to register a LED classdev for use by other drivers / userspace needs to allocate and fill a led_classdev struct and then call ”…””}”(hjõhžhhŸNh NubhŒtitle_reference”“”)”}”(hŒ`[devm_]led_classdev_register`”h]”hŒ[devm_]led_classdev_register”…””}”(hjÿhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jýhjõubhŒ. If the non devm version is used the driver must call led_classdev_unregister from its remove function before free-ing the led_classdev struct.”…””}”(hjõhžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KŠhjähžhubh¸)”}”(hX\If the driver can detect hardware initiated brightness changes and thus wants to have a brightness_hw_changed attribute then the LED_BRIGHT_HW_CHANGED flag must be set in flags before registering. Calling led_classdev_notify_brightness_hw_changed on a classdev not registered with the LED_BRIGHT_HW_CHANGED flag is a bug and will trigger a WARN_ON.”h]”hX\If the driver can detect hardware initiated brightness changes and thus wants to have a brightness_hw_changed attribute then the LED_BRIGHT_HW_CHANGED flag must be set in flags before registering. Calling led_classdev_notify_brightness_hw_changed on a classdev not registered with the LED_BRIGHT_HW_CHANGED flag is a bug and will trigger a WARN_ON.”…””}”(hjhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Khjähžhubeh}”(h]”Œled-registration-api”ah ]”h"]”Œled registration api”ah$]”h&]”uh1h¡hh£hžhhŸh¶h Kˆubh¢)”}”(hhh]”(h§)”}”(hŒ"Hardware accelerated blink of LEDs”h]”hŒ"Hardware accelerated blink of LEDs”…””}”(hj0hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hj-hžhhŸh¶h K—ubh¸)”}”(hXHSome LEDs can be programmed to blink without any CPU interaction. To support this feature, a LED driver can optionally implement the blink_set() function (see ). To set an LED to blinking, however, it is better to use the API function led_blink_set(), as it will check and implement software fallback if necessary.”h]”hXHSome LEDs can be programmed to blink without any CPU interaction. To support this feature, a LED driver can optionally implement the blink_set() function (see ). To set an LED to blinking, however, it is better to use the API function led_blink_set(), as it will check and implement software fallback if necessary.”…””}”(hj>hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K™hj-hžhubh¸)”}”(hŒ®To turn off blinking, use the API function led_brightness_set() with brightness value LED_OFF, which should stop any software timers that may have been required for blinking.”h]”hŒ®To turn off blinking, use the API function led_brightness_set() with brightness value LED_OFF, which should stop any software timers that may have been required for blinking.”…””}”(hjLhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KŸhj-hžhubh¸)”}”(hXThe blink_set() function should choose a user friendly blinking value if it is called with `*delay_on==0` && `*delay_off==0` parameters. In this case the driver should give back the chosen value through delay_on and delay_off parameters to the leds subsystem.”h]”(hŒ[The blink_set() function should choose a user friendly blinking value if it is called with ”…””}”(hjZhžhhŸNh Nubjþ)”}”(hŒ`*delay_on==0`”h]”hŒ*delay_on==0”…””}”(hjbhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jýhjZubhŒ && ”…””}”(hjZhžhhŸNh Nubjþ)”}”(hŒ`*delay_off==0`”h]”hŒ *delay_off==0”…””}”(hjthžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jýhjZubhŒ‡ parameters. In this case the driver should give back the chosen value through delay_on and delay_off parameters to the leds subsystem.”…””}”(hjZhžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K£hj-hžhubh¸)”}”(hŒ²Setting the brightness to zero with brightness_set() callback function should completely turn off the LED and cancel the previously programmed hardware blinking function, if any.”h]”hŒ²Setting the brightness to zero with brightness_set() callback function should completely turn off the LED and cancel the previously programmed hardware blinking function, if any.”…””}”(hjŒhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K¨hj-hžhubeh}”(h]”Œ"hardware-accelerated-blink-of-leds”ah ]”h"]”Œ"hardware accelerated blink of leds”ah$]”h&]”uh1h¡hh£hžhhŸh¶h K—ubh¢)”}”(hhh]”(h§)”}”(hŒHardware driven LEDs”h]”hŒHardware driven LEDs”…””}”(hj¥hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hj¢hžhhŸh¶h Kubh¸)”}”(hXSome LEDs can be programmed to be driven by hardware. This is not limited to blink but also to turn off or on autonomously. To support this feature, a LED needs to implement various additional ops and needs to declare specific support for the supported triggers.”h]”hXSome LEDs can be programmed to be driven by hardware. This is not limited to blink but also to turn off or on autonomously. To support this feature, a LED needs to implement various additional ops and needs to declare specific support for the supported triggers.”…””}”(hj³hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K¯hj¢hžhubh¸)”}”(hŒ7With hw control we refer to the LED driven by hardware.”h]”hŒ7With hw control we refer to the LED driven by hardware.”…””}”(hjÁhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K´hj¢hžhubh¸)”}”(hŒALED driver must define the following value to support hw control:”h]”hŒALED driver must define the following value to support hw control:”…””}”(hjÏhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K¶hj¢hžhubj8)”}”(hŒi- hw_control_trigger: unique trigger name supported by the LED in hw control mode. ”h]”jR)”}”(hhh]”jW)”}”(hŒchw_control_trigger: unique trigger name supported by the LED in hw control mode. ”h]”j])”}”(hhh]”jb)”}”(hŒQhw_control_trigger: unique trigger name supported by the LED in hw control mode. ”h]”(jh)”}”(hŒhw_control_trigger:”h]”hŒhw_control_trigger:”…””}”(hjïhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jghŸh¶h Kºhjëubjx)”}”(hhh]”h¸)”}”(hŒhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jghŸh¶h Kßhj:ubjx)”}”(hhh]”(h¸)”}”(hŒ‚get active modes from a LED already in hw control, parse them and set in flags the current active flags for the supported trigger.”h]”hŒ‚get active modes from a LED already in hw control, parse them and set in flags the current active flags for the supported trigger.”…””}”(hjOhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K×hjLubh¸)”}”(hŒÊReturn 0 on success, a negative error number on failing parsing the initial mode. Error from this function is NOT FATAL as the device may be in a not supported initial state by the attached LED trigger.”h]”hŒÊReturn 0 on success, a negative error number on failing parsing the initial mode. Error from this function is NOT FATAL as the device may be in a not supported initial state by the attached LED trigger.”…””}”(hj]hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KÛhjLubeh}”(h]”h ]”h"]”h$]”h&]”uh1jwhj:ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jahŸh¶h Kßhj7ubah}”(h]”h ]”h"]”h$]”h&]”uh1j\hj3ubah}”(h]”h ]”h"]”h$]”h&]”uh1jVhj0ubjW)”}”(hX=hw_control_get_device: return the device associated with the LED driver in hw control. A trigger might use this to match the returned device from this function with a configured device for the trigger as the source for blinking events and correctly enable hw control. (example a netdev trigger configured to blink for a particular dev match the returned dev from get_device to set hw control) Returns a pointer to a struct device or NULL if nothing is currently attached. ”h]”j])”}”(hhh]”jb)”}”(hXÙhw_control_get_device: return the device associated with the LED driver in hw control. A trigger might use this to match the returned device from this function with a configured device for the trigger as the source for blinking events and correctly enable hw control. (example a netdev trigger configured to blink for a particular dev match the returned dev from get_device to set hw control) Returns a pointer to a struct device or NULL if nothing is currently attached. ”h]”(jh)”}”(hŒhw_control_get_device:”h]”hŒhw_control_get_device:”…””}”(hjŽhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jghŸh¶h KìhjŠubjx)”}”(hhh]”(h¸)”}”(hXqreturn the device associated with the LED driver in hw control. A trigger might use this to match the returned device from this function with a configured device for the trigger as the source for blinking events and correctly enable hw control. (example a netdev trigger configured to blink for a particular dev match the returned dev from get_device to set hw control)”h]”hXqreturn the device associated with the LED driver in hw control. A trigger might use this to match the returned device from this function with a configured device for the trigger as the source for blinking events and correctly enable hw control. (example a netdev trigger configured to blink for a particular dev match the returned dev from get_device to set hw control)”…””}”(hjŸhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Kâhjœubh¸)”}”(hŒNReturns a pointer to a struct device or NULL if nothing is currently attached.”h]”hŒNReturns a pointer to a struct device or NULL if nothing is currently attached.”…””}”(hjhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Këhjœubeh}”(h]”h ]”h"]”h$]”h&]”uh1jwhjŠubeh}”(h]”h ]”h"]”h$]”h&]”uh1jahŸh¶h Kìhj‡ubah}”(h]”h ]”h"]”h$]”h&]”uh1j\hjƒubah}”(h]”h ]”h"]”h$]”h&]”uh1jVhj0ubeh}”(h]”h ]”h"]”h$]”h&]”j,j-uh1jQhŸh¶h KÖhjGubeh}”(h]”h ]”h"]”h$]”h&]”uh1jwhj5ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jahŸh¶h Kìhj2ubah}”(h]”h ]”h"]”h$]”h&]”uh1j\hj¢hžhhŸNh Nubh¸)”}”(hXLED driver can activate additional modes by default to workaround the impossibility of supporting each different mode on the supported trigger. Examples are hardcoding the blink speed to a set interval, enable special feature like bypassing blink if some requirements are not met.”h]”hXLED driver can activate additional modes by default to workaround the impossibility of supporting each different mode on the supported trigger. Examples are hardcoding the blink speed to a set interval, enable special feature like bypassing blink if some requirements are not met.”…””}”(hjëhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Kîhj¢hžhubh¸)”}”(hXA trigger should first check if the hw control API are supported by the LED driver and check if the trigger is supported to verify if hw control is possible, use hw_control_is_supported to check if the flags are supported and only at the end use hw_control_set to activate hw control.”h]”hXA trigger should first check if the hw control API are supported by the LED driver and check if the trigger is supported to verify if hw control is possible, use hw_control_is_supported to check if the flags are supported and only at the end use hw_control_set to activate hw control.”…””}”(hjùhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Kóhj¢hžhubh¸)”}”(hŒaA trigger can use hw_control_get to check if a LED is already in hw control and init their flags.”h]”hŒaA trigger can use hw_control_get to check if a LED is already in hw control and init their flags.”…””}”(hjhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Køhj¢hžhubh¸)”}”(hŒnWhen the LED is in hw control, no software blink is possible and doing so will effectively disable hw control.”h]”hŒnWhen the LED is in hw control, no software blink is possible and doing so will effectively disable hw control.”…””}”(hjhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Kûhj¢hžhubeh}”(h]”Œhardware-driven-leds”ah ]”h"]”Œhardware driven leds”ah$]”h&]”uh1h¡hh£hžhhŸh¶h Kubh¢)”}”(hhh]”(h§)”}”(hŒKnown Issues”h]”hŒKnown Issues”…””}”(hj.hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hj+hžhhŸh¶h Kÿubh¸)”}”(hŒüThe LED Trigger core cannot be a module as the simple trigger functions would cause nightmare dependency issues. I see this as a minor issue compared to the benefits the simple trigger functionality brings. The rest of the LED subsystem can be modular.”h]”hŒüThe LED Trigger core cannot be a module as the simple trigger functions would cause nightmare dependency issues. I see this as a minor issue compared to the benefits the simple trigger functionality brings. The rest of the LED subsystem can be modular.”…””}”(hj<hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Mhj+hžhubeh}”(h]”Œknown-issues”ah ]”h"]”Œknown issues”ah$]”h&]”uh1h¡hh£hžhhŸh¶h Kÿubeh}”(h]”Œled-handling-under-linux”ah ]”h"]”Œled handling under linux”ah$]”h&]”uh1h¡hhhžhhŸh¶h Kubeh}”(h]”h ]”h"]”h$]”h&]”Œsource”h¶uh1hŒcurrent_source”NŒcurrent_line”NŒsettings”Œdocutils.frontend”ŒValues”“”)”}”(h¦NŒ generator”NŒ datestamp”NŒsource_link”NŒ source_url”NŒ toc_backlinks”Œentry”Œfootnote_backlinks”KŒ sectnum_xform”KŒstrip_comments”NŒstrip_elements_with_classes”NŒ strip_classes”NŒreport_level”KŒ halt_level”KŒexit_status_level”KŒdebug”NŒwarning_stream”NŒ traceback”ˆŒinput_encoding”Œ utf-8-sig”Œinput_encoding_error_handler”Œstrict”Œoutput_encoding”Œutf-8”Œoutput_encoding_error_handler”j}Œerror_encoding”Œutf-8”Œerror_encoding_error_handler”Œbackslashreplace”Œ language_code”Œen”Œrecord_dependencies”NŒconfig”NŒ id_prefix”hŒauto_id_prefix”Œid”Œ dump_settings”NŒdump_internals”NŒdump_transforms”NŒdump_pseudo_xml”NŒexpose_internals”NŒstrict_visitor”NŒ_disable_config”NŒ_source”h¶Œ_destination”NŒ _config_files”]”Œ7/var/lib/git/docbuild/linux/Documentation/docutils.conf”aŒfile_insertion_enabled”ˆŒraw_enabled”KŒline_length_limit”M'Œpep_references”NŒpep_base_url”Œhttps://peps.python.org/”Œpep_file_url_template”Œpep-%04d”Œrfc_references”NŒrfc_base_url”Œ&https://datatracker.ietf.org/doc/html/”Œ tab_width”KŒtrim_footnote_reference_space”‰Œsyntax_highlight”Œlong”Œsmart_quotes”ˆŒsmartquotes_locales”]”Œcharacter_level_inline_markup”‰Œdoctitle_xform”‰Œ docinfo_xform”KŒsectsubtitle_xform”‰Œ image_loading”Œlink”Œembed_stylesheet”‰Œcloak_email_addresses”ˆŒsection_self_link”‰Œenv”NubŒreporter”NŒindirect_targets”]”Œsubstitution_defs”}”Œsubstitution_names”}”Œrefnames”}”Œrefids”}”Œnameids”}”(jWjTjjj#j jájÞj*j'jŸjœj(j%jOjLuŒ nametypes”}”(jW‰j‰j#‰já‰j*‰jŸ‰j(‰jO‰uh}”(jTh£jhñj jjÞj&j'jäjœj-j%j¢jLj+uŒ footnote_refs”}”Œ citation_refs”}”Œ autofootnotes”]”Œautofootnote_refs”]”Œsymbol_footnotes”]”Œsymbol_footnote_refs”]”Œ footnotes”]”Œ citations”]”Œautofootnote_start”KŒsymbol_footnote_start”KŒ id_counter”Œcollections”ŒCounter”“”}”…”R”Œparse_messages”]”Œtransform_messages”]”Œtransformer”NŒinclude_log”]”Œ decoration”Nhžhub.