CHIRP

# Copyright 2012 Dan Smith <dsmith@danplanet.com>

#

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

from builtins import bytes

import struct

import time

import logging

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

from chirp import bitwise

from chirp.settings import RadioSetting, RadioSettingGroup, \

    RadioSettingValueInteger, RadioSettingValueList, \

    RadioSettingValueBoolean, RadioSettingValueString, \

    RadioSettingValueFloat, InvalidValueError, RadioSettings

LOG = logging.getLogger(__name__)

MEM_FORMAT = """

#seekto 0x0008;

struct {

  lbcd rxfreq[4];

  lbcd txfreq[4];

  ul16 rxtone;

  ul16 txtone;

  u8 unused1:3,

     isuhf:1,

     scode:4;

  u8 unknown1:7,

     txtoneicon:1;

  u8 mailicon:3,

     unknown2:3,

     lowpower:2;

  u8 unknown3:1,

     wide:1,

     unknown4:2,

     bcl:1,

     scan:1,

     pttid:2;

} memory[128];

#seekto 0x0B08;

struct {

  u8 code[5];

  u8 unused[11];

} pttid[15];

#seekto 0x0C88;

struct {

  u8 code222[3];

  u8 unused222[2];

  u8 code333[3];

  u8 unused333[2];

  u8 alarmcode[3];

  u8 unused119[2];

  u8 unknown1;

  u8 code555[3];

  u8 unused555[2];

  u8 code666[3];

  u8 unused666[2];

  u8 code777[3];

  u8 unused777[2];

  u8 unknown2;

  u8 code60606[5];

  u8 code70707[5];

  u8 code[5];

  u8 unused1:6,

     aniid:2;

  u8 unknown[2];

  u8 dtmfon;

  u8 dtmfoff;

} ani;

#seekto 0x0E28;

struct {

  u8 squelch;

  u8 step;

  u8 unknown1;

  u8 save;

  u8 vox;

  u8 unknown2;

  u8 abr;

  u8 tdr;

  u8 beep;

  u8 timeout;

  u8 unknown3[4];

  u8 voice;

  u8 unknown4;

  u8 dtmfst;

  u8 unknown5;

  u8 unknown12:6,

     screv:2;

  u8 pttid;

  u8 pttlt;

  u8 mdfa;

  u8 mdfb;

  u8 bcl;

  u8 autolk; // NOTE: The UV-6 calls this byte voxenable, but the UV-5R

             // calls it autolk. Since this is a minor difference, it will

             // be referred to by the wrong name for the UV-6.

  u8 sftd;

  u8 unknown6[3];

  u8 wtled;

  u8 rxled;

  u8 txled;

  u8 almod;

  u8 band;

  u8 tdrab;

  u8 ste;

  u8 rpste;

  u8 rptrl;

  u8 ponmsg;

  u8 roger;

  u8 rogerrx;

  u8 tdrch; // NOTE: The UV-82HP calls this byte rtone, but the UV-6

            // calls it tdrch. Since this is a minor difference, it will

            // be referred to by the wrong name for the UV-82HP.

  u8 displayab:1,

     unknown1:2,

     fmradio:1,

     alarm:1,

     unknown2:1,

     reset:1,

     menu:1;

  u8 unknown1:6,

     singleptt:1,

     vfomrlock:1;

  u8 workmode;

  u8 keylock;

} settings;

#seekto 0x0E7E;

struct {

  u8 unused1:1,

     mrcha:7;

  u8 unused2:1,

     mrchb:7;

} wmchannel;

#seekto 0x0F10;

struct {

  u8 freq[8];

  u8 offset[6];

  ul16 rxtone;

  ul16 txtone;

  u8 unused1:7,

     band:1;

  u8 unknown3;

  u8 unused2:2,

     sftd:2,

     scode:4;

  u8 unknown4;

  u8 unused3:1

     step:3,

     unused4:4;

  u8 txpower:1,

     widenarr:1,

     unknown5:4,

     txpower3:2;

} vfoa;

#seekto 0x0F30;

struct {

  u8 freq[8];

  u8 offset[6];

  ul16 rxtone;

  ul16 txtone;

  u8 unused1:7,

     band:1;

  u8 unknown3;

  u8 unused2:2,

     sftd:2,

     scode:4;

  u8 unknown4;

  u8 unused3:1

     step:3,

     unused4:4;

  u8 txpower:1,

     widenarr:1,

     unknown5:4,

     txpower3:2;

} vfob;

#seekto 0x0F56;

u16 fm_presets;

#seekto 0x1008;

struct {

  char name[7];

  u8 unknown2[9];

} names[128];

#seekto 0x1818;

struct {

  char line1[7];

  char line2[7];

} sixpoweron_msg;

#seekto 0x%04X;

struct {

  char line1[7];

  char line2[7];

} poweron_msg;

#seekto 0x1838;

struct {

  char line1[7];

  char line2[7];

} firmware_msg;

struct limit {

  u8 enable;

  bbcd lower[2];

  bbcd upper[2];

};

#seekto 0x1908;

struct {

  struct limit vhf;

  struct limit uhf;

} limits_new;

#seekto 0x1910;

struct {

  u8 unknown1[2];

  struct limit vhf;

  u8 unknown2;

  u8 unknown3[8];

  u8 unknown4[2];

  struct limit uhf;

} limits_old;

struct squelch {

  u8 sql0;

  u8 sql1;

  u8 sql2;

  u8 sql3;

  u8 sql4;

  u8 sql5;

  u8 sql6;

  u8 sql7;

  u8 sql8;

  u8 sql9;

};

#seekto 0x18A8;

struct {

  struct squelch vhf;

  u8 unknown1[6];

  u8 unknown2[16];

  struct squelch uhf;

} squelch_new;

#seekto 0x18E8;

struct {

  struct squelch vhf;

  u8 unknown[6];

  struct squelch uhf;

} squelch_old;

"""

