[deliverable/linux.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>
#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);

/* 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_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,
};

enum ps3_match_sub_id {
	/* for PS3_MATCH_ID_GRAPHICS */
	PS3_MATCH_SUB_ID_FB		= 1,
};

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

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