pdc_stable.c 30.3 KB
Newer Older
Linus Torvalds's avatar
Linus Torvalds committed
1 2 3
/* 
 *    Interfaces to retrieve and set PDC Stable options (firmware)
 *
4
 *    Copyright (C) 2005-2006 Thibaut VARENE <varenet@parisc-linux.org>
Linus Torvalds's avatar
Linus Torvalds committed
5 6
 *
 *    This program is free software; you can redistribute it and/or modify
7 8
 *    it under the terms of the GNU General Public License, version 2, as
 *    published by the Free Software Foundation.
Linus Torvalds's avatar
Linus Torvalds committed
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
 *
 *    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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 *
 *    DEV NOTE: the PDC Procedures reference states that:
 *    "A minimum of 96 bytes of Stable Storage is required. Providing more than
 *    96 bytes of Stable Storage is optional [...]. Failure to provide the
 *    optional locations from 96 to 192 results in the loss of certain
 *    functionality during boot."
 *
 *    Since locations between 96 and 192 are the various paths, most (if not
 *    all) PA-RISC machines should have them. Anyway, for safety reasons, the
28
 *    following code can deal with just 96 bytes of Stable Storage, and all
Linus Torvalds's avatar
Linus Torvalds committed
29 30
 *    sizes between 96 and 192 bytes (provided they are multiple of struct
 *    device_path size, eg: 128, 160 and 192) to provide full information.
31 32 33 34 35 36 37 38 39
 *    One last word: there's one path we can always count on: the primary path.
 *    Anything above 224 bytes is used for 'osdep2' OS-dependent storage area.
 *
 *    The first OS-dependent area should always be available. Obviously, this is
 *    not true for the other one. Also bear in mind that reading/writing from/to
 *    osdep2 is much more expensive than from/to osdep1.
 *    NOTE: We do not handle the 2 bytes OS-dep area at 0x5D, nor the first
 *    2 bytes of storage available right after OSID. That's a total of 4 bytes
 *    sacrificed: -ETOOLAZY :P
40 41 42 43 44 45 46 47
 *
 *    The current policy wrt file permissions is:
 *	- write: root only
 *	- read: (reading triggers PDC calls) ? root only : everyone
 *    The rationale is that PDC calls could hog (DoS) the machine.
 *
 *	TODO:
 *	- timer/fastsize write calls
Linus Torvalds's avatar
Linus Torvalds committed
48 49 50 51 52 53 54 55 56 57 58 59 60
 */

#undef PDCS_DEBUG
#ifdef PDCS_DEBUG
#define DPRINTK(fmt, args...)	printk(KERN_DEBUG fmt, ## args)
#else
#define DPRINTK(fmt, args...)
#endif

#include <linux/module.h>
#include <linux/init.h>
#include <linux/kernel.h>
#include <linux/string.h>
61
#include <linux/capability.h>
Linus Torvalds's avatar
Linus Torvalds committed
62 63 64 65 66
#include <linux/ctype.h>
#include <linux/sysfs.h>
#include <linux/kobject.h>
#include <linux/device.h>
#include <linux/errno.h>
67
#include <linux/spinlock.h>
Linus Torvalds's avatar
Linus Torvalds committed
68 69 70 71 72 73

#include <asm/pdc.h>
#include <asm/page.h>
#include <asm/uaccess.h>
#include <asm/hardware.h>

74
#define PDCS_VERSION	"0.30"
75
#define PDCS_PREFIX	"PDC Stable Storage"
Linus Torvalds's avatar
Linus Torvalds committed
76 77 78

#define PDCS_ADDR_PPRI	0x00
#define PDCS_ADDR_OSID	0x40
79 80
#define PDCS_ADDR_OSD1	0x48
#define PDCS_ADDR_DIAG	0x58
Linus Torvalds's avatar
Linus Torvalds committed
81 82 83 84
#define PDCS_ADDR_FSIZ	0x5C
#define PDCS_ADDR_PCON	0x60
#define PDCS_ADDR_PALT	0x80
#define PDCS_ADDR_PKBD	0xA0
85
#define PDCS_ADDR_OSD2	0xE0
Linus Torvalds's avatar
Linus Torvalds committed
86 87 88 89 90 91

MODULE_AUTHOR("Thibaut VARENE <varenet@parisc-linux.org>");
MODULE_DESCRIPTION("sysfs interface to HP PDC Stable Storage data");
MODULE_LICENSE("GPL");
MODULE_VERSION(PDCS_VERSION);

92
/* holds Stable Storage size. Initialized once and for all, no lock needed */
93
static unsigned long pdcs_size __read_mostly;
Linus Torvalds's avatar
Linus Torvalds committed
94

95 96 97
/* holds OS ID. Initialized once and for all, hopefully to 0x0006 */
static u16 pdcs_osid __read_mostly;

Linus Torvalds's avatar
Linus Torvalds committed
98 99
/* This struct defines what we need to deal with a parisc pdc path entry */
struct pdcspath_entry {
100
	rwlock_t rw_lock;		/* to protect path entry access */
Linus Torvalds's avatar
Linus Torvalds committed
101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122
	short ready;			/* entry record is valid if != 0 */
	unsigned long addr;		/* entry address in stable storage */
	char *name;			/* entry name */
	struct device_path devpath;	/* device path in parisc representation */
	struct device *dev;		/* corresponding device */
	struct kobject kobj;
};

struct pdcspath_attribute {
	struct attribute attr;
	ssize_t (*show)(struct pdcspath_entry *entry, char *buf);
	ssize_t (*store)(struct pdcspath_entry *entry, const char *buf, size_t count);
};

#define PDCSPATH_ENTRY(_addr, _name) \
struct pdcspath_entry pdcspath_entry_##_name = { \
	.ready = 0, \
	.addr = _addr, \
	.name = __stringify(_name), \
};