# 0x1EC0 - 0x2000

vhf_220_radio = b"\x02"

BASETYPE_UV5R = [b"BFS", b"BFB", b"N5R-2", b"N5R2", b"N5RV", b"BTS", b"D5R2",

                 b"B5R2"]

BASETYPE_F11 = [b"USA"]

BASETYPE_UV82 = [b"US2S2", b"B82S", b"BF82", b"N82-2", b"N822"]

BASETYPE_BJ55 = [b"BJ55"]  # needed for for the Baojie UV-55 in bjuv55.py

BASETYPE_UV6 = [b"BF1", b"UV6"]

BASETYPE_KT980HP = [b"BFP3V3 B"]

BASETYPE_F8HP = [b"BFP3V3 F", b"N5R-3", b"N5R3", b"F5R3", b"BFT", b"N5RV"]

BASETYPE_UV82HP = [b"N82-3", b"N823", b"N5R2"]

BASETYPE_UV82X3 = [b"HN5RV01"]

BASETYPE_LIST = BASETYPE_UV5R + BASETYPE_F11 + BASETYPE_UV82 + \

    BASETYPE_BJ55 + BASETYPE_UV6 + BASETYPE_KT980HP + \

    BASETYPE_F8HP + BASETYPE_UV82HP + BASETYPE_UV82X3

AB_LIST = ["A", "B"]

ALMOD_LIST = ["Site", "Tone", "Code"]

BANDWIDTH_LIST = ["Wide", "Narrow"]

COLOR_LIST = ["Off", "Blue", "Orange", "Purple"]

DTMFSPEED_LIST = ["%s ms" % x for x in range(50, 2010, 10)]

DTMFST_LIST = ["OFF", "DT-ST", "ANI-ST", "DT+ANI"]

MODE_LIST = ["Channel", "Name", "Frequency"]

PONMSG_LIST = ["Full", "Message"]

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

PTTIDCODE_LIST = ["%s" % x for x in range(1, 16)]

RTONE_LIST = ["1000 Hz", "1450 Hz", "1750 Hz", "2100Hz"]

RESUME_LIST = ["TO", "CO", "SE"]

ROGERRX_LIST = ["Off"] + AB_LIST

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

SAVE_LIST = ["Off", "1:1", "1:2", "1:3", "1:4"]

SCODE_LIST = ["%s" % x for x in range(1, 16)]

