xref: /linux/arch/powerpc/platforms/cell/spufs/spufs.h (revision c537b994505099b7197e7d3125b942ecbcc51eb6)
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/mutex.h>
27 #include <linux/spinlock.h>
28 #include <linux/fs.h>
29 
30 #include <asm/spu.h>
31 #include <asm/spu_csa.h>
32 #include <asm/spu_info.h>
33 
34 /* The magic number for our file system */
35 enum {
36 	SPUFS_MAGIC = 0x23c9b64e,
37 };
38 
39 struct spu_context_ops;
40 struct spu_gang;
41 
42 /* ctx->sched_flags */
43 enum {
44 	SPU_SCHED_WAKE = 0, /* currently unused */
45 };
46 
47 struct spu_context {
48 	struct spu *spu;		  /* pointer to a physical SPU */
49 	struct spu_state csa;		  /* SPU context save area. */
50 	spinlock_t mmio_lock;		  /* protects mmio access */
51 	struct address_space *local_store; /* local store mapping.  */
52 	struct address_space *mfc;	   /* 'mfc' area mappings. */
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 	u64 object_id;		   /* user space pointer for oprofile */
59 
60 	enum { SPU_STATE_RUNNABLE, SPU_STATE_SAVED } state;
61 	struct mutex state_mutex;
62 	struct semaphore run_sema;
63 
64 	struct mm_struct *owner;
65 
66 	struct kref kref;
67 	wait_queue_head_t ibox_wq;
68 	wait_queue_head_t wbox_wq;
69 	wait_queue_head_t stop_wq;
70 	wait_queue_head_t mfc_wq;
71 	struct fasync_struct *ibox_fasync;
72 	struct fasync_struct *wbox_fasync;
73 	struct fasync_struct *mfc_fasync;
74 	u32 tagwait;
75 	struct spu_context_ops *ops;
76 	struct work_struct reap_work;
77 	unsigned long flags;
78 	unsigned long event_return;
79 
80 	struct list_head gang_list;
81 	struct spu_gang *gang;
82 
83 	/* scheduler fields */
84  	struct list_head rq;
85 	struct delayed_work sched_work;
86 	unsigned long sched_flags;
87 	unsigned long rt_priority;
88 	int policy;
89 	int prio;
90 };
91 
92 struct spu_gang {
93 	struct list_head list;
94 	struct mutex mutex;
95 	struct kref kref;
96 	int contexts;
97 };
98 
99 struct mfc_dma_command {
100 	int32_t pad;	/* reserved */
101 	uint32_t lsa;	/* local storage address */
102 	uint64_t ea;	/* effective address */
103 	uint16_t size;	/* transfer size */
104 	uint16_t tag;	/* command tag */
105 	uint16_t class;	/* class ID */
106 	uint16_t cmd;	/* command opcode */
107 };
108 
109 
110 /* SPU context query/set operations. */
111 struct spu_context_ops {
112 	int (*mbox_read) (struct spu_context * ctx, u32 * data);
113 	 u32(*mbox_stat_read) (struct spu_context * ctx);
114 	unsigned int (*mbox_stat_poll)(struct spu_context *ctx,
115 					unsigned int events);
116 	int (*ibox_read) (struct spu_context * ctx, u32 * data);
117 	int (*wbox_write) (struct spu_context * ctx, u32 data);
118 	 u32(*signal1_read) (struct spu_context * ctx);
119 	void (*signal1_write) (struct spu_context * ctx, u32 data);
120 	 u32(*signal2_read) (struct spu_context * ctx);
121 	void (*signal2_write) (struct spu_context * ctx, u32 data);
122 	void (*signal1_type_set) (struct spu_context * ctx, u64 val);
123 	 u64(*signal1_type_get) (struct spu_context * ctx);
124 	void (*signal2_type_set) (struct spu_context * ctx, u64 val);
125 	 u64(*signal2_type_get) (struct spu_context * ctx);
126 	 u32(*npc_read) (struct spu_context * ctx);
127 	void (*npc_write) (struct spu_context * ctx, u32 data);
128 	 u32(*status_read) (struct spu_context * ctx);
129 	char*(*get_ls) (struct spu_context * ctx);
130 	 u32 (*runcntl_read) (struct spu_context * ctx);
131 	void (*runcntl_write) (struct spu_context * ctx, u32 data);
132 	void (*master_start) (struct spu_context * ctx);
133 	void (*master_stop) (struct spu_context * ctx);
134 	int (*set_mfc_query)(struct spu_context * ctx, u32 mask, u32 mode);
135 	u32 (*read_mfc_tagstatus)(struct spu_context * ctx);
136 	u32 (*get_mfc_free_elements)(struct spu_context *ctx);
137 	int (*send_mfc_command)(struct spu_context * ctx,
138 				struct mfc_dma_command * cmd);
139 	void (*dma_info_read) (struct spu_context * ctx,
140 			       struct spu_dma_info * info);
141 	void (*proxydma_info_read) (struct spu_context * ctx,
142 				    struct spu_proxydma_info * info);
143 };
144 
145 extern struct spu_context_ops spu_hw_ops;
146 extern struct spu_context_ops spu_backing_ops;
147 
148 struct spufs_inode_info {
149 	struct spu_context *i_ctx;
150 	struct spu_gang *i_gang;
151 	struct inode vfs_inode;
152 };
153 #define SPUFS_I(inode) \
154 	container_of(inode, struct spufs_inode_info, vfs_inode)
155 
156 extern struct tree_descr spufs_dir_contents[];
157 extern struct tree_descr spufs_dir_nosched_contents[];
158 
159 /* system call implementation */
160 long spufs_run_spu(struct file *file,
161 		   struct spu_context *ctx, u32 *npc, u32 *status);
162 long spufs_create(struct nameidata *nd,
163 			 unsigned int flags, mode_t mode);
164 extern const struct file_operations spufs_context_fops;
165 
166 /* gang management */
167 struct spu_gang *alloc_spu_gang(void);
168 struct spu_gang *get_spu_gang(struct spu_gang *gang);
169 int put_spu_gang(struct spu_gang *gang);
170 void spu_gang_remove_ctx(struct spu_gang *gang, struct spu_context *ctx);
171 void spu_gang_add_ctx(struct spu_gang *gang, struct spu_context *ctx);
172 
173 /* context management */
174 static inline void spu_acquire(struct spu_context *ctx)
175 {
176 	mutex_lock(&ctx->state_mutex);
177 }
178 
179 static inline void spu_release(struct spu_context *ctx)
180 {
181 	mutex_unlock(&ctx->state_mutex);
182 }
183 
184 struct spu_context * alloc_spu_context(struct spu_gang *gang);
185 void destroy_spu_context(struct kref *kref);
186 struct spu_context * get_spu_context(struct spu_context *ctx);
187 int put_spu_context(struct spu_context *ctx);
188 void spu_unmap_mappings(struct spu_context *ctx);
189 
190 void spu_forget(struct spu_context *ctx);
191 int spu_acquire_runnable(struct spu_context *ctx, unsigned long flags);
192 void spu_acquire_saved(struct spu_context *ctx);
193 int spu_acquire_exclusive(struct spu_context *ctx);
194 
195 int spu_activate(struct spu_context *ctx, unsigned long flags);
196 void spu_deactivate(struct spu_context *ctx);
197 void spu_yield(struct spu_context *ctx);
198 void spu_start_tick(struct spu_context *ctx);
199 void spu_stop_tick(struct spu_context *ctx);
200 void spu_sched_tick(struct work_struct *work);
201 int __init spu_sched_init(void);
202 void __exit spu_sched_exit(void);
203 
204 extern char *isolated_loader;
205 
206 /*
207  * spufs_wait
208  * 	Same as wait_event_interruptible(), except that here
209  *	we need to call spu_release(ctx) before sleeping, and
210  *	then spu_acquire(ctx) when awoken.
211  */
212 
213 #define spufs_wait(wq, condition)					\
214 ({									\
215 	int __ret = 0;							\
216 	DEFINE_WAIT(__wait);						\
217 	for (;;) {							\
218 		prepare_to_wait(&(wq), &__wait, TASK_INTERRUPTIBLE);	\
219 		if (condition)						\
220 			break;						\
221 		if (!signal_pending(current)) {				\
222 			spu_release(ctx);				\
223 			schedule();					\
224 			spu_acquire(ctx);				\
225 			continue;					\
226 		}							\
227 		__ret = -ERESTARTSYS;					\
228 		break;							\
229 	}								\
230 	finish_wait(&(wq), &__wait);					\
231 	__ret;								\
232 })
233 
234 size_t spu_wbox_write(struct spu_context *ctx, u32 data);
235 size_t spu_ibox_read(struct spu_context *ctx, u32 *data);
236 
237 /* irq callback funcs. */
238 void spufs_ibox_callback(struct spu *spu);
239 void spufs_wbox_callback(struct spu *spu);
240 void spufs_stop_callback(struct spu *spu);
241 void spufs_mfc_callback(struct spu *spu);
242 void spufs_dma_callback(struct spu *spu, int type);
243 
244 extern struct spu_coredump_calls spufs_coredump_calls;
245 struct spufs_coredump_reader {
246 	char *name;
247 	ssize_t (*read)(struct spu_context *ctx,
248 			char __user *buffer, size_t size, loff_t *pos);
249 	u64 (*get)(void *data);
250 	size_t size;
251 };
252 extern struct spufs_coredump_reader spufs_coredump_read[];
253 extern int spufs_coredump_num_notes;
254 
255 #endif
256