CHIRP

# Quansheng UV-K5 driver (c) 2023 Jacek Lipkowski <sq5bpf@lipkowski.org>

#

# based on template.py Copyright 2012 Dan Smith <dsmith@danplanet.com>

#

#

# This is a preliminary version of a driver for the UV-K5

# It is based on my reverse engineering effort described here:

# https://github.com/sq5bpf/uvk5-reverse-engineering

#

# Warning: this driver is experimental, it may brick your radio,

# eat your lunch and mess up your configuration.

#

#

# 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 2 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/>.

import struct

import logging

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

from chirp.settings import RadioSetting, RadioSettingGroup, \

    RadioSettingValueBoolean, RadioSettingValueList, \

    RadioSettingValueInteger, RadioSettingValueString, \

    RadioSettings

LOG = logging.getLogger(__name__)

# Show the obfuscated version of commands. Not needed normally, but

# might be useful for someone who is debugging a similar radio

DEBUG_SHOW_OBFUSCATED_COMMANDS = False

# Show the memory being written/received. Not needed normally, because

# this is the same information as in the packet hexdumps, but

# might be useful for someone debugging some obscure memory issue

DEBUG_SHOW_MEMORY_ACTIONS = False

MEM_FORMAT = """

#seekto 0x0000;

struct {

  ul32 freq;

  ul32 offset;

  u8 rxcode;

  u8 txcode;

  u8 txcodeflag:4,

     rxcodeflag:4;

  //u8 flags1;

  u8 flags1_unknown7:1,

  flags1_unknown6:1,

  flags1_unknown5:1,

  enable_am:1,

  flags1_unknown3:1,

  is_in_scanlist:1,

  shift:2;

  //u8 flags2;

  u8 flags2_unknown7:1,

  flags2_unknown6:1,

  flags2_unknown5:1,

  bclo:1,

  txpower:2,

  bandwidth:1,

  freq_reverse:1;

  //u8 dtmf_flags;

  u8 dtmf_flags_unknown7:1,

  dtmf_flags_unknown6:1,

  dtmf_flags_unknown5:1,

  dtmf_flags_unknown4:1,

  dtmf_flags_unknown3:1,

  dtmf_pttid:2,

  dtmf_decode:1;

  u8 step;

  u8 scrambler;

} channel[214];

#seekto 0xd60;

struct {

u8 is_scanlist1:1,

is_scanlist2:1,

compander:2,

is_free:1,

band:3;

} channel_attributes[200];

#seekto 0xe40;

ul16 fmfreq[20];

#seekto 0xe70;

u8 call_channel;

u8 squelch;

u8 max_talk_time;

u8 noaa_autoscan;

u8 key_lock;

u8 vox_switch;

u8 vox_level;

u8 mic_gain;

u8 unknown3;

u8 channel_display_mode;

u8 crossband;

u8 battery_save;

u8 dual_watch;

u8 backlight_auto_mode;

u8 tail_note_elimination;

u8 vfo_open;

#seekto 0xe90;

u8 beep_control;

u8 key1_shortpress_action;

u8 key1_longpress_action;

u8 key2_shortpress_action;

u8 key2_longpress_action;

u8 scan_resume_mode;

u8 auto_keypad_lock;

u8 power_on_dispmode;

u8 password[4];

#seekto 0xea0;

u8 keypad_tone;

u8 language;

#seekto 0xea8;

u8 alarm_mode;

u8 reminding_of_end_talk;

u8 repeater_tail_elimination;

#seekto 0xeb0;

char logo_line1[16];

char logo_line2[16];

#seekto 0xed0;

struct {

u8 side_tone;

char separate_code;

char group_call_code;

u8 decode_response;

u8 auto_reset_time;

u8 preload_time;

u8 first_code_persist_time;

u8 hash_persist_time;

u8 code_persist_time;

u8 code_interval_time;

u8 permit_remote_kill;

} dtmf_settings;

#seekto 0xee0;

struct {

char dtmf_local_code[3];

char unused1[5];

char kill_code[5];

char unused2[3];

char revive_code[5];

char unused3[3];

char dtmf_up_code[16];

char dtmf_down_code[16];

} dtmf_settings_numbers;

#seekto 0xf18;

u8 scanlist_default;

u8 scanlist1_priority_scan;

u8 scanlist1_priority_ch1;

u8 scanlist1_priority_ch2;

u8 scanlist2_priority_scan;

u8 scanlist2_priority_ch1;

u8 scanlist2_priority_ch2;

u8 scanlist_unknown_0xff;

#seekto 0xf40;

struct {

u8 flock;

u8 tx350;

u8 killed;

u8 tx200;

u8 tx500;

u8 en350;

u8 enscramble;

} lock;

#seekto 0xf50;

struct {

char name[16];

} channelname[200];

#seekto 0x1c00;

struct {

char name[8];

char number[3];

char unused_00[5];

} dtmfcontact[16];

#seekto 0x1ed0;

struct {

struct {

    u8 start;

    u8 mid;

    u8 end;

} low;

struct {

    u8 start;

    u8 mid;

    u8 end;

} medium;

struct {

    u8 start;

    u8 mid;

    u8 end;

} high;

u8 unused_00[7];

} perbandpowersettings[7];

#seekto 0x1f40;

ul16 battery_level[6];

"""

