feat: add power-thresh command

This is for Power Threshold feature to get and set.

Signed-off-by: Tokunori Ikegami <[email protected]>

Author: ikegami-t

libnvme/src/nvme/types.h

@@ -1098,6 +1098,22 @@ enum nvme_psd_ps {
 	NVME_PSD_PS_10_MILLI_WATT	= 2,
 };
 
+/**
+ * enum nvme_power_measurement_type - Power measurement types.
+ * @NVME_PMT_NSS_TOTAL_POWER: NVM subsystem total power
+ * @NVME_PMT_RSVD_MIN:	      Reserved minimum value
+ * @NVME_PMT_RSVD_MAX:	      Reserved maximum value
+ * @NVME_PMT_VS_MIN:	      Vendor Specific minimum value
+ * @NVME_PMT_VS_MAX:	      Vendor Specific maximum value
+ */
+enum nvme_power_measurement_type {
+	NVME_PMT_NSS_TOTAL_POWER = 0x0,
+	NVME_PMT_RSVD_MIN	 = 0x1,
+	NVME_PMT_RSVD_MAX	 = 0xb,
+	NVME_PMT_VS_MIN		 = 0xc,
+	NVME_PMT_VS_MAX		 = 0xf,
+};
+
 /**
  * nvme_psd_power_scale() - power scale occupies the upper 3 bits
  * @ps: power scale value
@@ -9063,6 +9079,14 @@ enum nvme_features_id {
  * @NVME_FEAT_POWER_LIMIT_PLV_MASK:
  * @NVME_FEAT_POWER_LIMIT_PLS_SHIFT:
  * @NVME_FEAT_POWER_LIMIT_PLS_MASK:
+ * @NVME_FEAT_POWER_THRESH_PTV_SHIFT:
+ * @NVME_FEAT_POWER_THRESH_PTV_MASK:
+ * @NVME_FEAT_POWER_THRESH_PTS_SHIFT:
+ * @NVME_FEAT_POWER_THRESH_PTS_MASK:
+ * @NVME_FEAT_POWER_THRESH_PMTS_SHIFT:
+ * @NVME_FEAT_POWER_THRESH_PMTS_MASK:
+ * @NVME_FEAT_POWER_THRESH_EPT_SHIFT:
+ * @NVME_FEAT_POWER_THRESH_EPT_MASK:
  **/
 enum nvme_feat {
 	NVME_FEAT_ARBITRATION_BURST_SHIFT	= 0,
@@ -9221,6 +9245,14 @@ enum nvme_feat {
 	NVME_FEAT_POWER_LIMIT_PLV_MASK	= 0xffff,
 	NVME_FEAT_POWER_LIMIT_PLS_SHIFT	= 16,
 	NVME_FEAT_POWER_LIMIT_PLS_MASK	= 0x3,
+	NVME_FEAT_POWER_THRESH_PTV_SHIFT = 0,
+	NVME_FEAT_POWER_THRESH_PTV_MASK	= 0xffff,
+	NVME_FEAT_POWER_THRESH_PTS_SHIFT = 16,
+	NVME_FEAT_POWER_THRESH_PTS_MASK	= 0x3,
+	NVME_FEAT_POWER_THRESH_PMTS_SHIFT = 20,
+	NVME_FEAT_POWER_THRESH_PMTS_MASK = 0xf,
+	NVME_FEAT_POWER_THRESH_EPT_SHIFT = 31,
+	NVME_FEAT_POWER_THRESH_EPT_MASK	= 0x1,
 };
 
 /**

libnvme/src/nvme/util.h

@@ -291,6 +291,11 @@ static inline void nvme_feature_decode_arbitration(__u32 value, __u8 *ab,
 #define NVME_FEAT_POWER_LIMIT_PLV(v)	NVME_GET(v, FEAT_POWER_LIMIT_PLV)
 #define NVME_FEAT_POWER_LIMIT_PLS(v)	NVME_GET(v, FEAT_POWER_LIMIT_PLS)
 
+#define NVME_FEAT_POWER_THRESH_PTV(v)	NVME_GET(v, FEAT_POWER_THRESH_PTV)
+#define NVME_FEAT_POWER_THRESH_PTS(v)	NVME_GET(v, FEAT_POWER_THRESH_PTS)
+#define NVME_FEAT_POWER_THRESH_PMTS(v)	NVME_GET(v, FEAT_POWER_THRESH_PMTS)
+#define NVME_FEAT_POWER_THRESH_EPT(v)	NVME_GET(v, FEAT_POWER_THRESH_EPT)
+
 static inline void nvme_feature_decode_power_mgmt(__u32 value, __u8 *ps,
 						  __u8 *wh)
 {

nvme-print-json.c

@@ -4123,6 +4123,31 @@ static void json_feature_show_fields_power_limit(struct json_object *r,
 	obj_add_str(r, "Power Limit", k);
 }
 
+static void json_feature_show_fields_power_thresh(struct json_object *r,
+						  unsigned int result)
+{
+	__u8 field = NVME_FEAT_POWER_THRESH_EPT(result);
+
+	_cleanup_free_ char *k = NULL;
+
+	obj_add_str(r, "Enable Power Threshold (EPT)",
+		    field ? "Enabled" : "Disabled");
+
+	field = NVME_FEAT_POWER_THRESH_PMTS(result);
+	obj_add_str(r, "Power Measurement Type Select (PMTS)",
+		    nvme_power_measurement_type_to_string(field));
+
+	field = NVME_FEAT_POWER_THRESH_PTS(result);
+	obj_add_str(r, "Power Threshold Scale (PTS)",
+		    nvme_feature_power_limit_scale_to_string(field));
+
+	field = NVME_FEAT_POWER_THRESH_PTV(result);
+	obj_add_uint(r, "Power Threshold Value (PTV)", field);
+
+	k = get_power_and_scale(field, NVME_FEAT_POWER_THRESH_PTS(result));
+	obj_add_str(r, "Power Threshold", k);
+}
+
 static void json_feature_show(enum nvme_features_id fid, int sel, unsigned int result)
 {
 	struct json_object *r;
@@ -4265,6 +4290,9 @@ static void json_feature_show_fields(enum nvme_features_id fid, unsigned int res
 	case NVME_FEAT_FID_POWER_LIMIT:
 		json_feature_show_fields_power_limit(r, result);
 		break;
+	case NVME_FEAT_FID_POWER_THRESH:
+		json_feature_show_fields_power_thresh(r, result);
+		break;
 	default:
 		break;
 	}

nvme-print-stdout.c

@@ -5397,6 +5397,23 @@ static void stdout_feature_show_fields(enum nvme_features_id fid,
 		print_power_and_scale(NVME_FEAT_POWER_LIMIT_PLV(result), field);
 		printf("\n");
 		break;
+	case NVME_FEAT_FID_POWER_THRESH:
+		field = NVME_FEAT_POWER_THRESH_EPT(result);
+		printf("\tEnable Power Threshold (EPT): %u - %s\n",
+		       field, field ? "Enabled" : "Disabled");
+		field = NVME_FEAT_POWER_THRESH_PMTS(result);
+		printf("\tPower Measurement Type Select (PMTS): %u - %s\n",
+		       field, nvme_power_measurement_type_to_string(field));
+		field = NVME_FEAT_POWER_THRESH_PTS(result);
+		printf("\tPower Threshold Scale (PTS): %u - %s\n", field,
+		       nvme_feature_power_limit_scale_to_string(field));
+		printf("\tPower Threshold Value (PTV): %u\n",
+		       NVME_FEAT_POWER_THRESH_PTV(result));
+		printf("\tPower Threshold: ");
+		print_power_and_scale(NVME_FEAT_POWER_THRESH_PTV(result),
+				      field);
+		printf("\n");
+		break;
 	default:
 		break;
 	}

nvme-print.c

@@ -1511,6 +1511,20 @@ const char *nvme_feature_power_limit_scale_to_string(__u8 pls)
 	return "Reserved";
 }
 
+const char *nvme_power_measurement_type_to_string(__u8 pmt)
+{
+	switch (pmt) {
+	case NVME_PMT_NSS_TOTAL_POWER:
+		return "NVM subsystem total power";
+	case NVME_PMT_VS_MIN ... NVME_PMT_VS_MAX:
+		return "Vendor Specific";
+	default:
+		break;
+	}
+
+	return "Reserved";
+}
+
 void nvme_feature_show(enum nvme_features_id fid, int sel, unsigned int result)
 {
 	nvme_print(show_feature, NORMAL, fid, sel, result);

nvme-print.h

@@ -342,6 +342,7 @@ const char *nvme_time_scale_to_string(__u8 ts);
 const char *nvme_pls_mode_to_string(__u8 mode);
 const char *nvme_bpwps_to_string(__u8 bpwps);
 const char *nvme_feature_power_limit_scale_to_string(__u8 pls);
+const char *nvme_power_measurement_type_to_string(__u8 pmt);
 
 void nvme_dev_full_path(nvme_ns_t n, char *path, size_t len);
 void nvme_generic_full_path(nvme_ns_t n, char *path, size_t len);

plugins/feat/feat-nvme.c

@@ -49,6 +49,7 @@ static const char *temp_thresh_feat = "temperature threshold feature";
 static const char *arbitration_feat = "arbitration feature";
 static const char *volatile_wc_feat = "volatile write cache feature";
 static const char *power_limit_feat = "power limit feature";
+static const char *power_thresh_feat = "power threshold feature";
 
 static int feat_get(struct nvme_transport_handle *hdl, const __u8 fid,
 		    __u32 cdw11, __u8 sel, __u8 uidx, const char *feat)
@@ -669,3 +670,84 @@ static int feat_power_limit(int argc, char **argv, struct command *acmd,
 
 	return err;
 }
+
+static int power_thresh_set(struct nvme_transport_handle *hdl, const __u8 fid,
+			    __u8 ptv, __u8 pts, __u8 pmts, __u8 ept, __u8 uidx,
+			    bool sv)
+{
+	__u32 cdw11 = NVME_SET(ptv, FEAT_POWER_THRESH_PTV) |
+		      NVME_SET(pmts, FEAT_POWER_THRESH_PMTS) |
+		      NVME_SET(pts, FEAT_POWER_THRESH_PTS) |
+		      NVME_SET(ept, FEAT_POWER_THRESH_EPT);
+	__u64 result;
+	int err;
+
+	err = nvme_set_features(hdl, 0, fid, sv, cdw11, 0, 0, uidx, 0, NULL, 0,
+				&result);
+
+	nvme_show_init();
+
+	if (err > 0) {
+		nvme_show_status(err);
+	} else if (err < 0) {
+		nvme_show_perror("Set %s", power_thresh_feat);
+	} else {
+		nvme_show_result("Set %s: 0x%04x (%s)", power_thresh_feat,
+				 cdw11, sv ? "Save" : "Not save");
+		nvme_feature_show_fields(fid, cdw11, NULL);
+	}
+
+	nvme_show_finish();
+
+	return err;
+}
+
+static int feat_power_thresh(int argc, char **argv, struct command *acmd,
+			     struct plugin *plugin)
+{
+	const char *ptv = "power threshold value";
+	const char *pts = "power threshold scale";
+	const char *pmts = "power measurement type select";
+	const char *ept = "enable power threshold";
+	const __u8 fid = NVME_FEAT_FID_POWER_THRESH;
+
+	_cleanup_nvme_global_ctx_ struct nvme_global_ctx *ctx = NULL;
+
+	_cleanup_nvme_transport_handle_ struct nvme_transport_handle *hdl =
+	    NULL;
+	int err;
+
+	struct config {
+		__u8 ptv;
+		__u8 pts;
+		__u8 pmts;
+		__u8 ept;
+		__u8 uidx;
+		__u8 sel;
+	};
+
+	struct config cfg = { 0 };
+
+	FEAT_ARGS(opts,
+		  OPT_BYTE("ptv", 'p', &cfg.ptv, ptv),
+		  OPT_BYTE("pts", 't', &cfg.pts, pts),
+		  OPT_BYTE("pmts", 'm', &cfg.pmts, pmts),
+		  OPT_BYTE("ept", 'e', &cfg.ept, ept),
+		  OPT_BYTE("uuid-index", 'u', &cfg.uidx, uuid_index));
+
+	err = parse_and_open(&ctx, &hdl, argc, argv, POWER_LIMIT_DESC, opts);
+	if (err)
+		return err;
+
+	if (argconfig_parse_seen(opts, "ptv") ||
+	    argconfig_parse_seen(opts, "pmts") ||
+	    argconfig_parse_seen(opts, "ept"))
+		err = power_thresh_set(hdl, fid, cfg.ptv, cfg.pts, cfg.pmts,
+				       cfg.ept, cfg.uidx,
+				       argconfig_parse_seen(opts, "save"));
+	else
+		err = feat_get(hdl, fid, 0, cfg.sel, cfg.uidx,
+			       power_thresh_feat);
+
+	return err;
+}

plugins/feat/feat-nvme.h

@@ -18,6 +18,7 @@
 #define ARBITRATION_DESC "Get and set arbitration feature"
 #define VOLATILE_WC_DESC "Get and set volatile write cache feature"
 #define POWER_LIMIT_DESC "Get and set power limit feature"
+#define POWER_THRESH_DESC "Get and set power threshold feature"
 
 #define FEAT_ARGS(n, ...)                                              \
 	NVME_ARGS(n, ##__VA_ARGS__, OPT_FLAG("save", 's', NULL, save), \
@@ -33,6 +34,7 @@ PLUGIN(NAME("feat", "NVMe feature extensions", FEAT_PLUGIN_VERSION),
 		ENTRY("arbitration", ARBITRATION_DESC, feat_arbitration)
 		ENTRY("volatile-wc", VOLATILE_WC_DESC, feat_volatile_wc)
 		ENTRY("power-limit", POWER_LIMIT_DESC, feat_power_limit)
+		ENTRY("power-thresh", POWER_THRESH_DESC, feat_power_thresh)
 	)
 );
 #endif /* !FEAT_NVME || CMD_HEADER_MULTI_READ */