add PMU_counters spec

docs/PMU_counters_specification/.gitignore

+*.log
+*.out
+*.toc
+*.aux
+*.pyg
+*.pdf
+*.bbl
+*.blg
+*.cut
+*.dvi
+*.gz

docs/PMU_counters_specification/1-Section.tex

+\newpage
+\section{General purpose of the module}
+
+Submodule of the PMU to handle event counters. This module contains generic adders with reset and simple control logic to ease interface with other modules.\\
+\\
+New values for the counters is provided through regs\_i and output of the counters is provided  through regs\_o.\\
+\\
+Counter results are internally registered.

docs/PMU_counters_specification/2-Section.tex

+\section{Design placement}
+\label{chapter2}
+This modules is meant to be instantiated by the interface agnostic PMU (PMU\_raw.sv). Only one instance of this module is required. The application-specific interface shall take care of the  write enable of this module.
+%This module is meant to be a blackbox inside the chisel code. It belongs to the Drac class in the \emph{rocket.scala} file. We can have as many instances of this module as cores are instantiated in the SoC. Currently only single core operation has been tested. 
+
+
+
+

docs/PMU_counters_specification/3-Section.tex

+\section{Parameters}
+\label{chapter3}
+This module requires two integer parameters.REG\_WIDTH and N\_COUNTERS. \\
+\textbf{REG\_WIDTH} defines the number of bits that a counter has.\\
+\textbf{N\_COUNTERS} defines the amount of counters that are available in the PMU.\\
+\\
+Given the previous parameters the unit shall generate correct RTL without any manual modification to the source code.\\
+\\

docs/PMU_counters_specification/4-Section.tex

+\section{Interface}\label{interface}
+\label{chapter 4}
+
+Interface signals of the module are listed in the table below.
+
+%TODO
+%\begin{table}[H]
+%	\centering
+%	\begin{tabular}{lllll}
+%		\hline
+%		Port\_Name                      & Direction & Width & Index      & Description \\
+%		\hline
+%		CLK                             & INPUT     & 1     & -          & Main clock, up to 200MHz      \\
+%		RST                             & INPUT     & 1     & -          & Hard reset. Active LOW     \\
+%		SOFT\_RST                       & INPUT     & 1     & -          & Soft reset. Active LOW       \\
+%		RESET\_ADDRESS                  & INPUT     & 40    & -          & Inital address of PC after soft or hard reset       \\
+%		CSR\_RW\_RDATA                  & INPUT     & 64    & -          & -       \\
+%	\end{tabular}
+%\end{table}

docs/PMU_counters_specification/5-Section.tex

+\section{Reset behavior}
+
+The module contains two reset signals. One synchronous active high reset enabled by software called softrst\_i, the other is the global reset, called rstn\_i it is asynchronous and active low.\\
+\\
+Any reset when active shall clear any internal register and set them to 0. Interruptions shall become inactive while the unit is in reset.
+
+
+
+

docs/PMU_counters_specification/6-Section.tex

+\section{What could not happen}
+When a write is performed to any of the counter values fo the PMU regs\_o shall show the most up to date value of the counters, rather than the internally registered value of the counters. Otherwise the value of the counter may oscillate between the last value and new one. 

docs/PMU_counters_specification/7-Section.tex

+\section{Behavior}
+The module uses generate loops to parametrically implement the amount of counters required. The output of the adders is stored in slv\_reg. the adder takes the last value of the counter (slv\_reg[n]) and adds one to it if the unit is enabled and the event n is active. Events and counters share the same index, meaning that event[0] will map to  slv\_reg[0].\\
+\\
+The outputs of the adders are stored in slv\_reg. If counters need to be updated externally the write enable signal (we\_i) will be high. When we\_i is high the input regs\_i will be bypassed to regs\_o ignoring the current value of the counters, also each slv\_reg will be updated with regs\_i rather than the ouput of the adders.\\
+\\
+\subsection{Packages and structures}
+
+No packages and structures are used in this module.
+

docs/PMU_counters_specification/8-Section.tex

+\section{Special cases, corner cases}
+
+No special cases or corner cases have been considered.
\ No newline at end of file

docs/PMU_counters_specification/Makefile

+CC=pdflatex
+
+all: spec 
+
+spec: main.tex 1-Section.tex 2-Section.tex 3-Section.tex 4-Section.tex 5-Section.tex 6-Section.tex 7-Section.tex 8-Section.tex
+	$(CC) main.tex
+
+clean:
+	rm *.aux *.log *.blg *.bbl *.out
+
+clear:
+	rm *.aux *.log *.blg *.bbl *.out *.pdf 
+

docs/PMU_counters_specification/main.tex