SHIFTD_LIST = ["Off", "+", "-"]

STEDELAY_LIST = ["OFF"] + ["%s ms" % x for x in range(100, 1100, 100)]

STEPS = [2.5, 5.0, 6.25, 10.0, 12.5, 25.0]

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

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

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

TDRAB_LIST = ["Off"] + AB_LIST

TDRCH_LIST = ["CH%s" % x for x in range(1, 129)]

TIMEOUT_LIST = ["%s sec" % x for x in range(15, 615, 15)] + \

    ["Off (if supported by radio)"]

TXPOWER_LIST = ["High", "Low"]

TXPOWER3_LIST = ["High", "Mid", "Low"]

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

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

WORKMODE_LIST = ["Frequency", "Channel"]

SETTING_LISTS = {

    "almod": ALMOD_LIST,

    "aniid": PTTID_LIST,

    "displayab": AB_LIST,

    "dtmfst": DTMFST_LIST,

    "dtmfspeed": DTMFSPEED_LIST,

    "mdfa": MODE_LIST,

    "mdfb": MODE_LIST,

    "ponmsg": PONMSG_LIST,

    "pttid": PTTID_LIST,

    "rtone": RTONE_LIST,

    "rogerrx": ROGERRX_LIST,

    "rpste": RPSTE_LIST,

    "rxled": COLOR_LIST,

    "save": SAVE_LIST,

    "scode": PTTIDCODE_LIST,

    "screv": RESUME_LIST,

    "sftd": SHIFTD_LIST,

    "stedelay": STEDELAY_LIST,

    "step": STEP_LIST,

    "step291": STEP291_LIST,

    "tdrab": TDRAB_LIST,

    "tdrch": TDRCH_LIST,

    "timeout": TIMEOUT_LIST,

    "txled": COLOR_LIST,

    "txpower": TXPOWER_LIST,

    "txpower3": TXPOWER3_LIST,

    "voice": VOICE_LIST,

    "vox": VOX_LIST,

    "widenarr": BANDWIDTH_LIST,

    "workmode": WORKMODE_LIST,

    "wtled": COLOR_LIST

}

GMRS_FREQS1 = [462562500, 462587500, 462612500, 462637500, 462662500,

               462687500, 462712500]

GMRS_FREQS2 = [467562500, 467587500, 467612500, 467637500, 467662500,

               467687500, 467712500]

GMRS_FREQS3 = [462550000, 462575000, 462600000, 462625000, 462650000,

               462675000, 462700000, 462725000]

GMRS_FREQS = GMRS_FREQS1 + GMRS_FREQS2 + GMRS_FREQS3 * 2

def _do_status(radio, block):

    status = chirp_common.Status()

    status.msg = "Cloning"

    status.cur = block

    status.max = radio.get_memsize()

    radio.status_fn(status)

UV5R_MODEL_ORIG = b"\x50\xBB\xFF\x01\x25\x98\x4D"

UV5R_MODEL_291 = b"\x50\xBB\xFF\x20\x12\x07\x25"

UV5R_MODEL_F11 = b"\x50\xBB\xFF\x13\xA1\x11\xDD"

UV5R_MODEL_UV82 = b"\x50\xBB\xFF\x20\x13\x01\x05"

UV5R_MODEL_UV6 = b"\x50\xBB\xFF\x20\x12\x08\x23"

UV5R_MODEL_UV6_ORIG = b"\x50\xBB\xFF\x12\x03\x98\x4D"

UV5R_MODEL_A58 = b"\x50\xBB\xFF\x20\x14\x04\x13"

UV5R_MODEL_UV5G = b"\x50\xBB\xFF\x20\x12\x06\x25"

def _upper_band_from_data(data):

    return data[0x03:0x04]

def _upper_band_from_image(radio):

    return _upper_band_from_data(radio.get_mmap())

def _firmware_version_from_data(data, version_start, version_stop):

    version_tag = data[version_start:version_stop]

    return version_tag

def _firmware_version_from_image(radio):

    version = _firmware_version_from_data(

        radio.get_mmap().get_byte_compatible(),

        radio._fw_ver_file_start,

        radio._fw_ver_file_stop)

    return version

