[deliverable/linux.git] / arch / powerpc / platforms / cell / spufs / spufs.h

/*
 * SPU file system
 *
 * (C) Copyright IBM Deutschland Entwicklung GmbH 2005
 *
 * Author: Arnd Bergmann <arndb@de.ibm.com>
 *
 * 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; either version 2, or (at your option)
 * any later version.
 *
 * 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., 675 Mass Ave, Cambridge, MA 02139, USA.
 */
#ifndef SPUFS_H
#define SPUFS_H

#include <linux/kref.h>
#include <linux/mutex.h>
#include <linux/spinlock.h>
#include <linux/fs.h>

#include <asm/spu.h>
#include <asm/spu_csa.h>
#include <asm/spu_info.h>

/* The magic number for our file system */
enum {
	SPUFS_MAGIC = 0x23c9b64e,
};

struct spu_context_ops;
struct spu_gang;

/* ctx->sched_flags */
enum {
	SPU_SCHED_EXITING = 0,
};

struct spu_context {
	struct spu *spu;		  /* pointer to a physical SPU */
	struct spu_state csa;		  /* SPU context save area. */
	spinlock_t mmio_lock;		  /* protects mmio access */
	struct address_space *local_store; /* local store mapping.  */
	struct address_space *mfc;	   /* 'mfc' area mappings. */
	struct address_space *cntl;	   /* 'control' area mappings. */
	struct address_space *signal1;	   /* 'signal1' area mappings. */
	struct address_space *signal2;	   /* 'signal2' area mappings. */
	struct address_space *mss;	   /* 'mss' area mappings. */
	struct address_space *psmap;	   /* 'psmap' area mappings. */
	spinlock_t mapping_lock;
	u64 object_id;		   /* user space pointer for oprofile */

	enum { SPU_STATE_RUNNABLE, SPU_STATE_SAVED } state;
	struct mutex state_mutex;
	struct mutex run_mutex;

	struct mm_struct *owner;

	struct kref kref;
	wait_queue_head_t ibox_wq;
	wait_queue_head_t wbox_wq;
	wait_queue_head_t stop_wq;
	wait_queue_head_t mfc_wq;
	struct fasync_struct *ibox_fasync;
	struct fasync_struct *wbox_fasync;
	struct fasync_struct *mfc_fasync;
	u32 tagwait;
	struct spu_context_ops *ops;
	struct work_struct reap_work;
	unsigned long flags;
	unsigned long event_return;

	struct list_head gang_list;
	struct spu_gang *gang;

	/* scheduler fields */
 	struct list_head rq;
	struct delayed_work sched_work;
	unsigned long sched_flags;
	unsigned long rt_priority;
	int policy;
	int prio;
};

struct spu_gang {
	struct list_head list;
	struct mutex mutex;
	struct kref kref;
	int contexts;
};

struct mfc_dma_command {
	int32_t pad;	/* reserved */
	uint32_t lsa;	/* local storage address */
	uint64_t ea;	/* effective address */
	uint16_t size;	/* transfer size */
	uint16_t tag;	/* command tag */
	uint16_t class;	/* class ID */
	uint16_t cmd;	/* command opcode */
};


/* SPU context query/set operations. */
struct spu_context_ops {
	int (*mbox_read) (struct spu_context * ctx, u32 * data);
	 u32(*mbox_stat_read) (struct spu_context * ctx);
	unsigned int (*mbox_stat_poll)(struct spu_context *ctx,
					unsigned int events);
	int (*ibox_read) (struct spu_context * ctx, u32 * data);
	int (*wbox_write) (struct spu_context * ctx, u32 data);
	 u32(*signal1_read) (struct spu_context * ctx);
	void (*signal1_write) (struct spu_context * ctx, u32 data);
	 u32(*signal2_read) (struct spu_context * ctx);
	void (*signal2_write) (struct spu_context * ctx, u32 data);
	void (*signal1_type_set) (struct spu_context * ctx, u64 val);
	 u64(*signal1_type_get) (struct spu_context * ctx);
	void (*signal2_type_set) (struct spu_context * ctx, u64 val);
	 u64(*signal2_type_get) (struct spu_context * ctx);
	 u32(*npc_read) (struct spu_context * ctx);
	void (*npc_write) (struct spu_context * ctx, u32 data);
	 u32(*status_read) (struct spu_context * ctx);
	char*(*get_ls) (struct spu_context * ctx);
	 u32 (*runcntl_read) (struct spu_context * ctx);
	void (*runcntl_write) (struct spu_context * ctx, u32 data);
	void (*master_start) (struct spu_context * ctx);
	void (*master_stop) (struct spu_context * ctx);
	int (*set_mfc_query)(struct spu_context * ctx, u32 mask, u32 mode);
	u32 (*read_mfc_tagstatus)(struct spu_context * ctx);
	u32 (*get_mfc_free_elements)(struct spu_context *ctx);
	int (*send_mfc_command)(struct spu_context * ctx,
				struct mfc_dma_command * cmd);
	void (*dma_info_read) (struct spu_context * ctx,
			       struct spu_dma_info * info);
	void (*proxydma_info_read) (struct spu_context * ctx,
				    struct spu_proxydma_info * info);
	void (*restart_dma)(struct spu_context *ctx);
};

