[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/rwsem.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;

#define SPU_CONTEXT_PREEMPT          0UL

struct spu_gang;

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. */
	u64 object_id;		   /* user space pointer for oprofile */

	enum { SPU_STATE_RUNNABLE, SPU_STATE_SAVED } state;
	struct rw_semaphore state_sema;
	struct semaphore run_sema;

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

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

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

/* context management */
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);
void spu_acquire(struct spu_context *ctx);
void spu_release(struct spu_context *ctx);
int spu_acquire_runnable(struct spu_context *ctx);
void spu_acquire_saved(struct spu_context *ctx);
int spu_acquire_exclusive(struct spu_context *ctx);

static inline void spu_release_exclusive(struct spu_context *ctx)
{
	up_write(&ctx->state_sema);
}

int spu_activate(struct spu_context *ctx, u64 flags);
void spu_deactivate(struct spu_context *ctx);
void spu_yield(struct spu_context *ctx);
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);

#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>
	26	#include <linux/rwsem.h>
	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 AB	39	struct spu_context_ops;
8b3d6663 AB	40
8837d921	41	#define SPU_CONTEXT_PREEMPT 0UL
2a911f0b	42
6263203e AB	43	struct spu_gang;
6263203e AB	44
67207b96 AB	45	struct spu_context {
67207b96 AB	46	struct spu spu; / pointer to a physical SPU */
5473af04	47	struct spu_state csa; /* SPU context save area. */
67207b96	48	spinlock_t mmio_lock; /* protects mmio access */
6df10a82 MN	49	struct address_space local_store; / local store mapping. */
	50	struct address_space mfc; / 'mfc' area mappings. */
	51	struct address_space cntl; / 'control' area mappings. */
	52	struct address_space signal1; / 'signal1' area mappings. */
	53	struct address_space signal2; / 'signal2' area mappings. */
86767277	54	u64 object_id; /* user space pointer for oprofile */
8b3d6663 AB	55
	56	enum { SPU_STATE_RUNNABLE, SPU_STATE_SAVED } state;
	57	struct rw_semaphore state_sema;
5ef8224a	58	struct semaphore run_sema;
8b3d6663 AB	59
8b3d6663 AB	60	struct mm_struct *owner;
67207b96 AB	61
67207b96 AB	62	struct kref kref;
8b3d6663 AB	63	wait_queue_head_t ibox_wq;
8b3d6663 AB	64	wait_queue_head_t wbox_wq;
5110459f	65	wait_queue_head_t stop_wq;
a33a7d73	66	wait_queue_head_t mfc_wq;
8b3d6663 AB	67	struct fasync_struct *ibox_fasync;
8b3d6663 AB	68	struct fasync_struct *wbox_fasync;
a33a7d73 AB	69	struct fasync_struct *mfc_fasync;
a33a7d73 AB	70	u32 tagwait;
8b3d6663	71	struct spu_context_ops *ops;
2a911f0b	72	struct work_struct reap_work;
9add11da AB	73	unsigned long flags;
9add11da AB	74	unsigned long event_return;
6263203e AB	75
	76	struct list_head gang_list;
	77	struct spu_gang *gang;
	78	};
	79
	80	struct spu_gang {
	81	struct list_head list;
	82	struct mutex mutex;
	83	struct kref kref;
	84	int contexts;
8b3d6663 AB	85	};
8b3d6663 AB	86
a33a7d73 AB	87	struct mfc_dma_command {
	88	int32_t pad; /* reserved */
	89	uint32_t lsa; /* local storage address */
	90	uint64_t ea; /* effective address */
	91	uint16_t size; /* transfer size */
	92	uint16_t tag; /* command tag */
	93	uint16_t class; /* class ID */
	94	uint16_t cmd; /* command opcode */
	95	};
	96
	97
8b3d6663 AB	98	/* SPU context query/set operations. */
	99	struct spu_context_ops {
	100	int (mbox_read) (struct spu_context ctx, u32 * data);
	101	u32(mbox_stat_read) (struct spu_context ctx);
3a843d7c AB	102	unsigned int (mbox_stat_poll)(struct spu_context ctx,
3a843d7c AB	103	unsigned int events);
8b3d6663 AB	104	int (ibox_read) (struct spu_context ctx, u32 * data);
	105	int (wbox_write) (struct spu_context ctx, u32 data);
	106	u32(signal1_read) (struct spu_context ctx);
	107	void (signal1_write) (struct spu_context ctx, u32 data);
	108	u32(signal2_read) (struct spu_context ctx);
	109	void (signal2_write) (struct spu_context ctx, u32 data);
	110	void (signal1_type_set) (struct spu_context ctx, u64 val);
	111	u64(signal1_type_get) (struct spu_context ctx);
	112	void (signal2_type_set) (struct spu_context ctx, u64 val);
	113	u64(signal2_type_get) (struct spu_context ctx);
	114	u32(npc_read) (struct spu_context ctx);
	115	void (npc_write) (struct spu_context ctx, u32 data);
	116	u32(status_read) (struct spu_context ctx);
	117	char(get_ls) (struct spu_context * ctx);
3960c260	118	u32 (runcntl_read) (struct spu_context ctx);
5110459f	119	void (runcntl_write) (struct spu_context ctx, u32 data);
ee2d7340 AB	120	void (master_start) (struct spu_context ctx);
ee2d7340 AB	121	void (master_stop) (struct spu_context ctx);
a33a7d73 AB	122	int (set_mfc_query)(struct spu_context ctx, u32 mask, u32 mode);
	123	u32 (read_mfc_tagstatus)(struct spu_context ctx);
	124	u32 (get_mfc_free_elements)(struct spu_context ctx);
b9e3bd77 DGM	125	int (send_mfc_command)(struct spu_context ctx,
	126	struct mfc_dma_command * cmd);
	127	void (dma_info_read) (struct spu_context ctx,
	128	struct spu_dma_info * info);
	129	void (proxydma_info_read) (struct spu_context ctx,
	130	struct spu_proxydma_info * info);
67207b96 AB	131	};
67207b96 AB	132
8b3d6663 AB	133	extern struct spu_context_ops spu_hw_ops;
	134	extern struct spu_context_ops spu_backing_ops;
	135
