[Buildroot] [PATCH v4 1/1] package/swupdate: new package

[Buildroot] [PATCH v4 1/1] package/swupdate: new package

[Jörg Krause]

This patch is based on an WIP version submitted by Romain Naour, commented by
Arnout Vandecappelle:
https://patchwork.ozlabs.org/patch/401270/

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.

The package build file does not detect which dependencies are available. So we
provide a default configuration which selects the external dependencies by
default except for lua. Lua support can be added by the user by customizing
the configuration file (swupdate.config) add select the Lua 5.2 interpreter
manually.

Furthermore the U-Boot handler is not enabled by default, as it may cause
runtime issues if the U-Boot environment configuration file (fw_env.config) is
not present on the target system.

The package provides a default website which can be installed to the target to
enable firmware update with a browser.

Note, swupdate does not implement a savedefconfig and nconfig target.
Note, swupdate provides its own customized versions of mongoose and lsqlite3.

Signed-off-by: J?rg Krause <joerg.krause@embedded.rocks>
Cc: Romain Naour <romain.naour@openwide.fr>
Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
Cc: Arnout Vandecappelle <arnout@mind.be>
Tested-by: Mike Williams <mike@mikebwilliams.com>
---
Changes v3 -> v4:
  - bump to latest commit c68f02320858f89f2d441ff2057d49489fb6f586
  - remove lua dependency (Mike, Arnout)
  - remove U-Boot handler in swupdate.config (Arnout)
  - fix CONFIG_SYSROOT (Arnout)
  - pass $(TARGET_MAKE_ENV) to make (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 <joerg.krause@embedded.rocks>
---
 package/Config.in                                  |  1 +
 .../0001-Add-missing-header-for-off_t.patch        | 31 ++++++++
 package/swupdate/Config.in                         | 40 +++++++++++
 package/swupdate/swupdate.config                   | 82 ++++++++++++++++++++++
 package/swupdate/swupdate.mk                       | 53 ++++++++++++++
 5 files changed, 207 insertions(+)
 create mode 100644 package/swupdate/0001-Add-missing-header-for-off_t.patch
 create mode 100644 package/swupdate/Config.in
 create mode 100644 package/swupdate/swupdate.config
 create mode 100644 package/swupdate/swupdate.mk

diff --git a/package/Config.in b/package/Config.in
index afa145e..dd6d44b 100644
--- a/package/Config.in
+++ b/package/Config.in
@@ -1404,6 +1404,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
diff --git a/package/swupdate/0001-Add-missing-header-for-off_t.patch b/package/swupdate/0001-Add-missing-header-for-off_t.patch
new file mode 100644
index 0000000..5c17cf3
--- /dev/null
+++ b/package/swupdate/0001-Add-missing-header-for-off_t.patch
@@ -0,0 +1,31 @@
+From c200a9f1dff41fc476c314674ba92c7869b93e3e Mon Sep 17 00:00:00 2001
+From: Romain Naour <romain.naour@openwide.fr>
+Date: Sun, 7 Sep 2014 17:31:09 +0200
+Subject: [PATCH 1/1] Add missing header for off_t
+MIME-Version: 1.0
+Content-Type: text/plain; charset=UTF-8
+Content-Transfer-Encoding: 8bit
+
+Sent patch upstream:
+https://groups.google.com/d/msg/swupdate/xAZU9fk3qwM/zppNv8Xs-F0J
+
+Signed-off-by: Romain Naour <romain.naour@openwide.fr>
+Signed-off-by: J?rg Krause <joerg.krause@embedded.rocks>
+---
+ include/swupdate.h | 1 +
+ 1 file changed, 1 insertion(+)
+
+diff --git a/include/swupdate.h b/include/swupdate.h
+index dc03a50..5adf36c 100644
+--- a/include/swupdate.h
++++ b/include/swupdate.h
+@@ -20,6 +20,7 @@
+ #ifndef _SWUPDATE_H
+ #define _SWUPDATE_H
+
++#include <sys/types.h>
+ #include <sys/queue.h>
+ #include "flash.h"
+ #include "globals.h"
+--
+2.3.6
diff --git a/package/swupdate/Config.in b/package/swupdate/Config.in
new file mode 100644
index 0000000..a174866
--- /dev/null
+++ b/package/swupdate/Config.in
@@ -0,0 +1,40 @@
+config BR2_PACKAGE_SWUPDATE
+	bool "swupdate"
+	depends on BR2_TOOLCHAIN_HAS_THREADS # OpenSSL
+	select BR2_PACKAGE_LIBCONFIG
+	select BR2_PACKAGE_LIBCURL
+	select BR2_PACKAGE_MTD
+	select BR2_PACKAGE_OPENSSL
+	select BR2_PACKAGE_ZLIB
+	help
+	  swupdate provides a reliable way to update the software on an
+	  embedded system.
+
+	  https://github.com/sbabic/swupdate.git
+
+if BR2_PACKAGE_SWUPDATE
+
+config BR2_PACKAGE_SWUPDATE_CONFIG
+	string "swupdate configuration file"
+	default "package/swupdate/swupdate.config"
+	help
+	  The default swupdate configuration file will enable swupdate with
+	  an image downloader and a webserver, as well as handlers for UBI
+	  volumes, raw NAND or NOR flash, SD cards and shell scripts.
+
+	  Most people will just use the default swupdate configuration file.
+	  However, some people may wish to use their own modified swupdate
+	  configuration file, and will specify their config file location
+	  with this option.
+
+	  Note that if you add lua support in the configuration file you need
+	  the Lua 5.2 interpreter (BR_PACKAGE_LUA_5_2) manually.
+
+config BR2_PACKAGE_SWUPDATE_INSTALL_WEBSITE
+	bool "install default website"
+	help
+	  Install the provided website to /var/www/swupdate.
+endif
+
+comment "swupate support needs toolchain w/ threads"
+	depends on !BR2_TOOLCHAIN_HAS_THREADS
diff --git a/package/swupdate/swupdate.config b/package/swupdate/swupdate.config
new file mode 100644
index 0000000..efb0a23
--- /dev/null
+++ b/package/swupdate/swupdate.config
@@ -0,0 +1,82 @@
+#
+# Automatically generated make config: don't edit
+# swupdate version: 2014.07.0
+# Thu Apr 23 22:15:19 2015
+#
+CONFIG_HAVE_DOT_CONFIG=y
+
+#
+# Swupdate Settings
+#
+
+#
+# General Configuration
+#
+CONFIG_SCRIPTS=y
+# CONFIG_HW_COMPATIBILITY is not set
+CONFIG_HW_COMPATIBILITY_FILE=""
+# CONFIG_LUA is not set
+# CONFIG_FEATURE_SYSLOG is not set
+
+#
+# Build Options
+#
+# CONFIG_STATIC is not set
+CONFIG_CROSS_COMPILER_PREFIX=""
+CONFIG_SYSROOT=""
+CONFIG_EXTRA_CFLAGS=""
+CONFIG_EXTRA_LDFLAGS=""
+CONFIG_EXTRA_LDLIBS=""
+
+#
+# Debugging Options
+#
+# CONFIG_DEBUG is not set
+# CONFIG_DEBUG_PESSIMIZE is not set
+# CONFIG_WERROR is not set
+# CONFIG_NOCLEANUP is not set
+CONFIG_DOWNLOAD=y
+CONFIG_WEBSERVER=y
+
+#
+# Webserver Features
+#
+CONFIG_MONGOOSE=y
+
+#
+# Mongoose Feature
+#
+# CONFIG_MONGOOSELUA is not set
+# CONFIG_MONGOOSESQL is not set
+CONFIG_MONGOOSEIPV6=y
+CONFIG_MONGOOSESSL=y
+
+#
+# Archival Features
+#
+CONFIG_CPIO=y
+CONFIG_GUNZIP=y
+
+#
+# Parser Features
+#
+CONFIG_LIBCONFIG=y
+# CONFIG_LUAEXTERNAL is not set
+# CONFIG_SETEXTPARSERNAME is not set
+CONFIG_EXTPARSERNAME=""
+# CONFIG_SETSWDESCRIPTION is not set
+CONFIG_SWDESCRIPTION=""
+
+#
+# Image Handlers
+#
+CONFIG_UBIVOL=y
+CONFIG_UBIBLACKLIST=""
+CONFIG_UBIVIDOFFSET=0
+CONFIG_CFI=y
+CONFIG_RAW=y
+# CONFIG_LUASCRIPTHANDLER is not set
+CONFIG_SHELLSCRIPTHANDLER=y
+# CONFIG_HANDLER_IN_LUA is not set
+# CONFIG_UBOOT is not set
+CONFIG_UBOOT_FWENV=""
diff --git a/package/swupdate/swupdate.mk b/package/swupdate/swupdate.mk
new file mode 100644
index 0000000..71ae888
--- /dev/null
+++ b/package/swupdate/swupdate.mk
@@ -0,0 +1,53 @@
+################################################################################
+#
+# swupdate
+#
+################################################################################
+
+SWUPDATE_VERSION = c68f02320858f89f2d441ff2057d49489fb6f586
+SWUPDATE_SITE = $(call github,sbabic,swupdate,$(SWUPDATE_VERSION))
+SWUPDATE_LICENSE = GPLv2+
+SWUPDATE_LICENSE_FILES = COPYING
+
+# swupdate bundles its own mongoose and lsqlite3 versions
+SWUPDATE_DEPENDENCIES = libconfig libcurl mtd openssl zlib
+
+SWUPDATE_BUILD_CONFIG = $(@D)/.config
+
+SWUPDATE_KCONFIG_FILE = $(call qstrip,$(BR2_PACKAGE_SWUPDATE_CONFIG))
+SWUPDATE_KCONFIG_EDITORS = menuconfig xconfig gconfig
+
+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_COMPILER_PREFIX,"$(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) $(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))
-- 
2.3.6

[Buildroot] [PATCH v4 1/1] package/swupdate: new package

[Yann E. MORIN]

J?rg, All,

On 2015-04-25 01:02 +0200, J?rg Krause spake thusly:
> This patch is based on an WIP version submitted by Romain Naour, commented by
> Arnout Vandecappelle:
> https://patchwork.ozlabs.org/patch/401270/
> 
> 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.
> 
> The package build file does not detect which dependencies are available. So we
> provide a default configuration which selects the external dependencies by
> default except for lua. Lua support can be added by the user by customizing
> the configuration file (swupdate.config) add select the Lua 5.2 interpreter
> manually.
> 
> Furthermore the U-Boot handler is not enabled by default, as it may cause
> runtime issues if the U-Boot environment configuration file (fw_env.config) is
> not present on the target system.
> 
> The package provides a default website which can be installed to the target to
> enable firmware update with a browser.
> 
> Note, swupdate does not implement a savedefconfig and nconfig target.
> Note, swupdate provides its own customized versions of mongoose and lsqlite3.
> 
> Signed-off-by: J?rg Krause <joerg.krause@embedded.rocks>
> Cc: Romain Naour <romain.naour@openwide.fr>
> Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
> Cc: Arnout Vandecappelle <arnout@mind.be>
> Tested-by: Mike Williams <mike@mikebwilliams.com>
> ---
[--SNIP--]
> diff --git a/package/swupdate/Config.in b/package/swupdate/Config.in
> new file mode 100644
> index 0000000..a174866
> --- /dev/null
> +++ b/package/swupdate/Config.in
> @@ -0,0 +1,40 @@
> +config BR2_PACKAGE_SWUPDATE
> +	bool "swupdate"
> +	depends on BR2_TOOLCHAIN_HAS_THREADS # OpenSSL
> +	select BR2_PACKAGE_LIBCONFIG
> +	select BR2_PACKAGE_LIBCURL
> +	select BR2_PACKAGE_MTD
> +	select BR2_PACKAGE_OPENSSL
> +	select BR2_PACKAGE_ZLIB
> +	help
> +	  swupdate provides a reliable way to update the software on an
> +	  embedded system.
> +
> +	  https://github.com/sbabic/swupdate.git

We prefer to point to the homepage when it exists, rather than to the
git tree:
    https://sbabic.github.io/swupdate/

> +if BR2_PACKAGE_SWUPDATE
> +
> +config BR2_PACKAGE_SWUPDATE_CONFIG
> +	string "swupdate configuration file"
> +	default "package/swupdate/swupdate.config"
> +	help
> +	  The default swupdate configuration file will enable swupdate with
> +	  an image downloader and a webserver, as well as handlers for UBI
> +	  volumes, raw NAND or NOR flash, SD cards and shell scripts.
> +
> +	  Most people will just use the default swupdate configuration file.
> +	  However, some people may wish to use their own modified swupdate
> +	  configuration file, and will specify their config file location
> +	  with this option.
> +
> +	  Note that if you add lua support in the configuration file you need
> +	  the Lua 5.2 interpreter (BR_PACKAGE_LUA_5_2) manually.

Something's weird in this sentence. What about:

    Note that if you add lua support in the configuration file, you will
    have to enable the Lua 5.2 interpreter (BR_PACKAGE_LUA_5_2).

[--SNIP--]
> diff --git a/package/swupdate/swupdate.mk b/package/swupdate/swupdate.mk
> new file mode 100644
> index 0000000..71ae888
> --- /dev/null
> +++ b/package/swupdate/swupdate.mk
> @@ -0,0 +1,53 @@
> +################################################################################
> +#
> +# swupdate
> +#
> +################################################################################
> +
> +SWUPDATE_VERSION = c68f02320858f89f2d441ff2057d49489fb6f586
> +SWUPDATE_SITE = $(call github,sbabic,swupdate,$(SWUPDATE_VERSION))
> +SWUPDATE_LICENSE = GPLv2+

In fact, there are a few other licenses. For example, the copies of
Mongoose and lsqlite3 they bundle are MIT; the sqlite3 aggregated source
file is public domain ("The author disclaims copyright to this source
code.").

> +SWUPDATE_LICENSE_FILES = COPYING
> +
> +# swupdate bundles its own mongoose and lsqlite3 versions

Is it possible to make it use external versions, or does it only support
using its bundled ones?

If that's possible, we prefer that.

Regards,
Yann E. MORIN.

-- 
.-----------------.--------------------.------------------.--------------------.
|  Yann E. MORIN  | Real-Time Embedded | /"\ ASCII RIBBON | Erics' conspiracy: |
| +33 662 376 056 | Software  Designer | \ / CAMPAIGN     |  ___               |
| +33 223 225 172 `------------.-------:  X  AGAINST      |  \e/  There is no  |
| http://ymorin.is-a-geek.org/ | _/*\_ | / \ HTML MAIL    |   v   conspiracy.  |
'------------------------------^-------^------------------^--------------------'

[Buildroot] [PATCH v4 1/1] package/swupdate: new package

[Thomas Petazzoni]

Dear Yann E. MORIN,

On Sat, 25 Apr 2015 12:22:32 +0200, Yann E. MORIN wrote:

> > +SWUPDATE_VERSION = c68f02320858f89f2d441ff2057d49489fb6f586
> > +SWUPDATE_SITE = $(call github,sbabic,swupdate,$(SWUPDATE_VERSION))
> > +SWUPDATE_LICENSE = GPLv2+
> 
> In fact, there are a few other licenses. For example, the copies of
> Mongoose and lsqlite3 they bundle are MIT; the sqlite3 aggregated source
> file is public domain ("The author disclaims copyright to this source
> code.").

Do we care about this? If the all thing is then linked with GPLv2 code,
then the result is GPLv2 license, no?

Indeed, the authors of the MIT licensed code should get credited (by
means of a file in <pkg>_LICENSE_FILES), but I'm not sure we need to
mention MIT and public domain in <pkg>_LICENSE.

Thomas
-- 
Thomas Petazzoni, CTO, Free Electrons
Embedded Linux, Kernel and Android engineering
http://free-electrons.com

[Buildroot] [PATCH v4 1/1] package/swupdate: new package

[Romain Naour]

Hi J?rg, Yann, all

Le 25/04/2015 12:22, Yann E. MORIN a ?crit :
> J?rg, All,
> 
> On 2015-04-25 01:02 +0200, J?rg Krause spake thusly:
>> This patch is based on an WIP version submitted by Romain Naour, commented by
>> Arnout Vandecappelle:
>> https://patchwork.ozlabs.org/patch/401270/
>>
>> 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.
>>
>> The package build file does not detect which dependencies are available. So we
>> provide a default configuration which selects the external dependencies by
>> default except for lua. Lua support can be added by the user by customizing
>> the configuration file (swupdate.config) add select the Lua 5.2 interpreter
>> manually.
>>
>> Furthermore the U-Boot handler is not enabled by default, as it may cause
>> runtime issues if the U-Boot environment configuration file (fw_env.config) is
>> not present on the target system.
>>
>> The package provides a default website which can be installed to the target to
>> enable firmware update with a browser.
>>
>> Note, swupdate does not implement a savedefconfig and nconfig target.
>> Note, swupdate provides its own customized versions of mongoose and lsqlite3.
>>
>> Signed-off-by: J?rg Krause <joerg.krause@embedded.rocks>
>> Cc: Romain Naour <romain.naour@openwide.fr>
>> Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
>> Cc: Arnout Vandecappelle <arnout@mind.be>
>> Tested-by: Mike Williams <mike@mikebwilliams.com>
>> ---

[snip]

> 
>> +SWUPDATE_LICENSE_FILES = COPYING
>> +
>> +# swupdate bundles its own mongoose and lsqlite3 versions
> 
> Is it possible to make it use external versions, or does it only support
> using its bundled ones?

I tried to add mongoose dependency at first but it seems it use an embedded copy
of mongoose and lsqlite3 when CONFIG_MONGOOSE and CONFIG_MONGOOSESQL are set in
the config file.

See the last Arnout's comment (https://patchwork.ozlabs.org/patch/401270):
"Doesn't swupdate use an embedded mongoose? I.e., doesn't it link with it?"

Best regards,
Romain
> 
> If that's possible, we prefer that.
> 
> Regards,
> Yann E. MORIN.
> 

[Buildroot] [PATCH v4 1/1] package/swupdate: new package

[Jörg Krause]

Hi Yann,

On Sa, 2015-04-25 at 12:22 +0200, Yann E. MORIN wrote:
> J?rg, All,
> 

[snip]

> 
> We prefer to point to the homepage when it exists, rather than to the
> git tree:
>     https://sbabic.github.io/swupdate/

Ok.

> 
> > +if BR2_PACKAGE_SWUPDATE
> > +
> > +config BR2_PACKAGE_SWUPDATE_CONFIG
> > +   string "swupdate configuration file"
> > +   default "package/swupdate/swupdate.config"
> > +   help
> > +     The default swupdate configuration file will enable 
> > swupdate with
> > +     an image downloader and a webserver, as well as 
> > handlers for UBI
> > +     volumes, raw NAND or NOR flash, SD cards and shell 
> > scripts.
> > +
> > +     Most people will just use the default swupdate 
> > configuration file.
> > +     However, some people may wish to use their own modified 
> > swupdate
> > +     configuration file, and will specify their config file 
> > location
> > +     with this option.
> > +
> > +     Note that if you add lua support in the configuration 
> > file you need
> > +     the Lua 5.2 interpreter (BR_PACKAGE_LUA_5_2) manually.
> 
> Something's weird in this sentence. What about:
> 
>     Note that if you add lua support in the configuration file, you 
> will
>     have to enable the Lua 5.2 interpreter (BR_PACKAGE_LUA_5_2).

Ok.

> 
> [--SNIP--]
> > diff --git a/package/swupdate/swupdate.mk 
> > b/package/swupdate/swupdate.mk
> > new file mode 100644
> > index 0000000..71ae888
> > --- /dev/null
> > +++ b/package/swupdate/swupdate.mk
> > @@ -0,0 +1,53 @@
> > +##################################################################
> > ##############
> > +#
> > +# swupdate
> > +#
> > +##################################################################
> > ##############
> > +
> > +SWUPDATE_VERSION = c68f02320858f89f2d441ff2057d49489fb6f586
> > +SWUPDATE_SITE = $(call github,sbabic,swupdate,$(SWUPDATE_VERSION))
> > +SWUPDATE_LICENSE = GPLv2+
> 
> In fact, there are a few other licenses. For example, the copies of
> Mongoose and lsqlite3 they bundle are MIT; the sqlite3 aggregated 
> source
> file is public domain ("The author disclaims copyright to this source
> code.").

I see. So I'll add MIT and Public Domain, right?

> > +SWUPDATE_LICENSE_FILES = COPYING
> > +
> > +# swupdate bundles its own mongoose and lsqlite3 versions
> 
> Is it possible to make it use external versions, or does it only 
> support
> using its bundled ones?
> 
> If that's possible, we prefer that.

swupdate bundles with mongoose 3.8 (2013) and lsqlite3 0.8 (2011)
versions. I'm not sure it will work with recent versions.

Best regards
J?rg Krause