source: trunk/doc/documentacion.tex @ 22

\documentclass[a4paper,10pt]{article}

\usepackage{amsmath}
\usepackage[utf8]{inputenc}
\usepackage[T1]{fontenc}
\usepackage[spanish]{babel}
\usepackage[]{textcomp}
\usepackage[pdftex]{graphicx}
\usepackage[pdftex]{color}
\usepackage[all]{xy}
\usepackage[left=3cm,right=3cm]{geometry}
\usepackage{fancyhdr}
\usepackage{makeidx}
\usepackage[unicode=true, pdfusetitle, bookmarks=true,bookmarksnumbered=false, bookmarksopen=false, breaklinks=false, pdfborder={0 0 1}, backref=false, colorlinks=false]{hyperref}
\pagestyle{fancy}

\chead{}
\rhead{\textrm{Técnicas Digitales IV}}
\lfoot{U.T.N.}
\cfoot{}
\rfoot{Pag. \thepage}
\renewcommand{\headrulewidth}{0.3pt}
\renewcommand{\footrulewidth}{0.3pt}

\title{\Huge Skipper, \textbf{IDE} para programación en \textbf{HDL}}
\author{Redolfi, Javier Andrés; Henze, Agustín; Insaurralde, Pablo}
%\address{ Universidad Tecnologica Nacional, Fac. Reg. Cba.}
\makeindex

