Loading...
1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * linux/drivers/char/ttyprintk.c
4 *
5 * Copyright (C) 2010 Samo Pogacnik
6 */
7
8/*
9 * This pseudo device allows user to make printk messages. It is possible
10 * to store "console" messages inline with kernel messages for better analyses
11 * of the boot process, for example.
12 */
13
14#include <linux/console.h>
15#include <linux/device.h>
16#include <linux/serial.h>
17#include <linux/tty.h>
18#include <linux/module.h>
19#include <linux/spinlock.h>
20
21struct ttyprintk_port {
22 struct tty_port port;
23 spinlock_t spinlock;
24};
25
26static struct ttyprintk_port tpk_port;
27
28/*
29 * Our simple preformatting supports transparent output of (time-stamped)
30 * printk messages (also suitable for logging service):
31 * - any cr is replaced by nl
32 * - adds a ttyprintk source tag in front of each line
33 * - too long message is fragmented, with '\'nl between fragments
34 * - TPK_STR_SIZE isn't really the write_room limiting factor, because
35 * it is emptied on the fly during preformatting.
36 */
37#define TPK_STR_SIZE 508 /* should be bigger then max expected line length */
38#define TPK_MAX_ROOM 4096 /* we could assume 4K for instance */
39#define TPK_PREFIX KERN_SOH __stringify(CONFIG_TTY_PRINTK_LEVEL)
40
41static int tpk_curr;
42
43static u8 tpk_buffer[TPK_STR_SIZE + 4];
44
45static void tpk_flush(void)
46{
47 if (tpk_curr > 0) {
48 tpk_buffer[tpk_curr] = '\0';
49 printk(TPK_PREFIX "[U] %s\n", tpk_buffer);
50 tpk_curr = 0;
51 }
52}
53
54static int tpk_printk(const u8 *buf, size_t count)
55{
56 size_t i;
57
58 for (i = 0; i < count; i++) {
59 if (tpk_curr >= TPK_STR_SIZE) {
60 /* end of tmp buffer reached: cut the message in two */
61 tpk_buffer[tpk_curr++] = '\\';
62 tpk_flush();
63 }
64
65 switch (buf[i]) {
66 case '\r':
67 tpk_flush();
68 if ((i + 1) < count && buf[i + 1] == '\n')
69 i++;
70 break;
71 case '\n':
72 tpk_flush();
73 break;
74 default:
75 tpk_buffer[tpk_curr++] = buf[i];
76 break;
77 }
78 }
79
80 return count;
81}
82
83/*
84 * TTY operations open function.
85 */
86static int tpk_open(struct tty_struct *tty, struct file *filp)
87{
88 tty->driver_data = &tpk_port;
89
90 return tty_port_open(&tpk_port.port, tty, filp);
91}
92
93/*
94 * TTY operations close function.
95 */
96static void tpk_close(struct tty_struct *tty, struct file *filp)
97{
98 struct ttyprintk_port *tpkp = tty->driver_data;
99
100 tty_port_close(&tpkp->port, tty, filp);
101}
102
103/*
104 * TTY operations write function.
105 */
106static ssize_t tpk_write(struct tty_struct *tty, const u8 *buf, size_t count)
107{
108 struct ttyprintk_port *tpkp = tty->driver_data;
109 unsigned long flags;
110 int ret;
111
112 /* exclusive use of tpk_printk within this tty */
113 spin_lock_irqsave(&tpkp->spinlock, flags);
114 ret = tpk_printk(buf, count);
115 spin_unlock_irqrestore(&tpkp->spinlock, flags);
116
117 return ret;
118}
119
120/*
121 * TTY operations write_room function.
122 */
123static unsigned int tpk_write_room(struct tty_struct *tty)
124{
125 return TPK_MAX_ROOM;
126}
127
128/*
129 * TTY operations hangup function.
130 */
131static void tpk_hangup(struct tty_struct *tty)
132{
133 struct ttyprintk_port *tpkp = tty->driver_data;
134
135 tty_port_hangup(&tpkp->port);
136}
137
138/*
139 * TTY port operations shutdown function.
140 */
141static void tpk_port_shutdown(struct tty_port *tport)
142{
143 struct ttyprintk_port *tpkp =
144 container_of(tport, struct ttyprintk_port, port);
145 unsigned long flags;
146
147 spin_lock_irqsave(&tpkp->spinlock, flags);
148 tpk_flush();
149 spin_unlock_irqrestore(&tpkp->spinlock, flags);
150}
151
152static const struct tty_operations ttyprintk_ops = {
153 .open = tpk_open,
154 .close = tpk_close,
155 .write = tpk_write,
156 .write_room = tpk_write_room,
157 .hangup = tpk_hangup,
158};
159
160static const struct tty_port_operations tpk_port_ops = {
161 .shutdown = tpk_port_shutdown,
162};
163
164static struct tty_driver *ttyprintk_driver;
165
166static struct tty_driver *ttyprintk_console_device(struct console *c,
167 int *index)
168{
169 *index = 0;
170 return ttyprintk_driver;
171}
172
173static struct console ttyprintk_console = {
174 .name = "ttyprintk",
175 .device = ttyprintk_console_device,
176};
177
178static int __init ttyprintk_init(void)
179{
180 int ret;
181
182 spin_lock_init(&tpk_port.spinlock);
183
184 ttyprintk_driver = tty_alloc_driver(1,
185 TTY_DRIVER_RESET_TERMIOS |
186 TTY_DRIVER_REAL_RAW |
187 TTY_DRIVER_UNNUMBERED_NODE);
188 if (IS_ERR(ttyprintk_driver))
189 return PTR_ERR(ttyprintk_driver);
190
191 tty_port_init(&tpk_port.port);
192 tpk_port.port.ops = &tpk_port_ops;
193
194 ttyprintk_driver->driver_name = "ttyprintk";
195 ttyprintk_driver->name = "ttyprintk";
196 ttyprintk_driver->major = TTYAUX_MAJOR;
197 ttyprintk_driver->minor_start = 3;
198 ttyprintk_driver->type = TTY_DRIVER_TYPE_CONSOLE;
199 ttyprintk_driver->init_termios = tty_std_termios;
200 ttyprintk_driver->init_termios.c_oflag = OPOST | OCRNL | ONOCR | ONLRET;
201 tty_set_operations(ttyprintk_driver, &ttyprintk_ops);
202 tty_port_link_device(&tpk_port.port, ttyprintk_driver, 0);
203
204 ret = tty_register_driver(ttyprintk_driver);
205 if (ret < 0) {
206 printk(KERN_ERR "Couldn't register ttyprintk driver\n");
207 goto error;
208 }
209
210 register_console(&ttyprintk_console);
211
212 return 0;
213
214error:
215 tty_driver_kref_put(ttyprintk_driver);
216 tty_port_destroy(&tpk_port.port);
217 return ret;
218}
219
220static void __exit ttyprintk_exit(void)
221{
222 unregister_console(&ttyprintk_console);
223 tty_unregister_driver(ttyprintk_driver);
224 tty_driver_kref_put(ttyprintk_driver);
225 tty_port_destroy(&tpk_port.port);
226}
227
228device_initcall(ttyprintk_init);
229module_exit(ttyprintk_exit);
230
231MODULE_LICENSE("GPL");
1/*
2 * linux/drivers/char/ttyprintk.c
3 *
4 * Copyright (C) 2010 Samo Pogacnik
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the smems of the GNU General Public License as published by
8 * the Free Software Foundation; version 2 of the License.
9 */
10
11/*
12 * This pseudo device allows user to make printk messages. It is possible
13 * to store "console" messages inline with kernel messages for better analyses
14 * of the boot process, for example.
15 */
16
17#include <linux/device.h>
18#include <linux/serial.h>
19#include <linux/tty.h>
20#include <linux/export.h>
21
22struct ttyprintk_port {
23 struct tty_port port;
24 struct mutex port_write_mutex;
25};
26
27static struct ttyprintk_port tpk_port;
28
29/*
30 * Our simple preformatting supports transparent output of (time-stamped)
31 * printk messages (also suitable for logging service):
32 * - any cr is replaced by nl
33 * - adds a ttyprintk source tag in front of each line
34 * - too long message is fragmeted, with '\'nl between fragments
35 * - TPK_STR_SIZE isn't really the write_room limiting factor, bcause
36 * it is emptied on the fly during preformatting.
37 */
38#define TPK_STR_SIZE 508 /* should be bigger then max expected line length */
39#define TPK_MAX_ROOM 4096 /* we could assume 4K for instance */
40static const char *tpk_tag = "[U] "; /* U for User */
41static int tpk_curr;
42
43static int tpk_printk(const unsigned char *buf, int count)
44{
45 static char tmp[TPK_STR_SIZE + 4];
46 int i = tpk_curr;
47
48 if (buf == NULL) {
49 /* flush tmp[] */
50 if (tpk_curr > 0) {
51 /* non nl or cr terminated message - add nl */
52 tmp[tpk_curr + 0] = '\n';
53 tmp[tpk_curr + 1] = '\0';
54 printk(KERN_INFO "%s%s", tpk_tag, tmp);
55 tpk_curr = 0;
56 }
57 return i;
58 }
59
60 for (i = 0; i < count; i++) {
61 tmp[tpk_curr] = buf[i];
62 if (tpk_curr < TPK_STR_SIZE) {
63 switch (buf[i]) {
64 case '\r':
65 /* replace cr with nl */
66 tmp[tpk_curr + 0] = '\n';
67 tmp[tpk_curr + 1] = '\0';
68 printk(KERN_INFO "%s%s", tpk_tag, tmp);
69 tpk_curr = 0;
70 if ((i + 1) < count && buf[i + 1] == '\n')
71 i++;
72 break;
73 case '\n':
74 tmp[tpk_curr + 1] = '\0';
75 printk(KERN_INFO "%s%s", tpk_tag, tmp);
76 tpk_curr = 0;
77 break;
78 default:
79 tpk_curr++;
80 }
81 } else {
82 /* end of tmp buffer reached: cut the message in two */
83 tmp[tpk_curr + 1] = '\\';
84 tmp[tpk_curr + 2] = '\n';
85 tmp[tpk_curr + 3] = '\0';
86 printk(KERN_INFO "%s%s", tpk_tag, tmp);
87 tpk_curr = 0;
88 }
89 }
90
91 return count;
92}
93
94/*
95 * TTY operations open function.
96 */
97static int tpk_open(struct tty_struct *tty, struct file *filp)
98{
99 tty->driver_data = &tpk_port;
100
101 return tty_port_open(&tpk_port.port, tty, filp);
102}
103
104/*
105 * TTY operations close function.
106 */
107static void tpk_close(struct tty_struct *tty, struct file *filp)
108{
109 struct ttyprintk_port *tpkp = tty->driver_data;
110
111 mutex_lock(&tpkp->port_write_mutex);
112 /* flush tpk_printk buffer */
113 tpk_printk(NULL, 0);
114 mutex_unlock(&tpkp->port_write_mutex);
115
116 tty_port_close(&tpkp->port, tty, filp);
117}
118
119/*
120 * TTY operations write function.
121 */
122static int tpk_write(struct tty_struct *tty,
123 const unsigned char *buf, int count)
124{
125 struct ttyprintk_port *tpkp = tty->driver_data;
126 int ret;
127
128
129 /* exclusive use of tpk_printk within this tty */
130 mutex_lock(&tpkp->port_write_mutex);
131 ret = tpk_printk(buf, count);
132 mutex_unlock(&tpkp->port_write_mutex);
133
134 return ret;
135}
136
137/*
138 * TTY operations write_room function.
139 */
140static int tpk_write_room(struct tty_struct *tty)
141{
142 return TPK_MAX_ROOM;
143}
144
145/*
146 * TTY operations ioctl function.
147 */
148static int tpk_ioctl(struct tty_struct *tty,
149 unsigned int cmd, unsigned long arg)
150{
151 struct ttyprintk_port *tpkp = tty->driver_data;
152
153 if (!tpkp)
154 return -EINVAL;
155
156 switch (cmd) {
157 /* Stop TIOCCONS */
158 case TIOCCONS:
159 return -EOPNOTSUPP;
160 default:
161 return -ENOIOCTLCMD;
162 }
163 return 0;
164}
165
166static const struct tty_operations ttyprintk_ops = {
167 .open = tpk_open,
168 .close = tpk_close,
169 .write = tpk_write,
170 .write_room = tpk_write_room,
171 .ioctl = tpk_ioctl,
172};
173
174static struct tty_port_operations null_ops = { };
175
176static struct tty_driver *ttyprintk_driver;
177
178static int __init ttyprintk_init(void)
179{
180 int ret = -ENOMEM;
181 void *rp;
182
183 ttyprintk_driver = alloc_tty_driver(1);
184 if (!ttyprintk_driver)
185 return ret;
186
187 ttyprintk_driver->driver_name = "ttyprintk";
188 ttyprintk_driver->name = "ttyprintk";
189 ttyprintk_driver->major = TTYAUX_MAJOR;
190 ttyprintk_driver->minor_start = 3;
191 ttyprintk_driver->type = TTY_DRIVER_TYPE_CONSOLE;
192 ttyprintk_driver->init_termios = tty_std_termios;
193 ttyprintk_driver->init_termios.c_oflag = OPOST | OCRNL | ONOCR | ONLRET;
194 ttyprintk_driver->flags = TTY_DRIVER_RESET_TERMIOS |
195 TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
196 tty_set_operations(ttyprintk_driver, &ttyprintk_ops);
197
198 ret = tty_register_driver(ttyprintk_driver);
199 if (ret < 0) {
200 printk(KERN_ERR "Couldn't register ttyprintk driver\n");
201 goto error;
202 }
203
204 /* create our unnumbered device */
205 rp = device_create(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 3), NULL,
206 ttyprintk_driver->name);
207 if (IS_ERR(rp)) {
208 printk(KERN_ERR "Couldn't create ttyprintk device\n");
209 ret = PTR_ERR(rp);
210 goto error;
211 }
212
213 tty_port_init(&tpk_port.port);
214 tpk_port.port.ops = &null_ops;
215 mutex_init(&tpk_port.port_write_mutex);
216
217 return 0;
218
219error:
220 put_tty_driver(ttyprintk_driver);
221 ttyprintk_driver = NULL;
222 return ret;
223}
224module_init(ttyprintk_init);