CHIRP

# Copyright 2016 Pavel Milanes, CO7WT, <pavelmc@gmail.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/>.

import logging

import struct

import time

import sys

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

from textwrap import dedent

from chirp.settings import RadioSettingGroup, RadioSetting, \

    RadioSettingValueBoolean, RadioSettingValueList, \

    RadioSettingValueString, RadioSettingValueInteger, \

    RadioSettings

LOG = logging.getLogger(__name__)

##### IMPORTANT DATA ##########################################

# This radios have a span of

# 0x00000 - 0x08000 => Radio Memory / Settings data

# 0x08000 - 0x10000 => FIRMWARE... hum...

###############################################################

MEM_FORMAT = """

#seekto 0x0000;

struct {

  u8 unknown0[14];          // x00-x0d unknown

  u8 banks;                 // x0e how many banks are programmed

  u8 channels;              // x0f how many total channels are programmed

  // --

  ul16 tot;                 // x10 TOT value: range(15, 600, 15); x04b0 = off

  u8 tot_rekey;             // x12 TOT Re-key value range(0, 60); off= 0

  u8 unknown1;              // x13 unknown

  u8 tot_reset;             // x14 TOT Re-key value range(0, 60); off= 0

  u8 unknown2;              // x15 unknows

  u8 tot_alert;             // x16 TOT pre alert: range(0,10); 0 = off

  u8 unknown3[7];           // x17-x1d unknown

  u8 sql_level;             // x1e  SQ reference level

  u8 battery_save;          // Only for portable: FF = off, x32 = on

  // --

  u8 unknown4[10];          // x20

  u8 unknown5:3,            // x2d

     c2t:1,                 // 1 bit clear to transpond: 1-off

                            // This is relative to DTMF / 2-Tone settings

     unknown6:4;

  u8 unknown7[5];           // x2b-x2f

  // --

  u8 unknown8[16];          // x30 ?

  u8 unknown9[16];          // x40 ?

  u8 unknown10[16];          // x50 ?

  u8 unknown11[16];         // x60 ?

  // --

  u8 add[16];               // x70-x7f 128 bits corresponding add/skip values

  // --

  u8 unknown12:4,           // x80

     off_hook_decode:1,     // 1 bit off hook decode enabled: 1-off

     off_hook_horn_alert:1, // 1 bit off hook horn alert: 1-off

     unknown13:2;

  u8 unknown14;             // x81

  u8 unknown15:3,           // x82

     self_prog:1,           // 1 bit Self programming enabled: 1-on

     clone:1,               // 1 bit clone enabled: 1-on

     firmware_prog:1,       // 1 bit firmware programming enabled: 1-on

     unknown16:1,

     panel_test:1;          // 1 bit panel test enabled

  u8 unknown17;             // x83

  u8 unknown18:5,           // x84

     warn_tone:1,           // 1 bit warning tone, enabled: 1-on

     control_tone:1,        // 1 bit control tone (key tone), enabled: 1-on

     poweron_tone:1;        // 1 bit power on tone, enabled: 1-on

  u8 unknown19[5];          // x85-x89

  u8 min_vol;               // minimum volume posible: range(0,32); 0 = off

  u8 tone_vol;              // minimum tone volume posible:

                                // xff = continous, range(0, 31)

  u8 unknown20[4];          // x8c-x8f

  // --

  u8 unknown21[4];          // x90-x93

  char poweronmesg[8];      // x94-x9b power on mesg 8 bytes, off is "\FF" * 8

  u8 unknown22[4];          // x9c-x9f

  // --

  u8 unknown23[7];          // xa0-xa6

  char ident[8];            // xa7-xae radio identification string

  u8 unknown24;             // xaf

  // --

  u8 unknown26[11];         // xaf-xba

  char lastsoftversion[5];  // software version employed to program the radio

} settings;

#seekto 0xd0;

struct {

  u8 unknown[4];

  char radio[6];

  char data[6];

} passwords;

#seekto 0x0110;

struct {

  u8 kA;                // Portable > Closed circle

  u8 kDA;               // Protable > Triangle to Left

  u8 kGROUP_DOWN;       // Protable > Triangle to Right

  u8 kGROUP_UP;         // Protable > Side 1

  u8 kSCN;              // Portable > Open Circle

  u8 kMON;              // Protable > Side 2

  u8 kFOOT;

  u8 kCH_UP;

  u8 kCH_DOWN;

  u8 kVOL_UP;

  u8 kVOL_DOWN;

  u8 unknown30[5];

  // --

  u8 unknown31[4];

  u8 kP_KNOB;           // Just portable: channel knob

  u8 unknown32[11];

} keys;

#seekto 0x0140;

struct {

  lbcd tf01_rx[4];

  lbcd tf01_tx[4];

  u8 tf01_u_rx;

  u8 tf01_u_tx;

  lbcd tf02_rx[4];

  lbcd tf02_tx[4];

  u8 tf02_u_rx;

  u8 tf02_u_tx;

  lbcd tf03_rx[4];

  lbcd tf03_tx[4];

  u8 tf03_u_rx;

  u8 tf03_u_tx;

  lbcd tf04_rx[4];

  lbcd tf04_tx[4];

  u8 tf04_u_rx;

  u8 tf04_u_tx;

  lbcd tf05_rx[4];

  lbcd tf05_tx[4];

  u8 tf05_u_rx;

  u8 tf05_u_tx;

  lbcd tf06_rx[4];

  lbcd tf06_tx[4];

  u8 tf06_u_rx;

  u8 tf06_u_tx;

  lbcd tf07_rx[4];

  lbcd tf07_tx[4];

  u8 tf07_u_rx;

  u8 tf07_u_tx;

  lbcd tf08_rx[4];

  lbcd tf08_tx[4];

  u8 tf08_u_rx;

  u8 tf08_u_tx;

  lbcd tf09_rx[4];

  lbcd tf09_tx[4];

  u8 tf09_u_rx;

  u8 tf09_u_tx;

  lbcd tf10_rx[4];

  lbcd tf10_tx[4];

  u8 tf10_u_rx;

  u8 tf10_u_tx;

  lbcd tf11_rx[4];

  lbcd tf11_tx[4];

  u8 tf11_u_rx;

  u8 tf11_u_tx;

  lbcd tf12_rx[4];

  lbcd tf12_tx[4];

  u8 tf12_u_rx;

  u8 tf12_u_tx;

  lbcd tf13_rx[4];

  lbcd tf13_tx[4];

  u8 tf13_u_rx;

  u8 tf13_u_tx;

  lbcd tf14_rx[4];

  lbcd tf14_tx[4];

  u8 tf14_u_rx;

  u8 tf14_u_tx;

  lbcd tf15_rx[4];

  lbcd tf15_tx[4];

  u8 tf15_u_rx;

  u8 tf15_u_tx;

  lbcd tf16_rx[4];

  lbcd tf16_tx[4];

  u8 tf16_u_rx;

  u8 tf16_u_tx;

} test_freq;

#seekto 0x200;

struct {

  char line1[32];

  char line2[32];

} message;

#seekto 0x2000;

struct {

  u8 bnumb;             // mem number

  u8 bank;              // to which bank it belongs

  char name[8];         // name 8 chars

  u8 unknown20[2];      // unknown yet

  lbcd rxfreq[4];       // rx freq

  // --

  lbcd txfreq[4];       // tx freq

  u8 rx_unkw;           // unknown yet

  u8 tx_unkw;           // unknown yet

  ul16 rx_tone;         // rx tone

  ul16 tx_tone;         // tx tone

  u8 unknown23[5];      // unknown yet

  u8 signaling;         // xFF = off, x30 DTMF, x31 2-Tone

                        // See the zone on x7000

  // --

  u8 ptt_id:2,       // ??? BOT = 0, EOT = 1, Both = 2, NONE = 3

     beat_shift:1,      // 1 = off

     unknown26:2        // ???

     power:1,           // power: 0 low / 1 high

     compander:1,       // 1 = off

     wide:1;            // wide 1 / 0 narrow

  u8 unknown27:6,       // ???

     busy_lock:1,       // 1 = off

     unknown28:1;       // ???

  u8 unknown29[14];     // unknown yet

} memory[128];

#seekto 0x5900;

struct {

  char model[8];

  u8 unknown50[4];

  char type[2];

  u8 unknown51[2];

    // --

  char serial[8];

  u8 unknown52[8];

} id;

#seekto 0x6000;

struct {

  u8 code[8];

  u8 unknown60[7];

  u8 count;

} bot[128];

#seekto 0x6800;

struct {

  u8 code[8];

  u8 unknown61[7];

  u8 count;

} eot[128];

#seekto 0x7000;

struct {

  lbcd dt2_id[5];       // DTMF lbcd ID (000-9999999999)

                        // 2-Tone = "11 f1 ff ff ff" ???

                        // None = "00 f0 ff ff ff"

} dtmf;

"""

