==============
RVON+ Firmware
==============

These are the release notes for the firmware for the RVON+ card.


Components
==========

This release consists of the following files:

  - RVON+_Pkg_Firmware_v1.3.0.mot - Package containing all firmware components
  - RVON+_Pkg_All_v1.3.0.mot      - Package containing all firmware components,
                                        and also the FPGA image

Firmware can be downloaded from AZedit or from IPedit. However, depending on
the system size and configuration, the package containing the FPGA image may be
too large to download via AZedit; in this case, if the FPGA image needs to
be updated, IPedit must be used.


Boot Loader and Client Image
============================

The firmware is structured in two parts: The boot loader and the client
(application) image.

On power-up, the boot loader looks for a valid client image. If present,
control is passed to it; otherwise, the boot loader remains in control.

You can force the RVON+ to remain in the boot loader, even if a valid
client image is present, by pressing and holding both front-panel
pushbuttons, and hitting the reset button. Keep holding both pushbuttons
until the card finishes initialization.

While running the boot loader, the card will communicate with a Master
Controller card and will accept a new download. However, it will not attempt
to establish any audio links.


Minimum Firmware Versions
=========================

Full RVON+ support requires the following minimum versions:
  - AZedit v5.4.0
  - IPedit v4.0.0
  - ODIN v1.1.0
  - MCII-e v3.5.0
  - KP-Series-RVON v1.5.0
  - RVON-KP / RVON-16 / RVON-IO v2.7.0

An RVON+ can connect with an RVON device running v2.6.0 or earlier; however,
this requires the RVON device to be configured with a partner device type
of RVON-16 (rather than RVON+), and only channels 1-16 of the RVON+ card
will be accessible.


Change History
==============

Version 1.3.0 (CRC = 1653)
--------------------------

* Add support for RTS Edge

  This version allows connections from RTS Edge - either from a Web browser,
  or via the RTS Edge app running on a mobile device. Both G.711 and G.722
  codecs are supported.

  WebRTC connections are licensed. For each connected WebRTC channel, the
  RVON+ card must have a valid WebRTC license.


Version 1.2.0 (CRC = 6868)
--------------------------

* Added NAT support

  This version of firmware supports RVON connections where one of the
  devices is behind a NAT router. Both devices must have firmware which
  supports RVON behind NAT. (KP-Series RVON keypanels must be running
  v1.8.1 or later.)

  RVON behind NAT is not supported for legacy RVON devices such as the
  RVON-KP (keypanel daughter-card) and the RVON-16.


Version 1.1.1 (CRC = ca3d)
--------------------------

* RVON+ card could lose configuration information for individual channels

  If the Destination (partner) Channel for any channels were set to
  33 or higher, the destination configuration information for those channels
  would be lost if the card was reset. This would affect a channel configured
  to connect to channel 40 of an ODIN-HC, for example.

* RVON+ would sometimes fail to connect to ODIN-HC

  If the Destination Type for a channel was set to ODIN-HC or ODIN-R64, and
  the Destination Channel was set to a value between 1 and 16, in some cases
  the RVON link would fail to be established. (Connecting to a channel in
  the range 33-64 would always succeed.)


Version 1.1.0 (CRC = 9803)
--------------------------

* Support connections to keypanels behind a NAT firewall

  With RVON+ v1.1.0 and KP-Series RVON v1.8.0R, the keypanel can be
  connected behind a NAT router. In this case, the RVON+ must be configured
  to connect to the public IP address of the NAT router. It is not
  necessary to pre-program any static routes in the NAT router.

* Support new device types: RVOC Engine, DBP-R, DSPK-R


Version 1.0.5 (CRC = 9d57)
--------------------------

* Improved performance

  Some minor code revisions were made to reduce the jitter for transmitted
  packets, which reduced the number of lost packets and packet overruns for
  both the RVON+ and for connected KP-Series-RVON panels.

* Invalid ICMP Redirect packets could disable the default gateway


Version 1.0.4 (CRC = 4dd6)
--------------------------

