Skip to content

Commit ab88203

Browse files
author
Arunpandian J
committed
types.h: doc update for ZNS structures
Signed-off-by: Arunpandian J <[email protected]>
1 parent f38f141 commit ab88203

1 file changed

Lines changed: 32 additions & 32 deletions

File tree

src/nvme/types.h

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -3844,9 +3844,9 @@ enum nvme_sanitize_sstat {
38443844

38453845
/**
38463846
* struct nvme_zns_changed_zone_log - ZNS Changed Zone List log
3847-
* @nrzid:
3848-
* @rsvd2:
3849-
* @zid:
3847+
* @nrzid: Number of Zone Identifiers
3848+
* @rsvd2: Reserved
3849+
* @zid: Zone Identifier
38503850
*/
38513851
struct nvme_zns_changed_zone_log {
38523852
__le16 nrzid;
@@ -3864,11 +3864,11 @@ enum nvme_zns_zt {
38643864

38653865
/**
38663866
* enum nvme_zns_za -
3867-
* @NVME_ZNS_ZA_ZFC:
3868-
* @NVME_ZNS_ZA_FZR:
3869-
* @NVME_ZNS_ZA_RZR:
3867+
* @NVME_ZNS_ZA_ZFC: Zone Finished by Controller
3868+
* @NVME_ZNS_ZA_FZR: Finish Zone Recommended
3869+
* @NVME_ZNS_ZA_RZR: Reset Zone Recommended
38703870
* @NVME_ZNS_ZA_ZRWAV:
3871-
* @NVME_ZNS_ZA_ZDEV:
3871+
* @NVME_ZNS_ZA_ZDEV: Zone Descriptor Extension Valid
38723872
*/
38733873
enum nvme_zns_za {
38743874
NVME_ZNS_ZA_ZFC = 1 << 0,
@@ -3880,13 +3880,13 @@ enum nvme_zns_za {
38803880

38813881
/**
38823882
* enum nvme_zns_zs -
3883-
* @NVME_ZNS_ZS_EMPTY:
3884-
* @NVME_ZNS_ZS_IMPL_OPEN:
3885-
* @NVME_ZNS_ZS_EXPL_OPEN:
3886-
* @NVME_ZNS_ZS_CLOSED:
3887-
* @NVME_ZNS_ZS_READ_ONLY:
3888-
* @NVME_ZNS_ZS_FULL:
3889-
* @NVME_ZNS_ZS_OFFLINE:
3883+
* @NVME_ZNS_ZS_EMPTY: Empty state
3884+
* @NVME_ZNS_ZS_IMPL_OPEN: Implicitly open state
3885+
* @NVME_ZNS_ZS_EXPL_OPEN: Explicitly open state
3886+
* @NVME_ZNS_ZS_CLOSED: Closed state
3887+
* @NVME_ZNS_ZS_READ_ONLY: Read only state
3888+
* @NVME_ZNS_ZS_FULL: Full state
3889+
* @NVME_ZNS_ZS_OFFLINE: Offline state
38903890
*/
38913891
enum nvme_zns_zs {
38923892
NVME_ZNS_ZS_EMPTY = 0x1,
@@ -3900,15 +3900,15 @@ enum nvme_zns_zs {
39003900

39013901
/**
39023902
* struct nvme_zns_desc -
3903-
* @zt:
3904-
* @zs:
3905-
* @za:
3906-
* @zai:
3907-
* @rsvd4:
3908-
* @zcap:
3909-
* @zslba:
3910-
* @wp:
3911-
* @rsvd32:
3903+
* @zt: Zone Type
3904+
* @zs: Zone State
3905+
* @za: Zone Attributes
3906+
* @zai: Zone Attributes Information
3907+
* @rsvd4: Reserved
3908+
* @zcap: Zone Capacity
3909+
* @zslba: Zone Start Logical Block Address
3910+
* @wp: Write Pointer
3911+
* @rsvd32: Reserved
39123912
*/
39133913
struct nvme_zns_desc {
39143914
__u8 zt;
@@ -3936,11 +3936,11 @@ struct nvme_zone_report {
39363936

39373937
/**
39383938
* struct nvme_lba_status_desc -
3939-
* @dslba:
3940-
* @nlb:
3941-
* @rsvd12:
3942-
* @status:
3943-
* @rsvd14:
3939+
* @dslba: Descriptor Starting LBA
3940+
* @nlb: Number of Logical Blocks
3941+
* @rsvd12: Reserved
3942+
* @status: Additional status about this LBA range
3943+
* @rsvd14: Reserved
39443944
*/
39453945
struct nvme_lba_status_desc {
39463946
__le64 dslba;
@@ -3952,10 +3952,10 @@ struct nvme_lba_status_desc {
39523952

39533953
/**
39543954
* struct nvme_lba_status -
3955-
* @nlsd:
3956-
* @cmpc:
3957-
* @rsvd5:
3958-
* @descs:
3955+
* @nlsd: Number of LBA Status Descriptors
3956+
* @cmpc: Completion Condition
3957+
* @rsvd5: Reserved
3958+
* @descs: LBA status descriptor Entry
39593959
*/
39603960
struct nvme_lba_status {
39613961
__le32 nlsd;

0 commit comments

Comments
 (0)