sed-opal.c 54.1 KB
Newer Older
S
Scott Bauer 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33
/*
 * Copyright © 2016 Intel Corporation
 *
 * Authors:
 *    Scott  Bauer      <scott.bauer@intel.com>
 *    Rafael Antognolli <rafael.antognolli@intel.com>
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms and conditions of the GNU General Public License,
 * version 2, as published by the Free Software Foundation.
 *
 * This program is distributed in the hope 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.
 */

#define pr_fmt(fmt) KBUILD_MODNAME ":OPAL: " fmt

#include <linux/delay.h>
#include <linux/device.h>
#include <linux/kernel.h>
#include <linux/list.h>
#include <linux/genhd.h>
#include <linux/slab.h>
#include <linux/uaccess.h>
#include <uapi/linux/sed-opal.h>
#include <linux/sed-opal.h>
#include <linux/string.h>
#include <linux/kdev_t.h>

#include "opal_proto.h"

34 35 36
#define IO_BUFFER_LENGTH 2048
#define MAX_TOKS 64

37 38 39 40 41
struct opal_step {
	int (*fn)(struct opal_dev *dev, void *data);
	void *data;
};
typedef int (cont_fn)(struct opal_dev *dev);
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82

enum opal_atom_width {
	OPAL_WIDTH_TINY,
	OPAL_WIDTH_SHORT,
	OPAL_WIDTH_MEDIUM,
	OPAL_WIDTH_LONG,
	OPAL_WIDTH_TOKEN
};

/*
 * On the parsed response, we don't store again the toks that are already
 * stored in the response buffer. Instead, for each token, we just store a
 * pointer to the position in the buffer where the token starts, and the size
 * of the token in bytes.
 */
struct opal_resp_tok {
	const u8 *pos;
	size_t len;
	enum opal_response_token type;
	enum opal_atom_width width;
	union {
		u64 u;
		s64 s;
	} stored;
};

/*
 * From the response header it's not possible to know how many tokens there are
 * on the payload. So we hardcode that the maximum will be MAX_TOKS, and later
 * if we start dealing with messages that have more than that, we can increase
 * this number. This is done to avoid having to make two passes through the
 * response, the first one counting how many tokens we have and the second one
 * actually storing the positions.
 */
struct parsed_resp {
	int num;
	struct opal_resp_tok toks[MAX_TOKS];
};

struct opal_dev {
	bool supported;
83
	bool mbr_enabled;
84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106

	void *data;
	sec_send_recv *send_recv;

	struct mutex dev_lock;
	u16 comid;
	u32 hsn;
	u32 tsn;
	u64 align;
	u64 lowest_lba;

	size_t pos;
	u8 cmd[IO_BUFFER_LENGTH];
	u8 resp[IO_BUFFER_LENGTH];

	struct parsed_resp parsed;
	size_t prev_d_len;
	void *prev_data;

	struct list_head unlk_lst;
};


S
Scott Bauer 已提交
107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158
static const u8 opaluid[][OPAL_UID_LENGTH] = {
	/* users */
	[OPAL_SMUID_UID] =
		{ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xff },
	[OPAL_THISSP_UID] =
		{ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01 },
	[OPAL_ADMINSP_UID] =
		{ 0x00, 0x00, 0x02, 0x05, 0x00, 0x00, 0x00, 0x01 },
	[OPAL_LOCKINGSP_UID] =
		{ 0x00, 0x00, 0x02, 0x05, 0x00, 0x00, 0x00, 0x02 },
	[OPAL_ENTERPRISE_LOCKINGSP_UID] =
		{ 0x00, 0x00, 0x02, 0x05, 0x00, 0x01, 0x00, 0x01 },
	[OPAL_ANYBODY_UID] =
		{ 0x00, 0x00, 0x00, 0x09, 0x00, 0x00, 0x00, 0x01 },
	[OPAL_SID_UID] =
		{ 0x00, 0x00, 0x00, 0x09, 0x00, 0x00, 0x00, 0x06 },
	[OPAL_ADMIN1_UID] =
		{ 0x00, 0x00, 0x00, 0x09, 0x00, 0x01, 0x00, 0x01 },
	[OPAL_USER1_UID] =
		{ 0x00, 0x00, 0x00, 0x09, 0x00, 0x03, 0x00, 0x01 },
	[OPAL_USER2_UID] =
		{ 0x00, 0x00, 0x00, 0x09, 0x00, 0x03, 0x00, 0x02 },
	[OPAL_PSID_UID] =
		{ 0x00, 0x00, 0x00, 0x09, 0x00, 0x01, 0xff, 0x01 },
	[OPAL_ENTERPRISE_BANDMASTER0_UID] =
		{ 0x00, 0x00, 0x00, 0x09, 0x00, 0x00, 0x80, 0x01 },
	[OPAL_ENTERPRISE_ERASEMASTER_UID] =
		{ 0x00, 0x00, 0x00, 0x09, 0x00, 0x00, 0x84, 0x01 },

	/* tables */

	[OPAL_LOCKINGRANGE_GLOBAL] =
		{ 0x00, 0x00, 0x08, 0x02, 0x00, 0x00, 0x00, 0x01 },
	[OPAL_LOCKINGRANGE_ACE_RDLOCKED] =
		{ 0x00, 0x00, 0x00, 0x08, 0x00, 0x03, 0xE0, 0x01 },
	[OPAL_LOCKINGRANGE_ACE_WRLOCKED] =
		{ 0x00, 0x00, 0x00, 0x08, 0x00, 0x03, 0xE8, 0x01 },
	[OPAL_MBRCONTROL] =
		{ 0x00, 0x00, 0x08, 0x03, 0x00, 0x00, 0x00, 0x01 },
	[OPAL_MBR] =
		{ 0x00, 0x00, 0x08, 0x04, 0x00, 0x00, 0x00, 0x00 },
	[OPAL_AUTHORITY_TABLE] =
		{ 0x00, 0x00, 0x00, 0x09, 0x00, 0x00, 0x00, 0x00},
	[OPAL_C_PIN_TABLE] =
		{ 0x00, 0x00, 0x00, 0x0B, 0x00, 0x00, 0x00, 0x00},
	[OPAL_LOCKING_INFO_TABLE] =
		{ 0x00, 0x00, 0x08, 0x01, 0x00, 0x00, 0x00, 0x01 },
	[OPAL_ENTERPRISE_LOCKING_INFO_TABLE] =
		{ 0x00, 0x00, 0x08, 0x01, 0x00, 0x00, 0x00, 0x00 },

	/* C_PIN_TABLE object ID's */

159
	[OPAL_C_PIN_MSID] =
S
Scott Bauer 已提交
160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182
		{ 0x00, 0x00, 0x00, 0x0B, 0x00, 0x00, 0x84, 0x02},
	[OPAL_C_PIN_SID] =
		{ 0x00, 0x00, 0x00, 0x0B, 0x00, 0x00, 0x00, 0x01},
	[OPAL_C_PIN_ADMIN1] =
		{ 0x00, 0x00, 0x00, 0x0B, 0x00, 0x01, 0x00, 0x01},

	/* half UID's (only first 4 bytes used) */

	[OPAL_HALF_UID_AUTHORITY_OBJ_REF] =
		{ 0x00, 0x00, 0x0C, 0x05, 0xff, 0xff, 0xff, 0xff },
	[OPAL_HALF_UID_BOOLEAN_ACE] =
		{ 0x00, 0x00, 0x04, 0x0E, 0xff, 0xff, 0xff, 0xff },

	/* special value for omitted optional parameter */
	[OPAL_UID_HEXFF] =
		{ 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff},
};

/*
 * TCG Storage SSC Methods.
 * Derived from: TCG_Storage_Architecture_Core_Spec_v2.01_r1.00
 * Section: 6.3 Assigned UIDs
 */
183
static const u8 opalmethod[][OPAL_METHOD_LENGTH] = {
S
Scott Bauer 已提交
184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277
	[OPAL_PROPERTIES] =
		{ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xff, 0x01 },
	[OPAL_STARTSESSION] =
		{ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xff, 0x02 },
	[OPAL_REVERT] =
		{ 0x00, 0x00, 0x00, 0x06, 0x00, 0x00, 0x02, 0x02 },
	[OPAL_ACTIVATE] =
		{ 0x00, 0x00, 0x00, 0x06, 0x00, 0x00, 0x02, 0x03 },
	[OPAL_EGET] =
		{ 0x00, 0x00, 0x00, 0x06, 0x00, 0x00, 0x00, 0x06 },
	[OPAL_ESET] =
		{ 0x00, 0x00, 0x00, 0x06, 0x00, 0x00, 0x00, 0x07 },
	[OPAL_NEXT] =
		{ 0x00, 0x00, 0x00, 0x06, 0x00, 0x00, 0x00, 0x08 },
	[OPAL_EAUTHENTICATE] =
		{ 0x00, 0x00, 0x00, 0x06, 0x00, 0x00, 0x00, 0x0c },
	[OPAL_GETACL] =
		{ 0x00, 0x00, 0x00, 0x06, 0x00, 0x00, 0x00, 0x0d },
	[OPAL_GENKEY] =
		{ 0x00, 0x00, 0x00, 0x06, 0x00, 0x00, 0x00, 0x10 },
	[OPAL_REVERTSP] =
		{ 0x00, 0x00, 0x00, 0x06, 0x00, 0x00, 0x00, 0x11 },
	[OPAL_GET] =
		{ 0x00, 0x00, 0x00, 0x06, 0x00, 0x00, 0x00, 0x16 },
	[OPAL_SET] =
		{ 0x00, 0x00, 0x00, 0x06, 0x00, 0x00, 0x00, 0x17 },
	[OPAL_AUTHENTICATE] =
		{ 0x00, 0x00, 0x00, 0x06, 0x00, 0x00, 0x00, 0x1c },
	[OPAL_RANDOM] =
		{ 0x00, 0x00, 0x00, 0x06, 0x00, 0x00, 0x06, 0x01 },
	[OPAL_ERASE] =
		{ 0x00, 0x00, 0x00, 0x06, 0x00, 0x00, 0x08, 0x03 },
};

static int end_opal_session_error(struct opal_dev *dev);

struct opal_suspend_data {
	struct opal_lock_unlock unlk;
	u8 lr;
	struct list_head node;
};

/*
 * Derived from:
 * TCG_Storage_Architecture_Core_Spec_v2.01_r1.00
 * Section: 5.1.5 Method Status Codes
 */
static const char * const opal_errors[] = {
	"Success",
	"Not Authorized",
	"Unknown Error",
	"SP Busy",
	"SP Failed",
	"SP Disabled",
	"SP Frozen",
	"No Sessions Available",
	"Uniqueness Conflict",
	"Insufficient Space",
	"Insufficient Rows",
	"Invalid Function",
	"Invalid Parameter",
	"Invalid Reference",
	"Unknown Error",
	"TPER Malfunction",
	"Transaction Failure",
	"Response Overflow",
	"Authority Locked Out",
};

static const char *opal_error_to_human(int error)
{
	if (error == 0x3f)
		return "Failed";

	if (error >= ARRAY_SIZE(opal_errors) || error < 0)
		return "Unknown Error";

	return opal_errors[error];
}

static void print_buffer(const u8 *ptr, u32 length)
{
#ifdef DEBUG
	print_hex_dump_bytes("OPAL: ", DUMP_PREFIX_OFFSET, ptr, length);
	pr_debug("\n");
#endif
}

static bool check_tper(const void *data)
{
	const struct d0_tper_features *tper = data;
	u8 flags = tper->supported_features;

	if (!(flags & TPER_SYNC_SUPPORTED)) {
278 279
		pr_debug("TPer sync not supported. flags = %d\n",
			 tper->supported_features);
S
Scott Bauer 已提交
280 281 282 283 284 285
		return false;
	}

	return true;
}

286 287 288 289 290 291 292 293
static bool check_mbrenabled(const void *data)
{
	const struct d0_locking_features *lfeat = data;
	u8 sup_feat = lfeat->supported_features;

	return !!(sup_feat & MBR_ENABLED_MASK);
}

S
Scott Bauer 已提交
294 295 296 297 298 299
static bool check_sum(const void *data)
{
	const struct d0_single_user_mode *sum = data;
	u32 nlo = be32_to_cpu(sum->num_locking_objects);

	if (nlo == 0) {
300
		pr_debug("Need at least one locking object.\n");
S
Scott Bauer 已提交
301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324
		return false;
	}

	pr_debug("Number of locking objects: %d\n", nlo);

	return true;
}

static u16 get_comid_v100(const void *data)
{
	const struct d0_opal_v100 *v100 = data;

	return be16_to_cpu(v100->baseComID);
}

static u16 get_comid_v200(const void *data)
{
	const struct d0_opal_v200 *v200 = data;

	return be16_to_cpu(v200->baseComID);
}

static int opal_send_cmd(struct opal_dev *dev)
{
325
	return dev->send_recv(dev->data, dev->comid, TCG_SECP_01,
S
Scott Bauer 已提交
326 327 328 329 330 331
			      dev->cmd, IO_BUFFER_LENGTH,
			      true);
}

static int opal_recv_cmd(struct opal_dev *dev)
{
332
	return dev->send_recv(dev->data, dev->comid, TCG_SECP_01,
S
Scott Bauer 已提交
333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383
			      dev->resp, IO_BUFFER_LENGTH,
			      false);
}

static int opal_recv_check(struct opal_dev *dev)
{
	size_t buflen = IO_BUFFER_LENGTH;
	void *buffer = dev->resp;
	struct opal_header *hdr = buffer;
	int ret;

	do {
		pr_debug("Sent OPAL command: outstanding=%d, minTransfer=%d\n",
			 hdr->cp.outstandingData,
			 hdr->cp.minTransfer);

		if (hdr->cp.outstandingData == 0 ||
		    hdr->cp.minTransfer != 0)
			return 0;

		memset(buffer, 0, buflen);
		ret = opal_recv_cmd(dev);
	} while (!ret);

	return ret;
}

static int opal_send_recv(struct opal_dev *dev, cont_fn *cont)
{
	int ret;

	ret = opal_send_cmd(dev);
	if (ret)
		return ret;
	ret = opal_recv_cmd(dev);
	if (ret)
		return ret;
	ret = opal_recv_check(dev);
	if (ret)
		return ret;
	return cont(dev);
}

static void check_geometry(struct opal_dev *dev, const void *data)
{
	const struct d0_geometry_features *geo = data;

	dev->align = geo->alignment_granularity;
	dev->lowest_lba = geo->lowest_aligned_lba;
}

384 385
static int next(struct opal_dev *dev, const struct opal_step *steps,
		size_t n_steps)
S
Scott Bauer 已提交
386
{
387
	const struct opal_step *step;
388 389
	size_t state;
	int error = 0;
S
Scott Bauer 已提交
390

391 392
	for (state = 0; state < n_steps; state++) {
		step = &steps[state];
S
Scott Bauer 已提交
393

394
		error = step->fn(dev, step->data);
395 396 397
		if (error)
			goto out_error;
	}
398

399 400 401 402 403 404 405 406 407 408 409 410 411
	return 0;

out_error:
	/*
	 * For each OPAL command the first step in steps does a discovery0
	 * and the second step starts some sort of session. If an error occurred
	 * in the first two steps (and thus stopping the loop with state <= 1)
	 * then there was an error before or during the attempt to start a
	 * session. Therefore we shouldn't attempt to terminate a session, as
	 * one has not yet been created.
	 */
	if (state > 1)
		end_opal_session_error(dev);
S
Scott Bauer 已提交
412 413 414 415 416 417 418 419 420 421

	return error;
}

static int opal_discovery0_end(struct opal_dev *dev)
{
	bool found_com_id = false, supported = true, single_user = false;
	const struct d0_header *hdr = (struct d0_header *)dev->resp;
	const u8 *epos = dev->resp, *cpos = dev->resp;
	u16 comid = 0;
422
	u32 hlen = be32_to_cpu(hdr->length);
S
Scott Bauer 已提交
423

424
	print_buffer(dev->resp, hlen);
425
	dev->mbr_enabled = false;
S
Scott Bauer 已提交
426

427
	if (hlen > IO_BUFFER_LENGTH - sizeof(*hdr)) {
428 429
		pr_debug("Discovery length overflows buffer (%zu+%u)/%u\n",
			 sizeof(*hdr), hlen, IO_BUFFER_LENGTH);
430 431 432 433
		return -EFAULT;
	}

	epos += hlen; /* end of buffer */
S
Scott Bauer 已提交
434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450
	cpos += sizeof(*hdr); /* current position on buffer */

	while (cpos < epos && supported) {
		const struct d0_features *body =
			(const struct d0_features *)cpos;

		switch (be16_to_cpu(body->code)) {
		case FC_TPER:
			supported = check_tper(body->features);
			break;
		case FC_SINGLEUSER:
			single_user = check_sum(body->features);
			break;
		case FC_GEOMETRY:
			check_geometry(dev, body);
			break;
		case FC_LOCKING:
451 452
			dev->mbr_enabled = check_mbrenabled(body->features);
			break;
S
Scott Bauer 已提交
453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478
		case FC_ENTERPRISE:
		case FC_DATASTORE:
			/* some ignored properties */
			pr_debug("Found OPAL feature description: %d\n",
				 be16_to_cpu(body->code));
			break;
		case FC_OPALV100:
			comid = get_comid_v100(body->features);
			found_com_id = true;
			break;
		case FC_OPALV200:
			comid = get_comid_v200(body->features);
			found_com_id = true;
			break;
		case 0xbfff ... 0xffff:
			/* vendor specific, just ignore */
			break;
		default:
			pr_debug("OPAL Unknown feature: %d\n",
				 be16_to_cpu(body->code));

		}
		cpos += body->length + 4;
	}

	if (!supported) {
479
		pr_debug("This device is not Opal enabled. Not Supported!\n");
S
Scott Bauer 已提交
480 481 482 483
		return -EOPNOTSUPP;
	}

	if (!single_user)
484
		pr_debug("Device doesn't support single user mode\n");
S
Scott Bauer 已提交
485 486 487


	if (!found_com_id) {
488
		pr_debug("Could not find OPAL comid for device. Returning early\n");
489
		return -EOPNOTSUPP;
S
Scott Bauer 已提交
490 491 492 493 494 495 496
	}

	dev->comid = comid;

	return 0;
}

497
static int opal_discovery0(struct opal_dev *dev, void *data)
S
Scott Bauer 已提交
498 499 500 501 502 503 504 505 506 507 508
{
	int ret;

	memset(dev->resp, 0, IO_BUFFER_LENGTH);
	dev->comid = OPAL_DISCOVERY_COMID;
	ret = opal_recv_cmd(dev);
	if (ret)
		return ret;
	return opal_discovery0_end(dev);
}

509
static bool can_add(int *err, struct opal_dev *cmd, size_t len)
S
Scott Bauer 已提交
510 511
{
	if (*err)
512 513 514 515
		return false;

	if (len > IO_BUFFER_LENGTH || cmd->pos > IO_BUFFER_LENGTH - len) {
		pr_debug("Error adding %zu bytes: end of buffer.\n", len);
S
Scott Bauer 已提交
516
		*err = -ERANGE;
517
		return false;
S
Scott Bauer 已提交
518
	}
519 520 521 522 523 524 525 526

	return true;
}

static void add_token_u8(int *err, struct opal_dev *cmd, u8 tok)
{
	if (!can_add(err, cmd, 1))
		return;
S
Scott Bauer 已提交
527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566
	cmd->cmd[cmd->pos++] = tok;
}

static void add_short_atom_header(struct opal_dev *cmd, bool bytestring,
				  bool has_sign, int len)
{
	u8 atom;
	int err = 0;

	atom = SHORT_ATOM_ID;
	atom |= bytestring ? SHORT_ATOM_BYTESTRING : 0;
	atom |= has_sign ? SHORT_ATOM_SIGNED : 0;
	atom |= len & SHORT_ATOM_LEN_MASK;

	add_token_u8(&err, cmd, atom);
}

static void add_medium_atom_header(struct opal_dev *cmd, bool bytestring,
				   bool has_sign, int len)
{
	u8 header0;

	header0 = MEDIUM_ATOM_ID;
	header0 |= bytestring ? MEDIUM_ATOM_BYTESTRING : 0;
	header0 |= has_sign ? MEDIUM_ATOM_SIGNED : 0;
	header0 |= (len >> 8) & MEDIUM_ATOM_LEN_MASK;
	cmd->cmd[cmd->pos++] = header0;
	cmd->cmd[cmd->pos++] = len;
}

static void add_token_u64(int *err, struct opal_dev *cmd, u64 number)
{
	size_t len;
	int msb;

	if (!(number & ~TINY_ATOM_DATA_MASK)) {
		add_token_u8(err, cmd, number);
		return;
	}

567 568
	msb = fls64(number);
	len = DIV_ROUND_UP(msb, 8);
S
Scott Bauer 已提交
569

570
	if (!can_add(err, cmd, len + 1)) {
571
		pr_debug("Error adding u64: end of buffer.\n");
S
Scott Bauer 已提交
572 573 574
		return;
	}
	add_short_atom_header(cmd, false, false, len);
575 576
	while (len--)
		add_token_u8(err, cmd, number >> (len * 8));
S
Scott Bauer 已提交
577 578
}

579
static u8 *add_bytestring_header(int *err, struct opal_dev *cmd, size_t len)
S
Scott Bauer 已提交
580 581 582 583 584 585 586 587 588
{
	size_t header_len = 1;
	bool is_short_atom = true;

	if (len & ~SHORT_ATOM_LEN_MASK) {
		header_len = 2;
		is_short_atom = false;
	}

589
	if (!can_add(err, cmd, header_len + len)) {
590
		pr_debug("Error adding bytestring: end of buffer.\n");
591
		return NULL;
S
Scott Bauer 已提交
592 593 594 595 596 597 598
	}

	if (is_short_atom)
		add_short_atom_header(cmd, true, false, len);
	else
		add_medium_atom_header(cmd, true, false, len);

599 600
	return &cmd->cmd[cmd->pos];
}
S
Scott Bauer 已提交
601

602 603 604 605 606 607 608 609 610 611
static void add_token_bytestring(int *err, struct opal_dev *cmd,
				 const u8 *bytestring, size_t len)
{
	u8 *start;

	start = add_bytestring_header(err, cmd, len);
	if (!start)
		return;
	memcpy(start, bytestring, len);
	cmd->pos += len;
S
Scott Bauer 已提交
612 613 614 615 616
}

static int build_locking_range(u8 *buffer, size_t length, u8 lr)
{
	if (length > OPAL_UID_LENGTH) {
617
		pr_debug("Can't build locking range. Length OOB\n");
S
Scott Bauer 已提交
618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633
		return -ERANGE;
	}

	memcpy(buffer, opaluid[OPAL_LOCKINGRANGE_GLOBAL], OPAL_UID_LENGTH);

	if (lr == 0)
		return 0;
	buffer[5] = LOCKING_RANGE_NON_GLOBAL;
	buffer[7] = lr;

	return 0;
}

static int build_locking_user(u8 *buffer, size_t length, u8 lr)
{
	if (length > OPAL_UID_LENGTH) {
634
		pr_debug("Can't build locking range user. Length OOB\n");
S
Scott Bauer 已提交
635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659
		return -ERANGE;
	}

	memcpy(buffer, opaluid[OPAL_USER1_UID], OPAL_UID_LENGTH);

	buffer[7] = lr + 1;

	return 0;
}

