Skip to content

Latest commit

 

History

History
171 lines (115 loc) · 7.36 KB

README.ASM.md

File metadata and controls

171 lines (115 loc) · 7.36 KB

SMART Assembly Language Tutorial

Welcome to the SMART Assembly Language tutorial! SMART stands for Simple Machine Architecture & Runtime. This assembly language is designed to be both simple and comprehensive, making it perfect for educational purposes. It provides a balanced approach to help students understand the foundational concepts of assembly programming without overwhelming them with intricate details.

In this guide, we'll introduce you to the basics of the SMART Assembly language, its opcodes, and how to write simple programs. Let's dive in!

Table of Contents

Introduction

SMART Assembly is a simple assembly language designed for educational purposes. It provides a set of basic opcodes to perform arithmetic, logical, and control flow operations.

Opcodes

Here's a list of available opcodes in the SMART Assembly language:

Register operations

  • LOADA <label>: Load the value from the memory location specified by <label> into register A.
  • LOADB <label>: Load the value from the memory location specified by <label> into register B.
  • STOREA <label>: Store the value from register A into the memory location specified by <label>.
  • STOREB <label>: Store the value from register B into the memory location specified by <label>.

Flow Commands

  • NOP: No operation, move the program counter.
  • JUMP <label>: Jump to the address specified by <label>.
  • JZA <label>: Jump to the address specified by <label> if register A is zero.
  • JZB <label>: Jump to the address specified by <label> if register B is zero.
  • END: End the program execution.

Logic Commands

  • ORA <label>: Perform a bitwise OR operation between register A and the value at <label>, storing the result in register A.
  • ORB <label>: Perform a bitwise OR operation between register B and the value at <label>, storing the result in register B.
  • ANDA <label>: Perform a bitwise AND operation between register A and the value at <label>, storing the result in register A.
  • ANDB <label>: Perform a bitwise AND operation between register B and the value at <label>, storing the result in register B.
  • XORA <label>: Perform a bitwise XOR operation between register A and the value at <label>, storing the result in register A.
  • XORB <label>: Perform a bitwise XOR operation between register B and the value at <label>, storing the result in register B.
  • NOTA: Perform a bitwise NOT operation on register A.
  • NOTB: Perform a bitwise NOT operation on register B.

Arithmetic Commands

  • ADDA <label>: Add the value from the memory location specified by <label> to register A.
  • ADDB <label>: Add the value from the memory location specified by <label> to register B.
  • SHLA <value>: Shift the bits in register A to the left by <value> positions.
  • SHLB <value>: Shift the bits in register B to the left by <value> positions.
  • SHRA <value>: Shift the bits in register A to the right by <value> positions.
  • SHRB <value>: Shift the bits in register B to the right by <value> positions.

Stack Commands

  • PUSHA: Push the value from register A onto the stack.
  • POPA: Pop the top value from the stack into register A.
  • CALL <label>: Call a subroutine.
  • RET: Return from a subroutine.
  • SETBP <label>: Set the Base Pointer for stack operations.
  • LOADA [BP + <value>]: Load a value from the stack into register A using the Base Pointer and offset.
  • STOREA [BP + <value>]: Store a value from register A onto the stack using the Base Pointer and offset.

Case insensitive

In SMART Assembly, case sensitivity is not enforced, meaning that the syntax recognizes labels and commands irrespective of letter casing. For instance, the label START: is equivalent to start:, and similarly, commands can be written in either lowercase or uppercase without affecting their functionality. Thus, loada and LOADA are interpreted as the same command.

Comments and Labels

Comments

In SMART Assembly, comments are denoted by a semicolon (;). Anything following a semicolon on a line is considered a comment and is ignored by the assembler.

Example:

; This is a comment and will be ignored by the assembler
LOADA NUM1  ; This loads the value at NUM1 into register A

Labels

Labels are used to mark specific locations in the code. They are followed by a colon (:) and can be used as operands for certain opcodes. Labels are especially useful for jumps and data storage.

Example:

START:     ; This is a label named START
LOADA NUM1 ; Use the label NUM1 as an operand

Stack opration

The stack is a crucial data structure in SMART Assembly, facilitating temporary storage, parameter passing, and return address handling during subroutine calls. It operates on a Last-In-First-Out (LIFO) principle, where the last value pushed onto the stack is the first to be popped off.

Before utilizing stack operations, it's imperative to set the stack's start address using the SETBP opcode. If SETBP is not used, the stack pointer is set to zero, which could lead to unwanted behavior.

SETBP STACK

; rest of your program code;
; ...

; start of stack memory
STACK:
; make sure to leave this memory empty for the stack to grow into it

The stack is particularly useful for:

  • Parameter Passing: Parameters can be pushed onto the stack before a subroutine call, and then accessed within the subroutine using the LOADABP and STOREABP opcodes.
  • Return Address Handling: When a subroutine is called using the CALL opcode, the return address is automatically pushed onto the stack, to be retrieved later by the RET opcode.
  • Local Variable Storage: Local variables can be stored on the stack, providing temporary data storage that is cleaned up when the subroutine exits.
  • Nested and Recursive Calls: The stack allows for nested and recursive subroutine calls, each with its own set of parameters, local variables, and return address.

See recursive-fact.asm code for function call example.

Writing a Simple Program

Let's write a simple program to add two numbers:

; This program adds two numbers and stores the result

START:  LOADA NUM1       ; Load the first number into register A
        ADDA NUM2        ; Add the value at NUM2 to register A
        STOREA RESULT    ; Store the result

        END              ; End the program

NUM1:   DATA 0x05        ; 5 in decimal
NUM2:   DATA 0x03        ; 3 in decimal
RESULT: DATA 0x00        ; Placeholder for the result

This example uses the stack to swap two numbers:

SETBP STACK ; Init the stack pointer (base pointer)

; Push the pop to swap NUM1 with NUM2
LOADA NUM1
PUSHA
LOADA NUM2
PUSHA

POPA
STOREA NUM1
POPA
STOREA NUM2

END ; End program

NUM1: DATA 0xF0
NUM2: DATA 0x0F

STACK: ; start of stack memory

In this program, we first load the first number into register A. We then add the second number to register A and store the result.

Foe more examples see examples.

Conclusion

This tutorial introduced you to the basics of the SMART Assembly language, including its opcodes, comments, and labels. With this knowledge, you can start writing your own programs and exploring more advanced features of the language.