extern struct spu_context_ops spu_hw_ops;
extern struct spu_context_ops spu_backing_ops;

struct spufs_inode_info {
	struct spu_context *i_ctx;
	struct spu_gang *i_gang;
	struct inode vfs_inode;
	int i_openers;
};
#define SPUFS_I(inode) \
	container_of(inode, struct spufs_inode_info, vfs_inode)

extern struct tree_descr spufs_dir_contents[];
extern struct tree_descr spufs_dir_nosched_contents[];

/* system call implementation */
long spufs_run_spu(struct file *file,
		   struct spu_context *ctx, u32 *npc, u32 *status);
long spufs_create(struct nameidata *nd,
			 unsigned int flags, mode_t mode);
extern const struct file_operations spufs_context_fops;

/* gang management */
struct spu_gang *alloc_spu_gang(void);
struct spu_gang *get_spu_gang(struct spu_gang *gang);
int put_spu_gang(struct spu_gang *gang);
void spu_gang_remove_ctx(struct spu_gang *gang, struct spu_context *ctx);
void spu_gang_add_ctx(struct spu_gang *gang, struct spu_context *ctx);

/* fault handling */
int spufs_handle_class1(struct spu_context *ctx);

/* context management */
static inline void spu_acquire(struct spu_context *ctx)
{
	mutex_lock(&ctx->state_mutex);
}

static inline void spu_release(struct spu_context *ctx)
{
	mutex_unlock(&ctx->state_mutex);
}

struct spu_context * alloc_spu_context(struct spu_gang *gang);
void destroy_spu_context(struct kref *kref);
struct spu_context * get_spu_context(struct spu_context *ctx);
int put_spu_context(struct spu_context *ctx);
void spu_unmap_mappings(struct spu_context *ctx);

void spu_forget(struct spu_context *ctx);
int spu_acquire_runnable(struct spu_context *ctx, unsigned long flags);
void spu_acquire_saved(struct spu_context *ctx);

int spu_activate(struct spu_context *ctx, unsigned long flags);
void spu_deactivate(struct spu_context *ctx);
void spu_yield(struct spu_context *ctx);
void spu_start_tick(struct spu_context *ctx);
void spu_stop_tick(struct spu_context *ctx);
void spu_sched_tick(struct work_struct *work);
int __init spu_sched_init(void);
void __exit spu_sched_exit(void);

extern char *isolated_loader;

/*
 * spufs_wait
 * 	Same as wait_event_interruptible(), except that here
 *	we need to call spu_release(ctx) before sleeping, and
 *	then spu_acquire(ctx) when awoken.
 */

#define spufs_wait(wq, condition)					\
({									\
	int __ret = 0;							\
	DEFINE_WAIT(__wait);						\
	for (;;) {							\
		prepare_to_wait(&(wq), &__wait, TASK_INTERRUPTIBLE);	\
		if (condition)						\
			break;						\
		if (!signal_pending(current)) {				\
			spu_release(ctx);				\
			schedule();					\
			spu_acquire(ctx);				\
			continue;					\
		}							\
		__ret = -ERESTARTSYS;					\
		break;							\
	}								\
	finish_wait(&(wq), &__wait);					\
	__ret;								\
})

size_t spu_wbox_write(struct spu_context *ctx, u32 data);
size_t spu_ibox_read(struct spu_context *ctx, u32 *data);

