tjh.dev / kernel
Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux
1
fork

Configure Feed

Select the types of activity you want to include in your feed.

docs: debugging: add more info about devcoredump

Correct a few small things in the devcoredump synopsis and then add
the devcoredump APIs to it.

Fixes: a037699da0a1 ("docs: Add debugging section to process")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Sebastian Fricke <sebastian.fricke@collabora.com>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org
Cc: Johannes Berg <johannes@sipsolutions.net>
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: workflows@vger.kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20241130081107.552503-1-rdunlap@infradead.org

authored by

Randy Dunlap and committed by
Jonathan Corbet 126437fc 28884915

+16 -4
+16 -4
Documentation/process/debugging/driver_development_debugging_guide.rst
··· 207 207 device coredump 208 208 --------------- 209 209 210 - Prerequisite: ``#include <linux/devcoredump.h>`` 210 + Prerequisite: ``CONFIG_DEV_COREDUMP`` & ``#include <linux/devcoredump.h>`` 211 211 212 212 Provides the infrastructure for a driver to provide arbitrary data to userland. 213 213 It is most often used in conjunction with udev or similar userland application 214 214 to listen for kernel uevents, which indicate that the dump is ready. Udev has 215 215 rules to copy that file somewhere for long-term storage and analysis, as by 216 - default, the data for the dump is automatically cleaned up after 5 minutes. 217 - That data is analyzed with driver-specific tools or GDB. 216 + default, the data for the dump is automatically cleaned up after a default 217 + 5 minutes. That data is analyzed with driver-specific tools or GDB. 218 + 219 + A device coredump can be created with a vmalloc area, with read/free 220 + methods, or as a scatter/gather list. 218 221 219 222 You can find an example implementation at: 220 223 `drivers/media/platform/qcom/venus/core.c 221 - <https://elixir.bootlin.com/linux/v6.11.6/source/drivers/media/platform/qcom/venus/core.c#L30>`__ 224 + <https://elixir.bootlin.com/linux/v6.11.6/source/drivers/media/platform/qcom/venus/core.c#L30>`__, 225 + in the Bluetooth HCI layer, in several wireless drivers, and in several 226 + DRM drivers. 227 + 228 + devcoredump interfaces 229 + ~~~~~~~~~~~~~~~~~~~~~~ 230 + 231 + .. kernel-doc:: include/linux/devcoredump.h 232 + 233 + .. kernel-doc:: drivers/base/devcoredump.c 222 234 223 235 **Copyright** ©2024 : Collabora