\begin{document}
{
\printindex
\maketitle
\newpage

\tableofcontents
\newpage
\section{Introducción}

Skipper va a intentar ser, esperamos de aca a unos años, o no, un Entorno de Desarrollo Integrado para \textbf{HDL}.
Esto es, un entorno que permita escribir código en \textbf{HDL}, chequear sintaxis, escribir testbenchs, hacer simulación y ver los resultados.\\
La idea es no reinventar la rueda, o sea no escribir todas las herramientas, sino usar las que ya están hechas y escribir las que no están.\\
El proyecto surge como resultado de la falta de un \textbf{IDE} para la programación en dicho lenguaje con licencia \textbf{GPL}; si tenemos varias herramientas aisladas; las juntamos a todas y las hacemos encajar.\\
La meta principal en un principio es brindar una herramienta para aprender \textbf{HDL} y más adelante tener un buen \textbf{IDE} para el desarrollo.\\
Algunas de las herramientas que usa Skipper son gedit, ghdl, gtkWave, etc.\\
En esta versión 0.1, queremos agradecer a los docente Cayuela Pablo y a Olmedo Sergio por apoyar este trabajo y tener las intenciones de implementarlo en su cátedra Técnicas Digitales IV en la U.T.N. F.R.C.\\

\underline{Características:}

\begin{itemize}
  \item Soporte para vhdl y verilog.
  \item Multiplataforma, aunque en esto no nos esmeraremos mucho.
  \item etc.
\end{itemize}

\underline{Nota:} por ahora soporta vhdl y debería andar en otras plataformas debido a que los programas que se usan son multiplataforma.
        
\section{Hoja de Ruta de Skipper}
\begin{description}
        \item[Fase 1] Tener andando el editor, con todas sus características. En esta fase podríamos ya, escribir entidades y testbenchs.
        \item[Fase 2] Checkear sintaxis, ver logs de errores, simular.
        \item[Fase 3] Integrar en el \textbf{IDE} el visor de forma de onda.
        \item[Fase 4] Construir e Integrar al \textbf{IDE} el editor de UCF.
        \item[Fase 5] Construir e Integrar al \textbf{IDE} el editor de testbenchs.
        \item[Fase 6] Construir e Integrar al \textbf{IDE} el sintetizador.
        \item[Fase 7] Soportar verilog.
\end{description}

\underline{Nota:} esta versión cumplimenta la fase 1, la fase 2 y la fase 3.

\section{Herramientas de Skipper}

El \textbf{IDE} será basado en un editor de texto avanzado llamado gedit y tendrá la siguientes herramientas:

\subsection{El editor: gedit}

\underline{Características:}

\begin{itemize}
  \item Comentar código
  \item Completar paréntesis
  \item Indentación automágica
  \item Corrector Ortográfico
  \item Navegación de Documento
  \item Ampliación de funcionalidades mediante plugins
\end{itemize}

\subsection{Compilador/Simulador: ghdl}

\underline{Características:}

\begin{itemize}
  \item Es un simulador completo de VHDL, usando la tecnología GCC.
  \item Implementa el estandar de la IEEE 1076-1987 o IEEE 1076-1993.
  \item No sintetiza, esto es, no traduce tu diseño a netlist.
\end{itemize}

\subsection{TestBench}
Será a través de una tabla con las entradas declaradas en nuestra entidad, en la cuál especificaremos el tiempo, los valores de esas entradas y los valores de salida correctos. También se proporcionará un ayudante que permita realizar el testbenchs en forma gráfica.

\subsection{Visor de Ondas: gtkWave}

\underline{Características:}

\begin{itemize}
  \item Es un visor de formas de onda usado para examinar las salidas de varios simuladores digitales.
  \item Puede leer VCD(Estandar industrial de simulación), EVCD, LXT y LXT2 ( específicos del gtkWave ).
\end{itemize}

\subsection{Editor de UCF}
Este programa permitirá unir mediante una tabla, los puertos con los pines físicos del chip.

\subsection{Síntesis}
Este programa permitirá convertir el vhdl en formato EDIF, el cual luego puede ser leído por la herramienta privativa que estemos utilizando para nuestro chip, la cuál podrá generar el bitstream a partir de este archivo.

\section{Instalación}
Para funcionar, el \textbf{IDE} necesita tener instalados el gedit, el ghdl, el gtkWave y el interprete python.

Luego descargamos los plugins para gedit.
Esto lo podemos hacer a través de svn desde el siguiente repositorio:
  \href{http://www.sluc.org.ar/svn/skipper/}{http://www.sluc.org.ar/svn/skipper/}

Con el programa svn podemos usar el siguiente comando para descargar la versión en desarrollo:
  \begin{center}\textbf{svn co http://www.sluc.org.ar/svn/skipper/trunk skipper}\end{center}

Para probar la versión 0.1 bajamos \href{http://www.sluc.org.ar/svn/skipper/skipper-0.1/skipper-0.1.tar.bz2}{este tar.bz2}, o el .zip desde \href{http://www.sluc.org.ar/svn/skipper/skipper-0.1/skipper-0.1.zip}{aquí}.\\

Esto nos descargará una serie de plugins que debemos copiar en la carpeta .gnome2/gedit/plugins/ de nuestro home.
Luego abrimos el gedit y vamos al Menu Editar->Preferencias.
En preferencias vamos a la solapa Complementos, activamos Skipper y el Manejador de Proyecto.

Con esto ya tenemos andando el \textbf{IDE}.

\section{Uso}

Skipper se compone de 2 partes principales, la primera la tenemos en el menú Herramientas y la segunda el propio menú Proyecto.

\begin{itemize}
  \item En el menú herramientas tenemos 4 acciones:
    \begin{description}
        \item[Chequea Sintaxis:]esto llama al comando \textit{ghdl -s} y realiza un chequeo de sintaxis.
        \item[Analize Vhdl:]esto llama al comando \textit{ghdl -a} y construye un objeto.
        \item[Elaborate Vhdl:]esto llama al comando \textit{ghdl -e} y crea un ejecutable.
        \item[Simulate Vhdl:]esto llama al comando \textit{ghdl -r} y ejecuta el archivo, tambien llama al gtkWave con el resultado de la simulación; esto se usa con archivos del tipo testbench.
    \end{description}
\end{itemize}

\begin{itemize}
        \item El menú Proyecto nos permite crear un proyecto en el cual podemos agrupar varios archivos de tipo vhdl y testbench los cuales se llamarán por convención \textit{*.tbw}. Este menú además de realizar las acciones normales de un manejador de proyecto nos permite simular un proyecto completo.

Para simular un proyecto completo debemos escribir un testbench que simule nuestro proyecto o las entidades intermedias del mismo; luego cuando este activo en el editor este archivo debemos presionar Simular Proyecto del menú herramientas. Esto construirá un objeto para cada archivo vhdl que este en el proyecto, luego creará un ejecutable que responderá al testbench, lo ejecutará y abrirá el gtkWave mostrando los resultados de la simulación.
\end{itemize}

\section{Enlaces}
\begin{itemize}
  \item \href{http://www.sluc.org.ar/skipper}{Página Principal Skipper}
  \item \href{http://projects.gnome.org/gedit/}{gEdit}
  \item \href{http://ghdl.free.fr/}{GHDL}
  \item \href{http://gtkwave.sourceforge.net/}{gtkWave}
  \item \href{http://fpgalibre.sourceforge.net/}{fpgalibre}
  \item \href{http://live.gnome.org/Gedit/Windows}{gedit for Windows}
  \item \href{http://blogs.gnome.org/nacho/2009/06/02/porting-your-gtk-application-to-windows/}{Porting your Gtk+ application to windows}
  \item \href{http://www.geocities.com/SiliconValley/Campus/3216/GTKWave/gtkwave-win32.html}{The Win32 GTKWave Homepage}
  \item \href{http://ghdl.free.fr/download.html}{GHDL for Windows}
\end{itemize}

\section{Licencia de este Documento}

Skipper\\

Skipper, \textbf{IDE} para programación en \textbf{HDL}\\

Copyright © 2009 Redolfi Javier, Agustín Henze, Insaurralde Pablo.\\

Se concede permiso para copiar, distribuir y/o modificar este documento bajo los términos de la Licencia de Documentación Libre de la GNU, Version 1.1 o cualquier versión posterior publicada por la Free Software Foundation.\\

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation.
}
\end{document}