beremiz

Make online debug optional

2019-01-06, Andrey Skvortsov
eba2bbb2dd9a
Make online debug optional

It could be useful for very small targets like Atmega (Arduino) and
for target bring-up there developer want to have running PLC program,
but has not implemented runtime communication yet.


TARGET_DEBUG_AND_RETAIN_DISABLE - completely disable debug and retain
functionality. Previously named TARGET_DEBUG_DISABLE.

TARGET_ONLINE_DEBUG_DISABLE - can be used to enable retain
functionality (no define TARGET_DEBUG_AND_RETAIN_DISABLE is used), but disable
online debug with corresponding RAM/FLASH overhead.

TARGET_LOGGING_DISABLE - disables logging functionality from runtime and PLC program

TARGET_EXT_SYNC_DISABLE - disables PLC program synchronization with
external events. For example, it could be used to synchronize several
PLCs that control motors for different axes.

By default all these options are off.

To test generate program for Generic target, put following files in
project files directory and run build.sh after generating PLC program.
This is very easy to integrate into makefile (Generic target).

[------------- build.sh --------------------------]
files=$(find $PWD/../build -iname '*.c' | grep -v POUS.c)
arm-none-eabi-gcc \
-DTARGET_DEBUG_AND_RETAIN_DISABLE \
-DTARGET_ONLINE_DEBUG_DISABLE \
-DTARGET_LOGGING_DISABLE \
-DTARGET_EXT_SYNC_DISABLE \
-flto -ffunction-sections -fdata-sections -I../../../../matiec/lib/C \
$files \
main.c \
-Wl,--Map=./program.map,--cref \
-nodefaultlibs --specs=nano.specs -Wl,--static -Wl,--gc-section -Wl,--start-group -lc -lm -lnosys -lgcc -Wl,--end-group
[------------------------------------------------]

[------------- main.c --------------------------]
#ifndef TARGET_DEBUG_AND_RETAIN_DISABLE
void Retain(void){}
void InValidateRetainBuffer(void){}
void ValidateRetainBuffer(void){}
#endif

