include/asm/ps3.h

0001 /* SPDX-License-Identifier: GPL-2.0-only */
0002 /*
0003  *  PS3 platform declarations.
0004  *
0005  *  Copyright (C) 2006 Sony Computer Entertainment Inc.
0006  *  Copyright 2006 Sony Corp.
0007  */
0008
0009 #if !defined(_ASM_POWERPC_PS3_H)
0010 #define _ASM_POWERPC_PS3_H
0011
0012 #include <linux/types.h>
0013 #include <linux/device.h>
0014 #include <asm/cell-pmu.h>
0015
0016 union ps3_firmware_version {
0017     u64 raw;
0018     struct {
0019         u16 pad;
0020         u16 major;
0021         u16 minor;
0022         u16 rev;
0023     };
0024 };
0025
0026 void ps3_get_firmware_version(union ps3_firmware_version *v);
0027 int ps3_compare_firmware_version(u16 major, u16 minor, u16 rev);
0028
0029 /* 'Other OS' area */
0030
0031 enum ps3_param_av_multi_out {
0032     PS3_PARAM_AV_MULTI_OUT_NTSC = 0,
0033     PS3_PARAM_AV_MULTI_OUT_PAL_RGB = 1,
0034     PS3_PARAM_AV_MULTI_OUT_PAL_YCBCR = 2,
0035     PS3_PARAM_AV_MULTI_OUT_SECAM = 3,
0036 };
0037
0038 enum ps3_param_av_multi_out ps3_os_area_get_av_multi_out(void);
0039
0040 extern u64 ps3_os_area_get_rtc_diff(void);
0041 extern void ps3_os_area_set_rtc_diff(u64 rtc_diff);
0042
0043 struct ps3_os_area_flash_ops {
0044     ssize_t (*read)(void *buf, size_t count, loff_t pos);
0045     ssize_t (*write)(const void *buf, size_t count, loff_t pos);
0046 };
0047
0048 extern void ps3_os_area_flash_register(const struct ps3_os_area_flash_ops *ops);
0049
0050 /* dma routines */
0051
0052 enum ps3_dma_page_size {
0053     PS3_DMA_4K = 12U,
0054     PS3_DMA_64K = 16U,
0055     PS3_DMA_1M = 20U,
0056     PS3_DMA_16M = 24U,
0057 };
0058
0059 enum ps3_dma_region_type {
0060     PS3_DMA_OTHER = 0,
0061     PS3_DMA_INTERNAL = 2,
0062 };
0063
0064 struct ps3_dma_region_ops;
0065
0066 /**
0067  * struct ps3_dma_region - A per device dma state variables structure
0068  * @did: The HV device id.
0069  * @page_size: The ioc pagesize.
0070  * @region_type: The HV region type.
0071  * @bus_addr: The 'translated' bus address of the region.
0072  * @len: The length in bytes of the region.
0073  * @offset: The offset from the start of memory of the region.
0074  * @dma_mask: Device dma_mask.
0075  * @ioid: The IOID of the device who owns this region
0076  * @chunk_list: Opaque variable used by the ioc page manager.
0077  * @region_ops: struct ps3_dma_region_ops - dma region operations
0078  */
0079
0080 struct ps3_dma_region {
0081     struct ps3_system_bus_device *dev;
0082     /* device variables */
0083     const struct ps3_dma_region_ops *region_ops;
0084     unsigned char ioid;
0085     enum ps3_dma_page_size page_size;
0086     enum ps3_dma_region_type region_type;
0087     unsigned long len;
0088     unsigned long offset;
0089     u64 dma_mask;
0090
0091     /* driver variables  (set by ps3_dma_region_create) */
0092     unsigned long bus_addr;
0093     struct {
0094         spinlock_t lock;
0095         struct list_head head;
0096     } chunk_list;
0097 };
0098
0099 struct ps3_dma_region_ops {
0100     int (*create)(struct ps3_dma_region *);
0101     int (*free)(struct ps3_dma_region *);
0102     int (*map)(struct ps3_dma_region *,
0103            unsigned long virt_addr,
0104            unsigned long len,
0105            dma_addr_t *bus_addr,
0106            u64 iopte_pp);
0107     int (*unmap)(struct ps3_dma_region *,
0108              dma_addr_t bus_addr,
0109              unsigned long len);
0110 };
0111 /**
0112  * struct ps3_dma_region_init - Helper to initialize structure variables
0113  *
0114  * Helper to properly initialize variables prior to calling
0115  * ps3_system_bus_device_register.
0116  */
0117
0118 struct ps3_system_bus_device;
0119
0120 int ps3_dma_region_init(struct ps3_system_bus_device *dev,
0121     struct ps3_dma_region *r, enum ps3_dma_page_size page_size,
0122     enum ps3_dma_region_type region_type, void *addr, unsigned long len);
0123 int ps3_dma_region_create(struct ps3_dma_region *r);
0124 int ps3_dma_region_free(struct ps3_dma_region *r);
0125 int ps3_dma_map(struct ps3_dma_region *r, unsigned long virt_addr,
0126     unsigned long len, dma_addr_t *bus_addr,
0127     u64 iopte_pp);
0128 int ps3_dma_unmap(struct ps3_dma_region *r, dma_addr_t bus_addr,
0129     unsigned long len);
0130
0131 /* mmio routines */
0132
0133 enum ps3_mmio_page_size {
0134     PS3_MMIO_4K = 12U,
0135     PS3_MMIO_64K = 16U
0136 };
0137
0138 struct ps3_mmio_region_ops;
0139 /**
0140  * struct ps3_mmio_region - a per device mmio state variables structure
0141  *
0142  * Current systems can be supported with a single region per device.
0143  */
0144
0145 struct ps3_mmio_region {
0146     struct ps3_system_bus_device *dev;
0147     const struct ps3_mmio_region_ops *mmio_ops;
0148     unsigned long bus_addr;
0149     unsigned long len;
0150     enum ps3_mmio_page_size page_size;
0151     unsigned long lpar_addr;
0152 };
0153
0154 struct ps3_mmio_region_ops {
0155     int (*create)(struct ps3_mmio_region *);
0156     int (*free)(struct ps3_mmio_region *);
0157 };
0158 /**
0159  * struct ps3_mmio_region_init - Helper to initialize structure variables
0160  *
0161  * Helper to properly initialize variables prior to calling
0162  * ps3_system_bus_device_register.
0163  */
0164
0165 int ps3_mmio_region_init(struct ps3_system_bus_device *dev,
0166     struct ps3_mmio_region *r, unsigned long bus_addr, unsigned long len,
0167     enum ps3_mmio_page_size page_size);
0168 int ps3_mmio_region_create(struct ps3_mmio_region *r);
0169 int ps3_free_mmio_region(struct ps3_mmio_region *r);
0170 unsigned long ps3_mm_phys_to_lpar(unsigned long phys_addr);
0171
0172 /* inrerrupt routines */
0173
0174 enum ps3_cpu_binding {
0175     PS3_BINDING_CPU_ANY = -1,
0176     PS3_BINDING_CPU_0 = 0,
0177     PS3_BINDING_CPU_1 = 1,
0178 };
0179
0180 int ps3_irq_plug_setup(enum ps3_cpu_binding cpu, unsigned long outlet,
0181     unsigned int *virq);
0182 int ps3_irq_plug_destroy(unsigned int virq);
0183 int ps3_event_receive_port_setup(enum ps3_cpu_binding cpu, unsigned int *virq);
0184 int ps3_event_receive_port_destroy(unsigned int virq);
0185 int ps3_send_event_locally(unsigned int virq);
0186
0187 int ps3_io_irq_setup(enum ps3_cpu_binding cpu, unsigned int interrupt_id,
0188     unsigned int *virq);
0189 int ps3_io_irq_destroy(unsigned int virq);
0190 int ps3_vuart_irq_setup(enum ps3_cpu_binding cpu, void* virt_addr_bmp,
0191     unsigned int *virq);
0192 int ps3_vuart_irq_destroy(unsigned int virq);
0193 int ps3_spe_irq_setup(enum ps3_cpu_binding cpu, unsigned long spe_id,
0194     unsigned int class, unsigned int *virq);
0195 int ps3_spe_irq_destroy(unsigned int virq);
0196
0197 int ps3_sb_event_receive_port_setup(struct ps3_system_bus_device *dev,
0198     enum ps3_cpu_binding cpu, unsigned int *virq);
0199 int ps3_sb_event_receive_port_destroy(struct ps3_system_bus_device *dev,
0200     unsigned int virq);
0201
0202 /* lv1 result codes */
0203
0204 enum lv1_result {
0205     LV1_SUCCESS                     = 0,
0206     /* not used                       -1 */
0207     LV1_RESOURCE_SHORTAGE           = -2,
0208     LV1_NO_PRIVILEGE                = -3,
0209     LV1_DENIED_BY_POLICY            = -4,
0210     LV1_ACCESS_VIOLATION            = -5,
0211     LV1_NO_ENTRY                    = -6,
0212     LV1_DUPLICATE_ENTRY             = -7,
0213     LV1_TYPE_MISMATCH               = -8,
0214     LV1_BUSY                        = -9,
0215     LV1_EMPTY                       = -10,
0216     LV1_WRONG_STATE                 = -11,
0217     /* not used                       -12 */
0218     LV1_NO_MATCH                    = -13,
0219     LV1_ALREADY_CONNECTED           = -14,
0220     LV1_UNSUPPORTED_PARAMETER_VALUE = -15,
0221     LV1_CONDITION_NOT_SATISFIED     = -16,
0222     LV1_ILLEGAL_PARAMETER_VALUE     = -17,
0223     LV1_BAD_OPTION                  = -18,
0224     LV1_IMPLEMENTATION_LIMITATION   = -19,
0225     LV1_NOT_IMPLEMENTED             = -20,
0226     LV1_INVALID_CLASS_ID            = -21,
0227     LV1_CONSTRAINT_NOT_SATISFIED    = -22,
0228     LV1_ALIGNMENT_ERROR             = -23,
0229     LV1_HARDWARE_ERROR              = -24,
0230     LV1_INVALID_DATA_FORMAT         = -25,
0231     LV1_INVALID_OPERATION           = -26,
0232     LV1_INTERNAL_ERROR              = -32768,
0233 };
0234
0235 static inline const char* ps3_result(int result)
0236 {
0237 #if defined(DEBUG) || defined(PS3_VERBOSE_RESULT) || defined(CONFIG_PS3_VERBOSE_RESULT)
0238     switch (result) {
0239     case LV1_SUCCESS:
0240         return "LV1_SUCCESS (0)";
0241     case -1:
0242         return "** unknown result ** (-1)";
0243     case LV1_RESOURCE_SHORTAGE:
0244         return "LV1_RESOURCE_SHORTAGE (-2)";
0245     case LV1_NO_PRIVILEGE:
0246         return "LV1_NO_PRIVILEGE (-3)";
0247     case LV1_DENIED_BY_POLICY:
0248         return "LV1_DENIED_BY_POLICY (-4)";
0249     case LV1_ACCESS_VIOLATION:
0250         return "LV1_ACCESS_VIOLATION (-5)";
0251     case LV1_NO_ENTRY:
0252         return "LV1_NO_ENTRY (-6)";
0253     case LV1_DUPLICATE_ENTRY:
0254         return "LV1_DUPLICATE_ENTRY (-7)";
0255     case LV1_TYPE_MISMATCH:
0256         return "LV1_TYPE_MISMATCH (-8)";
0257     case LV1_BUSY:
0258         return "LV1_BUSY (-9)";
0259     case LV1_EMPTY:
0260         return "LV1_EMPTY (-10)";
0261     case LV1_WRONG_STATE:
0262         return "LV1_WRONG_STATE (-11)";
0263     case -12:
0264         return "** unknown result ** (-12)";
0265     case LV1_NO_MATCH:
0266         return "LV1_NO_MATCH (-13)";
0267     case LV1_ALREADY_CONNECTED:
0268         return "LV1_ALREADY_CONNECTED (-14)";
0269     case LV1_UNSUPPORTED_PARAMETER_VALUE:
0270         return "LV1_UNSUPPORTED_PARAMETER_VALUE (-15)";
0271     case LV1_CONDITION_NOT_SATISFIED:
0272         return "LV1_CONDITION_NOT_SATISFIED (-16)";
0273     case LV1_ILLEGAL_PARAMETER_VALUE:
0274         return "LV1_ILLEGAL_PARAMETER_VALUE (-17)";
0275     case LV1_BAD_OPTION:
0276         return "LV1_BAD_OPTION (-18)";
0277     case LV1_IMPLEMENTATION_LIMITATION:
0278         return "LV1_IMPLEMENTATION_LIMITATION (-19)";
0279     case LV1_NOT_IMPLEMENTED:
0280         return "LV1_NOT_IMPLEMENTED (-20)";
0281     case LV1_INVALID_CLASS_ID:
0282         return "LV1_INVALID_CLASS_ID (-21)";
0283     case LV1_CONSTRAINT_NOT_SATISFIED:
0284         return "LV1_CONSTRAINT_NOT_SATISFIED (-22)";
0285     case LV1_ALIGNMENT_ERROR:
0286         return "LV1_ALIGNMENT_ERROR (-23)";
0287     case LV1_HARDWARE_ERROR:
0288         return "LV1_HARDWARE_ERROR (-24)";
0289     case LV1_INVALID_DATA_FORMAT:
0290         return "LV1_INVALID_DATA_FORMAT (-25)";
0291     case LV1_INVALID_OPERATION:
0292         return "LV1_INVALID_OPERATION (-26)";
0293     case LV1_INTERNAL_ERROR:
0294         return "LV1_INTERNAL_ERROR (-32768)";
0295     default:
0296         BUG();
0297         return "** unknown result **";
0298     };
0299 #else
0300     return "";
0301 #endif
0302 }
0303
0304 /* system bus routines */
0305
0306 enum ps3_match_id {
0307     PS3_MATCH_ID_EHCI       = 1,
0308     PS3_MATCH_ID_OHCI       = 2,
0309     PS3_MATCH_ID_GELIC      = 3,
0310     PS3_MATCH_ID_AV_SETTINGS    = 4,
0311     PS3_MATCH_ID_SYSTEM_MANAGER = 5,
0312     PS3_MATCH_ID_STOR_DISK      = 6,
0313     PS3_MATCH_ID_STOR_ROM       = 7,
0314     PS3_MATCH_ID_STOR_FLASH     = 8,
0315     PS3_MATCH_ID_SOUND      = 9,
0316     PS3_MATCH_ID_GPU        = 10,
0317     PS3_MATCH_ID_LPM        = 11,
0318 };
0319
0320 enum ps3_match_sub_id {
0321     PS3_MATCH_SUB_ID_GPU_FB     = 1,
0322     PS3_MATCH_SUB_ID_GPU_RAMDISK    = 2,
0323 };
0324
0325 #define PS3_MODULE_ALIAS_EHCI       "ps3:1:0"
0326 #define PS3_MODULE_ALIAS_OHCI       "ps3:2:0"
0327 #define PS3_MODULE_ALIAS_GELIC      "ps3:3:0"
0328 #define PS3_MODULE_ALIAS_AV_SETTINGS    "ps3:4:0"
0329 #define PS3_MODULE_ALIAS_SYSTEM_MANAGER "ps3:5:0"
0330 #define PS3_MODULE_ALIAS_STOR_DISK  "ps3:6:0"
0331 #define PS3_MODULE_ALIAS_STOR_ROM   "ps3:7:0"
0332 #define PS3_MODULE_ALIAS_STOR_FLASH "ps3:8:0"
0333 #define PS3_MODULE_ALIAS_SOUND      "ps3:9:0"
0334 #define PS3_MODULE_ALIAS_GPU_FB     "ps3:10:1"
0335 #define PS3_MODULE_ALIAS_GPU_RAMDISK    "ps3:10:2"
0336 #define PS3_MODULE_ALIAS_LPM        "ps3:11:0"
0337
0338 enum ps3_system_bus_device_type {
0339     PS3_DEVICE_TYPE_IOC0 = 1,
0340     PS3_DEVICE_TYPE_SB,
0341     PS3_DEVICE_TYPE_VUART,
0342     PS3_DEVICE_TYPE_LPM,
0343 };
0344
0345 /**
0346  * struct ps3_system_bus_device - a device on the system bus
0347  */
0348
0349 struct ps3_system_bus_device {
0350     enum ps3_match_id match_id;
0351     enum ps3_match_sub_id match_sub_id;
0352     enum ps3_system_bus_device_type dev_type;
0353
0354     u64 bus_id;                       /* SB */
0355     u64 dev_id;                       /* SB */
0356     unsigned int interrupt_id;        /* SB */
0357     struct ps3_dma_region *d_region;  /* SB, IOC0 */
0358     struct ps3_mmio_region *m_region; /* SB, IOC0*/
0359     unsigned int port_number;         /* VUART */
0360     struct {                          /* LPM */
0361         u64 node_id;
0362         u64 pu_id;
0363         u64 rights;
0364     } lpm;
0365
0366 /*  struct iommu_table *iommu_table; -- waiting for BenH's cleanups */
0367     struct device core;
0368     void *driver_priv; /* private driver variables */
0369 };
0370
0371 int ps3_open_hv_device(struct ps3_system_bus_device *dev);
0372 int ps3_close_hv_device(struct ps3_system_bus_device *dev);
0373
0374 /**
0375  * struct ps3_system_bus_driver - a driver for a device on the system bus
0376  */
0377
0378 struct ps3_system_bus_driver {
0379     enum ps3_match_id match_id;
0380     enum ps3_match_sub_id match_sub_id;
0381     struct device_driver core;
0382     int (*probe)(struct ps3_system_bus_device *);
0383     void (*remove)(struct ps3_system_bus_device *);
0384     void (*shutdown)(struct ps3_system_bus_device *);
0385 /*  int (*suspend)(struct ps3_system_bus_device *, pm_message_t); */
0386 /*  int (*resume)(struct ps3_system_bus_device *); */
0387 };
0388
0389 int ps3_system_bus_device_register(struct ps3_system_bus_device *dev);
0390 int ps3_system_bus_driver_register(struct ps3_system_bus_driver *drv);
0391 void ps3_system_bus_driver_unregister(struct ps3_system_bus_driver *drv);
0392
0393 static inline struct ps3_system_bus_driver *ps3_drv_to_system_bus_drv(
0394     struct device_driver *_drv)
0395 {
0396     return container_of(_drv, struct ps3_system_bus_driver, core);
0397 }
0398 static inline struct ps3_system_bus_device *ps3_dev_to_system_bus_dev(
0399     struct device *_dev)
0400 {
0401     return container_of(_dev, struct ps3_system_bus_device, core);
0402 }
0403 static inline struct ps3_system_bus_driver *
0404     ps3_system_bus_dev_to_system_bus_drv(struct ps3_system_bus_device *_dev)
0405 {
0406     BUG_ON(!_dev);
0407     BUG_ON(!_dev->core.driver);
0408     return ps3_drv_to_system_bus_drv(_dev->core.driver);
0409 }
0410
0411 /**
0412  * ps3_system_bus_set_drvdata -
0413  * @dev: device structure
0414  * @data: Data to set
0415  */
0416
0417 static inline void ps3_system_bus_set_drvdata(
0418     struct ps3_system_bus_device *dev, void *data)
0419 {
0420     dev_set_drvdata(&dev->core, data);
0421 }
0422 static inline void *ps3_system_bus_get_drvdata(
0423     struct ps3_system_bus_device *dev)
0424 {
0425     return dev_get_drvdata(&dev->core);
0426 }
0427
0428 /* These two need global scope for get_arch_dma_ops(). */
0429
0430 extern struct bus_type ps3_system_bus_type;
0431
0432 /* system manager */
0433
0434 struct ps3_sys_manager_ops {
0435     struct ps3_system_bus_device *dev;
0436     void (*power_off)(struct ps3_system_bus_device *dev);
0437     void (*restart)(struct ps3_system_bus_device *dev);
0438 };
0439
0440 void ps3_sys_manager_register_ops(const struct ps3_sys_manager_ops *ops);
0441 void __noreturn ps3_sys_manager_power_off(void);
0442 void __noreturn ps3_sys_manager_restart(void);
0443 void __noreturn ps3_sys_manager_halt(void);
0444 int ps3_sys_manager_get_wol(void);
0445 void ps3_sys_manager_set_wol(int state);
0446
0447 struct ps3_prealloc {
0448     const char *name;
0449     void *address;
0450     unsigned long size;
0451     unsigned long align;
0452 };
0453
0454 extern struct ps3_prealloc ps3fb_videomemory;
0455 extern struct ps3_prealloc ps3flash_bounce_buffer;
0456
0457 /* logical performance monitor */
0458
0459 /**
0460  * enum ps3_lpm_rights - Rigths granted by the system policy module.
0461  *
0462  * @PS3_LPM_RIGHTS_USE_LPM: The right to use the lpm.
0463  * @PS3_LPM_RIGHTS_USE_TB: The right to use the internal trace buffer.
0464  */
0465
0466 enum ps3_lpm_rights {
0467     PS3_LPM_RIGHTS_USE_LPM = 0x001,
0468     PS3_LPM_RIGHTS_USE_TB = 0x100,
0469 };
0470
0471 /**
0472  * enum ps3_lpm_tb_type - Type of trace buffer lv1 should use.
0473  *
0474  * @PS3_LPM_TB_TYPE_NONE: Do not use a trace buffer.
0475  * @PS3_LPM_RIGHTS_USE_TB: Use the lv1 internal trace buffer.  Must have
0476  *  rights @PS3_LPM_RIGHTS_USE_TB.
0477  */
0478
0479 enum ps3_lpm_tb_type {
0480     PS3_LPM_TB_TYPE_NONE = 0,
0481     PS3_LPM_TB_TYPE_INTERNAL = 1,
0482 };
0483
0484 int ps3_lpm_open(enum ps3_lpm_tb_type tb_type, void *tb_cache,
0485     u64 tb_cache_size);
0486 int ps3_lpm_close(void);
0487 int ps3_lpm_copy_tb(unsigned long offset, void *buf, unsigned long count,
0488     unsigned long *bytes_copied);
0489 int ps3_lpm_copy_tb_to_user(unsigned long offset, void __user *buf,
0490     unsigned long count, unsigned long *bytes_copied);
0491 void ps3_set_bookmark(u64 bookmark);
0492 void ps3_set_pm_bookmark(u64 tag, u64 incident, u64 th_id);
0493 int ps3_set_signal(u64 rtas_signal_group, u8 signal_bit, u16 sub_unit,
0494     u8 bus_word);
0495
0496 u32 ps3_read_phys_ctr(u32 cpu, u32 phys_ctr);
0497 void ps3_write_phys_ctr(u32 cpu, u32 phys_ctr, u32 val);
0498 u32 ps3_read_ctr(u32 cpu, u32 ctr);
0499 void ps3_write_ctr(u32 cpu, u32 ctr, u32 val);
0500
0501 u32 ps3_read_pm07_control(u32 cpu, u32 ctr);
0502 void ps3_write_pm07_control(u32 cpu, u32 ctr, u32 val);
0503 u32 ps3_read_pm(u32 cpu, enum pm_reg_name reg);
0504 void ps3_write_pm(u32 cpu, enum pm_reg_name reg, u32 val);
0505
0506 u32 ps3_get_ctr_size(u32 cpu, u32 phys_ctr);
0507 void ps3_set_ctr_size(u32 cpu, u32 phys_ctr, u32 ctr_size);
0508
0509 void ps3_enable_pm(u32 cpu);
0510 void ps3_disable_pm(u32 cpu);
0511 void ps3_enable_pm_interrupts(u32 cpu, u32 thread, u32 mask);
0512 void ps3_disable_pm_interrupts(u32 cpu);
0513
0514 u32 ps3_get_and_clear_pm_interrupts(u32 cpu);
0515 void ps3_sync_irq(int node);
0516 u32 ps3_get_hw_thread_id(int cpu);
0517 u64 ps3_get_spe_id(void *arg);
0518
0519 void ps3_early_mm_init(void);
0520
0521 #endif