#define PDCS_ATTR(_name, _mode, _show, _store) \
123
struct kobj_attribute pdcs_attr_##_name = { \
124
	.attr = {.name = __stringify(_name), .mode = _mode}, \
Linus Torvalds's avatar
Linus Torvalds committed
125 126 127 128 129 130
	.show = _show, \
	.store = _store, \
};

#define PATHS_ATTR(_name, _mode, _show, _store) \
struct pdcspath_attribute paths_attr_##_name = { \
131
	.attr = {.name = __stringify(_name), .mode = _mode}, \
Linus Torvalds's avatar
Linus Torvalds committed
132 133 134 135 136 137 138 139 140 141 142 143
	.show = _show, \
	.store = _store, \
};

#define to_pdcspath_attribute(_attr) container_of(_attr, struct pdcspath_attribute, attr)
#define to_pdcspath_entry(obj)  container_of(obj, struct pdcspath_entry, kobj)

/**
 * pdcspath_fetch - This function populates the path entry structs.
 * @entry: A pointer to an allocated pdcspath_entry.
 * 
 * The general idea is that you don't read from the Stable Storage every time
Lucas De Marchi's avatar
Lucas De Marchi committed
144
 * you access the files provided by the facilities. We store a copy of the
Linus Torvalds's avatar
Linus Torvalds committed
145 146 147
 * content of the stable storage WRT various paths in these structs. We read
 * these structs when reading the files, and we will write to these structs when
 * writing to the files, and only then write them back to the Stable Storage.
148 149
 *
 * This function expects to be called with @entry->rw_lock write-hold.
Linus Torvalds's avatar
Linus Torvalds committed
150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188
 */
static int
pdcspath_fetch(struct pdcspath_entry *entry)
{
	struct device_path *devpath;

	if (!entry)
		return -EINVAL;

	devpath = &entry->devpath;
	
	DPRINTK("%s: fetch: 0x%p, 0x%p, addr: 0x%lx\n", __func__,
			entry, devpath, entry->addr);

	/* addr, devpath and count must be word aligned */
	if (pdc_stable_read(entry->addr, devpath, sizeof(*devpath)) != PDC_OK)
		return -EIO;
		
	/* Find the matching device.
	   NOTE: hardware_path overlays with device_path, so the nice cast can
	   be used */
	entry->dev = hwpath_to_device((struct hardware_path *)devpath);

	entry->ready = 1;
	
	DPRINTK("%s: device: 0x%p\n", __func__, entry->dev);
	
	return 0;
}

/**
 * pdcspath_store - This function writes a path to stable storage.
 * @entry: A pointer to an allocated pdcspath_entry.
 * 
 * It can be used in two ways: either by passing it a preset devpath struct
 * containing an already computed hardware path, or by passing it a device
 * pointer, from which it'll find out the corresponding hardware path.
 * For now we do not handle the case where there's an error in writing to the
 * Stable Storage area, so you'd better not mess up the data :P
189 190
 *
 * This function expects to be called with @entry->rw_lock write-hold.
Linus Torvalds's avatar
Linus Torvalds committed
191
 */
192
static void
Linus Torvalds's avatar
Linus Torvalds committed
193 194 195 196
pdcspath_store(struct pdcspath_entry *entry)
{
	struct device_path *devpath;

197
	BUG_ON(!entry);
Linus Torvalds's avatar
Linus Torvalds committed
198 199 200 201 202 203 204 205

	devpath = &entry->devpath;
	
	/* We expect the caller to set the ready flag to 0 if the hardware
	   path struct provided is invalid, so that we know we have to fill it.
	   First case, we don't have a preset hwpath... */
	if (!entry->ready) {
		/* ...but we have a device, map it */
206 207
		BUG_ON(!entry->dev);
		device_to_hwpath(entry->dev, (struct hardware_path *)devpath);
Linus Torvalds's avatar
Linus Torvalds committed
208 209 210 211 212 213 214
	}
	/* else, we expect the provided hwpath to be valid. */
	
	DPRINTK("%s: store: 0x%p, 0x%p, addr: 0x%lx\n", __func__,
			entry, devpath, entry->addr);

	/* addr, devpath and count must be word aligned */
215 216
	if (pdc_stable_write(entry->addr, devpath, sizeof(*devpath)) != PDC_OK)
		WARN(1, KERN_ERR "%s: an error occurred when writing to PDC.\n"
Linus Torvalds's avatar
Linus Torvalds committed
217 218 219
				"It is likely that the Stable Storage data has been corrupted.\n"
				"Please check it carefully upon next reboot.\n", __func__);
		
220 221
	/* kobject is already registered */
	entry->ready = 2;
Linus Torvalds's avatar
Linus Torvalds committed
222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237
	
	DPRINTK("%s: device: 0x%p\n", __func__, entry->dev);
}

/**
 * pdcspath_hwpath_read - This function handles hardware path pretty printing.
 * @entry: An allocated and populated pdscpath_entry struct.
 * @buf: The output buffer to write to.
 * 
 * We will call this function to format the output of the hwpath attribute file.
 */
static ssize_t
pdcspath_hwpath_read(struct pdcspath_entry *entry, char *buf)
{
	char *out = buf;
	struct device_path *devpath;
238
	short i;
Linus Torvalds's avatar
Linus Torvalds committed
239 240 241 242

	if (!entry || !buf)
		return -EINVAL;

243
	read_lock(&entry->rw_lock);
Linus Torvalds's avatar
Linus Torvalds committed
244
	devpath = &entry->devpath;
245 246
	i = entry->ready;
	read_unlock(&entry->rw_lock);
Linus Torvalds's avatar
Linus Torvalds committed
247

248
	if (!i)	/* entry is not ready */
Linus Torvalds's avatar
Linus Torvalds committed
249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268
		return -ENODATA;
	
	for (i = 0; i < 6; i++) {
		if (devpath->bc[i] >= 128)
			continue;
		out += sprintf(out, "%u/", (unsigned char)devpath->bc[i]);
	}
	out += sprintf(out, "%u\n", (unsigned char)devpath->mod);
	
	return out - buf;
}

