[mirror_ubuntu-hirsute-kernel.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>

/* 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);
	void (*runcntl_write) (struct spu_context * ctx, u32 data);
	void (*runcntl_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);
};

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

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