include/hw/s390x/css.h

   1 /*
   2  * Channel subsystem structures and definitions.
   3  *
   4  * Copyright 2012 IBM Corp.
   5  * Author(s): Cornelia Huck <cornelia.huck@de.ibm.com>
   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 CSS_H
  13 #define CSS_H
  14
  15 #include "hw/s390x/adapter.h"
  16 #include "hw/s390x/s390_flic.h"
  17 #include "hw/s390x/ioinst.h"
  18
  19 /* Channel subsystem constants. */
  20 #define MAX_DEVNO 65535
  21 #define MAX_SCHID 65535
  22 #define MAX_SSID 3
  23 #define MAX_CSSID 255
  24 #define MAX_CHPID 255
  25
  26 #define MAX_ISC 7
  27
  28 #define MAX_CIWS 62
  29
  30 #define VIRTUAL_CSSID 0xfe
  31 #define VIRTIO_CCW_CHPID 0   /* used by convention */
  32
  33 typedef struct CIW {
  34     uint8_t type;
  35     uint8_t command;
  36     uint16_t count;
  37 } QEMU_PACKED CIW;
  38
  39 typedef struct SenseId {
  40     /* common part */
  41     uint8_t reserved;        /* always 0x'FF' */
  42     uint16_t cu_type;        /* control unit type */
  43     uint8_t cu_model;        /* control unit model */
  44     uint16_t dev_type;       /* device type */
  45     uint8_t dev_model;       /* device model */
  46     uint8_t unused;          /* padding byte */
  47     /* extended part */
  48     CIW ciw[MAX_CIWS];       /* variable # of CIWs */
  49 } QEMU_PACKED SenseId;
  50
  51 /* Channel measurements, from linux/drivers/s390/cio/cmf.c. */
  52 typedef struct CMB {
  53     uint16_t ssch_rsch_count;
  54     uint16_t sample_count;
  55     uint32_t device_connect_time;
  56     uint32_t function_pending_time;
  57     uint32_t device_disconnect_time;
  58     uint32_t control_unit_queuing_time;
  59     uint32_t device_active_only_time;
  60     uint32_t reserved[2];
  61 } QEMU_PACKED CMB;
  62
  63 typedef struct CMBE {
  64     uint32_t ssch_rsch_count;
  65     uint32_t sample_count;
  66     uint32_t device_connect_time;
  67     uint32_t function_pending_time;
  68     uint32_t device_disconnect_time;
  69     uint32_t control_unit_queuing_time;
  70     uint32_t device_active_only_time;
  71     uint32_t device_busy_time;
  72     uint32_t initial_command_response_time;
  73     uint32_t reserved[7];
  74 } QEMU_PACKED CMBE;
  75
  76 typedef struct SubchDev SubchDev;
  77 struct SubchDev {
  78     /* channel-subsystem related things: */
  79     uint8_t cssid;
  80     uint8_t ssid;
  81     uint16_t schid;
  82     uint16_t devno;
  83     SCHIB curr_status;
  84     uint8_t sense_data[32];
  85     hwaddr channel_prog;
  86     CCW1 last_cmd;
  87     bool last_cmd_valid;
  88     bool ccw_fmt_1;
  89     bool thinint_active;
  90     uint8_t ccw_no_data_cnt;
  91     /* transport-provided data: */
  92     int (*ccw_cb) (SubchDev *, CCW1);
  93     void (*disable_cb)(SubchDev *);
  94     int (*do_subchannel_work) (SubchDev *, ORB *);
  95     SenseId id;
  96     void *driver_data;
  97 };
  98
  99 /*
 100  * Identify a device within the channel subsystem.
 101  * Note that this can be used to identify either the subchannel or
 102  * the attached I/O device, as there's always one I/O device per
 103  * subchannel.
 104  */
 105 typedef struct CssDevId {
 106     uint8_t cssid;
 107     uint8_t ssid;
 108     uint16_t devid;
 109     bool valid;
 110 } CssDevId;
 111
 112 extern PropertyInfo css_devid_propinfo;
 113
 114 #define DEFINE_PROP_CSS_DEV_ID(_n, _s, _f) \
 115     DEFINE_PROP(_n, _s, _f, css_devid_propinfo, CssDevId)
 116
 117 typedef struct IndAddr {
 118     hwaddr addr;
 119     uint64_t map;
 120     unsigned long refcnt;
 121     int len;
 122     QTAILQ_ENTRY(IndAddr) sibling;
 123 } IndAddr;
 124
 125 IndAddr *get_indicator(hwaddr ind_addr, int len);
 126 void release_indicator(AdapterInfo *adapter, IndAddr *indicator);
 127 int map_indicator(AdapterInfo *adapter, IndAddr *indicator);
 128
 129 typedef SubchDev *(*css_subch_cb_func)(uint8_t m, uint8_t cssid, uint8_t ssid,
 130                                        uint16_t schid);
 131 void subch_device_save(SubchDev *s, QEMUFile *f);
 132 int subch_device_load(SubchDev *s, QEMUFile *f);
 133 int css_create_css_image(uint8_t cssid, bool default_image);
 134 bool css_devno_used(uint8_t cssid, uint8_t ssid, uint16_t devno);
 135 void css_subch_assign(uint8_t cssid, uint8_t ssid, uint16_t schid,
 136                       uint16_t devno, SubchDev *sch);
 137 void css_sch_build_virtual_schib(SubchDev *sch, uint8_t chpid, uint8_t type);
 138 int css_sch_build_schib(SubchDev *sch, CssDevId *dev_id);
 139 unsigned int css_find_free_chpid(uint8_t cssid);
 140 uint16_t css_build_subchannel_id(SubchDev *sch);
 141 void copy_scsw_to_guest(SCSW *dest, const SCSW *src);
 142 void css_inject_io_interrupt(SubchDev *sch);
 143 void css_reset(void);
 144 void css_reset_sch(SubchDev *sch);
 145 void css_queue_crw(uint8_t rsc, uint8_t erc, int chain, uint16_t rsid);
 146 void css_generate_sch_crws(uint8_t cssid, uint8_t ssid, uint16_t schid,
 147                            int hotplugged, int add);
 148 void css_generate_chp_crws(uint8_t cssid, uint8_t chpid);
 149 void css_generate_css_crws(uint8_t cssid);
 150 void css_clear_sei_pending(void);
 151 void css_adapter_interrupt(uint8_t isc);
 152 int s390_ccw_cmd_request(ORB *orb, SCSW *scsw, void *data);
 153 int do_subchannel_work_virtual(SubchDev *sub, ORB *orb);
 154 int do_subchannel_work_passthrough(SubchDev *sub, ORB *orb);
 155
 156 typedef enum {
 157     CSS_IO_ADAPTER_VIRTIO = 0,
 158     CSS_IO_ADAPTER_PCI = 1,
 159     CSS_IO_ADAPTER_TYPE_NUMS,
 160 } CssIoAdapterType;
 161
 162 uint32_t css_get_adapter_id(CssIoAdapterType type, uint8_t isc);
 163 void css_register_io_adapters(CssIoAdapterType type, bool swap, bool maskable,
 164                               Error **errp);
 165
 166 #ifndef CONFIG_USER_ONLY
 167 SubchDev *css_find_subch(uint8_t m, uint8_t cssid, uint8_t ssid,
 168                          uint16_t schid);
 169 bool css_subch_visible(SubchDev *sch);
 170 void css_conditional_io_interrupt(SubchDev *sch);
 171 int css_do_stsch(SubchDev *sch, SCHIB *schib);
 172 bool css_schid_final(int m, uint8_t cssid, uint8_t ssid, uint16_t schid);
 173 int css_do_msch(SubchDev *sch, const SCHIB *schib);
 174 int css_do_xsch(SubchDev *sch);
 175 int css_do_csch(SubchDev *sch);
 176 int css_do_hsch(SubchDev *sch);
 177 int css_do_ssch(SubchDev *sch, ORB *orb);
 178 int css_do_tsch_get_irb(SubchDev *sch, IRB *irb, int *irb_len);
 179 void css_do_tsch_update_subch(SubchDev *sch);
 180 int css_do_stcrw(CRW *crw);
 181 void css_undo_stcrw(CRW *crw);
 182 int css_do_tpi(IOIntCode *int_code, int lowcore);
 183 int css_collect_chp_desc(int m, uint8_t cssid, uint8_t f_chpid, uint8_t l_chpid,
 184                          int rfmt, void *buf);
 185 void css_do_schm(uint8_t mbk, int update, int dct, uint64_t mbo);
 186 int css_enable_mcsse(void);
 187 int css_enable_mss(void);
 188 int css_do_rsch(SubchDev *sch);
 189 int css_do_rchp(uint8_t cssid, uint8_t chpid);
 190 bool css_present(uint8_t cssid);
 191 #endif
 192
 193 extern PropertyInfo css_devid_ro_propinfo;
 194
 195 #define DEFINE_PROP_CSS_DEV_ID_RO(_n, _s, _f) \
 196     DEFINE_PROP(_n, _s, _f, css_devid_ro_propinfo, CssDevId)
 197
 198 /**
 199  * Create a subchannel for the given bus id.
 200  *
 201  * If @p bus_id is valid, and @p squash_mcss is true, verify that it is
 202  * not already in use in the default css, and find a free devno from the
 203  * default css image for it.
 204  * If @p bus_id is valid, and @p squash_mcss is false, verify that it is
 205  * not already in use, and find a free devno for it.
 206  * If @p bus_id is not valid, and if either @p squash_mcss or @p is_virtual
 207  * is true, find a free subchannel id and device number across all
 208  * subchannel sets from the default css image.
 209  * If @p bus_id is not valid, and if both @p squash_mcss and @p is_virtual
 210  * are false, find a non-full css image and find a free subchannel id and
 211  * device number across all subchannel sets from it.
 212  *
 213  * If either of the former actions succeed, allocate a subchannel structure,
 214  * initialise it with the bus id, subchannel id and device number, register
 215  * it with the CSS and return it. Otherwise return NULL.
 216  *
 217  * The caller becomes owner of the returned subchannel structure and
 218  * is responsible for unregistering and freeing it.
 219  */
 220 SubchDev *css_create_sch(CssDevId bus_id, bool is_virtual, bool squash_mcss,
 221                          Error **errp);
 222 #endif