aboutsummaryrefslogtreecommitdiffstats
path: root/awlsim/common/hwmod.py
blob: bb935e9b45cec8a199da81f4060df52f3de5351e (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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
# -*- coding: utf-8 -*-
#
# AWL simulator - Hardware module descriptors
#
# Copyright 2014-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.xmlfactory import *
from awlsim.common.util import *
from awlsim.common.exceptions import *

import hashlib
import binascii


__all__ = [
	"HwmodDescriptorFactory",
	"HwmodDescriptor",
]


class HwmodDescriptorFactory(XmlFactory):
	def parser_open(self, tag=None):
		hwmodDesc = self.hwmodDesc
		self.inParams = False
		self.inOneParam = False
		if tag:
			name = tag.getAttr("name")
			hwmodDesc.setModuleName(name)
		XmlFactory.parser_open(self, tag)

	def parser_beginTag(self, tag):
		hwmodDesc = self.hwmodDesc
		if self.inParams:
			if not self.inOneParam:
				if tag.name == "param":
					name = tag.getAttr("name")
					value = tag.getAttr("value", "")
					hwmodDesc.addParameter(name, value)
					self.inOneParam = True
					return
		else:
			if tag.name == "params":
				hwmodDesc.setParameters([])
				self.inParams = True
				return
		XmlFactory.parser_beginTag(self, tag)

	def parser_endTag(self, tag):
		if self.inParams:
			if self.inOneParam:
				if tag.name == "param":
					self.inOneParam = False
					return
			else:
				if tag.name == "params":
					self.inParams = False
					return
		else:
			if tag.name == "module":
				self.parser_finish()
				return
		XmlFactory.parser_endTag(self, tag)

	def composer_getTags(self):
		hwmodDesc = self.hwmodDesc

		childTags = []

		hwmodParams = sorted(dictItems(hwmodDesc.getParameters()),
				     key = lambda p: p[0])
		paramsTags = []
		for modParamName, modParamValue in hwmodParams:
			if modParamValue is None:
				modParamValue = ""
			paramsTags.append(self.Tag(name="param",
						   attrs={
				"name"	: str(modParamName),
				"value"	: str(modParamValue),
			}))
		childTags.append(self.Tag(name="params",
					  tags=paramsTags))

		tags = [self.Tag(name="module",
				 comment="\nLoaded hardware module",
				 tags=childTags,
				 attrs={
					"name"	: str(hwmodDesc.getModuleName()),
		})]
		return tags

class HwmodDescriptor(object):
	"""Hardware module descriptor."""

	factory = HwmodDescriptorFactory

	IDENT_HASH	= hashlib.sha256

	def __init__(self, moduleName, parameters = None):
		"""Hardware module descriptor initialization.
		moduleName -> module name string
		parameters -> parameter dict with
				keys -> parameter name
				values -> parameter value
		"""
		self.setModuleName(moduleName)
		self.setParameters(parameters)

	def dup(self):
		"""Duplicate this descriptor.
		"""
		return HwmodDescriptor(self.getModuleName(),
				       dict(self.getParameters()))

	def setModuleName(self, moduleName):
		"""Set the module name string.
		"""
		self.moduleName = moduleName
		self.__identHash = None

	def getModuleName(self):
		"""Get the module name string.
		"""
		return self.moduleName

	def setParameters(self, parameters):
		"""Set the parameters dict.
		"""
		if not parameters:
			parameters = {}
		self.parameters = {}
		for name, value in dictItems(parameters):
			self.addParameter(name, value)
		self.__identHash = None

	def addParameter(self, name, value):
		"""Add a parameter to the parameter dict.
		"""
		self.setParameterValue(name, value)

	def setParameterValue(self, name, value):
		"""Set the value of a parameter.
		"""
		if value is None:
			value = ""
		self.parameters[name] = value
		self.__identHash = None

	def removeParameter(self, name):
		"""Remove a parameter from the parameter dict.
		"""
		self.parameters.pop(name, None)
		self.__identHash = None

	def getParameters(self):
		"""Get the parameters dict (reference).
		"""
		return self.parameters

	def getParameter(self, name):
		"""Get one parameter by name.
		"""
		return self.parameters.get(name)

	def getIdentHash(self):
		"""Get the unique identification hash for this
		hardware module descriptor.
		"""
		if not self.__identHash:
			# Calculate the ident hash
			h = self.IDENT_HASH(b"HwmodDescriptor")
			h.update(self.moduleName.encode("utf-8", "ignore"))
			for pName, pValue in sorted(dictItems(self.parameters),
						    key = lambda item: item[0]):
				h.update(pName.encode("utf-8", "ignore"))
				h.update(str(pValue).encode("utf-8", "ignore"))
			self.__identHash = h.digest()
		return self.__identHash

	def getIdentHashStr(self):
		return binascii.b2a_hex(self.getIdentHash()).decode("ascii")

	def __eq__(self, other):
		return self.getIdentHash() == other.getIdentHash()

	def __ne__(self, other):
		return not self.__eq__(other)
bues.ch cgit interface