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 254 /* 255 is reserved */
  24 #define MAX_CHPID 255
  25
  26 #define MAX_CIWS 62
  27
  28 #define VIRTUAL_CSSID 0xfe
  29
  30 typedef struct CIW {
  31     uint8_t type;
  32     uint8_t command;
  33     uint16_t count;
  34 } QEMU_PACKED CIW;
  35
  36 typedef struct SenseId {
  37     /* common part */
  38     uint8_t reserved;        /* always 0x'FF' */
  39     uint16_t cu_type;        /* control unit type */
  40     uint8_t cu_model;        /* control unit model */
  41     uint16_t dev_type;       /* device type */
  42     uint8_t dev_model;       /* device model */
  43     uint8_t unused;          /* padding byte */
  44     /* extended part */
  45     CIW ciw[MAX_CIWS];       /* variable # of CIWs */
  46 } QEMU_PACKED SenseId;
  47
  48 /* Channel measurements, from linux/drivers/s390/cio/cmf.c. */
  49 typedef struct CMB {
  50     uint16_t ssch_rsch_count;
  51     uint16_t sample_count;
  52     uint32_t device_connect_time;
  53     uint32_t function_pending_time;
  54     uint32_t device_disconnect_time;
  55     uint32_t control_unit_queuing_time;
  56     uint32_t device_active_only_time;
  57     uint32_t reserved[2];
  58 } QEMU_PACKED CMB;
  59
  60 typedef struct CMBE {
  61     uint32_t ssch_rsch_count;
  62     uint32_t sample_count;
  63     uint32_t device_connect_time;
  64     uint32_t function_pending_time;
  65     uint32_t device_disconnect_time;
  66     uint32_t control_unit_queuing_time;
  67     uint32_t device_active_only_time;
  68     uint32_t device_busy_time;
  69     uint32_t initial_command_response_time;
  70     uint32_t reserved[7];
  71 } QEMU_PACKED CMBE;
  72
  73 typedef struct SubchDev SubchDev;
  74 struct SubchDev {
  75     /* channel-subsystem related things: */
  76     uint8_t cssid;
  77     uint8_t ssid;
  78     uint16_t schid;
  79     uint16_t devno;
  80     SCHIB curr_status;
  81     uint8_t sense_data[32];
  82     hwaddr channel_prog;
  83     CCW1 last_cmd;
  84     bool last_cmd_valid;
  85     bool ccw_fmt_1;
  86     bool thinint_active;
  87     uint8_t ccw_no_data_cnt;
  88     /* transport-provided data: */
  89     int (*ccw_cb) (SubchDev *, CCW1);
  90     void (*disable_cb)(SubchDev *);
  91     SenseId id;
  92     void *driver_data;
  93 };
  94
  95 typedef struct IndAddr {
  96     hwaddr addr;
  97     uint64_t map;
  98     unsigned long refcnt;
  99     int len;
 100     QTAILQ_ENTRY(IndAddr) sibling;
 101 } IndAddr;
 102
 103 IndAddr *get_indicator(hwaddr ind_addr, int len);
 104 void release_indicator(AdapterInfo *adapter, IndAddr *indicator);
 105 int map_indicator(AdapterInfo *adapter, IndAddr *indicator);
 106
 107 typedef SubchDev *(*css_subch_cb_func)(uint8_t m, uint8_t cssid, uint8_t ssid,
 108                                        uint16_t schid);
 109 void subch_device_save(SubchDev *s, QEMUFile *f);
 110 int subch_device_load(SubchDev *s, QEMUFile *f);
 111 int css_create_css_image(uint8_t cssid, bool default_image);
 112 bool css_devno_used(uint8_t cssid, uint8_t ssid, uint16_t devno);
 113 void css_subch_assign(uint8_t cssid, uint8_t ssid, uint16_t schid,
 114                       uint16_t devno, SubchDev *sch);
 115 void css_sch_build_virtual_schib(SubchDev *sch, uint8_t chpid, uint8_t type);
 116 uint16_t css_build_subchannel_id(SubchDev *sch);
 117 void css_reset(void);
 118 void css_reset_sch(SubchDev *sch);
 119 void css_queue_crw(uint8_t rsc, uint8_t erc, int chain, uint16_t rsid);
 120 void css_generate_sch_crws(uint8_t cssid, uint8_t ssid, uint16_t schid,
 121                            int hotplugged, int add);
 122 void css_generate_chp_crws(uint8_t cssid, uint8_t chpid);
 123 void css_generate_css_crws(uint8_t cssid);
 124 void css_clear_sei_pending(void);
 125 void css_adapter_interrupt(uint8_t isc);
 126
 127 #define CSS_IO_ADAPTER_VIRTIO 1
 128 int css_register_io_adapter(uint8_t type, uint8_t isc, bool swap,
 129                             bool maskable, uint32_t *id);
 130
 131 #ifndef CONFIG_USER_ONLY
 132 SubchDev *css_find_subch(uint8_t m, uint8_t cssid, uint8_t ssid,
 133                          uint16_t schid);
 134 bool css_subch_visible(SubchDev *sch);
 135 void css_conditional_io_interrupt(SubchDev *sch);
 136 int css_do_stsch(SubchDev *sch, SCHIB *schib);
 137 bool css_schid_final(int m, uint8_t cssid, uint8_t ssid, uint16_t schid);
 138 int css_do_msch(SubchDev *sch, const SCHIB *schib);
 139 int css_do_xsch(SubchDev *sch);
 140 int css_do_csch(SubchDev *sch);
 141 int css_do_hsch(SubchDev *sch);
 142 int css_do_ssch(SubchDev *sch, ORB *orb);
 143 int css_do_tsch_get_irb(SubchDev *sch, IRB *irb, int *irb_len);
 144 void css_do_tsch_update_subch(SubchDev *sch);
 145 int css_do_stcrw(CRW *crw);
 146 void css_undo_stcrw(CRW *crw);
 147 int css_do_tpi(IOIntCode *int_code, int lowcore);
 148 int css_collect_chp_desc(int m, uint8_t cssid, uint8_t f_chpid, uint8_t l_chpid,
 149                          int rfmt, void *buf);
 150 void css_do_schm(uint8_t mbk, int update, int dct, uint64_t mbo);
 151 int css_enable_mcsse(void);
 152 int css_enable_mss(void);
 153 int css_do_rsch(SubchDev *sch);
 154 int css_do_rchp(uint8_t cssid, uint8_t chpid);
 155 bool css_present(uint8_t cssid);
 156 #endif
 157 /*
 158  * Identify a device within the channel subsystem.
 159  * Note that this can be used to identify either the subchannel or
 160  * the attached I/O device, as there's always one I/O device per
 161  * subchannel.
 162  */
 163 typedef struct CssDevId {
 164     uint8_t cssid;
 165     uint8_t ssid;
 166     uint16_t devid;
 167     bool valid;
 168 } CssDevId;
 169
 170 extern PropertyInfo css_devid_propinfo;
 171
 172 #define DEFINE_PROP_CSS_DEV_ID(_n, _s, _f) \
 173     DEFINE_PROP(_n, _s, _f, css_devid_propinfo, CssDevId)
 174
 175 /**
 176  * Create a subchannel for the given bus id.
 177  *
 178  * If @p bus_id is valid, verify that it uses the virtual channel
 179  * subsystem id and is not already in use, and find a free subchannel
 180  * id for it. If @p bus_id is not valid, find a free subchannel id and
 181  * device number across all subchannel sets. If either of the former
 182  * actions succeed, allocate a subchannel structure, initialise it
 183  * with the bus id, subchannel id and device number, register it with
 184  * the CSS and return it. Otherwise return NULL.
 185  *
 186  * The caller becomes owner of the returned subchannel structure and
 187  * is responsible for unregistering and freeing it.
 188  */
 189 SubchDev *css_create_virtual_sch(CssDevId bus_id, Error **errp);
 190 #endif