[linux-2.6-block.git] / arch / powerpc / include / asm / ps3.h

/*
 *  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/init.h>
#include <linux/types.h>
#include <linux/device.h>
#include "cell-pmu.h"

union ps3_firmware_version {
	u64 raw;
	struct {
		u16 pad;
		u16 major;
		u16 minor;
		u16 rev;
	};
};

void ps3_get_firmware_version(union ps3_firmware_version *v);
int ps3_compare_firmware_version(u16 major, u16 minor, u16 rev);

/* 'Other OS' area */

enum ps3_param_av_multi_out {
	PS3_PARAM_AV_MULTI_OUT_NTSC = 0,
	PS3_PARAM_AV_MULTI_OUT_PAL_RGB = 1,
	PS3_PARAM_AV_MULTI_OUT_PAL_YCBCR = 2,
	PS3_PARAM_AV_MULTI_OUT_SECAM = 3,
};

enum ps3_param_av_multi_out ps3_os_area_get_av_multi_out(void);

extern u64 ps3_os_area_get_rtc_diff(void);
extern void ps3_os_area_set_rtc_diff(u64 rtc_diff);

/* 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_ops;

/**
 * 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.
 * @offset: The offset from the start of memory of the region.
 * @ioid: The IOID of the device who owns this region
 * @chunk_list: Opaque variable used by the ioc page manager.
 * @region_ops: struct ps3_dma_region_ops - dma region operations
 */

struct ps3_dma_region {
	struct ps3_system_bus_device *dev;
	/* device variables */
	const struct ps3_dma_region_ops *region_ops;
	unsigned char ioid;
	enum ps3_dma_page_size page_size;
	enum ps3_dma_region_type region_type;
	unsigned long len;
	unsigned long offset;

	/* driver variables  (set by ps3_dma_region_create) */
	unsigned long bus_addr;
	struct {
		spinlock_t lock;
		struct list_head head;
	} chunk_list;
};

struct ps3_dma_region_ops {
	int (*create)(struct ps3_dma_region *);
	int (*free)(struct ps3_dma_region *);
	int (*map)(struct ps3_dma_region *,
		   unsigned long virt_addr,
		   unsigned long len,
		   dma_addr_t *bus_addr,
		   u64 iopte_pp);
	int (*unmap)(struct ps3_dma_region *,
		     dma_addr_t bus_addr,
		     unsigned long len);
};
/**
 * struct ps3_dma_region_init - Helper to initialize structure variables
 *
 * Helper to properly initialize variables prior to calling
 * ps3_system_bus_device_register.
 */

struct ps3_system_bus_device;

int ps3_dma_region_init(struct ps3_system_bus_device *dev,
	struct ps3_dma_region *r, enum ps3_dma_page_size page_size,
	enum ps3_dma_region_type region_type, void *addr, unsigned long len);
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, dma_addr_t *bus_addr,
	u64 iopte_pp);
int ps3_dma_unmap(struct ps3_dma_region *r, dma_addr_t bus_addr,
	unsigned long len);

/* mmio routines */

enum ps3_mmio_page_size {
	PS3_MMIO_4K = 12U,
	PS3_MMIO_64K = 16U
};

struct ps3_mmio_region_ops;
/**
 * 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_system_bus_device *dev;
	const struct ps3_mmio_region_ops *mmio_ops;
	unsigned long bus_addr;
	unsigned long len;
	enum ps3_mmio_page_size page_size;
	unsigned long lpar_addr;
};

struct ps3_mmio_region_ops {
	int (*create)(struct ps3_mmio_region *);
	int (*free)(struct ps3_mmio_region *);
};
/**
 * struct ps3_mmio_region_init - Helper to initialize structure variables
 *
 * Helper to properly initialize variables prior to calling
 * ps3_system_bus_device_register.
 */

int ps3_mmio_region_init(struct ps3_system_bus_device *dev,
	struct ps3_mmio_region *r, unsigned long bus_addr, unsigned long len,
	enum ps3_mmio_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_irq_plug_setup(enum ps3_cpu_binding cpu, unsigned long outlet,
	unsigned int *virq);
int ps3_irq_plug_destroy(unsigned int virq);
int ps3_event_receive_port_setup(enum ps3_cpu_binding cpu, unsigned int *virq);
int ps3_event_receive_port_destroy(unsigned int virq);
int ps3_send_event_locally(unsigned int virq);

int ps3_io_irq_setup(enum ps3_cpu_binding cpu, unsigned int interrupt_id,
	unsigned int *virq);
int ps3_io_irq_destroy(unsigned int virq);
int ps3_vuart_irq_setup(enum ps3_cpu_binding cpu, void* virt_addr_bmp,
	unsigned int *virq);
int ps3_vuart_irq_destroy(unsigned int virq);
int ps3_spe_irq_setup(enum ps3_cpu_binding cpu, unsigned long spe_id,
	unsigned int class, unsigned int *virq);
int ps3_spe_irq_destroy(unsigned int virq);

int ps3_sb_event_receive_port_setup(struct ps3_system_bus_device *dev,
	enum ps3_cpu_binding cpu, unsigned int *virq);
int ps3_sb_event_receive_port_destroy(struct ps3_system_bus_device *dev,
	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_HARDWARE_ERROR              = -24,
	LV1_INVALID_DATA_FORMAT         = -25,
	LV1_INVALID_OPERATION           = -26,
	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_HARDWARE_ERROR:
		return "LV1_HARDWARE_ERROR (-24)";
	case LV1_INVALID_DATA_FORMAT:
		return "LV1_INVALID_DATA_FORMAT (-25)";
	case LV1_INVALID_OPERATION:
		return "LV1_INVALID_OPERATION (-26)";
	case LV1_INTERNAL_ERROR:
		return "LV1_INTERNAL_ERROR (-32768)";
	default:
		BUG();
		return "** unknown result **";
	};
#else
	return "";
#endif
}

