construct the "sysresources.zip" datablock to be bound into the executable

.gitignore

@@ -2,4 +2,7 @@
 *.o
 src/upiwin
 src/splash.bin
+src/i_*.bin
 buildutils/mksplash
+buildutils/mkgfx
+output/

CODE-OF-CONDUCT.md

@@ -8,45 +8,45 @@ are *final.*
 2. This Code of Conduct contains harsh language. Tough shit. Suck it up, Buttercup.
 3. Anyone who is an *asshole* is **banned** *from this project.* **Permanently.**
 4. This project has certain objectives.  Anything outside of those objectives is *irrelevant,*
-unless and until the *Owner* changes the objectives. Not you. In particular, if you’re a Social
+unless and until the *Owner* changes the objectives. Not you. In particular, if you're a Social
 Justice Warrior trying to join this project to spread your *bullshit,* you are *automatically
-declared an asshole.* And you’re *gone.*
+declared an asshole.* And you're *gone.*
 5. The Owner reserves the right to change this Code of Conduct as they see fit.  If, however, you try
 to force the Owner to change it in ways that are *offensive to them,* or that try to advance
-“social justice” ideals in any way, shape, or form, you’re an *asshole.* And you’re *gone.*
+"social justice" ideals in any way, shape, or form, you're an *asshole.* And you're *gone.*
-6. In particular, this project explicitly *rejects* the “Open Code of Conduct” by the TODO Group,
+6. In particular, this project explicitly *rejects* the "Open Code of Conduct" by the TODO Group,
-the “Contributor Code of Merit” by Coraline Ada Ehmke, the “Citizen Code of Conduct” by
+the "Contributor Code of Merit" by Coraline Ada Ehmke, the "Citizen Code of Conduct" by
-Stumptown Syndicate, and any similar “codes of conduct” that may be promulgated. Anyone complaining
+Stumptown Syndicate, and any similar "codes of conduct" that may be promulgated. Anyone complaining
 about this is an *asshole,* because *who the fuck are you* to tell *the Owner* how *they* should
-run *their* goddamn project? And you’re *gone.*
+run *their* goddamn project? And you're *gone.*
 7. The *one and only* criterion that will be used to determine whether a contribution to this project
 will be accepted is *the quality of the contribution and how well it solves the problem it was
-contributed to solve.* **Period.** (“Contribution” may include code, documentation, testing, or fundraising.)
+contributed to solve.* **Period.** ("Contribution" may include code, documentation, testing, or fundraising.)
 8. The *one and only* criterion that will be used to judge your worth in relation to this project is
 *the quality of your contributions (as defined above) to this project.* **Period.**
 9. The Owner hereby does not give *one milli-micro-nano-fraction of a* **fuck** what race you are,
 what gender you are or identify as, who you want to sleep with, how old you are, what your height or
 weight is, what if anything may be different about your body or brain, what language you speak,
-what country you’re from, what God you pray to, where you work, how much money you have,
+what country you're from, what God you pray to, where you work, how much money you have,
-et fucking cetera. Is your contribution any *good?* That’s all that matters.
+et fucking cetera. Is your contribution any *good?* That's all that matters.
-10. If your contribution is not accepted, and you start *whining* about how it’s “actually” because you’re
+10. If your contribution is not accepted, and you start *whining* about how it's "actually" because you're
 of some-or-other gender/race/religion/nationality/whatthefuckever, you are attempting to have the deck
-stacked in your favor because you’re “special.” That makes you an *asshole.* And you’re *gone.*
+stacked in your favor because you're "special." That makes you an *asshole.* And you're *gone.*
 11. Only those people who have contributed a sufficient quantity of good work to the project,
 *as determined in the Owner's sole discretion,* will be allowed to assume any board position,
 administrative position, or management-related role. And, any position that the Owner gives, they can
-also *take away,* for any reason. Anyone who complains about this is an *asshole.* And they’re *gone.*
+also *take away,* for any reason. Anyone who complains about this is an *asshole.* And they're *gone.*
-12. You will do your own work.  If you try to pass off the work of others as your own, you’re a
+12. You will do your own work.  If you try to pass off the work of others as your own, you're a
-fucking *plagiarist,* and also an *asshole.* And you’re *gone.*
+fucking *plagiarist,* and also an *asshole.* And you're *gone.*
-13. If there’s a discussion that cannot be resolved within the scope of the project,
+13. If there's a discussion that cannot be resolved within the scope of the project,
 *take that shit somewhere else.* The Owner does not want your bullshit here.  If you continue to spread
