2 * Intel MIC Platform Software Stack (MPSS)
4 * Copyright(c) 2013 Intel Corporation.
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.
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.
15 * The full GNU General Public License is included in this distribution in
16 * the file called "COPYING".
21 #ifndef __MIC_COMMON_H_
22 #define __MIC_COMMON_H_
24 #include <linux/virtio_ring.h>
27 #define ALIGN(a, x) (((a) + (x) - 1) & ~((x) - 1))
28 #define __aligned(x) __attribute__ ((aligned(x)))
31 #define mic_aligned_size(x) ALIGN(sizeof(x), 8)
34 * struct mic_device_desc: Virtio device information shared between the
35 * virtio driver and userspace backend
37 * @type: Device type: console/network/disk etc. Type 0/-1 terminates.
38 * @num_vq: Number of virtqueues.
39 * @feature_len: Number of bytes of feature bits. Multiply by 2: one for
40 host features and one for guest acknowledgements.
41 * @config_len: Number of bytes of the config array after virtqueues.
42 * @status: A status byte, written by the Guest.
43 * @config: Start of the following variable length config.
45 struct mic_device_desc {
55 * struct mic_device_ctrl: Per virtio device information in the device page
56 * used internally by the host and card side drivers.
58 * @vdev: Used for storing MIC vdev information by the guest.
59 * @config_change: Set to 1 by host when a config change is requested.
60 * @vdev_reset: Set to 1 by guest to indicate virtio device has been reset.
61 * @guest_ack: Set to 1 by guest to ack a command.
62 * @host_ack: Set to 1 by host to ack a command.
63 * @used_address_updated: Set to 1 by guest when the used address should be
65 * @c2h_vdev_db: The doorbell number to be used by guest. Set by host.
66 * @h2c_vdev_db: The doorbell number to be used by host. Set by guest.
68 struct mic_device_ctrl {
74 __u8 used_address_updated;
80 * struct mic_bootparam: Virtio device independent information in device page
82 * @magic: A magic value used by the card to ensure it can see the host
83 * @c2h_shutdown_db: Card to Host shutdown doorbell set by host
84 * @h2c_shutdown_db: Host to Card shutdown doorbell set by card
85 * @h2c_config_db: Host to Card Virtio config doorbell set by card
86 * @shutdown_status: Card shutdown status set by card
87 * @shutdown_card: Set to 1 by the host when a card shutdown is initiated
89 struct mic_bootparam {
99 * struct mic_device_page: High level representation of the device page
101 * @bootparam: The bootparam structure is used for sharing information and
102 * status updates between MIC host and card drivers.
103 * @desc: Array of MIC virtio device descriptors.
105 struct mic_device_page {
106 struct mic_bootparam bootparam;
107 struct mic_device_desc desc[0];
110 * struct mic_vqconfig: This is how we expect the device configuration field
111 * for a virtqueue to be laid out in config space.
113 * @address: Guest/MIC physical address of the virtio ring
114 * (avail and desc rings)
115 * @used_address: Guest/MIC physical address of the used ring
116 * @num: The number of entries in the virtio_ring
118 struct mic_vqconfig {
125 * The alignment to use between consumer and producer parts of vring.
126 * This is pagesize for historical reasons.
128 #define MIC_VIRTIO_RING_ALIGN 4096
130 #define MIC_MAX_VRINGS 4
131 #define MIC_VRING_ENTRIES 128
134 * Max vring entries (power of 2) to ensure desc and avail rings
135 * fit in a single page
137 #define MIC_MAX_VRING_ENTRIES 128
140 * Max size of the desc block in bytes: includes:
141 * - struct mic_device_desc
142 * - struct mic_vqconfig (num_vq of these)
143 * - host and guest features
144 * - virtio device config space
146 #define MIC_MAX_DESC_BLK_SIZE 256
149 * struct _mic_vring_info - Host vring info exposed to userspace backend
150 * for the avail index and magic for the card.
152 * @avail_idx: host avail idx
153 * @magic: A magic debug cookie.
155 struct _mic_vring_info {
161 * struct mic_vring - Vring information.
163 * @vr: The virtio ring.
164 * @info: Host vring information exposed to the userspace backend for the
165 * avail index and magic for the card.
166 * @va: The va for the buffer allocated for vr and info.
167 * @len: The length of the buffer required for allocating vr and info.
171 struct _mic_vring_info *info;
176 #define mic_aligned_desc_size(d) ALIGN(mic_desc_size(d), 8)
178 #ifndef INTEL_MIC_CARD
179 static inline unsigned mic_desc_size(const struct mic_device_desc *desc)
181 return mic_aligned_size(*desc)
182 + desc->num_vq * mic_aligned_size(struct mic_vqconfig)
183 + desc->feature_len * 2
187 static inline struct mic_vqconfig *
188 mic_vq_config(const struct mic_device_desc *desc)
190 return (struct mic_vqconfig *)(desc + 1);
193 static inline __u8 *mic_vq_features(const struct mic_device_desc *desc)
195 return (__u8 *)(mic_vq_config(desc) + desc->num_vq);
198 static inline __u8 *mic_vq_configspace(const struct mic_device_desc *desc)
200 return mic_vq_features(desc) + desc->feature_len * 2;
202 static inline unsigned mic_total_desc_size(struct mic_device_desc *desc)
204 return mic_aligned_desc_size(desc) +
205 mic_aligned_size(struct mic_device_ctrl);
209 /* Device page size */
210 #define MIC_DP_SIZE 4096
212 #define MIC_MAGIC 0xc0ffee00
215 * enum mic_states - MIC states.
228 * enum mic_status - MIC status reported by card after
229 * a host or card initiated shutdown or a card crash.