package/swupdate: new package

swupdate provides a reliable way to update the software on an embedded system.

We use the latest commit of swupdate instead of the last release 2014.07 to obtain several bug fixes and get support for the image downloading feature and the JSON parser.

Note that swupdates has a reworked Kbuild/Kconfig system since the last submitted v6 [1]. Now it has support for the 'option' and 'env' symbols as well for the 'savedefconfig' target. This makes dependency handling much easier. We're now able to pass which dependencies are available through the environment, as already suggested by Arnout Vandecappelle in v2 [2].

Despite of the previous configurations, where all package dependencies except Lua were selected by default, swupdate only requires now only one dependency to get a reasonable firmware update system consisting of an embedded webserver, a parser (based either on libconfig, json-c or Lua), and a handler for raw NAND or NOR flash.

The user can modify this configuration by selecting the appropriate dependencies before running make swupdate-menuconfig. The necessary packages are described in the help text.

This package also installs a default website by default to get a working setup in conjunction with the embedded webserver.

Note, swupdate provides its own versions of mongoose and lsqlite3:
- mongoose is version 3.8 from year 2013
- lsqlite3 is version 0.8 from year 2011

This patch is based on a WIP version submitted by Romain Naour, commented by Arnout Vandecappelle [3].

[1]
http://patchwork.ozlabs.org/patch/467854/

[2]
http://lists.busybox.net/pipermail/buildroot/2015-March/122981.html

[3]
https://patchwork.ozlabs.org/patch/401270/

Signed-off-by J?rg Krause <[email protected]>

Cc Romain Naour <[email protected]>

Cc Thomas Petazzoni <[email protected]>

Cc Arnout Vandecappelle <[email protected]>

Cc Yann E. MORIN <[email protected]>

Tested-by Mike Williams <[email protected]>

---
Changes v6 -> v7:
- bump to latest commit
- use the updated Kbuild/Kconfig infrastructure of swupdate to pass the dependencies through the environment (suggested by Arnout)
- only select libconfig (if not json-c or Lua 5.2 is selected) as dependency
- provide a new configuration file for getting a reasonable swupdate configuration
- select BR2_PACKAGE_SWUPDATE_INSTALL_WEBSITE by default to get a working default swupdate setup
- rewrite help text
- rewrite commit log

Changes v5 -> v6:
- bump to latest commit package/swupdate/0001-Fix-musl-build.patch
- remove upstream applied musl patch

Changes v4 -> v5:
- bump to latest commit 524e3d729267fd430f539eb65e8a710abd89d0f4
- enable new feature JSON parser in .config and add dependency for json-c
- remove upstream applied patch "Add missing header for off_t"
- add musl patch
- point to the homepage in help text (Yann)
- add MIT and Public Domain to LICENSE (Yann), maybe not necessary (Thomas)
- clarify used versions of bundled mongoose and lsqlite3

Changes v3 -> v4:
- bump to latest commit c68f02320858f89f2d441ff2057d49489fb6f586
- remove lua dependency (Mike, Arnout)
- remove U-Boot handler in swupdate.config (Arnout)
- align help text
- sent patch upstream

Changes v2 -> v3:
- bump to latest commit d7753be4fd8bdf2ba4ba56ee869550663b2cca80
- enable all dependencies (Arnout)
- rewrite help text for configuration file
- add option to install default website

Changes v1 -> v2:
- bump to latest commit d9f58b5a3263b1b00c6d011cd8cdd65e69890b46
- update Sob email address

Signed-off-by J?rg Krause <[email protected]>

---
 package/Config.in                |   1 +
 package/swupdate/Config.in       |  50 ++++++++++++++++++
 package/swupdate/swupdate.config |  61 ++++++++++++++++++++++
 package/swupdate/swupdate.mk     | 106 +++++++++++++++++++++++++++++++++++++++
 4 files changed, 218 insertions(+)
 create mode 100644 package/swupdate/Config.in
 create mode 100644 package/swupdate/swupdate.config
 create mode 100644 package/swupdate/swupdate.mk

package/Config.in +1 -0

