OpenCores
URL https://opencores.org/ocsvn/hdlc/hdlc/trunk

Subversion Repositories hdlc

[/] [hdlc/] [trunk/] [DOCS/] [hdlc_project.tex] - Blame information for rev 2

Go to most recent revision | Details | Compare with Previous | View Log

Line No. Rev Author Line
1 2 khatib
\documentclass[a4paper,11pt]{article}
2
\usepackage{fancyheadings}
3
\usepackage{lastpage}
4
\pagestyle{fancy}
5
 
6
%% defined commands
7
\newcommand{\openhw}{\mbox{\textbf{\textit{OpenHW}}}}
8
\newcommand{\opendesign}{\mbox{\textbf{\textit{OpenDesign}}}}
9
\newcommand{\openipcore}{\mbox{\textbf{\textit{OpenIPCore}}}}
10
\newcommand{\opencores}{\mbox{\textbf{\textit{OpenCores}}}}
11
 
12
%% addcomment command: Author name: Comments
13
\newcommand{\addcomment}[2]{\rule{1ex}{1ex} \emph{Comment by \textbf{#1}: #2 }\rule{1ex}{1ex}}
14
 
15
%% addauthor command: Author name : List of changes: date: contact address
16
\newcommand{\addauthor}[4]{#1 & #2 & #3 & #4 \\ \hline}
17
 
18
 
19
 
20
%% Optional suffix or prefix
21
\newcommand{\prefix}[1]{[\textit{#1\_}]}
22
\newcommand{\suffix}[1]{[\textit{\_#1}]}
23
 
24
 
25
%% Must define Project Name
26
%% Must define Author Name
27
 
28
\author{Jamil Khatib}
29
\title{HDLC controller core}
30
 
31
 
32
 
33
%% Hyphenation list %%
34
\hyphenation{OpenIP OpenIPCore OpenHW OpenDesign OpenCores ISP CPLD FPGA CAD VHDL hard-ware soft-ware DSP ASIC}
35
 
36
 
37
%%Headers & footers
38
\lhead{\uppercase\rightmark}
39
\chead{}
40
\rhead{\bfseries \opencores Project}
41
\lfoot{HDLC controller}
42
\cfoot{}
43
\rfoot{\thepage~ of \pageref{LastPage}}
44
\setlength{\headrulewidth}{0.4pt}
45
\setlength{\footrulewidth}{0.4pt}
46
 
47
%% begin Document
48
\begin{document}
49
%% Cover page
50
\maketitle
51
 
52
\begin{center}(C) Copyright 2001 Jamil Khatib.\end{center}
53
 
54
\thispagestyle{empty}
55
 
56
\newpage
57
 
58
 
59
%%Table of contents page
60
\tableofcontents
61
 
62
\newpage
63
 
64
\section{List of authors and changes}
65
 
66
\begin{tabular}{|l|l|l|l|l|}
67
\hline
68
Name & Changes & Date & Contact address\\
69
\hline
70
\hline
71
 
72
\addauthor{Jamil Khatib}{Initial release}{9-1-2001}{khatib@ieee.org}
73
%% use add author command here
74
 
75
 
76
\end{tabular}
77
 
78
\newpage
79
 
80
%%- New section -%%
81
%%------------------------------------------%%
82
\section{Project Definition}
83
 
84
\subsection{Introduction}
85
HDLC protocol is used as a data link of most of the current communication systems like ISDN, Frame Relay, Ethernet \dots HDLC is a family of protocols that varies in address size, control field and FCS.
86
 
87
%\subsection{Definition}
88
 
89
\subsection{Objectives}
90
The aim of this project is to develop the basic HDLC functionalities to be used by many communication systems.
91
 
92
 
93
%%- New section -%%
94
%%------------------------------------------%%
95
\section{Specifications}
96
 
97
\subsection{System Specification}
98
\begin{itemize}
99
\item 1. 8 bit parallel back-end interface
100
\item 2. Use external RX and TX clocks
101
\item 3. Start and end of frame pattern generation
102
\item 4. Start and end of frame pattern checking
103
\item 5. Idle pattern generation and detection (all ones)
104
\item 5. a)  Idle pattern is assumed only after the end of a frame which is signaled by an abort signal
105
\item 6. Zero insertion
106
\item 7. Abort pattern generation and checking
107
\item 8. Address insertion and detection by software
108
\item 9. CRC generation and checking (Optional, external, since CRC-16 or CRC-32 can be used )
109
\item 10. FIFO buffers and synchronization (External)
110
\item 11. Byte aligned data (if data is not aligned to 8-bits extra random bits are inserted)
111
\item 12. Q.921 compliant
112
\end{itemize}
113
 
114
\subsection{External Interfaces}
115
 
116
\subsubsection{Receive Channel}
117
 
118
 
119
\begin{tabular}{|l|l|l|}
120
\hline
121
Signal name& Direction& Description\\
122
\hline
123
\hline
124
Serial Interface & & \\
125
\hline
126
\hline
127
RxClk & Input & Receive Clock\\
128
Rx & Input& Receive Data\\
129
\hline
130
\hline
131
Back-end Interface & &\\
132
\hline
133
\hline
134
RxD[7:0]& Output& Receive data bus\\
135
Valid Frame& Output& Valid Frame indication during all frame bytes transfer\\
136
Frame Error& Output& Error in the received data (lost bits)\\
137
Aborted& Output& Aborted Frame\\
138
Read& input& Read byte\\
139
Ready& Output& Valid data exists\\
140
\hline
141
\end{tabular}
142
 
143
\subsubsection{Back-end interface mapping to Wishbone SoC bus}
144
 
145
\begin{tabular}{|l|l|}
146
\hline
147
Signal Name& Wishbone signal\\
148
\hline
149
\hline
150
Master Configuration connected to FIFO&\\
151
\hline
152
Data[7:0]& DAT\_O[7:0]\\
153
ValidFrame& STB\_O\\
154
ReadByte& ACK\_I and not RTY\_I\\
155
ready& WE\_O\\
156
FrameERR& TAG\_O[0]\\
157
Aborted& TAG\_O[1]\\
158
\hline
159
Slave FIFO(two-clock domain FIFO)&\\
160
\hline
161
Data[7:0]& DAT\_I[7:0]\\
162
Chip Select& STB\_I\\
163
STB\_I& ACK\_O\\
164
FullFlag& RTY\_O\\
165
Write& WE\_I\\
166
\hline
167
Slave Configuration &\\
168
\hline
169
Data[7:0]& DAT\_O[7:0]\\
170
ValidFrame& TAG\_O[0]\\
171
ReadByte& WE\_I\\
172
Ready& RTY\_O\\
173
Always active& ACK\_O\\
174
FrameERR& TAG\_O[1]\\
175
Aborted& TAG\_O[0]\\
176
\hline
177
\end{tabular}
178
 
179
 
180
\subsubsection{Transmit Channel}
181
 
182
 
183
%%- New section -%%
184
%%------------------------------------------%%
185
\section{Internal Blocks}
186
 
187
 
188
%%- New section -%%
189
%%------------------------------------------%%
190
\section{Design description}
191
 
192
\subsection{Design notes}
193
\subsection{Timing}
194
\subsection{Diagrams}
195
 
196
 
197
 
198
%%- New section -%%
199
%%------------------------------------------%%
200
\section{Testing and verifications}
201
 
202
 
203
\begin{tabular}{|l|l|l|}
204
\hline
205
Requirement & Test method & Validation method \\
206
\hline
207
\hline
208
Interface timing & &\\
209
\hline
210
& & \\
211
\hline
212
\hline
213
Functionality & & \\
214
\hline
215
\end{tabular}
216
\subsection{Simulation and Test benches}
217
 
218
\subsection{Verification techniques and algorithms}
219
 
220
\subsection{Test plans}
221
 
222
%%- New section -%%
223
%%------------------------------------------%%
224
\section{Implementations}
225
 
226
\subsection{Scripts, files and any other information}
227
 
228
\subsection{Design conventions and coding styles}
229
 
230
%%- New section -%%
231
%%------------------------------------------%%
232
\section{Reviews and comments}
233
 
234
%%- New section -%%
235
%%------------------------------------------%%
236
\section{References}
237
 
238
 
239
\end{document}

powered by: WebSVN 2.1.0

© copyright 1999-2024 OpenCores.org, equivalent to Oliscience, all rights reserved. OpenCores®, registered trademark.