bus.tex

\documentclass[twoside]{article}
\usepackage[layout=letterpaper,margin=1in]{geometry}

\usepackage[protrusion=true,expansion=true,kerning,spacing]{microtype} % better type, spacing

%\usepackage{bold-extra} % for bf sc

\usepackage[font={normalsize,sf,bf}]{caption}
\usepackage{fancyhdr}
\usepackage{fixltx2e}
\usepackage{xspace}
\usepackage{color}
\usepackage{graphicx}
\usepackage{subcaption}
\usepackage{comment}
\usepackage{soul} % provides \hl{}
\newcommand{\hlc}[2][yellow]{{\sethlcolor{#1}\hl{#2}}}
\usepackage[normalem]{ulem} % provides \uline{}
\usepackage{listings}
\usepackage{amssymb} % For \checkmark
\usepackage{amsmath} % For \text, \underbrace
\usepackage{varwidth}

\usepackage[section]{placeins} % Don't let figs escape their section

\usepackage[all=normal,lists]{savetrees}

\usepackage{rotating}
\usepackage[endianness=big]{bytefield}
\bytefieldsetup{boxformatting={\centering\footnotesize}}

\usepackage{multirow}
\usepackage{tabularx}
\usepackage{nth}
\usepackage{moresize}
\usepackage{framed}
\usepackage{mdframed}

\usepackage{
  tikz,
  tikz-timing,
}
\usetikzlibrary{positioning}

\usepackage[nofancy]{svninfo}

\usepackage[colorlinks=true,citecolor=violet,urlcolor=blue,bookmarksopen=true,bookmarksopenlevel=2]{hyperref}
\hypersetup{pdfstartview=FitH} % Sets default zoom to 100% width

% And, of course, cleveref must be loaded last-last (read: after hyperref)
\usepackage[capitalise,nameinlink,noabbrev]{cleveref}     % Do the right thing with fig/table references

% http://tex.stackexchange.com/questions/94892/how-to-use-short-subsection-title-in-header-but-not-in-table-of-contents
\newcommand{\markedsection}[2]{\section[#2]{#2%
\sectionmark{#1}}
\sectionmark{#1}}

\newcommand{\markedsubsection}[2]{\subsection[#2]{#2%
\subsectionmark{#1}}
\subsectionmark{#1}}

\newcommand{\colorbitbox}[3]{%
\rlap{\bitbox{#2}{\color{#1}\rule{\width}{\height}}}%
\bitbox{#2}{#3}}

% From bytefield package documentation:
%   facilitates the creation of memory maps. Start address at the bottom,
%   end address at the top.
%   syntax:
%   \memsection{end address}{start address}{height in lines}{text in box}
\newcommand{\memsection}[4]{%
  % define the height of the memsection
  \bytefieldsetup{bitheight=#3\baselineskip}%
  \bitbox[]{8}{%
    \texttt{#1}% print end address
    \\
    % do some spacing
    \vspace{#3\baselineskip}
    \vspace{-2\baselineskip}
    \vspace{-#3pt}
    \texttt{#2}% print start address
  }%
  \bitbox{24}{#4}% print box with caption
}
\newcommand{\memsectionhuge}[4]{%
  \bitbox[]{8}{\texttt{#1}}
  \wordbox[lrt]{1}{#4} \\
  \bitbox[]{8}{\dots}
  \skippedwords \\
  \bitbox[]{8}{\texttt{#2}}
  \wordbox[lrb]{1}{#4}
}

\definecolor{lightblue}{RGB}{0,204,255}
\definecolor{lightcyan}{rgb}{0.84,1,1}
\definecolor{lightercyan}{rgb}{0.95,1,1}
\definecolor{lightgreen}{rgb}{0.64,1,0.71}
\definecolor{lightergreen}{rgb}{0.84,1,0.87}
\definecolor{lightred}{rgb}{1,0.7,0.71}

\definecolor{OliveGreen}{cmyk}{0.64,0,0.95,0.40}

\newcommand{\bus}{MBus\xspace}
\newcommand{\proto}{MPQ\xspace}
\newcommand{\CLK}{\texttt{CLK}\xspace}
\newcommand{\CLKIN}{\texttt{CLK\textsubscript{IN}}\xspace}
\newcommand{\CLKOUT}{\texttt{CLK\textsubscript{OUT}}\xspace}
\newcommand{\DAT}{\texttt{DATA}\xspace}
\newcommand{\DATZERO}{\texttt{DATA0}\xspace}
\newcommand{\DIN}{\texttt{DATA\textsubscript{IN}}\xspace}
\newcommand{\DOUT}{\texttt{DATA\textsubscript{OUT}}\xspace}
%\newcommand{\mbuscopy}{MBus~\textcopyright~$2012-2015$~The Regents of the University of Michigan}
\newcommand{\mbuscopy}{MBus~\textcopyright~$2012-2015$~The \bus Team and the Regents of the University of Michigan.}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\begin{document}

\svnInfo $Id$ 

\pagestyle{fancyplain}

\fancyfoot[LO,RE]{\footnotesize \ifnum\thepage=1 ~\else \mbuscopy \fi}
\fancyfoot[C]{\ifnum\thepage=1 \mbuscopy \fi}
\fancyfoot[LE,RO]{\ifnum\thepage=1 ~\else \thepage \fi}

%\fancyhf{}
%\fancyfoot[C]{\thepage}
%\fancyhead[C]{\em CONFIDENTIAL DRAFT --- DO NOT CITE OR DISTRIBUTE}

%\fancyhead[C]{\color{red} \textbf{\ifnum\thepage=1 ~ \else DRAFT -- Rev 0.3+ \fi}}
\fancyhead[C]{\textbf{\ifnum\thepage=1 ~ \else Rev 1.0-alpha \fi}}

\title{MBus Specification}
%\author{Pat Pannuto, Yoonmyung Lee, Ye-Sheng Kuo, ZhiYoong Foo, Ben Kempke,
%David Blaauw, Prabal Dutta\\$<$ppannuto@umich.edu$>$}
\author{%
 {\em \href{mailto:mbus-team@umich.edu}{\color{black}{$<$mbus-team@umich.edu$>$}} }\\
  \small
  Pat Pannuto,
  Yoonmyung Lee,
  Ye-Sheng Kuo,
  ZhiYoong Foo,
  Ben Kempke,
  David Blaauw,
  and Prabal Dutta
}
\date{Revision 1.0-alpha \\~\\Last Updated: June 14, 2015}
\maketitle

\input{overview}

\tableofcontents
\clearpage

\input{node_design}
\clearpage

\input{bus_design}
\clearpage

\input{power_design}
\clearpage

\input{address_design}
\clearpage

\input{protocol}
\clearpage

\input{mpq}
\clearpage

\input{programmer_model}
\clearpage

\input{specifications}
\clearpage

\input{todo}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\clearpage
\section{Document Revision History}
\label{sec:revisions}

\begin{itemize}

\item Revision 1.0-alpha -- June 14, 2015
  \subitem Initial Public Release

\end{itemize}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\clearpage
\appendix

%\input{requirements}
%\clearpage

\input{tests}

%\newpage
%\input{scratchpad}

\end{document}