xref: /openbmc/debug-trigger/README.md (revision 5d26ce6d)
1*5d26ce6dSAndrew Jeffery# BMC Debug Trigger
211cd254bSAndrew Jeffery
311cd254bSAndrew Jeffery`debug-trigger` listens for an external signal that the BMC is in some way
411cd254bSAndrew Jefferyunresponsive. When the signal is received it triggers a crash to collect debug
511cd254bSAndrew Jefferydata and reboots the system in the hope that it will recover.
611cd254bSAndrew Jeffery
7*5d26ce6dSAndrew Jeffery## Trigger sources
811cd254bSAndrew Jeffery
911cd254bSAndrew Jeffery`debug-trigger` implements a simple protocol over an LPC KCS device as its
1011cd254bSAndrew Jefferytrigger source.
1111cd254bSAndrew Jeffery
12*5d26ce6dSAndrew Jeffery## Debug actions
1311cd254bSAndrew Jeffery
1411cd254bSAndrew Jeffery`debug-trigger` implements a single action once the trigger event is received,
1511cd254bSAndrew Jefferywhich is to crash the kernel via `/proc/sysrq-trigger`. For systems with kdump
1611cd254bSAndrew Jefferyconfigured this results in collection of system state as context for why the
1711cd254bSAndrew Jefferysystem was externally unresponsive.
18