xref: /openbmc/debug-trigger/README.md (revision 11cd254b)
1*11cd254bSAndrew Jeffery# BMC Debug Trigger #
2*11cd254bSAndrew Jeffery
3*11cd254bSAndrew Jeffery`debug-trigger` listens for an external signal that the BMC is in some way
4*11cd254bSAndrew Jefferyunresponsive. When the signal is received it triggers a crash to collect debug
5*11cd254bSAndrew Jefferydata and reboots the system in the hope that it will recover.
6*11cd254bSAndrew Jeffery
7*11cd254bSAndrew Jeffery## Trigger sources ##
8*11cd254bSAndrew Jeffery
9*11cd254bSAndrew Jeffery`debug-trigger` implements a simple protocol over an LPC KCS device as its
10*11cd254bSAndrew Jefferytrigger source.
11*11cd254bSAndrew Jeffery
12*11cd254bSAndrew Jeffery## Debug actions ##
13*11cd254bSAndrew Jeffery
14*11cd254bSAndrew Jeffery`debug-trigger` implements a single action once the trigger event is received,
15*11cd254bSAndrew Jefferywhich is to crash the kernel via `/proc/sysrq-trigger`. For systems with kdump
16*11cd254bSAndrew Jefferyconfigured this results in collection of system state as context for why the
17*11cd254bSAndrew Jefferysystem was externally unresponsive.
18