added licensing

kooscode · kooscode · commit 58a0bc0bcdf1 · 2021-01-02T12:48:58.000-08:00
diff --git a/LICENSE b/LICENSE
diff --git a/README.md b/README.md
@@ -66,11 +66,7 @@ Ryzee119 provides the Xilinx CPLD's source code for LPC translation, but you sti
 
 I recently ran across a web article that showed JTAG programming a Xilinx FPGA via a Raspberry PI using a tool called XC3SPROG and I thought that would be a great platform to program a Xenium's CPLD !!
 
-See: https://linuxjedi.co.uk/2020/12/01/programming-xilinx-jtag-from-a-raspberry-pi/
-
-Now - if you can also get it to upload the BIOS to the Xenium Flash memory, that would make the PERFECT little Xenium programmer and for $5 more, you can make it a wireless remote and even standalone end-to-end OpenXenium mod chip programmer!!
-
-I downloaded the XC3SPROG tool and it worked fantastic! I could JTAG program the Xilinx CPLD in 12 seconds flat!! 
+I extracted pieces from XC3SPROG source code that will allow JTAG programming of just the Xenium CPLD and it worked fantastic! I can JTAG program the Xilinx CPLD in 12 seconds flat!! 
 
 So, I set about looking at how to bit-bang LPC through the Raspberry PI's GPIO ports and program Xenium Flash memory.
 
@@ -111,21 +107,20 @@ You can install Xenium Programmer stack by doing the following:
 
 - Clone this repo by running `git clone https://github.com/kooscode/xenium-programmer.git`
 - Run `./install` to download, build and install all the above mentioned tools.
-- This might take a while - please be patient!
-- BTW - the XC3SPROG build takes a while and has a bunch of warnings.. its normal..
 
 -------------
 ## -- HOOKING UP THE HARDWARE --
 
 ![jtag-pinout](images/connections.png)
 
 ### JTAG PROGRAMMING PINS
-- You need to hook up the JTAG pins for XC3SPROG in a specific way.. AFAIK, they are not configurable.. 
+- The JTAG pins are configurable by editing the `XeniumDefines.h` file 
+- I chose these pins for XC3SPROG compatability, use them as is, or change it as you see fit.. 
 
 ![jtag-pinout](images/jtag-pinout.png)
 
 ### FLASH PROGRAMMING PINS
-- These pins are configurable in the `BitBus.cpp` file of the `xenium-flash` app source.
+- The FLASH pins are configurable by editing the `XeniumDefines.h` file.
 - I chose these pins purely for convenience of my board layout, use them as is, or change it as you see fit.. 
 
 ![bitbus-pinout](images/bitbus-pinout.png)
diff --git a/firmware/xeniumflash.v b/firmware/xeniumflash.v
@@ -1,3 +1,23 @@
+/* 4-bit "BitBus" to Flash translator for OpenXenium
+
+Copyright (C) 2019-2020 Koos du Preez (kdupreez@hotmail.com)
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+*/
+
+
 module xeniumflash(
 			// led
 			output reg [2:0] led,
diff --git a/xenium-flash/src/flash/BitBus.cpp b/xenium-flash/src/flash/BitBus.cpp
@@ -1,3 +1,22 @@
+/* Custom 4-bit "BitBus"
+
+Copyright (C) 2019-2020 Koos du Preez (kdupreez@hotmail.com)
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+*/
+
 #include "BitBus.hpp"
 
 #include <thread>
diff --git a/xenium-flash/src/flash/BitBus.hpp b/xenium-flash/src/flash/BitBus.hpp
@@ -1,3 +1,22 @@
+/* Custom 4-bit "BitBus"
+
+Copyright (C) 2019-2020 Koos du Preez (kdupreez@hotmail.com)
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+*/
+
 #ifndef XK_BITBUS_
 #define XK_BITBUS_
 
diff --git a/xenium-flash/src/flash/Flash.cpp b/xenium-flash/src/flash/Flash.cpp
@@ -1,3 +1,22 @@
+/* Programming a SPANSION flash via 4-bit bus
+
+Copyright (C) 2019-2020 Koos du Preez (kdupreez@hotmail.com)
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+*/
+
 #include "Flash.hpp"
 
 #include <fstream>
diff --git a/xenium-flash/src/flash/Flash.hpp b/xenium-flash/src/flash/Flash.hpp
@@ -1,3 +1,22 @@
+/* Programming a SPANSION flash via 4-bit bus
+
+Copyright (C) 2019-2020 Koos du Preez (kdupreez@hotmail.com)
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+*/
+
 #ifndef XK_FLASH_
 #define XK_FLASH_
 
diff --git a/xenium-flash/src/jtag/IOXenium.h b/xenium-flash/src/jtag/IOXenium.h
@@ -1,4 +1,4 @@
-/* WiringPI implementation of XC3SPROG IOBase
+/* WiringPI implementation of for Xenium CPLD
 
 Copyright (C) 2019-2020 Koos du Preez (kdupreez@hotmail.com)
 
diff --git a/xenium-flash/src/xenium-flash.cpp b/xenium-flash/src/xenium-flash.cpp
@@ -1,3 +1,22 @@
+/* Programming a FLASH on OpenXenium
+
+Copyright (C) 2019-2020 Koos du Preez (kdupreez@hotmail.com)
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+*/
+
 
 #include <iostream>
 #include <fstream>
diff --git a/xenium-flash/src/xenium-jtag.cpp b/xenium-flash/src/xenium-jtag.cpp
@@ -1,3 +1,22 @@
+/* Programming a CPLD on OpenXenium
+
+Copyright (C) 2019-2020 Koos du Preez (kdupreez@hotmail.com)
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+*/
+
 #include <iostream>
 #include <memory>
 

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-/* WiringPI implementation of XC3SPROG IOBase`
	`1`	`+/* WiringPI implementation of for Xenium CPLD`
`2`	`2`
`3`	`3`	`Copyright (C) 2019-2020 Koos du Preez ([email protected])`
`4`	`4`