satip-axe/dist/README

SATIP-AXE firmware binary files
===============================

This directory contains USB and flash firmware for
  * Inverto IDL-400s
  * Grundig GSS.BOX
  * Telestar Digibit R1

Update:
-------

  - check differences in /etc/config.default against /etc/sysconfig/config
    - example: diff -u /etc/config.default /etc/sysconfig/config
  - since build 9 firmware upgrade may be upgraded using upgrade-fw tool
    - file can be fetched directly from github
    - or specified as a local firmware file directly
    - the file is copied to ramfs before flashing
    - the first attempt fails usually (ask Inverto), press Enter to repeat
    - example: 'upgrade-fw'
      - lists firmwares on github
    - example: 'upgrade-fw satip-axe-201504211434-8.fw'
      - fetches file from github and flashes it, but if the local
        file satip-axe-201504211434-8.fw exists, it is preferred

Installation:
-------------

  - set DHCP in the original firmware (not 100% required, but several
    users reported that without this change the network might not work)
  - setup a DHCP server for the box ethernet MAC address
  - copy satip-axe-$(VERSION).usb as idl4k.scr (rename the file) to the USB stick
  - copy satip-axe-$(VERSION).fw (no rename) to the USB stick
  - both files should be in the root directory on the USB stick
  - plug the USB stick to the upper USB port in box
  - turn on the box
  - the tuner LEDs must blink (Knight Rider effect) for few seconds
  - box is accessible through telnet or ssh, IP address is obtained using DHCP
  - the default login/password is root/satip
  - the firmware is not written to the internal flash - when the USB stick
    is not in the box, the original firmware will be booted

Installation to internal flash:
-------------------------------

  - WARNING! The original firmware will be deactivated!
  - the original firmware can be turned on using idl4k.recovery (see bellow)
  - same steps, but use satip-axe-$(VERSION).flash file as idl4k.scr
  - after boot of the new version, remove the USB stick to not write
    the .fw file multiple times to flash (on each box start); eventually
    the idl4k.scr file can be removed from the USB stick to prevent
    another reflash
  - the firmware is written to another internal flash area than
    the original firmware, but uboot is reconfigured

Extra packages:
---------------

  - the packages are unpacked at boot from /mnt/data/satip-axe/packages
  - only gzip (.tar.gz) and bzip2 (.tar.bz2) packages are supported
    - note bzip2 is slow!
  - there is 'fetch-package' script which will list all packages on github
    and download one package (use name of package as first argument)

Customization:
--------------

  - configuration file is in /etc/sysconfig/config
  - put localtime file (glibc) to /etc/sysconfig/localtime
  - put resolv.conf file to /etc/sysconfig/resolv.conf
  - localboot script can be in /etc/sysconfig/localboot
  - passwd file is copied from /etc/sysconfig/passwd
  - ssh authorized_keys file is copied from /etc/sysconfig/authorized_keys
  - inetd.conf file is linked to /etc/sysconfig/inetd.conf
  - oscam configs are in /etc/sysconfig/oscam directory
  - if /etc/sysconfig/customd script exists, it is executed from init
  - if /etc/sysconfig/profile script exists, it is executed at login
  - writeable ftp - copy /etc/inetd.conf to /etc/sysconfig/inetd.conf and
    add -w argument to the ftpd daemon

httpd:
------

  - /media tree is exported

ftpd:
-----

  - /media tree is exported, use root/satip as login

nfsd:
-----

  - only v3 protocol is supported
  - to list connected clients 'showmount'
  - to list exports 'exportfs'