/* system bus routines */

enum ps3_match_id {
	PS3_MATCH_ID_EHCI		= 1,
	PS3_MATCH_ID_OHCI		= 2,
	PS3_MATCH_ID_GELIC		= 3,
	PS3_MATCH_ID_AV_SETTINGS	= 4,
	PS3_MATCH_ID_SYSTEM_MANAGER	= 5,
	PS3_MATCH_ID_STOR_DISK		= 6,
	PS3_MATCH_ID_STOR_ROM		= 7,
	PS3_MATCH_ID_STOR_FLASH		= 8,
	PS3_MATCH_ID_SOUND		= 9,
	PS3_MATCH_ID_GPU		= 10,
	PS3_MATCH_ID_LPM		= 11,
};

enum ps3_match_sub_id {
	PS3_MATCH_SUB_ID_GPU_FB		= 1,
	PS3_MATCH_SUB_ID_GPU_RAMDISK	= 2,
};

#define PS3_MODULE_ALIAS_EHCI		"ps3:1:0"
#define PS3_MODULE_ALIAS_OHCI		"ps3:2:0"
#define PS3_MODULE_ALIAS_GELIC		"ps3:3:0"
#define PS3_MODULE_ALIAS_AV_SETTINGS	"ps3:4:0"
#define PS3_MODULE_ALIAS_SYSTEM_MANAGER	"ps3:5:0"
#define PS3_MODULE_ALIAS_STOR_DISK	"ps3:6:0"
#define PS3_MODULE_ALIAS_STOR_ROM	"ps3:7:0"
#define PS3_MODULE_ALIAS_STOR_FLASH	"ps3:8:0"
#define PS3_MODULE_ALIAS_SOUND		"ps3:9:0"
#define PS3_MODULE_ALIAS_GPU_FB		"ps3:10:1"
#define PS3_MODULE_ALIAS_GPU_RAMDISK	"ps3:10:2"
#define PS3_MODULE_ALIAS_LPM		"ps3:11:0"

enum ps3_system_bus_device_type {
	PS3_DEVICE_TYPE_IOC0 = 1,
	PS3_DEVICE_TYPE_SB,
	PS3_DEVICE_TYPE_VUART,
	PS3_DEVICE_TYPE_LPM,
};

/**
 * struct ps3_system_bus_device - a device on the system bus
 */

struct ps3_system_bus_device {
	enum ps3_match_id match_id;
	enum ps3_match_sub_id match_sub_id;
	enum ps3_system_bus_device_type dev_type;

	u64 bus_id;                       /* SB */
	u64 dev_id;                       /* SB */
	unsigned int interrupt_id;        /* SB */
	struct ps3_dma_region *d_region;  /* SB, IOC0 */
	struct ps3_mmio_region *m_region; /* SB, IOC0*/
	unsigned int port_number;         /* VUART */
	struct {                          /* LPM */
		u64 node_id;
		u64 pu_id;
		u64 rights;
	} lpm;

/*	struct iommu_table *iommu_table; -- waiting for BenH's cleanups */
	struct device core;
	void *driver_priv; /* private driver variables */
};

int ps3_open_hv_device(struct ps3_system_bus_device *dev);
int ps3_close_hv_device(struct ps3_system_bus_device *dev);

/**
 * 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;
	enum ps3_match_sub_id match_sub_id;
	struct device_driver core;
	int (*probe)(struct ps3_system_bus_device *);
	int (*remove)(struct ps3_system_bus_device *);
	int (*shutdown)(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 *ps3_drv_to_system_bus_drv(
	struct device_driver *_drv)
{
	return container_of(_drv, struct ps3_system_bus_driver, core);
}
static inline struct ps3_system_bus_device *ps3_dev_to_system_bus_dev(
	struct device *_dev)
{
	return container_of(_dev, struct ps3_system_bus_device, core);
}
static inline struct ps3_system_bus_driver *
	ps3_system_bus_dev_to_system_bus_drv(struct ps3_system_bus_device *_dev)
{
	BUG_ON(!_dev);
	BUG_ON(!_dev->core.driver);
	return ps3_drv_to_system_bus_drv(_dev->core.driver);
}

/**
 * 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;

/* system manager */