-your bullshit here, you’re an *asshole.* And you’re *gone.*
+your bullshit here, you're an *asshole.* And you're *gone.*
 14. As noted above, the Owner's decisions about any aspect of the project are *final.* Anyone
 *pissing the Owner off* by getting all up in their face about said decisions is an *asshole.*
-And they’re *gone.*
+And they're *gone.*
 15. Any advisory boards, committees, etc., having to do with this project will answer to *the Owner.*
 The Owner reserves the right to disband any such whenever the hell they feel like it.  As always, anyone
-complaining about this is an *asshole.* And they’re *gone.*
+complaining about this is an *asshole.* And they're *gone.*
 16. Anyone who does not approve of the objectives, direction, or attitude of this project is
 free to *get the fuck out* at any time. Bye Felicia!
 

LICENSE.md

@@ -2,7 +2,7 @@ GNU General Public License
 ==========================
 
 _Version 2, June 1991_  
-_Copyright © 1989, 1991 Free Software Foundation, Inc.,_  
+_Copyright © 1989, 1991 Free Software Foundation, Inc.,_  
 _51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA_
 
 Everyone is permitted to copy and distribute verbatim copies
@@ -62,13 +62,13 @@ modification follow.
 
 **0.** This License applies to any program or other work which contains
 a notice placed by the copyright holder saying it may be distributed
-under the terms of this General Public License.  The “Program”, below,
+under the terms of this General Public License.  The "Program", below,
-refers to any such program or work, and a “work based on the Program”
+refers to any such program or work, and a "work based on the Program"
 means either the Program or any derivative work under copyright law:
 that is to say, a work containing the Program or a portion of it,
 either verbatim or with modifications and/or translated into another
 language.  (Hereinafter, translation is included without limitation in
-the term “modification”.)  Each licensee is addressed as “you”.
+the term "modification".)  Each licensee is addressed as "you".
 
 Activities other than copying, distribution and modification are not
 covered by this License; they are outside its scope.  The act of
@@ -237,8 +237,8 @@ be similar in spirit to the present version, but may differ in detail to
 address new problems or concerns.
 
 Each version is given a distinguishing version number.  If the Program
-specifies a version number of this License which applies to it and “any
+specifies a version number of this License which applies to it and "any
-later version”, you have the option of following the terms and conditions
+later version", you have the option of following the terms and conditions
 either of that version or of any later version published by the Free
 Software Foundation.  If the Program does not specify a version number of
 this License, you may choose any version ever published by the Free Software
@@ -257,7 +257,7 @@ of promoting the sharing and reuse of software generally.
 **11.** BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
 FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
 OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
-PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
 OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
 TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
@@ -285,7 +285,7 @@ free software which everyone can redistribute and change under these terms.
 To do so, attach the following notices to the program.  It is safest
 to attach them to the start of each source file to most effectively
 convey the exclusion of warranty; and each file should have at least
-the “copyright” line and a pointer to where the full notice is found.
+the "copyright" line and a pointer to where the full notice is found.
 
     <one line to give the program's name and a brief idea of what it does.>
     Copyright (C) <year>  <name of author>
@@ -320,7 +320,7 @@ be called something other than `show w` and `show c`; they could even be
 mouse-clicks or menu items--whatever suits your program.
 
 You should also get your employer (if you work as a programmer) or your
-school, if any, to sign a “copyright disclaimer” for the program, if
+school, if any, to sign a "copyright disclaimer" for the program, if
 necessary.  Here is a sample; alter the names:
 
     Yoyodyne, Inc., hereby disclaims all copyright interest in the program

Makefile

@@ -18,7 +18,14 @@
 all:
 	make -C buildutils all
 	make -C src all
