openbmc/phosphor-buttons/README.md

1 # phosphor-buttons
3 Phosphor-buttons has a collection of IO event handler interfaces for physical
6 It defines an individual dbus interface object for each physical button/switch
7 inputs such as power button, reset button etc. Each button interface monitors
8 its associated IO for event changes and emits signals that the button-handler
11 ## Button Behavior
13 ### Power Button
15 All events occur when the button is released.
17 If the power is off, power on the host.
19 If the power is on, it depends on how long the press was and which options are
22 - Short press: Do a host power off
23 - Long press, as determined by the 'long-press-time-ms' meson option: Do a
24   chassis (hard) power off.
26 #### Custom Power Button Profiles  argument
28 The 'power-button-profile' meson option can be used to select custom power
29 button profiles that have different behaviors.
33 - host_then_chassis_poweroff: When power is on, short presses are ignored and a
34   long press issues a host power off first and then a chassis power off if held
38 ### Multi-Host Buttons
40 See [this section below](#group-gpio-config).
42 ### Reset Button
46 - If 'reset-button-do-warm-reboot' meson option is set to enabled, does warm
48 - Otherwise, reboots the host (default behavior)
50 ### ID Button
53 phosphor-led-manager repository. The group name can be changed using the
54 'id-led-group' meson option.
58 In order to monitor a button/input interface the respective gpio config details
59 should be mentioned in the gpio defs json file -
62 1. The button interface type name.
64    specific button interface.
113 gpio such as power button,reset button, OCP debug card host select button.
128 The following configs are related to multi-host bmc systems more info explained
130 <https://github.com/openbmc/docs/blob/master/designs/multihost-phosphor-buttons.md>
137 - name - This is name of the specific gpio line
138 - pin - This represents the pin number from linux dts file.
139 - polarity - polarity type of the gpio
140 - max_position - This represents the max number of hosts in the multi-host bmc
142 - host_selector_map - This map is oem specific host position map which has how
200 - name - The button interface type name.
201 - i2c_bus - The i2c bus of cpld
202 - i2c_address - The i2c address of cpld
203 - register_name - The register file name exported by CLD driver for IO event
205 - max_position - This represents the max number of hosts in the multi-host bmc
215       "register_name": "uart-selection-debug-card",
235 - name - this is name of the specific gpio line
236 - pin - this represents the pin number from linux dts file.
237 - polarity - polarity type of the gpio
238 - serial_uart_mux_map - This is the map for selected host position to the serial
293 ## Multiple power gpio config example
295 This config is used for configs with multiple power buttons on each slots and
296 whole sled, or for which needs multi-level chassis power control behavior.
298 name - this is name of the specific gpio line, "POWER_BUTTON" + the index of
301 - pin - this represents the pin number from linux dts file.
302 - multi-action - default no action, set the corresponding behavior with
304 - duration - activate when pulling gpio over this value (unit: millisecond)
305 - action - chassis power control behavior
314       "multi-action": [
325       "multi-action": [