struct ps3_sys_manager_ops {
	struct ps3_system_bus_device *dev;
	void (*power_off)(struct ps3_system_bus_device *dev);
	void (*restart)(struct ps3_system_bus_device *dev);
};

void ps3_sys_manager_register_ops(const struct ps3_sys_manager_ops *ops);
void __noreturn ps3_sys_manager_power_off(void);
void __noreturn ps3_sys_manager_restart(void);
void __noreturn ps3_sys_manager_halt(void);
int ps3_sys_manager_get_wol(void);
void ps3_sys_manager_set_wol(int state);

struct ps3_prealloc {
    const char *name;
    void *address;
    unsigned long size;
    unsigned long align;
};

extern struct ps3_prealloc ps3fb_videomemory;
extern struct ps3_prealloc ps3flash_bounce_buffer;

/* logical performance monitor */

/**
 * enum ps3_lpm_rights - Rigths granted by the system policy module.
 *
 * @PS3_LPM_RIGHTS_USE_LPM: The right to use the lpm.
 * @PS3_LPM_RIGHTS_USE_TB: The right to use the internal trace buffer.
 */

enum ps3_lpm_rights {
	PS3_LPM_RIGHTS_USE_LPM = 0x001,
	PS3_LPM_RIGHTS_USE_TB = 0x100,
};

/**
 * enum ps3_lpm_tb_type - Type of trace buffer lv1 should use.
 *
 * @PS3_LPM_TB_TYPE_NONE: Do not use a trace buffer.
 * @PS3_LPM_RIGHTS_USE_TB: Use the lv1 internal trace buffer.  Must have
 *  rights @PS3_LPM_RIGHTS_USE_TB.
 */

enum ps3_lpm_tb_type {
	PS3_LPM_TB_TYPE_NONE = 0,
	PS3_LPM_TB_TYPE_INTERNAL = 1,
};

int ps3_lpm_open(enum ps3_lpm_tb_type tb_type, void *tb_cache,
	u64 tb_cache_size);
int ps3_lpm_close(void);
int ps3_lpm_copy_tb(unsigned long offset, void *buf, unsigned long count,
	unsigned long *bytes_copied);
int ps3_lpm_copy_tb_to_user(unsigned long offset, void __user *buf,
	unsigned long count, unsigned long *bytes_copied);
void ps3_set_bookmark(u64 bookmark);
void ps3_set_pm_bookmark(u64 tag, u64 incident, u64 th_id);
int ps3_set_signal(u64 rtas_signal_group, u8 signal_bit, u16 sub_unit,
	u8 bus_word);

u32 ps3_read_phys_ctr(u32 cpu, u32 phys_ctr);
void ps3_write_phys_ctr(u32 cpu, u32 phys_ctr, u32 val);
u32 ps3_read_ctr(u32 cpu, u32 ctr);
void ps3_write_ctr(u32 cpu, u32 ctr, u32 val);

u32 ps3_read_pm07_control(u32 cpu, u32 ctr);
void ps3_write_pm07_control(u32 cpu, u32 ctr, u32 val);
u32 ps3_read_pm(u32 cpu, enum pm_reg_name reg);
void ps3_write_pm(u32 cpu, enum pm_reg_name reg, u32 val);

u32 ps3_get_ctr_size(u32 cpu, u32 phys_ctr);
void ps3_set_ctr_size(u32 cpu, u32 phys_ctr, u32 ctr_size);

void ps3_enable_pm(u32 cpu);
void ps3_disable_pm(u32 cpu);
void ps3_enable_pm_interrupts(u32 cpu, u32 thread, u32 mask);
void ps3_disable_pm_interrupts(u32 cpu);

u32 ps3_get_and_clear_pm_interrupts(u32 cpu);
void ps3_sync_irq(int node);
u32 ps3_get_hw_thread_id(int cpu);
u64 ps3_get_spe_id(void *arg);

/* mutex synchronizing GPU accesses and video mode changes */
extern struct mutex ps3_gpu_mutex;

#endif
Commit	Line	Data
f58a9d17 GL	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
f58a9d17 GL	24	#include <linux/init.h>
	25	#include <linux/types.h>
	26	#include <linux/device.h>
781749a4	27	#include "cell-pmu.h"
f58a9d17	28
66b44954 GL	29	union ps3_firmware_version {
	30	u64 raw;
	31	struct {
	32	u16 pad;
	33	u16 major;
	34	u16 minor;
	35	u16 rev;
	36	};
	37	};
	38
1322810c MM	39	void ps3_get_firmware_version(union ps3_firmware_version *v);
1322810c MM	40	int ps3_compare_firmware_version(u16 major, u16 minor, u16 rev);
66b44954	41
098e2744 GU	42	/* 'Other OS' area */
	43
	44	enum ps3_param_av_multi_out {
	45	PS3_PARAM_AV_MULTI_OUT_NTSC = 0,
	46	PS3_PARAM_AV_MULTI_OUT_PAL_RGB = 1,
	47	PS3_PARAM_AV_MULTI_OUT_PAL_YCBCR = 2,
	48	PS3_PARAM_AV_MULTI_OUT_SECAM = 3,
	49	};
	50
	51	enum ps3_param_av_multi_out ps3_os_area_get_av_multi_out(void);
	52
0b5f037a GU	53	extern u64 ps3_os_area_get_rtc_diff(void);
	54	extern void ps3_os_area_set_rtc_diff(u64 rtc_diff);
	55
f58a9d17 GL	56	/* dma routines */
	57
	58	enum ps3_dma_page_size {
	59	PS3_DMA_4K = 12U,
	60	PS3_DMA_64K = 16U,
	61	PS3_DMA_1M = 20U,
	62	PS3_DMA_16M = 24U,
	63	};
	64
	65	enum ps3_dma_region_type {
	66	PS3_DMA_OTHER = 0,
	67	PS3_DMA_INTERNAL = 2,
	68	};
	69
6bb5cf10 GL	70	struct ps3_dma_region_ops;
6bb5cf10 GL	71
f58a9d17 GL	72	/**
	73	* struct ps3_dma_region - A per device dma state variables structure
	74	* @did: The HV device id.
	75	* @page_size: The ioc pagesize.
	76	* @region_type: The HV region type.
	77	* @bus_addr: The 'translated' bus address of the region.
	78	* @len: The length in bytes of the region.
6bb5cf10 GL	79	* @offset: The offset from the start of memory of the region.
6bb5cf10 GL	80	* @ioid: The IOID of the device who owns this region
f58a9d17	81	* @chunk_list: Opaque variable used by the ioc page manager.
6bb5cf10	82	* @region_ops: struct ps3_dma_region_ops - dma region operations
f58a9d17 GL	83	*/
	84
	85	struct ps3_dma_region {
6bb5cf10 GL	86	struct ps3_system_bus_device *dev;
	87	/* device variables */
	88	const struct ps3_dma_region_ops *region_ops;
	89	unsigned char ioid;
f58a9d17 GL	90	enum ps3_dma_page_size page_size;
f58a9d17 GL	91	enum ps3_dma_region_type region_type;
f58a9d17	92	unsigned long len;
6bb5cf10 GL	93	unsigned long offset;
	94
	95	/* driver variables (set by ps3_dma_region_create) */
	96	unsigned long bus_addr;
f58a9d17 GL	97	struct {
	98	spinlock_t lock;
	99	struct list_head head;
	100	} chunk_list;
	101	};
	102
6bb5cf10 GL	103	struct ps3_dma_region_ops {
	104	int (create)(struct ps3_dma_region );
	105	int (free)(struct ps3_dma_region );
	106	int (map)(struct ps3_dma_region ,
	107	unsigned long virt_addr,
	108	unsigned long len,
494fd07a	109	dma_addr_t *bus_addr,
6bb5cf10 GL	110	u64 iopte_pp);
6bb5cf10 GL	111	int (unmap)(struct ps3_dma_region ,
494fd07a	112	dma_addr_t bus_addr,
6bb5cf10 GL	113	unsigned long len);
6bb5cf10 GL	114	};
f58a9d17 GL	115	/**
	116	* struct ps3_dma_region_init - Helper to initialize structure variables
	117	*
	118	* Helper to properly initialize variables prior to calling
	119	* ps3_system_bus_device_register.
	120	*/
	121
6bb5cf10 GL	122	struct ps3_system_bus_device;
	123
	124	int ps3_dma_region_init(struct ps3_system_bus_device *dev,
	125	struct ps3_dma_region *r, enum ps3_dma_page_size page_size,
	126	enum ps3_dma_region_type region_type, void *addr, unsigned long len);
f58a9d17 GL	127	int ps3_dma_region_create(struct ps3_dma_region *r);
	128	int ps3_dma_region_free(struct ps3_dma_region *r);
	129	int ps3_dma_map(struct ps3_dma_region *r, unsigned long virt_addr,
494fd07a	130	unsigned long len, dma_addr_t *bus_addr,
6bb5cf10	131	u64 iopte_pp);
494fd07a	132	int ps3_dma_unmap(struct ps3_dma_region *r, dma_addr_t bus_addr,
f58a9d17 GL	133	unsigned long len);
	134
	135	/* mmio routines */
	136
	137	enum ps3_mmio_page_size {
	138	PS3_MMIO_4K = 12U,
	139	PS3_MMIO_64K = 16U
	140	};
	141
6bb5cf10	142	struct ps3_mmio_region_ops;
f58a9d17 GL	143	/**
	144	* struct ps3_mmio_region - a per device mmio state variables structure
	145	*
	146	* Current systems can be supported with a single region per device.
	147	*/
	148
	149	struct ps3_mmio_region {
6bb5cf10 GL	150	struct ps3_system_bus_device *dev;
6bb5cf10 GL	151	const struct ps3_mmio_region_ops *mmio_ops;
f58a9d17 GL	152	unsigned long bus_addr;
	153	unsigned long len;
	154	enum ps3_mmio_page_size page_size;
	155	unsigned long lpar_addr;
	156	};
	157
