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
241
242
243
244
245
246
247
248
249
|
/** @file
Declarations of utility functions used by virtio device drivers.
Copyright (C) 2012, Red Hat, Inc.
This program and the accompanying materials are licensed and made available
under the terms and conditions of the BSD License which accompanies this
distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT
WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
#ifndef _VIRTIO_LIB_H_
#define _VIRTIO_LIB_H_
#include <Protocol/VirtioDevice.h>
#include <IndustryStandard/Virtio.h>
/**
Write a word into VirtIo Device Specific Region
The VirtIo Device Specific Region must be an iomem region.
This is an internal function for the driver-specific VIRTIO_CFG_WRITE()
macros.
@param[in] VirtIo Target Virtio device.
@param[in] FieldOffset Destination offset.
@param[in] FieldSize Destination field size, must be in { 1, 2, 4, 8 }.
@param[in] Value Little endian value to write, converted to UINT64.
The least significant FieldSize bytes will be used.
@return Status code returned by VirtIo->WriteDevice().
**/
EFI_STATUS
EFIAPI
VirtioWriteDevice (
IN VIRTIO_DEVICE_PROTOCOL *VirtIo,
IN UINTN FieldOffset,
IN UINTN FieldSize,
IN UINT64 Value
);
/**
Read a word from VirtIo Device Specific Region
The VirtIo Device Specific Region must be an iomem region.
This is an internal function for the driver-specific VIRTIO_CFG_READ()
macros.
@param[in] VirtIo Source Virtio device.
@param[in] FieldOffset Source offset.
@param[in] FieldSize Source field size, must be in { 1, 2, 4, 8 }.
@param[in] BufferSize Number of bytes available in the target buffer. Must
equal FieldSize.
@param[out] Buffer Target buffer.
@return Status code returned by VirtIo->ReadDevice().
**/
EFI_STATUS
EFIAPI
VirtioReadDevice (
IN VIRTIO_DEVICE_PROTOCOL *VirtIo,
IN UINTN FieldOffset,
IN UINTN FieldSize,
IN UINTN BufferSize,
OUT VOID *Buffer
);
/**
Configure a virtio ring.
This function sets up internal storage (the guest-host communication area)
and lays out several "navigation" (ie. no-ownership) pointers to parts of
that storage.
Relevant sections from the virtio-0.9.5 spec:
- 1.1 Virtqueues,
- 2.3 Virtqueue Configuration.
@param[in] The number of descriptors to allocate for the
virtio ring, as requested by the host.
@param[out] Ring The virtio ring to set up.
@retval EFI_OUT_OF_RESOURCES AllocatePages() failed to allocate contiguous
pages for the requested QueueSize. Fields of
Ring have indeterminate value.
@retval EFI_SUCCESS Allocation and setup successful. Ring->Base
(and nothing else) is responsible for
deallocation.
**/
EFI_STATUS
EFIAPI
VirtioRingInit (
IN UINT16 QueueSize,
OUT VRING *Ring
);
/**
Tear down the internal resources of a configured virtio ring.
The caller is responsible to stop the host from using this ring before
invoking this function: the VSTAT_DRIVER_OK bit must be clear in
VhdrDeviceStatus.
@param[out] Ring The virtio ring to clean up.
**/
VOID
EFIAPI
VirtioRingUninit (
IN OUT VRING *Ring
);
//
// Internal use structure for tracking the submission of a multi-descriptor
// request.
//
typedef struct {
UINT16 HeadDescIdx;
UINT16 NextDescIdx;
} DESC_INDICES;
/**
Turn off interrupt notifications from the host, and prepare for appending
multiple descriptors to the virtio ring.
The calling driver must be in VSTAT_DRIVER_OK state.
@param[in,out] Ring The virtio ring we intend to append descriptors to.
@param[out] Indices The DESC_INDICES structure to initialize.
**/
VOID
EFIAPI
VirtioPrepare (
IN OUT VRING *Ring,
OUT DESC_INDICES *Indices
);
/**
Append a contiguous buffer for transmission / reception via the virtio ring.
This function implements the following section from virtio-0.9.5:
- 2.4.1.1 Placing Buffers into the Descriptor Table
Free space is taken as granted, since the individual drivers support only
synchronous requests and host side status is processed in lock-step with
request submission. It is the calling driver's responsibility to verify the
ring size in advance.
The caller is responsible for initializing *Indices with VirtioPrepare()
first.
@param[in,out] Ring The virtio ring to append the buffer to, as a
descriptor.
@param[in] BufferPhysAddr (Guest pseudo-physical) start address of the
transmit / receive buffer.
@param[in] BufferSize Number of bytes to transmit or receive.
@param[in] Flags A bitmask of VRING_DESC_F_* flags. The caller
computes this mask dependent on further buffers to
append and transfer direction.
VRING_DESC_F_INDIRECT is unsupported. The
VRING_DESC.Next field is always set, but the host
only interprets it dependent on VRING_DESC_F_NEXT.
@param[in,out] Indices Indices->HeadDescIdx is not accessed.
On input, Indices->NextDescIdx identifies the next
descriptor to carry the buffer. On output,
Indices->NextDescIdx is incremented by one, modulo
2^16.
**/
VOID
EFIAPI
VirtioAppendDesc (
IN OUT VRING *Ring,
IN UINTN BufferPhysAddr,
IN UINT32 BufferSize,
IN UINT16 Flags,
IN OUT DESC_INDICES *Indices
);
/**
Notify the host about the descriptor chain just built, and wait until the
host processes it.
@param[in] VirtIo The target virtio device to notify.
@param[in] VirtQueueId Identifies the queue for the target device.
@param[in,out] Ring The virtio ring with descriptors to submit.
@param[in] Indices Indices->NextDescIdx is not accessed.
Indices->HeadDescIdx identifies the head descriptor
of the descriptor chain.
@return Error code from VirtIo->SetQueueNotify() if it fails.
@retval EFI_SUCCESS Otherwise, the host processed all descriptors.
**/
EFI_STATUS
EFIAPI
VirtioFlush (
IN VIRTIO_DEVICE_PROTOCOL *VirtIo,
IN UINT16 VirtQueueId,
IN OUT VRING *Ring,
IN DESC_INDICES *Indices
);
#endif // _VIRTIO_LIB_H_
|
