sed: incorporate review comment on pull request

- Fix compile errors with older kernels
- address all checkpatch error/warnings
- correct typos

Signed-off-by: Greg Joyce <gjoyce@linux.ibm.com>

Author: gjoyce-ibm

meson.build

@@ -153,6 +153,20 @@ conf.set10(
     cc.get_id() == 'clang',
     description: 'Is compiler warning about unused static line function?'
 )
+conf.set10(
+    'HAVE_KEY_TYPE',
+    cc.compiles(
+        '''
+	   #include <linux/sed-opal.h>
+	   int main(void) {
+                struct opal_key key;
+                key.key_type = OPAL_INCLUDED;
+           }
+        ''',
+        name: 'key_type'
+    ),
+    description: 'Does struct opal_key have a key_type field?'
+)
 
 if cc.has_function_attribute('fallthrough')
   conf.set('fallthrough', '__attribute__((__fallthrough__))')

plugins/meson.build

@@ -26,7 +26,6 @@ if json_c_dep.found()
     'plugins/wdc/wdc-utils.c',
     'plugins/ymtc/ymtc-nvme.c',
     'plugins/zns/zns.c',
-    'plugins/sed/sed.c',
   ]
   subdir('solidigm')
   subdir('ocp')

plugins/sed/meson.build

@@ -2,4 +2,3 @@ sources += [
   'plugins/sed/sed.c',
   'plugins/sed/sedopal_cmd.c',
 ]
-

plugins/sed/sed.c