* Fixed background noise problem when Comfort Noise Generator (CNG) was
  active for the G.722 codec


Version 1.0.3 (CRC = 7c24)
--------------------------

* Added new IPedit commands: reset authentication, factory reset

  If a user (logged in with Admin permissions) holds down Shift+Ctrl while
  right-clicking the RVON+ card in the catalog on the left-hand side, the
  pop-up context menu includes two new items:
     Reset Authentication Table
     Restore Factory Defaults
  (If the option is selected to restore the factory defaults, the relevant
  sections of flash memory are updated; however, the card's current operation
  is not changed. This includes its network IP settings, its authentication
  table, and its channel configuration. If the card is then reset, it will
  then have the true factory defaults - except that it may very well receive
  its configuration from the MCII-e.)

  These commands require IPedit v3.6.2 or later.

* Added security for various commands

  The following operations have been re-implemented so that they are more
  secure:
    - Clear channel and pass-through statistics
    - Tear down channel(s)
    - Reboot card
    - Enable/disable Telnet
  Admin permissions are now required in order to enable or disable Telnet.

  These commands now require IPedit v3.6.2 or later.

* Added security features for compliance with California Senate Bill 327

  For new devices, authentication must now be configured when first connecting
  to the device. This is necessary for compliance with California Law, 
  re: SB327: An act to add Title 1.81.26 (commencing with Section 1798.91.04) 
  to Part 4 of Division 3 of the California Civil Code, relating to information 
  privacy.

  With IPedit v3.6.2 or later, IPedit will switch to the Authentication tab,
  and display a message notifying the user of this requirement. Until
  authentication has been configured, the device will not allow any
  changes to be made; and IPedit (v3.6.2 or later) will switch to
  read-only mode.

  With earlier versions of IPedit, no notification will be displayed, but
  the device will still refuse to accept any changes until authentication has
  been configured.

  No change needs to be made to existing devices when this version of firmware
  is downloaded; however, if the authentication table is reset, or a factory
  reset is performed on the device, it will then enter the state where it
  requires authentication to be configured.

* Channel might come up but pass no audio

  If a channel was up and passing audio, and then got torn down (e.g. partner
  device was reset, channel was reconfigured), when the channel next came up
  it was possible that it would not handle any inbound audio. (The DSP to Micro
  Overrun errors would count continuously.) Resetting the channel would not
  help; the only solution was to reset the card. Fixed.

* Fixed audio playout problems

  There could be occasional audio artifacts on one or more channels, accompanied
  by DSP to Micro Overrun errors (as shown in AZedit and IPedit). Fixed.

  Note that the RVON+ FPGA must be updated to version 0.2.9 (included as part of
  this release) to resolve this problem.

* Fixed possible reset problem

  If the RVON+ card was connected to a device X, and device X tore down the
  link (e.g. because the link was reconfigured, or because IPedit connected
  to device X told it to tear down the link), in rare cases this could cause
  the RVON+ to reset. Fixed.


Version 1.0.2 (CRC = 6f29)
--------------------------

* Fixed audio drop-out problems

  In certain cases, an RVON+ card with a large number of audio links could
  experience audio drop-out problems. The problem was more likely to occur
  when using G.722 or G.729 codecs rather than G.711. Fixed.

* Fixed possible reset problem

  In rare circumstances, it was possible for the RVON+ card to reset. The
  problem was more likely to occur when many channels were connected, using
  G.722 or G.729 codecs. Fixed.


Version 1.0.1 (CRC = 0867)
--------------------------

* Links to RVON-16 / RVON-8 / RVON-C might not come up

  If the partner device for an RVON+ channel was a legacy RVON device
  (RVON-16, RVON-8, or RVON-C), the link would not come up if the IP address
  of one device was 128.0.0.0 or greater AND the IP address of the other
  device was 127.255.255.255 or less. Fixed.


Version 1.0.0 (CRC = eb34)
--------------------------

* Initial release

  The initial release consists of the following components:
    - Boot loader v1.0.0
    - Application code v1.0.0
    - CPU #2 v1.0.0
    - FPGA v0.2.8
