hw/s390x/ipl.h

   1 /*
   2  * s390 IPL device
   3  *
   4  * Copyright 2015 IBM Corp.
   5  * Author(s): Zhang Fan <[email protected]>
   6  *
   7  * This work is licensed under the terms of the GNU GPL, version 2 or (at
   8  * your option) any later version. See the COPYING file in the top-level
   9  * directory.
  10  */
  11
  12 #ifndef HW_S390_IPL_H
  13 #define HW_S390_IPL_H
  14
  15 #include "hw/qdev.h"
  16 #include "cpu.h"
  17
  18 struct IplBlockCcw {
  19     uint8_t  reserved0[85];
  20     uint8_t  ssid;
  21     uint16_t devno;
  22     uint8_t  vm_flags;
  23     uint8_t  reserved3[3];
  24     uint32_t vm_parm_len;
  25     uint8_t  nss_name[8];
  26     uint8_t  vm_parm[64];
  27     uint8_t  reserved4[8];
  28 } QEMU_PACKED;
  29 typedef struct IplBlockCcw IplBlockCcw;
  30
  31 struct IplBlockFcp {
  32     uint8_t  reserved1[305 - 1];
  33     uint8_t  opt;
  34     uint8_t  reserved2[3];
  35     uint16_t reserved3;
  36     uint16_t devno;
  37     uint8_t  reserved4[4];
  38     uint64_t wwpn;
  39     uint64_t lun;
  40     uint32_t bootprog;
  41     uint8_t  reserved5[12];
  42     uint64_t br_lba;
  43     uint32_t scp_data_len;
  44     uint8_t  reserved6[260];
  45     uint8_t  scp_data[];
  46 } QEMU_PACKED;
  47 typedef struct IplBlockFcp IplBlockFcp;
  48
  49 struct IplBlockQemuScsi {
  50     uint32_t lun;
  51     uint16_t target;
  52     uint16_t channel;
  53     uint8_t  reserved0[77];
  54     uint8_t  ssid;
  55     uint16_t devno;
  56 } QEMU_PACKED;
  57 typedef struct IplBlockQemuScsi IplBlockQemuScsi;
  58
  59 #define DIAG308_FLAGS_LP_VALID 0x80
  60
  61 union IplParameterBlock {
  62     struct {
  63         uint32_t len;
  64         uint8_t  reserved0[3];
  65         uint8_t  version;
  66         uint32_t blk0_len;
  67         uint8_t  pbt;
  68         uint8_t  flags;
  69         uint16_t reserved01;
  70         uint8_t  loadparm[8];
  71         union {
  72             IplBlockCcw ccw;
  73             IplBlockFcp fcp;
  74             IplBlockQemuScsi scsi;
  75         };
  76     } QEMU_PACKED;
  77     struct {
  78         uint8_t  reserved1[110];
  79         uint16_t devno;
  80         uint8_t  reserved2[88];
  81         uint8_t  reserved_ext[4096 - 200];
  82     } QEMU_PACKED;
  83 } QEMU_PACKED;
  84 typedef union IplParameterBlock IplParameterBlock;
  85
  86 int s390_ipl_set_loadparm(uint8_t *loadparm);
  87 void s390_ipl_update_diag308(IplParameterBlock *iplb);
  88 void s390_ipl_prepare_cpu(S390CPU *cpu);
  89 IplParameterBlock *s390_ipl_get_iplb(void);
  90 void s390_reipl_request(void);
  91
  92 #define QIPL_ADDRESS  0xcc
  93
  94 /* Boot Menu flags */
  95 #define QIPL_FLAG_BM_OPTS_CMD   0x80
  96 #define QIPL_FLAG_BM_OPTS_ZIPL  0x40
  97
  98 /*
  99  * The QEMU IPL Parameters will be stored at absolute address
 100  * 204 (0xcc) which means it is 32-bit word aligned but not
 101  * double-word aligned.
 102  * Placement of data fields in this area must account for
 103  * their alignment needs. E.g., netboot_start_address must
 104  * have an offset of 4 + n * 8 bytes within the struct in order
 105  * to keep it double-word aligned.
 106  * The total size of the struct must never exceed 28 bytes.
 107  * This definition must be kept in sync with the defininition
 108  * in pc-bios/s390-ccw/iplb.h.
 109  */
 110 struct QemuIplParameters {
 111     uint8_t  qipl_flags;
 112     uint8_t  reserved1[3];
 113     uint64_t netboot_start_addr;
 114     uint32_t boot_menu_timeout;
 115     uint8_t  reserved2[12];
 116 } QEMU_PACKED;
 117 typedef struct QemuIplParameters QemuIplParameters;
 118
 119 #define TYPE_S390_IPL "s390-ipl"
 120 #define S390_IPL(obj) OBJECT_CHECK(S390IPLState, (obj), TYPE_S390_IPL)
 121
 122 struct S390IPLState {
 123     /*< private >*/
 124     DeviceState parent_obj;
 125     uint64_t start_addr;
 126     uint64_t compat_start_addr;
 127     uint64_t bios_start_addr;
 128     uint64_t compat_bios_start_addr;
 129     bool enforce_bios;
 130     IplParameterBlock iplb;
 131     bool iplb_valid;
 132     bool reipl_requested;
 133     bool netboot;
 134     QemuIplParameters qipl;
 135
 136     /*< public >*/
 137     char *kernel;
 138     char *initrd;
 139     char *cmdline;
 140     char *firmware;
 141     char *netboot_fw;
 142     uint8_t cssid;
 143     uint8_t ssid;
 144     uint16_t devno;
 145     bool iplbext_migration;
 146 };
 147 typedef struct S390IPLState S390IPLState;
 148
 149 #define S390_IPL_TYPE_FCP 0x00
 150 #define S390_IPL_TYPE_CCW 0x02
 151 #define S390_IPL_TYPE_QEMU_SCSI 0xff
 152
 153 #define S390_IPLB_HEADER_LEN 8
 154 #define S390_IPLB_MIN_CCW_LEN 200
 155 #define S390_IPLB_MIN_FCP_LEN 384
 156 #define S390_IPLB_MIN_QEMU_SCSI_LEN 200
 157
 158 static inline bool iplb_valid_len(IplParameterBlock *iplb)
 159 {
 160     return be32_to_cpu(iplb->len) <= sizeof(IplParameterBlock);
 161 }
 162
 163 static inline bool iplb_valid_ccw(IplParameterBlock *iplb)
 164 {
 165     return be32_to_cpu(iplb->len) >= S390_IPLB_MIN_CCW_LEN &&
 166            iplb->pbt == S390_IPL_TYPE_CCW;
 167 }
 168
 169 static inline bool iplb_valid_fcp(IplParameterBlock *iplb)
 170 {
 171     return be32_to_cpu(iplb->len) >= S390_IPLB_MIN_FCP_LEN &&
 172            iplb->pbt == S390_IPL_TYPE_FCP;
 173 }
 174
 175 #endif