[deliverable/binutils-gdb.git] / opcodes / arc-ext.h

/* ARC target-dependent stuff.  Extension data structures.
   Copyright (C) 1995-2019 Free Software Foundation, Inc.

   This file is part of libopcodes.

   This library is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 3, or (at your option)
   any later version.

   It is distributed in the hope that it will be useful, but WITHOUT
   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
   or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public
   License for more details.

   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
   MA 02110-1301, USA.  */

/*This header file defines a table of extensions to the ARC processor
  architecture.  These extensions are read from the '.arcextmap' or
  '.gnu.linkonce.arcextmap.<type>.<N>' sections in the ELF file which
  is identified by the bfd parameter to the build_ARC_extmap function.

  These extensions may include:
	 core registers
	 auxiliary registers
	 instructions
	 condition codes

  Once the table has been constructed, accessor functions may be used
  to retrieve information from it.

  The build_ARC_extmap constructor function build_ARC_extmap may be
  called as many times as required; it will re-initialize the table
  each time.  */

#ifndef ARC_EXTENSIONS_H
#define ARC_EXTENSIONS_H

#include "opcode/arc.h"

#ifdef __cplusplus
extern "C" {
#endif

#define IGNORE_FIRST_OPD 1

/* Define this if we do not want to encode instructions based on the
   ARCompact Programmer's Reference.  */
#define UNMANGLED

/* This defines the kinds of extensions which may be read from the
   ections in the executable files.  */
enum ExtOperType
{
  EXT_INSTRUCTION	     = 0,
  EXT_CORE_REGISTER	     = 1,
  EXT_AUX_REGISTER	     = 2,
  EXT_COND_CODE		     = 3,
  EXT_INSTRUCTION32	     = 4,
  EXT_AC_INSTRUCTION	     = 4,
  EXT_REMOVE_CORE_REG	     = 5,
  EXT_LONG_CORE_REGISTER     = 6,
  EXT_AUX_REGISTER_EXTENDED  = 7,
  EXT_INSTRUCTION32_EXTENDED = 8,
  EXT_CORE_REGISTER_CLASS    = 9
};

enum ExtReadWrite
{
  REG_INVALID,
  REG_READ,
  REG_WRITE,
  REG_READWRITE
};

/* Macro used when generating the patterns for an extension
   instruction.  */
#define INSERT_XOP(OP, NAME, CODE, MASK, CPU, ARG, FLG)	\
  do {							\
    (OP)->name   = NAME;				\
    (OP)->opcode = CODE;				\
    (OP)->mask   = MASK;				\
    (OP)->cpu    = CPU;					\
    (OP)->insn_class  = ARITH;				\
    (OP)->subclass = NONE;				\
    memcpy ((OP)->operands, (ARG), MAX_INSN_ARGS);	\
    memcpy ((OP)->flags, (FLG), MAX_INSN_FLGS);		\
    (OP++);						\
  } while (0)

/* Typedef to hold the extension instruction definition.  */
typedef struct ExtInstruction
{
  /* Name.  */
  char *name;

  /* Major opcode.  */
  char major;

  /* Minor(sub) opcode.  */
  char minor;

  /* Flags, holds the syntax class and modifiers.  */
  char flags;

  /* Syntax class.  Use by assembler.  */
  unsigned char syntax;

  /* Syntax class modifier.  Used by assembler.  */
  unsigned char modsyn;

  /* Suffix class.  Used by assembler.  */
  unsigned char suffix;

  /* Pointer to the next extension instruction.  */
  struct ExtInstruction* next;
} extInstruction_t;

/* Constructor function.  */
extern void build_ARC_extmap (bfd *);

/* Accessor functions.  */
extern enum ExtReadWrite arcExtMap_coreReadWrite (int);
extern const char * arcExtMap_coreRegName (int);
extern const char * arcExtMap_auxRegName (long);
extern const char * arcExtMap_condCodeName (int);
extern const extInstruction_t *arcExtMap_insn (int, unsigned long long);
extern struct arc_opcode *arcExtMap_genOpcode (const extInstruction_t *,
					       unsigned arc_target,
					       const char **errmsg);

/* Dump function (for debugging).  */
extern void dump_ARC_extmap (void);

#ifdef __cplusplus
}
#endif

#endif /* ARC_EXTENSIONS_H */
Commit	Line	Data
886a2506	1	/* ARC target-dependent stuff. Extension data structures.
82704155	2	Copyright (C) 1995-2019 Free Software Foundation, Inc.
0d2bcfaf	3
9b201bb5	4	This file is part of libopcodes.
0d2bcfaf	5
9b201bb5 NC	6	This library is free software; you can redistribute it and/or modify
	7	it under the terms of the GNU General Public License as published by
	8	the Free Software Foundation; either version 3, or (at your option)
	9	any later version.
0d2bcfaf	10
9b201bb5 NC	11	It is distributed in the hope that it will be useful, but WITHOUT
	12	ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
	13	or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
	14	License for more details.
0d2bcfaf	15
9b201bb5 NC	16	You should have received a copy of the GNU General Public License
	17	along with this program; if not, write to the Free Software
	18	Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
	19	MA 02110-1301, USA. */
