gru_instructions.h revision 5658366ab55cccab24b4799b3ff8e94bdc1cc529
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 __GRU_INSTRUCTIONS_H__
20#define __GRU_INSTRUCTIONS_H__
21
22extern int gru_check_status_proc(void *cb);
23extern int gru_wait_proc(void *cb);
24extern void gru_wait_abort_proc(void *cb);
25
26
27
28/*
29 * Architecture dependent functions
30 */
31
32#if defined(CONFIG_IA64)
33#include <linux/compiler.h>
34#include <asm/intrinsics.h>
35#define __flush_cache(p)		ia64_fc((unsigned long)p)
36/* Use volatile on IA64 to ensure ordering via st4.rel */
37#define gru_ordered_store_ulong(p, v)					\
38		do {							\
39			barrier();					\
40			*((volatile unsigned long *)(p)) = v; /* force st.rel */	\
41		} while (0)
42#elif defined(CONFIG_X86_64)
43#define __flush_cache(p)		clflush(p)
44#define gru_ordered_store_ulong(p, v)					\
45		do {							\
46			barrier();					\
47			*(unsigned long *)p = v;			\
48		} while (0)
49#else
50#error "Unsupported architecture"
51#endif
52
53/*
54 * Control block status and exception codes
55 */
56#define CBS_IDLE			0
57#define CBS_EXCEPTION			1
58#define CBS_ACTIVE			2
59#define CBS_CALL_OS			3
60
61/* CB substatus bitmasks */
62#define CBSS_MSG_QUEUE_MASK		7
63#define CBSS_IMPLICIT_ABORT_ACTIVE_MASK	8
64
65/* CB substatus message queue values (low 3 bits of substatus) */
66#define CBSS_NO_ERROR			0
67#define CBSS_LB_OVERFLOWED		1
68#define CBSS_QLIMIT_REACHED		2
69#define CBSS_PAGE_OVERFLOW		3
70#define CBSS_AMO_NACKED			4
71#define CBSS_PUT_NACKED			5
72
73/*
74 * Structure used to fetch exception detail for CBs that terminate with
75 * CBS_EXCEPTION
76 */
77struct control_block_extended_exc_detail {
78	unsigned long	cb;
79	int		opc;
80	int		ecause;
81	int		exopc;
82	long		exceptdet0;
83	int		exceptdet1;
84	int		cbrstate;
85	int		cbrexecstatus;
86};
87
88/*
89 * Instruction formats
90 */
91
92/*
93 * Generic instruction format.
94 * This definition has precise bit field definitions.
95 */
96struct gru_instruction_bits {
97    /* DW 0  - low */
98    unsigned int		icmd:      1;
99    unsigned char		ima:	   3;	/* CB_DelRep, unmapped mode */
100    unsigned char		reserved0: 4;
101    unsigned int		xtype:     3;
102    unsigned int		iaa0:      2;
103    unsigned int		iaa1:      2;
104    unsigned char		reserved1: 1;
105    unsigned char		opc:       8;	/* opcode */
106    unsigned char		exopc:     8;	/* extended opcode */
107    /* DW 0  - high */
108    unsigned int		idef2:    22;	/* TRi0 */
109    unsigned char		reserved2: 2;
110    unsigned char		istatus:   2;
111    unsigned char		isubstatus:4;
112    unsigned char		reserved3: 1;
113    unsigned char		tlb_fault_color: 1;
114    /* DW 1 */
115    unsigned long		idef4;		/* 42 bits: TRi1, BufSize */
116    /* DW 2-6 */
117    unsigned long		idef1;		/* BAddr0 */
118    unsigned long		idef5;		/* Nelem */
119    unsigned long		idef6;		/* Stride, Operand1 */
120    unsigned long		idef3;		/* BAddr1, Value, Operand2 */
121    unsigned long		reserved4;
122    /* DW 7 */
123    unsigned long		avalue;		 /* AValue */
124};
125
126/*
127 * Generic instruction with friendlier names. This format is used
128 * for inline instructions.
129 */
130struct gru_instruction {
131    /* DW 0 */
132    union {
133    	unsigned long		op64;    /* icmd,xtype,iaa0,ima,opc,tri0 */
134	struct {
135		unsigned int	op32;
136		unsigned int	tri0;
137	};
138    };
139    unsigned long		tri1_bufsize;		/* DW 1 */
140    unsigned long		baddr0;			/* DW 2 */
141    unsigned long		nelem;			/* DW 3 */
142    unsigned long		op1_stride;		/* DW 4 */
143    unsigned long		op2_value_baddr1;	/* DW 5 */
144    unsigned long		reserved0;		/* DW 6 */
145    unsigned long		avalue;			/* DW 7 */
146};
147
148/* Some shifts and masks for the low 64 bits of a GRU command */
149#define GRU_CB_ICMD_SHFT	0
150#define GRU_CB_ICMD_MASK	0x1
151#define GRU_CB_XTYPE_SHFT	8
152#define GRU_CB_XTYPE_MASK	0x7
153#define GRU_CB_IAA0_SHFT	11
154#define GRU_CB_IAA0_MASK	0x3
155#define GRU_CB_IAA1_SHFT	13
156#define GRU_CB_IAA1_MASK	0x3
157#define GRU_CB_IMA_SHFT		1
158#define GRU_CB_IMA_MASK		0x3
159#define GRU_CB_OPC_SHFT		16
160#define GRU_CB_OPC_MASK		0xff
161#define GRU_CB_EXOPC_SHFT	24
162#define GRU_CB_EXOPC_MASK	0xff
163#define GRU_IDEF2_SHFT		32
164#define GRU_IDEF2_MASK		0x3ffff
165#define GRU_ISTATUS_SHFT	56
166#define GRU_ISTATUS_MASK	0x3
167
168/* GRU instruction opcodes (opc field) */
169#define OP_NOP		0x00
170#define OP_BCOPY	0x01
171#define OP_VLOAD	0x02
172#define OP_IVLOAD	0x03
173#define OP_VSTORE	0x04
174#define OP_IVSTORE	0x05
175#define OP_VSET		0x06
176#define OP_IVSET	0x07
177#define OP_MESQ		0x08
178#define OP_GAMXR	0x09
179#define OP_GAMIR	0x0a
180#define OP_GAMIRR	0x0b
181#define OP_GAMER	0x0c
182#define OP_GAMERR	0x0d
183#define OP_BSTORE	0x0e
184#define OP_VFLUSH	0x0f
185
186
187/* Extended opcodes values (exopc field) */
188
189/* GAMIR - AMOs with implicit operands */
190#define EOP_IR_FETCH	0x01 /* Plain fetch of memory */
191#define EOP_IR_CLR	0x02 /* Fetch and clear */
192#define EOP_IR_INC	0x05 /* Fetch and increment */
193#define EOP_IR_DEC	0x07 /* Fetch and decrement */
194#define EOP_IR_QCHK1	0x0d /* Queue check, 64 byte msg */
195#define EOP_IR_QCHK2	0x0e /* Queue check, 128 byte msg */
196
197/* GAMIRR - Registered AMOs with implicit operands */
198#define EOP_IRR_FETCH	0x01 /* Registered fetch of memory */
199#define EOP_IRR_CLR	0x02 /* Registered fetch and clear */
200#define EOP_IRR_INC	0x05 /* Registered fetch and increment */
201#define EOP_IRR_DEC	0x07 /* Registered fetch and decrement */
202#define EOP_IRR_DECZ	0x0f /* Registered fetch and decrement, update on zero*/
203
204/* GAMER - AMOs with explicit operands */
205#define EOP_ER_SWAP	0x00 /* Exchange argument and memory */
206#define EOP_ER_OR	0x01 /* Logical OR with memory */
207#define EOP_ER_AND	0x02 /* Logical AND with memory */
208#define EOP_ER_XOR	0x03 /* Logical XOR with memory */
209#define EOP_ER_ADD	0x04 /* Add value to memory */
210#define EOP_ER_CSWAP	0x08 /* Compare with operand2, write operand1 if match*/
211#define EOP_ER_CADD	0x0c /* Queue check, operand1*64 byte msg */
212
213/* GAMERR - Registered AMOs with explicit operands */
214#define EOP_ERR_SWAP	0x00 /* Exchange argument and memory */
215#define EOP_ERR_OR	0x01 /* Logical OR with memory */
216#define EOP_ERR_AND	0x02 /* Logical AND with memory */
217#define EOP_ERR_XOR	0x03 /* Logical XOR with memory */
218#define EOP_ERR_ADD	0x04 /* Add value to memory */
219#define EOP_ERR_CSWAP	0x08 /* Compare with operand2, write operand1 if match*/
220#define EOP_ERR_EPOLL	0x09 /* Poll for equality */
221#define EOP_ERR_NPOLL	0x0a /* Poll for inequality */
222
223/* GAMXR - SGI Arithmetic unit */
224#define EOP_XR_CSWAP	0x0b /* Masked compare exchange */
225
226
227/* Transfer types (xtype field) */
228#define XTYPE_B		0x0	/* byte */
229#define XTYPE_S		0x1	/* short (2-byte) */
230#define XTYPE_W		0x2	/* word (4-byte) */
231#define XTYPE_DW	0x3	/* doubleword (8-byte) */
232#define XTYPE_CL	0x6	/* cacheline (64-byte) */
233
234
235/* Instruction access attributes (iaa0, iaa1 fields) */
236#define IAA_RAM		0x0	/* normal cached RAM access */
237#define IAA_NCRAM	0x2	/* noncoherent RAM access */
238#define IAA_MMIO	0x1	/* noncoherent memory-mapped I/O space */
239#define IAA_REGISTER	0x3	/* memory-mapped registers, etc. */
240
241
242/* Instruction mode attributes (ima field) */
243#define IMA_MAPPED	0x0	/* Virtual mode  */
244#define IMA_CB_DELAY	0x1	/* hold read responses until status changes */
245#define IMA_UNMAPPED	0x2	/* bypass the TLBs (OS only) */
246#define IMA_INTERRUPT	0x4	/* Interrupt when instruction completes */
247
248/* CBE ecause bits */
249#define CBE_CAUSE_RI				(1 << 0)
250#define CBE_CAUSE_INVALID_INSTRUCTION		(1 << 1)
251#define CBE_CAUSE_UNMAPPED_MODE_FORBIDDEN	(1 << 2)
252#define CBE_CAUSE_PE_CHECK_DATA_ERROR		(1 << 3)
253#define CBE_CAUSE_IAA_GAA_MISMATCH		(1 << 4)
254#define CBE_CAUSE_DATA_SEGMENT_LIMIT_EXCEPTION	(1 << 5)
255#define CBE_CAUSE_OS_FATAL_TLB_FAULT		(1 << 6)
256#define CBE_CAUSE_EXECUTION_HW_ERROR		(1 << 7)
257#define CBE_CAUSE_TLBHW_ERROR			(1 << 8)
258#define CBE_CAUSE_RA_REQUEST_TIMEOUT		(1 << 9)
259#define CBE_CAUSE_HA_REQUEST_TIMEOUT		(1 << 10)
260#define CBE_CAUSE_RA_RESPONSE_FATAL		(1 << 11)
261#define CBE_CAUSE_RA_RESPONSE_NON_FATAL		(1 << 12)
262#define CBE_CAUSE_HA_RESPONSE_FATAL		(1 << 13)
263#define CBE_CAUSE_HA_RESPONSE_NON_FATAL		(1 << 14)
264#define CBE_CAUSE_ADDRESS_SPACE_DECODE_ERROR	(1 << 15)
265#define CBE_CAUSE_PROTOCOL_STATE_DATA_ERROR	(1 << 16)
266#define CBE_CAUSE_RA_RESPONSE_DATA_ERROR	(1 << 17)
267#define CBE_CAUSE_HA_RESPONSE_DATA_ERROR	(1 << 18)
268#define CBE_CAUSE_FORCED_ERROR			(1 << 19)
269
270/* CBE cbrexecstatus bits */
271#define CBR_EXS_ABORT_OCC_BIT			0
272#define CBR_EXS_INT_OCC_BIT			1
273#define CBR_EXS_PENDING_BIT			2
274#define CBR_EXS_QUEUED_BIT			3
275#define CBR_EXS_TLB_INVAL_BIT			4
276#define CBR_EXS_EXCEPTION_BIT			5
277#define CBR_EXS_CB_INT_PENDING_BIT		6
278
279#define CBR_EXS_ABORT_OCC			(1 << CBR_EXS_ABORT_OCC_BIT)
280#define CBR_EXS_INT_OCC				(1 << CBR_EXS_INT_OCC_BIT)
281#define CBR_EXS_PENDING				(1 << CBR_EXS_PENDING_BIT)
282#define CBR_EXS_QUEUED				(1 << CBR_EXS_QUEUED_BIT)
283#define CBR_EXS_TLB_INVAL			(1 << CBR_EXS_TLB_INVAL_BIT)
284#define CBR_EXS_EXCEPTION			(1 << CBR_EXS_EXCEPTION_BIT)
285#define CBR_EXS_CB_INT_PENDING			(1 << CBR_EXS_CB_INT_PENDING_BIT)
286
287/*
288 * Exceptions are retried for the following cases. If any OTHER bits are set
289 * in ecause, the exception is not retryable.
290 */
291#define EXCEPTION_RETRY_BITS (CBE_CAUSE_EXECUTION_HW_ERROR |		\
292			      CBE_CAUSE_TLBHW_ERROR |			\
293			      CBE_CAUSE_RA_REQUEST_TIMEOUT |		\
294			      CBE_CAUSE_RA_RESPONSE_NON_FATAL |		\
295			      CBE_CAUSE_HA_RESPONSE_NON_FATAL |		\
296			      CBE_CAUSE_RA_RESPONSE_DATA_ERROR |	\
297			      CBE_CAUSE_HA_RESPONSE_DATA_ERROR		\
298			      )
299
300/* Message queue head structure */
301union gru_mesqhead {
302	unsigned long	val;
303	struct {
304		unsigned int	head;
305		unsigned int	limit;
306	};
307};
308
309
310/* Generate the low word of a GRU instruction */
311static inline unsigned long
312__opdword(unsigned char opcode, unsigned char exopc, unsigned char xtype,
313       unsigned char iaa0, unsigned char iaa1,
314       unsigned long idef2, unsigned char ima)
315{
316    return (1 << GRU_CB_ICMD_SHFT) |
317	   ((unsigned long)CBS_ACTIVE << GRU_ISTATUS_SHFT) |
318	   (idef2<< GRU_IDEF2_SHFT) |
319	   (iaa0 << GRU_CB_IAA0_SHFT) |
320	   (iaa1 << GRU_CB_IAA1_SHFT) |
321	   (ima << GRU_CB_IMA_SHFT) |
322	   (xtype << GRU_CB_XTYPE_SHFT) |
323	   (opcode << GRU_CB_OPC_SHFT) |
324	   (exopc << GRU_CB_EXOPC_SHFT);
325}
326
327/*
328 * Architecture specific intrinsics
329 */
330static inline void gru_flush_cache(void *p)
331{
332	__flush_cache(p);
333}
334
335/*
336 * Store the lower 64 bits of the command including the "start" bit. Then
337 * start the instruction executing.
338 */
339static inline void gru_start_instruction(struct gru_instruction *ins, unsigned long op64)
340{
341	gru_ordered_store_ulong(ins, op64);
342	mb();
343	gru_flush_cache(ins);
344}
345
346
347/* Convert "hints" to IMA */
348#define CB_IMA(h)		((h) | IMA_UNMAPPED)
349
350/* Convert data segment cache line index into TRI0 / TRI1 value */
351#define GRU_DINDEX(i)		((i) * GRU_CACHE_LINE_BYTES)
352
353/* Inline functions for GRU instructions.
354 *     Note:
355 *     	- nelem and stride are in elements
356 *     	- tri0/tri1 is in bytes for the beginning of the data segment.
357 */
358static inline void gru_vload_phys(void *cb, unsigned long gpa,
359		unsigned int tri0, int iaa, unsigned long hints)
360{
361	struct gru_instruction *ins = (struct gru_instruction *)cb;
362
363	ins->baddr0 = (long)gpa | ((unsigned long)iaa << 62);
364	ins->nelem = 1;
365	ins->op1_stride = 1;
366	gru_start_instruction(ins, __opdword(OP_VLOAD, 0, XTYPE_DW, iaa, 0,
367					(unsigned long)tri0, CB_IMA(hints)));
368}
369
370static inline void gru_vload(void *cb, unsigned long mem_addr,
371		unsigned int tri0, unsigned char xtype, unsigned long nelem,
372		unsigned long stride, unsigned long hints)
373{
374	struct gru_instruction *ins = (struct gru_instruction *)cb;
375
376	ins->baddr0 = (long)mem_addr;
377	ins->nelem = nelem;
378	ins->op1_stride = stride;
379	gru_start_instruction(ins, __opdword(OP_VLOAD, 0, xtype, IAA_RAM, 0,
380					(unsigned long)tri0, CB_IMA(hints)));
381}
382
383static inline void gru_vstore(void *cb, unsigned long mem_addr,
384		unsigned int tri0, unsigned char xtype, unsigned long nelem,
385		unsigned long stride, unsigned long hints)
386{
387	struct gru_instruction *ins = (void *)cb;
388
389	ins->baddr0 = (long)mem_addr;
390	ins->nelem = nelem;
391	ins->op1_stride = stride;
392	gru_start_instruction(ins, __opdword(OP_VSTORE, 0, xtype, IAA_RAM, 0,
393					tri0, CB_IMA(hints)));
394}
395
396static inline void gru_ivload(void *cb, unsigned long mem_addr,
397		unsigned int tri0, unsigned int tri1, unsigned char xtype,
398		unsigned long nelem, unsigned long hints)
399{
400	struct gru_instruction *ins = (void *)cb;
401
402	ins->baddr0 = (long)mem_addr;
403	ins->nelem = nelem;
404	ins->tri1_bufsize = tri1;
405	gru_start_instruction(ins, __opdword(OP_IVLOAD, 0, xtype, IAA_RAM, 0,
406					tri0, CB_IMA(hints)));
407}
408
409static inline void gru_ivstore(void *cb, unsigned long mem_addr,
410		unsigned int tri0, unsigned int tri1,
411		unsigned char xtype, unsigned long nelem, unsigned long hints)
412{
413	struct gru_instruction *ins = (void *)cb;
414
415	ins->baddr0 = (long)mem_addr;
416	ins->nelem = nelem;
417	ins->tri1_bufsize = tri1;
418	gru_start_instruction(ins, __opdword(OP_IVSTORE, 0, xtype, IAA_RAM, 0,
419					tri0, CB_IMA(hints)));
420}
421
422static inline void gru_vset(void *cb, unsigned long mem_addr,
423		unsigned long value, unsigned char xtype, unsigned long nelem,
424		unsigned long stride, unsigned long hints)
425{
426	struct gru_instruction *ins = (void *)cb;
427
428	ins->baddr0 = (long)mem_addr;
429	ins->op2_value_baddr1 = value;
430	ins->nelem = nelem;
431	ins->op1_stride = stride;
432	gru_start_instruction(ins, __opdword(OP_VSET, 0, xtype, IAA_RAM, 0,
433					 0, CB_IMA(hints)));
434}
435
436static inline void gru_ivset(void *cb, unsigned long mem_addr,
437		unsigned int tri1, unsigned long value, unsigned char xtype,
438		unsigned long nelem, unsigned long hints)
439{
440	struct gru_instruction *ins = (void *)cb;
441
442	ins->baddr0 = (long)mem_addr;
443	ins->op2_value_baddr1 = value;
444	ins->nelem = nelem;
445	ins->tri1_bufsize = tri1;
446	gru_start_instruction(ins, __opdword(OP_IVSET, 0, xtype, IAA_RAM, 0,
447					0, CB_IMA(hints)));
448}
449
450static inline void gru_vflush(void *cb, unsigned long mem_addr,
451		unsigned long nelem, unsigned char xtype, unsigned long stride,
452		unsigned long hints)
453{
454	struct gru_instruction *ins = (void *)cb;
455
456	ins->baddr0 = (long)mem_addr;
457	ins->op1_stride = stride;
458	ins->nelem = nelem;
459	gru_start_instruction(ins, __opdword(OP_VFLUSH, 0, xtype, IAA_RAM, 0,
460					0, CB_IMA(hints)));
461}
462
463static inline void gru_nop(void *cb, int hints)
464{
465	struct gru_instruction *ins = (void *)cb;
466
467	gru_start_instruction(ins, __opdword(OP_NOP, 0, 0, 0, 0, 0, CB_IMA(hints)));
468}
469
470
471static inline void gru_bcopy(void *cb, const unsigned long src,
472		unsigned long dest,
473		unsigned int tri0, unsigned int xtype, unsigned long nelem,
474		unsigned int bufsize, unsigned long hints)
475{
476	struct gru_instruction *ins = (void *)cb;
477
478	ins->baddr0 = (long)src;
479	ins->op2_value_baddr1 = (long)dest;
480	ins->nelem = nelem;
481	ins->tri1_bufsize = bufsize;
482	gru_start_instruction(ins, __opdword(OP_BCOPY, 0, xtype, IAA_RAM,
483					IAA_RAM, tri0, CB_IMA(hints)));
484}
485
486static inline void gru_bstore(void *cb, const unsigned long src,
487		unsigned long dest, unsigned int tri0, unsigned int xtype,
488		unsigned long nelem, unsigned long hints)
489{
490	struct gru_instruction *ins = (void *)cb;
491
492	ins->baddr0 = (long)src;
493	ins->op2_value_baddr1 = (long)dest;
494	ins->nelem = nelem;
495	gru_start_instruction(ins, __opdword(OP_BSTORE, 0, xtype, 0, IAA_RAM,
496					tri0, CB_IMA(hints)));
497}
498
499static inline void gru_gamir(void *cb, int exopc, unsigned long src,
500		unsigned int xtype, unsigned long hints)
501{
502	struct gru_instruction *ins = (void *)cb;
503
504	ins->baddr0 = (long)src;
505	gru_start_instruction(ins, __opdword(OP_GAMIR, exopc, xtype, IAA_RAM, 0,
506					0, CB_IMA(hints)));
507}
508
509static inline void gru_gamirr(void *cb, int exopc, unsigned long src,
510		unsigned int xtype, unsigned long hints)
511{
512	struct gru_instruction *ins = (void *)cb;
513
514	ins->baddr0 = (long)src;
515	gru_start_instruction(ins, __opdword(OP_GAMIRR, exopc, xtype, IAA_RAM, 0,
516					0, CB_IMA(hints)));
517}
518
519static inline void gru_gamer(void *cb, int exopc, unsigned long src,
520		unsigned int xtype,
521		unsigned long operand1, unsigned long operand2,
522		unsigned long hints)
523{
524	struct gru_instruction *ins = (void *)cb;
525
526	ins->baddr0 = (long)src;
527	ins->op1_stride = operand1;
528	ins->op2_value_baddr1 = operand2;
529	gru_start_instruction(ins, __opdword(OP_GAMER, exopc, xtype, IAA_RAM, 0,
530					0, CB_IMA(hints)));
531}
532
533static inline void gru_gamerr(void *cb, int exopc, unsigned long src,
534		unsigned int xtype, unsigned long operand1,
535		unsigned long operand2, unsigned long hints)
536{
537	struct gru_instruction *ins = (void *)cb;
538
539	ins->baddr0 = (long)src;
540	ins->op1_stride = operand1;
541	ins->op2_value_baddr1 = operand2;
542	gru_start_instruction(ins, __opdword(OP_GAMERR, exopc, xtype, IAA_RAM, 0,
543					0, CB_IMA(hints)));
544}
545
546static inline void gru_gamxr(void *cb, unsigned long src,
547		unsigned int tri0, unsigned long hints)
548{
549	struct gru_instruction *ins = (void *)cb;
550
551	ins->baddr0 = (long)src;
552	ins->nelem = 4;
553	gru_start_instruction(ins, __opdword(OP_GAMXR, EOP_XR_CSWAP, XTYPE_DW,
554				 IAA_RAM, 0, 0, CB_IMA(hints)));
555}
556
557static inline void gru_mesq(void *cb, unsigned long queue,
558		unsigned long tri0, unsigned long nelem,
559		unsigned long hints)
560{
561	struct gru_instruction *ins = (void *)cb;
562
563	ins->baddr0 = (long)queue;
564	ins->nelem = nelem;
565	gru_start_instruction(ins, __opdword(OP_MESQ, 0, XTYPE_CL, IAA_RAM, 0,
566					tri0, CB_IMA(hints)));
567}
568
569static inline unsigned long gru_get_amo_value(void *cb)
570{
571	struct gru_instruction *ins = (void *)cb;
572
573	return ins->avalue;
574}
575
576static inline int gru_get_amo_value_head(void *cb)
577{
578	struct gru_instruction *ins = (void *)cb;
579
580	return ins->avalue & 0xffffffff;
581}
582
583static inline int gru_get_amo_value_limit(void *cb)
584{
585	struct gru_instruction *ins = (void *)cb;
586
587	return ins->avalue >> 32;
588}
589
590static inline union gru_mesqhead  gru_mesq_head(int head, int limit)
591{
592	union gru_mesqhead mqh;
593
594	mqh.head = head;
595	mqh.limit = limit;
596	return mqh;
597}
598
599/*
600 * Get struct control_block_extended_exc_detail for CB.
601 */
602extern int gru_get_cb_exception_detail(void *cb,
603		       struct control_block_extended_exc_detail *excdet);
604
605#define GRU_EXC_STR_SIZE		256
606
607
608/*
609 * Control block definition for checking status
610 */
611struct gru_control_block_status {
612	unsigned int	icmd		:1;
613	unsigned int	ima		:3;
614	unsigned int	reserved0	:4;
615	unsigned int	unused1		:24;
616	unsigned int	unused2		:24;
617	unsigned int	istatus		:2;
618	unsigned int	isubstatus	:4;
619	unsigned int	unused3		:2;
620};
621
622/* Get CB status */
623static inline int gru_get_cb_status(void *cb)
624{
625	struct gru_control_block_status *cbs = (void *)cb;
626
627	return cbs->istatus;
628}
629
630/* Get CB message queue substatus */
631static inline int gru_get_cb_message_queue_substatus(void *cb)
632{
633	struct gru_control_block_status *cbs = (void *)cb;
634
635	return cbs->isubstatus & CBSS_MSG_QUEUE_MASK;
636}
637
638/* Get CB substatus */
639static inline int gru_get_cb_substatus(void *cb)
640{
641	struct gru_control_block_status *cbs = (void *)cb;
642
643	return cbs->isubstatus;
644}
645
646/*
647 * User interface to check an instruction status. UPM and exceptions
648 * are handled automatically. However, this function does NOT wait
649 * for an active instruction to complete.
650 *
651 */
652static inline int gru_check_status(void *cb)
653{
654	struct gru_control_block_status *cbs = (void *)cb;
655	int ret;
656
657	ret = cbs->istatus;
658	if (ret != CBS_ACTIVE)
659		ret = gru_check_status_proc(cb);
660	return ret;
661}
662
663/*
664 * User interface (via inline function) to wait for an instruction
665 * to complete. Completion status (IDLE or EXCEPTION is returned
666 * to the user. Exception due to hardware errors are automatically
667 * retried before returning an exception.
668 *
669 */
670static inline int gru_wait(void *cb)
671{
672	return gru_wait_proc(cb);
673}
674
675/*
676 * Wait for CB to complete. Aborts program if error. (Note: error does NOT
677 * mean TLB mis - only fatal errors such as memory parity error or user
678 * bugs will cause termination.
679 */
680static inline void gru_wait_abort(void *cb)
681{
682	gru_wait_abort_proc(cb);
683}
684
685/*
686 * Get a pointer to the start of a gseg
687 * 	p	- Any valid pointer within the gseg
688 */
689static inline void *gru_get_gseg_pointer (void *p)
690{
691	return (void *)((unsigned long)p & ~(GRU_GSEG_PAGESIZE - 1));
692}
693
694/*
695 * Get a pointer to a control block
696 * 	gseg	- GSeg address returned from gru_get_thread_gru_segment()
697 * 	index	- index of desired CB
698 */
699static inline void *gru_get_cb_pointer(void *gseg,
700						      int index)
701{
702	return gseg + GRU_CB_BASE + index * GRU_HANDLE_STRIDE;
703}
704
705/*
706 * Get a pointer to a cacheline in the data segment portion of a GSeg
707 * 	gseg	- GSeg address returned from gru_get_thread_gru_segment()
708 * 	index	- index of desired cache line
709 */
710static inline void *gru_get_data_pointer(void *gseg, int index)
711{
712	return gseg + GRU_DS_BASE + index * GRU_CACHE_LINE_BYTES;
713}
714
715/*
716 * Convert a vaddr into the tri index within the GSEG
717 * 	vaddr		- virtual address of within gseg
718 */
719static inline int gru_get_tri(void *vaddr)
720{
721	return ((unsigned long)vaddr & (GRU_GSEG_PAGESIZE - 1)) - GRU_DS_BASE;
722}
723#endif		/* __GRU_INSTRUCTIONS_H__ */
724