virtio-blk: Define dev cfg layout before its fields

PATCH In review Parav Pandit 3 participants 6 messages Feb 23, 2023 – Mar 15, 2023

lore

Share & tools

lore

Parav Pandit

author

2023-02-23 13:52 UTC #0 lore raw

PATCH 1/1 virtio-blk: Define dev cfg layout before its fields

Define device configuration layout structure before describing its individual fields.

This is an editorial change.

Reviewed-by Max Gurtovoy <[email protected]>

Signed-off-by Parav Pandit <[email protected]>

---
 device-types/blk/description.tex | 95 ++++++++++++++++----------------
 1 file changed, 48 insertions(+), 47 deletions(-)

device-types/blk/description.tex +48 ~~-47~~

index 20007e3..517b012 100644
@@ -83,6 +83,54 @@ \subsubsection{Legacy Interface: Feature bits}\label{sec:Device Types / Block De
 
 \subsection{Device configuration layout}\label{sec:Device Types / Block Device / Device configuration layout}
 
+The block device has the following device configuration layout.
+
+\begin{lstlisting}
+struct virtio_blk_config {
+        le64 capacity;
+        le32 size_max;
+        le32 seg_max;
+        struct virtio_blk_geometry {
+                le16 cylinders;
+                u8 heads;
+                u8 sectors;
+        } geometry;
+        le32 blk_size;
+        struct virtio_blk_topology {
+                // # of logical blocks per physical block (log2)
+                u8 physical_block_exp;
+                // offset of first aligned logical block
+                u8 alignment_offset;
+                // suggested minimum I/O size in blocks
+                le16 min_io_size;
+                // optimal (suggested maximum) I/O size in blocks
+                le32 opt_io_size;
+        } topology;
+        u8 writeback;
+        u8 unused0;
+        u16 num_queues;
+        le32 max_discard_sectors;
+        le32 max_discard_seg;
+        le32 discard_sector_alignment;
+        le32 max_write_zeroes_sectors;
+        le32 max_write_zeroes_seg;
+        u8 write_zeroes_may_unmap;
+        u8 unused1[3];
+        le32 max_secure_erase_sectors;
+        le32 max_secure_erase_seg;
+        le32 secure_erase_sector_alignment;
+        struct virtio_blk_zoned_characteristics {
+                le32 zone_sectors;
+                le32 max_open_zones;
+                le32 max_active_zones;
+                le32 max_append_sectors;
+                le32 write_granularity;
+                u8 model;
+                u8 unused2[3];
+        } zoned;
+};
+\end{lstlisting}
+
 The \field{capacity} of the device (expressed in 512-byte sectors) is always
 present. The availability of the others all depend on various feature
 bits as indicated above.

@@ -167,53 +215,6 @@ \subsection{Device configuration layout}\label{sec:Device Types / Block Device /
 terminated by the device with a "zone resources exceeded" error as defined for
 specific commands later.
 
-\begin{lstlisting}
-struct virtio_blk_config {
-        le64 capacity;
-        le32 size_max;
-        le32 seg_max;
-        struct virtio_blk_geometry {
-                le16 cylinders;
-                u8 heads;
-                u8 sectors;
-        } geometry;
-        le32 blk_size;
-        struct virtio_blk_topology {
-                // # of logical blocks per physical block (log2)
-                u8 physical_block_exp;
-                // offset of first aligned logical block
-                u8 alignment_offset;
-                // suggested minimum I/O size in blocks
-                le16 min_io_size;
-                // optimal (suggested maximum) I/O size in blocks
-                le32 opt_io_size;
-        } topology;
-        u8 writeback;
-        u8 unused0;
-        u16 num_queues;
-        le32 max_discard_sectors;
-        le32 max_discard_seg;
-        le32 discard_sector_alignment;
-        le32 max_write_zeroes_sectors;
-        le32 max_write_zeroes_seg;
-        u8 write_zeroes_may_unmap;
-        u8 unused1[3];
-        le32 max_secure_erase_sectors;
-        le32 max_secure_erase_seg;
-        le32 secure_erase_sector_alignment;
-        struct virtio_blk_zoned_characteristics {
-                le32 zone_sectors;
-                le32 max_open_zones;
-                le32 max_active_zones;
-                le32 max_append_sectors;
-                le32 write_granularity;
-                u8 model;
-                u8 unused2[3];
-        } zoned;
-};
-\end{lstlisting}
-
-
 \subsubsection{Legacy Interface: Device configuration layout}\label{sec:Device Types / Block Device / Device configuration layout / Legacy Interface: Device configuration layout}
 When using the legacy interface, transitional devices and drivers
 MUST format the fields in struct virtio_blk_config

Signature · 1 line

2.26.2

Stefan Hajnoczi

Reviewed-by on v1 1/1

2023-02-23 20:46 UTC #1 lore raw

Quoted 127 lines · Parav Pandit

Define device configuration layout structure before describing its individual fields.

This is an editorial change.

Reviewed-by Max Gurtovoy <[email protected]>

Signed-off-by Parav Pandit <[email protected]>

---
 device-types/blk/description.tex | 95 ++++++++++++++++----------------
 1 file changed, 48 insertions(+), 47 deletions(-)

device-types/blk/description.tex +48 ~~-47~~

index 20007e3..517b012 100644
@@ -83,6 +83,54 @@ \subsubsection{Legacy Interface: Feature bits}\label{sec:Device Types / Block De
 
 \subsection{Device configuration layout}\label{sec:Device Types / Block Device / Device configuration layout}
 
+The block device has the following device configuration layout.
+
+\begin{lstlisting}
+struct virtio_blk_config {
+        le64 capacity;
+        le32 size_max;
+        le32 seg_max;
+        struct virtio_blk_geometry {
+                le16 cylinders;
+                u8 heads;
+                u8 sectors;
+        } geometry;
+        le32 blk_size;
+        struct virtio_blk_topology {
+                // # of logical blocks per physical block (log2)
+                u8 physical_block_exp;
+                // offset of first aligned logical block
+                u8 alignment_offset;
+                // suggested minimum I/O size in blocks
+                le16 min_io_size;
+                // optimal (suggested maximum) I/O size in blocks
+                le32 opt_io_size;
+        } topology;
+        u8 writeback;
+        u8 unused0;
+        u16 num_queues;
+        le32 max_discard_sectors;
+        le32 max_discard_seg;
+        le32 discard_sector_alignment;
+        le32 max_write_zeroes_sectors;
+        le32 max_write_zeroes_seg;
+        u8 write_zeroes_may_unmap;
+        u8 unused1[3];
+        le32 max_secure_erase_sectors;
+        le32 max_secure_erase_seg;
+        le32 secure_erase_sector_alignment;
+        struct virtio_blk_zoned_characteristics {
+                le32 zone_sectors;
+                le32 max_open_zones;
+                le32 max_active_zones;
+                le32 max_append_sectors;
+                le32 write_granularity;
+                u8 model;
+                u8 unused2[3];
+        } zoned;
+};
+\end{lstlisting}
+
 The \field{capacity} of the device (expressed in 512-byte sectors) is always
 present. The availability of the others all depend on various feature
 bits as indicated above.

@@ -167,53 +215,6 @@ \subsection{Device configuration layout}\label{sec:Device Types / Block Device /
 terminated by the device with a "zone resources exceeded" error as defined for
 specific commands later.
 
-\begin{lstlisting}
-struct virtio_blk_config {
-        le64 capacity;
-        le32 size_max;
-        le32 seg_max;
-        struct virtio_blk_geometry {
-                le16 cylinders;
-                u8 heads;
-                u8 sectors;
-        } geometry;
-        le32 blk_size;
-        struct virtio_blk_topology {
-                // # of logical blocks per physical block (log2)
-                u8 physical_block_exp;
-                // offset of first aligned logical block
-                u8 alignment_offset;
-                // suggested minimum I/O size in blocks
-                le16 min_io_size;
-                // optimal (suggested maximum) I/O size in blocks
-                le32 opt_io_size;
-        } topology;
-        u8 writeback;
-        u8 unused0;
-        u16 num_queues;
-        le32 max_discard_sectors;
-        le32 max_discard_seg;
-        le32 discard_sector_alignment;
-        le32 max_write_zeroes_sectors;
-        le32 max_write_zeroes_seg;
-        u8 write_zeroes_may_unmap;
-        u8 unused1[3];
-        le32 max_secure_erase_sectors;
-        le32 max_secure_erase_seg;
-        le32 secure_erase_sector_alignment;
-        struct virtio_blk_zoned_characteristics {
-                le32 zone_sectors;
-                le32 max_open_zones;
-                le32 max_active_zones;
-                le32 max_append_sectors;
-                le32 write_granularity;
-                u8 model;
-                u8 unused2[3];
-        } zoned;
-};
-\end{lstlisting}
-
-
 \subsubsection{Legacy Interface: Device configuration layout}\label{sec:Device Types / Block Device / Device configuration layout / Legacy Interface: Device configuration layout}
 When using the legacy interface, transitional devices and drivers
 MUST format the fields in struct virtio_blk_config

Signature · 1 line

2.26.2

Yes, please!

Reviewed-by Stefan Hajnoczi <[email protected]>

Parav Pandit

author

2023-03-12 13:22 UTC #2 lore raw

Quoted 16 lines

From: Stefan Hajnoczi <[email protected]>
Sent: Thursday, February 23, 2023 3:46 PM
Quoted 10 lines · Parav Pandit
Define device configuration layout structure before describing its individual fields.
This is an editorial change.
Suggested-by Cornelia Huck <[email protected]>
Reviewed-by Max Gurtovoy <[email protected]>
Signed-off-by Parav Pandit <[email protected]>
---
 device-types/blk/description.tex | 95

[..]

Quoted 3 lines

Yes, please!
Reviewed-by Stefan Hajnoczi <[email protected]>

Hi Cornelia,

Can you please merge this?

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/

Parav Pandit

author

2023-03-15 14:24 UTC #3 lore raw

Quoted 21 lines

From: [email protected] <[email protected] open.org> On Behalf Of Parav Pandit
Quoted 14 lines
From: Stefan Hajnoczi <[email protected]>
Sent: Thursday, February 23, 2023 3:46 PM
Quoted 10 lines · Parav Pandit
Define device configuration layout structure before describing its individual fields.
This is an editorial change.
Suggested-by Cornelia Huck <[email protected]>
Reviewed-by Max Gurtovoy <[email protected]>
Signed-off-by Parav Pandit <[email protected]>
---
 device-types/blk/description.tex | 95
[..]

Quoted 7 lines

Quoted 3 lines
Yes, please!
Reviewed-by Stefan Hajnoczi <[email protected]>
Hi Cornelia,
Can you please merge this?

Any updates?

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.

Michael S. Tsirkin

2023-03-15 15:00 UTC #4 lore raw

Quoted 23 lines · Parav Pandit

Quoted 23 lines
From: [email protected] <[email protected] open.org> On Behalf Of Parav Pandit
Quoted 14 lines
From: Stefan Hajnoczi <[email protected]>
Sent: Thursday, February 23, 2023 3:46 PM
Quoted 10 lines · Parav Pandit
Define device configuration layout structure before describing its individual fields.
This is an editorial change.
Suggested-by Cornelia Huck <[email protected]>
Reviewed-by Max Gurtovoy <[email protected]>
Signed-off-by Parav Pandit <[email protected]>
---
 device-types/blk/description.tex | 95
[..]
Quoted 2 lines
Yes, please!

Quoted 7 lines

Quoted 5 lines
Quoted 1 line
Reviewed-by Stefan Hajnoczi <[email protected]>
Hi Cornelia,
Can you please merge this?
Any updates?

Pushed, thanks!

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.

Parav Pandit

author

2023-03-15 15:12 UTC #5 lore raw

Quoted 11 lines

From: [email protected] <[email protected] open.org> On Behalf Of Michael S. Tsirkin
Quoted 5 lines
Quoted 3 lines
Hi Cornelia,
Can you please merge this?
Any updates?
Pushed, thanks!

Thank you.

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.