drivers/s390/char/raw3270.h

   1 /*
   2  *  drivers/s390/char/raw3270.h
   3  *    IBM/3270 Driver
   4  *
   5  *  Author(s):
   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 (C) 2003 IBM Deutschland Entwicklung GmbH, IBM Corporation
   9  */
  10
  11 #include <asm/idals.h>
  12 #include <asm/ioctl.h>
  13
  14 /* ioctls for fullscreen 3270 */
  15 #define TUBICMD         _IO('3', 3)     /* set ccw command for fs reads. */
  16 #define TUBOCMD         _IO('3', 4)     /* set ccw command for fs writes. */
  17 #define TUBGETI         _IO('3', 7)     /* get ccw command for fs reads. */
  18 #define TUBGETO         _IO('3', 8)     /* get ccw command for fs writes. */
  19 #define TUBSETMOD       _IO('3',12)     /* FIXME: what does it do ?*/
  20 #define TUBGETMOD       _IO('3',13)     /* FIXME: what does it do ?*/
  21
  22 /* Local Channel Commands */
  23 #define TC_WRITE        0x01            /* Write */
  24 #define TC_EWRITE       0x05            /* Erase write */
  25 #define TC_READMOD      0x06            /* Read modified */
  26 #define TC_EWRITEA      0x0d            /* Erase write alternate */
  27 #define TC_WRITESF      0x11            /* Write structured field */
  28
  29 /* Buffer Control Orders */
  30 #define TO_SF           0x1d            /* Start field */
  31 #define TO_SBA          0x11            /* Set buffer address */
  32 #define TO_IC           0x13            /* Insert cursor */
  33 #define TO_PT           0x05            /* Program tab */
  34 #define TO_RA           0x3c            /* Repeat to address */
  35 #define TO_SFE          0x29            /* Start field extended */
  36 #define TO_EUA          0x12            /* Erase unprotected to address */
  37 #define TO_MF           0x2c            /* Modify field */
  38 #define TO_SA           0x28            /* Set attribute */
  39
  40 /* Field Attribute Bytes */
  41 #define TF_INPUT        0x40            /* Visible input */
  42 #define TF_INPUTN       0x4c            /* Invisible input */
  43 #define TF_INMDT        0xc1            /* Visible, Set-MDT */
  44 #define TF_LOG          0x60
  45
  46 /* Character Attribute Bytes */
  47 #define TAT_RESET       0x00
  48 #define TAT_FIELD       0xc0
  49 #define TAT_EXTHI       0x41
  50 #define TAT_COLOR       0x42
  51 #define TAT_CHARS       0x43
  52 #define TAT_TRANS       0x46
  53
  54 /* Extended-Highlighting Bytes */
  55 #define TAX_RESET       0x00
  56 #define TAX_BLINK       0xf1
  57 #define TAX_REVER       0xf2
  58 #define TAX_UNDER       0xf4
  59
  60 /* Reset value */
  61 #define TAR_RESET       0x00
  62
  63 /* Color values */
  64 #define TAC_RESET       0x00
  65 #define TAC_BLUE        0xf1
  66 #define TAC_RED         0xf2
  67 #define TAC_PINK        0xf3
  68 #define TAC_GREEN       0xf4
  69 #define TAC_TURQ        0xf5
  70 #define TAC_YELLOW      0xf6
  71 #define TAC_WHITE       0xf7
  72 #define TAC_DEFAULT     0x00
  73
  74 /* Write Control Characters */
  75 #define TW_NONE         0x40            /* No particular action */
  76 #define TW_KR           0xc2            /* Keyboard restore */
  77 #define TW_PLUSALARM    0x04            /* Add this bit for alarm */
  78
  79 #define RAW3270_MAXDEVS 256
  80
  81 int raw3270_init(void);
  82 void raw3270_exit(void);
  83
  84 /* For TUBGETMOD and TUBSETMOD. Should include. */
  85 struct raw3270_iocb {
  86         short model;
  87         short line_cnt;
  88         short col_cnt;
  89         short pf_cnt;
  90         short re_cnt;
  91         short map;
  92 };
  93
  94 struct raw3270;
  95 struct raw3270_view;
  96
  97 /* 3270 CCW request */
  98 struct raw3270_request {
  99         struct list_head list;          /* list head for request queueing. */
 100         struct raw3270_view *view;      /* view of this request */
 101         struct ccw1 ccw;                /* single ccw. */
 102         void *buffer;                   /* output buffer. */
 103         size_t size;                    /* size of output buffer. */
 104         int rescnt;                     /* residual count from devstat. */
 105         int rc;                         /* return code for this request. */
 106
 107         /* Callback for delivering final status. */
 108         void (*callback)(struct raw3270_request *, void *);
 109         void *callback_data;
 110 };
 111
 112 struct raw3270_request *raw3270_request_alloc(size_t size);
 113 struct raw3270_request *raw3270_request_alloc_bootmem(size_t size);
 114 void raw3270_request_free(struct raw3270_request *);
 115 void raw3270_request_reset(struct raw3270_request *);
 116 void raw3270_request_set_cmd(struct raw3270_request *, u8 cmd);
 117 int  raw3270_request_add_data(struct raw3270_request *, void *, size_t);
 118 void raw3270_request_set_data(struct raw3270_request *, void *, size_t);
 119 void raw3270_request_set_idal(struct raw3270_request *, struct idal_buffer *);
 120
 121 static inline int
 122 raw3270_request_final(struct raw3270_request *rq)
 123 {
 124         return list_empty(&rq->list);
 125 }
 126
 127 void raw3270_buffer_address(struct raw3270 *, char *, unsigned short);
 128
 129 /* Return value of *intv (see raw3270_fn below) can be one of the following: */
 130 #define RAW3270_IO_DONE         0       /* request finished */
 131 #define RAW3270_IO_BUSY         1       /* request still active */
 132 #define RAW3270_IO_RETRY        2       /* retry current request */
 133 #define RAW3270_IO_STOP         3       /* kill current request */
 134
 135 /*
 136  * Functions of a 3270 view.
 137  */
 138 struct raw3270_fn {
 139         int  (*activate)(struct raw3270_view *);
 140         void (*deactivate)(struct raw3270_view *);
 141         int  (*intv)(struct raw3270_view *,
 142                      struct raw3270_request *, struct irb *);
 143         void (*release)(struct raw3270_view *);
 144         void (*free)(struct raw3270_view *);
 145 };
 146
 147 /*
 148  * View structure chaining. The raw3270_view structure is meant to
 149  * be embedded at the start of the real view data structure, e.g.:
 150  *   struct example {
 151  *     struct raw3270_view view;
 152  *     ...
 153  *   };
 154  */
 155 struct raw3270_view {
 156         struct list_head list;
 157         spinlock_t lock;
 158         atomic_t ref_count;
 159         struct raw3270 *dev;
 160         struct raw3270_fn *fn;
 161         unsigned int model;
 162         unsigned int rows, cols;        /* # of rows & colums of the view */
 163         unsigned char *ascebc;          /* ascii -> ebcdic table */
 164 };
 165
 166 int raw3270_add_view(struct raw3270_view *, struct raw3270_fn *, int);
 167 int raw3270_activate_view(struct raw3270_view *);
 168 void raw3270_del_view(struct raw3270_view *);
 169 void raw3270_deactivate_view(struct raw3270_view *);
 170 struct raw3270_view *raw3270_find_view(struct raw3270_fn *, int);
 171 int raw3270_start(struct raw3270_view *, struct raw3270_request *);
 172 int raw3270_start_irq(struct raw3270_view *, struct raw3270_request *);
 173
 174 /* Reference count inliner for view structures. */
 175 static inline void
 176 raw3270_get_view(struct raw3270_view *view)
 177 {
 178         atomic_inc(&view->ref_count);
 179 }
 180
 181 extern wait_queue_head_t raw3270_wait_queue;
 182
 183 static inline void
 184 raw3270_put_view(struct raw3270_view *view)
 185 {
 186         if (atomic_dec_return(&view->ref_count) == 0)
 187                 wake_up(&raw3270_wait_queue);
 188 }
 189
 190 struct raw3270 *raw3270_setup_console(struct ccw_device *cdev);
 191 void raw3270_wait_cons_dev(struct raw3270 *);
 192
 193 /*
 194  * Little memory allocator for string objects.
 195  */
 196 struct string
 197 {
 198         struct list_head list;
 199         struct list_head update;
 200         unsigned long size;
 201         unsigned long len;
 202         char string[0];
 203 } __attribute__ ((aligned(8)));
 204
 205 static inline struct string *
 206 alloc_string(struct list_head *free_list, unsigned long len)
 207 {
 208         struct string *cs, *tmp;
 209         unsigned long size;
 210
 211         size = (len + 7L) & -8L;
 212         list_for_each_entry(cs, free_list, list) {
 213                 if (cs->size < size)
 214                         continue;
 215                 if (cs->size > size + sizeof(struct string)) {
 216                         char *endaddr = (char *) (cs + 1) + cs->size;
 217                         tmp = (struct string *) (endaddr - size) - 1;
 218                         tmp->size = size;
 219                         cs->size -= size + sizeof(struct string);
 220                         cs = tmp;
 221                 } else
 222                         list_del(&cs->list);
 223                 cs->len = len;
 224                 INIT_LIST_HEAD(&cs->list);
 225                 INIT_LIST_HEAD(&cs->update);
 226                 return cs;
 227         }
 228         return 0;
 229 }
 230
 231 static inline unsigned long
 232 free_string(struct list_head *free_list, struct string *cs)
 233 {
 234         struct string *tmp;
 235         struct list_head *p, *left;
 236
 237         /* Find out the left neighbour in free memory list. */
 238         left = free_list;
 239         list_for_each(p, free_list) {
 240                 if (list_entry(p, struct string, list) > cs)
 241                         break;
 242                 left = p;
 243         }
 244         /* Try to merge with right neighbour = next element from left. */
 245         if (left->next != free_list) {
 246                 tmp = list_entry(left->next, struct string, list);
 247                 if ((char *) (cs + 1) + cs->size == (char *) tmp) {
 248                         list_del(&tmp->list);
 249                         cs->size += tmp->size + sizeof(struct string);
 250                 }
 251         }
 252         /* Try to merge with left neighbour. */
 253         if (left != free_list) {
 254                 tmp = list_entry(left, struct string, list);
 255                 if ((char *) (tmp + 1) + tmp->size == (char *) cs) {
 256                         tmp->size += cs->size + sizeof(struct string);
 257                         return tmp->size;
 258                 }
 259         }
 260         __list_add(&cs->list, left, left->next);
 261         return cs->size;
 262 }
 263
 264 static inline void
 265 add_string_memory(struct list_head *free_list, void *mem, unsigned long size)
 266 {
 267         struct string *cs;
 268
 269         cs = (struct string *) mem;
 270         cs->size = size - sizeof(struct string);
 271         free_string(free_list, cs);
 272 }
 273