<html>
|
<html>
|
<title>
|
<title>
|
Memory Initialization
|
Memory Initialization
|
</title>
|
</title>
|
<body>
|
<body>
|
This file describes the contents of the memory intialization file and how to
|
This file describes the contents of the memory intialization file and how to
|
use it for various vendor-specific tools.
|
use it for various vendor-specific tools.
|
<h1>Format</h1>
|
<h1>Format</h1>
|
Each line of the file consists of a hex address into which the values are to
|
Each line of the file consists of a hex address into which the values are to
|
be stored and the corresponding value. For SSBCC.9x8 these are 9-bit
|
be stored and the corresponding value. For SSBCC.9x8 these are 9-bit
|
values.<br/><br/>
|
values.<br/><br/>
|
The format of each line is "<tt>@%04X %03X</tt>" where the 4-digit value is
|
The format of each line is "<tt>@%04X %03X</tt>" where the 4-digit value is
|
the hex memory address and the 3-digit hex value is the 9-bit memory
|
the hex memory address and the 3-digit hex value is the 9-bit memory
|
value.<br/><br/>
|
value.<br/><br/>
|
<h1>Xilinx <tt>data2mem</tt></h1>
|
<h1>Xilinx <tt>data2mem</tt></h1>
|
<tt>data2mem</tt> is a tool for modifying the block ram initialization
|
<tt>data2mem</tt> is a tool for modifying the block ram initialization
|
contents of bitstreams. Using this tool allows the micro controller assembly
|
contents of bitstreams. Using this tool allows the micro controller assembly
|
code to be modified in the bitstream without rerunning the entire build
|
code to be modified in the bitstream without rerunning the entire build
|
process.<br/><br/>
|
process.<br/><br/>
|
The following illustrates how to use <tt>data2mem</tt> using
|
The following illustrates how to use <tt>data2mem</tt> using
|
ISE 14.5:<br/><br/>
|
ISE 14.5:<br/><br/>
|
<ol>
|
<ol>
|
<li>Create a <tt>BMM</tt> file named "<tt>uc.bmm</tt>" for inclusion in the
|
<li>Create a <tt>BMM</tt> file named "<tt>uc.bmm</tt>" for inclusion in the
|
build process:<br/><br/>
|
build process:<br/><br/>
|
The file should look like the following. The text
|
The file should look like the following. The text
|
"<tt>top_inst/uc_inst</tt>" needs to be modified to point to your
|
"<tt>top_inst/uc_inst</tt>" needs to be modified to point to your
|
instantiation of the micro controller. Sometimes
|
instantiation of the micro controller. Sometimes
|
"<tt>uc_inst/Mram_s_opcodeMemory</tt>" becomes
|
"<tt>uc_inst/Mram_s_opcodeMemory</tt>" becomes
|
"<tt>uc_inst_Mram_s_opcodeMemory</tt>"<br/><br/>
|
"<tt>uc_inst_Mram_s_opcodeMemory</tt>"<br/><br/>
|
<tt>ADDRESS_SPACE uc RAMB18 WORD_ADDRESSING [0x0:0x7FF]<br/>
|
<tt>ADDRESS_SPACE uc RAMB18 WORD_ADDRESSING [0x0:0x7FF]<br/>
|
BUS_BLOCK<br/>
|
BUS_BLOCK<br/>
|
top_inst/uc_inst/Mram_s_opcodeMemory [0:8];<br/>
|
top_inst/uc_inst/Mram_s_opcodeMemory [0:8];<br/>
|
END_BUS_BLOCK;<br/>
|
END_BUS_BLOCK;<br/>
|
END_ADDRESS_SPACE;<br/></tt><br/>
|
END_ADDRESS_SPACE;<br/></tt><br/>
|
The following command can be used to verify the syntax of this <tt>BMM</tt>
|
The following command can be used to verify the syntax of this <tt>BMM</tt>
|
file:<br/><br/>
|
file:<br/><br/>
|
<tt> data2mem -bm uc_bmm<br/></tt><br/>
|
<tt> data2mem -bm uc_bmm<br/></tt><br/>
|
WARNING: Using "<tt>ARCHITECTURE 4096</tt>" on a Spartan-6 build
|
WARNING: Using "<tt>ARCHITECTURE 4096</tt>" on a Spartan-6 build
|
produced two RAMB16's and one RAMB8, not the expected two RAMB18's.
|
produced two RAMB16's and one RAMB8, not the expected two RAMB18's.
|
Changing the configuration command to "<tt>ARCHITECTURE 2048*2</tt>"
|
Changing the configuration command to "<tt>ARCHITECTURE 2048*2</tt>"
|
produced the desired results. The following <tt>BMM</tt> extracted the two
|
produced the desired results. The following <tt>BMM</tt> extracted the two
|
RAMB18 locations with the desired memory mapping:<br/><br/>
|
RAMB18 locations with the desired memory mapping:<br/><br/>
|
<tt>ADDRESS_SPACE uc RAMB18 WORD_ADDRESSING [0x0:0xFFF]<br/>
|
<tt>ADDRESS_SPACE uc RAMB18 WORD_ADDRESSING [0x0:0xFFF]<br/>
|
BUS_BLOCK<br/>
|
BUS_BLOCK<br/>
|
top_inst/uc_inst_Mram_s_opcodeMemory_0 [0:8];<br/>
|
top_inst/uc_inst_Mram_s_opcodeMemory_0 [0:8];<br/>
|
END_BUS_BLOCK;<br/>
|
END_BUS_BLOCK;<br/>
|
BUS_BLOCK<br/>
|
BUS_BLOCK<br/>
|
top_inst/uc_inst_Mram_s_opcodeMemory_1 [0:8];<br/>
|
top_inst/uc_inst_Mram_s_opcodeMemory_1 [0:8];<br/>
|
END_BUS_BLOCK;<br/>
|
END_BUS_BLOCK;<br/>
|
END_ADDRESS_SPACE;<br/></tt><br/>
|
END_ADDRESS_SPACE;<br/></tt><br/>
|
|
Note: For a Spartan-3A the bit indices <tt>[0:8]</tt> may need to be reversed.<br/><br/>
|
<li>Add this file to the build process.<br/><br/>
|
<li>Add this file to the build process.<br/><br/>
|
For a command-line build this is done by adding "<tt>-bm uc.bmm</tt>"
|
For a command-line build this is done by adding "<tt>-bm uc.bmm</tt>"
|
to the argument list for ngdbuild.<br/><br/>
|
to the argument list for ngdbuild.<br/><br/>
|
When <tt>bitgen</tt> is run it will create a file named "<tt>uc_bd.bmm</tt>
|
When <tt>bitgen</tt> is run it will create a file named "<tt>uc_bd.bmm</tt>
|
which will include the memory block address required to run
|
which will include the memory block address required to run
|
<tt>data2mem</tt>.<br/><br/>
|
<tt>data2mem</tt>.<br/><br/>
|
<li>Perform the build and ensure that <tt>uc_bd.bmm</tt> has the address for
|
<li>Perform the build and ensure that <tt>uc_bd.bmm</tt> has the address for
|
the memory block.<br/><br/>
|
the memory block.<br/><br/>
|
<li>Run <tt>data2mem</tt> as follows, where "<tt>orig.bit</tt>" is the
|
<li>Run <tt>data2mem</tt> as follows, where "<tt>orig.bit</tt>" is the
|
assumed name for the original bitstream generated by Xilinx' tools:<br/><br/>
|
assumed name for the original bitstream generated by Xilinx' tools:<br/><br/>
|
<tt>data2mem -bm uc_bd.bmm -bt orig.bit -bd uc.mem -o b new.bit;<br/></tt><br/>
|
<tt>data2mem -bm uc_bd.bmm -bt orig.bit -bd uc.mem -o b new.bit;<br/></tt><br/>
|
<li>Compare the original bitstream to the modified bitstream as follows to
|
<li>Compare the original bitstream to the modified bitstream as follows to
|
ensure this process worked.<br/><br/>
|
ensure this process worked.<br/><br/>
|
<tt>data2mem -bm uc.bmm -bt orig.bit -d > orig.dump;<br/>
|
<tt>data2mem -bm uc.bmm -bt orig.bit -d > orig.dump;<br/>
|
data2mem -bm uc.bmm -bt new.bit -d > new.dump;<br/>
|
data2mem -bm uc.bmm -bt new.bit -d > new.dump;<br/>
|
diff orig.dump new.dump | less;<br/></tt><br/>
|
diff orig.dump new.dump | less;<br/></tt><br/>
|
The only differences other than file names and dates and such should be the
|
The only differences other than file names and dates and such should be the
|
initialization values for the memory block.<br/><br/>
|
initialization values for the memory block.<br/><br/>
|
You can validate this process by using the original memory initialization
|
You can validate this process by using the original memory initialization
|
file, in which case the above differences should be limited to the file
|
file, in which case the above differences should be limited to the file
|
name, data, etc., but not the memory contents.<br/><br/>
|
name, data, etc., but not the memory contents.<br/><br/>
|
</ol>
|
</ol>
|
If you didn't include the <tt>BMM</tt> file in the build process you can use
|
If you didn't include the <tt>BMM</tt> file in the build process you can use
|
<tt>fpga_editor</tt> to get the memory names and memory locations. The
|
<tt>fpga_editor</tt> to get the memory names and memory locations. The
|
command to invoke it is:<br/><br/>
|
command to invoke it is:<br/><br/>
|
<tt> fpga_editor -r file.ncd file.pcf<br/></tt><br/>
|
<tt> fpga_editor -r file.ncd file.pcf<br/></tt><br/>
|
Then, under "<tt>Name Filter</tt>" type "<tt>*opcodeMemory*</tt>" and hit
|
Then, under "<tt>Name Filter</tt>" type "<tt>*opcodeMemory*</tt>" and hit
|
the <tt>ENTER</tt> key.
|
the <tt>ENTER</tt> key.
|
<h1>Xilinx <tt>Vivado</tt></h1>
|
<h1>Xilinx <tt>Vivado</tt></h1>
|
As of this writing, Xilinx' Vivado does not have clean non-SDK support for
|
As of this writing, Xilinx' Vivado does not have clean non-SDK support for
|
generating the files required to modify the processor instruction memory.
|
generating the files required to modify the processor instruction memory.
|
However, the TCL scripting language can be used for the following work-around
|
However, the TCL scripting language can be used for the following work-around
|
to this problem:
|
to this problem:
|
<ol>
|
<ol>
|
<li>Determine the name of the memory.<br/><br/>
|
<li>Determine the name of the memory.<br/><br/>
|
The following commands lists the names of all the block rams. This
|
The following commands lists the names of all the block rams. This
|
obviously needs to be done after place and route.<br/><br/>
|
obviously needs to be done after place and route.<br/><br/>
|
<tt>join [get_cells -hierarchical -filter { LOC =~ "RAMB*" }] "\n";<br/></tt><br/>
|
<tt>join [get_cells -hierarchical -filter { LOC =~ "RAMB*" }] "\n";<br/></tt><br/>
|
or<br/><br/>
|
or<br/><br/>
|
<tt>join [filter [get_cells -hierarchical] { BEL =~ "RAMB*" }] "\n"<br/></tt><br/>
|
<tt>join [filter [get_cells -hierarchical] { BEL =~ "RAMB*" }] "\n"<br/></tt><br/>
|
Alternatively, the following command lists the names of the block rams, the
|
Alternatively, the following command lists the names of the block rams, the
|
type of the block ram, and their locations:<br/><br/>
|
type of the block ram, and their locations:<br/><br/>
|
<tt>foreach a [filter [get_cells -hierarchical] { BEL =~ "RAMB*" }] {
|
<tt>foreach a [filter [get_cells -hierarchical] { BEL =~ "RAMB*" }] {
|
puts "$a [lindex [report_property -return_string $a BEL] 7] [lindex
|
puts "$a [lindex [report_property -return_string $a BEL] 7] [lindex
|
[report_property -return_string $a LOC] 7]"; }<br/></tt><br/>
|
[report_property -return_string $a LOC] 7]"; }<br/></tt><br/>
|
Any of these can be included in the build script or can be cut and pasted
|
Any of these can be included in the build script or can be cut and pasted
|
into the TCL console in the GUI after place and route.<br/><br/>
|
into the TCL console in the GUI after place and route.<br/><br/>
|
Note: The "<tt>list_property_value</tt>" seems to be more natural to use
|
Note: The "<tt>list_property_value</tt>" seems to be more natural to use
|
than the "<tt>[lindex ...</tt>" commands, but can only be used for
|
than the "<tt>[lindex ...</tt>" commands, but can only be used for
|
enumerated types, i.e., not for <tt>BEL</tt> and <tt>LOC</tt>
|
enumerated types, i.e., not for <tt>BEL</tt> and <tt>LOC</tt>
|
properties.<br/><br/>
|
properties.<br/><br/>
|
</li>
|
</li>
|
<li>Once you've identified the name(s) of the memories, add the following
|
<li>Once you've identified the name(s) of the memories, add the following
|
command to the build script or use it on a checkpoint. Here,
|
command to the build script or use it on a checkpoint. Here,
|
uc/inst/s_PC_reg_rep was the single memory in the micro controller.<br/><br/>
|
uc/inst/s_PC_reg_rep was the single memory in the micro controller.<br/><br/>
|
<tt>foreach memName [list "uc/inst/s_PC_reg_rep"] {<br/>
|
<tt>foreach memName [list "uc/inst/s_PC_reg_rep"] {<br/>
|
set memBel [lindex [report_property -return_string [get_cells $memName] BEL] 7];<br/>
|
set memBel [lindex [report_property -return_string [get_cells $memName] BEL] 7];<br/>
|
set memLoc [lindex [report_property -return_string [get_cells $memName] LOC] 7];<br/>
|
set memLoc [lindex [report_property -return_string [get_cells $memName] LOC] 7];<br/>
|
puts "MYBMMINFO: $memName $memBel $memLoc]";<br/>
|
puts "MYBMMINFO: $memName $memBel $memLoc]";<br/>
|
}<br/></tt><br/>
|
}<br/></tt><br/>
|
This should add lines starting with "<tt>MYBMMINFO:</tt>" to the Vivado log
|
This should add lines starting with "<tt>MYBMMINFO:</tt>" to the Vivado log
|
file with each memory name, type, and location.<br/><br/>
|
file with each memory name, type, and location.<br/><br/>
|
Note: If the processor uses more than one block ram, simply append the name
|
Note: If the processor uses more than one block ram, simply append the name
|
to the "<tt>list</tt>" in this TCL script.<br/><br/>
|
to the "<tt>list</tt>" in this TCL script.<br/><br/>
|
</li>
|
</li>
|
<li>Use the following <tt>gawk</tt> script or similar to generate a
|
<li>Use the following <tt>gawk</tt> script or similar to generate a
|
<tt>BMM</tt> file from the "<tt>MYBMMINFO:</tt>" lines. Here, the
|
<tt>BMM</tt> file from the "<tt>MYBMMINFO:</tt>" lines. Here, the
|
"<tt>vivado.log</tt>" is the Vivado log file and "<tt>build-bmm</tt> is the
|
"<tt>vivado.log</tt>" is the Vivado log file and "<tt>build-bmm</tt> is the
|
name of this file.<br/><br/>
|
name of this file.<br/><br/>
|
<tt>#!/bin/bash<br/>
|
<tt>#!/bin/bash<br/>
|
#<br/>
|
#<br/>
|
# Generate a BMM file for the micro controller from the MYBMMINFO lines in the<br/>
|
# Generate a BMM file for the micro controller from the MYBMMINFO lines in the<br/>
|
# Vivado log file.<br/>
|
# Vivado log file.<br/>
|
#<br/>
|
#<br/>
|
# Usage: ./build-bmm<br/>
|
# Usage: ./build-bmm<br/>
|
<br/>
|
<br/>
|
gawk -- '<br/>
|
gawk -- '<br/>
|
BEGIN {<br/>
|
BEGIN {<br/>
|
nMemories = 0;<br/>
|
nMemories = 0;<br/>
|
memName[nMemories++] = "uc/inst/s_PC_reg_rep";<br/>
|
memName[nMemories++] = "uc/inst/s_PC_reg_rep";<br/>
|
}<br/>
|
}<br/>
|
/^MYBMMINFO:/ { bel[$2] = $3; loc[$2] = $4; }<br/>
|
/^MYBMMINFO:/ { bel[$2] = $3; loc[$2] = $4; }<br/>
|
END {<br/>
|
END {<br/>
|
for (ix=0; ix<nMemories; ++ix)<br/>
|
for (ix=0; ix<nMemories; ++ix)<br/>
|
if (!(memName[ix] in bel)) {<br/>
|
if (!(memName[ix] in bel)) {<br/>
|
printf("FATAL ERROR: MYBMMINFO record not found for \"%s\"\n", memName) > "/dev/stderr";<br/>
|
printf("FATAL ERROR: MYBMMINFO record not found for \"%s\"\n", memName) > "/dev/stderr";<br/>
|
exit 1;<br/>
|
exit 1;<br/>
|
}<br/>
|
}<br/>
|
memType = "";<br/>
|
memType = "";<br/>
|
for (ix=0; ix<nMemories; ++ix) {<br/>
|
for (ix=0; ix<nMemories; ++ix) {<br/>
|
split(loc[memName[ix]],splitLoc,"_");<br/>
|
split(loc[memName[ix]],splitLoc,"_");<br/>
|
if (memType == "") {<br/>
|
if (memType == "") {<br/>
|
memType = splitLoc[1];<br/>
|
memType = splitLoc[1];<br/>
|
if (memType = "RAMB18") L = 2048;<br/>
|
if (memType = "RAMB18") L = 2048;<br/>
|
if (memType = "RAMB36") L = 4096;<br/>
|
if (memType = "RAMB36") L = 4096;<br/>
|
L *= nMemories;<br/>
|
L *= nMemories;<br/>
|
printf("ADDRESS_SPACE uc %s WORD_ADDRESSING [0x0:0x%x]\n",memType,L-1);<br/>
|
printf("ADDRESS_SPACE uc %s WORD_ADDRESSING [0x0:0x%x]\n",memType,L-1);<br/>
|
}<br/>
|
}<br/>
|
else if (splitLoc[1] != memType) {<br/>
|
else if (splitLoc[1] != memType) {<br/>
|
printf("Inconsistent memory types: %s is %s instead of %s\n",memName[ix],splitLoc[1],memType) > "/dev/stderr";<br/>
|
printf("Inconsistent memory types: %s is %s instead of %s\n",memName[ix],splitLoc[1],memType) > "/dev/stderr";<br/>
|
exit 1;<br/>
|
exit 1;<br/>
|
}<br/>
|
}<br/>
|
printf(" BUS_BLOCK\n");<br/>
|
printf(" BUS_BLOCK\n");<br/>
|
printf(" %s [8:0] PLACED = %s;\n",memName[ix],splitLoc[2]);<br/>
|
printf(" %s [8:0] PLACED = %s;\n",memName[ix],splitLoc[2]);<br/>
|
printf(" END_BUS_BLOCK;\n");<br/>
|
printf(" END_BUS_BLOCK;\n");<br/>
|
}<br/>
|
}<br/>
|
printf("END_ADDRESS_SPACE;\n");<br/>
|
printf("END_ADDRESS_SPACE;\n");<br/>
|
}<br/>
|
}<br/>
|
' vivado.log > build_uc.bmm<br/></tt><br/>
|
' vivado.log > build_uc.bmm<br/></tt><br/>
|
</li>
|
</li>
|
<li>Update the contents of the bitstream file as follows. Here,
|
<li>Update the contents of the bitstream file as follows. Here,
|
<tt>build.bit</tt> is the original bitstream and <tt>build_uc.bit</tt> is
|
<tt>build.bit</tt> is the original bitstream and <tt>build_uc.bit</tt> is
|
the bitstream updated with the new micro controller instructions.<br/><br/>
|
the bitstream updated with the new micro controller instructions.<br/><br/>
|
<tt>data2mem -bm build_uc.bmm -bt build.bit -bd uc/uc.mem -o b
|
<tt>data2mem -bm build_uc.bmm -bt build.bit -bd uc/uc.mem -o b
|
build_uc.bit<br/></tt><br/>
|
build_uc.bit<br/></tt><br/>
|
Alternatively, use something like the following as an "<tt>update_uc</tt>"
|
Alternatively, use something like the following as an "<tt>update_uc</tt>"
|
script file:<br/><br/>
|
script file:<br/><br/>
|
<tt>#!/bin/bash<br/>
|
<tt>#!/bin/bash<br/>
|
#<br/>
|
#<br/>
|
# Update the micro controller instruction memory in the BIT file.<br/>
|
# Update the micro controller instruction memory in the BIT file.<br/>
|
#<br/>
|
#<br/>
|
# Usage: ./update-uc<br/>
|
# Usage: ./update-uc<br/>
|
<br/>
|
<br/>
|
if test ! -f build_uc.bmm -o vivado.log -nt build_uc.bmm; then<br/>
|
if test ! -f build_uc.bmm -o vivado.log -nt build_uc.bmm; then<br/>
|
./build-bmm || { echo "build-bmm failed" > /dev/stderr; exit 1; }<br/>
|
./build-bmm || { echo "build-bmm failed" > /dev/stderr; exit 1; }<br/>
|
fi<br/>
|
fi<br/>
|
<br/>
|
<br/>
|
( cd uc; ssbcc -q --define-clog2 uc.9x8 ) \<br/>
|
( cd uc; ssbcc -q --define-clog2 uc.9x8 ) \<br/>
|
|| { echo "ssbcc failed" > /dev/stderr; exit 1; }<br/>
|
|| { echo "ssbcc failed" > /dev/stderr; exit 1; }<br/>
|
<br/>
|
<br/>
|
data2mem -bm build_uc.bmm -bt build.bit -bd uc/uc.mem -o b build_uc.bit \<br/>
|
data2mem -bm build_uc.bmm -bt build.bit -bd uc/uc.mem -o b build_uc.bit \<br/>
|
|| { echo "data2mem failed" > /dev/stderr; exit 1; }<br/></tt><br/>
|
|| { echo "data2mem failed" > /dev/stderr; exit 1; }<br/></tt><br/>
|
</li>
|
</li>
|
</ol>
|
</ol>
|
Note: If you want to use these procedures to identify the memories after
|
Note: If you want to use these procedures to identify the memories after
|
you've run Vivado, you must include a "<tt>write_checkpoint</tt>" command in
|
you've run Vivado, you must include a "<tt>write_checkpoint</tt>" command in
|
your TCL script. For example, include the following command after
|
your TCL script. For example, include the following command after
|
"<tt>write_bitstream -force build.bit</tt>"<br/><br/>
|
"<tt>write_bitstream -force build.bit</tt>"<br/><br/>
|
<tt>write_checkpoint -force build;<br/></tt><br/>
|
<tt>write_checkpoint -force build;<br/></tt><br/>
|
and then use the following command in a subsequent Vivado session to open the
|
and then use the following command in a subsequent Vivado session to open the
|
checkpoint:<br/><br/>
|
checkpoint:<br/><br/>
|
<tt>read_checkpoint build;<br/></tt><br/>
|
<tt>read_checkpoint build;<br/></tt><br/>
|
Once these are done you can examine the memory names and so forth.<br/><br/>
|
Once these are done you can examine the memory names and so forth.<br/><br/>
|
</body>
|
</body>
|
</html>
|
</html>
|
|
|