static void set_comid(struct opal_dev *cmd, u16 comid)
{
	struct opal_header *hdr = (struct opal_header *)cmd->cmd;

	hdr->cp.extendedComID[0] = comid >> 8;
	hdr->cp.extendedComID[1] = comid;
	hdr->cp.extendedComID[2] = 0;
	hdr->cp.extendedComID[3] = 0;
}

static int cmd_finalize(struct opal_dev *cmd, u32 hsn, u32 tsn)
{
	struct opal_header *hdr;
	int err = 0;

D
David Kozub 已提交
660
	/* close the parameter list opened from cmd_start */
661 662
	add_token_u8(&err, cmd, OPAL_ENDLIST);

S
Scott Bauer 已提交
663 664 665 666 667 668 669 670
	add_token_u8(&err, cmd, OPAL_ENDOFDATA);
	add_token_u8(&err, cmd, OPAL_STARTLIST);
	add_token_u8(&err, cmd, 0);
	add_token_u8(&err, cmd, 0);
	add_token_u8(&err, cmd, 0);
	add_token_u8(&err, cmd, OPAL_ENDLIST);

	if (err) {
671
		pr_debug("Error finalizing command.\n");
S
Scott Bauer 已提交
672 673 674 675 676 677 678 679 680 681 682
		return -EFAULT;
	}

	hdr = (struct opal_header *) cmd->cmd;

	hdr->pkt.tsn = cpu_to_be32(tsn);
	hdr->pkt.hsn = cpu_to_be32(hsn);

	hdr->subpkt.length = cpu_to_be32(cmd->pos - sizeof(*hdr));
	while (cmd->pos % 4) {
		if (cmd->pos >= IO_BUFFER_LENGTH) {
683
			pr_debug("Error: Buffer overrun\n");
S
Scott Bauer 已提交
684 685 686 687 688 689 690 691 692 693 694
			return -ERANGE;
		}
		cmd->cmd[cmd->pos++] = 0;
	}
	hdr->pkt.length = cpu_to_be32(cmd->pos - sizeof(hdr->cp) -
				      sizeof(hdr->pkt));
	hdr->cp.length = cpu_to_be32(cmd->pos - sizeof(hdr->cp));

	return 0;
}

695 696 697
static const struct opal_resp_tok *response_get_token(
				const struct parsed_resp *resp,
				int n)
S
Scott Bauer 已提交
698 699 700
{
	const struct opal_resp_tok *tok;

701 702 703 704 705
	if (!resp) {
		pr_debug("Response is NULL\n");
		return ERR_PTR(-EINVAL);
	}

S
Scott Bauer 已提交
706
	if (n >= resp->num) {
707 708
		pr_debug("Token number doesn't exist: %d, resp: %d\n",
			 n, resp->num);
709
		return ERR_PTR(-EINVAL);
S
Scott Bauer 已提交
710 711 712 713
	}

	tok = &resp->toks[n];
	if (tok->len == 0) {
714
		pr_debug("Token length must be non-zero\n");
715
		return ERR_PTR(-EINVAL);
S
Scott Bauer 已提交
716 717
	}

718
	return tok;
S
Scott Bauer 已提交
719 720
}

721 722
static ssize_t response_parse_tiny(struct opal_resp_tok *tok,
				   const u8 *pos)
S
Scott Bauer 已提交
723 724 725 726 727 728 729 730 731 732 733 734 735 736 737
{
	tok->pos = pos;
	tok->len = 1;
	tok->width = OPAL_WIDTH_TINY;

	if (pos[0] & TINY_ATOM_SIGNED) {
		tok->type = OPAL_DTA_TOKENID_SINT;
	} else {
		tok->type = OPAL_DTA_TOKENID_UINT;
		tok->stored.u = pos[0] & 0x3f;
	}

	return tok->len;
}

738 739
static ssize_t response_parse_short(struct opal_resp_tok *tok,
				    const u8 *pos)
S
Scott Bauer 已提交
740 741 742 743 744 745 746 747 748 749 750
{
	tok->pos = pos;
	tok->len = (pos[0] & SHORT_ATOM_LEN_MASK) + 1;
	tok->width = OPAL_WIDTH_SHORT;

	if (pos[0] & SHORT_ATOM_BYTESTRING) {
		tok->type = OPAL_DTA_TOKENID_BYTESTRING;
	} else if (pos[0] & SHORT_ATOM_SIGNED) {
		tok->type = OPAL_DTA_TOKENID_SINT;
	} else {
		u64 u_integer = 0;
751
		ssize_t i, b = 0;
S
Scott Bauer 已提交
752 753 754

		tok->type = OPAL_DTA_TOKENID_UINT;
		if (tok->len > 9) {
755
			pr_debug("uint64 with more than 8 bytes\n");
S
Scott Bauer 已提交
756 757 758 759 760 761 762 763 764 765 766 767
			return -EINVAL;
		}
		for (i = tok->len - 1; i > 0; i--) {
			u_integer |= ((u64)pos[i] << (8 * b));
			b++;
		}
		tok->stored.u = u_integer;
	}

	return tok->len;
}

768 769
static ssize_t response_parse_medium(struct opal_resp_tok *tok,
				     const u8 *pos)
S
Scott Bauer 已提交
770 771 772 773 774 775 776 777 778 779 780 781 782 783 784
{
	tok->pos = pos;
	tok->len = (((pos[0] & MEDIUM_ATOM_LEN_MASK) << 8) | pos[1]) + 2;
	tok->width = OPAL_WIDTH_MEDIUM;

	if (pos[0] & MEDIUM_ATOM_BYTESTRING)
		tok->type = OPAL_DTA_TOKENID_BYTESTRING;
	else if (pos[0] & MEDIUM_ATOM_SIGNED)
		tok->type = OPAL_DTA_TOKENID_SINT;
	else
		tok->type = OPAL_DTA_TOKENID_UINT;

	return tok->len;
}

785 786
static ssize_t response_parse_long(struct opal_resp_tok *tok,
				   const u8 *pos)
S
Scott Bauer 已提交
787 788 789 790 791 792 793 794 795 796 797 798 799 800 801
{
	tok->pos = pos;
	tok->len = ((pos[1] << 16) | (pos[2] << 8) | pos[3]) + 4;
	tok->width = OPAL_WIDTH_LONG;

	if (pos[0] & LONG_ATOM_BYTESTRING)
		tok->type = OPAL_DTA_TOKENID_BYTESTRING;
	else if (pos[0] & LONG_ATOM_SIGNED)
		tok->type = OPAL_DTA_TOKENID_SINT;
	else
		tok->type = OPAL_DTA_TOKENID_UINT;

	return tok->len;
}

802 803
static ssize_t response_parse_token(struct opal_resp_tok *tok,
				    const u8 *pos)
S
Scott Bauer 已提交
804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819
{
	tok->pos = pos;
	tok->len = 1;
	tok->type = OPAL_DTA_TOKENID_TOKEN;
	tok->width = OPAL_WIDTH_TOKEN;

	return tok->len;
}

static int response_parse(const u8 *buf, size_t length,
			  struct parsed_resp *resp)
{
	const struct opal_header *hdr;
	struct opal_resp_tok *iter;
	int num_entries = 0;
	int total;
820
	ssize_t token_length;
S
Scott Bauer 已提交
821
	const u8 *pos;
822
	u32 clen, plen, slen;
S
Scott Bauer 已提交
823 824 825 826 827 828 829 830 831 832 833

	if (!buf)
		return -EFAULT;

	if (!resp)
		return -EFAULT;

	hdr = (struct opal_header *)buf;
	pos = buf;
	pos += sizeof(*hdr);

834 835 836 837 838 839 840 841
	clen = be32_to_cpu(hdr->cp.length);
	plen = be32_to_cpu(hdr->pkt.length);
	slen = be32_to_cpu(hdr->subpkt.length);
	pr_debug("Response size: cp: %u, pkt: %u, subpkt: %u\n",
		 clen, plen, slen);

	if (clen == 0 || plen == 0 || slen == 0 ||
	    slen > IO_BUFFER_LENGTH - sizeof(*hdr)) {
842 843
		pr_debug("Bad header length. cp: %u, pkt: %u, subpkt: %u\n",
			 clen, plen, slen);
S
Scott Bauer 已提交
844 845 846 847 848 849 850 851
		print_buffer(pos, sizeof(*hdr));
		return -EINVAL;
	}

	if (pos > buf + length)
		return -EFAULT;

	iter = resp->toks;
852
	total = slen;
S
Scott Bauer 已提交
853 854 855 856 857 858 859 860 861 862 863 864 865
	print_buffer(pos, total);
	while (total > 0) {
		if (pos[0] <= TINY_ATOM_BYTE) /* tiny atom */
			token_length = response_parse_tiny(iter, pos);
		else if (pos[0] <= SHORT_ATOM_BYTE) /* short atom */
			token_length = response_parse_short(iter, pos);
		else if (pos[0] <= MEDIUM_ATOM_BYTE) /* medium atom */
			token_length = response_parse_medium(iter, pos);
		else if (pos[0] <= LONG_ATOM_BYTE) /* long atom */
			token_length = response_parse_long(iter, pos);
		else /* TOKEN */
			token_length = response_parse_token(iter, pos);

866 867
		if (token_length < 0)
			return token_length;
S
Scott Bauer 已提交
868 869 870 871 872 873 874 875

		pos += token_length;
		total -= token_length;
		iter++;
		num_entries++;
	}

	if (num_entries == 0) {
876
		pr_debug("Couldn't parse response.\n");
S
Scott Bauer 已提交
877 878 879 880 881 882 883 884 885 886
		return -EINVAL;
	}
	resp->num = num_entries;

	return 0;
}

static size_t response_get_string(const struct parsed_resp *resp, int n,
				  const char **store)
{
887
	u8 skip;
888
	const struct opal_resp_tok *tok;
889

S
Scott Bauer 已提交
890
	*store = NULL;
891 892
	tok = response_get_token(resp, n);
	if (IS_ERR(tok))
S
Scott Bauer 已提交
893 894
		return 0;

895
	if (tok->type != OPAL_DTA_TOKENID_BYTESTRING) {
896
		pr_debug("Token is not a byte string!\n");
S
Scott Bauer 已提交
897 898 899
		return 0;
	}

900
	switch (tok->width) {
901 902 903 904 905 906 907 908 909 910 911 912 913 914 915
	case OPAL_WIDTH_TINY:
	case OPAL_WIDTH_SHORT:
		skip = 1;
		break;
	case OPAL_WIDTH_MEDIUM:
		skip = 2;
		break;
	case OPAL_WIDTH_LONG:
		skip = 4;
		break;
	default:
		pr_debug("Token has invalid width!\n");
		return 0;
	}

916 917
	*store = tok->pos + skip;
	return tok->len - skip;
S
Scott Bauer 已提交
918 919 920 921
}

static u64 response_get_u64(const struct parsed_resp *resp, int n)
{
922
	const struct opal_resp_tok *tok;
S
Scott Bauer 已提交
923

924 925
	tok = response_get_token(resp, n);
	if (IS_ERR(tok))
S
Scott Bauer 已提交
926 927
		return 0;

928 929
	if (tok->type != OPAL_DTA_TOKENID_UINT) {
		pr_debug("Token is not unsigned int: %d\n", tok->type);
S
Scott Bauer 已提交
930 931 932
		return 0;
	}

933 934
	if (tok->width != OPAL_WIDTH_TINY && tok->width != OPAL_WIDTH_SHORT) {
		pr_debug("Atom is not short or tiny: %d\n", tok->width);
S
Scott Bauer 已提交
935 936 937
		return 0;
	}

938
	return tok->stored.u;
S
Scott Bauer 已提交
939 940
}

941 942 943 944 945 946 947 948 949
static bool response_token_matches(const struct opal_resp_tok *token, u8 match)
{
	if (IS_ERR(token) ||
	    token->type != OPAL_DTA_TOKENID_TOKEN ||
	    token->pos[0] != match)
		return false;
	return true;
}

S
Scott Bauer 已提交
950 951
static u8 response_status(const struct parsed_resp *resp)
{
952 953 954 955
	const struct opal_resp_tok *tok;

	tok = response_get_token(resp, 0);
	if (response_token_matches(tok, OPAL_ENDOFSESSION))
S
Scott Bauer 已提交
956 957 958 959 960
		return 0;

	if (resp->num < 5)
		return DTAERROR_NO_METHOD_STATUS;

961 962 963 964 965 966
	tok = response_get_token(resp, resp->num - 5);
	if (!response_token_matches(tok, OPAL_STARTLIST))
		return DTAERROR_NO_METHOD_STATUS;

	tok = response_get_token(resp, resp->num - 1);
	if (!response_token_matches(tok, OPAL_ENDLIST))
S
Scott Bauer 已提交
967 968 969 970 971 972 973 974 975 976 977 978 979 980
		return DTAERROR_NO_METHOD_STATUS;

	return response_get_u64(resp, resp->num - 4);
}

/* Parses and checks for errors */
static int parse_and_check_status(struct opal_dev *dev)
{
	int error;

	print_buffer(dev->cmd, dev->pos);

	error = response_parse(dev->resp, IO_BUFFER_LENGTH, &dev->parsed);
	if (error) {
981
		pr_debug("Couldn't parse response.\n");
S
Scott Bauer 已提交
982 983 984 985 986 987 988 989 990 991 992 993
		return error;
	}

	return response_status(&dev->parsed);
}

static void clear_opal_cmd(struct opal_dev *dev)
{
	dev->pos = sizeof(struct opal_header);
	memset(dev->cmd, 0, IO_BUFFER_LENGTH);
}

D
David Kozub 已提交
994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014
static int cmd_start(struct opal_dev *dev, const u8 *uid, const u8 *method)
{
	int err = 0;

	clear_opal_cmd(dev);
	set_comid(dev, dev->comid);

	add_token_u8(&err, dev, OPAL_CALL);
	add_token_bytestring(&err, dev, uid, OPAL_UID_LENGTH);
	add_token_bytestring(&err, dev, method, OPAL_METHOD_LENGTH);

	/*
	 * Every method call is followed by its parameters enclosed within
	 * OPAL_STARTLIST and OPAL_ENDLIST tokens. We automatically open the
	 * parameter list here and close it later in cmd_finalize.
	 */
	add_token_u8(&err, dev, OPAL_STARTLIST);

	return err;
}

S
Scott Bauer 已提交
1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027
static int start_opal_session_cont(struct opal_dev *dev)
{
	u32 hsn, tsn;
	int error = 0;

	error = parse_and_check_status(dev);
	if (error)
		return error;

	hsn = response_get_u64(&dev->parsed, 4);
	tsn = response_get_u64(&dev->parsed, 5);

	if (hsn == 0 && tsn == 0) {
1028
		pr_debug("Couldn't authenticate session\n");
S
Scott Bauer 已提交
1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064
		return -EPERM;
	}

	dev->hsn = hsn;
	dev->tsn = tsn;
	return 0;
}

static void add_suspend_info(struct opal_dev *dev,
			     struct opal_suspend_data *sus)
{
	struct opal_suspend_data *iter;

	list_for_each_entry(iter, &dev->unlk_lst, node) {
		if (iter->lr == sus->lr) {
			list_del(&iter->node);
			kfree(iter);
			break;
		}
	}
	list_add_tail(&sus->node, &dev->unlk_lst);
}

static int end_session_cont(struct opal_dev *dev)
{
	dev->hsn = 0;
	dev->tsn = 0;
	return parse_and_check_status(dev);
}

static int finalize_and_send(struct opal_dev *dev, cont_fn cont)
{
	int ret;

	ret = cmd_finalize(dev, dev->hsn, dev->tsn);
	if (ret) {
1065
		pr_debug("Error finalizing command buffer: %d\n", ret);
S
Scott Bauer 已提交
1066 1067 1068 1069 1070 1071 1072 1073
		return ret;
	}

	print_buffer(dev->cmd, dev->pos);

	return opal_send_recv(dev, cont);
}

1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104
/*
 * request @column from table @table on device @dev. On success, the column
 * data will be available in dev->resp->tok[4]
 */
static int generic_get_column(struct opal_dev *dev, const u8 *table,
			      u64 column)
{
	int err;

	err = cmd_start(dev, table, opalmethod[OPAL_GET]);

	add_token_u8(&err, dev, OPAL_STARTLIST);

	add_token_u8(&err, dev, OPAL_STARTNAME);
	add_token_u8(&err, dev, OPAL_STARTCOLUMN);
	add_token_u64(&err, dev, column);
	add_token_u8(&err, dev, OPAL_ENDNAME);

	add_token_u8(&err, dev, OPAL_STARTNAME);
	add_token_u8(&err, dev, OPAL_ENDCOLUMN);
	add_token_u64(&err, dev, column);
	add_token_u8(&err, dev, OPAL_ENDNAME);

	add_token_u8(&err, dev, OPAL_ENDLIST);

	if (err)
		return err;

	return finalize_and_send(dev, parse_and_check_status);
}

1105
static int gen_key(struct opal_dev *dev, void *data)
S
Scott Bauer 已提交
1106 1107
{
	u8 uid[OPAL_UID_LENGTH];
D
David Kozub 已提交
1108
	int err;
S
Scott Bauer 已提交
1109 1110 1111 1112 1113

	memcpy(uid, dev->prev_data, min(sizeof(uid), dev->prev_d_len));
	kfree(dev->prev_data);
	dev->prev_data = NULL;

D
David Kozub 已提交
1114
	err = cmd_start(dev, uid, opalmethod[OPAL_GENKEY]);
S
Scott Bauer 已提交
1115 1116

	if (err) {
1117
		pr_debug("Error building gen key command\n");
S
Scott Bauer 已提交
1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134
		return err;

	}
	return finalize_and_send(dev, parse_and_check_status);
}

static int get_active_key_cont(struct opal_dev *dev)
{
	const char *activekey;
	size_t keylen;
	int error = 0;

	error = parse_and_check_status(dev);
	if (error)
		return error;
	keylen = response_get_string(&dev->parsed, 4, &activekey);
	if (!activekey) {
1135 1136
		pr_debug("%s: Couldn't extract the Activekey from the response\n",
			 __func__);
S
Scott Bauer 已提交
1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148
		return OPAL_INVAL_PARAM;
	}
	dev->prev_data = kmemdup(activekey, keylen, GFP_KERNEL);

	if (!dev->prev_data)
		return -ENOMEM;

	dev->prev_d_len = keylen;

	return 0;
}

1149
static int get_active_key(struct opal_dev *dev, void *data)
S
Scott Bauer 已提交
1150 1151
{
	u8 uid[OPAL_UID_LENGTH];
D
David Kozub 已提交
1152
	int err;
1153
	u8 *lr = data;
S
Scott Bauer 已提交
1154 1155 1156 1157 1158

	err = build_locking_range(uid, sizeof(uid), *lr);
	if (err)
		return err;

1159 1160
	err = generic_get_column(dev, uid, OPAL_ACTIVEKEY);
	if (err)
S
Scott Bauer 已提交
1161 1162
		return err;

1163
	return get_active_key_cont(dev);
S
Scott Bauer 已提交
1164 1165 1166 1167 1168 1169
}

static int generic_lr_enable_disable(struct opal_dev *dev,
				     u8 *uid, bool rle, bool wle,
				     bool rl, bool wl)
{
D
David Kozub 已提交
1170
	int err;
S
Scott Bauer 已提交
1171

D
David Kozub 已提交
1172
	err = cmd_start(dev, uid, opalmethod[OPAL_SET]);
S
Scott Bauer 已提交
1173 1174 1175 1176 1177 1178

	add_token_u8(&err, dev, OPAL_STARTNAME);
	add_token_u8(&err, dev, OPAL_VALUES);
	add_token_u8(&err, dev, OPAL_STARTLIST);

	add_token_u8(&err, dev, OPAL_STARTNAME);
1179
	add_token_u8(&err, dev, OPAL_READLOCKENABLED);
S
Scott Bauer 已提交
1180 1181 1182 1183
	add_token_u8(&err, dev, rle);
	add_token_u8(&err, dev, OPAL_ENDNAME);

	add_token_u8(&err, dev, OPAL_STARTNAME);
1184
	add_token_u8(&err, dev, OPAL_WRITELOCKENABLED);
S
Scott Bauer 已提交
1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210
	add_token_u8(&err, dev, wle);
	add_token_u8(&err, dev, OPAL_ENDNAME);

	add_token_u8(&err, dev, OPAL_STARTNAME);
	add_token_u8(&err, dev, OPAL_READLOCKED);
	add_token_u8(&err, dev, rl);
	add_token_u8(&err, dev, OPAL_ENDNAME);

	add_token_u8(&err, dev, OPAL_STARTNAME);
	add_token_u8(&err, dev, OPAL_WRITELOCKED);
	add_token_u8(&err, dev, wl);
	add_token_u8(&err, dev, OPAL_ENDNAME);

	add_token_u8(&err, dev, OPAL_ENDLIST);
	add_token_u8(&err, dev, OPAL_ENDNAME);
	return err;
}

static inline int enable_global_lr(struct opal_dev *dev, u8 *uid,
				   struct opal_user_lr_setup *setup)
{
	int err;

	err = generic_lr_enable_disable(dev, uid, !!setup->RLE, !!setup->WLE,
					0, 0);
	if (err)
1211
		pr_debug("Failed to create enable global lr command\n");
S
Scott Bauer 已提交
1212 1213 1214
	return err;
}

1215
static int setup_locking_range(struct opal_dev *dev, void *data)
S
Scott Bauer 已提交
1216 1217
{
	u8 uid[OPAL_UID_LENGTH];
1218
	struct opal_user_lr_setup *setup = data;
S
Scott Bauer 已提交
1219
	u8 lr;
D
David Kozub 已提交
1220
	int err;
S
Scott Bauer 已提交
1221 1222 1223 1224 1225 1226 1227 1228 1229

	lr = setup->session.opal_key.lr;
	err = build_locking_range(uid, sizeof(uid), lr);
	if (err)
		return err;

	if (lr == 0)
		err = enable_global_lr(dev, uid, setup);
	else {
D
David Kozub 已提交
1230
		err = cmd_start(dev, uid, opalmethod[OPAL_SET]);
S
Scott Bauer 已提交
1231 1232 1233 1234 1235 1236

		add_token_u8(&err, dev, OPAL_STARTNAME);
		add_token_u8(&err, dev, OPAL_VALUES);
		add_token_u8(&err, dev, OPAL_STARTLIST);

		add_token_u8(&err, dev, OPAL_STARTNAME);
1237
		add_token_u8(&err, dev, OPAL_RANGESTART);
S
Scott Bauer 已提交
1238 1239 1240 1241
		add_token_u64(&err, dev, setup->range_start);
		add_token_u8(&err, dev, OPAL_ENDNAME);

		add_token_u8(&err, dev, OPAL_STARTNAME);
1242
		add_token_u8(&err, dev, OPAL_RANGELENGTH);
S
Scott Bauer 已提交
1243 1244 1245 1246
		add_token_u64(&err, dev, setup->range_length);
		add_token_u8(&err, dev, OPAL_ENDNAME);

		add_token_u8(&err, dev, OPAL_STARTNAME);
1247
		add_token_u8(&err, dev, OPAL_READLOCKENABLED);
S
Scott Bauer 已提交
1248 1249 1250 1251
		add_token_u64(&err, dev, !!setup->RLE);
		add_token_u8(&err, dev, OPAL_ENDNAME);

		add_token_u8(&err, dev, OPAL_STARTNAME);
1252
		add_token_u8(&err, dev, OPAL_WRITELOCKENABLED);
S
Scott Bauer 已提交
1253 1254 1255 1256 1257 1258 1259
		add_token_u64(&err, dev, !!setup->WLE);
		add_token_u8(&err, dev, OPAL_ENDNAME);

		add_token_u8(&err, dev, OPAL_ENDLIST);
		add_token_u8(&err, dev, OPAL_ENDNAME);
	}
	if (err) {
1260
		pr_debug("Error building Setup Locking range command.\n");
S
Scott Bauer 已提交
1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274
		return err;

	}

	return finalize_and_send(dev, parse_and_check_status);
}

