Merge tag 'docs-4.16' of git://git.lwn.net/linux
[sfrench/cifs-2.6.git] / arch / xtensa / platforms / iss / console.c
1 /*
2  * arch/xtensa/platforms/iss/console.c
3  *
4  * This file is subject to the terms and conditions of the GNU General Public
5  * License.  See the file "COPYING" in the main directory of this archive
6  * for more details.
7  *
8  * Copyright (C) 2001-2005 Tensilica Inc.
9  *   Authors    Christian Zankel, Joe Taylor
10  */
11
12 #include <linux/module.h>
13 #include <linux/kernel.h>
14 #include <linux/sched.h>
15 #include <linux/console.h>
16 #include <linux/init.h>
17 #include <linux/mm.h>
18 #include <linux/major.h>
19 #include <linux/param.h>
20 #include <linux/seq_file.h>
21 #include <linux/serial.h>
22
23 #include <linux/uaccess.h>
24 #include <asm/irq.h>
25
26 #include <platform/simcall.h>
27
28 #include <linux/tty.h>
29 #include <linux/tty_flip.h>
30
31 #define SERIAL_MAX_NUM_LINES 1
32 #define SERIAL_TIMER_VALUE (HZ / 10)
33
34 static struct tty_driver *serial_driver;
35 static struct tty_port serial_port;
36 static struct timer_list serial_timer;
37
38 static DEFINE_SPINLOCK(timer_lock);
39
40 static char *serial_version = "0.1";
41 static char *serial_name = "ISS serial driver";
42
43 /*
44  * This routine is called whenever a serial port is opened.  It
45  * enables interrupts for a serial port, linking in its async structure into
46  * the IRQ chain.   It also performs the serial-specific
47  * initialization for the tty structure.
48  */
49
50 static void rs_poll(struct timer_list *);
51
52 static int rs_open(struct tty_struct *tty, struct file * filp)
53 {
54         tty->port = &serial_port;
55         spin_lock_bh(&timer_lock);
56         if (tty->count == 1) {
57                 timer_setup(&serial_timer, rs_poll, 0);
58                 mod_timer(&serial_timer, jiffies + SERIAL_TIMER_VALUE);
59         }
60         spin_unlock_bh(&timer_lock);
61
62         return 0;
63 }
64
65
66 /*
67  * ------------------------------------------------------------
68  * iss_serial_close()
69  *
70  * This routine is called when the serial port gets closed.  First, we
71  * wait for the last remaining data to be sent.  Then, we unlink its
72  * async structure from the interrupt chain if necessary, and we free
73  * that IRQ if nothing is left in the chain.
74  * ------------------------------------------------------------
75  */
76 static void rs_close(struct tty_struct *tty, struct file * filp)
77 {
78         spin_lock_bh(&timer_lock);
79         if (tty->count == 1)
80                 del_timer_sync(&serial_timer);
81         spin_unlock_bh(&timer_lock);
82 }
83
84
85 static int rs_write(struct tty_struct * tty,
86                     const unsigned char *buf, int count)
87 {
88         /* see drivers/char/serialX.c to reference original version */
89
90         simc_write(1, buf, count);
91         return count;
92 }
93
94 static void rs_poll(struct timer_list *unused)
95 {
96         struct tty_port *port = &serial_port;
97         int i = 0;
98         int rd = 1;
99         unsigned char c;
100
101         spin_lock(&timer_lock);
102
103         while (simc_poll(0)) {
104                 rd = simc_read(0, &c, 1);
105                 if (rd <= 0)
106                         break;
107                 tty_insert_flip_char(port, c, TTY_NORMAL);
108                 i++;
109         }
110
111         if (i)
112                 tty_flip_buffer_push(port);
113         if (rd)
114                 mod_timer(&serial_timer, jiffies + SERIAL_TIMER_VALUE);
115         spin_unlock(&timer_lock);
116 }
117
118
119 static int rs_put_char(struct tty_struct *tty, unsigned char ch)
120 {
121         return rs_write(tty, &ch, 1);
122 }
123
124 static void rs_flush_chars(struct tty_struct *tty)
125 {
126 }
127
128 static int rs_write_room(struct tty_struct *tty)
129 {
130         /* Let's say iss can always accept 2K characters.. */
131         return 2 * 1024;
132 }
133
134 static int rs_chars_in_buffer(struct tty_struct *tty)
135 {
136         /* the iss doesn't buffer characters */
137         return 0;
138 }
139
140 static void rs_hangup(struct tty_struct *tty)
141 {
142         /* Stub, once again.. */
143 }
144
145 static void rs_wait_until_sent(struct tty_struct *tty, int timeout)
146 {
147         /* Stub, once again.. */
148 }
149
150 static int rs_proc_show(struct seq_file *m, void *v)
151 {
152         seq_printf(m, "serinfo:1.0 driver:%s\n", serial_version);
153         return 0;
154 }
155
156 static int rs_proc_open(struct inode *inode, struct file *file)
157 {
158         return single_open(file, rs_proc_show, NULL);
159 }
160
161 static const struct file_operations rs_proc_fops = {
162         .owner          = THIS_MODULE,
163         .open           = rs_proc_open,
164         .read           = seq_read,
165         .llseek         = seq_lseek,
166         .release        = single_release,
167 };
168
169 static const struct tty_operations serial_ops = {
170         .open = rs_open,
171         .close = rs_close,
172         .write = rs_write,
173         .put_char = rs_put_char,
174         .flush_chars = rs_flush_chars,
175         .write_room = rs_write_room,
176         .chars_in_buffer = rs_chars_in_buffer,
177         .hangup = rs_hangup,
178         .wait_until_sent = rs_wait_until_sent,
179         .proc_fops = &rs_proc_fops,
180 };
181
182 int __init rs_init(void)
183 {
184         tty_port_init(&serial_port);
185
186         serial_driver = alloc_tty_driver(SERIAL_MAX_NUM_LINES);
187
188         pr_info("%s %s\n", serial_name, serial_version);
189
190         /* Initialize the tty_driver structure */
191
192         serial_driver->driver_name = "iss_serial";
193         serial_driver->name = "ttyS";
194         serial_driver->major = TTY_MAJOR;
195         serial_driver->minor_start = 64;
196         serial_driver->type = TTY_DRIVER_TYPE_SERIAL;
197         serial_driver->subtype = SERIAL_TYPE_NORMAL;
198         serial_driver->init_termios = tty_std_termios;
199         serial_driver->init_termios.c_cflag =
200                 B9600 | CS8 | CREAD | HUPCL | CLOCAL;
201         serial_driver->flags = TTY_DRIVER_REAL_RAW;
202
203         tty_set_operations(serial_driver, &serial_ops);
204         tty_port_link_device(&serial_port, serial_driver, 0);
205
206         if (tty_register_driver(serial_driver))
207                 panic("Couldn't register serial driver\n");
208         return 0;
209 }
210
211
212 static __exit void rs_exit(void)
213 {
214         int error;
215
216         if ((error = tty_unregister_driver(serial_driver)))
217                 pr_err("ISS_SERIAL: failed to unregister serial driver (%d)\n",
218                        error);
219         put_tty_driver(serial_driver);
220         tty_port_destroy(&serial_port);
221 }
222
223
224 /* We use `late_initcall' instead of just `__initcall' as a workaround for
225  * the fact that (1) simcons_tty_init can't be called before tty_init,
226  * (2) tty_init is called via `module_init', (3) if statically linked,
227  * module_init == device_init, and (4) there's no ordering of init lists.
228  * We can do this easily because simcons is always statically linked, but
229  * other tty drivers that depend on tty_init and which must use
230  * `module_init' to declare their init routines are likely to be broken.
231  */
232
233 late_initcall(rs_init);
234
235
236 #ifdef CONFIG_SERIAL_CONSOLE
237
238 static void iss_console_write(struct console *co, const char *s, unsigned count)
239 {
240         int len = strlen(s);
241
242         if (s != 0 && *s != 0)
243                 simc_write(1, s, count < len ? count : len);
244 }
245
246 static struct tty_driver* iss_console_device(struct console *c, int *index)
247 {
248         *index = c->index;
249         return serial_driver;
250 }
251
252
253 static struct console sercons = {
254         .name = "ttyS",
255         .write = iss_console_write,
256         .device = iss_console_device,
257         .flags = CON_PRINTBUFFER,
258         .index = -1
259 };
260
261 static int __init iss_console_init(void)
262 {
263         register_console(&sercons);
264         return 0;
265 }
266
267 console_initcall(iss_console_init);
268
269 #endif /* CONFIG_SERIAL_CONSOLE */
270