c5865dd19eec663d7dca14e16ad9f51edc644b14
[linux-2.6.git] / drivers / misc / sgi-gru / grulib.h
1 /*
2  *  Copyright (c) 2008 Silicon Graphics, Inc.  All Rights Reserved.
3  *
4  *  This program is free software; you can redistribute it and/or modify
5  *  it under the terms of the GNU Lesser General Public License as published by
6  *  the Free Software Foundation; either version 2.1 of the License, or
7  *  (at your option) any later version.
8  *
9  *  This program is distributed in the hope that it will be useful,
10  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
11  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  *  GNU Lesser General Public License for more details.
13  *
14  *  You should have received a copy of the GNU Lesser General Public License
15  *  along with this program; if not, write to the Free Software
16  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
17  */
18
19 #ifndef __GRULIB_H__
20 #define __GRULIB_H__
21
22 #define GRU_BASENAME            "gru"
23 #define GRU_FULLNAME            "/dev/gru"
24 #define GRU_IOCTL_NUM            'G'
25
26 /*
27  * Maximum number of GRU segments that a user can have open
28  * ZZZ temp - set high for testing. Revisit.
29  */
30 #define GRU_MAX_OPEN_CONTEXTS           32
31
32 /* Set Number of Request Blocks */
33 #define GRU_CREATE_CONTEXT              _IOWR(GRU_IOCTL_NUM, 1, void *)
34
35 /* Register task as using the slice */
36 #define GRU_SET_TASK_SLICE              _IOWR(GRU_IOCTL_NUM, 5, void *)
37
38 /* Fetch exception detail */
39 #define GRU_USER_GET_EXCEPTION_DETAIL   _IOWR(GRU_IOCTL_NUM, 6, void *)
40
41 /* For user call_os handling - normally a TLB fault */
42 #define GRU_USER_CALL_OS                _IOWR(GRU_IOCTL_NUM, 8, void *)
43
44 /* For user unload context */
45 #define GRU_USER_UNLOAD_CONTEXT         _IOWR(GRU_IOCTL_NUM, 9, void *)
46
47 /* For fetching GRU chiplet status */
48 #define GRU_GET_CHIPLET_STATUS          _IOWR(GRU_IOCTL_NUM, 10, void *)
49
50 /* For dumpping GRU chiplet state */
51 #define GRU_DUMP_CHIPLET_STATE          _IOWR(GRU_IOCTL_NUM, 11, void *)
52
53 /* For getting gseg statistics */
54 #define GRU_GET_GSEG_STATISTICS         _IOWR(GRU_IOCTL_NUM, 12, void *)
55
56 /* For user TLB flushing (primarily for tests) */
57 #define GRU_USER_FLUSH_TLB              _IOWR(GRU_IOCTL_NUM, 50, void *)
58
59 /* Get some config options (primarily for tests & emulator) */
60 #define GRU_GET_CONFIG_INFO             _IOWR(GRU_IOCTL_NUM, 51, void *)
61
62 /* Various kernel self-tests */
63 #define GRU_KTEST                       _IOWR(GRU_IOCTL_NUM, 52, void *)
64
65 #define CONTEXT_WINDOW_BYTES(th)        (GRU_GSEG_PAGESIZE * (th))
66 #define THREAD_POINTER(p, th)           (p + GRU_GSEG_PAGESIZE * (th))
67 #define GSEG_START(cb)                  ((void *)((unsigned long)(cb) & ~(GRU_GSEG_PAGESIZE - 1)))
68
69 /*
70  * Statictics kept on a per-GTS basis.
71  */
72 struct gts_statistics {
73         unsigned long   fmm_tlbdropin;
74         unsigned long   upm_tlbdropin;
75         unsigned long   context_stolen;
76 };
77
78 struct gru_get_gseg_statistics_req {
79         unsigned long           gseg;
80         struct gts_statistics   stats;
81 };
82
83 /*
84  * Structure used to pass TLB flush parameters to the driver
85  */
86 struct gru_create_context_req {
87         unsigned long           gseg;
88         unsigned int            data_segment_bytes;
89         unsigned int            control_blocks;
90         unsigned int            maximum_thread_count;
91         unsigned int            options;
92 };
93
94 /*
95  * Structure used to pass unload context parameters to the driver
96  */
97 struct gru_unload_context_req {
98         unsigned long   gseg;
99 };
100
101 /*
102  * Structure used to pass TLB flush parameters to the driver
103  */
104 struct gru_flush_tlb_req {
105         unsigned long   gseg;
106         unsigned long   vaddr;
107         size_t          len;
108 };
109
110 /*
111  * Structure used to pass TLB flush parameters to the driver
112  */
113 enum {dcs_pid, dcs_gid};
114 struct gru_dump_chiplet_state_req {
115         unsigned int    op;
116         int             gid;
117         int             ctxnum;
118         char            data_opt;
119         char            lock_cch;
120         pid_t           pid;
121         void            *buf;
122         size_t          buflen;
123         /* ---- output --- */
124         unsigned int    num_contexts;
125 };
126
127 #define GRU_DUMP_MAGIC  0x3474ab6c
128 struct gru_dump_context_header {
129         unsigned int    magic;
130         unsigned char   gid;
131         unsigned char   ctxnum;
132         unsigned char   cbrcnt;
133         unsigned char   dsrcnt;
134         pid_t           pid;
135         unsigned long   vaddr;
136         int             cch_locked;
137         unsigned long   data[0];
138 };
139
140 /*
141  * GRU configuration info (temp - for testing)
142  */
143 struct gru_config_info {
144         int             cpus;
145         int             blades;
146         int             nodes;
147         int             chiplets;
148         int             fill[16];
149 };
150
151 #endif /* __GRULIB_H__ */