3 Declarations of utility functions used by virtio device drivers.
5 Copyright (C) 2012-2016, Red Hat, Inc.
6 Copyright (C) 2017, AMD Inc, All rights reserved.<BR>
8 This program and the accompanying materials are licensed and made available
9 under the terms and conditions of the BSD License which accompanies this
10 distribution. The full text of the license may be found at
11 http://opensource.org/licenses/bsd-license.php
13 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT
14 WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
18 #ifndef _VIRTIO_LIB_H_
19 #define _VIRTIO_LIB_H_
21 #include <Protocol/VirtioDevice.h>
23 #include <IndustryStandard/Virtio.h>
28 Configure a virtio ring.
30 This function sets up internal storage (the guest-host communication area)
31 and lays out several "navigation" (ie. no-ownership) pointers to parts of
34 Relevant sections from the virtio-0.9.5 spec:
36 - 2.3 Virtqueue Configuration.
38 @param[in] VirtIo The virtio device which will use the ring.
40 @param[in] The number of descriptors to allocate for the
41 virtio ring, as requested by the host.
43 @param[out] Ring The virtio ring to set up.
45 @retval EFI_OUT_OF_RESOURCES AllocatePages() failed to allocate contiguous
46 pages for the requested QueueSize. Fields of
47 Ring have indeterminate value.
49 @retval EFI_SUCCESS Allocation and setup successful. Ring->Base
50 (and nothing else) is responsible for
57 IN VIRTIO_DEVICE_PROTOCOL
*VirtIo
,
65 Map the ring buffer so that it can be accessed equally by both guest
68 @param[in] VirtIo The virtio device instance.
70 @param[in] Ring The virtio ring to map.
72 @param[out] RingBaseShift A resulting translation offset, to be
73 passed to VirtIo->SetQueueAddress().
75 @param[out] Mapping A resulting token to pass to
76 VirtIo->UnmapSharedBuffer().
78 @return Status code from VirtIo->MapSharedBuffer()
83 IN VIRTIO_DEVICE_PROTOCOL
*VirtIo
,
85 OUT UINT64
*RingBaseShift
,
91 Tear down the internal resources of a configured virtio ring.
93 The caller is responsible to stop the host from using this ring before
94 invoking this function: the VSTAT_DRIVER_OK bit must be clear in
97 @param[in] VirtIo The virtio device which was using the ring.
99 @param[out] Ring The virtio ring to clean up.
105 IN VIRTIO_DEVICE_PROTOCOL
*VirtIo
,
111 // Internal use structure for tracking the submission of a multi-descriptor
122 Turn off interrupt notifications from the host, and prepare for appending
123 multiple descriptors to the virtio ring.
125 The calling driver must be in VSTAT_DRIVER_OK state.
127 @param[in,out] Ring The virtio ring we intend to append descriptors to.
129 @param[out] Indices The DESC_INDICES structure to initialize.
136 OUT DESC_INDICES
*Indices
142 Append a contiguous buffer for transmission / reception via the virtio ring.
144 This function implements the following section from virtio-0.9.5:
145 - 2.4.1.1 Placing Buffers into the Descriptor Table
147 Free space is taken as granted, since the individual drivers support only
148 synchronous requests and host side status is processed in lock-step with
149 request submission. It is the calling driver's responsibility to verify the
150 ring size in advance.
152 The caller is responsible for initializing *Indices with VirtioPrepare()
155 @param[in,out] Ring The virtio ring to append the buffer to, as a
158 @param[in] BufferPhysAddr (Guest pseudo-physical) start address of the
159 transmit / receive buffer.
161 @param[in] BufferSize Number of bytes to transmit or receive.
163 @param[in] Flags A bitmask of VRING_DESC_F_* flags. The caller
164 computes this mask dependent on further buffers to
165 append and transfer direction.
166 VRING_DESC_F_INDIRECT is unsupported. The
167 VRING_DESC.Next field is always set, but the host
168 only interprets it dependent on VRING_DESC_F_NEXT.
170 @param[in,out] Indices Indices->HeadDescIdx is not accessed.
171 On input, Indices->NextDescIdx identifies the next
172 descriptor to carry the buffer. On output,
173 Indices->NextDescIdx is incremented by one, modulo
181 IN UINTN BufferPhysAddr
,
182 IN UINT32 BufferSize
,
184 IN OUT DESC_INDICES
*Indices
190 Notify the host about the descriptor chain just built, and wait until the
193 @param[in] VirtIo The target virtio device to notify.
195 @param[in] VirtQueueId Identifies the queue for the target device.
197 @param[in,out] Ring The virtio ring with descriptors to submit.
199 @param[in] Indices Indices->NextDescIdx is not accessed.
200 Indices->HeadDescIdx identifies the head descriptor
201 of the descriptor chain.
203 @param[out] UsedLen On success, the total number of bytes, consecutively
204 across the buffers linked by the descriptor chain,
205 that the host wrote. May be NULL if the caller
206 doesn't care, or can compute the same information
207 from device-specific request structures linked by the
210 @return Error code from VirtIo->SetQueueNotify() if it fails.
212 @retval EFI_SUCCESS Otherwise, the host processed all descriptors.
218 IN VIRTIO_DEVICE_PROTOCOL
*VirtIo
,
219 IN UINT16 VirtQueueId
,
221 IN DESC_INDICES
*Indices
,
222 OUT UINT32
*UsedLen OPTIONAL
228 Report the feature bits to the VirtIo 1.0 device that the VirtIo 1.0 driver
231 In VirtIo 1.0, a device can reject a self-inconsistent feature bitmap through
232 the new VSTAT_FEATURES_OK status bit. (For example if the driver requests a
233 higher level feature but clears a prerequisite feature.) This function is a
234 small wrapper around VIRTIO_DEVICE_PROTOCOL.SetGuestFeatures() that also
235 verifies if the VirtIo 1.0 device accepts the feature bitmap.
237 @param[in] VirtIo Report feature bits to this device.
239 @param[in] Features The set of feature bits that the driver wishes
240 to report. The caller is responsible to perform
241 any masking before calling this function; the
242 value is directly written with
243 VIRTIO_DEVICE_PROTOCOL.SetGuestFeatures().
245 @param[in,out] DeviceStatus On input, the status byte most recently written
246 to the device's status register. On output (even
247 on error), DeviceStatus will be updated so that
248 it is suitable for further status bit
249 manipulation and writing to the device's status
252 @retval EFI_SUCCESS The device accepted the configuration in Features.
254 @return EFI_UNSUPPORTED The device rejected the configuration in Features.
256 @retval EFI_UNSUPPORTED VirtIo->Revision is smaller than 1.0.0.
258 @return Error codes from the SetGuestFeatures(),
259 SetDeviceStatus(), GetDeviceStatus() member
265 Virtio10WriteFeatures (
266 IN VIRTIO_DEVICE_PROTOCOL
*VirtIo
,
268 IN OUT UINT8
*DeviceStatus
272 Provides the virtio device address required to access system memory from a
275 The interface follows the same usage pattern as defined in UEFI spec 2.6
276 (Section 13.2 PCI Root Bridge I/O Protocol)
278 The VirtioMapAllBytesInSharedBuffer() is similar to VIRTIO_MAP_SHARED
279 with exception that NumberOfBytes is IN-only parameter. The function
280 maps all the bytes specified in NumberOfBytes param in one consecutive
283 @param[in] VirtIo The virtio device for which the mapping is
286 @param[in] Operation Indicates if the bus master is going to
287 read or write to system memory.
289 @param[in] HostAddress The system memory address to map to shared
292 @param[in] NumberOfBytes Number of bytes to map.
294 @param[out] DeviceAddress The resulting shared map address for the
295 bus master to access the hosts HostAddress.
297 @param[out] Mapping A resulting token to pass to
301 @retval EFI_SUCCESS The NumberOfBytes is succesfully mapped.
302 @retval EFI_UNSUPPORTED The HostAddress cannot be mapped as a
304 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
305 @retval EFI_OUT_OF_RESOURCES The request could not be completed due to
306 a lack of resources. This includes the case
307 when NumberOfBytes bytes cannot be mapped
308 in one consecutive range.
309 @retval EFI_DEVICE_ERROR The system hardware could not map the
314 VirtioMapAllBytesInSharedBuffer (
315 IN VIRTIO_DEVICE_PROTOCOL
*VirtIo
,
316 IN VIRTIO_MAP_OPERATION Operation
,
317 IN VOID
*HostAddress
,
318 IN UINTN NumberOfBytes
,
319 OUT EFI_PHYSICAL_ADDRESS
*DeviceAddress
,
322 #endif // _VIRTIO_LIB_H_