index 86a53c8..e8770fe 100644
@@ -1443,6 +1443,7 @@ if BR2_PACKAGE_BUSYBOX_SHOW_OTHERS
 	source "package/start-stop-daemon/Config.in"
 endif
 	source "package/supervisor/Config.in"
+	source "package/swupdate/Config.in"
 if BR2_PACKAGE_BUSYBOX_SHOW_OTHERS
 	source "package/sysklogd/Config.in"
 endif

package/swupdate/Config.in new file +0 -0

new file mode 100644
index 0000000..e120200

package/swupdate/Config.in new file +48 -0

+	# swupdate requires a parser and uses libconfig as default
+	select BR2_PACKAGE_LIBCONFIG if !BR2_PACKAGE_JSON_C && !BR2_PACKAGE_LUA_5_2
+	help
+	  swupdate provides a reliable way to update the software on an
+	  embedded system.
+
+	  swupdate is highly configurable to fit the targets requirements and
+	  to minimize the footprint. The provided default configuration file
+	  BR2_PACKAGE_SWUPDATE_CONFIG will enable swupdate with an embedded
+	  webserver, a parser and a handler for raw NAND or NOR flash.
+
+	  The default configuration file builds a reasonable firmware update
+	  system with minimal external dependencies in my mind. If you like to
+	  use your own modified configuration, you have to select the
+	  necessary packages manually:
+
+	  * Select BR2_PACKAGE_LUA_5_2 if you want to have Lua support.
+	  * Select BR2_LIBCURL if you want to use the download feature.
+	  * Select BR2_PACKAGE_OPENSSL is you want to add encryptions support
+	    to the webserver.
+	  * Select BR2_PACKAGE_MTD if you want to use swupdate with UBI
+	    partitions.
+	  * Select BR2_PACKAGE_ZLIB if you want to deal with zip compressed
+	    archives.
+
+	  https://sbabic.github.io/swupdate
+
+if BR2_PACKAGE_SWUPDATE
+
+config BR2_PACKAGE_SWUPDATE_CONFIG
+	string "swupdate configuration file"
+	default "package/swupdate/swupdate.config"
+	help
+	  Path to the swupdate configuration file.
+
+	  I you wish to use your own modified swupdate configuration file
+	  specify the config file location with this option.
+
+config BR2_PACKAGE_SWUPDATE_INSTALL_WEBSITE
+	bool "install default website"
+	default y
+	help
+	  Install the provided website to /var/www/swupdate.
+
+	  This is necessary if you want to run swupdate with the embedded
+	  webserver and do not provide an own website to be installed to
+	  /var/www/swupdate.
+endif

package/swupdate/swupdate.config new file +61 -0

new file mode 100644
index 0000000..bac7a58
@@ -0,0 +1,61 @@
+#
+# Automatically generated file; DO NOT EDIT.
+# Swupdate Configuration
+#
+CONFIG_HAVE_DOT_CONFIG=y
+
+#
+# Swupdate Settings
+#
+
+#
+# General Configuration
+#
+CONFIG_SCRIPTS=y
+# CONFIG_HW_COMPATIBILITY is not set
+# CONFIG_FEATURE_SYSLOG is not set
+
+#
+# Build Options
+#
+# CONFIG_STATIC is not set
+CONFIG_CROSS_COMPILE=""
+CONFIG_SYSROOT=""
+CONFIG_EXTRA_CFLAGS=""
+CONFIG_EXTRA_LDFLAGS=""
+CONFIG_EXTRA_LDLIBS=""
+
+#
+# Debugging Options
+#
+# CONFIG_DEBUG is not set
+# CONFIG_WERROR is not set
+# CONFIG_NOCLEANUP is not set
+CONFIG_WEBSERVER=y
+
+#
+# Webserver Features
+#
+CONFIG_MONGOOSE=y
+
+#
+# Mongoose Feature
+#
+CONFIG_MONGOOSEIPV6=y
+
+#
+# Archival Features
+#
+CONFIG_CPIO=y
+
+#
+# Parser Features
+#
+# CONFIG_SETSWDESCRIPTION is not set
+
+#
+# Image Handlers
+#
+CONFIG_RAW=y
+# CONFIG_SHELLSCRIPTHANDLER is not set
+# CONFIG_UBOOT is not set

