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