; mmk, firmware for micro/DIGI/CW KEYER (MK/CK/DK), change log
; by Brano Panak (v1.0) & Martin Bujdak (since v1.1), microHAM
--------------------------------------------------------------------------------

v5.4, released 080305
v5.3, released 080211
  - minor internal changes
v5.2, released 080127
  - minor bug fixed: Potential deadlock in situation when PS2 CLK is faulty
    shortened to ground was eliminated.
v5.1, released 071211
  - Some code optimizations.
v5.0, released 071122
  - Some changes in keyer protocol and settings format was introduced to be
    compatible with router v5.1.0. Hence firmware MUST be upgraded and power-up
    settings MUST be again stored to EEPROM of keyer.
  - BackSpace on PS2 keyboard now functions as ESC.
v4.2, released 071017
  - serious bug fixed: Under some circumstances a data sended from computer
    to keyer could be lost. It caused various undesirable keyer behavior
    (incorrect PTT configuration, incorrect WK commands, lost data for WK, ...)
  - bug fixed: PS2 keyboard/pad sporadically freeze in state in which it didn't
    respond to key strokes.
  - bug fixed: WinKey PinConfig was not always updated on mode change. This
    caused that incorrect PTT selection (PTT1/PTT2/noPTT) was used.
v4.1, released 070912
v4.0, released 070905 (testing)
  - Implemented WinKey partial command parser to prevent computer to send WinKey
    inadequate settings and to have WPM under control.
  - PTT selection (PTT1/PTT2/noPTT) was unified for all PTT sources (foot switch,
    serial PTT, WinKey)
  - PTT delay was coupled with WinKey PTT Lead.
  - Added possibility to switch mode on num pad (special keys: *0,*1,*2,*3,*4)
  - Added possibility to temporarily disable PA/LNA PTT (special key *9)
  - bug fixed: WPM control from PS2 keyboard/numpad didn't work in standalone
    mode.
v3.4, released 070423
  - Special edition for CK/DK and ORION II. It forces 56000 bps.
v3.3, released 070115
  - Extended router-firmware protocol:
    - Possibility to start/abort playback/recording of CW/FSK messages
    - Forced switching of keyboard mode in manual mode
  - NUM LED on PS2 keyboard is used in voice mode too.
v3.2, released 061123
  - bug fixed: 56000 bps issue
  - "auto number" is not send for CK.
v3.1, released 061116
  - bug fixed: Band Decoder compatibility
  - Keyboard mode and "auto number" are resend to router when USB connection is
    resumed.
v3.0, released 060721
  - When message is played in FSK mode a WinKey commands possibly contained
    in message (except PTT ON/OFF) are filtered out. It allows playing of
    "any" message in both CW and FSK modes.
  - Added possibility to insert extra FIGURE SHIFT, extra LETTER SHIFT, BLANK
    and BEL characters to FSK Message. Also PTT ON and PTT OFF commands work in
    FSK mode.
  - New keyboard mode switching: When MK is connected router can force one of
    CW, FSK or VOICE keyboard mode or can set "manual" to allow user switch modes
    by CAPS key. When MK is disconnected user can manually switch between CW
    and FSK modes (VOICE mode cannot be used without router).
  - bug fixed: When in CW mode the ALT key (or CTRL in versions older than v2.7)
    was pressed without entering the new number, keyer stoped respond to keyboard
    events.
  - bug fixed: CK and DK now return correct value of CTS.
  - bug fixed: Small bug related to "USB disconnect timer" was fixed.
  - Migration to WinAVR 20060125
  - Note: Since this version the firmware is updated consistently with "mok"
    firmware for MK2R.
v2.7, released 060303
  - Now it is possible to utilize messages in both modes CW and FSK.
  - Using of CTRL key was replaced by ALT to prevent interference with some
    keyboard switches available on the market.
  - Some small changes in keyboard evaluation.
v2.6, released 051223 (private)
  - PA PTT output can optionaly generate also LNA PTT (with PTT tail)
  - PTT2 can be again generated from foot switch like before v1.8 (PTT1/PTT2
    from footswitch are always delayed)
  - New flag "FSK busy" is generated. This allows to host applications turn PTT
    off in the right time.
  - Function TUNE, started with asterisk on key pad, now generate PTT in advance
    before CW to overcome problems with some radios.
  - Added possibility to temporarily suppress keyboard evaluation. This can be
    used by router to handle voice message recording/playing from keyer keyboard
    without mixing with standard function of keyboard.
  - support for digi keyer
v2.5, released 051104
  - Advanced radio data transfer.
v2.4, released 050916
  - CTS ignored in CW keyer.
v2.3, released 050822
  - Because the same firmware is used for whole family of devices (micro KEYER,
    CW KEYER, ...) there was built in device subtype detection to enable/disable
    some features.
  - bug fixed: Since v2.0 firmware correctly transmits only 5-bits stream on FSK
    channel. It results in undesirable behavior when router (older than v2.2.2)
    set FSK channel to non 5-bit mode.
v2.2, released 050809
  - CTS from radio is passed to computer. When RTS/CTS handshake is set on radio
    port, keyer respects CTS level and suspend transmition to radio if inactive.
    Radio TX buffer extended to 128 bytes.
v2.1, released 050715
  - bug fixed: Previous version incorrectly read/write CW messages from/to
    EEPROM memory.
  - bug fixed: Foot switch did not activate PTT1 when delay was set to 0.
v2.0, released 050713
  - Wide optimalization of code.
  - new features:
    - Auto numbering in CW mode (ENTER invoke sending of number optionally with
      report 5NN, number is automatically incremented, can be changed from
      keyboard)
    - Type ahead with buffer of 16 characters (optional in both FSK and CW mode)
    - Optional QWERTZ keyboard layout
    - Keys ENTER,+,- on numpad have two alternative functions (WPM speed control
      and auto numbering control) that are toggled by numpad key /. Its old
      function (side tone control) is obsolete.
    - F10 operate as foot switch
v1.8, released 050515
  - Added new input flag "any PTT on" that is needed by router v2.0 to display
    current rx/tx state on audio page.
  - PTT2 from WinKey is no longer generated (PTT1 still generated by WinKey)
  - PTT2 from foot switch is no longer generated (PTT1 always delayed)
  - Serial PTT (both PTT1 and PTT2) can be delayed according to configuration.
  - Only one delay constant is used for both PTT1 and PTT2, second is reserved
    for extension.
v1.7, released 041216
  - Support for inverted FSK (Dedicated to use with TT-OMNI V or TT-OMNI VI).
  - bug fixed: When side tone was turned on, the data from radio to computer
    was sporadically disturbed, especially on high baud rates like a 57600 bps.
  - bug fixed: Data from computer to Winkey are routed without protection
    against Winkey buffer overflow. Only host application is responsible
    for this protection. It prevents too late response to message abort.
    Use with router v1.13.
v1.6, released 041201
  - bug fixed: Another modification was made in initialization to prevent
    the keyer to hang-up at start up when WinKey revision 9 is used.
v1.5, released 041110
  - Some changes was made in initialization to achieve the compatibility
    with WinKey revision 9.
  - bug fixed: Prosign keys used by WinKey 9 are now correctly assigned
    to keyboard keys.
v1.4, released 040929
  - bug fixed: PTT handling was disabled in previous version by mistake.
v1.3, released 040928
  - Wide code optimalization to support the baud rate of 57600 bps on radio port.
  - bug fixed: It sometimes stayed frozen after power up if paddle was pressed.
v1.2, released 040728
  - bug fixed: PTT2 for WinKey now works
v1.1, released 040727
  - first release for testing