6bb5cf10 GL	158	struct ps3_mmio_region_ops {
	159	int (create)(struct ps3_mmio_region );
	160	int (free)(struct ps3_mmio_region );
	161	};
f58a9d17 GL	162	/**
	163	* struct ps3_mmio_region_init - Helper to initialize structure variables
	164	*
	165	* Helper to properly initialize variables prior to calling
	166	* ps3_system_bus_device_register.
	167	*/
	168
6bb5cf10 GL	169	int ps3_mmio_region_init(struct ps3_system_bus_device *dev,
	170	struct ps3_mmio_region *r, unsigned long bus_addr, unsigned long len,
	171	enum ps3_mmio_page_size page_size);
f58a9d17 GL	172	int ps3_mmio_region_create(struct ps3_mmio_region *r);
	173	int ps3_free_mmio_region(struct ps3_mmio_region *r);
	174	unsigned long ps3_mm_phys_to_lpar(unsigned long phys_addr);
	175
	176	/* inrerrupt routines */
	177
861be32c GL	178	enum ps3_cpu_binding {
	179	PS3_BINDING_CPU_ANY = -1,
	180	PS3_BINDING_CPU_0 = 0,
	181	PS3_BINDING_CPU_1 = 1,
	182	};
	183
dc4f60c2 GL	184	int ps3_irq_plug_setup(enum ps3_cpu_binding cpu, unsigned long outlet,
	185	unsigned int *virq);
	186	int ps3_irq_plug_destroy(unsigned int virq);
	187	int ps3_event_receive_port_setup(enum ps3_cpu_binding cpu, unsigned int *virq);
	188	int ps3_event_receive_port_destroy(unsigned int virq);
f58a9d17	189	int ps3_send_event_locally(unsigned int virq);
dc4f60c2 GL	190
dc4f60c2 GL	191	int ps3_io_irq_setup(enum ps3_cpu_binding cpu, unsigned int interrupt_id,
861be32c	192	unsigned int *virq);
dc4f60c2 GL	193	int ps3_io_irq_destroy(unsigned int virq);
dc4f60c2 GL	194	int ps3_vuart_irq_setup(enum ps3_cpu_binding cpu, void* virt_addr_bmp,
f58a9d17	195	unsigned int *virq);
dc4f60c2 GL	196	int ps3_vuart_irq_destroy(unsigned int virq);
dc4f60c2 GL	197	int ps3_spe_irq_setup(enum ps3_cpu_binding cpu, unsigned long spe_id,
861be32c	198	unsigned int class, unsigned int *virq);
dc4f60c2 GL	199	int ps3_spe_irq_destroy(unsigned int virq);
dc4f60c2 GL	200
6bb5cf10 GL	201	int ps3_sb_event_receive_port_setup(struct ps3_system_bus_device *dev,
	202	enum ps3_cpu_binding cpu, unsigned int *virq);
	203	int ps3_sb_event_receive_port_destroy(struct ps3_system_bus_device *dev,
	204	unsigned int virq);