/* irq callback funcs. */
void spufs_ibox_callback(struct spu *spu);
void spufs_wbox_callback(struct spu *spu);
void spufs_stop_callback(struct spu *spu);
void spufs_mfc_callback(struct spu *spu);
void spufs_dma_callback(struct spu *spu, int type);

extern struct spu_coredump_calls spufs_coredump_calls;
struct spufs_coredump_reader {
	char *name;
	ssize_t (*read)(struct spu_context *ctx,
			char __user *buffer, size_t size, loff_t *pos);
	u64 (*get)(void *data);
	size_t size;
};
extern struct spufs_coredump_reader spufs_coredump_read[];
extern int spufs_coredump_num_notes;

#endif
Commit	Line	Data
67207b96 AB	1	/*
	2	* SPU file system
	3	*
	4	* (C) Copyright IBM Deutschland Entwicklung GmbH 2005
	5	*
	6	* Author: Arnd Bergmann <arndb@de.ibm.com>
	7	*
	8	* This program is free software; you can redistribute it and/or modify
	9	* it under the terms of the GNU General Public License as published by
	10	* the Free Software Foundation; either version 2, or (at your option)
	11	* any later version.
	12	*
	13	* This program is distributed in the hope that it will be useful,
	14	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	15	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	16	* GNU General Public License for more details.
	17	*
	18	* You should have received a copy of the GNU General Public License
	19	* along with this program; if not, write to the Free Software
	20	* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
	21	*/
	22	#ifndef SPUFS_H
	23	#define SPUFS_H
	24
	25	#include <linux/kref.h>
650f8b02	26	#include <linux/mutex.h>
67207b96 AB	27	#include <linux/spinlock.h>
	28	#include <linux/fs.h>
	29
	30	#include <asm/spu.h>
5473af04	31	#include <asm/spu_csa.h>
b9e3bd77	32	#include <asm/spu_info.h>
67207b96 AB	33
	34	/* The magic number for our file system */
	35	enum {
	36	SPUFS_MAGIC = 0x23c9b64e,
	37	};
	38
8b3d6663	39	struct spu_context_ops;
6263203e AB	40	struct spu_gang;
6263203e AB	41
26bec673 CH	42	/* ctx->sched_flags */
26bec673 CH	43	enum {
08873095	44	SPU_SCHED_EXITING = 0,
26bec673 CH	45	};
26bec673 CH	46
67207b96 AB	47	struct spu_context {
67207b96 AB	48	struct spu spu; / pointer to a physical SPU */
5473af04	49	struct spu_state csa; /* SPU context save area. */
67207b96	50	spinlock_t mmio_lock; /* protects mmio access */
6df10a82 MN	51	struct address_space local_store; / local store mapping. */
6df10a82 MN	52	struct address_space mfc; / 'mfc' area mappings. */
43c2bbd9 CH	53	struct address_space cntl; / 'control' area mappings. */
	54	struct address_space signal1; / 'signal1' area mappings. */
	55	struct address_space signal2; / 'signal2' area mappings. */
	56	struct address_space mss; / 'mss' area mappings. */
	57	struct address_space psmap; / 'psmap' area mappings. */
	58	spinlock_t mapping_lock;
86767277	59	u64 object_id; /* user space pointer for oprofile */
8b3d6663 AB	60
8b3d6663 AB	61	enum { SPU_STATE_RUNNABLE, SPU_STATE_SAVED } state;
650f8b02	62	struct mutex state_mutex;
e45d48a3	63	struct mutex run_mutex;
8b3d6663 AB	64
8b3d6663 AB	65	struct mm_struct *owner;
67207b96 AB	66
67207b96 AB	67	struct kref kref;
8b3d6663 AB	68	wait_queue_head_t ibox_wq;
8b3d6663 AB	69	wait_queue_head_t wbox_wq;
5110459f	70	wait_queue_head_t stop_wq;
a33a7d73	71	wait_queue_head_t mfc_wq;
8b3d6663 AB	72	struct fasync_struct *ibox_fasync;
8b3d6663 AB	73	struct fasync_struct *wbox_fasync;
a33a7d73 AB	74	struct fasync_struct *mfc_fasync;
a33a7d73 AB	75	u32 tagwait;
8b3d6663	76	struct spu_context_ops *ops;
2a911f0b	77	struct work_struct reap_work;
9add11da AB	78	unsigned long flags;
9add11da AB	79	unsigned long event_return;
6263203e AB	80
	81	struct list_head gang_list;
	82	struct spu_gang *gang;
8389998a CH	83
8389998a CH	84	/* scheduler fields */
079cdb61	85	struct list_head rq;
2eb1b120	86	struct delayed_work sched_work;
26bec673	87	unsigned long sched_flags;
52f04fcf	88	unsigned long rt_priority;
2eb1b120	89	int policy;
8389998a	90	int prio;
6263203e AB	91	};
	92
	93	struct spu_gang {
	94	struct list_head list;
	95	struct mutex mutex;
	96	struct kref kref;
	97	int contexts;
8b3d6663 AB	98	};
8b3d6663 AB	99
a33a7d73 AB	100	struct mfc_dma_command {
	101	int32_t pad; /* reserved */
	102	uint32_t lsa; /* local storage address */
	103	uint64_t ea; /* effective address */
	104	uint16_t size; /* transfer size */
	105	uint16_t tag; /* command tag */
	106	uint16_t class; /* class ID */
	107	uint16_t cmd; /* command opcode */
	108	};
	109
	110
