[linux-2.6-block.git] / include / asm-powerpc / 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>

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);

/* 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,
		   unsigned long *bus_addr,
		   u64 iopte_pp);
	int (*unmap)(struct ps3_dma_region *,
		     unsigned long 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, unsigned long *bus_addr,
	u64 iopte_pp);
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_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_virq_setup(enum ps3_cpu_binding cpu, unsigned long outlet,
	unsigned int *virq);
int ps3_virq_destroy(unsigned int virq);
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_GRAPHICS       = 10,
	PS3_MATCH_ID_LPM            = 11,
};

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

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_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;
	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 ps3_sys_manager_power_off(void);
void ps3_sys_manager_restart(void);

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;


#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>
	27
66b44954 GL	28	union ps3_firmware_version {
	29	u64 raw;
	30	struct {
	31	u16 pad;
	32	u16 major;
	33	u16 minor;
	34	u16 rev;
	35	};
	36	};
	37
1322810c MM	38	void ps3_get_firmware_version(union ps3_firmware_version *v);
1322810c MM	39	int ps3_compare_firmware_version(u16 major, u16 minor, u16 rev);
66b44954	40
098e2744 GU	41	/* 'Other OS' area */
	42
	43	enum ps3_param_av_multi_out {
	44	PS3_PARAM_AV_MULTI_OUT_NTSC = 0,
	45	PS3_PARAM_AV_MULTI_OUT_PAL_RGB = 1,
	46	PS3_PARAM_AV_MULTI_OUT_PAL_YCBCR = 2,
	47	PS3_PARAM_AV_MULTI_OUT_SECAM = 3,
	48	};
	49
	50	enum ps3_param_av_multi_out ps3_os_area_get_av_multi_out(void);
	51
f58a9d17 GL	52	/* dma routines */
	53
	54	enum ps3_dma_page_size {
	55	PS3_DMA_4K = 12U,
	56	PS3_DMA_64K = 16U,
	57	PS3_DMA_1M = 20U,
	58	PS3_DMA_16M = 24U,
	59	};
	60
	61	enum ps3_dma_region_type {
	62	PS3_DMA_OTHER = 0,
	63	PS3_DMA_INTERNAL = 2,
	64	};
	65
6bb5cf10 GL	66	struct ps3_dma_region_ops;
6bb5cf10 GL	67
f58a9d17 GL	68	/**
	69	* struct ps3_dma_region - A per device dma state variables structure
	70	* @did: The HV device id.
	71	* @page_size: The ioc pagesize.
	72	* @region_type: The HV region type.
	73	* @bus_addr: The 'translated' bus address of the region.
	74	* @len: The length in bytes of the region.
6bb5cf10 GL	75	* @offset: The offset from the start of memory of the region.
6bb5cf10 GL	76	* @ioid: The IOID of the device who owns this region
f58a9d17	77	* @chunk_list: Opaque variable used by the ioc page manager.
6bb5cf10	78	* @region_ops: struct ps3_dma_region_ops - dma region operations
f58a9d17 GL	79	*/
	80
	81	struct ps3_dma_region {
6bb5cf10 GL	82	struct ps3_system_bus_device *dev;
	83	/* device variables */
	84	const struct ps3_dma_region_ops *region_ops;
	85	unsigned char ioid;
f58a9d17 GL	86	enum ps3_dma_page_size page_size;
f58a9d17 GL	87	enum ps3_dma_region_type region_type;
f58a9d17	88	unsigned long len;
6bb5cf10 GL	89	unsigned long offset;
	90
	91	/* driver variables (set by ps3_dma_region_create) */
	92	unsigned long bus_addr;
f58a9d17 GL	93	struct {
	94	spinlock_t lock;
	95	struct list_head head;
	96	} chunk_list;
	97	};
	98
6bb5cf10 GL	99	struct ps3_dma_region_ops {
	100	int (create)(struct ps3_dma_region );
	101	int (free)(struct ps3_dma_region );
	102	int (map)(struct ps3_dma_region ,
	103	unsigned long virt_addr,
	104	unsigned long len,
	105	unsigned long *bus_addr,
	106	u64 iopte_pp);
	107	int (unmap)(struct ps3_dma_region ,
	108	unsigned long bus_addr,
	109	unsigned long len);
	110	};
f58a9d17 GL	111	/**
	112	* struct ps3_dma_region_init - Helper to initialize structure variables
	113	*
	114	* Helper to properly initialize variables prior to calling
	115	* ps3_system_bus_device_register.
	116	*/
	117