f58a9d17 GL	205
	206	/* lv1 result codes */
	207
	208	enum lv1_result {
	209	LV1_SUCCESS = 0,
	210	/* not used -1 */
	211	LV1_RESOURCE_SHORTAGE = -2,
	212	LV1_NO_PRIVILEGE = -3,
	213	LV1_DENIED_BY_POLICY = -4,
	214	LV1_ACCESS_VIOLATION = -5,
	215	LV1_NO_ENTRY = -6,
	216	LV1_DUPLICATE_ENTRY = -7,
	217	LV1_TYPE_MISMATCH = -8,
	218	LV1_BUSY = -9,
	219	LV1_EMPTY = -10,
	220	LV1_WRONG_STATE = -11,
	221	/* not used -12 */
	222	LV1_NO_MATCH = -13,
	223	LV1_ALREADY_CONNECTED = -14,
	224	LV1_UNSUPPORTED_PARAMETER_VALUE = -15,
	225	LV1_CONDITION_NOT_SATISFIED = -16,
	226	LV1_ILLEGAL_PARAMETER_VALUE = -17,
	227	LV1_BAD_OPTION = -18,
	228	LV1_IMPLEMENTATION_LIMITATION = -19,
	229	LV1_NOT_IMPLEMENTED = -20,
	230	LV1_INVALID_CLASS_ID = -21,
	231	LV1_CONSTRAINT_NOT_SATISFIED = -22,
	232	LV1_ALIGNMENT_ERROR = -23,
06462d92 GU	233	LV1_HARDWARE_ERROR = -24,
	234	LV1_INVALID_DATA_FORMAT = -25,
	235	LV1_INVALID_OPERATION = -26,
f58a9d17 GL	236	LV1_INTERNAL_ERROR = -32768,
	237	};
	238
	239	static inline const char* ps3_result(int result)
	240	{
	241	#if defined(DEBUG)
	242	switch (result) {
	243	case LV1_SUCCESS:
	244	return "LV1_SUCCESS (0)";
	245	case -1:
	246	return " unknown result (-1)";
	247	case LV1_RESOURCE_SHORTAGE:
	248	return "LV1_RESOURCE_SHORTAGE (-2)";
	249	case LV1_NO_PRIVILEGE:
	250	return "LV1_NO_PRIVILEGE (-3)";
	251	case LV1_DENIED_BY_POLICY:
	252	return "LV1_DENIED_BY_POLICY (-4)";
	253	case LV1_ACCESS_VIOLATION:
	254	return "LV1_ACCESS_VIOLATION (-5)";
	255	case LV1_NO_ENTRY:
	256	return "LV1_NO_ENTRY (-6)";
	257	case LV1_DUPLICATE_ENTRY:
	258	return "LV1_DUPLICATE_ENTRY (-7)";
	259	case LV1_TYPE_MISMATCH:
	260	return "LV1_TYPE_MISMATCH (-8)";
	261	case LV1_BUSY:
	262	return "LV1_BUSY (-9)";
	263	case LV1_EMPTY:
	264	return "LV1_EMPTY (-10)";
	265	case LV1_WRONG_STATE:
	266	return "LV1_WRONG_STATE (-11)";
	267	case -12:
	268	return " unknown result (-12)";
	269	case LV1_NO_MATCH:
	270	return "LV1_NO_MATCH (-13)";
	271	case LV1_ALREADY_CONNECTED:
	272	return "LV1_ALREADY_CONNECTED (-14)";
	273	case LV1_UNSUPPORTED_PARAMETER_VALUE:
	274	return "LV1_UNSUPPORTED_PARAMETER_VALUE (-15)";
	275	case LV1_CONDITION_NOT_SATISFIED:
	276	return "LV1_CONDITION_NOT_SATISFIED (-16)";
	277	case LV1_ILLEGAL_PARAMETER_VALUE:
	278	return "LV1_ILLEGAL_PARAMETER_VALUE (-17)";
	279	case LV1_BAD_OPTION:
	280	return "LV1_BAD_OPTION (-18)";
	281	case LV1_IMPLEMENTATION_LIMITATION:
	282	return "LV1_IMPLEMENTATION_LIMITATION (-19)";
	283	case LV1_NOT_IMPLEMENTED:
	284	return "LV1_NOT_IMPLEMENTED (-20)";
	285	case LV1_INVALID_CLASS_ID:
	286	return "LV1_INVALID_CLASS_ID (-21)";
	287	case LV1_CONSTRAINT_NOT_SATISFIED:
	288	return "LV1_CONSTRAINT_NOT_SATISFIED (-22)";
	289	case LV1_ALIGNMENT_ERROR:
	290	return "LV1_ALIGNMENT_ERROR (-23)";
06462d92 GU	291	case LV1_HARDWARE_ERROR:
	292	return "LV1_HARDWARE_ERROR (-24)";
	293	case LV1_INVALID_DATA_FORMAT:
	294	return "LV1_INVALID_DATA_FORMAT (-25)";
	295	case LV1_INVALID_OPERATION:
	296	return "LV1_INVALID_OPERATION (-26)";
f58a9d17 GL	297	case LV1_INTERNAL_ERROR:
	298	return "LV1_INTERNAL_ERROR (-32768)";
	299	default:
	300	BUG();
	301	return " unknown result ";
	302	};
	303	#else
	304	return "";
	305	#endif
	306	}
	307
a3d4d643 GL	308	/* system bus routines */
	309
	310	enum ps3_match_id {
46d01492 GU	311	PS3_MATCH_ID_EHCI = 1,
	312	PS3_MATCH_ID_OHCI = 2,
	313	PS3_MATCH_ID_GELIC = 3,
	314	PS3_MATCH_ID_AV_SETTINGS = 4,
	315	PS3_MATCH_ID_SYSTEM_MANAGER = 5,
	316	PS3_MATCH_ID_STOR_DISK = 6,
	317	PS3_MATCH_ID_STOR_ROM = 7,
	318	PS3_MATCH_ID_STOR_FLASH = 8,
	319	PS3_MATCH_ID_SOUND = 9,
	320	PS3_MATCH_ID_GPU = 10,
	321	PS3_MATCH_ID_LPM = 11,
6bb5cf10 GL	322	};
6bb5cf10 GL	323
46d01492 GU	324	enum ps3_match_sub_id {
46d01492 GU	325	PS3_MATCH_SUB_ID_GPU_FB = 1,
cffb4add	326	PS3_MATCH_SUB_ID_GPU_RAMDISK = 2,
46d01492 GU	327	};
	328
	329	#define PS3_MODULE_ALIAS_EHCI "ps3:1:0"
	330	#define PS3_MODULE_ALIAS_OHCI "ps3:2:0"
	331	#define PS3_MODULE_ALIAS_GELIC "ps3:3:0"
	332	#define PS3_MODULE_ALIAS_AV_SETTINGS "ps3:4:0"
	333	#define PS3_MODULE_ALIAS_SYSTEM_MANAGER "ps3:5:0"
	334	#define PS3_MODULE_ALIAS_STOR_DISK "ps3:6:0"
	335	#define PS3_MODULE_ALIAS_STOR_ROM "ps3:7:0"
	336	#define PS3_MODULE_ALIAS_STOR_FLASH "ps3:8:0"
	337	#define PS3_MODULE_ALIAS_SOUND "ps3:9:0"
	338	#define PS3_MODULE_ALIAS_GPU_FB "ps3:10:1"
