aboutsummaryrefslogtreecommitdiffstats
path: root/bba
diff options
context:
space:
mode:
authorClifford Wolf <cliffordvienna@gmail.com>2018-07-26 12:33:46 +0000
committerClifford Wolf <cliffordvienna@gmail.com>2018-07-26 12:33:46 +0000
commit171d00ee3751a355624cc56f9a2a5e27cffc4010 (patch)
tree57c86e1f5e0b02d976566547fa34c831489143ff /bba
parent4587b8c0001d853ab2fb6f820627f1508e28e316 (diff)
downloadnextpnr-171d00ee3751a355624cc56f9a2a5e27cffc4010.tar.gz
nextpnr-171d00ee3751a355624cc56f9a2a5e27cffc4010.tar.bz2
nextpnr-171d00ee3751a355624cc56f9a2a5e27cffc4010.zip
Update README.md
Diffstat (limited to 'bba')
-rw-r--r--bba/README.md36
1 files changed, 18 insertions, 18 deletions
diff --git a/bba/README.md b/bba/README.md
index 7e64b582..db620d52 100644
--- a/bba/README.md
+++ b/bba/README.md
@@ -12,20 +12,20 @@ independent.
Valid commands for the input are as follows.
-pre <string>
-------------
+pre \<string\>
+--------------
When a C file is generated as output, all the "pre" strings will be included
before the binary blob.
-post <string>
--------------
+post \<string\>
+---------------
When a C file is generated as output, all the "post" strings will be included
after the binary blob.
-push <name>
------------
+push \<name\>
+-------------
All following commands up until the matching "pop" will be writen to stream
<name>. Everything written to the same stream will end up in a continous
@@ -36,35 +36,35 @@ pop
End of a push..pop block.
-label <name> [<comment>]
-------------------------
+label \<name\> \[\<comment\>\]
+------------------------------
Add a label for the current position.
-ref <name> [<comment>]
-----------------------
+ref \<name\> \[\<comment\>\]
+----------------------------
Add a 32-bit reference to the specified label. The reference will be a byte
offset relative to the memory location of the reference itself.
-u8 <value> [<comment>]
-----------------------
+u8 \<value\> \[\<comment\>\]
+----------------------------
Add a 8-bit value to the binary blob.
-u16 <value> [<comment>]
------------------------
+u16 \<value\> \[\<comment\>\]
+-----------------------------
Add a 16-bit value to the binary blob. Note that the input must be structured
in a way that ensures that all u16 are aligned to 2-byte addresses.
-u32 <value> [<comment>]
-----------------------
+u32 \<value\> \[\<comment\>\]
+-----------------------------
Add a 32-bit value to the binary blob. Note that the input must be structured
in a way that ensures that all u32 are aligned to 4-byte addresses.
-str <string>
-------------
+str \<string\>
+--------------
Add a reference to a zero-terminated copy of the specified string.