annotate docs/lyx/ede.lyx @ 42:792da050d8c4 tip

more dox

#LyX 2.0 created this file. For more info see http://www.lyx.org/
\lyxformat 413
\begin_document
\begin_header
\textclass article
\use_default_options true
\maintain_unincluded_children false
\language english
\language_package default
\inputencoding auto
\fontencoding global
\font_roman default
\font_sans default
\font_typewriter default
\font_default_family default
\use_non_tex_fonts false
\font_sc false
\font_osf false
\font_sf_scale 100
\font_tt_scale 100

\graphics default
\default_output_format default
\output_sync 0
\bibtex_command default
\index_command default
\paperfontsize default
\use_hyperref false
\papersize default
\use_geometry false
\use_amsmath 1
\use_esint 1
\use_mhchem 1
\use_mathdots 1
\cite_engine basic
\use_bibtopic false
\use_indices false
\paperorientation portrait
\suppress_date false
\use_refstyle 1
\index Index
\shortcut idx
\color #008000
\end_index
\secnumdepth 3
\tocdepth 3
\paragraph_separation indent
\paragraph_indentation default
\quotes_language english
\papercolumns 1
\papersides 1
\paperpagestyle default
\tracking_changes false
\output_changes false
\html_math_output 0
\html_css_as_file 0
\html_be_strict false
\end_header

\begin_body

\begin_layout Part
The ELB816 Development Environment
\end_layout

\begin_layout Section
EDE Overview
\end_layout

\begin_layout Standard
EDE is a software implementation of the ELB816 micro-processor along with
 a basic tool chain to develop and debug code for it.
 The block diagram below depicts the system that this project aims to implement.
\end_layout

\begin_layout Standard
\begin_inset ERT
status open

\begin_layout Plain Layout


\backslash
bigskip
\end_layout

\end_inset


\end_layout

\begin_layout Standard
\begin_inset Graphics
	filename /home/jmz/qm/ede/docs/img/ede/system_overview.svg
	display false

\end_inset


\end_layout

\begin_layout Section
EDE Use Cases
\end_layout

\begin_layout Standard
EDE is highly modular.
 Each of it's components, with the exception of the UI, is written as a
 stand alone program and works independently.
 Because of this design strategy EDE can be used in a number of different
 ways.
 This section details the use cases experimented with so far.
\end_layout

\begin_layout Subsection
Assemble/Upload/Execute/Debug
\end_layout

\begin_layout Standard
Using the tool chain in this manner is analogous to programming and run-time
 debugging a real-world micro-controller.
 Source code is assembled and written into the emulator's memory.
 The user can then use the debug prompt to step through program and probe
 the emulator internals.
\end_layout

\begin_layout Standard
\begin_inset ERT
status open

\begin_layout Plain Layout


\backslash
bigskip
\end_layout

\end_inset


\end_layout

\begin_layout Standard
\begin_inset Graphics
	filename /home/jmz/qm/ede/docs/img/ede/aued.svg
	display false

\end_inset


\end_layout

\begin_layout Standard
\begin_inset Newpage pagebreak
\end_inset


\end_layout

\begin_layout Subsection
Interpreter Mode
\end_layout

\begin_layout Standard
Source code does not have to be pre-assembled.
 Since the command-line interface, the assembler and the debugger are all
 written in python, the assembler's functions can be imported into the interface
 code.
 This has been done to create a mode where the user enters assembly code
 at a prompt, and then that code is immediately assembled and executed on
 an instance of the emulator.
\end_layout

\begin_layout Standard
\begin_inset ERT
status open

\begin_layout Plain Layout


\backslash
bigskip
\end_layout

\end_inset


\end_layout

\begin_layout Standard
\begin_inset Graphics
	filename /home/jmz/qm/ede/docs/img/ede/interpreter.svg
	display false

\end_inset


\end_layout

\end_body
\end_document