-
Notifications
You must be signed in to change notification settings - Fork 2
/
machxo_i2c.py
265 lines (236 loc) · 9.56 KB
/
machxo_i2c.py
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
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
# The MIT License (MIT)
#
# Author(s): Greg Steiert
# Copyright (c) 2018 Lattice Semiconductor Corporation
#
# 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.
"""
`machxo_i2c`
====================================================
An I2C programming utility for the MachXO2/3.
* Author(s): Greg Steiert
"""
from adafruit_bus_device.i2c_device import I2CDevice
# ISC_ERASE bit assignments
ERASE_SRAM = 1 << 16
ERASE_FEATURE_ROW = 1 << 17
ERASE_CONGFIG_FLASH = 1 << 18
ERASE_UFM = 1 << 19
class MachXOi2c:
"""Programming utility for MachXO2/3 through I2C"""
def init(self, i2c_bus, i2c_addr=0x40):
"""Assign i2c bus and lock it for use"""
self.i2c_dev = I2CDevice(i2c_bus, i2c_addr)
while not self.i2c_dev.i2c.try_lock():
pass
def kill(self):
self.i2c_dev.i2c.unlock()
def read_device_id(self):
"""Read and return device ID"""
device_id = bytearray(4)
self.i2c_dev.write(bytes([0xE0, 0, 0, 0]), stop=False)
self.i2c_dev.readinto(device_id)
return device_id
def read_user_code(self):
"""Read and return user code"""
user_code = bytearray(4)
self.i2c_dev.write(bytes([0xC0, 0, 0, 0]), stop=False)
self.i2c_dev.readinto(user_code)
return user_code
def read_status(self):
"""Read and return status register"""
status = bytearray(4)
self.i2c_dev.write(bytes([0x3C, 0, 0, 0]), stop=False)
self.i2c_dev.readinto(status)
return status
def read_feature_row(self):
"""Read and return feature row"""
feature_row = bytearray(8)
self.i2c_dev.write(bytes([0xE7, 0, 0, 0]), stop=False)
self.i2c_dev.readinto(feature_row)
return feature_row
def read_feature_bits(self):
"""Read and return feature bits"""
feature_bits = bytearray(2)
self.i2c_dev.write(bytes([0xFB, 0, 0, 0]), stop=False)
self.i2c_dev.readinto(feature_bits)
return feature_bits
def read_flash(self):
"""Read one page from flash"""
read_data = bytearray(16)
self.i2c_dev.write(bytes([0x73, 0x00, 0x00, 0x01]), stop=False)
self.i2c_dev.readinto(read_data)
return read_data
def read_ufm(self):
"""Read one page from UFM"""
read_data = bytearray(16)
self.i2c_dev.write(bytes([0xCA, 0x00, 0x00, 0x01]), stop=False)
self.i2c_dev.readinto(read_data)
return read_data
def read_otp_fuses(self):
"""Read and return status register"""
ucfsucfs = bytearray(1)
self.i2c_dev.write(bytes([0xFA, 0, 0, 0]), stop=False)
self.i2c_dev.readinto(ucfsucfs)
return ucfsucfs
def erase_ufm(self):
"""Erase only UFM"""
self.i2c_dev.write(bytes([0xCB, 0, 0, 0]), stop=True)
def erase(self, flags):
"""Erase blocks identified in flags"""
command = bytes([
0x0E,
(0xFF & (flags >> 16)),
(0xFF & (flags >> 8)),
(0xFF & (flags >> 0)),
])
self.i2c_dev.write(command, stop=True)
def enable_config_transparent(self):
self.i2c_dev.write(bytes([0x74, 0x08, 0]), stop=True)
def enable_config_offline(self):
self.i2c_dev.write(bytes([0xC6, 0x08, 0]), stop=True)
def check_busy(self):
"""Return True if busy"""
busy_byte = bytearray(1)
self.i2c_dev.write(bytes([0xF0, 0, 0, 0]), stop=False)
self.i2c_dev.readinto(busy_byte)
if (busy_byte[0] & 0x80):
return True
else:
return False
def wait_busy(self):
while self.check_busy():
pass
def reset_config_addr(self):
"""Set page address to beginning of configuration sector"""
self.i2c_dev.write(bytes([0x46, 0, 0, 0]), stop=True)
def reset_ufm_addr(self):
"""Set page address to beginning of UFM sector"""
self.i2c_dev.write(bytes([0x47, 0, 0, 0]), stop=True)
def set_config_addr(self, page):
"""Set page address of configuration sector"""
command = bytes([
0xB4, 0x00, 0x00, 0x00,
0x00, 0x00, (0xFF & (page >> 8)), (0xFF & page),
])
self.i2c_dev.write(command, stop=True)
def set_ufm_addr(self, page):
"""Set page address of UFM sector"""
command = bytes([
0xB4, 0x00, 0x00, 0x00,
0x40, 0x00, (0xFF & (page >> 8)), (0xFF & page),
])
self.i2c_dev.write(command, stop=True)
def program_page(self, page_data):
if (len(page_data) == 16):
command = bytes([
0x70, 0x00, 0x00, 0x01,
page_data[0], page_data[1], page_data[2], page_data[3],
page_data[4], page_data[5], page_data[6], page_data[7],
page_data[8], page_data[9], page_data[10], page_data[11],
page_data[12], page_data[13], page_data[14], page_data[15],
])
self.i2c_dev.write(command, stop=True)
else:
print("wrong number of elements in write array")
def program_done(self):
self.i2c_dev.write(bytes([0x5E, 0x00, 0x00, 0x00]), stop=True)
def refresh(self):
"""Reconfigure device"""
self.i2c_dev.write(bytes([0x79, 0, 0]), stop=True)
def wakeup(self):
"""No opperation, wakeup device"""
self.i2c_dev.write(bytes([0xFF, 0xFF, 0xFF, 0xFF]), stop=True)
def load_jed(self, filename):
jed_file = open(filename, 'r')
line = jed_file.readline().rstrip()
while line:
if line[0] == "L":
page_addr = int(line[1:])
if page_addr == 0:
self.reset_config_addr()
line = jed_file.readline().rstrip()
count = 0
while len(line) == 128:
page_data = [
int(line[0:8], 2),
int(line[8:16], 2),
int(line[16:24], 2),
int(line[24:32], 2),
int(line[32:40], 2),
int(line[40:48], 2),
int(line[48:56], 2),
int(line[56:64], 2),
int(line[64:72], 2),
int(line[72:80], 2),
int(line[80:88], 2),
int(line[88:96], 2),
int(line[96:104], 2),
int(line[104:112], 2),
int(line[112:120], 2),
int(line[120:128], 2),
]
self.program_page(page_data)
# It takes >400us to load command +128 bits at 400kHz
# You shouldn't need to check the busy flag with I2C
# self.wait_busy()
count += 1
line = jed_file.readline().rstrip()
if line[0] == "*":
print("wrote ", count, " pages")
else:
print("bad page data format")
line = jed_file.readline().rstrip()
jed_file.close()
def load_hex(self, filename):
hex_file = open(filename, 'r')
count = 0
self.reset_config_addr()
line = hex_file.readline().rstrip()
while line:
if len(line) == 32:
page_data = [
int(line[0:2], 16),
int(line[2:4], 16),
int(line[4:6], 16),
int(line[6:8], 16),
int(line[8:10], 16),
int(line[10:12], 16),
int(line[12:14], 16),
int(line[14:16], 16),
int(line[16:18], 16),
int(line[18:20], 16),
int(line[20:22], 16),
int(line[22:24], 16),
int(line[24:26], 16),
int(line[26:28], 16),
int(line[28:30], 16),
int(line[30:32], 16),
]
self.program_page(page_data)
# It takes >400us to load command +128 bits at 400kHz
# You shouldn't need to check the busy flag with I2C
# self.wait_busy()
count += 1
else:
print("expected 32 bytes, got ", len(line), " at line ", count)
line = hex_file.readline().rstrip()
print("wrote ", count, " pages")
hex_file.close()
self.wait_busy()