0a2d15b9	339	#define PS3_MODULE_ALIAS_GPU_RAMDISK "ps3:10:2"
46d01492	340	#define PS3_MODULE_ALIAS_LPM "ps3:11:0"
6bb5cf10 GL	341
	342	enum ps3_system_bus_device_type {
	343	PS3_DEVICE_TYPE_IOC0 = 1,
	344	PS3_DEVICE_TYPE_SB,
	345	PS3_DEVICE_TYPE_VUART,
ed757002	346	PS3_DEVICE_TYPE_LPM,
a3d4d643 GL	347	};
	348
	349	/**
	350	* struct ps3_system_bus_device - a device on the system bus
	351	*/
	352
	353	struct ps3_system_bus_device {
	354	enum ps3_match_id match_id;
059e4938	355	enum ps3_match_sub_id match_sub_id;
6bb5cf10 GL	356	enum ps3_system_bus_device_type dev_type;
6bb5cf10 GL	357
034e0ab5 GU	358	u64 bus_id; /* SB */
034e0ab5 GU	359	u64 dev_id; /* SB */
6bb5cf10 GL	360	unsigned int interrupt_id; /* SB */
	361	struct ps3_dma_region d_region; / SB, IOC0 */
	362	struct ps3_mmio_region m_region; / SB, IOC0*/
	363	unsigned int port_number; /* VUART */
ed757002 GL	364	struct { /* LPM */
	365	u64 node_id;
	366	u64 pu_id;
	367	u64 rights;
	368	} lpm;
6bb5cf10 GL	369
6bb5cf10 GL	370	/* struct iommu_table iommu_table; -- waiting for BenH's cleanups /
a3d4d643	371	struct device core;
6bb5cf10	372	void driver_priv; / private driver variables */
a3d4d643 GL	373	};
a3d4d643 GL	374
6bb5cf10 GL	375	int ps3_open_hv_device(struct ps3_system_bus_device *dev);
	376	int ps3_close_hv_device(struct ps3_system_bus_device *dev);
	377
a3d4d643 GL	378	/**
	379	* struct ps3_system_bus_driver - a driver for a device on the system bus
	380	*/
	381
	382	struct ps3_system_bus_driver {
	383	enum ps3_match_id match_id;
059e4938	384	enum ps3_match_sub_id match_sub_id;
a3d4d643 GL	385	struct device_driver core;
	386	int (probe)(struct ps3_system_bus_device );
	387	int (remove)(struct ps3_system_bus_device );
6bb5cf10	388	int (shutdown)(struct ps3_system_bus_device );
a3d4d643 GL	389	/* int (suspend)(struct ps3_system_bus_device , pm_message_t); */
	390	/* int (resume)(struct ps3_system_bus_device ); */
	391	};
	392
	393	int ps3_system_bus_device_register(struct ps3_system_bus_device *dev);
	394	int ps3_system_bus_driver_register(struct ps3_system_bus_driver *drv);
	395	void ps3_system_bus_driver_unregister(struct ps3_system_bus_driver *drv);
6bb5cf10 GL	396
6bb5cf10 GL	397	static inline struct ps3_system_bus_driver *ps3_drv_to_system_bus_drv(
a3d4d643 GL	398	struct device_driver *_drv)
	399	{
	400	return container_of(_drv, struct ps3_system_bus_driver, core);
	401	}
6bb5cf10	402	static inline struct ps3_system_bus_device *ps3_dev_to_system_bus_dev(
a3d4d643 GL	403	struct device *_dev)
	404	{
	405	return container_of(_dev, struct ps3_system_bus_device, core);
	406	}
6bb5cf10 GL	407	static inline struct ps3_system_bus_driver *
	408	ps3_system_bus_dev_to_system_bus_drv(struct ps3_system_bus_device *_dev)
	409	{
	410	BUG_ON(!_dev);
	411	BUG_ON(!_dev->core.driver);
	412	return ps3_drv_to_system_bus_drv(_dev->core.driver);
	413	}
a3d4d643 GL	414
	415	/**
	416	* ps3_system_bus_set_drvdata -
	417	* @dev: device structure
	418	* @data: Data to set
	419	*/
	420
	421	static inline void ps3_system_bus_set_driver_data(
	422	struct ps3_system_bus_device dev, void data)
	423	{
	424	dev->core.driver_data = data;
	425	}
	426	static inline void *ps3_system_bus_get_driver_data(
	427	struct ps3_system_bus_device *dev)
	428	{
	429	return dev->core.driver_data;
	430	}
	431
	432	/* These two need global scope for get_dma_ops(). */
	433
	434	extern struct bus_type ps3_system_bus_type;
	435