Minisatip config:
-----------------

  - you may add extra parameters to MINISATIP_OPTS= in /etc/sysconfig/config
  - WARNING: use -d with unique numbers if you have _multiple_ SAT>IP servers on net
  - SEE: minisatip.md file in this directory for more details
  - example 1: only two tuners: MINISATIP_OPTS="-e 0-1"
  - example 2: unicable: MINISATIP_OPTS="-u 0:1-1420,1:0-1210,2:2-1680,3:3-2040"
  - AXE hardware specific options:
     -L link adapters (identical src,lo/hi,h/v), the format is M:S (master:slave)
     -Q quattro LNB config (H/H,H/V,L/H,L/V)
     -X X AXE unicable/jess input (0-3)
  - example 3: unicable coax in input 2: MINISATIP_OPTS="-X 1"
  - example 4: quattro LNB: MINISATIP_OPTS="-Q"
  - example 5: coax in inputs 1,2, tuner 3 slave to input 1, tuner 4 slave to input 2
               MINISATIP_OPTS="-L 0:2,1:3"

OSCAM config:
-------------

  - in /etc/sysconfig/oscam directory
  - login/password is oscam/satip, http webui available at http://<boxip>:8888
  - use persistent serial device names (like /dev/ttyUSB1-1.2:1.0)
  - or use customized serial device names (see /etc/sysconfig/config)

Misc:
-----

  - full tuner reset - "axe-debug reset"

Recovery from the wrong configuration:
--------------------------------------

  - it works with firmware build 10 and later
  - for flashed firmware:
    - copy idl4k.cfgreset file as idl4k.scr file to the root directory on the USB stick
  - for firmware on the USB stick:
    - copy idl4k.cfgresetusb file as idl4k.scr file to the root directory on the USB stick
    - copy satip-axe-*.fw file as satip-axe.fw to the root directory on the USB stick
      (build 10 or later)
  - plug the USB stick to the upper USB port in box
  - turn on the box
  - the old configuration file is moved to /etc/sysconfig/config.old

Recovery of the original firmware:
----------------------------------

  - copy idl4k.recovery file as idl4k.scr file to the root directory on the USB stick
  - plug the USB stick to the upper USB port in box
  - turn on the box
  - box is accessible through http (web browser) - original firmware

Notes:
------

  - there is 128M SPI flash memory in the device
  - 128k for u-boot (probably)
  - 4M marked as system-nand0 (probably unused)
  - the original firmware uses fw1-nand0 flash region (32M)
  - the satip-axe firmware uses fw2-nand0 flash region (32M)
  - data block is named data-nand0 - uses rest of flash

Disclaimer:
-----------

The SATIP AXE firmware is supplied "AS IS" without any warranties and
support.

The authors assumes no responsibility or liability for the use of
the software, conveys no license or title under any patent, copyright, or
mask work right to the product.

The authors reserve the right to make changes in the software
without notification. Authors also make no representation or
warranty that such software will be suitable for the specified use
without further testing or modification.

Bugs:
-----

  - the Inverto driver do not initialize properly sometimes
    (minisatip is not started); if minisatip does not work,
    you may check 'logread' for tuner initialization error (512)
    or use 'dmesg' to check the lines bellow;
    turn off the box for 5-30 minutes and try again...

        demod900] setup [num_demods 4]
        [pll6120] setup [num_plls:4] [clk:30000000] [bbgain:16]
        [fe] Checking lut 0xC1ABEAF0
        [fe] Checking lut 0xC1ABEB26
        [fe] Checking lut 0xC1ABEAF0
        [fe] Checking lut 0xC1ABEB54
        [dmx] ... init 0
        [dmx-ts] ... init 0
        [i2c] I2C bus error /errno -121/!!
        [i2c] I2C bus error /errno -121/!!
        [i2c] I2C bus error /errno -121/!!
        [pll6120] init error!
        [fta_fe] FE Initialization done, res -1

  - reboot command cannot be used (uboot usb init fails, hw init fails)

History:
--------

