Skip to content

V
VME64x core
Commit b7033b1e authored by Tristan Gingold's avatar Tristan Gingold
Browse files
Options

Fix doc (now as asciidoc).

parent a8ed0135
Hide whitespace changes
Inline Side-by-side
Showing with 414 additions and 215 deletions
doc/Makefile 0 → 100644
View file @ b7033b1e
all: vme64x_core-ug.pdf
vme64x_core-ug.xml: vme64x_core-ug.txt
asciidoc -v -d book -b docbook vme64x_core-ug.txt
vme64x_core-ug.pdf: vme64x_core-ug.xml
a2x -f pdf vme64x_core-ug.xml
clean:
$(RM) vme64x_core-ug.xml vme64x_core-ug.pdf
doc/core.fig 0 → 100644
View file @ b7033b1e
#FIG 3.2 Produced by xfig version 3.2.5c
Landscape
Center
Metric
A4
100.00
Single
-2
1200 2
2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5
2475 3375 9900 3375 9900 8100 2475 8100 2475 3375
2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5
2250 4050 3375 4050 3375 7875 2250 7875 2250 4050
2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5
10125 4050 9000 4050 9000 7875 10125 7875 10125 4050
2 1 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 9
3600 4050 3600 7875 8775 7875 8775 5400 7650 5400 7650 6750
4275 6750 4275 4050 3600 4050
2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5
4500 5850 6750 5850 6750 6525 4500 6525 4500 5850
2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5
4500 4050 7200 4050 7200 4725 4500 4725 4500 4050
2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5
4500 4950 7200 4950 7200 5625 4500 5625 4500 4950
2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5
7650 4050 8775 4050 8775 5175 7650 5175 7650 4050
4 0 0 50 -1 0 24 0.0000 4 270 2340 4950 3825 VME64xCore\001
4 0 0 50 -1 0 22 1.5708 4 240 1980 2925 6975 VME64x Bus\001
4 0 0 50 -1 0 22 1.5708 4 240 2115 9675 6750 Wishbone Bus\001
4 0 0 50 -1 0 22 0.0000 4 315 420 8100 4725 Irq\001
4 0 0 50 -1 0 22 0.0000 4 315 1710 4950 4500 cr/csr space\001
4 0 0 50 -1 0 22 0.0000 4 240 1635 4950 5400 func match\001
4 0 0 50 -1 0 22 0.0000 4 165 975 4950 6300 user cr\001
4 0 0 50 -1 0 22 0.0000 4 315 2340 4950 7425 vme_bus (FSM)\001
doc/core.svg 0 → 100644
View file @ b7033b1e
<?xml version="1.0" standalone="no"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
"http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<!-- Creator: fig2dev Version 3.2 Patchlevel 5d -->
<!-- CreationDate: Thu Dec 14 10:40:14 2017 -->
<!-- Magnification: 1.050 -->
<svg xmlns="http://www.w3.org/2000/svg"
xmlns:xlink="http://www.w3.org/1999/xlink"
width="6.9in" height="4.2in"
viewBox="2349 3530 8292 4985">
<g style="stroke-width:.025in; fill:none">
<!-- Line: box -->
<rect x="2598" y="3543" width="7795" height="4960" rx="0"
style="stroke:#000000;stroke-width:8;
stroke-linejoin:miter; stroke-linecap:butt;
"/>
<!-- Line: box -->
<rect x="2362" y="4251" width="1181" height="4015" rx="0"
style="stroke:#000000;stroke-width:8;
stroke-linejoin:miter; stroke-linecap:butt;
"/>
<!-- Line: box -->
<rect x="9448" y="4251" width="1181" height="4015" rx="0"
style="stroke:#000000;stroke-width:8;
stroke-linejoin:miter; stroke-linecap:butt;
"/>
<!-- Line -->
<polyline points="3779,4251
3779,8267
9212,8267
9212,5669
8031,5669
8031,7086
4488,7086
4488,4251
3779,4251
" style="stroke:#000000;stroke-width:8;
stroke-linejoin:miter; stroke-linecap:butt;
"/>
<!-- Line: box -->
<rect x="4724" y="6141" width="2362" height="708" rx="0"
style="stroke:#000000;stroke-width:8;
stroke-linejoin:miter; stroke-linecap:butt;
"/>
<!-- Line: box -->
<rect x="4724" y="4251" width="2834" height="708" rx="0"
style="stroke:#000000;stroke-width:8;
stroke-linejoin:miter; stroke-linecap:butt;
"/>
<!-- Line: box -->
<rect x="4724" y="5196" width="2834" height="708" rx="0"
style="stroke:#000000;stroke-width:8;
stroke-linejoin:miter; stroke-linecap:butt;
"/>
<!-- Line: box -->
<rect x="8031" y="4251" width="1181" height="1181" rx="0"
style="stroke:#000000;stroke-width:8;
stroke-linejoin:miter; stroke-linecap:butt;
"/>
<!-- Text -->
<text xml:space="preserve" x="5196" y="4015" fill="#000000" font-family="Times" font-style="normal" font-weight="normal" font-size="303" text-anchor="start">VME64xCore</text>
<!-- Text -->
<g transform="translate(3070,7322) rotate(-90.00021046)" >
<text xml:space="preserve" x="0" y="0" fill="#000000" font-family="Times" font-style="normal" font-weight="normal" font-size="278" text-anchor="start">VME64x Bus</text>
</g><!-- Text -->
<g transform="translate(10157,7086) rotate(-90.00021046)" >
<text xml:space="preserve" x="0" y="0" fill="#000000" font-family="Times" font-style="normal" font-weight="normal" font-size="278" text-anchor="start">Wishbone Bus</text>
</g><!-- Text -->
<text xml:space="preserve" x="8503" y="4960" fill="#000000" font-family="Times" font-style="normal" font-weight="normal" font-size="278" text-anchor="start">Irq</text>
<!-- Text -->
<text xml:space="preserve" x="5196" y="4724" fill="#000000" font-family="Times" font-style="normal" font-weight="normal" font-size="278" text-anchor="start">cr/csr space</text>
<!-- Text -->
<text xml:space="preserve" x="5196" y="5669" fill="#000000" font-family="Times" font-style="normal" font-weight="normal" font-size="278" text-anchor="start">func match</text>
<!-- Text -->
<text xml:space="preserve" x="5196" y="6614" fill="#000000" font-family="Times" font-style="normal" font-weight="normal" font-size="278" text-anchor="start">user cr</text>
<!-- Text -->
<text xml:space="preserve" x="5196" y="7795" fill="#000000" font-family="Times" font-style="normal" font-weight="normal" font-size="278" text-anchor="start">vme_bus (FSM)</text>
</g>
</svg>
doc/vme64x_core-ug.md → doc/vme64x_core-ug.txt
View file @ b7033b1e
# VME64x to WB core User Guide VME64x to WB core User Guide
============================
:Author: Tristan Gingold
:Date: 2017-12-12
:Revision: 2.0
Introduction
------------
This core implements a VME64x slave - WB master bridge. This core implements a VME64x slave - WB master bridge.
## Introduction The design can be downloaded from https://www.ohwr.org/projects/vme64x-core
The vme64x core conforms to the standards defined by ANSI/VITA VME64 The vme64x core conforms to the standards defined by ANSI/VITA VME64 <<1>>
and VME64x. In particular this core is provided with the "plug and and VME64x <<2>>. In particular this core is provided with the "plug and
play" capability. It means that in the vme64x core you can find a play" capability. It means that in the vme64x core you can find a
CR/CSR space whose base address is set automatically with the CR/CSR space whose base address is set automatically with the
geographical address lines and does not need to be set by jumpers or geographical address lines and does not need to be set by jumpers or
...@@ -20,18 +27,25 @@ controller with one interrupt input and a programmable interrupt level ...@@ -20,18 +27,25 @@ controller with one interrupt input and a programmable interrupt level
and Status/ID register are provided optionally and can be enabled at and Status/ID register are provided optionally and can be enabled at
instantiation. instantiation.
Since the vme64x core acts as a Wishbone (WB) master in the WB side, the WB Since the vme64x core acts as a Wishbone (WB) master in the WB side,
pipelined single read/write transfer is provided by the the WB pipelined single read/write transfer is provided by the
core. This functionality conforms the Wishbone B4 standard. core. This functionality conforms the Wishbone B4 standard <<3>>.
.Block schema
image::core.svg[scaledwidth="70%"]
## Features Features
--------
### VME interface VME interface
~~~~~~~~~~~~~
This section lists which VME features are supported and which are not This section lists which VME features are supported and which are not
supported by the core. supported by the core.
#### Supported: Supported:
^^^^^^^^^^
* D08(EO), D16, D32 * D08(EO), D16, D32
* Addressing mode: A16, A24, A32 * Addressing mode: A16, A24, A32
* BLT, MBLT * BLT, MBLT
...@@ -39,7 +53,9 @@ supported by the core. ...@@ -39,7 +53,9 @@ supported by the core.
* CR/CSR space with extensions from VME64x * CR/CSR space with extensions from VME64x
* Geographic Address (GA), dynamic configuration (ader). * Geographic Address (GA), dynamic configuration (ader).
#### Not supported: Not supported:
^^^^^^^^^^^^^^
* 2eVME * 2eVME
* 2eSST * 2eSST
* Dynamic size (DFSR, DFS) * Dynamic size (DFSR, DFS)
...@@ -55,43 +71,50 @@ supported by the core. ...@@ -55,43 +71,50 @@ supported by the core.
* D08, D16 for BLT * D08, D16 for BLT
* RETRY (cf rule 2.91 - incompatibility with WB) * RETRY (cf rule 2.91 - incompatibility with WB)
#### Deviations Deviations
* Not compatible with non-VME64x crates (doesn't support jumpers to set ^^^^^^^^^^
the GA).
* The reset bit in the Bit Set Register is automatically cleared at the next * Not compatible with non-VME64x crates (doesn't support jumpers to
access. set the GA).
* Automatically repeat interrupts every 1 ms if the source is always active. * The reset bit in the Bit Set Register is automatically cleared at the
next access.
### WB interface * Automatically repeat interrupts every 1 ms if the source is always
active.
This section corresponds to the datasheet required by the WB specification.
WB interface
1. Compliant to Wishbone B4 specifications ~~~~~~~~~~~~
2. Slave
3. Signals name follows the specification This section corresponds to the datasheet required by the WB
4. err_i is forwarded to VME as BERR* specification <<3>>.
5. rty_i is not supported
6. no TAGs 1. Compliant to Wishbone B4 specifications
7. Port size is 32 bit 2. Slave
8. Port granularity is 8 bit 3. Signals name follows the specification
9. Maximum operand size is 8 bit (TBC) 4. err_i is forwarded to VME as BERR*
5. rty_i is not supported
6. no TAGs
7. Port size is 32 bit
8. Port granularity is 8 bit
9. Maximum operand size is 8 bit (TBC)
10. Data transfer ordering is BIG ENDIAN 10. Data transfer ordering is BIG ENDIAN
11. Sequence of data transfer is defined by the VME side 11. Sequence of data transfer is defined by the VME side
12. No CLK_I signal, clock is provided separately. 12. No CLK_I signal, clock is provided separately.
* Non pipeline behaviour (but compatible with pipeline). The core doesn't take * Non pipeline behaviour (but compatible with pipeline). The core
any advantage of the pipeline behaviour, as the WB bus is much faster than doesn't take any advantage of the pipeline behaviour, as the WB bus is
the VME bus. much faster than the VME bus.
### CR/CSR space [[crcsr-space]]
CR/CSR space
~~~~~~~~~~~~
To provide a “plug and play” capability, CR/CSR space is implemented as To provide a “plug and play” capability, CR/CSR space is implemented
defined by ANSI/VITA Standards for VME64 Extensions [2]. as defined by ANSI/VITA Standards for VME64 Extensions.
A dedicated “Configuration ROM / Control & Status Register” (CR/CSR) A dedicated “Configuration ROM / Control & Status Register” (CR/CSR)
address space is provided by the core. It consists of ROM and RAM regions address space is provided by the core. It consists of ROM and RAM
with a set of well-defined registers. It is addressed with the address regions with a set of well-defined registers. It is addressed with the
modifier 0x2F in the A24 address space. address modifier 0x2F in the A24 address space.
Every VME module occupies a 512 kB page in this address space. The Every VME module occupies a 512 kB page in this address space. The
location of this page in the A24 space is defined by geographical location of this page in the A24 space is defined by geographical
...@@ -104,7 +127,8 @@ match), the base address is set to 0x00, which indicates a faulty ...@@ -104,7 +127,8 @@ match), the base address is set to 0x00, which indicates a faulty
condition. An odd parity is used. condition. An odd parity is used.
If the board is plugged into an old crate that doesn't provide the GA If the board is plugged into an old crate that doesn't provide the GA
lines, the CR/CSR space cannot be accessed and therefore the core remains lines, the CR/CSR space cannot be accessed and therefore the core
remains
disabled. disabled.
The CR/CSR space can be accessed with the data width D08(EO), D16 The CR/CSR space can be accessed with the data width D08(EO), D16
...@@ -126,32 +150,40 @@ configuration space) are reserved in the CR region. Designers are free ...@@ -126,32 +150,40 @@ configuration space) are reserved in the CR region. Designers are free
to use these regions for module specific purposes. to use these regions for module specific purposes.
By default the size of the CRAM space is 0, which means it is disabled By default the size of the CRAM space is 0, which means it is disabled
and doesn't use any resources. User can define the address range of and doesn't use any resources. User can define the address range of
CRAM in order to generate a programmable area. CRAM in order to generate a programmable area.
All the registers in the CSR space have been implemented as defined by All the registers in the CSR space have been implemented as defined by
the VME64 Extensions. the VME64 Extensions.
Start Address | End Address | Content .CSR Address Space
------- | ----------- | ------------------------------ [cols=",,",options="header",]
0x7ff60 | 0x7ffff | CSR (Control Status Registers) |=====================================================
0x7fc00 | 0x7ff5f | Reserved for CSR | Start Address | End Address | Content
BEG_USER_CSR | END_USER_CSR | User defined CSR (option) | 0x7ff60 | 0x7ffff | CSR (Control Status Registers)
BEG_CRAM | END_CRAM | User defined CRAM (option) | 0x7fc00 | 0x7ff5f | Reserved for CSR
BEG_USER_CR | END_USER_CR | User defined CR (option) | BEG_USER_CSR | END_USER_CSR | User defined CSR (option)
0x00000 | 0x00fff | CR (Configuration ROM) | BEG_CRAM | END_CRAM | User defined CRAM (option)
| BEG_USER_CR | END_USER_CR | User defined CR (option)
| 0x00000 | 0x00fff | CR (Configuration ROM)
|=====================================================
In addition to the standard registers in the CSR space and for In addition to the standard registers in the CSR space and for
compatibility with existing drivers for previous version of the core, compatibility with existing drivers for previous version of the core,
the VME64x defines by default a user CSR space (within the CSR space the VME64x defines by default a user CSR space (within the CSR space
reserved by the VME64x standard) with the following registers: reserved by the VME64x standard) with the following registers:
Address | Content | Reset value .Default User CSR Space
--------| ---------- | ----------- [cols=",,",options="header",]
0x7ff5f | IRQ vector | 0x00 |=============================
0x7ff5b | IRQ level | 0x00 |Address |Content |Reset value
|0x7ff5f |IRQ vector |0x00
|0x7ff5b |IRQ level |0x00
|=============================
### Interrupt controller [[interrupt-controller]]
Interrupt controller
~~~~~~~~~~~~~~~~~~~~
The interrupt controller implemented is a ROAK (Release On The interrupt controller implemented is a ROAK (Release On
Acknowledge) type controller. It means that the Interrupter releases Acknowledge) type controller. It means that the Interrupter releases
...@@ -159,7 +191,7 @@ the interrupt request lines when it acknowledges the interrupt cycle. ...@@ -159,7 +191,7 @@ the interrupt request lines when it acknowledges the interrupt cycle.
Upon synchronously detecting a rising edge on the interrupt request Upon synchronously detecting a rising edge on the interrupt request
signal input on the WB bus, the VME64x core drives the IRQ request signal input on the WB bus, the VME64x core drives the IRQ request
line on the VME bus low thus issuing an interrupt request. The VME line on the VME bus low thus issuing an interrupt request. The VME
master acknowledges the interrupt in the form of an IACK cycle. During master acknowledges the interrupt in the form of an IACK cycle. During
the IACK cycle the vme64x core sends the IRQ_Vector to the the IACK cycle the vme64x core sends the IRQ_Vector to the
master. After the interrupt is acknowledged, the VME IRQ line is master. After the interrupt is acknowledged, the VME IRQ line is
released. released.
...@@ -172,144 +204,153 @@ space. The value of this register corresponds to the number of the IRQ ...@@ -172,144 +204,153 @@ space. The value of this register corresponds to the number of the IRQ
line on the VME bus that is to be used (note that on the VME master line on the VME bus that is to be used (note that on the VME master
side priorities are taken into account, IRQ7 having the highest side priorities are taken into account, IRQ7 having the highest
priority and IRQ1 the lowest). If the IRQ level register is set to priority and IRQ1 the lowest). If the IRQ level register is set to
0x00, interrupts are disabled. In the default power-up and reset 0x00, interrupts are disabled. In the default power-up and reset
configuration the interrupts are disabled. configuration the interrupts are disabled.
There is a non-standard mechanism to retrigger unhandled interrupts. There is a non-standard mechanism to retrigger unhandled interrupts.
Once an interrupt is asserted by the WB slave, the interrupt is marked Once an interrupt is asserted by the WB slave, the interrupt is marked
as pending and the interrupt request that it is relayed on the VME bus. as pending and the interrupt request that it is relayed on the VME
The OS and the driver has to acknowledge the interrupt and to act on the bus.
The OS and the driver has to acknowledge the interrupt and to act on
the
hardware so that the WB slave doesn't request anymore OS attention. hardware so that the WB slave doesn't request anymore OS attention.
If the OS acknowledge the interrupt but doesn't acknowledge the request, the If the OS acknowledge the interrupt but doesn't acknowledge the request,
the
VME64x Core will relay again the interrupt on the VME bus after 1ms. VME64x Core will relay again the interrupt on the VME bus after 1ms.
## References [[vme64x-core-instantiation]]
VME64x Core Instantiation
The specifications used for this core are: -------------------------
* VME64 ANSI/VITA 1-1994 (Stabilized Maintenance 2011)
* VME64 Extensions ANSI/VITA 1.1-1997 (Stabilized Maintenance 2011)
* Wishbone System-on-chip (SoC) Interconnection Architecture for
Portable IP Cores, Revision B4
## VME64x Core Instantiation
There are two top-level entities: There are two top-level entities:
* The `xvme64x_core` that is the main top-level entity. It uses records
* The `xvme64x_core` that is the main top-level entity. It uses
records
for the `g_DECODER` generic, VME and WB buses in order to simplify the for the `g_DECODER` generic, VME and WB buses in order to simplify the
connections. connections.
* The `vme64x_core` that is a wrapper of `xvme64x_core` which allows * The `vme64x_core` that is a wrapper of `xvme64x_core` which allows
interfacing with verilog code. interfacing with verilog code.
### Generics [[generics]]
Generics
~~~~~~~~
Generic `g_CLOCK_PERIOD` defines the clock priod in ns. This generic Generic `g_CLOCK_PERIOD` defines the clock priod in ns. This generic
must be set by the user and is used for synchronization of the VME DS signal. must be set by the user and is used for synchronization of the VME DS
signal.
Generic `g_DECODE_AM` enables/disables the AM field of ADER when decoding Generic `g_DECODE_AM` enables/disables the AM field of ADER when
decoding
address. When it is set to false, behavior of this core is consistent address. When it is set to false, behavior of this core is consistent
with its previous versions. In particlular, when false, the AM field with its previous versions. In particlular, when false, the AM field
of ADER is not used when decoding address, so the core will recognize of ADER is not used when decoding address, so the core will recognize
any access allowed by the corresponding AMCAP. New designs should set this any access allowed by the corresponding AMCAP. New designs should set
this
generic to true. generic to true.
Generic `g_USER_CSR_EXT` enables/disables user-defined CSR. The Generic `g_USER_CSR_EXT` enables/disables user-defined CSR. The
interface with the user CSR is a very simple synchronous SRAM (signals interface with the user CSR is a very simple synchronous SRAM (signals
`user_csr_addr_o`, `user_csr_data_i`, `user_csr_data_o` and `user_csr_addr_o`, `user_csr_data_i`, `user_csr_data_o` and
`user_csr_we_o`). In addition, if user-defined CSR is enabled, the `user_csr_we_o`). In addition, if user-defined CSR is enabled, the
input port `irq_level_i` and `irq_vector_i` are used by the interrupt input port `irq_level_i` and `irq_vector_i` are used by the interrupt
controller to define the irq level and vector (otherwise they are read controller to define the irq level and vector (otherwise they are read
from the default user CSR registers). from the default user CSR registers).
The other generics define values in the CSR. The package `vme64x_pkg` The other generics define values in the CSR. The package `vme64x_pkg`
defines default constants for these values, see the VME64x specification for defines default constants for these values, see the VME64x specification
for
details about these values: details about these values:
* `g_MANUFACTURER_ID` provides the manufacturer ID, * `g_MANUFACTURER_ID` provides the manufacturer ID,
* `g_BOARD_ID` provides the board ID, * `g_BOARD_ID` provides the board ID,
* `g_REVISION_ID` provides the revision ID, * `g_REVISION_ID` provides the revision ID,
* `g_PROGRAM_ID` provides the type of code in CR, * `g_PROGRAM_ID` provides the type of code in CR,
* `g_ASCII_PTR` provides the pointer to the user defined ASCII string in CR, * `g_ASCII_PTR` provides the pointer to the user defined ASCII string in
* `g_BEG_USER_CR` and `g_END_USER_CR` provides the range of the user defined CR CR,
area. If the range is not null, ports `user_cr_addr_o` and `user_cr_data_i` * `g_BEG_USER_CR` and `g_END_USER_CR` provides the range of the user
must be connected to a ROM. defined CR
* `g_BEG_CRAM` and `g_END_CRAM` provide the range of user CRAM. If the range is area. If the range is not null, ports `user_cr_addr_o` and
not null, the core instantiates an SRAM. `user_cr_data_i`
* `g_BEG_USER_CSR` and `g_END_USER_CSR` provide the range of the user defined must be connected to a ROM.
CSR. See above the description of `g_USER_CSR_EXT`. * `g_BEG_CRAM` and `g_END_CRAM` provide the range of user CRAM. If the
* `g_BEG_SN` and `g_END_SN` provides the area in CR of the serial number. range is
* `g_DECODER` describes the 8 function decoder. Each decoder is described by not null, the core instantiates an SRAM.
the following bits (see VME64x specification for details): * `g_BEG_USER_CSR` and `g_END_USER_CSR` provide the range of the user
* `adem` bits 8 to 31: address mask defined
* `adem` bits 0 to 7: must be set to 0 CSR. See above the description of `g_USER_CSR_EXT`.
* `amcap`: address modifier supported by the decoder. Only bits 0x08 to * `g_BEG_SN` and `g_END_SN` provides the area in CR of the serial
0x0f and 0x38 to 0x3f can be set to 1. number.
* `dawpr`: data access width (ignored by the decoder). * `g_DECODER` describes the 8 function decoder. Each decoder is
Note that setting `adem` to 0 disable the decoder. If disabled decoders, described by
the following bits (see VME64x specification for details):
* `adem` bits 8 to 31: address mask
* `adem` bits 0 to 7: must be set to 0
* `amcap`: address modifier supported by the decoder. Only bits 0x08
to
0x0f and 0x38 to 0x3f can be set to 1.
* `dawpr`: data access width (ignored by the decoder).
Note that setting `adem` to 0 disable the decoder. If disabled
decoders,
they don't use any hardware resources. they don't use any hardware resources.
### Ports [[ports]]
Ports
~~~~~
* `clk_i` is the clock signal, and the clock of the WB bus. Note that * `clk_i` is the clock signal, and the clock of the WB bus. Note that
the `g_CLOCK_PERIOD` generic must be set according to the `clk_i` the `g_CLOCK_PERIOD` generic must be set according to the `clk_i`
frequency to get correct timing for the VME `DS` signals. The VME `DTACK` frequency to get correct timing for the VME `DS` signals. The VME `DTACK`
and `BERR` signals are supposed to be released at most 30ns after `DS` is and `BERR` signals are supposed to be released at most 30ns after `DS`
released; as the design needs 4 closk to release them (due to synchronizer), is released; as the design needs 4 closk to release them (due to
this means the minimal frequency is supposed to be 133Mhz. In practice, VME synchronizer), this means the minimal frequency is supposed to be 133Mhz.
masters are much more tolerant. In practice, VME masters are much more tolerant.
* `rst_n_i` is the reset signal. It could be considered as a power-on
* `rst_n_i` is the reset signal. It could be considered as a power-on reset reset and is synchronous.
and is synchronous. * `rst_n_o` is the reset signal to the wishbone core. It is asserted in
case of reset on the VME bus, or if the module reset bit is set in the CSR,
* `rst_n_o` is the reset signal to the wishbone core. It is asserted in case or if the `rst_n_i` signal is asserted.
of reset on the VME bus, or if the module reset bit is set in the CSR, or * `vme_i` and `vme_o` are signals for the VME bus. Refer to the VME64
if the `rst_n_i` signal is asserted. standard for details.
* `wb_i` and `wb_o` are the signals for the WB bus. Refer to the WB
* `vme_i` and `vme_o` are signals for the VME bus. Refer to the VME64 specification for details. Note that the WB `rty` (retry) signal cannot
standard for details. be used, as the VME BLT transactions can only be retried during the
address phase and this restriction is not exposed to the WB side. The WB err
* `wb_i` and `wb_o` are the signals for the WB bus. Refer to the WB signal is forwarded to the VME bus as BERR. The address on the WB bus
specification for details. Note that the WB `rty` (retry) signal cannot corresponds to the lower bits of the address on the VME bus (bits used to
be used, as the VME BLT transactions can only be retried during the address decode the address are cleared on the WB bus).
phase and this restriction is not exposed to the WB side. The WB err signal
is forwarded to the VME bus as BERR. The address on the WB bus corresponds
to the lower bits of the address on the VME bus (bits used to decode the
address are cleared on the WB bus).
* `irq_ack_o` signal is asserted during one cycle when the VME64x Core * `irq_ack_o` signal is asserted during one cycle when the VME64x Core
acknowledge the interrupt on the VME bus. This signal could be used by the acknowledge the interrupt on the VME bus. This signal could be used by
slave interrupt controller. the slave interrupt controller.
The following signals are used only when the `g_USER_CSR_EXT` generic is The following signals are used only when the `g_USER_CSR_EXT` generic
set to true: is set to true:
* `irq_level_i` defines which VME IRQ signal is asserted by the VME64x Core * `irq_level_i` defines which VME IRQ signal is asserted by the VME64x
to send an interrupt to the VME bus. If set to 0, interrupts are never sent. Core to send an interrupt to the VME bus. If set to 0, interrupts are never
The level corresponds to the interrupt priority on the VME bus, 7 is the sent. The level corresponds to the interrupt priority on the VME bus, 7 is
highest priority and 1 the lowest. The value shouldn't change while an the highest priority and 1 the lowest. The value shouldn't change while
interrupt is pending. an interrupt is pending.
* `irq_vector_i` is the vector sent on the VME bus by the core during
* `irq_vector_i` is the vector sent on the VME bus by the core during an an acknowledge cycle.
acknowledge cycle.
* `user_csr_addr_o`, `user_csr_data_i`, `user_csr_data_o`, `user_csr_we_o` * `user_csr_addr_o`, `user_csr_data_i`, `user_csr_data_o`, `user_csr_we_o`
define an interface to an external SRAM containing the user CSR values. For define an interface to an external SRAM containing the user CSR values.
read cycles, the data value must be stable on the next cycle. For read cycles, the data value must be stable on the next cycle.
The following signals are used when a user CR area is defined (i.e. the The following signals are used when a user CR area is defined (i.e.
range defined by `g_BEG_USER_CR` and `g_END_USER_CR` is not null): the range defined by `g_BEG_USER_CR` and `g_END_USER_CR` is not null):
* `user_cr_addr_o`, `user_cr_data_i` define an interface to an external ROM * `user_cr_addr_o`, `user_cr_data_i` define an interface to an external
containing the user CR values. Data must be stable on the next cycle. ROM containing the user CR values. Data must be stable on the next cycle.
Note that the `vme` ports are designed to be connected to VME bus transceivers Note that the `vme` ports are designed to be connected to VME bus
like SN74VMEH2250. In the particular case of the CERN SVEC card, the signals transceivers like SN74VMEH2250. In the particular case of the CERN
`berr` and `irq` are inverted by the transceivers, so a `not` gate must be SVEC card, the signals `berr` and `irq` are inverted by the
inserted in the FPGA. You can refer to the `svec_vmecore_test_top.vhd` file transceivers, so a `not` gate must be inserted in the FPGA. You can
in the svec repository for an example. refer to the `svec_vmecore_test_top.vhd` file in the svec repository
(https://www.ohwr.org/projects/svec) for an example.
## Programing the VME64x Core Programming the VME64x Core
---------------------------
After power-up or reset, the VME core is disabled (as the After power-up or reset, the VME core is disabled (as the
`module_enable` bit is cleared) and therefore only the CS/CSR space `module_enable` bit is cleared) and therefore only the CS/CSR space
...@@ -317,49 +358,62 @@ can be accessed. Software must then first map the module memory in the ...@@ -317,49 +358,62 @@ can be accessed. Software must then first map the module memory in the
address space by setting the Address Decoder Compare (ADER) address space by setting the Address Decoder Compare (ADER)
registers in CSR, which, together with Address Decoder Mask (ADEM) registers in CSR, which, together with Address Decoder Mask (ADEM)
registers in the CR relocate the module memory to the desired address registers in the CR relocate the module memory to the desired address
range. ADER for each function must also contains the AM code to range. ADER for each function must also contains the AM code to
which it responds. After the module has been placed in the desired which it responds. After the module has been placed in the desired
address space, it can be enabled by writing 0x10 (`module_enable`) to address space, it can be enabled by writing 0x10 (`module_enable`) to
the Bit Set Register i the CSR. the Bit Set Register in the CSR.
If the master needs to access to the slave using different address
space (e.g. both A32 and A24), or different transaction (e.g. both
single and BLT), several function decoders must be used.
If the master needs to access to the slave using different address space (e.g. The base address is of the CR/CSR space is set by the geographical
both A32 and A24), or different transaction (e.g. both single and BLT), lines. If the core is used in an old VME system without GA lines, the
several function decoders must be used. core reads GA as "11111" which is invalid. As a consequence, the CS/CSR
is not accessible and the card cannot be enabled.
The base address is of the CR/CSR space is set by the geographical lines. It is possible to reset the card in software by setting the `reset`
If the core is used in an old VME system without GA lines, the core should bit in the Bit Set Register. Contrary to the VME64 specification (and
be provided with a logic that detects if GA = "11111", which is invalid. for backward compatibility with drivers and previous versions of the
core), this bit is automatically cleared during the next CSR write
access.
It is possible to reset the card in software by setting the `reset` bit in .Pseudo code
the Bit Set Register. Contrary to the VME64 specification (and for backward . Determine the geographical address of the card (e.g. bus scan)
compatibility with drivers and previous versions of the core), this bit . Optionally reset the card (through the Bit Set and Clear registers)
is automatically cleared during the next CSR write access. . Set ADERs
. Enable the card: Write 0x10 to the Bit Set Register
## Performance [[performance]]
Performance
-----------
The performance was measured with the `test_vme` program, available in The performance was measured with the `test_vme` program, available in
the svec repository. In the measurement setup, the master was the MEN A20 the svec repository. In the measurement setup, the master was the MEN
board and the VME64x Core frequency was 125Mhz. A20 board (https://www.men.de/products/discontinued-products/a20/) and
the VME64x Core frequency was 125Mhz.
A24 SCT DMA: A24 SCT DMA:
* Read Rate: 15.761240 MB/sec * Read Rate: 15.7 MB/sec
* Write Rate: 17.172745 MB/sec * Write Rate: 17.1 MB/sec
A24 BLT DMA: A24 BLT DMA:
* Read Rate: 12.472540 MB/sec * Read Rate: 12.4 MB/sec
* Write Rate: 12.932751 MB/sec * Write Rate: 12.9 MB/sec
A24 MBLT DMA: A24 MBLT DMA:
* Read Rate: 25.906049 MB/sec * Read Rate: 25.9 MB/sec
* Write Rate: 26.259754 MB/sec * Write Rate: 26.2 MB/sec
According to the simulation, the bad performances of BLT transfer is due to According to the simulation, the bad performances of BLT transfer is due
the master. to the master.
## Changes in V2 (compared to V1) [[changes-in-v2-compared-to-v1]]
Changes in V2 (compared to V1)
------------------------------
* Core is smaller (number of slices is less than 1000) * Core is smaller (number of slices is less than 1000)
* No retry * No retry
...@@ -368,11 +422,15 @@ the master. ...@@ -368,11 +422,15 @@ the master.
* Internal component declarations removed. * Internal component declarations removed.
* Async inputs registered with gc_sync_register. * Async inputs registered with gc_sync_register.
## Appendix: Implementation of the core [[appendix-implementation-of-the-core]]
Appendix: Implementation of the core
------------------------------------
This section describes the internal implementation of the VME64x core. This section describes the internal implementation of the VME64x core.
### xvme64x_core.vhd [[xvme64x_core.vhd]]
xvme64x_core.vhd
~~~~~~~~~~~~~~~~
The top module `xvme64x_core` instantiates the sub-modules and also The top module `xvme64x_core` instantiates the sub-modules and also
synchronizes the asynchronous VME signals (that need to be) to avoid synchronizes the asynchronous VME signals (that need to be) to avoid
...@@ -381,60 +439,69 @@ metastability problems. ...@@ -381,60 +439,69 @@ metastability problems.
This module also handles the `g_USER_CSR_EXT` generic and instantiates This module also handles the `g_USER_CSR_EXT` generic and instantiates
a default user CSR if the generic is set to false. a default user CSR if the generic is set to false.
### vme_bus.vhd [[vme_bus.vhd]]
vme_bus.vhd
~~~~~~~~~~~
This is the main module. It implements an FSM to handle the VME protocol, This is the main module. It implements an FSM to handle the VME
and acts as the interface between the VME bus and either the WB bus or the protocol, and acts as the interface between the VME bus and either the
CR/CSR memory. WB bus or the CR/CSR memory.
The module also handles the interrupt acknowledge. If IACK is asserted on The module also handles the interrupt acknowledge. If IACK is asserted
a falling edge of AS, the cycle is considered as an acknowledge cycle. The FSM on a falling edge of AS, the cycle is considered as an acknowledge
then waits until IACKIN is asserted (or until AS is deasserted). If an cycle. The FSM then waits until IACKIN is asserted (or until AS is
interrupt was pending at the right level when IACKIN is asserted, the VME64x deasserted). If an interrupt was pending at the right level when
Core responds to the acknowledge cycle with the interrupt vector; otherwise IACKIN is asserted, the VME64x Core responds to the acknowledge cycle
it asserts IACKOUT. with the interrupt vector; otherwise it asserts IACKOUT.
### vme_cr_csr_space.vhd [[vme_cr_csr_space.vhd]]
vme_cr_csr_space.vhd
~~~~~~~~~~~~~~~~~~~~
This module implements the CR and CSR spaces. It builds (during elaboration) This module implements the CR and CSR spaces. It builds (during
the CR memory from the generics value, handle accesses from the VME bus to elaboration) the CR memory from the generics value, handle accesses
these memories, interfaces with CRAM (if present), user CR (if present) from the VME bus to these memories, interfaces with CRAM (if present),
and user CSR (if present). user CR (if present) and user CSR (if present).
### vme_func_match.vhd [[vme_func_match.vhd]]
vme_func_match.vhd
~~~~~~~~~~~~~~~~~~
This module checks if the VME address+AM has to be handled by this VME This module checks if the VME address+AM has to be handled by this VME
slave according to ADER and decoder values. Gives back the slave according to ADER and decoder values. Gives back the
corresponding WB address. corresponding WB address.
### vme_user_csr.vhd [[vme_user_csr.vhd]]
vme_user_csr.vhd
~~~~~~~~~~~~~~~~
This module implements a default user CSR with the irq_level and irq_vector This module implements a default user CSR with the irq_level and
registers. irq_vector registers.
### vme_irq_controller.vhd [[vme_irq_controller.vhd]]
vme_irq_controller.vhd
~~~~~~~~~~~~~~~~~~~~~~
This module implements the interrupt controller. The interrupt cycle is: This module implements the interrupt controller. The interrupt cycle is:
1. The wishbone slave generates an pulse on the `int` line when it has to
interrupts the master
2. If no interrupt is pending and the retry mechanism is not started, this
module asserts (to 0) the corresponding VME IRQ line (as defined by
`irq_level`).
1. The wishbone slave generates an pulse on the `int` line when it has
to interrupts the master
2. If no interrupt is pending and the retry mechanism is not started,
this module asserts (to 0) the corresponding VME IRQ line (as defined by
`irq_level`).
3. When ack'ed, the interrupt is marked as not pending anymore. 3. When ack'ed, the interrupt is marked as not pending anymore.
4. If the interrupt request stays active for more than 1 cycle (therefore it 4. If the interrupt request stays active for more than 1 cycle (therefore it
isn't a pulse), a retry mechanism is started. The interrupt will be isn't a pulse), a retry mechanism is started. The interrupt will be
re-sent on the VME bus every 1ms as long as it is active. re-sent on the VME bus every 1ms as long as it is active.
## Appendix VME64 VITA-1 rules compliance Appendix VME64 VITA-1 rules compliance
--------------------------------------
This appendix lists all rules in the VME64 (in the textual appearance order), This appendix lists all rules in the VME64 (in the textual appearance
and specifies how it is followed. When the rule doesn't concern this core, order), and specifies how it is followed. When the rule doesn't
the reason is brievly indicated: 'Master' when the rule applies only to concern this core, the reason is brievly indicated: 'Master' when the
master modules, 'D64' or 'A64' for unsupported features. rule applies only to master modules, 'D64' or 'A64' for unsupported
features.
* 2.1a: Master * 2.1a: Master
* 2.69: Master * 2.69: Master
...@@ -477,7 +544,8 @@ master modules, 'D64' or 'A64' for unsupported features. ...@@ -477,7 +544,8 @@ master modules, 'D64' or 'A64' for unsupported features.
* 2.22: Master * 2.22: Master
* 2.23: Master * 2.23: Master
* 2.24: Master * 2.24: Master
* 2.25: Followed (DATA lines are all driven for read, MBLT not supported) * 2.25: Followed (DATA lines are all driven for read, MBLT not
supported)
* 2.26: Followed (Likewise) * 2.26: Followed (Likewise)
* 2.27: Master * 2.27: Master
* 2.28: Master * 2.28: Master
...@@ -525,9 +593,17 @@ master modules, 'D64' or 'A64' for unsupported features. ...@@ -525,9 +593,17 @@ master modules, 'D64' or 'A64' for unsupported features.
* 2.105: TBC (retry) * 2.105: TBC (retry)
* 2.59: Bus timer * 2.59: Bus timer
* 2.60: Bus timer * 2.60: Bus timer
* 3.x: Arbitration * 3.x: Arbitration
* 4.1: Backplace * 4.1: Backplace
* 4.50: Followed (slave can generate interrupt) * 4.50: Followed (slave can generate interrupt)
* 4.2 Followed * 4.2 Followed
External References
-------------------
Specifications used for this core
* [[1]]<<1>> VME64 ANSI/VITA 1-1994 (Stabilized Maintenance 2011)
* [[2]]<<2>> VME64 Extensions ANSI/VITA 1.1-1997 (Stabilized Maintenance 2011)
* [[3]]<<3>> Wishbone System-on-chip (SoC) Interconnection Architecture for
Portable IP Cores, Revision B4
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment