SAFE public projects git trees. - safe/jmp/linux-2.6/blob - include/asm-powerpc/ps3.h

   1 /*
   2  *  PS3 platform declarations.
   3  *
   4  *  Copyright (C) 2006 Sony Computer Entertainment Inc.
   5  *  Copyright 2006 Sony Corp.
   6  *
   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.
  10  *
  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.
  15  *
  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
  19  */
  20
  21 #if !defined(_ASM_POWERPC_PS3_H)
  22 #define _ASM_POWERPC_PS3_H
  23
  24 #include <linux/compiler.h> /* for __deprecated */
  25 #include <linux/init.h>
  26 #include <linux/types.h>
  27 #include <linux/device.h>
  28 #include <scsi/scsi.h>
  29
  30 /**
  31  * struct ps3_device_id - HV bus device identifier from the system repository
  32  * @bus_id: HV bus id, {1..} (zero invalid)
  33  * @dev_id: HV device id, {0..}
  34  */
  35
  36 struct ps3_device_id {
  37         unsigned int bus_id;
  38         unsigned int dev_id;
  39 };
  40
  41
  42 /* dma routines */
  43
  44 enum ps3_dma_page_size {
  45         PS3_DMA_4K = 12U,
  46         PS3_DMA_64K = 16U,
  47         PS3_DMA_1M = 20U,
  48         PS3_DMA_16M = 24U,
  49 };
  50
  51 enum ps3_dma_region_type {
  52         PS3_DMA_OTHER = 0,
  53         PS3_DMA_INTERNAL = 2,
  54 };
  55
  56 /**
  57  * struct ps3_dma_region - A per device dma state variables structure
  58  * @did: The HV device id.
  59  * @page_size: The ioc pagesize.
  60  * @region_type: The HV region type.
  61  * @bus_addr: The 'translated' bus address of the region.
  62  * @len: The length in bytes of the region.
  63  * @chunk_list: Opaque variable used by the ioc page manager.
  64  */
  65
  66 struct ps3_dma_region {
  67         struct ps3_device_id did;
  68         enum ps3_dma_page_size page_size;
  69         enum ps3_dma_region_type region_type;
  70         unsigned long bus_addr;
  71         unsigned long len;
  72         struct {
  73                 spinlock_t lock;
  74                 struct list_head head;
  75         } chunk_list;
  76 };
  77
  78 /**
  79  * struct ps3_dma_region_init - Helper to initialize structure variables
  80  *
  81  * Helper to properly initialize variables prior to calling
  82  * ps3_system_bus_device_register.
  83  */
  84
  85 static inline void ps3_dma_region_init(struct ps3_dma_region *r,
  86         const struct ps3_device_id* did, enum ps3_dma_page_size page_size,
  87         enum ps3_dma_region_type region_type)
  88 {
  89         r->did = *did;
  90         r->page_size = page_size;
  91         r->region_type = region_type;
  92 }
  93 int ps3_dma_region_create(struct ps3_dma_region *r);
  94 int ps3_dma_region_free(struct ps3_dma_region *r);
  95 int ps3_dma_map(struct ps3_dma_region *r, unsigned long virt_addr,
  96         unsigned long len, unsigned long *bus_addr);
  97 int ps3_dma_unmap(struct ps3_dma_region *r, unsigned long bus_addr,
  98         unsigned long len);
  99
 100 /* mmio routines */
 101
 102 enum ps3_mmio_page_size {
 103         PS3_MMIO_4K = 12U,
 104         PS3_MMIO_64K = 16U
 105 };
 106
 107 /**
 108  * struct ps3_mmio_region - a per device mmio state variables structure
 109  *
 110  * Current systems can be supported with a single region per device.
 111  */
 112
 113 struct ps3_mmio_region {
 114         struct ps3_device_id did;
 115         unsigned long bus_addr;
 116         unsigned long len;
 117         enum ps3_mmio_page_size page_size;
 118         unsigned long lpar_addr;
 119 };
 120
 121 /**
 122  * struct ps3_mmio_region_init - Helper to initialize structure variables
 123  *
 124  * Helper to properly initialize variables prior to calling
 125  * ps3_system_bus_device_register.
 126  */
 127
 128 static inline void ps3_mmio_region_init(struct ps3_mmio_region *r,
 129         const struct ps3_device_id* did, unsigned long bus_addr,
 130         unsigned long len, enum ps3_mmio_page_size page_size)
 131 {
 132         r->did = *did;
 133         r->bus_addr = bus_addr;
 134         r->len = len;
 135         r->page_size = page_size;
 136 }
 137 int ps3_mmio_region_create(struct ps3_mmio_region *r);
 138 int ps3_free_mmio_region(struct ps3_mmio_region *r);
 139 unsigned long ps3_mm_phys_to_lpar(unsigned long phys_addr);
 140
 141 /* inrerrupt routines */
 142
 143 enum ps3_cpu_binding {
 144         PS3_BINDING_CPU_ANY = -1,
 145         PS3_BINDING_CPU_0 = 0,
 146         PS3_BINDING_CPU_1 = 1,
 147 };
 148
 149 int ps3_alloc_io_irq(enum ps3_cpu_binding cpu, unsigned int interrupt_id,
 150         unsigned int *virq);
 151 int ps3_free_io_irq(unsigned int virq);
 152 int ps3_alloc_event_irq(enum ps3_cpu_binding cpu, unsigned int *virq);
 153 int ps3_free_event_irq(unsigned int virq);
 154 int ps3_send_event_locally(unsigned int virq);
 155 int ps3_connect_event_irq(enum ps3_cpu_binding cpu,
 156         const struct ps3_device_id *did, unsigned int interrupt_id,
 157         unsigned int *virq);
 158 int ps3_disconnect_event_irq(const struct ps3_device_id *did,
 159         unsigned int interrupt_id, unsigned int virq);
 160 int ps3_alloc_vuart_irq(enum ps3_cpu_binding cpu, void* virt_addr_bmp,
 161         unsigned int *virq);
 162 int ps3_free_vuart_irq(unsigned int virq);
 163 int ps3_alloc_spe_irq(enum ps3_cpu_binding cpu, unsigned long spe_id,
 164         unsigned int class, unsigned int *virq);
 165 int ps3_free_spe_irq(unsigned int virq);
 166 int ps3_alloc_irq(enum ps3_cpu_binding cpu, unsigned long outlet,
 167         unsigned int *virq);
 168 int ps3_free_irq(unsigned int virq);
 169
 170 /* lv1 result codes */
 171
 172 enum lv1_result {
 173         LV1_SUCCESS                     = 0,
 174         /* not used                       -1 */
 175         LV1_RESOURCE_SHORTAGE           = -2,
 176         LV1_NO_PRIVILEGE                = -3,
 177         LV1_DENIED_BY_POLICY            = -4,
 178         LV1_ACCESS_VIOLATION            = -5,
 179         LV1_NO_ENTRY                    = -6,
 180         LV1_DUPLICATE_ENTRY             = -7,
 181         LV1_TYPE_MISMATCH               = -8,
 182         LV1_BUSY                        = -9,
 183         LV1_EMPTY                       = -10,
 184         LV1_WRONG_STATE                 = -11,
 185         /* not used                       -12 */
 186         LV1_NO_MATCH                    = -13,
 187         LV1_ALREADY_CONNECTED           = -14,
 188         LV1_UNSUPPORTED_PARAMETER_VALUE = -15,
 189         LV1_CONDITION_NOT_SATISFIED     = -16,
 190         LV1_ILLEGAL_PARAMETER_VALUE     = -17,
 191         LV1_BAD_OPTION                  = -18,
 192         LV1_IMPLEMENTATION_LIMITATION   = -19,
 193         LV1_NOT_IMPLEMENTED             = -20,
 194         LV1_INVALID_CLASS_ID            = -21,
 195         LV1_CONSTRAINT_NOT_SATISFIED    = -22,
 196         LV1_ALIGNMENT_ERROR             = -23,
 197         LV1_INTERNAL_ERROR              = -32768,
 198 };
 199
 200 static inline const char* ps3_result(int result)
 201 {
 202 #if defined(DEBUG)
 203         switch (result) {
 204         case LV1_SUCCESS:
 205                 return "LV1_SUCCESS (0)";
 206         case -1:
 207                 return "** unknown result ** (-1)";
 208         case LV1_RESOURCE_SHORTAGE:
 209                 return "LV1_RESOURCE_SHORTAGE (-2)";
 210         case LV1_NO_PRIVILEGE:
 211                 return "LV1_NO_PRIVILEGE (-3)";
 212         case LV1_DENIED_BY_POLICY:
 213                 return "LV1_DENIED_BY_POLICY (-4)";
 214         case LV1_ACCESS_VIOLATION:
 215                 return "LV1_ACCESS_VIOLATION (-5)";
 216         case LV1_NO_ENTRY:
 217                 return "LV1_NO_ENTRY (-6)";
 218         case LV1_DUPLICATE_ENTRY:
 219                 return "LV1_DUPLICATE_ENTRY (-7)";
 220         case LV1_TYPE_MISMATCH:
 221                 return "LV1_TYPE_MISMATCH (-8)";
 222         case LV1_BUSY:
 223                 return "LV1_BUSY (-9)";
 224         case LV1_EMPTY:
 225                 return "LV1_EMPTY (-10)";
 226         case LV1_WRONG_STATE:
 227                 return "LV1_WRONG_STATE (-11)";
 228         case -12:
 229                 return "** unknown result ** (-12)";
 230         case LV1_NO_MATCH:
 231                 return "LV1_NO_MATCH (-13)";
 232         case LV1_ALREADY_CONNECTED:
 233                 return "LV1_ALREADY_CONNECTED (-14)";
 234         case LV1_UNSUPPORTED_PARAMETER_VALUE:
 235                 return "LV1_UNSUPPORTED_PARAMETER_VALUE (-15)";
 236         case LV1_CONDITION_NOT_SATISFIED:
 237                 return "LV1_CONDITION_NOT_SATISFIED (-16)";
 238         case LV1_ILLEGAL_PARAMETER_VALUE:
 239                 return "LV1_ILLEGAL_PARAMETER_VALUE (-17)";
 240         case LV1_BAD_OPTION:
 241                 return "LV1_BAD_OPTION (-18)";
 242         case LV1_IMPLEMENTATION_LIMITATION:
 243                 return "LV1_IMPLEMENTATION_LIMITATION (-19)";
 244         case LV1_NOT_IMPLEMENTED:
 245                 return "LV1_NOT_IMPLEMENTED (-20)";
 246         case LV1_INVALID_CLASS_ID:
 247                 return "LV1_INVALID_CLASS_ID (-21)";
 248         case LV1_CONSTRAINT_NOT_SATISFIED:
 249                 return "LV1_CONSTRAINT_NOT_SATISFIED (-22)";
 250         case LV1_ALIGNMENT_ERROR:
 251                 return "LV1_ALIGNMENT_ERROR (-23)";
 252         case LV1_INTERNAL_ERROR:
 253                 return "LV1_INTERNAL_ERROR (-32768)";
 254         default:
 255                 BUG();
 256                 return "** unknown result **";
 257         };
 258 #else
 259         return "";
 260 #endif
 261 }
 262
 263 /* repository bus info */
 264
 265 enum ps3_bus_type {
 266         PS3_BUS_TYPE_SB = 4,
 267         PS3_BUS_TYPE_STORAGE = 5,
 268 };
 269
 270 enum ps3_dev_type {
 271         PS3_DEV_TYPE_STOR_DISK = TYPE_DISK,     /* 0 */
 272         PS3_DEV_TYPE_SB_GELIC = 3,
 273         PS3_DEV_TYPE_SB_USB = 4,
 274         PS3_DEV_TYPE_STOR_ROM = TYPE_ROM,       /* 5 */
 275         PS3_DEV_TYPE_SB_GPIO = 6,
 276         PS3_DEV_TYPE_STOR_FLASH = TYPE_RBC,     /* 14 */
 277 };
 278
 279 int ps3_repository_read_bus_str(unsigned int bus_index, const char *bus_str,
 280         u64 *value);
 281 int ps3_repository_read_bus_id(unsigned int bus_index, unsigned int *bus_id);
 282 int ps3_repository_read_bus_type(unsigned int bus_index,
 283         enum ps3_bus_type *bus_type);
 284 int ps3_repository_read_bus_num_dev(unsigned int bus_index,
 285         unsigned int *num_dev);
 286
 287 /* repository bus device info */
 288
 289 enum ps3_interrupt_type {
 290         PS3_INTERRUPT_TYPE_EVENT_PORT = 2,
 291         PS3_INTERRUPT_TYPE_SB_OHCI = 3,
 292         PS3_INTERRUPT_TYPE_SB_EHCI = 4,
 293         PS3_INTERRUPT_TYPE_OTHER = 5,
 294 };
 295
 296 enum ps3_reg_type {
 297         PS3_REG_TYPE_SB_OHCI = 3,
 298         PS3_REG_TYPE_SB_EHCI = 4,
 299         PS3_REG_TYPE_SB_GPIO = 5,
 300 };
 301
 302 int ps3_repository_read_dev_str(unsigned int bus_index,
 303         unsigned int dev_index, const char *dev_str, u64 *value);
 304 int ps3_repository_read_dev_id(unsigned int bus_index, unsigned int dev_index,
 305         unsigned int *dev_id);
 306 int ps3_repository_read_dev_type(unsigned int bus_index,
 307         unsigned int dev_index, enum ps3_dev_type *dev_type);
 308 int ps3_repository_read_dev_intr(unsigned int bus_index,
 309         unsigned int dev_index, unsigned int intr_index,
 310         enum ps3_interrupt_type *intr_type, unsigned int *interrupt_id);
 311 int ps3_repository_read_dev_reg_type(unsigned int bus_index,
 312         unsigned int dev_index, unsigned int reg_index,
 313         enum ps3_reg_type *reg_type);
 314 int ps3_repository_read_dev_reg_addr(unsigned int bus_index,
 315         unsigned int dev_index, unsigned int reg_index, u64 *bus_addr,
 316         u64 *len);
 317 int ps3_repository_read_dev_reg(unsigned int bus_index,
 318         unsigned int dev_index, unsigned int reg_index,
 319         enum ps3_reg_type *reg_type, u64 *bus_addr, u64 *len);
 320
 321 /* repository bus enumerators */
 322
 323 struct ps3_repository_device {
 324         unsigned int bus_index;
 325         unsigned int dev_index;
 326         struct ps3_device_id did;
 327 };
 328
 329 int ps3_repository_find_device(enum ps3_bus_type bus_type,
 330         enum ps3_dev_type dev_type,
 331         const struct ps3_repository_device *start_dev,
 332         struct ps3_repository_device *dev);
 333 static inline int ps3_repository_find_first_device(
 334         enum ps3_bus_type bus_type, enum ps3_dev_type dev_type,
 335         struct ps3_repository_device *dev)
 336 {
 337         return ps3_repository_find_device(bus_type, dev_type, NULL, dev);
 338 }
 339 int ps3_repository_find_interrupt(const struct ps3_repository_device *dev,
 340         enum ps3_interrupt_type intr_type, unsigned int *interrupt_id);
 341 int ps3_repository_find_reg(const struct ps3_repository_device *dev,
 342         enum ps3_reg_type reg_type, u64 *bus_addr, u64 *len);
 343
 344 /* repository block device info */
 345
 346 int ps3_repository_read_stor_dev_port(unsigned int bus_index,
 347         unsigned int dev_index, u64 *port);
 348 int ps3_repository_read_stor_dev_blk_size(unsigned int bus_index,
 349         unsigned int dev_index, u64 *blk_size);
 350 int ps3_repository_read_stor_dev_num_blocks(unsigned int bus_index,
 351         unsigned int dev_index, u64 *num_blocks);
 352 int ps3_repository_read_stor_dev_num_regions(unsigned int bus_index,
 353         unsigned int dev_index, unsigned int *num_regions);
 354 int ps3_repository_read_stor_dev_region_id(unsigned int bus_index,
 355         unsigned int dev_index, unsigned int region_index,
 356         unsigned int *region_id);
 357 int ps3_repository_read_stor_dev_region_size(unsigned int bus_index,
 358         unsigned int dev_index, unsigned int region_index, u64 *region_size);
 359 int ps3_repository_read_stor_dev_region_start(unsigned int bus_index,
 360         unsigned int dev_index, unsigned int region_index, u64 *region_start);
 361 int ps3_repository_read_stor_dev_info(unsigned int bus_index,
 362         unsigned int dev_index, u64 *port, u64 *blk_size,
 363         u64 *num_blocks, unsigned int *num_regions);
 364 int ps3_repository_read_stor_dev_region(unsigned int bus_index,
 365         unsigned int dev_index, unsigned int region_index,
 366         unsigned int *region_id, u64 *region_start, u64 *region_size);
 367
 368 /* repository pu and memory info */
 369
 370 int ps3_repository_read_num_pu(unsigned int *num_pu);
 371 int ps3_repository_read_ppe_id(unsigned int *pu_index, unsigned int *ppe_id);
 372 int ps3_repository_read_rm_base(unsigned int ppe_id, u64 *rm_base);
 373 int ps3_repository_read_rm_size(unsigned int ppe_id, u64 *rm_size);
 374 int ps3_repository_read_region_total(u64 *region_total);
 375 int ps3_repository_read_mm_info(u64 *rm_base, u64 *rm_size,
 376         u64 *region_total);
 377
 378 /* repository pme info */
 379
 380 int ps3_repository_read_num_be(unsigned int *num_be);
 381 int ps3_repository_read_be_node_id(unsigned int be_index, u64 *node_id);
 382 int ps3_repository_read_tb_freq(u64 node_id, u64 *tb_freq);
 383 int ps3_repository_read_be_tb_freq(unsigned int be_index, u64 *tb_freq);
 384
 385 /* repository 'Other OS' area */
 386
 387 int ps3_repository_read_boot_dat_addr(u64 *lpar_addr);
 388 int ps3_repository_read_boot_dat_size(unsigned int *size);
 389 int ps3_repository_read_boot_dat_info(u64 *lpar_addr, unsigned int *size);
 390
 391 /* repository spu info */
 392
 393 /**
 394  * enum spu_resource_type - Type of spu resource.
 395  * @spu_resource_type_shared: Logical spu is shared with other partions.
 396  * @spu_resource_type_exclusive: Logical spu is not shared with other partions.
 397  *
 398  * Returned by ps3_repository_read_spu_resource_id().
 399  */
 400
 401 enum ps3_spu_resource_type {
 402         PS3_SPU_RESOURCE_TYPE_SHARED = 0,
 403         PS3_SPU_RESOURCE_TYPE_EXCLUSIVE = 0x8000000000000000UL,
 404 };
 405
 406 int ps3_repository_read_num_spu_reserved(unsigned int *num_spu_reserved);
 407 int ps3_repository_read_num_spu_resource_id(unsigned int *num_resource_id);
 408 int ps3_repository_read_spu_resource_id(unsigned int res_index,
 409         enum ps3_spu_resource_type* resource_type, unsigned int *resource_id);
 410
 411
 412 /* system bus routines */
 413
 414 enum ps3_match_id {
 415         PS3_MATCH_ID_EHCI = 1,
 416         PS3_MATCH_ID_OHCI,
 417         PS3_MATCH_ID_GELIC,
 418         PS3_MATCH_ID_AV_SETTINGS,
 419         PS3_MATCH_ID_SYSTEM_MANAGER,
 420 };
 421
 422 /**
 423  * struct ps3_system_bus_device - a device on the system bus
 424  */
 425
 426 struct ps3_system_bus_device {
 427         enum ps3_match_id match_id;
 428         struct ps3_device_id did;
 429         unsigned int interrupt_id;
 430 /*      struct iommu_table *iommu_table; -- waiting for Ben's cleanups */
 431         struct ps3_dma_region *d_region;
 432         struct ps3_mmio_region *m_region;
 433         struct device core;
 434 };
 435
 436 /**
 437  * struct ps3_system_bus_driver - a driver for a device on the system bus
 438  */
 439
 440 struct ps3_system_bus_driver {
 441         enum ps3_match_id match_id;
 442         struct device_driver core;
 443         int (*probe)(struct ps3_system_bus_device *);
 444         int (*remove)(struct ps3_system_bus_device *);
 445 /*      int (*suspend)(struct ps3_system_bus_device *, pm_message_t); */
 446 /*      int (*resume)(struct ps3_system_bus_device *); */
 447 };
 448
 449 int ps3_system_bus_device_register(struct ps3_system_bus_device *dev);
 450 int ps3_system_bus_driver_register(struct ps3_system_bus_driver *drv);
 451 void ps3_system_bus_driver_unregister(struct ps3_system_bus_driver *drv);
 452 static inline struct ps3_system_bus_driver *to_ps3_system_bus_driver(
 453         struct device_driver *_drv)
 454 {
 455         return container_of(_drv, struct ps3_system_bus_driver, core);
 456 }
 457 static inline struct ps3_system_bus_device *to_ps3_system_bus_device(
 458         struct device *_dev)
 459 {
 460         return container_of(_dev, struct ps3_system_bus_device, core);
 461 }
 462
 463 /**
 464  * ps3_system_bus_set_drvdata -
 465  * @dev: device structure
 466  * @data: Data to set
 467  */
 468
 469 static inline void ps3_system_bus_set_driver_data(
 470         struct ps3_system_bus_device *dev, void *data)
 471 {
 472         dev->core.driver_data = data;
 473 }
 474 static inline void *ps3_system_bus_get_driver_data(
 475         struct ps3_system_bus_device *dev)
 476 {
 477         return dev->core.driver_data;
 478 }
 479
 480 /* These two need global scope for get_dma_ops(). */
 481
 482 extern struct bus_type ps3_system_bus_type;
 483
 484 #endif