openbmc/phosphor-buttons/README.md

1 # phosphor-buttons
3 Phosphor-buttons has a collection of IO event handler interfaces for physical
8 its associated IO for event changes and emits signals that the button-handler
22 - Short press: Do a host power off
23 - Long press, as determined by the 'long-press-time-ms' meson option: Do a
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
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.
56 ## Gpio defs config
58 In order to monitor a button/input interface the respective gpio config details
59 should be mentioned in the gpio defs json file -
60 `/etc/default/obmc/gpio/gpio_defs.json`
63 2. An array consists of single or multiple gpio configs associated with the
66 A gpio can be mapped using the "pin" or "num" keyword. The "pin" key uses
69 ## example gpio def Json config
118 ## Single gpio config
120 This config is original config which can be used for configs with only single
121 gpio such as power button,reset button, OCP debug card host select button.
131 **Note:** this config is used by most of the other platforms so this format is
132 kept as it is so that existing gpio configs do not get affected.
134 ## Group gpio config
136 The following configs are related to multi-host bmc systems more info explained
138 <https://github.com/openbmc/docs/blob/master/designs/multihost-phosphor-buttons.md>
140 ### Host selector gpio config example  argument
145 - name - This is name of the specific gpio line
146 - pin - This represents the pin number from linux dts file.
147 - polarity - polarity type of the gpio
148 - max_position - This represents the max number of hosts in the multi-host bmc
150 - host_selector_map - This map is oem specific host position map which has how
154 Example : The value of "7" derived from the 4 host select gpio lines are mapped
203 ### Host selector cpld config example  argument
208 - name - The button interface type name.
209 - i2c_bus - The i2c bus of cpld
210 - i2c_address - The i2c address of cpld
211 - register_name - The register file name exported by CLD driver for IO event
213 - max_position - This represents the max number of hosts in the multi-host bmc
223       "register_name": "uart-selection-debug-card",
230 ### Serial uart mux config  argument
233 uart mux. These gpio configs are specified as part of json array
237 card present gpio is mentioned part of the group_gpio_config. The debug card
238 present gpio is identified by its name "debug_card_present".
240 The other gpios part of the group gpio config is serial uart MUX gpio select
243 - name - this is name of the specific gpio line
244 - pin - this represents the pin number from linux dts file.
245 - polarity - polarity type of the gpio
246 - serial_uart_mux_map - This is the map for selected host position to the serial
301 ## Multiple power gpio config example
303 This config is used for configs with multiple power buttons on each slots and
304 whole sled, or for which needs multi-level chassis power control behavior.
306 name - this is name of the specific gpio line, "POWER_BUTTON" + the index of
309 - pin - this represents the pin number from linux dts file.
310 - multi-action - default no action, set the corresponding behavior with
312 - duration - activate when pulling gpio over this value (unit: millisecond)
313 - action - chassis power control behavior
322       "multi-action": [
333       "multi-action": [