From f16dfbeca8bfeb490d09f1dc82e7f39e9fa5eaa4 Mon Sep 17 00:00:00 2001 From: cdg123 Date: Thu, 26 Sep 2024 14:12:34 +0100 Subject: [PATCH 1/4] Update sysupgrade.md Added extra details to make it easier for new people to the project to understand the firmware update options --- en/sysupgrade.md | 69 +++++++++++++++++++++++++++++++++--------------- 1 file changed, 48 insertions(+), 21 deletions(-) diff --git a/en/sysupgrade.md b/en/sysupgrade.md index 9e94840..b137cf6 100644 --- a/en/sysupgrade.md +++ b/en/sysupgrade.md @@ -3,31 +3,50 @@ Upgrading firmware ------------------ +Once the initial installation of the OpenIPC software for your camera is complete it is possible to upgrade it either via the Majestic web interface or manually via a terminal window. -### Upgrading from GitHub -For old firmware running `sysupgrade` without parameters is enough. For newer firmware, run `sysupgrade -k -r` to update both kernel and rootfs. +This article is about how to manually perform an update using a terminal window using the sysupgrade command. -__ATTENTION! Upgrading firmware can lead to "bricking" your camera. Make sure you are prepared both morally and skillwise. Have your rescue SD card and/or UART adapter ready. Be prepared to de-solder and reprogram flash chip as the last resort. Do not upgrade production cameras unless you really have to!__ +_Note: By default, sysupgrade will reboot the camera to complete the update. If you don't wish to do that then use the -x option (see sysupgrade --help for all options)_ -### Upgrading from a TFTP server +### Upgrading from the GitHub latest release. +By default, running sysupgrade will attempt to download the latest software for your camera model from the github sources. -[Set up a TFTP server](installation-tftpd.md). +There are other options available such as pointing to your own online .tgz file or a local copy of the Linux kernel (uImage) and camera software (rootfs.squashfs) -Go to and download the latest firmware bundle for your SoC. -Extract content of the bundle into the root directory of your TFTP server. +For old firmware running `sysupgrade` without parameters is enough. For newer firmware, run `sysupgrade -k -r` to update both kernel and rootfs is required -On the camera run: +__ATTENTION! Upgrading firmware can lead to "bricking" your camera. Make sure you are prepared both morally and skill wise. Have your rescue SD card and/or UART adapter ready. Be prepared to de-solder and reprogram flash chip as the last resort. Do not upgrade production cameras unless you really have to!__ -#### Github: From Linux +### Using sysupgrade +Typically running sysupgrade will give you the latest release for your camera, as described above, however if you wish to revert to a previous image, or load your own updates, then use any the following options. +Remember once you are ready to run sysupgrade you must use the syntax

+`sysupgrade --kernel=/tmp/uImage.${soc} --rootfs=/tmp/rootfs.squashfs.${soc} -z`

