[POWERPC] spufs: optimize spu_run
[safe/jmp/linux-2.6] / arch / powerpc / platforms / cell / spufs / spufs.h
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,
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         unsigned long sched_flags;
86         int prio;
87 };
88
89 struct spu_gang {
90         struct list_head list;
91         struct mutex mutex;
92         struct kref kref;
93         int contexts;
94 };
95
96 struct mfc_dma_command {
97         int32_t pad;    /* reserved */
98         uint32_t lsa;   /* local storage address */
99         uint64_t ea;    /* effective address */
100         uint16_t size;  /* transfer size */
101         uint16_t tag;   /* command tag */
102         uint16_t class; /* class ID */
103         uint16_t cmd;   /* command opcode */
104 };
105
106
107 /* SPU context query/set operations. */
108 struct spu_context_ops {
109         int (*mbox_read) (struct spu_context * ctx, u32 * data);
110          u32(*mbox_stat_read) (struct spu_context * ctx);
111         unsigned int (*mbox_stat_poll)(struct spu_context *ctx,
112                                         unsigned int events);
113         int (*ibox_read) (struct spu_context * ctx, u32 * data);
114         int (*wbox_write) (struct spu_context * ctx, u32 data);
115          u32(*signal1_read) (struct spu_context * ctx);
116         void (*signal1_write) (struct spu_context * ctx, u32 data);
117          u32(*signal2_read) (struct spu_context * ctx);
118         void (*signal2_write) (struct spu_context * ctx, u32 data);
119         void (*signal1_type_set) (struct spu_context * ctx, u64 val);
120          u64(*signal1_type_get) (struct spu_context * ctx);
121         void (*signal2_type_set) (struct spu_context * ctx, u64 val);
122          u64(*signal2_type_get) (struct spu_context * ctx);
123          u32(*npc_read) (struct spu_context * ctx);
124         void (*npc_write) (struct spu_context * ctx, u32 data);
125          u32(*status_read) (struct spu_context * ctx);
126         char*(*get_ls) (struct spu_context * ctx);
127          u32 (*runcntl_read) (struct spu_context * ctx);
128         void (*runcntl_write) (struct spu_context * ctx, u32 data);
129         void (*master_start) (struct spu_context * ctx);
130         void (*master_stop) (struct spu_context * ctx);
131         int (*set_mfc_query)(struct spu_context * ctx, u32 mask, u32 mode);
132         u32 (*read_mfc_tagstatus)(struct spu_context * ctx);
133         u32 (*get_mfc_free_elements)(struct spu_context *ctx);
134         int (*send_mfc_command)(struct spu_context * ctx,
135                                 struct mfc_dma_command * cmd);
136         void (*dma_info_read) (struct spu_context * ctx,
137                                struct spu_dma_info * info);
138         void (*proxydma_info_read) (struct spu_context * ctx,
139                                     struct spu_proxydma_info * info);
140 };
141
142 extern struct spu_context_ops spu_hw_ops;
143 extern struct spu_context_ops spu_backing_ops;
144
145 struct spufs_inode_info {
146         struct spu_context *i_ctx;
147         struct spu_gang *i_gang;
148         struct inode vfs_inode;
149 };
150 #define SPUFS_I(inode) \
151         container_of(inode, struct spufs_inode_info, vfs_inode)
152
153 extern struct tree_descr spufs_dir_contents[];
154 extern struct tree_descr spufs_dir_nosched_contents[];
155
156 /* system call implementation */
157 long spufs_run_spu(struct file *file,
158                    struct spu_context *ctx, u32 *npc, u32 *status);
159 long spufs_create(struct nameidata *nd,
160                          unsigned int flags, mode_t mode);
161 extern const struct file_operations spufs_context_fops;
162
163 /* gang management */
164 struct spu_gang *alloc_spu_gang(void);
165 struct spu_gang *get_spu_gang(struct spu_gang *gang);
166 int put_spu_gang(struct spu_gang *gang);
167 void spu_gang_remove_ctx(struct spu_gang *gang, struct spu_context *ctx);
168 void spu_gang_add_ctx(struct spu_gang *gang, struct spu_context *ctx);
169
170 /* context management */
171 static inline void spu_acquire(struct spu_context *ctx)
172 {
173         mutex_lock(&ctx->state_mutex);
174 }
175
176 static inline void spu_release(struct spu_context *ctx)
177 {
178         mutex_unlock(&ctx->state_mutex);
179 }
180
181 struct spu_context * alloc_spu_context(struct spu_gang *gang);
182 void destroy_spu_context(struct kref *kref);
183 struct spu_context * get_spu_context(struct spu_context *ctx);
184 int put_spu_context(struct spu_context *ctx);
185 void spu_unmap_mappings(struct spu_context *ctx);
186
187 void spu_forget(struct spu_context *ctx);
188 int spu_acquire_runnable(struct spu_context *ctx, unsigned long flags);
189 void spu_acquire_saved(struct spu_context *ctx);
190 int spu_acquire_exclusive(struct spu_context *ctx);
191 enum {
192         SPU_ACTIVATE_NOWAKE = 1,
193 };
194 int spu_activate(struct spu_context *ctx, unsigned long flags);
195 void spu_deactivate(struct spu_context *ctx);
196 void spu_yield(struct spu_context *ctx);
197 int __init spu_sched_init(void);
198 void __exit spu_sched_exit(void);
199
200 extern char *isolated_loader;
201
202 /*
203  * spufs_wait
204  *      Same as wait_event_interruptible(), except that here
205  *      we need to call spu_release(ctx) before sleeping, and
206  *      then spu_acquire(ctx) when awoken.
207  */
208
209 #define spufs_wait(wq, condition)                                       \
210 ({                                                                      \
211         int __ret = 0;                                                  \
212         DEFINE_WAIT(__wait);                                            \
213         for (;;) {                                                      \
214                 prepare_to_wait(&(wq), &__wait, TASK_INTERRUPTIBLE);    \
215                 if (condition)                                          \
216                         break;                                          \
217                 if (!signal_pending(current)) {                         \
218                         spu_release(ctx);                               \
219                         schedule();                                     \
220                         spu_acquire(ctx);                               \
221                         continue;                                       \
222                 }                                                       \
223                 __ret = -ERESTARTSYS;                                   \
224                 break;                                                  \
225         }                                                               \
226         finish_wait(&(wq), &__wait);                                    \
227         __ret;                                                          \
228 })
229
230 size_t spu_wbox_write(struct spu_context *ctx, u32 data);
231 size_t spu_ibox_read(struct spu_context *ctx, u32 *data);
232
233 /* irq callback funcs. */
234 void spufs_ibox_callback(struct spu *spu);
235 void spufs_wbox_callback(struct spu *spu);
236 void spufs_stop_callback(struct spu *spu);
237 void spufs_mfc_callback(struct spu *spu);
238 void spufs_dma_callback(struct spu *spu, int type);
239
240 extern struct spu_coredump_calls spufs_coredump_calls;
241 struct spufs_coredump_reader {
242         char *name;
243         ssize_t (*read)(struct spu_context *ctx,
244                         char __user *buffer, size_t size, loff_t *pos);
245         u64 (*get)(void *data);
246         size_t size;
247 };
248 extern struct spufs_coredump_reader spufs_coredump_read[];
249 extern int spufs_coredump_num_notes;
250
251 #endif