/**
 * pdcspath_hwpath_write - This function handles hardware path modifying.
 * @entry: An allocated and populated pdscpath_entry struct.
 * @buf: The input buffer to read from.
 * @count: The number of bytes to be read.
 * 
 * We will call this function to change the current hardware path.
 * Hardware paths are to be given '/'-delimited, without brackets.
269
 * We make sure that the provided path actually maps to an existing
Linus Torvalds's avatar
Linus Torvalds committed
270 271 272 273 274 275 276 277 278 279 280
 * device, BUT nothing would prevent some foolish user to set the path to some
 * PCI bridge or even a CPU...
 * A better work around would be to make sure we are at the end of a device tree
 * for instance, but it would be IMHO beyond the simple scope of that driver.
 * The aim is to provide a facility. Data correctness is left to userland.
 */
static ssize_t
pdcspath_hwpath_write(struct pdcspath_entry *entry, const char *buf, size_t count)
{
	struct hardware_path hwpath;
	unsigned short i;
281
	char in[64], *temp;
Linus Torvalds's avatar
Linus Torvalds committed
282
	struct device *dev;
283
	int ret;
Linus Torvalds's avatar
Linus Torvalds committed
284 285 286 287 288

	if (!entry || !buf || !count)
		return -EINVAL;

	/* We'll use a local copy of buf */
289
	count = min_t(size_t, count, sizeof(in)-1);
Linus Torvalds's avatar
Linus Torvalds committed
290
	strncpy(in, buf, count);
291
	in[count] = '\0';
Linus Torvalds's avatar
Linus Torvalds committed
292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326
	
	/* Let's clean up the target. 0xff is a blank pattern */
	memset(&hwpath, 0xff, sizeof(hwpath));
	
	/* First, pick the mod field (the last one of the input string) */
	if (!(temp = strrchr(in, '/')))
		return -EINVAL;
			
	hwpath.mod = simple_strtoul(temp+1, NULL, 10);
	in[temp-in] = '\0';	/* truncate the remaining string. just precaution */
	DPRINTK("%s: mod: %d\n", __func__, hwpath.mod);
	
	/* Then, loop for each delimiter, making sure we don't have too many.
	   we write the bc fields in a down-top way. No matter what, we stop
	   before writing the last field. If there are too many fields anyway,
	   then the user is a moron and it'll be caught up later when we'll
	   check the consistency of the given hwpath. */
	for (i=5; ((temp = strrchr(in, '/'))) && (temp-in > 0) && (likely(i)); i--) {
		hwpath.bc[i] = simple_strtoul(temp+1, NULL, 10);
		in[temp-in] = '\0';
		DPRINTK("%s: bc[%d]: %d\n", __func__, i, hwpath.bc[i]);
	}
	
	/* Store the final field */		
	hwpath.bc[i] = simple_strtoul(in, NULL, 10);
	DPRINTK("%s: bc[%d]: %d\n", __func__, i, hwpath.bc[i]);
	
	/* Now we check that the user isn't trying to lure us */
	if (!(dev = hwpath_to_device((struct hardware_path *)&hwpath))) {
		printk(KERN_WARNING "%s: attempt to set invalid \"%s\" "
			"hardware path: %s\n", __func__, entry->name, buf);
		return -EINVAL;
	}
	
	/* So far so good, let's get in deep */
327
	write_lock(&entry->rw_lock);
Linus Torvalds's avatar
Linus Torvalds committed
328 329 330 331
	entry->ready = 0;
	entry->dev = dev;
	
	/* Now, dive in. Write back to the hardware */
332
	pdcspath_store(entry);
Linus Torvalds's avatar
Linus Torvalds committed
333 334 335
	
	/* Update the symlink to the real device */
	sysfs_remove_link(&entry->kobj, "device");
336 337 338
	ret = sysfs_create_link(&entry->kobj, &entry->dev->kobj, "device");
	WARN_ON(ret);

339
	write_unlock(&entry->rw_lock);
Linus Torvalds's avatar
Linus Torvalds committed
340
	
341
	printk(KERN_INFO PDCS_PREFIX ": changed \"%s\" path to \"%s\"\n",
Linus Torvalds's avatar
Linus Torvalds committed
342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358
		entry->name, buf);
	
	return count;
}

/**
 * pdcspath_layer_read - Extended layer (eg. SCSI ids) pretty printing.
 * @entry: An allocated and populated pdscpath_entry struct.
 * @buf: The output buffer to write to.
 * 
 * We will call this function to format the output of the layer attribute file.
 */
static ssize_t
pdcspath_layer_read(struct pdcspath_entry *entry, char *buf)
{
	char *out = buf;
	struct device_path *devpath;
359
	short i;
Linus Torvalds's avatar
Linus Torvalds committed
360 361 362 363

	if (!entry || !buf)
		return -EINVAL;
	
364
	read_lock(&entry->rw_lock);
Linus Torvalds's avatar
Linus Torvalds committed
365
	devpath = &entry->devpath;
366 367
	i = entry->ready;
	read_unlock(&entry->rw_lock);
Linus Torvalds's avatar
Linus Torvalds committed
368

369
	if (!i)	/* entry is not ready */
Linus Torvalds's avatar
Linus Torvalds committed
370 371
		return -ENODATA;
	
372
	for (i = 0; i < 6 && devpath->layers[i]; i++)
Linus Torvalds's avatar
Linus Torvalds committed
373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396
		out += sprintf(out, "%u ", devpath->layers[i]);

	out += sprintf(out, "\n");
	
	return out - buf;
}

