drivers/s390/char/sclp.h

   1 /*
   2  *  drivers/s390/char/sclp.h
   3  *
   4  *  S390 version
   5  *    Copyright (C) 1999 IBM Deutschland Entwicklung GmbH, IBM Corporation
   6  *    Author(s): Martin Peschke <mpeschke@de.ibm.com>
   7  *               Martin Schwidefsky <schwidefsky@de.ibm.com>
   8  */
   9
  10 #ifndef __SCLP_H__
  11 #define __SCLP_H__
  12
  13 #include <linux/types.h>
  14 #include <linux/list.h>
  15
  16 #include <asm/ebcdic.h>
  17
  18 /* maximum number of pages concerning our own memory management */
  19 #define MAX_KMEM_PAGES (sizeof(unsigned long) << 3)
  20 #define MAX_CONSOLE_PAGES       4
  21
  22 #define EvTyp_OpCmd             0x01
  23 #define EvTyp_Msg               0x02
  24 #define EvTyp_StateChange       0x08
  25 #define EvTyp_PMsgCmd           0x09
  26 #define EvTyp_CntlProgOpCmd     0x20
  27 #define EvTyp_CntlProgIdent     0x0B
  28 #define EvTyp_SigQuiesce        0x1D
  29 #define EvTyp_VT220Msg          0x1A
  30
  31 #define EvTyp_OpCmd_Mask        0x80000000
  32 #define EvTyp_Msg_Mask          0x40000000
  33 #define EvTyp_StateChange_Mask  0x01000000
  34 #define EvTyp_PMsgCmd_Mask      0x00800000
  35 #define EvTyp_CtlProgOpCmd_Mask 0x00000001
  36 #define EvTyp_CtlProgIdent_Mask 0x00200000
  37 #define EvTyp_SigQuiesce_Mask   0x00000008
  38 #define EvTyp_VT220Msg_Mask     0x00000040
  39
  40 #define GnrlMsgFlgs_DOM         0x8000
  41 #define GnrlMsgFlgs_SndAlrm     0x4000
  42 #define GnrlMsgFlgs_HoldMsg     0x2000
  43
  44 #define LnTpFlgs_CntlText       0x8000
  45 #define LnTpFlgs_LabelText      0x4000
  46 #define LnTpFlgs_DataText       0x2000
  47 #define LnTpFlgs_EndText        0x1000
  48 #define LnTpFlgs_PromptText     0x0800
  49
  50 typedef unsigned int sclp_cmdw_t;
  51
  52 #define SCLP_CMDW_READDATA      0x00770005
  53 #define SCLP_CMDW_WRITEDATA     0x00760005
  54 #define SCLP_CMDW_WRITEMASK     0x00780005
  55
  56 #define GDS_ID_MDSMU            0x1310
  57 #define GDS_ID_MDSRouteInfo     0x1311
  58 #define GDS_ID_AgUnWrkCorr      0x1549
  59 #define GDS_ID_SNACondReport    0x1532
  60 #define GDS_ID_CPMSU            0x1212
  61 #define GDS_ID_RoutTargInstr    0x154D
  62 #define GDS_ID_OpReq            0x8070
  63 #define GDS_ID_TextCmd          0x1320
  64
  65 #define GDS_KEY_SelfDefTextMsg  0x31
  66
  67 typedef u32 sccb_mask_t;        /* ATTENTION: assumes 32bit mask !!! */
  68
  69 struct sccb_header {
  70         u16     length;
  71         u8      function_code;
  72         u8      control_mask[3];
  73         u16     response_code;
  74 } __attribute__((packed));
  75
  76 struct gds_subvector {
  77         u8      length;
  78         u8      key;
  79 } __attribute__((packed));
  80
  81 struct gds_vector {
  82         u16     length;
  83         u16     gds_id;
  84 } __attribute__((packed));
  85
  86 struct evbuf_header {
  87         u16     length;
  88         u8      type;
  89         u8      flags;
  90         u16     _reserved;
  91 } __attribute__((packed));
  92
  93 struct sclp_req {
  94         struct list_head list;          /* list_head for request queueing. */
  95         sclp_cmdw_t command;            /* sclp command to execute */
  96         void    *sccb;                  /* pointer to the sccb to execute */
  97         char    status;                 /* status of this request */
  98         /* Callback that is called after reaching final status. */
  99         void (*callback)(struct sclp_req *, void *data);
 100         void *callback_data;
 101 };
 102
 103 #define SCLP_REQ_FILLED   0x00  /* request is ready to be processed */
 104 #define SCLP_REQ_QUEUED   0x01  /* request is queued to be processed */
 105 #define SCLP_REQ_RUNNING  0x02  /* request is currently running */
 106 #define SCLP_REQ_DONE     0x03  /* request is completed successfully */
 107 #define SCLP_REQ_FAILED   0x05  /* request is finally failed */
 108
 109 /* function pointers that a high level driver has to use for registration */
 110 /* of some routines it wants to be called from the low level driver */
 111 struct sclp_register {
 112         struct list_head list;
 113         /* event masks this user is registered for */
 114         sccb_mask_t receive_mask;
 115         sccb_mask_t send_mask;
 116         /* actually present events */
 117         sccb_mask_t sclp_receive_mask;
 118         sccb_mask_t sclp_send_mask;
 119         /* called if event type availability changes */
 120         void (*state_change_fn)(struct sclp_register *);
 121         /* called for events in cp_receive_mask/sclp_receive_mask */
 122         void (*receiver_fn)(struct evbuf_header *);
 123 };
 124
 125 /* externals from sclp.c */
 126 void sclp_add_request(struct sclp_req *req);
 127 void sclp_sync_wait(void);
 128 int sclp_register(struct sclp_register *reg);
 129 void sclp_unregister(struct sclp_register *reg);
 130 char *sclp_error_message(u16 response_code);
 131 int sclp_remove_processed(struct sccb_header *sccb);
 132
 133 /* useful inlines */
 134
 135 /* VM uses EBCDIC 037, LPAR+native(SE+HMC) use EBCDIC 500 */
 136 /* translate single character from ASCII to EBCDIC */
 137 static inline unsigned char
 138 sclp_ascebc(unsigned char ch)
 139 {
 140         return (MACHINE_IS_VM) ? _ascebc[ch] : _ascebc_500[ch];
 141 }
 142
 143 /* translate string from EBCDIC to ASCII */
 144 static inline void
 145 sclp_ebcasc_str(unsigned char *str, int nr)
 146 {
 147         (MACHINE_IS_VM) ? EBCASC(str, nr) : EBCASC_500(str, nr);
 148 }
 149
 150 /* translate string from ASCII to EBCDIC */
 151 static inline void
 152 sclp_ascebc_str(unsigned char *str, int nr)
 153 {
 154         (MACHINE_IS_VM) ? ASCEBC(str, nr) : ASCEBC_500(str, nr);
 155 }
 156
 157 #endif   /* __SCLP_H__ */