forked from oasis-tcs/virtio-spec
-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathcl-os-1.3wd01_to_1.4.tex
More file actions
2956 lines (2191 loc) · 94.5 KB
/
cl-os-1.3wd01_to_1.4.tex
File metadata and controls
2956 lines (2191 loc) · 94.5 KB
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
db68dc046b32 & 28 Sep 2023 & Cornelia Huck & { Revert "remove enumerate usage that makes the tool unhappy"
\newline
This reverts commit 3abace87db23ddceaf9688a405dd3fd540023977.
\newline
We can fix it properly instead.
\newline
Signed-off-by: Cornelia Huck <cohuck@redhat.com>\newline
} \\
\hline
c7bef01491d0 & 28 Sep 2023 & Michael S. Tsirkin & { html: add missing enumitem package
\newline
makediffhtml.sh currently fails with:
\newline
! Missing number, treated as zero.
<to be read again>
\textbackslash c@*
l.25850 \textbackslash begin\{enumerate\}[label=\textbackslash alph*
.]
?
! Emergency stop.
<to be read again>
\textbackslash c@*
l.25850 \textbackslash begin\{enumerate\}[label=\textbackslash alph*
.]
\newline
Some web searches turned up suggestions to use enumitem and in fact,
virtio.tex already does this - but virtio-html.tex doesn't.
\newline
Adding \textbackslash usepackage\{enumitem\} in virtio-html.tex too fixes the issue.
\newline
Signed-off-by: Michael S. Tsirkin <mst@redhat.com>\newline
Signed-off-by: Cornelia Huck <cohuck@redhat.com>\newline
} \\
\hline
3fdaa170307f & 30 Oct 2023 & jeshwank & { virtio-tee: Reserve device ID 46 for TEE device
\newline
In a virtual environment, an application running in guest VM may want
to delegate security sensitive tasks to a Trusted Application (TA)
running within a Trusted Execution Environment (TEE). A TEE is a trusted
OS running in some secure environment, for example, TrustZone on ARM
CPUs, or a separate secure co-processor etc.
\newline
A virtual TEE device emulates a TEE within a guest VM. Such a virtual
TEE device supports multiple operations such as:
\newline
VIRTIO_TEE_CMD_OPEN_DEVICE – Open a communication channel with virtio
TEE device.
VIRTIO_TEE_CMD_CLOSE_DEVICE – Close communication channel with virtio
TEE device.
VIRTIO_TEE_CMD_GET_VERSION – Get version of virtio TEE.
VIRTIO_TEE_CMD_OPEN_SESSION – Open a session to communicate with
trusted application running in TEE.
VIRTIO_TEE_CMD_CLOSE_SESSION – Close a session to end communication
with trusted application running in TEE.
VIRTIO_TEE_CMD_INVOKE_FUNC – Invoke a command or function in trusted
application running in TEE.
VIRTIO_TEE_CMD_CANCEL_REQ – Cancel an ongoing command within TEE.
VIRTIO_TEE_CMD_REGISTER_MEM - Register shared memory with TEE.
VIRTIO_TEE_CMD_UNREGISTER_MEM - Unregister shared memory from TEE.
\newline
We would like to reserve device ID 46 for Virtio-TEE device.
\newline
Fixes: \url{https://github.com/oasis-tcs/virtio-spec/issues/175}\newline
Signed-off-by: Jeshwanth Kumar <jeshwanthkumar.nk@amd.com>\newline
Reviewed-by: Rijo Thomas <Rijo-john.Thomas@amd.com>\newline
Reviewed-by: Parav Pandit <parav@nvidia.com>\newline
Acked-by: Sumit Garg <sumit.garg@linaro.org>\newline
Signed-off-by: Cornelia Huck <cohuck@redhat.com>\newline
} \\
\hline
42f389989823 & 30 Oct 2023 & Xuan Zhuo & { virtio-net: support device stats
\newline
This patch allows the driver to obtain some statistics from the device.
\newline
In the device implementation, we can count a lot of such information,
which can be used for debugging and judging the running status of the
device. We hope to directly display it to the user through ethtool.
\newline
To get stats atomically, try to get stats for all/multiple queue pairs
in one command.
\newline
Fixes: \url{https://github.com/oasis-tcs/virtio-spec/issues/180}\newline
Signed-off-by: Xuan Zhuo <xuanzhuo@linux.alibaba.com>\newline
Suggested-by: Michael S. Tsirkin <mst@redhat.com>\newline
Reviewed-by: Parav Pandit <parav@nvidia.com>\newline
Signed-off-by: Cornelia Huck <cohuck@redhat.com>\newline
} \\
\hline
925b42e3f72f & 30 Oct 2023 & Parav Pandit & { conformance: Add missing virtqueue reset conformance references
\newline
Add the missing references to the virtqueue reset related conformance
requirements.
\newline
Signed-off-by: Parav Pandit <parav@nvidia.com>\newline
Reviewed-by: Xuan Zhuo <xuanzhuo@linux.alibaba.com>\newline
[CH: pushed as an editorial change]
Signed-off-by: Cornelia Huck <cohuck@redhat.com>\newline
} \\
\hline
68d5cc4fe408 & 30 Oct 2023 & Parav Pandit & { packed-ring: Change host,guest to device,driver
\newline
Rest of the packed ring description already uses the device
and driver terminology. Change the introductory line as well from
host and guest to device and driver respectively.
\newline
Signed-off-by: Parav Pandit <parav@nvidia.com>\newline
Acked-by: Michael S. Tsirkin <mst@redhat.com>\newline
[CH: pushed as an editorial update]
Signed-off-by: Cornelia Huck <cohuck@redhat.com>\newline
} \\
\hline
c8249d73d2fd & 30 Oct 2023 & Cornelia Huck & { editorial: allow for longer device id table
\newline
Move to "longtable" to allow the table to span multiple pages (it
became too long to fit on one page with the latest addition.)
\newline
Signed-off-by: Cornelia Huck <cohuck@redhat.com>\newline
} \\
\hline
eb16e3397177 & 03 Nov 2023 & Cornelia Huck & { editorial: various fixes for 1.3-csd01
\newline
- Set approval date to 06 October 2023. (applies to front page subtitle,
citation format, PDF page footers)
\newline
- Set filenames and URIs to show csd01 instead of wd01 (also PDF footers)
\newline
- Set "Previous stage" to "N/A" (don't list a different numbered Version)
\newline
- In "Related work", change (3x) text - "Latest version" to "Latest stage"
\newline
- In "Notices", set the copyright year to 2023.
\newline
- In the first line of Appendix D. Revision History, replace "the previous
version" with "Version 1.2"
\newline
- In Section 1.3, apply the current IETF-recommended text:
"The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and
"OPTIONAL" in this document are to be interpreted as described in BCP 14
[[RFC2119](\#link)] and [[RFC8174](\#link)] when, and only when, they appear
in all capitals, as shown here."
\newline
- Also, add the RFC 8174 reference:
[RFC8174]
Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words", BCP
14, RFC 8174, DOI 10.17487/RFC8174, May 2017,
\url{https://www.rfc-editor.org/info/rfc8174.}
\newline
Reported-by: Paul Knight <paul.knight@oasis-open.org>\newline
Signed-off-by: Cornelia Huck <cohuck@redhat.com>\newline
} \\
\hline
43a948ec6a92 & 03 Nov 2023 & Cornelia Huck & { editorial: update "Computer Language Definitions" URL
\newline
Split out from the other fixes for 1.3-csd01 so that we can fixup the
diff.
\newline
- In "Status", (fourth paragraph) change the hyperlink under (Computer
Language Definitions) to be "
\url{https://www.oasis-open.org/policies-guidelines/tc-process-2017-05-26/\#wpComponentsCompLang}
"
\newline
Reported-by: Paul Knight <paul.knight@oasis-open.org>\newline
Signed-off-by: Cornelia Huck <cohuck@redhat.com>\newline
} \\
\hline
5fc35a7efb90 & 03 Nov 2023 & Cornelia Huck & { makediff: update list of cherry-picks
\newline
We don't need to apply the old commits anymore, but we have to apply
the URL update to work around a not-yet-debugged latexdiff problem.
\newline
Signed-off-by: Cornelia Huck <cohuck@redhat.com>\newline
} \\
\hline
4cb03b12dc95 & 17 Nov 2023 & Parav Pandit & { description: Avoid splitting the word virtqueue
\newline
Don't split the word virtqueue.
\newline
Signed-off-by: Parav Pandit <parav@nvidia.com>\newline
[CH: applied as editorial]
Signed-off-by: Cornelia Huck <cohuck@redhat.com>\newline
} \\
\hline
878a5e7287d7 & 13 Feb 2024 & Shujun Xue & { Define the DEVICE ID of Virtio Cpu balloon device as 47.
\newline
The Virtio CPU balloon device is a primitive device for managing guest
CPU capacity: the device asks for certain CPU cores to be online,
offline or throttled, and the driver performs the requested operation.
This allows the guest to adapt to changes in allowance of underlying
CPU capacity.
\newline
Fixes: \url{https://github.com/oasis-tcs/virtio-spec/issues/187}\newline
Signed-off-by: Shujun Xue <shujunxue@google.com>\newline
Signed-off-by: Cornelia Huck <cohuck@redhat.com>\newline
} \\
\hline
07bb9f7f642d & 13 Feb 2024 & Harald Mommer & { virtio-can: Device specification.
\newline
virtio-can is a virtual CAN device. It provides a way to give access to
a CAN controller from a driver guest. The device is aimed to be used by
driver guests running a HLOS as well as by driver guests running a
typical RTOS as used in controller environments.
\newline
Fixes: \url{https://github.com/oasis-tcs/virtio-spec/issues/186}\newline
Signed-off-by: Harald Mommer <Harald.Mommer@opensynergy.com>\newline
Signed-off-by: Mikhail Golubev-Ciuchea <Mikhail.Golubev-Ciuchea@opensynergy.com>\newline
Signed-off-by: Cornelia Huck <cohuck@redhat.com>\newline
} \\
\hline
193daee1d7a3 & 13 Feb 2024 & Heng Qi & { virtio-net: support the RSS context
\newline
Commit 84a1d9c48200 ("net: ethtool: extend RXNFC API to support RSS spreading of
filter matches") adds support for RSS context as a destination for receive flow filters
(see WIP work: \url{https://lists.oasis-open.org/archives/virtio-comment/202308/msg00194.html).}
\newline
An RSS context consists of configurable parameters specified by receive-side scaling.
\newline
Some use cases:
1. When users want some data flows to be steered to specific multiple rxqs, they can set
receive flow filter rules for these data flows to an RSS context with desired rxqs.
2. Traffic isolation. Used when users want the traffic of certain applications to occupy
several queues without being distubed.
\newline
How to set/configure an RSS context:
Assuming no RSS context has been created before.
1. ethtool -X eth0 context new start 5 equal 8
\newline
This command creates an RSS context with an id=1 for eth0, and fills in the indirection
table with rxq indexes 5-8 circularly. The hash key and hash types reuse the default
RSS configuration.
\newline
Then, we can use 'ethtool -x eth0 context 1' to query the above configuration.
\newline
2. ethtool -X eth0 context new start 6 equal 7 \textbackslash
hkey 8f:bf:dd:11:23:58:d2:8a:00:31:d0:32:a3:b5:1f:\textbackslash
1f:e4:d1:fe:47:7f:64:42:fd:d0:61:16:b8:b0:f9:71:e8:2d:36:7f:18:dd:4d:c8:f3
\newline
This command creates an RSS context with an id=2 for eth0, and fills in the indirection
table with rxq indexes 6-7 circularly. The hash key is 8f:bf:dd:11:23:58:d2:8a:00:31:d0\textbackslash
:32:a3:b5:1f:1f:e4:d1:fe:47:7f:64:42:fd:d0:61:16:b8:b0:f9:71:e8:2d:36:7f:18:dd:4d:c8:f3.
Hash types reuse the default RSS configuration.
\newline
3. ethtool -N eth0 rx-flow-hash tcp4 sdfn context 1
\newline
This command specifies the hash types for the RSS context whose id=1 on eth0.
Now this RSS context only has the hash key to reuse the default RSS configuration.
\newline
4. ethtool -N eth0 flow-type udp4 src-ip 1.1.1.1 context 1
\newline
This command configures a receive flow filter rule for eth0, and the data flow matching
this rule will continue to select the final rxq according to the RSS context configuration
with id=1.
\newline
Fixes: \url{https://github.com/oasis-tcs/virtio-spec/issues/178}\newline
Signed-off-by: Heng Qi <hengqi@linux.alibaba.com>\newline
Signed-off-by: Parav Pandit <parav@nvidia.com>\newline
Acked-by: Satananda Burla <sburla@marvell.com>\newline
Acked-by: Xuan Zhuo <xuanzhuo@linux.alibaba.com>\newline
Signed-off-by: Cornelia Huck <cohuck@redhat.com>\newline
} \\
\hline
bb11bf9b25cc & 13 Feb 2024 & Haixu Cui & { content: Rename SPI master to SPI controller
\newline
SPI master is an outdated term and should use SPI controller.
\newline
Signed-off-by: Haixu Cui <quic_haixcui@quicinc.com>\newline
Reviewed-by: Viresh Kumar <viresh.kumar@linaro.org>\newline
Signed-off-by: Cornelia Huck <cohuck@redhat.com>\newline
} \\
\hline
a402acce814f & 13 Feb 2024 & Haixu Cui & { virtio-spi: add the device specification
\newline
The Virtio SPI (Serial Peripheral Interface) device is a virtual
SPI controller that allows the driver to operate and use the SPI
controller under the control of the host.
\newline
This patch adds the specification for virtio-spi.
\newline
Fixes: \url{https://github.com/oasis-tcs/virtio-spec/issues/189}\newline
Signed-off-by: Haixu Cui <quic_haixcui@quicinc.com>\newline
Reviewed-by: Viresh Kumar <viresh.kumar@linaro.org>\newline
Signed-off-by: Cornelia Huck <cohuck@redhat.com>\newline
} \\
\hline
37c6a406678a & 16 Feb 2024 & Pape, Andreas (ADITG/ESS3) & { sound: add sampling rates 12000Hz and 24000Hz
\newline
24kHz is used for 'super wideband' voice transmission 12kHz is added 'for completeness'
\newline
Fixes: \url{https://github.com/oasis-tcs/virtio-spec/issues/184}\newline
Signed-off-by: Andreas Pape <apape@de.adit-jv.com>\newline
Reviewed-by: Anton Yakovlev <anton.yakovlev@opensynergy.com>\newline
Signed-off-by: Cornelia Huck <cohuck@redhat.com>\newline
} \\
\hline
71fe8e907c9d & 21 May 2024 & Michael S. Tsirkin & { README.md: update mailing list info
\newline
As approved by the TC, we are moving to a less formal
way of discussing the specification, on the mailing lists
provided by the Linux Foundation:
\newline
\url{https://groups.oasis-open.org/higherlogic/ws/public/ballot?id=3820}
\newline
Update README.md, CONTRIBUTING.md and newdevice.tex accordingly.
\newline
Use this opportunity to explain when and how to use each
mailing list.
\newline
Oh yes, and device numbers are reserved through virtio-comment
not through virtio-dev. Correct that.
\newline
Message-Id: <\nolinkurl{8f5db33c96d685fcebca3579b05d09b64dd720d9.1715766697.git.mst@redhat.com}>\newline
Signed-off-by: Michael S. Tsirkin <mst@redhat.com>\newline
} \\
\hline
6678bbf0ac15 & 11 Jul 2024 & Parav Pandit & { Add link for the feature bits section
\newline
Device common feature bits overview in the basic facilities and
their actual description are apart by 24 chapters.
\newline
Help reader to directly reach out to feature bits definitions from
the basic chapter.
\newline
MST: merged as a trivial editorial change\newline
Signed-off-by: Parav Pandit <parav@nvidia.com>\newline
Message-Id: <\nolinkurl{20240612073522.2571082-1-parav@nvidia.com}>\newline
Signed-off-by: Michael S. Tsirkin <mst@redhat.com>\newline
} \\
\hline
550b76062270 & 11 Jul 2024 & Michael S. Tsirkin & { can: drop a broken conformance link
\newline
CAN device has a single device conformance section, drop
a link to a non-existent section, fixing a Latex error.
\newline
Fixes: 07bb9f7 ("virtio-can: Device specification.")\newline
Message-ID: <87a6c3c4463e9f304cdd5dd5fac2194a95a8bcd2.1720724591.git.mst@redhat.com>\newline
Signed-off-by: Michael S. Tsirkin <mst@redhat.com>\newline
} \\
\hline
d7c486b49283 & 11 Jul 2024 & Michael S. Tsirkin & { introduction: fix label
\newline
label to rfc8174 is incorrect, leading to undefined reference
and multiple defined reference latex errors.
\newline
Fix it up.
\newline
Message-Id: <\nolinkurl{52b6fc16793e3b24284aefafda94322c739b9f7f.1720725332.git.mst@redhat.com}>\newline
Fixes: eb16e33 ("editorial: various fixes for 1.3-csd01")\newline
Signed-off-by: Michael S. Tsirkin <mst@redhat.com>\newline
} \\
\hline
7e454b64747d & 11 Jul 2024 & Michael S. Tsirkin & { makediff: cherry pick label change
\newline
label changes tend to trip up makediff - this one
causes an undefined reference from deleted section.
To fix, cherry-pick it.
\newline
Message-Id: <\nolinkurl{216774e3fa811e0a6e994a3815f0804ddfc0bb03.1720731399.git.mst@redhat.com}>\newline
Signed-off-by: Michael S. Tsirkin <mst@redhat.com>\newline
} \\
\hline
b495841a8e80 & 11 Jul 2024 & Michael S. Tsirkin & { transport-mmio: fix up makediff from 1.2
\newline
we fixed a typo in label name: in the diff old links become
undefined. Add the old label back for now, we can drop it
down the road.
\newline
Message-Id: <\nolinkurl{fc98549666e0fe74e890a7a62ca71248e709712b.1720731329.git.mst@redhat.com}>\newline
Fixes: ca97719 ("transport-mmio: Fix spellings and white spaces")\newline
Signed-off-by: Michael S. Tsirkin <mst@redhat.com>\newline
} \\
\hline
75086cb72af6 & 11 Jul 2024 & Michael S. Tsirkin & { Merge tag 'v1.3-wd02' into virtio-1.4
\newline
Merge fixes from master branch (1.3) up to tag v1.3-wd02
commit b495841 ("transport-mmio: fix up makediff from 1.2")
\newline
Signed-off-by: Michael S. Tsirkin <mst@redhat.com>\newline
} \\
\hline
61b65cbade3e & 11 Jul 2024 & Cornelia Huck & { editorial: allow for longer device id table: makediff 1.3
\newline
Move to "longtable" to allow the table to span multiple pages (it
became too long to fit on one page with the latest addition.)
\newline
Signed-off-by: Cornelia Huck <cohuck@redhat.com>\newline
(cherry picked from commit c8249d73d2fdbbfd38e8bf45c8492057bc2485e9)
\newline
} \\
\hline
6fa0087aa8d3 & 11 Jul 2024 & Michael S. Tsirkin & { Merge tag 'v1.3-wd02-makediff' into virtio-1.4
\newline
this is just so makediff can cherry pick a workaround
for latexdiff.
\newline
Signed-off-by: Michael S. Tsirkin <mst@redhat.com>\newline
} \\
\hline
79b04be2e022 & 11 Jul 2024 & Michael S. Tsirkin & { makediff: update base version to 1.3
\newline
might cause minor conflicts if we merge 1.3 branch
again, but seems cleaner than seeing full diff here.
\newline
Signed-off-by: Michael S. Tsirkin <mst@redhat.com>\newline
} \\
\hline
18e47c01207b & 11 Jul 2024 & Parav Pandit & { virtio-blk: Fix data type of num_queues field
\newline
Correct the endianness of num_queues field to be little endian.
\newline
Suggested-by: Max Gurtovoy <mgurtovoy@nvidia.com>\newline
Reviewed-by: Max Gurtovoy <mgurtovoy@nvidia.com>\newline
Signed-off-by: Parav Pandit <parav@nvidia.com>\newline
Reviewed-by: Stefano Garzarella <sgarzare@redhat.com>\newline
Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com>\newline
Message-Id: <\nolinkurl{20240521122119.2004071-1-parav@nvidia.com}>\newline
Signed-off-by: Michael S. Tsirkin <mst@redhat.com>\newline
} \\
\hline
008068153853 & 11 Jul 2024 & Parav Pandit & { virtio-net: Fix receive buffer size calculation text
\newline
Receive buffer size calculation is based on the following
negotiated features.
\newline
The text has wrong calculation for IPv6 and also it has missed
VIRTIO_NET_F_HASH_REPORT.
\newline
The problem of igorance of VIRTIO_NET_F_HASH_REPORT is reported
in [1], however fix for ipv6 payload length must also be
considered.
\newline
Since for the both the fixes touching same requirements, a
new issue is created as [2].
\newline
This patch brings following fixes.
\newline
1. Fix annotating struct virtio_net_hdr as field
2. Fix receive buffer calculation for guest GSO cases to consider
ipv6 payload length
3. small grammar corrections for article
4. reword the requirement to consider the virtio_ndr_hdr which is
depends on the negotiated feature, hence first clarify the
struct virtio_net_hdr size
\newline
[1] \url{https://github.com/oasis-tcs/virtio-spec/issues/170}
[2] \url{https://github.com/oasis-tcs/virtio-spec/issues/183}
\newline
Fixes: \url{https://github.com/oasis-tcs/virtio-spec/issues/170}\newline
Fixes: \url{https://github.com/oasis-tcs/virtio-spec/issues/183}\newline
Reviewed-by: Xuan Zhuo <xuanzhuo@linux.alibaba.com>\newline
Signed-off-by: Parav Pandit <parav@nvidia.com>\newline
Message-Id: <\nolinkurl{20240606102014.2103986-2-parav@nvidia.com}>\newline
Signed-off-by: Michael S. Tsirkin <mst@redhat.com>\newline
} \\
\hline
bf0fdf8ba828 & 11 Jul 2024 & Parav Pandit & { virtio-net: Clarify the size of the struct virtio_net_hdr for tx
\newline
The feature VIRTIO_NET_F_HASH_REPORT only applies to the receive side.
However, when VIRTIO_NET_F_HASH_REPORT feature was introduced, it was
not clarified that the size of the struct virtio_net_hdr on the packet
transmission also uses higher size when VIRTIO_NET_F_HASH_REPORT is
negotiated.
\newline
Explicitly clarify this.
\newline
Fixes: \url{https://github.com/oasis-tcs/virtio-spec/issues/183}\newline
Reviewed-by: Xuan Zhuo <xuanzhuo@linux.alibaba.com>\newline
Signed-off-by: Parav Pandit <parav@nvidia.com>\newline
Message-Id: <\nolinkurl{20240606102014.2103986-3-parav@nvidia.com}>\newline
Signed-off-by: Michael S. Tsirkin <mst@redhat.com>\newline
} \\
\hline
6abd42fd2398 & 11 Jul 2024 & Parav Pandit & { virtio-net: Annotate virtio_net_hdr as field
\newline
At several places struct virtio_net_hdr missed out the field
annotation. Add it.
\newline
Reviewed-by: Xuan Zhuo <xuanzhuo@linux.alibaba.com>\newline
Signed-off-by: Parav Pandit <parav@nvidia.com>\newline
Message-Id: <\nolinkurl{20240606102014.2103986-4-parav@nvidia.com}>\newline
Signed-off-by: Michael S. Tsirkin <mst@redhat.com>\newline
} \\
\hline
fdd39cfa7d76 & 11 Jul 2024 & Parav Pandit & { admin: Introduce self group
\newline
Define self group to control the self device itself.
\newline
Subsequent patches introduces the concept of device capabilities
and device resources which utilizes the self group to access
capabilities and uses device resources to refer to the device itself.
\newline
Fixes: \url{https://github.com/oasis-tcs/virtio-spec/issues/179}\newline
Signed-off-by: Parav Pandit <parav@nvidia.com>\newline
Signed-off-by: Michael S. Tsirkin <mst@redhat.com>\newline
Acked-by: Satananda Burla <sburla@marvell.com>\newline
Message-Id: <\nolinkurl{20240604132903.2093195-2-parav@nvidia.com}>\newline
Signed-off-by: Michael S. Tsirkin <mst@redhat.com>\newline
} \\
\hline
bfe175d9e018 & 11 Jul 2024 & Parav Pandit & { admin: Use already defined names for the legacy commands
\newline
Instead of description, use the existing name for defining the legacy
commands. While at it, prefer the shorter label names which
are already unique and refer them as hyperreference in the table
for quick naviation.
\newline
This is editorial change to align to subsequent patches.
\newline
Fixes: \url{https://github.com/oasis-tcs/virtio-spec/issues/179}\newline
Signed-off-by: Parav Pandit <parav@nvidia.com>\newline
Acked-by: Satananda Burla <sburla@marvell.com>\newline
Message-Id: <\nolinkurl{20240604132903.2093195-3-parav@nvidia.com}>\newline
Signed-off-by: Michael S. Tsirkin <mst@redhat.com>\newline
} \\
\hline
88a24d28db5b & 11 Jul 2024 & Parav Pandit & { admin: Add theory of operation for capability admin commands
\newline
Device capability indicates the supported functionality and
resources of the device to the driver.
\newline
Driver capability indicates the supported functionality
and resources which driver will be using. Driver capability is
subset of the device capability.
\newline
Add theory of operation describing it.
\newline
Fixes: \url{https://github.com/oasis-tcs/virtio-spec/issues/179}\newline
Signed-off-by: Parav Pandit <parav@nvidia.com>\newline
Signed-off-by: Michael S. Tsirkin <mst@redhat.com>\newline
Acked-by: Satananda Burla <sburla@marvell.com>\newline
Message-Id: <\nolinkurl{20240604132903.2093195-4-parav@nvidia.com}>\newline
Signed-off-by: Michael S. Tsirkin <mst@redhat.com>\newline
} \\
\hline
72a91e6d6365 & 11 Jul 2024 & Parav Pandit & { admin: Prepare table for multipage listing
\newline
If the table spans across two pages, it is not readable.
Make use of xltabular package that supports table spanning
across multiple pages.
\newline
Signed-off-by: Parav Pandit <parav@nvidia.com>\newline
Acked-by: Satananda Burla <sburla@marvell.com>\newline
Message-Id: <\nolinkurl{20240604132903.2093195-5-parav@nvidia.com}>\newline
Signed-off-by: Michael S. Tsirkin <mst@redhat.com>\newline
} \\
\hline
d60a39072890 & 11 Jul 2024 & Parav Pandit & { admin: Add capability admin commands
\newline
Add three capabilities related administration commands.
First to get the device capability.
Second to set the driver capability.
Third for the driver to discover which capabilities can be accessed.
\newline
Even though the current series restricts device capability reading
to the self group type, same structure and command format etc will
be reusable in future to read the capability from the owner device
and also to set the device capability via owner device using
new DEV_CAP_SET command.
\newline
Resource objects are introduced in subsequent patch which utilizes
the capability, however some description around resource object
limit is covered in this patch to keep things simple.
\newline
Fixes: \url{https://github.com/oasis-tcs/virtio-spec/issues/179}\newline
Signed-off-by: Parav Pandit <parav@nvidia.com>\newline
Signed-off-by: Michael S. Tsirkin <mst@redhat.com>\newline
Acked-by: Satananda Burla <sburla@marvell.com>\newline
Message-Id: <\nolinkurl{20240604132903.2093195-6-parav@nvidia.com}>\newline
Signed-off-by: Michael S. Tsirkin <mst@redhat.com>\newline
} \\
\hline
738f0a213307 & 11 Jul 2024 & Parav Pandit & { admin: Add theory of operation for device resource objects
\newline
The driver controls the device by means of device resource objects.
These operations include create, query, modify, and destroy the device
resource objects.
\newline
Fixes: \url{https://github.com/oasis-tcs/virtio-spec/issues/179}\newline
Signed-off-by: Parav Pandit <parav@nvidia.com>\newline
Signed-off-by: Michael S. Tsirkin <mst@redhat.com>\newline
Acked-by: Satananda Burla <sburla@marvell.com>\newline
Message-Id: <\nolinkurl{20240604132903.2093195-7-parav@nvidia.com}>\newline
Signed-off-by: Michael S. Tsirkin <mst@redhat.com>\newline
} \\
\hline
5040f36bd8c9 & 11 Jul 2024 & Parav Pandit & { admin: Add device resource objects admin commands
\newline
Add generic administration commands create, modify, query and destroy
device resource object.
\newline
Each resource object defines resource specific attributes for the commands.
Once the resource object is created by the driver, it can be query/modify or
destroyed by the driver.
\newline
Each resource object is identified using a unique resource id per
resource type.
\newline
Fixes: \url{https://github.com/oasis-tcs/virtio-spec/issues/179}\newline
Signed-off-by: Parav Pandit <parav@nvidia.com>\newline
Signed-off-by: Michael S. Tsirkin <mst@redhat.com>\newline
Acked-by: Satananda Burla <sburla@marvell.com>\newline
Message-Id: <\nolinkurl{20240604132903.2093195-8-parav@nvidia.com}>\newline
Signed-off-by: Michael S. Tsirkin <mst@redhat.com>\newline
} \\
\hline
7b3bdd63d821 & 11 Jul 2024 & Parav Pandit & { virtio-net: Add theory of operation for flow filter
\newline
Currently packet allow/drop interface has following limitations.
\newline
1. Driver can either select which MAC and VLANs to consider
for allowing/dropping packets, here, the driver has a
limitation that driver needs to supply full mac
table or full vlan table for each type. Driver cannot add or
delete an individual entry.
\newline
2. Driver cannot select mac+vlan combination for which
to allow/drop packet.
\newline
3. Driver cannot not set other commonly used packet match fields
such as IP header fields, TCP, UDP, SCP header fields.
\newline
4. Driver cannot steer specific packets based on the match
fields to specific receiveq.
\newline
5. Driver do not have multiple or dedicated virtqueues to
perform flow filter requests in accelerated manner in
the device.
\newline
Flow filter as a generic framework overcome above limitations.
\newline
As starting point it is useful to support at least two use cases.
a. ARFS
b. ethtool ntuple steering
\newline
In future it can be further extended for usecases such as
switching device, connection tracking or may be more.
\newline
The flow filter has following properties.
\newline
1. It is an extendible object that driver can create, destroy.
2. It belongs to a flow filter group.
3. Each flow filter rule is identified using a unique id,
has priority, match key, destination(rq) and action(allow/drop).
4. Flow filter key also refers to the mask to learn which fields
of the packets to match.
\newline
This patch adds theory of operation for flow filter functionality.
\newline
Fixes: \url{https://github.com/oasis-tcs/virtio-spec/issues/179}\newline
Signed-off-by: Parav Pandit <parav@nvidia.com>\newline
Signed-off-by: Heng Qi <hengqi@linux.alibaba.com>\newline
Signed-off-by: Michael S. Tsirkin <mst@redhat.com>\newline
Acked-by: Satananda Burla <sburla@marvell.com>\newline
Message-Id: <\nolinkurl{20240604132903.2093195-9-parav@nvidia.com}>\newline
Signed-off-by: Michael S. Tsirkin <mst@redhat.com>\newline
} \\
\hline
899bb0ca24d8 & 11 Jul 2024 & Parav Pandit & { virtio-net: Add flow filter capability
\newline
Add first flow filter capability that indicates device resource
limits such as number of flow filter rules, groups and selectors.
\newline
add second capability that indicates supported selectors defining
which packet headers and their fields supported.
\newline
[Parav Pandit: resolve conflict: editorial: in spec links]
Fixes: \url{https://github.com/oasis-tcs/virtio-spec/issues/179}\newline
Signed-off-by: Parav Pandit <parav@nvidia.com>\newline
Signed-off-by: Heng Qi <hengqi@linux.alibaba.com>\newline
Signed-off-by: Michael S. Tsirkin <mst@redhat.com>\newline
Acked-by: Satananda Burla <sburla@marvell.com>\newline
Message-Id: <\nolinkurl{20240604132903.2093195-10-parav@nvidia.com}>\newline
Signed-off-by: Michael S. Tsirkin <mst@redhat.com>\newline
} \\
\hline
224e98b0f53c & 11 Jul 2024 & Parav Pandit & { virtio-net: Add flow filter group, classifier and rule resource objects
\newline
Flow filter rules depend on the flow filter group resource object.
The device can have one or more flow filter groups. Each flow filter
group has its own order. The group order defines the packet
processing order in the flow filter domain.
\newline
Define flow filter classifier object which consists of one
or multiple types of packet header fields to consider
for matching. A mask can match on partial field or whole
field if the device supports partial masking for a given
mask type.
\newline
Define flow filter rule resource which consists of
match key, reference to group and mask objects and
an action.
\newline
Currently it covers the most common filter types and value
of Ethernet header, IPV4 and IPV6 headers and TCP and UDP headers.
\newline
Fixes: \url{https://github.com/oasis-tcs/virtio-spec/issues/179}\newline
Signed-off-by: Parav Pandit <parav@nvidia.com>\newline
Signed-off-by: Heng Qi <hengqi@linux.alibaba.com>\newline
Signed-off-by: Michael S. Tsirkin <mst@redhat.com>\newline
Acked-by: Satananda Burla <sburla@marvell.com>\newline
Message-Id: <\nolinkurl{20240604132903.2093195-11-parav@nvidia.com}>\newline
Signed-off-by: Michael S. Tsirkin <mst@redhat.com>\newline
} \\
\hline
3b7b7371dbed & 11 Jul 2024 & Parav Pandit & { virtio-net: Add flow filter device and driver requirements
\newline
Add device and driver flow filter requirements.
\newline
Fixes: \url{https://github.com/oasis-tcs/virtio-spec/issues/179}\newline
Signed-off-by: Parav Pandit <parav@nvidia.com>\newline
Signed-off-by: Heng Qi <hengqi@linux.alibaba.com>\newline
Acked-by: Satananda Burla <sburla@marvell.com>\newline
Message-Id: <\nolinkurl{20240604132903.2093195-12-parav@nvidia.com}>\newline
Signed-off-by: Michael S. Tsirkin <mst@redhat.com>\newline
} \\
\hline
9b3129fe7236 & 12 Jul 2024 & Martin Kröning & { virtio_pci_cap64: specify offset_hi, length_hi endianness
\newline
While the capability introduction says "This virtio structure capability uses little-endian format,"
it might be preferrable to be explicit about the endianness of offset_hi and length_hi.
\newline
Signed-off-by: Martin Kröning <martin.kroening@eonerc.rwth-aachen.de>\newline
Reviewed-by: Parav Pandit <parav@nvidia.com>\newline
Fixes: \url{https://github.com/oasis-tcs/virtio-spec/issues/196}\newline
Message-Id: <\nolinkurl{DF89BB0F-6BA4-4DAB-AEC3-03AAF858EC8E@eonerc.rwth-aachen.de}>\newline
Signed-off-by: Michael S. Tsirkin <mst@redhat.com>\newline
} \\
\hline
67141d1cb0fe & 12 Jul 2024 & Parav Pandit & { admin: Add theory of operation for device parts
\newline
A device can get and set the state of the device which is
organized as multiple device parts. This can be useful
in cases of VM snapshot, VM migration, debug or some other use
cases.
\newline
Add the theory of operations on how to get/set device parts
and how it affects when the device is stopped or resumed.
\newline
Fixes: \url{https://github.com/oasis-tcs/virtio-spec/issues/176}\newline
Signed-off-by: Michael S. Tsirkin <mst@redhat.com>\newline
Signed-off-by: Parav Pandit <parav@nvidia.com>\newline
Message-Id: <\nolinkurl{20240601145042.2074739-2-parav@nvidia.com}>\newline
} \\
\hline
a1281addd9b2 & 12 Jul 2024 & Parav Pandit & { admin: Extend resource objects for sr-iov group type
\newline