1

#!/usr/bin/env python

     2

# -*- coding: utf-8 -*-

     3

     4

# This file is part of Beremiz, a Integrated Development Environment for

     5

# programming IEC 61131-3 automates supporting plcopen standard and CanFestival.

     6

#

     7

# Copyright (C) 2007: Edouard TISSERANT and Laurent BESSARD

     8

#

     9

# See COPYING file for copyrights details.

    10

#

    11

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

    12

# modify it under the terms of the GNU General Public License

    13

# as published by the Free Software Foundation; either version 2

    14

# of the License, or (at your option) any later version.

    15

#

    16

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

    17

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

    18

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    19

# GNU General Public License for more details.

    20

#

    21

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

    22

# along with this program; if not, write to the Free Software

    23

# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

    24

    25

from types import *

    26

    27

# Translation between IEC types and Can Open types

    28

IECToCOType = {

    29

    "BOOL":    0x01,

    30

    "SINT":    0x02,

    31

    "INT":     0x03,

    32

    "DINT":    0x04,

    33

    "LINT":    0x10,

    34

    "USINT":   0x05,

    35

    "UINT":    0x06,

    36

    "UDINT":   0x07,

    37

    "ULINT":   0x1B,

    38

    "REAL":    0x08,

    39

    "LREAL":   0x11,

    40

    "STRING":  0x09,

    41

    "BYTE":    0x05,

    42

    "WORD":    0x06,

    43

    "DWORD":   0x07,

    44

    "LWORD":   0x1B,

    45

    "WSTRING": 0x0B

    46

}

    47

    48

# Constants for PDO types

    49

RPDO = 1

    50

TPDO = 2

    51

    52

SlavePDOType = {"I": TPDO, "Q": RPDO}

    53

InvertPDOType = {RPDO: TPDO, TPDO: RPDO}

    54

PDOTypeBaseIndex = {RPDO: 0x1400, TPDO: 0x1800}

    55

PDOTypeBaseCobId = {RPDO: 0x200, TPDO: 0x180}

    56

    57

VariableIncrement = 0x100

    58

VariableStartIndex = {TPDO: 0x2000, RPDO: 0x4000}

    59

VariableDirText = {TPDO: "__I", RPDO: "__Q"}

    60

VariableTypeOffset = dict(zip(["", "X", "B", "W", "D", "L"], range(6)))

    61

    62

TrashVariables = [(1, 0x01), (8, 0x05), (16, 0x06), (32, 0x07), (64, 0x1B)]

    63

    64

#-------------------------------------------------------------------------------

    65

#                  Specific exception for PDO mapping errors

    66

#-------------------------------------------------------------------------------

    67

    68

    69

class PDOmappingException(Exception):

    70

    pass

    71

    72

    73

def LE_to_BE(value, size):

    74

    """

    75

    Convert Little Endian to Big Endian

    76

    @param value: value expressed in integer

    77

    @param size: number of bytes generated

    78

    @return: a string containing the value converted

    79

    """

    80

    81

    data = ("%" + str(size * 2) + "." + str(size * 2) + "X") % value

    82

    list_car = [data[i:i+2] for i in xrange(0, len(data), 2)]

    83

    list_car.reverse()

    84

    return "".join([chr(int(car, 16)) for car in list_car])

    85

    86

    87

def GetNodePDOIndexes(node, type, parameters=False):

    88

    """

    89

    Find the PDO indexes of a node

    90

    @param node: node

    91

    @param type: type of PDO searched (RPDO or TPDO or both)

    92

    @param parameters: indicate which indexes are expected (PDO paramaters : True or PDO mappings : False)

    93

    @return: a list of indexes found

    94

    """

    95

    96

    indexes = []

    97

    if type & RPDO:

    98

        indexes.extend([idx for idx in node.GetIndexes() if 0x1400 <= idx <= 0x15FF])

    99

    if type & TPDO:

   100

        indexes.extend([idx for idx in node.GetIndexes() if 0x1800 <= idx <= 0x19FF])

   101

    if not parameters:

   102

        return [idx + 0x200 for idx in indexes]

   103

    else:

   104

        return indexes

   105

   106

   107

