Skip to content

types: add performance attribute structures #971

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
igaw merged 4 commits into from
Apr 7, 2025
Merged

types: add performance attribute structures #971

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f381c3b
types: add performance attribute structures
ikegami-t Mar 20, 2025
8bb8407
types: add performance characteristics feature access values
ikegami-t Mar 21, 2025
95f5557
util: add performance characteristics feature decode function
ikegami-t Mar 21, 2025
50471e0
types: add performance characteristics attribute type values
ikegami-t Mar 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
84 changes: 84 additions & 0 deletions src/nvme/types.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,9 @@
* NVMe standard definitions
*/

#define NVME_UUID_LEN 16
Comment thread
igaw marked this conversation as resolved.
#define NVME_UUID_LEN_STRING 37 /* 1b4e28ba-2fa1-11d2-883f-0016d3cca427 + \0 */

/**
* NVME_GET() - extract field from complex value
* @value: The original value of a complex field
Expand Down Expand Up @@ -5997,6 +6000,75 @@ enum nvme_apst_entry {
NVME_APST_ENTRY_ITPT_MASK = 0xffffff,
};

/**
* struct nvme_std_perf_attr - Standard performance attribute structure
* @rsvd0: Reserved
* @r4karl: Random 4 KiB average read latency
* @rsvd5: Reserved
*/
struct nvme_std_perf_attr {
__u8 rsvd0[4];
__u8 r4karl;
__u8 rsvd5[4091];
};

/**
* struct nvme_perf_attr_id - Performance attribute identifier structure
* @id: Performance attribute identifier
*/
struct nvme_perf_attr_id {
__u8 id[NVME_UUID_LEN];
};

/**
* struct nvme_perf_attr_id_list - Performance attribute identifier list structure
* @attrtyp: Bits 7-3: Reserved
* Bits 2-0: Attribute type
* @msvspa: Maximum saveable vendor specific performance attributes
* @usvspa: Unused saveable vendor specific performance attributes
* @rsvd3: Reserved
* @id_list: Performance attribute identifier list
* @rsvd1024: Reserved
*/
struct nvme_perf_attr_id_list {
__u8 attrtyp;
__u8 msvspa;
__u8 usvspa;
__u8 rsvd3[13];
struct nvme_perf_attr_id id_list[63];
__u8 rsvd1024[3072];
};

/**
* struct nvme_vs_perf_attr - Vendor specific performance attribute structure
* @paid: Performance attribute identifier
* @rsvd16: Reserved
* @attrl: Attribute Length
* @vs: Vendor specific
*/
struct nvme_vs_perf_attr {
__u8 paid[16];
__u8 rsvd16[14];
__le16 attrl;
__u8 vs[4064];
};

/**
* struct nvme_perf_characteristics - Performance attribute structure
* @std_perf: Standard performance attribute
* @id_list: Performance attribute identifier list
* @vs_perf: Vendor specific performance attribute
* @attr_buf: Attribute buffer
*/
struct nvme_perf_characteristics {
union {
struct nvme_std_perf_attr std_perf[0];
struct nvme_perf_attr_id_list id_list[0];
struct nvme_vs_perf_attr vs_perf[0];
__u8 attr_buf[4096];
};
};

/**
* struct nvme_metadata_element_desc - Metadata Element Descriptor
* @type: Element Type (ET)
Expand Down Expand Up @@ -8822,6 +8894,12 @@ enum nvme_features_id {
* @NVME_FEAT_SPINUP_CONTROL_MASK:
* @NVME_FEAT_PLS_MODE_SHIFT:
* @NVME_FEAT_PLS_MODE_MASK:
* @NVME_FEAT_PERFC_ATTRI_SHIFT:
* @NVME_FEAT_PERFC_ATTRI_MASK:
* @NVME_FEAT_PERFC_RVSPA_SHIFT:
* @NVME_FEAT_PERFC_RVSPA_MASK:
* @NVME_FEAT_PERFC_ATTRTYP_SHIFT:
* @NVME_FEAT_PERFC_ATTRTYP_MASK:
* @NVME_FEAT_FDP_ENABLED_SHIFT:
* @NVME_FEAT_FDP_ENABLED_MASK:
* @NVME_FEAT_FDP_INDEX_SHIFT:
Expand Down Expand Up @@ -8956,6 +9034,12 @@ enum nvme_feat {
NVME_FEAT_SPINUP_CONTROL_MASK = 0x1,
NVME_FEAT_PLS_MODE_SHIFT = 0,
NVME_FEAT_PLS_MODE_MASK = 0x3,
NVME_FEAT_PERFC_ATTRI_SHIFT = 0,
NVME_FEAT_PERFC_ATTRI_MASK = 0xff,
NVME_FEAT_PERFC_RVSPA_SHIFT = 8,
NVME_FEAT_PERFC_RVSPA_MASK = 0x1,
NVME_FEAT_PERFC_ATTRTYP_SHIFT = 0,
NVME_FEAT_PERFC_ATTRTYP_MASK = 0x3,
NVME_FEAT_FDP_ENABLED_SHIFT = 0,
NVME_FEAT_FDP_ENABLED_MASK = 0x1,
NVME_FEAT_FDP_INDEX_SHIFT = 8,
Expand Down
12 changes: 9 additions & 3 deletions src/nvme/util.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -448,6 +448,15 @@ static inline void nvme_feature_decode_endurance_group_event_config(__u32 value,
*endgcw = NVME_FEAT_EG_EGCW(value);
}

#define NVME_FEAT_PERFC_ATTRI(v) NVME_GET(v, FEAT_PERFC_ATTRI)
#define NVME_FEAT_PERFC_RVSPA(v) NVME_GET(v, FEAT_PERFC_RVSPA)

static inline void nvme_feature_decode_perf_characteristics(__u32 value, __u8 *attri, bool *rvspa)
{
*attri = NVME_FEAT_PERFC_ATTRI(value);
*rvspa = NVME_FEAT_PERFC_RVSPA(value);
}

#define NVME_FEAT_SPM_PBSLC(v) NVME_GET(v, FEAT_SPM_PBSLC)

static inline void nvme_feature_decode_software_progress_marker(__u32 value,
Expand Down Expand Up @@ -646,9 +655,6 @@ enum nvme_version {
*/
const char *nvme_get_version(enum nvme_version type);

#define NVME_UUID_LEN_STRING 37 /* 1b4e28ba-2fa1-11d2-883f-0016d3cca427 + \0 */
#define NVME_UUID_LEN 16

/**
* nvme_uuid_to_string - Return string represenation of encoded UUID
* @uuid: Binary encoded input UUID
Expand Down