/**
 * pdcspath_layer_write - This function handles extended layer modifying.
 * @entry: An allocated and populated pdscpath_entry struct.
 * @buf: The input buffer to read from.
 * @count: The number of bytes to be read.
 * 
 * We will call this function to change the current layer value.
 * Layers are to be given '.'-delimited, without brackets.
 * XXX beware we are far less checky WRT input data provided than for hwpath.
 * Potential harm can be done, since there's no way to check the validity of
 * the layer fields.
 */
static ssize_t
pdcspath_layer_write(struct pdcspath_entry *entry, const char *buf, size_t count)
{
	unsigned int layers[6]; /* device-specific info (ctlr#, unit#, ...) */
	unsigned short i;
397
	char in[64], *temp;
Linus Torvalds's avatar
Linus Torvalds committed
398 399 400 401 402

	if (!entry || !buf || !count)
		return -EINVAL;

	/* We'll use a local copy of buf */
403
	count = min_t(size_t, count, sizeof(in)-1);
Linus Torvalds's avatar
Linus Torvalds committed
404
	strncpy(in, buf, count);
405
	in[count] = '\0';
Linus Torvalds's avatar
Linus Torvalds committed
406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424
	
	/* Let's clean up the target. 0 is a blank pattern */
	memset(&layers, 0, sizeof(layers));
	
	/* First, pick the first layer */
	if (unlikely(!isdigit(*in)))
		return -EINVAL;
	layers[0] = simple_strtoul(in, NULL, 10);
	DPRINTK("%s: layer[0]: %d\n", __func__, layers[0]);
	
	temp = in;
	for (i=1; ((temp = strchr(temp, '.'))) && (likely(i<6)); i++) {
		if (unlikely(!isdigit(*(++temp))))
			return -EINVAL;
		layers[i] = simple_strtoul(temp, NULL, 10);
		DPRINTK("%s: layer[%d]: %d\n", __func__, i, layers[i]);
	}
		
	/* So far so good, let's get in deep */
425
	write_lock(&entry->rw_lock);
Linus Torvalds's avatar
Linus Torvalds committed
426 427 428 429 430 431
	
	/* First, overwrite the current layers with the new ones, not touching
	   the hardware path. */
	memcpy(&entry->devpath.layers, &layers, sizeof(layers));
	
	/* Now, dive in. Write back to the hardware */
432 433
	pdcspath_store(entry);
	write_unlock(&entry->rw_lock);
Linus Torvalds's avatar
Linus Torvalds committed
434
	
435
	printk(KERN_INFO PDCS_PREFIX ": changed \"%s\" layers to \"%s\"\n",
Linus Torvalds's avatar
Linus Torvalds committed
436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 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 479 480 481 482 483
		entry->name, buf);
	
	return count;
}

/**
 * pdcspath_attr_show - Generic read function call wrapper.
 * @kobj: The kobject to get info from.
 * @attr: The attribute looked upon.
 * @buf: The output buffer.
 */
static ssize_t
pdcspath_attr_show(struct kobject *kobj, struct attribute *attr, char *buf)
{
	struct pdcspath_entry *entry = to_pdcspath_entry(kobj);
	struct pdcspath_attribute *pdcs_attr = to_pdcspath_attribute(attr);
	ssize_t ret = 0;

	if (pdcs_attr->show)
		ret = pdcs_attr->show(entry, buf);

	return ret;
}

/**
 * pdcspath_attr_store - Generic write function call wrapper.
 * @kobj: The kobject to write info to.
 * @attr: The attribute to be modified.
 * @buf: The input buffer.
 * @count: The size of the buffer.
 */
static ssize_t
pdcspath_attr_store(struct kobject *kobj, struct attribute *attr,
			const char *buf, size_t count)
{
	struct pdcspath_entry *entry = to_pdcspath_entry(kobj);
	struct pdcspath_attribute *pdcs_attr = to_pdcspath_attribute(attr);
	ssize_t ret = 0;

	if (!capable(CAP_SYS_ADMIN))
		return -EACCES;

	if (pdcs_attr->store)
		ret = pdcs_attr->store(entry, buf, count);

	return ret;
}

484
static const struct sysfs_ops pdcspath_attr_ops = {
Linus Torvalds's avatar
Linus Torvalds committed
485 486 487 488 489
	.show = pdcspath_attr_show,
	.store = pdcspath_attr_store,
};

/* These are the two attributes of any PDC path. */
490 491
static PATHS_ATTR(hwpath, 0644, pdcspath_hwpath_read, pdcspath_hwpath_write);
static PATHS_ATTR(layer, 0644, pdcspath_layer_read, pdcspath_layer_write);
Linus Torvalds's avatar
Linus Torvalds committed
492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519

static struct attribute *paths_subsys_attrs[] = {
	&paths_attr_hwpath.attr,
	&paths_attr_layer.attr,
	NULL,
};

/* Specific kobject type for our PDC paths */
static struct kobj_type ktype_pdcspath = {
	.sysfs_ops = &pdcspath_attr_ops,
	.default_attrs = paths_subsys_attrs,
};

/* We hard define the 4 types of path we expect to find */
static PDCSPATH_ENTRY(PDCS_ADDR_PPRI, primary);
static PDCSPATH_ENTRY(PDCS_ADDR_PCON, console);
static PDCSPATH_ENTRY(PDCS_ADDR_PALT, alternative);
static PDCSPATH_ENTRY(PDCS_ADDR_PKBD, keyboard);

/* An array containing all PDC paths we will deal with */
static struct pdcspath_entry *pdcspath_entries[] = {
	&pdcspath_entry_primary,
	&pdcspath_entry_alternative,
	&pdcspath_entry_console,
	&pdcspath_entry_keyboard,
	NULL,
};

520 521 522 523

/* For more insight of what's going on here, refer to PDC Procedures doc,
 * Section PDC_STABLE */

Linus Torvalds's avatar
Linus Torvalds committed
524
/**
525
 * pdcs_size_read - Stable Storage size output.
Linus Torvalds's avatar
Linus Torvalds committed
526 527
 * @buf: The output buffer to write to.
 */
