simplefpga/generic_ip/generic_versioning/doc/generic_versioning.htm
David Rodriguez cb47323ec9 1)Stop tracking rtl
2) added qip files from pei and changed folder structure
3) added files generic_ip, .qip and related files
2026-04-05 16:58:14 +01:00

293 lines
15 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html>
<!-- ********************************************* -->
<!-- * AUTO-GENERATED BY gen_htm.py. DO NOT EDIT * -->
<!-- ********************************************* -->
<html lang="en-GB">
<head>
<title>Datasheet for GENERIC_VERSIONING GIS soft IP component</title>
<style>
h1, h2, h3, h4 {
font-family: Helvetica, Arial, sans-serif;
}
p {
font-family: Helvetica, Arial, sans-serif;
font-size: 10pt;
text-justify: auto;
}
table#main {
font-family: Helvetica, Arial, sans-serif;
font-size: 11px;
border-collapse: collapse;
width: 850px;
border: 3px solid #009ab0;
}
table#main td {
border: 1px solid #80c0c0;
text-align: left;
padding: 5px;
font-family: "Lucida Console", Monaco, monospace;
}
table#main th {
border: 1px solid #dddddd;
text-align: left;
background-color: #009ab0;
color: #ffffff;
padding: 5px;
}
table#key {
font-family: Helvetica, Arial, sans-serif;
font-size: 8pt;
border-collapse: collapse;
width: 500px;
border: 0px;
}
table#key td, th {
text-align: left;
padding: 5px;
vertical-align: top;}
</style>
</head>
<body>
<img src="data:image/png;base64,
iVBORw0KGgoAAAANSUhEUgAAALgAAABACAYAAACp8r2zAAASHklEQVR4nO2df7QVxX3AP3mlHELfoZRaSim1aACRIlF+GKJRqZJUouAYIf5AK5U4rSCaRKmYFD3GoImC
xhCVDGoIGmNFdEQLhBBQIIIaX1ARkCJQQEqppRz6jofSd177x3eGu3fv3ru79+1990n3c849+97emdm593535jvf73e+Czk5OTk5OTk5HY5P1bsDORUw9lvANcBMtHqu
3t35JNJQ7w7kVOQiYCBwWb078kklF/COzf7QMScluYDnHNfkAp5zXJMLeM5xTS7gOcc1nerdgU8MxjagVWu9u1E1xnYDRiG/+Sa02hZRZhBwGK32xrTVBxgOtALr0Opg
6P0GoB/QmcIgugutDldocyBwCK32h843AIOAg2i1r2K/IshGwI3tgXx5/YDPAb2BbhQ+3FHgILANeBdoQqvX2njNToACuiBfdBQNwH60Wpmy7X7A+cDZiJmuO9AVY1uB
I8BhYBewHtiIVquq+ATth7Hzga+FzjUBk9Fqo/u/AXgPWAl8sUw7PYCfAheHzi9wbfnfoQewhbCGYOwzwMSSgcLYvq78IeAPQlftisjMM8CVFT5lJG0TcGMvBm4GRgKN
CWqMCtTdBSwFHkarzVVcvSuwKEG5HcBnErVo7LnATGB0gtLDgfGu3nbgOWAOWn2U6FrthbFrgS8ArwD3Ah8DY4G/B36LsWPQanmgRrRMGNsZeB84AXgamI8I8O3AJGAw
MMKVbnCvlcBcd+5SV64zpXb9q9yxO8aORKsNgff8TVKVrFYn4MZeDUwHhlRVX+gLTAGmYOzzwCy0akpRvxX5sbrGlIu3IRvbCPyYwhedln7ADOBGjL0bre6rsp1sMfZu
RLino9XswDvrMPZJZGQcAwQF/EiZ1hYhwn0RWi0NnF+FsVOAhzH2YbSaCrS491aj1RL39xKM/RLwlYi2pwN7kZl/JuLg8vjRvly/KpJukWnsUIx9FXiStgl3mK8Ab2Hs
XDdSJCWJTly5jOh+W6heuIM0At/H2NedmlM/ROX4B2B3SLgFrTah1afQ6mZ3prwsiG4+DngqJNy+rUeAjchg1YCoGgB/FGijL3KDFOv3xl6IqIATgNnAl536mQnJGzL2
OuDxrC5chhuRDzi2SrUlHcb2Bt4ifhZIy5nAFvc5lseWrg1+AHr02BljuwOzKAjzHuDTwM/QaivGlmvrfHes9PvPde8PRqt3MPYo8HWMvSlwvUPAn4fq3QaAVhsw9iNE
dRqP6NxtJtkIbuyt1F64PScjo/nIdrjWWrIXbk8nYBnGXuVGtfbGXzM4tXdH1MK/c69ZyCg/PGFblWZDr5YEP+s+YB2wBmhy159x7F2ZrUcBzwKg1XbEGHF7TH8SE//F
i3Dfn9UFE9IFWI+xZ9bsCsY+iNxMteZR5PO0N++44w2Bc7uBP3Wv3wWMOx9n0VrjjhMrlLneHTe5Y2fgCbQ6z72GAY8BszDWzy5eHz8BY+/F2FnITTTEmSKhjb6aypWN
vYr2F+4gv66JLmtsT+DrmbdbyhrgDLT6uB2uVYxWLcCPgAEY+zV3rhWt9rlXC6CBrWi1I1CzOaKtjchNoDG2dLQ3djyymH0OrVqcKgSlI/56d+zpjv7mOx8Z2b+F6OkA
fxuqW96GXoHyOrjcQT+rptEM6QS8iow4WXJ1irLNyDT7huvPWYiOHafa/DCwgKsPWk3D2FHAfIwdBvwE+TxnIWY+8CY7UaNagX6uDsjnPYBW77hyHwJvYuydwMvu/YnA
TchidoKr5w0FQ5yq6Z01/pqrnHpyLvA8Iuid3PU7ATuBWxGLir/hBpXpV0UqLTJfiKtchg3ACuAD5K7rhBj+T0Hu1NNTttcbY38FfDFDT+IlCcu9jDgwDhSdlRlgKnBH
RJ2jiDOjo2xQGAb8nILe7TkAXBZazLciv8/qwLltwClotR9jT3Ft3eVenqVEO2GUe3l2A5ejVSvGznHnvh3x/c4GZmDsULRqcovfUQT9KL5fMZQz6n+V+IVHmAXAg7F3
lejVtwBfTdhuM7JAyZKBCcrsQquxke/ID3Inxi5DhMHr2E3AhNCUX1+0OgpchrEnI2pEI7AZrV4JlWvF2POQmcmPwK3AR4Ey24ERGDsUGIosLF+LcPsfBP7StePb2hfy
c7wAvIBWWyN6fSfwSwrmxvNCbRX3qwLRW9aM3Yk4YpLQDFyLVs8nLO+vMQmZMivxBHB7yR0u9RuBfyXeg7oOrc4J1Ovh6sXZ2x9Aq1tiyuCcF78AlqPVmNjyaTB2MbIQ
+wFafSPTtv+fULrIFHd134T1DwKfTS3cAFotQO7MKJYDI9CqVD1oO43ECzcktbBotQI4J3PhzsmEKCvKtBT1z27TdKzVGmRTrWcDMBatxqDVb6putzKHSeb2VS4kIR6t
1rWpRzk1I0rAv5Sw7p1l9Kd0aPUUspi7B60+j1Yvt7nNytc7RHKT05MufGBwLbuUUzuKF5minnRLUO8gWn0ns16UW8zVju0UbLFx3IgEUb0CvAQszeTGbg+M7QU0HIuj
FtNvS5mY695ILPhhjO2K2KO9vTzYXt9QtJ9/z9c5gFZH3FqnK8W28AZEdj52lqjOlNrKJZZFq1J7fBWER/CkJryHsrh4HanGBDoKmIPEmLyFsQ+5AaEj8zoS4uoFcCew
xwWYBemNxKX4RfUk4F8IBtQZOw5ZnE8tc62rXJ1R7v8fuzY/DLz2IKECuLb2BM4Hy2Tmqg+bCWPtio74RaWxv0QWqy0xJZPSGZiPVt/LoK0FtM1D681kN2HsZuBh4NkO
FwsusR9BK5P/vV+k+Lf2A12XyKOxA1ydg8C1Za7l6/gF/AB3nBe6jh/9vw38MaIxXIdEGT6PjOi/KP+R0hEW8CQhsM2IkT2Oc0lmrUjDqZm0otVHGDsTuDuD1gYhAv59
jH0EuNfp+R0B72jztCCOqAEYe0dAzQzHXB91R+/TeNsdT6ngbDsaOnZDVJ4bIksHByqJVF1SC89vWEXpE1mqmCbnPIgj9f65BByML5IQrb4LlI0PrYJGJNTznzE2Kqi/
I9AJGVHnAXcF4nzCA52Xi84Y+5J7/9SUM1Qyr7OELIN4uzMnLOBJQkezE7J6o9Wl+FDN7DgBWIyx38y43axoCIyqy9wxPOP4AezXyP7L/VUsrHcAjW7zx5vu9S7GXlFd
t6sjLOAdfdd49nHVWl2ObJlKMiulYQ7GtkfEYlq8bnw9Elg1PkKl8tGPA4EfAn0wNsn+1yBHkd/rTCTsYziyb7NXVb2ukrDAJLEPt2sH2wXZ0tUf+TGzXCg+6LZ7dSRk
0a/VY0iE5CKMHY0MbgXVRLjN6cVLgPEx/gBvTPDqTj+g2W2LC75+kOFniSUs4LsT1DkdY+sRwA/Zj7IFtNrtfsyTEEvBioxafjS+SN24wB2XIbLwX+5///s+5Y6XB8qV
Izw4diY7C1rVhBcXG4lPmdAFmbo2xpSrxVawD2rQZjHiYFgILHSLsNFIzMxoCsH4aTgXY/sQl0ynNnSi1JJVGNS0asbYqYgVCAoDiC/TC3H2HMHYacBcjJ2EVgswVgGL
EfVuAeCDwXzE4GFEtbkwdP2taLUroj812dYXbvT9hPWSJGBJeve2pigbG+CeKVptR6t5aHUlsll2DBLhmNbLNj7zviWjJ6WDWPei/2RHvE/t4L3YfnDqFCj3I2SG/wnG
nghsRixlc4D/QDZR3Ech+1Qzfl9q8StsNvQy2J0aEP7wSbNNTcHvhi7POSS3g79OshCBJPb32iDbzpYDyzH2NsTbltRSMqxm/arMeRR+4yOISlK6xtDqEow9HwlhAFFN
3kCEOMgZiH8DFwP+Z27vwBnASxRnK7uB6BssbI3Z7/qVddQoEBUPbuyHiOs2ju+hVdtdqjKFVdLtPE1u46qvV108eOW+9EwVnmvs44gXLg7rTJLpyOPB20yU3pN0q9UM
jP1Cm64u+/L+MWHpF9t0rThkW9wHpEs8NDe+CJC9RzcnIVECniaQ6tXARtBqWE0y1QRkIZM9xp6Mse8i+0UbEedGUpJGJFaVdiyn7ZQKuGxgWFNatGz91am9dsaeiLFv
IguTJKxCqyQmzHTIdrN3EQeEZzjGrk5oCo1bh3iqSnmQ03bK7aqfivzwSZmDsdci5qaXKZfHWcI0JyIxG2mm7ekpyibD2Dso3hkeZBQSFjs9cne8hJ7OoZDSLI7Xq+li
Zkhsdk9gx7E4IskX3hoZdy3x4ScUrUekjV6ujSOBciADXWlct48ll3LhMsH3xWZeKWuC5CtsLSoj9U5GYtAjQ0iiBVyrTUjO50llL1jKECQGuMWFkO6lEHDV23UkyW72
MJZ0WWcrI1/2IqKznAbpi3j5tiF5Ud5DfqDTkESUaWziS+KL1Ahjfw5cEfh/ITLzNAA7Mda6cAX//kAkQc/TwFQnWIsIpn8w9gkkdrwZ+J/A1fYRNFAYewmSXfZFZEd/
sSnQ2AluAFmEzJwXRMa8GHs/kstmMpKiwp+7NVBmBfCNUBqMinlRrge+THI9M9jmELLJPttM5XRh6TD2LOQmTLMFbQCF+I1q+E3ZGa3WGPsicjMa4LfId/nXwHq0moex
zwJXY+zjbvM0iPOmOzJDgWwOuRix/7+JZIG9DliGVs9h7API2qUPIi+bkQEBCmbH0YiDcCGFmbsBCcgCuSl6I9a0k0Kf4SwKgtzNnZvizq10/fsLxHQ9k5CPpryASwqu
sxHnT72e5fNXZJv27F7SCXcWJNXTs0Wm73HIEyh8GrR5TmBkRtTqGhfauwz4HWeyHQRMQ6sdbra7GFiJVpMDbQzF28h9ag1J1/afwP0uY0KQLkj+lHKbJbya1Bdj56LV
NNdmV4oX/V4WHkJUmsKTKOQpFiW54CsLriR6SWZDzp7JtPUxJ6VcTiE5ZHuwgvo93sTrqoOLzLlavXZMhxbGAg0YOxdRFTY7ryVO320BRhZtz9OqKdQGFGa5csF4lSJV
+yChH7OR/a8+6epad/QqlF/4Sxo9yYno+7SxZK8pSUZmEbILYjqYNbeg1ROZtypfwAji42iy4DAyndcHWcBdhMzSazF2C5JsKVxuFaJ+3IioGuH8Lpe4869i7Af4RJ7p
2AsMxNj7MXaOewUjLTsDjWg1HfG0/hPG3oVsCxxBYYuk1ziuceUWYex/Y+wMtwguIZnqIV/CZ6n96NcCXINWD9TsClodQaszSO7QqoZDwDAqPVWsPZCnMZyEhAH3ReJI
3keethDEW6meLjHHShufAR5ARuf5buNCmh04+5FF+a1IeMM3key+fp3WSmE32edc2TuAZ1x+nOGBct6U3R/Z17kbUT3/zalfRSTXreWRF6e5RmvhuFiK7Pl7KrZkFkgm
1L8h++fANwGnOfWu/mi1C61uRqtPI2HAAyjNGux1211l2tiBVreg1e8hi7jBpMtMMAQJlPv90Cs4yBw9di1RVQ64IDeICsfQ6hBa3YNW/YHPu7O/ChdLv3jU6h5kVHiM
bOJ9tyEZRy8iXZasBpI92a18GVkM9UfyaGehgs1Gq2F1Co0txdghLmZH0GohIszhka4xdAy3UXB6afUMEhiVJmVGZ3zOleJXtPyIqtI/cKb46RHG9nURjb78BuSRJyXO
ueoe9iO67PVOTxqH6Gmnk9ykuBsxJS2mmryGQiuiClRy9TcQ50UUR8c0Z1e9Annc3ekkfyrDNkRH/GmkDbdeSF7u9cAOjB2DzFQKCYUtZ5cPP9dyKPIMo00YOwGxc3vT
8dNl6kYNmkeAnhG7m3a777+BsCxGq3cHnWVnp+vfOcjMMBCxk5dESrbtaVYyUj0CPOLMUiMRh04v4A8RXUqSlcO/I1/QVrR6o03XlWs3Y+ypFBKnR9FAUnVKdM/7gPuQ
rEsjgROBP3FHfyMdQjZe7AXeoXY5FNvKLmTxeB3Fcf6bEdUsiBfKsF69O9DGlsD5jRQeWeLx9u3wg1xBZo0BiLMsyETkRulDZW3CDzY9kTTPPuXH2kCZo0jK5iKye5S3
uIDXkDyOJYtrZq0/+3YPUE/vYxbIdzMZSTQ/Dnmk39tOTQlzCNHPi40IkiZisjMhXujaeK+MhWuTayPqhr8SGfSCs2IDBYfQpVQO3Whyba9z/fqu86YqZAG8B1hYzl2f
01ExdjHG/i/ywKycKqiXhzInp13IBTznuCYX8JzjmlzAOzY9QseclOQC3rHZikTavR1XMCcnJycnJycnJycnpyPwf6qZnReB1P5+AAAAAElFTkSuQmCC"
alt="gis_logo.png">
<h1>Datasheet for the GENERIC_VERSIONING GIS Soft IP Embedded Logic</h1>
<h2>Register Definitions</h2>
<table id="main" style="margin-left:20px">
<tr>
<th>generic_versioning</th>
<th colspan="7" style="font-family: Helvetica, Arial, sans-serif;"font-family: Helvetica, Arial, sans-serif;>This block is the generic versioning</th>
</tr>
<tr>
<th>Register Name</th>
<th>Byte Addr Offset</th>
<th>Field</th>
<th>Bits</th>
<th>Type</th>
<th>subtype</th>
<th>Reset</th>
<th style="font-family: Helvetica, Arial, sans-serif;">Description</th>
</tr>
<tr>
<td valign="top" rowspan=4 style="border-bottom: 2px solid #80c0c0">CSR_GENERIC_VERSIONING_IP_ID</td>
<td valign="top" rowspan=4 style="border-bottom: 2px solid #80c0c0">0x0</td>
<td> </td>
<td>32</td>
<td> </td>
<td> </td>
<td> </td>
<td style="font-family: Helvetica, Arial, sans-serif;">Unique ID for this IP block</td>
</tr>
<tr>
<td>IP_NUMBER</td>
<td>7:0</td>
<td>c</td>
<td></td>
<td>0x09</td>
<td style="font-family: Helvetica, Arial, sans-serif;">IP identifier number</td>
</tr>
<tr>
<td>MFR_NUMBER</td>
<td>15:8</td>
<td>c</td>
<td></td>
<td>0xFF</td>
<td style="font-family: Helvetica, Arial, sans-serif;">Manufacturer number</td>
</tr>
<tr>
<td style="border-bottom: 2px solid #80c0c0">RESERVED</td>
<td style="border-bottom: 2px solid #80c0c0">31:16</td>
<td style="border-bottom: 2px solid #80c0c0">rsv</td>
<td style="border-bottom: 2px solid #80c0c0"></td>
<td style="border-bottom: 2px solid #80c0c0">0</td>
<td style="font-family: Helvetica, Arial, sans-serif;border-bottom: 2px solid #80c0c0">Reserved bits</td>
</tr>
<tr>
<td valign="top" rowspan=4 style="border-bottom: 2px solid #80c0c0">CSR_GENERIC_VERSIONING_IP_VER</td>
<td valign="top" rowspan=4 style="border-bottom: 2px solid #80c0c0">0x4</td>
<td> </td>
<td>32</td>
<td> </td>
<td> </td>
<td> </td>
<td style="font-family: Helvetica, Arial, sans-serif;">Bits[7:0] = Minor version number, Bits[15:8] = Major version number, etc.</td>
</tr>
<tr>
<td>MINOR_NUMBER</td>
<td>7:0</td>
<td>c</td>
<td></td>
<td>0x02</td>
<td style="font-family: Helvetica, Arial, sans-serif;">Minor number</td>
</tr>
<tr>
<td>MAJOR_NUMBER</td>
<td>15:8</td>
<td>c</td>
<td></td>
<td>0x00</td>
<td style="font-family: Helvetica, Arial, sans-serif;">Major number</td>
</tr>
<tr>
<td style="border-bottom: 2px solid #80c0c0">RESERVED</td>
<td style="border-bottom: 2px solid #80c0c0">31:16</td>
<td style="border-bottom: 2px solid #80c0c0">rsv</td>
<td style="border-bottom: 2px solid #80c0c0"></td>
<td style="border-bottom: 2px solid #80c0c0">0</td>
<td style="font-family: Helvetica, Arial, sans-serif;border-bottom: 2px solid #80c0c0">Reserved bits</td>
</tr>
<tr>
<td style="border-bottom: 2px solid #80c0c0">CSR_GENERIC_VERSIONING_FW_VER_ZERO</td>
<td style="border-bottom: 2px solid #80c0c0">0x8</td>
<td style="border-bottom: 2px solid #80c0c0"> </td>
<td style="border-bottom: 2px solid #80c0c0">16</td>
<td style="border-bottom: 2px solid #80c0c0">c</td>
<td style="border-bottom: 2px solid #80c0c0"> </td>
<td style="border-bottom: 2px solid #80c0c0">1</td>
<td style="font-family: Helvetica, Arial, sans-serif;border-bottom: 2px solid #80c0c0">Firmware version zeroth number (default overridden in Jenkins build)</td>
</tr>
<tr>
<td style="border-bottom: 2px solid #80c0c0">CSR_GENERIC_VERSIONING_FW_VER_ONE</td>
<td style="border-bottom: 2px solid #80c0c0">0xc</td>
<td style="border-bottom: 2px solid #80c0c0"> </td>
<td style="border-bottom: 2px solid #80c0c0">16</td>
<td style="border-bottom: 2px solid #80c0c0">c</td>
<td style="border-bottom: 2px solid #80c0c0"> </td>
<td style="border-bottom: 2px solid #80c0c0">20000</td>
<td style="font-family: Helvetica, Arial, sans-serif;border-bottom: 2px solid #80c0c0">Firmware version first number (default overridden in Jenkins build)</td>
</tr>
<tr>
<td style="border-bottom: 2px solid #80c0c0">CSR_GENERIC_VERSIONING_FW_VER_TWO</td>
<td style="border-bottom: 2px solid #80c0c0">0x10</td>
<td style="border-bottom: 2px solid #80c0c0"> </td>
<td style="border-bottom: 2px solid #80c0c0">16</td>
<td style="border-bottom: 2px solid #80c0c0">c</td>
<td style="border-bottom: 2px solid #80c0c0"> </td>
<td style="border-bottom: 2px solid #80c0c0">0</td>
<td style="font-family: Helvetica, Arial, sans-serif;border-bottom: 2px solid #80c0c0">Firmware version second number (default overridden in Jenkins build)</td>
</tr>
<tr>
<td>CSR_GENERIC_VERSIONING_FW_VER_THREE</td>
<td>0x14</td>
<td> </td>
<td>16</td>
<td>c</td>
<td> </td>
<td>0</td>
<td style="font-family: Helvetica, Arial, sans-serif;">Firmware version third number (default overridden in Jenkins build)</td>
</tr>
</table>
<p style="margin-left:20px"><i>Register/field type key:</i></p>
<table id="key" style="margin-left:30px">
<tr>
<th>Type</th><th>Description</th>
</tr>
<tr>
<td>c</td><td>Constant, with value defined by "reset" attribute
</tr>
<tr>
<td>rsv</td><td>Same as constant, except no reset value and always 0. Can be mixed with write types.</td>
</tr>
<tr>
<td>w</td><td>Write register (and read<61>no write only type). Register defined in register block and reset to "reset" attribute value. Split into fields (if applicable) for signalling and output, where attribute associated with fields, not register.</td>
</tr>
<tr>
<td>wp</td><td>Write with pulse. Register is not declared in block, but write bus split into fields as output port signals, and a pulse generated on write to register address. Register reads back 0. The "reset" attribute is for documentation only, as set externally.</td>
</tr>
<tr>
<td>w0</td><td>Same as w, but auto-clears to 0 (and thus always reads as 0). At output port, signal will go high for one cycle when bit is written with a 1 (no effect if written to a 0). No "reset" attribute, as must always be 0.</td>
</tr>
<tr>
<td>r</td><td>Read only value. Input ports generated for each field (where applicable), and concatenated on returned read data bus.</td>
</tr>
<tr>
<td>rp</td><td>Similar to r, but a pulse generated on a read access to the register address to allow peripheral logic to update value. The "reset" attribute is for documentation only, as set externally.</td>
</tr>
<tr>
<td>rwp</td><td>Similar to wp, but also generates a (separate) pulse on a read access to the register</td>
</tr>
<tr>
<td>bitdef</td><td>Defines the bits used in the read, set, clear registers</td>
</tr>
<tr>
<td>&nbsp;</td><td>&nbsp;</td>
</tr>
<tr>
<th>Subype</th><th>Description</th>
</tr>
<tr>
<td>unsigned</td><td>Register/field is specified as an unsigned value.
</td></tr>
<tr>
<td>signed</td><td>Register/field is specified as a signed value.
</td></tr>
<tr>
<td><i>&lt;blank&gt;</i?</td><td>Register/field sign status is not explicitly defined and defaults to unsigned.
</td></tr>
</table>
<h2>Usage Notes</b></h2>
<div style="width:800px">
<p style="margin-left:30px">
NB: this block is a key component that is parsed externally, and cannot be renamed with major number tags in order to be processed correctly. Therefore do not modify the source code for this block. If a change is required for a project then a whole new component will be necessary and this signed off in review by the embedded logic line manager.
</p>
</div>
<p>&nbsp;</p><hr>
<p style="font-style:italic">Copyright &copy; 2024 Global Inkjet Systems. Generated by gen_htm.py &mdash;2024-10-30 09:43</p>
</body>
</html>