package/swupdate/swupdate.mk new file +0 -0

new file mode 100644
index 0000000..3a2a057

package/swupdate/swupdate.mk new file +17 -0

+SWUPDATE_SITE = $(call github,sbabic,swupdate,$(SWUPDATE_VERSION))
+SWUPDATE_LICENSE = GPLv2+, MIT, Public Domain
+SWUPDATE_LICENSE_FILES = COPYING
+
+# swupdate bundles its own version of mongoose (version 3.8) and
+# lsqlite3 (version 0.8)
+
+ifeq ($(BR2_PACKAGE_JSON_C),y)
+SWUPDATE_DEPENDENCIES += json-c
+SWUPDATE_MAKE_ENV += HAVE_JSON_C=y
+else
+SWUPDATE_MAKE_ENV += HAVE_JSON_C=n
+endif
+
+ifeq ($(BR2_PACKAGE_LIBCONFIG),y)
+SWUPDATE_DEPENDENCIES += libconfig
+SWUPDATE_MAKE_ENV += HAVE_LIBCONFIG=y

package/swupdate/swupdate.mk new file +72 -0

+
+ifeq ($(BR2_PACKAGE_LUA_5_2),y)
+SWUPDATE_DEPENDENCIES += lua
+SWUPDATE_MAKE_ENV += HAVE_LUA=y
+else
+SWUPDATE_MAKE_ENV += HAVE_LUA=n
+endif
+
+ifeq ($(BR2_PACKAGE_MTD),y)
+SWUPDATE_DEPENDENCIES += mtd
+SWUPDATE_MAKE_ENV += HAVE_LIBMTD=y
+SWUPDATE_MAKE_ENV += HAVE_LIBUBI=y
+else
+SWUPDATE_MAKE_ENV += HAVE_LIBMTD=n
+SWUPDATE_MAKE_ENV += HAVE_LIBUBI=n
+endif
+
+ifeq ($(BR2_PACKAGE_OPENSSL),y)
+SWUPDATE_DEPENDENCIES += openssl
+SWUPDATE_MAKE_ENV += HAVE_LIBSSL=y
+SWUPDATE_MAKE_ENV += HAVE_LIBCRYPTO=y
+else
+SWUPDATE_MAKE_ENV += HAVE_LIBSSL=n
+SWUPDATE_MAKE_ENV += HAVE_LIBCRYPTO=n
+endif
+
+ifeq ($(BR2_PACKAGE_ZLIB),y)
+SWUPDATE_DEPENDENCIES += zlib
+SWUPDATE_MAKE_ENV += HAVE_ZLIB=y
+else
+SWUPDATE_MAKE_ENV += HAVE_ZLIB=n
+endif
+
+SWUPDATE_BUILD_CONFIG = $(@D)/.config
+
+SWUPDATE_KCONFIG_FILE = $(call qstrip,$(BR2_PACKAGE_SWUPDATE_CONFIG))
+SWUPDATE_KCONFIG_EDITORS = menuconfig xconfig gconfig nconfig
+
+ifeq ($(BR2_PREFER_STATIC_LIB),y)
+define SWUPDATE_PREFER_STATIC
+	$(call KCONFIG_ENABLE_OPT,CONFIG_STATIC,$(SWUPDATE_BUILD_CONFIG))
+endef
+endif
+
+define SWUPDATE_SET_BUILD_OPTIONS
+	$(call KCONFIG_SET_OPT,CONFIG_CROSS_COMPILE,"$(TARGET_CROSS)", \
+		$(SWUPDATE_BUILD_CONFIG))
+	$(call KCONFIG_SET_OPT,CONFIG_SYSROOT,"$(STAGING_DIR)", \
+		$(SWUPDATE_BUILD_CONFIG))
+	$(call KCONFIG_SET_OPT,CONFIG_EXTRA_CFLAGS,"$(TARGET_CFLAGS)", \
+		$(SWUPDATE_BUILD_CONFIG))
+	$(call KCONFIG_SET_OPT,CONFIG_EXTRA_LDFLAGS,"$(TARGET_LDFLAGS)", \
+		$(SWUPDATE_BUILD_CONFIG))
+endef
+
+define SWUPDATE_KCONFIG_FIXUP_CMDS
+	$(SWUPDATE_PREFER_STATIC)
+	$(SWUPDATE_SET_BUILD_OPTIONS)
+endef
+
+define SWUPDATE_BUILD_CMDS
+	$(TARGET_MAKE_ENV) $(SWUPDATE_MAKE_ENV) $(MAKE) -C $(@D)
+endef
+
+define SWUPDATE_INSTALL_TARGET_CMDS
+	$(INSTALL) -D -m 0755 $(@D)/swupdate $(TARGET_DIR)/usr/bin/swupdate
+	$(if $(BR2_PACKAGE_SWUPDATE_INSTALL_WEBSITE), \
+		mkdir -p $(TARGET_DIR)/var/www/swupdate; \
+		cp -dpf $(@D)/www/* $(TARGET_DIR)/var/www/swupdate)
+endef
+
+$(eval $(kconfig-package))

Hi J?rg,

Can you check for toolchain dependencies ?

swupdate seems depends on BR2_TOOLCHAIN_HAS_THREADS since pthread functions are used all over the place.

Also, when mongoose web server is enable swupdate must also depends on BR2_USE_MMU.
I don't know if swupdate can really be used in a mmu less system, so it's ok if
swupdate depends on BR2_USE_MMU even when mongoose support is disabled.

Some days after your sent this patch, the 2015.07 release has been tagged in the
repository. It's only 3 commits after this one.

It not obvious that you must enable CONFIG_DOWNLOAD in swupdate
config to use
libcurl. I don't know how to express this dependency, so a comment is welcome here.

Have you tried to use $(call
KCONFIG_ENABLE_OPT,CONFIG_DOWNLOAD,$(@D)/.config)
in KCONFIG_FIXUP_CMDS ?

Sorry for the late review.

Quoted 1 line

Hi J?rg,

[snip]

Quoted 11 lines

Can you check for toolchain dependencies ?

swupdate seems depends on BR2_TOOLCHAIN_HAS_THREADS since pthread functions are used all over the place.

Also, when mongoose web server is enable swupdate must also depends on BR2_USE_MMU.
I don't know if swupdate can really be used in a mmu less system, so it's ok if
swupdate depends on BR2_USE_MMU even when mongoose support is disabled.

You're right! I'll add those dependencies.

[snip]

Quoted 3 lines

Some days after your sent this patch, the 2015.07 release has been tagged in the
repository. It's only 3 commits after this one.

I'll update to this version.

[snip]

Quoted 5 lines

It not obvious that you must enable CONFIG_DOWNLOAD in swupdate
config to use
libcurl. I don't know how to express this dependency, so a comment is welcome here.

Actually, you've to select libcurl first to be able to enable CONFIG_DOWNLOAD. A comment about this is in the help text.

Quoted 4 lines

Have you tried to use $(call
KCONFIG_ENABLE_OPT,CONFIG_DOWNLOAD,$(@D)/.config)
in KCONFIG_FIXUP_CMDS ?

I followed Arnouts suggestion [1] to remove all the user options that update the .config file as the user can just make swupdate-menuconfig. The help text tells the user which other packages may be of interest.

Quoted 2 lines

Sorry for the late review.

Never mind! Thanks for the review!

[1]
http://patchwork.ozlabs.org/patch/451763/

Hi J?rg,

IIUC, the swupdate-menuconfig will not display some options if corresponding
dependencies are not meet. This is great!

But what do you think about a comment in the swupdate Kconfig ? Something like (untested):

config DOWNLOAD
bool "Enable image downloading"
default n
depends on HAVE_LIBCURL
help
Enable update from image URL using libcurl. Files are
downloaded
completely before installation begins.

comment "image downloading needs libcurl"
depends on !HAVE_LIBCURL