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>
26 #define __mic_align(a, x) (((a) + (x) - 1) & ~((x) - 1))
29 * struct mic_device_desc: Virtio device information shared between the
30 * virtio driver and userspace backend
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.
40 struct mic_device_desc {
47 } __attribute__ ((aligned(8)));
50 * struct mic_device_ctrl: Per virtio device information in the device page
51 * used internally by the host and card side drivers.
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
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.
63 struct mic_device_ctrl {
69 __u8 used_address_updated;
72 } __attribute__ ((aligned(8)));
75 * struct mic_bootparam: Virtio device independent information in device page
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 * @tot_nodes: Total number of nodes in the SCIF network
84 * @node_id: Unique id of the node
85 * @h2c_scif_db - Host to card SCIF doorbell set by card
86 * @c2h_scif_db - Card to host SCIF doorbell set by host
87 * @scif_host_dma_addr - SCIF host queue pair DMA address
88 * @scif_card_dma_addr - SCIF card queue pair DMA address
90 struct mic_bootparam {
101 __u64 scif_host_dma_addr;
102 __u64 scif_card_dma_addr;
103 } __attribute__ ((aligned(8)));
106 * struct mic_device_page: High level representation of the device page
108 * @bootparam: The bootparam structure is used for sharing information and
109 * status updates between MIC host and card drivers.
110 * @desc: Array of MIC virtio device descriptors.
112 struct mic_device_page {
113 struct mic_bootparam bootparam;
114 struct mic_device_desc desc[0];
117 * struct mic_vqconfig: This is how we expect the device configuration field
118 * for a virtqueue to be laid out in config space.
120 * @address: Guest/MIC physical address of the virtio ring
121 * (avail and desc rings)
122 * @used_address: Guest/MIC physical address of the used ring
123 * @num: The number of entries in the virtio_ring
125 struct mic_vqconfig {
129 } __attribute__ ((aligned(8)));
132 * The alignment to use between consumer and producer parts of vring.
133 * This is pagesize for historical reasons.
135 #define MIC_VIRTIO_RING_ALIGN 4096
137 #define MIC_MAX_VRINGS 4
138 #define MIC_VRING_ENTRIES 128
141 * Max vring entries (power of 2) to ensure desc and avail rings
142 * fit in a single page
144 #define MIC_MAX_VRING_ENTRIES 128
147 * Max size of the desc block in bytes: includes:
148 * - struct mic_device_desc
149 * - struct mic_vqconfig (num_vq of these)
150 * - host and guest features
151 * - virtio device config space
153 #define MIC_MAX_DESC_BLK_SIZE 256
156 * struct _mic_vring_info - Host vring info exposed to userspace backend
157 * for the avail index and magic for the card.
159 * @avail_idx: host avail idx
160 * @magic: A magic debug cookie.
162 struct _mic_vring_info {
168 * struct mic_vring - Vring information.
170 * @vr: The virtio ring.
171 * @info: Host vring information exposed to the userspace backend for the
172 * avail index and magic for the card.
173 * @va: The va for the buffer allocated for vr and info.
174 * @len: The length of the buffer required for allocating vr and info.
178 struct _mic_vring_info *info;
183 #define mic_aligned_desc_size(d) __mic_align(mic_desc_size(d), 8)
185 #ifndef INTEL_MIC_CARD
186 static inline unsigned mic_desc_size(const struct mic_device_desc *desc)
188 return sizeof(*desc) + desc->num_vq * sizeof(struct mic_vqconfig)
189 + desc->feature_len * 2 + desc->config_len;
192 static inline struct mic_vqconfig *
193 mic_vq_config(const struct mic_device_desc *desc)
195 return (struct mic_vqconfig *)(desc + 1);
198 static inline __u8 *mic_vq_features(const struct mic_device_desc *desc)
200 return (__u8 *)(mic_vq_config(desc) + desc->num_vq);
203 static inline __u8 *mic_vq_configspace(const struct mic_device_desc *desc)
205 return mic_vq_features(desc) + desc->feature_len * 2;
207 static inline unsigned mic_total_desc_size(struct mic_device_desc *desc)
209 return mic_aligned_desc_size(desc) + sizeof(struct mic_device_ctrl);
213 /* Device page size */
214 #define MIC_DP_SIZE 4096
216 #define MIC_MAGIC 0xc0ffee00
219 * enum mic_states - MIC states.
232 * enum mic_status - MIC status reported by card after
233 * a host or card initiated shutdown or a card crash.