0d2bcfaf	20
886a2506 NC	21	/*This header file defines a table of extensions to the ARC processor
	22	architecture. These extensions are read from the '.arcextmap' or
	23	'.gnu.linkonce.arcextmap.<type>.<N>' sections in the ELF file which
	24	is identified by the bfd parameter to the build_ARC_extmap function.
0d2bcfaf	25
886a2506 NC	26	These extensions may include:
	27	core registers
	28	auxiliary registers
	29	instructions
	30	condition codes
0d2bcfaf	31
886a2506 NC	32	Once the table has been constructed, accessor functions may be used
886a2506 NC	33	to retrieve information from it.
0d2bcfaf	34
886a2506 NC	35	The build_ARC_extmap constructor function build_ARC_extmap may be
	36	called as many times as required; it will re-initialize the table
	37	each time. */
	38
	39	#ifndef ARC_EXTENSIONS_H
	40	#define ARC_EXTENSIONS_H
	41
b99747ae CZ	42	#include "opcode/arc.h"
b99747ae CZ	43
6b477896 TS	44	#ifdef __cplusplus
	45	extern "C" {
	46	#endif
	47
886a2506 NC	48	#define IGNORE_FIRST_OPD 1
	49
	50	/* Define this if we do not want to encode instructions based on the
	51	ARCompact Programmer's Reference. */
	52	#define UNMANGLED
0d2bcfaf	53
886a2506 NC	54	/* This defines the kinds of extensions which may be read from the
	55	ections in the executable files. */
	56	enum ExtOperType
0d2bcfaf	57	{
886a2506 NC	58	EXT_INSTRUCTION = 0,
	59	EXT_CORE_REGISTER = 1,
	60	EXT_AUX_REGISTER = 2,
	61	EXT_COND_CODE = 3,
	62	EXT_INSTRUCTION32 = 4,
	63	EXT_AC_INSTRUCTION = 4,
	64	EXT_REMOVE_CORE_REG = 5,
	65	EXT_LONG_CORE_REGISTER = 6,
	66	EXT_AUX_REGISTER_EXTENDED = 7,
	67	EXT_INSTRUCTION32_EXTENDED = 8,
	68	EXT_CORE_REGISTER_CLASS = 9
0d2bcfaf NC	69	};
0d2bcfaf NC	70
886a2506	71	enum ExtReadWrite
0d2bcfaf	72	{
886a2506 NC	73	REG_INVALID,
	74	REG_READ,
	75	REG_WRITE,
	76	REG_READWRITE
0d2bcfaf NC	77	};
0d2bcfaf NC	78
b99747ae CZ	79	/* Macro used when generating the patterns for an extension
	80	instruction. */
	81	#define INSERT_XOP(OP, NAME, CODE, MASK, CPU, ARG, FLG) \
	82	do { \
	83	(OP)->name = NAME; \
	84	(OP)->opcode = CODE; \
	85	(OP)->mask = MASK; \
	86	(OP)->cpu = CPU; \
c810e0b8	87	(OP)->insn_class = ARITH; \
b99747ae CZ	88	(OP)->subclass = NONE; \
	89	memcpy ((OP)->operands, (ARG), MAX_INSN_ARGS); \
	90	memcpy ((OP)->flags, (FLG), MAX_INSN_FLGS); \
	91	(OP++); \
	92	} while (0)
	93
	94	/* Typedef to hold the extension instruction definition. */
	95	typedef struct ExtInstruction
	96	{
	97	/* Name. */
	98	char *name;
	99
	100	/* Major opcode. */
	101	char major;
	102
	103	/* Minor(sub) opcode. */
	104	char minor;
	105
	106	/* Flags, holds the syntax class and modifiers. */
	107	char flags;
	108
	109	/* Syntax class. Use by assembler. */
	110	unsigned char syntax;
	111
	112	/* Syntax class modifier. Used by assembler. */
	113	unsigned char modsyn;
	114
	115	/* Suffix class. Used by assembler. */
	116	unsigned char suffix;
	117
	118	/* Pointer to the next extension instruction. */
	119	struct ExtInstruction* next;
	120	} extInstruction_t;
0d2bcfaf	121
886a2506 NC	122	/* Constructor function. */
	123	extern void build_ARC_extmap (bfd *);
	124
	125	/* Accessor functions. */
	126	extern enum ExtReadWrite arcExtMap_coreReadWrite (int);
	127	extern const char * arcExtMap_coreRegName (int);
	128	extern const char * arcExtMap_auxRegName (long);
	129	extern const char * arcExtMap_condCodeName (int);
bdfe53e3	130	extern const extInstruction_t *arcExtMap_insn (int, unsigned long long);
b99747ae CZ	131	extern struct arc_opcode arcExtMap_genOpcode (const extInstruction_t ,
	132	unsigned arc_target,
	133	const char **errmsg);
886a2506 NC	134
	135	/* Dump function (for debugging). */
	136	extern void dump_ARC_extmap (void);
0d2bcfaf	137
6b477896 TS	138	#ifdef __cplusplus
	139	}
	140	#endif
	141
886a2506	142	#endif /* ARC_EXTENSIONS_H */