1 // SPDX-License-Identifier: GPL-2.0
3 * IBM/3270 Driver - core functions.
6 * Original 3270 Code for 2.4 written by Richard Hitt (UTS Global)
7 * Rewritten for 2.5 by Martin Schwidefsky <schwidefsky@de.ibm.com>
8 * Copyright IBM Corp. 2003, 2009
11 #include <linux/module.h>
12 #include <linux/err.h>
13 #include <linux/init.h>
14 #include <linux/interrupt.h>
15 #include <linux/list.h>
16 #include <linux/slab.h>
17 #include <linux/types.h>
18 #include <linux/wait.h>
20 #include <asm/ccwdev.h>
22 #include <asm/ebcdic.h>
27 #include <linux/major.h>
28 #include <linux/kdev_t.h>
29 #include <linux/device.h>
30 #include <linux/mutex.h>
32 const struct class class3270 = {
35 EXPORT_SYMBOL(class3270);
37 /* The main 3270 data structure. */
39 struct list_head list;
40 struct ccw_device *cdev;
43 int model, rows, cols;
44 int old_model, old_rows, old_cols;
48 struct list_head req_queue; /* Request queue. */
49 struct list_head view_list; /* List of available views. */
50 struct raw3270_view *view; /* Active view. */
52 struct timer_list timer; /* Device timer. */
54 unsigned char *ascebc; /* ascii -> ebcdic table */
56 struct raw3270_view init_view;
57 struct raw3270_request init_reset;
58 struct raw3270_request init_readpart;
59 struct raw3270_request init_readmod;
60 unsigned char init_data[256];
61 struct work_struct resize_work;
65 #define RAW3270_STATE_INIT 0 /* Initial state */
66 #define RAW3270_STATE_RESET 1 /* Reset command is pending */
67 #define RAW3270_STATE_W4ATTN 2 /* Wait for attention interrupt */
68 #define RAW3270_STATE_READMOD 3 /* Read partition is pending */
69 #define RAW3270_STATE_READY 4 /* Device is usable by views */
72 #define RAW3270_FLAGS_14BITADDR 0 /* 14-bit buffer addresses */
73 #define RAW3270_FLAGS_BUSY 1 /* Device busy, leave it alone */
74 #define RAW3270_FLAGS_CONSOLE 2 /* Device is the console. */
76 /* Semaphore to protect global data of raw3270 (devices, views, etc). */
77 static DEFINE_MUTEX(raw3270_mutex);
79 /* List of 3270 devices. */
80 static LIST_HEAD(raw3270_devices);
83 * Flag to indicate if the driver has been registered. Some operations
84 * like waiting for the end of i/o need to be done differently as long
85 * as the kernel is still starting up (console support).
87 static int raw3270_registered;
89 /* Module parameters */
90 static bool tubxcorrect;
91 module_param(tubxcorrect, bool, 0);
94 * Wait queue for device init/delete, view delete.
96 DECLARE_WAIT_QUEUE_HEAD(raw3270_wait_queue);
97 EXPORT_SYMBOL(raw3270_wait_queue);
99 static void __raw3270_disconnect(struct raw3270 *rp);
102 * Encode array for 12 bit 3270 addresses.
104 static unsigned char raw3270_ebcgraf[64] = {
105 0x40, 0xc1, 0xc2, 0xc3, 0xc4, 0xc5, 0xc6, 0xc7,
106 0xc8, 0xc9, 0x4a, 0x4b, 0x4c, 0x4d, 0x4e, 0x4f,
107 0x50, 0xd1, 0xd2, 0xd3, 0xd4, 0xd5, 0xd6, 0xd7,
108 0xd8, 0xd9, 0x5a, 0x5b, 0x5c, 0x5d, 0x5e, 0x5f,
109 0x60, 0x61, 0xe2, 0xe3, 0xe4, 0xe5, 0xe6, 0xe7,
110 0xe8, 0xe9, 0x6a, 0x6b, 0x6c, 0x6d, 0x6e, 0x6f,
111 0xf0, 0xf1, 0xf2, 0xf3, 0xf4, 0xf5, 0xf6, 0xf7,
112 0xf8, 0xf9, 0x7a, 0x7b, 0x7c, 0x7d, 0x7e, 0x7f
115 static inline int raw3270_state_ready(struct raw3270 *rp)
117 return rp->state == RAW3270_STATE_READY;
120 void raw3270_buffer_address(struct raw3270 *rp, char *cp, int x, int y)
125 x = max_t(int, 0, rp->view->cols + x);
127 y = max_t(int, 0, rp->view->rows + y);
128 addr = (y * rp->view->cols) + x;
129 if (test_bit(RAW3270_FLAGS_14BITADDR, &rp->flags)) {
130 cp[0] = (addr >> 8) & 0x3f;
133 cp[0] = raw3270_ebcgraf[(addr >> 6) & 0x3f];
134 cp[1] = raw3270_ebcgraf[addr & 0x3f];
137 EXPORT_SYMBOL(raw3270_buffer_address);
140 * Allocate a new 3270 ccw request
142 struct raw3270_request *raw3270_request_alloc(size_t size)
144 struct raw3270_request *rq;
146 /* Allocate request structure */
147 rq = kzalloc(sizeof(*rq), GFP_KERNEL | GFP_DMA);
149 return ERR_PTR(-ENOMEM);
151 /* alloc output buffer. */
153 rq->buffer = kmalloc(size, GFP_KERNEL | GFP_DMA);
156 return ERR_PTR(-ENOMEM);
160 INIT_LIST_HEAD(&rq->list);
165 rq->ccw.cda = virt_to_dma32(rq->buffer);
166 rq->ccw.flags = CCW_FLAG_SLI;
170 EXPORT_SYMBOL(raw3270_request_alloc);
173 * Free 3270 ccw request
175 void raw3270_request_free(struct raw3270_request *rq)
180 EXPORT_SYMBOL(raw3270_request_free);
183 * Reset request to initial state.
185 int raw3270_request_reset(struct raw3270_request *rq)
187 if (WARN_ON_ONCE(!list_empty(&rq->list)))
189 rq->ccw.cmd_code = 0;
191 rq->ccw.cda = virt_to_dma32(rq->buffer);
192 rq->ccw.flags = CCW_FLAG_SLI;
197 EXPORT_SYMBOL(raw3270_request_reset);
200 * Set command code to ccw of a request.
202 void raw3270_request_set_cmd(struct raw3270_request *rq, u8 cmd)
204 rq->ccw.cmd_code = cmd;
206 EXPORT_SYMBOL(raw3270_request_set_cmd);
209 * Add data fragment to output buffer.
211 int raw3270_request_add_data(struct raw3270_request *rq, void *data, size_t size)
213 if (size + rq->ccw.count > rq->size)
215 memcpy(rq->buffer + rq->ccw.count, data, size);
216 rq->ccw.count += size;
219 EXPORT_SYMBOL(raw3270_request_add_data);
222 * Set address/length pair to ccw of a request.
224 void raw3270_request_set_data(struct raw3270_request *rq, void *data, size_t size)
226 rq->ccw.cda = virt_to_dma32(data);
227 rq->ccw.count = size;
229 EXPORT_SYMBOL(raw3270_request_set_data);
232 * Set idal buffer to ccw of a request.
234 void raw3270_request_set_idal(struct raw3270_request *rq, struct idal_buffer *ib)
236 rq->ccw.cda = virt_to_dma32(ib->data);
237 rq->ccw.count = ib->size;
238 rq->ccw.flags |= CCW_FLAG_IDA;
240 EXPORT_SYMBOL(raw3270_request_set_idal);
243 * Add the request to the request queue, try to start it if the
244 * 3270 device is idle. Return without waiting for end of i/o.
246 static int __raw3270_start(struct raw3270 *rp, struct raw3270_view *view,
247 struct raw3270_request *rq)
250 raw3270_get_view(view);
251 if (list_empty(&rp->req_queue) &&
252 !test_bit(RAW3270_FLAGS_BUSY, &rp->flags)) {
253 /* No other requests are on the queue. Start this one. */
254 rq->rc = ccw_device_start(rp->cdev, &rq->ccw,
255 (unsigned long)rq, 0, 0);
257 raw3270_put_view(view);
261 list_add_tail(&rq->list, &rp->req_queue);
265 int raw3270_view_active(struct raw3270_view *view)
267 struct raw3270 *rp = view->dev;
269 return rp && rp->view == view;
272 int raw3270_start(struct raw3270_view *view, struct raw3270_request *rq)
278 spin_lock_irqsave(get_ccwdev_lock(view->dev->cdev), flags);
280 if (!rp || rp->view != view)
282 else if (!raw3270_state_ready(rp))
285 rc = __raw3270_start(rp, view, rq);
286 spin_unlock_irqrestore(get_ccwdev_lock(view->dev->cdev), flags);
289 EXPORT_SYMBOL(raw3270_start);
291 int raw3270_start_request(struct raw3270_view *view, struct raw3270_request *rq,
292 int cmd, void *data, size_t len)
296 rc = raw3270_request_reset(rq);
299 raw3270_request_set_cmd(rq, cmd);
300 rc = raw3270_request_add_data(rq, data, len);
303 return raw3270_start(view, rq);
305 EXPORT_SYMBOL(raw3270_start_request);
307 int raw3270_start_locked(struct raw3270_view *view, struct raw3270_request *rq)
313 if (!rp || rp->view != view)
315 else if (!raw3270_state_ready(rp))
318 rc = __raw3270_start(rp, view, rq);
321 EXPORT_SYMBOL(raw3270_start_locked);
323 int raw3270_start_irq(struct raw3270_view *view, struct raw3270_request *rq)
329 raw3270_get_view(view);
330 list_add_tail(&rq->list, &rp->req_queue);
333 EXPORT_SYMBOL(raw3270_start_irq);
336 * 3270 interrupt routine, called from the ccw_device layer
338 static void raw3270_irq(struct ccw_device *cdev, unsigned long intparm, struct irb *irb)
341 struct raw3270_view *view;
342 struct raw3270_request *rq;
344 rp = dev_get_drvdata(&cdev->dev);
347 rq = (struct raw3270_request *)intparm;
348 view = rq ? rq->view : rp->view;
351 /* Handle CE-DE-UE and subsequent UDE */
352 if (irb->scsw.cmd.dstat & DEV_STAT_DEV_END)
353 clear_bit(RAW3270_FLAGS_BUSY, &rp->flags);
354 if (irb->scsw.cmd.dstat == (DEV_STAT_CHN_END |
356 DEV_STAT_UNIT_EXCEP))
357 set_bit(RAW3270_FLAGS_BUSY, &rp->flags);
358 /* Handle disconnected devices */
359 if ((irb->scsw.cmd.dstat & DEV_STAT_UNIT_CHECK) &&
360 (irb->ecw[0] & SNS0_INTERVENTION_REQ)) {
361 set_bit(RAW3270_FLAGS_BUSY, &rp->flags);
362 if (rp->state > RAW3270_STATE_RESET)
363 __raw3270_disconnect(rp);
365 /* Call interrupt handler of the view */
367 view->fn->intv(view, rq, irb);
370 if (test_bit(RAW3270_FLAGS_BUSY, &rp->flags))
371 /* Device busy, do not start I/O */
374 if (rq && !list_empty(&rq->list)) {
375 /* The request completed, remove from queue and do callback. */
376 list_del_init(&rq->list);
378 rq->callback(rq, rq->callback_data);
379 /* Do put_device for get_device in raw3270_start. */
380 raw3270_put_view(view);
384 * Try to start each request on request queue until one is
385 * started successful.
387 while (!list_empty(&rp->req_queue)) {
388 rq = list_entry(rp->req_queue.next, struct raw3270_request, list);
389 rq->rc = ccw_device_start(rp->cdev, &rq->ccw,
390 (unsigned long)rq, 0, 0);
393 /* Start failed. Remove request and do callback. */
394 list_del_init(&rq->list);
396 rq->callback(rq, rq->callback_data);
397 /* Do put_device for get_device in raw3270_start. */
398 raw3270_put_view(view);
403 * To determine the size of the 3270 device we need to do:
404 * 1) send a 'read partition' data stream to the device
405 * 2) wait for the attn interrupt that precedes the query reply
406 * 3) do a read modified to get the query reply
407 * To make things worse we have to cope with intervention
408 * required (3270 device switched to 'stand-by') and command
409 * rejects (old devices that can't do 'read partition').
411 struct raw3270_ua { /* Query Reply structure for Usable Area */
412 struct { /* Usable Area Query Reply Base */
413 short l; /* Length of this structured field */
414 char sfid; /* 0x81 if Query Reply */
415 char qcode; /* 0x81 if Usable Area */
418 short w; /* Width of usable area */
419 short h; /* Heigth of usavle area */
420 char units; /* 0x00:in; 0x01:mm */
425 short buffsz; /* Character buffer size, bytes */
431 struct { /* Alternate Usable Area Self-Defining Parameter */
432 char l; /* Length of this Self-Defining Parm */
433 char sdpid; /* 0x02 if Alternate Usable Area */
435 char auaid; /* 0x01 is Id for the A U A */
436 short wauai; /* Width of AUAi */
437 short hauai; /* Height of AUAi */
438 char auaunits; /* 0x00:in, 0x01:mm */
446 static void raw3270_size_device_vm(struct raw3270 *rp)
449 struct ccw_dev_id dev_id;
450 struct diag210 diag_data;
451 struct diag8c diag8c_data;
453 ccw_device_get_id(rp->cdev, &dev_id);
454 rc = diag8c(&diag8c_data, &dev_id);
457 rp->rows = diag8c_data.height;
458 rp->cols = diag8c_data.width;
459 if (diag8c_data.flags & 1)
460 set_bit(RAW3270_FLAGS_14BITADDR, &rp->flags);
464 diag_data.vrdcdvno = dev_id.devno;
465 diag_data.vrdclen = sizeof(struct diag210);
466 rc = diag210(&diag_data);
467 model = diag_data.vrdccrmd;
468 /* Use default model 2 if the size could not be detected */
469 if (rc || model < 2 || model > 5)
495 static void raw3270_size_device(struct raw3270 *rp, char *init_data)
497 struct raw3270_ua *uap;
499 /* Got a Query Reply */
500 uap = (struct raw3270_ua *)(init_data + 1);
501 /* Paranoia check. */
502 if (init_data[0] != 0x88 || uap->uab.qcode != 0x81) {
503 /* Couldn't detect size. Use default model 2. */
509 /* Copy rows/columns of default Usable Area */
510 rp->rows = uap->uab.h;
511 rp->cols = uap->uab.w;
512 /* Check for 14 bit addressing */
513 if ((uap->uab.flags0 & 0x0d) == 0x01)
514 set_bit(RAW3270_FLAGS_14BITADDR, &rp->flags);
515 /* Check for Alternate Usable Area */
516 if (uap->uab.l == sizeof(struct raw3270_ua) &&
517 uap->aua.sdpid == 0x02) {
518 rp->rows = uap->aua.hauai;
519 rp->cols = uap->aua.wauai;
521 /* Try to find a model. */
523 if (rp->rows == 24 && rp->cols == 80)
525 if (rp->rows == 32 && rp->cols == 80)
527 if (rp->rows == 43 && rp->cols == 80)
529 if (rp->rows == 27 && rp->cols == 132)
533 static void raw3270_resize_work(struct work_struct *work)
535 struct raw3270 *rp = container_of(work, struct raw3270, resize_work);
536 struct raw3270_view *view;
538 /* Notify views about new size */
539 list_for_each_entry(view, &rp->view_list, list) {
540 if (view->fn->resize)
541 view->fn->resize(view, rp->model, rp->rows, rp->cols,
542 rp->old_model, rp->old_rows, rp->old_cols);
544 rp->old_cols = rp->cols;
545 rp->old_rows = rp->rows;
546 rp->old_model = rp->model;
547 /* Setup processing done, now activate a view */
548 list_for_each_entry(view, &rp->view_list, list) {
550 if (view->fn->activate(view) == 0)
556 static void raw3270_size_device_done(struct raw3270 *rp)
559 rp->state = RAW3270_STATE_READY;
560 schedule_work(&rp->resize_work);
563 void raw3270_read_modified_cb(struct raw3270_request *rq, void *data)
565 struct raw3270 *rp = rq->view->dev;
567 raw3270_size_device(rp, data);
568 raw3270_size_device_done(rp);
570 EXPORT_SYMBOL(raw3270_read_modified_cb);
572 static void raw3270_read_modified(struct raw3270 *rp)
574 if (rp->state != RAW3270_STATE_W4ATTN)
576 /* Use 'read modified' to get the result of a read partition. */
577 memset(&rp->init_readmod, 0, sizeof(rp->init_readmod));
578 memset(&rp->init_data, 0, sizeof(rp->init_data));
579 rp->init_readmod.ccw.cmd_code = TC_READMOD;
580 rp->init_readmod.ccw.flags = CCW_FLAG_SLI;
581 rp->init_readmod.ccw.count = sizeof(rp->init_data);
582 rp->init_readmod.ccw.cda = virt_to_dma32(rp->init_data);
583 rp->init_readmod.callback = raw3270_read_modified_cb;
584 rp->init_readmod.callback_data = rp->init_data;
585 rp->state = RAW3270_STATE_READMOD;
586 raw3270_start_irq(&rp->init_view, &rp->init_readmod);
589 static void raw3270_writesf_readpart(struct raw3270 *rp)
591 static const unsigned char wbuf[] = {
592 0x00, 0x07, 0x01, 0xff, 0x03, 0x00, 0x81
595 /* Store 'read partition' data stream to init_data */
596 memset(&rp->init_readpart, 0, sizeof(rp->init_readpart));
597 memset(&rp->init_data, 0, sizeof(rp->init_data));
598 memcpy(&rp->init_data, wbuf, sizeof(wbuf));
599 rp->init_readpart.ccw.cmd_code = TC_WRITESF;
600 rp->init_readpart.ccw.flags = CCW_FLAG_SLI;
601 rp->init_readpart.ccw.count = sizeof(wbuf);
602 rp->init_readpart.ccw.cda = virt_to_dma32(&rp->init_data);
603 rp->state = RAW3270_STATE_W4ATTN;
604 raw3270_start_irq(&rp->init_view, &rp->init_readpart);
610 static void raw3270_reset_device_cb(struct raw3270_request *rq, void *data)
612 struct raw3270 *rp = rq->view->dev;
614 if (rp->state != RAW3270_STATE_RESET)
617 /* Reset command failed. */
618 rp->state = RAW3270_STATE_INIT;
619 } else if (MACHINE_IS_VM) {
620 raw3270_size_device_vm(rp);
621 raw3270_size_device_done(rp);
623 raw3270_writesf_readpart(rp);
625 memset(&rp->init_reset, 0, sizeof(rp->init_reset));
628 static int __raw3270_reset_device(struct raw3270 *rp)
632 /* Check if reset is already pending */
633 if (rp->init_reset.view)
635 /* Store reset data stream to init_data/init_reset */
636 rp->init_data[0] = TW_KR;
637 rp->init_reset.ccw.cmd_code = TC_EWRITEA;
638 rp->init_reset.ccw.flags = CCW_FLAG_SLI;
639 rp->init_reset.ccw.count = 1;
640 rp->init_reset.ccw.cda = virt_to_dma32(rp->init_data);
641 rp->init_reset.callback = raw3270_reset_device_cb;
642 rc = __raw3270_start(rp, &rp->init_view, &rp->init_reset);
643 if (rc == 0 && rp->state == RAW3270_STATE_INIT)
644 rp->state = RAW3270_STATE_RESET;
648 static int raw3270_reset_device(struct raw3270 *rp)
653 spin_lock_irqsave(get_ccwdev_lock(rp->cdev), flags);
654 rc = __raw3270_reset_device(rp);
655 spin_unlock_irqrestore(get_ccwdev_lock(rp->cdev), flags);
659 int raw3270_reset(struct raw3270_view *view)
665 if (!rp || rp->view != view)
667 else if (!raw3270_state_ready(rp))
670 rc = raw3270_reset_device(view->dev);
673 EXPORT_SYMBOL(raw3270_reset);
675 static void __raw3270_disconnect(struct raw3270 *rp)
677 struct raw3270_request *rq;
678 struct raw3270_view *view;
680 rp->state = RAW3270_STATE_INIT;
681 rp->view = &rp->init_view;
682 /* Cancel all queued requests */
683 while (!list_empty(&rp->req_queue)) {
684 rq = list_entry(rp->req_queue.next, struct raw3270_request, list);
687 list_del_init(&rq->list);
689 rq->callback(rq, rq->callback_data);
690 raw3270_put_view(view);
692 /* Start from scratch */
693 __raw3270_reset_device(rp);
696 static void raw3270_init_irq(struct raw3270_view *view, struct raw3270_request *rq,
702 if (irb->scsw.cmd.dstat & DEV_STAT_UNIT_CHECK) {
703 if (irb->ecw[0] & SNS0_CMD_REJECT)
704 rq->rc = -EOPNOTSUPP;
709 if (irb->scsw.cmd.dstat & DEV_STAT_ATTENTION) {
710 /* Queue read modified after attention interrupt */
712 raw3270_read_modified(rp);
716 static struct raw3270_fn raw3270_init_fn = {
717 .intv = raw3270_init_irq
721 * Setup new 3270 device.
723 static int raw3270_setup_device(struct ccw_device *cdev, struct raw3270 *rp,
730 memset(rp, 0, sizeof(struct raw3270));
731 /* Copy ebcdic -> ascii translation table. */
732 memcpy(ascebc, _ascebc, 256);
734 /* correct brackets and circumflex */
744 rp->old_rows = rp->rows;
745 rp->old_cols = rp->cols;
747 INIT_LIST_HEAD(&rp->req_queue);
748 INIT_LIST_HEAD(&rp->view_list);
750 rp->init_view.dev = rp;
751 rp->init_view.fn = &raw3270_init_fn;
752 rp->view = &rp->init_view;
753 INIT_WORK(&rp->resize_work, raw3270_resize_work);
756 * Add device to list and find the smallest unused minor
757 * number for it. Note: there is no device with minor 0,
758 * see special case for fs3270.c:fs3270_open().
760 mutex_lock(&raw3270_mutex);
761 /* Keep the list sorted. */
762 minor = RAW3270_FIRSTMINOR;
764 list_for_each(l, &raw3270_devices) {
765 tmp = list_entry(l, struct raw3270, list);
766 if (tmp->minor > minor) {
768 __list_add(&rp->list, l->prev, l);
773 if (rp->minor == -1 && minor < RAW3270_MAXDEVS + RAW3270_FIRSTMINOR) {
775 list_add_tail(&rp->list, &raw3270_devices);
777 mutex_unlock(&raw3270_mutex);
778 /* No free minor number? Then give up. */
782 dev_set_drvdata(&cdev->dev, rp);
783 cdev->handler = raw3270_irq;
787 #ifdef CONFIG_TN3270_CONSOLE
788 /* Tentative definition - see below for actual definition. */
789 static struct ccw_driver raw3270_ccw_driver;
791 static inline int raw3270_state_final(struct raw3270 *rp)
793 return rp->state == RAW3270_STATE_INIT ||
794 rp->state == RAW3270_STATE_READY;
798 * Setup 3270 device configured as console.
800 struct raw3270 __init *raw3270_setup_console(void)
802 struct ccw_device *cdev;
808 cdev = ccw_device_create_console(&raw3270_ccw_driver);
810 return ERR_CAST(cdev);
812 rp = kzalloc(sizeof(*rp), GFP_KERNEL | GFP_DMA);
813 ascebc = kzalloc(256, GFP_KERNEL);
814 rc = raw3270_setup_device(cdev, rp, ascebc);
817 set_bit(RAW3270_FLAGS_CONSOLE, &rp->flags);
819 rc = ccw_device_enable_console(cdev);
821 ccw_device_destroy_console(cdev);
825 spin_lock_irqsave(get_ccwdev_lock(rp->cdev), flags);
827 __raw3270_reset_device(rp);
828 while (!raw3270_state_final(rp)) {
829 ccw_device_wait_idle(rp->cdev);
832 } while (rp->state != RAW3270_STATE_READY);
833 spin_unlock_irqrestore(get_ccwdev_lock(rp->cdev), flags);
837 void raw3270_wait_cons_dev(struct raw3270 *rp)
841 spin_lock_irqsave(get_ccwdev_lock(rp->cdev), flags);
842 ccw_device_wait_idle(rp->cdev);
843 spin_unlock_irqrestore(get_ccwdev_lock(rp->cdev), flags);
849 * Create a 3270 device structure.
851 static struct raw3270 *raw3270_create_device(struct ccw_device *cdev)
857 rp = kzalloc(sizeof(*rp), GFP_KERNEL | GFP_DMA);
859 return ERR_PTR(-ENOMEM);
860 ascebc = kmalloc(256, GFP_KERNEL);
863 return ERR_PTR(-ENOMEM);
865 rc = raw3270_setup_device(cdev, rp, ascebc);
871 /* Get reference to ccw_device structure. */
872 get_device(&cdev->dev);
877 * This helper just validates that it is safe to activate a
878 * view in the panic() context, due to locking restrictions.
880 int raw3270_view_lock_unavailable(struct raw3270_view *view)
882 struct raw3270 *rp = view->dev;
886 if (spin_is_locked(get_ccwdev_lock(rp->cdev)))
891 static int raw3270_assign_activate_view(struct raw3270 *rp, struct raw3270_view *view)
894 return view->fn->activate(view);
897 static int __raw3270_activate_view(struct raw3270 *rp, struct raw3270_view *view)
899 struct raw3270_view *oldview = NULL, *nv;
902 if (rp->view == view)
905 if (!raw3270_state_ready(rp))
908 if (rp->view && rp->view->fn->deactivate) {
910 oldview->fn->deactivate(oldview);
913 rc = raw3270_assign_activate_view(rp, view);
917 /* Didn't work. Try to reactivate the old view. */
919 rc = raw3270_assign_activate_view(rp, oldview);
924 /* Didn't work as well. Try any other view. */
925 list_for_each_entry(nv, &rp->view_list, list) {
926 if (nv == view || nv == oldview)
928 rc = raw3270_assign_activate_view(rp, nv);
939 int raw3270_activate_view(struct raw3270_view *view)
948 spin_lock_irqsave(get_ccwdev_lock(rp->cdev), flags);
949 rc = __raw3270_activate_view(rp, view);
950 spin_unlock_irqrestore(get_ccwdev_lock(rp->cdev), flags);
953 EXPORT_SYMBOL(raw3270_activate_view);
956 * Deactivate current view.
958 void raw3270_deactivate_view(struct raw3270_view *view)
966 spin_lock_irqsave(get_ccwdev_lock(rp->cdev), flags);
967 if (rp->view == view) {
968 view->fn->deactivate(view);
970 /* Move deactivated view to end of list. */
971 list_del_init(&view->list);
972 list_add_tail(&view->list, &rp->view_list);
973 /* Try to activate another view. */
974 if (raw3270_state_ready(rp)) {
975 list_for_each_entry(view, &rp->view_list, list) {
977 if (view->fn->activate(view) == 0)
983 spin_unlock_irqrestore(get_ccwdev_lock(rp->cdev), flags);
985 EXPORT_SYMBOL(raw3270_deactivate_view);
988 * Add view to device with minor "minor".
990 int raw3270_add_view(struct raw3270_view *view, struct raw3270_fn *fn,
991 int minor, int subclass)
999 mutex_lock(&raw3270_mutex);
1001 list_for_each_entry(rp, &raw3270_devices, list) {
1002 if (rp->minor != minor)
1004 spin_lock_irqsave(get_ccwdev_lock(rp->cdev), flags);
1005 atomic_set(&view->ref_count, 2);
1008 view->model = rp->model;
1009 view->rows = rp->rows;
1010 view->cols = rp->cols;
1011 view->ascebc = rp->ascebc;
1012 spin_lock_init(&view->lock);
1013 lockdep_set_subclass(&view->lock, subclass);
1014 list_add(&view->list, &rp->view_list);
1016 spin_unlock_irqrestore(get_ccwdev_lock(rp->cdev), flags);
1019 mutex_unlock(&raw3270_mutex);
1022 EXPORT_SYMBOL(raw3270_add_view);
1025 * Find specific view of device with minor "minor".
1027 struct raw3270_view *raw3270_find_view(struct raw3270_fn *fn, int minor)
1030 struct raw3270_view *view, *tmp;
1031 unsigned long flags;
1033 mutex_lock(&raw3270_mutex);
1034 view = ERR_PTR(-ENODEV);
1035 list_for_each_entry(rp, &raw3270_devices, list) {
1036 if (rp->minor != minor)
1038 spin_lock_irqsave(get_ccwdev_lock(rp->cdev), flags);
1039 list_for_each_entry(tmp, &rp->view_list, list) {
1040 if (tmp->fn == fn) {
1041 raw3270_get_view(tmp);
1046 spin_unlock_irqrestore(get_ccwdev_lock(rp->cdev), flags);
1049 mutex_unlock(&raw3270_mutex);
1052 EXPORT_SYMBOL(raw3270_find_view);
1055 * Remove view from device and free view structure via call to view->fn->free.
1057 void raw3270_del_view(struct raw3270_view *view)
1059 unsigned long flags;
1061 struct raw3270_view *nv;
1064 spin_lock_irqsave(get_ccwdev_lock(rp->cdev), flags);
1065 if (rp->view == view) {
1066 view->fn->deactivate(view);
1069 list_del_init(&view->list);
1070 if (!rp->view && raw3270_state_ready(rp)) {
1071 /* Try to activate another view. */
1072 list_for_each_entry(nv, &rp->view_list, list) {
1073 if (nv->fn->activate(nv) == 0) {
1079 spin_unlock_irqrestore(get_ccwdev_lock(rp->cdev), flags);
1080 /* Wait for reference counter to drop to zero. */
1081 atomic_dec(&view->ref_count);
1082 wait_event(raw3270_wait_queue, atomic_read(&view->ref_count) == 0);
1084 view->fn->free(view);
1086 EXPORT_SYMBOL(raw3270_del_view);
1089 * Remove a 3270 device structure.
1091 static void raw3270_delete_device(struct raw3270 *rp)
1093 struct ccw_device *cdev;
1095 /* Remove from device chain. */
1096 mutex_lock(&raw3270_mutex);
1097 list_del_init(&rp->list);
1098 mutex_unlock(&raw3270_mutex);
1100 /* Disconnect from ccw_device. */
1103 dev_set_drvdata(&cdev->dev, NULL);
1104 cdev->handler = NULL;
1106 /* Put ccw_device structure. */
1107 put_device(&cdev->dev);
1109 /* Now free raw3270 structure. */
1114 static int raw3270_probe(struct ccw_device *cdev)
1120 * Additional attributes for a 3270 device
1122 static ssize_t model_show(struct device *dev, struct device_attribute *attr,
1125 return sysfs_emit(buf, "%i\n",
1126 ((struct raw3270 *)dev_get_drvdata(dev))->model);
1128 static DEVICE_ATTR_RO(model);
1130 static ssize_t rows_show(struct device *dev, struct device_attribute *attr,
1133 return sysfs_emit(buf, "%i\n",
1134 ((struct raw3270 *)dev_get_drvdata(dev))->rows);
1136 static DEVICE_ATTR_RO(rows);
1139 columns_show(struct device *dev, struct device_attribute *attr,
1142 return sysfs_emit(buf, "%i\n",
1143 ((struct raw3270 *)dev_get_drvdata(dev))->cols);
1145 static DEVICE_ATTR_RO(columns);
1147 static struct attribute *raw3270_attrs[] = {
1148 &dev_attr_model.attr,
1149 &dev_attr_rows.attr,
1150 &dev_attr_columns.attr,
1154 static const struct attribute_group raw3270_attr_group = {
1155 .attrs = raw3270_attrs,
1158 static int raw3270_create_attributes(struct raw3270 *rp)
1160 return sysfs_create_group(&rp->cdev->dev.kobj, &raw3270_attr_group);
1164 * Notifier for device addition/removal
1166 static LIST_HEAD(raw3270_notifier);
1168 int raw3270_register_notifier(struct raw3270_notifier *notifier)
1172 mutex_lock(&raw3270_mutex);
1173 list_add_tail(¬ifier->list, &raw3270_notifier);
1174 list_for_each_entry(rp, &raw3270_devices, list)
1175 notifier->create(rp->minor);
1176 mutex_unlock(&raw3270_mutex);
1179 EXPORT_SYMBOL(raw3270_register_notifier);
1181 void raw3270_unregister_notifier(struct raw3270_notifier *notifier)
1185 mutex_lock(&raw3270_mutex);
1186 list_for_each_entry(rp, &raw3270_devices, list)
1187 notifier->destroy(rp->minor);
1188 list_del(¬ifier->list);
1189 mutex_unlock(&raw3270_mutex);
1191 EXPORT_SYMBOL(raw3270_unregister_notifier);
1194 * Set 3270 device online.
1196 static int raw3270_set_online(struct ccw_device *cdev)
1198 struct raw3270_notifier *np;
1202 rp = raw3270_create_device(cdev);
1205 rc = raw3270_create_attributes(rp);
1208 raw3270_reset_device(rp);
1209 mutex_lock(&raw3270_mutex);
1210 list_for_each_entry(np, &raw3270_notifier, list)
1211 np->create(rp->minor);
1212 mutex_unlock(&raw3270_mutex);
1216 raw3270_delete_device(rp);
1221 * Remove 3270 device structure.
1223 static void raw3270_remove(struct ccw_device *cdev)
1225 unsigned long flags;
1227 struct raw3270_view *v;
1228 struct raw3270_notifier *np;
1230 rp = dev_get_drvdata(&cdev->dev);
1232 * _remove is the opposite of _probe; it's probe that
1233 * should set up rp. raw3270_remove gets entered for
1234 * devices even if they haven't been varied online.
1235 * Thus, rp may validly be NULL here.
1240 sysfs_remove_group(&cdev->dev.kobj, &raw3270_attr_group);
1242 /* Deactivate current view and remove all views. */
1243 spin_lock_irqsave(get_ccwdev_lock(cdev), flags);
1245 if (rp->view->fn->deactivate)
1246 rp->view->fn->deactivate(rp->view);
1249 while (!list_empty(&rp->view_list)) {
1250 v = list_entry(rp->view_list.next, struct raw3270_view, list);
1253 spin_unlock_irqrestore(get_ccwdev_lock(cdev), flags);
1254 raw3270_del_view(v);
1255 spin_lock_irqsave(get_ccwdev_lock(cdev), flags);
1257 spin_unlock_irqrestore(get_ccwdev_lock(cdev), flags);
1259 mutex_lock(&raw3270_mutex);
1260 list_for_each_entry(np, &raw3270_notifier, list)
1261 np->destroy(rp->minor);
1262 mutex_unlock(&raw3270_mutex);
1264 /* Reset 3270 device. */
1265 raw3270_reset_device(rp);
1266 /* And finally remove it. */
1267 raw3270_delete_device(rp);
1271 * Set 3270 device offline.
1273 static int raw3270_set_offline(struct ccw_device *cdev)
1277 rp = dev_get_drvdata(&cdev->dev);
1278 if (test_bit(RAW3270_FLAGS_CONSOLE, &rp->flags))
1280 raw3270_remove(cdev);
1284 static struct ccw_device_id raw3270_id[] = {
1285 { CCW_DEVICE(0x3270, 0) },
1286 { CCW_DEVICE(0x3271, 0) },
1287 { CCW_DEVICE(0x3272, 0) },
1288 { CCW_DEVICE(0x3273, 0) },
1289 { CCW_DEVICE(0x3274, 0) },
1290 { CCW_DEVICE(0x3275, 0) },
1291 { CCW_DEVICE(0x3276, 0) },
1292 { CCW_DEVICE(0x3277, 0) },
1293 { CCW_DEVICE(0x3278, 0) },
1294 { CCW_DEVICE(0x3279, 0) },
1295 { CCW_DEVICE(0x3174, 0) },
1296 { /* end of list */ },
1299 static struct ccw_driver raw3270_ccw_driver = {
1302 .owner = THIS_MODULE,
1305 .probe = &raw3270_probe,
1306 .remove = &raw3270_remove,
1307 .set_online = &raw3270_set_online,
1308 .set_offline = &raw3270_set_offline,
1309 .int_class = IRQIO_C70,
1312 static int raw3270_init(void)
1317 if (raw3270_registered)
1319 raw3270_registered = 1;
1320 rc = ccw_driver_register(&raw3270_ccw_driver);
1323 rc = class_register(&class3270);
1326 /* Create attributes for early (= console) device. */
1327 mutex_lock(&raw3270_mutex);
1328 list_for_each_entry(rp, &raw3270_devices, list) {
1329 get_device(&rp->cdev->dev);
1330 raw3270_create_attributes(rp);
1332 mutex_unlock(&raw3270_mutex);
1336 static void raw3270_exit(void)
1338 ccw_driver_unregister(&raw3270_ccw_driver);
1339 class_unregister(&class3270);
1342 MODULE_LICENSE("GPL");
1344 module_init(raw3270_init);
1345 module_exit(raw3270_exit);