NOTE = """ MENTAL NOTE ABOUT RADIO MEM

The OEM insist on not reading/writing some mem segments, see below

read: (hex)

    00 - 03

    07 - 08

    10

    20 - 21

    58 - 7F

write: (hex)

    00 - 03

    07 - 08

    10

    20 - 21

    60 - 7F

This can be an artifact to just read/write in the needed mem space and speed

up things, if so the first read blocks has all the data about channel groups

and freq/tones & names employed.

This is a copied trick from the "60G series" ones and may use the same schema.

I must investigate further on this.

"""

MEM_SIZE = 0x8000  # 32,768 bytes (128 blocks of 256 bytes)

BLOCK_SIZE = 256

MEM_BLOCKS = range(0, MEM_SIZE / BLOCK_SIZE)

# undefined yet...

#~ RO_BLOCKS = range(0x10, 0x1F) + range(0x59, 0x5f)

# define and empty block of data, as it will be used a lot in this code

EMPTY_BLOCK = "\xFF" * 256

ACK_CMD = "\x06"

POWER_LEVELS = [chirp_common.PowerLevel("Low", watts=1),

                chirp_common.PowerLevel("High", watts=5)]

MODES = ["NFM", "FM"]  # 12.5 / 25 Khz

VALID_CHARS = chirp_common.CHARSET_UPPER_NUMERIC + "_-*()/\-+=)"

