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/slab.h>
27 #include <linux/reboot.h>
29 #include <asm/firmware.h>
30 #include <asm/lv1call.h>
31 #include <asm/ps3stor.h>
35 static int __init ps3_register_lpm_devices(void)
40 struct ps3_system_bus_device *dev;
42 pr_debug(" -> %s:%d\n", __func__, __LINE__);
44 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
48 dev->match_id = PS3_MATCH_ID_LPM;
49 dev->dev_type = PS3_DEVICE_TYPE_LPM;
51 /* The current lpm driver only supports a single BE processor. */
53 result = ps3_repository_read_be_node_id(0, &dev->lpm.node_id);
56 pr_debug("%s:%d: ps3_repository_read_be_node_id failed \n",
61 result = ps3_repository_read_lpm_privileges(dev->lpm.node_id, &tmp1,
65 pr_debug("%s:%d: ps3_repository_read_lpm_privileges failed\n",
70 lv1_get_logical_partition_id(&tmp2);
73 pr_debug("%s:%d: wrong lpar\n",
79 if (!(dev->lpm.rights & PS3_LPM_RIGHTS_USE_LPM)) {
80 pr_debug("%s:%d: don't have rights to use lpm\n",
86 pr_debug("%s:%d: pu_id %llu, rights %llu(%llxh)\n",
87 __func__, __LINE__, dev->lpm.pu_id, dev->lpm.rights,
90 result = ps3_repository_read_pu_id(0, &dev->lpm.pu_id);
93 pr_debug("%s:%d: ps3_repository_read_pu_id failed \n",
98 result = ps3_system_bus_device_register(dev);
101 pr_debug("%s:%d ps3_system_bus_device_register failed\n",
106 pr_debug(" <- %s:%d\n", __func__, __LINE__);
114 pr_debug(" <- %s:%d: failed\n", __func__, __LINE__);
119 * ps3_setup_gelic_device - Setup and register a gelic device instance.
121 * Allocates memory for a struct ps3_system_bus_device instance, initialises the
122 * structure members, and registers the device instance with the system bus.
125 static int __init ps3_setup_gelic_device(
126 const struct ps3_repository_device *repo)
130 struct ps3_system_bus_device dev;
131 struct ps3_dma_region d_region;
134 pr_debug(" -> %s:%d\n", __func__, __LINE__);
136 BUG_ON(repo->bus_type != PS3_BUS_TYPE_SB);
137 BUG_ON(repo->dev_type != PS3_DEV_TYPE_SB_GELIC);
139 p = kzalloc(sizeof(struct layout), GFP_KERNEL);
146 p->dev.match_id = PS3_MATCH_ID_GELIC;
147 p->dev.dev_type = PS3_DEVICE_TYPE_SB;
148 p->dev.bus_id = repo->bus_id;
149 p->dev.dev_id = repo->dev_id;
150 p->dev.d_region = &p->d_region;
152 result = ps3_repository_find_interrupt(repo,
153 PS3_INTERRUPT_TYPE_EVENT_PORT, &p->dev.interrupt_id);
156 pr_debug("%s:%d ps3_repository_find_interrupt failed\n",
158 goto fail_find_interrupt;
161 BUG_ON(p->dev.interrupt_id != 0);
163 result = ps3_dma_region_init(&p->dev, p->dev.d_region, PS3_DMA_64K,
164 PS3_DMA_OTHER, NULL, 0);
167 pr_debug("%s:%d ps3_dma_region_init failed\n",
172 result = ps3_system_bus_device_register(&p->dev);
175 pr_debug("%s:%d ps3_system_bus_device_register failed\n",
177 goto fail_device_register;
180 pr_debug(" <- %s:%d\n", __func__, __LINE__);
183 fail_device_register:
188 pr_debug(" <- %s:%d: fail.\n", __func__, __LINE__);
192 static int __ref ps3_setup_uhc_device(
193 const struct ps3_repository_device *repo, enum ps3_match_id match_id,
194 enum ps3_interrupt_type interrupt_type, enum ps3_reg_type reg_type)
198 struct ps3_system_bus_device dev;
199 struct ps3_dma_region d_region;
200 struct ps3_mmio_region m_region;
205 pr_debug(" -> %s:%d\n", __func__, __LINE__);
207 BUG_ON(repo->bus_type != PS3_BUS_TYPE_SB);
208 BUG_ON(repo->dev_type != PS3_DEV_TYPE_SB_USB);
210 p = kzalloc(sizeof(struct layout), GFP_KERNEL);
217 p->dev.match_id = match_id;
218 p->dev.dev_type = PS3_DEVICE_TYPE_SB;
219 p->dev.bus_id = repo->bus_id;
220 p->dev.dev_id = repo->dev_id;
221 p->dev.d_region = &p->d_region;
222 p->dev.m_region = &p->m_region;
224 result = ps3_repository_find_interrupt(repo,
225 interrupt_type, &p->dev.interrupt_id);
228 pr_debug("%s:%d ps3_repository_find_interrupt failed\n",
230 goto fail_find_interrupt;
233 result = ps3_repository_find_reg(repo, reg_type,
237 pr_debug("%s:%d ps3_repository_find_reg failed\n",
242 result = ps3_dma_region_init(&p->dev, p->dev.d_region, PS3_DMA_64K,
243 PS3_DMA_INTERNAL, NULL, 0);
246 pr_debug("%s:%d ps3_dma_region_init failed\n",
251 result = ps3_mmio_region_init(&p->dev, p->dev.m_region, bus_addr, len,
255 pr_debug("%s:%d ps3_mmio_region_init failed\n",
260 result = ps3_system_bus_device_register(&p->dev);
263 pr_debug("%s:%d ps3_system_bus_device_register failed\n",
265 goto fail_device_register;
268 pr_debug(" <- %s:%d\n", __func__, __LINE__);
271 fail_device_register:
278 pr_debug(" <- %s:%d: fail.\n", __func__, __LINE__);
282 static int __init ps3_setup_ehci_device(
283 const struct ps3_repository_device *repo)
285 return ps3_setup_uhc_device(repo, PS3_MATCH_ID_EHCI,
286 PS3_INTERRUPT_TYPE_SB_EHCI, PS3_REG_TYPE_SB_EHCI);
289 static int __init ps3_setup_ohci_device(
290 const struct ps3_repository_device *repo)
292 return ps3_setup_uhc_device(repo, PS3_MATCH_ID_OHCI,
293 PS3_INTERRUPT_TYPE_SB_OHCI, PS3_REG_TYPE_SB_OHCI);
296 static int __init ps3_setup_vuart_device(enum ps3_match_id match_id,
297 unsigned int port_number)
301 struct ps3_system_bus_device dev;
304 pr_debug(" -> %s:%d: match_id %u, port %u\n", __func__, __LINE__,
305 match_id, port_number);
307 p = kzalloc(sizeof(struct layout), GFP_KERNEL);
312 p->dev.match_id = match_id;
313 p->dev.dev_type = PS3_DEVICE_TYPE_VUART;
314 p->dev.port_number = port_number;
316 result = ps3_system_bus_device_register(&p->dev);
319 pr_debug("%s:%d ps3_system_bus_device_register failed\n",
321 goto fail_device_register;
323 pr_debug(" <- %s:%d\n", __func__, __LINE__);
326 fail_device_register:
328 pr_debug(" <- %s:%d fail\n", __func__, __LINE__);
332 static int ps3_setup_storage_dev(const struct ps3_repository_device *repo,
333 enum ps3_match_id match_id)
336 struct ps3_storage_device *p;
337 u64 port, blk_size, num_blocks;
338 unsigned int num_regions, i;
340 pr_debug(" -> %s:%u: match_id %u\n", __func__, __LINE__, match_id);
342 result = ps3_repository_read_stor_dev_info(repo->bus_index,
343 repo->dev_index, &port,
344 &blk_size, &num_blocks,
347 printk(KERN_ERR "%s:%u: _read_stor_dev_info failed %d\n",
348 __func__, __LINE__, result);
352 pr_debug("%s:%u: (%u:%u:%u): port %llu blk_size %llu num_blocks %llu "
353 "num_regions %u\n", __func__, __LINE__, repo->bus_index,
354 repo->dev_index, repo->dev_type, port, blk_size, num_blocks,
357 p = kzalloc(struct_size(p, regions, num_regions), GFP_KERNEL);
363 p->sbd.match_id = match_id;
364 p->sbd.dev_type = PS3_DEVICE_TYPE_SB;
365 p->sbd.bus_id = repo->bus_id;
366 p->sbd.dev_id = repo->dev_id;
367 p->sbd.d_region = &p->dma_region;
368 p->blk_size = blk_size;
369 p->num_regions = num_regions;
371 result = ps3_repository_find_interrupt(repo,
372 PS3_INTERRUPT_TYPE_EVENT_PORT,
373 &p->sbd.interrupt_id);
375 printk(KERN_ERR "%s:%u: find_interrupt failed %d\n", __func__,
378 goto fail_find_interrupt;
381 for (i = 0; i < num_regions; i++) {
385 result = ps3_repository_read_stor_dev_region(repo->bus_index,
391 "%s:%u: read_stor_dev_region failed %d\n",
392 __func__, __LINE__, result);
394 goto fail_read_region;
396 pr_debug("%s:%u: region %u: id %u start %llu size %llu\n",
397 __func__, __LINE__, i, id, start, size);
399 p->regions[i].id = id;
400 p->regions[i].start = start;
401 p->regions[i].size = size;
404 result = ps3_system_bus_device_register(&p->sbd);
406 pr_debug("%s:%u ps3_system_bus_device_register failed\n",
408 goto fail_device_register;
411 pr_debug(" <- %s:%u\n", __func__, __LINE__);
414 fail_device_register:
419 pr_debug(" <- %s:%u: fail.\n", __func__, __LINE__);
423 static int __init ps3_register_vuart_devices(void)
426 unsigned int port_number;
428 pr_debug(" -> %s:%d\n", __func__, __LINE__);
430 result = ps3_repository_read_vuart_av_port(&port_number);
432 port_number = 0; /* av default */
434 result = ps3_setup_vuart_device(PS3_MATCH_ID_AV_SETTINGS, port_number);
437 result = ps3_repository_read_vuart_sysmgr_port(&port_number);
439 port_number = 2; /* sysmgr default */
441 result = ps3_setup_vuart_device(PS3_MATCH_ID_SYSTEM_MANAGER,
445 pr_debug(" <- %s:%d\n", __func__, __LINE__);
449 static int __init ps3_register_sound_devices(void)
453 struct ps3_system_bus_device dev;
454 struct ps3_dma_region d_region;
455 struct ps3_mmio_region m_region;
458 pr_debug(" -> %s:%d\n", __func__, __LINE__);
460 p = kzalloc(sizeof(*p), GFP_KERNEL);
464 p->dev.match_id = PS3_MATCH_ID_SOUND;
465 p->dev.dev_type = PS3_DEVICE_TYPE_IOC0;
466 p->dev.d_region = &p->d_region;
467 p->dev.m_region = &p->m_region;
469 result = ps3_system_bus_device_register(&p->dev);
472 pr_debug("%s:%d ps3_system_bus_device_register failed\n",
474 goto fail_device_register;
476 pr_debug(" <- %s:%d\n", __func__, __LINE__);
479 fail_device_register:
481 pr_debug(" <- %s:%d failed\n", __func__, __LINE__);
485 static int __init ps3_register_graphics_devices(void)
489 struct ps3_system_bus_device dev;
492 pr_debug(" -> %s:%d\n", __func__, __LINE__);
494 p = kzalloc(sizeof(struct layout), GFP_KERNEL);
499 p->dev.match_id = PS3_MATCH_ID_GPU;
500 p->dev.match_sub_id = PS3_MATCH_SUB_ID_GPU_FB;
501 p->dev.dev_type = PS3_DEVICE_TYPE_IOC0;
503 result = ps3_system_bus_device_register(&p->dev);
506 pr_debug("%s:%d ps3_system_bus_device_register failed\n",
508 goto fail_device_register;
511 pr_debug(" <- %s:%d\n", __func__, __LINE__);
514 fail_device_register:
516 pr_debug(" <- %s:%d failed\n", __func__, __LINE__);
520 static int __init ps3_register_ramdisk_device(void)
524 struct ps3_system_bus_device dev;
527 pr_debug(" -> %s:%d\n", __func__, __LINE__);
529 p = kzalloc(sizeof(struct layout), GFP_KERNEL);
534 p->dev.match_id = PS3_MATCH_ID_GPU;
535 p->dev.match_sub_id = PS3_MATCH_SUB_ID_GPU_RAMDISK;
536 p->dev.dev_type = PS3_DEVICE_TYPE_IOC0;
538 result = ps3_system_bus_device_register(&p->dev);
541 pr_debug("%s:%d ps3_system_bus_device_register failed\n",
543 goto fail_device_register;
546 pr_debug(" <- %s:%d\n", __func__, __LINE__);
549 fail_device_register:
551 pr_debug(" <- %s:%d failed\n", __func__, __LINE__);
556 * ps3_setup_dynamic_device - Setup a dynamic device from the repository
559 static int ps3_setup_dynamic_device(const struct ps3_repository_device *repo)
563 switch (repo->dev_type) {
564 case PS3_DEV_TYPE_STOR_DISK:
565 result = ps3_setup_storage_dev(repo, PS3_MATCH_ID_STOR_DISK);
567 /* Some devices are not accessible from the Other OS lpar. */
568 if (result == -ENODEV) {
570 pr_debug("%s:%u: not accessible\n", __func__,
575 pr_debug("%s:%u ps3_setup_storage_dev failed\n",
579 case PS3_DEV_TYPE_STOR_ROM:
580 result = ps3_setup_storage_dev(repo, PS3_MATCH_ID_STOR_ROM);
582 pr_debug("%s:%u ps3_setup_storage_dev failed\n",
586 case PS3_DEV_TYPE_STOR_FLASH:
587 result = ps3_setup_storage_dev(repo, PS3_MATCH_ID_STOR_FLASH);
589 pr_debug("%s:%u ps3_setup_storage_dev failed\n",
595 pr_debug("%s:%u: unsupported dev_type %u\n", __func__, __LINE__,
603 * ps3_setup_static_device - Setup a static device from the repository
606 static int __init ps3_setup_static_device(const struct ps3_repository_device *repo)
610 switch (repo->dev_type) {
611 case PS3_DEV_TYPE_SB_GELIC:
612 result = ps3_setup_gelic_device(repo);
614 pr_debug("%s:%d ps3_setup_gelic_device failed\n",
618 case PS3_DEV_TYPE_SB_USB:
620 /* Each USB device has both an EHCI and an OHCI HC */
622 result = ps3_setup_ehci_device(repo);
625 pr_debug("%s:%d ps3_setup_ehci_device failed\n",
629 result = ps3_setup_ohci_device(repo);
632 pr_debug("%s:%d ps3_setup_ohci_device failed\n",
638 return ps3_setup_dynamic_device(repo);
644 static void ps3_find_and_add_device(u64 bus_id, u64 dev_id)
646 struct ps3_repository_device repo;
648 unsigned int retries;
652 * On some firmware versions (e.g. 1.90), the device may not show up
653 * in the repository immediately
655 for (retries = 0; retries < 10; retries++) {
656 res = ps3_repository_find_device_by_id(&repo, bus_id, dev_id);
660 rem = msleep_interruptible(100);
664 pr_warn("%s:%u: device %llu:%llu not found\n",
665 __func__, __LINE__, bus_id, dev_id);
670 pr_debug("%s:%u: device %llu:%llu found after %u retries\n",
671 __func__, __LINE__, bus_id, dev_id, retries);
673 ps3_setup_dynamic_device(&repo);
677 #define PS3_NOTIFICATION_DEV_ID ULONG_MAX
678 #define PS3_NOTIFICATION_INTERRUPT_ID 0
680 struct ps3_notification_device {
681 struct ps3_system_bus_device sbd;
685 struct completion done;
688 enum ps3_notify_type {
689 notify_device_ready = 0,
690 notify_region_probe = 1,
691 notify_region_update = 2,
694 struct ps3_notify_cmd {
695 u64 operation_code; /* must be zero */
696 u64 event_mask; /* OR of 1UL << enum ps3_notify_type */
699 struct ps3_notify_event {
700 u64 event_type; /* enum ps3_notify_type */
707 static irqreturn_t ps3_notification_interrupt(int irq, void *data)
709 struct ps3_notification_device *dev = data;
713 spin_lock(&dev->lock);
714 res = lv1_storage_get_async_status(PS3_NOTIFICATION_DEV_ID, &tag,
717 pr_err("%s:%u: tag mismatch, got %llx, expected %llx\n",
718 __func__, __LINE__, tag, dev->tag);
721 pr_err("%s:%u: res %d status 0x%llx\n", __func__, __LINE__, res,
724 pr_debug("%s:%u: completed, status 0x%llx\n", __func__,
726 dev->lv1_status = status;
727 complete(&dev->done);
729 spin_unlock(&dev->lock);
733 static int ps3_notification_read_write(struct ps3_notification_device *dev,
736 const char *op = write ? "write" : "read";
740 init_completion(&dev->done);
741 spin_lock_irqsave(&dev->lock, flags);
742 res = write ? lv1_storage_write(dev->sbd.dev_id, 0, 0, 1, 0, lpar,
744 : lv1_storage_read(dev->sbd.dev_id, 0, 0, 1, 0, lpar,
746 spin_unlock_irqrestore(&dev->lock, flags);
748 pr_err("%s:%u: %s failed %d\n", __func__, __LINE__, op, res);
751 pr_debug("%s:%u: notification %s issued\n", __func__, __LINE__, op);
753 res = wait_event_interruptible(dev->done.wait,
754 dev->done.done || kthread_should_stop());
755 if (kthread_should_stop())
758 pr_debug("%s:%u: interrupted %s\n", __func__, __LINE__, op);
762 if (dev->lv1_status) {
763 pr_err("%s:%u: %s not completed, status 0x%llx\n", __func__,
764 __LINE__, op, dev->lv1_status);
767 pr_debug("%s:%u: notification %s completed\n", __func__, __LINE__, op);
772 static struct task_struct *probe_task;
775 * ps3_probe_thread - Background repository probing at system startup.
777 * This implementation only supports background probing on a single bus.
778 * It uses the hypervisor's storage device notification mechanism to wait until
779 * a storage device is ready. The device notification mechanism uses a
780 * pseudo device to asynchronously notify the guest when storage devices become
781 * ready. The notification device has a block size of 512 bytes.
784 static int ps3_probe_thread(void *data)
786 struct ps3_notification_device dev;
791 struct ps3_notify_cmd *notify_cmd;
792 struct ps3_notify_event *notify_event;
794 pr_debug(" -> %s:%u: kthread started\n", __func__, __LINE__);
796 buf = kzalloc(512, GFP_KERNEL);
800 lpar = ps3_mm_phys_to_lpar(__pa(buf));
804 /* dummy system bus device */
805 dev.sbd.bus_id = (u64)data;
806 dev.sbd.dev_id = PS3_NOTIFICATION_DEV_ID;
807 dev.sbd.interrupt_id = PS3_NOTIFICATION_INTERRUPT_ID;
809 res = lv1_open_device(dev.sbd.bus_id, dev.sbd.dev_id, 0);
811 pr_err("%s:%u: lv1_open_device failed %s\n", __func__,
812 __LINE__, ps3_result(res));
816 res = ps3_sb_event_receive_port_setup(&dev.sbd, PS3_BINDING_CPU_ANY,
819 pr_err("%s:%u: ps3_sb_event_receive_port_setup failed %d\n",
820 __func__, __LINE__, res);
821 goto fail_close_device;
824 spin_lock_init(&dev.lock);
826 res = request_irq(irq, ps3_notification_interrupt, 0,
827 "ps3_notification", &dev);
829 pr_err("%s:%u: request_irq failed %d\n", __func__, __LINE__,
831 goto fail_sb_event_receive_port_destroy;
834 /* Setup and write the request for device notification. */
835 notify_cmd->operation_code = 0; /* must be zero */
836 notify_cmd->event_mask = 1UL << notify_region_probe;
838 res = ps3_notification_read_write(&dev, lpar, 1);
842 /* Loop here processing the requested notification events. */
846 memset(notify_event, 0, sizeof(*notify_event));
848 res = ps3_notification_read_write(&dev, lpar, 0);
852 pr_debug("%s:%u: notify event type 0x%llx bus id %llu dev id %llu"
853 " type %llu port %llu\n", __func__, __LINE__,
854 notify_event->event_type, notify_event->bus_id,
855 notify_event->dev_id, notify_event->dev_type,
856 notify_event->dev_port);
858 if (notify_event->event_type != notify_region_probe ||
859 notify_event->bus_id != dev.sbd.bus_id) {
860 pr_warn("%s:%u: bad notify_event: event %llu, dev_id %llu, dev_type %llu\n",
861 __func__, __LINE__, notify_event->event_type,
862 notify_event->dev_id, notify_event->dev_type);
866 ps3_find_and_add_device(dev.sbd.bus_id, notify_event->dev_id);
868 } while (!kthread_should_stop());
872 fail_sb_event_receive_port_destroy:
873 ps3_sb_event_receive_port_destroy(&dev.sbd, irq);
875 lv1_close_device(dev.sbd.bus_id, dev.sbd.dev_id);
881 pr_debug(" <- %s:%u: kthread finished\n", __func__, __LINE__);
887 * ps3_stop_probe_thread - Stops the background probe thread.
891 static int ps3_stop_probe_thread(struct notifier_block *nb, unsigned long code,
895 kthread_stop(probe_task);
899 static struct notifier_block nb = {
900 .notifier_call = ps3_stop_probe_thread
904 * ps3_start_probe_thread - Starts the background probe thread.
908 static int __init ps3_start_probe_thread(enum ps3_bus_type bus_type)
911 struct task_struct *task;
912 struct ps3_repository_device repo;
914 pr_debug(" -> %s:%d\n", __func__, __LINE__);
916 memset(&repo, 0, sizeof(repo));
918 repo.bus_type = bus_type;
920 result = ps3_repository_find_bus(repo.bus_type, 0, &repo.bus_index);
923 printk(KERN_ERR "%s: Cannot find bus (%d)\n", __func__, result);
927 result = ps3_repository_read_bus_id(repo.bus_index, &repo.bus_id);
930 printk(KERN_ERR "%s: read_bus_id failed %d\n", __func__,
935 task = kthread_run(ps3_probe_thread, (void *)repo.bus_id,
936 "ps3-probe-%u", bus_type);
939 result = PTR_ERR(task);
940 printk(KERN_ERR "%s: kthread_run failed %d\n", __func__,
946 register_reboot_notifier(&nb);
948 pr_debug(" <- %s:%d\n", __func__, __LINE__);
953 * ps3_register_devices - Probe the system and register devices found.
955 * A device_initcall() routine.
958 static int __init ps3_register_devices(void)
962 if (!firmware_has_feature(FW_FEATURE_PS3_LV1))
965 pr_debug(" -> %s:%d\n", __func__, __LINE__);
967 /* ps3_repository_dump_bus_info(); */
969 result = ps3_start_probe_thread(PS3_BUS_TYPE_STORAGE);
971 ps3_register_vuart_devices();
973 ps3_register_graphics_devices();
975 ps3_repository_find_devices(PS3_BUS_TYPE_SB, ps3_setup_static_device);
977 ps3_register_sound_devices();
979 ps3_register_lpm_devices();
981 ps3_register_ramdisk_device();
983 pr_debug(" <- %s:%d\n", __func__, __LINE__);
987 device_initcall(ps3_register_devices);