Subversion Repositories phr

\documentclass [a4paper,11pt]{article}

% Configuración del idioma

\usepackage [utf8] {inputenc}

\usepackage [spanish] {babel}

\addto\captionsspanish{\renewcommand{\contentsname}{Contenidos}}

% Para incluir gráficos

\usepackage{graphicx}

%

\ProvidesPackage{reporte-phr}

\usepackage{reporte-phr}

% Para el titulo

\def\logo{./img/title/phr_logo.pdf}

\def\producto{Interfaz gráfica de usuario\par \vspace{0.5ex} PHR GUI v0.1}

\title{Guía de Instalación y uso}

%\author{Maximiliano Quinteros}

\def\docver{0.9}

\date{Abril de 2013}

%comandos por maximiq

\newcommand{\problema}[1]{\vspace{1.5ex}\textbf{Problema: #1}}

\newcommand{\solucion}[1]{\vspace{1.5ex}\textbf{Solución:} #1 \vspace{1.5ex}}

\hyphenation{ma-ne-ra su-per-u-sua-rio}

\begin {document}

\maketitle

\tableofcontents

\clearpage

\section{Introducción}

Para transferir el diseño que realiza el usuario a la FPGA es necesario establecer una comunicación entre la computadora donde se sintetiza el proyecto y la FPGA de la placa PHR. En bajo nivel la computadora se comunica a través de un puerto USB con el chip FT2232D de la placa OOCDLink que luego se conecta mediante interfaz JTAG con la FPGA y la PROM. Subiendo en el nivel de abstracción es necesario un software que tome un archivo generado por la herramienta de síntesis y lo envíe a través de los drivers del sistema operativo al dispositivo concreto.

PHR GUI es una interfaz gráfica que permite al usuario transmitir los datos de una manera muy sencilla sin la necesidad de tener que sumirse en los pormenores de la transferencia del fichero. Si bien este es el software con el que interactúa el usuario, tiene que considerarse simplemente como un front-end para la aplicación que hace el verdadero trabajo. Esta es la denominada xc3sprog.

\begin{figure}[!h]

\centering

  \includegraphics{./img/intro/front-end.pdf}

  \caption{PHR GUI es una interfaz que facilita el uso de xc3sprog.}

%  \label{none}

\end{figure}

Xc3sprog\footnote{http://xc3sprog.sourceforge.net/} es en realidad un conjunto de aplicaciones de licencia libre que funciona en linea de comandos y sirve para programar mediante JTAG varios dispositivos. Su nombre hace referencia a que inicialmente fue diseñado para la familia de FPGA Spartan-3 de Xilinx. Sin embargo se ha extendido el manejo a otros tipos de dispositivos que incluyen otras FPGAs, CPLDs, XCF flash PROMs, microprocesadores AVRs de Atmel y memorias flash SPI. Xc3sprog soporta varios cables JTAG, incluyendo cables de puerto paralelo y programadores USB.

Es además capaz de funcionar con los drivers propietarios del chip FT2232D o con la libreria libre libUSB. Se encuentra disponible para los sistemas GNU/Linux y Windows.

\section{Instalación}\label{sec:instalacion}

\subsection{MS Windows}

Actualmente PHR GUI para Windows funciona con los drivers propietarios ofrecidos por el fabricante del chip FT2232D, Future Technology Devices International\footnote{http://www.ftdichip.com/}.

El procedimiento general para hacer correr la aplicación en los sistemas Windows consiste en primero descargar los drivers propietarios del FT2232D, luego instalarlos para poder conectar la placa OOCDLink y por último instalar PHR GUI v0.1 que distribuye los binarios de xc3sprog.

A continuación se desarrolla el procedimiento específico para Windows XP.

\subsubsection{Windows XP}

Necesitará el hardware PHR y los siguientes paquetes de software:

\begin{description}

\item[Drivers D2XX:] Son los drivers provistos por FTDI y están disponibles en distintas formas. Este manual  ejemplifica la instalación con la versión ejecutable. En particular se usa el archivo \texttt{CDM v2.10.00 WHQL Certified.exe}, pero se recomienda la versión mas nueva al momento de la descarga.

Para descargarlo consulte: \texttt{http://www.ftdichip.com/Drivers/}.

En la misma página puede ver el procedimiento mas detallado de instalación.

\item[Instalador de PHR GUI v0.1:] Se puede obtener de la sección de descargas en el sitio web del proyecto: \texttt{http://opencores.org/project,phr,descargas}.

\end{description}

\subsubsection*{Procedimiento:}

\begin{enumerate}

\item  Ejecutar el asistente de instalación de los drivers D2XX. Esto prepara al sistema para que en el próximo paso se reconozcan los controladores de una forma mas sencilla.

\begin{center}

  \includegraphics[width=0.9\textwidth]{./img/instalacion/ftdi-wiz.pdf}

%  \caption{caption.}

%  \label{none}

\end{center}

Si Windows le muestra una advertencia de que el software no supera la prueba de compatibilidad con Windows XP elija \emph{Continuar}.

\item Conectar la PHR al puerto USB de la computadora, la cual debe usar los drivers pre-instalados para configurar dos nuevos dispositivos. A continuación se muestra como cambia el Administrador de dispositivos de Windows.

\begin{center}

  \includegraphics[width=0.9\textwidth]{./img/instalacion/ad-disp.pdf}

%  \caption{caption.}

%  \label{none}

\end{center}

\item Ejecutar el instalador de PHR GUI v0.1. Una vez terminado el asistente puede optar por abrir el programa que debe estar listo para ser utilizado.

\begin{center}

  \includegraphics[width=0.9\textwidth]{./img/instalacion/phr-gui-wiz.pdf}

%  \caption{caption.}

%  \label{none}

\end{center}

\end{enumerate}

\subsection{GNU/Linux} \label{inst-linux}

La instalación en los sistemas GNU/Linux no es necesaria ya que PHR GUI v0.1 en un software desarrollado en el lenguaje Python (versión 2.7.6) y las distribuciones GNU/Linux incluyen un interprete Python. Sin embargo hay que seguir una serie de pasos que están relacionados en su mayoría con el software xc3sprog. Se describe el procedimiento general:

\begin{enumerate}

\item Obtener los binarios de xc3sprog. Para esto hay dos opciones:

        \begin{enumerate}

        \item Descargar desde la web los binarios ya compilados para la arquitectura específica (\texttt{http://sourceforge.net/projects/xc3sprog/}).

        \item Descargar desde la web o a través de svn el código fuente del proyecto y compilarlo manualmente (Método mas recomendado que el anterior).

        \end{enumerate}

\emph{Nota:} Xc3sprog hace uso de los paquetes \emph{usblib} y \emph{libftdi}.

\item Desde el sitio web de PHR descargar PHR GUI v0.1 para GNU/Linux.

\item Descomprimir el archivo anterior y moverse en los directorios hacia la carpeta descomprimida. El script que corre la aplicación es el \texttt{phr-gui.py}.

\begin{lstlisting}

user@host:~/$ tar -xzf phr-gui-linux.tar.gz

user@host:~/$ cd phr-gui-linux

user@host:~/phr-gui-linux$ ls

crear-enlace.sh  ejemplos  grafica  phr-gui.py

\end{lstlisting}

\item PHR GUI buscará el software xc3sprog en una carpeta del mismo nombre. Se puede mover el directorio o crear un enlace:

\begin{lstlisting}

user@host:~/phr-gui-linux$ ln -s /carpeta/de/los/binarios xc3sprog

\end{lstlisting}

\item Para una ejecución correcta de xc3sprog, éste debe tener permisos especiales de superusuario.

\begin{lstlisting}

user@host:~/phr-gui-linux$ cd xc3sprog

user@host:~/phr-gui-linux/xc3sprog$ su

Password:

root@host:/home/user/phr-gui-linux/xc3sprog# chown root:root xc3sprog

root@host:/home/user/phr-gui-linux/xc3sprog# chmod 4755 xc3sprog

root@host:/home/user/phr-gui-linux/xc3sprog# exit

user@host:~/phr-gui-linux/xc3sprog$ cd ..

user@host:~/phr-gui-linux$

\end{lstlisting}

Mediante \texttt{chown} se cambia el propietario del archivo al usuario root. Luego, con \texttt{chmod} se modifican los permisos:

\begin{description}

\item[4:] Hace que al ejecutarse el archivo se le asigne el UID del propietario (root).

\item[7:] Confiere permisos de lectura, escritura y ejecución al propietario (root).

\item[5:] Confiere permisos de lectura y ejecución al grupo.

\item[5:] Confiere permisos de lectura y ejecución al resto de los usuarios.

\end{description}

\item Al asignar permisos de ejecución, \texttt{phr-gui.py} debe estar listo para ejecutarse:

\begin{lstlisting}

user@host:~/phr-gui-linux$ chmod +x phr-gui.py

user@host:~/phr-gui-linux$ ./phr-gui.py

\end{lstlisting}

\item Para tener una experiencia totalmente gráfica se recomienda crear un lanzador. El script \texttt{crear-lanzador.sh} se encarga de esto.

\begin{lstlisting}

user@host:~/phr-gui-linux$ chmod +x crear-enlace.sh

user@host:~/phr-gui-linux$ ./crear-lanzador.sh

\end{lstlisting}

Se genera un nuevo archivo que puede moverse a un lugar conveniente del entorno gráfico.

\end{enumerate}

\section{Uso de la interfaz}

Para poder transferir el diseño a la placa el usuario debe realizar la síntesis del proyecto y generar un archivo en formato BIT que es el formato por defecto de Xilinx.

Una ves obtenido el fichero, la PHR ofrece dos posibilidades al momento de descargar el diseño sobre la FPGA. Un método consiste en transferir los datos directamente a la FPGA (\emph{configuración de la FPGA}) y el otro método consiste en transferirlos a la PROM (\emph{programación de la PROM}). El primero es mucho mas rápido pero debido a la volatilidad de la FPGA tiene la desventaja de que se pierde el diseño una vez que el circuito es desenergizado. Contrariamente, el segundo es un procedimiento mas lento pero su ventaja radica en que los datos se conservan en los sucesivos ciclos de encendido y apagado.

La forma en que se setea la FPGA para que ésta tome los datos de una u otra fuente es mediante un selector en donde un jumper se cambia de posición. El hecho se ilustra en la Fig. \ref{cargaFPGA}. Luego el usuario debe interactuar con la interfaz PHR GUI (ver Fig. \ref{phrgui}) para que la computadora efectivamente envíe los datos correspondientes.

\begin{figure}[!h]

\centering

  \includegraphics{./img/uso/fpgaSelector.pdf}

  \caption{Selección de la fuente de carga.}

  \label{cargaFPGA}

\end{figure}

\begin{figure}[!h]

\centering

  \includegraphics[width=11cm]{./img/uso/msw9x.png}

  \caption{Interfaz de usuario PHR GUI.}

  \label{phrgui}

\end{figure}

\subsection{Configuración de la FPGA}

Procedimiento para transferir el diseño a la FPGA:

\begin{enumerate}

\item Coloque el jumper de la PHR para que la FPGA cargue desde JTAG (ver Fig. \ref{cargaFPGA}).

\item Elija el archivo BIT que desea transferir desde el diálogo que surge al presionar el botón \emph{Elegir fichero}.

\item Presione el botón \emph{Configurar FPGA}.

\item El software xc3sprog es invocado y PHR GUI muestra su salida.

\item El diseño debe comenzar a funcionar una vez terminado el proceso de descarga.

\end{enumerate}

\subsection{Programación de la PROM}

Procedimiento para transferir el diseño a la PROM:

\begin{enumerate}

\item Coloque el jumper de la PHR para que la FPGA cargue desde PROM (ver Fig. \ref{cargaFPGA}).

\item Elija el archivo BIT que desea transferir desde el diálogo que surge al presionar el botón \emph{Elegir fichero}.

\item Presione el botón \emph{Programar PROM}.

\item El software xc3sprog es invocado y PHR GUI muestra su salida.

\item Una vez terminado el proceso de programación, presione el botón de RESET en la placa PHR (ver Fig.  \ref{cargaFPGA}) para que la FPGA cargue el diseño.

\end{enumerate}

\subsection{Interpretación de las salidas de texto}

\subsubsection*{Comprobar conexión}

Para verificar que el hardware esté bien conectado se puede recurrir al botón \emph{Comprobar conexión}. Al presionarlo se espera una salida como la siguiente:

\begin{lstlisting}

PHR>>> xc3sprog\xc3sprog -c ftdi -L -j -v

XC3SPROG (c) 2004-2011 xc3sprog project $Rev: 691 $ OS: Windows

Free software: If you contribute nothing, expect nothing!

Feedback on success/failure/enhancement requests:

        http://sourceforge.net/mail/?group_id=170565

Check Sourceforge for updates:

        http://sourceforge.net/projects/xc3sprog/develop

Using built-in device list

Using built-in cable list

Cable ftdi type ftdi VID 0x0403 PID 0x6010 dbus data 00 enable 0b cbus data 00 data 00

Using FTD2XX, Using JTAG frequency 1200000

JTAG chainpos: 0 Device IDCODE = 0x02218093     Desc: XC3S200A

JTAG loc.:   0  IDCODE: 0x02218093  Desc:      XC3S200A Rev: A  IR length:  6

JTAG loc.:   1  IDCODE: 0xd5045093  Desc:        XCF02S Rev: M  IR length:  8

USB transactions: Write 6 read 4 retries 0

PHR>>>

\end{lstlisting}

Lo importante son las dos últimas líneas en donde se reconocen 2 elementos en la cadena JTAG. En la posición 0 con ID 0x02218093 se encuentra la FPGA (XC3S200A). En la posición 1 con ID 0xd5045093 se encuentra la PROM (XCF02S).

\subsubsection*{Configurar FPGA}

Al configurar la FPGA se espera esta salida:

\begin{lstlisting}

PHR>>> xc3sprog\xc3sprog -v -L -c ftdi -p 0 fpgaFile:w:0:BIT

XC3SPROG (c) 2004-2011 xc3sprog project $Rev: 691 $ OS: Windows

Free software: If you contribute nothing, expect nothing!

Feedback on success/failure/enhancement requests:

        http://sourceforge.net/mail/?group_id=170565

Check Sourceforge for updates:

        http://sourceforge.net/projects/xc3sprog/develop

Using built-in device list

Using built-in cable list

Cable ftdi type ftdi VID 0x0403 PID 0x6010 dbus data 00 enable 0b cbus data 00 data 00

Using FTD2XX, Using JTAG frequency 1200000

JTAG chainpos: 0 Device IDCODE = 0x02218093     Desc: XC3S200A

Created from NCD file: test1_top.ncd;UserID=0xFFFFFFFF

Target device: 3s200avq100

Created: 2014/03/19 18:31:15

Bitstream length: 1196128 bits

DNA is 0x95cde80efb9ba0fe

done. Programming time 1044.1 ms

USB transactions: Write 84 read 9 retries 0

PHR>>>

\end{lstlisting}

La penúltima linea es la que indica que la grabación ha finalizado y muestra el tiempo que demoró el proceso.

\subsubsection*{Programar PROM}

La salida que se lista está resumida puesto que suele ser muy larga:

\begin{lstlisting}

PHR>>> xc3sprog\xc3sprog.exe -v -L -c ftdi -p 1 fpgaFile:w:0:BIT

XC3SPROG (c) 2004-2011 xc3sprog project $Rev: 691 $ OS: Windows

Free software: If you contribute nothing, expect nothing!

Feedback on success/failure/enhancement requests:

        http://sourceforge.net/mail/?group_id=170565

Check Sourceforge for updates:

        http://sourceforge.net/projects/xc3sprog/develop

Using built-in device list

Using built-in cable list

Cable ftdi type ftdi VID 0x0403 PID 0x6010 dbus data 00 enable 0b cbus data 00 data 00

Using FTD2XX, Using JTAG frequency 1200000

JTAG chainpos: 1 Device IDCODE = 0xd5045093     Desc: XCF02S

Erasing......done

Erase time 3129.2 ms

Programming does not end at block boundary (nbits = 1196128), padding

Programming block      0/   293 at XCF frame 0x0000.

...

Programming block    292/   293 at XCF frame 0x2480.done

Programming time 2802.2 ms

Verify block      0/   293 at XCF frame 0x0000

...

Verify block    278/   293 at XCF frame 0x22c0

VerSuccess! Verify time 1893.1 ms

USB transactions: Write 1815 read 906 retries 0

PHR>>>

\end{lstlisting}

Básicamente se efectúan tres operaciones. Primero se borra la memoria PROM, luego se programa la misma y después se verifican los datos. Para el caso que se muestra (depende de la versión de xc3sprog que se use) la línea que dice \texttt{VerSuccess!} indica que la programación fue exitosa.

\section{Soluciones a problemas frecuentes}

%\subsection{Instalación}

%\subsection{Uso de la interfaz}

\problema{[Windows] Cualquiera de los tres botones, Configurar FPGA, Programar PROM o Comprobar conexión, invocan comandos pero no producen salida alguna}

\solucion{Si la placa OOCDLink no se conectó nunca en la computadora, posiblemente sea necesario instalar la librería para que xc3sprog funcione correctamente. Consulte la sección \ref{sec:instalacion} para instalar la placa.}

\problema{[GNU/Linux] Al presionar alguno de los tres botones Configurar FPGA, Programar PROM o Comprobar conexión, se produce una salida similar a: }

\begin{lstlisting}

PHR>>> ./xc3sprog/xc3sprog -c ftdi

/bin/sh: ./xc3sprog/xc3sprog: not found

PHR>>>

\end{lstlisting}

\solucion{PHR GUI v0.1 busca los binarios de xc3sprog en el subdirectorio del mismo nombre y no lo encuentra. Debe descargar el software xc3sprog y ubicarlo en dicho directorio (consulte \emph{Instalación en GNU/Linux}, página \pageref{inst-linux}).}

\problema{[GNU/Linux] Al presionar alguno de los tres botones Configurar FPGA, Programar PROM o Comprobar conexión, se produce una salida similar a:}

\begin{lstlisting}

HR>>> ./xc3sprog/xc3sprog -c ftdi

XC3SPROG (c) 2004-2011 xc3sprog project $Rev: 747 $ OS: Linux

Free software: If you contribute nothing, expect nothing!

Feedback on success/failure/enhancement requests:

        http://sourceforge.net/mail/?group_id=170565

Check Sourceforge for updates:

        http://sourceforge.net/projects/xc3sprog/develop

Could not open FTDI device (using libftdi): inappropriate permissions on device!

Unable to access FTDI device with either libftdi or FTD2XX

PHR>>>

\end{lstlisting}

\solucion{Posiblemente xc3sprog no tenga permisos para acceder al puerto USB. Debe conceder los permisos (consulte \emph{Instalación en GNU/Linux}, página \pageref{inst-linux}).}

\end {document}