include/uapi/linux/mic_common.h

   1 /*
   2  * Intel MIC Platform Software Stack (MPSS)
   3  *
   4  * Copyright(c) 2013 Intel Corporation.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License, version 2, as
   8  * published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  13  * General Public License for more details.
  14  *
  15  * The full GNU General Public License is included in this distribution in
  16  * the file called "COPYING".
  17  *
  18  * Intel MIC driver.
  19  *
  20  */
  21 #ifndef __MIC_COMMON_H_
  22 #define __MIC_COMMON_H_
  23
  24 #include <linux/virtio_ring.h>
  25
  26 #define __mic_align(a, x) (((a) + (x) - 1) & ~((x) - 1))
  27
  28 /**
  29  * struct mic_device_desc: Virtio device information shared between the
  30  * virtio driver and userspace backend
  31  *
  32  * @type: Device type: console/network/disk etc.  Type 0/-1 terminates.
  33  * @num_vq: Number of virtqueues.
  34  * @feature_len: Number of bytes of feature bits.  Multiply by 2: one for
  35    host features and one for guest acknowledgements.
  36  * @config_len: Number of bytes of the config array after virtqueues.
  37  * @status: A status byte, written by the Guest.
  38  * @config: Start of the following variable length config.
  39  */
  40 struct mic_device_desc {
  41         __s8 type;
  42         __u8 num_vq;
  43         __u8 feature_len;
  44         __u8 config_len;
  45         __u8 status;
  46         __le64 config[0];
  47 } __attribute__ ((aligned(8)));
  48
  49 /**
  50  * struct mic_device_ctrl: Per virtio device information in the device page
  51  * used internally by the host and card side drivers.
  52  *
  53  * @vdev: Used for storing MIC vdev information by the guest.
  54  * @config_change: Set to 1 by host when a config change is requested.
  55  * @vdev_reset: Set to 1 by guest to indicate virtio device has been reset.
  56  * @guest_ack: Set to 1 by guest to ack a command.
  57  * @host_ack: Set to 1 by host to ack a command.
  58  * @used_address_updated: Set to 1 by guest when the used address should be
  59  * updated.
  60  * @c2h_vdev_db: The doorbell number to be used by guest. Set by host.
  61  * @h2c_vdev_db: The doorbell number to be used by host. Set by guest.
  62  */
  63 struct mic_device_ctrl {
  64         __le64 vdev;
  65         __u8 config_change;
  66         __u8 vdev_reset;
  67         __u8 guest_ack;
  68         __u8 host_ack;
  69         __u8 used_address_updated;
  70         __s8 c2h_vdev_db;
  71         __s8 h2c_vdev_db;
  72 } __attribute__ ((aligned(8)));
  73
  74 /**
  75  * struct mic_bootparam: Virtio device independent information in device page
  76  *
  77  * @magic: A magic value used by the card to ensure it can see the host
  78  * @c2h_shutdown_db: Card to Host shutdown doorbell set by host
  79  * @h2c_shutdown_db: Host to Card shutdown doorbell set by card
  80  * @h2c_config_db: Host to Card Virtio config doorbell set by card
  81  * @shutdown_status: Card shutdown status set by card
  82  * @shutdown_card: Set to 1 by the host when a card shutdown is initiated
  83  */
  84 struct mic_bootparam {
  85         __le32 magic;
  86         __s8 c2h_shutdown_db;
  87         __s8 h2c_shutdown_db;
  88         __s8 h2c_config_db;
  89         __u8 shutdown_status;
  90         __u8 shutdown_card;
  91 } __attribute__ ((aligned(8)));
  92
  93 /**
  94  * struct mic_device_page: High level representation of the device page
  95  *
  96  * @bootparam: The bootparam structure is used for sharing information and
  97  * status updates between MIC host and card drivers.
  98  * @desc: Array of MIC virtio device descriptors.
  99  */
 100 struct mic_device_page {
 101         struct mic_bootparam bootparam;
 102         struct mic_device_desc desc[0];
 103 };
 104 /**
 105  * struct mic_vqconfig: This is how we expect the device configuration field
 106  * for a virtqueue to be laid out in config space.
 107  *
 108  * @address: Guest/MIC physical address of the virtio ring
 109  * (avail and desc rings)
 110  * @used_address: Guest/MIC physical address of the used ring
 111  * @num: The number of entries in the virtio_ring
 112  */
 113 struct mic_vqconfig {
 114         __le64 address;
 115         __le64 used_address;
 116         __le16 num;
 117 } __attribute__ ((aligned(8)));
 118
 119 /*
 120  * The alignment to use between consumer and producer parts of vring.
 121  * This is pagesize for historical reasons.
 122  */
 123 #define MIC_VIRTIO_RING_ALIGN           4096
 124
 125 #define MIC_MAX_VRINGS                  4
 126 #define MIC_VRING_ENTRIES               128
 127
 128 /*
 129  * Max vring entries (power of 2) to ensure desc and avail rings
 130  * fit in a single page
 131  */
 132 #define MIC_MAX_VRING_ENTRIES           128
 133
 134 /**
 135  * Max size of the desc block in bytes: includes:
 136  *      - struct mic_device_desc
 137  *      - struct mic_vqconfig (num_vq of these)
 138  *      - host and guest features
 139  *      - virtio device config space
 140  */
 141 #define MIC_MAX_DESC_BLK_SIZE           256
 142
 143 /**
 144  * struct _mic_vring_info - Host vring info exposed to userspace backend
 145  * for the avail index and magic for the card.
 146  *
 147  * @avail_idx: host avail idx
 148  * @magic: A magic debug cookie.
 149  */
 150 struct _mic_vring_info {
 151         __u16 avail_idx;
 152         __le32 magic;
 153 };
 154
 155 /**
 156  * struct mic_vring - Vring information.
 157  *
 158  * @vr: The virtio ring.
 159  * @info: Host vring information exposed to the userspace backend for the
 160  * avail index and magic for the card.
 161  * @va: The va for the buffer allocated for vr and info.
 162  * @len: The length of the buffer required for allocating vr and info.
 163  */
 164 struct mic_vring {
 165         struct vring vr;
 166         struct _mic_vring_info *info;
 167         void *va;
 168         int len;
 169 };
 170
 171 #define mic_aligned_desc_size(d) __mic_align(mic_desc_size(d), 8)
 172
 173 #ifndef INTEL_MIC_CARD
 174 static inline unsigned mic_desc_size(const struct mic_device_desc *desc)
 175 {
 176         return sizeof(*desc) + desc->num_vq * sizeof(struct mic_vqconfig)
 177                 + desc->feature_len * 2 + desc->config_len;
 178 }
 179
 180 static inline struct mic_vqconfig *
 181 mic_vq_config(const struct mic_device_desc *desc)
 182 {
 183         return (struct mic_vqconfig *)(desc + 1);
 184 }
 185
 186 static inline __u8 *mic_vq_features(const struct mic_device_desc *desc)
 187 {
 188         return (__u8 *)(mic_vq_config(desc) + desc->num_vq);
 189 }
 190
 191 static inline __u8 *mic_vq_configspace(const struct mic_device_desc *desc)
 192 {
 193         return mic_vq_features(desc) + desc->feature_len * 2;
 194 }
 195 static inline unsigned mic_total_desc_size(struct mic_device_desc *desc)
 196 {
 197         return mic_aligned_desc_size(desc) + sizeof(struct mic_device_ctrl);
 198 }
 199 #endif
 200
 201 /* Device page size */
 202 #define MIC_DP_SIZE 4096
 203
 204 #define MIC_MAGIC 0xc0ffee00
 205
 206 /**
 207  * enum mic_states - MIC states.
 208  */
 209 enum mic_states {
 210         MIC_OFFLINE = 0,
 211         MIC_ONLINE,
 212         MIC_SHUTTING_DOWN,
 213         MIC_RESET_FAILED,
 214         MIC_SUSPENDING,
 215         MIC_SUSPENDED,
 216         MIC_LAST
 217 };
 218
 219 /**
 220  * enum mic_status - MIC status reported by card after
 221  * a host or card initiated shutdown or a card crash.
 222  */
 223 enum mic_status {
 224         MIC_NOP = 0,
 225         MIC_CRASHED,
 226         MIC_HALTED,
 227         MIC_POWER_OFF,
 228         MIC_RESTART,
 229         MIC_STATUS_LAST
 230 };
 231
 232 #endif