ps3flash.c 10.6 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
/*
 * PS3 FLASH ROM Storage Driver
 *
 * Copyright (C) 2007 Sony Computer Entertainment Inc.
 * Copyright 2007 Sony Corp.
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published
 * by the Free Software Foundation; version 2 of the License.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#include <linux/fs.h>
#include <linux/miscdevice.h>
23
#include <linux/slab.h>
24
#include <linux/uaccess.h>
25
#include <linux/module.h>
26 27 28 29 30 31 32 33 34 35 36 37

#include <asm/lv1call.h>
#include <asm/ps3stor.h>


#define DEVICE_NAME		"ps3flash"

#define FLASH_BLOCK_SIZE	(256*1024)


struct ps3flash_private {
	struct mutex mutex;	/* Bounce buffer mutex */
38 39 40
	u64 chunk_sectors;
	int tag;		/* Start sector of buffer, -1 if invalid */
	bool dirty;
41 42 43 44
};

static struct ps3_storage_device *ps3flash_dev;

45
static int ps3flash_read_write_sectors(struct ps3_storage_device *dev,
46
				       u64 start_sector, int write)
47
{
48 49 50
	struct ps3flash_private *priv = ps3_system_bus_get_drvdata(&dev->sbd);
	u64 res = ps3stor_read_write_sectors(dev, dev->bounce_lpar,
					     start_sector, priv->chunk_sectors,
51 52
					     write);
	if (res) {
53
		dev_err(&dev->sbd.core, "%s:%u: %s failed 0x%llx\n", __func__,
54 55 56
			__LINE__, write ? "write" : "read", res);
		return -EIO;
	}
57
	return 0;
58 59
}

60
static int ps3flash_writeback(struct ps3_storage_device *dev)
61
{
62 63
	struct ps3flash_private *priv = ps3_system_bus_get_drvdata(&dev->sbd);
	int res;
64

65 66 67
	if (!priv->dirty || priv->tag < 0)
		return 0;

68
	res = ps3flash_read_write_sectors(dev, priv->tag, 1);
69 70
	if (res)
		return res;
71

72 73
	priv->dirty = false;
	return 0;
74 75
}

76
static int ps3flash_fetch(struct ps3_storage_device *dev, u64 start_sector)
77
{
78 79 80
	struct ps3flash_private *priv = ps3_system_bus_get_drvdata(&dev->sbd);
	int res;

81
	if (start_sector == priv->tag)
82 83 84 85 86 87 88 89
		return 0;

	res = ps3flash_writeback(dev);
	if (res)
		return res;

	priv->tag = -1;

90
	res = ps3flash_read_write_sectors(dev, start_sector, 0);
91 92 93
	if (res)
		return res;

94
	priv->tag = start_sector;
95
	return 0;
96 97 98 99 100
}

static loff_t ps3flash_llseek(struct file *file, loff_t offset, int origin)
{
	struct ps3_storage_device *dev = ps3flash_dev;
101 102
	return generic_file_llseek_size(file, offset, origin, MAX_LFS_FILESIZE,
			dev->regions[dev->region_idx].size*dev->blk_size);
103 104
}

105 106
static ssize_t ps3flash_read(char __user *userbuf, void *kernelbuf,
			     size_t count, loff_t *pos)
107 108
{
	struct ps3_storage_device *dev = ps3flash_dev;
109
	struct ps3flash_private *priv = ps3_system_bus_get_drvdata(&dev->sbd);
110
	u64 size, sector, offset;
111
	int res;
112
	size_t remaining, n;
113
	const void *src;
114 115

	dev_dbg(&dev->sbd.core,
116 117
		"%s:%u: Reading %zu bytes at position %lld to U0x%p/K0x%p\n",
		__func__, __LINE__, count, *pos, userbuf, kernelbuf);
118 119 120 121 122 123 124 125 126 127 128 129

	size = dev->regions[dev->region_idx].size*dev->blk_size;
	if (*pos >= size || !count)
		return 0;

	if (*pos + count > size) {
		dev_dbg(&dev->sbd.core,
			"%s:%u Truncating count from %zu to %llu\n", __func__,
			__LINE__, count, size - *pos);
		count = size - *pos;
	}

130
	sector = *pos / dev->bounce_size * priv->chunk_sectors;
131
	offset = *pos % dev->bounce_size;
132 133 134

	remaining = count;
	do {
135 136
		n = min_t(u64, remaining, dev->bounce_size - offset);
		src = dev->bounce_buf + offset;
137

138 139
		mutex_lock(&priv->mutex);

140
		res = ps3flash_fetch(dev, sector);
141
		if (res)
142 143 144
			goto fail;

		dev_dbg(&dev->sbd.core,
145 146 147 148
			"%s:%u: copy %lu bytes from 0x%p to U0x%p/K0x%p\n",
			__func__, __LINE__, n, src, userbuf, kernelbuf);
		if (userbuf) {
			if (copy_to_user(userbuf, src, n)) {
149
				res = -EFAULT;
150 151 152 153 154 155 156
				goto fail;
			}
			userbuf += n;
		}
		if (kernelbuf) {
			memcpy(kernelbuf, src, n);
			kernelbuf += n;
157 158 159 160 161 162
		}

		mutex_unlock(&priv->mutex);

		*pos += n;
		remaining -= n;
163
		sector += priv->chunk_sectors;
164 165 166 167 168 169
		offset = 0;
	} while (remaining > 0);

	return count;

fail:
170 171
	mutex_unlock(&priv->mutex);
	return res;
172 173
}

174 175
static ssize_t ps3flash_write(const char __user *userbuf,
			      const void *kernelbuf, size_t count, loff_t *pos)
176 177
{
	struct ps3_storage_device *dev = ps3flash_dev;
178
	struct ps3flash_private *priv = ps3_system_bus_get_drvdata(&dev->sbd);
179 180
	u64 size, sector, offset;
	int res = 0;
181
	size_t remaining, n;
182
	void *dst;
183 184

	dev_dbg(&dev->sbd.core,
185 186
		"%s:%u: Writing %zu bytes at position %lld from U0x%p/K0x%p\n",
		__func__, __LINE__, count, *pos, userbuf, kernelbuf);
187 188 189 190 191 192 193 194 195 196 197 198

	size = dev->regions[dev->region_idx].size*dev->blk_size;
	if (*pos >= size || !count)
		return 0;

	if (*pos + count > size) {
		dev_dbg(&dev->sbd.core,
			"%s:%u Truncating count from %zu to %llu\n", __func__,
			__LINE__, count, size - *pos);
		count = size - *pos;
	}

199
	sector = *pos / dev->bounce_size * priv->chunk_sectors;
200 201 202 203
	offset = *pos % dev->bounce_size;

	remaining = count;
	do {
204
		n = min_t(u64, remaining, dev->bounce_size - offset);
205
		dst = dev->bounce_buf + offset;
206

207 208
		mutex_lock(&priv->mutex);

209
		if (n != dev->bounce_size)
210
			res = ps3flash_fetch(dev, sector);
211 212 213 214
		else if (sector != priv->tag)
			res = ps3flash_writeback(dev);
		if (res)
			goto fail;
215 216

		dev_dbg(&dev->sbd.core,
217 218 219 220 221 222 223 224 225 226 227 228
			"%s:%u: copy %lu bytes from U0x%p/K0x%p to 0x%p\n",
			__func__, __LINE__, n, userbuf, kernelbuf, dst);
		if (userbuf) {
			if (copy_from_user(dst, userbuf, n)) {
				res = -EFAULT;
				goto fail;
			}
			userbuf += n;
		}
		if (kernelbuf) {
			memcpy(dst, kernelbuf, n);
			kernelbuf += n;
229 230
		}

231 232
		priv->tag = sector;
		priv->dirty = true;
233 234 235 236 237

		mutex_unlock(&priv->mutex);

		*pos += n;
		remaining -= n;
238
		sector += priv->chunk_sectors;
239 240 241 242 243 244 245 246 247 248
		offset = 0;
	} while (remaining > 0);

	return count;

fail:
	mutex_unlock(&priv->mutex);
	return res;
}

249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268
static ssize_t ps3flash_user_read(struct file *file, char __user *buf,
				  size_t count, loff_t *pos)
{
	return ps3flash_read(buf, NULL, count, pos);
}

static ssize_t ps3flash_user_write(struct file *file, const char __user *buf,
				   size_t count, loff_t *pos)
{
	return ps3flash_write(buf, NULL, count, pos);
}

static ssize_t ps3flash_kernel_read(void *buf, size_t count, loff_t pos)
{
	return ps3flash_read(NULL, buf, count, &pos);
}

static ssize_t ps3flash_kernel_write(const void *buf, size_t count,
				     loff_t pos)
{
269 270 271 272 273 274 275 276 277 278 279 280 281
	ssize_t res;
	int wb;

	res = ps3flash_write(NULL, buf, count, &pos);
	if (res < 0)
		return res;

	/* Make kernel writes synchronous */
	wb = ps3flash_writeback(ps3flash_dev);
	if (wb)
		return wb;

	return res;
282 283
}

284 285 286 287 288
static int ps3flash_flush(struct file *file, fl_owner_t id)
{
	return ps3flash_writeback(ps3flash_dev);
}

289
static int ps3flash_fsync(struct file *file, loff_t start, loff_t end, int datasync)
290
{
Al Viro's avatar
Al Viro committed
291
	struct inode *inode = file_inode(file);
292
	int err;
Al Viro's avatar
Al Viro committed
293
	inode_lock(inode);
294
	err = ps3flash_writeback(ps3flash_dev);
Al Viro's avatar
Al Viro committed
295
	inode_unlock(inode);
296
	return err;
297
}
298 299 300 301 302 303 304 305 306 307 308

static irqreturn_t ps3flash_interrupt(int irq, void *data)
{
	struct ps3_storage_device *dev = data;
	int res;
	u64 tag, status;

	res = lv1_storage_get_async_status(dev->sbd.dev_id, &tag, &status);

	if (tag != dev->tag)
		dev_err(&dev->sbd.core,
309
			"%s:%u: tag mismatch, got %llx, expected %llx\n",
310 311 312
			__func__, __LINE__, tag, dev->tag);

	if (res) {
313
		dev_err(&dev->sbd.core, "%s:%u: res=%d status=0x%llx\n",
314 315 316 317 318 319 320 321 322 323 324
			__func__, __LINE__, res, status);
	} else {
		dev->lv1_status = status;
		complete(&dev->done);
	}
	return IRQ_HANDLED;
}

static const struct file_operations ps3flash_fops = {
	.owner	= THIS_MODULE,
	.llseek	= ps3flash_llseek,
325 326
	.read	= ps3flash_user_read,
	.write	= ps3flash_user_write,
327 328
	.flush	= ps3flash_flush,
	.fsync	= ps3flash_fsync,
329 330 331 332 333
};

static const struct ps3_os_area_flash_ops ps3flash_kernel_ops = {
	.read	= ps3flash_kernel_read,
	.write	= ps3flash_kernel_write,
334 335 336 337 338 339 340 341
};

static struct miscdevice ps3flash_misc = {
	.minor	= MISC_DYNAMIC_MINOR,
	.name	= DEVICE_NAME,
	.fops	= &ps3flash_fops,
};

342
static int ps3flash_probe(struct ps3_system_bus_device *_dev)
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
{
	struct ps3_storage_device *dev = to_ps3_storage_device(&_dev->core);
	struct ps3flash_private *priv;
	int error;
	unsigned long tmp;

	tmp = dev->regions[dev->region_idx].start*dev->blk_size;
	if (tmp % FLASH_BLOCK_SIZE) {
		dev_err(&dev->sbd.core,
			"%s:%u region start %lu is not aligned\n", __func__,
			__LINE__, tmp);
		return -EINVAL;
	}
	tmp = dev->regions[dev->region_idx].size*dev->blk_size;
	if (tmp % FLASH_BLOCK_SIZE) {
		dev_err(&dev->sbd.core,
			"%s:%u region size %lu is not aligned\n", __func__,
			__LINE__, tmp);
		return -EINVAL;
	}

	/* use static buffer, kmalloc cannot allocate 256 KiB */
	if (!ps3flash_bounce_buffer.address)
		return -ENODEV;

	if (ps3flash_dev) {
		dev_err(&dev->sbd.core,
			"Only one FLASH device is supported\n");
		return -EBUSY;
	}

	ps3flash_dev = dev;

	priv = kzalloc(sizeof(*priv), GFP_KERNEL);
	if (!priv) {
		error = -ENOMEM;
		goto fail;
	}

382
	ps3_system_bus_set_drvdata(&dev->sbd, priv);
383
	mutex_init(&priv->mutex);
384
	priv->tag = -1;
385 386 387

	dev->bounce_size = ps3flash_bounce_buffer.size;
	dev->bounce_buf = ps3flash_bounce_buffer.address;
388
	priv->chunk_sectors = dev->bounce_size / dev->blk_size;
389 390 391 392 393 394 395 396 397 398 399 400 401 402 403

	error = ps3stor_setup(dev, ps3flash_interrupt);
	if (error)
		goto fail_free_priv;

	ps3flash_misc.parent = &dev->sbd.core;
	error = misc_register(&ps3flash_misc);
	if (error) {
		dev_err(&dev->sbd.core, "%s:%u: misc_register failed %d\n",
			__func__, __LINE__, error);
		goto fail_teardown;
	}

	dev_info(&dev->sbd.core, "%s:%u: registered misc device %d\n",
		 __func__, __LINE__, ps3flash_misc.minor);
404 405

	ps3_os_area_flash_register(&ps3flash_kernel_ops);
406 407 408 409 410 411
	return 0;

fail_teardown:
	ps3stor_teardown(dev);
fail_free_priv:
	kfree(priv);
412
	ps3_system_bus_set_drvdata(&dev->sbd, NULL);
413 414 415 416 417 418 419 420 421
fail:
	ps3flash_dev = NULL;
	return error;
}

static int ps3flash_remove(struct ps3_system_bus_device *_dev)
{
	struct ps3_storage_device *dev = to_ps3_storage_device(&_dev->core);

422
	ps3_os_area_flash_register(NULL);
423 424
	misc_deregister(&ps3flash_misc);
	ps3stor_teardown(dev);
425 426
	kfree(ps3_system_bus_get_drvdata(&dev->sbd));
	ps3_system_bus_set_drvdata(&dev->sbd, NULL);
427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458
	ps3flash_dev = NULL;
	return 0;
}


static struct ps3_system_bus_driver ps3flash = {
	.match_id	= PS3_MATCH_ID_STOR_FLASH,
	.core.name	= DEVICE_NAME,
	.core.owner	= THIS_MODULE,
	.probe		= ps3flash_probe,
	.remove		= ps3flash_remove,
	.shutdown	= ps3flash_remove,
};


static int __init ps3flash_init(void)
{
	return ps3_system_bus_driver_register(&ps3flash);
}

static void __exit ps3flash_exit(void)
{
	ps3_system_bus_driver_unregister(&ps3flash);
}

module_init(ps3flash_init);
module_exit(ps3flash_exit);

MODULE_LICENSE("GPL");
MODULE_DESCRIPTION("PS3 FLASH ROM Storage Driver");
MODULE_AUTHOR("Sony Corporation");
MODULE_ALIAS(PS3_MODULE_ALIAS_STOR_FLASH);