mirror of
https://github.com/akuker/RASCSI.git
synced 2024-06-07 13:53:33 +00:00
ea3bb8363a
commit94786aec54
Author: Uwe Seimet <48174652+uweseimet@users.noreply.github.com> Date: Tue Dec 21 08:43:21 2021 +0100 Added support for operation meta data, code cleanup (#534) * Added messages * Comment update * Interface update * Support for localized descriptions * Sort operations * Completed meta data * rasctl -s returns operation meta data * Manpage update * Type update * Comment update * Description updates * Comment update * Added convenience method * Added convenience method * Code cleanup * Comment update * Display permitted values * For completeness sake added permitted boolean values * Added support for default value * Removed redundant message field * Description update * Description upddate * Squashed commit of the following: commit 8171c6ea27982c736c30c0db69a7fdde07ee10ce Author: Uwe Seimet <Uwe.Seimet@seimet.de> Date: Sat Dec 18 12:43:14 2021 +0100 The data type is implicit commit fb01dc9d82e8ff7456b05a0cb9d08069adacc64c Author: Uwe Seimet <Uwe.Seimet@seimet.de> Date: Sat Dec 18 12:37:49 2021 +0100 Renaming commit 057dbf1aca7be3f7e76a5ff89a582a276b6d3089 Author: Uwe Seimet <Uwe.Seimet@seimet.de> Date: Sat Dec 18 12:29:54 2021 +0100 Comment update commit 5f699aad2f835f72accdb445d1e59f094aeb108f Author: Uwe Seimet <Uwe.Seimet@seimet.de> Date: Sat Dec 18 12:24:25 2021 +0100 Signature update commit cbcf8b09f9d1ba7b82f816269bcfe91d9f00eb6e Author: Uwe Seimet <Uwe.Seimet@seimet.de> Date: Sat Dec 18 12:22:45 2021 +0100 Signature update commit a8148ef802ca809e5a305d2caa69856c9033d932 Author: Uwe Seimet <Uwe.Seimet@seimet.de> Date: Sat Dec 18 12:16:46 2021 +0100 Comment update commit ce685a92d4827e131d80d10ecd56e2b3baf173f8 Author: Uwe Seimet <Uwe.Seimet@seimet.de> Date: Sat Dec 18 12:15:46 2021 +0100 Use map instead of list commit 454c0438f3589904f5dbe5253963dd200ea416dd Author: Uwe Seimet <Uwe.Seimet@seimet.de> Date: Sat Dec 18 10:47:36 2021 +0100 Updated size check commit b386dbba4b0262f4f6f02aecb2a1daeffd41f4a2 Author: Uwe Seimet <Uwe.Seimet@seimet.de> Date: Sat Dec 18 01:23:43 2021 +0100 Initial improvements * Default value update * Comment update * Comment update * Map operations by ordinal * Added safeguard against unknown operations * Added cast * Data type update * Sort map by operation name * Renaming * Code cleanup * Comment update * Renaming * Comment update * Description updates * Fixed typo * Added operation * Logging update * Interface comment update * Fixed typo * Aded operation parameters * Updated handling of mandatory parameters * Updated assertion handling * Added missing condition * Removed duplicate cod3 * Code cleanup * Logging update * Removed duplicate code * Code cleanup * Squashed commit of the following: commit4ae273ccbd
Author: akuker <34318535+akuker@users.noreply.github.com> Date: Sun Dec 19 22:30:22 2021 -0600 Loopback tester pcb (#545) commit46c5c1966f
Author: akuker <34318535+akuker@users.noreply.github.com> Date: Sun Dec 19 22:29:59 2021 -0600 RaSCSI Zero version 1.0 (#546) commitd09df31d67
Author: Daniel Markstedt <markstedt@gmail.com> Date: Sun Dec 19 20:25:23 2021 -0800 Remove redundant code from OLED script (#547) commitd8828da690
Author: akuker <34318535+akuker@users.noreply.github.com> Date: Sun Dec 19 21:02:50 2021 -0600 Added list of sponsors commitbcd7e8396d
Author: Daniel Markstedt <markstedt@gmail.com> Date: Sun Dec 19 15:51:45 2021 -0800 Second attempt at properly creating the manpage dir (#542) commitc887edfc8c
Author: Daniel Markstedt <markstedt@gmail.com> Date: Sun Dec 19 15:50:03 2021 -0800 Remove special elevated privileges for the Web Interface (#536) * Use the pi_shutdown method to restart the rascsi service * Use the pi_shutdown method to restart the rascsi service * Remove modifications to sudoers no longer needed * Introduce sleeps attempting to connect to socket; reduce overall number of retries * Remove systemd helped methods and the functionality that depends on it * Attempts to speed up splash code * Remove unneccessary verbosity * Attempt to optimize service definition commit801aebfb96
Author: Daniel Markstedt <markstedt@gmail.com> Date: Sun Dec 19 15:47:22 2021 -0800 More readable message when downloading a file (#531) commit29cf58288f
Author: Daniel Markstedt <markstedt@gmail.com> Date: Sun Dec 19 15:47:03 2021 -0800 Add a warning notice when ejecting removable media (#526) commit7efa895239
Author: Daniel Markstedt <markstedt@gmail.com> Date: Sun Dec 19 15:46:22 2021 -0800 Unzip zipfiles before storing to iso (#525) * Unzip zipfiles before storing to iso * Add helptext * Skip unzip for MacZip format * Should not be an fstring commit39bc485671
Author: Daniel Markstedt <markstedt@gmail.com> Date: Sun Dec 19 15:28:22 2021 -0800 Add pip3 to global dependencies; remove duplicates from monitor_rascs… (#523) * Add pip3 to global dependencies; remove duplicates from monitor_rascsi dependencies * Cleanup * Shutdown functionality is only available if started with root permissions * Only restrict shutdown parameters, not everything if not root * Updated operation count check commit693ade2967
Author: Daniel Markstedt <markstedt@gmail.com> Date: Mon Dec 20 12:04:23 2021 -0800 Bump Macproxy version to 21.12.2 (#550) commit958fb95908
Author: akuker <34318535+akuker@users.noreply.github.com> Date: Mon Dec 20 12:50:14 2021 -0600 Adjust bus settle delay to match SCSI standard (#544) * Move the GCC v10 compiler flags into makefile instead of easyinstall.sh * #504 - Update the bus settle time to match the SCSI standard Co-authored-by: RaSCSI User <user@rascsi.com> commit200bc7251f
Author: Daniel Markstedt <markstedt@gmail.com> Date: Mon Dec 20 06:20:22 2021 -0800 More helpful error message when IP does not resolve for OLED screen (#541) * More helpful error message * Remove confusing fallback IP * Tweak message commit4ae273ccbd
Author: akuker <34318535+akuker@users.noreply.github.com> Date: Sun Dec 19 22:30:22 2021 -0600 Loopback tester pcb (#545) commit46c5c1966f
Author: akuker <34318535+akuker@users.noreply.github.com> Date: Sun Dec 19 22:29:59 2021 -0600 RaSCSI Zero version 1.0 (#546) commitd09df31d67
Author: Daniel Markstedt <markstedt@gmail.com> Date: Sun Dec 19 20:25:23 2021 -0800 Remove redundant code from OLED script (#547) commitd8828da690
Author: akuker <34318535+akuker@users.noreply.github.com> Date: Sun Dec 19 21:02:50 2021 -0600 Added list of sponsors commitbcd7e8396d
Author: Daniel Markstedt <markstedt@gmail.com> Date: Sun Dec 19 15:51:45 2021 -0800 Second attempt at properly creating the manpage dir (#542) commitc887edfc8c
Author: Daniel Markstedt <markstedt@gmail.com> Date: Sun Dec 19 15:50:03 2021 -0800 Remove special elevated privileges for the Web Interface (#536) * Use the pi_shutdown method to restart the rascsi service * Use the pi_shutdown method to restart the rascsi service * Remove modifications to sudoers no longer needed * Introduce sleeps attempting to connect to socket; reduce overall number of retries * Remove systemd helped methods and the functionality that depends on it * Attempts to speed up splash code * Remove unneccessary verbosity * Attempt to optimize service definition commit801aebfb96
Author: Daniel Markstedt <markstedt@gmail.com> Date: Sun Dec 19 15:47:22 2021 -0800 More readable message when downloading a file (#531) commit29cf58288f
Author: Daniel Markstedt <markstedt@gmail.com> Date: Sun Dec 19 15:47:03 2021 -0800 Add a warning notice when ejecting removable media (#526) commit7efa895239
Author: Daniel Markstedt <markstedt@gmail.com> Date: Sun Dec 19 15:46:22 2021 -0800 Unzip zipfiles before storing to iso (#525) * Unzip zipfiles before storing to iso * Add helptext * Skip unzip for MacZip format * Should not be an fstring commit39bc485671
Author: Daniel Markstedt <markstedt@gmail.com> Date: Sun Dec 19 15:28:22 2021 -0800 Add pip3 to global dependencies; remove duplicates from monitor_rascs… (#523) * Add pip3 to global dependencies; remove duplicates from monitor_rascsi dependencies * Cleanup
270 lines
7.4 KiB
Makefile
270 lines
7.4 KiB
Makefile
.DEFAULT_GOAL: all
|
|
|
|
## Optional build flags:
|
|
## CROSS_COMPILE : Specify which compiler toolchain to use.
|
|
## To cross compile set this accordingly, e.g. to:
|
|
## arm-linux-gnueabihf-
|
|
CROSS_COMPILE =
|
|
|
|
CC = $(CROSS_COMPILE)gcc
|
|
CXX = $(CROSS_COMPILE)g++
|
|
|
|
## DEBUG=1 : A Debug build includes the debugger symbols
|
|
## and disables compiler optimization. Typically,
|
|
## this is only used by developers.
|
|
DEBUG ?= 0
|
|
ifeq ($(DEBUG), 1)
|
|
# Debug CFLAGS
|
|
CFLAGS += -O0 -g -Wall -DDEBUG
|
|
CXXFLAGS += -O0 -g -Wall -DDEBUG
|
|
BUILD_TYPE = Debug
|
|
else
|
|
# Release CFLAGS
|
|
CFLAGS += -O3 -Wall -Werror -DNDEBUG
|
|
CXXFLAGS += -O3 -Wall -Werror -DNDEBUG
|
|
BUILD_TYPE = Release
|
|
endif
|
|
CFLAGS += -iquote . -D_FILE_OFFSET_BITS=64 -MD -MP
|
|
CXXFLAGS += -std=c++17 -Wno-psabi -iquote . -D_FILE_OFFSET_BITS=64 -MD -MP
|
|
|
|
## EXTRA_FLAGS : Can be used to pass special purpose flags
|
|
CFLAGS += $(EXTRA_FLAGS)
|
|
CXXFLAGS += $(EXTRA_FLAGS)
|
|
|
|
# If we're using GCC version 10 or later, we need to add the FMT_HEADER_ONLY definition
|
|
GCCVERSION10 := $(shell expr `gcc -dumpversion` \>= 10)
|
|
|
|
ifeq "$(GCCVERSION10)" "1"
|
|
CFLAGS += -DFMT_HEADER_ONLY
|
|
CXXFLAGS += -DFMT_HEADER_ONLY
|
|
endif
|
|
|
|
|
|
|
|
## CONNECT_TYPE=FULLSPEC : Specify the type of RaSCSI board type
|
|
## that you are using. The typical options are
|
|
## STANDARD or FULLSPEC. The default is FULLSPEC
|
|
## * THIS IS TYPICALLY THE ONLY COMPILE OPTION YOU
|
|
## * NEED TO SPECIFY
|
|
# If its not specified, build for FULLSPEC configuration
|
|
CONNECT_TYPE ?= FULLSPEC
|
|
|
|
ifdef CONNECT_TYPE
|
|
CFLAGS += -DCONNECT_TYPE_$(CONNECT_TYPE)
|
|
CXXFLAGS += -DCONNECT_TYPE_$(CONNECT_TYPE)
|
|
endif
|
|
|
|
RASCSI = rascsi
|
|
RASCTL = rasctl
|
|
RASDUMP = rasdump
|
|
SASIDUMP = sasidump
|
|
SCSIMON = scsimon
|
|
|
|
SYSTEMD_CONF = /etc/systemd/system/rascsi.service
|
|
RSYSLOG_CONF = /etc/rsyslog.d/rascsi.conf
|
|
RSYSLOG_LOG = /var/log/rascsi.log
|
|
|
|
USR_LOCAL_BIN = /usr/local/bin
|
|
MAN_PAGE_DIR = /usr/local/man/man1
|
|
DOC_DIR = ../../doc
|
|
OS_FILES = ./os_integration
|
|
|
|
OBJDIR := ./obj/$(shell echo $(CONNECT_TYPE) | tr '[:upper:]' '[:lower:]')
|
|
BINDIR := ./bin/$(shell echo $(CONNECT_TYPE) | tr '[:upper:]' '[:lower:]')
|
|
|
|
BIN_ALL = \
|
|
$(BINDIR)/$(RASCSI) \
|
|
$(BINDIR)/$(RASCTL) \
|
|
$(BINDIR)/$(SCSIMON) \
|
|
$(BINDIR)/$(RASDUMP) \
|
|
$(BINDIR)/$(SASIDUMP)
|
|
|
|
SRC_PROTOC = \
|
|
rascsi_interface.proto
|
|
|
|
SRC_PROTOBUF = \
|
|
rascsi_interface.pb.cpp
|
|
|
|
SRC_RASCSI = \
|
|
rascsi.cpp \
|
|
scsi.cpp \
|
|
gpiobus.cpp \
|
|
filepath.cpp \
|
|
fileio.cpp\
|
|
rascsi_version.cpp \
|
|
rascsi_image.cpp \
|
|
rascsi_response.cpp \
|
|
rasutil.cpp \
|
|
protobuf_util.cpp
|
|
SRC_RASCSI += $(shell find ./controllers -name '*.cpp')
|
|
SRC_RASCSI += $(shell find ./devices -name '*.cpp')
|
|
SRC_RASCSI += $(SRC_PROTOBUF)
|
|
|
|
SRC_SCSIMON = \
|
|
scsimon.cpp \
|
|
scsi.cpp \
|
|
gpiobus.cpp \
|
|
filepath.cpp \
|
|
fileio.cpp \
|
|
rascsi_version.cpp
|
|
|
|
SRC_RASCTL = \
|
|
rasctl.cpp\
|
|
rasctl_commands.cpp \
|
|
rasctl_display.cpp \
|
|
rascsi_version.cpp \
|
|
rasutil.cpp \
|
|
protobuf_util.cpp
|
|
SRC_RASCTL += $(SRC_PROTOBUF)
|
|
|
|
SRC_RASDUMP = \
|
|
rasdump.cpp \
|
|
scsi.cpp \
|
|
gpiobus.cpp \
|
|
filepath.cpp \
|
|
fileio.cpp\
|
|
rascsi_version.cpp
|
|
|
|
SRC_SASIDUMP = \
|
|
sasidump.cpp \
|
|
scsi.cpp \
|
|
gpiobus.cpp \
|
|
filepath.cpp \
|
|
fileio.cpp\
|
|
rascsi_version.cpp
|
|
|
|
vpath %.h ./ ./controllers ./devices
|
|
vpath %.cpp ./ ./controllers ./devices
|
|
vpath %.o ./$(OBJDIR)
|
|
vpath ./$(BINDIR)
|
|
|
|
|
|
OBJ_RASCSI := $(addprefix $(OBJDIR)/,$(notdir $(SRC_RASCSI:%.cpp=%.o)))
|
|
OBJ_RASCTL := $(addprefix $(OBJDIR)/,$(notdir $(SRC_RASCTL:%.cpp=%.o)))
|
|
OBJ_RASDUMP := $(addprefix $(OBJDIR)/,$(notdir $(SRC_RASDUMP:%.cpp=%.o)))
|
|
OBJ_SASIDUMP := $(addprefix $(OBJDIR)/,$(notdir $(SRC_SASIDUMP:%.cpp=%.o)))
|
|
OBJ_SCSIMON := $(addprefix $(OBJDIR)/,$(notdir $(SRC_SCSIMON:%.cpp=%.o)))
|
|
|
|
GEN_PROTOBUF := $(SRC_PROTOBUF) rascsi_interface.pb.h
|
|
|
|
|
|
# The following will include all of the auto-generated dependency files (*.d)
|
|
# if they exist. This will trigger a rebuild of a source file if a header changes
|
|
ALL_DEPS := $(patsubst %.o,%.d,$(OBJ_RASCSI) $(OBJ_RASCTL) $(OBJ_SCSIMON))
|
|
-include $(ALL_DEPS)
|
|
|
|
$(OBJDIR) $(BINDIR):
|
|
echo "-- Creating directory $@"
|
|
mkdir -p $@
|
|
|
|
$(OBJDIR)/%.o: %.cpp | $(OBJDIR)
|
|
$(CXX) $(CXXFLAGS) -c $< -o $@
|
|
|
|
$(SRC_PROTOBUF): $(SRC_PROTOC)
|
|
echo "-- Generating protobuf-based source files"
|
|
protoc --cpp_out=. $(SRC_PROTOC)
|
|
mv rascsi_interface.pb.cc $@
|
|
|
|
## Build Targets:
|
|
## all : Rebuild all of the executable files and re-generate
|
|
## the text versions of the manpages
|
|
## docs : Re-generate the text versions of the man pages
|
|
.DEFAULT_GOAL := all
|
|
.PHONY: all ALL docs
|
|
all: $(BIN_ALL) docs
|
|
ALL: all
|
|
|
|
docs: $(DOC_DIR)/rascsi_man_page.txt $(DOC_DIR)/rasctl_man_page.txt $(DOC_DIR)/scsimon_man_page.txt
|
|
|
|
$(BINDIR)/$(RASCSI): $(SRC_PROTOBUF) $(OBJ_RASCSI) | $(BINDIR)
|
|
$(CXX) $(CXXFLAGS) -o $@ $(OBJ_RASCSI) -lpthread -lz -lpcap -lprotobuf -lstdc++fs
|
|
|
|
$(BINDIR)/$(RASCTL): $(SRC_PROTOBUF) $(OBJ_RASCTL) | $(BINDIR)
|
|
$(CXX) $(CXXFLAGS) -o $@ $(OBJ_RASCTL) -lpthread -lprotobuf -lstdc++fs
|
|
|
|
$(BINDIR)/$(RASDUMP): $(OBJ_RASDUMP) | $(BINDIR)
|
|
$(CXX) $(CXXFLAGS) -o $@ $(OBJ_RASDUMP)
|
|
|
|
$(BINDIR)/$(SASIDUMP): $(OBJ_SASIDUMP) | $(BINDIR)
|
|
$(CXX) $(CXXFLAGS) -o $@ $(OBJ_SASIDUMP)
|
|
|
|
$(BINDIR)/$(SCSIMON): $(OBJ_SCSIMON) | $(BINDIR)
|
|
$(CXX) $(CXXFLAGS) -o $@ $(OBJ_SCSIMON) -lpthread
|
|
|
|
## clean : Remove all of the object files, intermediate
|
|
## compiler files and executable files
|
|
.PHONY: clean
|
|
clean:
|
|
rm -rf $(OBJDIR) $(BINDIR) $(GEN_PROTOBUF)
|
|
|
|
## install : Copies all of the man pages to the correct location
|
|
## Copies the binaries to a global install location
|
|
## Configures the Systemd and RSyslog services to auto-run RaSCSI
|
|
## * This target needs to be run with sudo (ex: sudo make install)
|
|
## * Before running this, you need to stop the rascsi service if
|
|
## * it is already running:
|
|
## * sudo systemctl stop rascsi
|
|
## * After running this, you will need to reboot or run:
|
|
## * sudo systemctl daemon-reload
|
|
## * sudo systemctl restart rsyslog
|
|
## * sudo systemctl enable rascsi
|
|
## * sudo systemctl start rascsi
|
|
.PHONY: install
|
|
install: \
|
|
$(MAN_PAGE_DIR)/rascsi.1 \
|
|
$(MAN_PAGE_DIR)/rasctl.1 \
|
|
$(MAN_PAGE_DIR)/scsimon.1 \
|
|
$(MAN_PAGE_DIR)/rasdump.1 \
|
|
$(MAN_PAGE_DIR)/sasidump.1 \
|
|
$(USR_LOCAL_BIN)/$(RASCTL) \
|
|
$(USR_LOCAL_BIN)/$(RASCSI) \
|
|
$(USR_LOCAL_BIN)/$(SCSIMON) \
|
|
$(USR_LOCAL_BIN)/$(RASDUMP) \
|
|
$(USR_LOCAL_BIN)/$(SASIDUMP) \
|
|
$(SYSTEMD_CONF) \
|
|
$(RSYSLOG_CONF) \
|
|
$(RSYSLOG_LOG)
|
|
@echo "-- Done installing!"
|
|
|
|
$(USR_LOCAL_BIN)% : $(BINDIR)/%
|
|
@echo "-- Copying $@"
|
|
cp $< $@
|
|
|
|
$(MAN_PAGE_DIR)/%.1 : $(DOC_DIR)/%.1 | $(MAN_PAGE_DIR)/
|
|
@echo "-- Copying $@"
|
|
cp $< $@
|
|
|
|
$(DOC_DIR)/%_man_page.txt : $(DOC_DIR)/%.1
|
|
@echo "!! ------ THIS FILE IS AUTO_GENERATED! DO NOT MANUALLY UPDATE!!!" > $@
|
|
@echo "!! ------ The native file is $(notdir $<). Re-run 'make docs' after updating\n\n" >> $@
|
|
man -l $< | col -bx >> $@
|
|
|
|
$(SYSTEMD_CONF) : $(OS_FILES)/$(notdir $(SYSTEMD_CONF))
|
|
@echo "-- Copying $@"
|
|
cp $< $@
|
|
|
|
$(RSYSLOG_CONF) : $(OS_FILES)/$(notdir $(RSYSLOG_CONF))
|
|
@echo "-- Copying $@"
|
|
cp $< $@
|
|
|
|
$(RSYSLOG_LOG) :
|
|
@echo "-- Creating $@"
|
|
touch /var/log/rascsi.log
|
|
chown root:adm /var/log/rascsi.log
|
|
|
|
$(MAN_PAGE_DIR)/:
|
|
echo "-- Creating directory $@"
|
|
mkdir -p $@
|
|
|
|
## help : Lists information about how to use the makefile
|
|
# The help rule is based upon the approach from:
|
|
# https://swcarpentry.github.io/make-novice/08-self-doc/index.html
|
|
.PHONY: help
|
|
help : Makefile
|
|
@sed -n 's/^##//p' $<
|
|
|
|
## Debug : Same as 'all'. Useful when using a debugger.
|
|
.PHONY: Debug
|
|
Debug: all
|
|
|