static int start_generic_opal_session(struct opal_dev *dev,
				      enum opal_uid auth,
				      enum opal_uid sp_type,
				      const char *key,
				      u8 key_len)
{
	u32 hsn;
D
David Kozub 已提交
1275
	int err;
S
Scott Bauer 已提交
1276

1277
	if (key == NULL && auth != OPAL_ANYBODY_UID)
S
Scott Bauer 已提交
1278 1279 1280
		return OPAL_INVAL_PARAM;

	hsn = GENERIC_HOST_SESSION_NUM;
D
David Kozub 已提交
1281 1282
	err = cmd_start(dev, opaluid[OPAL_SMUID_UID],
			opalmethod[OPAL_STARTSESSION]);
S
Scott Bauer 已提交
1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303

	add_token_u64(&err, dev, hsn);
	add_token_bytestring(&err, dev, opaluid[sp_type], OPAL_UID_LENGTH);
	add_token_u8(&err, dev, 1);

	switch (auth) {
	case OPAL_ANYBODY_UID:
		break;
	case OPAL_ADMIN1_UID:
	case OPAL_SID_UID:
		add_token_u8(&err, dev, OPAL_STARTNAME);
		add_token_u8(&err, dev, 0); /* HostChallenge */
		add_token_bytestring(&err, dev, key, key_len);
		add_token_u8(&err, dev, OPAL_ENDNAME);
		add_token_u8(&err, dev, OPAL_STARTNAME);
		add_token_u8(&err, dev, 3); /* HostSignAuth */
		add_token_bytestring(&err, dev, opaluid[auth],
				     OPAL_UID_LENGTH);
		add_token_u8(&err, dev, OPAL_ENDNAME);
		break;
	default:
1304
		pr_debug("Cannot start Admin SP session with auth %d\n", auth);
S
Scott Bauer 已提交
1305 1306 1307 1308
		return OPAL_INVAL_PARAM;
	}

	if (err) {
1309
		pr_debug("Error building start adminsp session command.\n");
S
Scott Bauer 已提交
1310 1311 1312 1313 1314 1315
		return err;
	}

	return finalize_and_send(dev, start_opal_session_cont);
}

1316
static int start_anybodyASP_opal_session(struct opal_dev *dev, void *data)
S
Scott Bauer 已提交
1317 1318 1319 1320 1321
{
	return start_generic_opal_session(dev, OPAL_ANYBODY_UID,
					  OPAL_ADMINSP_UID, NULL, 0);
}

1322
static int start_SIDASP_opal_session(struct opal_dev *dev, void *data)
S
Scott Bauer 已提交
1323 1324 1325 1326 1327
{
	int ret;
	const u8 *key = dev->prev_data;

	if (!key) {
1328
		const struct opal_key *okey = data;
1329

S
Scott Bauer 已提交
1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343
		ret = start_generic_opal_session(dev, OPAL_SID_UID,
						 OPAL_ADMINSP_UID,
						 okey->key,
						 okey->key_len);
	} else {
		ret = start_generic_opal_session(dev, OPAL_SID_UID,
						 OPAL_ADMINSP_UID,
						 key, dev->prev_d_len);
		kfree(key);
		dev->prev_data = NULL;
	}
	return ret;
}

1344
static int start_admin1LSP_opal_session(struct opal_dev *dev, void *data)
S
Scott Bauer 已提交
1345
{
1346
	struct opal_key *key = data;
1347

S
Scott Bauer 已提交
1348 1349 1350 1351 1352
	return start_generic_opal_session(dev, OPAL_ADMIN1_UID,
					  OPAL_LOCKINGSP_UID,
					  key->key, key->key_len);
}

1353
static int start_auth_opal_session(struct opal_dev *dev, void *data)
S
Scott Bauer 已提交
1354
{
1355
	struct opal_session_info *session = data;
S
Scott Bauer 已提交
1356
	u8 lk_ul_user[OPAL_UID_LENGTH];
1357
	size_t keylen = session->opal_key.key_len;
S
Scott Bauer 已提交
1358 1359 1360 1361 1362
	int err = 0;

	u8 *key = session->opal_key.key;
	u32 hsn = GENERIC_HOST_SESSION_NUM;

D
David Kozub 已提交
1363
	if (session->sum)
S
Scott Bauer 已提交
1364 1365
		err = build_locking_user(lk_ul_user, sizeof(lk_ul_user),
					 session->opal_key.lr);
D
David Kozub 已提交
1366
	else if (session->who != OPAL_ADMIN1 && !session->sum)
S
Scott Bauer 已提交
1367 1368
		err = build_locking_user(lk_ul_user, sizeof(lk_ul_user),
					 session->who - 1);
D
David Kozub 已提交
1369
	else
S
Scott Bauer 已提交
1370 1371
		memcpy(lk_ul_user, opaluid[OPAL_ADMIN1_UID], OPAL_UID_LENGTH);

D
David Kozub 已提交
1372 1373 1374 1375 1376
	if (err)
		return err;

	err = cmd_start(dev, opaluid[OPAL_SMUID_UID],
			opalmethod[OPAL_STARTSESSION]);
S
Scott Bauer 已提交
1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391

	add_token_u64(&err, dev, hsn);
	add_token_bytestring(&err, dev, opaluid[OPAL_LOCKINGSP_UID],
			     OPAL_UID_LENGTH);
	add_token_u8(&err, dev, 1);
	add_token_u8(&err, dev, OPAL_STARTNAME);
	add_token_u8(&err, dev, 0);
	add_token_bytestring(&err, dev, key, keylen);
	add_token_u8(&err, dev, OPAL_ENDNAME);
	add_token_u8(&err, dev, OPAL_STARTNAME);
	add_token_u8(&err, dev, 3);
	add_token_bytestring(&err, dev, lk_ul_user, OPAL_UID_LENGTH);
	add_token_u8(&err, dev, OPAL_ENDNAME);

	if (err) {
1392
		pr_debug("Error building STARTSESSION command.\n");
S
Scott Bauer 已提交
1393 1394 1395 1396 1397 1398
		return err;
	}

	return finalize_and_send(dev, start_opal_session_cont);
}

1399
static int revert_tper(struct opal_dev *dev, void *data)
S
Scott Bauer 已提交
1400
{
D
David Kozub 已提交
1401
	int err;
S
Scott Bauer 已提交
1402

D
David Kozub 已提交
1403 1404
	err = cmd_start(dev, opaluid[OPAL_ADMINSP_UID],
			opalmethod[OPAL_REVERT]);
S
Scott Bauer 已提交
1405
	if (err) {
1406
		pr_debug("Error building REVERT TPER command.\n");
S
Scott Bauer 已提交
1407 1408 1409 1410 1411 1412
		return err;
	}

	return finalize_and_send(dev, parse_and_check_status);
}

1413
static int internal_activate_user(struct opal_dev *dev, void *data)
S
Scott Bauer 已提交
1414
{
1415
	struct opal_session_info *session = data;
S
Scott Bauer 已提交
1416
	u8 uid[OPAL_UID_LENGTH];
D
David Kozub 已提交
1417
	int err;
S
Scott Bauer 已提交
1418 1419 1420 1421

	memcpy(uid, opaluid[OPAL_USER1_UID], OPAL_UID_LENGTH);
	uid[7] = session->who;

D
David Kozub 已提交
1422
	err = cmd_start(dev, uid, opalmethod[OPAL_SET]);
S
Scott Bauer 已提交
1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433
	add_token_u8(&err, dev, OPAL_STARTNAME);
	add_token_u8(&err, dev, OPAL_VALUES);
	add_token_u8(&err, dev, OPAL_STARTLIST);
	add_token_u8(&err, dev, OPAL_STARTNAME);
	add_token_u8(&err, dev, 5); /* Enabled */
	add_token_u8(&err, dev, OPAL_TRUE);
	add_token_u8(&err, dev, OPAL_ENDNAME);
	add_token_u8(&err, dev, OPAL_ENDLIST);
	add_token_u8(&err, dev, OPAL_ENDNAME);

	if (err) {
1434
		pr_debug("Error building Activate UserN command.\n");
S
Scott Bauer 已提交
1435 1436 1437 1438 1439 1440
		return err;
	}

	return finalize_and_send(dev, parse_and_check_status);
}

1441
static int erase_locking_range(struct opal_dev *dev, void *data)
S
Scott Bauer 已提交
1442
{
1443
	struct opal_session_info *session = data;
S
Scott Bauer 已提交
1444
	u8 uid[OPAL_UID_LENGTH];
D
David Kozub 已提交
1445
	int err;
S
Scott Bauer 已提交
1446 1447 1448 1449

	if (build_locking_range(uid, sizeof(uid), session->opal_key.lr) < 0)
		return -ERANGE;

D
David Kozub 已提交
1450
	err = cmd_start(dev, uid, opalmethod[OPAL_ERASE]);
S
Scott Bauer 已提交
1451 1452

	if (err) {
1453
		pr_debug("Error building Erase Locking Range Command.\n");
S
Scott Bauer 已提交
1454 1455 1456 1457 1458
		return err;
	}
	return finalize_and_send(dev, parse_and_check_status);
}

1459
static int set_mbr_done(struct opal_dev *dev, void *data)
S
Scott Bauer 已提交
1460
{
1461
	u8 *mbr_done_tf = data;
D
David Kozub 已提交
1462
	int err;
S
Scott Bauer 已提交
1463

D
David Kozub 已提交
1464 1465
	err = cmd_start(dev, opaluid[OPAL_MBRCONTROL],
			opalmethod[OPAL_SET]);
S
Scott Bauer 已提交
1466 1467 1468 1469 1470

	add_token_u8(&err, dev, OPAL_STARTNAME);
	add_token_u8(&err, dev, OPAL_VALUES);
	add_token_u8(&err, dev, OPAL_STARTLIST);
	add_token_u8(&err, dev, OPAL_STARTNAME);
1471
	add_token_u8(&err, dev, OPAL_MBRDONE);
1472
	add_token_u8(&err, dev, *mbr_done_tf); /* Done T or F */
S
Scott Bauer 已提交
1473 1474 1475 1476 1477
	add_token_u8(&err, dev, OPAL_ENDNAME);
	add_token_u8(&err, dev, OPAL_ENDLIST);
	add_token_u8(&err, dev, OPAL_ENDNAME);

	if (err) {
1478
		pr_debug("Error Building set MBR Done command\n");
S
Scott Bauer 已提交
1479 1480 1481 1482 1483 1484
		return err;
	}

	return finalize_and_send(dev, parse_and_check_status);
}

