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