+	make output
+
+output:
+	mkdir -p output
+	cp src/upiwin output
+	cp scripts/*.py output
 
 clean:
+	-rm -rf output
 	make -C buildutils clean
 	make -C src clean

README.md

@@ -4,12 +4,14 @@
 
 This project involves the development of a framework for running self-contained applications in Python
 on a Raspberry Pi with LCD graphical output and touchscreen input.  The ultimate goal is to produce a
-framework which is flexible enough to serve any number of “appliance” needs, by using different Python
+framework which is flexible enough to serve any number of "appliance" needs, by using different Python
 scripts over the same native-code substrate, deployed on an inexpensive embedded platform.
 
 ## Hardware requirements
 
-- Raspberry Pi 3 with PiTFT touchscreen (Adafruit product ID 2423)
+- Raspberry Pi 3 with PiTFT touchscreen (Adafruit product ID 2423). See
+  [Building the Hardware to Run UPIWIN](docs/hardware-instructions.md) to assemble the hardware, and
+  [Preparing the Operating System for UPIWIN](docs/os-instructions.md) for the system software.
 
 ## Acknowledgements
 

docs/hardware-instructions.md

@@ -0,0 +1,37 @@
+# Building the Hardware to Run UPIWIN
+
+UPIWIN is designed for a hardware configuration with a miniature capacitive-touch touchscreen mounted on a
+Raspberry Pi computer, making for a compact assembly.  This document describes how to assemble one.
+
+## Parts List
+
+- Raspberry Pi 3 Model B+ computer
+- PiTFT Plus 320x240 2.8" Capacitive Touch Touchscreen (Adafruit part number 2423)
+- Pi Model B+/Pi 2 Case Base - Clear (Adafruit part number 2253)
+- PiTFT Faceplate and Buttons (Adafruit part number 2807)
+- 2x Brass M2.5 Standoffs (Adafruit part number 2337)
+- Additional Raspberry Pi hardware (MicroSD card, power supply, keyboard and display connections)
+
+## Assembly Instructions
+
+1. On the back of the PiTFT, solder closed the jumper pads labeled "#18". This will allow the use of GPIO line 18 as
+   a PWM backlight control.
+2. Attach two standoffs to the underside of the PiTFT (pointing in the same direction as the 40-pin connector), on the
+   right side (the side with the pushbutton switches).  Secure with the included nuts.
+3. Attach the PiTFT to the Raspberry Pi, pressing down hard to seat the 40-pin connector atop the Pi's GPIO pins.
+4. Seat the completed assembly inside the case base, lining up the holes for the USB and Ethernet ports on the left
+   side.  Press down to snap the latches into place.
+5. Holding the faceplate upside down, insert four plastic buttons into the four small rectangular slots. Invert the
+   case assembly and snap it together with the faceplate, lining the buttons up with the pushbutton switches.
+6. Connect the Pi to keyboard, display, power, and network (if necessary). Insert the MicroSD card with the operating
+   system installed, and boot as usual.
+
+## Illustrations
+
+### Completed subassembly
+
+![Completed subassembly](subassembly.jpg)
+
+### Completed Assembly
+
+![Completed assembly](complete.jpg)

docs/os-instructions.md

@@ -0,0 +1,64 @@
+# Preparing the Operating System for UPIWIN
+
+The Raspberry Pi OS needs to be configured with the appropriate device tree support, software, and libraries to compile
+and run UPIWIN successfully.  This document describes the process.
+
+## Preparing the Operating System
+
+1. Download an image of Raspberry Pi OS from
+   [the Raspberry Pi Foundation](https://downloads.raspberrypi.org/raspios_armhf/images/). The most-recent version of
+   Raspberry Pi OS that is known to work with the PiTFT is
+   [the December 4, 2020 image](https://downloads.raspberrypi.org/raspios_armhf/images/raspios_armhf-2020-12-04/).
+2. Unzip the `.zip` file for your image and write th included `.img` file to a fresh MicroSD card using one of the
+   methods described on [this page](https://www.raspberrypi.org/documentation/computers/getting-started.html).
+3. Connect your UPIWIN-compatible Raspberry Pi (RPi 3B+ with PiTFT) to power, HDMI display, keyboard, and network
+   (if necessary).  Insert the freshly-written MicroSD card into the Pi.
+4. Turn on the Pi, boot into Raspberry Pi OS, and set it up.  Make sure to get updates installed.
+
+## Installing the PiTFT Drivers
+
+1. In a terminal window, enter the command `sudo -i` to get a root command prompt.
+2. Enter the following commands:
+
+    pip3 install --upgrade adafruit-python-shell click
+    git clone https://github.com/adafruit/Raspberry-Pi-Installer-Scripts.git
+    cd Raspberry-Pi-Installer-Scripts
+    python3 adafruit-pitft.py --display=28c --rotation=90
+
+3. Answer "N" to the questions about the console appearing on the PiTFT display and mirroring HDMI to the PiTFT
+   display.
+4. Reboot the Pi when prompted.
+
+## Installing Libraries for UPIWIN
+
+1. Use `sudo -i` to get a root command prompt.
+2. Execute the command to install packaged libraries:
+
+    apt install python3-dev libfreetype6-dev libpng-dev ttf-mscorefonts-installer
+
+3. Execute the commands to install the BCM2835 library:
+
+    wget http://www.airspayce.com/mikem/bcm2835/bcm2835-1.68.tar.gz
+    tar xzvf bcm2835-1.68.tar.gz
+    cd bcm2835-1.68
+    ./configure
+    make
+    make check
+    make install
+
+4. Copy the Arial font to where the code expects to see it:
+
+    mkdir /usr/local/share/fonts/truetype
+    cp /usr/share/fonts/truetype/msttcorefonts/arial.ttf /usr/local/share/fonts/truetype
+
+## Building the Source
+
+After cloning the repository for UPIWIN, enter the following commands:
+
+    cd upiwin
+    make
+
+The resulting executable and demo scripts will be placed into the `output` directory.
+
+To execute, change to the `output` directory and enter the command `sudo ./upiwin` followed by the name of the script
+to be run. For example, `sudo ./upiwin demo1.py`.

src/Makefile

@@ -17,12 +17,12 @@
 # ------------------------------------------------------------------------
 BUILDUTILS=../buildutils
 RESOURCES=../resources
-SPLASHSCREEN=splash-vmwcblk.png
+SPLASHSCREEN=splash-erbosoft.png
 
 OBJS=main.o sysinput.o ep_init.o ep_upiwin.o ep_backlight.o ep_msg.o ep_graphics.o ep_devctxt.o ep_bitmap.o \
      ep_upiwin_tmp.o ep_util.o fbinit.o rect.o gfxobj.o devctxt.o dc_screen.o fontengine.o \
 	 bitmap.o stockobj.o fbprimitive.o log.o gpio.o msg_queue.o time_func.o config.o \
-	 i_freehand.o i_line.o i_rect.o i_fillrect.o i_undo.o i_clear.o splash.o
+	 i_freehand.o i_line.o i_rect.o i_fillrect.o i_undo.o i_clear.o splash.o sysresources.o
 LIBS=-lpython3.7m -lcrypt -lfreetype -lbcm2835 -lpthread -ldl -lutil -lm
 CFLAGS=-I/usr/include/python3.7m -I/usr/include/freetype2 -I/usr/include/libpng16 \
        -Wall -Werror -fstack-protector -fwrapv -fno-PIE -g -O3 -DDEBUG_ASSERT
@@ -37,6 +37,14 @@ upiwin: $(OBJS)
 .c.o:
 	gcc -c $(CFLAGS) $<
 
+sysresources.o: sysresources.zip
+	objcopy -I binary -O elf32-littlearm -B arm --rename-section \
+		.data=.rodata,alloc,load,readonly,data,contents sysresources.zip sysresources.o
+
+sysresources.zip: splash.bin
+	-rm sysresources.zip
+	zip sysresources.zip splash.bin
+
 %.o: %.bin
 	objcopy -I binary -O elf32-littlearm -B arm --rename-section \
 		.data=.rodata,alloc,load,readonly,data,contents $< $@

src/dc_screen.c

@@ -41,7 +41,7 @@ inline static COLORREF COLORREF_from_native(UINT16 cr)
   return (COLORREF)(((tmp << 19) & 0xF80000) | ((tmp << 5) & 0xFC00) | ((tmp >> 8) & 0xF800));
 }
 
-static inline UINT16 apply_rop2(INT32 op, UINT16 disp, UINT16 pen)
+inline static UINT16 apply_rop2(INT32 op, UINT16 disp, UINT16 pen)
 {
   switch (op)
   {

src/devctxt.h

@@ -25,7 +25,7 @@
 #include "gfxobj.h"
 #include "bitmap.h"
 
-#define DCTXT_SIG_WORD  0x78744344   /* "DCtx */
+#define DCTXT_SIG_WORD  0x78744344   /* "DCtx" */
 
 /* Raster operation codes */
 #define R2_BLACK        1

src/ep_msg.c

@@ -87,4 +87,3 @@ PyObject *Epython_post_quit_message(PyObject *self, PyObject *args)
   Mq_post1(Sys_Queue, 0, WM_QUIT, exitcode);
   Py_RETURN_NONE;
 }
-

src/sysinput.c

@@ -150,12 +150,11 @@ static BOOL poll_touchscreen(void)
     		break;
 
       case EV_ABS:
-	    /* Note that the touchscreen driver assumes the screen is "vertical," so swap the x and y axes */
+        /* The screen driver thinks the screen is horizontal with origin at upper left and max at lower right. */
-		/* Also it thinks origin is lower left with up = +y */
     		if (buffer[i].code == ABS_X)
-		  touch_y = Fb_Info->height - buffer[i].value;
-		else if (buffer[i].code == ABS_Y)
     		  touch_x = buffer[i].value;
+    		else if (buffer[i].code == ABS_Y)
+    		  touch_y = buffer[i].value;
     		break;
 
       case EV_KEY: