adjust remaining docs and --guess

sierrafoxtrot · Apr 14, 2023 · 27a1463 · 27a1463
1 parent a04cdfb
commit 27a1463
Show file tree

Hide file tree

Showing 6 changed files with 17 additions and 2 deletions.
diff --git a/doc/etc/README.man b/doc/etc/README.man
@@ -103,6 +103,9 @@ The Formatted Binary format is understood for both reading and writing.
 Four Packed Code (FPC)
 The FPC format is understood for both reading and writing.
 .\" ----------  G  ---------------------------------------------------------
+.TP
+Gowin Bitstream
+The Gowin bitstream format is understood for reading only.
 .\" ----------  H  ---------------------------------------------------------
 .TP
 Hexdump

diff --git a/doc/html/index.html b/doc/html/index.html
@@ -169,6 +169,11 @@
 The FPC format is understood for both reading and writing.
 <p>
 .\" ----------  G  ---------------------------------------------------------
+<dt>
+<a href="man/man5/srec_gowin.5.html" >Gowin bitstream</a>
+<dd>
+The Gowin bitstream format is understood for reading only.
+<p>
 .\" ----------  H  ---------------------------------------------------------
 <dt>
 Hexdump

diff --git a/doc/man1/srec_input.1 b/doc/man1/srec_input.1
@@ -122,6 +122,10 @@ This option says to use the FPC format to read the file.
 See \f[I]srec_fpc\fP(5) for a description of this file format.
 .\" ----------  G  ---------------------------------------------------------
 .TP 8n
+\fB\-GOwin_fs\fP
+This option says to use the Gowin bitstream format to read the file.
+See \f[I]srec_gowin\fP(5) for a description of this file format.
+.TP 8n
 \fB\-Guess\fP
 This option may be used to ask the command to guess the input format.
 This is slower than specifying an explicit format,

diff --git a/doc/man5/srec_gowin.5 b/doc/man5/srec_gowin.5
@@ -18,11 +18,11 @@
 .\"
 .ds n) srec_gowin
 .TH \*(n) 5 SRecord "Reference Manual"
-.SH NAME
-srec_gowin \- Gowin bitstream file format
 .if require_index \{
 .XX "srec_gowin(5)" "Gowin bitstream file format"
 .\}
+.SH NAME
+srec_gowin \- Gowin bitstream file format
 .SH DESCRIPTION
 This format is the Gowin bitstream file format. It is generated by the IDE from Gowin to program their FPGAs.
 

diff --git a/srecord/input/file/guess.cc b/srecord/input/file/guess.cc
@@ -32,6 +32,7 @@
 #include <srecord/input/file/fastload.h>
 #include <srecord/input/file/formatted_binary.h>
 #include <srecord/input/file/four_packed_code.h>
+#include <srecord/input/file/gowin_fs.h>
 #include <srecord/input/file/hexdump.h>
 #include <srecord/input/file/hp64k.h>
 #include <srecord/input/file/idt.h>
@@ -78,6 +79,7 @@ static func_p table[] =
     srecord::input_file_fastload::create,
     srecord::input_file_formatted_binary::create,
     srecord::input_file_four_packed_code::create,
+    srecord::input_file_gowin_fs::create,
     srecord::input_file_hp64k::create,
     srecord::input_file_idt::create,
     srecord::input_file_intel::create,

diff --git a/srecord/srecord.h b/srecord/srecord.h
@@ -36,6 +36,7 @@
 #include <srecord/input/file/fastload.h>
 #include <srecord/input/file/formatted_binary.h>
 #include <srecord/input/file/four_packed_code.h>
+#include <srecord/input/file/gowin_fs.h>
 #include <srecord/input/file/intel.h>
 #include <srecord/input/file/logisim.h>
 #include <srecord/input/file/mem.h>