2 * PS3 device registration routines.
4 * Copyright (C) 2007 Sony Computer Entertainment Inc.
5 * Copyright 2007 Sony Corp.
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; version 2 of the License.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 #include <linux/delay.h>
22 #include <linux/freezer.h>
23 #include <linux/kernel.h>
24 #include <linux/kthread.h>
25 #include <linux/init.h>
26 #include <linux/reboot.h>
28 #include <asm/firmware.h>
29 #include <asm/lv1call.h>
30 #include <asm/ps3stor.h>
34 static int __init ps3_register_lpm_devices(void)
39 struct ps3_system_bus_device *dev;
41 pr_debug(" -> %s:%d\n", __func__, __LINE__);
43 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
47 dev->match_id = PS3_MATCH_ID_LPM;
48 dev->dev_type = PS3_DEVICE_TYPE_LPM;
50 /* The current lpm driver only supports a single BE processor. */
52 result = ps3_repository_read_be_node_id(0, &dev->lpm.node_id);
55 pr_debug("%s:%d: ps3_repository_read_be_node_id failed \n",
60 result = ps3_repository_read_lpm_privileges(dev->lpm.node_id, &tmp1,
64 pr_debug("%s:%d: ps3_repository_read_lpm_privleges failed \n",
69 lv1_get_logical_partition_id(&tmp2);
72 pr_debug("%s:%d: wrong lpar\n",
78 if (!(dev->lpm.rights & PS3_LPM_RIGHTS_USE_LPM)) {
79 pr_debug("%s:%d: don't have rights to use lpm\n",
85 pr_debug("%s:%d: pu_id %llu, rights %llu(%llxh)\n",
86 __func__, __LINE__, dev->lpm.pu_id, dev->lpm.rights,
89 result = ps3_repository_read_pu_id(0, &dev->lpm.pu_id);
92 pr_debug("%s:%d: ps3_repository_read_pu_id failed \n",
97 result = ps3_system_bus_device_register(dev);
100 pr_debug("%s:%d ps3_system_bus_device_register failed\n",
105 pr_debug(" <- %s:%d\n", __func__, __LINE__);
113 pr_debug(" <- %s:%d: failed\n", __func__, __LINE__);
118 * ps3_setup_gelic_device - Setup and register a gelic device instance.
120 * Allocates memory for a struct ps3_system_bus_device instance, initialises the
121 * structure members, and registers the device instance with the system bus.
124 static int __init ps3_setup_gelic_device(
125 const struct ps3_repository_device *repo)
129 struct ps3_system_bus_device dev;
130 struct ps3_dma_region d_region;
133 pr_debug(" -> %s:%d\n", __func__, __LINE__);
135 BUG_ON(repo->bus_type != PS3_BUS_TYPE_SB);
136 BUG_ON(repo->dev_type != PS3_DEV_TYPE_SB_GELIC);
138 p = kzalloc(sizeof(struct layout), GFP_KERNEL);
145 p->dev.match_id = PS3_MATCH_ID_GELIC;
146 p->dev.dev_type = PS3_DEVICE_TYPE_SB;
147 p->dev.bus_id = repo->bus_id;
148 p->dev.dev_id = repo->dev_id;
149 p->dev.d_region = &p->d_region;
151 result = ps3_repository_find_interrupt(repo,
152 PS3_INTERRUPT_TYPE_EVENT_PORT, &p->dev.interrupt_id);
155 pr_debug("%s:%d ps3_repository_find_interrupt failed\n",
157 goto fail_find_interrupt;
160 BUG_ON(p->dev.interrupt_id != 0);
162 result = ps3_dma_region_init(&p->dev, p->dev.d_region, PS3_DMA_64K,
163 PS3_DMA_OTHER, NULL, 0);
166 pr_debug("%s:%d ps3_dma_region_init failed\n",
171 result = ps3_system_bus_device_register(&p->dev);
174 pr_debug("%s:%d ps3_system_bus_device_register failed\n",
176 goto fail_device_register;
179 pr_debug(" <- %s:%d\n", __func__, __LINE__);
182 fail_device_register:
187 pr_debug(" <- %s:%d: fail.\n", __func__, __LINE__);
191 static int __init_refok ps3_setup_uhc_device(
192 const struct ps3_repository_device *repo, enum ps3_match_id match_id,
193 enum ps3_interrupt_type interrupt_type, enum ps3_reg_type reg_type)
197 struct ps3_system_bus_device dev;
198 struct ps3_dma_region d_region;
199 struct ps3_mmio_region m_region;
204 pr_debug(" -> %s:%d\n", __func__, __LINE__);
206 BUG_ON(repo->bus_type != PS3_BUS_TYPE_SB);
207 BUG_ON(repo->dev_type != PS3_DEV_TYPE_SB_USB);
209 p = kzalloc(sizeof(struct layout), GFP_KERNEL);
216 p->dev.match_id = match_id;
217 p->dev.dev_type = PS3_DEVICE_TYPE_SB;
218 p->dev.bus_id = repo->bus_id;
219 p->dev.dev_id = repo->dev_id;
220 p->dev.d_region = &p->d_region;
221 p->dev.m_region = &p->m_region;
223 result = ps3_repository_find_interrupt(repo,
224 interrupt_type, &p->dev.interrupt_id);
227 pr_debug("%s:%d ps3_repository_find_interrupt failed\n",
229 goto fail_find_interrupt;
232 result = ps3_repository_find_reg(repo, reg_type,
236 pr_debug("%s:%d ps3_repository_find_reg failed\n",
241 result = ps3_dma_region_init(&p->dev, p->dev.d_region, PS3_DMA_64K,
242 PS3_DMA_INTERNAL, NULL, 0);
245 pr_debug("%s:%d ps3_dma_region_init failed\n",
250 result = ps3_mmio_region_init(&p->dev, p->dev.m_region, bus_addr, len,
254 pr_debug("%s:%d ps3_mmio_region_init failed\n",
259 result = ps3_system_bus_device_register(&p->dev);
262 pr_debug("%s:%d ps3_system_bus_device_register failed\n",
264 goto fail_device_register;
267 pr_debug(" <- %s:%d\n", __func__, __LINE__);
270 fail_device_register:
277 pr_debug(" <- %s:%d: fail.\n", __func__, __LINE__);
281 static int __init ps3_setup_ehci_device(
282 const struct ps3_repository_device *repo)
284 return ps3_setup_uhc_device(repo, PS3_MATCH_ID_EHCI,
285 PS3_INTERRUPT_TYPE_SB_EHCI, PS3_REG_TYPE_SB_EHCI);
288 static int __init ps3_setup_ohci_device(
289 const struct ps3_repository_device *repo)
291 return ps3_setup_uhc_device(repo, PS3_MATCH_ID_OHCI,
292 PS3_INTERRUPT_TYPE_SB_OHCI, PS3_REG_TYPE_SB_OHCI);
295 static int __init ps3_setup_vuart_device(enum ps3_match_id match_id,
296 unsigned int port_number)
300 struct ps3_system_bus_device dev;
303 pr_debug(" -> %s:%d: match_id %u, port %u\n", __func__, __LINE__,
304 match_id, port_number);
306 p = kzalloc(sizeof(struct layout), GFP_KERNEL);
311 p->dev.match_id = match_id;
312 p->dev.dev_type = PS3_DEVICE_TYPE_VUART;
313 p->dev.port_number = port_number;
315 result = ps3_system_bus_device_register(&p->dev);
318 pr_debug("%s:%d ps3_system_bus_device_register failed\n",
320 goto fail_device_register;
322 pr_debug(" <- %s:%d\n", __func__, __LINE__);
325 fail_device_register:
327 pr_debug(" <- %s:%d fail\n", __func__, __LINE__);
331 static int ps3_setup_storage_dev(const struct ps3_repository_device *repo,
332 enum ps3_match_id match_id)
335 struct ps3_storage_device *p;
336 u64 port, blk_size, num_blocks;
337 unsigned int num_regions, i;
339 pr_debug(" -> %s:%u: match_id %u\n", __func__, __LINE__, match_id);
341 result = ps3_repository_read_stor_dev_info(repo->bus_index,
342 repo->dev_index, &port,
343 &blk_size, &num_blocks,
346 printk(KERN_ERR "%s:%u: _read_stor_dev_info failed %d\n",
347 __func__, __LINE__, result);
351 pr_debug("%s:%u: (%u:%u:%u): port %llu blk_size %llu num_blocks %llu "
352 "num_regions %u\n", __func__, __LINE__, repo->bus_index,
353 repo->dev_index, repo->dev_type, port, blk_size, num_blocks,
356 p = kzalloc(sizeof(struct ps3_storage_device) +
357 num_regions * sizeof(struct ps3_storage_region),
364 p->sbd.match_id = match_id;
365 p->sbd.dev_type = PS3_DEVICE_TYPE_SB;
366 p->sbd.bus_id = repo->bus_id;
367 p->sbd.dev_id = repo->dev_id;
368 p->sbd.d_region = &p->dma_region;
369 p->blk_size = blk_size;
370 p->num_regions = num_regions;
372 result = ps3_repository_find_interrupt(repo,
373 PS3_INTERRUPT_TYPE_EVENT_PORT,
374 &p->sbd.interrupt_id);
376 printk(KERN_ERR "%s:%u: find_interrupt failed %d\n", __func__,
379 goto fail_find_interrupt;
382 for (i = 0; i < num_regions; i++) {
386 result = ps3_repository_read_stor_dev_region(repo->bus_index,
392 "%s:%u: read_stor_dev_region failed %d\n",
393 __func__, __LINE__, result);
395 goto fail_read_region;
397 pr_debug("%s:%u: region %u: id %u start %llu size %llu\n",
398 __func__, __LINE__, i, id, start, size);
400 p->regions[i].id = id;
401 p->regions[i].start = start;
402 p->regions[i].size = size;
405 result = ps3_system_bus_device_register(&p->sbd);
407 pr_debug("%s:%u ps3_system_bus_device_register failed\n",
409 goto fail_device_register;
412 pr_debug(" <- %s:%u\n", __func__, __LINE__);
415 fail_device_register:
420 pr_debug(" <- %s:%u: fail.\n", __func__, __LINE__);
424 static int __init ps3_register_vuart_devices(void)
427 unsigned int port_number;
429 pr_debug(" -> %s:%d\n", __func__, __LINE__);
431 result = ps3_repository_read_vuart_av_port(&port_number);
433 port_number = 0; /* av default */
435 result = ps3_setup_vuart_device(PS3_MATCH_ID_AV_SETTINGS, port_number);
438 result = ps3_repository_read_vuart_sysmgr_port(&port_number);
440 port_number = 2; /* sysmgr default */
442 result = ps3_setup_vuart_device(PS3_MATCH_ID_SYSTEM_MANAGER,
446 pr_debug(" <- %s:%d\n", __func__, __LINE__);
450 static int __init ps3_register_sound_devices(void)
454 struct ps3_system_bus_device dev;
455 struct ps3_dma_region d_region;
456 struct ps3_mmio_region m_region;
459 pr_debug(" -> %s:%d\n", __func__, __LINE__);
461 p = kzalloc(sizeof(*p), GFP_KERNEL);
465 p->dev.match_id = PS3_MATCH_ID_SOUND;
466 p->dev.dev_type = PS3_DEVICE_TYPE_IOC0;
467 p->dev.d_region = &p->d_region;
468 p->dev.m_region = &p->m_region;
470 result = ps3_system_bus_device_register(&p->dev);
473 pr_debug("%s:%d ps3_system_bus_device_register failed\n",
475 goto fail_device_register;
477 pr_debug(" <- %s:%d\n", __func__, __LINE__);
480 fail_device_register:
482 pr_debug(" <- %s:%d failed\n", __func__, __LINE__);
486 static int __init ps3_register_graphics_devices(void)
490 struct ps3_system_bus_device dev;
493 pr_debug(" -> %s:%d\n", __func__, __LINE__);
495 p = kzalloc(sizeof(struct layout), GFP_KERNEL);
500 p->dev.match_id = PS3_MATCH_ID_GPU;
501 p->dev.match_sub_id = PS3_MATCH_SUB_ID_GPU_FB;
502 p->dev.dev_type = PS3_DEVICE_TYPE_IOC0;
504 result = ps3_system_bus_device_register(&p->dev);
507 pr_debug("%s:%d ps3_system_bus_device_register failed\n",
509 goto fail_device_register;
512 pr_debug(" <- %s:%d\n", __func__, __LINE__);
515 fail_device_register:
517 pr_debug(" <- %s:%d failed\n", __func__, __LINE__);
521 static int __init ps3_register_ramdisk_device(void)
525 struct ps3_system_bus_device dev;
528 pr_debug(" -> %s:%d\n", __func__, __LINE__);
530 p = kzalloc(sizeof(struct layout), GFP_KERNEL);
535 p->dev.match_id = PS3_MATCH_ID_GPU;
536 p->dev.match_sub_id = PS3_MATCH_SUB_ID_GPU_RAMDISK;
537 p->dev.dev_type = PS3_DEVICE_TYPE_IOC0;
539 result = ps3_system_bus_device_register(&p->dev);
542 pr_debug("%s:%d ps3_system_bus_device_register failed\n",
544 goto fail_device_register;
547 pr_debug(" <- %s:%d\n", __func__, __LINE__);
550 fail_device_register:
552 pr_debug(" <- %s:%d failed\n", __func__, __LINE__);
557 * ps3_setup_dynamic_device - Setup a dynamic device from the repository
560 static int ps3_setup_dynamic_device(const struct ps3_repository_device *repo)
564 switch (repo->dev_type) {
565 case PS3_DEV_TYPE_STOR_DISK:
566 result = ps3_setup_storage_dev(repo, PS3_MATCH_ID_STOR_DISK);
568 /* Some devices are not accessable from the Other OS lpar. */
569 if (result == -ENODEV) {
571 pr_debug("%s:%u: not accessable\n", __func__,
576 pr_debug("%s:%u ps3_setup_storage_dev failed\n",
580 case PS3_DEV_TYPE_STOR_ROM:
581 result = ps3_setup_storage_dev(repo, PS3_MATCH_ID_STOR_ROM);
583 pr_debug("%s:%u ps3_setup_storage_dev failed\n",
587 case PS3_DEV_TYPE_STOR_FLASH:
588 result = ps3_setup_storage_dev(repo, PS3_MATCH_ID_STOR_FLASH);
590 pr_debug("%s:%u ps3_setup_storage_dev failed\n",
596 pr_debug("%s:%u: unsupported dev_type %u\n", __func__, __LINE__,
604 * ps3_setup_static_device - Setup a static device from the repository
607 static int __init ps3_setup_static_device(const struct ps3_repository_device *repo)
611 switch (repo->dev_type) {
612 case PS3_DEV_TYPE_SB_GELIC:
613 result = ps3_setup_gelic_device(repo);
615 pr_debug("%s:%d ps3_setup_gelic_device failed\n",
619 case PS3_DEV_TYPE_SB_USB:
621 /* Each USB device has both an EHCI and an OHCI HC */
623 result = ps3_setup_ehci_device(repo);
626 pr_debug("%s:%d ps3_setup_ehci_device failed\n",
630 result = ps3_setup_ohci_device(repo);
633 pr_debug("%s:%d ps3_setup_ohci_device failed\n",
639 return ps3_setup_dynamic_device(repo);
645 static void ps3_find_and_add_device(u64 bus_id, u64 dev_id)
647 struct ps3_repository_device repo;
649 unsigned int retries;
653 * On some firmware versions (e.g. 1.90), the device may not show up
654 * in the repository immediately
656 for (retries = 0; retries < 10; retries++) {
657 res = ps3_repository_find_device_by_id(&repo, bus_id, dev_id);
661 rem = msleep_interruptible(100);
665 pr_warning("%s:%u: device %llu:%llu not found\n", __func__, __LINE__,
671 pr_debug("%s:%u: device %llu:%llu found after %u retries\n",
672 __func__, __LINE__, bus_id, dev_id, retries);
674 ps3_setup_dynamic_device(&repo);
678 #define PS3_NOTIFICATION_DEV_ID ULONG_MAX
679 #define PS3_NOTIFICATION_INTERRUPT_ID 0
681 struct ps3_notification_device {
682 struct ps3_system_bus_device sbd;
686 struct completion done;
689 enum ps3_notify_type {
690 notify_device_ready = 0,
691 notify_region_probe = 1,
692 notify_region_update = 2,
695 struct ps3_notify_cmd {
696 u64 operation_code; /* must be zero */
697 u64 event_mask; /* OR of 1UL << enum ps3_notify_type */
700 struct ps3_notify_event {
701 u64 event_type; /* enum ps3_notify_type */
708 static irqreturn_t ps3_notification_interrupt(int irq, void *data)
710 struct ps3_notification_device *dev = data;
714 spin_lock(&dev->lock);
715 res = lv1_storage_get_async_status(PS3_NOTIFICATION_DEV_ID, &tag,
718 pr_err("%s:%u: tag mismatch, got %llx, expected %llx\n",
719 __func__, __LINE__, tag, dev->tag);
722 pr_err("%s:%u: res %d status 0x%llx\n", __func__, __LINE__, res,
725 pr_debug("%s:%u: completed, status 0x%llx\n", __func__,
727 dev->lv1_status = status;
728 complete(&dev->done);
730 spin_unlock(&dev->lock);
734 static int ps3_notification_read_write(struct ps3_notification_device *dev,
737 const char *op = write ? "write" : "read";
741 init_completion(&dev->done);
742 spin_lock_irqsave(&dev->lock, flags);
743 res = write ? lv1_storage_write(dev->sbd.dev_id, 0, 0, 1, 0, lpar,
745 : lv1_storage_read(dev->sbd.dev_id, 0, 0, 1, 0, lpar,
747 spin_unlock_irqrestore(&dev->lock, flags);
749 pr_err("%s:%u: %s failed %d\n", __func__, __LINE__, op, res);
752 pr_debug("%s:%u: notification %s issued\n", __func__, __LINE__, op);
754 res = wait_event_interruptible(dev->done.wait,
755 dev->done.done || kthread_should_stop());
756 if (kthread_should_stop())
759 pr_debug("%s:%u: interrupted %s\n", __func__, __LINE__, op);
763 if (dev->lv1_status) {
764 pr_err("%s:%u: %s not completed, status 0x%llx\n", __func__,
765 __LINE__, op, dev->lv1_status);
768 pr_debug("%s:%u: notification %s completed\n", __func__, __LINE__, op);
773 static struct task_struct *probe_task;
776 * ps3_probe_thread - Background repository probing at system startup.
778 * This implementation only supports background probing on a single bus.
779 * It uses the hypervisor's storage device notification mechanism to wait until
780 * a storage device is ready. The device notification mechanism uses a
781 * pseudo device to asynchronously notify the guest when storage devices become
782 * ready. The notification device has a block size of 512 bytes.
785 static int ps3_probe_thread(void *data)
787 struct ps3_notification_device dev;
792 struct ps3_notify_cmd *notify_cmd;
793 struct ps3_notify_event *notify_event;
795 pr_debug(" -> %s:%u: kthread started\n", __func__, __LINE__);
797 buf = kzalloc(512, GFP_KERNEL);
801 lpar = ps3_mm_phys_to_lpar(__pa(buf));
805 /* dummy system bus device */
806 dev.sbd.bus_id = (u64)data;
807 dev.sbd.dev_id = PS3_NOTIFICATION_DEV_ID;
808 dev.sbd.interrupt_id = PS3_NOTIFICATION_INTERRUPT_ID;
810 res = lv1_open_device(dev.sbd.bus_id, dev.sbd.dev_id, 0);
812 pr_err("%s:%u: lv1_open_device failed %s\n", __func__,
813 __LINE__, ps3_result(res));
817 res = ps3_sb_event_receive_port_setup(&dev.sbd, PS3_BINDING_CPU_ANY,
820 pr_err("%s:%u: ps3_sb_event_receive_port_setup failed %d\n",
821 __func__, __LINE__, res);
822 goto fail_close_device;
825 spin_lock_init(&dev.lock);
827 res = request_irq(irq, ps3_notification_interrupt, IRQF_DISABLED,
828 "ps3_notification", &dev);
830 pr_err("%s:%u: request_irq failed %d\n", __func__, __LINE__,
832 goto fail_sb_event_receive_port_destroy;
835 /* Setup and write the request for device notification. */
836 notify_cmd->operation_code = 0; /* must be zero */
837 notify_cmd->event_mask = 1UL << notify_region_probe;
839 res = ps3_notification_read_write(&dev, lpar, 1);
843 /* Loop here processing the requested notification events. */
847 memset(notify_event, 0, sizeof(*notify_event));
849 res = ps3_notification_read_write(&dev, lpar, 0);
853 pr_debug("%s:%u: notify event type 0x%llx bus id %llu dev id %llu"
854 " type %llu port %llu\n", __func__, __LINE__,
855 notify_event->event_type, notify_event->bus_id,
856 notify_event->dev_id, notify_event->dev_type,
857 notify_event->dev_port);
859 if (notify_event->event_type != notify_region_probe ||
860 notify_event->bus_id != dev.sbd.bus_id) {
861 pr_warning("%s:%u: bad notify_event: event %llu, "
862 "dev_id %llu, dev_type %llu\n",
863 __func__, __LINE__, notify_event->event_type,
864 notify_event->dev_id,
865 notify_event->dev_type);
869 ps3_find_and_add_device(dev.sbd.bus_id, notify_event->dev_id);
871 } while (!kthread_should_stop());
875 fail_sb_event_receive_port_destroy:
876 ps3_sb_event_receive_port_destroy(&dev.sbd, irq);
878 lv1_close_device(dev.sbd.bus_id, dev.sbd.dev_id);
884 pr_debug(" <- %s:%u: kthread finished\n", __func__, __LINE__);
890 * ps3_stop_probe_thread - Stops the background probe thread.
894 static int ps3_stop_probe_thread(struct notifier_block *nb, unsigned long code,
898 kthread_stop(probe_task);
902 static struct notifier_block nb = {
903 .notifier_call = ps3_stop_probe_thread
907 * ps3_start_probe_thread - Starts the background probe thread.
911 static int __init ps3_start_probe_thread(enum ps3_bus_type bus_type)
914 struct task_struct *task;
915 struct ps3_repository_device repo;
917 pr_debug(" -> %s:%d\n", __func__, __LINE__);
919 memset(&repo, 0, sizeof(repo));
921 repo.bus_type = bus_type;
923 result = ps3_repository_find_bus(repo.bus_type, 0, &repo.bus_index);
926 printk(KERN_ERR "%s: Cannot find bus (%d)\n", __func__, result);
930 result = ps3_repository_read_bus_id(repo.bus_index, &repo.bus_id);
933 printk(KERN_ERR "%s: read_bus_id failed %d\n", __func__,
938 task = kthread_run(ps3_probe_thread, (void *)repo.bus_id,
939 "ps3-probe-%u", bus_type);
942 result = PTR_ERR(task);
943 printk(KERN_ERR "%s: kthread_run failed %d\n", __func__,
949 register_reboot_notifier(&nb);
951 pr_debug(" <- %s:%d\n", __func__, __LINE__);
956 * ps3_register_devices - Probe the system and register devices found.
958 * A device_initcall() routine.
961 static int __init ps3_register_devices(void)
965 if (!firmware_has_feature(FW_FEATURE_PS3_LV1))
968 pr_debug(" -> %s:%d\n", __func__, __LINE__);
970 /* ps3_repository_dump_bus_info(); */
972 result = ps3_start_probe_thread(PS3_BUS_TYPE_STORAGE);
974 ps3_register_vuart_devices();
976 ps3_register_graphics_devices();
978 ps3_repository_find_devices(PS3_BUS_TYPE_SB, ps3_setup_static_device);
980 ps3_register_sound_devices();
982 ps3_register_lpm_devices();
984 ps3_register_ramdisk_device();
986 pr_debug(" <- %s:%d\n", __func__, __LINE__);
990 device_initcall(ps3_register_devices);