├── overlay ├── etc │ ├── hwrevision │ ├── fw_env.config │ ├── init.d │ │ └── S99verify_update │ └── fstab ├── opt │ └── scripts │ │ ├── invalidate_update.sh │ │ ├── save_env │ │ ├── boot.sh │ │ ├── change_application_part.sh │ │ ├── rootfs_verification.sh │ │ ├── app_verification.sh │ │ ├── lauch_update.sh │ │ └── get_archive_name.sh └── usr │ └── sbin │ └── verify_update ├── mountpoint └── data │ ├── update_files │ ├── invalid_update │ └── current_versions │ ├── current_application_part │ ├── config │ └── env_var ├── doc ├── check_update.png ├── resume_update.png └── Schema simplifie.png ├── .gitmodules ├── rpi-scripts ├── uboot.env ├── uboot_env.img ├── post-build.sh ├── create_img.sh ├── post-image.sh ├── config.txt ├── genimage-rpi-scripts.cfg └── uboot_env.hush ├── external.mk ├── Config.in ├── toolchain └── defconfig ├── Makefile ├── Makefile.toolchain ├── patch └── 0001-fix-config-file-loading-in-env-library.patch ├── package └── swupdate-custom │ ├── swupdate-custom.config │ ├── Config.in │ └── swupdate-custom.mk ├── defconfig ├── swupdate ├── create-archive.sh └── sw-description ├── README.md ├── common.mk └── LICENSE /overlay/etc/hwrevision: -------------------------------------------------------------------------------- 1 | rpi revA 2 | -------------------------------------------------------------------------------- /mountpoint/data/update_files/invalid_update: -------------------------------------------------------------------------------- 1 | 2 | -------------------------------------------------------------------------------- /mountpoint/data/current_application_part: -------------------------------------------------------------------------------- 1 | /dev/mmcblk0p5 2 | -------------------------------------------------------------------------------- /overlay/etc/fw_env.config: -------------------------------------------------------------------------------- 1 | /mnt/uboot.env 0x0000 0x4000 0x4000 2 | -------------------------------------------------------------------------------- /mountpoint/data/update_files/current_versions: -------------------------------------------------------------------------------- 1 | Application=1.0.0 2 | Rootfs=1.0.0 3 | -------------------------------------------------------------------------------- /doc/check_update.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rboussel/SWUpdate-rpi-demo/HEAD/doc/check_update.png -------------------------------------------------------------------------------- /.gitmodules: -------------------------------------------------------------------------------- 1 | [submodule "buildroot"] 2 | path = buildroot 3 | url = git://git.buildroot.net/buildroot 4 | -------------------------------------------------------------------------------- /doc/resume_update.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rboussel/SWUpdate-rpi-demo/HEAD/doc/resume_update.png -------------------------------------------------------------------------------- /rpi-scripts/uboot.env: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rboussel/SWUpdate-rpi-demo/HEAD/rpi-scripts/uboot.env -------------------------------------------------------------------------------- /doc/Schema simplifie.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rboussel/SWUpdate-rpi-demo/HEAD/doc/Schema simplifie.png -------------------------------------------------------------------------------- /rpi-scripts/uboot_env.img: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rboussel/SWUpdate-rpi-demo/HEAD/rpi-scripts/uboot_env.img -------------------------------------------------------------------------------- /external.mk: -------------------------------------------------------------------------------- 1 | # Makefiles used by all subprojects 2 | include $(sort $(wildcard $(BR2_EXTERNAL)/package/*/*.mk)) 3 | 4 | -------------------------------------------------------------------------------- /mountpoint/data/config: -------------------------------------------------------------------------------- 1 | BOOT_partition=/dev/mmcblk0p1 2 | DATA_partition=/dev/mmcblk0p7 3 | main_partition=/dev/mmcblk0p5 4 | alt_partition=/dev/mmcblk0p6 5 | -------------------------------------------------------------------------------- /overlay/etc/init.d/S99verify_update: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | case "$1" in 4 | start) 5 | echo "Starting update validation..." 6 | source /usr/sbin/verify_update 7 | ;; 8 | *) 9 | 10 | echo "Usage: $0 {start}" 11 | exit 1 12 | ;; 13 | esac 14 | -------------------------------------------------------------------------------- /Config.in: -------------------------------------------------------------------------------- 1 | # make the variant name available as a Config.in variable 2 | # 3 | # you can use BR2SM_PROJECT_NAME to have some options only appear for some variants 4 | # 5 | config BR2SM_PROJECT_NAME 6 | string 7 | option env="PROJECT_NAME" 8 | source "$BR2_EXTERNAL/package/swupdate-custom/Config.in" 9 | -------------------------------------------------------------------------------- /rpi-scripts/post-build.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | set -u 4 | set -e 5 | 6 | # Add a console on tty1 7 | grep -qE '^tty1::' ${TARGET_DIR}/etc/inittab || \ 8 | sed -i '/GENERIC_SERIAL/a\ 9 | tty1::respawn:/sbin/getty -L tty1 0 vt100 # HDMI console' ${TARGET_DIR}/etc/inittab 10 | echo ${TARGET_DIR} 11 | -------------------------------------------------------------------------------- /overlay/opt/scripts/invalidate_update.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | # invalidate_update.sh - A shell script to invalidate versions 3 | 4 | # Write archive's name in invalid_update file 5 | invalidate_version () { 6 | # Args 7 | # $1 - Invalid file's name 8 | echo "$1" >> $FILE_INVALID_UPDATE 9 | } 10 | 11 | invalidate_version $1 12 | -------------------------------------------------------------------------------- /rpi-scripts/create_img.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | #Post build genimage script 3 | 4 | SCRIPT_PATH="${BR2_EXTERNAL}/rpi-scripts/uboot_env.hush" 5 | DESTINATION_PATH="${BINARIES_DIR}/uboot_env.img" 6 | 7 | create_swu_image(){ 8 | 9 | mkimage -T script -C none -n 'Script init' -d ${SCRIPT_PATH} ${DESTINATION_PATH} 10 | } 11 | 12 | create_swu_image 13 | -------------------------------------------------------------------------------- /overlay/opt/scripts/save_env: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | # save_env - A shell script to save environnement variables file 3 | 4 | 5 | save_environnement_file () { 6 | 7 | for var in $(cat $SCRIPT_ENVIRONNEMENT | cut -d= -f1) 8 | do 9 | eval echo $var=\$$var >> "$SCRIPT_ENVIRONNEMENT.tmp" 10 | done 11 | 12 | sort -u "$SCRIPT_ENVIRONNEMENT.tmp" > $SCRIPT_ENVIRONNEMENT 13 | rm "$SCRIPT_ENVIRONNEMENT.tmp" 14 | } 15 | 16 | save_environnement_file 17 | -------------------------------------------------------------------------------- /rpi-scripts/post-image.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | BOARD_DIR="$(dirname $0)" 4 | BOARD_NAME="$(basename ${BOARD_DIR})" 5 | GENIMAGE_CFG="${BOARD_DIR}/genimage-${BOARD_NAME}.cfg" 6 | GENIMAGE_TMP="${BUILD_DIR}/genimage.tmp" 7 | 8 | # Mark the kernel as DT-enabled 9 | mkdir -p "${BINARIES_DIR}/kernel-marked" 10 | ${HOST_DIR}/usr/bin/mkknlimg "${BINARIES_DIR}/zImage" \ 11 | "${BINARIES_DIR}/kernel-marked/zImage" 12 | 13 | rm -rf "${GENIMAGE_TMP}" 14 | genimage \ 15 | --rootpath "${BR2_EXTERNAL}/mountpoint" \ 16 | --tmppath "${GENIMAGE_TMP}" \ 17 | --inputpath "${BINARIES_DIR}" \ 18 | --outputpath "${BINARIES_DIR}" \ 19 | --config "${GENIMAGE_CFG}" 20 | 21 | exit $? 22 | -------------------------------------------------------------------------------- /overlay/etc/fstab: -------------------------------------------------------------------------------- 1 | # 2 | /dev/root / ext2 rw,noauto 0 1 3 | proc /proc proc defaults 0 0 4 | devpts /dev/pts devpts defaults,gid=5,mode=620 0 0 5 | tmpfs /dev/shm tmpfs mode=0777 0 0 6 | tmpfs /tmp tmpfs mode=1777 0 0 7 | tmpfs /run tmpfs mode=0755,nosuid,nodev 0 0 8 | sysfs /sys sysfs defaults 0 0 9 | /dev/mmcblk0p7 /DATA ext4 rw,relatime,errors=remount-ro,data=ordered 0 0 10 | /dev/sda /DATA/update f2fs rw,relatime,background_gc=on,user_xattr,acl,inline_data,extent_cache,active_logs=6 0 0 11 | 12 | -------------------------------------------------------------------------------- /rpi-scripts/config.txt: -------------------------------------------------------------------------------- 1 | # Please note that this is only a sample, we recommend you to change it to fit 2 | # your needs. 3 | # You should override this file using a post-build script. 4 | # See http://buildroot.org/manual.html#rootfs-custom 5 | # and http://elinux.org/RPiconfig for a description of config.txt syntax 6 | 7 | kernel=u-boot.bin 8 | 9 | # To use an external initramfs file 10 | #initramfs rootfs.cpio.gz 11 | 12 | # Disable overscan assuming the display supports displaying the full resolution 13 | # If the text shown on the screen disappears off the edge, comment this out 14 | disable_overscan=1 15 | 16 | # How much memory in MB to assign to the GPU on Pi models having 17 | # 256, 512 or 1024 MB total memory 18 | gpu_mem_256=100 19 | gpu_mem_512=100 20 | gpu_mem_1024=100 21 | -------------------------------------------------------------------------------- /toolchain/defconfig: -------------------------------------------------------------------------------- 1 | BR2_arm=y 2 | BR2_arm1176jzf_s=y 3 | BR2_DL_DIR="$(BR2_EXTERNAL)/dl" 4 | BR2_PACKAGE_OVERRIDE_FILE="$(BR2_EXTERNAL)/local.mk" 5 | BR2_GLOBAL_PATCH_DIR="$(BR2_EXTERNAL)/patch" 6 | BR2_KERNEL_HEADERS_4_4=y 7 | BR2_TOOLCHAIN_BUILDROOT_GLIBC=y 8 | BR2_TOOLCHAIN_BUILDROOT_CXX=y 9 | BR2_INIT_NONE=y 10 | BR2_ROOTFS_OVERLAY="$(BR2_EXTERNAL)/overlay" 11 | BR2_ROOTFS_POST_BUILD_SCRIPT="board/raspberrypi/post-build.sh" 12 | BR2_ROOTFS_POST_IMAGE_SCRIPT="board/raspberrypi/post-image.sh" 13 | # BR2_PACKAGE_BUSYBOX is not set 14 | BR2_PACKAGE_RPI_FIRMWARE=y 15 | # BR2_PACKAGE_RPI_FIRMWARE_INSTALL_DTB_OVERLAYS is not set 16 | BR2_TARGET_ROOTFS_EXT2=y 17 | BR2_TARGET_ROOTFS_EXT2_4=y 18 | # BR2_TARGET_ROOTFS_TAR is not set 19 | BR2_PACKAGE_HOST_DOSFSTOOLS=y 20 | BR2_PACKAGE_HOST_GENIMAGE=y 21 | BR2_PACKAGE_HOST_MTOOLS=y 22 | -------------------------------------------------------------------------------- /overlay/opt/scripts/boot.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | # boot.sh - Script to lauch system when updated verification finished 3 | 4 | # Variables 5 | R="2" # Number of try for rootfs boot 6 | 7 | # Reset some variables and wait for a new update 8 | wait_update () { 9 | 10 | $SETENV_CMD $VALIDATION_UPDATE "true" # Validate update 11 | $SETENV_CMD $RETRY_ROOTFS_UPDATE_COUNTER "$R" # Reset rootfs counter 12 | UPDATE_STATE="WAIT" 13 | mount $CURRENT_APP_PART "/APP" 14 | sed -i '/TEMP_APP_PART/d' $SCRIPT_ENVIRONNEMENT # Remove temporary environnement variables 15 | sed -i '/APPLI_UPDATE_NAME/d' $SCRIPT_ENVIRONNEMENT # Remove temporary environnement variables 16 | sed -i '/ROOTFS_UPDATE_NAME/d' $SCRIPT_ENVIRONNEMENT 17 | } 18 | 19 | mount $BOOT_PARTITION /mnt # Mount u-boot partition 20 | wait_update 21 | umount /mnt 22 | 23 | source $SCRIPT_SAVE_ENVIRONNEMENT 24 | -------------------------------------------------------------------------------- /overlay/opt/scripts/change_application_part.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | # change_application_part.sh - Change application part in current_partition_part and env_var files 3 | 4 | # Get the inactive application partition 5 | get_innactive_partition () { 6 | 7 | if [ "$CURRENT_APP_PART" = $(cat $CONFIG_DATA | sed -n '/main_partition=/p' | cut -d= -f2) ] 8 | then 9 | echo $(cat $CONFIG_DATA | sed -n '/alt_partition=/p' | cut -d= -f2) 10 | else 11 | echo $(cat $CONFIG_DATA | sed -n '/main_partition=/p' | cut -d= -f2) 12 | fi 13 | } 14 | 15 | case $1 in 16 | "change") CURRENT_APP_PART=$(get_innactive_partition) 17 | echo $CURRENT_APP_PART > $FILE_CURRENT_APPLICATION_PART 18 | ;; 19 | 20 | "temp") TEMP_APP_PART=$(get_innactive_partition) 21 | echo "TEMP_APP_PART=$TEMP_APP_PART" >> $SCRIPT_ENVIRONNEMENT 22 | ;; 23 | esac 24 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | # This file is part of buildroot-submodule. 2 | # 3 | # buildroot-submodule is free software: you can redistribute it and/or modify 4 | # it under the terms of the GNU General Public License as published by 5 | # the Free Software Foundation, either version 3 of the License, or 6 | # (at your option) any later version. 7 | # 8 | # buildroot-submodule is distributed in the hope that it will be useful, 9 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 10 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 11 | # GNU General Public License for more details. 12 | # 13 | # You should have received a copy of the GNU General Public License 14 | # along with buildroot-submodule. If not, see . 2 15 | 16 | 17 | #Makefile for the anonymous (default) project 18 | PROJECT_NAME := 19 | 20 | include common.mk 21 | -------------------------------------------------------------------------------- /Makefile.toolchain: -------------------------------------------------------------------------------- 1 | # This file is part of buildroot-submodule. 2 | # 3 | # buildroot-submodule is free software: you can redistribute it and/or modify 4 | # it under the terms of the GNU General Public License as published by 5 | # the Free Software Foundation, either version 3 of the License, or 6 | # (at your option) any later version. 7 | # 8 | # buildroot-submodule is distributed in the hope that it will be useful, 9 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 10 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 11 | # GNU General Public License for more details. 12 | # 13 | # You should have received a copy of the GNU General Public License 14 | # along with buildroot-submodule. If not, see . 2 15 | 16 | 17 | #Makefile for the anonymous (default) project 18 | PROJECT_NAME := toolchain 19 | 20 | include common.mk 21 | -------------------------------------------------------------------------------- /overlay/usr/sbin/verify_update: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | # swu_satte_machine - A shell script to check system state after update 3 | 4 | # Variable 5 | SCRIPTS_PATH="/opt/scripts" 6 | SCRIPT_ENVIRONNEMENT="/DATA/env_var" 7 | 8 | # Source environnement variables 9 | source $SCRIPT_ENVIRONNEMENT 10 | 11 | check_update_state_value () { 12 | 13 | case $UPDATE_STATE in 14 | "WAIT") source $SCRIPT_WAIT_UPDATE ;; # All is ok 15 | "GET_APP_ARCHIVE_NAME" | "GET_APP_ARCHIVE" | "GET_ROOTFS_NAME" | "UPDATE_SYSTEM" |"UPDATE_APP") source $SCRIPT_GET_ARCHIVE ;; # The update was interrupted 16 | "SYSTEM_UPDATED") mount $TEMP_APP_PART /APP; source $SCRIPT_ROOTFS_VERIFICATION ;; # Rootfs and Application partitions were updated 17 | "APP_UPDATED") mount $TEMP_APP_PART /APP ; source $SCRIPT_APP_VERIFICATION ;; # Only Application partition was updated 18 | esac 19 | } 20 | 21 | check_update_state_value 22 | # Save environnement variables 23 | source $SCRIPT_SAVE_ENVIRONNEMENT 24 | -------------------------------------------------------------------------------- /patch/0001-fix-config-file-loading-in-env-library.patch: -------------------------------------------------------------------------------- 1 | On 29/04/2016 22:00, Anatolij Gustschin wrote: 2 | env library is broken as the config file pointer is only initialized 3 | in main(). When running in the env library parse_config() fails: 4 | 5 | Cannot parse config file '(null)': Bad address 6 | 7 | Ensure that config file pointer is always initialized. 8 | 9 | Signed-off-by: Anatolij Gustschin 10 | Cc: Stefano Babic 11 | --- 12 | tools/env/fw_env.c | 3 +++ 13 | 1 file changed, 3 insertions(+) 14 | 15 | diff --git a/tools/env/fw_env.c b/tools/env/fw_env.c 16 | index 1420ac5..06cf63d 100644 17 | --- a/tools/env/fw_env.c 18 | +++ b/tools/env/fw_env.c 19 | @@ -1325,6 +1325,9 @@ static int parse_config () 20 | struct stat st; 21 | 22 | #if defined(CONFIG_FILE) 23 | + if (!common_args.config_file) 24 | + common_args.config_file = CONFIG_FILE; 25 | + 26 | /* Fills in DEVNAME(), ENVSIZE(), DEVESIZE(). Or don't. */ 27 | if (get_config(common_args.config_file)) { 28 | fprintf(stderr, "Cannot parse config file '%s': %m\n", 29 | 30 | -------------------------------------------------------------------------------- /overlay/opt/scripts/rootfs_verification.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | # rootfs_verification.sh - A shell script to check rootfs state after update 3 | 4 | decrement_variable () { 5 | 6 | new_value=$($PRINTENV_CMD $1 | cut -d= -f2) 7 | let new_value-- 8 | $SENTENV_CMD $1 $new_value 9 | echo $new_value 10 | } 11 | 12 | # Retry rootfs update, if failed, invalidate rootfs and app version 13 | retry_update () { 14 | 15 | retry_count_val=$(decrement_variable $RETRY_ROOTFS_UPDATE_COUNTER) 16 | if [ "$retry_count_val" -gt 0 ] 17 | then 18 | UPDATE_STATE="UPDATE_SYSTEM" 19 | source $SCRIPT_SAVE_ENVIRONNEMENT 20 | source $SCRIPT_LAUNCH_UPDATE 21 | else 22 | source $SCRIPT_INVALIDATE_UPDATE $ROOTFS_UPDATE_NAME 23 | source $SCRIPT_INVALIDATE_UPDATE $APPLI_UPDATE_NAME 24 | source $SCRIPT_WAIT_UPDATE 25 | fi 26 | } 27 | 28 | # Check if rootfs boots correctly and launch application verification 29 | check_value () { 30 | 31 | val_count=$($PRINTENV_CMD $1 | cut -d= -f2) 32 | if [ "$val_count" -gt "0" ]; then source $SCRIPT_APP_VERIFICATION; else retry_update ; fi 33 | } 34 | 35 | mount $BOOT_PARTITION /mnt 36 | 37 | check_value $ROOTFS_COUNTER 38 | 39 | umount /mnt 40 | -------------------------------------------------------------------------------- /mountpoint/data/env_var: -------------------------------------------------------------------------------- 1 | APP_STATE="WAIT" 2 | BOOT_PARTITION="/dev/mmcblk0p1" 3 | CONFIG_DATA="/DATA/config" 4 | CURRENT_APP_PART="/dev/mmcblk0p5" 5 | CURRENT_ROOTFS_PART="part" 6 | DATA_PARTITION="/dev/mmcblk0p7" 7 | DIR_DOWNLOAD="/home/test" 8 | DIR_UPDATE="/DATA/update" 9 | DIR_UPDATE_FILES="/DATA/update_files" 10 | FILE_CURRENT_APPLICATION_PART="$DIR_UPDATE_FILES/current_application_part" 11 | FILE_CURRENT_VERSIONS="$DIR_UPDATE_FILES/current_versions" 12 | FILE_INVALID_UPDATE="$DIR_UPDATE_FILES/invalid_update" 13 | FILE_MINIMAL_ROOTFS_VERSION="$DIR_UPDATE/minimal_rootfs_version" 14 | FILE_PUBLIC_KEY="$DIR_UPDATE/public.pem" 15 | FILE_SWUPDATE_LOG="$DIR_UPDATE_FILES/swupdate.log" 16 | ID="test" 17 | PASS="test" 18 | PRINTENV_CMD="fw_printenv" 19 | RETRY_ROOTFS_UPDATE_COUNTER="retry_count" 20 | ROOTFS_COUNTER="test_count" 21 | SCRIPT_APP_VERIFICATION="$SCRIPTS_PATH/app_verification.sh" 22 | SCRIPT_CHANGE_APP_PART="$SCRIPTS_PATH/change_application_part.sh" 23 | SCRIPT_ENVIRONNEMENT="/DATA/env_var" 24 | SCRIPT_GET_ARCHIVE="$SCRIPTS_PATH/get_archive_name.sh" 25 | SCRIPT_INVALIDATE_UPDATE="$SCRIPTS_PATH/invalidate_update.sh" 26 | SCRIPT_LAUNCH_UPDATE="$SCRIPTS_PATH/lauch_update.sh" 27 | SCRIPT_ROOTFS_VERIFICATION="$SCRIPTS_PATH/rootfs_verification.sh" 28 | SCRIPT_SAVE_ENVIRONNEMENT="$SCRIPTS_PATH/save_env" 29 | SCRIPT_WAIT_UPDATE="$SCRIPTS_PATH/boot.sh" 30 | SETENV_CMD="fw_setenv" 31 | UPDATE_STATE="WAIT" 32 | VALIDATION_UPDATE="test_validity" 33 | -------------------------------------------------------------------------------- /rpi-scripts/genimage-rpi-scripts.cfg: -------------------------------------------------------------------------------- 1 | image boot.vfat { 2 | vfat { 3 | files = { 4 | 5 | "rpi-firmware/bootcode.bin", 6 | "rpi-firmware/cmdline.txt", 7 | "${BR2_EXTERNAL}/rpi-scripts/config.txt", 8 | "rpi-firmware/fixup.dat", 9 | "rpi-firmware/start.elf", 10 | "bcm2708-rpi-b.dtb", 11 | "bcm2708-rpi-b-plus.dtb", 12 | "bcm2708-rpi-cm.dtb", 13 | "${BR2_EXTERNAL}/rpi-scripts/uboot_env.img", 14 | "u-boot.bin" 15 | } 16 | } 17 | size = 32M 18 | } 19 | 20 | image app_part_image.ext4 { 21 | ext4 { 22 | } 23 | size = 10M 24 | mountpoint = "/applications" 25 | } 26 | 27 | image data_part_image.ext4 { 28 | ext4 { 29 | } 30 | size = 10M 31 | mountpoint = "/data" 32 | } 33 | 34 | image sdcard.img { 35 | hdimage { 36 | } 37 | partition boot { 38 | partition-type = 0xC 39 | bootable = "true" 40 | image = "boot.vfat" 41 | } 42 | 43 | partition rootfs_1 { 44 | partition-type = 0x83 45 | image = "rootfs.ext4" 46 | size = 90M 47 | } 48 | 49 | partition rootfs_2 { 50 | partition-type = 0x83 51 | image = "rootfs.ext4" 52 | size = 90M 53 | } 54 | partition app_part_1 { 55 | partition-type = 0x83 56 | image = "app_part_image.ext4" 57 | size = 10M 58 | } 59 | partition app_part_2 { 60 | partition-type = 0x83 61 | image = "app_part_image.ext4" 62 | size = 10M 63 | } 64 | 65 | partition data_part { 66 | partition-type = 0x83 67 | image = "data_part_image.ext4" 68 | size = 10M 69 | } 70 | 71 | } 72 | 73 | -------------------------------------------------------------------------------- /package/swupdate-custom/swupdate-custom.config: -------------------------------------------------------------------------------- 1 | #Swupdate file config for rpi 2 | #Version 2016-06 3 | 4 | CONFIG_HAVE_DOT_CONFIG=y 5 | 6 | # 7 | # General Configuration 8 | # 9 | CONFIG_SCRIPTS=y 10 | CONFIG_SW_VERSION_FILE="/etc/sw-versions" 11 | CONFIG_HW_COMPATIBILITY=y 12 | CONFIG_HW_COMPATIBILITY_FILE="/etc/hwrevision" 13 | #CONFIG_LUA is not set 14 | # CONFIG_FEATURE_SYSLOG is not set 15 | 16 | # 17 | # Build Options 18 | # 19 | # CONFIG_STATIC is not set 20 | CONFIG_CROSS_COMPILER_PREFIX="" 21 | CONFIG_SYSROOT="" 22 | CONFIG_EXTRA_CFLAGS="" 23 | CONFIG_EXTRA_LDFLAGS="" 24 | CONFIG_EXTRA_LDLIBS="" 25 | 26 | # 27 | # Debugging Options 28 | # 29 | # CONFIG_DEBUG is not set 30 | # CONFIG_DEBUG_PESSIMIZE is not set 31 | # CONFIG_WERROR is not set 32 | # CONFIG_NOCLEANUP is not set 33 | CONFIG_DOWNLOAD =y 34 | CONFIG_WEBSERVER=y 35 | 36 | # 37 | # Webserver Features 38 | # 39 | CONFIG_MONGOOSE=y 40 | 41 | # 42 | # Mongoose Feature 43 | # 44 | #CONFIG_MONGOOSELUA is not set 45 | # CONFIG_MONGOOSESQL is not set 46 | CONFIG_MONGOOSEIPV6=y 47 | CONFIG_MONGOOSESSL=y 48 | 49 | # 50 | # Archival Features 51 | # 52 | CONFIG_CPIO=y 53 | CONFIG_GUNZIP=y 54 | 55 | # 56 | # Parser Features 57 | # 58 | CONFIG_LIBCONFIG=y 59 | # CONFIG_LUAEXTERNAL is not set 60 | # CONFIG_SETEXTPARSERNAME is not set 61 | CONFIG_EXTPARSERNAME="" 62 | # CONFIG_SETSWDESCRIPTION is not set 63 | CONFIG_SWDESCRIPTION="" 64 | 65 | # 66 | # Image Handlers 67 | # 68 | # CONFIG_UBIVOL is not set 69 | CONFIG_UBIBLACKLIST="" 70 | CONFIG_UBIVIDOFFSET=0 71 | CONFIG_CFI=y 72 | CONFIG_RAW=y 73 | #CONFIG_LUASCRIPTHANDLER is not set 74 | CONFIG_SHELLSCRIPTHANDLER=y 75 | #CONFIG_HANDLER_IN_LUA is not set 76 | CONFIG_UBOOT=y 77 | CONFIG_UBOOT_FWENV="/etc/fw_env.config" 78 | 79 | # 80 | # Image Signed 81 | # 82 | CONFIG_SIGNED_IMAGES=y 83 | -------------------------------------------------------------------------------- /defconfig: -------------------------------------------------------------------------------- 1 | BR2_arm=y 2 | BR2_arm1176jzf_s=y 3 | BR2_DL_DIR="$(BR2_EXTERNAL)/dl" 4 | BR2_PACKAGE_OVERRIDE_FILE="$(BR2_EXTERNAL)/local.mk" 5 | BR2_GLOBAL_PATCH_DIR="$(BR2_EXTERNAL)/patch" 6 | BR2_TOOLCHAIN_EXTERNAL=y 7 | BR2_TOOLCHAIN_EXTERNAL_CUSTOM=y 8 | BR2_TOOLCHAIN_EXTERNAL_PATH="${BR2_EXTERNAL}/toolchain/output/host/usr" 9 | BR2_TOOLCHAIN_EXTERNAL_GCC_4_9=y 10 | BR2_TOOLCHAIN_EXTERNAL_HEADERS_4_4=y 11 | BR2_TOOLCHAIN_EXTERNAL_CUSTOM_GLIBC=y 12 | BR2_TOOLCHAIN_EXTERNAL_CXX=y 13 | BR2_TARGET_GENERIC_ROOT_PASSWD="hello" 14 | BR2_SYSTEM_DHCP="eth0" 15 | BR2_ROOTFS_OVERLAY="$(BR2_EXTERNAL)/overlay" 16 | BR2_ROOTFS_POST_BUILD_SCRIPT="${BR2_EXTERNAL}/rpi-scripts/post-build.sh ${BR2_EXTERNAL}/rpi-scripts/create_img.sh" 17 | BR2_ROOTFS_POST_IMAGE_SCRIPT="${BR2_EXTERNAL}/rpi-scripts/post-image.sh" 18 | BR2_LINUX_KERNEL=y 19 | BR2_LINUX_KERNEL_CUSTOM_GIT=y 20 | BR2_LINUX_KERNEL_CUSTOM_REPO_URL="https://github.com/raspberrypi/linux.git" 21 | BR2_LINUX_KERNEL_CUSTOM_REPO_VERSION="26f3b72a9c049be10e6af196252283e1f6ab9d1f" 22 | BR2_LINUX_KERNEL_DEFCONFIG="bcmrpi" 23 | BR2_LINUX_KERNEL_DTS_SUPPORT=y 24 | BR2_LINUX_KERNEL_INTREE_DTS_NAME="bcm2708-rpi-b bcm2708-rpi-b-plus bcm2708-rpi-cm" 25 | BR2_LINUX_KERNEL_INSTALL_TARGET=y 26 | BR2_PACKAGE_BUSYBOX_SHOW_OTHERS=y 27 | BR2_PACKAGE_RPI_FIRMWARE=y 28 | # BR2_PACKAGE_RPI_FIRMWARE_INSTALL_DTB_OVERLAYS is not set 29 | BR2_PACKAGE_UBOOT_TOOLS=y 30 | BR2_PACKAGE_OPENSSL=y 31 | BR2_PACKAGE_DCRON=y 32 | BR2_TARGET_ROOTFS_EXT2=y 33 | BR2_TARGET_ROOTFS_EXT2_4=y 34 | # BR2_TARGET_ROOTFS_TAR is not set 35 | BR2_TARGET_UBOOT=y 36 | BR2_TARGET_UBOOT_BOARDNAME="rpi" 37 | BR2_PACKAGE_HOST_DOSFSTOOLS=y 38 | BR2_PACKAGE_HOST_GENIMAGE=y 39 | BR2_PACKAGE_HOST_MTOOLS=y 40 | BR2_PACKAGE_HOST_UBOOT_TOOLS=y 41 | BR2_PACKAGE_SWUPDATE_CUSTOM=y 42 | # BR2_PACKAGE_SWUPDATE_CUSTOM_INSTALL_WEBSITE is not set 43 | -------------------------------------------------------------------------------- /overlay/opt/scripts/app_verification.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | # app_verification.sh - A shell script to check app state after update 3 | 4 | # Variables 5 | APP_VERIFICATION_VALUE="ok" # Response of application validatation test (test is not implemented yet) 6 | 7 | # Write new version in config file 8 | write_version () { 9 | # Args 10 | # $1 - "appli" or "rootfs" 11 | 12 | if [ "$1" = "appli" ]; then 13 | new_version=$(echo $APPLI_UPDATE_NAME | cut -d_ -f3) 14 | version=$(cat $FILE_CURRENT_VERSIONS | sed -n '/Application/p' | cut -d= -f2) 15 | sed -i "s/$version/$new_version/" $FILE_CURRENT_VERSIONS 16 | elif [ "$1" = "rootfs" ] 17 | then 18 | new_version=$(echo $ROOTFS_UPDATE_NAME | cut -d_ -f3) 19 | version=$(cat $FILE_CURRENT_VERSIONS | sed -n '/Rootfs/p' | cut -d= -f2) 20 | sed -i "s/$version/$new_version/" $FILE_CURRENT_VERSIONS 21 | fi 22 | } 23 | 24 | # Check application validation 25 | wait_application_validation () { 26 | 27 | if [ "$APP_VERIFICATION_VALUE" = "ok" ]; then 28 | APP_STATE="WAIT" 29 | write_version "appli" 30 | if [ "$UPDATE_STATE" = "SYSTEM_UPDATED" ]; then 31 | write_version "rootfs" 32 | fi 33 | source $SCRIPT_CHANGE_APP_PART "change" 34 | source $SCRIPT_WAIT_UPDATE 35 | else # If application does not work, use previous version ( the other partition) 36 | APP_STATE="PREVIOUS_VERSION" 37 | if [ "$UPDATE_STATE" = "SYSTEM_UPDATED" ]; then 38 | fw_setenv "part" 'setexpr part ${part} ^ 1' # Change rootfs too 39 | fi 40 | source $SCRIPT_INVALIDATE_UPDATE $APPLI_UPDATE_NAME 41 | UPDATE_STATE="WAIT" 42 | reboot 43 | fi 44 | } 45 | 46 | mount $BOOT_PARTITION /mnt # Mount u-boot partition 47 | 48 | wait_application_validation 49 | 50 | umount $BOOT_PARTITION 51 | source $SCRIPT_SAVE_ENVIRONNEMENT 52 | -------------------------------------------------------------------------------- /swupdate/create-archive.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | # Script to create a signed .swu archive due to the sw-description file. 3 | # All files specified in sw-description need to be in SWUPDATE_FILES_PATH 4 | # except images which are in BINARIES_DIR 5 | # This script does not create sw-description 6 | 7 | # Variables 8 | VERSION="1.0" 9 | EMERGENCY_WORD="CRITICAL" 10 | PRODUCT_NAME="rpi_swupdate" 11 | SWUPDATE_FILES_PATH="${BR2_EXTERNAL}/swupdate" 12 | FILES="sw-description sw-description.sig" 13 | 14 | # Add hash in sw-description. 15 | compute_hash(){ 16 | names=$(cat "${SWUPDATE_FILES_PATH}/sw-description" | sed -n '/@/p' | cut -d@ -f2 | uniq ) 17 | cp ${SWUPDATE_FILES_PATH}/sw-description ${BINARIES_DIR}/sw-description ; 18 | for name in $names;do 19 | FILES+=" $name"; 20 | cp "${SWUPDATE_FILES_PATH}/$name" "${BINARIES_DIR}/$name" ; 21 | sha256=$(sha256sum "${BINARIES_DIR}/$name" | cut -d ' ' -f1 ) 22 | sed -i "s/@$name/\"$sha256\";/" "${BINARIES_DIR}/sw-description" ; done ; 23 | } 24 | 25 | # Create sw-description.sig. A private key is needed 26 | create_swdescription_sig(){ 27 | if test -f "${SWUPDATE_FILES_PATH}/priv.pem" 28 | then 29 | openssl dgst -sha256 -sign "${SWUPDATE_FILES_PATH}/priv.pem" "${BINARIES_DIR}/sw-description" > "${BINARIES_DIR}/sw-description.sig" 30 | else 31 | echo "Private key doesn't exist" 32 | exit 1 33 | fi 34 | } 35 | 36 | # Create .swu archive 37 | create_swu(){ 38 | cd ${BINARIES_DIR} 39 | for file in $FILES; do 40 | echo $file;done | cpio -ov -H crc > ${PRODUCT_NAME}-${VERSION}-${EMERGENCY_WORD}.swu 41 | if [ -f "${PRODUCT_NAME}-${CONTAINER_VER}-${EMERGENCY_WORD}.swu" ] 42 | then 43 | echo "L'archive ${PRODUCT_NAME}-${VERSION}-${EMERGENCY_WORD}.swu a bien été créée dans ${BINARIES_DIR}" 44 | fi 45 | 46 | rm sw-description sw-description.sig 47 | } 48 | 49 | compute_hash 50 | create_swdescription_sig ; 51 | create_swu 52 | 53 | exit 0 54 | -------------------------------------------------------------------------------- /rpi-scripts/uboot_env.hush: -------------------------------------------------------------------------------- 1 | # uboot_env.hush - Init script for u-boot variables 2 | # To use this script, use mkimage 3 | # This script is used to init u-boot variables 4 | # and to verify if the rootfs boots after an update. 5 | 6 | 7 | mmc dev 0 8 | 9 | # Load files 10 | # Kernel files 11 | setenv bootfile bootcode.bin 12 | setenv fdtfile bcm2708-rpi-b-plus.dtb 13 | setenv boot_kernel 'bootz ${kernel_addr_r} - ${fdt_addr_r}' 14 | setenv bootargs earlyprintk root=${which_fs_part} rootwait console=tty1 console=ttyAMA0,115200 15 | setenv put_files 'ext2load mmc 0:2 ${kernel_addr_r} /boot/zImage ; fatload mmc 0:1 ${fdt_addr_r} ${fdtfile}' 16 | 17 | # We need to reload bootargs when partition changed 18 | setenv reload_bootargs 'setenv bootargs earlyprintk root=${which_fs_part} rootwait console=tty1 console=ttyAMA0,115200' 19 | 20 | # Update and boot partition 21 | # Rootfs 22 | setenv part 0 # Current rootfs partition 23 | setenv FS_PART_0 /dev/mmcblk0p2 # Main rootfs partition 24 | setenv FS_PART_1 /dev/mmcblk0p3 # Alt Rootfs partition 25 | setenv which_fs_part ${FS_PART_0} # Current rootfs part 26 | 27 | setenv test_validity true # validate update 28 | setenv test_count 3 # number of try 29 | setenv update_verif ' if test "${test_validity}" = "false" ; then setexpr test_count ${test_count} - 1 ; if test "${test_count}" = "0" ; then setexpr part ${part} ^ 1 ;fi; if test ${part} = "0" ; then setenv which_fs_part ${FS_PART_0}; else setenv which_fs_part ${FS_PART_1};fi;fi; run reload_bootargs ; echo " Partition change " ; saveenv ; run boot_kernel ' # Verify if rootfs boots 30 | 31 | # Used if is_init_ok=0 to init u-boot variables 32 | setenv put_init_script ' mmc dev 0 ; fatload mmc 0:1 ${scriptaddr} init_script.img ' 33 | 34 | # bootcmd is the first variable executed 35 | setenv bootcmd ' if test "${is_init_ok}" = "0" ; then run put_init_script ;source ${scriptaddr} ; else run put_files ; run update_verif; fi' 36 | 37 | setenv is_init_ok 1 38 | 39 | saveenv 40 | boot 41 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | SWUpdate Raspberry-pi demo 2 | ========================== 3 | 4 | Project 5 | ------- 6 | This project is a demo of a complete update schema in the Raspberry Pi. 7 | [SWUpdate] (http://sbabic.github.io/swupdate) is used to update images and u-boot as a bootloader. 8 | Several shell scripts are used to verify the update. 9 | 10 | Buildroot submodule is used to build the Rpi images and [Swu-generator] (https://github.com/rboussel/swu-generator) is used to create the .swu archive. 11 | 12 | - mountpoint/data folder contains configuration and log files. This is the Data partition. 13 | - overlay folder contains all scripts necessary to update the system. 14 | The init update verification script is in usr/sbin folder and the other in opt folder. 15 | - rpi-scripts folder contains u-boot script 16 | - swupdate folder contains an exemple of sw-description and a script to create the .swu archive. 17 | They are not used in the demo. 18 | 19 | Principle 20 | --------- 21 | In this demo, the target has six partitions 22 | 23 | - mmcblk0p1 - U-boot 24 | - mmcblk0p2 - Kernel + Rootfs-1 25 | - mmcblk0p3 - Kernel + Rootfs-2 26 | - mmcblk0p5 - Application-1 27 | - mmcblk0p6 - Application-2 28 | - mmcblk0p7 - Data 29 | 30 | mmcblk0p3 and mmcblk0p6 are rootfs and application copies. 31 | With the dual-copy strategy, SWUpdate update the inactive partition 32 | while the active partition is running. When the system reboots, 33 | u-boot boots the updated partition. 34 | If the new partitions are corrupted, u-boot or init script changed current rootfs and 35 | application partitions. 36 | 37 | Update schema 38 | ------------- 39 | To verify update and partition state, three variables are used : 40 | 41 | - test_validy : Enable to validate rootfs update. This is an u-boot variable 42 | - UPDATE_STATE : Give the update state and enable to get back the update in case of power off 43 | - APP_STATE : Enable to know if the previous application update fails or not 44 | 45 | In this demo, the system get update archives from FTP server with the script get_archive_name.sh. 46 | This script verifies if there is a new archive and launch update. After the system reboot, 47 | the script verify_update checks if there was an update and launches application and rootfs verification. 48 | 49 | 50 | 51 | -------------------------------------------------------------------------------- /package/swupdate-custom/Config.in: -------------------------------------------------------------------------------- 1 | config BR2_PACKAGE_SWUPDATE_CUSTOM 2 | bool "swupdate-custom" 3 | depends on BR2_TOOLCHAIN_HAS_THREADS 4 | depends on BR2_USE_MMU # fork() 5 | # swupdate-custom requires a parser and uses libconfig as default 6 | select BR2_PACKAGE_LIBCONFIG if !BR2_PACKAGE_JSON_C && !BR2_PACKAGE_LUA_5_2 7 | help 8 | swupdate-custom provides a reliable way to update the software on an 9 | embedded system. 10 | 11 | swupdate-custom is highly configurable to fit the targets requirements and 12 | to minimize the footprint. The provided default configuration file 13 | BR2_PACKAGE_SWUPDATE_CUSTOM_CONFIG will enable swupdate-custom with an embedded 14 | webserver, a parser and a handler for raw NAND or NOR flash. 15 | 16 | The default configuration file builds a reasonable firmware update 17 | system with minimal external dependencies in my mind. If you like to 18 | use your own modified configuration, you have to select the 19 | necessary packages manually: 20 | 21 | * Select BR2_PACKAGE_LUA if you want to have Lua support. 22 | * Select BR2_LIBCURL if you want to use the download feature. 23 | * Select BR2_PACKAGE_OPENSSL is you want to add encryptions support 24 | to the webserver. 25 | * Select BR2_PACKAGE_MTD if you want to use swupdate-custom with UBI 26 | partitions. 27 | * Select BR2_PACKAGE_ZLIB if you want to deal with gzip compressed 28 | archives. 29 | * Select BR2_PACKAGE_UBOOT_TOOLS and BR2_PACKAGE_ZLIB to add support 30 | for setting the U-Boot environment. 31 | 32 | https://sbabic.github.io/swupdate 33 | 34 | if BR2_PACKAGE_SWUPDATE_CUSTOM 35 | 36 | config BR2_PACKAGE_SWUPDATE_CUSTOM_CONFIG 37 | string "swupdate-custom configuration file" 38 | default "${BR2_EXTERNAL}/package/swupdate-custom/swupdate-custom.config" 39 | help 40 | Path to the swupdate-custom configuration file. 41 | 42 | I you wish to use your own modified swupdate-custom configuration file 43 | specify the config file location with this option. 44 | 45 | config BR2_PACKAGE_SWUPDATE_CUSTOM_INSTALL_WEBSITE 46 | bool "install default website" 47 | default y 48 | help 49 | Install the provided website to /var/www/swupdate-custom. 50 | 51 | This is necessary if you want to run swupdate-custom with the embedded 52 | webserver and do not provide an own website to be installed to 53 | /var/www/swupdate-custom. 54 | endif 55 | 56 | comment "swupdate-custom needs a toolchain w/ threads" 57 | depends on BR2_USE_MMU 58 | depends on !BR2_TOOLCHAIN_HAS_THREADS 59 | -------------------------------------------------------------------------------- /swupdate/sw-description: -------------------------------------------------------------------------------- 1 | software = 2 | { 3 | version = "0.1"; 4 | hardware-compatibility = [ "revA" ]; 5 | 6 | rootfs: 7 | { 8 | main: 9 | { 10 | images: ( 11 | { 12 | filename = "rootfs.ext2"; 13 | device = "/dev/mmcblk0p2"; 14 | sha256 = @rootfs.ext2 15 | } 16 | ); 17 | uboot: ( 18 | { 19 | name = "test_count"; 20 | value = "3"; 21 | }, 22 | { 23 | name = "test_validity"; 24 | value = "false"; 25 | }, 26 | { 27 | name = "part"; 28 | value = "0"; 29 | } 30 | ); 31 | 32 | } 33 | 34 | alt: 35 | { 36 | images: ( 37 | { 38 | filename = "rootfs.ext2"; 39 | device = "/dev/mmcblk0p3"; 40 | sha256 = @rootfs.ext2 41 | } 42 | ); 43 | 44 | uboot: ( 45 | { 46 | name = "test_count"; 47 | value = "3"; 48 | }, 49 | { 50 | name = "test_validity"; 51 | value = "false"; 52 | }, 53 | { 54 | name = "part"; 55 | value = "1"; 56 | } 57 | ); 58 | 59 | }; 60 | }; 61 | 62 | 63 | application = { 64 | main: { 65 | 66 | images: ( 67 | { 68 | filename = "app_part_image.ext4"; 69 | device = "/dev/mmcblk0p5"; 70 | sha256 = @app_part_image.ext4 71 | } 72 | ); 73 | 74 | uboot: ( 75 | { 76 | name = "appli"; 77 | value = "0"; 78 | } 79 | ); 80 | } 81 | 82 | alt: { 83 | 84 | images: ( 85 | { 86 | filename = "app_part_image.ext4"; 87 | device = "/dev/mmcblk0p6"; 88 | sha256 = @app_part_image.ext4 89 | } 90 | ); 91 | 92 | uboot: ( 93 | { 94 | name = "appli"; 95 | value = "1"; 96 | } 97 | ); 98 | } 99 | }; 100 | } 101 | 102 | -------------------------------------------------------------------------------- /overlay/opt/scripts/lauch_update.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | # lauch_update.sh - A shell script to lauch update 3 | 4 | # Select rootfs partition to update (main or alt) due to u-boot variable 5 | find_fs () { 6 | 7 | current_part=$($PRINTENV_CMD $CURRENT_ROOTFS_PART | cut -d= -f2) 8 | if [ "$current_part" -eq 0 ] 9 | then 10 | UPDATED_PARTITION="rootfs,alt" 11 | else 12 | UPDATED_PARTITION="rootfs,main" 13 | fi 14 | echo "$UPDATED_PARTITION" 15 | } 16 | 17 | # Select application partition to update (main or alt) due to environnement variables 18 | find_app () { 19 | 20 | if [ "$CURRENT_APP_PART" = $(cat $CONFIG_DATA | sed -n '/main_partition=/p' | cut -d= -f2) ] 21 | then 22 | UPDATED_PARTITION="application,alt" 23 | else 24 | UPDATED_PARTITION="application,main" 25 | fi 26 | echo "$UPDATED_PARTITION" 27 | } 28 | 29 | # Get log messages 30 | catch_returned_msg () { 31 | # Args 32 | # $1 - Swupdate command or error message 33 | # $2 - "APP" or "ROOTFS" 34 | 35 | error_value=$( echo "$1" | grep ERROR) 36 | if [ "$error_value" ] 37 | then 38 | echo "$(date "+%F %H:%M:%S") [$2] $error_value" >> $FILE_SWUPDATE_LOG 39 | echo "failed" 40 | else 41 | success_value=$( echo "$1" | grep "updated successfully") 42 | echo "$(date "+%F %H:%M:%S") [$2] $success_value" >> $FILE_SWUPDATE_LOG 43 | echo "success" 44 | fi 45 | } 46 | 47 | # Lauch the correct update (app or system) and verify if immediate reboot is needed 48 | lauch_update () { 49 | 50 | mount $BOOT_PARTITION /mnt 51 | rootfs_state="false" 52 | app_state="false" 53 | 54 | if [ "$UPDATE_STATE" = "UPDATE_SYSTEM" -a "$APP_STATE" = "WAIT" ]; then 55 | UPDATED_PARTITION=$(find_fs) 56 | rootfs_state=$(catch_returned_msg "$(swupdate -k ${FILE_PUBLIC_KEY} -e ${UPDATED_PARTITION} -vi "${DIR_UPDATE}/$ROOTFS_UPDATE_NAME")" "ROOTFS") 57 | if [ "$rootfs_state" = "success" ]; then 58 | UPDATED_PARTITION=$(find_app) 59 | app_state=$(catch_returned_msg "$(swupdate -k ${FILE_PUBLIC_KEY} -e ${UPDATED_PARTITION} -vi "${DIR_UPDATE}/$APPLI_UPDATE_NAME")" "APP") 60 | else 61 | catch_returned_msg "ERROR : Rootfs update failed, App update cancelled" "APP" 62 | fi 63 | 64 | if [ "$rootfs_state" = "success" -a "$app_state" = "success" ]; then 65 | UPDATE_STATE="SYSTEM_UPDATED" 66 | source $SCRIPT_CHANGE_APP_PART "temp" 67 | else 68 | # if error wait next update 69 | UPDATE_STATE="WAIT" 70 | fi 71 | source $SCRIPT_SAVE_ENVIRONNEMENT 72 | 73 | elif [ "$UPDATE_STATE" = "UPDATE_APP" ]; then 74 | UPDATED_PARTITION=$(find_app) 75 | app_state=$(catch_returned_msg "$(swupdate -k ${FILE_PUBLIC_KEY} -e ${UPDATED_PARTITION} -vi "${DIR_UPDATE}/$APPLI_UPDATE_NAME")" "APP") 76 | if [ "$app_state" = "success" ] 77 | then 78 | UPDATE_STATE="APP_UPDATED" 79 | source $SCRIPT_CHANGE_APP_PART "temp" 80 | else 81 | # if error wait next update 82 | UPDATE_STATE="WAIT" 83 | fi 84 | source $SCRIPT_SAVE_ENVIRONNEMENT 85 | fi 86 | 87 | umount $BOOT_PARTITION 88 | 89 | if [ "$(echo $APPLI_UPDATE_NAME | cut -d_ -f4)" = "REBOOT" ] 90 | then 91 | REBOOT="1" 92 | else 93 | REBOOT="0" 94 | fi 95 | } 96 | 97 | lauch_update 98 | 99 | -------------------------------------------------------------------------------- /common.mk: -------------------------------------------------------------------------------- 1 | # This file is part of buildroot-submodule. 2 | # 3 | # buildroot-submodule is free software: you can redistribute it and/or modify 4 | # it under the terms of the GNU General Public License as published by 5 | # the Free Software Foundation, either version 3 of the License, or 6 | # (at your option) any later version. 7 | # 8 | # buildroot-submodule is distributed in the hope that it will be useful, 9 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 10 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 11 | # GNU General Public License for more details. 12 | # 13 | # You should have received a copy of the GNU General Public License 14 | # along with buildroot-submodule. If not, see . 2 15 | 16 | #location of the buildroot sources 17 | MAKEARGS := -C $(CURDIR)/buildroot 18 | #location to store build files 19 | MAKEARGS += O=$(CURDIR)/$(PROJECT_NAME)/output 20 | # location to store extra config options and buildroot packages 21 | MAKEARGS += BR2_EXTERNAL=$(CURDIR) 22 | #transmit project name to be able to use it in kconfig 23 | MAKEARGS += PROJECT_NAME=$(PROJECT_NAME) 24 | # location of default defconfig 25 | DEFCONFIG_FILE=$(CURDIR)/$(PROJECT_NAME)/defconfig 26 | DEFCONFIG := BR2_DEFCONFIG=$(DEFCONFIG_FILE) 27 | ALT_DEFCONFIG := BR2_DEFCONFIG=$(CURDIR)/defconfig 28 | 29 | MAKEFLAGS += --no-print-directory 30 | 31 | #these targets change the config file 32 | config_change_targets:=menuconfig nconfig xconfig gconfig oldconfig \ 33 | silentoldconfig randconfig allyesconfig allnoconfig randpackageconfig \ 34 | allyespackageconfig allnopackageconfig 35 | 36 | special_target:=$(config_change_targets) Makefile defconfig savedefconfig %_defconfig 37 | 38 | all := $(filter-out $(special_target),$(MAKECMDGOALS)) 39 | 40 | default: 41 | $(MAKE) $(MAKEARGS) $(DEFCONFIG) defconfig 42 | $(MAKE) $(MAKEARGS) $(DEFCONFIG) 43 | 44 | 45 | .PHONY: $(special_target) $(all) 46 | 47 | # update from current config and save it as defconfig 48 | defconfig: 49 | $(MAKE) $(MAKEARGS) $(ALT_DEFCONFIG) $@ 50 | $(MAKE) $(MAKEARGS) $(DEFCONFIG) savedefconfig 51 | 52 | # update from defconfig and save it as current configuration 53 | savedefconfig: 54 | $(MAKE) $(MAKEARGS) $(DEFCONFIG) defconfig 55 | $(MAKE) $(MAKEARGS) $(ALT_DEFCONFIG) savedefconfig 56 | 57 | # generate from a defconfig then save as current configuration 58 | %_defconfig: 59 | $(MAKE) $(MAKEARGS) $(DEFCONFIG) $@ 60 | $(MAKE) $(MAKEARGS) $(DEFCONFIG) savedefconfig 61 | $(call UPDATE_DEFCONFIG) 62 | 63 | 64 | # update from current configuration, run the command, then save the result 65 | $(config_change_targets): $(DEFCONFIG_FILE) 66 | $(MAKE) $(MAKEARGS) $(DEFCONFIG) defconfig $@ 67 | $(MAKE) $(MAKEARGS) $(DEFCONFIG) savedefconfig 68 | 69 | _all: 70 | $(MAKE) $(MAKEARGS) $(DEFCONFIG) $(all) 71 | 72 | $(all): _all 73 | @: 74 | 75 | %/: _all 76 | @: 77 | 78 | Makefile:; 79 | 80 | $(DEFCONFIG_FILE): 81 | $(call UPDATE_DEFCONFIG) 82 | 83 | define UPDATE_DEFCONFIG 84 | echo 'BR2_DL_DIR="$$(BR2_EXTERNAL)/dl"' >> $(DEFCONFIG_FILE) 85 | echo 'BR2_ROOTFS_OVERLAY="$$(BR2_EXTERNAL)/overlay"' >> $(DEFCONFIG_FILE) 86 | echo 'BR2_PACKAGE_OVERRIDE_FILE="$$(BR2_EXTERNAL)/local.mk"' >> $(DEFCONFIG_FILE) 87 | echo 'BR2_GLOBAL_PATCH_DIR="$$(BR2_EXTERNAL)/patch"' >> $(DEFCONFIG_FILE) 88 | $(MAKE) $(MAKEARGS) $(DEFCONFIG) defconfig 89 | $(MAKE) $(MAKEARGS) $(DEFCONFIG) savedefconfig 90 | endef 91 | 92 | 93 | -------------------------------------------------------------------------------- /package/swupdate-custom/swupdate-custom.mk: -------------------------------------------------------------------------------- 1 | ################################################################################ 2 | # 3 | # swupdate-custom 4 | # 5 | ################################################################################ 6 | 7 | SWUPDATE_CUSTOM_VERSION = master 8 | SWUPDATE_CUSTOM_SITE = git://github.com/sbabic/swupdate.git 9 | SWUPDATE_CUSTOM_LICENSE = GPLv2+, MIT, Public Domain 10 | SWUPDATE_CUSTOM_LICENSE_FILES = COPYING 11 | 12 | # Upstream patch to fix build without MTD support 13 | #SWUPDATE_CUSTOM_PATCH = https://github.com/sbabic/swupdate/commit/69c0e66994f01ce1bf2299fbce86aee7a1baa37b.patch \ 14 | 15 | 16 | # swupdate-custom bundles its own version of mongoose (version 3.8) 17 | 18 | ifeq ($(BR2_PACKAGE_JSON_C),y) 19 | SWUPDATE_CUSTOM_DEPENDENCIES += json-c 20 | SWUPDATE_CUSTOM_MAKE_ENV += HAVE_JSON_C=y 21 | else 22 | SWUPDATE_CUSTOM_MAKE_ENV += HAVE_JSON_C=n 23 | endif 24 | 25 | ifeq ($(BR2_PACKAGE_LIBARCHIVE),y) 26 | SWUPDATE_CUSTOM_DEPENDENCIES += libarchive 27 | SWUPDATE_CUSTOM_MAKE_ENV += HAVE_LIBARCHIVE=y 28 | else 29 | SWUPDATE_CUSTOM_MAKE_ENV += HAVE_LIBARCHIVE=n 30 | endif 31 | 32 | ifeq ($(BR2_PACKAGE_LIBCONFIG),y) 33 | SWUPDATE_CUSTOM_DEPENDENCIES += libconfig 34 | SWUPDATE_CUSTOM_MAKE_ENV += HAVE_LIBCONFIG=y 35 | else 36 | SWUPDATE_CUSTOM_MAKE_ENV += HAVE_LIBCONFIG=n 37 | endif 38 | 39 | ifeq ($(BR2_PACKAGE_LIBCURL),y) 40 | SWUPDATE_CUSTOM_DEPENDENCIES += libcurl 41 | SWUPDATE_CUSTOM_MAKE_ENV += HAVE_LIBCURL=y 42 | else 43 | SWUPDATE_CUSTOM_MAKE_ENV += HAVE_LIBCURL=n 44 | endif 45 | 46 | ifeq ($(BR2_PACKAGE_LUA),y) 47 | SWUPDATE_CUSTOM_DEPENDENCIES += lua host-pkgconf 48 | SWUPDATE_CUSTOM_MAKE_ENV += HAVE_LUA=y 49 | else 50 | SWUPDATE_CUSTOM_MAKE_ENV += HAVE_LUA=n 51 | endif 52 | 53 | ifeq ($(BR2_PACKAGE_MTD),y) 54 | SWUPDATE_CUSTOM_DEPENDENCIES += mtd 55 | SWUPDATE_CUSTOM_MAKE_ENV += HAVE_LIBMTD=y 56 | SWUPDATE_CUSTOM_MAKE_ENV += HAVE_LIBUBI=y 57 | else 58 | SWUPDATE_CUSTOM_MAKE_ENV += HAVE_LIBMTD=n 59 | SWUPDATE_CUSTOM_MAKE_ENV += HAVE_LIBUBI=n 60 | endif 61 | 62 | ifeq ($(BR2_PACKAGE_OPENSSL),y) 63 | SWUPDATE_CUSTOM_DEPENDENCIES += openssl 64 | SWUPDATE_CUSTOM_MAKE_ENV += HAVE_LIBSSL=y 65 | SWUPDATE_CUSTOM_MAKE_ENV += HAVE_LIBCRYPTO=y 66 | else 67 | SWUPDATE_CUSTOM_MAKE_ENV += HAVE_LIBSSL=n 68 | SWUPDATE_CUSTOM_MAKE_ENV += HAVE_LIBCRYPTO=n 69 | endif 70 | 71 | ifeq ($(BR2_PACKAGE_UBOOT_TOOLS),y) 72 | SWUPDATE_CUSTOM_DEPENDENCIES += uboot-tools 73 | SWUPDATE_CUSTOM_MAKE_ENV += HAVE_LIBUBOOTENV=y 74 | else 75 | SWUPDATE_CUSTOM_MAKE_ENV += HAVE_LIBUBOOTENV=n 76 | endif 77 | 78 | ifeq ($(BR2_PACKAGE_ZLIB),y) 79 | SWUPDATE_CUSTOM_DEPENDENCIES += zlib 80 | SWUPDATE_CUSTOM_MAKE_ENV += HAVE_ZLIB=y 81 | else 82 | SWUPDATE_CUSTOM_MAKE_ENV += HAVE_ZLIB=n 83 | endif 84 | 85 | SWUPDATE_CUSTOM_BUILD_CONFIG = $(@D)/.config 86 | 87 | SWUPDATE_CUSTOM_KCONFIG_FILE = $(call qstrip,$(BR2_PACKAGE_SWUPDATE_CUSTOM_CONFIG)) 88 | SWUPDATE_CUSTOM_KCONFIG_EDITORS = menuconfig xconfig gconfig nconfig 89 | 90 | ifeq ($(BR2_PREFER_STATIC_LIB),y) 91 | define SWUPDATE_CUSTOM_PREFER_STATIC 92 | $(call KCONFIG_ENABLE_OPT,CONFIG_STATIC,$(SWUPDATE_CUSTOM_BUILD_CONFIG)) 93 | endef 94 | endif 95 | 96 | define SWUPDATE_CUSTOM_SET_BUILD_OPTIONS 97 | $(call KCONFIG_SET_OPT,CONFIG_CROSS_COMPILE,"$(TARGET_CROSS)", \ 98 | $(SWUPDATE_CUSTOM_BUILD_CONFIG)) 99 | $(call KCONFIG_SET_OPT,CONFIG_SYSROOT,"$(STAGING_DIR)", \ 100 | $(SWUPDATE_CUSTOM_BUILD_CONFIG)) 101 | $(call KCONFIG_SET_OPT,CONFIG_EXTRA_CFLAGS,"$(TARGET_CFLAGS)", \ 102 | $(SWUPDATE_CUSTOM_BUILD_CONFIG)) 103 | $(call KCONFIG_SET_OPT,CONFIG_EXTRA_LDFLAGS,"$(TARGET_LDFLAGS)", \ 104 | $(SWUPDATE_CUSTOM_BUILD_CONFIG)) 105 | endef 106 | 107 | define SWUPDATE_CUSTOM_KCONFIG_FIXUP_CMDS 108 | $(SWUPDATE_CUSTOM_PREFER_STATIC) 109 | $(SWUPDATE_CUSTOM_SET_BUILD_OPTIONS) 110 | endef 111 | 112 | define SWUPDATE_CUSTOM_BUILD_CMDS 113 | $(TARGET_MAKE_ENV) $(SWUPDATE_CUSTOM_MAKE_ENV) $(MAKE) -C $(@D) 114 | endef 115 | 116 | define SWUPDATE_CUSTOM_INSTALL_TARGET_CMDS 117 | $(INSTALL) -D -m 0755 $(@D)/swupdate $(TARGET_DIR)/usr/bin/swupdate 118 | $(if $(BR2_PACKAGE_SWUPDATE_CUSTOM_INSTALL_WEBSITE), \ 119 | mkdir -p $(TARGET_DIR)/var/www/swupdate; \ 120 | cp -dpf $(@D)/www/* $(TARGET_DIR)/var/www/swupdate) 121 | endef 122 | 123 | # Checks to give errors that the user can understand 124 | # Must be before we call to kconfig-package 125 | ifeq ($(BR2_PACKAGE_SWUPDATE_CUSTOM)$(BR_BUILDING),yy) 126 | ifeq ($(call qstrip,$(BR2_PACKAGE_SWUPDATE_CUSTOM_CONFIG)),) 127 | $(error No Swupdate configuration file specified, check your BR2_PACKAGE_SWUPDATE_CUSTOM_CONFIG setting) 128 | endif 129 | endif 130 | $(eval $(kconfig-package)) 131 | -------------------------------------------------------------------------------- /overlay/opt/scripts/get_archive_name.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | # get_archive_name.sh - A shell script to get new archive 3 | 4 | # Variables 5 | SCRIPTS_PATH="/opt/scripts" 6 | SCRIPT_ENVIRONNEMENT="/DATA/env_var" 7 | is_archive="" 8 | 9 | # Get last archive name in the FTP server. 10 | get_last_archive_name () { 11 | 12 | if [ "$UPDATE_STATE" = "WAIT" ] 13 | then 14 | #wget --no-remove-listing "ftp://$ID:$PASS@10.5.16.130/$DIR_DOWNLOAD" 15 | ls $DIR_UPDATE > "$DIR_UPDATE/.listing" 16 | APPLI_UPDATE_NAME=$(sort "$DIR_UPDATE/.listing" | grep .swu | grep APP | tail -1) 17 | if [ "$APPLI_UPDATE_NAME" ]; then 18 | echo "APPLI_UPDATE_NAME=$APPLI_UPDATE_NAME" >> $SCRIPT_ENVIRONNEMENT 19 | UPDATE_STATE="GET_APP_ARCHIVE_NAME" 20 | source $SCRIPT_SAVE_ENVIRONNEMENT 21 | else exit 0; fi 22 | fi 23 | # Verify that new version is greater than the current version 24 | new_version=$(echo $APPLI_UPDATE_NAME | cut -d_ -f3) 25 | current_version=$(get_version "appli") 26 | is_archive=$(compare_versions $current_version $new_version) 27 | } 28 | 29 | # Parse archive's name to know which partition will be updated and download archives 30 | which_part () { 31 | 32 | # Get application archive 33 | if [ "$UPDATE_STATE" = "GET_APP_ARCHIVE_NAME" ] 34 | then 35 | #wget "ftp://$ID:$PASS@10.5.16.130/$DIR_DOWNLOAD/$APPLI_UPDATE_NAME" 36 | cd $DIR_UPDATE 37 | cpio -idv < $APPLI_UPDATE_NAME 38 | UPDATE_STATE="GET_APP_ARCHIVE" 39 | APPLI_UPDATE_NAME=$(ls | sort | grep .swu | grep APP | tail -1) 40 | source $SCRIPT_SAVE_ENVIRONNEMENT 41 | cd 42 | fi 43 | # Verify if new rootfs is needed 44 | rootfs_min_version=$(cat $FILE_MINIMAL_ROOTFS_VERSION) 45 | current_rootfs_version=$(get_version "rootfs") 46 | is_greater=$(compare_versions $current_rootfs_version $rootfs_min_version ) 47 | 48 | if [ "$is_greater" = "yes" ] 49 | then 50 | if [ "$UPDATE_STATE" = "GET_APP_ARCHIVE" ] 51 | then 52 | # Get rootfs name 53 | ROOTFS_UPDATE_NAME=$(sort "$DIR_UPDATE/.listing" | grep .swu | grep ROOTFS | tail -1) 54 | if [ "$ROOTFS_UPDATE_NAME" ]; then 55 | echo "ROOTFS_UPDATE_NAME=$ROOTFS_UPDATE_NAME" >> "$SCRIPT_ENVIRONNEMENT" 56 | UPDATE_STATE="GET_ROOTFS_NAME" 57 | source $SCRIPT_SAVE_ENVIRONNEMENT 58 | else exit 0; fi 59 | fi 60 | 61 | if [ "$UPDATE_STATE" = "GET_ROOTFS_NAME" ] 62 | then 63 | # Verify rootfs version validity 64 | if [ $(verify_validity $ROOTFS_UPDATE_NAME) = "yes" ] 65 | then 66 | # If the application version is not the previous, download the new rootfs, else we do not need it, 67 | # it is in the inactive rootfs partition 68 | if [ "$APP_STATE" = "WAIT" ] 69 | then 70 | #wget "ftp://$ID:$PASS@10.5.16.130/$DIR_DOWNLOAD/$ROOTFS_UPDATE_NAME" 71 | UPDATE_STATE="UPDATE_SYSTEM" 72 | else 73 | UPDATE_STATE="UPDATE_APP" 74 | fi 75 | else 76 | # If rootfs invalid wait next update 77 | UPDATE_STATE="WAIT" 78 | fi 79 | source $SCRIPT_SAVE_ENVIRONNEMENT 80 | fi 81 | else 82 | UPDATE_STATE="UPDATE_APP" 83 | source $SCRIPT_SAVE_ENVIRONNEMENT 84 | fi 85 | 86 | if [ $UPDATE_STATE = "UPDATE_APP" -o $UPDATE_STATE = "UPDATE_SYSTEM" ] 87 | then 88 | source $SCRIPT_LAUNCH_UPDATE 89 | fi 90 | 91 | } 92 | 93 | # Compare previous and new version 94 | compare_versions () { 95 | # Args 96 | # $1 - Current version 97 | # $2 - New version 98 | 99 | major_current=$(echo $1 | cut -d. -f1) 100 | major_new=$(echo $2 | cut -d. -f1) 101 | result="no" 102 | 103 | if [ $major_new -gt $major_current ]; then result="yes"; fi 104 | if [ $major_new -eq $major_current ]; then 105 | minor_current=$(echo $1 | cut -d. -f2) 106 | minor_new=$(echo $2 | cut -d. -f2) 107 | if [ $minor_new -gt $minor_current ]; then result="yes"; fi 108 | if [ $minor_new -eq $minor_current ]; then 109 | revision_current=$(echo $1 | cut -d. -f3) 110 | revision_new=$(echo $2 | cut -d. -f3) 111 | if [ $revision_new -gt $revision_current ]; then result="yes"; fi; fi; fi 112 | echo $result 113 | } 114 | 115 | # Get current app and rootfs version 116 | get_version () { 117 | # Args 118 | # $1 - "appli" or "rootfs" 119 | 120 | if [ $1 = "appli" ] 121 | then 122 | echo $(cat "$FILE_CURRENT_VERSIONS" | sed -n '/Application/p' | cut -d= -f2) 123 | elif [ $1 = "rootfs" ] 124 | then 125 | echo $(cat "$FILE_CURRENT_VERSIONS" | sed -n '/Rootfs/p' | cut -d= -f2) 126 | fi 127 | 128 | } 129 | 130 | # Verify if the version is not in invalid update file 131 | verify_validity () { 132 | # Args 133 | # $1 - Archive name 134 | 135 | grep $1 $FILE_INVALID_UPDATE && echo "no" || echo "yes" 136 | } 137 | 138 | is_need_reboot () { 139 | if [ $REBOOT = "1" ] 140 | then 141 | reboot 142 | fi 143 | } 144 | 145 | main () { 146 | 147 | get_last_archive_name 148 | if [ "$is_archive" = "yes" ] 149 | then 150 | is_valide=$(verify_validity $APPLI_UPDATE_NAME) 151 | if [ "$is_valide" = "yes" ] 152 | then 153 | which_part 154 | exit 0 155 | else 156 | UPDATE_STATE="WAIT" 157 | exit 0 158 | fi 159 | fi 160 | } 161 | 162 | source $SCRIPT_ENVIRONNEMENT 163 | main 164 | source $SCRIPT_SAVE_ENVIRONNEMENT 165 | #is_need_reboot 166 | 167 | 168 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | 676 | --------------------------------------------------------------------------------