1485
static int set_mbr_enable_disable(struct opal_dev *dev, void *data)
S
Scott Bauer 已提交
1486
{
1487
	u8 *mbr_en_dis = data;
D
David Kozub 已提交
1488
	int err;
S
Scott Bauer 已提交
1489

D
David Kozub 已提交
1490 1491
	err = cmd_start(dev, opaluid[OPAL_MBRCONTROL],
			opalmethod[OPAL_SET]);
S
Scott Bauer 已提交
1492 1493 1494 1495 1496

	add_token_u8(&err, dev, OPAL_STARTNAME);
	add_token_u8(&err, dev, OPAL_VALUES);
	add_token_u8(&err, dev, OPAL_STARTLIST);
	add_token_u8(&err, dev, OPAL_STARTNAME);
1497
	add_token_u8(&err, dev, OPAL_MBRENABLE);
1498
	add_token_u8(&err, dev, *mbr_en_dis);
S
Scott Bauer 已提交
1499 1500 1501 1502 1503
	add_token_u8(&err, dev, OPAL_ENDNAME);
	add_token_u8(&err, dev, OPAL_ENDLIST);
	add_token_u8(&err, dev, OPAL_ENDNAME);

	if (err) {
1504
		pr_debug("Error Building set MBR done command\n");
S
Scott Bauer 已提交
1505 1506 1507 1508 1509 1510 1511 1512 1513
		return err;
	}

	return finalize_and_send(dev, parse_and_check_status);
}

static int generic_pw_cmd(u8 *key, size_t key_len, u8 *cpin_uid,
			  struct opal_dev *dev)
{
D
David Kozub 已提交
1514
	int err;
S
Scott Bauer 已提交
1515

D
David Kozub 已提交
1516
	err = cmd_start(dev, cpin_uid, opalmethod[OPAL_SET]);
S
Scott Bauer 已提交
1517 1518 1519 1520 1521

	add_token_u8(&err, dev, OPAL_STARTNAME);
	add_token_u8(&err, dev, OPAL_VALUES);
	add_token_u8(&err, dev, OPAL_STARTLIST);
	add_token_u8(&err, dev, OPAL_STARTNAME);
1522
	add_token_u8(&err, dev, OPAL_PIN);
S
Scott Bauer 已提交
1523 1524 1525 1526 1527 1528 1529 1530
	add_token_bytestring(&err, dev, key, key_len);
	add_token_u8(&err, dev, OPAL_ENDNAME);
	add_token_u8(&err, dev, OPAL_ENDLIST);
	add_token_u8(&err, dev, OPAL_ENDNAME);

	return err;
}

1531
static int set_new_pw(struct opal_dev *dev, void *data)
S
Scott Bauer 已提交
1532 1533
{
	u8 cpin_uid[OPAL_UID_LENGTH];
1534
	struct opal_session_info *usr = data;
S
Scott Bauer 已提交
1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547

	memcpy(cpin_uid, opaluid[OPAL_C_PIN_ADMIN1], OPAL_UID_LENGTH);

	if (usr->who != OPAL_ADMIN1) {
		cpin_uid[5] = 0x03;
		if (usr->sum)
			cpin_uid[7] = usr->opal_key.lr + 1;
		else
			cpin_uid[7] = usr->who;
	}

	if (generic_pw_cmd(usr->opal_key.key, usr->opal_key.key_len,
			   cpin_uid, dev)) {
1548
		pr_debug("Error building set password command.\n");
S
Scott Bauer 已提交
1549 1550 1551 1552 1553 1554
		return -ERANGE;
	}

	return finalize_and_send(dev, parse_and_check_status);
}

1555
static int set_sid_cpin_pin(struct opal_dev *dev, void *data)
S
Scott Bauer 已提交
1556 1557
{
	u8 cpin_uid[OPAL_UID_LENGTH];
1558
	struct opal_key *key = data;
S
Scott Bauer 已提交
1559 1560 1561 1562

	memcpy(cpin_uid, opaluid[OPAL_C_PIN_SID], OPAL_UID_LENGTH);

	if (generic_pw_cmd(key->key, key->key_len, cpin_uid, dev)) {
1563
		pr_debug("Error building Set SID cpin\n");
S
Scott Bauer 已提交
1564 1565 1566 1567 1568
		return -ERANGE;
	}
	return finalize_and_send(dev, parse_and_check_status);
}

1569
static int add_user_to_lr(struct opal_dev *dev, void *data)
S
Scott Bauer 已提交
1570 1571 1572
{
	u8 lr_buffer[OPAL_UID_LENGTH];
	u8 user_uid[OPAL_UID_LENGTH];
1573
	struct opal_lock_unlock *lkul = data;
D
David Kozub 已提交
1574
	int err;
S
Scott Bauer 已提交
1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588

	memcpy(lr_buffer, opaluid[OPAL_LOCKINGRANGE_ACE_RDLOCKED],
	       OPAL_UID_LENGTH);

	if (lkul->l_state == OPAL_RW)
		memcpy(lr_buffer, opaluid[OPAL_LOCKINGRANGE_ACE_WRLOCKED],
		       OPAL_UID_LENGTH);

	lr_buffer[7] = lkul->session.opal_key.lr;

	memcpy(user_uid, opaluid[OPAL_USER1_UID], OPAL_UID_LENGTH);

	user_uid[7] = lkul->session.who;

D
David Kozub 已提交
1589
	err = cmd_start(dev, lr_buffer, opalmethod[OPAL_SET]);
S
Scott Bauer 已提交
1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629

	add_token_u8(&err, dev, OPAL_STARTNAME);
	add_token_u8(&err, dev, OPAL_VALUES);

	add_token_u8(&err, dev, OPAL_STARTLIST);
	add_token_u8(&err, dev, OPAL_STARTNAME);
	add_token_u8(&err, dev, 3);

	add_token_u8(&err, dev, OPAL_STARTLIST);


	add_token_u8(&err, dev, OPAL_STARTNAME);
	add_token_bytestring(&err, dev,
			     opaluid[OPAL_HALF_UID_AUTHORITY_OBJ_REF],
			     OPAL_UID_LENGTH/2);
	add_token_bytestring(&err, dev, user_uid, OPAL_UID_LENGTH);
	add_token_u8(&err, dev, OPAL_ENDNAME);


	add_token_u8(&err, dev, OPAL_STARTNAME);
	add_token_bytestring(&err, dev,
			     opaluid[OPAL_HALF_UID_AUTHORITY_OBJ_REF],
			     OPAL_UID_LENGTH/2);
	add_token_bytestring(&err, dev, user_uid, OPAL_UID_LENGTH);
	add_token_u8(&err, dev, OPAL_ENDNAME);


	add_token_u8(&err, dev, OPAL_STARTNAME);
	add_token_bytestring(&err, dev, opaluid[OPAL_HALF_UID_BOOLEAN_ACE],
			     OPAL_UID_LENGTH/2);
	add_token_u8(&err, dev, 1);
	add_token_u8(&err, dev, OPAL_ENDNAME);


	add_token_u8(&err, dev, OPAL_ENDLIST);
	add_token_u8(&err, dev, OPAL_ENDNAME);
	add_token_u8(&err, dev, OPAL_ENDLIST);
	add_token_u8(&err, dev, OPAL_ENDNAME);

	if (err) {
1630
		pr_debug("Error building add user to locking range command.\n");
S
Scott Bauer 已提交
1631 1632 1633 1634 1635 1636
		return err;
	}

	return finalize_and_send(dev, parse_and_check_status);
}

1637
static int lock_unlock_locking_range(struct opal_dev *dev, void *data)
S
Scott Bauer 已提交
1638 1639
{
	u8 lr_buffer[OPAL_UID_LENGTH];
1640
	struct opal_lock_unlock *lkul = data;
S
Scott Bauer 已提交
1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657
	u8 read_locked = 1, write_locked = 1;
	int err = 0;

	if (build_locking_range(lr_buffer, sizeof(lr_buffer),
				lkul->session.opal_key.lr) < 0)
		return -ERANGE;

	switch (lkul->l_state) {
	case OPAL_RO:
		read_locked = 0;
		write_locked = 1;
		break;
	case OPAL_RW:
		read_locked = 0;
		write_locked = 0;
		break;
	case OPAL_LK:
1658
		/* vars are initialized to locked */
S
Scott Bauer 已提交
1659 1660
		break;
	default:
1661
		pr_debug("Tried to set an invalid locking state... returning to uland\n");
S
Scott Bauer 已提交
1662 1663 1664
		return OPAL_INVAL_PARAM;
	}

D
David Kozub 已提交
1665 1666
	err = cmd_start(dev, lr_buffer, opalmethod[OPAL_SET]);

S
Scott Bauer 已提交
1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684
	add_token_u8(&err, dev, OPAL_STARTNAME);
	add_token_u8(&err, dev, OPAL_VALUES);
	add_token_u8(&err, dev, OPAL_STARTLIST);

	add_token_u8(&err, dev, OPAL_STARTNAME);
	add_token_u8(&err, dev, OPAL_READLOCKED);
	add_token_u8(&err, dev, read_locked);
	add_token_u8(&err, dev, OPAL_ENDNAME);

	add_token_u8(&err, dev, OPAL_STARTNAME);
	add_token_u8(&err, dev, OPAL_WRITELOCKED);
	add_token_u8(&err, dev, write_locked);
	add_token_u8(&err, dev, OPAL_ENDNAME);

	add_token_u8(&err, dev, OPAL_ENDLIST);
	add_token_u8(&err, dev, OPAL_ENDNAME);

	if (err) {
1685
		pr_debug("Error building SET command.\n");
S
Scott Bauer 已提交
1686 1687 1688 1689 1690 1691
		return err;
	}
	return finalize_and_send(dev, parse_and_check_status);
}


1692
static int lock_unlock_locking_range_sum(struct opal_dev *dev, void *data)
S
Scott Bauer 已提交
1693 1694 1695
{
	u8 lr_buffer[OPAL_UID_LENGTH];
	u8 read_locked = 1, write_locked = 1;
1696
	struct opal_lock_unlock *lkul = data;
S
Scott Bauer 已提交
1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715
	int ret;

	clear_opal_cmd(dev);
	set_comid(dev, dev->comid);

	if (build_locking_range(lr_buffer, sizeof(lr_buffer),
				lkul->session.opal_key.lr) < 0)
		return -ERANGE;

	switch (lkul->l_state) {
	case OPAL_RO:
		read_locked = 0;
		write_locked = 1;
		break;
	case OPAL_RW:
		read_locked = 0;
		write_locked = 0;
		break;
	case OPAL_LK:
1716
		/* vars are initialized to locked */
S
Scott Bauer 已提交
1717 1718
		break;
	default:
1719
		pr_debug("Tried to set an invalid locking state.\n");
S
Scott Bauer 已提交
1720 1721 1722 1723 1724 1725
		return OPAL_INVAL_PARAM;
	}
	ret = generic_lr_enable_disable(dev, lr_buffer, 1, 1,
					read_locked, write_locked);

	if (ret < 0) {
1726
		pr_debug("Error building SET command.\n");
S
Scott Bauer 已提交
1727 1728 1729 1730 1731
		return ret;
	}
	return finalize_and_send(dev, parse_and_check_status);
}