8b3d6663 AB	111	/* SPU context query/set operations. */
	112	struct spu_context_ops {
	113	int (mbox_read) (struct spu_context ctx, u32 * data);
	114	u32(mbox_stat_read) (struct spu_context ctx);
3a843d7c AB	115	unsigned int (mbox_stat_poll)(struct spu_context ctx,
3a843d7c AB	116	unsigned int events);
8b3d6663 AB	117	int (ibox_read) (struct spu_context ctx, u32 * data);
	118	int (wbox_write) (struct spu_context ctx, u32 data);
	119	u32(signal1_read) (struct spu_context ctx);
	120	void (signal1_write) (struct spu_context ctx, u32 data);
	121	u32(signal2_read) (struct spu_context ctx);
	122	void (signal2_write) (struct spu_context ctx, u32 data);
	123	void (signal1_type_set) (struct spu_context ctx, u64 val);
	124	u64(signal1_type_get) (struct spu_context ctx);
	125	void (signal2_type_set) (struct spu_context ctx, u64 val);
	126	u64(signal2_type_get) (struct spu_context ctx);
	127	u32(npc_read) (struct spu_context ctx);
	128	void (npc_write) (struct spu_context ctx, u32 data);
	129	u32(status_read) (struct spu_context ctx);
	130	char(get_ls) (struct spu_context * ctx);
3960c260	131	u32 (runcntl_read) (struct spu_context ctx);
5110459f	132	void (runcntl_write) (struct spu_context ctx, u32 data);
ee2d7340 AB	133	void (master_start) (struct spu_context ctx);
ee2d7340 AB	134	void (master_stop) (struct spu_context ctx);
a33a7d73 AB	135	int (set_mfc_query)(struct spu_context ctx, u32 mask, u32 mode);
	136	u32 (read_mfc_tagstatus)(struct spu_context ctx);
	137	u32 (get_mfc_free_elements)(struct spu_context ctx);
b9e3bd77 DGM	138	int (send_mfc_command)(struct spu_context ctx,
	139	struct mfc_dma_command * cmd);
	140	void (dma_info_read) (struct spu_context ctx,
	141	struct spu_dma_info * info);
	142	void (proxydma_info_read) (struct spu_context ctx,
	143	struct spu_proxydma_info * info);
57dace23	144	void (restart_dma)(struct spu_context ctx);
67207b96 AB	145	};
67207b96 AB	146
8b3d6663 AB	147	extern struct spu_context_ops spu_hw_ops;
	148	extern struct spu_context_ops spu_backing_ops;
	149
67207b96 AB	150	struct spufs_inode_info {
67207b96 AB	151	struct spu_context *i_ctx;
6263203e	152	struct spu_gang *i_gang;
67207b96	153	struct inode vfs_inode;
43c2bbd9	154	int i_openers;
67207b96 AB	155	};
	156	#define SPUFS_I(inode) \
	157	container_of(inode, struct spufs_inode_info, vfs_inode)
	158
	159	extern struct tree_descr spufs_dir_contents[];
5737edd1	160	extern struct tree_descr spufs_dir_nosched_contents[];
67207b96 AB	161
	162	/* system call implementation */
	163	long spufs_run_spu(struct file *file,
	164	struct spu_context ctx, u32 npc, u32 *status);