def SearchNodePDOMapping(loc_infos, node):

   108

    """

   109

    Find the PDO indexes of a node

   110

    @param node: node

   111

    @param type: type of PDO searched (RPDO or TPDO or both)

   112

    @param parameters: indicate which indexes are expected (PDO paramaters : True or PDO mappings : False)

   113

    @return: a list of indexes found

   114

    """

   115

   116

    model = (loc_infos["index"] << 16) + (loc_infos["subindex"] << 8)

   117

   118

    for PDOidx in GetNodePDOIndexes(node, loc_infos["pdotype"]):

   119

        values = node.GetEntry(PDOidx)

   120

        if values is not None:

   121

            for subindex, mapping in enumerate(values):

   122

                if subindex != 0 and mapping & 0xFFFFFF00 == model:

   123

                    return PDOidx, subindex

   124

    return None

   125

   126

   127

def GeneratePDOMappingDCF(idx, cobid, transmittype, pdomapping):

   128

    """

   129

    Build concise DCF value for configuring a PDO

   130

    @param idx: index of PDO parameters

   131

    @param cobid: PDO generated COB ID

   132

    @param transmittype : PDO transmit type

   133

    @param pdomapping: list of PDO mappings

   134

    @return: a tuple of value and number of parameters to add to DCF

   135

    """

   136

   137

    dcfdata = []

   138

    # Create entry for RPDO or TPDO parameters and Disable PDO

   139

    #           ---- INDEX -----   --- SUBINDEX ----   ----- SIZE ------   ------ DATA ------

   140

    dcfdata += [LE_to_BE(idx, 2) + LE_to_BE(0x01, 1) + LE_to_BE(0x04, 4) + LE_to_BE(0x80000000 + cobid, 4)]

   141

    # Set Transmit type

   142

    dcfdata += [LE_to_BE(idx, 2) + LE_to_BE(0x02, 1) + LE_to_BE(0x01, 4) + LE_to_BE(transmittype, 1)]

   143

    if len(pdomapping) > 0:

   144

        # Disable Mapping

   145

        dcfdata += [LE_to_BE(idx + 0x200, 2) + LE_to_BE(0x00, 1) + LE_to_BE(0x01, 4) + LE_to_BE(0x00, 1)]

   146

        # Map Variables

   147

        for subindex, (name, loc_infos) in enumerate(pdomapping):

   148

            value = (loc_infos["index"] << 16) + (loc_infos["subindex"] << 8) + loc_infos["size"]

   149

            dcfdata += [LE_to_BE(idx + 0x200, 2) + LE_to_BE(subindex + 1, 1) + LE_to_BE(0x04, 4) + LE_to_BE(value, 4)]

   150

        # Re-enable Mapping

   151

        dcfdata += [LE_to_BE(idx + 0x200, 2) + LE_to_BE(0x00, 1) + LE_to_BE(0x01, 4) + LE_to_BE(len(pdomapping), 1)]

   152

    # Re-Enable PDO

   153

    dcfdata += [LE_to_BE(idx, 2) + LE_to_BE(0x01, 1) + LE_to_BE(0x04, 4) + LE_to_BE(cobid, 4)]

   154

    return "".join(dcfdata), len(dcfdata)

   155

   156

   157