where '${soc}' is your camera specific soc e.g. gk7205v300 +otherwise the Github latest will be downloaded. + +### Using a TFTP server +#### On your host machine: +If you haven't already got a TFTP server running on your host machine then take a look at the Wiki article [Set up a TFTP server](installation-tftpd.md). + +If you don't already have the uImage and rootfs.squashfs images for your camera then go to and download the latest firmware bundle for your SoC and extract the content of the bundle into the root directory of your TFTP server. + +If you have built your own versions using a copy of the [firmware repository](https://github.com/OpenIPC/firmware) then your uImage and rootsfs.squashfs images will be in your _output/images_ folder. Copy these to the root of your tftp server. + +#### On the camera: +You can either update the images from a Linux terminal session or from the U-Boot prompt if you have a UART serial connection and interrupted Linux loading. + +##### From Linux ```bash soc=$(fw_printenv -n soc) serverip=$(fw_printenv -n serverip) +cd /tmp busybox tftp -r rootfs.squashfs.${soc} -g ${serverip} busybox tftp -r uImage.${soc} -g ${serverip} +sysupgrade --kernel=/tmp/uImage.${soc} --rootfs=/tmp/rootfs.squashfs.${soc} -z ``` -#### Github: Alternatively, from U-Boot +##### From U-Boot for 8MB image @@ -49,37 +68,45 @@ tftp ${baseaddr} rootfs.squashfs.${soc} sf probe 0; sf erase 0x250000 0xA00000; sf write ${baseaddr} 0x250000 ${filesize} ``` -### Upgrading from local files +Now restart the camera to load the new images -Go to and download the latest firmware bundle for your SoC. -Unpack the bundle and upload its content on camera using `scp`: +### Using scp +#### On your host machine: +If you don't already have the uImage and rootfs.squashfs images for your camera then go to and download the latest firmware bundle for your SoC and extract the contents + +If you have built your own versions using a copy of the [firmware repository](https://github.com/OpenIPC/firmware) then your uImage and rootsfs.squashfs images will be in your _output/images_ folder. + +Now copy these to the camera using scp ```bash tar xvf scp uImage* rootfs* root@:/tmp/ ``` -On the camera run: +#### On the camera: +Now create a terminal session with the camera e.g. ssh root@192.168.1.10 and run the sysupgrade command pointing at your new images in /tmp. ```bash soc=$(fw_printenv -n soc) sysupgrade --kernel=/tmp/uImage.${soc} --rootfs=/tmp/rootfs.squashfs.${soc} -z ``` -### Upgrading from SD card +### Upgrading from an SD card +#### On your host machine +If you don't already have the uImage and rootfs.squashfs images for your camera then go to and download the latest firmware bundle for your SoC and extract the contents -#### SD Card: From Linux +If you have built your own versions using a copy of the [firmware repository](https://github.com/OpenIPC/firmware) then your uImage and rootsfs.squashfs images will be in your _output/images_ folder. -Go to and download the latest firmware bundle for your SoC. -Insert an SD card into your desktop PC. Unpack the bundle and copy its content to the card: +Insert an SD card into your host machine and copy the uImage and squashfs files to the card e.g. ```bash -tar xvf cp uImage* rootfs* /media/// ``` +#### On your camera Insert the SD card into your camera. -On the camera run: + +Create a terminal session and run the following ```bash soc=$(fw_printenv -n soc) @@ -114,7 +141,7 @@ sf probe 0; sf erase 0x350000 0xa00000; sf write ${baseaddr} 0x350000 ${filesize ### Flashing U-Boot via ymodem -Clean 320K of RAM amd load bootloader file into it: +Clean 320K of RAM and load bootloader file into it: ```bash mw.b ${baseaddr} 0xff 0x50000 From a1345c9776358143cae012a049570ab19dd1aee5 Mon Sep 17 00:00:00 2001 From: cdg123 Date: Thu, 26 Sep 2024 15:41:20 +0100 Subject: [PATCH 2/4] Update sysupgrade.md --- en/sysupgrade.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/en/sysupgrade.md b/en/sysupgrade.md index b137cf6..60dc077 100644 --- a/en/sysupgrade.md +++ b/en/sysupgrade.md @@ -3,7 +3,7 @@ Upgrading firmware ------------------ -Once the initial installation of the OpenIPC software for your camera is complete it is possible to upgrade it either via the Majestic web interface or manually via a terminal window. +Once the initial installation of the OpenIPC software for your camera is complete it is possible to upgrade it either via the web interface or manually via a terminal window. This article is about how to manually perform an update using a terminal window using the sysupgrade command. @@ -12,18 +12,18 @@ _Note: By default, sysupgrade will reboot the camera to complete the update. If ### Upgrading from the GitHub latest release. By default, running sysupgrade will attempt to download the latest software for your camera model from the github sources. -There are other options available such as pointing to your own online .tgz file or a local copy of the Linux kernel (uImage) and camera software (rootfs.squashfs) +There are other options available so you can use a local copy of the Linux kernel (uImage) and camera software (rootfs.squashfs) For old firmware running `sysupgrade` without parameters is enough. For newer firmware, run `sysupgrade -k -r` to update both kernel and rootfs is required __ATTENTION! Upgrading firmware can lead to "bricking" your camera. Make sure you are prepared both morally and skill wise. Have your rescue SD card and/or UART adapter ready. Be prepared to de-solder and reprogram flash chip as the last resort. Do not upgrade production cameras unless you really have to!__ ### Using sysupgrade -Typically running sysupgrade will give you the latest release for your camera, as described above, however if you wish to revert to a previous image, or load your own updates, then use any the following options. +Typically running sysupgrade will give you the latest release for your camera, as described above, however if you wish to revert to a previous image, or load your own updates, then use any the options described below. Remember once you are ready to run sysupgrade you must use the syntax

`sysupgrade --kernel=/tmp/uImage.${soc} --rootfs=/tmp/rootfs.squashfs.${soc} -z`

