]> err.no Git - linux-2.6/blob - arch/powerpc/platforms/cell/spufs/spufs.h
7f5d0b2fdea37072d48b44bef7388f6e53a96b12
[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 #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 struct spu_context {
44         struct spu *spu;                  /* pointer to a physical SPU */
45         struct spu_state csa;             /* SPU context save area. */
46         spinlock_t mmio_lock;             /* protects mmio access */
47         struct address_space *local_store; /* local store mapping.  */
48         struct address_space *mfc;         /* 'mfc' area mappings. */
49         struct address_space *cntl;        /* 'control' area mappings. */
50         struct address_space *signal1;     /* 'signal1' area mappings. */
51         struct address_space *signal2;     /* 'signal2' area mappings. */
52         struct address_space *mss;         /* 'mss' area mappings. */
53         struct address_space *psmap;       /* 'psmap' area mappings. */
54         struct mutex mapping_lock;
55         u64 object_id;             /* user space pointer for oprofile */
56
57         enum { SPU_STATE_RUNNABLE, SPU_STATE_SAVED } state;
58         struct mutex state_mutex;
59         struct mutex run_mutex;
60
61         struct mm_struct *owner;
62
63         struct kref kref;
64         wait_queue_head_t ibox_wq;
65         wait_queue_head_t wbox_wq;
66         wait_queue_head_t stop_wq;
67         wait_queue_head_t mfc_wq;
68         struct fasync_struct *ibox_fasync;
69         struct fasync_struct *wbox_fasync;
70         struct fasync_struct *mfc_fasync;
71         u32 tagwait;
72         struct spu_context_ops *ops;
73         struct work_struct reap_work;
74         unsigned long flags;
75         unsigned long event_return;
76
77         struct list_head gang_list;
78         struct spu_gang *gang;
79
80         /* owner thread */
81         pid_t tid;
82
83         /* scheduler fields */
84         struct list_head rq;
85         unsigned int time_slice;
86         unsigned long sched_flags;
87         cpumask_t cpus_allowed;
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         void (*restart_dma)(struct spu_context *ctx);
144 };
145
146 extern struct spu_context_ops spu_hw_ops;
147 extern struct spu_context_ops spu_backing_ops;
148
149 struct spufs_inode_info {
150         struct spu_context *i_ctx;
151         struct spu_gang *i_gang;
152         struct inode vfs_inode;
153         int i_openers;
154 };
155 #define SPUFS_I(inode) \
156         container_of(inode, struct spufs_inode_info, vfs_inode)
157
158 extern struct tree_descr spufs_dir_contents[];
159 extern struct tree_descr spufs_dir_nosched_contents[];
160
161 /* system call implementation */
162 long spufs_run_spu(struct file *file,
163                    struct spu_context *ctx, u32 *npc, u32 *status);
164 long spufs_create(struct nameidata *nd,
165                          unsigned int flags, mode_t mode);
166 extern const struct file_operations spufs_context_fops;
167
168 /* gang management */
169 struct spu_gang *alloc_spu_gang(void);
170 struct spu_gang *get_spu_gang(struct spu_gang *gang);
171 int put_spu_gang(struct spu_gang *gang);
172 void spu_gang_remove_ctx(struct spu_gang *gang, struct spu_context *ctx);
173 void spu_gang_add_ctx(struct spu_gang *gang, struct spu_context *ctx);
174
175 /* fault handling */
176 int spufs_handle_class1(struct spu_context *ctx);
177
178 /* context management */
179 extern atomic_t nr_spu_contexts;
180 static inline void spu_acquire(struct spu_context *ctx)
181 {
182         mutex_lock(&ctx->state_mutex);
183 }
184
185 static inline void spu_release(struct spu_context *ctx)
186 {
187         mutex_unlock(&ctx->state_mutex);
188 }
189
190 struct spu_context * alloc_spu_context(struct spu_gang *gang);
191 void destroy_spu_context(struct kref *kref);
192 struct spu_context * get_spu_context(struct spu_context *ctx);
193 int put_spu_context(struct spu_context *ctx);
194 void spu_unmap_mappings(struct spu_context *ctx);
195
196 void spu_forget(struct spu_context *ctx);
197 int spu_acquire_runnable(struct spu_context *ctx, unsigned long flags);
198 void spu_acquire_saved(struct spu_context *ctx);
199
200 int spu_activate(struct spu_context *ctx, unsigned long flags);
201 void spu_deactivate(struct spu_context *ctx);
202 void spu_yield(struct spu_context *ctx);
203 void spu_set_timeslice(struct spu_context *ctx);
204 void spu_update_sched_info(struct spu_context *ctx);
205 void __spu_update_sched_info(struct spu_context *ctx);
206 int __init spu_sched_init(void);
207 void __exit spu_sched_exit(void);
208
209 extern char *isolated_loader;
210
211 /*
212  * spufs_wait
213  *      Same as wait_event_interruptible(), except that here
214  *      we need to call spu_release(ctx) before sleeping, and
215  *      then spu_acquire(ctx) when awoken.
216  */
217
218 #define spufs_wait(wq, condition)                                       \
219 ({                                                                      \
220         int __ret = 0;                                                  \
221         DEFINE_WAIT(__wait);                                            \
222         for (;;) {                                                      \
223                 prepare_to_wait(&(wq), &__wait, TASK_INTERRUPTIBLE);    \
224                 if (condition)                                          \
225                         break;                                          \
226                 if (signal_pending(current)) {                          \
227                         __ret = -ERESTARTSYS;                           \
228                         break;                                          \
229                 }                                                       \
230                 spu_release(ctx);                                       \
231                 schedule();                                             \
232                 spu_acquire(ctx);                                       \
233         }                                                               \
234         finish_wait(&(wq), &__wait);                                    \
235         __ret;                                                          \
236 })
237
238 size_t spu_wbox_write(struct spu_context *ctx, u32 data);
239 size_t spu_ibox_read(struct spu_context *ctx, u32 *data);
240
241 /* irq callback funcs. */
242 void spufs_ibox_callback(struct spu *spu);
243 void spufs_wbox_callback(struct spu *spu);
244 void spufs_stop_callback(struct spu *spu);
245 void spufs_mfc_callback(struct spu *spu);
246 void spufs_dma_callback(struct spu *spu, int type);
247
248 extern struct spu_coredump_calls spufs_coredump_calls;
249 struct spufs_coredump_reader {
250         char *name;
251         ssize_t (*read)(struct spu_context *ctx,
252                         char __user *buffer, size_t size, loff_t *pos);
253         u64 (*get)(void *data);
254         size_t size;
255 };
256 extern struct spufs_coredump_reader spufs_coredump_read[];
257 extern int spufs_coredump_num_notes;
258
259 #endif