class ConciseDCFGenerator:

   158

   159

    def __init__(self, nodelist, nodename):

   160

        # Dictionary of location informations classed by name

   161

        self.IECLocations = {}

   162

        # Dictionary of location that have not been mapped yet

   163

        self.LocationsNotMapped = {}

   164

        # Dictionary of location informations classed by name

   165

        self.MasterMapping = {}

   166

        # List of COB IDs available

   167

        self.ListCobIDAvailable = range(0x180, 0x580)

   168

        # Dictionary of mapping value where unexpected variables are stored

   169

        self.TrashVariables = {}

   170

        # Dictionary of pointed variables

   171

        self.PointedVariables = {}

   172

   173

        self.NodeList = nodelist

   174

        self.Manager = self.NodeList.Manager

   175

        self.MasterNode = self.Manager.GetCurrentNodeCopy()

   176

        self.MasterNode.SetNodeName(nodename)

   177

        self.PrepareMasterNode()

   178

   179

    def GetPointedVariables(self):

   180

        return self.PointedVariables

   181

   182

    def RemoveUsedNodeCobId(self, node):

   183

        """

   184

        Remove all PDO COB ID used by the given node from the list of available COB ID

   185

        @param node: node

   186

        @return: a tuple of number of RPDO and TPDO for the node

   187

        """

   188

   189

        # Get list of all node TPDO and RPDO indexes

   190

        nodeRpdoIndexes = GetNodePDOIndexes(node, RPDO, True)

   191

        nodeTpdoIndexes = GetNodePDOIndexes(node, TPDO, True)

   192

   193

        # Mark all the COB ID of the node already mapped PDO as not available

   194

        for PdoIdx in nodeRpdoIndexes + nodeTpdoIndexes:

   195

            pdo_cobid = node.GetEntry(PdoIdx, 0x01)

   196

            # Extract COB ID, if PDO isn't active

   197

            if pdo_cobid > 0x600:

   198

                pdo_cobid -= 0x80000000

   199

            # Remove COB ID from the list of available COB ID

   200

            if pdo_cobid in self.ListCobIDAvailable:

   201

                self.ListCobIDAvailable.remove(pdo_cobid)

   202

   203

        return len(nodeRpdoIndexes), len(nodeTpdoIndexes)

   204

   205

    def PrepareMasterNode(self):

   206

        """

   207

        Add mandatory entries for DCF generation into MasterNode.

   208

        """

   209

   210

        # Adding DCF entry into Master node

   211

        if not self.MasterNode.IsEntry(0x1F22):

   212

            self.MasterNode.AddEntry(0x1F22, 1, "")

   213

        self.Manager.AddSubentriesToCurrent(0x1F22, 127, self.MasterNode)

   214

   215

        # Adding trash mappable variables for unused mapped datas

   216

        idxTrashVariables = 0x2000 + self.MasterNode.GetNodeID()

   217

        # Add an entry for storing unexpected all variable

   218

        self.Manager.AddMapVariableToCurrent(idxTrashVariables, self.MasterNode.GetNodeName()+"_trashvariables", 3, len(TrashVariables), self.MasterNode)

   219

        for subidx, (size, typeidx) in enumerate(TrashVariables):

   220

            # Add a subentry for storing unexpected variable of this size

   221

            self.Manager.SetCurrentEntry(idxTrashVariables, subidx + 1, "TRASH%d" % size, "name", None, self.MasterNode)

   222

            self.Manager.SetCurrentEntry(idxTrashVariables, subidx + 1, typeidx, "type", None, self.MasterNode)

   223

            # Store the mapping value for this entry

   224

            self.TrashVariables[size] = (idxTrashVariables << 16) + ((subidx + 1) << 8) + size

   225

   226

        RPDOnumber, TPDOnumber = self.RemoveUsedNodeCobId(self.MasterNode)

   227

   228

        # Store the indexes of the first RPDO and TPDO available for MasterNode

   229

        self.CurrentPDOParamsIdx = {RPDO: 0x1400 + RPDOnumber, TPDO: 0x1800 + TPDOnumber}

   230

   231

        # Prepare MasterNode with all nodelist slaves

   232

        for idx, (nodeid, nodeinfos) in enumerate(self.NodeList.SlaveNodes.items()):

   233

            node = nodeinfos["Node"]

   234

            node.SetNodeID(nodeid)

   235

   236

            RPDOnumber, TPDOnumber = self.RemoveUsedNodeCobId(node)

   237

   238

            # Get Slave's default SDO server parameters

   239

            RSDO_cobid = node.GetEntry(0x1200, 0x01)

   240

            if not RSDO_cobid:

   241

                RSDO_cobid = 0x600 + nodeid

   242

            TSDO_cobid = node.GetEntry(0x1200, 0x02)

   243

            if not TSDO_cobid:

   244

                TSDO_cobid = 0x580 + nodeid

   245

   246

            # Configure Master's SDO parameters entries

   247

            self.Manager.ManageEntriesOfCurrent([0x1280 + idx], [], self.MasterNode)

   248

            self.MasterNode.SetEntry(0x1280 + idx, 0x01, RSDO_cobid)

   249

            self.MasterNode.SetEntry(0x1280 + idx, 0x02, TSDO_cobid)

   250

            self.MasterNode.SetEntry(0x1280 + idx, 0x03, nodeid)

   251

   252

    def GetMasterNode(self):

   253

        """

   254

        Return MasterNode.

   255

        """

   256

        return self.MasterNode

   257

   258

    def AddParamsToDCF(self, nodeid, data, nbparams):

   259

        """

   260

        Add entry to DCF, for the requested nodeID

   261

        @param nodeid: id of the slave (int)

   262

        @param data: data to add to slave DCF (string)

   263

        @param nbparams: number of params added to slave DCF (int)

   264

        """

   265

        # Get current DCF for slave

   266

        nodeDCF = self.MasterNode.GetEntry(0x1F22, nodeid)

   267

   268

        # Extract data and number of params in current DCF

   269

        if nodeDCF is not None and nodeDCF != '':

   270

            tmpnbparams = [i for i in nodeDCF[:4]]

   271

            tmpnbparams.reverse()

   272

            nbparams += int(''.join(["%2.2x" % ord(i) for i in tmpnbparams]), 16)

   273

            data = nodeDCF[4:] + data

   274

   275

        # Build new DCF

   276

        dcf = LE_to_BE(nbparams, 0x04) + data

   277

        # Set new DCF for slave

   278

        self.MasterNode.SetEntry(0x1F22, nodeid, dcf)

   279

   280

    def GetEmptyPDO(self, nodeid, pdotype, start_index=None):

   281

        """

   282

        Search a not configured PDO for a slave

   283

        @param node: the slave node object

   284

        @param pdotype: type of PDO to generated (RPDO or TPDO)

   285

        @param start_index: Index where search must start (default: None)

   286

        @return tuple of PDO index, COB ID and number of subindex defined

   287

        """

   288

        # If no start_index defined, start with PDOtype base index

   289

        if start_index is None:

   290

            index = PDOTypeBaseIndex[pdotype]

   291

        else:

   292

            index = start_index

   293

   294

        # Search for all PDO possible index until find a configurable PDO

   295

        # starting from start_index

   296

        while index < PDOTypeBaseIndex[pdotype] + 0x200:

   297

            values = self.NodeList.GetSlaveNodeEntry(nodeid, index + 0x200)

   298

            if values is not None and values[0] > 0:

   299

                # Check that all subindex upper than 0 equal 0 => configurable PDO

   300

                if reduce(lambda x, y: x and y, map(lambda x: x == 0, values[1:]), True):

   301

                    cobid = self.NodeList.GetSlaveNodeEntry(nodeid, index, 1)

   302

                    # If no COB ID defined in PDO, generate a new one (not used)

   303

                    if cobid == 0:

   304

                        if len(self.ListCobIDAvailable) == 0:

   305

                            return None

   306

                        # Calculate COB ID from standard values

   307

                        if index < PDOTypeBaseIndex[pdotype] + 4:

   308

                            cobid = PDOTypeBaseCobId[pdotype] + 0x100 * (index - PDOTypeBaseIndex[pdotype]) + nodeid

   309

                        if cobid not in self.ListCobIDAvailable:

   310

                            cobid = self.ListCobIDAvailable.pop(0)

   311

                    return index, cobid, values[0]

   312

            index += 1

   313

        return None

   314

   315

    def AddPDOMapping(self, nodeid, pdotype, pdoindex, pdocobid, pdomapping, sync_TPDOs):

   316

        """

   317

        Record a new mapping request for a slave, and add related slave config to the DCF

   318

        @param nodeid: id of the slave (int)

   319

        @param pdotype: type of PDO to generated (RPDO or TPDO)

   320

        @param pdomapping: list od variables to map with PDO

   321

        """

   322

        # Add an entry to MasterMapping

   323

        self.MasterMapping[pdocobid] = {"type": InvertPDOType[pdotype],

   324

            "mapping": [None] + [(loc_infos["type"], name) for name, loc_infos in pdomapping]}

   325

   326

        # Return the data to add to DCF

   327

        if sync_TPDOs:

   328

            return GeneratePDOMappingDCF(pdoindex, pdocobid, 0x01, pdomapping)

   329

        else:

   330

            return GeneratePDOMappingDCF(pdoindex, pdocobid, 0xFF, pdomapping)

   331

        return 0, ""

   332

   333

    def GenerateDCF(self, locations, current_location, sync_TPDOs):

   334

        """

   335

        Generate Concise DCF of MasterNode for the locations list given

   336

        @param locations: list of locations to be mapped

   337

        @param current_location: tuple of the located prefixes not to be considered

   338

        @param sync_TPDOs: indicate if TPDO must be synchronous

   339

        """

   340

   341

        #-------------------------------------------------------------------------------

   342

        #               Verify that locations correspond to real slave variables

   343

        #-------------------------------------------------------------------------------

   344

   345

        # Get list of locations check if exists and mappables -> put them in IECLocations

   346

        for location in locations:

   347

            COlocationtype = IECToCOType[location["IEC_TYPE"]]

   348

            name = location["NAME"]

   349

            if name in self.IECLocations:

   350

                if self.IECLocations[name]["type"] != COlocationtype:

   352

            else:

   353

                # Get only the part of the location that concern this node

   354

                loc = location["LOC"][len(current_location):]

   355

                # loc correspond to (ID, INDEX, SUBINDEX [,BIT])

   356

                if len(loc) not in (2, 3, 4):

   358

                elif len(loc) == 2:

   359

                    continue

   360

   361

                direction = location["DIR"]

   362

   363

                sizelocation = location["SIZE"]

   364

   365

                # Extract and check nodeid

   366

                nodeid, index, subindex = loc[:3]

   367

   368

                # Check Id is in slave node list

   369

                if nodeid not in self.NodeList.SlaveNodes.keys():

   373

   374

                # Get the model for this node (made from EDS)

   375

                node = self.NodeList.SlaveNodes[nodeid]["Node"]

   376

   377

                # Extract and check index and subindex

   378

                if not node.IsEntry(index, subindex):

   379

                    msg = _("No such index/subindex ({a1},{a2}) in ID : {a3} (variable {a4})").\

   380

                          format(a1="%x" % index, a2="%x" % subindex, a3=nodeid, a4=name)

   382

   383

                # Get the entry info

   384

                subentry_infos = node.GetSubentryInfos(index, subindex)

   385

   386

                # If a PDO mappable

   387

                if subentry_infos and subentry_infos["pdo"]:

   388

                    if sizelocation == "X" and len(loc) > 3:

   389

                        numbit = loc[3]

   390

                    elif sizelocation != "X" and len(loc) > 3:

   394

                    else:

   395

                        numbit = None

   396

   397

                    if location["IEC_TYPE"] != "BOOL" and subentry_infos["type"] != COlocationtype:

   404

   405

                    typeinfos = node.GetEntryInfos(COlocationtype)

   406

                    self.IECLocations[name] = {

   407

                        "type":         COlocationtype,

   408

                        "pdotype":      SlavePDOType[direction],

   409

                        "nodeid":       nodeid,

   410

                        "index":        index,

   411

                        "subindex":     subindex,

   412

                        "bit":          numbit,

   413

                        "size":         typeinfos["size"],

   414

                        "sizelocation": sizelocation

   415

                    }

   416

                else:

   420

   421

        #-------------------------------------------------------------------------------

   422

        #                         Search for locations already mapped

   423

        #-------------------------------------------------------------------------------

   424

   425

        for name, locationinfos in self.IECLocations.items():

   426

            node = self.NodeList.SlaveNodes[locationinfos["nodeid"]]["Node"]

   427

   428

            # Search if slave has a PDO mapping this locations

   429

            result = SearchNodePDOMapping(locationinfos, node)

   430

            if result is not None:

   431

                index, subindex = result

   432

                # Get COB ID of the PDO

   433

                cobid = self.NodeList.GetSlaveNodeEntry(locationinfos["nodeid"], index - 0x200, 1)

   434

   435

                # Add PDO to MasterMapping

   436

                if cobid not in self.MasterMapping.keys():

   437

                    # Verify that PDO transmit type is conform to sync_TPDOs

   438

                    transmittype = self.NodeList.GetSlaveNodeEntry(locationinfos["nodeid"], index - 0x200, 2)

   439

                    if sync_TPDOs and transmittype != 0x01 or transmittype != 0xFF:

   440

                        if sync_TPDOs:

   441

                            # Change TransmitType to SYNCHRONE

   442

                            data, nbparams = GeneratePDOMappingDCF(index - 0x200, cobid, 0x01, [])

   443

                        else:

   444

                            # Change TransmitType to ASYCHRONE

   445

                            data, nbparams = GeneratePDOMappingDCF(index - 0x200, cobid, 0xFF, [])

   446

   447

                        # Add entry to slave dcf to change transmit type of

   448

                        self.AddParamsToDCF(locationinfos["nodeid"], data, nbparams)

   449

   450

                    mapping = [None]

   451

                    values = node.GetEntry(index)

   452

                    # Store the size of each entry mapped in PDO

   453

                    for value in values[1:]:

   454

                        if value != 0:

   455

                            mapping.append(value % 0x100)

   456

                    self.MasterMapping[cobid] = {"type": InvertPDOType[locationinfos["pdotype"]], "mapping": mapping}

   457

   458

                # Indicate that this PDO entry must be saved

   459

                if locationinfos["bit"] is not None:

   460

                    if not isinstance(self.MasterMapping[cobid]["mapping"][subindex], ListType):

   461

                        self.MasterMapping[cobid]["mapping"][subindex] = [1] * self.MasterMapping[cobid]["mapping"][subindex]

   462

                    if locationinfos["bit"] < len(self.MasterMapping[cobid]["mapping"][subindex]):

   463

                        self.MasterMapping[cobid]["mapping"][subindex][locationinfos["bit"]] = (locationinfos["type"], name)

   464

                else:

   465

                    self.MasterMapping[cobid]["mapping"][subindex] = (locationinfos["type"], name)

   466

   467

            else:

   468

                # Add location to those that haven't been mapped yet

   469

                if locationinfos["nodeid"] not in self.LocationsNotMapped.keys():

   470

                    self.LocationsNotMapped[locationinfos["nodeid"]] = {TPDO: [], RPDO: []}

   471

                self.LocationsNotMapped[locationinfos["nodeid"]][locationinfos["pdotype"]].append((name, locationinfos))

   472

   473

        #-------------------------------------------------------------------------------

   474

        #                         Build concise DCF for the others locations

   475

        #-------------------------------------------------------------------------------

   476

   477

        for nodeid, locations in self.LocationsNotMapped.items():

   478

            node = self.NodeList.SlaveNodes[nodeid]["Node"]

   479

   480

            # Initialize number of params and data to add to node DCF

   481

            nbparams = 0

   482

            dataparams = ""

   483

   484

            # Generate the best PDO mapping for each type of PDO

   485

            for pdotype in (TPDO, RPDO):

   486

                if len(locations[pdotype]) > 0:

   487

                    pdosize = 0

   488

                    pdomapping = []

   489

                    result = self.GetEmptyPDO(nodeid, pdotype)

   490

                    if result is None:

   493

                    pdoindex, pdocobid, pdonbparams = result

   494

                    for name, loc_infos in locations[pdotype]:

   495

                        pdosize += loc_infos["size"]

   496

                        # If pdo's size > 64 bits

   497

                        if pdosize > 64 or len(pdomapping) >= pdonbparams:

   498

                            # Generate a new PDO Mapping

   499

                            data, nbaddedparams = self.AddPDOMapping(nodeid, pdotype, pdoindex, pdocobid, pdomapping, sync_TPDOs)