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