err.no Git - linux-2.6/blob - 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         /* statistics */
  92         struct {
  93                 /* updates protected by ctx->state_mutex */
  94                 enum spu_utilization_state util_state;
  95                 unsigned long long tstamp;      /* time of last state switch */
  96                 unsigned long long times[SPU_UTIL_MAX];
  97                 unsigned long long vol_ctx_switch;
  98                 unsigned long long invol_ctx_switch;
  99                 unsigned long long min_flt;
 100                 unsigned long long maj_flt;
 101                 unsigned long long hash_flt;
 102                 unsigned long long slb_flt;
 103                 unsigned long long slb_flt_base; /* # at last ctx switch */
 104                 unsigned long long class2_intr;
 105                 unsigned long long class2_intr_base; /* # at last ctx switch */
 106                 unsigned long long libassist;
 107         } stats;
 108 };
 109
 110 struct spu_gang {
 111         struct list_head list;
 112         struct mutex mutex;
 113         struct kref kref;
 114         int contexts;
 115 };
 116
 117 struct mfc_dma_command {
 118         int32_t pad;    /* reserved */
 119         uint32_t lsa;   /* local storage address */
 120         uint64_t ea;    /* effective address */
 121         uint16_t size;  /* transfer size */
 122         uint16_t tag;   /* command tag */
 123         uint16_t class; /* class ID */
 124         uint16_t cmd;   /* command opcode */
 125 };
 126
 127
 128 /* SPU context query/set operations. */
 129 struct spu_context_ops {
 130         int (*mbox_read) (struct spu_context * ctx, u32 * data);
 131          u32(*mbox_stat_read) (struct spu_context * ctx);
 132         unsigned int (*mbox_stat_poll)(struct spu_context *ctx,
 133                                         unsigned int events);
 134         int (*ibox_read) (struct spu_context * ctx, u32 * data);
 135         int (*wbox_write) (struct spu_context * ctx, u32 data);
 136          u32(*signal1_read) (struct spu_context * ctx);
 137         void (*signal1_write) (struct spu_context * ctx, u32 data);
 138          u32(*signal2_read) (struct spu_context * ctx);
 139         void (*signal2_write) (struct spu_context * ctx, u32 data);
 140         void (*signal1_type_set) (struct spu_context * ctx, u64 val);
 141          u64(*signal1_type_get) (struct spu_context * ctx);
 142         void (*signal2_type_set) (struct spu_context * ctx, u64 val);
 143          u64(*signal2_type_get) (struct spu_context * ctx);
 144          u32(*npc_read) (struct spu_context * ctx);
 145         void (*npc_write) (struct spu_context * ctx, u32 data);
 146          u32(*status_read) (struct spu_context * ctx);
 147         char*(*get_ls) (struct spu_context * ctx);
 148          u32 (*runcntl_read) (struct spu_context * ctx);
 149         void (*runcntl_write) (struct spu_context * ctx, u32 data);
 150         void (*master_start) (struct spu_context * ctx);
 151         void (*master_stop) (struct spu_context * ctx);
 152         int (*set_mfc_query)(struct spu_context * ctx, u32 mask, u32 mode);
 153         u32 (*read_mfc_tagstatus)(struct spu_context * ctx);
 154         u32 (*get_mfc_free_elements)(struct spu_context *ctx);
 155         int (*send_mfc_command)(struct spu_context * ctx,
 156                                 struct mfc_dma_command * cmd);
 157         void (*dma_info_read) (struct spu_context * ctx,
 158                                struct spu_dma_info * info);
 159         void (*proxydma_info_read) (struct spu_context * ctx,
 160                                     struct spu_proxydma_info * info);
 161         void (*restart_dma)(struct spu_context *ctx);
 162 };
 163
 164 extern struct spu_context_ops spu_hw_ops;
 165 extern struct spu_context_ops spu_backing_ops;
 166
 167 struct spufs_inode_info {
 168         struct spu_context *i_ctx;
 169         struct spu_gang *i_gang;
 170         struct inode vfs_inode;
 171         int i_openers;
 172 };
 173 #define SPUFS_I(inode) \
 174         container_of(inode, struct spufs_inode_info, vfs_inode)
 175
 176 extern struct tree_descr spufs_dir_contents[];
 177 extern struct tree_descr spufs_dir_nosched_contents[];
 178
 179 /* system call implementation */
 180 long spufs_run_spu(struct file *file,
 181                    struct spu_context *ctx, u32 *npc, u32 *status);
 182 long spufs_create(struct nameidata *nd,
 183                          unsigned int flags, mode_t mode);
 184 extern const struct file_operations spufs_context_fops;
 185
 186 /* gang management */
 187 struct spu_gang *alloc_spu_gang(void);
 188 struct spu_gang *get_spu_gang(struct spu_gang *gang);
 189 int put_spu_gang(struct spu_gang *gang);
 190 void spu_gang_remove_ctx(struct spu_gang *gang, struct spu_context *ctx);
 191 void spu_gang_add_ctx(struct spu_gang *gang, struct spu_context *ctx);
 192
 193 /* fault handling */
 194 int spufs_handle_class1(struct spu_context *ctx);
 195
 196 /* context management */
 197 extern atomic_t nr_spu_contexts;
 198 static inline void spu_acquire(struct spu_context *ctx)
 199 {
 200         mutex_lock(&ctx->state_mutex);
 201 }
 202
 203 static inline void spu_release(struct spu_context *ctx)
 204 {
 205         mutex_unlock(&ctx->state_mutex);
 206 }
 207
 208 struct spu_context * alloc_spu_context(struct spu_gang *gang);
 209 void destroy_spu_context(struct kref *kref);
 210 struct spu_context * get_spu_context(struct spu_context *ctx);
 211 int put_spu_context(struct spu_context *ctx);
 212 void spu_unmap_mappings(struct spu_context *ctx);
 213
 214 void spu_forget(struct spu_context *ctx);
 215 int spu_acquire_runnable(struct spu_context *ctx, unsigned long flags);
 216 void spu_acquire_saved(struct spu_context *ctx);
 217
 218 int spu_activate(struct spu_context *ctx, unsigned long flags);
 219 void spu_deactivate(struct spu_context *ctx);
 220 void spu_yield(struct spu_context *ctx);
 221 void spu_set_timeslice(struct spu_context *ctx);
 222 void spu_update_sched_info(struct spu_context *ctx);
 223 void __spu_update_sched_info(struct spu_context *ctx);
 224 int __init spu_sched_init(void);
 225 void spu_sched_exit(void);
 226
 227 extern char *isolated_loader;
 228
 229 /*
 230  * spufs_wait
 231  *      Same as wait_event_interruptible(), except that here
 232  *      we need to call spu_release(ctx) before sleeping, and
 233  *      then spu_acquire(ctx) when awoken.
 234  */
 235
 236 #define spufs_wait(wq, condition)                                       \
 237 ({                                                                      \
 238         int __ret = 0;                                                  \
 239         DEFINE_WAIT(__wait);                                            \
 240         for (;;) {                                                      \
 241                 prepare_to_wait(&(wq), &__wait, TASK_INTERRUPTIBLE);    \
 242                 if (condition)                                          \
 243                         break;                                          \
 244                 if (signal_pending(current)) {                          \
 245                         __ret = -ERESTARTSYS;                           \
 246                         break;                                          \
 247                 }                                                       \
 248                 spu_release(ctx);                                       \
 249                 schedule();                                             \
 250                 spu_acquire(ctx);                                       \
 251         }                                                               \
 252         finish_wait(&(wq), &__wait);                                    \
 253         __ret;                                                          \
 254 })
 255
 256 size_t spu_wbox_write(struct spu_context *ctx, u32 data);
 257 size_t spu_ibox_read(struct spu_context *ctx, u32 *data);
 258
 259 /* irq callback funcs. */
 260 void spufs_ibox_callback(struct spu *spu);
 261 void spufs_wbox_callback(struct spu *spu);
 262 void spufs_stop_callback(struct spu *spu);
 263 void spufs_mfc_callback(struct spu *spu);
 264 void spufs_dma_callback(struct spu *spu, int type);
 265
 266 extern struct spu_coredump_calls spufs_coredump_calls;
 267 struct spufs_coredump_reader {
 268         char *name;
 269         ssize_t (*read)(struct spu_context *ctx,
 270                         char __user *buffer, size_t size, loff_t *pos);
 271         u64 (*get)(void *data);
 272         size_t size;
 273 };
 274 extern struct spufs_coredump_reader spufs_coredump_read[];
 275 extern int spufs_coredump_num_notes;
 276
 277 /*
 278  * This function is a little bit too large for an inline, but
 279  * as fault.c is built into the kernel we can't move it out of
 280  * line.
 281  */
 282 static inline void spuctx_switch_state(struct spu_context *ctx,
 283                 enum spu_utilization_state new_state)
 284 {
 285         unsigned long long curtime;
 286         signed long long delta;
 287         struct timespec ts;
 288         struct spu *spu;
 289         enum spu_utilization_state old_state;
 290
 291         ktime_get_ts(&ts);
 292         curtime = timespec_to_ns(&ts);
 293         delta = curtime - ctx->stats.tstamp;
 294
 295         WARN_ON(!mutex_is_locked(&ctx->state_mutex));
 296         WARN_ON(delta < 0);
 297
 298         spu = ctx->spu;
 299         old_state = ctx->stats.util_state;
 300         ctx->stats.util_state = new_state;
 301         ctx->stats.tstamp = curtime;
 302
 303         /*
 304          * Update the physical SPU utilization statistics.
 305          */
 306         if (spu) {
 307                 ctx->stats.times[old_state] += delta;
 308                 spu->stats.times[old_state] += delta;
 309                 spu->stats.util_state = new_state;
 310                 spu->stats.tstamp = curtime;
 311         }
 312 }
 313
 314 #endif