forked from oasis-tcs/virtio-spec
-
Notifications
You must be signed in to change notification settings - Fork 0
/
cl-os.tex
2593 lines (1654 loc) · 84.7 KB
/
cl-os.tex
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
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
d519c224ba69 & 20 Jun 2019 & Stefan Hajnoczi & { content: reserve virtio device ID for file system devices
Reserve device ID 26 for virtio-fs devices.
Fixes: \url{https://github.com/oasis-tcs/virtio-spec/issues/31}
Signed-off-by: Stefan Hajnoczi <[email protected]>
Signed-off-by: Michael S. Tsirkin <[email protected]>
See \ref{sec:Device Types}.
} \\
\hline
9454b568c29b & 20 Jun 2019 & Pankaj Gupta & { content: reserve device ID for virtio-pmem devices
We need a device ID for virtio-pmem devices. As 25 is requested by
audio device and 26 is requested by virtio-fs, so requesting
next available(27). Also, updated the previously requested github
issue[1] for voting.
Fixes: \url{https://github.com/oasis-tcs/virtio-spec/issues/38}
Reviewed-by: Cornelia Huck <[email protected]>
Signed-off-by: Pankaj Gupta <[email protected]>
Reviewed-by: Stefan Hajnoczi <[email protected]>
Signed-off-by: Michael S. Tsirkin <[email protected]>
See \ref{sec:Device Types}.
} \\
\hline
efd4028b7aec & 25 Jul 2019 & Dr. David Alan Gilbert & { shared memory: Define shared memory regions
Define the requirements and idea behind shared memory regions.
Fixes: \url{https://github.com/oasis-tcs/virtio-spec/issues/40}
Signed-off-by: Dr. David Alan Gilbert <[email protected]>
Reviewed-by: Stefan Hajnoczi <[email protected]>
Reviewed-by: Cornelia Huck <[email protected]>
Signed-off-by: Michael S. Tsirkin <[email protected]>
See \ref{sec:Basic Facilities of a Virtio Device / Shared Memory Regions}.
} \\
\hline
39dfc8afc0b9 & 25 Jul 2019 & Dr. David Alan Gilbert & { pci: Define id field
For the virtio-fs device we require multiple large shared memory
regions. Differentiate these by an 'id' field in the base capability.
Fixes: \url{https://github.com/oasis-tcs/virtio-spec/issues/40}
Signed-off-by: Dr. David Alan Gilbert <[email protected]>
Reviewed-by: Cornelia Huck <[email protected]>
Signed-off-by: Michael S. Tsirkin <[email protected]>
See \ref{sec:Virtio Transport Options / Virtio Over PCI Bus / Virtio Structure PCI Capabilities}.
} \\
\hline
8100dcfcd622 & 25 Jul 2019 & Dr. David Alan Gilbert & { pci: Define virtio_pci_cap64
Define 'virtio_pci_cap64' to allow capabilities to describe
memory regions larger than, or with an offset larger than 4GiB.
This will be used by the shared memory region capability.
Fixes: \url{https://github.com/oasis-tcs/virtio-spec/issues/40}
Signed-off-by: Dr. David Alan Gilbert <[email protected]>
Reviewed-by: Cornelia Huck <[email protected]>
Signed-off-by: Michael S. Tsirkin <[email protected]>
See \ref{sec:Virtio Transport Options / Virtio Over PCI Bus / Virtio Structure PCI Capabilities}.
} \\
\hline
855ad7af2bd6 & 25 Jul 2019 & Dr. David Alan Gilbert & { shared memory: Define PCI capability
Define the PCI capability used for enumerating shared memory regions.
Fixes: \url{https://github.com/oasis-tcs/virtio-spec/issues/40}
Signed-off-by: Dr. David Alan Gilbert <[email protected]>
Signed-off-by: Michael S. Tsirkin <[email protected]>
Reviewed-by: Cornelia Huck <[email protected]>
See \ref{sec:Virtio Transport Options / Virtio Over PCI Bus / PCI Device Layout / Shared memory capability}.
} \\
\hline
2dd2d468f69b & 25 Jul 2019 & Dr. David Alan Gilbert & { shared memory: Define mmio registers
Define an MMIO interface to discover and map shared
memory regions.
Fixes: \url{https://github.com/oasis-tcs/virtio-spec/issues/40}
Signed-off-by: Dr. David Alan Gilbert <[email protected]>
Reviewed-by: Stefan Hajnoczi <[email protected]>
Reviewed-by: Cornelia Huck <[email protected]>
Signed-off-by: Michael S. Tsirkin <[email protected]>
See \ref{sec:Virtio Transport Options / Virtio Over MMIO / MMIO Device Register Layout}.
} \\
\hline
4237d22cd5b1 & 08 Sep 2019 & Nikos Dragazis & { content: fix typo
Signed-off-by: Nikos Dragazis <[email protected]>
Signed-off-by: Michael S. Tsirkin <[email protected]>
Reviewed-by: Cornelia Huck <[email protected]>
See \ref{sec:Virtio Transport Options / Virtio Over PCI Bus / Virtio Structure PCI Capabilities}.
} \\
\hline
1571d741f300 & 08 Sep 2019 & Dr. David Alan Gilbert & { shared memory: Typo fix
Fix double hex in SHM*High defs.
Signed-off-by: Dr. David Alan Gilbert <[email protected]>
Signed-off-by: Michael S. Tsirkin <[email protected]>
Reviewed-by: Cornelia Huck <[email protected]>
Reviewed-by: Stefan Hajnoczi <[email protected]>
See \ref{sec:Virtio Transport Options / Virtio Over MMIO / MMIO Device Register Layout}.
} \\
\hline
7a25d74962d3 & 08 Sep 2019 & Tiwei Bie & { content: fix typo in feature bit name
Signed-off-by: Tiwei Bie <[email protected]>
Signed-off-by: Michael S. Tsirkin <[email protected]>
Fixes: \url{https://github.com/oasis-tcs/virtio-spec/issues/46}
Reviewed-by: Stefan Hajnoczi <[email protected]>
See \ref{sec:Device Types / Network Device / Device Operation / Control Virtqueue / VLAN Filtering}.
} \\
\hline
6aecd69eb90b & 08 Sep 2019 & Tiwei Bie & { content: explicitly document the VLAN filtering as best-effort
Similar to the MAC address based filtering, the VLAN filtering
is also best-effort in implementations, but it's not quite clear
in the spec. So document this behaviour explicitly to reflect
the way implementations behave.
Signed-off-by: Tiwei Bie <[email protected]>
Acked-by: Michael S. Tsirkin <[email protected]>
Reviewed-by: Cornelia Huck <[email protected]>
Signed-off-by: Michael S. Tsirkin <[email protected]>
Fixes: \url{https://github.com/oasis-tcs/virtio-spec/issues/47}
See \ref{sec:Device Types / Network Device / Device Operation / Control Virtqueue / VLAN Filtering}.
} \\
\hline
29540779e4fd & 25 Sep 2019 & Stefan Hajnoczi & { content: add virtio file system device
The virtio file system device transports Linux FUSE requests between a
FUSE daemon running on the host and the FUSE driver inside the guest.
The actual FUSE request definitions are not duplicated in the virtio
specification, similar to how virtio-scsi does not document SCSI
command details. FUSE request definitions are available here:
\url{https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/include/uapi/linux/fuse.h}
This patch documents the core virtio file system device, which is
functional but lacks the DAX feature introduced in the next patch.
Signed-off-by: Stefan Hajnoczi <[email protected]>
Reviewed-by: Cornelia Huck <[email protected]>
Signed-off-by: Michael S. Tsirkin <[email protected]>
Fixes: \url{https://github.com/oasis-tcs/virtio-spec/issues/49}
See \ref{sec:Device Types / File System Device}.
} \\
\hline
ef5a7f405b95 & 25 Sep 2019 & Stefan Hajnoczi & { virtio-fs: add DAX window
Describe how shared memory region ID 0 is the DAX window and how
FUSE_SETUPMAPPING maps file ranges into the window.
Signed-off-by: Stefan Hajnoczi <[email protected]>
Signed-off-by: Michael S. Tsirkin <[email protected]>
Reviewed-by: Cornelia Huck <[email protected]>
Fixes: \url{https://github.com/oasis-tcs/virtio-spec/issues/49}
See \ref{sec:Device Types / File System Device / Device Operation / Device Operation: DAX Window},
and \ref{sec:Device Types / File System Device / Security Considerations}.
} \\
\hline
1e30753d53d2 & 12 Oct 2019 & Jan Kiszka & { Fix \textasciicircum= in example code
Trying to escaping \textasciicircum\space here only leaves the backslash in the output.
Signed-off-by: Jan Kiszka <[email protected]>
Signed-off-by: Michael S. Tsirkin <[email protected]>
See \ref{sec:Basic Facilities of a Virtio Device / Packed Virtqueues / Supplying Buffers to The Device / Implementation Example},
and \ref{sec:Basic Facilities of a Virtio Device / Packed Virtqueues / Receiving Used Buffers From The Device}.
} \\
\hline
f9bed5bcb25e & 12 Oct 2019 & Jan Kiszka & { Lift "Driver Notifications" to section level
Currently, it slips under the Packed Virtqueues section while it is not
specific to this format.
At this chance, capitalize "Notifications".
Signed-off-by: Jan Kiszka <[email protected]>
Signed-off-by: Michael S. Tsirkin <[email protected]>
See \ref{sec:Virtqueues / Driver notifications}.
} \\
\hline
8f2c4e03eae8 & 27 Oct 2019 & Eugenio Pérez & { block: Add multiqueue
The spec miss that field. Add the field, some description around.
I've followed the network device's multiqueue mentions, and copied /
adapted when needed.
Fixes: \url{https://github.com/oasis-tcs/virtio-spec/issues/50}
Reviewed-by: Stefan Hajnoczi <[email protected]>
Signed-off-by: Eugenio Pérez <[email protected]>
Signed-off-by: Michael S. Tsirkin <[email protected]>
See \ref{sec:Device Types / Block Device},
\ref{sec:Device Types / Block Device / Virtqueues},
\ref{sec:Device Types / Block Device / Feature bits},
\ref{sec:Device Types / Block Device / Device configuration layout},
\ref{sec:Device Types / Block Device / Device Initialization},
and \ref{sec:Device Types / Block Device / Device Operation}.
} \\
\hline
f1f2f85c1482 & 27 Oct 2019 & Jan Kiszka & { Console Device: Add a missing word
Signed-off-by: Jan Kiszka <[email protected]>
See \ref{sec:Device Types / Console Device / Device Operation}.
} \\
\hline
da17c7fc4e12 & 27 Oct 2019 & Paolo Bonzini & { virtio_pci_common_cfg: fix field name
The field is named config_msix_vector in the rest of the document,
use the same name in the struct.
Signed-off-by: Michael S. Tsirkin <[email protected]>
Fixes: \url{https://github.com/oasis-tcs/virtio-spec/issues/41}
Reviewed-by: Stefan Hajnoczi <[email protected]>
See \ref{sec:Virtio Transport Options / Virtio Over PCI Bus / PCI Device Layout / Common configuration structure layout}.
} \\
\hline
f459b9e0ea60 & 27 Oct 2019 & Eugenio Pérez & { virtio-blk: typo: Capitalization in Device Initialization item
Signed-off-by: Eugenio Pérez <[email protected]>
Signed-off-by: Michael S. Tsirkin <[email protected]>
Fixes: \url{https://github.com/oasis-tcs/virtio-spec/issues/51}
Reviewed-by: Stefan Hajnoczi <[email protected]>
See \ref{sec:Device Types / Block Device / Device Initialization}.
} \\
\hline
30d8e1ad22f7 & 27 Oct 2019 & Philipp Hahn & { Balloon: Fix Memory Statistics structure size
5.5.6.3 Memory Statistics: 6 -> 10 byte
> Within the buffer, statistics are an array of 6-byte entries.
\textasciicircum
> Each statistic consists of a 16 bit tag and a 64 bit value.
...
> struct virtio_balloon_stat .
...
> le16 tag;
> le64 val;
> \} __attribute__((packed));
If my calculation is right that is a (16 + 64) = 80 bits which is a
10-byte sized entry - not 6-byte.
Fixes: \url{https://github.com/oasis-tcs/virtio-spec/issues/45}
Signed-off-by: Michael S. Tsirkin <[email protected]>
See \ref{sec:Device Types / Memory Balloon Device / Device Operation / Memory Statistics}.
} \\
\hline
acfe7bd5bcbe & 27 Oct 2019 & Michael S. Tsirkin & { README.md: document the minor cleanups standing rule
Signed-off-by: Michael S. Tsirkin <[email protected]>
} \\
\hline
a610121f250b & 24 Nov 2019 & Jan Kiszka & { virtio-mmio: Rename remaining QueueAvail/Used references
These have been changed in ae98c6bc21bc. Convert the rest.
Signed-off-by: Jan Kiszka <[email protected]>
Signed-off-by: Michael S. Tsirkin <[email protected]>
Reviewed-by: Stefan Hajnoczi <[email protected]>
Fixes: \url{https://github.com/oasis-tcs/virtio-spec/issues/52}
See \ref{sec:Virtio Transport Options / Virtio Over MMIO / MMIO Device Register Layout}.
} \\
\hline
4be5d38ad692 & 24 Nov 2019 & Stefan Fritsch & { Fix typo
It's balloon, not ballon.
Reviewed-by: Stefan Hajnoczi <[email protected]>
Signed-off-by: Stefan Fritsch <[email protected]>
Signed-off-by: Michael S. Tsirkin <[email protected]>
See \ref{sec:Device Types / Memory Balloon Device / Virtqueues}.
} \\
\hline
3109be870170 & 24 Nov 2019 & Paolo Bonzini & { Reserve id for virtio-audio device
Project ACRN has a virtio-audio device. Unfortunately, the id they are using is
already reserved in the virtio specification, but it is nevertheless useful to
have one.
Fixes: \url{https://github.com/oasis-tcs/virtio-spec/issues/42}
Signed-off-by: Paolo Bonzini <[email protected]>
Signed-off-by: Michael S. Tsirkin <[email protected]>
See \ref{sec:Device Types}.
} \\
\hline
4f1981a1ff46 & 24 Nov 2019 & Vitaly Mireyno & { virtio-net: Add support for correct hdr_len field.
Includes device implementation note for using hdr_len
Signed-off-by: Vitaly Mireyno <[email protected]>
Signed-off-by: Michael S. Tsirkin <[email protected]>
Fixes: \url{https://github.com/oasis-tcs/virtio-spec/issues/57}
See \ref{sec:Device Types / Network Device / Feature bits},
and \ref{sec:Device Types / Network Device / Device Operation / Packet Transmission}.
} \\
\hline
2c77526beb13 & 24 Nov 2019 & Cornelia Huck & { virtio-net: add missing articles for new hdr_len feature
And tweak a sentence slightly.
Reviewed-by: Stefan Hajnoczi <[email protected]>
Signed-off-by: Cornelia Huck <[email protected]>
Reviewed-by: Stefan Hajnoczi <[email protected]>
See \ref{sec:Device Types / Network Device / Device Operation / Packet Transmission}.
} \\
\hline
8c6acac22a99 & 27 Nov 2019 & Huang Yang & { Add virtio rpmb device specification
Add virtio RPMB (Replay Protected Memory Block) device documentation to
spec.
Signed-off-by: Yang Huang <[email protected]>
Reviewed-by: Bing Zhu <[email protected]>
Reviewed-by: Tomas Winkler <[email protected]>
Fixes: \url{https://github.com/oasis-tcs/virtio-spec/issues/53}
Signed-off-by: Michael S. Tsirkin <[email protected]>
See \ref{sec:Device Types / RPMB Device}.
} \\
\hline
e8ba780bd7ab & 27 Nov 2019 & Huang Yang & { Reserve device id 28 for virtio RPMB device
Signed-off-by: Huang Yang <[email protected]>
Signed-off-by: Michael S. Tsirkin <[email protected]>
Reviewed-by: Stefan Hajnoczi <[email protected]>
Fixes: \url{https://github.com/oasis-tcs/virtio-spec/issues/58}
See \ref{sec:Device Types}.
} \\
\hline
356aeeb40d7a & 20 Jan 2020 & Michael S. Tsirkin & { content: add vendor specific cfg type
Vendors might want to add their own capability in the PCI capability
list. However, Virtio already uses the vendor specific capability ID
(0x09) for its own purposes.
Provide a structure for vendor specific extensions.
Fixes: \url{https://github.com/oasis-tcs/virtio-spec/issues/62}
Signed-off-by: Michael S. Tsirkin <[email protected]>
See \ref{sec:Virtio Transport Options / Virtio Over PCI Bus / Virtio Structure PCI Capabilities},
and \ref{sec:Virtio Transport Options / Virtio Over PCI Bus / PCI Device Layout / Vendor data capability}.
} \\
\hline
50049af040d4 & 20 Jan 2020 & Michael S. Tsirkin & { virtio_pci_cap64: bar/BAR cleanups
When we mean PCI register we should say BAR.
When we mean a virtio config register we should say \textbackslash field\{cap.bar\}.
Finally, offset_hi/length_hi are not within the cap structure.
Tweak wording slightly: "A,B,C" are fields, there's no need
to say that.
Reported-by: Christophe de Dinechin <[email protected]>
Signed-off-by: Michael S. Tsirkin <[email protected]>
Reviewed-by: Cornelia Huck <[email protected]>
See \ref{sec:Virtio Transport Options / Virtio Over PCI Bus / Virtio Structure PCI Capabilities},
and \ref{sec:Virtio Transport Options / Virtio Over PCI Bus / PCI Device Layout / Shared memory capability}.
} \\
\hline
b6e992c7af88 & 20 Jan 2020 & Yuri Benditovich & { virtio-net: define support for receive-side scaling
Fixes: \url{https://github.com/oasis-tcs/virtio-spec/issues/48}
Added support for RSS receive steering mode.
Signed-off-by: Yuri Benditovich <[email protected]>
Signed-off-by: Michael S. Tsirkin <[email protected]>
See \ref{sec:Device Types / Network Device / Virtqueues},
\ref{sec:Device Types / Network Device / Feature bits},
\ref{sec:Device Types / Network Device / Feature bits / Feature bit requirements},
\ref{sec:Device Types / Network Device / Device configuration layout},
and \ref{sec:Device Types / Network Device / Device Operation / Control Virtqueue}.
} \\
\hline
8361dd6eb0f4 & 20 Jan 2020 & Michael S. Tsirkin & { virtio-net: receive-side scaling
Typo/grammar fixes as suggested by Cornelia (and a couple
noticed by myself).
Signed-off-by: Michael S. Tsirkin <[email protected]>
See \ref{sec:Device Types / Network Device / Device configuration layout},
and \ref{sec:Device Types / Network Device / Device Operation / Control Virtqueue}.
} \\
\hline
1efcda892193 & 20 Jan 2020 & Michael S. Tsirkin & { virtio-net: missing "." for feature descriptions
At end of each sentence, for consistency.
Signed-off-by: Michael S. Tsirkin <[email protected]>
See \ref{sec:Device Types / Network Device / Feature bits}.
} \\
\hline
652237ea2839 & 20 Jan 2020 & Jean-Philippe Brucker & { Add virtio-iommu device specification
The IOMMU device allows a guest to manage DMA mappings for physical,
emulated and paravirtualized endpoints. Add device description for the
virtio-iommu device and driver. Introduce PROBE, ATTACH, DETACH, MAP and
UNMAP requests, as well as translation error reporting.
Fixes: \url{https://github.com/oasis-tcs/virtio-spec/issues/37}
Signed-off-by: Jean-Philippe Brucker <[email protected]>
Signed-off-by: Michael S. Tsirkin <[email protected]>
See \ref{sec:Device Types / IOMMU Device}.
} \\
\hline
6914d2df75ec & 28 Jan 2020 & Keiichi Watanabe & { content: Reserve device ID for video encoder and decoder device
Reserve device ID 30 for video encoder device and 31 for video decoder device.
Signed-off-by: Keiichi Watanabe <[email protected]>
Signed-off-by: Michael S. Tsirkin <[email protected]>
Acked-by: Gerd Hoffmann <[email protected]>
See \ref{sec:Device Types}.
} \\
\hline
d7e91b5469fb & 28 Jan 2020 & Michael S. Tsirkin & { virtio-rng: fix device/driver confusion
The point of rng is to give data to driver so of course
all buffers are driver readable. What shouldn't be there
is device readable buffers - this matches our terminology
elsewhere too (read/write-ability is from POV of device).
Fixes: \url{https://github.com/oasis-tcs/virtio-spec/issues/55}
Signed-off-by: Michael S. Tsirkin <[email protected]>
Reviewed-by: Pankaj Gupta <[email protected]>
See \ref{sec:Device Types / Entropy Device / Device Operation}.
} \\
\hline
da60923ce164 & 28 Jan 2020 & Michael S. Tsirkin & { content: document speed, duplex
Document as used by Linux.
Fixes: \url{https://github.com/oasis-tcs/virtio-spec/issues/59}
Signed-off-by: Michael S. Tsirkin <[email protected]>
Reviewed-by: Cornelia Huck <[email protected]>
See \ref{sec:Device Types / Network Device / Feature bits},
and \ref{sec:Device Types / Network Device / Device configuration layout}.
} \\
\hline
61124330bf1c & 27 Feb 2020 & Gerd Hoffmann & { virtio-gpu: add 3d command overview
Add 3d commands to the command enumeration.
Add a section with a very short overview.
Fixes: \url{https://github.com/oasis-tcs/virtio-spec/issues/65}
Signed-off-by: Gerd Hoffmann <[email protected]>
Signed-off-by: Michael S. Tsirkin <[email protected]>
See \ref{sec:Device Types / GPU Device / Device Operation / Device Operation: Request header},
and \ref{sec:Device Types / GPU Device / Device Operation / Device Operation: controlq}.
} \\
\hline
0c0dd715152c & 27 Feb 2020 & Gerd Hoffmann & { virtio-gpu: some edid clarifications
Add some notes about fetching the EDID information.
Fixes: \url{https://github.com/oasis-tcs/virtio-spec/issues/64}
Signed-off-by: Gerd Hoffmann <[email protected]>
Signed-off-by: Michael S. Tsirkin <[email protected]>
See \ref{sec:Device Types / GPU Device / Device configuration layout},
and \ref{devicenormative:Device Types / GPU Device / Device Initialization}.
} \\
\hline
f42cc75d0725 & 01 Mar 2020 & Michael S. Tsirkin & { virtio-net/rss: maximal -> maximum
Maximal can mean "local as opposed to a global maximum". Rest of the
spec says maximum everywhere. Let's be consistent.
Cc: Yuri Benditovich <[email protected]>
Signed-off-by: Michael S. Tsirkin <[email protected]>
See \ref{sec:Device Types / Network Device / Device configuration layout}.
} \\
\hline
089bc5911dea & 04 May 2020 & Jean-Philippe Brucker & { virtio-iommu: Remove invalid requirement about padding
This reference to 'padding' is a leftover from a previous draft of the
virtio-iommu device. The field doesn't exist anymore, remove the
requirement.
Signed-off-by: Jean-Philippe Brucker <[email protected]>
Signed-off-by: Michael S. Tsirkin <[email protected]>
See \ref{sec:Device Types / IOMMU Device / Device configuration layout}.
} \\
\hline
e73c8cdf3e82 & 01 Sep 2020 & Anton Yakovlev & { virtio-snd: add virtio sound device specification
This patch proposes virtio specification for a new virtio sound device,
that may be useful in case when having audio is required but a device
passthrough or emulation is not an option.
Fixes: \url{https://github.com/oasis-tcs/virtio-spec/issues/54}
Signed-off-by: Anton Yakovlev <[email protected]>
Signed-off-by: Michael S. Tsirkin <[email protected]>
See \ref{sec:Device Types / Network Device / Device configuration layout}.
} \\
\hline
3f27648d9c66 & 01 Sep 2020 & Jan Kiszka & { split-ring: Demand that a device must not change descriptor entries
So far the spec only indirectly says that a descriptor table entry is
not modified by a device when processing it. Make this explicit by
adding it as normative requirement. Existing drivers already depend on
this.
See also \url{https://lists.oasis-open.org/archives/virtio-dev/201910/msg00057.html}.
Fixes: \url{https://github.com/oasis-tcs/virtio-spec/issues/56}
Signed-off-by: Jan Kiszka <[email protected]>
Signed-off-by: Michael S. Tsirkin <[email protected]>
See \ref{sec:Basic Facilities of a Virtio Device / Virtqueues / The Virtqueue Descriptor Table}.
} \\
\hline
3353ed1c255a & 01 Sep 2020 & Yuri Benditovich & { virtio-net: Define per-packet hash reporting feature
Define respective feature bit for virtio-net.
Extend packet layout to populate hash value and type.
Move the definition of IP/TCP/UDP header fields to
calculate the hash out of RSS section to common network
device section.
Fixes: \url{https://github.com/oasis-tcs/virtio-spec/issues/66}
Signed-off-by: Yuri Benditovich <[email protected]>
Signed-off-by: Michael S. Tsirkin <[email protected]>
See \ref{sec:Device Types / Network Device / Feature bits},
\ref{sec:Device Types / Network Device / Device configuration layout},
\ref{sec:Device Types / Network Device / Device Operation},
\ref{sec:Device Types / Network Device / Device Operation / Processing of Incoming Packets},
and \ref{sec:Device Types / Network Device / Device Operation / Control Virtqueue}.
} \\
\hline
51cad55ea64d & 01 Sep 2020 & Johannes Berg & { reserve device ID for hwsim wireless simulation
The Linux mac80211-hwsim module currently allows simulation of
multiple wireless radios on a shared medium, and has an existing
API for this to work through a userspace implementation of the
medium simulation (e.g. implemented by wmediumd).
In order to simplify working with virtual machines and to enable
(time-compressed) simulation use cases, allocate a virtio device
ID to allow carrying this protocol over virtio in addition to
the current netlink sockets.
Since device ID 28 was previously requested, use 29.
Signed-off-by: Johannes Berg <[email protected]>
Signed-off-by: Michael S. Tsirkin <[email protected]>
Fixes: \url{https://github.com/oasis-tcs/virtio-spec/issues/68}
See \ref{sec:Device Types}.
} \\
\hline
832099d5df8c & 01 Sep 2020 & Vitaly Mireyno & { virtio-net: Fix VIRTIO_NET_F_GUEST_HDRLEN feature definition.
Fix driver and device requirements with regards to the VIRTIO_NET_F_GUEST_HDRLEN feature - 'hdr_len' must be accurate only for TSO/UFO packets.
Signed-off-by: Vitaly Mireyno <[email protected]>
Signed-off-by: Michael S. Tsirkin <[email protected]>
Fixes: \url{https://github.com/oasis-tcs/virtio-spec/issues/72}
See \ref{sec:Device Types / Network Device / Device Operation / Packet Transmission}.
} \\
\hline
5d9444d699e5 & 01 Sep 2020 & Peter Hilber & { Reserve device ID 32 for SCMI device
Signed-off-by: Peter Hilber <[email protected]>
Signed-off-by: Michael S. Tsirkin <[email protected]>
Fixes: \url{https://github.com/oasis-tcs/virtio-spec/issues/74}
Reviewed-by: Stefan Hajnoczi <[email protected]>
See \ref{sec:Device Types}.
} \\
\hline
68f66ff7a3d9 & 01 Sep 2020 & David Stevens & { content: define what an exported object is
Define a mechanism for sharing objects between different virtio
devices.
Fixes: \url{https://github.com/oasis-tcs/virtio-spec/issues/76}
Signed-off-by: David Stevens <[email protected]>
Signed-off-by: Michael S. Tsirkin <[email protected]>
See \ref{sec:Basic Facilities of a Virtio Device / Exporting Objects}.
} \\
\hline
162578b7e26c & 01 Sep 2020 & David Stevens & { virtio-gpu: add the ability to export resources
Fixes: \url{https://github.com/oasis-tcs/virtio-spec/issues/76}
Signed-off-by: David Stevens <[email protected]>
Signed-off-by: Michael S. Tsirkin <[email protected]>
See \ref{sec:Device Types / GPU Device / Feature bits},
\ref{sec:Device Types / GPU Device / Device Operation / Device Operation: Request header},
and \ref{sec:Device Types / GPU Device / Device Operation / Device Operation: controlq}.
} \\
\hline
12d74846a6ee & 01 Sep 2020 & Petre Eftime & { content: Reserve virtio-nsm device ID
The NitroSecureModule is a device with a very stripped down
Trusted Platform Module functionality, which is used in the
context of a Nitro Enclave (see \url{https://lkml.org/lkml/2020/4/21/1020})
to provide boot time measurement and attestation.
Since this device provides some critical cryptographic operations,
there are a series of operations which are required to have guarantees
of atomicity, ordering and consistency: operations fully succeed or fully
fail, including when some external events might interfere in the
process: live migration, crashes, etc; any failure in the critical
section requires termination of the enclave it is attached to, so
the device needs to be as resilient as possible, simplicity is
strongly desired.
To account for that, the device and driver are made to have very few
error cases in the critical path and the operations themselves can be
rolled back and retried if events happen outside the critical
area, while processing a request. The driver itself can be made very
simple and thus is easily portable.
Since the requests can be handled directly in the virtio queue, serving
most requests requires no additional buffering or memory allocations
on the host side.
Signed-off-by: Petre Eftime <[email protected]>
Signed-off-by: Michael S. Tsirkin <[email protected]>
Reviewed-by: Stefan Hajnoczi <[email protected]>
Fixes: \url{https://github.com/oasis-tcs/virtio-spec/issues/81}
See \ref{sec:Device Types}.
} \\
\hline
7a46ee550d70 & 01 Sep 2020 & David Hildenbrand & { conformance: make driver conformance list easier to read and maintain
Let's define it just like the device conformance list.
Reviewed-by: Cornelia Huck <[email protected]>
Signed-off-by: David Hildenbrand <[email protected]>
Signed-off-by: Michael S. Tsirkin <[email protected]>
See \ref{sec:Conformance / Conformance Targets}.
} \\
\hline
9abf00ff4654 & 01 Sep 2020 & David Hildenbrand & { conformance: Reference RPMB Driver Conformance
We forgot to reference the driver conformance.
Reviewed-by: Cornelia Huck <[email protected]>
Cc: Yang Huang <[email protected]>
Signed-off-by: David Hildenbrand <[email protected]>
Signed-off-by: Michael S. Tsirkin <[email protected]>
Reviewed-by: Alex Bennée <[email protected]>
See \ref{sec:Conformance / Conformance Targets}.
} \\
\hline
af6b93bfd9a0 & 01 Sep 2020 & David Hildenbrand & { Add virtio-mem device specification
The virtio memory device provides and manages a memory region in guest
physical address space. This memory region is partitioned into memory
blocks of fixed size that can either be in the state plugged or unplugged.
Specify the device configuration, initialization, and operation.
Introduce PLUG, UNPLUG, UNPLUG ALL and STATE requests.
Fixes: \url{https://github.com/oasis-tcs/virtio-spec/issues/82}
Cc: teawater <[email protected]>
Signed-off-by: David Hildenbrand <[email protected]>
Signed-off-by: Michael S. Tsirkin <[email protected]>
See \ref{sec:Device Types / Memory Device}.
} \\
\hline
28ea45d8d79f & 11 Nov 2020 & Jie Deng & { content: Reserve device ID 34 for I2C adapter
Request the ID 34 for I2C adapter.
Fixes: \url{https://github.com/oasis-tcs/virtio-spec/issues/85}
Signed-off-by: Jie Deng <[email protected]>
Signed-off-by: Cornelia Huck <[email protected]>
See \ref{sec:Device Types}.
} \\
\hline
d44895cdadc0 & 11 Nov 2020 & Rob Bradford & { content: Reserve virtio-watchog device ID
Reserve an ID for a watchdog device which may be used to ensure that the
guest is responsive. This is equivalent of a hardware watchdog device
and will trigger the reboot of the guest if the the host does not
periodic ping from the the guest.
Fixes: \url{https://github.com/oasis-tcs/virtio-spec/issues/87}
Signed-off-by: Rob Bradford <[email protected]>
Signed-off-by: Cornelia Huck <[email protected]>
See \ref{sec:Device Types}.
} \\
\hline
38448268eba0 & 11 Nov 2020 & Alexander Duyck & { content: Document balloon feature free page hints
Free page hints allow the balloon driver to provide information on what
pages are not currently in use so that we can avoid the cost of copying
them in migration scenarios. Add a feature description for free page hints
describing basic functioning and requirements.
Fixes: \url{https://github.com/oasis-tcs/virtio-spec/issues/84}
Acked-by: Cornelia Huck <[email protected]>
Reviewed-by: David Hildenbrand <[email protected]>
Signed-off-by: Alexander Duyck <[email protected]>
Signed-off-by: Cornelia Huck <[email protected]>
See \ref{sec:Device Types / Memory Balloon Device / Virtqueues},
\ref{sec:Device Types / Memory Balloon Device / Feature bits},
\ref{sec:Device Types / Memory Balloon Device / Device configuration layout},
\ref{sec:Device Types / Memory Balloon Device / Device Initialization},
and \ref{sec:Device Types / Memory Balloon Device / Device Operation / Free Page Hinting}.
} \\
\hline
4749f03e72f8 & 11 Nov 2020 & Alexander Duyck & { content: Document balloon feature page poison
Page poison provides a way for the guest to notify the host that it is
initializing or poisoning freed pages with some specific poison value. As a
result of this we can infer a couple traits about the guest:
1. Free pages will contain a specific pattern within the guest.
2. Modifying free pages from this value may cause an error in the guest.
3. Pages will be immediately written to by the driver when deflated.
There are currently no existing features that make use of this data. In the
upcoming feature free page reporting we will need to make use of this to
identify if we can evict pages from the guest without causing data
corruption.
Add documentation for the page poison feature describing the basic
functionality and requirements.
Fixes: \url{https://github.com/oasis-tcs/virtio-spec/issues/84}
Reviewed-by: Cornelia Huck <[email protected]>
Reviewed-by: David Hildenbrand <[email protected]>
Signed-off-by: Alexander Duyck <[email protected]>
Signed-off-by: Cornelia Huck <[email protected]>
See \ref{sec:Device Types / Memory Balloon Device / Feature bits},
\ref{sec:Device Types / Memory Balloon Device / Device configuration layout},
\ref{sec:Device Types / Memory Balloon Device / Device Initialization},
and \ref{sec:Device Types / Memory Balloon Device / Device Operation / Page Poison}.
} \\
\hline
d917d4a8d552 & 11 Nov 2020 & Alexander Duyck & { content: Document balloon feature free page reporting
Free page reporting is a feature that allows the guest to proactively
report unused pages to the host. By making use of this feature is is
possible to reduce the overall memory footprint of the guest in cases where
some significant portion of the memory is idle. Add documentation for the
free page reporting feature describing the functionality and requirements.
Fixes: \url{https://github.com/oasis-tcs/virtio-spec/issues/84}
Reviewed-by: Cornelia Huck <[email protected]>
Reviewed-by: David Hildenbrand <[email protected]>