[PATCH] kernel-side context switch code for spufs
[pandora-kernel.git] / include / asm-powerpc / spu_csa.h
1 /*
2  * spu_csa.h: Definitions for SPU context save area (CSA).
3  *
4  * (C) Copyright IBM 2005
5  *
6  * Author: Mark Nutter <mnutter@us.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
23 #ifndef _SPU_CSA_H_
24 #define _SPU_CSA_H_
25
26 /*
27  * Total number of 128-bit registers.
28  */
29 #define NR_SPU_GPRS             128
30 #define NR_SPU_SPRS             9
31 #define NR_SPU_REGS_PAD         7
32 #define NR_SPU_SPILL_REGS       144     /* GPRS + SPRS + PAD */
33 #define SIZEOF_SPU_SPILL_REGS   NR_SPU_SPILL_REGS * 16
34
35 #define SPU_SAVE_COMPLETE       0x3FFB
36 #define SPU_RESTORE_COMPLETE    0x3FFC
37
38 /*
39  * Definitions for various 'stopped' status conditions,
40  * to be recreated during context restore.
41  */
42 #define SPU_STOPPED_STATUS_P    1
43 #define SPU_STOPPED_STATUS_I    2
44 #define SPU_STOPPED_STATUS_H    3
45 #define SPU_STOPPED_STATUS_S    4
46 #define SPU_STOPPED_STATUS_S_I  5
47 #define SPU_STOPPED_STATUS_S_P  6
48 #define SPU_STOPPED_STATUS_P_H  7
49 #define SPU_STOPPED_STATUS_P_I  8
50 #define SPU_STOPPED_STATUS_R    9
51
52 #ifndef  __ASSEMBLY__
53 /**
54  * spu_reg128 - generic 128-bit register definition.
55  */
56 struct spu_reg128 {
57         u32 slot[4];
58 };
59
60 /**
61  * struct spu_lscsa - Local Store Context Save Area.
62  * @gprs: Array of saved registers.
63  * @fpcr: Saved floating point status control register.
64  * @decr: Saved decrementer value.
65  * @decr_status: Indicates decrementer run status.
66  * @ppu_mb: Saved PPU mailbox data.
67  * @ppuint_mb: Saved PPU interrupting mailbox data.
68  * @tag_mask: Saved tag group mask.
69  * @event_mask: Saved event mask.
70  * @srr0: Saved SRR0.
71  * @stopped_status: Conditions to be recreated by restore.
72  * @ls: Saved contents of Local Storage Area.
73  *
74  * The LSCSA represents state that is primarily saved and
75  * restored by SPU-side code.
76  */
77 struct spu_lscsa {
78         struct spu_reg128 gprs[128];
79         struct spu_reg128 fpcr;
80         struct spu_reg128 decr;
81         struct spu_reg128 decr_status;
82         struct spu_reg128 ppu_mb;
83         struct spu_reg128 ppuint_mb;
84         struct spu_reg128 tag_mask;
85         struct spu_reg128 event_mask;
86         struct spu_reg128 srr0;
87         struct spu_reg128 stopped_status;
88         struct spu_reg128 pad[119];     /* 'ls' must be page-aligned. */
89         unsigned char ls[LS_SIZE];
90 };
91
92 #ifdef __KERNEL__
93
94 /*
95  * struct spu_problem_collapsed - condensed problem state area, w/o pads.
96  */
97 struct spu_problem_collapsed {
98         u64 spc_mssync_RW;
99         u32 mfc_lsa_W;
100         u32 unused_pad0;
101         u64 mfc_ea_W;
102         union mfc_tag_size_class_cmd mfc_union_W;
103         u32 dma_qstatus_R;
104         u32 dma_querytype_RW;
105         u32 dma_querymask_RW;
106         u32 dma_tagstatus_R;
107         u32 pu_mb_R;
108         u32 spu_mb_W;
109         u32 mb_stat_R;
110         u32 spu_runcntl_RW;
111         u32 spu_status_R;
112         u32 spu_spc_R;
113         u32 spu_npc_RW;
114         u32 signal_notify1;
115         u32 signal_notify2;
116         u32 unused_pad1;
117 };
118
119 /*
120  * struct spu_priv1_collapsed - condensed privileged 1 area, w/o pads.
121  */
122 struct spu_priv1_collapsed {
123         u64 mfc_sr1_RW;
124         u64 mfc_lpid_RW;
125         u64 spu_idr_RW;
126         u64 mfc_vr_RO;
127         u64 spu_vr_RO;
128         u64 int_mask_class0_RW;
129         u64 int_mask_class1_RW;
130         u64 int_mask_class2_RW;
131         u64 int_stat_class0_RW;
132         u64 int_stat_class1_RW;
133         u64 int_stat_class2_RW;
134         u64 int_route_RW;
135         u64 mfc_atomic_flush_RW;
136         u64 resource_allocation_groupID_RW;
137         u64 resource_allocation_enable_RW;
138         u64 mfc_fir_R;
139         u64 mfc_fir_status_or_W;
140         u64 mfc_fir_status_and_W;
141         u64 mfc_fir_mask_R;
142         u64 mfc_fir_mask_or_W;
143         u64 mfc_fir_mask_and_W;
144         u64 mfc_fir_chkstp_enable_RW;
145         u64 smf_sbi_signal_sel;
146         u64 smf_ato_signal_sel;
147         u64 mfc_sdr_RW;
148         u64 tlb_index_hint_RO;
149         u64 tlb_index_W;
150         u64 tlb_vpn_RW;
151         u64 tlb_rpn_RW;
152         u64 tlb_invalidate_entry_W;
153         u64 tlb_invalidate_all_W;
154         u64 smm_hid;
155         u64 mfc_accr_RW;
156         u64 mfc_dsisr_RW;
157         u64 mfc_dar_RW;
158         u64 rmt_index_RW;
159         u64 rmt_data1_RW;
160         u64 mfc_dsir_R;
161         u64 mfc_lsacr_RW;
162         u64 mfc_lscrr_R;
163         u64 mfc_tclass_id_RW;
164         u64 mfc_rm_boundary;
165         u64 smf_dma_signal_sel;
166         u64 smm_signal_sel;
167         u64 mfc_cer_R;
168         u64 pu_ecc_cntl_RW;
169         u64 pu_ecc_stat_RW;
170         u64 spu_ecc_addr_RW;
171         u64 spu_err_mask_RW;
172         u64 spu_trig0_sel;
173         u64 spu_trig1_sel;
174         u64 spu_trig2_sel;
175         u64 spu_trig3_sel;
176         u64 spu_trace_sel;
177         u64 spu_event0_sel;
178         u64 spu_event1_sel;
179         u64 spu_event2_sel;
180         u64 spu_event3_sel;
181         u64 spu_trace_cntl;
182 };
183
184 /*
185  * struct spu_priv2_collapsed - condensed priviliged 2 area, w/o pads.
186  */
187 struct spu_priv2_collapsed {
188         u64 slb_index_W;
189         u64 slb_esid_RW;
190         u64 slb_vsid_RW;
191         u64 slb_invalidate_entry_W;
192         u64 slb_invalidate_all_W;
193         struct mfc_cq_sr spuq[16];
194         struct mfc_cq_sr puq[8];
195         u64 mfc_control_RW;
196         u64 puint_mb_R;
197         u64 spu_privcntl_RW;
198         u64 spu_lslr_RW;
199         u64 spu_chnlcntptr_RW;
200         u64 spu_chnlcnt_RW;
201         u64 spu_chnldata_RW;
202         u64 spu_cfg_RW;
203         u64 spu_tag_status_query_RW;
204         u64 spu_cmd_buf1_RW;
205         u64 spu_cmd_buf2_RW;
206         u64 spu_atomic_status_RW;
207 };
208
209 /**
210  * struct spu_state
211  * @lscsa: Local Store Context Save Area.
212  * @prob: Collapsed Problem State Area, w/o pads.
213  * @priv1: Collapsed Privileged 1 Area, w/o pads.
214  * @priv2: Collapsed Privileged 2 Area, w/o pads.
215  * @spu_chnlcnt_RW: Array of saved channel counts.
216  * @spu_chnldata_RW: Array of saved channel data.
217  * @suspend_time: Time stamp when decrementer disabled.
218  * @slb_esid_RW: Array of saved SLB esid entries.
219  * @slb_vsid_RW: Array of saved SLB vsid entries.
220  *
221  * Structure representing the whole of the SPU
222  * context save area (CSA).  This struct contains
223  * all of the state necessary to suspend and then
224  * later optionally resume execution of an SPU
225  * context.
226  *
227  * The @lscsa region is by far the largest, and is
228  * allocated separately so that it may either be
229  * pinned or mapped to/from application memory, as
230  * appropriate for the OS environment.
231  */
232 struct spu_state {
233         struct spu_lscsa *lscsa;
234         struct spu_problem_collapsed prob;
235         struct spu_priv1_collapsed priv1;
236         struct spu_priv2_collapsed priv2;
237         u64 spu_chnlcnt_RW[32];
238         u64 spu_chnldata_RW[32];
239         u32 spu_mailbox_data[4];
240         u32 pu_mailbox_data[1];
241         unsigned long suspend_time;
242         u64 slb_esid_RW[8];
243         u64 slb_vsid_RW[8];
244 };
245
246 extern void spu_init_csa(struct spu_state *csa);
247 extern void spu_fini_csa(struct spu_state *csa);
248 extern int spu_save(struct spu_state *prev, struct spu *spu);
249 extern int spu_restore(struct spu_state *new, struct spu *spu);
250 extern int spu_switch(struct spu_state *prev, struct spu_state *new,
251                       struct spu *spu);
252
253 #endif /* __KERNEL__ */
254 #endif /* !__ASSEMBLY__ */
255 #endif /* _SPU_CSA_H_ */