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

Subversion Repositories versatile_library

[/] [versatile_library/] [trunk/] [doc/] [src/] [versatile_library.txt] - Blame information for rev 138

Details | Compare with Previous | View Log

Line No. Rev Author Line
1 138 unneback
Versatile library
2
=================
3
Michael Unneb├Ąck
4
v1.0, 2011-11-11
5
:doctype: book
6
 
7
[preface]
8
Library usage
9
-------------
10
The overall goal of this project is to present a Verilog HDL library with target technology specific functions
11
collected into a library. Out of a common code base special variants can be generated supporting a large
12
flavour of FPGAs.
13
 
14
Library structure
15
-----------------
16
Versatile library is divided into several sub sections
17
Followed by an example table:
18
 
19
.Sub sections
20
[width="60%",options="header"]
21
|==============================================
22
| Sub section     | Description
23
| clock and reset | Clock generation and reset sources
24
| Register        | Different type of register elements
25
| Logic           | Logic functions
26
| IO              | Special function IO
27
| Counter         | Different types of counters
28
| Memory          | Many types of memory
29
| Wishbone        | Wishbone functions such as bridges
30
| Arithmetic      | Arithmetic functios
31
|==============================================
32
 
33
Currently supported targets
34
[width="60%"]
35
|==============================================
36
| Generic | For simulation and generic targets
37
| ALTERA |
38
| ACTEL  |
39
|==============================================
40
 
41
.An example example
42
===============================================
43
Lorum ipum...
44
===============================================
45
 
46
[[X1]]
47
Sub-section with Anchor
48
~~~~~~~~~~~~~~~~~~~~~~~
49
Sub-section at level 2.
50
 
51
Chapter Sub-section
52
^^^^^^^^^^^^^^^^^^^
53
Sub-section at level 3.
54
 
55
Chapter Sub-section
56
+++++++++++++++++++
57
Sub-section at level 4.
58
 
59
This is the maximum sub-section depth supported by the distributed
60
AsciiDoc configuration.
61
footnote:[A second example footnote.]
62
 
63
 
64
Clock and reset
65
---------------
66
 
67
gbuf
68
~~~~
69
Global buffer to be used for high fabout signals such as clock and reset network
70
 
71
sync_rst
72
~~~~~~~~
73
 
74
 
75
An example link to anchor at start of the <>.
76
indexterm:[Second example index entry]
77
 
78
An example link to a bibliography entry <>.
79
 
80
 
81
The Third Chapter
82
-----------------
83
Book chapters are at level 1 and can contain sub-sections.
84
 
85
 
86
:numbered!:
87
 
88
[appendix]
89
Example Appendix
90
----------------
91
One or more optional appendixes go here at section level 1.
92
 
93
Appendix Sub-section
94
~~~~~~~~~~~~~~~~~~~
95
Sub-section body.
96
 
97
 
98
[bibliography]
99
Example Bibliography
100
--------------------
101
The bibliography list is a style of AsciiDoc bulleted list.
102
 
103
[bibliography]
104
.Books
105
- [[[taoup]]] Eric Steven Raymond. 'The Art of Unix
106
  Programming'. Addison-Wesley. ISBN 0-13-142901-9.
107
- [[[walsh-muellner]]] Norman Walsh & Leonard Muellner.
108
  'DocBook - The Definitive Guide'. O'Reilly & Associates. 1999.
109
  ISBN 1-56592-580-7.
110
 
111
[bibliography]
112
.Articles
113
- [[[abc2003]]] Gall Anonim. 'An article', Whatever. 2003.
114
 
115
 
116
[glossary]
117
Example Glossary
118
----------------
119
Glossaries are optional. Glossaries entries are an example of a style
120
of AsciiDoc labeled lists.
121
 
122
[glossary]
123
A glossary term::
124
  The corresponding (indented) definition.
125
 
126
A second glossary term::
127
  The corresponding (indented) definition.
128
 
129
 
130
[colophon]
131
Example Colophon
132
----------------
133
Text at the end of a book describing facts about its production.
134
 
135
 
136
[index]
137
Example Index
138
-------------
139
////////////////////////////////////////////////////////////////
140
The index is normally left completely empty, it's contents being
141
generated automatically by the DocBook toolchain.
142
////////////////////////////////////////////////////////////////
143
 

powered by: WebSVN 2.1.0

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