blob: cd9c919095966b271fb0dee6a6dfdd49d176e022 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Michael Holzheu62b749422009-06-16 10:30:40 +02002 * SCLP VT220 terminal driver.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 *
Michael Holzheu62b749422009-06-16 10:30:40 +02004 * Copyright IBM Corp. 2003, 2009
5 *
6 * Author(s): Peter Oberparleiter <Peter.Oberparleiter@de.ibm.com>
Linus Torvalds1da177e2005-04-16 15:20:36 -07007 */
8
Linus Torvalds1da177e2005-04-16 15:20:36 -07009#include <linux/module.h>
10#include <linux/spinlock.h>
11#include <linux/list.h>
12#include <linux/wait.h>
13#include <linux/timer.h>
14#include <linux/kernel.h>
15#include <linux/tty.h>
16#include <linux/tty_driver.h>
Alan Cox33f0f882006-01-09 20:54:13 -080017#include <linux/tty_flip.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070018#include <linux/errno.h>
19#include <linux/mm.h>
20#include <linux/major.h>
21#include <linux/console.h>
22#include <linux/kdev_t.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070023#include <linux/interrupt.h>
24#include <linux/init.h>
Holger Smolinski2332ce12008-10-10 21:33:27 +020025#include <linux/reboot.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090026#include <linux/slab.h>
Holger Smolinski2332ce12008-10-10 21:33:27 +020027
Linus Torvalds1da177e2005-04-16 15:20:36 -070028#include <asm/uaccess.h>
29#include "sclp.h"
30
Linus Torvalds1da177e2005-04-16 15:20:36 -070031#define SCLP_VT220_MAJOR TTY_MAJOR
32#define SCLP_VT220_MINOR 65
33#define SCLP_VT220_DRIVER_NAME "sclp_vt220"
34#define SCLP_VT220_DEVICE_NAME "ttysclp"
35#define SCLP_VT220_CONSOLE_NAME "ttyS"
36#define SCLP_VT220_CONSOLE_INDEX 1 /* console=ttyS1 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070037
38/* Representation of a single write request */
39struct sclp_vt220_request {
40 struct list_head list;
41 struct sclp_req sclp_req;
42 int retry_count;
43};
44
45/* VT220 SCCB */
46struct sclp_vt220_sccb {
47 struct sccb_header header;
48 struct evbuf_header evbuf;
49};
50
51#define SCLP_VT220_MAX_CHARS_PER_BUFFER (PAGE_SIZE - \
52 sizeof(struct sclp_vt220_request) - \
53 sizeof(struct sclp_vt220_sccb))
54
55/* Structures and data needed to register tty driver */
56static struct tty_driver *sclp_vt220_driver;
57
Jiri Slaby092f7372012-04-02 13:54:13 +020058static struct tty_port sclp_vt220_port;
Linus Torvalds1da177e2005-04-16 15:20:36 -070059
60/* Lock to protect internal data from concurrent access */
61static spinlock_t sclp_vt220_lock;
62
63/* List of empty pages to be used as write request buffers */
64static struct list_head sclp_vt220_empty;
65
66/* List of pending requests */
67static struct list_head sclp_vt220_outqueue;
68
Michael Holzheu62b749422009-06-16 10:30:40 +020069/* Suspend mode flag */
70static int sclp_vt220_suspended;
71
72/* Flag that output queue is currently running */
73static int sclp_vt220_queue_running;
Linus Torvalds1da177e2005-04-16 15:20:36 -070074
Linus Torvalds1da177e2005-04-16 15:20:36 -070075/* Timer used for delaying write requests to merge subsequent messages into
76 * a single buffer */
77static struct timer_list sclp_vt220_timer;
78
79/* Pointer to current request buffer which has been partially filled but not
80 * yet sent */
81static struct sclp_vt220_request *sclp_vt220_current_request;
82
83/* Number of characters in current request buffer */
84static int sclp_vt220_buffered_chars;
85
Peter Oberparleiterad211792008-07-14 09:59:07 +020086/* Counter controlling core driver initialization. */
87static int __initdata sclp_vt220_init_count;
Linus Torvalds1da177e2005-04-16 15:20:36 -070088
89/* Flag indicating that sclp_vt220_current_request should really
90 * have been already queued but wasn't because the SCLP was processing
91 * another buffer */
92static int sclp_vt220_flush_later;
93
94static void sclp_vt220_receiver_fn(struct evbuf_header *evbuf);
Michael Holzheu62b749422009-06-16 10:30:40 +020095static void sclp_vt220_pm_event_fn(struct sclp_register *reg,
96 enum sclp_pm_event sclp_pm_event);
Linus Torvalds1da177e2005-04-16 15:20:36 -070097static int __sclp_vt220_emit(struct sclp_vt220_request *request);
98static void sclp_vt220_emit_current(void);
99
Peter Oberparleitere106e4e2014-04-09 13:10:05 +0200100/* Registration structure for SCLP output event buffers */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101static struct sclp_register sclp_vt220_register = {
Stefan Haberland6d4740c2007-04-27 16:01:53 +0200102 .send_mask = EVTYP_VT220MSG_MASK,
Michael Holzheu62b749422009-06-16 10:30:40 +0200103 .pm_event_fn = sclp_vt220_pm_event_fn,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104};
105
Peter Oberparleitere106e4e2014-04-09 13:10:05 +0200106/* Registration structure for SCLP input event buffers */
107static struct sclp_register sclp_vt220_register_input = {
108 .receive_mask = EVTYP_VT220MSG_MASK,
109 .receiver_fn = sclp_vt220_receiver_fn,
110};
111
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112
113/*
114 * Put provided request buffer back into queue and check emit pending
115 * buffers if necessary.
116 */
117static void
118sclp_vt220_process_queue(struct sclp_vt220_request *request)
119{
120 unsigned long flags;
121 void *page;
122
123 do {
124 /* Put buffer back to list of empty buffers */
125 page = request->sclp_req.sccb;
126 spin_lock_irqsave(&sclp_vt220_lock, flags);
127 /* Move request from outqueue to empty queue */
128 list_del(&request->list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129 list_add_tail((struct list_head *) page, &sclp_vt220_empty);
130 /* Check if there is a pending buffer on the out queue. */
131 request = NULL;
132 if (!list_empty(&sclp_vt220_outqueue))
133 request = list_entry(sclp_vt220_outqueue.next,
134 struct sclp_vt220_request, list);
Michael Holzheu62b749422009-06-16 10:30:40 +0200135 if (!request || sclp_vt220_suspended) {
136 sclp_vt220_queue_running = 0;
137 spin_unlock_irqrestore(&sclp_vt220_lock, flags);
138 break;
139 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140 spin_unlock_irqrestore(&sclp_vt220_lock, flags);
Michael Holzheu62b749422009-06-16 10:30:40 +0200141 } while (__sclp_vt220_emit(request));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142 if (request == NULL && sclp_vt220_flush_later)
143 sclp_vt220_emit_current();
Jiri Slaby6aad04f2013-03-07 13:12:29 +0100144 tty_port_tty_wakeup(&sclp_vt220_port);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145}
146
147#define SCLP_BUFFER_MAX_RETRY 1
148
149/*
150 * Callback through which the result of a write request is reported by the
151 * SCLP.
152 */
153static void
154sclp_vt220_callback(struct sclp_req *request, void *data)
155{
156 struct sclp_vt220_request *vt220_request;
157 struct sclp_vt220_sccb *sccb;
158
159 vt220_request = (struct sclp_vt220_request *) data;
160 if (request->status == SCLP_REQ_FAILED) {
161 sclp_vt220_process_queue(vt220_request);
162 return;
163 }
164 sccb = (struct sclp_vt220_sccb *) vt220_request->sclp_req.sccb;
165
166 /* Check SCLP response code and choose suitable action */
167 switch (sccb->header.response_code) {
168 case 0x0020 :
169 break;
170
171 case 0x05f0: /* Target resource in improper state */
172 break;
173
174 case 0x0340: /* Contained SCLP equipment check */
175 if (++vt220_request->retry_count > SCLP_BUFFER_MAX_RETRY)
176 break;
177 /* Remove processed buffers and requeue rest */
178 if (sclp_remove_processed((struct sccb_header *) sccb) > 0) {
179 /* Not all buffers were processed */
180 sccb->header.response_code = 0x0000;
181 vt220_request->sclp_req.status = SCLP_REQ_FILLED;
182 if (sclp_add_request(request) == 0)
183 return;
184 }
185 break;
186
187 case 0x0040: /* SCLP equipment check */
188 if (++vt220_request->retry_count > SCLP_BUFFER_MAX_RETRY)
189 break;
190 sccb->header.response_code = 0x0000;
191 vt220_request->sclp_req.status = SCLP_REQ_FILLED;
192 if (sclp_add_request(request) == 0)
193 return;
194 break;
195
196 default:
197 break;
198 }
199 sclp_vt220_process_queue(vt220_request);
200}
201
202/*
203 * Emit vt220 request buffer to SCLP. Return zero on success, non-zero
204 * otherwise.
205 */
206static int
207__sclp_vt220_emit(struct sclp_vt220_request *request)
208{
Peter Oberparleiterd082d3c2008-02-19 15:29:32 +0100209 if (!(sclp_vt220_register.sclp_receive_mask & EVTYP_VT220MSG_MASK)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210 request->sclp_req.status = SCLP_REQ_FAILED;
211 return -EIO;
212 }
Heiko Carstensab14de62007-02-05 21:18:37 +0100213 request->sclp_req.command = SCLP_CMDW_WRITE_EVENT_DATA;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214 request->sclp_req.status = SCLP_REQ_FILLED;
215 request->sclp_req.callback = sclp_vt220_callback;
216 request->sclp_req.callback_data = (void *) request;
217
218 return sclp_add_request(&request->sclp_req);
219}
220
221/*
Michael Holzheu62b749422009-06-16 10:30:40 +0200222 * Queue and emit current request.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223 */
224static void
225sclp_vt220_emit_current(void)
226{
227 unsigned long flags;
228 struct sclp_vt220_request *request;
229 struct sclp_vt220_sccb *sccb;
230
231 spin_lock_irqsave(&sclp_vt220_lock, flags);
Michael Holzheu62b749422009-06-16 10:30:40 +0200232 if (sclp_vt220_current_request) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233 sccb = (struct sclp_vt220_sccb *)
234 sclp_vt220_current_request->sclp_req.sccb;
235 /* Only emit buffers with content */
236 if (sccb->header.length != sizeof(struct sclp_vt220_sccb)) {
Michael Holzheu62b749422009-06-16 10:30:40 +0200237 list_add_tail(&sclp_vt220_current_request->list,
238 &sclp_vt220_outqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239 sclp_vt220_current_request = NULL;
240 if (timer_pending(&sclp_vt220_timer))
241 del_timer(&sclp_vt220_timer);
242 }
243 sclp_vt220_flush_later = 0;
244 }
Michael Holzheu62b749422009-06-16 10:30:40 +0200245 if (sclp_vt220_queue_running || sclp_vt220_suspended)
246 goto out_unlock;
247 if (list_empty(&sclp_vt220_outqueue))
248 goto out_unlock;
249 request = list_first_entry(&sclp_vt220_outqueue,
250 struct sclp_vt220_request, list);
251 sclp_vt220_queue_running = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252 spin_unlock_irqrestore(&sclp_vt220_lock, flags);
Michael Holzheu62b749422009-06-16 10:30:40 +0200253
254 if (__sclp_vt220_emit(request))
255 sclp_vt220_process_queue(request);
256 return;
257out_unlock:
258 spin_unlock_irqrestore(&sclp_vt220_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259}
260
261#define SCLP_NORMAL_WRITE 0x00
262
263/*
264 * Helper function to initialize a page with the sclp request structure.
265 */
266static struct sclp_vt220_request *
267sclp_vt220_initialize_page(void *page)
268{
269 struct sclp_vt220_request *request;
270 struct sclp_vt220_sccb *sccb;
271
272 /* Place request structure at end of page */
273 request = ((struct sclp_vt220_request *)
274 ((addr_t) page + PAGE_SIZE)) - 1;
275 request->retry_count = 0;
276 request->sclp_req.sccb = page;
277 /* SCCB goes at start of page */
278 sccb = (struct sclp_vt220_sccb *) page;
279 memset((void *) sccb, 0, sizeof(struct sclp_vt220_sccb));
280 sccb->header.length = sizeof(struct sclp_vt220_sccb);
281 sccb->header.function_code = SCLP_NORMAL_WRITE;
282 sccb->header.response_code = 0x0000;
Stefan Haberland6d4740c2007-04-27 16:01:53 +0200283 sccb->evbuf.type = EVTYP_VT220MSG;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284 sccb->evbuf.length = sizeof(struct evbuf_header);
285
286 return request;
287}
288
289static inline unsigned int
290sclp_vt220_space_left(struct sclp_vt220_request *request)
291{
292 struct sclp_vt220_sccb *sccb;
293 sccb = (struct sclp_vt220_sccb *) request->sclp_req.sccb;
294 return PAGE_SIZE - sizeof(struct sclp_vt220_request) -
295 sccb->header.length;
296}
297
298static inline unsigned int
299sclp_vt220_chars_stored(struct sclp_vt220_request *request)
300{
301 struct sclp_vt220_sccb *sccb;
302 sccb = (struct sclp_vt220_sccb *) request->sclp_req.sccb;
303 return sccb->evbuf.length - sizeof(struct evbuf_header);
304}
305
306/*
307 * Add msg to buffer associated with request. Return the number of characters
308 * added.
309 */
310static int
311sclp_vt220_add_msg(struct sclp_vt220_request *request,
312 const unsigned char *msg, int count, int convertlf)
313{
314 struct sclp_vt220_sccb *sccb;
315 void *buffer;
316 unsigned char c;
317 int from;
318 int to;
319
320 if (count > sclp_vt220_space_left(request))
321 count = sclp_vt220_space_left(request);
322 if (count <= 0)
323 return 0;
324
325 sccb = (struct sclp_vt220_sccb *) request->sclp_req.sccb;
326 buffer = (void *) ((addr_t) sccb + sccb->header.length);
327
328 if (convertlf) {
329 /* Perform Linefeed conversion (0x0a -> 0x0a 0x0d)*/
330 for (from=0, to=0;
331 (from < count) && (to < sclp_vt220_space_left(request));
332 from++) {
333 /* Retrieve character */
334 c = msg[from];
335 /* Perform conversion */
336 if (c == 0x0a) {
337 if (to + 1 < sclp_vt220_space_left(request)) {
338 ((unsigned char *) buffer)[to++] = c;
339 ((unsigned char *) buffer)[to++] = 0x0d;
340 } else
341 break;
342
343 } else
344 ((unsigned char *) buffer)[to++] = c;
345 }
346 sccb->header.length += to;
347 sccb->evbuf.length += to;
348 return from;
349 } else {
350 memcpy(buffer, (const void *) msg, count);
351 sccb->header.length += count;
352 sccb->evbuf.length += count;
353 return count;
354 }
355}
356
357/*
358 * Emit buffer after having waited long enough for more data to arrive.
359 */
360static void
361sclp_vt220_timeout(unsigned long data)
362{
363 sclp_vt220_emit_current();
364}
365
Christian Borntraegerfa331ff2008-03-05 12:37:12 +0100366#define BUFFER_MAX_DELAY HZ/20
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367
Martin Schwidefsky25b41a72013-05-24 12:30:03 +0200368/*
369 * Drop oldest console buffer if sclp_con_drop is set
370 */
371static int
372sclp_vt220_drop_buffer(void)
373{
374 struct list_head *list;
375 struct sclp_vt220_request *request;
376 void *page;
377
378 if (!sclp_console_drop)
379 return 0;
380 list = sclp_vt220_outqueue.next;
381 if (sclp_vt220_queue_running)
382 /* The first element is in I/O */
383 list = list->next;
384 if (list == &sclp_vt220_outqueue)
385 return 0;
386 list_del(list);
387 request = list_entry(list, struct sclp_vt220_request, list);
388 page = request->sclp_req.sccb;
389 list_add_tail((struct list_head *) page, &sclp_vt220_empty);
390 return 1;
391}
392
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393/*
394 * Internal implementation of the write function. Write COUNT bytes of data
395 * from memory at BUF
396 * to the SCLP interface. In case that the data does not fit into the current
397 * write buffer, emit the current one and allocate a new one. If there are no
398 * more empty buffers available, wait until one gets emptied. If DO_SCHEDULE
399 * is non-zero, the buffer will be scheduled for emitting after a timeout -
400 * otherwise the user has to explicitly call the flush function.
401 * A non-zero CONVERTLF parameter indicates that 0x0a characters in the message
402 * buffer should be converted to 0x0a 0x0d. After completion, return the number
403 * of bytes written.
404 */
405static int
406__sclp_vt220_write(const unsigned char *buf, int count, int do_schedule,
Heiko Carstensd4820e42008-05-30 10:03:30 +0200407 int convertlf, int may_fail)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408{
409 unsigned long flags;
410 void *page;
411 int written;
412 int overall_written;
413
414 if (count <= 0)
415 return 0;
416 overall_written = 0;
417 spin_lock_irqsave(&sclp_vt220_lock, flags);
418 do {
Heiko Carstensd4820e42008-05-30 10:03:30 +0200419 /* Create an sclp output buffer if none exists yet */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420 if (sclp_vt220_current_request == NULL) {
Martin Schwidefsky25b41a72013-05-24 12:30:03 +0200421 if (list_empty(&sclp_vt220_empty))
422 sclp_console_full++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423 while (list_empty(&sclp_vt220_empty)) {
Michael Holzheu62b749422009-06-16 10:30:40 +0200424 if (may_fail || sclp_vt220_suspended)
Heiko Carstensd4820e42008-05-30 10:03:30 +0200425 goto out;
Martin Schwidefsky25b41a72013-05-24 12:30:03 +0200426 if (sclp_vt220_drop_buffer())
427 break;
428 spin_unlock_irqrestore(&sclp_vt220_lock, flags);
429
430 sclp_sync_wait();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431 spin_lock_irqsave(&sclp_vt220_lock, flags);
432 }
433 page = (void *) sclp_vt220_empty.next;
434 list_del((struct list_head *) page);
435 sclp_vt220_current_request =
436 sclp_vt220_initialize_page(page);
437 }
438 /* Try to write the string to the current request buffer */
439 written = sclp_vt220_add_msg(sclp_vt220_current_request,
440 buf, count, convertlf);
441 overall_written += written;
442 if (written == count)
443 break;
444 /*
445 * Not all characters could be written to the current
446 * output buffer. Emit the buffer, create a new buffer
447 * and then output the rest of the string.
448 */
449 spin_unlock_irqrestore(&sclp_vt220_lock, flags);
450 sclp_vt220_emit_current();
451 spin_lock_irqsave(&sclp_vt220_lock, flags);
452 buf += written;
453 count -= written;
454 } while (count > 0);
455 /* Setup timer to output current console buffer after some time */
456 if (sclp_vt220_current_request != NULL &&
457 !timer_pending(&sclp_vt220_timer) && do_schedule) {
458 sclp_vt220_timer.function = sclp_vt220_timeout;
459 sclp_vt220_timer.data = 0UL;
460 sclp_vt220_timer.expires = jiffies + BUFFER_MAX_DELAY;
461 add_timer(&sclp_vt220_timer);
462 }
Heiko Carstensd4820e42008-05-30 10:03:30 +0200463out:
Martin Schwidefsky25b41a72013-05-24 12:30:03 +0200464 spin_unlock_irqrestore(&sclp_vt220_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465 return overall_written;
466}
467
468/*
469 * This routine is called by the kernel to write a series of
470 * characters to the tty device. The characters may come from
471 * user space or kernel space. This routine will return the
472 * number of characters actually accepted for writing.
473 */
474static int
475sclp_vt220_write(struct tty_struct *tty, const unsigned char *buf, int count)
476{
Heiko Carstensd1e23372008-04-17 07:46:02 +0200477 return __sclp_vt220_write(buf, count, 1, 0, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478}
479
480#define SCLP_VT220_SESSION_ENDED 0x01
481#define SCLP_VT220_SESSION_STARTED 0x80
482#define SCLP_VT220_SESSION_DATA 0x00
483
484/*
485 * Called by the SCLP to report incoming event buffers.
486 */
487static void
488sclp_vt220_receiver_fn(struct evbuf_header *evbuf)
489{
490 char *buffer;
491 unsigned int count;
492
Linus Torvalds1da177e2005-04-16 15:20:36 -0700493 buffer = (char *) ((addr_t) evbuf + sizeof(struct evbuf_header));
494 count = evbuf->length - sizeof(struct evbuf_header);
495
496 switch (*buffer) {
497 case SCLP_VT220_SESSION_ENDED:
498 case SCLP_VT220_SESSION_STARTED:
499 break;
500 case SCLP_VT220_SESSION_DATA:
501 /* Send input to line discipline */
502 buffer++;
503 count--;
Jiri Slaby05c7cd32013-01-03 15:53:04 +0100504 tty_insert_flip_string(&sclp_vt220_port, buffer, count);
Jiri Slaby2e124b42013-01-03 15:53:06 +0100505 tty_flip_buffer_push(&sclp_vt220_port);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506 break;
507 }
508}
509
510/*
511 * This routine is called when a particular tty device is opened.
512 */
513static int
514sclp_vt220_open(struct tty_struct *tty, struct file *filp)
515{
516 if (tty->count == 1) {
Jiri Slaby092f7372012-04-02 13:54:13 +0200517 tty_port_tty_set(&sclp_vt220_port, tty);
Jiri Slabyd6c53c02013-01-03 15:53:05 +0100518 sclp_vt220_port.low_latency = 0;
Hendrik Brueckner0b665d72010-01-27 10:12:38 +0100519 if (!tty->winsize.ws_row && !tty->winsize.ws_col) {
520 tty->winsize.ws_row = 24;
521 tty->winsize.ws_col = 80;
522 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523 }
524 return 0;
525}
526
527/*
528 * This routine is called when a particular tty device is closed.
529 */
530static void
531sclp_vt220_close(struct tty_struct *tty, struct file *filp)
532{
Jiri Slabyb538c4e2012-04-02 13:54:14 +0200533 if (tty->count == 1)
Jiri Slaby092f7372012-04-02 13:54:13 +0200534 tty_port_tty_set(&sclp_vt220_port, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700535}
536
537/*
538 * This routine is called by the kernel to write a single
539 * character to the tty device. If the kernel uses this routine,
540 * it must call the flush_chars() routine (if defined) when it is
541 * done stuffing characters into the driver.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542 */
Alan Cox9e7c9a12008-04-30 00:54:00 -0700543static int
Linus Torvalds1da177e2005-04-16 15:20:36 -0700544sclp_vt220_put_char(struct tty_struct *tty, unsigned char ch)
545{
Heiko Carstensd4820e42008-05-30 10:03:30 +0200546 return __sclp_vt220_write(&ch, 1, 0, 0, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700547}
548
549/*
550 * This routine is called by the kernel after it has written a
551 * series of characters to the tty device using put_char().
552 */
553static void
554sclp_vt220_flush_chars(struct tty_struct *tty)
555{
Michael Holzheu62b749422009-06-16 10:30:40 +0200556 if (!sclp_vt220_queue_running)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557 sclp_vt220_emit_current();
558 else
559 sclp_vt220_flush_later = 1;
560}
561
562/*
563 * This routine returns the numbers of characters the tty driver
564 * will accept for queuing to be written. This number is subject
565 * to change as output buffers get emptied, or if the output flow
566 * control is acted.
567 */
568static int
569sclp_vt220_write_room(struct tty_struct *tty)
570{
571 unsigned long flags;
572 struct list_head *l;
573 int count;
574
575 spin_lock_irqsave(&sclp_vt220_lock, flags);
576 count = 0;
577 if (sclp_vt220_current_request != NULL)
578 count = sclp_vt220_space_left(sclp_vt220_current_request);
579 list_for_each(l, &sclp_vt220_empty)
580 count += SCLP_VT220_MAX_CHARS_PER_BUFFER;
581 spin_unlock_irqrestore(&sclp_vt220_lock, flags);
582 return count;
583}
584
585/*
586 * Return number of buffered chars.
587 */
588static int
589sclp_vt220_chars_in_buffer(struct tty_struct *tty)
590{
591 unsigned long flags;
592 struct list_head *l;
593 struct sclp_vt220_request *r;
594 int count;
595
596 spin_lock_irqsave(&sclp_vt220_lock, flags);
597 count = 0;
598 if (sclp_vt220_current_request != NULL)
599 count = sclp_vt220_chars_stored(sclp_vt220_current_request);
600 list_for_each(l, &sclp_vt220_outqueue) {
601 r = list_entry(l, struct sclp_vt220_request, list);
602 count += sclp_vt220_chars_stored(r);
603 }
604 spin_unlock_irqrestore(&sclp_vt220_lock, flags);
605 return count;
606}
607
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608/*
609 * Pass on all buffers to the hardware. Return only when there are no more
610 * buffers pending.
611 */
612static void
613sclp_vt220_flush_buffer(struct tty_struct *tty)
614{
615 sclp_vt220_emit_current();
616}
617
Peter Oberparleiterad211792008-07-14 09:59:07 +0200618/* Release allocated pages. */
619static void __init __sclp_vt220_free_pages(void)
Heiko Carstens5aaaf9f2007-07-27 12:29:22 +0200620{
621 struct list_head *page, *p;
622
623 list_for_each_safe(page, p, &sclp_vt220_empty) {
624 list_del(page);
Heiko Carstens5c0792f2009-06-22 12:08:07 +0200625 free_page((unsigned long) page);
Heiko Carstens5aaaf9f2007-07-27 12:29:22 +0200626 }
627}
628
Peter Oberparleiterad211792008-07-14 09:59:07 +0200629/* Release memory and unregister from sclp core. Controlled by init counting -
630 * only the last invoker will actually perform these actions. */
631static void __init __sclp_vt220_cleanup(void)
632{
633 sclp_vt220_init_count--;
634 if (sclp_vt220_init_count != 0)
635 return;
636 sclp_unregister(&sclp_vt220_register);
637 __sclp_vt220_free_pages();
Jiri Slaby191c5f12012-11-15 09:49:56 +0100638 tty_port_destroy(&sclp_vt220_port);
Peter Oberparleiterad211792008-07-14 09:59:07 +0200639}
640
641/* Allocate buffer pages and register with sclp core. Controlled by init
642 * counting - only the first invoker will actually perform these actions. */
643static int __init __sclp_vt220_init(int num_pages)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644{
645 void *page;
646 int i;
Christian Borntraeger59eb1ca2008-02-09 18:24:33 +0100647 int rc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648
Peter Oberparleiterad211792008-07-14 09:59:07 +0200649 sclp_vt220_init_count++;
650 if (sclp_vt220_init_count != 1)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652 spin_lock_init(&sclp_vt220_lock);
653 INIT_LIST_HEAD(&sclp_vt220_empty);
654 INIT_LIST_HEAD(&sclp_vt220_outqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655 init_timer(&sclp_vt220_timer);
Jiri Slaby092f7372012-04-02 13:54:13 +0200656 tty_port_init(&sclp_vt220_port);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657 sclp_vt220_current_request = NULL;
658 sclp_vt220_buffered_chars = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659 sclp_vt220_flush_later = 0;
660
661 /* Allocate pages for output buffering */
Heiko Carstens5c0792f2009-06-22 12:08:07 +0200662 rc = -ENOMEM;
Heiko Carstens5aaaf9f2007-07-27 12:29:22 +0200663 for (i = 0; i < num_pages; i++) {
Heiko Carstens5c0792f2009-06-22 12:08:07 +0200664 page = (void *) get_zeroed_page(GFP_KERNEL | GFP_DMA);
665 if (!page)
Peter Oberparleiterad211792008-07-14 09:59:07 +0200666 goto out;
Heiko Carstens5c0792f2009-06-22 12:08:07 +0200667 list_add_tail(page, &sclp_vt220_empty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700668 }
Christian Borntraeger59eb1ca2008-02-09 18:24:33 +0100669 rc = sclp_register(&sclp_vt220_register);
Peter Oberparleiterad211792008-07-14 09:59:07 +0200670out:
Christian Borntraeger59eb1ca2008-02-09 18:24:33 +0100671 if (rc) {
Peter Oberparleiterad211792008-07-14 09:59:07 +0200672 __sclp_vt220_free_pages();
673 sclp_vt220_init_count--;
Jiri Slaby191c5f12012-11-15 09:49:56 +0100674 tty_port_destroy(&sclp_vt220_port);
Christian Borntraeger59eb1ca2008-02-09 18:24:33 +0100675 }
676 return rc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677}
678
Jeff Dikeb68e31d2006-10-02 02:17:18 -0700679static const struct tty_operations sclp_vt220_ops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680 .open = sclp_vt220_open,
681 .close = sclp_vt220_close,
682 .write = sclp_vt220_write,
683 .put_char = sclp_vt220_put_char,
684 .flush_chars = sclp_vt220_flush_chars,
685 .write_room = sclp_vt220_write_room,
686 .chars_in_buffer = sclp_vt220_chars_in_buffer,
Heiko Carstens5aaaf9f2007-07-27 12:29:22 +0200687 .flush_buffer = sclp_vt220_flush_buffer,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700688};
689
690/*
691 * Register driver with SCLP and Linux and initialize internal tty structures.
692 */
Heiko Carstens5aaaf9f2007-07-27 12:29:22 +0200693static int __init sclp_vt220_tty_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694{
695 struct tty_driver *driver;
696 int rc;
697
698 /* Note: we're not testing for CONSOLE_IS_SCLP here to preserve
699 * symmetry between VM and LPAR systems regarding ttyS1. */
700 driver = alloc_tty_driver(1);
701 if (!driver)
702 return -ENOMEM;
Peter Oberparleiterad211792008-07-14 09:59:07 +0200703 rc = __sclp_vt220_init(MAX_KMEM_PAGES);
Heiko Carstens5aaaf9f2007-07-27 12:29:22 +0200704 if (rc)
705 goto out_driver;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700706
Linus Torvalds1da177e2005-04-16 15:20:36 -0700707 driver->driver_name = SCLP_VT220_DRIVER_NAME;
708 driver->name = SCLP_VT220_DEVICE_NAME;
709 driver->major = SCLP_VT220_MAJOR;
710 driver->minor_start = SCLP_VT220_MINOR;
711 driver->type = TTY_DRIVER_TYPE_SYSTEM;
712 driver->subtype = SYSTEM_TYPE_TTY;
713 driver->init_termios = tty_std_termios;
714 driver->flags = TTY_DRIVER_REAL_RAW;
715 tty_set_operations(driver, &sclp_vt220_ops);
Jiri Slabyb19e2ca2012-08-07 21:47:51 +0200716 tty_port_link_device(&sclp_vt220_port, driver, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700717
718 rc = tty_register_driver(driver);
Martin Schwidefskya12c53f2008-07-14 09:59:28 +0200719 if (rc)
Christian Borntraeger59eb1ca2008-02-09 18:24:33 +0100720 goto out_init;
Peter Oberparleitere106e4e2014-04-09 13:10:05 +0200721 rc = sclp_register(&sclp_vt220_register_input);
722 if (rc)
723 goto out_reg;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724 sclp_vt220_driver = driver;
725 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726
Peter Oberparleitere106e4e2014-04-09 13:10:05 +0200727out_reg:
728 tty_unregister_driver(driver);
Heiko Carstens5aaaf9f2007-07-27 12:29:22 +0200729out_init:
Peter Oberparleiterad211792008-07-14 09:59:07 +0200730 __sclp_vt220_cleanup();
Heiko Carstens5aaaf9f2007-07-27 12:29:22 +0200731out_driver:
732 put_tty_driver(driver);
733 return rc;
734}
735__initcall(sclp_vt220_tty_init);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700736
Heiko Carstensb3b59d32008-12-25 13:39:18 +0100737static void __sclp_vt220_flush_buffer(void)
738{
739 unsigned long flags;
740
741 sclp_vt220_emit_current();
742 spin_lock_irqsave(&sclp_vt220_lock, flags);
743 if (timer_pending(&sclp_vt220_timer))
744 del_timer(&sclp_vt220_timer);
Michael Holzheu62b749422009-06-16 10:30:40 +0200745 while (sclp_vt220_queue_running) {
Heiko Carstensb3b59d32008-12-25 13:39:18 +0100746 spin_unlock_irqrestore(&sclp_vt220_lock, flags);
747 sclp_sync_wait();
748 spin_lock_irqsave(&sclp_vt220_lock, flags);
749 }
750 spin_unlock_irqrestore(&sclp_vt220_lock, flags);
751}
752
Michael Holzheu62b749422009-06-16 10:30:40 +0200753/*
754 * Resume console: If there are cached messages, emit them.
755 */
756static void sclp_vt220_resume(void)
757{
758 unsigned long flags;
759
760 spin_lock_irqsave(&sclp_vt220_lock, flags);
761 sclp_vt220_suspended = 0;
762 spin_unlock_irqrestore(&sclp_vt220_lock, flags);
763 sclp_vt220_emit_current();
764}
765
766/*
767 * Suspend console: Set suspend flag and flush console
768 */
769static void sclp_vt220_suspend(void)
770{
771 unsigned long flags;
772
773 spin_lock_irqsave(&sclp_vt220_lock, flags);
774 sclp_vt220_suspended = 1;
775 spin_unlock_irqrestore(&sclp_vt220_lock, flags);
776 __sclp_vt220_flush_buffer();
777}
778
779static void sclp_vt220_pm_event_fn(struct sclp_register *reg,
780 enum sclp_pm_event sclp_pm_event)
781{
782 switch (sclp_pm_event) {
783 case SCLP_PM_EVENT_FREEZE:
784 sclp_vt220_suspend();
785 break;
786 case SCLP_PM_EVENT_RESTORE:
787 case SCLP_PM_EVENT_THAW:
788 sclp_vt220_resume();
789 break;
790 }
791}
792
Michael Holzheuac522b62009-10-14 12:43:51 +0200793#ifdef CONFIG_SCLP_VT220_CONSOLE
794
795static void
796sclp_vt220_con_write(struct console *con, const char *buf, unsigned int count)
797{
798 __sclp_vt220_write((const unsigned char *) buf, count, 1, 1, 0);
799}
800
801static struct tty_driver *
802sclp_vt220_con_device(struct console *c, int *index)
803{
804 *index = 0;
805 return sclp_vt220_driver;
806}
807
Holger Smolinski2332ce12008-10-10 21:33:27 +0200808static int
809sclp_vt220_notify(struct notifier_block *self,
810 unsigned long event, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811{
812 __sclp_vt220_flush_buffer();
Holger Smolinski2332ce12008-10-10 21:33:27 +0200813 return NOTIFY_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700814}
815
Holger Smolinski2332ce12008-10-10 21:33:27 +0200816static struct notifier_block on_panic_nb = {
817 .notifier_call = sclp_vt220_notify,
818 .priority = 1,
819};
820
821static struct notifier_block on_reboot_nb = {
822 .notifier_call = sclp_vt220_notify,
823 .priority = 1,
824};
825
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826/* Structure needed to register with printk */
827static struct console sclp_vt220_console =
828{
829 .name = SCLP_VT220_CONSOLE_NAME,
830 .write = sclp_vt220_con_write,
831 .device = sclp_vt220_con_device,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700832 .flags = CON_PRINTBUFFER,
833 .index = SCLP_VT220_CONSOLE_INDEX
834};
835
836static int __init
837sclp_vt220_con_init(void)
838{
839 int rc;
840
841 if (!CONSOLE_IS_SCLP)
842 return 0;
Martin Schwidefsky25b41a72013-05-24 12:30:03 +0200843 rc = __sclp_vt220_init(sclp_console_pages);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700844 if (rc)
845 return rc;
846 /* Attach linux console */
Holger Smolinski2332ce12008-10-10 21:33:27 +0200847 atomic_notifier_chain_register(&panic_notifier_list, &on_panic_nb);
848 register_reboot_notifier(&on_reboot_nb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700849 register_console(&sclp_vt220_console);
850 return 0;
851}
852
853console_initcall(sclp_vt220_con_init);
854#endif /* CONFIG_SCLP_VT220_CONSOLE */
855