def _do_ident(radio, magic, secondack=True):

    serial = radio.pipe

    serial.timeout = 1

    LOG.info("Sending Magic: %s" % util.hexprint(magic))

    for byte in magic:

        serial.write(bytes([byte]))

        time.sleep(0.01)

    ack = serial.read(1)

    if ack != b"\x06":

        if ack:

            LOG.debug(repr(ack))

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

    serial.write(b"\x02")

    # Until recently, the "ident" returned by the radios supported by this

    # driver have always been 8 bytes long. The image structure is the 8 byte

    # "ident" followed by the downloaded memory data. So all of the settings

    # structures are offset by 8 bytes. The ident returned from a UV-6 radio

    # can be 8 bytes (original model) or now 12 bytes.

    #

    # To accommodate this, the "ident" is now read one byte at a time until the

    # last byte ("\xdd") is encountered. The bytes containing the value "\x01"

    # are discarded to shrink the "ident" length down to 8 bytes to keep the

    # image data aligned with the existing settings structures.

    # Ok, get the response

    response = b""

    for i in range(1, 13):

        byte = serial.read(1)

        response += byte

        # stop reading once the last byte ("\xdd") is encountered

        if byte == b"\xDD":

            break

    # check if response is OK

    if len(response) in [8, 12]:

        # DEBUG

        LOG.info("Valid response, got this:")

        LOG.debug(util.hexprint(response))

        if len(response) == 12:

            ident = (bytes([response[0], response[3], response[5]]) +

                     response[7:])

        else:

            ident = response

    else:

        # bad response

        msg = "Unexpected response, got this:"

        msg += util.hexprint(response)

        LOG.debug(msg)

        raise errors.RadioError("Unexpected response from radio.")

    if secondack:

        serial.write(b"\x06")

        ack = serial.read(1)

        if ack != b"\x06":

            raise errors.RadioError("Radio refused clone")

    return ident

def _read_block(radio, start, size, first_command=False):

    msg = struct.pack(">BHB", ord("S"), start, size)

    radio.pipe.write(msg)

    if first_command is False:

        ack = radio.pipe.read(1)

        if ack != b"\x06":

            raise errors.RadioError(

                "Radio refused to send second block 0x%04x" % start)

    answer = radio.pipe.read(4)

    if len(answer) != 4:

        raise errors.RadioError("Radio refused to send block 0x%04x" % start)

    cmd, addr, length = struct.unpack(">BHB", answer)

    if cmd != ord("X") or addr != start or length != size:

        LOG.error("Invalid answer for block 0x%04x:" % start)

        LOG.debug("CMD: %s  ADDR: %04x  SIZE: %02x" % (cmd, addr, length))

        raise errors.RadioError("Unknown response from radio")

    chunk = radio.pipe.read(size)

    if not chunk:

        raise errors.RadioError("Radio did not send block 0x%04x" % start)

    elif len(chunk) != size:

        LOG.error("Chunk length was 0x%04i" % len(chunk))

        raise errors.RadioError("Radio sent incomplete block 0x%04x" % start)

    radio.pipe.write(b"\x06")

    time.sleep(0.05)

    return chunk

def _get_radio_firmware_version(radio):

    if radio.MODEL == "BJ-UV55":

        block = _read_block(radio, 0x1FF0, 0x40, True)

        version = block[0:6]

    else:

        block0 = _read_block(radio, 0x1EC0, 0x40, True)   # dir read

        block1 = _read_block(radio, 0x1E80, 0x40, False)  # seq read 1 of 2

        block2 = _read_block(radio, 0x1EC0, 0x40, False)  # seq read 2 of 2

        version_d = block0[48:62]  # directly read block

        version = block2[48:62]    # sequentially read block

    return version, version_d

IDENT_BLACKLIST = {

    b"\x50\x0D\x0C\x20\x16\x03\x28": "Radio identifies as BTECH UV-5X3",

    b"\x50\xBB\xFF\x20\x12\x06\x25": "Radio identifies as Radioddity UV-5G",

}

