drivers/s390/char/sclp.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /*
   3  * Copyright IBM Corp. 1999,2012
   4  *
   5  * Author(s): Martin Peschke <mpeschke@de.ibm.com>
   6  *            Martin Schwidefsky <schwidefsky@de.ibm.com>
   7  */
   8
   9 #ifndef __SCLP_H__
  10 #define __SCLP_H__
  11
  12 #include <linux/types.h>
  13 #include <linux/list.h>
  14 #include <asm/asm-extable.h>
  15 #include <asm/sclp.h>
  16 #include <asm/ebcdic.h>
  17 #include <asm/asm.h>
  18
  19 /* maximum number of pages concerning our own memory management */
  20 #define MAX_KMEM_PAGES (sizeof(unsigned long) << 3)
  21 #define SCLP_CONSOLE_PAGES      6
  22
  23 #define SCLP_EVTYP_MASK(T) (1UL << (sizeof(sccb_mask_t) * BITS_PER_BYTE - (T)))
  24
  25 #define EVTYP_OPCMD             0x01
  26 #define EVTYP_MSG               0x02
  27 #define EVTYP_CONFMGMDATA       0x04
  28 #define EVTYP_DIAG_TEST         0x07
  29 #define EVTYP_STATECHANGE       0x08
  30 #define EVTYP_PMSGCMD           0x09
  31 #define EVTYP_ASYNC             0x0A
  32 #define EVTYP_CTLPROGIDENT      0x0B
  33 #define EVTYP_STORE_DATA        0x0C
  34 #define EVTYP_ERRNOTIFY         0x18
  35 #define EVTYP_VT220MSG          0x1A
  36 #define EVTYP_SDIAS             0x1C
  37 #define EVTYP_SIGQUIESCE        0x1D
  38 #define EVTYP_OCF               0x1E
  39
  40 #define EVTYP_OPCMD_MASK        SCLP_EVTYP_MASK(EVTYP_OPCMD)
  41 #define EVTYP_MSG_MASK          SCLP_EVTYP_MASK(EVTYP_MSG)
  42 #define EVTYP_CONFMGMDATA_MASK  SCLP_EVTYP_MASK(EVTYP_CONFMGMDATA)
  43 #define EVTYP_DIAG_TEST_MASK    SCLP_EVTYP_MASK(EVTYP_DIAG_TEST)
  44 #define EVTYP_STATECHANGE_MASK  SCLP_EVTYP_MASK(EVTYP_STATECHANGE)
  45 #define EVTYP_PMSGCMD_MASK      SCLP_EVTYP_MASK(EVTYP_PMSGCMD)
  46 #define EVTYP_ASYNC_MASK        SCLP_EVTYP_MASK(EVTYP_ASYNC)
  47 #define EVTYP_CTLPROGIDENT_MASK SCLP_EVTYP_MASK(EVTYP_CTLPROGIDENT)
  48 #define EVTYP_STORE_DATA_MASK   SCLP_EVTYP_MASK(EVTYP_STORE_DATA)
  49 #define EVTYP_ERRNOTIFY_MASK    SCLP_EVTYP_MASK(EVTYP_ERRNOTIFY)
  50 #define EVTYP_VT220MSG_MASK     SCLP_EVTYP_MASK(EVTYP_VT220MSG)
  51 #define EVTYP_SDIAS_MASK        SCLP_EVTYP_MASK(EVTYP_SDIAS)
  52 #define EVTYP_SIGQUIESCE_MASK   SCLP_EVTYP_MASK(EVTYP_SIGQUIESCE)
  53 #define EVTYP_OCF_MASK          SCLP_EVTYP_MASK(EVTYP_OCF)
  54
  55 #define GNRLMSGFLGS_DOM         0x8000
  56 #define GNRLMSGFLGS_SNDALRM     0x4000
  57 #define GNRLMSGFLGS_HOLDMSG     0x2000
  58
  59 #define LNTPFLGS_CNTLTEXT       0x8000
  60 #define LNTPFLGS_LABELTEXT      0x4000
  61 #define LNTPFLGS_DATATEXT       0x2000
  62 #define LNTPFLGS_ENDTEXT        0x1000
  63 #define LNTPFLGS_PROMPTTEXT     0x0800
  64
  65 typedef unsigned int sclp_cmdw_t;
  66
  67 #define SCLP_CMDW_READ_CPU_INFO         0x00010001
  68 #define SCLP_CMDW_READ_SCP_INFO         0x00020001
  69 #define SCLP_CMDW_READ_STORAGE_INFO     0x00040001
  70 #define SCLP_CMDW_READ_SCP_INFO_FORCED  0x00120001
  71 #define SCLP_CMDW_READ_EVENT_DATA       0x00770005
  72 #define SCLP_CMDW_WRITE_EVENT_DATA      0x00760005
  73 #define SCLP_CMDW_WRITE_EVENT_MASK      0x00780005
  74
  75 #define GDS_ID_MDSMU            0x1310
  76 #define GDS_ID_MDSROUTEINFO     0x1311
  77 #define GDS_ID_AGUNWRKCORR      0x1549
  78 #define GDS_ID_SNACONDREPORT    0x1532
  79 #define GDS_ID_CPMSU            0x1212
  80 #define GDS_ID_ROUTTARGINSTR    0x154D
  81 #define GDS_ID_OPREQ            0x8070
  82 #define GDS_ID_TEXTCMD          0x1320
  83
  84 #define GDS_KEY_SELFDEFTEXTMSG  0x31
  85
  86 typedef u64 sccb_mask_t;
  87
  88 struct sccb_header {
  89         u16     length;
  90         u8      function_code;
  91         u8      control_mask[3];
  92         u16     response_code;
  93 } __attribute__((packed));
  94
  95 struct init_sccb {
  96         struct sccb_header header;
  97         u16 _reserved;
  98         u16 mask_length;
  99         u8 masks[4 * 1021];     /* variable length */
 100         /*
 101          * u8 receive_mask[mask_length];
 102          * u8 send_mask[mask_length];
 103          * u8 sclp_receive_mask[mask_length];
 104          * u8 sclp_send_mask[mask_length];
 105          */
 106 } __attribute__((packed));
 107
 108 #define SCLP_MASK_SIZE_COMPAT 4
 109
 110 static inline sccb_mask_t sccb_get_mask(u8 *masks, size_t len, int i)
 111 {
 112         sccb_mask_t res = 0;
 113
 114         memcpy(&res, masks + i * len, min(sizeof(res), len));
 115         return res;
 116 }
 117
 118 static inline void sccb_set_mask(u8 *masks, size_t len, int i, sccb_mask_t val)
 119 {
 120         memset(masks + i * len, 0, len);
 121         memcpy(masks + i * len, &val, min(sizeof(val), len));
 122 }
 123
 124 #define sccb_get_generic_mask(sccb, i)                                  \
 125 ({                                                                      \
 126         __typeof__(sccb) __sccb = sccb;                                 \
 127                                                                         \
 128         sccb_get_mask(__sccb->masks, __sccb->mask_length, i);           \
 129 })
 130 #define sccb_get_recv_mask(sccb)        sccb_get_generic_mask(sccb, 0)
 131 #define sccb_get_send_mask(sccb)        sccb_get_generic_mask(sccb, 1)
 132 #define sccb_get_sclp_recv_mask(sccb)   sccb_get_generic_mask(sccb, 2)
 133 #define sccb_get_sclp_send_mask(sccb)   sccb_get_generic_mask(sccb, 3)
 134
 135 #define sccb_set_generic_mask(sccb, i, val)                             \
 136 ({                                                                      \
 137         __typeof__(sccb) __sccb = sccb;                                 \
 138                                                                         \
 139         sccb_set_mask(__sccb->masks, __sccb->mask_length, i, val);      \
 140 })
 141 #define sccb_set_recv_mask(sccb, val)       sccb_set_generic_mask(sccb, 0, val)
 142 #define sccb_set_send_mask(sccb, val)       sccb_set_generic_mask(sccb, 1, val)
 143 #define sccb_set_sclp_recv_mask(sccb, val)  sccb_set_generic_mask(sccb, 2, val)
 144 #define sccb_set_sclp_send_mask(sccb, val)  sccb_set_generic_mask(sccb, 3, val)
 145
 146 struct read_cpu_info_sccb {
 147         struct  sccb_header header;
 148         u16     nr_configured;
 149         u16     offset_configured;
 150         u16     nr_standby;
 151         u16     offset_standby;
 152         /*
 153          * Without ext sccb, struct size is PAGE_SIZE.
 154          * With ext sccb, struct size is EXT_SCCB_READ_CPU.
 155          */
 156         u8      reserved[];
 157 } __attribute__((packed, aligned(PAGE_SIZE)));
 158
 159 struct read_info_sccb {
 160         struct  sccb_header header;     /* 0-7 */
 161         u16     rnmax;                  /* 8-9 */
 162         u8      rnsize;                 /* 10 */
 163         u8      _pad_11[16 - 11];       /* 11-15 */
 164         u16     ncpurl;                 /* 16-17 */
 165         u16     cpuoff;                 /* 18-19 */
 166         u8      _pad_20[24 - 20];       /* 20-23 */
 167         u8      loadparm[8];            /* 24-31 */
 168         u8      _pad_32[42 - 32];       /* 32-41 */
 169         u8      fac42;                  /* 42 */
 170         u8      fac43;                  /* 43 */
 171         u8      _pad_44[48 - 44];       /* 44-47 */
 172         u64     facilities;             /* 48-55 */
 173         u8      _pad_56[66 - 56];       /* 56-65 */
 174         u8      fac66;                  /* 66 */
 175         u8      _pad_67[76 - 67];       /* 67-83 */
 176         u32     ibc;                    /* 76-79 */
 177         u8      _pad80[84 - 80];        /* 80-83 */
 178         u8      fac84;                  /* 84 */
 179         u8      fac85;                  /* 85 */
 180         u8      _pad_86[91 - 86];       /* 86-90 */
 181         u8      fac91;                  /* 91 */
 182         u8      _pad_92[98 - 92];       /* 92-97 */
 183         u8      fac98;                  /* 98 */
 184         u8      hamaxpow;               /* 99 */
 185         u32     rnsize2;                /* 100-103 */
 186         u64     rnmax2;                 /* 104-111 */
 187         u32     hsa_size;               /* 112-115 */
 188         u8      fac116;                 /* 116 */
 189         u8      fac117;                 /* 117 */
 190         u8      fac118;                 /* 118 */
 191         u8      fac119;                 /* 119 */
 192         u16     hcpua;                  /* 120-121 */
 193         u8      _pad_122[124 - 122];    /* 122-123 */
 194         u32     hmfai;                  /* 124-127 */
 195         u8      _pad_128[134 - 128];    /* 128-133 */
 196         u8      byte_134;                       /* 134 */
 197         u8      cpudirq;                /* 135 */
 198         u16     cbl;                    /* 136-137 */
 199         u8      _pad_138[EXT_SCCB_READ_SCP - 138];
 200 } __packed __aligned(PAGE_SIZE);
 201
 202 struct read_storage_sccb {
 203         struct sccb_header header;
 204         u16 max_id;
 205         u16 assigned;
 206         u16 standby;
 207         u16 :16;
 208         u32 entries[];
 209 } __packed;
 210
 211 static inline void sclp_fill_core_info(struct sclp_core_info *info,
 212                                        struct read_cpu_info_sccb *sccb)
 213 {
 214         char *page = (char *) sccb;
 215
 216         memset(info, 0, sizeof(*info));
 217         info->configured = sccb->nr_configured;
 218         info->standby = sccb->nr_standby;
 219         info->combined = sccb->nr_configured + sccb->nr_standby;
 220         memcpy(&info->core, page + sccb->offset_configured,
 221                info->combined * sizeof(struct sclp_core_entry));
 222 }
 223
 224 #define SCLP_HAS_CHP_INFO       (sclp.facilities & 0x8000000000000000ULL)
 225 #define SCLP_HAS_CHP_RECONFIG   (sclp.facilities & 0x2000000000000000ULL)
 226 #define SCLP_HAS_CPU_INFO       (sclp.facilities & 0x0800000000000000ULL)
 227 #define SCLP_HAS_CPU_RECONFIG   (sclp.facilities & 0x0400000000000000ULL)
 228 #define SCLP_HAS_PCI_RECONFIG   (sclp.facilities & 0x0000000040000000ULL)
 229 #define SCLP_HAS_AP_RECONFIG    (sclp.facilities & 0x0000000100000000ULL)
 230
 231 struct gds_subvector {
 232         u8      length;
 233         u8      key;
 234 } __attribute__((packed));
 235
 236 struct gds_vector {
 237         u16     length;
 238         u16     gds_id;
 239 } __attribute__((packed));
 240
 241 struct evbuf_header {
 242         u16     length;
 243         u8      type;
 244         u8      flags;
 245         u16     _reserved;
 246 } __attribute__((packed));
 247
 248 struct sclp_req {
 249         struct list_head list;          /* list_head for request queueing. */
 250         sclp_cmdw_t command;            /* sclp command to execute */
 251         void    *sccb;                  /* pointer to the sccb to execute */
 252         char    status;                 /* status of this request */
 253         int     start_count;            /* number of SVCs done for this req */
 254         /* Callback that is called after reaching final status. */
 255         void (*callback)(struct sclp_req *, void *data);
 256         void *callback_data;
 257         int queue_timeout;              /* request queue timeout (sec), set by
 258                                            caller of sclp_add_request(), if
 259                                            needed */
 260         /* Internal fields */
 261         unsigned long queue_expires;    /* request queue timeout (jiffies) */
 262 };
 263
 264 #define SCLP_REQ_FILLED   0x00  /* request is ready to be processed */
 265 #define SCLP_REQ_QUEUED   0x01  /* request is queued to be processed */
 266 #define SCLP_REQ_RUNNING  0x02  /* request is currently running */
 267 #define SCLP_REQ_DONE     0x03  /* request is completed successfully */
 268 #define SCLP_REQ_FAILED   0x05  /* request is finally failed */
 269 #define SCLP_REQ_QUEUED_TIMEOUT 0x06    /* request on queue timed out */
 270
 271 #define SCLP_QUEUE_INTERVAL 5   /* timeout interval for request queue */
 272
 273 /* function pointers that a high level driver has to use for registration */
 274 /* of some routines it wants to be called from the low level driver */
 275 struct sclp_register {
 276         struct list_head list;
 277         /* User wants to receive: */
 278         sccb_mask_t receive_mask;
 279         /* User wants to send: */
 280         sccb_mask_t send_mask;
 281         /* H/W can receive: */
 282         sccb_mask_t sclp_receive_mask;
 283         /* H/W can send: */
 284         sccb_mask_t sclp_send_mask;
 285         /* called if event type availability changes */
 286         void (*state_change_fn)(struct sclp_register *);
 287         /* called for events in cp_receive_mask/sclp_receive_mask */
 288         void (*receiver_fn)(struct evbuf_header *);
 289 };
 290
 291 /* externals from sclp.c */
 292 int sclp_add_request(struct sclp_req *req);
 293 void sclp_sync_wait(void);
 294 int sclp_register(struct sclp_register *reg);
 295 void sclp_unregister(struct sclp_register *reg);
 296 int sclp_remove_processed(struct sccb_header *sccb);
 297 int sclp_deactivate(void);
 298 int sclp_reactivate(void);
 299 int sclp_sync_request(sclp_cmdw_t command, void *sccb);
 300 int sclp_sync_request_timeout(sclp_cmdw_t command, void *sccb, int timeout);
 301 int sclp_sdias_init(void);
 302
 303 enum {
 304         sclp_init_state_uninitialized,
 305         sclp_init_state_initializing,
 306         sclp_init_state_initialized
 307 };
 308
 309 extern int sclp_init_state;
 310 extern int sclp_console_pages;
 311 extern bool sclp_console_drop;
 312 extern unsigned long sclp_console_full;
 313 extern bool sclp_mask_compat_mode;
 314
 315 void sclp_early_wait_irq(void);
 316 int sclp_early_cmd(sclp_cmdw_t cmd, void *sccb);
 317 unsigned int sclp_early_con_check_linemode(struct init_sccb *sccb);
 318 unsigned int sclp_early_con_check_vt220(struct init_sccb *sccb);
 319 int sclp_early_set_event_mask(struct init_sccb *sccb,
 320                               sccb_mask_t receive_mask,
 321                               sccb_mask_t send_mask);
 322 struct read_info_sccb * __init sclp_early_get_info(void);
 323
 324 /* useful inlines */
 325
 326 /* Perform service call. Return 0 on success, non-zero otherwise. */
 327 static inline int sclp_service_call(sclp_cmdw_t command, void *sccb)
 328 {
 329         int cc, exception;
 330
 331         exception = 1;
 332         asm volatile(
 333                 "0:     .insn   rre,0xb2200000,%[cmd],%[sccb]\n" /* servc */
 334                 "1:     lhi     %[exc],0\n"
 335                 "2:\n"
 336                 CC_IPM(cc)
 337                 EX_TABLE(0b, 2b)
 338                 EX_TABLE(1b, 2b)
 339                 : CC_OUT(cc, cc), [exc] "+d" (exception)
 340                 : [cmd] "d" (command), [sccb] "a" (__pa(sccb))
 341                 : CC_CLOBBER_LIST("memory"));
 342         if (exception)
 343                 return -EINVAL;
 344         cc = CC_TRANSFORM(cc);
 345         if (cc == 3)
 346                 return -EIO;
 347         if (cc == 2)
 348                 return -EBUSY;
 349         return 0;
 350 }
 351
 352 /* VM uses EBCDIC 037, LPAR+native(SE+HMC) use EBCDIC 500 */
 353 /* translate single character from ASCII to EBCDIC */
 354 static inline unsigned char
 355 sclp_ascebc(unsigned char ch)
 356 {
 357         return (MACHINE_IS_VM) ? _ascebc[ch] : _ascebc_500[ch];
 358 }
 359
 360 /* translate string from EBCDIC to ASCII */
 361 static inline void
 362 sclp_ebcasc_str(char *str, int nr)
 363 {
 364         (MACHINE_IS_VM) ? EBCASC(str, nr) : EBCASC_500(str, nr);
 365 }
 366
 367 /* translate string from ASCII to EBCDIC */
 368 static inline void
 369 sclp_ascebc_str(char *str, int nr)
 370 {
 371         (MACHINE_IS_VM) ? ASCEBC(str, nr) : ASCEBC_500(str, nr);
 372 }
 373
 374 static inline struct gds_vector *
 375 sclp_find_gds_vector(void *start, void *end, u16 id)
 376 {
 377         struct gds_vector *v;
 378
 379         for (v = start; (void *) v < end; v = (void *) v + v->length)
 380                 if (v->gds_id == id)
 381                         return v;
 382         return NULL;
 383 }
 384
 385 static inline struct gds_subvector *
 386 sclp_find_gds_subvector(void *start, void *end, u8 key)
 387 {
 388         struct gds_subvector *sv;
 389
 390         for (sv = start; (void *) sv < end; sv = (void *) sv + sv->length)
 391                 if (sv->key == key)
 392                         return sv;
 393         return NULL;
 394 }
 395
 396 #endif   /* __SCLP_H__ */