The structure 'console_cmdline' was originally intended to store details
about consoles defined on the kernel command line. However, its usage
has since expanded; it now stores information for consoles preferred
via SPCR, device tree, or by particular platforms, e.g. XEN.
The current naming is misleading as it implies the configuration only
originates from the command line.
Rename the structure and associated artifacts to better reflect their
current purpose, for example:
- struct console_cmdline c -> struct preferred_console pc
- console_cmdline[] -> preferred_consoles[]
- console_cmdline.h -> console_register.h
- c -> pc
Additionally, renaming the header file to console_register.h would
eventually allow to decouple console registration logic from
the monolithic printk.c.
Finally, renaming the local variable from "c" to "pc" helps to distinguish
it from struct console variables. Note that "c" is used for struct console
in some code, for example see vt_console_device() function definition.
Signed-off-by: Petr Mladek <pmladek@suse.com>
---
kernel/printk/braille.c | 10 +--
kernel/printk/braille.h | 10 +--
.../{console_cmdline.h => console_register.h} | 6 +-
kernel/printk/printk.c | 84 ++++++++++---------
4 files changed, 56 insertions(+), 54 deletions(-)
rename kernel/printk/{console_cmdline.h => console_register.h} (83%)
diff --git a/kernel/printk/braille.c b/kernel/printk/braille.c
index 17a9591e54ff..9d21a2bb1d38 100644
--- a/kernel/printk/braille.c
+++ b/kernel/printk/braille.c
@@ -6,7 +6,7 @@
#include <linux/errno.h>
#include <linux/string.h>
-#include "console_cmdline.h"
+#include "console_register.h"
#include "braille.h"
int _braille_console_setup(char **str, char **brl_options)
@@ -35,14 +35,14 @@ int _braille_console_setup(char **str, char **brl_options)
}
int
-_braille_register_console(struct console *console, struct console_cmdline *c)
+_braille_register_console(struct console *console, struct preferred_console *pc)
{
int rtn = 0;
- if (c->brl_options) {
+ if (pc->brl_options) {
console->flags |= CON_BRL;
- rtn = braille_register_console(console, c->index, c->options,
- c->brl_options);
+ rtn = braille_register_console(console, pc->index, pc->options,
+ pc->brl_options);
}
return rtn;
diff --git a/kernel/printk/braille.h b/kernel/printk/braille.h
index 123154f86304..55cd3178a17a 100644
--- a/kernel/printk/braille.h
+++ b/kernel/printk/braille.h
@@ -5,9 +5,9 @@
#ifdef CONFIG_A11Y_BRAILLE_CONSOLE
static inline void
-braille_set_options(struct console_cmdline *c, char *brl_options)
+braille_set_options(struct preferred_console *pc, char *brl_options)
{
- c->brl_options = brl_options;
+ pc->brl_options = brl_options;
}
/*
@@ -21,7 +21,7 @@ int
_braille_console_setup(char **str, char **brl_options);
int
-_braille_register_console(struct console *console, struct console_cmdline *c);
+_braille_register_console(struct console *console, struct preferred_console *pc);
int
_braille_unregister_console(struct console *console);
@@ -29,7 +29,7 @@ _braille_unregister_console(struct console *console);
#else
static inline void
-braille_set_options(struct console_cmdline *c, char *brl_options)
+braille_set_options(struct preferred_console *pc, char *brl_options)
{
}
@@ -40,7 +40,7 @@ _braille_console_setup(char **str, char **brl_options)
}
static inline int
-_braille_register_console(struct console *console, struct console_cmdline *c)
+_braille_register_console(struct console *console, struct preferred_console *pc)
{
return 0;
}
diff --git a/kernel/printk/console_cmdline.h b/kernel/printk/console_register.h
similarity index 83%
rename from kernel/printk/console_cmdline.h
rename to kernel/printk/console_register.h
index 0ab573b6d4dc..9ab3e1cc749b 100644
--- a/kernel/printk/console_cmdline.h
+++ b/kernel/printk/console_register.h
@@ -1,8 +1,8 @@
/* SPDX-License-Identifier: GPL-2.0 */
-#ifndef _CONSOLE_CMDLINE_H
-#define _CONSOLE_CMDLINE_H
+#ifndef _CONSOLE_REGISTER_H
+#define _CONSOLE_REGISTER_H
-struct console_cmdline
+struct preferred_console
{
char name[16]; /* Name of the driver */
int index; /* Minor dev. to use */
diff --git a/kernel/printk/printk.c b/kernel/printk/printk.c
index 1d765ad242b8..86a908e74445 100644
--- a/kernel/printk/printk.c
+++ b/kernel/printk/printk.c
@@ -58,7 +58,7 @@
#include <trace/events/printk.h>
#include "printk_ringbuffer.h"
-#include "console_cmdline.h"
+#include "console_register.h"
#include "braille.h"
#include "internal.h"
@@ -360,9 +360,9 @@ static int console_locked;
* Array of consoles built from command line options (console=)
*/
-#define MAX_CMDLINECONSOLES 8
+#define MAX_PREFERRED_CONSOLES 8
-static struct console_cmdline console_cmdline[MAX_CMDLINECONSOLES];
+static struct preferred_console preferred_consoles[MAX_PREFERRED_CONSOLES];
static int preferred_console = -1;
int console_set_on_cmdline;
@@ -2491,7 +2491,7 @@ asmlinkage __visible void early_printk(const char *fmt, ...)
}
#endif
-static void set_user_specified(struct console_cmdline *c, bool user_specified)
+static void set_user_specified(struct preferred_console *pc, bool user_specified)
{
if (!user_specified)
return;
@@ -2500,7 +2500,7 @@ static void set_user_specified(struct console_cmdline *c, bool user_specified)
* @c console was defined by the user on the command line.
* Do not clear when added twice also by SPCR or the device tree.
*/
- c->user_specified = true;
+ pc->user_specified = true;
/* At least one console defined by the user on the command line. */
console_set_on_cmdline = 1;
}
@@ -2509,7 +2509,7 @@ static int __add_preferred_console(const char *name, const short idx,
const char *devname, char *options,
char *brl_options, bool user_specified)
{
- struct console_cmdline *c;
+ struct preferred_console *pc;
int i;
if (!name && !devname)
@@ -2528,30 +2528,30 @@ static int __add_preferred_console(const char *name, const short idx,
* See if this tty is not yet registered, and
* if we have a slot free.
*/
- for (i = 0, c = console_cmdline;
- i < MAX_CMDLINECONSOLES && (c->name[0] || c->devname[0]);
- i++, c++) {
- if ((name && strcmp(c->name, name) == 0 && c->index == idx) ||
- (devname && strcmp(c->devname, devname) == 0)) {
+ for (i = 0, pc = preferred_consoles;
+ i < MAX_PREFERRED_CONSOLES && (pc->name[0] || pc->devname[0]);
+ i++, pc++) {
+ if ((name && strcmp(pc->name, name) == 0 && pc->index == idx) ||
+ (devname && strcmp(pc->devname, devname) == 0)) {
if (!brl_options)
preferred_console = i;
- set_user_specified(c, user_specified);
+ set_user_specified(pc, user_specified);
return 0;
}
}
- if (i == MAX_CMDLINECONSOLES)
+ if (i == MAX_PREFERRED_CONSOLES)
return -E2BIG;
if (!brl_options)
preferred_console = i;
if (name)
- strscpy(c->name, name);
+ strscpy(pc->name, name);
if (devname)
- strscpy(c->devname, devname);
- c->options = options;
- set_user_specified(c, user_specified);
- braille_set_options(c, brl_options);
+ strscpy(pc->devname, devname);
+ pc->options = options;
+ set_user_specified(pc, user_specified);
+ braille_set_options(pc, brl_options);
- c->index = idx;
+ pc->index = idx;
return 0;
}
@@ -2571,8 +2571,10 @@ __setup("console_msg_format=", console_msg_format_setup);
*/
static int __init console_setup(char *str)
{
- static_assert(sizeof(console_cmdline[0].devname) >= sizeof(console_cmdline[0].name) + 4);
- char buf[sizeof(console_cmdline[0].devname)];
+ static_assert(sizeof(preferred_consoles[0].devname) >=
+ sizeof(preferred_consoles[0].name) + 4);
+
+ char buf[sizeof(preferred_consoles[0].devname)];
char *brl_options = NULL;
char *ttyname = NULL;
char *devname = NULL;
@@ -2677,19 +2679,19 @@ int match_devname_and_update_preferred_console(const char *devname,
const char *name,
const short idx)
{
- struct console_cmdline *c = console_cmdline;
+ struct preferred_console *pc = preferred_consoles;
int i;
if (!devname || !strlen(devname) || !name || !strlen(name) || idx < 0)
return -EINVAL;
- for (i = 0; i < MAX_CMDLINECONSOLES && (c->name[0] || c->devname[0]);
- i++, c++) {
- if (!strcmp(devname, c->devname)) {
+ for (i = 0; i < MAX_PREFERRED_CONSOLES && (pc->name[0] || pc->devname[0]);
+ i++, pc++) {
+ if (!strcmp(devname, pc->devname)) {
pr_info("associate the preferred console \"%s\" with \"%s%d\"\n",
devname, name, idx);
- strscpy(c->name, name);
- c->index = idx;
+ strscpy(pc->name, name);
+ pc->index = idx;
return 0;
}
}
@@ -3859,33 +3861,33 @@ static int console_call_setup(struct console *newcon, char *options)
static int try_enable_preferred_console(struct console *newcon,
bool user_specified)
{
- struct console_cmdline *c;
+ struct preferred_console *pc;
int i, err;
- for (i = 0, c = console_cmdline;
- i < MAX_CMDLINECONSOLES && (c->name[0] || c->devname[0]);
- i++, c++) {
+ for (i = 0, pc = preferred_consoles;
+ i < MAX_PREFERRED_CONSOLES && (pc->name[0] || pc->devname[0]);
+ i++, pc++) {
/* Console not yet initialized? */
- if (!c->name[0])
+ if (!pc->name[0])
continue;
- if (c->user_specified != user_specified)
+ if (pc->user_specified != user_specified)
continue;
if (!newcon->match ||
- newcon->match(newcon, c->name, c->index, c->options) != 0) {
+ newcon->match(newcon, pc->name, pc->index, pc->options) != 0) {
/* default matching */
- BUILD_BUG_ON(sizeof(c->name) != sizeof(newcon->name));
- if (strcmp(c->name, newcon->name) != 0)
+ BUILD_BUG_ON(sizeof(pc->name) != sizeof(newcon->name));
+ if (strcmp(pc->name, newcon->name) != 0)
continue;
if (newcon->index >= 0 &&
- newcon->index != c->index)
+ newcon->index != pc->index)
continue;
if (newcon->index < 0)
- newcon->index = c->index;
+ newcon->index = pc->index;
- if (_braille_register_console(newcon, c))
+ if (_braille_register_console(newcon, pc))
return 0;
- err = console_call_setup(newcon, c->options);
+ err = console_call_setup(newcon, pc->options);
if (err)
return err;
}
@@ -3900,7 +3902,7 @@ static int try_enable_preferred_console(struct console *newcon,
* without matching. Accept the pre-enabled consoles only when match()
* and setup() had a chance to be called.
*/
- if (newcon->flags & CON_ENABLED && c->user_specified == user_specified)
+ if (newcon->flags & CON_ENABLED && pc->user_specified == user_specified)
return 0;
return -ENOENT;
--
2.52.0
© 2016 - 2026 Red Hat, Inc.