extern void __run(void);
int main(void)
{
for(;;) {
__run();
// sleep common_ticktime__ ns
// add common_ticktime__ ns to __CURRENT_TIME
}
return 0;
}
[------------------------------------------------]
#!/usr/bin/env python
# -*- coding: utf-8 -*-
# This file is part of Beremiz, a Integrated Development Environment for
# programming IEC 61131-3 automates supporting plcopen standard and CanFestival.
#
# Copyright (C) 2012: Edouard TISSERANT and Laurent BESSARD
# Copyright (C) 2017: Andrey Skvortsov <andrej.skvortzov@gmail.com>
#
# See COPYING file for copyrights details.
#
# 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, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
from __future__ import absolute_import
import wx
from plcopen.structures import TestIdentifier, IEC_KEYWORDS
from util.TranslationCatalogs import NoTranslate
class PouDialog(wx.Dialog):
"""
Dialog to create new POU.
It allows selection of POU type, name and
used IEC 61131-3 programming language
"""
POU_TYPES = None
POU_TYPES_DICT = None
POU_LANGUAGES = None
POU_LANGUAGES_DICT = None
def __init__(self, parent, pou_type=None, type_readonly=False):
wx.Dialog.__init__(self, id=-1, parent=parent,
name='PouDialog', title=_('Create a new POU'),
style=wx.DEFAULT_DIALOG_STYLE)
if PouDialog.POU_TYPES_DICT is None:
self.InitPouTypesDict()
self.InitPouLanguagesDict()
main_sizer = wx.FlexGridSizer(cols=1, hgap=0, rows=2, vgap=10)
main_sizer.AddGrowableCol(0)
main_sizer.AddGrowableRow(0)
infos_sizer = wx.FlexGridSizer(cols=2, hgap=5, rows=3, vgap=15)
infos_sizer.AddGrowableCol(1)
main_sizer.AddSizer(infos_sizer, border=20,
flag=wx.GROW | wx.TOP | wx.LEFT | wx.RIGHT)
pouname_label = wx.StaticText(self, label=_('POU Name:'))
infos_sizer.AddWindow(pouname_label, border=4,
flag=wx.ALIGN_CENTER_VERTICAL | wx.TOP)
self.PouName = wx.TextCtrl(self)
infos_sizer.AddWindow(self.PouName, flag=wx.GROW)
poutype_label = wx.StaticText(self, label=_('POU Type:'))
infos_sizer.AddWindow(poutype_label, border=4,
flag=wx.ALIGN_CENTER_VERTICAL | wx.TOP)
self.PouType = wx.ComboBox(self, style=wx.CB_READONLY)
self.Bind(wx.EVT_COMBOBOX, self.OnTypeChanged, self.PouType)
infos_sizer.AddWindow(self.PouType, flag=wx.GROW)
language_label = wx.StaticText(self, label=_('Language:'))
infos_sizer.AddWindow(language_label, border=4,
flag=wx.ALIGN_CENTER_VERTICAL | wx.TOP)
self.Language = wx.ComboBox(self, style=wx.CB_READONLY)
infos_sizer.AddWindow(self.Language, flag=wx.GROW)
button_sizer = self.CreateButtonSizer(wx.OK | wx.CANCEL | wx.CENTRE)
self.Bind(wx.EVT_BUTTON, self.OnOK, button_sizer.GetAffirmativeButton())
main_sizer.AddSizer(button_sizer, border=20,
flag=wx.ALIGN_RIGHT | wx.BOTTOM | wx.LEFT | wx.RIGHT)
self.SetSizer(main_sizer)
for option in self.POU_TYPES:
if not type_readonly or _(option) == _(pou_type):
self.PouType.Append(_(option))
if pou_type is not None:
self.PouType.SetStringSelection(_(pou_type))
self.RefreshLanguage()
self.Fit()
self.PouNames = []
self.PouElementNames = []
def InitPouTypes(self):
"""
Initialize POU_TYPES class list.
This list contains not translated POU types used in PLCopen XML.
_() are necessary so mk18n.py could find these string for localization.
"""
_ = NoTranslate
self.__class__.POU_TYPES = [_("function"), _("functionBlock"), _("program")]
def InitPouTypesDict(self):
"""
Initialize POU_TYPES_DICT class dictionary and POU_TYPE list
Dictionary contains localized POU types and they are shown in UI.
"""
self.InitPouTypes()
self.__class__.POU_TYPES_DICT = dict([(_(pou_type), pou_type)
for pou_type in self.POU_TYPES])
def InitPouLanguages(self):
"""
Initialize POU_LANGUAGES class list.
This list contains not translated programming languages used in PLCopen XML.
_() are necessary so mk18n.py could find these string for localization.
"""
_ = NoTranslate
self.__class__.POU_LANGUAGES = [_("IL"), _("ST"), _("LD"), _("FBD"), _("SFC")]
def InitPouLanguagesDict(self):
"""
Initialize POU_LANGUAGES_DICT class dictionary and POU_LANGUAGES list
Dictionary contains localized names for programming languages
as they are shown in UI.
"""
self.InitPouLanguages()
self.__class__.POU_LANGUAGES_DICT = dict([(_(language), language)
for language in self.POU_LANGUAGES])
def OnOK(self, event):
error = []
pou_name = self.PouName.GetValue()
if pou_name == "":
error.append(_("POU Name"))
if self.PouType.GetSelection() == -1:
error.append(_("POU Type"))
if self.Language.GetSelection() == -1:
error.append(_("Language"))
message = None
question = False
if len(error) > 0:
text = ""
for i, item in enumerate(error):
if i == 0:
text += item
elif i == len(error) - 1:
text += _(" and %s") % item
else:
text += _(", %s") % item
message = _("Form isn't complete. %s must be filled!") % text
elif not TestIdentifier(pou_name):
message = _("\"%s\" is not a valid identifier!") % pou_name
elif pou_name.upper() in IEC_KEYWORDS:
message = _("\"%s\" is a keyword. It can't be used!") % pou_name
elif pou_name.upper() in self.PouNames:
message = _("\"%s\" pou already exists!") % pou_name
elif pou_name.upper() in self.PouElementNames:
message = _("A POU has an element named \"%s\". This could cause a conflict. Do you wish to continue?") % pou_name
question = True
if message is not None:
if question:
dialog = wx.MessageDialog(self, message, _("Warning"), wx.YES_NO | wx.ICON_EXCLAMATION)
result = dialog.ShowModal()
dialog.Destroy()
if result == wx.ID_YES:
self.EndModal(wx.ID_OK)
else:
dialog = wx.MessageDialog(self, message, _("Error"), wx.OK | wx.ICON_ERROR)
dialog.ShowModal()
dialog.Destroy()
else:
self.EndModal(wx.ID_OK)
def RefreshLanguage(self):
selection = self.POU_LANGUAGES_DICT.get(self.Language.GetStringSelection(), "")
self.Language.Clear()
for language in self.POU_LANGUAGES:
if language != "SFC" or self.POU_TYPES_DICT[self.PouType.GetStringSelection()] != "function":
self.Language.Append(_(language))
if self.Language.FindString(_(selection)) != wx.NOT_FOUND:
self.Language.SetStringSelection(_(selection))
def OnTypeChanged(self, event):
self.RefreshLanguage()
event.Skip()
def SetPouNames(self, pou_names):
self.PouNames = [pou_name.upper() for pou_name in pou_names]
def SetPouElementNames(self, element_names):
self.PouElementNames = [element_name.upper() for element_name in element_names]
def SetValues(self, values):
for item, value in values.items():
if item == "pouName":
self.PouName.SetValue(value)
elif item == "pouType":
self.PouType.SetStringSelection(_(value))
elif item == "language":
self.Language.SetStringSelection(_(value))
def GetValues(self):
values = {}
values["pouName"] = self.PouName.GetValue()
values["pouType"] = self.POU_TYPES_DICT[self.PouType.GetStringSelection()]
values["language"] = self.POU_LANGUAGES_DICT[self.Language.GetStringSelection()]
return values