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