6bb5cf10 GL	118	struct ps3_system_bus_device;
	119
	120	int ps3_dma_region_init(struct ps3_system_bus_device *dev,
	121	struct ps3_dma_region *r, enum ps3_dma_page_size page_size,
	122	enum ps3_dma_region_type region_type, void *addr, unsigned long len);
f58a9d17 GL	123	int ps3_dma_region_create(struct ps3_dma_region *r);
	124	int ps3_dma_region_free(struct ps3_dma_region *r);
	125	int ps3_dma_map(struct ps3_dma_region *r, unsigned long virt_addr,
6bb5cf10 GL	126	unsigned long len, unsigned long *bus_addr,
6bb5cf10 GL	127	u64 iopte_pp);
f58a9d17 GL	128	int ps3_dma_unmap(struct ps3_dma_region *r, unsigned long bus_addr,
	129	unsigned long len);
	130
	131	/* mmio routines */
	132
	133	enum ps3_mmio_page_size {
	134	PS3_MMIO_4K = 12U,
	135	PS3_MMIO_64K = 16U
	136	};
	137
6bb5cf10	138	struct ps3_mmio_region_ops;
f58a9d17 GL	139	/**
	140	* struct ps3_mmio_region - a per device mmio state variables structure
	141	*
	142	* Current systems can be supported with a single region per device.
	143	*/
	144
	145	struct ps3_mmio_region {
6bb5cf10 GL	146	struct ps3_system_bus_device *dev;
6bb5cf10 GL	147	const struct ps3_mmio_region_ops *mmio_ops;
f58a9d17 GL	148	unsigned long bus_addr;
	149	unsigned long len;
	150	enum ps3_mmio_page_size page_size;
	151	unsigned long lpar_addr;
	152	};
	153
6bb5cf10 GL	154	struct ps3_mmio_region_ops {
	155	int (create)(struct ps3_mmio_region );
	156	int (free)(struct ps3_mmio_region );
	157	};
f58a9d17 GL	158	/**
	159	* struct ps3_mmio_region_init - Helper to initialize structure variables
	160	*
	161	* Helper to properly initialize variables prior to calling
	162	* ps3_system_bus_device_register.
	163	*/
	164
6bb5cf10 GL	165	int ps3_mmio_region_init(struct ps3_system_bus_device *dev,
	166	struct ps3_mmio_region *r, unsigned long bus_addr, unsigned long len,
	167	enum ps3_mmio_page_size page_size);
f58a9d17 GL	168	int ps3_mmio_region_create(struct ps3_mmio_region *r);
	169	int ps3_free_mmio_region(struct ps3_mmio_region *r);
	170	unsigned long ps3_mm_phys_to_lpar(unsigned long phys_addr);
	171
	172	/* inrerrupt routines */
	173
861be32c GL	174	enum ps3_cpu_binding {
	175	PS3_BINDING_CPU_ANY = -1,
	176	PS3_BINDING_CPU_0 = 0,
	177	PS3_BINDING_CPU_1 = 1,
	178	};
	179
dc4f60c2	180	int ps3_virq_setup(enum ps3_cpu_binding cpu, unsigned long outlet,
861be32c	181	unsigned int *virq);
dc4f60c2 GL	182	int ps3_virq_destroy(unsigned int virq);
	183	int ps3_irq_plug_setup(enum ps3_cpu_binding cpu, unsigned long outlet,
	184	unsigned int *virq);
	185	int ps3_irq_plug_destroy(unsigned int virq);
	186	int ps3_event_receive_port_setup(enum ps3_cpu_binding cpu, unsigned int *virq);
	187	int ps3_event_receive_port_destroy(unsigned int virq);