+
+% License:
+% CC BY-NC-SA 3.0 (http://creativecommons.org/licenses/by-nc-sa/3.0/)
+%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+%----------------------------------------------------------------------------------------
+%	PACKAGES AND OTHER DOCUMENT CONFIGURATIONS
+%----------------------------------------------------------------------------------------
+
+\documentclass[paper=a4, fontsize=11pt]{scrartcl} % A4 paper and 11pt font size
+
+\usepackage[T1]{fontenc} % Use 8-bit encoding that has 256 glyphs
+\usepackage{fourier} % Use the Adobe Utopia font for the document - comment this line to return to the LaTeX default
+\usepackage[english]{babel} % English language/hyphenation
+\usepackage{amsmath,amsfonts,amsthm} % Math packages
+\usepackage{lipsum} % Used for inserting dummy 'Lorem ipsum' text into the template
+
+\usepackage{caption}
+\usepackage{subcaption}
+\usepackage{graphicx}
+
+\usepackage{float}
+
+\usepackage{blindtext} %for enumarations
+
+\usepackage[]{hyperref}  %link collor
+
+%talbe layout to the right
+%\usepackage[labelfont=bf]{caption}
+%\captionsetup[table]{labelsep=space,justification=raggedright,singlelinecheck=off}
+%\captionsetup[figure]{labelsep=quad}
+
+\usepackage{sectsty} % Allows customizing section commands
+\allsectionsfont{\centering \normalfont\scshape} % Make all sections centered, the default font and small caps
+
+\usepackage{fancyhdr} % Custom headers and footers
+\pagestyle{fancyplain} % Makes all pages in the document conform to the custom headers and footers
+\fancyhead{} % No page header - if you want one, create it in the same way as the footers below
+\fancyfoot[L]{} % Empty left footer
+\fancyfoot[C]{} % Empty center footer
+\fancyfoot[R]{\thepage} % Page numbering for right footer
+\renewcommand{\headrulewidth}{0pt} % Remove header underlines
+\renewcommand{\footrulewidth}{0pt} % Remove footer underlines
+\setlength{\headheight}{13.6pt} % Customize the height of the header
+
+\numberwithin{equation}{section} % Number equations within sections (i.e. 1.1, 1.2, 2.1, 2.2 instead of 1, 2, 3, 4)
+\numberwithin{figure}{section} % Number figures within sections (i.e. 1.1, 1.2, 2.1, 2.2 instead of 1, 2, 3, 4)
+\numberwithin{table}{section} % Number tables within sections (i.e. 1.1, 1.2, 2.1, 2.2 instead of 1, 2, 3, 4)
+
+%\setlength\parindent{0pt} % Removes all indentation from paragraphs - comment this line for an assignment with lots of text
+
+
+\setlength\parskip{4pt}
+
+%----------------------------------------------------------------------------------------
+%	TITLE SECTION
+%----------------------------------------------------------------------------------------
+
+\newcommand{\horrule}[1]{\rule{\linewidth}{#1}} % Create horizontal rule command with 1 argument of height
+
+\title{	
+\normalfont \normalsize 
+\horrule{0.5pt} \\[0.4cm] % Thin top horizontal rule
+\huge  PMU\_counters specification version v1 \\ % The assignment title
+\horrule{2pt} \\[0.5cm] % Thick bottom horizontal rule
+}
+
+\author{ Guillem Cabo Pitarch} % Your name
+
+\date{\today} % Today's date or a custom date
+
+\begin{document}
+%\nocite{*}
+\maketitle % Print the title
+
+\newpage
+\tableofcontents
+
+%----------------------------------------------------------------------------------------
+%	Section 1
+%----------------------------------------------------------------------------------------
+
+\input{1-Section.tex}
+
+%----------------------------------------------------------------------------------------
+%	Section 2
+%----------------------------------------------------------------------------------------
+
+\input{2-Section.tex}
+
+\input{3-Section.tex}
+
+\input{4-Section.tex}
+
+\input{5-Section.tex}
+
+\input{6-Section.tex}
+
+\input{7-Section.tex}
+
+\input{8-Section.tex}
+
+
+
+\end{document}

docs/PMU_quota_specification/.gitignore

+*.log
+*.out
+*.toc
+*.aux
+*.pyg
+*.pdf
+*.bbl
+*.blg
+*.cut
+*.dvi
+*.gz

submodules/counters/PMU_counters.sv

 //-----------------------------------------------------
 // ProjectName: LEON3_kc705_pmu
-// Function   : Submodule of the PMU to handle counters 
-// Description: This module is contains the adders and registers for the PMU
+// Function   : Submodule of the PMU to handle event counters 
+// Description: This module contains the adders and registers for the PMU
 //              the registers are exposed through the interface to the modules
 //              other modules of the PMU and passed through to the PMU wrapper
 //              through the module PMU_raw