def _ident_radio(radio):

    for magic in radio._idents:

        error = None

        try:

            data = _do_ident(radio, magic)

            return data

        except errors.RadioError as e:

            LOG.error("uv5r._ident_radio: %s", e)

            error = e

            time.sleep(2)

    for magic, reason in list(IDENT_BLACKLIST.items()):

        try:

            _do_ident(radio, magic, secondack=False)

        except errors.RadioError as e:

            # No match, try the next one

            continue

        # If we got here, it means we identified the radio as

        # something other than one of our valid idents. Warn

        # the user so they can do the right thing.

        LOG.warning(('Identified radio as a blacklisted model '

                     '(details: %s)') % reason)

        raise errors.RadioError(('%s. Please choose the proper vendor/'

                                 'model and try again.') % reason)

    if error:

        raise error

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

def _do_download(radio):

    data = _ident_radio(radio)

    radio_version, radio_version_d = _get_radio_firmware_version(radio)

    LOG.info("Radio Version S is %s" % repr(radio_version))

    LOG.info("Radio Version D is %s" % repr(radio_version_d))

    if b"HN5RV" in radio_version:

        # A radio with HN5RV firmware has been detected. It could be a

        # UV-5R style radio with HIGH/LOW power levels or it could be a

        # BF-F8HP style radio with HIGH/MID/LOW power levels.

        # We are going to count on the user to make the right choice and

        # then append that model type to the end of the image so it can

        # be properly detected when loaded.

        append_model = True

    elif b"\xFF" * 7 in radio_version:

        # A radio UV-5R style radio that reports no firmware version has

        # been detected.

        # We are going to count on the user to make the right choice and

        # then append that model type to the end of the image so it can

        # be properly detected when loaded.

        append_model = True

    elif b"\x20" * 14 in radio_version:

        # A radio UV-5R style radio that reports no firmware version has

        # been detected.

        # We are going to count on the user to make the right choice and

        # then append that model type to the end of the image so it can

        # be properly detected when loaded.

        append_model = True

    elif not any(type in radio_version for type in radio._basetype):

        # This radio can't be properly detected by parsing its firmware

        # version.

        raise errors.RadioError("Incorrect 'Model' selected.")

    else:

        # This radio can be properly detected by parsing its firmware version.

        # There is no need to append its model type to the end of the image.

        append_model = False

    # Main block

    LOG.debug("downloading main block...")

    for i in range(0, 0x1800, 0x40):

        data += _read_block(radio, i, 0x40, False)

        _do_status(radio, i)

    _do_status(radio, radio.get_memsize())

    LOG.debug("done.")

    if radio._aux_block:

        LOG.debug("downloading aux block...")

        # Auxiliary block starts at 0x1ECO (?)

        for i in range(0x1EC0, 0x2000, 0x40):

            data += _read_block(radio, i, 0x40, False)

    if append_model:

        data += radio.MODEL.ljust(8).encode()

    LOG.debug("done.")

    return memmap.MemoryMapBytes(data)

def _send_block(radio, addr, data):

    msg = struct.pack(">BHB", ord("X"), addr, len(data))

    radio.pipe.write(msg + data)

    time.sleep(0.05)

    ack = radio.pipe.read(1)

    if ack != b"\x06":

        raise errors.RadioError("Radio refused to accept block 0x%04x" % addr)

