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