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