lc3.h

Go to the documentation of this file.

#ifndef __LC3_H__
#define __LC3_H__

/*
 * "Copyright (c) 2014 by Fritz Sieker."
 * based on ideas/code by Steven S. Lumetta
 *
 * Permission to use, copy, modify, and distribute this software and its
 * documentation for any purpose, without fee, and without written
 * agreement is hereby granted, provided that the above copyright notice
 * and the following two paragraphs appear in all copies of this software.
 *
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE TO ANY PARTY FOR DIRECT,
 * INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT
 * OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF THE AUTHOR
 * HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * THE AUTHOR SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS ON AN "AS IS"
 * BASIS, AND THE AUTHOR NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT,
 * UPDATES, ENHANCEMENTS, OR MODIFICATIONS."
 */

#include <stdio.h>

#ifndef LC3_VAR
#define LC3_VAR extern
#endif

#include "symbol.h" 

char* strdup(const char *);

#define LC3_WORD unsigned short

#define LC3_MEM_SIZE 65536

#define LC3_NUM_REGS 8  

#define RETURN_ADDR_REG   7

LC3_VAR int inHex;

LC3_VAR sym_table_t* lc3_sym_tab;

typedef enum opcode {
  OP_INVALID = -1, 
  OP_BR,           
  OP_ADD,          
  OP_LD,           
  OP_ST,           
  OP_JSR_JSRR,     
  OP_AND,          
  OP_LDR,          
  OP_STR,          
  OP_RTI,          
  OP_NOT,          
  OP_LDI,          
  OP_STI,          
  OP_JMP_RET,      
  OP_RESERVED,     
  OP_LEA,          
  OP_TRAP,         
  OP_ORIG,         
  OP_END,          
  OP_BLKW,         
  OP_FILL,         
  OP_STRINGZ,      
  OP_GETC,         
  OP_OUT,          
  OP_PUTS,         
  OP_IN,           
  OP_PUTSP,        
  OP_HALT,         
  OP_GETS,         
  OP_ZERO,         
  OP_COPY,         
  OP_NEG,          
  NUM_OPCODES      
} opcode_t;

typedef enum operand {
    FMT_R1    = 0x001, 
    FMT_R2    = 0x002, 
    FMT_R3    = 0x004, 
    FMT_CC    = 0x008, 
    FMT_IMM5  = 0x010, 
    FMT_IMM6  = 0x020, 
    FMT_VEC8  = 0x040, 
    FMT_ASC8  = 0x080, 
    FMT_PCO9  = 0x100, 
    FMT_PCO11 = 0x200, 
    FMT_IMM16 = 0x400, 
    FMT_STR   = 0x800  
} operand_t;

typedef enum operands {
  FMT_      = 0,
  FMT_RRR   = (FMT_R1 | FMT_R2 | FMT_R3),
  FMT_RRI5  = (FMT_R1 | FMT_R2 | FMT_IMM5),
  FMT_L     = FMT_PCO9,
  FMT_R     = FMT_R2,
  FMT_I11   = FMT_PCO11,
  FMT_RL    = (FMT_R1 | FMT_PCO9),
  FMT_RRI6  = (FMT_R1 | FMT_R2 | FMT_IMM6),
  FMT_RR    = (FMT_R1 | FMT_R2),
  FMT_V     = FMT_VEC8,
  FMT_A     = FMT_ASC8,
  FMT_16    = FMT_IMM16,
  FMT_S     = FMT_STR
} operands_t;

typedef struct inst_format {
 char*      name;      
 operands_t operands;  
 int        prototype; 
} inst_format_t;

typedef struct LC3_inst {
  int           formBit;    
  inst_format_t forms[2];   
} LC3_inst_t;

char lc3_escaped_char (char c);

LC3_inst_t* lc3_get_inst_info (opcode_t opcode);

const char* lc3_get_format_name (operands_t format);

const char* lc3_get_opcode_name (opcode_t op);

const char* lc3_get_operand_name (operand_t operand);

int lc3_read_LC3_word (FILE *f);

void lc3_read_sym_table (FILE* sym_file);

void lc3_write_LC3_word (FILE* f, int value);

void lc3_write_sym_table (FILE* sym_file);

int lc3_get_int (char* token, int* value);

int lc3_get_address (char* token, int* value);

#endif /* __LC3_H__ */