s390.h revision 1.1.1.7 
1/* s390.h -- Header file for S390 opcode table
2   Copyright (C) 2000-2019 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 3 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
27enum s390_opcode_mode_val
28  {
29    S390_OPCODE_ESA = 0,
30    S390_OPCODE_ZARCH
31  };
32
33enum 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    S390_OPCODE_Z9_EC,
41    S390_OPCODE_Z10,
42    S390_OPCODE_Z196,
43    S390_OPCODE_ZEC12,
44    S390_OPCODE_Z13,
45    S390_OPCODE_ARCH12,
46    S390_OPCODE_ARCH13,
47    S390_OPCODE_MAXCPU
48  };
49
50/* Instruction specific flags.  */
51#define S390_INSTR_FLAG_OPTPARM 0x1
52#define S390_INSTR_FLAG_OPTPARM2 0x2
53
54#define S390_INSTR_FLAG_HTM 0x4
55#define S390_INSTR_FLAG_VX 0x8
56#define S390_INSTR_FLAG_FACILITY_MASK 0xc
57
58/* The opcode table is an array of struct s390_opcode.  */
59
60struct s390_opcode
61  {
62    /* The opcode name.  */
63    const char * name;
64
65    /* The opcode itself.  Those bits which will be filled in with
66       operands are zeroes.  */
67    unsigned char opcode[6];
68
69    /* The opcode mask.  This is used by the disassembler.  This is a
70       mask containing ones indicating those bits which must match the
71       opcode field, and zeroes indicating those bits which need not
72       match (and are presumably filled in by operands).  */
73    unsigned char mask[6];
74
75    /* The opcode length in bytes. */
76    int oplen;
77
78    /* An array of operand codes.  Each code is an index into the
79       operand table.  They appear in the order which the operands must
80       appear in assembly code, and are terminated by a zero.  */
81    unsigned char operands[6];
82
83    /* Bitmask of execution modes this opcode is available for.  */
84    unsigned int modes;
85
86    /* First cpu this opcode is available for.  */
87    enum s390_opcode_cpu_val min_cpu;
88
89    /* Instruction specific flags.  */
90    unsigned int flags;
91  };
92
93/* The table itself is sorted by major opcode number, and is otherwise
94   in the order in which the disassembler should consider
95   instructions.  */
96extern const struct s390_opcode s390_opcodes[];
97extern const int                s390_num_opcodes;
98
99/* A opcode format table for the .insn pseudo mnemonic.  */
100extern const struct s390_opcode s390_opformats[];
101extern const int                s390_num_opformats;
102
103/* Values defined for the flags field of a struct s390_opcode.  */
104
105/* The operands table is an array of struct s390_operand.  */
106
107struct s390_operand
108  {
109    /* The number of bits in the operand.  */
110    int bits;
111
112    /* How far the operand is left shifted in the instruction.  */
113    int shift;
114
115    /* One bit syntax flags.  */
116    unsigned long flags;
117  };
118
119/* Elements in the table are retrieved by indexing with values from
120   the operands field of the s390_opcodes table.  */
121
122extern const struct s390_operand s390_operands[];
123
124/* Values defined for the flags field of a struct s390_operand.  */
125
126/* This operand names a register.  The disassembler uses this to print
127   register names with a leading 'r'.  */
128#define S390_OPERAND_GPR 0x1
129
130/* This operand names a floating point register.  The disassembler
131   prints these with a leading 'f'. */
132#define S390_OPERAND_FPR 0x2
133
134/* This operand names an access register.  The disassembler
135   prints these with a leading 'a'.  */
136#define S390_OPERAND_AR 0x4
137
138/* This operand names a control register.  The disassembler
139   prints these with a leading 'c'.  */
140#define S390_OPERAND_CR 0x8
141
142/* This operand is a displacement.  */
143#define S390_OPERAND_DISP 0x10
144
145/* This operand names a base register.  */
146#define S390_OPERAND_BASE 0x20
147
148/* This operand names an index register, it can be skipped.  */
149#define S390_OPERAND_INDEX 0x40
150
151/* This operand is a relative branch displacement.  The disassembler
152   prints these symbolically if possible.  */
153#define S390_OPERAND_PCREL 0x80
154
155/* This operand takes signed values.  */
156#define S390_OPERAND_SIGNED 0x100
157
158/* This operand is a length.  */
159#define S390_OPERAND_LENGTH 0x200
160
161/* The operand needs to be a valid GP or FP register pair.  */
162#define S390_OPERAND_REG_PAIR 0x400
163
164/* This operand names a vector register.  The disassembler uses this
165   to print register names with a leading 'v'.  */
166#define S390_OPERAND_VR 0x800
167
168#define S390_OPERAND_CP16 0x1000
169
170#define S390_OPERAND_OR1 0x2000
171#define S390_OPERAND_OR2 0x4000
172#define S390_OPERAND_OR8 0x8000
173
174#endif /* S390_H */
175