aboutsummaryrefslogtreecommitdiffstats
path: root/awlsim/common/cpuconfig.py
blob: 70e7a0a3ac8b29cf39e67a507d7179827eb2d594 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
# -*- coding: utf-8 -*-
#
# AWL simulator - CPU core configuration
#
# Copyright 2012-2020 Michael Buesch <m@bues.ch>
#
# 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 division, absolute_import, print_function, unicode_literals
#from awlsim.common.cython_support cimport * #@cy
from awlsim.common.compat import *

from awlsim.common.util import *
from awlsim.common.enumeration import *
from awlsim.common.exceptions import *


__all__ = [
	"S7CPUConfig",
]


class S7CPUConfig(object):
	"""STEP 7 CPU core configuration.
	"""

	__slots__ = (
		"cpu",
		"__configuredMnemonics",
		"__detectedMnemonics",
		"clockMemByte",
		"cycleTimeLimitUs",
		"cycleTimeTargetUs",
		"runTimeLimitUs",
		"extInsnsEn",
		"obStartinfoEn",
	)

	# Mnemonic identifiers
	# Note: These numbers are .awlpro file ABI.
	EnumGen.start
	MNEMONICS_AUTO			= EnumGen.item
	MNEMONICS_EN			= EnumGen.item
	MNEMONICS_DE			= EnumGen.item
	EnumGen.end

	DEFAULT_MNEMONICS		= MNEMONICS_AUTO
	DEFAULT_CLOCKMEM		= -1
	DEFAULT_CYCLETIMELIMIT_US	= 1 * 1000 * 1000
	DEFAULT_CYCLETIMETARGET_US	= 0
	DEFAULT_RUNTIMELIMIT_US		= -1
	DEFAULT_EXTINSNS_EN		= False
	DEFAULT_OBSTARTINFO_EN		= False

	def __init__(self, cpu=None):
		self.cpu = None
		self.setConfiguredMnemonics(self.DEFAULT_MNEMONICS)
		self.setClockMemByte(self.DEFAULT_CLOCKMEM)
		self.setCycleTimeLimitUs(self.DEFAULT_CYCLETIMELIMIT_US)
		self.setCycleTimeTargetUs(self.DEFAULT_CYCLETIMETARGET_US)
		self.setRunTimeLimitUs(self.DEFAULT_RUNTIMELIMIT_US)
		self.setExtInsnsEn(self.DEFAULT_EXTINSNS_EN)
		self.setOBStartinfoEn(self.DEFAULT_OBSTARTINFO_EN)
		self.cpu = cpu

	def assignFrom(self, otherCpuConfig):
		self.setConfiguredMnemonics(otherCpuConfig.getConfiguredMnemonics())
		self.setClockMemByte(otherCpuConfig.clockMemByte)
		self.setCycleTimeLimitUs(otherCpuConfig.cycleTimeLimitUs)
		self.setCycleTimeTargetUs(otherCpuConfig.cycleTimeTargetUs)
		self.setRunTimeLimitUs(otherCpuConfig.runTimeLimitUs)
		self.setExtInsnsEn(otherCpuConfig.extInsnsEn)
		self.setOBStartinfoEn(otherCpuConfig.obStartinfoEn)

	def __copy__(self):
		new = self.__class__()
		new.assignFrom(self)
		new.cpu = self.cpu
		return new

	def __deepcopy__(self, memo):
		raise NotImplementedError

	def setConfiguredMnemonics(self, mnemonics):
		if mnemonics not in (self.MNEMONICS_AUTO,
				     self.MNEMONICS_EN,
				     self.MNEMONICS_DE):
			raise AwlSimError("Invalid mnemonics configuration: %d" % mnemonics) #@nocov
		self.__configuredMnemonics = mnemonics
		self.setDetectedMnemonics(self.MNEMONICS_AUTO)

	def setDetectedMnemonics(self, mnemonics):
		self.__detectedMnemonics = mnemonics

	def getConfiguredMnemonics(self):
		return self.__configuredMnemonics

	def getMnemonics(self):
		if self.__configuredMnemonics == self.MNEMONICS_AUTO:
			return self.__detectedMnemonics
		return self.__configuredMnemonics

	def setClockMemByte(self, byteAddress):
		self.clockMemByte = byteAddress
		if self.cpu:
			self.cpu.initClockMemState()

	def setCycleTimeLimitUs(self, microseconds):
		self.cycleTimeLimitUs = clamp(microseconds, 0, 0x7FFFFFFF)
		if self.cpu:
			seconds = float(microseconds) / 1000000.0
			self.cpu.setCycleTimeLimit(seconds)

	def setCycleTimeTargetUs(self, microseconds):
		self.cycleTimeTargetUs = clamp(microseconds, 0, 0x7FFFFFFF)
		if self.cpu:
			seconds = float(microseconds) / 1000000.0
			self.cpu.setCycleTimeTarget(seconds)

	def setRunTimeLimitUs(self, microseconds):
		self.runTimeLimitUs = clamp(microseconds, -1, 0x7FFFFFFF)
		if self.cpu:
			seconds = -1.0
			if microseconds >= 0:
				seconds = float(microseconds) / 1000000.0
			self.cpu.setRunTimeLimit(seconds)

	def setExtInsnsEn(self, extInsnsEnabled):
		self.extInsnsEn = extInsnsEnabled
		if self.cpu:
			self.cpu.enableExtendedInsns(extInsnsEnabled)

	def setOBStartinfoEn(self, obStartinfoEnabled):
		self.obStartinfoEn = obStartinfoEnabled
		if self.cpu:
			self.cpu.enableObTempPresets(obStartinfoEnabled)
bues.ch cgit interface