SKIP_VALUES = ["", "S"]

TONES = chirp_common.TONES

# TONES.remove(254.1)

DTCS_CODES = chirp_common.DTCS_CODES

TOT = ["off"] + ["%s" % x for x in range(15, 615, 15)]

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

TOT_REKEY = ["off"] + ["%s" % x for x in range(1, 61)]

TOT_RESET = ["off"] + ["%s" % x for x in range(1, 16)]

VOL = ["off"] + ["%s" % x for x in range(1, 32)]

TVOL = ["%s" % x for x in range(0, 33)]

TVOL[32] = "Continous"

SQL = ["off"] + ["%s" % x for x in range(1, 10)]

## BOT = 0, EOT = 1, Both = 2, NONE = 3

#PTTID = ["BOT", "EOT", "Both", "none"]

# For debugging purposes

debug = False

#~ KEYS = {

    #~ 0x33: "Display character",

    #~ 0x35: "Home Channel",                   # Posible portable only, chek it

    #~ 0x37: "CH down",

    #~ 0x38: "CH up",

    #~ 0x39: "Key lock",

    #~ 0x3a: "Lamp",                           # Portable only

    #~ 0x3b: "Public address",

    #~ 0x3c: "Reverse",                        # Just in updated firmwares (768G)

    #~ 0x3d: "Horn alert",

    #~ 0x3e: "Selectable QT",                  # Just in updated firmwares (768G)

    #~ 0x3f: "2-tone encode",

    #~ 0x40: "Monitor A: open mommentary",

    #~ 0x41: "Monitor B: Open Toggle",

    #~ 0x42: "Monitor C: Carrier mommentary",

    #~ 0x43: "Monitor D: Carrier toogle",

    #~ 0x44: "Operator selectable tone",

    #~ 0x45: "Redial",

    #~ 0x46: "RF Power Low",                   # portable only ?

    #~ 0x47: "Scan",

    #~ 0x48: "Scan del/add",

    #~ 0x4a: "GROUP down",

    #~ 0x4b: "GROUP up",

    #~ #0x4e: "Tone off (Experimental)",       # undocumented !!!!

    #~ 0x4f: "None",

    #~ 0x50: "VOL down",

    #~ 0x51: "VOL up",

    #~ 0x52: "Talk around",

    #~ 0x5d: "AUX",

    #~ 0xa1: "Channel Up/Down"                 # Knob for portables only

    #~ }