1732
static int activate_lsp(struct opal_dev *dev, void *data)
S
Scott Bauer 已提交
1733
{
1734
	struct opal_lr_act *opal_act = data;
S
Scott Bauer 已提交
1735 1736
	u8 user_lr[OPAL_UID_LENGTH];
	u8 uint_3 = 0x83;
D
David Kozub 已提交
1737
	int err, i;
S
Scott Bauer 已提交
1738

D
David Kozub 已提交
1739 1740
	err = cmd_start(dev, opaluid[OPAL_LOCKINGSP_UID],
			opalmethod[OPAL_ACTIVATE]);
S
Scott Bauer 已提交
1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764

	if (opal_act->sum) {
		err = build_locking_range(user_lr, sizeof(user_lr),
					  opal_act->lr[0]);
		if (err)
			return err;

		add_token_u8(&err, dev, OPAL_STARTNAME);
		add_token_u8(&err, dev, uint_3);
		add_token_u8(&err, dev, 6);
		add_token_u8(&err, dev, 0);
		add_token_u8(&err, dev, 0);

		add_token_u8(&err, dev, OPAL_STARTLIST);
		add_token_bytestring(&err, dev, user_lr, OPAL_UID_LENGTH);
		for (i = 1; i < opal_act->num_lrs; i++) {
			user_lr[7] = opal_act->lr[i];
			add_token_bytestring(&err, dev, user_lr, OPAL_UID_LENGTH);
		}
		add_token_u8(&err, dev, OPAL_ENDLIST);
		add_token_u8(&err, dev, OPAL_ENDNAME);
	}

	if (err) {
1765
		pr_debug("Error building Activate LockingSP command.\n");
S
Scott Bauer 已提交
1766 1767 1768 1769 1770 1771
		return err;
	}

	return finalize_and_send(dev, parse_and_check_status);
}

1772 1773
/* Determine if we're in the Manufactured Inactive or Active state */
static int get_lsp_lifecycle(struct opal_dev *dev, void *data)
S
Scott Bauer 已提交
1774 1775
{
	u8 lc_status;
1776
	int err;
S
Scott Bauer 已提交
1777

1778 1779 1780 1781
	err = generic_get_column(dev, opaluid[OPAL_LOCKINGSP_UID],
				 OPAL_LIFECYCLE);
	if (err)
		return err;
S
Scott Bauer 已提交
1782 1783

	lc_status = response_get_u64(&dev->parsed, 4);
1784
	/* 0x08 is Manufactured Inactive */
S
Scott Bauer 已提交
1785 1786
	/* 0x09 is Manufactured */
	if (lc_status != OPAL_MANUFACTURED_INACTIVE) {
1787
		pr_debug("Couldn't determine the status of the Lifecycle state\n");
S
Scott Bauer 已提交
1788 1789 1790 1791 1792 1793
		return -ENODEV;
	}

	return 0;
}

1794
static int get_msid_cpin_pin(struct opal_dev *dev, void *data)
S
Scott Bauer 已提交
1795 1796 1797
{
	const char *msid_pin;
	size_t strlen;
1798
	int err;
S
Scott Bauer 已提交
1799

1800 1801 1802
	err = generic_get_column(dev, opaluid[OPAL_C_PIN_MSID], OPAL_PIN);
	if (err)
		return err;
S
Scott Bauer 已提交
1803 1804 1805

	strlen = response_get_string(&dev->parsed, 4, &msid_pin);
	if (!msid_pin) {
1806
		pr_debug("Couldn't extract MSID_CPIN from response\n");
S
Scott Bauer 已提交
1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818
		return OPAL_INVAL_PARAM;
	}

	dev->prev_data = kmemdup(msid_pin, strlen, GFP_KERNEL);
	if (!dev->prev_data)
		return -ENOMEM;

	dev->prev_d_len = strlen;

	return 0;
}

1819
static int end_opal_session(struct opal_dev *dev, void *data)
S
Scott Bauer 已提交
1820 1821 1822 1823 1824 1825 1826
{
	int err = 0;

	clear_opal_cmd(dev);
	set_comid(dev, dev->comid);
	add_token_u8(&err, dev, OPAL_ENDOFSESSION);

1827 1828
	if (err < 0)
		return err;
S
Scott Bauer 已提交
1829 1830 1831 1832 1833
	return finalize_and_send(dev, end_session_cont);
}

static int end_opal_session_error(struct opal_dev *dev)
{
1834
	const struct opal_step error_end_session[] = {
1835
		{ end_opal_session, }
S
Scott Bauer 已提交
1836
	};
1837
	return next(dev, error_end_session, ARRAY_SIZE(error_end_session));
S
Scott Bauer 已提交
1838 1839
}

1840
static inline void setup_opal_dev(struct opal_dev *dev)
S
Scott Bauer 已提交
1841 1842 1843 1844 1845 1846 1847 1848
{
	dev->tsn = 0;
	dev->hsn = 0;
	dev->prev_data = NULL;
}

static int check_opal_support(struct opal_dev *dev)
{
1849
	const struct opal_step steps[] = {
1850
		{ opal_discovery0, }
S
Scott Bauer 已提交
1851 1852 1853 1854
	};
	int ret;

	mutex_lock(&dev->dev_lock);
1855 1856
	setup_opal_dev(dev);
	ret = next(dev, steps, ARRAY_SIZE(steps));
S
Scott Bauer 已提交
1857 1858 1859 1860 1861
	dev->supported = !ret;
	mutex_unlock(&dev->dev_lock);
	return ret;
}

1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883
static void clean_opal_dev(struct opal_dev *dev)
{

	struct opal_suspend_data *suspend, *next;

	mutex_lock(&dev->dev_lock);
	list_for_each_entry_safe(suspend, next, &dev->unlk_lst, node) {
		list_del(&suspend->node);
		kfree(suspend);
	}
	mutex_unlock(&dev->dev_lock);
}

void free_opal_dev(struct opal_dev *dev)
{
	if (!dev)
		return;
	clean_opal_dev(dev);
	kfree(dev);
}
EXPORT_SYMBOL(free_opal_dev);

1884
struct opal_dev *init_opal_dev(void *data, sec_send_recv *send_recv)
S
Scott Bauer 已提交
1885
{
1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896
	struct opal_dev *dev;

	dev = kmalloc(sizeof(*dev), GFP_KERNEL);
	if (!dev)
		return NULL;

	INIT_LIST_HEAD(&dev->unlk_lst);
	mutex_init(&dev->dev_lock);
	dev->data = data;
	dev->send_recv = send_recv;
	if (check_opal_support(dev) != 0) {
1897
		pr_debug("Opal is not supported on this device\n");
1898 1899 1900 1901
		kfree(dev);
		return NULL;
	}
	return dev;
S
Scott Bauer 已提交
1902 1903 1904 1905 1906 1907
}
EXPORT_SYMBOL(init_opal_dev);

static int opal_secure_erase_locking_range(struct opal_dev *dev,
					   struct opal_session_info *opal_session)
{
1908 1909 1910 1911 1912
	const struct opal_step erase_steps[] = {
		{ opal_discovery0, },
		{ start_auth_opal_session, opal_session },
		{ get_active_key, &opal_session->opal_key.lr },
		{ gen_key, },
1913
		{ end_opal_session, }
S
Scott Bauer 已提交
1914 1915 1916 1917
	};
	int ret;

	mutex_lock(&dev->dev_lock);
1918 1919
	setup_opal_dev(dev);
	ret = next(dev, erase_steps, ARRAY_SIZE(erase_steps));
S
Scott Bauer 已提交
1920 1921 1922 1923 1924 1925 1926
	mutex_unlock(&dev->dev_lock);
	return ret;
}

static int opal_erase_locking_range(struct opal_dev *dev,
				    struct opal_session_info *opal_session)
{
1927 1928 1929 1930
	const struct opal_step erase_steps[] = {
		{ opal_discovery0, },
		{ start_auth_opal_session, opal_session },
		{ erase_locking_range, opal_session },
1931
		{ end_opal_session, }
S
Scott Bauer 已提交
1932 1933 1934 1935
	};
	int ret;

	mutex_lock(&dev->dev_lock);
1936 1937
	setup_opal_dev(dev);
	ret = next(dev, erase_steps, ARRAY_SIZE(erase_steps));
S
Scott Bauer 已提交
1938 1939 1940 1941 1942 1943 1944
	mutex_unlock(&dev->dev_lock);
	return ret;
}

static int opal_enable_disable_shadow_mbr(struct opal_dev *dev,
					  struct opal_mbr_data *opal_mbr)
{
1945 1946 1947
	u8 enable_disable = opal_mbr->enable_disable == OPAL_MBR_ENABLE ?
		OPAL_TRUE : OPAL_FALSE;

1948 1949 1950
	const struct opal_step mbr_steps[] = {
		{ opal_discovery0, },
		{ start_admin1LSP_opal_session, &opal_mbr->key },
1951
		{ set_mbr_done, &enable_disable },
1952 1953
		{ end_opal_session, },
		{ start_admin1LSP_opal_session, &opal_mbr->key },
1954
		{ set_mbr_enable_disable, &enable_disable },
1955
		{ end_opal_session, }
S
Scott Bauer 已提交
1956 1957 1958 1959 1960 1961 1962 1963
	};
	int ret;

	if (opal_mbr->enable_disable != OPAL_MBR_ENABLE &&
	    opal_mbr->enable_disable != OPAL_MBR_DISABLE)
		return -EINVAL;

	mutex_lock(&dev->dev_lock);
1964 1965
	setup_opal_dev(dev);
	ret = next(dev, mbr_steps, ARRAY_SIZE(mbr_steps));
S
Scott Bauer 已提交
1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981
	mutex_unlock(&dev->dev_lock);
	return ret;
}

static int opal_save(struct opal_dev *dev, struct opal_lock_unlock *lk_unlk)
{
	struct opal_suspend_data *suspend;

	suspend = kzalloc(sizeof(*suspend), GFP_KERNEL);
	if (!suspend)
		return -ENOMEM;

	suspend->unlk = *lk_unlk;
	suspend->lr = lk_unlk->session.opal_key.lr;

	mutex_lock(&dev->dev_lock);
1982
	setup_opal_dev(dev);
S
Scott Bauer 已提交
1983 1984 1985 1986 1987 1988 1989 1990
	add_suspend_info(dev, suspend);
	mutex_unlock(&dev->dev_lock);
	return 0;
}

static int opal_add_user_to_lr(struct opal_dev *dev,
			       struct opal_lock_unlock *lk_unlk)
{
1991 1992 1993 1994
	const struct opal_step steps[] = {
		{ opal_discovery0, },
		{ start_admin1LSP_opal_session, &lk_unlk->session.opal_key },
		{ add_user_to_lr, lk_unlk },
1995
		{ end_opal_session, }
S
Scott Bauer 已提交
1996 1997 1998 1999 2000
	};
	int ret;

	if (lk_unlk->l_state != OPAL_RO &&
	    lk_unlk->l_state != OPAL_RW) {
2001
		pr_debug("Locking state was not RO or RW\n");
S
Scott Bauer 已提交
2002 2003
		return -EINVAL;
	}
2004
	if (lk_unlk->session.who < OPAL_USER1 ||
S
Scott Bauer 已提交
2005
	    lk_unlk->session.who > OPAL_USER9) {
2006 2007
		pr_debug("Authority was not within the range of users: %d\n",
			 lk_unlk->session.who);
S
Scott Bauer 已提交
2008 2009 2010
		return -EINVAL;
	}
	if (lk_unlk->session.sum) {
2011 2012
		pr_debug("%s not supported in sum. Use setup locking range\n",
			 __func__);
S
Scott Bauer 已提交
2013 2014 2015 2016
		return -EINVAL;
	}

	mutex_lock(&dev->dev_lock);
2017 2018
	setup_opal_dev(dev);
	ret = next(dev, steps, ARRAY_SIZE(steps));
S
Scott Bauer 已提交
2019 2020 2021 2022 2023 2024
	mutex_unlock(&dev->dev_lock);
	return ret;
}