fde5efd0 GL	436	/* system manager */
fde5efd0 GL	437
66c63b84 GL	438	struct ps3_sys_manager_ops {
	439	struct ps3_system_bus_device *dev;
	440	void (power_off)(struct ps3_system_bus_device dev);
	441	void (restart)(struct ps3_system_bus_device dev);
	442	};
	443
	444	void ps3_sys_manager_register_ops(const struct ps3_sys_manager_ops *ops);
ca052f79 GU	445	void __noreturn ps3_sys_manager_power_off(void);
	446	void __noreturn ps3_sys_manager_restart(void);
	447	void __noreturn ps3_sys_manager_halt(void);
1c43d265 GL	448	int ps3_sys_manager_get_wol(void);
1c43d265 GL	449	void ps3_sys_manager_set_wol(int state);
fde5efd0	450
fbdb3e5b GU	451	struct ps3_prealloc {
	452	const char *name;
	453	void *address;
	454	unsigned long size;
	455	unsigned long align;
	456	};
	457
	458	extern struct ps3_prealloc ps3fb_videomemory;
32d73318	459	extern struct ps3_prealloc ps3flash_bounce_buffer;
fbdb3e5b	460
781749a4 TY	461	/* logical performance monitor */
	462
	463	/**
	464	* enum ps3_lpm_rights - Rigths granted by the system policy module.
	465	*
	466	* @PS3_LPM_RIGHTS_USE_LPM: The right to use the lpm.
	467	* @PS3_LPM_RIGHTS_USE_TB: The right to use the internal trace buffer.
	468	*/
	469
	470	enum ps3_lpm_rights {
	471	PS3_LPM_RIGHTS_USE_LPM = 0x001,
	472	PS3_LPM_RIGHTS_USE_TB = 0x100,
	473	};
	474
	475	/**
	476	* enum ps3_lpm_tb_type - Type of trace buffer lv1 should use.
	477	*
	478	* @PS3_LPM_TB_TYPE_NONE: Do not use a trace buffer.
	479	* @PS3_LPM_RIGHTS_USE_TB: Use the lv1 internal trace buffer. Must have
	480	* rights @PS3_LPM_RIGHTS_USE_TB.
	481	*/
	482
	483	enum ps3_lpm_tb_type {
	484	PS3_LPM_TB_TYPE_NONE = 0,
	485	PS3_LPM_TB_TYPE_INTERNAL = 1,
	486	};
	487
	488	int ps3_lpm_open(enum ps3_lpm_tb_type tb_type, void *tb_cache,
	489	u64 tb_cache_size);
	490	int ps3_lpm_close(void);
	491	int ps3_lpm_copy_tb(unsigned long offset, void *buf, unsigned long count,
	492	unsigned long *bytes_copied);
	493	int ps3_lpm_copy_tb_to_user(unsigned long offset, void __user *buf,
	494	unsigned long count, unsigned long *bytes_copied);
	495	void ps3_set_bookmark(u64 bookmark);
	496	void ps3_set_pm_bookmark(u64 tag, u64 incident, u64 th_id);
	497	int ps3_set_signal(u64 rtas_signal_group, u8 signal_bit, u16 sub_unit,
	498	u8 bus_word);
	499
	500	u32 ps3_read_phys_ctr(u32 cpu, u32 phys_ctr);
	501	void ps3_write_phys_ctr(u32 cpu, u32 phys_ctr, u32 val);
	502	u32 ps3_read_ctr(u32 cpu, u32 ctr);
	503	void ps3_write_ctr(u32 cpu, u32 ctr, u32 val);
	504
	505	u32 ps3_read_pm07_control(u32 cpu, u32 ctr);
	506	void ps3_write_pm07_control(u32 cpu, u32 ctr, u32 val);
	507	u32 ps3_read_pm(u32 cpu, enum pm_reg_name reg);
	508	void ps3_write_pm(u32 cpu, enum pm_reg_name reg, u32 val);
	509
	510	u32 ps3_get_ctr_size(u32 cpu, u32 phys_ctr);
	511	void ps3_set_ctr_size(u32 cpu, u32 phys_ctr, u32 ctr_size);
	512
	513	void ps3_enable_pm(u32 cpu);
	514	void ps3_disable_pm(u32 cpu);
	515	void ps3_enable_pm_interrupts(u32 cpu, u32 thread, u32 mask);
	516	void ps3_disable_pm_interrupts(u32 cpu);
	517
	518	u32 ps3_get_and_clear_pm_interrupts(u32 cpu);
	519	void ps3_sync_irq(int node);
	520	u32 ps3_get_hw_thread_id(int cpu);
	521	u64 ps3_get_spe_id(void *arg);
66c63b84	522
9b82f3e6 GU	523	/* mutex synchronizing GPU accesses and video mode changes */
	524	extern struct mutex ps3_gpu_mutex;
	525
f58a9d17	526	#endif