def _do_upload(radio):

    ident = _ident_radio(radio)

    radio_upper_band = ident[3:4]

    image_upper_band = _upper_band_from_image(radio)

    if image_upper_band == vhf_220_radio or radio_upper_band == vhf_220_radio:

        if image_upper_band != radio_upper_band:

            raise errors.RadioError("Image not supported by radio")

    image_version = _firmware_version_from_image(radio)

    radio_version, radio_version_d = _get_radio_firmware_version(radio)

    LOG.info("Image Version is %s" % repr(image_version))

    LOG.info("Radio Version S is %s" % repr(radio_version))

    LOG.info("Radio Version D is %s" % repr(radio_version_d))

    # default ranges

    _ranges_main_default = [

        (0x0008, 0x0CF8),

        (0x0D08, 0x0DF8),

        (0x0E08, 0x1808)

        ]

    _ranges_aux_default = [

        (0x1EC0, 0x1EF0),

        ]

    # extra aux ranges

    _ranges_aux_extra = [

        (0x1F60, 0x1F70),

        (0x1F80, 0x1F90),

        (0x1FC0, 0x1FE0)

        ]

    if radio_version != radio_version_d:

        # not safe to upload 'aux block', set flag to skip it

        _skip_aux_block_flag = True

    else:

        # safe to upload 'aux block'

        _skip_aux_block_flag = False

    if radio._all_range_flag:

        image_matched_radio = True

        ranges_main = radio._ranges_main

        ranges_aux = radio._ranges_aux

        LOG.warning('Sending all ranges to radio as instructed')

    elif image_version == radio_version:

        image_matched_radio = True

        ranges_main = _ranges_main_default

        ranges_aux = _ranges_aux_default + _ranges_aux_extra

    elif any(type in radio_version for type in radio._basetype):

        image_matched_radio = False

        ranges_main = _ranges_main_default

        ranges_aux = _ranges_aux_default

    else:

        msg = ("The upload was stopped because the firmware "

               "version of the image (%s) does not match that "

               "of the radio (%s).")

        raise errors.RadioError(msg % (image_version, radio_version))

    if not radio._aux_block:

        image_matched_radio = True

    # Main block

    mmap = radio.get_mmap().get_byte_compatible()

    for start_addr, end_addr in ranges_main:

        for i in range(start_addr, end_addr, 0x10):

            _send_block(radio, i - 0x08, mmap[i:i + 0x10])

            _do_status(radio, i)

        _do_status(radio, radio.get_memsize())

    if len(mmap.get_packed()) == 0x1808:

        LOG.info("Old image, not writing aux block")

        return  # Old image, no aux block

    if _skip_aux_block_flag:

        LOG.info("Skiped writing aux block")

        msg = ("This is NOT an error.\n"

               "Upload finished. The 'Aux block' (which contains "

               "the 'Other Settings' and 'Service Settings') was "

               "skipped because testing has determined that uploading "

               "it to this radio is not safe.")

        raise errors.RadioError(msg)

        return  # Aux block skipped

    # Auxiliary block at radio address 0x1EC0, our offset 0x1808

    for start_addr, end_addr in ranges_aux:

        for i in range(start_addr, end_addr, 0x10):

            addr = 0x1808 + (i - 0x1EC0)

            _send_block(radio, i, mmap[addr:addr + 0x10])

    if not image_matched_radio:

        msg = ("Upload finished, but the 'Other Settings' "

               "could not be sent because the firmware "

               "version of the image (%s) does not match "

               "that of the radio (%s).")

        raise errors.RadioError(msg % (image_version, radio_version))

    if radio._all_range_flag:

        radio._all_range_flag = False

        LOG.warning('Sending all ranges to radio has completed')

        raise errors.RadioError(

            "This is NOT an error.\n"

            "The upload has finished successfully.\n"

            "Please restart CHIRP.")

UV5R_POWER_LEVELS = [chirp_common.PowerLevel("High", watts=4.00),

                     chirp_common.PowerLevel("Low",  watts=1.00)]

UV5R_POWER_LEVELS3 = [chirp_common.PowerLevel("High", watts=8.00),

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

                      chirp_common.PowerLevel("Low",  watts=1.00)]

UV5R_DTCS = tuple(sorted(chirp_common.DTCS_CODES + (645,)))

UV5R_CHARSET = chirp_common.CHARSET_UPPER_NUMERIC + \

    "!@#$%^&*()+-=[]:\";'<>?,./"

def model_match(cls, data):

    """Match the opened/downloaded image to the correct version"""

    if len(data) == 0x1950:

        rid = data[0x1948:0x1950]

        return rid.startswith(cls.MODEL)

    elif len(data) == 0x1948:

        rid = data[cls._fw_ver_file_start:cls._fw_ver_file_stop]

        if any(type in rid for type in cls._basetype):

            return True

    else:

        return False

class BaofengUV5R(chirp_common.CloneModeRadio):

    """Baofeng UV-5R"""

    VENDOR = "Baofeng"

    MODEL = "UV-5R"

    BAUD_RATE = 9600

    NEEDS_COMPAT_SERIAL = False

    _memsize = 0x1808

    _basetype = BASETYPE_UV5R

    _idents = [UV5R_MODEL_291,

               UV5R_MODEL_ORIG

               ]

    _vhf_range = (130000000, 176000000)

    _220_range = (220000000, 260000000)

    _uhf_range = (400000000, 520000000)

    _aux_block = True

    _tri_power = False

    _bw_shift = False

    _mem_params = (0x1828  # poweron_msg offset

                   )

    # offset of fw version in image file

    _fw_ver_file_start = 0x1838

    _fw_ver_file_stop = 0x1846

    _ranges_main = [

                    (0x0008, 0x1808),

                   ]

    _ranges_aux = [

                   (0x1EC0, 0x2000),

                  ]

    _valid_chars = UV5R_CHARSET

    @classmethod

    def get_prompts(cls):

        rp = chirp_common.RadioPrompts()

        rp.experimental = \

            ('Due to the fact that the manufacturer continues to '

             'release new versions of the firmware with obscure and '

             'hard-to-track changes, this driver may not work with '

             'your device. Thus far and to the best knowledge of the '

             'author, no UV-5R radios have been harmed by using CHIRP. '

             'However, proceed at your own risk!')

        rp.pre_download = _(

            "1. Turn radio off.\n"

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

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

            "4. Turn radio on (volume may need to be set at 100%).\n"

            "5. Ensure that the radio is tuned to channel with no"

            " activity.\n"

            "6. Click OK to download image from device.\n")

        rp.pre_upload = _(

            "1. Turn radio off.\n"

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

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

            "4. Turn radio on (volume may need to be set at 100%).\n"

            "5. Ensure that the radio is tuned to channel with no"

            " activity.\n"

            "6. Click OK to upload image to device.\n")

        return rp

    def get_features(self):

        rf = chirp_common.RadioFeatures()

        rf.has_settings = True

        rf.has_bank = False

        rf.has_cross = True

        rf.has_rx_dtcs = True

        rf.has_tuning_step = False

        rf.can_odd_split = True

        rf.valid_name_length = 7

        rf.valid_characters = self._valid_chars

        rf.valid_skips = ["", "S"]

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

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

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

        rf.valid_power_levels = UV5R_POWER_LEVELS

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

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

        rf.valid_tuning_steps = STEPS

        rf.valid_dtcs_codes = UV5R_DTCS

        normal_bands = [self._vhf_range, self._uhf_range]

        rax_bands = [self._vhf_range, self._220_range]

        if self._mmap is None:

            rf.valid_bands = [normal_bands[0], rax_bands[1], normal_bands[1]]

        elif not self._is_orig() and self._my_upper_band() == vhf_220_radio:

            rf.valid_bands = rax_bands

        else:

            rf.valid_bands = normal_bands

        rf.memory_bounds = (0, 127)

        return rf

    @classmethod

    def match_model(cls, filedata, filename):

        match_size = False

        match_model = False

        if len(filedata) in [0x1808, 0x1948, 0x1950]:

            match_size = True

        match_model = model_match(cls, filedata)

        if match_size and match_model:

            return True

        else:

            return False

    def process_mmap(self):

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

        self._all_range_flag = False

    def sync_in(self):

        try:

            self._mmap = _do_download(self)

        except errors.RadioError:

            raise

        except Exception as e:

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

        self.process_mmap()

    def sync_out(self):

        try:

            _do_upload(self)

        except errors.RadioError:

            raise

        except Exception as e:

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

    def get_raw_memory(self, number):

        return repr(self._memobj.memory[number])

    def _is_txinh(self, _mem):

        raw_tx = ""

        for i in range(0, 4):

            raw_tx += _mem.txfreq[i].get_raw()

        return raw_tx == "\xFF\xFF\xFF\xFF"

    def _get_mem(self, number):

        return self._memobj.memory[number]

    def _get_nam(self, number):

        return self._memobj.names[number]

    def get_memory(self, number):

        _mem = self._get_mem(number)

        _nam = self._get_nam(number)

        mem = chirp_common.Memory()

        mem.number = number