L4Re Operating System Framework
Interface and Usage Documentation
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
virtio.h
1/* SPDX-License-Identifier: MIT */
2/*
3 * Copyright (C) 2013-2022, 2024 Kernkonzept GmbH.
4 * Author(s): Alexander Warg <alexander.warg@kernkonzept.com>
5 * Matthias Lange <matthias.lange@kernkonzept.com>
6 *
7 */
8#pragma once
9
28#include <l4/sys/utcb.h>
29#include <l4/sys/ipc.h>
30#include <l4/sys/types.h>
31
34{
35 L4VIRTIO_PROTOCOL = 0,
36};
37
38enum L4virtio_magic
39{
40 L4VIRTIO_MAGIC = 0x74726976
41};
42
43enum L4virtio_vendor
44{
45 L4VIRTIO_VENDOR_KK = 0x44
46};
47
59
83
94
103
113
126
131{
132 /* Virtio(0x00): device config */
138 /* Virtio(0x10): device features */
140 l4_uint32_t dev_features_sel;
141 l4_uint32_t _res1[2];
142
143 /* Virtio(0x20): driver features */
144 l4_uint32_t driver_features;
145 l4_uint32_t driver_features_sel;
146
147 /* L4Virtio(0x28): L4 queue */
151 /* Virtio(0x30): queue status */
152 l4_uint32_t queue_sel;
153 l4_uint32_t queue_num_max;
154 l4_uint32_t queue_num;
155 l4_uint32_t _res3[2];
156 l4_uint32_t queue_ready;
157 l4_uint32_t _res4[2];
158
159 /* Virtio(0x50): queue notify */
160 l4_uint32_t queue_notify;
161 l4_uint32_t _res5[3];
162
163 /* Virtio(0x60): interrupt handling */
164 l4_uint32_t irq_status;
165 l4_uint32_t irq_ack;
166 l4_uint32_t _res6[2];
167
168 /* Virtio(0x70): Device status register (read-only). The register must be
169 * written using l4virtio_set_status(). */
170 l4_uint32_t status;
171
172 /* L4Virtio(0x74): W: Event index to be used for config notifications (device to driver) */
173 l4_uint32_t cfg_driver_notify_index;
174 /* L4Virtio(0x78): R: Event index to be used for config notifications (driver to device) */
175 l4_uint32_t cfg_device_notify_index;
176
177 /* L4Virtio(0x7c) L4 specific command register polled by the driver iff supported */
178 l4_uint32_t cmd;
179
180 /* Virtio(0x80): queue descriptors */
181 l4_uint64_t queue_desc;
182 l4_uint32_t _res8[2];
183 l4_uint64_t queue_avail;
184 l4_uint32_t _res9[2];
185 l4_uint64_t queue_used;
186
187 l4_uint32_t _res10[1];
188
189 /* Virtio(0xac): shared memory region */
190 l4_uint32_t shm_sel;
191 l4_uint64_t shm_len;
192 l4_uint64_t shm_base;
193
194 /* L4Virtio(0xc0): use the unused space here for device and driver feature bitmaps */
195 l4_uint32_t dev_features_map[6];
196 l4_uint32_t _res11[2];
197 l4_uint32_t driver_features_map[6];
198 l4_uint32_t _res12[1];
199
200 /* Virtio(0xfc): config generation */
201 l4_uint32_t generation;
203
241
243
254
260L4_INLINE void *
262{
263 return (void *)(((l4_addr_t)cfg) + 0x100);
264}
265
269L4_INLINE void
270l4virtio_set_feature(l4_uint32_t *feature_map, unsigned feat)
271{
272 unsigned idx = feat / 32;
273
274 if (idx < 8)
275 feature_map[idx] |= 1UL << (feat % 32);
276}
277
281L4_INLINE void
282l4virtio_clear_feature(l4_uint32_t *feature_map, unsigned feat)
283{
284 unsigned idx = feat / 32;
285
286 if (idx < 8)
287 feature_map[idx] &= ~(1UL << (feat % 32));
288}
289
293L4_INLINE unsigned
294l4virtio_get_feature(l4_uint32_t *feature_map, unsigned feat)
295{
296 unsigned idx = feat / 32;
297
298 if (idx >= 8)
299 return 0;
300
301 return feature_map[idx] & (1UL << (feat % 32));
302}
303
309L4_CV int
311
317L4_CV int
319
325L4_CV int
327 l4_uint64_t base, l4_umword_t offset,
329
335L4_CV int
337 l4_addr_t *ds_offset) L4_NOTHROW;
338
344L4_CV int
347
349
unsigned long l4_umword_t
Unsigned machine word.
Definition l4int.h:40
unsigned long l4_addr_t
Address type.
Definition l4int.h:34
unsigned int l4_uint32_t
Unsigned 32bit value.
Definition l4int.h:29
unsigned short int l4_uint16_t
Unsigned 16bit value.
Definition l4int.h:27
unsigned long long l4_uint64_t
Unsigned 64bit value.
Definition l4int.h:31
unsigned long l4_cap_idx_t
Capability selector type.
Definition types.h:335
#define __END_DECLS
End section with C types and functions.
Definition compiler.h:167
#define L4_CV
Define calling convention.
Definition linkage.h:33
#define L4_NOTHROW
Mark a function declaration and definition as never throwing an exception.
Definition compiler.h:159
#define L4_INLINE
L4 Inline function attribute.
Definition compiler.h:51
#define __BEGIN_DECLS
Start section with C types and functions.
Definition compiler.h:164
L4virtio_feature_bits
L4virtio-specific feature bits.
Definition virtio.h:97
L4virtio_device_status
Virtio device status bits.
Definition virtio.h:86
int l4virtio_set_status(l4_cap_idx_t cap, unsigned status) L4_NOTHROW
int l4virtio_device_notification_irq(l4_cap_idx_t cap, unsigned index, l4_cap_idx_t irq) L4_NOTHROW
L4_virtio_opcodes
Opcodes to setup and configure a device.
Definition virtio.h:52
l4virtio_config_queue_t * l4virtio_config_queues(l4virtio_config_hdr_t const *cfg)
Get the pointer to the first queue config.
Definition virtio.h:250
L4_virtio_cmd
Virtio commands for device configuration.
Definition virtio.h:118
L4_virtio_protocol
L4-VIRTIO protocol number.
Definition virtio.h:34
int l4virtio_config_queue(l4_cap_idx_t cap, unsigned queue) L4_NOTHROW
int l4virtio_device_config_ds(l4_cap_idx_t cap, l4_cap_idx_t config_ds, l4_addr_t *ds_offset) L4_NOTHROW
L4virtio_device_ids
Virtio device IDs as reported in the driver's config space.
Definition virtio.h:62
void * l4virtio_device_config(l4virtio_config_hdr_t const *cfg)
Get the pointer to the device configuration.
Definition virtio.h:261
void l4virtio_clear_feature(l4_uint32_t *feature_map, unsigned feat)
Clear the given feature bit in a feature map.
Definition virtio.h:282
void l4virtio_set_feature(l4_uint32_t *feature_map, unsigned feat)
Set the given feature bit in a feature map.
Definition virtio.h:270
int l4virtio_register_ds(l4_cap_idx_t cap, l4_cap_idx_t ds_cap, l4_uint64_t base, l4_umword_t offset, l4_umword_t size) L4_NOTHROW
unsigned l4virtio_get_feature(l4_uint32_t *feature_map, unsigned feat)
Check if the given bit in a feature map is set.
Definition virtio.h:294
L4_virtio_irq_status
VIRTIO IRQ status codes (l4virtio_config_hdr_t::irq_status).
Definition virtio.h:109
@ L4VIRTIO_FEATURE_CMD_CONFIG
Status and queue config are set via cmd field instead of via IPC.
Definition virtio.h:101
@ L4VIRTIO_FEATURE_VERSION_1
Virtio protocol version 1 supported. Must be 1 for L4virtio.
Definition virtio.h:99
@ L4VIRTIO_STATUS_DRIVER
Guest OS knows how to drive device.
Definition virtio.h:88
@ L4VIRTIO_STATUS_FAILED
Driver detected fatal error.
Definition virtio.h:92
@ L4VIRTIO_STATUS_ACKNOWLEDGE
Guest OS has found device.
Definition virtio.h:87
@ L4VIRTIO_STATUS_FEATURES_OK
Driver has acknowledged feature set.
Definition virtio.h:90
@ L4VIRTIO_STATUS_DRIVER_OK
Driver is set up.
Definition virtio.h:89
@ L4VIRTIO_STATUS_DEVICE_NEEDS_RESET
Device detected fatal error.
Definition virtio.h:91
@ L4VIRTIO_OP_SET_STATUS
Write device status register.
Definition virtio.h:53
@ L4VIRTIO_OP_GET_DEVICE_IRQ
Retrieve device notification IRQ.
Definition virtio.h:57
@ L4VIRTIO_OP_DEVICE_CONFIG
Get device config page.
Definition virtio.h:56
@ L4VIRTIO_OP_CONFIG_QUEUE
Configure queue.
Definition virtio.h:54
@ L4VIRTIO_OP_REGISTER_DS
Register shared memory with device.
Definition virtio.h:55
@ L4VIRTIO_CMD_NOTIFY_QUEUE
Configure a queue.
Definition virtio.h:123
@ L4VIRTIO_CMD_NONE
No command pending.
Definition virtio.h:119
@ L4VIRTIO_CMD_SET_STATUS
Set the status register.
Definition virtio.h:120
@ L4VIRTIO_CMD_CFG_QUEUE
Configure a queue.
Definition virtio.h:121
@ L4VIRTIO_CMD_MASK
Mask to get command bits.
Definition virtio.h:124
@ L4VIRTIO_CMD_CFG_CHANGED
Device config changed.
Definition virtio.h:122
@ L4VIRTIO_ID_SCSI
SCSI host device.
Definition virtio.h:69
@ L4VIRTIO_ID_BLOCK
General block device.
Definition virtio.h:64
@ L4VIRTIO_ID_BALLOON
Memory ballooning device.
Definition virtio.h:67
@ L4VIRTIO_ID_RPMSG
Device using rpmsg protocol.
Definition virtio.h:68
@ L4VIRTIO_ID_INPUT
Input.
Definition virtio.h:74
@ L4VIRTIO_ID_RPROC_SERIAL
Rproc serial device.
Definition virtio.h:71
@ L4VIRTIO_ID_CONSOLE
Simple device for data IO via ports.
Definition virtio.h:65
@ L4VIRTIO_ID_FS
FS.
Definition virtio.h:77
@ L4VIRTIO_ID_RNG
Entropy source.
Definition virtio.h:66
@ L4VIRTIO_ID_NET
Virtual ethernet card.
Definition virtio.h:63
@ L4VIRTIO_ID_SOCK
Unofficial socket device.
Definition virtio.h:81
@ L4VIRTIO_ID_CRYPTO
Crypto.
Definition virtio.h:76
@ L4VIRTIO_ID_VSOCK
Vsock transport.
Definition virtio.h:75
@ L4VIRTIO_ID_GPU
GPU.
Definition virtio.h:73
@ L4VIRTIO_ID_I2C
I2C device.
Definition virtio.h:79
@ L4VIRTIO_ID_9P
Device using 9P transport protocol.
Definition virtio.h:70
@ L4VIRTIO_ID_CAIF
Device using CAIF network protocol.
Definition virtio.h:72
@ L4VIRTIO_ID_SCMI
Scmi device.
Definition virtio.h:78
@ L4VIRTIO_IRQ_STATUS_VRING
VRING IRQ pending flag.
Definition virtio.h:110
@ L4VIRTIO_IRQ_STATUS_CONFIG
CONFIG IRQ pending flag.
Definition virtio.h:111
Common L4 ABI Data Types.
L4-VIRTIO config header, provided in shared data space.
Definition virtio.h:131
l4_uint32_t vendor
vendor ID
Definition virtio.h:136
l4_uint32_t magic
magic value (must be 'virt').
Definition virtio.h:133
l4_uint32_t dev_features
device features windows selected by device_feature_sel
Definition virtio.h:139
l4_uint32_t queues_offset
offset of virtqueue config array
Definition virtio.h:149
l4_uint32_t device
device ID
Definition virtio.h:135
l4_uint32_t num_queues
number of virtqueues
Definition virtio.h:148
l4_uint32_t version
VIRTIO version.
Definition virtio.h:134
Queue configuration entry.
Definition virtio.h:222
l4_uint16_t device_notify_index
R: Event index to be used by the driver (driver to device)
Definition virtio.h:239
l4_uint16_t driver_notify_index
W: Event index to be used for device notifications (device to driver)
Definition virtio.h:232
l4_uint64_t avail_addr
W: address of available ring.
Definition virtio.h:235
l4_uint64_t desc_addr
W: address of descriptor table.
Definition virtio.h:234
l4_uint64_t used_addr
W: address of used ring.
Definition virtio.h:236
l4_uint16_t ready
RW: queue ready flag (read-write)
Definition virtio.h:229
l4_uint16_t num_max
R: maximum number of descriptors supported by this queue.
Definition virtio.h:224
l4_uint16_t num
RW: number of descriptors configured for this queue.
Definition virtio.h:226