@@ -32,17 +32,20 @@ OPT_ARGS(key_opts) = {
 OPT_ARGS(revert_opts) = {
 	OPT_FLAG("destructive", 'e', &sedopal_destructive_revert,
 			"destructive revert"),
+#ifdef IOC_OPAL_PSID_REVERT_TPR
 	OPT_FLAG("psid", 'p', &sedopal_psid_revert, "PSID revert"),
+#endif
 	OPT_END()
 };
 
 
 /*
  * Open the NVMe device specified on the command line. It must be the
- * NVMe block device (e.g. /deve/nvme0n1).
+ * NVMe block device (e.g. /dev/nvme0n1).
  */
 static int sed_opal_open_device(struct nvme_dev **dev, int argc, char **argv,
-		const char *desc, struct argconfig_commandline_options *opts) {
+		const char *desc, struct argconfig_commandline_options *opts)
+{
 	int err;
 
 	err = parse_and_open(dev, argc, argv, desc, opts);
@@ -59,6 +62,7 @@ static int sed_opal_open_device(struct nvme_dev **dev, int argc, char **argv,
 	return err;
 }
 
+#ifdef IOC_OPAL_DISCOVERY
 static int sed_opal_discover(int argc, char **argv, struct command *cmd,
 		struct plugin *plugin)
 {
@@ -75,6 +79,7 @@ static int sed_opal_discover(int argc, char **argv, struct command *cmd,
 	dev_close(dev);
 	return err;
 }
+#endif
 
 static int sed_opal_initialize(int argc, char **argv, struct command *cmd,
 		struct plugin *plugin)

plugins/sed/sed.h

@@ -3,10 +3,13 @@
 #define CMD_INC_FILE plugins/sed/sed
 
 #include "cmd.h"
+#include <linux/sed-opal.h>
 
 PLUGIN(NAME("sed", "SED Opal Command Set", NVME_VERSION),
 	COMMAND_LIST(
+#ifdef IOC_OPAL_DISCOVERY
 		ENTRY("discover", "Discover SED Opal Locking Features", sed_opal_discover, "1")
+#endif
 		ENTRY("initialize", "Initialize a SED Opal Device for locking", sed_opal_initialize)
 		ENTRY("revert", "Revert a SED Opal Device from locking", sed_opal_revert)
 		ENTRY("lock", "Lock a SED Opal Device", sed_opal_lock)

plugins/sed/sedopal_cmd.c

@@ -1,21 +1,4 @@
-/*
- * Copyright (C) 2023, 2024 IBM Corporation
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; either version 2
- * of the License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
- * USA.
- */
+// SPDX-License-Identifier: GPL-2.0-or-later
 
 #include <ctype.h>
 #include <stdio.h>
@@ -34,22 +17,22 @@
 /*
  * ask user for key rather than obtaining it from kernel keyring
  */
-bool sedopal_ask_key = false;
+bool sedopal_ask_key;
 
 /*
  * initiate dialog to ask for and confirm new password
  */
-bool sedopal_ask_new_key = false;
+bool sedopal_ask_new_key;
 
 /*
  * perform a destructive drive revert
  */
-bool sedopal_destructive_revert = false;
+bool sedopal_destructive_revert;
 
 /*
  * perform a PSID drive revert
  */
-bool sedopal_psid_revert = false;
+bool sedopal_psid_revert;
 
 /*
  * Map method status codes to error text
@@ -94,7 +77,8 @@ const char *sedopal_error_to_text(int code)
 /*
  * Read a user entered password and do some basic validity checks.
  */
-char * sedopal_get_password(char * prompt) {
+char *sedopal_get_password(char *prompt)
+{
 	char *pass;
 	int len;
 
@@ -117,7 +101,14 @@ char * sedopal_get_password(char * prompt) {
  * key should be looked up in the kernel keyring, or it should be
  * populated in the key by prompting the user.
  */
-int sedopal_set_key(struct opal_key *key) {
+int sedopal_set_key(struct opal_key *key)
+{
+#ifndef OPAL_KEY_TYPE
+	/*
+	 * If key_type isn't avaialable, force key prompt
+	 */
+	sedopal_ask_key = true;
+#endif
 
 	if (sedopal_ask_key) {
 		char *pass;
@@ -139,7 +130,9 @@ int sedopal_set_key(struct opal_key *key) {
 		if (pass == NULL)
 			return -EINVAL;
 
+#if HAVE_KEY_TYPE
 		key->key_type = OPAL_INCLUDED;
+#endif
 		key->key_len = strlen(pass);
 		memcpy(key->key, pass, key->key_len);
 
@@ -156,8 +149,10 @@ int sedopal_set_key(struct opal_key *key) {
 			}
 		}
 	} else {
-		key->key_type = OPAL_KEYRING; 
-		key->key_len = 0; 
+#if HAVE_KEY_TYPE
+		key->key_type = OPAL_KEYRING;
+#endif
+		key->key_len = 0;
 	}
 
 	key->lr = 0;
@@ -168,7 +163,8 @@ int sedopal_set_key(struct opal_key *key) {
 /*
  * Prepare a drive for SED Opal locking.
  */
-int sedopal_cmd_initialize(int fd) {
+int sedopal_cmd_initialize(int fd)
+{
 	int rc;
 	struct opal_key key;
 	struct opal_lr_act lr_act = {};
@@ -227,25 +223,28 @@ int sedopal_cmd_initialize(int fd) {
 /*
  * Lock a SED Opal drive
  */
-int sedopal_cmd_lock(int fd) {
+int sedopal_cmd_lock(int fd)
+{
 
 	return sedopal_lock_unlock(fd, OPAL_LK);
 }
 
 /*
  * Unlock a SED Opal drive
  */
-int sedopal_cmd_unlock(int fd) {
+int sedopal_cmd_unlock(int fd)
+{
 
 	return sedopal_lock_unlock(fd, OPAL_RW);
 }
 
 /*
  * Prepare and issue an ioctl to lock/unlock a drive
  */
-int sedopal_lock_unlock(int fd, int lock_state) {
+int sedopal_lock_unlock(int fd, int lock_state)
+{
 	int rc;
-	struct opal_lock_unlock opal_lu;
+	struct opal_lock_unlock opal_lu = {};
 
 	rc = sedopal_set_key(&opal_lu.session.opal_key);
 	if (rc != 0)
@@ -254,16 +253,15 @@ int sedopal_lock_unlock(int fd, int lock_state) {
 	opal_lu.session.sum = 0;
 	opal_lu.session.who = OPAL_ADMIN1;
 	opal_lu.l_state = lock_state;
-	opal_lu.flags = 0;
 
 	rc = ioctl(fd, IOC_OPAL_LOCK_UNLOCK, &opal_lu);
 	if (rc != 0)
 		fprintf(stderr,
 			"Error: failed locking or unlocking - %d\n", rc);
 
 	/*
-	 * If the unlock was successful, force a re-read of the 
-	 * partion table.
+	 * If the unlock was successful, force a re-read of the
+	 * partition table.
 	 */
 	if (rc == 0) {
 		rc = ioctl(fd, BLKRRPART, 0);
@@ -278,7 +276,8 @@ int sedopal_lock_unlock(int fd, int lock_state) {
 /*
  * Confirm a destructive drive so that data is inadvertently erased
  */
-static bool sedopal_confirm_revert() {
+static bool sedopal_confirm_revert(void)
+{
 	int rc;
 	char ans;
 	bool confirmed = false;
@@ -302,7 +301,8 @@ static bool sedopal_confirm_revert() {
 /*
  * perform a destructive drive revert
  */
-static int sedopal_revert_destructive(int fd) {
+static int sedopal_revert_destructive(int fd)
+{
 	struct opal_key key;
 	int rc;
 
@@ -323,10 +323,12 @@ static int sedopal_revert_destructive(int fd) {
 	return rc;
 }
 
+#ifdef IOC_OPAL_PSID_REVERT_TPR
 /*
  * perform a PSID drive revert
  */
-static int sedopal_revert_psid(int fd) {
+static int sedopal_revert_psid(int fd)
+{
 	struct opal_key key;
 	int rc;
 
@@ -344,33 +346,44 @@ static int sedopal_revert_psid(int fd) {
 
 	return rc;
 }
+#endif /* IOC_OPAL_PSID_REVERT_TPR */
 
 /*
  * revert a drive from the provisioned state to a state where locking
  * is disabled.
  */
-int sedopal_cmd_revert(int fd) {
+int sedopal_cmd_revert(int fd)
+{
 	int rc;
-	struct opal_revert_lsp revert_lsp;
 
 	/*
 	 * for revert, require that key/PSID is provided
 	 */
 	sedopal_ask_key = true;
 
 	if (sedopal_psid_revert) {
+#ifdef IOC_OPAL_PSID_REVERT_TPR
 		rc = sedopal_revert_psid(fd);
+#else
+		rc = -EOPNOTSUPP;
+#endif
 	} else if (sedopal_destructive_revert) {
 		rc = sedopal_revert_destructive(fd);
 	} else {
+#ifdef IOC_OPAL_REVERT_LSP
+		struct opal_revert_lsp revert_lsp;
+
 		rc = sedopal_set_key(&revert_lsp.key);
 		if (rc != 0)
 			return rc;
 
 		revert_lsp.options = OPAL_PRESERVE;
-		revert_lsp.__pad = 0;	
+		revert_lsp.__pad = 0;
 
 		rc = ioctl(fd, IOC_OPAL_REVERT_LSP, &revert_lsp);
+#else
+		rc = -EOPNOTSUPP;
+#endif
 	}
 
 	if (rc != 0)
@@ -383,7 +396,8 @@ int sedopal_cmd_revert(int fd) {
  * Change the password of a drive. The existing password must be
  * provided and the new password is confirmed by re-entry.
  */
-int sedopal_cmd_password(int fd) {
+int sedopal_cmd_password(int fd)
+{
 	int rc;
 	struct opal_new_pw new_pw = {};
 
@@ -417,7 +431,8 @@ int sedopal_cmd_password(int fd) {
 /*
  * Print the state of locking features.
  */
-void sedopal_print_locking_features(uint8_t features) {
+void sedopal_print_locking_features(uint8_t features)
+{
 	printf("Locking Features:\n");
 	printf("\tLocking Supported:         %s\n",
 		(features & OPAL_FEATURE_LOCKING_SUPPORTED) ? "Yes" : "No");
@@ -428,10 +443,12 @@ void sedopal_print_locking_features(uint8_t features) {
 }
 
 /*
- * Query a drive to determine if it's SED Opal capabled and
+ * Query a drive to determine if it's SED Opal capable and
  * it's current locking status.
  */
-int sedopal_cmd_discover(int fd) {
+int sedopal_cmd_discover(int fd)
+{
+#ifdef IOC_OPAL_DISCOVERY
 	int rc;
 	bool sedopal_locking_supported = false;
 	struct opal_discovery discover;
@@ -442,7 +459,7 @@ int sedopal_cmd_discover(int fd) {
 	uint8_t locking_flags;
 	char buf[4096];
 
-	discover.data = (__u64)buf; 
+	discover.data = (__u64)buf;
 	discover.size = sizeof(buf);
 
 	rc = ioctl(fd, IOC_OPAL_DISCOVERY, &discover);
@@ -467,7 +484,7 @@ int sedopal_cmd_discover(int fd) {
 	 */
 	while (feat < feat_end) {
 		code = be16toh(feat->code);
-		switch(code) {
+		switch (code) {
 		case OPAL_FEATURE_CODE_LOCKING:
 			locking_flags = feat->feature;
 			break;
@@ -489,4 +506,7 @@ int sedopal_cmd_discover(int fd) {
 		sedopal_print_locking_features(locking_flags);
 
 	return rc;
+#else /* IOC_OPAL_DISCOVERY */
+	return -EOPNOTSUPP;
+#endif
 }