2 * ps3vram - Use extra PS3 video ram as MTD block device.
4 * Copyright (c) 2007-2008 Jim Paris <jim@jtan.com>
5 * Added support RSX DMA Vivien Chappelier <vivien.chappelier@free.fr>
10 #include <linux/init.h>
11 #include <linux/kernel.h>
12 #include <linux/list.h>
13 #include <linux/module.h>
14 #include <linux/moduleparam.h>
15 #include <linux/slab.h>
16 #include <linux/version.h>
17 #include <linux/gfp.h>
18 #include <linux/delay.h>
19 #include <linux/mtd/mtd.h>
21 #include <asm/lv1call.h>
24 #define DEVICE_NAME "ps3vram"
26 #define XDR_BUF_SIZE (2 * 1024 * 1024) /* XDR buffer (must be 1MiB aligned) */
27 #define XDR_IOIF 0x0c000000
29 #define FIFO_BASE XDR_IOIF
30 #define FIFO_SIZE (64 * 1024)
32 #define DMA_PAGE_SIZE (4 * 1024)
34 #define CACHE_PAGE_SIZE (256 * 1024)
35 #define CACHE_PAGE_COUNT ((XDR_BUF_SIZE - FIFO_SIZE) / CACHE_PAGE_SIZE)
37 #define CACHE_OFFSET CACHE_PAGE_SIZE
44 #define UPLOAD_SUBCH 1
45 #define DOWNLOAD_SUBCH 2
47 #define NV_MEMORY_TO_MEMORY_FORMAT_OFFSET_IN 0x0000030c
48 #define NV_MEMORY_TO_MEMORY_FORMAT_NOTIFY 0x00000104
50 #define L1GPU_CONTEXT_ATTRIBUTE_FB_BLIT 0x601
52 struct mtd_info ps3vram_mtd;
54 #define CACHE_PAGE_PRESENT 1
55 #define CACHE_PAGE_DIRTY 2
62 struct ps3vram_cache {
63 unsigned int page_count;
64 unsigned int page_size;
65 struct ps3vram_tag *tags;
80 struct ps3vram_cache cache;
82 /* Used to serialize cache/DMA operations */
86 #define DMA_NOTIFIER_HANDLE_BASE 0x66604200 /* first DMA notifier handle */
87 #define DMA_NOTIFIER_OFFSET_BASE 0x1000 /* first DMA notifier offset */
88 #define DMA_NOTIFIER_SIZE 0x40
89 #define NOTIFIER 7 /* notifier used for completion report */
91 /* A trailing '-' means to subtract off ps3fb_videomemory.size */
93 module_param(size, charp, 0);
94 MODULE_PARM_DESC(size, "memory size");
96 static u32 *ps3vram_get_notifier(u32 *reports, int notifier)
98 return (void *) reports +
99 DMA_NOTIFIER_OFFSET_BASE +
100 DMA_NOTIFIER_SIZE * notifier;
103 static void ps3vram_notifier_reset(struct mtd_info *mtd)
107 struct ps3vram_priv *priv = mtd->priv;
108 u32 *notify = ps3vram_get_notifier(priv->reports, NOTIFIER);
109 for (i = 0; i < 4; i++)
110 notify[i] = 0xffffffff;
113 static int ps3vram_notifier_wait(struct mtd_info *mtd, unsigned int timeout_ms)
115 struct ps3vram_priv *priv = mtd->priv;
116 u32 *notify = ps3vram_get_notifier(priv->reports, NOTIFIER);
117 unsigned long timeout = jiffies + msecs_to_jiffies(timeout_ms);
123 } while (time_before(jiffies, timeout));
128 static void ps3vram_init_ring(struct mtd_info *mtd)
130 struct ps3vram_priv *priv = mtd->priv;
132 priv->ctrl[CTRL_PUT] = FIFO_BASE + FIFO_OFFSET;
133 priv->ctrl[CTRL_GET] = FIFO_BASE + FIFO_OFFSET;
136 static int ps3vram_wait_ring(struct mtd_info *mtd, unsigned int timeout_ms)
138 struct ps3vram_priv *priv = mtd->priv;
139 unsigned long timeout = jiffies + msecs_to_jiffies(timeout_ms);
142 if (priv->ctrl[CTRL_PUT] == priv->ctrl[CTRL_GET])
145 } while (time_before(jiffies, timeout));
147 dev_dbg(priv->dev, "%s:%d: FIFO timeout (%08x/%08x/%08x)\n", __func__,
148 __LINE__, priv->ctrl[CTRL_PUT], priv->ctrl[CTRL_GET],
149 priv->ctrl[CTRL_TOP]);
154 static void ps3vram_out_ring(struct ps3vram_priv *priv, u32 data)
156 *(priv->fifo_ptr)++ = data;
159 static void ps3vram_begin_ring(struct ps3vram_priv *priv, u32 chan,
162 ps3vram_out_ring(priv, (size << 18) | (chan << 13) | tag);
165 static void ps3vram_rewind_ring(struct mtd_info *mtd)
167 struct ps3vram_priv *priv = mtd->priv;
170 ps3vram_out_ring(priv, 0x20000000 | (FIFO_BASE + FIFO_OFFSET));
172 priv->ctrl[CTRL_PUT] = FIFO_BASE + FIFO_OFFSET;
174 /* asking the HV for a blit will kick the fifo */
175 status = lv1_gpu_context_attribute(priv->context_handle,
176 L1GPU_CONTEXT_ATTRIBUTE_FB_BLIT,
179 dev_err(priv->dev, "%s:%d: lv1_gpu_context_attribute failed\n",
182 priv->fifo_ptr = priv->fifo_base;
185 static void ps3vram_fire_ring(struct mtd_info *mtd)
187 struct ps3vram_priv *priv = mtd->priv;
190 mutex_lock(&ps3_gpu_mutex);
192 priv->ctrl[CTRL_PUT] = FIFO_BASE + FIFO_OFFSET +
193 (priv->fifo_ptr - priv->fifo_base) * sizeof(u32);
195 /* asking the HV for a blit will kick the fifo */
196 status = lv1_gpu_context_attribute(priv->context_handle,
197 L1GPU_CONTEXT_ATTRIBUTE_FB_BLIT,
200 dev_err(priv->dev, "%s:%d: lv1_gpu_context_attribute failed\n",
203 if ((priv->fifo_ptr - priv->fifo_base) * sizeof(u32) >
205 dev_dbg(priv->dev, "%s:%d: fifo full, rewinding\n", __func__,
207 ps3vram_wait_ring(mtd, 200);
208 ps3vram_rewind_ring(mtd);
211 mutex_unlock(&ps3_gpu_mutex);
214 static void ps3vram_bind(struct mtd_info *mtd)
216 struct ps3vram_priv *priv = mtd->priv;
218 ps3vram_begin_ring(priv, UPLOAD_SUBCH, 0, 1);
219 ps3vram_out_ring(priv, 0x31337303);
220 ps3vram_begin_ring(priv, UPLOAD_SUBCH, 0x180, 3);
221 ps3vram_out_ring(priv, DMA_NOTIFIER_HANDLE_BASE + NOTIFIER);
222 ps3vram_out_ring(priv, 0xfeed0001); /* DMA system RAM instance */
223 ps3vram_out_ring(priv, 0xfeed0000); /* DMA video RAM instance */
225 ps3vram_begin_ring(priv, DOWNLOAD_SUBCH, 0, 1);
226 ps3vram_out_ring(priv, 0x3137c0de);
227 ps3vram_begin_ring(priv, DOWNLOAD_SUBCH, 0x180, 3);
228 ps3vram_out_ring(priv, DMA_NOTIFIER_HANDLE_BASE + NOTIFIER);
229 ps3vram_out_ring(priv, 0xfeed0000); /* DMA video RAM instance */
230 ps3vram_out_ring(priv, 0xfeed0001); /* DMA system RAM instance */
232 ps3vram_fire_ring(mtd);
235 static int ps3vram_upload(struct mtd_info *mtd, unsigned int src_offset,
236 unsigned int dst_offset, int len, int count)
238 struct ps3vram_priv *priv = mtd->priv;
240 ps3vram_begin_ring(priv, UPLOAD_SUBCH,
241 NV_MEMORY_TO_MEMORY_FORMAT_OFFSET_IN, 8);
242 ps3vram_out_ring(priv, XDR_IOIF + src_offset);
243 ps3vram_out_ring(priv, dst_offset);
244 ps3vram_out_ring(priv, len);
245 ps3vram_out_ring(priv, len);
246 ps3vram_out_ring(priv, len);
247 ps3vram_out_ring(priv, count);
248 ps3vram_out_ring(priv, (1 << 8) | 1);
249 ps3vram_out_ring(priv, 0);
251 ps3vram_notifier_reset(mtd);
252 ps3vram_begin_ring(priv, UPLOAD_SUBCH,
253 NV_MEMORY_TO_MEMORY_FORMAT_NOTIFY, 1);
254 ps3vram_out_ring(priv, 0);
255 ps3vram_begin_ring(priv, UPLOAD_SUBCH, 0x100, 1);
256 ps3vram_out_ring(priv, 0);
257 ps3vram_fire_ring(mtd);
258 if (ps3vram_notifier_wait(mtd, 200) < 0) {
259 dev_dbg(priv->dev, "%s:%d: notifier timeout\n", __func__,
267 static int ps3vram_download(struct mtd_info *mtd, unsigned int src_offset,
268 unsigned int dst_offset, int len, int count)
270 struct ps3vram_priv *priv = mtd->priv;
272 ps3vram_begin_ring(priv, DOWNLOAD_SUBCH,
273 NV_MEMORY_TO_MEMORY_FORMAT_OFFSET_IN, 8);
274 ps3vram_out_ring(priv, src_offset);
275 ps3vram_out_ring(priv, XDR_IOIF + dst_offset);
276 ps3vram_out_ring(priv, len);
277 ps3vram_out_ring(priv, len);
278 ps3vram_out_ring(priv, len);
279 ps3vram_out_ring(priv, count);
280 ps3vram_out_ring(priv, (1 << 8) | 1);
281 ps3vram_out_ring(priv, 0);
283 ps3vram_notifier_reset(mtd);
284 ps3vram_begin_ring(priv, DOWNLOAD_SUBCH,
285 NV_MEMORY_TO_MEMORY_FORMAT_NOTIFY, 1);
286 ps3vram_out_ring(priv, 0);
287 ps3vram_begin_ring(priv, DOWNLOAD_SUBCH, 0x100, 1);
288 ps3vram_out_ring(priv, 0);
289 ps3vram_fire_ring(mtd);
290 if (ps3vram_notifier_wait(mtd, 200) < 0) {
291 dev_dbg(priv->dev, "%s:%d: notifier timeout\n", __func__,
299 static void ps3vram_cache_evict(struct mtd_info *mtd, int entry)
301 struct ps3vram_priv *priv = mtd->priv;
302 struct ps3vram_cache *cache = &priv->cache;
304 if (cache->tags[entry].flags & CACHE_PAGE_DIRTY) {
305 dev_dbg(priv->dev, "%s:%d: flushing %d : 0x%08x\n", __func__,
306 __LINE__, entry, cache->tags[entry].address);
307 if (ps3vram_upload(mtd,
308 CACHE_OFFSET + entry * cache->page_size,
309 cache->tags[entry].address,
311 cache->page_size / DMA_PAGE_SIZE) < 0) {
312 dev_dbg(priv->dev, "%s:%d: failed to upload from "
313 "0x%x to 0x%x size 0x%x\n", __func__, __LINE__,
314 entry * cache->page_size,
315 cache->tags[entry].address, cache->page_size);
317 cache->tags[entry].flags &= ~CACHE_PAGE_DIRTY;
321 static void ps3vram_cache_load(struct mtd_info *mtd, int entry,
322 unsigned int address)
324 struct ps3vram_priv *priv = mtd->priv;
325 struct ps3vram_cache *cache = &priv->cache;
327 dev_dbg(priv->dev, "%s:%d: fetching %d : 0x%08x\n", __func__, __LINE__,
329 if (ps3vram_download(mtd,
331 CACHE_OFFSET + entry * cache->page_size,
333 cache->page_size / DMA_PAGE_SIZE) < 0) {
334 dev_err(priv->dev, "%s:%d: failed to download from "
335 "0x%x to 0x%x size 0x%x\n", __func__, __LINE__, address,
336 entry * cache->page_size, cache->page_size);
339 cache->tags[entry].address = address;
340 cache->tags[entry].flags |= CACHE_PAGE_PRESENT;
344 static void ps3vram_cache_flush(struct mtd_info *mtd)
346 struct ps3vram_priv *priv = mtd->priv;
347 struct ps3vram_cache *cache = &priv->cache;
350 dev_dbg(priv->dev, "%s:%d: FLUSH\n", __func__, __LINE__);
351 for (i = 0; i < cache->page_count; i++) {
352 ps3vram_cache_evict(mtd, i);
353 cache->tags[i].flags = 0;
357 static unsigned int ps3vram_cache_match(struct mtd_info *mtd, loff_t address)
359 struct ps3vram_priv *priv = mtd->priv;
360 struct ps3vram_cache *cache = &priv->cache;
366 offset = (unsigned int) (address & (cache->page_size - 1));
367 base = (unsigned int) (address - offset);
369 /* fully associative check */
370 for (i = 0; i < cache->page_count; i++) {
371 if ((cache->tags[i].flags & CACHE_PAGE_PRESENT) &&
372 cache->tags[i].address == base) {
373 dev_dbg(priv->dev, "%s:%d: found entry %d : 0x%08x\n",
374 __func__, __LINE__, i, cache->tags[i].address);
379 /* choose a random entry */
380 i = (jiffies + (counter++)) % cache->page_count;
381 dev_dbg(priv->dev, "%s:%d: using entry %d\n", __func__, __LINE__, i);
383 ps3vram_cache_evict(mtd, i);
384 ps3vram_cache_load(mtd, i, base);
389 static int ps3vram_cache_init(struct mtd_info *mtd)
391 struct ps3vram_priv *priv = mtd->priv;
393 priv->cache.page_count = CACHE_PAGE_COUNT;
394 priv->cache.page_size = CACHE_PAGE_SIZE;
395 priv->cache.tags = kzalloc(sizeof(struct ps3vram_tag) *
396 CACHE_PAGE_COUNT, GFP_KERNEL);
397 if (priv->cache.tags == NULL) {
398 dev_err(priv->dev, "%s:%d: could not allocate cache tags\n",
403 dev_info(priv->dev, "created ram cache: %d entries, %d KiB each\n",
404 CACHE_PAGE_COUNT, CACHE_PAGE_SIZE / 1024);
409 static void ps3vram_cache_cleanup(struct mtd_info *mtd)
411 struct ps3vram_priv *priv = mtd->priv;
413 ps3vram_cache_flush(mtd);
414 kfree(priv->cache.tags);
417 static int ps3vram_erase(struct mtd_info *mtd, struct erase_info *instr)
419 struct ps3vram_priv *priv = mtd->priv;
421 if (instr->addr + instr->len > mtd->size)
424 mutex_lock(&priv->lock);
426 ps3vram_cache_flush(mtd);
428 /* Set bytes to 0xFF */
429 memset_io(priv->ddr_base + instr->addr, 0xFF, instr->len);
431 mutex_unlock(&priv->lock);
433 instr->state = MTD_ERASE_DONE;
434 mtd_erase_callback(instr);
439 static int ps3vram_read(struct mtd_info *mtd, loff_t from, size_t len,
440 size_t *retlen, u_char *buf)
442 struct ps3vram_priv *priv = mtd->priv;
443 unsigned int cached, count;
445 dev_dbg(priv->dev, "%s:%d: from=0x%08x len=0x%zx\n", __func__, __LINE__,
446 (unsigned int)from, len);
448 if (from >= mtd->size)
451 if (len > mtd->size - from)
452 len = mtd->size - from;
454 /* Copy from vram to buf */
457 unsigned int offset, avail;
460 offset = (unsigned int) (from & (priv->cache.page_size - 1));
461 avail = priv->cache.page_size - offset;
463 mutex_lock(&priv->lock);
465 entry = ps3vram_cache_match(mtd, from);
466 cached = CACHE_OFFSET + entry * priv->cache.page_size + offset;
468 dev_dbg(priv->dev, "%s:%d: from=%08x cached=%08x offset=%08x "
469 "avail=%08x count=%08x\n", __func__, __LINE__,
470 (unsigned int)from, cached, offset, avail, count);
474 memcpy(buf, priv->xdr_buf + cached, avail);
476 mutex_unlock(&priv->lock);
487 static int ps3vram_write(struct mtd_info *mtd, loff_t to, size_t len,
488 size_t *retlen, const u_char *buf)
490 struct ps3vram_priv *priv = mtd->priv;
491 unsigned int cached, count;
496 if (len > mtd->size - to)
497 len = mtd->size - to;
499 /* Copy from buf to vram */
502 unsigned int offset, avail;
505 offset = (unsigned int) (to & (priv->cache.page_size - 1));
506 avail = priv->cache.page_size - offset;
508 mutex_lock(&priv->lock);
510 entry = ps3vram_cache_match(mtd, to);
511 cached = CACHE_OFFSET + entry * priv->cache.page_size + offset;
513 dev_dbg(priv->dev, "%s:%d: to=%08x cached=%08x offset=%08x "
514 "avail=%08x count=%08x\n", __func__, __LINE__,
515 (unsigned int)to, cached, offset, avail, count);
519 memcpy(priv->xdr_buf + cached, buf, avail);
521 priv->cache.tags[entry].flags |= CACHE_PAGE_DIRTY;
523 mutex_unlock(&priv->lock);
534 static int __devinit ps3vram_probe(struct ps3_system_bus_device *dev)
536 struct ps3vram_priv *priv;
548 ps3vram_mtd.priv = kzalloc(sizeof(struct ps3vram_priv), GFP_KERNEL);
549 if (!ps3vram_mtd.priv)
551 priv = ps3vram_mtd.priv;
553 mutex_init(&priv->lock);
554 priv->dev = &dev->core;
556 /* Allocate XDR buffer (1MiB aligned) */
557 priv->xdr_buf = (void *)__get_free_pages(GFP_KERNEL,
558 get_order(XDR_BUF_SIZE));
559 if (priv->xdr_buf == NULL) {
560 dev_dbg(&dev->core, "%s:%d: could not allocate XDR buffer\n",
566 /* Put FIFO at begginning of XDR buffer */
567 priv->fifo_base = (u32 *) (priv->xdr_buf + FIFO_OFFSET);
568 priv->fifo_ptr = priv->fifo_base;
570 /* XXX: Need to open GPU, in case ps3fb or snd_ps3 aren't loaded */
571 if (ps3_open_hv_device(dev)) {
572 dev_err(&dev->core, "%s:%d: ps3_open_hv_device failed\n",
580 ddr_size = memparse(size, &rest);
582 ddr_size -= ps3fb_videomemory.size;
583 ddr_size = ALIGN(ddr_size, 1024*1024);
585 dev_err(&dev->core, "%s:%d: specified size is too small\n",
591 while (ddr_size > 0) {
592 status = lv1_gpu_memory_allocate(ddr_size, 0, 0, 0, 0,
593 &priv->memory_handle,
597 ddr_size -= 1024*1024;
599 if (status || ddr_size <= 0) {
600 dev_err(&dev->core, "%s:%d: lv1_gpu_memory_allocate failed\n",
603 goto out_free_xdr_buf;
606 /* Request context */
607 status = lv1_gpu_context_allocate(priv->memory_handle,
609 &priv->context_handle,
615 dev_err(&dev->core, "%s:%d: lv1_gpu_context_allocate failed\n",
618 goto out_free_memory;
621 /* Map XDR buffer to RSX */
622 status = lv1_gpu_context_iomap(priv->context_handle, XDR_IOIF,
623 ps3_mm_phys_to_lpar(__pa(priv->xdr_buf)),
626 dev_err(&dev->core, "%s:%d: lv1_gpu_context_iomap failed\n",
629 goto out_free_context;
632 priv->ddr_base = ioremap_flags(ddr_lpar, ddr_size, _PAGE_NO_CACHE);
634 if (!priv->ddr_base) {
635 dev_err(&dev->core, "%s:%d: ioremap failed\n", __func__,
638 goto out_free_context;
641 priv->ctrl = ioremap(ctrl_lpar, 64 * 1024);
643 dev_err(&dev->core, "%s:%d: ioremap failed\n", __func__,
649 priv->reports = ioremap(reports_lpar, reports_size);
650 if (!priv->reports) {
651 dev_err(&dev->core, "%s:%d: ioremap failed\n", __func__,
657 mutex_lock(&ps3_gpu_mutex);
658 ps3vram_init_ring(&ps3vram_mtd);
659 mutex_unlock(&ps3_gpu_mutex);
661 ps3vram_mtd.name = "ps3vram";
662 ps3vram_mtd.size = ddr_size;
663 ps3vram_mtd.flags = MTD_CAP_RAM;
664 ps3vram_mtd.erase = ps3vram_erase;
665 ps3vram_mtd.point = NULL;
666 ps3vram_mtd.unpoint = NULL;
667 ps3vram_mtd.read = ps3vram_read;
668 ps3vram_mtd.write = ps3vram_write;
669 ps3vram_mtd.owner = THIS_MODULE;
670 ps3vram_mtd.type = MTD_RAM;
671 ps3vram_mtd.erasesize = CACHE_PAGE_SIZE;
672 ps3vram_mtd.writesize = 1;
674 ps3vram_bind(&ps3vram_mtd);
676 mutex_lock(&ps3_gpu_mutex);
677 ret = ps3vram_wait_ring(&ps3vram_mtd, 100);
678 mutex_unlock(&ps3_gpu_mutex);
680 dev_err(&dev->core, "%s:%d: failed to initialize channels\n",
683 goto out_unmap_reports;
686 ps3vram_cache_init(&ps3vram_mtd);
688 if (add_mtd_device(&ps3vram_mtd)) {
689 dev_err(&dev->core, "%s:%d: add_mtd_device failed\n",
692 goto out_cache_cleanup;
695 dev_info(&dev->core, "reserved %u MiB of gpu memory\n",
696 (unsigned int)(ddr_size / 1024 / 1024));
701 ps3vram_cache_cleanup(&ps3vram_mtd);
703 iounmap(priv->reports);
707 iounmap(priv->ddr_base);
709 lv1_gpu_context_free(priv->context_handle);
711 lv1_gpu_memory_free(priv->memory_handle);
713 ps3_close_hv_device(dev);
715 free_pages((unsigned long) priv->xdr_buf, get_order(XDR_BUF_SIZE));
717 kfree(ps3vram_mtd.priv);
718 ps3vram_mtd.priv = NULL;
723 static int ps3vram_shutdown(struct ps3_system_bus_device *dev)
725 struct ps3vram_priv *priv;
727 priv = ps3vram_mtd.priv;
729 del_mtd_device(&ps3vram_mtd);
730 ps3vram_cache_cleanup(&ps3vram_mtd);
731 iounmap(priv->reports);
733 iounmap(priv->ddr_base);
734 lv1_gpu_context_free(priv->context_handle);
735 lv1_gpu_memory_free(priv->memory_handle);
736 ps3_close_hv_device(dev);
737 free_pages((unsigned long) priv->xdr_buf, get_order(XDR_BUF_SIZE));
742 static struct ps3_system_bus_driver ps3vram_driver = {
743 .match_id = PS3_MATCH_ID_GPU,
744 .match_sub_id = PS3_MATCH_SUB_ID_GPU_RAMDISK,
745 .core.name = DEVICE_NAME,
746 .core.owner = THIS_MODULE,
747 .probe = ps3vram_probe,
748 .remove = ps3vram_shutdown,
749 .shutdown = ps3vram_shutdown,
752 static int __init ps3vram_init(void)
754 return ps3_system_bus_driver_register(&ps3vram_driver);
757 static void __exit ps3vram_exit(void)
759 ps3_system_bus_driver_unregister(&ps3vram_driver);
762 module_init(ps3vram_init);
763 module_exit(ps3vram_exit);
765 MODULE_LICENSE("GPL");
766 MODULE_AUTHOR("Jim Paris <jim@jtan.com>");
767 MODULE_DESCRIPTION("MTD driver for PS3 video RAM");
768 MODULE_ALIAS(PS3_MODULE_ALIAS_GPU_RAMDISK);