openbmc/phosphor-buttons/README.md

1 # phosphor-buttons
3 Phosphor-buttons has a collection of IO event handler interfaces for physical
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
13 ### Power Button
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
28 The 'power-button-profile' meson option can be used to select custom power
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).
46 - If 'reset-button-do-warm-reboot' meson option is set to enabled, does warm
48 - Otherwise, reboots the host (default behavior)
53 phosphor-led-manager repository. The group name can be changed using the
54 'id-led-group' meson option.
59 should be mentioned in the gpio defs json file -
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
147 a CPLD as GPIO inputs without edge-triggered interrupt support (e.g., no edge
148 detection on GPIOs). In such situations, software-based polling mode can be
151 - **polling_mode** : Set to `true` to enable polling mode.
152 - **polling_interval_ms** (optional): Polling interval in milliseconds. Defaults
261 - name - The button interface type name.
262 - i2c_bus - The i2c bus of cpld
263 - i2c_address - The i2c address of cpld
264 - register_name - The register file name exported by CLD driver for IO event
266 - max_position - This represents the max number of hosts in the multi-host bmc
276       "register_name": "uart-selection-debug-card",
294 lines and serial_uart_rx line.
296 - name - this is name of the specific gpio line
297 - pin - this represents the pin number from linux dts file.
298 - polarity - polarity type of the gpio
299 - serial_uart_mux_map - This is the map for selected host position to the serial
354 ## Multiple power gpio config example
356 This config is used for configs with multiple power buttons on each slots and
357 whole sled, or for which needs multi-level chassis power control behavior.
359 name - this is name of the specific gpio line, "POWER_BUTTON" + the index of
362 - pin - this represents the pin number from linux dts file.
363 - multi-action - default no action, set the corresponding behavior with
365 - duration - activate when pulling gpio over this value (unit: millisecond)
366 - action - chassis power control behavior
375       "multi-action": [
386       "multi-action": [