Update datasheet, include nice title

fractalclone · Feb 10, 2016 · af65c1e · af65c1e
1 parent 1fa21a7
commit af65c1e
Show file tree

Hide file tree

Showing 9 changed files with 56 additions and 533 deletions.
diff --git a/doc/blockdiagram.obj b/doc/blockdiagram.obj
diff --git a/doc/datasheet/content/peripherals_gpio.tex b/doc/datasheet/content/peripherals_gpio.tex
@@ -1,7 +1,7 @@
 \section{GPIO}
 
 \begin{table}[H]
- \caption{External GPIO Signals}
+ \caption{GPIO Signals}
  \label{tab:gpio_signals}
   \begin{tabularx}{\textwidth}{@{}llX@{}} \toprule
     \textbf{Signal}                  & \textbf{Direction} & \textbf{Description}         \\ \toprule

diff --git a/doc/datasheet/content/peripherals_i2c.tex b/doc/datasheet/content/peripherals_i2c.tex
@@ -1,4 +1,24 @@
-\section{I2C}
+\section{I$^\text{2}$C}
+
+I$^\text{2}$C is an open-drain signaling protocol, meaning that the pad output
+driver will be switched on and off, while always driving a low value when
+enabled. Logic high values are achieved by using a pull-up resistor on the
+\signal{SDA} and \signal{SCL} lines.
+
+\begin{table}[H]
+ \caption{I$^\text{2}$C Signals}
+ \label{tab:i2c_signals}
+  \begin{tabularx}{\textwidth}{@{}llX@{}} \toprule
+    \textbf{Signal}                  & \textbf{Direction} & \textbf{Description}        \\ \toprule
+    \signal{scl\_pad\_i}             & \textbf{input}     & SCL Input                   \\ \hline
+    \signal{scl\_pad\_o}             & \textbf{output}    & SCL Output (always 0)       \\ \hline
+    \signal{scl\_padoen\_o}          & \textbf{output}    & SCL Pad Direction           \\ \hline
+    \signal{sda\_pad\_i}             & \textbf{input}     & SDA Input                   \\ \hline
+    \signal{sda\_pad\_o}             & \textbf{output}    & SDA Output (always 0)       \\ \hline
+    \signal{sda\_padoen\_o}          & \textbf{output}    & SDA Pad Direction           \\ \hline
+    \signal{interrupt\_o}            & \textbf{output}    & Event/Interrupt             \\ \hline
+  \end{tabularx}
+\end{table}
 
 \regDesc{0x1A10\_5000}{0x0000\_0000}{CPR (Clock Prescale Register)}{
   \begin{bytefield}[rightcurly=.,endianness=big]{32}
@@ -11,7 +31,7 @@ \section{I2C}
 }{
   \regItem{Bit 15:0}{PRE}{Prescaler.\\
     Sets the clock prescaler by the value in PRE to
-    achieve the desired I2C clock by dividing the current system clock by the
+    achieve the desired I$^\text{2}$C clock by dividing the current system clock by the
     given factor.}
 }
 
@@ -33,7 +53,7 @@ \section{I2C}
   \end{bytefield}
 }{
   \regItem{Bit 7}{EN}{Enable.\\
-  Enable the I2C peripheral.}
+  Enable the I$^\text{2}$C peripheral.}
   \regItem{Bit 6}{IE}{Interrupt enable.\\
   Enable interrupts.}
   \regItem{Bit 5:0}{Reserved}{Set to 0.}

diff --git a/doc/datasheet/content/peripherals_spi.tex b/doc/datasheet/content/peripherals_spi.tex
@@ -1,7 +1,7 @@
 \section{SPI Master}
 
 \begin{table}[H]
- \caption{External SPI Signals}
+ \caption{SPI Signals}
  \label{tab:spi_signals}
   \begin{tabularx}{\textwidth}{@{}llX@{}} \toprule
     \textbf{Signal}                  & \textbf{Direction} & \textbf{Description}        \\ \toprule

diff --git a/doc/datasheet/content/peripherals_timer.tex b/doc/datasheet/content/peripherals_timer.tex
@@ -1,7 +1,5 @@
 \section{Timer}
 
-The timer unit has no external signals.
-
 The timer unit has 2 timers per default. This can be overwritten by a parameter
 when instantiating the timer.
 

diff --git a/doc/datasheet/content/title.tex b/doc/datasheet/content/title.tex
@@ -0,0 +1,29 @@
+\makeatletter
+\begin{titlepage}
+
+ % Remove the page number in the footer.
+ \thispagestyle{empty}
+
+ \begin{center}
+
+  \begin{spacing}{2.0}
+  {\Huge\textbf{\@title}}
+  \end{spacing}
+
+  \vspace{0.2cm}
+
+  \vfill
+
+  \includegraphics[height = 12cm]{figures/imperio_layout}
+
+  \vfill
+
+  {\Large \@author}\\
+  {[email protected]}
+  \vfill
+  \@date
+
+ \end{center}
+\end{titlepage}
+\makeatother
+
diff --git a/doc/datasheet/datasheet.tex b/doc/datasheet/datasheet.tex
@@ -18,6 +18,7 @@
 
 %%%%% Mandatory title page settings.
 \title{PULPino: Datasheet}
+\author{Andreas Traber}
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 %%%%%                                                                 %
@@ -26,7 +27,7 @@
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 \begin{document}
 
-\maketitle
+\input{./content/title.tex}
 
 \tableofcontents
 

diff --git a/doc/datasheet/figures/imperio_layout.jpg b/doc/datasheet/figures/imperio_layout.jpg
diff --git a/doc/datasheet/figures/riscv_arch.pdf b/doc/datasheet/figures/riscv_arch.pdf