| Line 40... |
Line 40... |
%% http://www.gnu.org/licenses/gpl.html
|
%% http://www.gnu.org/licenses/gpl.html
|
%%
|
%%
|
%%
|
%%
|
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
\documentclass{gqtekspec}
|
\documentclass{gqtekspec}
|
\project{Real-Time Clock}
|
\project{ICAPE2 Access via Wishbone}
|
\title{Specification}
|
\title{Specification}
|
\author{Dan Gisselquist, Ph.D.}
|
\author{Dan Gisselquist, Ph.D.}
|
\email{dgisselq (at) opencores.org}
|
\email{dgisselq (at) opencores.org}
|
\revision{Rev.~0.1}
|
\revision{Rev.~0.1}
|
\begin{document}
|
\begin{document}
|
| Line 66... |
Line 66... |
You should have received a copy of the GNU General Public License along
|
You should have received a copy of the GNU General Public License along
|
with this program. If not, see \hbox{<http://www.gnu.org/licenses/>} for a
|
with this program. If not, see \hbox{<http://www.gnu.org/licenses/>} for a
|
copy.
|
copy.
|
\end{license}
|
\end{license}
|
\begin{revisionhistory}
|
\begin{revisionhistory}
|
|
0.2 & 4/22/2016 & Gisselquist & Minor Updates \\\hline
|
0.1 & 5/25/2015 & Gisselquist & First Draft \\\hline
|
0.1 & 5/25/2015 & Gisselquist & First Draft \\\hline
|
\end{revisionhistory}
|
\end{revisionhistory}
|
% Revision History
|
% Revision History
|
% Table of Contents, named Contents
|
% Table of Contents, named Contents
|
\tableofcontents
|
\tableofcontents
|
% \listoffigures
|
% \listoffigures
|
\listoftables
|
\listoftables
|
\begin{preface}
|
\begin{preface}
|
My thanks to those helpers on the Xilinx Forum who helped me get the final
|
My thanks to those helpers on the Xilinx Forum who helped me through the final
|
step to getting this working.
|
step in getting this working.
|
\end{preface}
|
\end{preface}
|
|
|
\chapter{Introduction}
|
\chapter{Introduction}
|
\pagenumbering{arabic}
|
\pagenumbering{arabic}
|
\setcounter{page}{1}
|
\setcounter{page}{1}
|
|
|
This core makes the ICAPE2 FPGA configuration registers available to be read
|
This core makes the ICAPE2 FPGA configuration registers available to be read
|
or written from a wishbone bus. As the documentation of this capability could
|
or written from a wishbone bus. As Xilinx's documentation of this capability
|
use a bit to be desired, I have put this file together to help document
|
leaves a bit to be desired, I have put this file together to help document
|
what works.
|
what works.
|
|
|
The interface itself is very valuable for a couple of purposes---from my humble
|
The interface itself is very valuable for a couple of purposes---from my humble
|
and personal perspective. The first is the user configurable watchdog timer
|
and personal perspective. The first is the user configurable watchdog timer
|
which can be used to automatically reset an FPGA after it locks up. The second
|
which can be used to automatically reset an FPGA after it locks up. The second
|
is the warm boot start capability, which makes it possible to create a fall
|
is the warm boot start capability, which makes it possible to create a fall
|
back configuration image and test it without compromising the ability of the
|
back configuration image and test it without compromising the ability of the
|
FPGA to be started in a known good image. The third valuable capability is that
|
FPGA to be started in a known good image. The third valuable capability is that
|
of commanding a reconfiguration. All of these capabilities are available
|
of commanding a reconfiguration. All of these capabilities are available
|
through this interface. Further details are available from Xilinx's "7-Series
|
through this interface. Further details are available from Xilinx's ``7-Series
|
FPGAs Configuration" User Guide.
|
FPGAs Configuration'' User Guide\footnote{For the Spartan, further details are
|
|
available in the ``Spartan--6 FPGA Coniguration'' User Guide}.
|
|
|
This introduction is the first chapter. Beyond this introduction, most
|
This introduction is the first chapter. Beyond this introduction, most
|
of the capabilities are documented elsewhere. Hence, the register chapter
|
of the capabilities are documented elsewhere. Hence, the register chapter
|
will be omitted and the reader will be gently pointed to the User's Guide.
|
will be omitted and the reader will be gently pointed to the User's Guide.
|
This leaves the Wishbone chapter and the I/O Port's chapter which follow.
|
This leaves the Wishbone chapter and the I/O Port's chapter which follow.
|
| Line 110... |
Line 112... |
|
|
If I understand correctly, every one of Xilinx's 7--Series FPGA's contains
|
If I understand correctly, every one of Xilinx's 7--Series FPGA's contains
|
two ICAPE2 interface modules. These modules allow user logic to communicate
|
two ICAPE2 interface modules. These modules allow user logic to communicate
|
with the configuration interface of the chip. This interface, however, isn't
|
with the configuration interface of the chip. This interface, however, isn't
|
well documented. According to the User's Guide, it matches the SelectMAP
|
well documented. According to the User's Guide, it matches the SelectMAP
|
interface, yet in practice \ldots it doesn't.
|
interface, yet in practice \ldots it doesn't. It may come close, but the
|
|
timing and interface requirements of the SelectMAP aren't really the same as the
|
|
ICAPE2 port.
|
|
|
This core encapsulates the difficulty of matching that interface. Register
|
This core encapsulates the difficulty of matching that interface. Register
|
addresses match those in the User's Guide, as do register definitions.
|
addresses match those in the User's Guide, as do register definitions.
|
|
|
\chapter{Operation}\label{chap:ops}
|
\chapter{Operation}\label{chap:ops}
|
|
|
Consider the warm boot reload operation. To do this, write the address in
|
Realistically, this is better documented by Xilinx than anything you will find
|
configuration memory of an FPGA image to the warm boot start address (WBSTAR).
|
here. Still, two examples might be worthwhile.
|
In this case, that is address 5'h10 within this interface. A second write to
|
|
the configuration command address (CMD), 5'h4 in this interface, will issue the
|
First, consider the warm boot reload operation. To do this, write the address
|
IPROG command to the FPGA and cause it to configure itself from the address
|
in configuration memory of an FPGA image to the warm boot start address
|
you just gave it.
|
(WBSTAR). In this case, that is address 5'h10 within this interface. A second
|
|
write to the configuration command address (CMD), 5'h4 in this interface, will
|
|
issue the IPROG command to the FPGA and cause it to configure itself from the
|
|
address you just gave it. You can see this from C pseudo code in
|
|
Fig.~\ref{fig:warmboot}.
|
|
\begin{figure}\begin{center}\begin{tabbing}
|
|
{\tt warmboot(uint32 address) \{} \\
|
|
\hbox to 0.25in{}\={\tt uint32\_t *icape = (volatile uint32\_t *)0x{\em <ICAPE port address>};}\\
|
|
\>{\tt icape[16] = address};\\
|
|
\>{\tt icape[4] = 15};\\
|
|
\>{\em // FPGA is now reconfiguring itself from the new address}\\
|
|
\>{\em // If executed on an FPGA, this routine will never return.}\\
|
|
{\tt \}}
|
|
\end{tabbing}
|
|
\caption{Series--7 ICAPE2 Usage}\label{fig:warmboot}
|
|
\end{center}\end{figure}
|
|
|
There, wasn't that simple?
|
There, wasn't that simple?
|
|
|
|
We could do it for the Spartan--6 as well, as shown in Fig.~\ref{fig:sp6boot}.
|
|
\begin{figure}\begin{center}\begin{tabbing}
|
|
{\tt warmboot(uint32 address) \{} \\
|
|
\hbox to 0.25in{}\={\tt uint32\_t *icape6 = (volatile uint32\_t *)0x{\em <ICAPE port address>};}\\
|
|
\>{\tt icape6[13] = (address<<2)\&0x0ffff;}\\
|
|
\>{\tt icape6[14] = ((address>>14)\&0x0ff)|((0x03)<<8);}\\
|
|
\>{\tt icape6[4] = 14;}\\
|
|
\>{\em // The Spartan--6 is now reconfiguring itself from the new address.}\\
|
|
\>{\em // If executed from a softcore internal to a Spartan--6, this routine}\\
|
|
\>{\em // will never return.}\\
|
|
{\tt \}}
|
|
\end{tabbing}
|
|
\caption{Spartan--6 ICAPE Usage}\label{fig:sp6boot}
|
|
\end{center}\end{figure}
|
|
|
Now I can, from the comfort of my home, reconfigure an FPGA in my office without
|
Now I can, from the comfort of my home, reconfigure an FPGA in my office without
|
needing to press the power button or connect to a JTAG cable. Not bad, no?
|
needing to press the power button or connect to a JTAG cable. Not bad, no?
|
|
|
|
\iffalse
|
|
\chapter{Configuration Registers}\label{chap:registers}
|
|
% Tbl.~\ref{tbl:wishbone}
|
|
|
|
% 7 Series
|
|
\begin{table}[htbp]\begin{center}\hline
|
|
\begin{tabular}{|p{0.75in}|p{0.75in}|p{0.5in}|p{2.875in}|}\hline
|
|
\rowcolor[gray]{0.85} Name & Address & Access & Description \\\hline\hline
|
|
CRC & {\tt 0x00} & R/W & CRC Register \\\hline
|
|
FAR & {\tt 0x01} & R/W & Frame Address Register\\\hline
|
|
FDRI & {\tt 0x02} & W & Frame Data Register, Input Register (write configuration data)\\\hline
|
|
FDRO & {\tt 0x03} & R & Frame Data Register, Output Register (read configuration data)\\\hline
|
|
CMD & {\tt 0x04} & R/W & Command Register\\\hline
|
|
CTL0 & {\tt 0x05} & R/W & Control Register 0\\\hline
|
|
MASK & {\tt 0x06} & R/W & Masking Register for CTL0 and CTL1\\\hline
|
|
STAT & {\tt 0x07} & R & Status Register\\\hline
|
|
LOUT & {\tt 0x08} & W & Legacy Output Register for Daisy Chain\\\hline
|
|
COR0 & {\tt 0x09} & R/W & Configuration Option Register 0\\\hline
|
|
MFWR & {\tt 0x0a} & W & Multiple Frame Write Register \\\hline
|
|
CBC & {\tt 0x0b} & W & Initial CBC Value Register \\\hline
|
|
IDCODE & {\tt 0x0c} & R/W & Device ID Register\\\hline
|
|
AXSS & {\tt 0x0d} & R/W & User Access Register \\\hline
|
|
COR1 & {\tt 0x0e} & R/W & Configuration Options Register 1\\\hline
|
|
WBSTAR & {\tt 0x10} & R/W & Warm boot Start Addres Register \\\hline
|
|
TIMER & {\tt 0x11} & R/W & Watchdog Timer Register\\\hline
|
|
BOOTSTS & {\tt 0x16} & R & Boot History Status Register \\\hline
|
|
CTL1 & {\tt 0x18} & R/W & Control Register 1 \\\hline
|
|
BSPI & {\tt 0x1f} & R/W & BPI/SPI Configuration Options Register\\\hline
|
|
\end{tabular}
|
|
\caption{7--Series Configuration Register Addresses}\label{tbl:7addrs}
|
|
\end{center}\end{table}
|
|
|
|
% SPARTAN-6 series
|
|
\begin{table}[htbp]\begin{center}\hline
|
|
\begin{tabular}
|
|
\begin{tabular}{|p{0.75in}|p{0.75in}|p{0.5in}|p{2.875in}|}\hline
|
|
\rowcolor[gray]{0.85} Name & Address & Access & Description \\\hline\hline
|
|
CRC & {\tt 0x00} & W & Cyclic Redundancy Check\\\hline
|
|
FAR\_MAJ & {\tt 0x01} & W & Frame Address Register Block and Major\\\hline
|
|
FAR\_MIN & {\tt 0x02} & W & Frame Address Register Minor\\\hline
|
|
FDRI & {\tt 0x03} & W & Frame Data Input\\\hline
|
|
FDRO & {\tt 0x04} & R & Frame Data Output\\\hline
|
|
CMD & {\tt 0x05} & R/W & Command \\\hline
|
|
CTL & {\tt 0x06} & R/W & Control \\\hline
|
|
MASK & {\tt 0x07} & R/W & Control Mask\\\hline
|
|
STAT & {\tt 0x08} & R & Status \\\hline
|
|
LOUT & {\tt 0x09} & W & Legacy Output for Daisy Chain\\\hline
|
|
COR1 & {\tt 0x0a} & R/W & Configuration Option 1\\\hline
|
|
COR2 & {\tt 0x0b} & R/W & Configuration Option 2\\\hline
|
|
PWRDN\_REG & {\tt 0x0c} & R/W & Power Down Option Register\\\hline
|
|
FLR & {\tt 0x0d} & W & Frame Length Register\\\hline
|
|
IDCODE & {\tt 0x0e} & R/W & Product IDCODE\\\hline
|
|
CWDT & {\tt 0x0f} & R/W & Configuration Watchdog Timer\\\hline
|
|
HC\_OPT\_REG & {\tt 0x10} & R/W & House Clean Option Register\\\hline
|
|
CSBO & {\tt 0x12} & W & CSB Output for Parallel Daisy Chaining\\\hline
|
|
GENERAL1 & {\tt 0x13} & R/W & Power up Self-Test or Loadable Program Address\\\hline
|
|
GENERAL2 & {\tt 0x14} & R/W & Power up Self-Test or Loadable Program Address and new SPI opcode\\\hline
|
|
GENERAL3 & {\tt 0x15} & R/W & Golden Bitstream Address\\\hline
|
|
GENERAL4 & {\tt 0x16} & R/W & Golden Bitstream Address and new SPI Opcode\\\hline
|
|
GENERAL5 & {\tt 0x17} & R/W & User-defined register for fail-safe scheme\\\hline
|
|
MODE\_REG & {\tt 0x18} & R/W & Reboot mode\\\hline
|
|
PU\_GWE & {\tt 0x19} & W & GWE cycle during wake-up from suspend\\\hline
|
|
PU\_GTS & {\tt 0x1a} & W & GTS cycle during wake-up from suspend\\\hline
|
|
MFWR & {\tt 0x1b} & W & Multi-frame write register\\\hline
|
|
CCLK\_FREQ & {\tt 0x1c} & W & CCLK frequency select for master mode\\\hline
|
|
SEU\_OPT & {\tt 0x1d} & R/W & SEU frequency, enable and status\\\hline
|
|
EXP\_SIGN & {\tt 0x1e} & R/W & Expected readback signature for SEU detection\\\hline
|
|
RDBK\_SIGN & {\tt 0x1f} & W & Readback signature for readback command and SEU\\\hline
|
|
BOOTSTS & {\tt 0x20} & R & Boot History Register\\\hline
|
|
EYE\_MASK & {\tt 0x21} & R/W & Mask pins for Multi--Pin Wake-up\\\hline
|
|
CBC\_REG & {\tt 0x22} & W & Initial CBC Value Register\\\hline
|
|
\end{tabular}
|
|
\caption{Spartan--6 Configuration Register Addresses}\label{tbl:6addrs}
|
|
\end{center}\end{table}
|
|
|
|
% icape->general1 = (fpgaddr<<2);
|
|
% icape->general2 = ((fpgaddr>>14)&0x0ff)|((0x03)<<8);
|
|
% icape->cmd = 0x0e // IPROG
|
|
\fi
|
|
|
\chapter{Wishbone Datasheet}\label{chap:wishbone}
|
\chapter{Wishbone Datasheet}\label{chap:wishbone}
|
Tbl.~\ref{tbl:wishbone}
|
Tbl.~\ref{tbl:wishbone}
|
\begin{table}[htbp]
|
\begin{table}[htbp]
|
\begin{center}
|
\begin{center}
|
\begin{wishboneds}
|
\begin{wishboneds}
|
