-
Notifications
You must be signed in to change notification settings - Fork 9
Expand file tree
/
Copy pathdriver.py
More file actions
246 lines (187 loc) · 7.21 KB
/
driver.py
File metadata and controls
246 lines (187 loc) · 7.21 KB
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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
#Distributed under the MIT licesnse.
#Copyright (c) 2011 Dave McCoy ([email protected])
#Permission is hereby granted, free of charge, to any person obtaining a copy of
#this software and associated documentation files (the "Software"), to deal in
#the Software without restriction, including without limitation the rights to
#use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
#of the Software, and to permit persons to whom the Software is furnished to do
#so, subject to the following conditions:
#
#The above copyright notice and this permission notice shall be included in all
#copies or substantial portions of the Software.
#
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
#IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
#FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
#AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
#LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
#OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
#SOFTWARE.
import sys
import os
import time
from array import array as Array
class Driver(object):
def __init__(self,
driver,
base_address,
debug):
self.driver = driver
self.debug = debug
self.base_addr = base_address
def __del__(self):
pass
def read_register(self, address):
"""read_register
Reads a single register from the read command and then converts it to an
integer
Args:
address (int): Address of the register/memory to read
Returns:
(int): 32-bit unsigned register value
Raises:
NysaCommError: Error in communication
"""
return self.read(address, 1)[0]
def read(self, address, length = 1):
"""read
Args:
length (int): Number of 32 bit words to read from the FPGA
address (int): Address of the register/memory to read
Returns:
(Array of unsigned bytes): A byte array containtin the raw data
returned from Nysa
Raises:
NysaCommError: Error in communication
"""
address = int((self.base_addr + address) >> 2)
return self.driver.read(address, length)
def write_register(self, address, value):
"""write_register
Writes a single register from a 32-bit unsingned integer
Args:
address (int): Address of the register/memory to read
value (int) 32-bit unsigned integer to be written into the register
Returns:
Nothing
Raises:
NysaCommError: Error in communication
"""
self.write(address, [value])
def write(self, address, data):
"""write
Generic write command usd to write data to an Nysa image, this will be
overriden based on the communication method with the specific FPGA board
Args:
address (int): Address of the register/memory to read
data (array of unsigned bytes): Array of raw bytes to send to the
device
Returns:
Nothing
Raises:
AssertionError: This function must be overriden by a board specific
implementation
"""
address = int((self.base_addr + address) >> 2)
self.driver.write(address, data)
def enable_register_bit(self, address, bit, enable):
"""enable_register_bit
Pass a bool value to set/clear a bit
Args:
address (int): Address of the register/memory to modify
bit (int): Address of bit to set (31 - 0)
enable (bool): set or clear a bit
Returns:
Nothing
Raises:
NysaCommError: Error in communication
"""
if enable:
self.set_register_bit(address, bit)
else:
self.clear_register_bit(address, bit)
def set_register_bit(self, address, bit):
"""set_register_bit
Sets an individual bit in a register
Args:
address (int): Address of the register/memory to modify
bit (int): Address of bit to set (31 - 0)
Returns:
Nothing
Raises:
NysaCommError: Error in communication
"""
register = self.read_register(address)
bit_mask = 1 << bit
register |= bit_mask
self.write_register(address, register)
def clear_register_bit(self, address, bit):
"""clear_register_bit
Clear an individual bit in a register
Args:
address (int): Address of the register/memory to modify
bit (int): Address of bit to set (31 - 0)
Returns:
Nothing
Raises:
NysaCommError: Error in communication
"""
register = self.read_register(address)
bit_mask = 1 << bit
register &= ~bit_mask
self.write_register(address, register)
def is_register_bit_set(self, address, bit):
"""is_register_bit_set
returns true if an individual bit is set, false if clear
Args:
address (int): Address of the register/memory to read
bit (int): Address of bit to check (31 - 0)
Returns:
(boolean):
True: bit is set
False: bit is not set
Raises:
NysaCommError
"""
register = self.read_register(address)
bit_mask = 1 << bit
return ((register & bit_mask) > 0)
def write_register_bit_range(self, address, high_bit, low_bit, value):
"""
Write data to a range of bits within a register
Register = [XXXXXXXXXXXXXXXXXXXXXXXH---LXXXX]
Write to a range of bits within ia register
Args:
address (unsigned int): Address or the register/memory to write
high_bit (int): the high bit of the bit range to edit
low_bit (int): the low bit of the bit range to edit
value (int): the value to write in the range
Returns:
Nothing
Raises:
NysaCommError
"""
reg = self.read_register(address)
bitmask = (((1 << (high_bit + 1))) - (1 << low_bit))
reg &= ~(bitmask)
reg |= value << low_bit
self.write_register(address, reg)
def read_register_bit_range(self, address, high_bit, low_bit):
"""
Read a range of bits within a register at address 'address'
Register = [XXXXXXXXXXXXXXXXXXXXXXXH---LXXXX]
Read the value within a register, the top bit is H and bottom is L
Args:
address (unsigned int): Address or the register/memory to read
high_bit (int): the high bit of the bit range to read
low_bit (int): the low bit of the bit range to read
Returns (unsigned integer):
Value within the bitfield
Raises:
NysaCommError
"""
value = self.read_register(address)
bitmask = (((1 << (high_bit + 1))) - (1 << low_bit))
value = value & bitmask
value = value >> low_bit
return value