528 529 530
static ssize_t pdcs_size_read(struct kobject *kobj,
			      struct kobj_attribute *attr,
			      char *buf)
Linus Torvalds's avatar
Linus Torvalds committed
531 532
{
	char *out = buf;
533

534
	if (!buf)
Linus Torvalds's avatar
Linus Torvalds committed
535
		return -EINVAL;
536

Linus Torvalds's avatar
Linus Torvalds committed
537
	/* show the size of the stable storage */
538
	out += sprintf(out, "%ld\n", pdcs_size);
Linus Torvalds's avatar
Linus Torvalds committed
539

540 541 542 543 544 545 546 547
	return out - buf;
}

/**
 * pdcs_auto_read - Stable Storage autoboot/search flag output.
 * @buf: The output buffer to write to.
 * @knob: The PF_AUTOBOOT or PF_AUTOSEARCH flag
 */
548 549 550
static ssize_t pdcs_auto_read(struct kobject *kobj,
			      struct kobj_attribute *attr,
			      char *buf, int knob)
551 552 553
{
	char *out = buf;
	struct pdcspath_entry *pathentry;
Helge Deller's avatar
Helge Deller committed
554

555
	if (!buf)
556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572
		return -EINVAL;

	/* Current flags are stored in primary boot path entry */
	pathentry = &pdcspath_entry_primary;

	read_lock(&pathentry->rw_lock);
	out += sprintf(out, "%s\n", (pathentry->devpath.flags & knob) ?
					"On" : "Off");
	read_unlock(&pathentry->rw_lock);

	return out - buf;
}

/**
 * pdcs_autoboot_read - Stable Storage autoboot flag output.
 * @buf: The output buffer to write to.
 */
573 574
static ssize_t pdcs_autoboot_read(struct kobject *kobj,
				  struct kobj_attribute *attr, char *buf)
575
{
576
	return pdcs_auto_read(kobj, attr, buf, PF_AUTOBOOT);
577 578 579 580 581 582
}

/**
 * pdcs_autosearch_read - Stable Storage autoboot flag output.
 * @buf: The output buffer to write to.
 */
583 584
static ssize_t pdcs_autosearch_read(struct kobject *kobj,
				    struct kobj_attribute *attr, char *buf)
585
{
586
	return pdcs_auto_read(kobj, attr, buf, PF_AUTOSEARCH);
587 588 589 590 591 592 593 594
}

/**
 * pdcs_timer_read - Stable Storage timer count output (in seconds).
 * @buf: The output buffer to write to.
 *
 * The value of the timer field correponds to a number of seconds in powers of 2.
 */
595 596
static ssize_t pdcs_timer_read(struct kobject *kobj,
			       struct kobj_attribute *attr, char *buf)
597 598 599 600
{
	char *out = buf;
	struct pdcspath_entry *pathentry;

601
	if (!buf)
602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619
		return -EINVAL;

	/* Current flags are stored in primary boot path entry */
	pathentry = &pdcspath_entry_primary;

	/* print the timer value in seconds */
	read_lock(&pathentry->rw_lock);
	out += sprintf(out, "%u\n", (pathentry->devpath.flags & PF_TIMER) ?
				(1 << (pathentry->devpath.flags & PF_TIMER)) : 0);
	read_unlock(&pathentry->rw_lock);

	return out - buf;
}

/**
 * pdcs_osid_read - Stable Storage OS ID register output.
 * @buf: The output buffer to write to.
 */
620 621
static ssize_t pdcs_osid_read(struct kobject *kobj,
			      struct kobj_attribute *attr, char *buf)
622 623 624
{
	char *out = buf;

625
	if (!buf)
626
		return -EINVAL;
Linus Torvalds's avatar
Linus Torvalds committed
627

628 629
	out += sprintf(out, "%s dependent data (0x%.4x)\n",
		os_id_to_string(pdcs_osid), pdcs_osid);
630 631 632 633 634 635 636 637 638 639

	return out - buf;
}

/**
 * pdcs_osdep1_read - Stable Storage OS-Dependent data area 1 output.
 * @buf: The output buffer to write to.
 *
 * This can hold 16 bytes of OS-Dependent data.
 */
640 641
static ssize_t pdcs_osdep1_read(struct kobject *kobj,
				struct kobj_attribute *attr, char *buf)
642 643 644 645
{
	char *out = buf;
	u32 result[4];

646
	if (!buf)
647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665
		return -EINVAL;

	if (pdc_stable_read(PDCS_ADDR_OSD1, &result, sizeof(result)) != PDC_OK)
		return -EIO;

	out += sprintf(out, "0x%.8x\n", result[0]);
	out += sprintf(out, "0x%.8x\n", result[1]);
	out += sprintf(out, "0x%.8x\n", result[2]);
	out += sprintf(out, "0x%.8x\n", result[3]);

	return out - buf;
}

/**
 * pdcs_diagnostic_read - Stable Storage Diagnostic register output.
 * @buf: The output buffer to write to.
 *
 * I have NFC how to interpret the content of that register ;-).
 */
666 667
static ssize_t pdcs_diagnostic_read(struct kobject *kobj,
				    struct kobj_attribute *attr, char *buf)
668 669 670 671
{
	char *out = buf;
	u32 result;

672
	if (!buf)
673 674 675 676 677 678 679
		return -EINVAL;

	/* get diagnostic */
	if (pdc_stable_read(PDCS_ADDR_DIAG, &result, sizeof(result)) != PDC_OK)
		return -EIO;

	out += sprintf(out, "0x%.4x\n", (result >> 16));
680 681 682 683 684 685 686 687 688 689

	return out - buf;
}

/**
 * pdcs_fastsize_read - Stable Storage FastSize register output.
 * @buf: The output buffer to write to.
 *
 * This register holds the amount of system RAM to be tested during boot sequence.
 */
690 691
static ssize_t pdcs_fastsize_read(struct kobject *kobj,
				  struct kobj_attribute *attr, char *buf)
