CHIRP

# Copyright 2022 Mel Terechenok <melvin.terechenok@gmail.com>

# KG-UV980P , KG-1000G, KG-1000G Plus, KG-UV950P unified driver using

# KG-935G, KG-UV8H, KG-UV920P, and KG-UV9D Plus drivers as resources

#

# Based on the previous work of Pavel Milanes CO7WT <pavelmc@gmail.com>

# and Krystian Struzik <toner_82@tlen.pl>

# who figured out the crypt used and made possible the

# Wuoxun KG-UV8D Plus driver.

#

# This program is free software: you can redistribute it and/or modify

# it under the terms of the GNU General Public License as published by

# the Free Software Foundation, either version 3 of the License, or

# (at your option) any later version.

#

# This program is distributed in the hope that it will be useful,

# but WITHOUT ANY WARRANTY; without even the implied warranty of

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

# GNU General Public License for more details.

#

# You should have received a copy of the GNU General Public License

# along with this program.  If not, see <http://www.gnu.org/licenses/>.

"""Wouxun KG-UV980P radio management module"""

import time

import logging

import struct

from chirp import util, chirp_common, bitwise, memmap, errors, directory

from chirp.settings import RadioSetting, RadioSettingGroup, \

    RadioSettingValueBoolean, RadioSettingValueList, \

    RadioSettingValueInteger, RadioSettingValueString, \

    RadioSettingValueFloat, RadioSettingValueMap, RadioSettings

LOG = logging.getLogger(__name__)

CMD_ID = 0x80

CMD_END = 0x81

CMD_RD = 0x82

CMD_WR = 0x83

DIR_TO = 0xFF

DIR_FROM = 0x00

# This is used to write the configuration of the radio base on info

# gleaned from the downloaded app. There are empty spaces and we honor

# them because we don't know what they are (yet) although we read the

# whole of memory.

# Max Write Size = 64 for comm protocol

config_map = (          # map address, write size, write count

    # (0x0, 64, 512),     # 0 to 8000 - full write use only

    (0x4c,  12, 1),    # Mode PSW --  Display name

    (0x60,  44, 1),    # Freq Limits

    (0x740,  40, 1),    # FM chan 1-20

    (0x830,  16, 13),    # General settings

    (0x900, 8, 1),       # General settings

    (0x940,  64, 2),    # Scan groups and names

    (0xa00,  64, 249),  # Memory Channels 1-996

    (0x4840, 48, 1),    # Memory Channels 997-999

    (0x4900, 64, 124),  # Memory Names    1-992

    (0x6800, 8, 7),    # Memory Names    997-999

    (0x7000, 64, 15),    # mem valid 1 -960

    (0x73c0, 39, 1),    # mem valid 961 - 999

)

MEM_VALID = 0x00

TX_BLANK = 0x40

RX_BLANK = 0x80

CHARSET_NUMERIC = "0123456789"

CHARSET = "0123456789" + \

          ":;<=>?@" + \

          "ABCDEFGHIJKLMNOPQRSTUVWXYZ" + \

          "[\\]^_`" + \

          "abcdefghijklmnopqrstuvwxyz" + \

          "{|}~\x4E" + \

          " !\"#$%&'()*+,-./"

SCANNAME_CHARSET = "0123456789" + \

          ":;<=>?@" + \

          "ABCDEFGHIJKLMNOPQRSTUVWXYZ" + \

          "[\\]^_`" + \

          "abcdefghijklmnopqrstuvwxyz" + \

          "{|}~\x4E" + \

          " !\"#$%&'()*+,-./"

MUTE_MODE_MAP = [('QT',      0b01),

                 ('QT*DTMF', 0b10),

                 ('QT+DTMF', 0b11)]

STEPS = [2.5, 5.0, 6.25, 10.0, 12.5, 20.0, 25.0, 30.0, 50.0, 100.0]

STEP_LIST = [str(x) for x in STEPS]

SQL_LIST = [int(i) for i in range(0, 10)]

M_POWER_MAP = [('1 = 20W', 1),

               ('2 = 10W', 2)]