satip-axe-201603051934-11 - Sat Mar  5 2016
  - updated stmmac ethernet driver from latest stlinux kernel
    - linux-sh4-2.6.32.y - _stm24_0217
    - enabled Realtek PHY module (RTL8211E)
    - disable scatter-gather, increase ring descriptors (from 256 to 512)
  - updated axe_fe.ko kernel module (fix for tuners 3 & 4 from Inverto)
  - updated axe_dmxts.ko kernel module from idl4k-1.24.0.156
  - updated dropbear to 2015.71
    - changed from dss host key to rsa host key (for latest openssl)
  - updated nfsutils to 1.3.3
  - updated nano to 2.4.3
  - updated oscam to 11211
  - minisatip accepts -M option to skip first MPEG-TS packets from demuxer
    - the default value is 35 (to skip packets from previous tune)
  - minisatip can handle multiple unicable groups (-Z option)
  - minisatip improved/fixed LNB standby/power handling (-P option)
  - added second minisatip binary (minisatip5 - based on 0.5.30 version)
    - add new lines to /etc/sysconfig/config from /etc/config.default
  - added support for extra packages (put them to /mnt/data/satip-axe/packages)
    - added Python-3.5.1-1.tar.gz package (required for multicast-rtp)
    - added multicast-rtp-1.tar.gz package (see /sbin/multicast-rtp for help)

satip-axe-201508061051-10 - Thu Aug  6 2015
  - replaced stapi / frontend / demuxer drivers with latest from Inverto
  - updated kernel USB stack, fixed ftdi_sio kernel oops (mouse readers)
  - updated minisatip to new demuxts (reduce CPU usage)
  - fixed -b option for minisatip
  - updated oscamd to 10937
  - fixed /etc/mdev.conf to mount USB sticks without partitions
  - added idl4k.cfgreset script to reset wrong config

satip-axe-201505242057-9 - Sun May 24 2015
  - added http://boxip:8080/axe-status.txt status page (shell parseable)
  - fixed ntpd start
  - added crond start / configuration
  - added customd start (custom daemon/service/setup - script) from init
  - added nano text editor
  - updated oscam to 10663
  - added upgrade-fw script for the internal flash upgrade without an USB stick
  - added /etc/sysconfig/profile support

satip-axe-201504211434-8 - Tue Apr 21 2015
  - faster boot (approx. 25 seconds from flash)
  - tuners - configurable gain (0-16dB) - STV6210_BAMP in config
  - enabled inetd/httpd/ftpd/nfsd by default
  - added nfsd v3 support
  - added ethtool
  - extended debug tools for I2C bus (axe-debug, axehelper)

satip-axe-201504142137-7 - Tue Apr 14 2015
  - minisatip
    - allow configurable DVR read buffer (-b option)
    - decrease default DVR read buffer to 14 UDP packets (18424 bytes)
    - allow 13V only for unicable/jess (* before freq)
    - tuner LED fixes
  - AXE modules
    - remove the load hell from STLinux, move everything to /etc/init.d/rcS
    - another workarounds for the correct tuner initialization

satip-axe-201504101512-6 - Fri Apr 10 2015
  - extended minisatip (quattro LNB, master/slave, unicable on other input)
  - another shuffling in the AXE modules load procedure

satip-axe-201504092035-5 - Thu Apr  9 2015
  - fixed minisatip & dhcp issue - minisatip is started with good IP
  - changed load order of AXE modules and AXE hw initialization

satip-axe-201504082030-4 : Wed Apr  8 2015
  - upgraded busybox to v1.23.2
  - added ntpd configuration (network time daemon)
  - changed dropbear default PATH to "/sbin:/usr/sbin:/bin:/usr/bin:/usr/local/bin"
  - added /dev/sd* devices hotplug (mounted to /media tree using labels)
  - added kernel modules for USB serial converters (most Phoenix readers)
  - added /dev/ttyUSB* devices hotplug (persistent names like /dev/ttyUSB2-1:1.0)
  - added oscam r10619
  - allow customization of hostname (/etc/sysconfig/config)
  - minisatip fixes (signal levels, cleanups)

satip-axe-201504061852-3 : Mon Apr  6 2015
  - minisatip fixes (unicable-jess, corrected input selection - coax inputs)

satip-axe-201504061852-2 : Mon Apr  6 2015
  - minisatip fixes (unicable, multiple tuners, h/v and lo/hi setup)
  - load axe modules in rcSBB

satip-axe-201503311856-1 : Tue Mar 31 2015
  - initial firmware release