692 693
{
	char *out = buf;
694
	u32 result;
695

696
	if (!buf)
697
		return -EINVAL;
Linus Torvalds's avatar
Linus Torvalds committed
698 699 700 701 702 703

	/* get fast-size */
	if (pdc_stable_read(PDCS_ADDR_FSIZ, &result, sizeof(result)) != PDC_OK)
		return -EIO;

	if ((result & 0x0F) < 0x0E)
704
		out += sprintf(out, "%d kB", (1<<(result & 0x0F))*256);
Linus Torvalds's avatar
Linus Torvalds committed
705 706 707 708 709 710 711
	else
		out += sprintf(out, "All");
	out += sprintf(out, "\n");
	
	return out - buf;
}

712 713 714 715 716 717
/**
 * pdcs_osdep2_read - Stable Storage OS-Dependent data area 2 output.
 * @buf: The output buffer to write to.
 *
 * This can hold pdcs_size - 224 bytes of OS-Dependent data, when available.
 */
718 719
static ssize_t pdcs_osdep2_read(struct kobject *kobj,
				struct kobj_attribute *attr, char *buf)
720 721 722 723 724 725 726 727 728 729 730
{
	char *out = buf;
	unsigned long size;
	unsigned short i;
	u32 result;

	if (unlikely(pdcs_size <= 224))
		return -ENODATA;

	size = pdcs_size - 224;

731
	if (!buf)
732 733 734 735 736 737 738 739 740 741 742 743
		return -EINVAL;

	for (i=0; i<size; i+=4) {
		if (unlikely(pdc_stable_read(PDCS_ADDR_OSD2 + i, &result,
					sizeof(result)) != PDC_OK))
			return -EIO;
		out += sprintf(out, "0x%.8x\n", result);
	}

	return out - buf;
}

Linus Torvalds's avatar
Linus Torvalds committed
744
/**
745
 * pdcs_auto_write - This function handles autoboot/search flag modifying.
Linus Torvalds's avatar
Linus Torvalds committed
746 747
 * @buf: The input buffer to read from.
 * @count: The number of bytes to be read.
748
 * @knob: The PF_AUTOBOOT or PF_AUTOSEARCH flag
Linus Torvalds's avatar
Linus Torvalds committed
749
 * 
750
 * We will call this function to change the current autoboot flag.
Linus Torvalds's avatar
Linus Torvalds committed
751
 * We expect a precise syntax:
752
 *	\"n\" (n == 0 or 1) to toggle AutoBoot Off or On
Linus Torvalds's avatar
Linus Torvalds committed
753
 */
754 755 756
static ssize_t pdcs_auto_write(struct kobject *kobj,
			       struct kobj_attribute *attr, const char *buf,
			       size_t count, int knob)
Linus Torvalds's avatar
Linus Torvalds committed
757 758 759
{
	struct pdcspath_entry *pathentry;
	unsigned char flags;
760
	char in[8], *temp;
Linus Torvalds's avatar
Linus Torvalds committed
761 762 763 764 765
	char c;

	if (!capable(CAP_SYS_ADMIN))
		return -EACCES;

766
	if (!buf || !count)
Linus Torvalds's avatar
Linus Torvalds committed
767 768 769
		return -EINVAL;

	/* We'll use a local copy of buf */
770
	count = min_t(size_t, count, sizeof(in)-1);
Linus Torvalds's avatar
Linus Torvalds committed
771
	strncpy(in, buf, count);
772
	in[count] = '\0';
Linus Torvalds's avatar
Linus Torvalds committed
773 774 775 776 777

	/* Current flags are stored in primary boot path entry */
	pathentry = &pdcspath_entry_primary;
	
	/* Be nice to the existing flag record */
778
	read_lock(&pathentry->rw_lock);
Linus Torvalds's avatar
Linus Torvalds committed
779
	flags = pathentry->devpath.flags;
780
	read_unlock(&pathentry->rw_lock);
Linus Torvalds's avatar
Linus Torvalds committed
781 782
	
	DPRINTK("%s: flags before: 0x%X\n", __func__, flags);
783 784 785

	temp = skip_spaces(in);

Linus Torvalds's avatar
Linus Torvalds committed
786 787 788 789
	c = *temp++ - '0';
	if ((c != 0) && (c != 1))
		goto parse_error;
	if (c == 0)
790
		flags &= ~knob;
Linus Torvalds's avatar
Linus Torvalds committed
791
	else
792
		flags |= knob;
Linus Torvalds's avatar
Linus Torvalds committed
793 794 795 796
	
	DPRINTK("%s: flags after: 0x%X\n", __func__, flags);
		
	/* So far so good, let's get in deep */
797
	write_lock(&pathentry->rw_lock);
Linus Torvalds's avatar
Linus Torvalds committed
798 799 800 801 802
	
	/* Change the path entry flags first */
	pathentry->devpath.flags = flags;
		
	/* Now, dive in. Write back to the hardware */
803 804
	pdcspath_store(pathentry);
	write_unlock(&pathentry->rw_lock);
Linus Torvalds's avatar
Linus Torvalds committed
805
	
806 807 808
	printk(KERN_INFO PDCS_PREFIX ": changed \"%s\" to \"%s\"\n",
		(knob & PF_AUTOBOOT) ? "autoboot" : "autosearch",
		(flags & knob) ? "On" : "Off");
Linus Torvalds's avatar
Linus Torvalds committed
809 810 811 812
	
	return count;

parse_error:
813
	printk(KERN_WARNING "%s: Parse error: expect \"n\" (n == 0 or 1)\n", __func__);
Linus Torvalds's avatar
Linus Torvalds committed
814 815 816
	return -EINVAL;
}

817 818 819 820 821 822 823 824 825
/**
 * pdcs_autoboot_write - This function handles autoboot flag modifying.
 * @buf: The input buffer to read from.
 * @count: The number of bytes to be read.
 *
 * We will call this function to change the current boot flags.
 * We expect a precise syntax:
 *	\"n\" (n == 0 or 1) to toggle AutoSearch Off or On
 */
