xref: /openbsd-src/gnu/usr.bin/binutils-2.17/include/opcode/s390.h (revision 3d8817e467ea46cf4772788d6804dd293abfb01a)
1 /* s390.h -- Header file for S390 opcode table
2    Copyright 2000, 2001, 2003 Free Software Foundation, Inc.
3    Contributed by Martin Schwidefsky (schwidefsky@de.ibm.com).
4 
5    This file is part of BFD, the Binary File Descriptor library.
6 
7    This program is free software; you can redistribute it and/or modify
8    it under the terms of the GNU General Public License as published by
9    the Free Software Foundation; either version 2 of the License, or
10    (at your option) any later version.
11 
12    This program is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15    GNU General Public License for more details.
16 
17    You should have received a copy of the GNU General Public License
18    along with this program; if not, write to the Free Software
19    Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA
20    02110-1301, USA.  */
21 
22 #ifndef S390_H
23 #define S390_H
24 
25 /* List of instruction sets variations. */
26 
27 enum s390_opcode_mode_val
28   {
29     S390_OPCODE_ESA = 0,
30     S390_OPCODE_ZARCH
31   };
32 
33 enum s390_opcode_cpu_val
34   {
35     S390_OPCODE_G5 = 0,
36     S390_OPCODE_G6,
37     S390_OPCODE_Z900,
38     S390_OPCODE_Z990,
39     S390_OPCODE_Z9_109
40   };
41 
42 /* The opcode table is an array of struct s390_opcode.  */
43 
44 struct s390_opcode
45   {
46     /* The opcode name.  */
47     const char * name;
48 
49     /* The opcode itself.  Those bits which will be filled in with
50        operands are zeroes.  */
51     unsigned char opcode[6];
52 
53     /* The opcode mask.  This is used by the disassembler.  This is a
54        mask containing ones indicating those bits which must match the
55        opcode field, and zeroes indicating those bits which need not
56        match (and are presumably filled in by operands).  */
57     unsigned char mask[6];
58 
59     /* The opcode length in bytes. */
60     int oplen;
61 
62     /* An array of operand codes.  Each code is an index into the
63        operand table.  They appear in the order which the operands must
64        appear in assembly code, and are terminated by a zero.  */
65     unsigned char operands[6];
66 
67     /* Bitmask of execution modes this opcode is available for.  */
68     unsigned int modes;
69 
70     /* First cpu this opcode is available for.  */
71     enum s390_opcode_cpu_val min_cpu;
72   };
73 
74 /* The table itself is sorted by major opcode number, and is otherwise
75    in the order in which the disassembler should consider
76    instructions.  */
77 extern const struct s390_opcode s390_opcodes[];
78 extern const int                s390_num_opcodes;
79 
80 /* A opcode format table for the .insn pseudo mnemonic.  */
81 extern const struct s390_opcode s390_opformats[];
82 extern const int                s390_num_opformats;
83 
84 /* Values defined for the flags field of a struct powerpc_opcode.  */
85 
86 /* The operands table is an array of struct s390_operand.  */
87 
88 struct s390_operand
89   {
90     /* The number of bits in the operand.  */
91     int bits;
92 
93     /* How far the operand is left shifted in the instruction.  */
94     int shift;
95 
96     /* One bit syntax flags.  */
97     unsigned long flags;
98   };
99 
100 /* Elements in the table are retrieved by indexing with values from
101    the operands field of the powerpc_opcodes table.  */
102 
103 extern const struct s390_operand s390_operands[];
104 
105 /* Values defined for the flags field of a struct s390_operand.  */
106 
107 /* This operand names a register.  The disassembler uses this to print
108    register names with a leading 'r'.  */
109 #define S390_OPERAND_GPR 0x1
110 
111 /* This operand names a floating point register.  The disassembler
112    prints these with a leading 'f'. */
113 #define S390_OPERAND_FPR 0x2
114 
115 /* This operand names an access register.  The disassembler
116    prints these with a leading 'a'.  */
117 #define S390_OPERAND_AR 0x4
118 
119 /* This operand names a control register.  The disassembler
120    prints these with a leading 'c'.  */
121 #define S390_OPERAND_CR 0x8
122 
123 /* This operand is a displacement.  */
124 #define S390_OPERAND_DISP 0x10
125 
126 /* This operand names a base register.  */
127 #define S390_OPERAND_BASE 0x20
128 
129 /* This operand names an index register, it can be skipped.  */
130 #define S390_OPERAND_INDEX 0x40
131 
132 /* This operand is a relative branch displacement.  The disassembler
133    prints these symbolically if possible.  */
134 #define S390_OPERAND_PCREL 0x80
135 
136 /* This operand takes signed values.  */
137 #define S390_OPERAND_SIGNED 0x100
138 
139 /* This operand is a length.  */
140 #define S390_OPERAND_LENGTH 0x200
141 
142 /* This operand is optional. Only a single operand at the end of
143    the instruction may be optional.  */
144 #define S390_OPERAND_OPTIONAL 0x400
145 
146 	#endif /* S390_H */
147