67207b96 AB	136	struct spufs_inode_info {
67207b96 AB	137	struct spu_context *i_ctx;
6263203e	138	struct spu_gang *i_gang;
67207b96 AB	139	struct inode vfs_inode;
	140	};
	141	#define SPUFS_I(inode) \
	142	container_of(inode, struct spufs_inode_info, vfs_inode)
	143
	144	extern struct tree_descr spufs_dir_contents[];
5737edd1	145	extern struct tree_descr spufs_dir_nosched_contents[];
67207b96 AB	146
	147	/* system call implementation */
	148	long spufs_run_spu(struct file *file,
	149	struct spu_context ctx, u32 npc, u32 *status);
6263203e	150	long spufs_create(struct nameidata *nd,
67207b96	151	unsigned int flags, mode_t mode);
e80358ad	152	extern struct file_operations spufs_context_fops;
67207b96	153
6263203e AB	154	/* gang management */
	155	struct spu_gang *alloc_spu_gang(void);
	156	struct spu_gang get_spu_gang(struct spu_gang gang);
	157	int put_spu_gang(struct spu_gang *gang);
	158	void spu_gang_remove_ctx(struct spu_gang gang, struct spu_context ctx);
	159	void spu_gang_add_ctx(struct spu_gang gang, struct spu_context ctx);
	160
67207b96	161	/* context management */
6263203e	162	struct spu_context * alloc_spu_context(struct spu_gang *gang);
67207b96 AB	163	void destroy_spu_context(struct kref *kref);
	164	struct spu_context * get_spu_context(struct spu_context *ctx);
	165	int put_spu_context(struct spu_context *ctx);
5110459f	166	void spu_unmap_mappings(struct spu_context *ctx);
67207b96	167
8b3d6663	168	void spu_forget(struct spu_context *ctx);
67207b96 AB	169	void spu_acquire(struct spu_context *ctx);
67207b96 AB	170	void spu_release(struct spu_context *ctx);
8b3d6663	171	int spu_acquire_runnable(struct spu_context *ctx);
67207b96	172	void spu_acquire_saved(struct spu_context *ctx);
099814bb JK	173	int spu_acquire_exclusive(struct spu_context *ctx);
	174
	175	static inline void spu_release_exclusive(struct spu_context *ctx)
	176	{
	177	up_write(&ctx->state_sema);
	178	}
67207b96	179
8b3d6663 AB	180	int spu_activate(struct spu_context *ctx, u64 flags);
	181	void spu_deactivate(struct spu_context *ctx);
	182	void spu_yield(struct spu_context *ctx);
	183	int __init spu_sched_init(void);
	184	void __exit spu_sched_exit(void);
	185
c6730ed4 JK	186	extern char *isolated_loader;
c6730ed4 JK	187
ce8ab854 AB	188	/*
	189	* spufs_wait
	190	* Same as wait_event_interruptible(), except that here
	191	* we need to call spu_release(ctx) before sleeping, and
	192	* then spu_acquire(ctx) when awoken.
	193	*/
	194
	195	#define spufs_wait(wq, condition) \
	196	({ \
	197	int __ret = 0; \
	198	DEFINE_WAIT(__wait); \
	199	for (;;) { \
	200	prepare_to_wait(&(wq), &__wait, TASK_INTERRUPTIBLE); \
	201	if (condition) \
	202	break; \
	203	if (!signal_pending(current)) { \
	204	spu_release(ctx); \
	205	schedule(); \
	206	spu_acquire(ctx); \
	207	continue; \
	208	} \
	209	__ret = -ERESTARTSYS; \
	210	break; \
	211	} \
	212	finish_wait(&(wq), &__wait); \
	213	__ret; \
	214	})
	215
8b3d6663 AB	216	size_t spu_wbox_write(struct spu_context *ctx, u32 data);
	217	size_t spu_ibox_read(struct spu_context ctx, u32 data);
	218
	219	/* irq callback funcs. */
	220	void spufs_ibox_callback(struct spu *spu);
	221	void spufs_wbox_callback(struct spu *spu);
5110459f	222	void spufs_stop_callback(struct spu *spu);
a33a7d73	223	void spufs_mfc_callback(struct spu *spu);
9add11da	224	void spufs_dma_callback(struct spu *spu, int type);
8b3d6663	225
67207b96	226	#endif