826 827 828
static ssize_t pdcs_autoboot_write(struct kobject *kobj,
				   struct kobj_attribute *attr,
				   const char *buf, size_t count)
829
{
830
	return pdcs_auto_write(kobj, attr, buf, count, PF_AUTOBOOT);
831 832 833 834 835 836 837 838 839 840 841
}

/**
 * pdcs_autosearch_write - This function handles autosearch flag modifying.
 * @buf: The input buffer to read from.
 * @count: The number of bytes to be read.
 *
 * We will call this function to change the current boot flags.
 * We expect a precise syntax:
 *	\"n\" (n == 0 or 1) to toggle AutoSearch Off or On
 */
842 843 844
static ssize_t pdcs_autosearch_write(struct kobject *kobj,
				     struct kobj_attribute *attr,
				     const char *buf, size_t count)
845
{
846
	return pdcs_auto_write(kobj, attr, buf, count, PF_AUTOSEARCH);
847 848
}

849 850 851 852 853 854 855 856 857
/**
 * pdcs_osdep1_write - Stable Storage OS-Dependent data area 1 input.
 * @buf: The input buffer to read from.
 * @count: The number of bytes to be read.
 *
 * This can store 16 bytes of OS-Dependent data. We use a byte-by-byte
 * write approach. It's up to userspace to deal with it when constructing
 * its input buffer.
 */
858 859 860
static ssize_t pdcs_osdep1_write(struct kobject *kobj,
				 struct kobj_attribute *attr,
				 const char *buf, size_t count)
861 862 863 864 865 866
{
	u8 in[16];

	if (!capable(CAP_SYS_ADMIN))
		return -EACCES;

867
	if (!buf || !count)
868 869
		return -EINVAL;

Kyle McMartin's avatar
Kyle McMartin committed
870
	if (unlikely(pdcs_osid != OS_ID_LINUX))
871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894
		return -EPERM;

	if (count > 16)
		return -EMSGSIZE;

	/* We'll use a local copy of buf */
	memset(in, 0, 16);
	memcpy(in, buf, count);

	if (pdc_stable_write(PDCS_ADDR_OSD1, &in, sizeof(in)) != PDC_OK)
		return -EIO;

	return count;
}

/**
 * pdcs_osdep2_write - Stable Storage OS-Dependent data area 2 input.
 * @buf: The input buffer to read from.
 * @count: The number of bytes to be read.
 *
 * This can store pdcs_size - 224 bytes of OS-Dependent data. We use a
 * byte-by-byte write approach. It's up to userspace to deal with it when
 * constructing its input buffer.
 */
895 896 897
static ssize_t pdcs_osdep2_write(struct kobject *kobj,
				 struct kobj_attribute *attr,
				 const char *buf, size_t count)
898 899 900 901 902 903 904 905
{
	unsigned long size;
	unsigned short i;
	u8 in[4];

	if (!capable(CAP_SYS_ADMIN))
		return -EACCES;

906
	if (!buf || !count)
907 908 909 910 911
		return -EINVAL;

	if (unlikely(pdcs_size <= 224))
		return -ENOSYS;

Kyle McMartin's avatar
Kyle McMartin committed
912
	if (unlikely(pdcs_osid != OS_ID_LINUX))
913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932
		return -EPERM;

	size = pdcs_size - 224;

	if (count > size)
		return -EMSGSIZE;

	/* We'll use a local copy of buf */

	for (i=0; i<count; i+=4) {
		memset(in, 0, 4);
		memcpy(in, buf+i, (count-i < 4) ? count-i : 4);
		if (unlikely(pdc_stable_write(PDCS_ADDR_OSD2 + i, &in,
					sizeof(in)) != PDC_OK))
			return -EIO;
	}

	return count;
}

933 934 935 936 937
/* The remaining attributes. */
static PDCS_ATTR(size, 0444, pdcs_size_read, NULL);
static PDCS_ATTR(autoboot, 0644, pdcs_autoboot_read, pdcs_autoboot_write);
static PDCS_ATTR(autosearch, 0644, pdcs_autosearch_read, pdcs_autosearch_write);
static PDCS_ATTR(timer, 0444, pdcs_timer_read, NULL);
938 939 940
static PDCS_ATTR(osid, 0444, pdcs_osid_read, NULL);
static PDCS_ATTR(osdep1, 0600, pdcs_osdep1_read, pdcs_osdep1_write);
static PDCS_ATTR(diagnostic, 0400, pdcs_diagnostic_read, NULL);
941
static PDCS_ATTR(fastsize, 0400, pdcs_fastsize_read, NULL);
942
static PDCS_ATTR(osdep2, 0600, pdcs_osdep2_read, pdcs_osdep2_write);
Linus Torvalds's avatar
Linus Torvalds committed
943

944 945 946 947 948 949 950 951 952 953
static struct attribute *pdcs_subsys_attrs[] = {
	&pdcs_attr_size.attr,
	&pdcs_attr_autoboot.attr,
	&pdcs_attr_autosearch.attr,
	&pdcs_attr_timer.attr,
	&pdcs_attr_osid.attr,
	&pdcs_attr_osdep1.attr,
	&pdcs_attr_diagnostic.attr,
	&pdcs_attr_fastsize.attr,
	&pdcs_attr_osdep2.attr,
954
	NULL,
Linus Torvalds's avatar
Linus Torvalds committed
955 956
};

957 958 959 960
static struct attribute_group pdcs_attr_group = {
	.attrs = pdcs_subsys_attrs,
};

961
static struct kobject *stable_kobj;
962
static struct kset *paths_kset;
Linus Torvalds's avatar
Linus Torvalds committed
963 964 965 966 967 968 969 970 971 972 973 974 975 976 977

