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