static int opal_reverttper(struct opal_dev *dev, struct opal_key *opal)
{
2025 2026 2027
	const struct opal_step revert_steps[] = {
		{ opal_discovery0, },
		{ start_SIDASP_opal_session, opal },
2028
		{ revert_tper, } /* controller will terminate session */
S
Scott Bauer 已提交
2029 2030 2031 2032
	};
	int ret;

	mutex_lock(&dev->dev_lock);
2033 2034
	setup_opal_dev(dev);
	ret = next(dev, revert_steps, ARRAY_SIZE(revert_steps));
S
Scott Bauer 已提交
2035
	mutex_unlock(&dev->dev_lock);
2036 2037 2038 2039 2040 2041 2042 2043

	/*
	 * If we successfully reverted lets clean
	 * any saved locking ranges.
	 */
	if (!ret)
		clean_opal_dev(dev);

S
Scott Bauer 已提交
2044 2045 2046
	return ret;
}

2047 2048
static int __opal_lock_unlock(struct opal_dev *dev,
			      struct opal_lock_unlock *lk_unlk)
S
Scott Bauer 已提交
2049
{
2050 2051 2052 2053
	const struct opal_step unlock_steps[] = {
		{ opal_discovery0, },
		{ start_auth_opal_session, &lk_unlk->session },
		{ lock_unlock_locking_range, lk_unlk },
2054
		{ end_opal_session, }
S
Scott Bauer 已提交
2055
	};
2056 2057 2058 2059
	const struct opal_step unlock_sum_steps[] = {
		{ opal_discovery0, },
		{ start_auth_opal_session, &lk_unlk->session },
		{ lock_unlock_locking_range_sum, lk_unlk },
2060
		{ end_opal_session, }
S
Scott Bauer 已提交
2061 2062
	};

2063 2064 2065 2066 2067
	if (lk_unlk->session.sum)
		return next(dev, unlock_sum_steps,
			    ARRAY_SIZE(unlock_sum_steps));
	else
		return next(dev, unlock_steps, ARRAY_SIZE(unlock_steps));
S
Scott Bauer 已提交
2068 2069
}

2070 2071
static int __opal_set_mbr_done(struct opal_dev *dev, struct opal_key *key)
{
2072
	u8 mbr_done_tf = OPAL_TRUE;
2073
	const struct opal_step mbrdone_step[] = {
2074 2075 2076
		{ opal_discovery0, },
		{ start_admin1LSP_opal_session, key },
		{ set_mbr_done, &mbr_done_tf },
2077
		{ end_opal_session, }
2078 2079
	};

2080
	return next(dev, mbrdone_step, ARRAY_SIZE(mbrdone_step));
2081 2082
}

2083 2084
static int opal_lock_unlock(struct opal_dev *dev,
			    struct opal_lock_unlock *lk_unlk)
S
Scott Bauer 已提交
2085 2086 2087 2088 2089 2090 2091 2092
{
	int ret;

	if (lk_unlk->session.who < OPAL_ADMIN1 ||
	    lk_unlk->session.who > OPAL_USER9)
		return -EINVAL;

	mutex_lock(&dev->dev_lock);
2093
	ret = __opal_lock_unlock(dev, lk_unlk);
S
Scott Bauer 已提交
2094 2095 2096 2097 2098 2099
	mutex_unlock(&dev->dev_lock);
	return ret;
}

static int opal_take_ownership(struct opal_dev *dev, struct opal_key *opal)
{
2100 2101 2102 2103 2104 2105 2106
	const struct opal_step owner_steps[] = {
		{ opal_discovery0, },
		{ start_anybodyASP_opal_session, },
		{ get_msid_cpin_pin, },
		{ end_opal_session, },
		{ start_SIDASP_opal_session, opal },
		{ set_sid_cpin_pin, opal },
2107
		{ end_opal_session, }
S
Scott Bauer 已提交
2108 2109 2110 2111 2112 2113 2114
	};
	int ret;

	if (!dev)
		return -ENODEV;

	mutex_lock(&dev->dev_lock);
2115 2116
	setup_opal_dev(dev);
	ret = next(dev, owner_steps, ARRAY_SIZE(owner_steps));
S
Scott Bauer 已提交
2117 2118 2119 2120
	mutex_unlock(&dev->dev_lock);
	return ret;
}

2121 2122
static int opal_activate_lsp(struct opal_dev *dev,
			     struct opal_lr_act *opal_lr_act)
S
Scott Bauer 已提交
2123
{
2124 2125 2126 2127 2128
	const struct opal_step active_steps[] = {
		{ opal_discovery0, },
		{ start_SIDASP_opal_session, &opal_lr_act->key },
		{ get_lsp_lifecycle, },
		{ activate_lsp, opal_lr_act },
2129
		{ end_opal_session, }
S
Scott Bauer 已提交
2130 2131 2132 2133 2134 2135 2136
	};
	int ret;

	if (!opal_lr_act->num_lrs || opal_lr_act->num_lrs > OPAL_MAX_LRS)
		return -EINVAL;

	mutex_lock(&dev->dev_lock);
2137 2138
	setup_opal_dev(dev);
	ret = next(dev, active_steps, ARRAY_SIZE(active_steps));
S
Scott Bauer 已提交
2139 2140 2141 2142 2143 2144 2145
	mutex_unlock(&dev->dev_lock);
	return ret;
}

static int opal_setup_locking_range(struct opal_dev *dev,
				    struct opal_user_lr_setup *opal_lrs)
{
2146 2147 2148 2149
	const struct opal_step lr_steps[] = {
		{ opal_discovery0, },
		{ start_auth_opal_session, &opal_lrs->session },
		{ setup_locking_range, opal_lrs },
2150
		{ end_opal_session, }
S
Scott Bauer 已提交
2151 2152 2153 2154
	};
	int ret;

	mutex_lock(&dev->dev_lock);
2155 2156
	setup_opal_dev(dev);
	ret = next(dev, lr_steps, ARRAY_SIZE(lr_steps));
S
Scott Bauer 已提交
2157 2158 2159 2160 2161 2162
	mutex_unlock(&dev->dev_lock);
	return ret;
}

static int opal_set_new_pw(struct opal_dev *dev, struct opal_new_pw *opal_pw)
{
2163 2164 2165 2166
	const struct opal_step pw_steps[] = {
		{ opal_discovery0, },
		{ start_auth_opal_session, &opal_pw->session },
		{ set_new_pw, &opal_pw->new_user_pw },
2167
		{ end_opal_session, }
S
Scott Bauer 已提交
2168 2169 2170 2171 2172 2173 2174 2175 2176 2177
	};
	int ret;

	if (opal_pw->session.who < OPAL_ADMIN1 ||
	    opal_pw->session.who > OPAL_USER9  ||
	    opal_pw->new_user_pw.who < OPAL_ADMIN1 ||
	    opal_pw->new_user_pw.who > OPAL_USER9)
		return -EINVAL;

	mutex_lock(&dev->dev_lock);
2178 2179
	setup_opal_dev(dev);
	ret = next(dev, pw_steps, ARRAY_SIZE(pw_steps));
S
Scott Bauer 已提交
2180 2181 2182 2183 2184 2185 2186
	mutex_unlock(&dev->dev_lock);
	return ret;
}

static int opal_activate_user(struct opal_dev *dev,
			      struct opal_session_info *opal_session)
{
2187 2188 2189 2190
	const struct opal_step act_steps[] = {
		{ opal_discovery0, },
		{ start_admin1LSP_opal_session, &opal_session->opal_key },
		{ internal_activate_user, opal_session },
2191
		{ end_opal_session, }
S
Scott Bauer 已提交
2192 2193 2194 2195
	};
	int ret;

	/* We can't activate Admin1 it's active as manufactured */
2196
	if (opal_session->who < OPAL_USER1 ||
S
Scott Bauer 已提交
2197
	    opal_session->who > OPAL_USER9) {
2198
		pr_debug("Who was not a valid user: %d\n", opal_session->who);
S
Scott Bauer 已提交
2199 2200 2201 2202
		return -EINVAL;
	}

	mutex_lock(&dev->dev_lock);
2203 2204
	setup_opal_dev(dev);
	ret = next(dev, act_steps, ARRAY_SIZE(act_steps));
S
Scott Bauer 已提交
2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220
	mutex_unlock(&dev->dev_lock);
	return ret;
}

bool opal_unlock_from_suspend(struct opal_dev *dev)
{
	struct opal_suspend_data *suspend;
	bool was_failure = false;
	int ret = 0;

	if (!dev)
		return false;
	if (!dev->supported)
		return false;

	mutex_lock(&dev->dev_lock);
2221
	setup_opal_dev(dev);
S
Scott Bauer 已提交
2222 2223 2224 2225 2226

	list_for_each_entry(suspend, &dev->unlk_lst, node) {
		dev->tsn = 0;
		dev->hsn = 0;

2227
		ret = __opal_lock_unlock(dev, &suspend->unlk);
S
Scott Bauer 已提交
2228
		if (ret) {
2229 2230 2231
			pr_debug("Failed to unlock LR %hhu with sum %d\n",
				 suspend->unlk.session.opal_key.lr,
				 suspend->unlk.session.sum);
S
Scott Bauer 已提交
2232 2233
			was_failure = true;
		}
2234 2235 2236 2237 2238
		if (dev->mbr_enabled) {
			ret = __opal_set_mbr_done(dev, &suspend->unlk.session.opal_key);
			if (ret)
				pr_debug("Failed to set MBR Done in S3 resume\n");
		}
S
Scott Bauer 已提交
2239 2240 2241 2242 2243 2244
	}
	mutex_unlock(&dev->dev_lock);
	return was_failure;
}
EXPORT_SYMBOL(opal_unlock_from_suspend);

2245
int sed_ioctl(struct opal_dev *dev, unsigned int cmd, void __user *arg)
S
Scott Bauer 已提交
2246
{
2247 2248
	void *p;
	int ret = -ENOTTY;
S
Scott Bauer 已提交
2249 2250 2251

	if (!capable(CAP_SYS_ADMIN))
		return -EACCES;
2252 2253
	if (!dev)
		return -ENOTSUPP;
2254
	if (!dev->supported)
S
Scott Bauer 已提交
2255 2256
		return -ENOTSUPP;

2257
	p = memdup_user(arg, _IOC_SIZE(cmd));
2258 2259
	if (IS_ERR(p))
		return PTR_ERR(p);
S
Scott Bauer 已提交
2260

2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297
	switch (cmd) {
	case IOC_OPAL_SAVE:
		ret = opal_save(dev, p);
		break;
	case IOC_OPAL_LOCK_UNLOCK:
		ret = opal_lock_unlock(dev, p);
		break;
	case IOC_OPAL_TAKE_OWNERSHIP:
		ret = opal_take_ownership(dev, p);
		break;
	case IOC_OPAL_ACTIVATE_LSP:
		ret = opal_activate_lsp(dev, p);
		break;
	case IOC_OPAL_SET_PW:
		ret = opal_set_new_pw(dev, p);
		break;
	case IOC_OPAL_ACTIVATE_USR:
		ret = opal_activate_user(dev, p);
		break;
	case IOC_OPAL_REVERT_TPR:
		ret = opal_reverttper(dev, p);
		break;
	case IOC_OPAL_LR_SETUP:
		ret = opal_setup_locking_range(dev, p);
		break;
	case IOC_OPAL_ADD_USR_TO_LR:
		ret = opal_add_user_to_lr(dev, p);
		break;
	case IOC_OPAL_ENABLE_DISABLE_MBR:
		ret = opal_enable_disable_shadow_mbr(dev, p);
		break;
	case IOC_OPAL_ERASE_LR:
		ret = opal_erase_locking_range(dev, p);
		break;
	case IOC_OPAL_SECURE_ERASE_LR:
		ret = opal_secure_erase_locking_range(dev, p);
		break;
S
Scott Bauer 已提交
2298
	default:
2299
		break;
S
Scott Bauer 已提交
2300
	}
2301 2302 2303

	kfree(p);
	return ret;
S
Scott Bauer 已提交
2304 2305
}
EXPORT_SYMBOL_GPL(sed_ioctl);