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 * @h2c_config_db: Host to Card Virtio config doorbell set by card
79 * @node_id: Unique id of the node
80 * @h2c_scif_db - Host to card SCIF doorbell set by card
81 * @c2h_scif_db - Card to host SCIF doorbell set by host
82 * @scif_host_dma_addr - SCIF host queue pair DMA address
83 * @scif_card_dma_addr - SCIF card queue pair DMA address
84 */
85 struct mic_bootparam {
86 __le32 magic;
87 __s8 h2c_config_db;
88 __u8 node_id;
89 __u8 h2c_scif_db;
90 __u8 c2h_scif_db;
91 __u64 scif_host_dma_addr;
92 __u64 scif_card_dma_addr;
93 } __attribute__ ((aligned(8)));
94
95 /**
96 * struct mic_device_page: High level representation of the device page
97 *
98 * @bootparam: The bootparam structure is used for sharing information and
99 * status updates between MIC host and card drivers.
100 * @desc: Array of MIC virtio device descriptors.
101 */
102 struct mic_device_page {
103 struct mic_bootparam bootparam;
104 struct mic_device_desc desc[0];
105 };
106 /**
107 * struct mic_vqconfig: This is how we expect the device configuration field
108 * for a virtqueue to be laid out in config space.
109 *
110 * @address: Guest/MIC physical address of the virtio ring
111 * (avail and desc rings)
112 * @used_address: Guest/MIC physical address of the used ring
113 * @num: The number of entries in the virtio_ring
114 */
115 struct mic_vqconfig {
116 __le64 address;
117 __le64 used_address;
118 __le16 num;
119 } __attribute__ ((aligned(8)));
120
121 /*
122 * The alignment to use between consumer and producer parts of vring.
123 * This is pagesize for historical reasons.
124 */
125 #define MIC_VIRTIO_RING_ALIGN 4096
126
127 #define MIC_MAX_VRINGS 4
128 #define MIC_VRING_ENTRIES 128
129
130 /*
131 * Max vring entries (power of 2) to ensure desc and avail rings
132 * fit in a single page
133 */
134 #define MIC_MAX_VRING_ENTRIES 128
135
136 /**
137 * Max size of the desc block in bytes: includes:
138 * - struct mic_device_desc
139 * - struct mic_vqconfig (num_vq of these)
140 * - host and guest features
141 * - virtio device config space
142 */
143 #define MIC_MAX_DESC_BLK_SIZE 256
144
145 /**
146 * struct _mic_vring_info - Host vring info exposed to userspace backend
147 * for the avail index and magic for the card.
148 *
149 * @avail_idx: host avail idx
150 * @magic: A magic debug cookie.
151 */
152 struct _mic_vring_info {
153 __u16 avail_idx;
154 __le32 magic;
155 };
156
157 /**
158 * struct mic_vring - Vring information.
159 *
160 * @vr: The virtio ring.
161 * @info: Host vring information exposed to the userspace backend for the
162 * avail index and magic for the card.
163 * @va: The va for the buffer allocated for vr and info.
164 * @len: The length of the buffer required for allocating vr and info.
165 */
166 struct mic_vring {
167 struct vring vr;
168 struct _mic_vring_info *info;
169 void *va;
170 int len;
171 };
172
173 #define mic_aligned_desc_size(d) __mic_align(mic_desc_size(d), 8)
174
175 #ifndef INTEL_MIC_CARD
mic_desc_size(const struct mic_device_desc * desc)176 static inline unsigned mic_desc_size(const struct mic_device_desc *desc)
177 {
178 return sizeof(*desc) + desc->num_vq * sizeof(struct mic_vqconfig)
179 + desc->feature_len * 2 + desc->config_len;
180 }
181
182 static inline struct mic_vqconfig *
mic_vq_config(const struct mic_device_desc * desc)183 mic_vq_config(const struct mic_device_desc *desc)
184 {
185 return (struct mic_vqconfig *)(desc + 1);
186 }
187
mic_vq_features(const struct mic_device_desc * desc)188 static inline __u8 *mic_vq_features(const struct mic_device_desc *desc)
189 {
190 return (__u8 *)(mic_vq_config(desc) + desc->num_vq);
191 }
192
mic_vq_configspace(const struct mic_device_desc * desc)193 static inline __u8 *mic_vq_configspace(const struct mic_device_desc *desc)
194 {
195 return mic_vq_features(desc) + desc->feature_len * 2;
196 }
mic_total_desc_size(struct mic_device_desc * desc)197 static inline unsigned mic_total_desc_size(struct mic_device_desc *desc)
198 {
199 return mic_aligned_desc_size(desc) + sizeof(struct mic_device_ctrl);
200 }
201 #endif
202
203 /* Device page size */
204 #define MIC_DP_SIZE 4096
205
206 #define MIC_MAGIC 0xc0ffee00
207
208 /**
209 * enum mic_states - MIC states.
210 */
211 enum mic_states {
212 MIC_READY = 0,
213 MIC_BOOTING,
214 MIC_ONLINE,
215 MIC_SHUTTING_DOWN,
216 MIC_RESETTING,
217 MIC_RESET_FAILED,
218 MIC_LAST
219 };
220
221 /**
222 * enum mic_status - MIC status reported by card after
223 * a host or card initiated shutdown or a card crash.
224 */
225 enum mic_status {
226 MIC_NOP = 0,
227 MIC_CRASHED,
228 MIC_HALTED,
229 MIC_POWER_OFF,
230 MIC_RESTART,
231 MIC_STATUS_LAST
232 };
233
234 #endif
235