f58a9d17	188	int ps3_send_event_locally(unsigned int virq);
dc4f60c2 GL	189
dc4f60c2 GL	190	int ps3_io_irq_setup(enum ps3_cpu_binding cpu, unsigned int interrupt_id,
861be32c	191	unsigned int *virq);
dc4f60c2 GL	192	int ps3_io_irq_destroy(unsigned int virq);
dc4f60c2 GL	193	int ps3_vuart_irq_setup(enum ps3_cpu_binding cpu, void* virt_addr_bmp,
f58a9d17	194	unsigned int *virq);
dc4f60c2 GL	195	int ps3_vuart_irq_destroy(unsigned int virq);
dc4f60c2 GL	196	int ps3_spe_irq_setup(enum ps3_cpu_binding cpu, unsigned long spe_id,
861be32c	197	unsigned int class, unsigned int *virq);
dc4f60c2 GL	198	int ps3_spe_irq_destroy(unsigned int virq);
dc4f60c2 GL	199
6bb5cf10 GL	200	int ps3_sb_event_receive_port_setup(struct ps3_system_bus_device *dev,
	201	enum ps3_cpu_binding cpu, unsigned int *virq);
	202	int ps3_sb_event_receive_port_destroy(struct ps3_system_bus_device *dev,
	203	unsigned int virq);
f58a9d17 GL	204
	205	/* lv1 result codes */
	206
	207	enum lv1_result {
	208	LV1_SUCCESS = 0,
	209	/* not used -1 */
	210	LV1_RESOURCE_SHORTAGE = -2,
	211	LV1_NO_PRIVILEGE = -3,
	212	LV1_DENIED_BY_POLICY = -4,
	213	LV1_ACCESS_VIOLATION = -5,
	214	LV1_NO_ENTRY = -6,
	215	LV1_DUPLICATE_ENTRY = -7,
	216	LV1_TYPE_MISMATCH = -8,
	217	LV1_BUSY = -9,
	218	LV1_EMPTY = -10,
	219	LV1_WRONG_STATE = -11,
	220	/* not used -12 */
	221	LV1_NO_MATCH = -13,
	222	LV1_ALREADY_CONNECTED = -14,
	223	LV1_UNSUPPORTED_PARAMETER_VALUE = -15,
	224	LV1_CONDITION_NOT_SATISFIED = -16,
	225	LV1_ILLEGAL_PARAMETER_VALUE = -17,
	226	LV1_BAD_OPTION = -18,
	227	LV1_IMPLEMENTATION_LIMITATION = -19,
	228	LV1_NOT_IMPLEMENTED = -20,
	229	LV1_INVALID_CLASS_ID = -21,
	230	LV1_CONSTRAINT_NOT_SATISFIED = -22,
	231	LV1_ALIGNMENT_ERROR = -23,
06462d92 GU	232	LV1_HARDWARE_ERROR = -24,
	233	LV1_INVALID_DATA_FORMAT = -25,
	234	LV1_INVALID_OPERATION = -26,
f58a9d17 GL	235	LV1_INTERNAL_ERROR = -32768,
	236	};
	237
	238	static inline const char* ps3_result(int result)
	239	{
	240	#if defined(DEBUG)
	241	switch (result) {
	242	case LV1_SUCCESS:
	243	return "LV1_SUCCESS (0)";
	244	case -1:
	245	return " unknown result (-1)";
	246	case LV1_RESOURCE_SHORTAGE:
	247	return "LV1_RESOURCE_SHORTAGE (-2)";
	248	case LV1_NO_PRIVILEGE:
	249	return "LV1_NO_PRIVILEGE (-3)";
	250	case LV1_DENIED_BY_POLICY:
	251	return "LV1_DENIED_BY_POLICY (-4)";
	252	case LV1_ACCESS_VIOLATION:
	253	return "LV1_ACCESS_VIOLATION (-5)";
	254	case LV1_NO_ENTRY:
	255	return "LV1_NO_ENTRY (-6)";
	256	case LV1_DUPLICATE_ENTRY:
	257	return "LV1_DUPLICATE_ENTRY (-7)";
	258	case LV1_TYPE_MISMATCH:
	259	return "LV1_TYPE_MISMATCH (-8)";
	260	case LV1_BUSY:
	261	return "LV1_BUSY (-9)";
	262	case LV1_EMPTY:
	263	return "LV1_EMPTY (-10)";
	264	case LV1_WRONG_STATE:
	265	return "LV1_WRONG_STATE (-11)";
	266	case -12:
	267	return " unknown result (-12)";
	268	case LV1_NO_MATCH:
	269	return "LV1_NO_MATCH (-13)";
	270	case LV1_ALREADY_CONNECTED:
	271	return "LV1_ALREADY_CONNECTED (-14)";
	272	case LV1_UNSUPPORTED_PARAMETER_VALUE:
	273	return "LV1_UNSUPPORTED_PARAMETER_VALUE (-15)";
	274	case LV1_CONDITION_NOT_SATISFIED:
	275	return "LV1_CONDITION_NOT_SATISFIED (-16)";
	276	case LV1_ILLEGAL_PARAMETER_VALUE:
	277	return "LV1_ILLEGAL_PARAMETER_VALUE (-17)";
	278	case LV1_BAD_OPTION:
	279	return "LV1_BAD_OPTION (-18)";
	280	case LV1_IMPLEMENTATION_LIMITATION:
	281	return "LV1_IMPLEMENTATION_LIMITATION (-19)";
	282	case LV1_NOT_IMPLEMENTED:
	283	return "LV1_NOT_IMPLEMENTED (-20)";
	284	case LV1_INVALID_CLASS_ID:
	285	return "LV1_INVALID_CLASS_ID (-21)";
	286	case LV1_CONSTRAINT_NOT_SATISFIED:
	287	return "LV1_CONSTRAINT_NOT_SATISFIED (-22)";
	288	case LV1_ALIGNMENT_ERROR:
	289	return "LV1_ALIGNMENT_ERROR (-23)";
06462d92 GU	290	case LV1_HARDWARE_ERROR:
	291	return "LV1_HARDWARE_ERROR (-24)";
	292	case LV1_INVALID_DATA_FORMAT:
	293	return "LV1_INVALID_DATA_FORMAT (-25)";
	294	case LV1_INVALID_OPERATION:
	295	return "LV1_INVALID_OPERATION (-26)";
f58a9d17 GL	296	case LV1_INTERNAL_ERROR:
	297	return "LV1_INTERNAL_ERROR (-32768)";
	298	default:
	299	BUG();
	300	return " unknown result ";
	301	};
	302	#else
	303	return "";
	304	#endif
	305	}
	306
