Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
tty: vt: document the rest of struct consw
There are still members of struct consw which are not documented yet.
Fix that up, so we can generate kernel-doc for that struct.
Signed-off-by: "Jiri Slaby (SUSE)" <jirislaby@kernel.org>
Tested-by: Helge Deller <deller@gmx.de> # parisc STI console
Link: https://lore.kernel.org/r/20240122110401.7289-46-jirislaby@kernel.org
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
authored by
Jiri Slaby (SUSE)
and committed by
Greg Kroah-Hartman
d1e22216
b23bf1a4
+25
-9
+25
-9
include/linux/console.h
+25
-9
include/linux/console.h
···
37
37
/**
38
38
* struct consw - callbacks for consoles
39
39
*
40
+
* @owner: the module to get references of when this console is used
41
+
* @con_startup: set up the console and return its name (like VGA, EGA, ...)
40
42
* @con_init: initialize the console on @vc. @init is true for the very first
41
43
* call on this @vc.
44
+
* @con_deinit: deinitialize the console from @vc.
42
45
* @con_clear: erase @count characters at [@x, @y] on @vc. @count >= 1.
43
46
* @con_putc: emit one character with attributes @ca to [@x, @y] on @vc.
44
47
* (optional -- @con_putcs would be called instead)
···
55
52
* @con_blank: blank/unblank the console. The target mode is passed in @blank.
56
53
* @mode_switch is set if changing from/to text/graphics. The hook
57
54
* is supposed to return true if a redraw is needed.
58
-
* @con_set_palette: sets the palette of the console to @table (optional)
55
+
* @con_font_set: set console @vc font to @font with height @vpitch. @flags can
56
+
* be %KD_FONT_FLAG_DONT_RECALC. (optional)
57
+
* @con_font_get: fetch the current font on @vc of height @vpitch into @font.
58
+
* (optional)
59
+
* @con_font_default: set default font on @vc. @name can be %NULL or font name
60
+
* to search for. @font can be filled back. (optional)
61
+
* @con_resize: resize the @vc console to @width x @height. @from_user is true
62
+
* when this change comes from the user space.
63
+
* @con_set_palette: sets the palette of the console @vc to @table (optional)
59
64
* @con_scrolldelta: the contents of the console should be scrolled by @lines.
60
65
* Invoked by user. (optional)
61
66
* @con_set_origin: set origin (see &vc_data::vc_origin) of the @vc. If not
62
67
* provided or returns false, the origin is set to
63
68
* @vc->vc_screenbuf. (optional)
69
+
* @con_save_screen: save screen content into @vc->vc_screenbuf. Called e.g.
70
+
* upon entering graphics. (optional)
71
+
* @con_build_attr: build attributes based on @color, @intensity and other
72
+
* parameters. The result is used for both normal and erase
73
+
* characters. (optional)
74
+
* @con_invert_region: invert a region of length @count on @vc starting at @p.
75
+
* (optional)
76
+
* @con_debug_enter: prepare the console for the debugger. This includes, but
77
+
* is not limited to, unblanking the console, loading an
78
+
* appropriate palette, and allowing debugger generated output.
79
+
* (optional)
80
+
* @con_debug_leave: restore the console to its pre-debug state as closely as
81
+
* possible. (optional)
64
82
*/
65
83
struct consw {
66
84
struct module *owner;
···
120
96
enum vc_intensity intensity,
121
97
bool blink, bool underline, bool reverse, bool italic);
122
98
void (*con_invert_region)(struct vc_data *vc, u16 *p, int count);
123
-
/*
124
-
* Prepare the console for the debugger. This includes, but is not
125
-
* limited to, unblanking the console, loading an appropriate
126
-
* palette, and allowing debugger generated output.
127
-
*/
128
99
void (*con_debug_enter)(struct vc_data *vc);
129
-
/*
130
-
* Restore the console to its pre-debug state as closely as possible.
131
-
*/
132
100
void (*con_debug_leave)(struct vc_data *vc);
133
101
};
134
102