def _raw_recv(radio, amount):

    """Raw read from the radio device"""

    data = ""

    try:

        data = radio.pipe.read(amount)

    except:

        raise errors.RadioError("Error reading data from radio")

    # DEBUG

    if debug is True:

        LOG.debug("<== (%d) bytes:\n\n%s" % (len(data), util.hexprint(data)))

    return data

def _raw_send(radio, data):

    """Raw send to the radio device"""

    try:

        radio.pipe.write(data)

    except:

        raise errors.RadioError("Error sending data to radio")

    # DEBUG

    if debug is True:

        LOG.debug("==> (%d) bytes:\n\n%s" % (len(data), util.hexprint(data)))

def _close_radio(radio):

    """Get the radio out of program mode"""

    _raw_send(radio, "\x45")

def _checksum(data):

    """the radio block checksum algorithm"""

    cs = 0

    for byte in data:

            cs += ord(byte)

    return cs % 256

def _send(radio, frame):

    """Generic send data to the radio"""

    _raw_send(radio, frame)

def _make_frame(cmd, addr):

    """Pack the info in the format it likes"""

    return struct.pack(">BH", ord(cmd), addr)

def _handshake(radio, msg=""):

    """Make a full handshake"""

    # send ACK

    _raw_send(radio, ACK_CMD)

    # receive ACK

    ack = _raw_recv(radio, 1)

    # check ACK

    if ack != ACK_CMD:

        _close_radio(radio)

        mesg = "Handshake failed " + msg

        # DEBUG

        LOG.debug(mesg)

        raise Exception(mesg)

def _check_write_ack(r, ack, addr):

    """Process the ack from the write process

    this is half handshake needed in tx data block"""

    # all ok

    if ack == ACK_CMD:

        return True

    # Explicit BAD checksum

    if ack == "\x15":

        _close_radio(r)

        raise errors.RadioError(

            "Bad checksum in block %02x write" % addr)

    # everything else

    _close_radio(r)

    raise errors.RadioError(

        "Problem with the ack to block %02x write, ack %03i" %

        (addr, int(ack)))

def _recv(radio):

    """Receive data from the radio, 258 bytes split in (cmd, data, checksum)

    checking the checksum to be correct, and returning just

    256 bytes of data or false if short empty block"""

    rxdata = _raw_recv(radio, BLOCK_SIZE + 2)

    # when the RX block has two bytes and the first is \x5A

    # then the block is all \xFF

    if len(rxdata) == 2 and rxdata[0] == "\x5A":

        # just return false to flag about empty block

        return False

    elif len(rxdata) != 258:

        # not the amount of data we want

        msg = "The radio send %d bytes, we need 258" % len(rxdata)

        # DEBUG

        LOG.error(msg)

        raise errors.RadioError(msg)

    else:

        rcs = ord(rxdata[-1])

        data = rxdata[1:-1]

        ccs = _checksum(data)

        if rcs != ccs:

            _close_radio(radio)

            raise errors.RadioError(

                "Block Checksum Error! real %02x, calculated %02x" %

                (rcs, ccs))

        _handshake(radio, "after checksum")

        return data