# bits that we will save from the channel structure (mostly unknown)

SAVE_MASK_0A = 0b11001100

SAVE_MASK_0B = 0b11101100

SAVE_MASK_0C = 0b11100000

SAVE_MASK_0D = 0b11111000

SAVE_MASK_0E = 0b11110001

SAVE_MASK_0F = 0b11110000

# flags1

FLAGS1_OFFSET_NONE = 0b00

FLAGS1_OFFSET_MINUS = 0b10

FLAGS1_OFFSET_PLUS = 0b01

POWER_HIGH = 0b10

POWER_MEDIUM = 0b01

POWER_LOW = 0b00

# power

UVK5_POWER_LEVELS = [chirp_common.PowerLevel("Low",  watts=1.50),

                     chirp_common.PowerLevel("Med",  watts=3.00),

                     chirp_common.PowerLevel("High", watts=5.00),

                     ]

# scrambler

SCRAMBLER_LIST = ["off", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10"]

# channel display mode

CHANNELDISP_LIST = ["Frequency", "Channel No", "Channel Name"]

# battery save

BATSAVE_LIST = ["OFF", "1:1", "1:2", "1:3", "1:4"]

# Backlight auto mode

BACKLIGHT_LIST = ["Off", "1s", "2s", "3s", "4s", "5s"]

# Crossband receiving/transmitting

CROSSBAND_LIST = ["Off", "Band A", "Band B"]

DUALWATCH_LIST = CROSSBAND_LIST

# ctcss/dcs codes

TMODES = ["", "Tone", "DTCS", "DTCS"]

TONE_NONE = 0

TONE_CTCSS = 1

TONE_DCS = 2

TONE_RDCS = 3

CTCSS_TONES = [

    67.0, 69.3, 71.9, 74.4, 77.0, 79.7, 82.5, 85.4,

    88.5, 91.5, 94.8, 97.4, 100.0, 103.5, 107.2, 110.9,

    114.8, 118.8, 123.0, 127.3, 131.8, 136.5, 141.3, 146.2,

    151.4, 156.7, 159.8, 162.2, 165.5, 167.9, 171.3, 173.8,

    177.3, 179.9, 183.5, 186.2, 189.9, 192.8, 196.6, 199.5,

    203.5, 206.5, 210.7, 218.1, 225.7, 229.1, 233.6, 241.8,

    250.3, 254.1

]

# lifted from ft4.py

DTCS_CODES = [

    23,  25,  26,  31,  32,  36,  43,  47,  51,  53,  54,

    65,  71,  72,  73,  74,  114, 115, 116, 122, 125, 131,

    132, 134, 143, 145, 152, 155, 156, 162, 165, 172, 174,

    205, 212, 223, 225, 226, 243, 244, 245, 246, 251, 252,

    255, 261, 263, 265, 266, 271, 274, 306, 311, 315, 325,

    331, 332, 343, 346, 351, 356, 364, 365, 371, 411, 412,

    413, 423, 431, 432, 445, 446, 452, 454, 455, 462, 464,

    465, 466, 503, 506, 516, 523, 526, 532, 546, 565, 606,

    612, 624, 627, 631, 632, 654, 662, 664, 703, 712, 723,

    731, 732, 734, 743, 754

]

FLOCK_LIST = ["Off", "FCC", "CE", "GB", "430", "438"]

SCANRESUME_LIST = ["TO: Resume after 5 seconds",

                   "CO: Resume after signal disappears",

                   "SE: Stop scanning after receiving a signal"]

WELCOME_LIST = ["Full Screen", "Welcome Info", "Voltage"]

KEYPADTONE_LIST = ["Off", "Chinese", "English"]

LANGUAGE_LIST = ["Chinese", "English"]

ALARMMODE_LIST = ["SITE", "TONE"]

REMENDOFTALK_LIST = ["Off", "ROGER", "MDC"]

RTE_LIST = ["Off", "100ms", "200ms", "300ms", "400ms",

            "500ms", "600ms", "700ms", "800ms", "900ms"]

MEM_SIZE = 0x2000  # size of all memory

PROG_SIZE = 0x1d00  # size of the memory that we will write

MEM_BLOCK = 0x80  # largest block of memory that we can reliably write

# fm radio supported frequencies

FMMIN = 76.0

FMMAX = 108.0

# bands supported by the UV-K5

BANDS = {

        0: [50.0, 76.0],

        1: [108.0, 135.9999],

        2: [136.0, 199.9990],

        3: [200.0, 299.9999],

        4: [350.0, 399.9999],

        5: [400.0, 469.9999],

        6: [470.0, 600.0]

        }

# for radios with modified firmware:

BANDS_NOLIMITS = {

        0: [18.0, 76.0],

        1: [108.0, 135.9999],

        2: [136.0, 199.9990],

        3: [200.0, 299.9999],

        4: [350.0, 399.9999],

        5: [400.0, 469.9999],

        6: [470.0, 1300.0]

        }

SPECIALS = {

        "F1(50M-76M)A": 200,

        "F1(50M-76M)B": 201,

        "F2(108M-136M)A": 202,

        "F2(108M-136M)B": 203,

        "F3(136M-174M)A": 204,

        "F3(136M-174M)B": 205,

        "F4(174M-350M)A": 206,

        "F4(174M-350M)B": 207,

        "F5(350M-400M)A": 208,

        "F5(350M-400M)B": 209,

        "F6(400M-470M)A": 210,

        "F6(400M-470M)B": 211,

        "F7(470M-600M)A": 212,

        "F7(470M-600M)B": 213

        }

VFO_CHANNEL_NAMES = ["F1(50M-76M)A", "F1(50M-76M)B",

                     "F2(108M-136M)A", "F2(108M-136M)B",

                     "F3(136M-174M)A", "F3(136M-174M)B",

                     "F4(174M-350M)A", "F4(174M-350M)B",

                     "F5(350M-400M)A", "F5(350M-400M)B",

                     "F6(400M-470M)A", "F6(400M-470M)B",

                     "F7(470M-600M)A", "F7(470M-600M)B"]

SCANLIST_LIST = ["None", "1", "2", "1+2"]

DTMF_CHARS = "0123456789ABCD*# "

DTMF_CHARS_ID = "0123456789ABCDabcd"

DTMF_CHARS_KILL = "0123456789ABCDabcd"

DTMF_CHARS_UPDOWN = "0123456789ABCDabcd#* "

DTMF_CODE_CHARS = "ABCD*# "

DTMF_DECODE_RESPONSE_LIST = ["None", "Ring", "Reply", "Both"]

KEYACTIONS_LIST = ["None", "Flashlight on/off", "Power select",

                   "Monitor", "Scan on/off", "VOX on/off",

                   "Alarm on/off", "FM radio on/off", "Transmit 1750 Hz"]

def xorarr(data: bytes):

    """the communication is obfuscated using this fine mechanism"""

    tbl = [22, 108, 20, 230, 46, 145, 13, 64, 33, 53, 213, 64, 19, 3, 233, 128]

    ret = b""

    idx = 0

    for byte in data:

        ret += bytes([byte ^ tbl[idx]])

        idx = (idx+1) % len(tbl)

    return ret

def calculate_crc16_xmodem(data: bytes):

    """

    if this crc was used for communication to AND from the radio, then it

    would be a measure to increase reliability.

    but it's only used towards the radio, so it's for further obfuscation

    """

    poly = 0x1021

    crc = 0x0

    for byte in data:

        crc = crc ^ (byte << 8)

        for _ in range(8):

            crc = crc << 1

            if crc & 0x10000:

                crc = (crc ^ poly) & 0xFFFF

    return crc & 0xFFFF

def _send_command(serport, data: bytes):

    """Send a command to UV-K5 radio"""

    LOG.debug("Sending command (unobfuscated) len=0x%4.4x:\n%s",

              len(data), util.hexprint(data))

    crc = calculate_crc16_xmodem(data)

    data2 = data + struct.pack("<H", crc)

    command = struct.pack(">HBB", 0xabcd, len(data), 0) + \

        xorarr(data2) + \

        struct.pack(">H", 0xdcba)

    if DEBUG_SHOW_OBFUSCATED_COMMANDS:

        LOG.debug("Sending command (obfuscated):\n%s", util.hexprint(command))

    try:

        result = serport.write(command)

    except Exception as e:

        raise errors.RadioError("Error writing data to radio") from e

    return result

def _receive_reply(serport):

    header = serport.read(4)

    if len(header) != 4:

        LOG.warning("Header short read: [%s] len=%i",

                    util.hexprint(header), len(header))

        raise errors.RadioError("Header short read")

    if header[0] != 0xAB or header[1] != 0xCD or header[3] != 0x00:

        LOG.warning("Bad response header: %s len=%i",

                    util.hexprint(header), len(header))

        raise errors.RadioError("Bad response header")

    cmd = serport.read(int(header[2]))

    if len(cmd) != int(header[2]):

        LOG.warning("Body short read: [%s] len=%i",

                    util.hexprint(cmd), len(cmd))

        raise errors.RadioError("Command body short read")

    footer = serport.read(4)

    if len(footer) != 4:

        LOG.warning("Footer short read: [%s] len=%i",

                    util.hexprint(footer), len(footer))

        raise errors.RadioError("Footer short read")

    if footer[2] != 0xDC or footer[3] != 0xBA:

        LOG.debug("Reply before bad response footer (obfuscated)"

                  "len=0x%4.4x:\n%s", len(cmd), util.hexprint(cmd))

        LOG.warning("Bad response footer: %s len=%i",

                    util.hexprint(footer), len(footer))

        raise errors.RadioError("Bad response footer")

    if DEBUG_SHOW_OBFUSCATED_COMMANDS:

        LOG.debug("Received reply (obfuscated) len=0x%4.4x:\n%s",

                  len(cmd), util.hexprint(cmd))

    cmd2 = xorarr(cmd)

    LOG.debug("Received reply (unobfuscated) len=0x%4.4x:\n%s",

              len(cmd2), util.hexprint(cmd2))

    return cmd2

def _getstring(data: bytes, begin, maxlen):

    tmplen = min(maxlen+1, len(data))

    ss = [data[i] for i in range(begin, tmplen)]

    key = 0

    for key, val in enumerate(ss):

        if val < ord(' ') or val > ord('~'):

            return ''.join(chr(x) for x in ss[0:key])

    return ''

def _sayhello(serport):

    hellopacket = b"\x14\x05\x04\x00\x6a\x39\x57\x64"

    tries = 5

    while True:

        LOG.debug("Sending hello packet")

        _send_command(serport, hellopacket)

        rep = _receive_reply(serport)

        if rep:

            break

        tries -= 1

        if tries == 0:

            LOG.warning("Failed to initialise radio")

            raise errors.RadioError("Failed to initialize radio")

    if rep.startswith(b'\x18\x05'):

        raise errors.RadioError("Radio is in programming mode, "

                                "restart radio into normal mode")

    firmware = _getstring(rep, 4, 24)

    LOG.info("Found firmware: %s", firmware)

    return firmware

def _readmem(serport, offset, length):

    LOG.debug("Sending readmem offset=0x%4.4x len=0x%4.4x", offset, length)

    readmem = b"\x1b\x05\x08\x00" + \

        struct.pack("<HBB", offset, length, 0) + \

        b"\x6a\x39\x57\x64"

    _send_command(serport, readmem)

    rep = _receive_reply(serport)

    if DEBUG_SHOW_MEMORY_ACTIONS:

        LOG.debug("readmem Received data len=0x%4.4x:\n%s",

                  len(rep), util.hexprint(rep))

    return rep[8:]

def _writemem(serport, data, offset):

    LOG.debug("Sending writemem offset=0x%4.4x len=0x%4.4x",

              offset, len(data))

    if DEBUG_SHOW_MEMORY_ACTIONS:

        LOG.debug("writemem sent data offset=0x%4.4x len=0x%4.4x:\n%s",

                  offset, len(data), util.hexprint(data))

    dlen = len(data)

    writemem = b"\x1d\x05" + \

        struct.pack("<BBHBB", dlen+8, 0, offset, dlen, 1) + \

        b"\x6a\x39\x57\x64"+data

    _send_command(serport, writemem)

    rep = _receive_reply(serport)

    LOG.debug("writemem Received data: %s len=%i",

              util.hexprint(rep), len(rep))

    if (rep[0] == 0x1e and

       rep[4] == (offset & 0xff) and

       rep[5] == (offset >> 8) & 0xff):

        return True

    LOG.warning("Bad data from writemem")

    raise errors.RadioError("Bad response to writemem")

def _resetradio(serport):

    resetpacket = b"\xdd\x05\x00\x00"

    _send_command(serport, resetpacket)

def do_download(radio):

    """download eeprom from radio"""

    serport = radio.pipe

    serport.timeout = 0.5

    status = chirp_common.Status()

    status.cur = 0

    status.max = MEM_SIZE

    status.msg = "Downloading from radio"

    radio.status_fn(status)

    eeprom = b""

    f = _sayhello(serport)

    if not f:

        raise errors.RadioError('Unable to determine firmware version')

    if not radio.k5_approve_firmware(f):

        raise errors.RadioError(

            'Firmware version is not supported by this driver')

    radio.metadata = {'uvk5_firmware': f}

    addr = 0

    while addr < MEM_SIZE:

        data = _readmem(serport, addr, MEM_BLOCK)

        status.cur = addr

        radio.status_fn(status)

        if data and len(data) == MEM_BLOCK:

            eeprom += data

            addr += MEM_BLOCK

        else:

            raise errors.RadioError("Memory download incomplete")

    return memmap.MemoryMapBytes(eeprom)

def do_upload(radio):

    """upload configuration to radio eeprom"""

    serport = radio.pipe

    serport.timeout = 0.5

    status = chirp_common.Status()

    status.cur = 0

    status.msg = "Uploading to radio"

    if radio._upload_calibration:

        status.max = MEM_SIZE - radio._cal_start

        start_addr = radio._cal_start

        stop_addr = MEM_SIZE

    else:

        status.max = PROG_SIZE

        start_addr = 0

        stop_addr = PROG_SIZE

    radio.status_fn(status)

    f = _sayhello(serport)

    if not f:

        raise errors.RadioError('Unable to determine firmware version')

    if not radio.k5_approve_firmware(f):

        raise errors.RadioError(

            'Firmware version is not supported by this driver')

    LOG.info('Uploading image from firmware %r to radio with %r',

             radio.metadata.get('uvk5_firmware', 'unknown'), f)

    addr = start_addr

    while addr < stop_addr:

        dat = radio.get_mmap()[addr:addr+MEM_BLOCK]

        _writemem(serport, dat, addr)

        status.cur = addr - start_addr

        radio.status_fn(status)

        if dat:

            addr += MEM_BLOCK

        else:

            raise errors.RadioError("Memory upload incomplete")

    status.msg = "Uploaded OK"

    _resetradio(serport)

    return True

def _find_band(nolimits, hz):

    mhz = hz/1000000.0

    if nolimits:

        B = BANDS_NOLIMITS

    else:

        B = BANDS

    # currently the hacked firmware sets band=1 below 50 MHz

    if nolimits and mhz < 50.0:

        return 1

    for a in B:

        if mhz >= B[a][0] and mhz <= B[a][1]:

            return a

    return False

class UVK5RadioBase(chirp_common.CloneModeRadio):

    """Quansheng UV-K5"""

    VENDOR = "Quansheng"

    MODEL = "UV-K5"

    BAUD_RATE = 38400

    NEEDS_COMPAT_SERIAL = False

    _cal_start = 0

    _expanded_limits = False

    _upload_calibration = False

    _pttid_list = ["off", "BOT", "EOT", "BOTH"]

    _steps = [1.0, 2.5, 5.0, 6.25, 10.0, 12.5, 25.0, 8.33]

    @classmethod

    def k5_approve_firmware(cls, firmware):

        # All subclasses must implement this

        raise NotImplementedError()

    @classmethod

    def detect_from_serial(cls, pipe):

        firmware = _sayhello(pipe)

        for rclass in [UVK5Radio] + cls.DETECTED_MODELS:

            if rclass.k5_approve_firmware(firmware):

                return rclass

        raise errors.RadioError('Firmware %r not supported' % firmware)

    def get_prompts(x=None):

        rp = chirp_common.RadioPrompts()

        rp.experimental = _(

            'This is an experimental driver for the Quansheng UV-K5. '

            'It may harm your radio, or worse. Use at your own risk.\n\n'

            'Before attempting to do any changes please download '

            'the memory image from the radio with chirp '

            'and keep it. This can be later used to recover the '

            'original settings. \n\n'

            'some details are not yet implemented')

        rp.pre_download = _(

            "1. Turn radio on.\n"

            "2. Connect cable to mic/spkr connector.\n"

            "3. Make sure connector is firmly connected.\n"

            "4. Click OK to download image from device.\n\n"

            "It will may not work if you turn on the radio "

            "with the cable already attached\n")

        rp.pre_upload = _(

            "1. Turn radio on.\n"

            "2. Connect cable to mic/spkr connector.\n"

            "3. Make sure connector is firmly connected.\n"

            "4. Click OK to upload the image to device.\n\n"

            "It will may not work if you turn on the radio "

            "with the cable already attached")

        return rp

    # Return information about this radio's features, including

    # how many memories it has, what bands it supports, etc

    def get_features(self):

        rf = chirp_common.RadioFeatures()

        rf.has_bank = False

        rf.valid_dtcs_codes = DTCS_CODES

        rf.has_rx_dtcs = True

        rf.has_ctone = True

        rf.has_settings = True

        rf.has_comment = False

        rf.valid_name_length = 10

        rf.valid_power_levels = UVK5_POWER_LEVELS

        rf.valid_special_chans = list(SPECIALS.keys())

        rf.valid_duplexes = ["", "-", "+", "off"]

        # hack so we can input any frequency,

        # the 0.1 and 0.01 steps don't work unfortunately

        rf.valid_tuning_steps = list(self._steps)

        rf.valid_tmodes = ["", "Tone", "TSQL", "DTCS", "Cross"]

        rf.valid_cross_modes = ["Tone->Tone", "Tone->DTCS", "DTCS->Tone",

                                "->Tone", "->DTCS", "DTCS->", "DTCS->DTCS"]

        rf.valid_characters = chirp_common.CHARSET_ASCII

        rf.valid_modes = ["FM", "NFM", "AM", "NAM"]

        rf.valid_tmodes = ["", "Tone", "TSQL", "DTCS", "Cross"]

        rf.valid_skips = [""]

        # This radio supports memories 1-200, 201-214 are the VFO memories

        rf.memory_bounds = (1, 200)

        rf.valid_bands = []

        for a in BANDS_NOLIMITS:

            rf.valid_bands.append(

                    (int(BANDS_NOLIMITS[a][0]*1000000),

                     int(BANDS_NOLIMITS[a][1]*1000000)))

        return rf

    # Do a download of the radio from the serial port

    def sync_in(self):

        self._mmap = do_download(self)

        self.process_mmap()

    # Do an upload of the radio to the serial port

    def sync_out(self):

        do_upload(self)

    def _check_firmware_at_load(self):

        firmware = self.metadata.get('uvk5_firmware')

        if not firmware:

            LOG.warning(_('This image is missing firmware information. '

                          'It may have been generated with an old or '

                          'modified version of CHIRP. It is advised that '

                          'you download a fresh image from your radio and '

                          'use that going forward for the best safety and '

                          'compatibility.'))

        elif not self.k5_approve_firmware(self.metadata['uvk5_firmware']):

            raise errors.RadioError(

                'Image firmware is %r but is not supported by '

                'this driver' % firmware)

    # Convert the raw byte array into a memory object structure

    def process_mmap(self):

        self._check_firmware_at_load()

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

    # Return a raw representation of the memory object, which

    # is very helpful for development

    def get_raw_memory(self, number):

        return repr(self._memobj.channel[number-1])

    def validate_memory(self, mem):

        msgs = super().validate_memory(mem)

        if mem.duplex == 'off':

            return msgs

        # find tx frequency

        if mem.duplex == '-':

            txfreq = mem.freq - mem.offset

        elif mem.duplex == '+':

            txfreq = mem.freq + mem.offset

        else:

            txfreq = mem.freq

        # find band

        band = _find_band(self._expanded_limits, txfreq)

        if band is False:

            msg = "Transmit frequency %.4f MHz is not supported by this radio"\

                   % (txfreq/1000000.0)

            msgs.append(chirp_common.ValidationError(msg))

        band = _find_band(self._expanded_limits, mem.freq)

        if band is False:

            msg = "The frequency %.4f MHz is not supported by this radio" \

                   % (mem.freq/1000000.0)

            msgs.append(chirp_common.ValidationError(msg))

        return msgs

    def _set_tone(self, mem, _mem):

        ((txmode, txtone, txpol),

         (rxmode, rxtone, rxpol)) = chirp_common.split_tone_encode(mem)

        if txmode == "Tone":

            txtoval = CTCSS_TONES.index(txtone)

            txmoval = 0b01

        elif txmode == "DTCS":

            txmoval = txpol == "R" and 0b11 or 0b10

            txtoval = DTCS_CODES.index(txtone)

        else:

            txmoval = 0

            txtoval = 0

        if rxmode == "Tone":

            rxtoval = CTCSS_TONES.index(rxtone)

            rxmoval = 0b01

        elif rxmode == "DTCS":

            rxmoval = rxpol == "R" and 0b11 or 0b10

            rxtoval = DTCS_CODES.index(rxtone)

        else:

            rxmoval = 0

            rxtoval = 0

        _mem.rxcodeflag = rxmoval

        _mem.txcodeflag = txmoval

        _mem.rxcode = rxtoval

        _mem.txcode = txtoval

    def _get_tone(self, mem, _mem):

        rxtype = _mem.rxcodeflag

        txtype = _mem.txcodeflag

        rx_tmode = TMODES[rxtype]

        tx_tmode = TMODES[txtype]

        rx_tone = tx_tone = None

        if tx_tmode == "Tone":

            if _mem.txcode < len(CTCSS_TONES):

                tx_tone = CTCSS_TONES[_mem.txcode]

            else:

                tx_tone = 0

                tx_tmode = ""

        elif tx_tmode == "DTCS":

            if _mem.txcode < len(DTCS_CODES):

                tx_tone = DTCS_CODES[_mem.txcode]

            else:

                tx_tone = 0

                tx_tmode = ""

        if rx_tmode == "Tone":

            if _mem.rxcode < len(CTCSS_TONES):

                rx_tone = CTCSS_TONES[_mem.rxcode]

            else:

                rx_tone = 0

                rx_tmode = ""

        elif rx_tmode == "DTCS":

            if _mem.rxcode < len(DTCS_CODES):

                rx_tone = DTCS_CODES[_mem.rxcode]

            else:

                rx_tone = 0

                rx_tmode = ""

        tx_pol = txtype == 0x03 and "R" or "N"

        rx_pol = rxtype == 0x03 and "R" or "N"

        chirp_common.split_tone_decode(mem, (tx_tmode, tx_tone, tx_pol),

                                       (rx_tmode, rx_tone, rx_pol))

    def _get_mem_extra(self, mem, _mem):

        tmpscn = SCANLIST_LIST[0]

        # We'll also look at the channel attributes if a memory has them

        if mem.number <= 200:

            _mem3 = self._memobj.channel_attributes[mem.number - 1]

            # free memory bit

            if _mem3.is_free > 0: