1
linux/include/asm-powerpc/ps3.h
Geoff Levand 66b44954f8 [POWERPC] ps3: get firmware version
Add a new routine ps3_get_firmware_version() and use it to output the firmware
version to dmesg.

Signed-off-by: Geoff Levand <geoffrey.levand@am.sony.com>
Acked-by: Arnd Bergmann <arnd.bergmann@de.ibm.com>
Signed-off-by: Paul Mackerras <paulus@samba.org>
2007-02-07 14:03:18 +11:00

497 lines
15 KiB
C

/*
* PS3 platform declarations.
*
* Copyright (C) 2006 Sony Computer Entertainment Inc.
* Copyright 2006 Sony Corp.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; version 2 of the License.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
#if !defined(_ASM_POWERPC_PS3_H)
#define _ASM_POWERPC_PS3_H
#include <linux/compiler.h> /* for __deprecated */
#include <linux/init.h>
#include <linux/types.h>
#include <linux/device.h>
#include <scsi/scsi.h>
union ps3_firmware_version {
u64 raw;
struct {
u16 pad;
u16 major;
u16 minor;
u16 rev;
};
};
int ps3_get_firmware_version(union ps3_firmware_version *v);
/**
* struct ps3_device_id - HV bus device identifier from the system repository
* @bus_id: HV bus id, {1..} (zero invalid)
* @dev_id: HV device id, {0..}
*/
struct ps3_device_id {
unsigned int bus_id;
unsigned int dev_id;
};
/* dma routines */
enum ps3_dma_page_size {
PS3_DMA_4K = 12U,
PS3_DMA_64K = 16U,
PS3_DMA_1M = 20U,
PS3_DMA_16M = 24U,
};
enum ps3_dma_region_type {
PS3_DMA_OTHER = 0,
PS3_DMA_INTERNAL = 2,
};
/**
* struct ps3_dma_region - A per device dma state variables structure
* @did: The HV device id.
* @page_size: The ioc pagesize.
* @region_type: The HV region type.
* @bus_addr: The 'translated' bus address of the region.
* @len: The length in bytes of the region.
* @chunk_list: Opaque variable used by the ioc page manager.
*/
struct ps3_dma_region {
struct ps3_device_id did;
enum ps3_dma_page_size page_size;
enum ps3_dma_region_type region_type;
unsigned long bus_addr;
unsigned long len;
struct {
spinlock_t lock;
struct list_head head;
} chunk_list;
};
/**
* struct ps3_dma_region_init - Helper to initialize structure variables
*
* Helper to properly initialize variables prior to calling
* ps3_system_bus_device_register.
*/
static inline void ps3_dma_region_init(struct ps3_dma_region *r,
const struct ps3_device_id* did, enum ps3_dma_page_size page_size,
enum ps3_dma_region_type region_type)
{
r->did = *did;
r->page_size = page_size;
r->region_type = region_type;
}
int ps3_dma_region_create(struct ps3_dma_region *r);
int ps3_dma_region_free(struct ps3_dma_region *r);
int ps3_dma_map(struct ps3_dma_region *r, unsigned long virt_addr,
unsigned long len, unsigned long *bus_addr);
int ps3_dma_unmap(struct ps3_dma_region *r, unsigned long bus_addr,
unsigned long len);
/* mmio routines */
enum ps3_mmio_page_size {
PS3_MMIO_4K = 12U,
PS3_MMIO_64K = 16U
};
/**
* struct ps3_mmio_region - a per device mmio state variables structure
*
* Current systems can be supported with a single region per device.
*/
struct ps3_mmio_region {
struct ps3_device_id did;
unsigned long bus_addr;
unsigned long len;
enum ps3_mmio_page_size page_size;
unsigned long lpar_addr;
};
/**
* struct ps3_mmio_region_init - Helper to initialize structure variables
*
* Helper to properly initialize variables prior to calling
* ps3_system_bus_device_register.
*/
static inline void ps3_mmio_region_init(struct ps3_mmio_region *r,
const struct ps3_device_id* did, unsigned long bus_addr,
unsigned long len, enum ps3_mmio_page_size page_size)
{
r->did = *did;
r->bus_addr = bus_addr;
r->len = len;
r->page_size = page_size;
}
int ps3_mmio_region_create(struct ps3_mmio_region *r);
int ps3_free_mmio_region(struct ps3_mmio_region *r);
unsigned long ps3_mm_phys_to_lpar(unsigned long phys_addr);
/* inrerrupt routines */
enum ps3_cpu_binding {
PS3_BINDING_CPU_ANY = -1,
PS3_BINDING_CPU_0 = 0,
PS3_BINDING_CPU_1 = 1,
};
int ps3_alloc_io_irq(enum ps3_cpu_binding cpu, unsigned int interrupt_id,
unsigned int *virq);
int ps3_free_io_irq(unsigned int virq);
int ps3_alloc_event_irq(enum ps3_cpu_binding cpu, unsigned int *virq);
int ps3_free_event_irq(unsigned int virq);
int ps3_send_event_locally(unsigned int virq);
int ps3_connect_event_irq(enum ps3_cpu_binding cpu,
const struct ps3_device_id *did, unsigned int interrupt_id,
unsigned int *virq);
int ps3_disconnect_event_irq(const struct ps3_device_id *did,
unsigned int interrupt_id, unsigned int virq);
int ps3_alloc_vuart_irq(enum ps3_cpu_binding cpu, void* virt_addr_bmp,
unsigned int *virq);
int ps3_free_vuart_irq(unsigned int virq);
int ps3_alloc_spe_irq(enum ps3_cpu_binding cpu, unsigned long spe_id,
unsigned int class, unsigned int *virq);
int ps3_free_spe_irq(unsigned int virq);
int ps3_alloc_irq(enum ps3_cpu_binding cpu, unsigned long outlet,
unsigned int *virq);
int ps3_free_irq(unsigned int virq);
/* lv1 result codes */
enum lv1_result {
LV1_SUCCESS = 0,
/* not used -1 */
LV1_RESOURCE_SHORTAGE = -2,
LV1_NO_PRIVILEGE = -3,
LV1_DENIED_BY_POLICY = -4,
LV1_ACCESS_VIOLATION = -5,
LV1_NO_ENTRY = -6,
LV1_DUPLICATE_ENTRY = -7,
LV1_TYPE_MISMATCH = -8,
LV1_BUSY = -9,
LV1_EMPTY = -10,
LV1_WRONG_STATE = -11,
/* not used -12 */
LV1_NO_MATCH = -13,
LV1_ALREADY_CONNECTED = -14,
LV1_UNSUPPORTED_PARAMETER_VALUE = -15,
LV1_CONDITION_NOT_SATISFIED = -16,
LV1_ILLEGAL_PARAMETER_VALUE = -17,
LV1_BAD_OPTION = -18,
LV1_IMPLEMENTATION_LIMITATION = -19,
LV1_NOT_IMPLEMENTED = -20,
LV1_INVALID_CLASS_ID = -21,
LV1_CONSTRAINT_NOT_SATISFIED = -22,
LV1_ALIGNMENT_ERROR = -23,
LV1_INTERNAL_ERROR = -32768,
};
static inline const char* ps3_result(int result)
{
#if defined(DEBUG)
switch (result) {
case LV1_SUCCESS:
return "LV1_SUCCESS (0)";
case -1:
return "** unknown result ** (-1)";
case LV1_RESOURCE_SHORTAGE:
return "LV1_RESOURCE_SHORTAGE (-2)";
case LV1_NO_PRIVILEGE:
return "LV1_NO_PRIVILEGE (-3)";
case LV1_DENIED_BY_POLICY:
return "LV1_DENIED_BY_POLICY (-4)";
case LV1_ACCESS_VIOLATION:
return "LV1_ACCESS_VIOLATION (-5)";
case LV1_NO_ENTRY:
return "LV1_NO_ENTRY (-6)";
case LV1_DUPLICATE_ENTRY:
return "LV1_DUPLICATE_ENTRY (-7)";
case LV1_TYPE_MISMATCH:
return "LV1_TYPE_MISMATCH (-8)";
case LV1_BUSY:
return "LV1_BUSY (-9)";
case LV1_EMPTY:
return "LV1_EMPTY (-10)";
case LV1_WRONG_STATE:
return "LV1_WRONG_STATE (-11)";
case -12:
return "** unknown result ** (-12)";
case LV1_NO_MATCH:
return "LV1_NO_MATCH (-13)";
case LV1_ALREADY_CONNECTED:
return "LV1_ALREADY_CONNECTED (-14)";
case LV1_UNSUPPORTED_PARAMETER_VALUE:
return "LV1_UNSUPPORTED_PARAMETER_VALUE (-15)";
case LV1_CONDITION_NOT_SATISFIED:
return "LV1_CONDITION_NOT_SATISFIED (-16)";
case LV1_ILLEGAL_PARAMETER_VALUE:
return "LV1_ILLEGAL_PARAMETER_VALUE (-17)";
case LV1_BAD_OPTION:
return "LV1_BAD_OPTION (-18)";
case LV1_IMPLEMENTATION_LIMITATION:
return "LV1_IMPLEMENTATION_LIMITATION (-19)";
case LV1_NOT_IMPLEMENTED:
return "LV1_NOT_IMPLEMENTED (-20)";
case LV1_INVALID_CLASS_ID:
return "LV1_INVALID_CLASS_ID (-21)";
case LV1_CONSTRAINT_NOT_SATISFIED:
return "LV1_CONSTRAINT_NOT_SATISFIED (-22)";
case LV1_ALIGNMENT_ERROR:
return "LV1_ALIGNMENT_ERROR (-23)";
case LV1_INTERNAL_ERROR:
return "LV1_INTERNAL_ERROR (-32768)";
default:
BUG();
return "** unknown result **";
};
#else
return "";
#endif
}
/* repository bus info */
enum ps3_bus_type {
PS3_BUS_TYPE_SB = 4,
PS3_BUS_TYPE_STORAGE = 5,
};
enum ps3_dev_type {
PS3_DEV_TYPE_STOR_DISK = TYPE_DISK, /* 0 */
PS3_DEV_TYPE_SB_GELIC = 3,
PS3_DEV_TYPE_SB_USB = 4,
PS3_DEV_TYPE_STOR_ROM = TYPE_ROM, /* 5 */
PS3_DEV_TYPE_SB_GPIO = 6,
PS3_DEV_TYPE_STOR_FLASH = TYPE_RBC, /* 14 */
};
int ps3_repository_read_bus_str(unsigned int bus_index, const char *bus_str,
u64 *value);
int ps3_repository_read_bus_id(unsigned int bus_index, unsigned int *bus_id);
int ps3_repository_read_bus_type(unsigned int bus_index,
enum ps3_bus_type *bus_type);
int ps3_repository_read_bus_num_dev(unsigned int bus_index,
unsigned int *num_dev);
/* repository bus device info */
enum ps3_interrupt_type {
PS3_INTERRUPT_TYPE_EVENT_PORT = 2,
PS3_INTERRUPT_TYPE_SB_OHCI = 3,
PS3_INTERRUPT_TYPE_SB_EHCI = 4,
PS3_INTERRUPT_TYPE_OTHER = 5,
};
enum ps3_reg_type {
PS3_REG_TYPE_SB_OHCI = 3,
PS3_REG_TYPE_SB_EHCI = 4,
PS3_REG_TYPE_SB_GPIO = 5,
};
int ps3_repository_read_dev_str(unsigned int bus_index,
unsigned int dev_index, const char *dev_str, u64 *value);
int ps3_repository_read_dev_id(unsigned int bus_index, unsigned int dev_index,
unsigned int *dev_id);
int ps3_repository_read_dev_type(unsigned int bus_index,
unsigned int dev_index, enum ps3_dev_type *dev_type);
int ps3_repository_read_dev_intr(unsigned int bus_index,
unsigned int dev_index, unsigned int intr_index,
enum ps3_interrupt_type *intr_type, unsigned int *interrupt_id);
int ps3_repository_read_dev_reg_type(unsigned int bus_index,
unsigned int dev_index, unsigned int reg_index,
enum ps3_reg_type *reg_type);
int ps3_repository_read_dev_reg_addr(unsigned int bus_index,
unsigned int dev_index, unsigned int reg_index, u64 *bus_addr,
u64 *len);
int ps3_repository_read_dev_reg(unsigned int bus_index,
unsigned int dev_index, unsigned int reg_index,
enum ps3_reg_type *reg_type, u64 *bus_addr, u64 *len);
/* repository bus enumerators */
struct ps3_repository_device {
unsigned int bus_index;
unsigned int dev_index;
struct ps3_device_id did;
};
int ps3_repository_find_device(enum ps3_bus_type bus_type,
enum ps3_dev_type dev_type,
const struct ps3_repository_device *start_dev,
struct ps3_repository_device *dev);
static inline int ps3_repository_find_first_device(
enum ps3_bus_type bus_type, enum ps3_dev_type dev_type,
struct ps3_repository_device *dev)
{
return ps3_repository_find_device(bus_type, dev_type, NULL, dev);
}
int ps3_repository_find_interrupt(const struct ps3_repository_device *dev,
enum ps3_interrupt_type intr_type, unsigned int *interrupt_id);
int ps3_repository_find_reg(const struct ps3_repository_device *dev,
enum ps3_reg_type reg_type, u64 *bus_addr, u64 *len);
/* repository block device info */
int ps3_repository_read_stor_dev_port(unsigned int bus_index,
unsigned int dev_index, u64 *port);
int ps3_repository_read_stor_dev_blk_size(unsigned int bus_index,
unsigned int dev_index, u64 *blk_size);
int ps3_repository_read_stor_dev_num_blocks(unsigned int bus_index,
unsigned int dev_index, u64 *num_blocks);
int ps3_repository_read_stor_dev_num_regions(unsigned int bus_index,
unsigned int dev_index, unsigned int *num_regions);
int ps3_repository_read_stor_dev_region_id(unsigned int bus_index,
unsigned int dev_index, unsigned int region_index,
unsigned int *region_id);
int ps3_repository_read_stor_dev_region_size(unsigned int bus_index,
unsigned int dev_index, unsigned int region_index, u64 *region_size);
int ps3_repository_read_stor_dev_region_start(unsigned int bus_index,
unsigned int dev_index, unsigned int region_index, u64 *region_start);
int ps3_repository_read_stor_dev_info(unsigned int bus_index,
unsigned int dev_index, u64 *port, u64 *blk_size,
u64 *num_blocks, unsigned int *num_regions);
int ps3_repository_read_stor_dev_region(unsigned int bus_index,
unsigned int dev_index, unsigned int region_index,
unsigned int *region_id, u64 *region_start, u64 *region_size);
/* repository pu and memory info */
int ps3_repository_read_num_pu(unsigned int *num_pu);
int ps3_repository_read_ppe_id(unsigned int *pu_index, unsigned int *ppe_id);
int ps3_repository_read_rm_base(unsigned int ppe_id, u64 *rm_base);
int ps3_repository_read_rm_size(unsigned int ppe_id, u64 *rm_size);
int ps3_repository_read_region_total(u64 *region_total);
int ps3_repository_read_mm_info(u64 *rm_base, u64 *rm_size,
u64 *region_total);
/* repository pme info */
int ps3_repository_read_num_be(unsigned int *num_be);
int ps3_repository_read_be_node_id(unsigned int be_index, u64 *node_id);
int ps3_repository_read_tb_freq(u64 node_id, u64 *tb_freq);
int ps3_repository_read_be_tb_freq(unsigned int be_index, u64 *tb_freq);
/* repository 'Other OS' area */
int ps3_repository_read_boot_dat_addr(u64 *lpar_addr);
int ps3_repository_read_boot_dat_size(unsigned int *size);
int ps3_repository_read_boot_dat_info(u64 *lpar_addr, unsigned int *size);
/* repository spu info */
/**
* enum spu_resource_type - Type of spu resource.
* @spu_resource_type_shared: Logical spu is shared with other partions.
* @spu_resource_type_exclusive: Logical spu is not shared with other partions.
*
* Returned by ps3_repository_read_spu_resource_id().
*/
enum ps3_spu_resource_type {
PS3_SPU_RESOURCE_TYPE_SHARED = 0,
PS3_SPU_RESOURCE_TYPE_EXCLUSIVE = 0x8000000000000000UL,
};
int ps3_repository_read_num_spu_reserved(unsigned int *num_spu_reserved);
int ps3_repository_read_num_spu_resource_id(unsigned int *num_resource_id);
int ps3_repository_read_spu_resource_id(unsigned int res_index,
enum ps3_spu_resource_type* resource_type, unsigned int *resource_id);
/* system bus routines */
enum ps3_match_id {
PS3_MATCH_ID_EHCI = 1,
PS3_MATCH_ID_OHCI,
PS3_MATCH_ID_GELIC,
PS3_MATCH_ID_AV_SETTINGS,
PS3_MATCH_ID_SYSTEM_MANAGER,
};
/**
* struct ps3_system_bus_device - a device on the system bus
*/
struct ps3_system_bus_device {
enum ps3_match_id match_id;
struct ps3_device_id did;
unsigned int interrupt_id;
/* struct iommu_table *iommu_table; -- waiting for Ben's cleanups */
struct ps3_dma_region *d_region;
struct ps3_mmio_region *m_region;
struct device core;
};
/**
* struct ps3_system_bus_driver - a driver for a device on the system bus
*/
struct ps3_system_bus_driver {
enum ps3_match_id match_id;
struct device_driver core;
int (*probe)(struct ps3_system_bus_device *);
int (*remove)(struct ps3_system_bus_device *);
/* int (*suspend)(struct ps3_system_bus_device *, pm_message_t); */
/* int (*resume)(struct ps3_system_bus_device *); */
};
int ps3_system_bus_device_register(struct ps3_system_bus_device *dev);
int ps3_system_bus_driver_register(struct ps3_system_bus_driver *drv);
void ps3_system_bus_driver_unregister(struct ps3_system_bus_driver *drv);
static inline struct ps3_system_bus_driver *to_ps3_system_bus_driver(
struct device_driver *_drv)
{
return container_of(_drv, struct ps3_system_bus_driver, core);
}
static inline struct ps3_system_bus_device *to_ps3_system_bus_device(
struct device *_dev)
{
return container_of(_dev, struct ps3_system_bus_device, core);
}
/**
* ps3_system_bus_set_drvdata -
* @dev: device structure
* @data: Data to set
*/
static inline void ps3_system_bus_set_driver_data(
struct ps3_system_bus_device *dev, void *data)
{
dev->core.driver_data = data;
}
static inline void *ps3_system_bus_get_driver_data(
struct ps3_system_bus_device *dev)
{
return dev->core.driver_data;
}
/* These two need global scope for get_dma_ops(). */
extern struct bus_type ps3_system_bus_type;
#endif