def _open_radio(radio, status):

    """Open the radio into program mode and check if it's the correct model"""

    # The OEM sets the timeout to 0.550 second, we tested it and no joy.

    radio.pipe.baudrate = 9600

    radio.pipe.timeout = 0.7

    radio.pipe.parity = "N"

    # DEBUG

    LOG.debug("Entering program mode.")

    # max tries

    tries = 10

    # UI

    status.cur = 0

    status.max = tries

    status.msg = "Entering program mode..."

    # try a few times to get the radio into program mode

    exito = False

    for i in range(0, tries):

        # flush in pyserial 3.0 way

        radio.pipe.reset_input_buffer()

        radio.pipe.reset_output_buffer()

        time.sleep(0.02)

        # line dance between each try:

        radio.pipe.rts = True

        radio.pipe.dtr = True

        time.sleep(0.02)

        radio.pipe.dtr = False

        # now send the magic

        _raw_send(radio, "PROGRAM")

        ack = _raw_recv(radio, 1)

        if length(ack) == 0 or ack != ACK_CMD:

            # DEBUG

            LOG.debug("Try %s failed, traying again..." % i)

            time.sleep(0.25)

        else:

            exito = True

            break

        status.cur += 1

        radio.status_fn(status)

    if exito is False:

        _close_radio(radio)

        LOG.debug("Radio did not accepted PROGRAM command in %s atempts" % tries)

        raise errors.RadioError("The radio doesn't accept program mode")

    # DEBUG

    LOG.debug("Received ACK to the PROGRAM command, send ID query.")

    # lest's check the radio model

    _raw_send(radio, "\x02")

    rid = _raw_recv(radio, 8)

    if not (radio.TYPE in rid):

        # bad response, properly close the radio before exception

        _close_radio(radio)

        # DEBUG

        LOG.debug("Incorrect model ID:")

        LOG.debug(util.hexprint(rid))

        raise errors.RadioError(

            "Incorrect model ID, got %s, it not contains %s" %

            (rid.strip("\xff"), radio.TYPE))

    # DEBUG

    LOG.debug("Full ident string is:")

    LOG.debug(util.hexprint(rid))

    _handshake(radio)

    # alert the user of the success

    status.msg = "Radio ident success!"

    radio.status_fn(status)

    # this radios checks some kind of version (radio version?)

    _raw_send(radio, "\x50")    # 'P'

    ver = _raw_recv(radio, 10)

    # DEBUG

    LOG.debug("Version returned by the radios is:")

    LOG.debug(util.hexprint(ver))

    _handshake(radio)

    # the radio that was procesed returned this:

    # v2.01k.... [76 32 2E 30 31 6B EF FF FF FF]

    # now the OEM writes simpy "O" and get no answer...

    # after that we are ready to receive the radio image or to write to it

    _raw_send(radio, "\x4F")    # 'O'

def do_download(radio):

    """ The download function """

    # UI progress

    status = chirp_common.Status()

    data = ""

    count = 0

    # open the radio

    _open_radio(radio, status)

    # reset UI data

    status.cur = 0

    status.max = MEM_SIZE / BLOCK_SIZE

    status.msg = "Cloning from radio..."

    radio.status_fn(status)

    # set the timeout and if windows keep it bigger

    if sys.platform in ["win32", "cygwin"]:

        # bigger timeout

        radio.pipe.timeout = 0.55

    else:

        # Linux can keep up, MAC?

        radio.pipe.timeout = 0.05

    # DEBUG

    LOG.debug("Starting the download from radio")

    for addr in MEM_BLOCKS:

        # send request, but before flush the rx buffer

        radio.pipe.flush()

        _send(radio, _make_frame("R", addr))

        # now we get the data

        d = _recv(radio)

        # if empty block, it return false

        # aka we asume a empty 256 xFF block

        if d is False:

            d = EMPTY_BLOCK

        data += d

        # UI Update

        status.cur = count

        radio.status_fn(status)

        count += 1

    _close_radio(radio)

    return memmap.MemoryMap(data)

