]> pilppa.org Git - linux-2.6-omap-h63xx.git/blob - arch/powerpc/platforms/cell/spufs/spufs.h
Merge branch 'for-2.6.25' of git://git.kernel.org/pub/scm/linux/kernel/git/paulus...
[linux-2.6-omap-h63xx.git] / 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 #include <linux/cpumask.h>
30
31 #include <asm/spu.h>
32 #include <asm/spu_csa.h>
33 #include <asm/spu_info.h>
34
35 /* The magic number for our file system */
36 enum {
37         SPUFS_MAGIC = 0x23c9b64e,
38 };
39
40 struct spu_context_ops;
41 struct spu_gang;
42
43 /* ctx->sched_flags */
44 enum {
45         SPU_SCHED_NOTIFY_ACTIVE,
46         SPU_SCHED_WAS_ACTIVE,   /* was active upon spu_acquire_saved()  */
47 };
48
49 struct spu_context {
50         struct spu *spu;                  /* pointer to a physical SPU */
51         struct spu_state csa;             /* SPU context save area. */
52         spinlock_t mmio_lock;             /* protects mmio access */
53         struct address_space *local_store; /* local store mapping.  */
54         struct address_space *mfc;         /* 'mfc' area mappings. */
55         struct address_space *cntl;        /* 'control' area mappings. */
56         struct address_space *signal1;     /* 'signal1' area mappings. */
57         struct address_space *signal2;     /* 'signal2' area mappings. */
58         struct address_space *mss;         /* 'mss' area mappings. */
59         struct address_space *psmap;       /* 'psmap' area mappings. */
60         struct mutex mapping_lock;
61         u64 object_id;             /* user space pointer for oprofile */
62
63         enum { SPU_STATE_RUNNABLE, SPU_STATE_SAVED } state;
64         struct mutex state_mutex;
65         struct mutex run_mutex;
66
67         struct mm_struct *owner;
68
69         struct kref kref;
70         wait_queue_head_t ibox_wq;
71         wait_queue_head_t wbox_wq;
72         wait_queue_head_t stop_wq;
73         wait_queue_head_t mfc_wq;
74         wait_queue_head_t run_wq;
75         struct fasync_struct *ibox_fasync;
76         struct fasync_struct *wbox_fasync;
77         struct fasync_struct *mfc_fasync;
78         u32 tagwait;
79         struct spu_context_ops *ops;
80         struct work_struct reap_work;
81         unsigned long flags;
82         unsigned long event_return;
83
84         struct list_head gang_list;
85         struct spu_gang *gang;
86         struct kref *prof_priv_kref;
87         void ( * prof_priv_release) (struct kref *kref);
88
89         /* owner thread */
90         pid_t tid;
91
92         /* scheduler fields */
93         struct list_head rq;
94         unsigned int time_slice;
95         unsigned long sched_flags;
96         cpumask_t cpus_allowed;
97         int policy;
98         int prio;
99
100         /* statistics */
101         struct {
102                 /* updates protected by ctx->state_mutex */
103                 enum spu_utilization_state util_state;
104                 unsigned long long tstamp;      /* time of last state switch */
105                 unsigned long long times[SPU_UTIL_MAX];
106                 unsigned long long vol_ctx_switch;
107                 unsigned long long invol_ctx_switch;
108                 unsigned long long min_flt;
109                 unsigned long long maj_flt;
110                 unsigned long long hash_flt;
111                 unsigned long long slb_flt;
112                 unsigned long long slb_flt_base; /* # at last ctx switch */
113                 unsigned long long class2_intr;
114                 unsigned long long class2_intr_base; /* # at last ctx switch */
115                 unsigned long long libassist;
116         } stats;
117
118         struct list_head aff_list;
119         int aff_head;
120         int aff_offset;
121 };
122
123 struct spu_gang {
124         struct list_head list;
125         struct mutex mutex;
126         struct kref kref;
127         int contexts;
128
129         struct spu_context *aff_ref_ctx;
130         struct list_head aff_list_head;
131         struct mutex aff_mutex;
132         int aff_flags;
133         struct spu *aff_ref_spu;
134         atomic_t aff_sched_count;
135 };
136
137 /* Flag bits for spu_gang aff_flags */
138 #define AFF_OFFSETS_SET         1
139 #define AFF_MERGED              2
140
141 struct mfc_dma_command {
142         int32_t pad;    /* reserved */
143         uint32_t lsa;   /* local storage address */
144         uint64_t ea;    /* effective address */
145         uint16_t size;  /* transfer size */
146         uint16_t tag;   /* command tag */
147         uint16_t class; /* class ID */
148         uint16_t cmd;   /* command opcode */
149 };
150
151
152 /* SPU context query/set operations. */
153 struct spu_context_ops {
154         int (*mbox_read) (struct spu_context * ctx, u32 * data);
155          u32(*mbox_stat_read) (struct spu_context * ctx);
156         unsigned int (*mbox_stat_poll)(struct spu_context *ctx,
157                                         unsigned int events);
158         int (*ibox_read) (struct spu_context * ctx, u32 * data);
159         int (*wbox_write) (struct spu_context * ctx, u32 data);
160          u32(*signal1_read) (struct spu_context * ctx);
161         void (*signal1_write) (struct spu_context * ctx, u32 data);
162          u32(*signal2_read) (struct spu_context * ctx);
163         void (*signal2_write) (struct spu_context * ctx, u32 data);
164         void (*signal1_type_set) (struct spu_context * ctx, u64 val);
165          u64(*signal1_type_get) (struct spu_context * ctx);
166         void (*signal2_type_set) (struct spu_context * ctx, u64 val);
167          u64(*signal2_type_get) (struct spu_context * ctx);
168          u32(*npc_read) (struct spu_context * ctx);
169         void (*npc_write) (struct spu_context * ctx, u32 data);
170          u32(*status_read) (struct spu_context * ctx);
171         char*(*get_ls) (struct spu_context * ctx);
172         void (*privcntl_write) (struct spu_context *ctx, u64 data);
173          u32 (*runcntl_read) (struct spu_context * ctx);
174         void (*runcntl_write) (struct spu_context * ctx, u32 data);
175         void (*runcntl_stop) (struct spu_context * ctx);
176         void (*master_start) (struct spu_context * ctx);
177         void (*master_stop) (struct spu_context * ctx);
178         int (*set_mfc_query)(struct spu_context * ctx, u32 mask, u32 mode);
179         u32 (*read_mfc_tagstatus)(struct spu_context * ctx);
180         u32 (*get_mfc_free_elements)(struct spu_context *ctx);
181         int (*send_mfc_command)(struct spu_context * ctx,
182                                 struct mfc_dma_command * cmd);
183         void (*dma_info_read) (struct spu_context * ctx,
184                                struct spu_dma_info * info);
185         void (*proxydma_info_read) (struct spu_context * ctx,
186                                     struct spu_proxydma_info * info);
187         void (*restart_dma)(struct spu_context *ctx);
188 };
189
190 extern struct spu_context_ops spu_hw_ops;
191 extern struct spu_context_ops spu_backing_ops;
192
193 struct spufs_inode_info {
194         struct spu_context *i_ctx;
195         struct spu_gang *i_gang;
196         struct inode vfs_inode;
197         int i_openers;
198 };
199 #define SPUFS_I(inode) \
200         container_of(inode, struct spufs_inode_info, vfs_inode)
201
202 extern struct tree_descr spufs_dir_contents[];
203 extern struct tree_descr spufs_dir_nosched_contents[];
204
205 /* system call implementation */
206 extern struct spufs_calls spufs_calls;
207 long spufs_run_spu(struct spu_context *ctx, u32 *npc, u32 *status);
208 long spufs_create(struct nameidata *nd, unsigned int flags,
209                         mode_t mode, struct file *filp);
210 /* ELF coredump callbacks for writing SPU ELF notes */
211 extern int spufs_coredump_extra_notes_size(void);
212 extern int spufs_coredump_extra_notes_write(struct file *file, loff_t *foffset);
213
214 extern const struct file_operations spufs_context_fops;
215
216 /* gang management */
217 struct spu_gang *alloc_spu_gang(void);
218 struct spu_gang *get_spu_gang(struct spu_gang *gang);
219 int put_spu_gang(struct spu_gang *gang);
220 void spu_gang_remove_ctx(struct spu_gang *gang, struct spu_context *ctx);
221 void spu_gang_add_ctx(struct spu_gang *gang, struct spu_context *ctx);
222
223 /* fault handling */
224 int spufs_handle_class1(struct spu_context *ctx);
225 int spufs_handle_class0(struct spu_context *ctx);
226
227 /* affinity */
228 struct spu *affinity_check(struct spu_context *ctx);
229
230 /* context management */
231 extern atomic_t nr_spu_contexts;
232 static inline int __must_check spu_acquire(struct spu_context *ctx)
233 {
234         return mutex_lock_interruptible(&ctx->state_mutex);
235 }
236
237 static inline void spu_release(struct spu_context *ctx)
238 {
239         mutex_unlock(&ctx->state_mutex);
240 }
241
242 struct spu_context * alloc_spu_context(struct spu_gang *gang);
243 void destroy_spu_context(struct kref *kref);
244 struct spu_context * get_spu_context(struct spu_context *ctx);
245 int put_spu_context(struct spu_context *ctx);
246 void spu_unmap_mappings(struct spu_context *ctx);
247
248 void spu_forget(struct spu_context *ctx);
249 int __must_check spu_acquire_saved(struct spu_context *ctx);
250 void spu_release_saved(struct spu_context *ctx);
251
252 int spu_stopped(struct spu_context *ctx, u32 * stat);
253 void spu_del_from_rq(struct spu_context *ctx);
254 int spu_activate(struct spu_context *ctx, unsigned long flags);
255 void spu_deactivate(struct spu_context *ctx);
256 void spu_yield(struct spu_context *ctx);
257 void spu_switch_notify(struct spu *spu, struct spu_context *ctx);
258 void spu_set_timeslice(struct spu_context *ctx);
259 void spu_update_sched_info(struct spu_context *ctx);
260 void __spu_update_sched_info(struct spu_context *ctx);
261 int __init spu_sched_init(void);
262 void spu_sched_exit(void);
263
264 extern char *isolated_loader;
265
266 /*
267  * spufs_wait
268  *      Same as wait_event_interruptible(), except that here
269  *      we need to call spu_release(ctx) before sleeping, and
270  *      then spu_acquire(ctx) when awoken.
271  *
272  *      Returns with state_mutex re-acquired when successfull or
273  *      with -ERESTARTSYS and the state_mutex dropped when interrupted.
274  */
275
276 #define spufs_wait(wq, condition)                                       \
277 ({                                                                      \
278         int __ret = 0;                                                  \
279         DEFINE_WAIT(__wait);                                            \
280         for (;;) {                                                      \
281                 prepare_to_wait(&(wq), &__wait, TASK_INTERRUPTIBLE);    \
282                 if (condition)                                          \
283                         break;                                          \
284                 spu_release(ctx);                                       \
285                 if (signal_pending(current)) {                          \
286                         __ret = -ERESTARTSYS;                           \
287                         break;                                          \
288                 }                                                       \
289                 schedule();                                             \
290                 __ret = spu_acquire(ctx);                               \
291                 if (__ret)                                              \
292                         break;                                          \
293         }                                                               \
294         finish_wait(&(wq), &__wait);                                    \
295         __ret;                                                          \
296 })
297
298 size_t spu_wbox_write(struct spu_context *ctx, u32 data);
299 size_t spu_ibox_read(struct spu_context *ctx, u32 *data);
300
301 /* irq callback funcs. */
302 void spufs_ibox_callback(struct spu *spu);
303 void spufs_wbox_callback(struct spu *spu);
304 void spufs_stop_callback(struct spu *spu);
305 void spufs_mfc_callback(struct spu *spu);
306 void spufs_dma_callback(struct spu *spu, int type);
307
308 extern struct spu_coredump_calls spufs_coredump_calls;
309 struct spufs_coredump_reader {
310         char *name;
311         ssize_t (*read)(struct spu_context *ctx,
312                         char __user *buffer, size_t size, loff_t *pos);
313         u64 (*get)(struct spu_context *ctx);
314         size_t size;
315 };
316 extern struct spufs_coredump_reader spufs_coredump_read[];
317 extern int spufs_coredump_num_notes;
318
319 extern int spu_init_csa(struct spu_state *csa);
320 extern void spu_fini_csa(struct spu_state *csa);
321 extern int spu_save(struct spu_state *prev, struct spu *spu);
322 extern int spu_restore(struct spu_state *new, struct spu *spu);
323 extern int spu_switch(struct spu_state *prev, struct spu_state *new,
324                       struct spu *spu);
325 extern int spu_alloc_lscsa(struct spu_state *csa);
326 extern void spu_free_lscsa(struct spu_state *csa);
327
328 extern void spuctx_switch_state(struct spu_context *ctx,
329                 enum spu_utilization_state new_state);
330
331 #define spu_context_trace(name, ctx, spu) \
332         trace_mark(name, "%p %p", ctx, spu);
333 #define spu_context_nospu_trace(name, ctx) \
334         trace_mark(name, "%p", ctx);
335
336 #endif