lc3.h

Go to the documentation of this file.

#ifndef __LC3_H__
#define __LC3_H__

/*
 * "Copyright (c) 2014-2015 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>
#include <stdbool.h>

#include "symbol.h" 

#ifndef LC3_VAR
#define LC3_VAR extern
#endif

char* strdup(const char *);

#define LC3_WORD unsigned short

#define LC3_MEM_SIZE (1 << 16)

#define LC3_NUM_REGS 8  

#define RETURN_ADDR_REG   7

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_NEWLN,        
  OP_ZERO,         
  OP_COPY,         
  OP_SETCC,        
  OP_SUB,          
  NUM_OPCODES      
} opcode_t;

typedef enum operand {
    OPN_DR    = 0x0001, 
    OPN_SR1   = 0x0002, 
    OPN_SR2   = 0x0004, 
    OPN_CC    = 0x0008, 
    OPN_IMM5  = 0x0010, 
    OPN_OFF6  = 0x0020, 
    OPN_VEC8  = 0x0040, 
    OPN_ASC8  = 0x0080, 
    OPN_PCO9  = 0x0100, 
    OPN_PCO11 = 0x0200, 
    OPN_IMM16 = 0x0400, 
    OPN_STR   = 0x0800, 
    OPN_FILL  = 0x1000  
} operand_t;

typedef enum format {
  FMT_      = 0,
  FMT_RRR   = (OPN_DR | OPN_SR1 | OPN_SR2),
  FMT_RRI5  = (OPN_DR | OPN_SR1 | OPN_IMM5),
  FMT_CL    = (OPN_CC | OPN_PCO9),
  FMT_R1    = OPN_DR,
  FMT_R2    = OPN_SR1,
  FMT_I11   = OPN_PCO11,
  FMT_RL    = (OPN_DR | OPN_PCO9),
  FMT_RRI6  = (OPN_DR | OPN_SR1 | OPN_OFF6),
  FMT_RR    = (OPN_DR | OPN_SR1),
  FMT_V     = OPN_VEC8,
  FMT_A     = OPN_ASC8,
  FMT_16    = OPN_IMM16,
  FMT_S     = OPN_STR,
  FMT_FILL  = OPN_FILL
} format_t;

typedef struct inst_format {
 char*      name;      
 format_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);

inst_format_t* lc3_get_inst_format (const char* name);

char* lc3_get_suffix (char* file_name);

bool lc3_file_has_suffix (const char* file_name, const char* suffix);

char* lc3_replace_suffix (char* file_name, char* new_suffix);

const char* lc3_get_format_name (format_t format);

const char* lc3_get_opcode_name (opcode_t op);

const char* lc3_get_operand_name (operand_t operand);

void lc3_set_obj_file_mode (const char* name);

int lc3_read_LC3_word (FILE *f);

void lc3_read_sym_table (FILE* sym_file, sym_table_t* symTab);

void lc3_write_LC3_word (FILE* f, int value);

void lc3_write_sym_table (FILE* sym_file, sym_table_t* symTab);

bool lc3_get_address (sym_table_t* symTab, const char* token, int* value);

#endif /* __LC3_H__ */