def do_upload(radio):

    """ The upload function """

    # DISABLED in this pre-alpha state_close_radio(radio)

    _close_radio(radio)

    raise errors.RadioError("No upload possible yet, this is a test driver")

    #~ # UI progress

    #~ status = chirp_common.Status()

    #~ data = ""

    #~ count = 0

    #~ # open the radio

    #~ _open_radio(radio, status)

    #~ # update UI

    #~ status.cur = 0

    #~ status.max = MEM_SIZE / BLOCK_SIZE

    #~ status.msg = "Cloning to radio..."

    #~ radio.status_fn(status)

    #~ # the default for the original soft as measured

    #~ radio.pipe.timeout = 0.5

    #~ # DEBUG

    #~ LOG.debug("Starting the upload to the radio")

    #~ count = 0

    #~ raddr = 0

    #~ for addr in MEM_BLOCKS:

        #~ # this is the data block to write

        #~ data = radio.get_mmap()[raddr:raddr+BLOCK_SIZE]

        #~ # The blocks from x59-x5F are NOT programmable

        #~ # The blocks from x11-x1F are writed only if not empty

        #~ if addr in RO_BLOCKS:

            #~ # checking if in the range of optional blocks

            #~ if addr >= 0x10 and addr <= 0x1F:

                #~ # block is empty ?

                #~ if data == EMPTY_BLOCK:

                    #~ # no write of this block

                    #~ # but we have to continue updating the counters

                    #~ count += 1

                    #~ raddr = count * 256

                    #~ continue

            #~ else:

                #~ count += 1

                #~ raddr = count * 256

                #~ continue

        #~ if data == EMPTY_BLOCK:

            #~ frame = _make_frame("Z", addr) + "\xFF"

        #~ else:

            #~ cs = _checksum(data)

            #~ frame = _make_frame("W", addr) + data + chr(cs)

        #~ _send(radio, frame)

        #~ # get the ACK

        #~ ack = _raw_recv(radio, 1)

        #~ _check_write_ack(radio, ack, addr)

        #~ # DEBUG

        #~ LOG.debug("Sending block %02x" % addr)

        #~ # UI Update

        #~ status.cur = count

        #~ radio.status_fn(status)

        #~ count += 1

        #~ raddr = count * 256

    #~ _close_radio(radio)

def model_match(cls, data):

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

    rid = data[0xA7:0xAE]

    if (rid in cls.VARIANTS):

        # correct model

        return True

    else:

        return False

class Kenwood60GBankModel(chirp_common.BankModel):

    """Testing the bank model on kennwood"""

    channelAlwaysHasBank = True

    def get_num_mappings(self):

        return self._radio._num_banks

    def get_mappings(self):

        banks = []

        for i in range(0, self._radio._num_banks):

            bindex = i + 1

            bank = self._radio._bclass(self, i, "%03i" % bindex)

            bank.index = i

            banks.append(bank)

        return banks

    def add_memory_to_mapping(self, memory, bank):

        self._radio._set_bank(memory.number, bank.index)

    def remove_memory_from_mapping(self, memory, bank):

        if self._radio._get_bank(memory.number) != bank.index:

            raise Exception("Memory %i not in bank %s. Cannot remove." %

                            (memory.number, bank))

        # We can't "Remove" it for good

        # the kenwood paradigm don't allow it

        # instead we move it to bank 0

        self._radio._set_bank(memory.number, 0)

    def get_mapping_memories(self, bank):

        memories = []

        for i in range(0, self._radio._upper):

            if self._radio._get_bank(i) == bank.index:

                memories.append(self._radio.get_memory(i))

        return memories

    def get_memory_mappings(self, memory):

        index = self._radio._get_bank(memory.number)

        return [self.get_mappings()[index]]

class memBank(chirp_common.Bank):

    """A bank model for kenwood"""

    # Integral index of the bank (not to be confused with per-memory

    # bank indexes

    index = 0

