Skip to contentSkip to conversation

virtio-network: Avoid confusion between a card and a device

PATCH In review Parav Pandit 2 participants 5 messages Dec 24, 2022 – Dec 26, 2022

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 virtio-network: Avoid confusion between a card and a device

Ethernet card is a relatively vague term in context of virtio network device specification. A Ethernet card in the industry has one to multiple ports, one to multiple PCI functions.

Historically virtio network device is documented as a Ethernet card. However it is usually just a single virtual Ethernet device.

Hence, avoid this confusing term 'card' and align the specification to adhere to widely used specification term as 'device' used for all virtio device types.

This patch is on top of change [1].

[1] https://lists.oasis-open.org/archives/virtio-dev/202212/msg00042.html

---
 content.tex        | 6 +++---
 virtio-network.tex | 6 +++---
 2 files changed, 6 insertions(+), 6 deletions(-)
content.tex +3 -3
index 5baef90..37e7943 100644
@@ -619,7 +619,7 @@ \subsection{PCI Device Discovery}\label{sec:Virtio Transport Options / Virtio Ov
 \hline
 Transitional PCI Device ID  &  Virtio Device    \\
 \hline \hline
-0x1000      &   network card     \\
+0x1000      &   network device     \\
 \hline
 0x1001     &   block device     \\
 \hline
@@ -635,7 +635,7 @@ \subsection{PCI Device Discovery}\label{sec:Virtio Transport Options / Virtio Ov
 \hline
 \end{tabular}
 
-For example, the network card device with the Virtio Device ID 1
+For example, the network device device with the Virtio Device ID 1
 has the PCI Device ID 0x1041 or the Transitional PCI Device ID 0x1000.
 
 The PCI Subsystem Vendor ID and the PCI Subsystem Device ID MAY reflect
@@ -2912,7 +2912,7 @@ \chapter{Device Types}\label{sec:Device Types}
 \hline \hline
 0          & reserved (invalid) \\
 \hline
-1          &   network card     \\
+1          &   network device     \\
 \hline
 2          &   block device     \\
 \hline
virtio-network.tex +3 -3
index 28ed343..b05ce61 100644
@@ -1,6 +1,6 @@
 \section{Network Device}\label{sec:Device Types / Network Device}
 
-The virtio network device is a virtual ethernet card, and is the
+The virtio network device is a virtual ethernet device, and is the
 most complex of the devices supported so far by virtio. It has
 enhanced rapidly and demonstrates clearly how support for new
 features are added to an existing device. Empty buffers are
@@ -33,7 +33,7 @@ \subsection{Feature bits}\label{sec:Device Types / Network Device / Feature bits
 
 \begin{description}
 \item[VIRTIO_NET_F_CSUM (0)] Device handles packets with partial checksum.   This 
-  ``checksum offload'' is a common feature on modern network cards.
+  ``checksum offload'' is a common feature on modern network device.
 
 \item[VIRTIO_NET_F_GUEST_CSUM (1)] Driver handles packets with partial checksum.
 
@@ -323,7 +323,7 @@ \subsection{Device Initialization}\label{sec:Device Types / Network Device / Dev
 
 \item If the VIRTIO_NET_F_MAC feature bit is set, the configuration
   space \field{mac} entry indicates the ``physical'' address of the
-  network card, otherwise the driver would typically generate a random
+  network device, otherwise the driver would typically generate a random
   local MAC address.
 
 \item If the VIRTIO_NET_F_STATUS feature bit is negotiated, the link
Signature · 18 lines
2.26.2


This publicly archived list offers a means to provide input to the
OASIS Virtual I/O Device (VIRTIO) TC.

In order to verify user consent to the Feedback License terms and
to minimize spam in the list archive, subscription is required
before posting.

Subscribe: [email protected]
Unsubscribe: [email protected]
List help: [email protected]
List archive: https://lists.oasis-open.org/archives/virtio-comment/
Feedback License: https://www.oasis-open.org/who/ipr/feedback_license.pdf
List Guidelines: https://www.oasis-open.org/policies-guidelines/mailing-lists
Committee: https://www.oasis-open.org/committees/virtio/
Join OASIS: https://www.oasis-open.org/join/
#1 lore raw
Quoted 3 lines · Parav Pandit

Ethernet card is a relatively vague term in context of virtio network device specification. A Ethernet card in the industry has one to multiple ports, one to multiple PCI functions.

Is this the terminology that IEEE uses?

Quoted 7 lines

Historically virtio network device is documented as a Ethernet card. However it is usually just a single virtual Ethernet device.

Hence, avoid this confusing term 'card' and align the specification to adhere to widely used specification term as 'device' used for all virtio device types.

Quoted 6 lines

This patch is on top of change [1].

[1] https://lists.oasis-open.org/archives/virtio-dev/202212/msg00042.html

This results in a bit of confusion since device has very specific meaning within virtio. I agree "card" sounds archaic. Would "ethernet adapter" work maybe?

Quoted 19 lines
---
 content.tex        | 6 +++---
 virtio-network.tex | 6 +++---
 2 files changed, 6 insertions(+), 6 deletions(-)
content.tex +1 -1
index 5baef90..37e7943 100644
@@ -619,7 +619,7 @@ \subsection{PCI Device Discovery}\label{sec:Virtio Transport Options / Virtio Ov
 \hline
 Transitional PCI Device ID  &  Virtio Device    \\
 \hline \hline
-0x1000      &   network card     \\
+0x1000      &   network device     \\
 \hline
 0x1001     &   block device     \\
 \hline

content.tex \subsection{PCI Device Discovery}\label{sec:Virtio Transport Options / Virtio Ov · line 638

Quoted 5 lines
content.tex +1 -1
@@ -635,7 +635,7 @@ \subsection{PCI Device Discovery}\label{sec:Virtio Transport Options / Virtio Ov
 \hline
 \end{tabular}
 
-For example, the network card device with the Virtio Device ID 1
+For example, the network device device with the Virtio Device ID 1

device repeated twice here

Quoted 17 lines
content.tex +1 -1
 has the PCI Device ID 0x1041 or the Transitional PCI Device ID 0x1000.
 
 The PCI Subsystem Vendor ID and the PCI Subsystem Device ID MAY reflect
@@ -2912,7 +2912,7 @@ \chapter{Device Types}\label{sec:Device Types}
 \hline \hline
 0          & reserved (invalid) \\
 \hline
-1          &   network card     \\
+1          &   network device     \\
 \hline
 2          &   block device     \\
 \hline
virtio-network.tex +0 -0
index 28ed343..b05ce61 100644

virtio-network.tex line 3

Quoted 4 lines
virtio-network.tex +1 -1
@@ -1,6 +1,6 @@
 \section{Network Device}\label{sec:Device Types / Network Device}
 
-The virtio network device is a virtual ethernet card, and is the
+The virtio network device is a virtual ethernet device, and is the

"virtio device is an ethernet device" sounds repetetive.

virtio-network.tex \subsection{Feature bits}\label{sec:Device Types / Network Device / Feature bits · line 36

Quoted 9 lines
virtio-network.tex +1 -1
 most complex of the devices supported so far by virtio. It has
 enhanced rapidly and demonstrates clearly how support for new
 features are added to an existing device. Empty buffers are
@@ -33,7 +33,7 @@ \subsection{Feature bits}\label{sec:Device Types / Network Device / Feature bits
 
 \begin{description}
 \item[VIRTIO_NET_F_CSUM (0)] Device handles packets with partial checksum.   This 
-  ``checksum offload'' is a common feature on modern network cards.
+  ``checksum offload'' is a common feature on modern network device.

ungrammatical

virtio-network.tex \subsection{Device Initialization}\label{sec:Device Types / Network Device / Dev · line 327

Quoted 10 lines
virtio-network.tex +1 -1
 \item[VIRTIO_NET_F_GUEST_CSUM (1)] Driver handles packets with partial checksum.
 
@@ -323,7 +323,7 @@ \subsection{Device Initialization}\label{sec:Device Types / Network Device / Dev
 
 \item If the VIRTIO_NET_F_MAC feature bit is set, the configuration
   space \field{mac} entry indicates the ``physical'' address of the
-  network card, otherwise the driver would typically generate a random
+  network device, otherwise the driver would typically generate a random
   local MAC address.

here it is unclear whether this refers to virtio device or ethernet device

Quoted 4 lines
virtio-network.tex +0 -0
 \item If the VIRTIO_NET_F_STATUS feature bit is negotiated, the link
Signature · 1 line
2.26.2

This publicly archived list offers a means to provide input to the OASIS Virtual I/O Device (VIRTIO) TC.

In order to verify user consent to the Feedback License terms and to minimize spam in the list archive, subscription is required before posting.

Subscribe: [email protected]
Unsubscribe: [email protected]
List help: [email protected]
List archive: https://lists.oasis-open.org/archives/virtio-comment/
Feedback License: https://www.oasis-open.org/who/ipr/feedback_license.pdf
List Guidelines: https://www.oasis-open.org/policies-guidelines/mailing-lists
Committee: https://www.oasis-open.org/committees/virtio/
Join OASIS: https://www.oasis-open.org/join/

#2 lore raw
Quoted 11 lines

From: [email protected] <[email protected] open.org> On Behalf Of Michael S. Tsirkin

Quoted 3 lines · Parav Pandit

Ethernet card is a relatively vague term in context of virtio network device specification. A Ethernet card in the industry has one to multiple ports, one to multiple PCI functions.

Is this the terminology that IEEE uses?

I do not know if the IEEE has defined Ethernet _card_ per say.

Quoted 13 lines
Quoted 13 lines

Historically virtio network device is documented as a Ethernet card. However it is usually just a single virtual Ethernet device.

Hence, avoid this confusing term 'card' and align the specification to adhere to widely used specification term as 'device' used for all virtio device types.

This patch is on top of change [1].

[1]
https://lists.oasis-open.org/archives/virtio-dev/202212/msg00042.html

Quoted 7 lines
Quoted 2 lines

This results in a bit of confusion since device has very specific meaning within virtio. I agree "card" sounds archaic.
Would "ethernet adapter" work maybe?

I don't see how virtio net device any different than virtio blk device in context of this definition. Anything broken with ethernet device definition?
Device functional definition is anyway present in the respective section.

Quoted 21 lines
Quoted 21 lines
---
 content.tex        | 6 +++---
 virtio-network.tex | 6 +++---
 2 files changed, 6 insertions(+), 6 deletions(-)
content.tex +0 -0
@@ -619,7 +619,7 @@ \subsection{PCI Device Discovery}\label{sec:Virtio

Transport Options / Virtio Ov \hline
Transitional PCI Device ID & Virtio Device \\
\hline \hline

-0x1000      &   network card     \\
+0x1000      &   network device     \\

\hline
0x1001 & block device \\
\hline

content.tex +0 -0
@@ -635,7 +635,7 @@ \subsection{PCI Device Discovery}\label{sec:Virtio
 Transport Options / Virtio Ov  \hline  \end{tabular}
 
Quoted 5 lines

content.tex \subsection{PCI Device Discovery}\label{sec:Virtio Transport Options / Virtio Ov · line 638

Quoted 2 lines
content.tex +1 -1
-For example, the network card device with the Virtio Device ID 1
+For example, the network device device with the Virtio Device ID 1

device repeated twice here

Ah, will fix it in v1.

Quoted 20 lines
Quoted 20 lines
content.tex +0 -0
 has the PCI Device ID 0x1041 or the Transitional PCI Device ID 0x1000.
 
 The PCI Subsystem Vendor ID and the PCI Subsystem Device ID MAY

reflect @@ -2912,7 +2912,7 @@ \chapter{Device Types}\label{sec:Device Types} \hline \hline
0 & reserved (invalid) \\
\hline

-1          &   network card     \\
+1          &   network device     \\

\hline
2 & block device \\
\hline

virtio-network.tex index renamed from virtio-network.tex +0 -0

28ed343..b05ce61 100644

virtio-network.tex +0 -0
@@ -1,6 +1,6 @@
 \section{Network Device}\label{sec:Device Types / Network Device}
 
Quoted 5 lines

virtio-network.tex line 3

Quoted 2 lines
virtio-network.tex +1 -1
-The virtio network device is a virtual ethernet card, and is the
+The virtio network device is a virtual ethernet device, and is the

"virtio device is an ethernet device" sounds repetetive.

Here the definition is clear that it's a virtual ethernet device. Similar definition as block, reads fine.

Quoted 7 lines
Quoted 7 lines
virtio-network.tex +0 -0
 most complex of the devices supported so far by virtio. It has

enhanced rapidly and demonstrates clearly how support for new features are added to an existing device. Empty buffers are @@ -33,7 +33,7 @@ \subsection{Feature bits}\label{sec:Device Types / Network Device / Feature bits

Quoted 8 lines
Quoted 2 lines

\begin{description}
\item[VIRTIO_NET_F_CSUM (0)] Device handles packets with partial

checksum. This

virtio-network.tex \subsection{Feature bits}\label{sec:Device Types / Network Device / Feature bits · line 36

Quoted 2 lines
virtio-network.tex +1 -1
-  ``checksum offload'' is a common feature on modern network cards.
+  ``checksum offload'' is a common feature on modern network device.

ungrammatical

Right.
Will fix it as
checksum offload'' is a common feature of modern network device.

Quoted 7 lines
Quoted 2 lines

\item[VIRTIO_NET_F_GUEST_CSUM (1)] Driver handles packets with partial

checksum.

Quoted 4 lines
virtio-network.tex +0 -0
@@ -323,7 +323,7 @@ \subsection{Device

Initialization}\label{sec:Device Types / Network Device / Dev

Quoted 10 lines
Quoted 7 lines

\item If the VIRTIO_NET_F_MAC feature bit is set, the configuration
space \field{mac} entry indicates the ``physical'' address of the
- network card, otherwise the driver would typically generate a random
+ network device, otherwise the driver would typically generate a
+ random
local MAC address.

here it is unclear whether this refers to virtio device or ethernet device

Virtio network device because it is in the subsection. "virtio" is not repeated every time a network device is referenced. Do you suggest to prefix it every time?

This publicly archived list offers a means to provide input to the OASIS Virtual I/O Device (VIRTIO) TC.

In order to verify user consent to the Feedback License terms and to minimize spam in the list archive, subscription is required before posting.

Subscribe: [email protected]
Unsubscribe: [email protected]
List help: [email protected]
List archive: https://lists.oasis-open.org/archives/virtio-comment/
Feedback License: https://www.oasis-open.org/who/ipr/feedback_license.pdf
List Guidelines: https://www.oasis-open.org/policies-guidelines/mailing-lists
Committee: https://www.oasis-open.org/committees/virtio/
Join OASIS: https://www.oasis-open.org/join/

#3 lore raw
Quoted 5 lines · Parav Pandit
Quoted 5 lines

From: [email protected] <[email protected] open.org> On Behalf Of Michael S. Tsirkin

Quoted 8 lines
Quoted 6 lines · Parav Pandit
Quoted 3 lines

Ethernet card is a relatively vague term in context of virtio network device specification. A Ethernet card in the industry has one to multiple ports, one to multiple PCI functions.

Is this the terminology that IEEE uses?

I do not know if the IEEE has defined Ethernet _card_ per say.

What terminology does it use? I don't have a spec to hand - does not it talk about host adapters?

Quoted 116 lines
Quoted 13 lines
Quoted 13 lines

Historically virtio network device is documented as a Ethernet card. However it is usually just a single virtual Ethernet device.

Hence, avoid this confusing term 'card' and align the specification to adhere to widely used specification term as 'device' used for all virtio device types.

This patch is on top of change [1].

[1]
https://lists.oasis-open.org/archives/virtio-dev/202212/msg00042.html

Quoted 7 lines
Quoted 2 lines

This results in a bit of confusion since device has very specific meaning within virtio. I agree "card" sounds archaic.
Would "ethernet adapter" work maybe?

I don't see how virtio net device any different than virtio blk device in context of this definition. Anything broken with ethernet device definition?
Device functional definition is anyway present in the respective section.

Quoted 21 lines
Quoted 21 lines
---
 content.tex        | 6 +++---
 virtio-network.tex | 6 +++---
 2 files changed, 6 insertions(+), 6 deletions(-)
content.tex +0 -0
@@ -619,7 +619,7 @@ \subsection{PCI Device Discovery}\label{sec:Virtio

Transport Options / Virtio Ov \hline
Transitional PCI Device ID & Virtio Device \\
\hline \hline

-0x1000      &   network card     \\
+0x1000      &   network device     \\

\hline
0x1001 & block device \\
\hline

content.tex +0 -0
@@ -635,7 +635,7 @@ \subsection{PCI Device Discovery}\label{sec:Virtio
 Transport Options / Virtio Ov  \hline  \end{tabular}
 
Quoted 5 lines

content.tex \subsection{PCI Device Discovery}\label{sec:Virtio Transport Options / Virtio Ov · line 638

Quoted 2 lines
content.tex +1 -1
-For example, the network card device with the Virtio Device ID 1
+For example, the network device device with the Virtio Device ID 1

device repeated twice here

Ah, will fix it in v1.

Quoted 20 lines
Quoted 20 lines
content.tex +0 -0
 has the PCI Device ID 0x1041 or the Transitional PCI Device ID 0x1000.
 
 The PCI Subsystem Vendor ID and the PCI Subsystem Device ID MAY

reflect @@ -2912,7 +2912,7 @@ \chapter{Device Types}\label{sec:Device Types} \hline \hline
0 & reserved (invalid) \\
\hline

-1          &   network card     \\
+1          &   network device     \\

\hline
2 & block device \\
\hline

virtio-network.tex index renamed from virtio-network.tex +0 -0

28ed343..b05ce61 100644

virtio-network.tex +0 -0
@@ -1,6 +1,6 @@
 \section{Network Device}\label{sec:Device Types / Network Device}
 
Quoted 5 lines

virtio-network.tex line 3

Quoted 2 lines
virtio-network.tex +1 -1
-The virtio network device is a virtual ethernet card, and is the
+The virtio network device is a virtual ethernet device, and is the

"virtio device is an ethernet device" sounds repetetive.

Here the definition is clear that it's a virtual ethernet device. Similar definition as block, reads fine.

Quoted 7 lines
Quoted 7 lines
virtio-network.tex +0 -0
 most complex of the devices supported so far by virtio. It has

enhanced rapidly and demonstrates clearly how support for new features are added to an existing device. Empty buffers are @@ -33,7 +33,7 @@ \subsection{Feature bits}\label{sec:Device Types / Network Device / Feature bits

Quoted 8 lines
Quoted 2 lines

\begin{description}
\item[VIRTIO_NET_F_CSUM (0)] Device handles packets with partial

checksum. This

virtio-network.tex \subsection{Feature bits}\label{sec:Device Types / Network Device / Feature bits · line 36

Quoted 2 lines
virtio-network.tex +1 -1
-  ``checksum offload'' is a common feature on modern network cards.
+  ``checksum offload'' is a common feature on modern network device.

ungrammatical

Right.
Will fix it as
checksum offload'' is a common feature of modern network device.

Quoted 7 lines
Quoted 2 lines

\item[VIRTIO_NET_F_GUEST_CSUM (1)] Driver handles packets with partial

checksum.

Quoted 4 lines
virtio-network.tex +0 -0
@@ -323,7 +323,7 @@ \subsection{Device

Initialization}\label{sec:Device Types / Network Device / Dev

Quoted 10 lines
Quoted 7 lines

\item If the VIRTIO_NET_F_MAC feature bit is set, the configuration
space \field{mac} entry indicates the ``physical'' address of the
- network card, otherwise the driver would typically generate a random
+ network device, otherwise the driver would typically generate a
+ random
local MAC address.

here it is unclear whether this refers to virtio device or ethernet device

Quoted 3 lines

Virtio network device because it is in the subsection. "virtio" is not repeated every time a network device is referenced. Do you suggest to prefix it every time?

---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]

#4 lore raw
Quoted 16 lines

From: Michael S. Tsirkin <[email protected]>
Sent: Sunday, December 25, 2022 6:33 AM

Quoted 11 lines · Parav Pandit
Quoted 11 lines

From: [email protected] <[email protected] open.org> On Behalf Of Michael S. Tsirkin

Quoted 3 lines · Parav Pandit

Ethernet card is a relatively vague term in context of virtio network device specification. A Ethernet card in the industry has one to multiple ports, one to multiple PCI functions.

Quoted 6 lines
Quoted 3 lines
Quoted 1 line

Is this the terminology that IEEE uses?

I do not know if the IEEE has defined Ethernet _card_ per say.

What terminology does it use? I don't have a spec to hand - does not it talk about host adapters?

No. In context of IEEE spec 802.3 and 802.1q ocean, there are various terms that address the network device of the host as below. Mac service providers, link peers, mac client, end station port depending on the part of the spec you refer to.

Virtio spec only refers to the MAC address portion of the IEEE 802.3 spec.

This publicly archived list offers a means to provide input to the OASIS Virtual I/O Device (VIRTIO) TC.

In order to verify user consent to the Feedback License terms and to minimize spam in the list archive, subscription is required before posting.

Subscribe: [email protected]
Unsubscribe: [email protected]
List help: [email protected]
List archive: https://lists.oasis-open.org/archives/virtio-comment/
Feedback License: https://www.oasis-open.org/who/ipr/feedback_license.pdf
List Guidelines: https://www.oasis-open.org/policies-guidelines/mailing-lists
Committee: https://www.oasis-open.org/committees/virtio/
Join OASIS: https://www.oasis-open.org/join/