a3d4d643 GL	307	/* system bus routines */
	308
	309	enum ps3_match_id {
6bb5cf10 GL	310	PS3_MATCH_ID_EHCI = 1,
	311	PS3_MATCH_ID_OHCI = 2,
	312	PS3_MATCH_ID_GELIC = 3,
	313	PS3_MATCH_ID_AV_SETTINGS = 4,
	314	PS3_MATCH_ID_SYSTEM_MANAGER = 5,
	315	PS3_MATCH_ID_STOR_DISK = 6,
	316	PS3_MATCH_ID_STOR_ROM = 7,
	317	PS3_MATCH_ID_STOR_FLASH = 8,
	318	PS3_MATCH_ID_SOUND = 9,
	319	PS3_MATCH_ID_GRAPHICS = 10,
ed757002	320	PS3_MATCH_ID_LPM = 11,
6bb5cf10 GL	321	};
	322
	323	#define PS3_MODULE_ALIAS_EHCI "ps3:1"
	324	#define PS3_MODULE_ALIAS_OHCI "ps3:2"
	325	#define PS3_MODULE_ALIAS_GELIC "ps3:3"
	326	#define PS3_MODULE_ALIAS_AV_SETTINGS "ps3:4"
	327	#define PS3_MODULE_ALIAS_SYSTEM_MANAGER "ps3:5"
	328	#define PS3_MODULE_ALIAS_STOR_DISK "ps3:6"
	329	#define PS3_MODULE_ALIAS_STOR_ROM "ps3:7"
	330	#define PS3_MODULE_ALIAS_STOR_FLASH "ps3:8"
	331	#define PS3_MODULE_ALIAS_SOUND "ps3:9"
	332	#define PS3_MODULE_ALIAS_GRAPHICS "ps3:10"
ed757002	333	#define PS3_MODULE_ALIAS_LPM "ps3:11"
6bb5cf10 GL	334
	335	enum ps3_system_bus_device_type {
	336	PS3_DEVICE_TYPE_IOC0 = 1,
	337	PS3_DEVICE_TYPE_SB,
	338	PS3_DEVICE_TYPE_VUART,
ed757002	339	PS3_DEVICE_TYPE_LPM,
a3d4d643 GL	340	};
	341
	342	/**
	343	* struct ps3_system_bus_device - a device on the system bus
	344	*/
	345
	346	struct ps3_system_bus_device {
	347	enum ps3_match_id match_id;
6bb5cf10 GL	348	enum ps3_system_bus_device_type dev_type;
6bb5cf10 GL	349
034e0ab5 GU	350	u64 bus_id; /* SB */
034e0ab5 GU	351	u64 dev_id; /* SB */
6bb5cf10 GL	352	unsigned int interrupt_id; /* SB */
	353	struct ps3_dma_region d_region; / SB, IOC0 */
	354	struct ps3_mmio_region m_region; / SB, IOC0*/
	355	unsigned int port_number; /* VUART */
ed757002 GL	356	struct { /* LPM */
	357	u64 node_id;
	358	u64 pu_id;
	359	u64 rights;
	360	} lpm;
6bb5cf10 GL	361
6bb5cf10 GL	362	/* struct iommu_table iommu_table; -- waiting for BenH's cleanups /
a3d4d643	363	struct device core;
6bb5cf10	364	void driver_priv; / private driver variables */
a3d4d643 GL	365	};
a3d4d643 GL	366
6bb5cf10 GL	367	int ps3_open_hv_device(struct ps3_system_bus_device *dev);
	368	int ps3_close_hv_device(struct ps3_system_bus_device *dev);
	369
a3d4d643 GL	370	/**
	371	* struct ps3_system_bus_driver - a driver for a device on the system bus
	372	*/
	373
	374	struct ps3_system_bus_driver {
	375	enum ps3_match_id match_id;
	376	struct device_driver core;
	377	int (probe)(struct ps3_system_bus_device );
	378	int (remove)(struct ps3_system_bus_device );
6bb5cf10	379	int (shutdown)(struct ps3_system_bus_device );
a3d4d643 GL	380	/* int (suspend)(struct ps3_system_bus_device , pm_message_t); */
	381	/* int (resume)(struct ps3_system_bus_device ); */
	382	};
	383
	384	int ps3_system_bus_device_register(struct ps3_system_bus_device *dev);
	385	int ps3_system_bus_driver_register(struct ps3_system_bus_driver *drv);
	386	void ps3_system_bus_driver_unregister(struct ps3_system_bus_driver *drv);
6bb5cf10 GL	387
6bb5cf10 GL	388	static inline struct ps3_system_bus_driver *ps3_drv_to_system_bus_drv(
a3d4d643 GL	389	struct device_driver *_drv)
	390	{
	391	return container_of(_drv, struct ps3_system_bus_driver, core);
	392	}
6bb5cf10	393	static inline struct ps3_system_bus_device *ps3_dev_to_system_bus_dev(
a3d4d643 GL	394	struct device *_dev)
	395	{
	396	return container_of(_dev, struct ps3_system_bus_device, core);
	397	}
6bb5cf10 GL	398	static inline struct ps3_system_bus_driver *
	399	ps3_system_bus_dev_to_system_bus_drv(struct ps3_system_bus_device *_dev)
	400	{
	401	BUG_ON(!_dev);
	402	BUG_ON(!_dev->core.driver);
	403	return ps3_drv_to_system_bus_drv(_dev->core.driver);
	404	}
a3d4d643 GL	405
	406	/**
	407	* ps3_system_bus_set_drvdata -
	408	* @dev: device structure
	409	* @data: Data to set
	410	*/
	411
	412	static inline void ps3_system_bus_set_driver_data(
	413	struct ps3_system_bus_device dev, void data)
	414	{
	415	dev->core.driver_data = data;
	416	}
	417	static inline void *ps3_system_bus_get_driver_data(
	418	struct ps3_system_bus_device *dev)
	419	{
	420	return dev->core.driver_data;
	421	}
	422
	423	/* These two need global scope for get_dma_ops(). */
	424
	425	extern struct bus_type ps3_system_bus_type;
	426
fde5efd0 GL	427	/* system manager */
fde5efd0 GL	428
66c63b84 GL	429	struct ps3_sys_manager_ops {
	430	struct ps3_system_bus_device *dev;
	431	void (power_off)(struct ps3_system_bus_device dev);
	432	void (restart)(struct ps3_system_bus_device dev);
	433	};
	434
	435	void ps3_sys_manager_register_ops(const struct ps3_sys_manager_ops *ops);
fde5efd0	436	void ps3_sys_manager_power_off(void);
66c63b84	437	void ps3_sys_manager_restart(void);
fde5efd0	438
fbdb3e5b GU	439	struct ps3_prealloc {
	440	const char *name;
	441	void *address;
	442	unsigned long size;
	443	unsigned long align;
	444	};
	445
	446	extern struct ps3_prealloc ps3fb_videomemory;
32d73318	447	extern struct ps3_prealloc ps3flash_bounce_buffer;
fbdb3e5b	448
66c63b84	449
f58a9d17	450	#endif