/**
 * pdcs_register_pathentries - Prepares path entries kobjects for sysfs usage.
 * 
 * It creates kobjects corresponding to each path entry with nice sysfs
 * links to the real device. This is where the magic takes place: when
 * registering the subsystem attributes during module init, each kobject hereby
 * created will show in the sysfs tree as a folder containing files as defined
 * by path_subsys_attr[].
 */
static inline int __init
pdcs_register_pathentries(void)
{
	unsigned short i;
	struct pdcspath_entry *entry;
978
	int err;
Linus Torvalds's avatar
Linus Torvalds committed
979
	
980 981 982 983
	/* Initialize the entries rw_lock before anything else */
	for (i = 0; (entry = pdcspath_entries[i]); i++)
		rwlock_init(&entry->rw_lock);

Linus Torvalds's avatar
Linus Torvalds committed
984
	for (i = 0; (entry = pdcspath_entries[i]); i++) {
985 986 987 988 989
		write_lock(&entry->rw_lock);
		err = pdcspath_fetch(entry);
		write_unlock(&entry->rw_lock);

		if (err < 0)
Linus Torvalds's avatar
Linus Torvalds committed
990 991
			continue;

992
		entry->kobj.kset = paths_kset;
993 994 995
		err = kobject_init_and_add(&entry->kobj, &ktype_pdcspath, NULL,
					   "%s", entry->name);
		if (err)
996
			return err;
997

998
		/* kobject is now registered */
999
		write_lock(&entry->rw_lock);
1000 1001
		entry->ready = 2;
		
Linus Torvalds's avatar
Linus Torvalds committed
1002
		/* Add a nice symlink to the real device */
1003 1004 1005 1006
		if (entry->dev) {
			err = sysfs_create_link(&entry->kobj, &entry->dev->kobj, "device");
			WARN_ON(err);
		}
1007 1008

		write_unlock(&entry->rw_lock);
1009
		kobject_uevent(&entry->kobj, KOBJ_ADD);
Linus Torvalds's avatar
Linus Torvalds committed
1010 1011 1012 1013 1014 1015 1016 1017
	}
	
	return 0;
}

/**
 * pdcs_unregister_pathentries - Routine called when unregistering the module.
 */
1018
static inline void
Linus Torvalds's avatar
Linus Torvalds committed
1019 1020 1021 1022 1023
pdcs_unregister_pathentries(void)
{
	unsigned short i;
	struct pdcspath_entry *entry;
	
1024 1025
	for (i = 0; (entry = pdcspath_entries[i]); i++) {
		read_lock(&entry->rw_lock);
1026
		if (entry->ready >= 2)
1027
			kobject_put(&entry->kobj);
1028 1029
		read_unlock(&entry->rw_lock);
	}
Linus Torvalds's avatar
Linus Torvalds committed
1030 1031 1032
}

/*
1033 1034
 * For now we register the stable subsystem with the firmware subsystem
 * and the paths subsystem with the stable subsystem
Linus Torvalds's avatar
Linus Torvalds committed
1035 1036 1037 1038
 */
static int __init
pdc_stable_init(void)
{
1039
	int rc = 0, error = 0;
1040
	u32 result;
Linus Torvalds's avatar
Linus Torvalds committed
1041 1042 1043 1044 1045

	/* find the size of the stable storage */
	if (pdc_stable_get_size(&pdcs_size) != PDC_OK) 
		return -ENODEV;

1046 1047 1048 1049 1050
	/* make sure we have enough data */
	if (pdcs_size < 96)
		return -ENODATA;

	printk(KERN_INFO PDCS_PREFIX " facility v%s\n", PDCS_VERSION);
Linus Torvalds's avatar
Linus Torvalds committed
1051

1052 1053 1054 1055 1056 1057 1058
	/* get OSID */
	if (pdc_stable_read(PDCS_ADDR_OSID, &result, sizeof(result)) != PDC_OK)
		return -EIO;

	/* the actual result is 16 bits away */
	pdcs_osid = (u16)(result >> 16);

1059 1060 1061
	/* For now we'll register the directory at /sys/firmware/stable */
	stable_kobj = kobject_create_and_add("stable", firmware_kobj);
	if (!stable_kobj) {
1062
		rc = -ENOMEM;
1063
		goto fail_firmreg;
1064
	}
Linus Torvalds's avatar
Linus Torvalds committed
1065

1066
	/* Don't forget the root entries */
1067
	error = sysfs_create_group(stable_kobj, &pdcs_attr_group);
1068

1069
	/* register the paths kset as a child of the stable kset */
1070
	paths_kset = kset_create_and_add("paths", NULL, stable_kobj);
1071 1072 1073 1074
	if (!paths_kset) {
		rc = -ENOMEM;
		goto fail_ksetreg;
	}
Linus Torvalds's avatar
Linus Torvalds committed
1075

1076
	/* now we create all "files" for the paths kset */
1077 1078 1079 1080
	if ((rc = pdcs_register_pathentries()))
		goto fail_pdcsreg;

	return rc;
Linus Torvalds's avatar
Linus Torvalds committed
1081
	
1082 1083
fail_pdcsreg:
	pdcs_unregister_pathentries();
1084
	kset_unregister(paths_kset);
1085
	
1086
fail_ksetreg:
1087
	kobject_put(stable_kobj);
1088 1089
	
fail_firmreg:
1090
	printk(KERN_INFO PDCS_PREFIX " bailing out\n");
1091
	return rc;
Linus Torvalds's avatar
Linus Torvalds committed
1092 1093 1094 1095 1096 1097
}

static void __exit
pdc_stable_exit(void)
{
	pdcs_unregister_pathentries();
1098
	kset_unregister(paths_kset);
1099
	kobject_put(stable_kobj);
Linus Torvalds's avatar
Linus Torvalds committed
1100 1101 1102 1103 1104
}


module_init(pdc_stable_init);
module_exit(pdc_stable_exit);