ROGER_LIST = ["Off", "BOT", "EOT", "Both"]

VOICE_MAP = [('Off', 0),

             ('Chinese', 1),

             ('On / English', 2)]

VOICE_MAP_1000GPLUS = [('Off', 0),

                       ('On', 2)]

SC_REV_MAP = [('Timeout (TO)',  1),

              ('Carrier (CO)',  2),

              ('Stop (SE)',     3)]

TOT_MAP = [('%d min' % i, int('%02d' % i, 10)) for i in range(1, 61)]

TOT_MAP_1000GPLUS = [('%d min' % i, int('%02d' % i, 16)) for i in range(1, 61)]

TOA_LIST = ["Off", "1s", "2s", "3s", "4s", "5s", "6s", "7s", "8s", "9s", "10s"]

TOA_MAP = [('Off', 0)] + \

          [('%ds' % i, int('%02d' % i, 16)) for i in range(1, 11)]

RING_LIST = ["Off", "1s", "2s", "3s", "4s", "5s", "6s", "7s",

             "8s", "9s", "10s"]

RING_MAP = [('Off', 0)] + \

           [('%ds' % i, int('%02d' % i, 10)) for i in range(1, 11)]

DTMF_ST_LIST = ["Off", "DT-ST", "ANI-ST", "DT+ANI"]

DTMF_ST_LIST_1000GPLUS = ["Off", "DTMF", "ID", "DTMF+ID"]

PTT_ID_MAP = [('BOT',  1),

              ('EOT',  2),

              ('Both', 3)]

PTT_ID_MAP_1000GPLUS = [('Off', 0),

                        ('BOT',  1),

                        ('EOT',  2),

                        ('Both', 3)]

BACKLIGHT_LIST = ["Off", "Red", "Orange", "Green"]

BACKLIGHT_LIST_950 = ["Off", "White", "Blue", "Green" ]

SPEAKER_MAP = [('SPK_1',   1),

               ('SPK_2',   2),

               ('SPK_1+2', 3)]

SPEAKER_MAP_1000GPLUS = [('RADIO',   1),

                         ('MIC',   2),

                         ('BOTH', 3)]

RPT_MODE_LIST = ["Radio", "X-DIRPT", "X-TWRPT", "RPT-RX", "T-W RPT"]

RPT_MODE_MAP = [("OFF", 0),

                ("RPT-RX", 3),

                ("RPT-TX", 4)]

APO_TIME_LIST = ["Off", "30", "60", "90", "120", "150"]

ALERT_MAP = [('1750', 1),

             ('2100', 2),

             ('1000', 3),

             ('1450', 4)]

FAN_MODE_LIST = ["TX", "Hi-Temp/TX", "Always"]

SCAN_GROUP_LIST = ["All"] + ["%s" % x for x in range(1, 11)]

WORKMODE_MAP = [('VFO',             1),

                ('Ch. No.',         2),

                ('Ch. No.+Freq.',   3),

                ('Ch. No.+Name',    4)]

WORKMODE_MAP_1000GPLUS = [('Freq',   1),

                          ('Ch-Num',  2),

                          ('Ch-Freq', 3),

                          ('Ch-Name', 4)]

VFOBAND_MAP = [("150M", 0),

               ("450M", 1),

               ("20M", 2),

               ("50M", 3),

               ("350M", 4),

               ("850M", 5)]

AB_LIST = ["A", "B"]

POWER_MAP = [('Low', 0),

             ('Med', 1),

             ('Med2', 2),

             ('High', 3)]

BANDWIDTH_MAP = [('Narrow', 1),

                 ('Wide',  0)]

SCRAMBLER_LIST = ["Off", "1", "2", "3", "4", "5", "6", "7", "8"]

ANS_LIST = ["Off", "Normal", "Strong"]

DTMF_TIMES = [str(x) for x in range(80, 501, 20)]

DTMF_INTERVALS = [str(x) for x in range(60, 501, 20)]

ROGER_TIMES = [str(x) for x in range(20, 1001, 20)]

