linux/drivers/s390/char/sclp.h
<<
>>
Prefs
   1/*
   2 * Copyright IBM Corp. 1999,2012
   3 *
   4 * Author(s): Martin Peschke <mpeschke@de.ibm.com>
   5 *            Martin Schwidefsky <schwidefsky@de.ibm.com>
   6 */
   7
   8#ifndef __SCLP_H__
   9#define __SCLP_H__
  10
  11#include <linux/types.h>
  12#include <linux/list.h>
  13#include <asm/sclp.h>
  14#include <asm/ebcdic.h>
  15
  16/* maximum number of pages concerning our own memory management */
  17#define MAX_KMEM_PAGES (sizeof(unsigned long) << 3)
  18#define SCLP_CONSOLE_PAGES      6
  19
  20#define EVTYP_OPCMD             0x01
  21#define EVTYP_MSG               0x02
  22#define EVTYP_STATECHANGE       0x08
  23#define EVTYP_PMSGCMD           0x09
  24#define EVTYP_CNTLPROGOPCMD     0x20
  25#define EVTYP_CNTLPROGIDENT     0x0B
  26#define EVTYP_SIGQUIESCE        0x1D
  27#define EVTYP_VT220MSG          0x1A
  28#define EVTYP_CONFMGMDATA       0x04
  29#define EVTYP_SDIAS             0x1C
  30#define EVTYP_ASYNC             0x0A
  31#define EVTYP_OCF               0x1E
  32
  33#define EVTYP_OPCMD_MASK        0x80000000
  34#define EVTYP_MSG_MASK          0x40000000
  35#define EVTYP_STATECHANGE_MASK  0x01000000
  36#define EVTYP_PMSGCMD_MASK      0x00800000
  37#define EVTYP_CTLPROGOPCMD_MASK 0x00000001
  38#define EVTYP_CTLPROGIDENT_MASK 0x00200000
  39#define EVTYP_SIGQUIESCE_MASK   0x00000008
  40#define EVTYP_VT220MSG_MASK     0x00000040
  41#define EVTYP_CONFMGMDATA_MASK  0x10000000
  42#define EVTYP_SDIAS_MASK        0x00000010
  43#define EVTYP_ASYNC_MASK        0x00400000
  44#define EVTYP_OCF_MASK          0x00000004
  45
  46#define GNRLMSGFLGS_DOM         0x8000
  47#define GNRLMSGFLGS_SNDALRM     0x4000
  48#define GNRLMSGFLGS_HOLDMSG     0x2000
  49
  50#define LNTPFLGS_CNTLTEXT       0x8000
  51#define LNTPFLGS_LABELTEXT      0x4000
  52#define LNTPFLGS_DATATEXT       0x2000
  53#define LNTPFLGS_ENDTEXT        0x1000
  54#define LNTPFLGS_PROMPTTEXT     0x0800
  55
  56typedef unsigned int sclp_cmdw_t;
  57
  58#define SCLP_CMDW_READ_EVENT_DATA       0x00770005
  59#define SCLP_CMDW_WRITE_EVENT_DATA      0x00760005
  60#define SCLP_CMDW_WRITE_EVENT_MASK      0x00780005
  61
  62#define GDS_ID_MDSMU            0x1310
  63#define GDS_ID_MDSROUTEINFO     0x1311
  64#define GDS_ID_AGUNWRKCORR      0x1549
  65#define GDS_ID_SNACONDREPORT    0x1532
  66#define GDS_ID_CPMSU            0x1212
  67#define GDS_ID_ROUTTARGINSTR    0x154D
  68#define GDS_ID_OPREQ            0x8070
  69#define GDS_ID_TEXTCMD          0x1320
  70
  71#define GDS_KEY_SELFDEFTEXTMSG  0x31
  72
  73enum sclp_pm_event {
  74        SCLP_PM_EVENT_FREEZE,
  75        SCLP_PM_EVENT_THAW,
  76        SCLP_PM_EVENT_RESTORE,
  77};
  78
  79#define SCLP_PANIC_PRIO         1
  80#define SCLP_PANIC_PRIO_CLIENT  0
  81
  82typedef u32 sccb_mask_t;        /* ATTENTION: assumes 32bit mask !!! */
  83
  84struct sccb_header {
  85        u16     length;
  86        u8      function_code;
  87        u8      control_mask[3];
  88        u16     response_code;
  89} __attribute__((packed));
  90
  91struct init_sccb {
  92        struct sccb_header header;
  93        u16 _reserved;
  94        u16 mask_length;
  95        sccb_mask_t receive_mask;
  96        sccb_mask_t send_mask;
  97        sccb_mask_t sclp_receive_mask;
  98        sccb_mask_t sclp_send_mask;
  99} __attribute__((packed));
 100
 101extern u64 sclp_facilities;
 102
 103#define SCLP_HAS_CHP_INFO       (sclp_facilities & 0x8000000000000000ULL)
 104#define SCLP_HAS_CHP_RECONFIG   (sclp_facilities & 0x2000000000000000ULL)
 105#define SCLP_HAS_CPU_INFO       (sclp_facilities & 0x0800000000000000ULL)
 106#define SCLP_HAS_CPU_RECONFIG   (sclp_facilities & 0x0400000000000000ULL)
 107#define SCLP_HAS_PCI_RECONFIG   (sclp_facilities & 0x0000000040000000ULL)
 108
 109
 110struct gds_subvector {
 111        u8      length;
 112        u8      key;
 113} __attribute__((packed));
 114
 115struct gds_vector {
 116        u16     length;
 117        u16     gds_id;
 118} __attribute__((packed));
 119
 120struct evbuf_header {
 121        u16     length;
 122        u8      type;
 123        u8      flags;
 124        u16     _reserved;
 125} __attribute__((packed));
 126
 127struct sclp_req {
 128        struct list_head list;          /* list_head for request queueing. */
 129        sclp_cmdw_t command;            /* sclp command to execute */
 130        void    *sccb;                  /* pointer to the sccb to execute */
 131        char    status;                 /* status of this request */
 132        int     start_count;            /* number of SVCs done for this req */
 133        /* Callback that is called after reaching final status. */
 134        void (*callback)(struct sclp_req *, void *data);
 135        void *callback_data;
 136};
 137
 138#define SCLP_REQ_FILLED   0x00  /* request is ready to be processed */
 139#define SCLP_REQ_QUEUED   0x01  /* request is queued to be processed */
 140#define SCLP_REQ_RUNNING  0x02  /* request is currently running */
 141#define SCLP_REQ_DONE     0x03  /* request is completed successfully */
 142#define SCLP_REQ_FAILED   0x05  /* request is finally failed */
 143
 144/* function pointers that a high level driver has to use for registration */
 145/* of some routines it wants to be called from the low level driver */
 146struct sclp_register {
 147        struct list_head list;
 148        /* User wants to receive: */
 149        sccb_mask_t receive_mask;
 150        /* User wants to send: */
 151        sccb_mask_t send_mask;
 152        /* H/W can receive: */
 153        sccb_mask_t sclp_receive_mask;
 154        /* H/W can send: */
 155        sccb_mask_t sclp_send_mask;
 156        /* called if event type availability changes */
 157        void (*state_change_fn)(struct sclp_register *);
 158        /* called for events in cp_receive_mask/sclp_receive_mask */
 159        void (*receiver_fn)(struct evbuf_header *);
 160        /* called for power management events */
 161        void (*pm_event_fn)(struct sclp_register *, enum sclp_pm_event);
 162        /* pm event posted flag */
 163        int pm_event_posted;
 164};
 165
 166/* externals from sclp.c */
 167int sclp_add_request(struct sclp_req *req);
 168void sclp_sync_wait(void);
 169int sclp_register(struct sclp_register *reg);
 170void sclp_unregister(struct sclp_register *reg);
 171int sclp_remove_processed(struct sccb_header *sccb);
 172int sclp_deactivate(void);
 173int sclp_reactivate(void);
 174int sclp_service_call(sclp_cmdw_t command, void *sccb);
 175int sclp_sync_request(sclp_cmdw_t command, void *sccb);
 176
 177int sclp_sdias_init(void);
 178void sclp_sdias_exit(void);
 179
 180extern int sclp_console_pages;
 181extern int sclp_console_drop;
 182extern unsigned long sclp_console_full;
 183extern u8 sclp_fac84;
 184extern unsigned long long sclp_rzm;
 185extern unsigned long long sclp_rnmax;
 186extern __initdata int sclp_early_read_info_sccb_valid;
 187
 188/* useful inlines */
 189
 190/* VM uses EBCDIC 037, LPAR+native(SE+HMC) use EBCDIC 500 */
 191/* translate single character from ASCII to EBCDIC */
 192static inline unsigned char
 193sclp_ascebc(unsigned char ch)
 194{
 195        return (MACHINE_IS_VM) ? _ascebc[ch] : _ascebc_500[ch];
 196}
 197
 198/* translate string from EBCDIC to ASCII */
 199static inline void
 200sclp_ebcasc_str(unsigned char *str, int nr)
 201{
 202        (MACHINE_IS_VM) ? EBCASC(str, nr) : EBCASC_500(str, nr);
 203}
 204
 205/* translate string from ASCII to EBCDIC */
 206static inline void
 207sclp_ascebc_str(unsigned char *str, int nr)
 208{
 209        (MACHINE_IS_VM) ? ASCEBC(str, nr) : ASCEBC_500(str, nr);
 210}
 211
 212static inline struct gds_vector *
 213sclp_find_gds_vector(void *start, void *end, u16 id)
 214{
 215        struct gds_vector *v;
 216
 217        for (v = start; (void *) v < end; v = (void *) v + v->length)
 218                if (v->gds_id == id)
 219                        return v;
 220        return NULL;
 221}
 222
 223static inline struct gds_subvector *
 224sclp_find_gds_subvector(void *start, void *end, u8 key)
 225{
 226        struct gds_subvector *sv;
 227
 228        for (sv = start; (void *) sv < end; sv = (void *) sv + sv->length)
 229                if (sv->key == key)
 230                        return sv;
 231        return NULL;
 232}
 233
 234#endif   /* __SCLP_H__ */
 235