where '${soc}' is your camera specific soc e.g. gk7205v300 -otherwise the Github latest will be downloaded. +otherwise the latest release on Github will be downloaded. ### Using a TFTP server #### On your host machine: @@ -34,7 +34,11 @@ If you don't already have the uImage and rootfs.squashfs images for your camera If you have built your own versions using a copy of the [firmware repository](https://github.com/OpenIPC/firmware) then your uImage and rootsfs.squashfs images will be in your _output/images_ folder. Copy these to the root of your tftp server. #### On the camera: -You can either update the images from a Linux terminal session or from the U-Boot prompt if you have a UART serial connection and interrupted Linux loading. +You can either update the images from a Linux terminal session or from the U-Boot prompt, if you have a UART serial connection and interrupted Linux loading. + +Check that your camera environment variable for the TFTP server is correct by looking for the _serverip_ entry when listing them with _fw_printenv_. + +If it needs updating use _fw_setenv serverip _ command. ##### From Linux ```bash From 16eb13dc272cacfc6a8f013e9e6d83fcdbd89909 Mon Sep 17 00:00:00 2001 From: cdg123 Date: Thu, 26 Sep 2024 16:40:30 +0100 Subject: [PATCH 3/4] Update sysupgrade.md scp comments updated to reflect need for -O option in latest desktop OS's --- en/sysupgrade.md | 32 ++++++++++++++++++++++---------- 1 file changed, 22 insertions(+), 10 deletions(-) diff --git a/en/sysupgrade.md b/en/sysupgrade.md index 60dc077..1bd4ba8 100644 --- a/en/sysupgrade.md +++ b/en/sysupgrade.md @@ -7,14 +7,14 @@ Once the initial installation of the OpenIPC software for your camera is complet This article is about how to manually perform an update using a terminal window using the sysupgrade command. -_Note: By default, sysupgrade will reboot the camera to complete the update. If you don't wish to do that then use the -x option (see sysupgrade --help for all options)_ +_Note: By default, sysupgrade will reboot the camera to complete the update. If you don't wish to do that then use the -x option (see sysupgrade --help for all options)_. ### Upgrading from the GitHub latest release. By default, running sysupgrade will attempt to download the latest software for your camera model from the github sources. -There are other options available so you can use a local copy of the Linux kernel (uImage) and camera software (rootfs.squashfs) +There are other options available so you can use a local copy of the Linux kernel (uImage) and camera software (rootfs.squashfs). -For old firmware running `sysupgrade` without parameters is enough. For newer firmware, run `sysupgrade -k -r` to update both kernel and rootfs is required +For old firmware running `sysupgrade` without parameters is enough. For newer firmware, run `sysupgrade -k -r` to update both kernel and rootfs is required. __ATTENTION! Upgrading firmware can lead to "bricking" your camera. Make sure you are prepared both morally and skill wise. Have your rescue SD card and/or UART adapter ready. Be prepared to de-solder and reprogram flash chip as the last resort. Do not upgrade production cameras unless you really have to!__ @@ -29,7 +29,11 @@ otherwise the latest release on Github will be downloaded. #### On your host machine: If you haven't already got a TFTP server running on your host machine then take a look at the Wiki article [Set up a TFTP server](installation-tftpd.md). -If you don't already have the uImage and rootfs.squashfs images for your camera then go to and download the latest firmware bundle for your SoC and extract the content of the bundle into the root directory of your TFTP server. +If you don't already have the uImage and rootfs.squashfs images for your camera then go to and download the latest firmware bundle for your SoC and extract the content of the bundle into the root directory of your TFTP server. + +```bash +tar xvf +``` If you have built your own versions using a copy of the [firmware repository](https://github.com/OpenIPC/firmware) then your uImage and rootsfs.squashfs images will be in your _output/images_ folder. Copy these to the root of your tftp server. @@ -72,21 +76,29 @@ tftp ${baseaddr} rootfs.squashfs.${soc} sf probe 0; sf erase 0x250000 0xA00000; sf write ${baseaddr} 0x250000 ${filesize} ``` -Now restart the camera to load the new images +Now restart the camera to load the new images. ### Using scp #### On your host machine: -If you don't already have the uImage and rootfs.squashfs images for your camera then go to and download the latest firmware bundle for your SoC and extract the contents - -If you have built your own versions using a copy of the [firmware repository](https://github.com/OpenIPC/firmware) then your uImage and rootsfs.squashfs images will be in your _output/images_ folder. - -Now copy these to the camera using scp +If you don't already have the uImage and rootfs.squashfs images for your camera then go to and download the latest firmware bundle for your SoC and extract the contents. ```bash tar xvf +``` + +If you have built your own versions using a copy of the [firmware repository](https://github.com/OpenIPC/firmware) then your uImage and rootsfs.squashfs images will be in your _output/images_ folder. + +Now copy these to the camera using scp. + +```bash scp uImage* rootfs* root@:/tmp/ ``` +**Note:** If you get an error that '/usr/libexec/sftp-server could not be found' it is because in later versions of scp sftp is now used behind the scenes and this is not built into the busybox implementation currently. To force scp to use the legacy behavour use the -O option so +```bash +scp -O uImage* rootfs* root@:/tmp/ +``` +ssh #### On the camera: Now create a terminal session with the camera e.g. ssh root@192.168.1.10 and run the sysupgrade command pointing at your new images in /tmp. From 6a7677b3037a6a15d8aab03c0cd2e1193d92635b Mon Sep 17 00:00:00 2001 From: cdg123 Date: Thu, 26 Sep 2024 16:46:03 +0100 Subject: [PATCH 4/4] Update sysupgrade.md Fix typo --- en/sysupgrade.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/en/sysupgrade.md b/en/sysupgrade.md index 1bd4ba8..0a7a880 100644 --- a/en/sysupgrade.md +++ b/en/sysupgrade.md @@ -98,7 +98,7 @@ scp uImage* rootfs* root@:/tmp/ ```bash scp -O uImage* rootfs* root@:/tmp/ ``` -ssh + #### On the camera: Now create a terminal session with the camera e.g. ssh root@192.168.1.10 and run the sysupgrade command pointing at your new images in /tmp.