# For py3 compliance x/100 must be changed to x//100

PTT_ID_DELAY_MAP = [(str(x), x//100) for x in range(100, 1001, 100)]

ROGER_INTERVALS = ROGER_TIMES

TONE_MAP = [('Off', 0x0000)] + \

           [('%.1f' % tone, int(tone * 10)) for tone in chirp_common.TONES] + \

           [('DN%d' % tone, int(0x8000 + tone))

               for tone in chirp_common.DTCS_CODES] + \

           [('DI%d' % tone, int(0xC000 + tone))

               for tone in chirp_common.DTCS_CODES]

DUPLEX_LIST = ["Off", "Plus", "Minus"]

SC_QT_MAP = [("Decoder - Rx QT/DT MEM", 1), ("Encoder- Tx QT/DT MEM", 2),

             ("All- RxTx QT/DT MEM", 3)]

SC_QT_MAP_1000GPLUS = [("Rx", 1), ("Tx", 2),

                       ("Tx/Rx", 3)]

HOLD_TIMES = ["Off"] + ["%s" % x for x in range(100, 5001, 100)]

PF1_SETTINGS = ["Off", "Stun", "Kill", "Monitor", "Inspection"]

PF1_SETTINGS_1000GPLUS = ["OFF", "Reverse", "Pri-Sel", "Pri-Scan", "Squelch",

                          "TX PWR", "Scan", "Scan CTCSS",

                          "Scan DCS", "FM Radio", "Weather", "Ch-Add", "W-N",

                          "TDR", "WORKMODE", "Band", "Repeater", "Lock",

                          "Monitor"]

ABR_LIST = ["Always", "1s", "2s", "3s", "4s", "5s", "6s", "7s", "8s",

            "9s", "10s", "11s", "12s", "13s", "14s", "15s", "16s", "17s",

            "18s", "19s", "20s", "Off"]

KEY_LIST = ["Off", "B/SW", "MENCH", "H-M-L", "VFO/MR", "SET-D", "TDR",

            "SQL", "SCAN", "FM-Radio", "Scan CTCSS", "Scan DCS"]

KEY_LIST_1000GPLUS = ["OFF", "Reverse", "Pri-Sel", "Pri-Scan", "Squelch",

                      "TX PWR", "Scan", "Scan CTCSS", "Scan DCS",

                      "FM Radio", "Weather", "Ch-Add", "W-N", "TDR",

                      "WORKMODE", "Band", "Repeater", "Lock", "Monitor"]

RC_POWER_LIST = ["RC Stop", "RC Open"]

ACTIVE_AREA_LIST = ["Area A - Left", "Area B - Right"]

TDR_LIST = ["TDR ON", "TDR OFF"]

PRI_CH_SCAN_LIST = ["Off", "ON-Stby", "On-Always"]

# memory slot 0 is not used, start at 1 (so need 1000 slots, not 999)

# structure elements whose name starts with x are currently unidentified

_MEM_FORMAT = """

    #seekto 0x004c;

    struct {

        u24 mode_psw;

        u8  xunk04F;

        u8  display_name[8];

    } oem;

    #seekto 0x0060;

    struct {

        bbcd    limit_144M_ChA_rx_start[2];

        bbcd    limit_144M_ChA_rx_stop[2];

        bbcd    limit_70cm_rx_start[2];

        bbcd    limit_70cm_rx_stop[2];

        bbcd    limit_10m_rx_start[2];

        bbcd    limit_10m_rx_stop[2];

        bbcd    limit_6m_rx_start[2];

        bbcd    limit_6m_rx_stop[2];

        bbcd    limit_350M_rx_start[2];

        bbcd    limit_350M_rx_stop[2];

        bbcd    limit_850M_rx_start[2];

        bbcd    limit_850M_rx_stop[2];

        bbcd    limit_144M_tx_start[2];

        bbcd    limit_144M_tx_stop[2];

        bbcd    limit_70cm_tx_start[2];

        bbcd    limit_70cm_tx_stop[2];

        bbcd    limit_10m_tx_start[2];

        bbcd    limit_10m_tx_stop[2];

        bbcd    limit_6m_tx_start[2];

        bbcd    limit_6m_tx_stop[2];

        bbcd    limit_144M_ChB_rx_start[2];

        bbcd    limit_144M_ChB_rx_stop[2];

    } bandlimits;

    #seekto 0x0740;

    struct {

        u16    FM_radio1;

        u16    FM_radio2;

        u16    FM_radio3;

        u16    FM_radio4;

        u16    FM_radio5;

        u16    FM_radio6;

        u16    FM_radio7;

        u16    FM_radio8;

        u16    FM_radio9;

        u16    FM_radio10;

        u16    FM_radio11;

        u16    FM_radio12;

        u16    FM_radio13;

        u16    FM_radio14;

        u16    FM_radio15;

        u16    FM_radio16;

        u16    FM_radio17;

        u16    FM_radio18;

        u16    FM_radio19;

        u16    FM_radio20;

        u16    FM_radio21;

        u16    FM_radio22;

        u8  x76c_pad[196];

        u32  vfofreq1;     // 0x0830

        u32  vfoofst1;

        u16  txtone1;

        u16  rxtone1;

        u8  xunk83C_1:3,

            mute1:2,

            xunk83C_2:3;

        u8  xunk83d_1:1,

            xunk83d_2:1,

            xunk83d_3:1,

            power1:2,

            am_mode1:1,

            xunk83d_7:1,

            narrow1:1;

        u8  xunk83e:6,

            shft_dir1:2;

        u8  xunk83F:3,

            compander1:1,

            scrambler1:4;

        u32  vfofreq2;

        u32  vfoofst2;

        u16  txtone2;

        u16  rxtone2;

        u8  xunk84C_1:3,

            mute2:2,

            xunk84C_2:3;

        u8  xunk84d_1:1,

            xunk84d_2:1,

            xunk84d_3:1,

            power2:2,

            am_mode2:1,

            xunk84d_7:1,

            narrow2:1;

        u8  xunk84e:6,

            shft_dir2:2;

        u8  xunk84F:3,

            compander2:1,

            scrambler2:4;

        u32  vfofreq3;

        u32  vfoofst3;

        u16  txtone3;

        u16  rxtone3;

        u8  xunk85C_1:3,

            mute3:2,

            xunk85C_2:3;

        u8  xunk85d_1:1,

            xunk85d_2:1,

            xunk85d_3:1,

            power3:2,

            am_mode3:1,

            xunk85d_7:1,

            narrow3:1;

        u8  xunk85e:6,

            shft_dir3:2;

        u8  xunk85F:3,

            compander3:1,

            scrambler3:4;

        u32  vfofreq4;

        u32  vfoofst4;

        u16  txtone4;

        u16  rxtone4;

        u8  xunk86C_1:3,

            mute4:2,

            xunk86C_2:3;

        u8  xunk86d_1:1,

            xunk86d_2:1,

            xunk86d_3:1,

            power4:2,

            am_mode4:1,

            xunk86d_7:1,

            narrow4:1;

        u8  xunk86e:6,

            shft_dir4:2;

        u8  xunk86F:3,

            compander4:1,

            scrambler4:4;

        u32  vfofreq5;

        u32  vfoofst5;

        u16  txtone5;

        u16  rxtone5;

        u8  xunk87C_1:3,

            mute5:2,

            xunk87C_2:3;

        u8  xunk87d_1:1,

            xunk87d_2:1,

            xunk87d_3:1,

            power5:2,

            am_mode5:1,

            xunk87d_7:1,

            narrow5:1;

        u8  xunk87e:6,

            shft_dir5:2;

        u8  xunk87F:3,

            compander5:1,

            scrambler5:4;

        u32  vfofreq6;

        u32  vfoofst6;

        u16  txtone6;

        u16  rxtone6;

        u8  xunk88C_1:3,

            mute6:2,

            xunk88C_2:3;

        u8  xunk88d_1:1,

            xunk88d_2:1,

            xunk88d_3:1,

            power6:2,

            am_mode6:1,

            xunk88d_7:1,

            narrow6:1;

        u8  xunk88e:6,

            shft_dir6:2;

        u8  xunk8F:3,

            compander6:1,

            scrambler6:4;

        u32  vfofreq7;

        u32  vfoofst7;

        u16  txtone7;

        u16  rxtone7;

        u8  xunk89C_1:3,

            mute7:2,

            xunk89C_2:3;

        u8  xunk89d_1:1,

            xunk89d_2:1,

            xunk89d_3:1,

            power7:2,

            am_mode7:1,

            xunk89d_7:1,

            narrow7:1;

        u8  xunk89e:6,

            shft_dir7:2;

        u8  xunk89F:3,

            compander7:1,

            scrambler7:4;

        u8  x8a0;

        u16  vfochan_a;

        u8  x8a3;

        u16  vfochan_b;

        u16  pri_ch;

        u8  x8a8;

        u8  x8a9;

        u8  scan_a_act;

        u8  scan_b_act;

        u8  m_pwr;

        u8  hold_time_rpt;

        u8  spk_cont;

        u8  x8af;

        u8  rc_power;

        u8  voice;

        u8  tot;

        u8  toa;

        u8  roger;

        u8  sc_rev;

        u8  dtmfsf;

        u8  ptt_id;

        u8  ring;

        u8  ani_sw;

        u8  rc_sw;

        u8  alert;

        u8  bcl_a;

        u8  prich_sw;

        u8  x8bE;

        u8  ptt_id_dly;

        u8  menu;

        u8  x8c1;

        u8  beep;

        u8  key_lock;

        u8  x8c4;

        u8  tx_led;

        u8  wt_led;

        u8  rx_led;

        u8  act_area;

        u8  vfomode_a;

        u8  vfomode_b;

        u8  vfosquelch_a;

        u8  vfosquelch_b;

        u8  vfostep_a;

        u8  vfostep_b;

        u8  tdr_off;

        u8  rpt_spk;       //x8d0

        u8  rpt_ptt;

        u8  autolock;

        u8  apo_time;

        u8  low_v;

        u8  fan;

        u8  rpt_set_model;

        u8  pf1_set;

        u8  auto_am;

        u8  dtmf_time;

        u8  dtmf_int;

        u8  bcl_b;

        u8  rpt_tone;

        u8  sc_qt;

        u8  vfoband_a;

        u8  x8dF;

        u24  ani_edit;

        u8  x8e3;

        u24  mcc_edit;

        u8  x8e7;

        u24  scc_edit;

        u8  x8eB;

        u24  ctrl_edit;

        u8  x8eF;

        u8  KeyA;

        u8  KeyB;

        u8  KeyC;

        u8  ABR;

        u8  x8f4;

        u8  x8f5;

        u8  KeyD;       // KG-1000G Plus ONLY

        u8  x8f7;

        u8  x8f8;

        u8  x8f9;

        u8  x8fA;

        u8  x8fB;

        u8  x8fC;

        u8  x8fD;

        u8  x8fE;

        u8  x8fF;

        u16  FM_radio_cur_freq;

        u8  x902;

        u8  scan_det;

        u8  x904;

        u8  thr_vol_tx;

        u16  thr_vol_lvl;

        u8  x908;

        u8  x909;

        u8  x90A;

        u8  x90B;

        u8  x90C;

        u8  x90D;

        u8  x90E;

        u8  x90F;

        u8  x910pad[48];

        u16  scanlower1; // x940

        u16  scanupper1;

        u16  scanlower2;

        u16  scanupper2;

        u16  scanlower3;

        u16  scanupper3;

        u16  scanlower4;

        u16  scanupper4;

        u16  scanlower5;

        u16  scanupper5;

        u16  scanlower6;

        u16  scanupper6;

        u16  scanlower7;

        u16  scanupper7;

        u16  scanlower8;

        u16  scanupper8;

        u16  scanlower9;

        u16  scanupper9;

        u16  scanlower10;

        u16  scanupper10;

        u8  scanname0[8]; // x968

        u8  scanname1[8];

        u8  scanname2[8];

        u8  scanname3[8];

        u8  scanname4[8];

        u8  scanname5[8];

        u8  scanname6[8];

        u8  scanname7[8];

        u8  scanname8[8];

        u8  scanname9[8];

        u8  scanname10[8];

     } settings;

    #seekto 0x09f0;

    struct {

        u32     rxfreq;

        u32     txfreq;

        u16     txtone;

        u16     rxtone;

        u8      unknown1:3,

                mute_mode:2,

                unknown2:3;

        u8      named:1,

                scan_add:1,

                extra_power_bit:1,

                power:2,

                am_mode:1,

                unknownbit2:1,

                isnarrow:1;

        u8      unknown3:6,

                Unknown4_shft_dir:2;

        u8      unknown5:3,

                compander:1,

                scrambler:4;

    } memory[1000];

    #seekto 0x48f8;

    struct {

        u8    name[8];

    } names[1000];

    #seekto 0x6fff;

    u8          valid[1000];

    """

def _freq_decode(in_freq, bytes=4):

    out_freq = 0

    for i in range(bytes*2):

        out_freq += (in_freq & 0xF) * (10 ** i)

        in_freq = in_freq >> 4

    if bytes == 4:

        return out_freq * 10

    elif bytes == 2:

        return out_freq * 100000

def _freq_encode(in_freq, bytes=4):

    if bytes == 4:

        return int('%08d' % (in_freq / 10), 16)

    elif bytes == 2:

        return int('%04d' % (in_freq / 100000), 16)

def _oem_str_decode(in_str):

    out_str = ''

    stopchar = False

    for c in in_str:

        if c != 0x50 and stopchar is False:

            if chr(c+48) in chirp_common.CHARSET_ASCII:

                out_str += chr(c+48)

        else:

            out_str += ''

            stopchar = True

    return out_str

def _oem_str_encode(in_str):

    out_str = ''

    LOG.debug("OEM Input String = %s", in_str)

    for c in in_str:

        try:

            out_str += chr(int(ord(c))-48)

        except ValueError:

            pass

    while len(out_str) < 8:

        out_str += chr(0x50)

    LOG.debug("OEM Ouput String = %s", out_str)

    return out_str

# OEM String Encode for KG-1000G Plus

def _oem_str_decode_1000GPLUS(in_str):

    LOG.debug("decode OEM Input String = %s", in_str)

    out_str = ''

    for c in in_str:

        # 1000G+ character mapping starts with P = 32 and O = 127

        if 127 >= c >= 80:

            out_str += chr(c - 48)

        elif 32 <= c < 80:

            out_str += chr(c+48)

        else:

            out_str += ''

    LOG.debug("decode OEM Ouput String = %s", out_str)

    return out_str

# OEM String Encode for KG-1000G Plus

def _oem_str_encode_1000GPLUS(in_str):

    out_str = ''

    LOG.debug("encode OEM Input String = %s", in_str)

    for c in in_str:

        if 32 <= ord(c) < 80:

            out_str += chr(int(ord(c)) + 48)

        elif 127 >= ord(c) >= 80:

            out_str += chr(int(ord(c)) - 48)

    while len(out_str) < 8:

        out_str += chr(0x50)

    LOG.debug("encode OEM Ouput String = %s", out_str)

    return out_str

def _str_decode_950(in_str):

    out_str = ''

    for c in in_str:

        if c > 95:

            out_str += ''

        elif c >= 80:

            out_str += chr(c-48)

        else:

            out_str += chr(c+48)

    return out_str

def _str_decode(in_str):

    out_str = ''

    stopchar = False

    for c in in_str:

        if c != 0x00 and stopchar is False:

            if chr(c) in chirp_common.CHARSET_ASCII:

                out_str += chr(c)

        else:

            out_str += ''

            stopchar = True

    return out_str

def _str_encode(in_str):

    out_str = ''

    for c in in_str:

        try:

            out_str += chr(ord(c))

        except ValueError:

            pass

    while len(out_str) < 8:

        out_str += chr(0x00)

    if out_str == "        " or out_str == "":

        out_str = "\x00\x00\x00\x00\x00\x00\x00\x00"

    return out_str

def _str_encode_950(in_str):

    out_str = ''

    for c in in_str:

        if ord(c) < 32 or ord(c)> 126:

            out_str += ''

        elif ord(c) >= 32 and ord(c)<= 47:

            out_str += chr(int(ord(c)+48))

        else:

            out_str += chr(int(ord(c)-48))         

    while len(out_str) < 8:

        out_str += chr(0x50)

    if out_str == "        " or out_str == "":

        out_str = "\x00\x00\x00\x00\x00\x00\x00\x00"

    return out_str

def _chnum_decode(in_ch):

    return int(('%04x' % in_ch)[0:3])

def _chnum_encode(in_ch):

    return int('%03d0' % in_ch, 16)

# Support for the Wouxun KG-UV980P radio

# Serial coms are at 19200 baud

# The data is passed in variable length records

# Record structure:

#  Offset   Usage

#    0      start of record (\x7c)

#    1      Command (\x80 Identify \x81 End/Reboot \x82 Read \x83 Write)

#    2      direction (\xff PC-> Radio, \x00 Radio -> PC)

#    3      length of payload (excluding header/checksum) (n)

#    4      payload (n bytes)

#    4+n+1  checksum - only lower 4 bits of byte sum (% 256) of bytes 1 -> 4+n

#

# Memory Read Records:

# the payload is 3 bytes, first 2 are offset (big endian),

# 3rd is number of bytes to read

# Memory Write Records:

# the maximum payload size (from the Wouxun software) seems to be 66 bytes

#  (2 bytes location + 64 bytes data).

@directory.register

class KG980PRadio(chirp_common.CloneModeRadio,

                  chirp_common.ExperimentalRadio):

    """Wouxun KG-UV980P"""

    VENDOR = "Wouxun"

    MODEL = "KG-UV980P"

    _model = b"KG-UV950R2"

    _file_ident = b"980P"

    BAUD_RATE = 19200

    NEEDS_COMPAT_SERIAL = False

    # Start Byte for Communication messages

    _record_start = 0xDA

    # _cs_size = 0x0F for 4-bit checksum, 0xFF for 8-Bit checksum

    _cs_size = 0x0F

    # _valxor = value needed to encrypt/decrypt the bytes to/from the radio

    _valxor = 0x57

    POWER_LEVELS = [chirp_common.PowerLevel("L", watts=1.0),

                    chirp_common.PowerLevel("M", watts=20.0),

                    chirp_common.PowerLevel("H", watts=50.0)]

    def _checksum(self, data):

        cs = 0

        for byte in data:

            cs += byte

        return ((cs % 256) & self._cs_size)

    def _write_record(self, cmd, payload=b''):

        _packet = struct.pack('BBBB', self._record_start, cmd, 0xFF,

                              len(payload))

        checksum = bytes([self._checksum(_packet[1:] + payload)])

        _packet += self.encrypt(payload + checksum)

        LOG.debug("Sent:\n%s" % util.hexprint(_packet))

        self.pipe.write(_packet)

    def _read_record(self):

        # read 4 chars for the header

        _header = self.pipe.read(4)

        if len(_header) != 4:

            raise errors.RadioError('Radio did not respond')

        _length = struct.unpack('xxxB', _header)[0]

        _packet = self.pipe.read(_length)

        _rcs_xor = _packet[-1]

        _packet = self.decrypt(_packet)

        _cs = self._checksum(_header[1:])

        _cs += self._checksum(_packet)

        _cs %= 256

        _cs = _cs & self._cs_size

        _rcs = self.strxor(self.pipe.read(1)[0], _rcs_xor)[0]

        return (_rcs != _cs, _packet)

    def decrypt(self, data):

        result = b''

        for i in range(len(data)-1, 0, -1):

            result += self.strxor(data[i], data[i - 1])

        result += self.strxor(data[0], self._valxor)

        return result[::-1]

    def encrypt(self, data):

        result = self.strxor(self._valxor, data[0])

        for i in range(1, len(data), 1):

            result += self.strxor(result[i - 1], data[i])

        return result

    def strxor(self, xora, xorb):

        return bytes([xora ^ xorb])

    # Identify the radio

    #

    # A Gotcha: the first identify packet returns a bad checksum, subsequent

    # attempts return the correct checksum... (well it does on my radio!)

    #

    # The ID record returned by the radio also includes the

    # current frequency range

    # as 4 bytes big-endian in 10Hz increments

    #

    # Offset

    #  0:10     Model, zero padded

    def _identify(self):

        """Do the identification dance"""

        for _i in range(0, 3):

            LOG.debug("ID try #"+str(_i))

            self._write_record(CMD_ID)

            _chksum_err, _resp = self._read_record()

            if len(_resp) == 0:

                raise errors.RadioError("Radio not responding")

            else:

                LOG.debug("Got:\n%s" % util.hexprint(_resp))

                LOG.debug("Model received is %s" % _resp[0:10])

                LOG.debug("Model expected is %s" % self._model)

                if _chksum_err:

                    LOG.error("Checksum error: retrying ident...")

                    time.sleep(0.100)

                    continue

                else:

                    LOG.debug("checksum passed")

                    if _resp[0:8] == self._model[0:8]:

                        LOG.debug("Passed identify")

                        break

                    else:

                        LOG.debug("FAILED to identify")

                        raise errors.RadioError("Failed Identification")

    def _finish(self):

        self._write_record(CMD_END)

    def process_mmap(self):

        self._memobj = bitwise.parse(_MEM_FORMAT, self._mmap)

    def sync_in(self):

        try:

            self._mmap = self._download()

        except errors.RadioError:

            raise

        except Exception:

            raise errors.RadioError("Failed to communicate with radio: %s")

        self.process_mmap()

    def sync_out(self):

        self._upload()

    # TODO: Load all memory.

    # It would be smarter to only load the active areas and none of

    # the padding/unused areas. Padding still need to be investigated.

    def _download(self):

        """Talk to a wouxun KG-UV980P and do a download"""

        try:

            self._identify()

            return self._do_download(0, 32768, 64)

        except errors.RadioError:

            raise

        except Exception:

            LOG.exception('Unknown error during download process')

            raise errors.RadioError("Failed to communicate with radio: %s")

    def _do_download(self, start, end, size):

        # allocate & fill memory

        LOG.debug("Start Download")

        image = b""

        for i in range(start, end, size):

            req = struct.pack("BBB", int(i / 256), int(i % 256), int(size))

            self._write_record(CMD_RD, req)

            cs_error, resp = self._read_record()

            if cs_error:

                LOG.debug(util.hexprint(resp))

                raise errors.RadioError("Checksum error on read")

            image += resp[2:]

            if self.status_fn:

                status = chirp_common.Status()

                status.cur = i

                status.max = end

                status.msg = "Cloning from radio"

                self.status_fn(status)

        self._finish()

        LOG.debug("Download Completed")

        return memmap.MemoryMapBytes(image)

    def _upload(self):

        """Talk to a wouxun KG-UV980P and do a upload"""

        try:

            self._identify()

            LOG.debug("Done with Upload Identify")

            self._do_upload()

            LOG.debug("Done with Mem and Settings Upload")

            self._finish()

        except errors.RadioError:

            raise

        except Exception:

            raise errors.RadioError("Failed to communicate with radio: %s")

        return

    def _do_upload(self):

        LOG.debug("Start of _do_upload")

        cfg_map = config_map

        endwrite = 0x73E7

        for start, blocksize, count in cfg_map:

            end = start + (blocksize * count)

            LOG.debug("start = " + str(start))

            LOG.debug("end = " + str(end))

            LOG.debug("blksize = " + str(blocksize))