6263203e	165	long spufs_create(struct nameidata *nd,
67207b96	166	unsigned int flags, mode_t mode);
9c2e08c5	167	extern const struct file_operations spufs_context_fops;
67207b96	168
6263203e AB	169	/* gang management */
	170	struct spu_gang *alloc_spu_gang(void);
	171	struct spu_gang get_spu_gang(struct spu_gang gang);
	172	int put_spu_gang(struct spu_gang *gang);
	173	void spu_gang_remove_ctx(struct spu_gang gang, struct spu_context ctx);
	174	void spu_gang_add_ctx(struct spu_gang gang, struct spu_context ctx);
	175
57dace23 AB	176	/* fault handling */
	177	int spufs_handle_class1(struct spu_context *ctx);
	178
67207b96	179	/* context management */
6a0641e5 CH	180	static inline void spu_acquire(struct spu_context *ctx)
	181	{
	182	mutex_lock(&ctx->state_mutex);
	183	}
	184
	185	static inline void spu_release(struct spu_context *ctx)
	186	{
	187	mutex_unlock(&ctx->state_mutex);
	188	}
	189
6263203e	190	struct spu_context * alloc_spu_context(struct spu_gang *gang);
67207b96 AB	191	void destroy_spu_context(struct kref *kref);
	192	struct spu_context * get_spu_context(struct spu_context *ctx);
	193	int put_spu_context(struct spu_context *ctx);
5110459f	194	void spu_unmap_mappings(struct spu_context *ctx);
67207b96	195
8b3d6663	196	void spu_forget(struct spu_context *ctx);
26bec673	197	int spu_acquire_runnable(struct spu_context *ctx, unsigned long flags);
67207b96	198	void spu_acquire_saved(struct spu_context *ctx);
50b520d4	199
26bec673	200	int spu_activate(struct spu_context *ctx, unsigned long flags);
8b3d6663 AB	201	void spu_deactivate(struct spu_context *ctx);
8b3d6663 AB	202	void spu_yield(struct spu_context *ctx);
2eb1b120 CH	203	void spu_start_tick(struct spu_context *ctx);
	204	void spu_stop_tick(struct spu_context *ctx);
	205	void spu_sched_tick(struct work_struct *work);
8b3d6663 AB	206	int __init spu_sched_init(void);
	207	void __exit spu_sched_exit(void);
	208
c6730ed4 JK	209	extern char *isolated_loader;
c6730ed4 JK	210
ce8ab854 AB	211	/*
	212	* spufs_wait
	213	* Same as wait_event_interruptible(), except that here
	214	* we need to call spu_release(ctx) before sleeping, and
	215	* then spu_acquire(ctx) when awoken.
	216	*/
	217
	218	#define spufs_wait(wq, condition) \
	219	({ \
	220	int __ret = 0; \
	221	DEFINE_WAIT(__wait); \
	222	for (;;) { \
	223	prepare_to_wait(&(wq), &__wait, TASK_INTERRUPTIBLE); \
	224	if (condition) \
	225	break; \
	226	if (!signal_pending(current)) { \
	227	spu_release(ctx); \
	228	schedule(); \
	229	spu_acquire(ctx); \
	230	continue; \
	231	} \
	232	__ret = -ERESTARTSYS; \
	233	break; \
	234	} \
	235	finish_wait(&(wq), &__wait); \
	236	__ret; \
	237	})
	238
8b3d6663 AB	239	size_t spu_wbox_write(struct spu_context *ctx, u32 data);
	240	size_t spu_ibox_read(struct spu_context ctx, u32 data);
	241
	242	/* irq callback funcs. */
	243	void spufs_ibox_callback(struct spu *spu);
	244	void spufs_wbox_callback(struct spu *spu);
5110459f	245	void spufs_stop_callback(struct spu *spu);
a33a7d73	246	void spufs_mfc_callback(struct spu *spu);
9add11da	247	void spufs_dma_callback(struct spu *spu, int type);
8b3d6663	248
bf1ab978 DGM	249	extern struct spu_coredump_calls spufs_coredump_calls;
	250	struct spufs_coredump_reader {
	251	char *name;
	252	ssize_t (read)(struct spu_context ctx,
	253	char __user buffer, size_t size, loff_t pos);
	254	u64 (get)(void data);
	255	size_t size;
	256	};
	257	extern struct spufs_coredump_reader spufs_coredump_read[];
	258	extern int spufs_coredump_num_notes;
	259
67207b96	260	#endif