Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 84c08fd6 authored by Jason Wessel's avatar Jason Wessel
Browse files

kgdb,docs: Update the kgdb docs to include kdb 



Update the kgdb docs to reflect the new directory structure and API.

Merge in the kdb shell information.

[Randy Dunlap <rdunlap@xenotime.net>: grammatical corrections]

CC: Randy Dunlap <rdunlap@xenotime.net>
Signed-off-by: default avatarJason Wessel <jason.wessel@windriver.com>
parent ada64e4c

Documentation/DocBook/kgdb.tmpl

+516 −176

File changed.

Preview size limit exceeded, changes collapsed.

Documentation/kernel-parameters.txt

+5 −1
Original line number Diff line number Diff line
@@ -58,6 +58,7 @@ parameter is applicable: 
	ISAPNP	ISA PnP code is enabled.

	ISDN	Appropriate ISDN support is enabled.

	JOY	Appropriate joystick support is enabled.

	KGDB	Kernel debugger support is enabled.

	KVM	Kernel Virtual Machine support is enabled.

	LIBATA  Libata driver is enabled

	LP	Printer support is enabled.
@@ -1120,13 +1121,16 @@ and is between 256 and 4096 characters. It is defined in the file 
			use the HighMem zone if it exists, and the Normal

			zone if it does not.



	kgdboc=		[HW] kgdb over consoles.

	kgdboc=		[KGDB,HW] kgdb over consoles.

			Requires a tty driver that supports console polling,

			or a supported polling keyboard driver (non-usb).

			Serial only format: <serial_device>[,baud]

			keyboard only format: kbd

			keyboard and serial format: kbd,<serial_device>[,baud]



	kgdbwait	[KGDB] Stop kernel execution and enter the

			kernel debugger at the earliest opportunity.



	kmac=		[MIPS] korina ethernet MAC address.

			Configure the RouterBoard 532 series on-chip

			Ethernet adapter MAC address.

include/linux/kgdb.h

+11 −1
Original line number Diff line number Diff line
@@ -204,6 +204,17 @@ kgdb_arch_handle_exception(int vector, int signo, int err_code, 
 */

extern void kgdb_roundup_cpus(unsigned long flags);



/**

 *	kgdb_arch_set_pc - Generic call back to the program counter

 *	@regs: Current &struct pt_regs.

 *  @pc: The new value for the program counter

 *

 *	This function handles updating the program counter and requires an

 *	architecture specific implementation.

 */

extern void kgdb_arch_set_pc(struct pt_regs *regs, unsigned long pc);





/* Optional functions. */

extern int kgdb_validate_break_address(unsigned long addr);

extern int kgdb_arch_set_breakpoint(unsigned long addr, char *saved_instr);
@@ -264,7 +275,6 @@ extern struct kgdb_arch arch_kgdb_ops; 


extern unsigned long __weak kgdb_arch_pc(int exception, struct pt_regs *regs);



extern void kgdb_arch_set_pc(struct pt_regs *regs, unsigned long pc);

extern int kgdb_register_io_module(struct kgdb_io *local_kgdb_io_ops);

extern void kgdb_unregister_io_module(struct kgdb_io *local_kgdb_io_ops);

extern struct kgdb_io *dbg_io_ops;