\ExplSyntaxOn
% Opcode, Opcode Name, Description, Flags Affected, Options
% Maybe have an optional argument to relabel the operands Source and Destination
\NewDocumentCommand{\createoptable}{ m m m m m }{
	\clist_clear_new:N \l_options
	
	\clist_set:Nn \l_options {#3}
	
	\seq_clear:N \l_tmpa_seq
	
	\tl_set:Nn \l_tmpa_seq { \begin{tabularx}{\textwidth}{ | c | X | c | c | } \hline }
	
	\tl_put_right:Nn \l_tmpa_seq { Opcode & Instruction & Operand One & Operand Two \\ \hline }
	
	\clist_map_inline:Nn \l_options {
		
		\str_case:nnF{##1} {
			 {0}{
				\tl_put_right:Nn \l_tmpa_seq { #1~##1 & #2~/r,~/r & r & r \\ \hline }
			}{1}{
				\tl_put_right:Nn \l_tmpa_seq { #1~##1 & #2~/r,~[/r] & r & [r] \\ \hline }
			}{2}{
				\tl_put_right:Nn \l_tmpa_seq { #1~##1 & #2 [/r],~/r2 & [r] & r \\ \hline }
			}{5}{
				\tl_put_right:Nn \l_tmpa_seq { #1~##1 & #2~/r,~[imm] & r & [imm] \\ \hline }
			}{8}{
				\tl_put_right:Nn \l_tmpa_seq { #1~##1 & #2~imm,~/r & imm & r \\ \hline }
			}{9}{
				\tl_put_right:Nn \l_tmpa_seq { #1~##1 & #2 ~imm, [r] & imm & [r] \\ \hline }
			}{A}{
				\tl_put_right:Nn \l_tmpa_seq { #1~##1 & #2~[imm], /r & imm & r \\ \hline }
			}{D}{
				\tl_put_right:Nn \l_tmpa_seq { #1~##1 & #2 ~imm,~[imm] & imm & [imm] \\ \hline }
			}
		}{ \tl_put_right:Nn \l_tmpa_seq {#1~##1 & INVALID & -- & -- \\ \hline} }
		
	}
	
	\tl_put_right:Nn \l_tmpa_seq { \end{tabularx} }
	\tl_put_right:Nn \l_tmpa_seq { \paragraph{Description} #5 }
	\tl_put_right:Nn \l_tmpa_seq { \paragraph{Flags Affected} #4 }
	
	\tl_use:N \l_tmpa_seq
}

\ExplSyntaxOff

\chapter{Instruction Set Architecture}
In general instructions are variable length depending on the number of arguments and their width. The first byte of an instruction is the \textit{opcode} which tells the machine what operation is to be performed. If one or more arguments are required, then the next byte is the \textit{options} byte which describes the type and width of the argument(s). The exact meaning of all the bits in the \textit{options} byte are shown in Figure \ref{fig:opencoding}. The order of the arguments follows the AT\&T syntax, meaning the left hand argument is the \textit{source} and the right hand argument is the \textit{destination}.

\section{Instruction Layout}
%Because this machine is little endian, the opcode byte is physically located on the right hand-side of a word.
% Placement info here: https://en.wikibooks.org/wiki/LaTeX/Floats,_Figures_and_Captions#Figures
% Paths: https://tikz.dev/tikz-paths
\begin{figure}[ht]
	\begin{tikzpicture}
		%\draw[help lines] (-8,-5) grid (8,5);
		\draw (-8, 4) node[above] {7} rectangle (-6, 3) node[above = 1] {0};
		\node at (-7, 2.5) {Opcode};
		\draw (-5, 4) node[above] {7} rectangle (-3, 3) node[above = 1] {0};
		\draw[dashed] (-4.5, 3) -- (-4.5, 4) node[above] {6};
		\draw[dashed] (-4, 3) -- (-4, 4) node[above] {4};
		\draw[dashed] (-3.5, 3) -- (-3.5, 4) node[above] {2};
		\node at (-4, 2.5) {Mode};
		\node (A) at (-4, 2.0) {(If required)};
		
		%Operand One
		\draw (-2, 4) node[above] {31} rectangle (2, 3) node[above = 1] {0};
		\draw[dashed] (1, 3) -- (1, 4) node[above] {7};
		\draw[dashed] (0, 3) -- (0, 4) node[above] {15};
		\node at (0, 2.5) {Source (Variable)};
		\node at (0, 2.0) {(If required)};
		%Operand Two
		\draw (3, 4) node[above] {31} rectangle (7, 3) node[above = 1] {0};
		\draw[dashed] (6, 3) -- (6, 4) node[above] {7};
		\draw[dashed] (5, 3) -- (5, 4) node[above] {15};
		\node at (5, 2.5) {Destination (Variable)};
		\node at (5, 2.0) {(If required)};
		%Mode / argument break down.
		%Fanout
		\draw (A.west) -- (-8, 0);
		\draw (A.east) -- (3, 0);
		%Operand One Type
		\draw (-8, 0) node[above] {7} rectangle (-6, -1) node[above = 1] {6};
		\node at (-7, -1.5) {Source Type};
		%Operand Two Type
		\draw (-5, 0) node[above] {5} rectangle (-3, -1) node[above = 1] {4};
		\node at (-4, -1.5) {Destination Type};
		%Reserved
		\draw (-2, 0) node[above] {3} rectangle (0, -1) node[above = 1] {2};
		\node at (-1, -1.5) {Reserved};
		%Width Descriptor
		\draw (1, 0) node[above] {1} rectangle (3, -1) node[above = 1] {0};
		\node at (2, -1.5) {Source Width};
	\end{tikzpicture}
	\caption{Encoding}
	\label{fig:opencoding} % https://www.overleaf.com/learn/latex/Referencing_Figures
\end{figure}
%Argument options
%	Register first
\newcommand{\rRArgH}{0}\newcommand{\rRaArgH}{1}\newcommand{\rAArgH}{3}
%	Register contains address first
\newcommand{\raRArgH}{4}\newcommand{\raRaArgH}{5}\newcommand{\raAArgH}{7}
%	Immediate first
\newcommand{\immRArgH}{8}\newcommand{\immRaArgH}{9}\newcommand{\immAArgH}{B}
%	Address first
\newcommand{\aRArgH}{C}\newcommand{\aRaArgH}{D}\newcommand{\aAArgH}{F}
%Width hex codes
\newcommand{\byteWidthH}{1}\newcommand{\shortWidthH}{2}\newcommand{\intWidthH}{3}

\begin{figure}
	\begin{tabularx}{\textwidth}{ | c | c | X | }
		\hline
		Type & Pattern & Description \\
		\hline
		Register & 00 & Operand is a register \\
		{[Register]} & 01 & Operand is a 32-bit address stored in a register \\
		Immediate & 10 & Operand is an 8-, 16- or 32-bit value \\
		{[Immediate]} & 11 & Operand is treated as a 32-bit address \\
		\hline
		\multicolumn{3}{ | X | }{Source Operand Width Patterns} \\
		\hline
		Invalid & 00 & Source must have a width \\
		8-bit & 01 & 8-bit wide source \\
		16-bit & 10 & 16-bit wide source \\
		32-bit & 11 & 32-bit wide source \\
		\hline
	\end{tabularx}
	\caption{Operand Type and Width Bit Patterns}
	\label{fig:ModeSettingEncodingFigure} % https://www.overleaf.com/learn/latex/Referencing_Figures
\end{figure}
\clearpage
\section{Instructions}
The /r represents a byte that specifies a register. /immX is for the immediate data type, where \textit{X} defines the width, which are 8, 16, or 32 bits. An address is defined as /addrX with the \textit{X} denoting the size of the data that will be written which can be 8, 16 or 32 bits, with the address itself always being 32-bits wide.
\subsection{Add}
	\createoptable{01}{add}{0, 8}{ OF and ZF. }
	{
		Adds two unsigned values together, the source (operand one) and the destination (operand two), storing the result in destination. The overflow flag (OF) is set if the result is less than the source and the zero flag (ZF) is set when the result of addition is zero.
	}
\subsection{Sub}
	\createoptable{02}{sub}{0, 8}{ UF and ZF. }
	{
		Subtracts two unsigned values, the source (operand one) and the destination (operand two), storing the result in destination. The underflow flag (UF) is set if the result is greater than the source and the zero flag (ZF) is set when the result of subtraction is zero.
	}
\subsection{Mul}
	\createoptable{03}{mul}{0, 8}{ OF and ZF. }
	{
		Multiplies two unsigned values together, the source (operand one) and the destination (operand two), storing the result in destination. The overflow flag (OF) is set if the result is less than the source and the zero flag (ZF) is set when the result of addition is zero.
	}
\subsection{Div}
	\createoptable{04}{div}{0, 8}{ UF and ZF. }
	{
		Divides two unsigned values, the source (operand one) and the destination (operand two), storing the result in destination. The underflow flag (UF) is set if the result is greater than the source and the zero flag (ZF) is set when the result of subtraction is zero.
	}
\subsection{Mov}\label{sec:mov}
	\createoptable{05}{mov}{0, 1, 2, 5, 8, 9, A, D}{ None. }
	{
		Copies the source (operand one) value to the destination (operand two).
	}
\subsection{AND}
	\createoptable{06}{and}{0, 8}{ ZF. }
	{
		Bitwise AND's the source (operand one) with the destination (operand two) storing the result in the destination. If the result of the operation is zero then the Zero Flag (ZF) is set.
	}
\subsection{OR}
	\createoptable{07}{or}{0, 8}{ ZF. }
	{
		Bitwise OR's the source (operand one) with the destination (operand two) storing the result in the destination. If the result of the operation is zero then the Zero Flag (ZF) is set.
	}
\subsection{XOR}
	\createoptable{08}{xor}{0, 8}{ ZF. }
	{
		Bitwise exclusive OR's (XOR) the source (operand one) with the destination (operand two) storing the result in the destination. If the result of the operation is zero then the Zero Flag (ZF) is set.
	}
\subsection{NOT}
	\begin{tabularx}{\textwidth}{ | c | X | c | c | }
		\hline
		Opcode & Instruction & Operand One & Operand Two \\
		\hline
		09 & xor /r & /r & None \\
		\hline
	\end{tabularx}
	\paragraph{Description} Bit-wise NOT's the source (operand one) in place.
	\paragraph{Flags Affected} None.
\subsection{SHL}
	\createoptable{0A}{shl}{8}{ OF and ZF. }
	{
		Shifts the destination (operand two) left \textit{operand one} times in place. If the source is smaller than before the operation the overflow flag (OF) is set. If the result of the operation is zero than the zero flag (ZF) is set.
	}
\subsection{SHR}
	\createoptable{0B}{shr}{8}{ UF and ZF. }
	{
		Shifts the destination (operand two) right \textit{operand one} times in place. If the source is larger than before the operation the underflow flag (UF) is set. If the result of the operation is zero than the zero flag (ZF) is set.
	}
\subsection{NOP}
	\begin{tabularx}{\textwidth}{ | c | X | c | c | }
		\hline
		Opcode & Instruction & Operand One & Operand Two \\
		\hline
		0C & nop & None & None \\
		\hline
	\end{tabularx}
	\paragraph{Description} Performs no operation except for incrementing the program counter by one.
	\paragraph{Flags Affected} None.
\subsection{CMP}
	\createoptable{0D}{cmp}{0, 8}{ OF, UF and ZF. }
	{
		Compares \textit{operand one} to \textit{operand two} by subtracting \textit{operand one} from \textit{operand two}, updating the status register with the results. If \textit{operand one} is larger than the result, and the result is not zero, the overflow flag (OF) is set. If \textit{operand one} is smaller than the result, and the result is not zero, the underflow flag (UF) is set. And if the result of the subtraction is zero the zero flag (ZF) is set.
	}
\subsection{JMP}\label{sec:jmp}
	\begin{tabularx}{\textwidth}{ | c | X | c | c | }
		\hline
		Opcode & Instruction & Operand One & Operand Two \\
		\hline
		0E & jmp /imm32 & /imm32 & None \\
		\hline
	\end{tabularx}
	\paragraph{Description} Jumps unconditionally to the absolute memory address specified in \textit{operand one}.
	\paragraph{Flags Affected} None.
\subsection{JZ}
	\begin{tabularx}{\textwidth}{ | c | X | c | c | }
		\hline
		Opcode & Instruction & Operand One & Operand Two \\
		\hline
		0F & jz /imm32 & /imm32 & None \\
		\hline
	\end{tabularx}
	\paragraph{Description} Jumps to the absolute memory address specified in \textit{operand one} if the zero flag (ZF) is zet.
	\paragraph{Flags Affected} None.
\subsection{JG}
	\begin{tabularx}{\textwidth}{ | c | X | c | c | }
		\hline
		Opcode & Instruction & Operand One & Operand Two \\
		\hline
		10 & jg /imm32 & /imm32 & None \\
		\hline
	\end{tabularx}
	\paragraph{Description} Jumps to the absolute memory address specified in \textit{operand one} if the overflow flag (OF) is zet.
	\paragraph{Flags Affected} None.
\subsection{JL}
	\begin{tabularx}{\textwidth}{ | c | X | c | c | }
		\hline
		Opcode & Instruction & Operand One & Operand Two \\
		\hline
		11 & jl /imm32 & /imm32 & None \\
		\hline
	\end{tabularx}
	\paragraph{Description} Jumps to the absolute memory address specified in \textit{operand one} if the underflow flag (UF) is zet.
	\paragraph{Flags Affected} None.
%Maybe these in/out instructions could have a mode setting for choosing the width of the data written to the port.
\subsection{Outb}
	\begin{tabularx}{\textwidth}{ | c | X | c | c | }
		\hline
		Opcode & Instruction & Operand One & Operand Two \\
		\hline
		12 & outb /imm8, /imm8 & /imm8 & /imm8 \\
		\hline
	\end{tabularx}
	\paragraph{Description} Writes a byte of data to the port number specified in the destination (operand two).
	\paragraph{Flags Affected} None.
\subsection{Inb}
	\begin{tabularx}{\textwidth}{ | c | X | c | c | }
		\hline
		Opcode & Instruction & Operand One & Operand Two \\
		\hline
		13 & inb /imm8, /r & /imm8 & /r \\
		\hline
	\end{tabularx}
	\paragraph{Description} Reads a byte of data from the port number in source (operand one) to the destination (operand two) register.
	\paragraph{Flags Affected} None.
\subsection{HLT}
	\begin{tabularx}{\textwidth}{ | c | X | c | c | }
		\hline
		Opcode & Instruction & Operand One & Operand Two \\
		\hline
		14 & hlt & None & None \\
		\hline
	\end{tabularx}
	\paragraph{Description} Halts the processor preventing it from executing the next instruction until an interrupt is received.
	\paragraph{Flags Affected} None.
\subsection{CLI}\label{sec:cli}
	\begin{tabularx}{\textwidth}{ | c | X | c | c | }
		\hline
		Opcode & Instruction & Operand One & Operand Two \\
		\hline
		15 & cli & None & None \\
		\hline
	\end{tabularx}
	\paragraph{Description} Clears interrupts, preventing the processor from responding to interrupts.
	\paragraph{Flags Affected} None.
\subsection{ENI}\label{sec:eni}
	\begin{tabularx}{\textwidth}{ | c | X | c | c | }
		\hline
		Opcode & Instruction & Operand One & Operand Two \\
		\hline
		16 & eni & None & None \\
		\hline
	\end{tabularx}
	\paragraph{Description} Enables interrupts, allowing the processor to respond to interrupts.
	\paragraph{Flags Affected} None.
\subsection{INT}\label{sec:int}
	\begin{tabularx}{\textwidth}{ | c | X | c | c | }
		\hline
		Opcode & Instruction & Operand One & Operand Two \\
		\hline
		17 & int /imm8 & /imm8 & None \\
		\hline
	\end{tabularx}
	\paragraph{Description} Triggers a software interrupt of type \textit{operand one} causing the flow of execution to jump to the registered subroutine in the Interrupt Vector Table at index \textit{operand one}.
	\paragraph{Flags Affected} None.
\subsection{LIVT}\label{sec:livt}
	\begin{tabularx}{\textwidth}{ | c | X | c | c | }
		\hline
		Opcode & Instruction & Operand One & Operand Two \\
		\hline
		18 & livt /imm32 & /imm32 & None \\
		\hline
	\end{tabularx}
	\paragraph{Description} Registers a 1024 byte block of memory starting at \textit{operand one} as the Interrupt Vector Table.
	\paragraph{Flags Affected} None.
\subsection{PUSHA}
	\begin{tabularx}{\textwidth}{ | c | X | c | c | }
		\hline
		Opcode & Instruction & Operand One & Operand Two \\
		\hline
		19 & pusha & None & None \\
		\hline
	\end{tabularx}
	\paragraph{Description} Pushes all general purpose registers to the stack in order starting from \textit{r1} to \textit{r8}.
	\paragraph{Flags Affected} None.
\subsection{POPA}
	\begin{tabularx}{\textwidth}{ | c | X | c | c | }
		\hline
		Opcode & Instruction & Operand One & Operand Two \\
		\hline
		20 & popa & None & None \\
		\hline
	\end{tabularx}
	\paragraph{Description} Pops all general purpose registers from the stack, restoring them, in the reverse order of \textit{r8} to \textit{r1}.
	\paragraph{Flags Affected} None.
\subsection{CALL}\label{sec:call}
	\begin{tabularx}{\textwidth}{ | c | X | c | c | }
		\hline
		Opcode & Instruction & Operand One & Operand Two \\
		\hline
		21 & call & None & None \\
		\hline
	\end{tabularx}
	\paragraph{Description} Calls a subroutine pushing the Program Counter (PC), plus one to return execution to the next opcode, to the stack.
	\paragraph{Flags Affected} None.
\subsection{RET}
	\begin{tabularx}{\textwidth}{ | c | X | c | c | }
		\hline
		Opcode & Instruction & Operand One & Operand Two \\
		\hline
		22 & ret & None & None \\
		\hline
	\end{tabularx}
	\paragraph{Description} Returns from the subroutine, popping the stack to restore the return address into the Program Counter (PC).
	\paragraph{Flags Affected} None.
\subsection{PUSH}
	\begin{tabularx}{\textwidth}{ | c | X | c | c | }
		\hline
		Opcode & Instruction & Operand One & Operand Two \\
		\hline
		23 & push /r & /r & None \\
		\hline
	\end{tabularx}
	\paragraph{Description} Pushes the contents of register \textit{Operand One} onto the top of the stack.
	\paragraph{Flags Affected} None.
\subsection{POP}
	\begin{tabularx}{\textwidth}{ | c | X | c | c | }
		\hline
		Opcode & Instruction & Operand One & Operand Two \\
		\hline
		24 & pop /r & /r & None \\
		\hline
	\end{tabularx}
	\paragraph{Description} Pops 32-bits from the top of the stack into the register \textit{Operand One}.
	\paragraph{Flags Affected} None.