class Kenwood_Serie_80(chirp_common.CloneModeRadio):

    """Kenwood Serie 80 Radios base class"""

    VENDOR = "Kenwood"

    BAUD_RATE = 9600

    _memsize = MEM_SIZE

    NAME_LENGTH = 8

    _range = [136000000, 174000000]

    _upper = 250

    _chs_progs = 0

    _num_banks = 250

    _bclass = memBank

    _kind = ""

    VARIANT = ""

    MODEL = ""

    @classmethod

    def get_prompts(cls):

        rp = chirp_common.RadioPrompts()

        rp.experimental = \

            ('This driver is experimental and for personal use only.'

             'It has a limited set of features, but the most used.'

             ''

             'The most notorius missing features are this:'

             '=> PTT ID, in fact it is disabled if detected'

             '=> Priority / Home channel'

             '=> Bank names'

             '=> Others'

             ''

             'If you need one of this, get your official software to do it'

             'and raise and issue on the chirp site about it and maybe'

             'it will be implemented in the future.'

             ''

             'The band limits on some of this radios are set here far from'

             'the vendor limits to cover most of the ham bands. It is a'

             'known fact that this radios can work safely outside the OEM'

             'limits, but each radio is different, you may find in trouble'

             'with some particular radios, but this is also possible with'

             'the OEM software; as usual YMMV.'

             ''

             'A detail: this driver is slow reading from the radio in'

             'Windows, due to the way windows serial works.'

             )

        rp.pre_download = _(dedent("""\

            Follow this instructions to download your info:

            1 - Turn off your radio

            2 - Connect your interface cable

            3 - Turn on your radio (unblock it if password protected)

            4 - Do the download of your radio data

            """))

        rp.pre_upload = _(dedent("""\

            Follow this instructions to upload your info:

            1 - Turn off your radio

            2 - Connect your interface cable

            3 - Turn on your radio (unblock it if password protected)

            4 - Do the upload of your radio data

            """))

        return rp

    def get_features(self):

        """Return information about this radio's features"""

        rf = chirp_common.RadioFeatures()

        rf.has_settings = True

        rf.has_bank = True

        rf.has_tuning_step = False

        rf.has_name = True

        rf.has_offset = True

        rf.has_mode = True

        rf.has_dtcs = True

        rf.has_rx_dtcs = True

        rf.has_dtcs_polarity = True

        rf.has_ctone = True

        rf.has_cross = True

        rf.valid_modes = MODES

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

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

        rf.valid_cross_modes = [

            "Tone->Tone",

            "DTCS->",

            "->DTCS",

            "Tone->DTCS",

            "DTCS->Tone",

            "->Tone",

            "DTCS->DTCS"]

        rf.valid_power_levels = POWER_LEVELS

        rf.valid_characters = VALID_CHARS

        rf.valid_skips = SKIP_VALUES

        rf.valid_dtcs_codes = DTCS_CODES

        rf.valid_bands = [self._range]

        rf.valid_name_length = 8

        rf.memory_bounds = (1, self._upper)

        return rf

    def _fill(self, offset, data):

        """Fill an specified area of the memmap with the passed data"""

        for addr in range(0, len(data)):

            self._mmap[offset + addr] = data[addr]

    def _prep_data(self):

        """Prepare the areas in the memmap to do a consistend write

        it has to make an update on the x300 area with banks and channel

        info; other in the x1000 with banks and channel counts

        and a last one in x7000 with flag data"""

        rchs = 0

        data = dict()

        # sorting the data

        for ch in range(0, self._upper):

            mem = self._memobj.memory[ch]

            bnumb = int(mem.bnumb)

            bank = int(mem.bank)

            if bnumb != 255 and (bank != 255 and bank != 0):

                try:

                    data[bank].append(ch)

                except:

                    data[bank] = list()

                    data[bank].append(ch)

                data[bank].sort()

                # counting the real channels

                rchs = rchs + 1

        # updating the channel/bank count

        self._memobj.settings.channels = rchs

        self._chs_progs = rchs

        self._memobj.settings.banks = len(data)

        # building the data for the memmap

        fdata = ""

        for k, v in data.iteritems():

            # posible bad data

            if k == 0:

                k = 1

                raise errors.InvalidValueError(

                    "Invalid bank value '%k', bad data in the image? \

                    Triying to fix this, review your bank data!" % k)

            c = 1

            for i in v:

                fdata += chr(k) + chr(c) + chr(k - 1) + chr(i)

                c = c + 1

        # fill to match a full 256 bytes block

        fdata += (len(fdata) % 256) * "\xFF"

        # updating the data in the memmap [x300]

        self._fill(0x300, fdata)

        # update the info in x1000; it has 2 bytes with

        # x00 = bank , x01 = bank's channel count

        # the rest of the 14 bytes are \xff

        bdata = ""

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

            line = chr(i) + chr(len(data[i]))

            line += "\xff" * 14

            bdata += line

        # fill to match a full 256 bytes block

        bdata += (256 - (len(bdata)) % 256) * "\xFF"

        # fill to match the whole area

        bdata += (16 - len(bdata) / 256) * EMPTY_BLOCK

        # updating the data in the memmap [x1000]

        self._fill(0x1000, bdata)

        # DTMF id for each channel, 5 bytes lbcd at x7000

        # ############## TODO ###################

        fldata = "\x00\xf0\xff\xff\xff" * self._chs_progs + \

            "\xff" * (5 * (self._upper - self._chs_progs))

        # write it

        # updating the data in the memmap [x7000]

        self._fill(0x7000, fldata)

    def _set_variant(self):

        """Select and set the correct variables for the class acording

        to the correct variant of the radio"""

        rid = self._mmap[0xA7:0xAE]

        # indentify the radio variant and set the enviroment to it's values

        try:

            self._upper, low, high, self._kind = self.VARIANTS[rid]

            self._range = [low * 1000000, high * 1000000]

            # setting the bank data in the features, 8 & 16 CH dont have banks

            if self._upper < 32:

                rf = chirp_common.RadioFeatures()

                rf.has_bank = False

            # put the VARIANT in the class, clean the model / CHs / Type

            # in the same layout as the KPG program

            self._VARIANT = self.MODEL + " [" + str(self._upper) + "CH]: "

            self._VARIANT += self._kind + ", " + str(self._range[0]/1000000) + "-"

            self._VARIANT += str(self._range[1]/1000000) + " Mhz"

        except KeyError:

            LOG.debug("Wrong Kenwood radio, ID or unknown variant")

            LOG.debug(util.hexprint(rid))

            raise errors.RadioError(

                "Wrong Kenwood radio, ID or unknown variant, see LOG output.")

            return False

    def sync_in(self):

        """Do a download of the radio eeprom"""

        self._mmap = do_download(self)

        self.process_mmap()

    def sync_out(self):

        """Do an upload to the radio eeprom"""

        # chirp signature on the eprom ;-)

        sign = "Chirp"

        self._fill(0xbb, sign)

        try:

            self._prep_data()

            do_upload(self)

        except errors.RadioError:

            raise

        except Exception, e:

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

    def process_mmap(self):

        """Process the memory object"""

        # how many channels are programed

        self._chs_progs = ord(self._mmap[15])

        # load the memobj

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

        # to set the vars on the class to the correct ones

        self._set_variant()

    def get_raw_memory(self, number):

        """Return a raw representation of the memory object, which

        is very helpful for development"""

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

    def _decode_tone(self, val):

        """Parse the tone data to decode from mem, it returns:

        Mode (''|DTCS|Tone), Value (None|###), Polarity (None,N,R)"""

        val = int(val)

        if val == 65535:

            return '', None, None

        elif val >= 0x2800:

            code = int("%03o" % (val & 0x07FF))

            pol = (val & 0x8000) and "R" or "N"

            return 'DTCS', code, pol

        else:

            a = val / 10.0