aboutsummaryrefslogtreecommitdiffstats
path: root/mpm/python/usrp_mpm/e31x_legacy_eeprom.py
diff options
context:
space:
mode:
Diffstat (limited to 'mpm/python/usrp_mpm/e31x_legacy_eeprom.py')
-rw-r--r--mpm/python/usrp_mpm/e31x_legacy_eeprom.py103
1 files changed, 103 insertions, 0 deletions
diff --git a/mpm/python/usrp_mpm/e31x_legacy_eeprom.py b/mpm/python/usrp_mpm/e31x_legacy_eeprom.py
new file mode 100644
index 000000000..4c0fb19a5
--- /dev/null
+++ b/mpm/python/usrp_mpm/e31x_legacy_eeprom.py
@@ -0,0 +1,103 @@
+#
+# Copyright 2017 Ettus Research, a National Instruments Company
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+#
+"""
+EEPROM management code
+"""
+
+import struct
+import zlib
+from builtins import zip
+from builtins import object
+
+
+class MboardEEPROM(object):
+ """
+ Given a nvmem path, read out EEPROM values from the motherboard's EEPROM.
+ The format of data in the EEPROM must follow the following standard:
+
+ E310 Legacy EEPROM Format
+
+ - 2 bytes data_version_major
+ - 2 bytes data_version_minor
+ - 6 bytes MAC address
+ - 2 bytes hw_pid
+ - 2 bytes hw_rev
+ - 8 bytes serial number (zero-terminated string of 7 characters)
+ - 12 bytes padding
+ - 8 bytes user_name
+
+ MAC addresses are ignored here; they are read elsewhere. If we really need
+ to know the MAC address of an interface, we can fish it out the raw data,
+ or ask the system.
+ """
+
+ # Refer e300_eeprom_manager.hpp.
+ eeprom_header_format = "<H H 6s H H 7s 12s 8s"
+ eeprom_header_keys = ('data_version_major', 'data_version_minor', 'mac_address', 'pid', 'rev', 'serial', 'pad', 'user_name')
+
+class DboardEEPROM(object):
+ """
+ Given a nvmem path, read out EEPROM values from the daughterboard's EEPROM.
+ The format of data in the EEPROM must follow the following standard:
+
+ E310 Legacy EEPROM Format
+
+ - 2 bytes data_version_major
+ - 2 bytes data_version_minor
+ - 2 bytes hw_pid
+ - 2 bytes hw_rev
+ - 8 bytes serial number (zero-terminated string of 7 characters)
+ - 12 bytes padding
+ """
+
+ # Refer e300_eeprom_manager.hpp.
+ eeprom_header_format = "<H H H H 7s 12s"
+ eeprom_header_keys = ('data_version_major', 'data_version_minor', 'pid', 'rev', 'serial', 'pad')
+
+def read_eeprom(
+ isMotherboard,
+ nvmem_path,
+ offset,
+ eeprom_header_format,
+ eeprom_header_keys,
+ max_size=None,
+):
+ """
+ Read the EEPROM located at nvmem_path and return a tuple (header, data)
+ Header is already parsed in the common header fields
+ Data contains the full eeprom data structure
+
+ nvmem_path -- Path to readable file (typically something in sysfs)
+ eeprom_header_format -- List of header formats, by version
+ eeprom_header_keys -- List of keys for the entries in the EEPROM
+ max_size -- Max number of bytes to be read. If omitted, will read the full file.
+ """
+
+ max_size = max_size or -1
+ with open(nvmem_path, "rb") as nvmem_file:
+ data = nvmem_file.read(max_size)[offset:]
+ eeprom_parser = struct.Struct(eeprom_header_format)
+ eeprom_keys = eeprom_header_keys
+ parsed_data = eeprom_parser.unpack_from(data)
+
+ if isMotherboard: # E310 MB.
+ # Rectify the PID and REV parsing. Reverse the bytes.
+ # PID and REV are the 4th and 5th elements in the tuple.
+ parsed_data_list = list(parsed_data)
+ parsed_data_list[3] = struct.unpack("<H", struct.pack(">H", parsed_data_list[3]))[0]
+ parsed_data_list[4] = struct.unpack("<H", struct.pack(">H", parsed_data_list[4]))[0]
+ parsed_data = tuple(parsed_data_list)
+
+ else: # E310 DB.
+ # Rectify the PID and REV parsing. Reverse the bytes.
+ # PID and REV are the 3rd and 4th elements in the tuple.
+ parsed_data_list = list(parsed_data)
+ parsed_data_list[2] = struct.unpack("<H", struct.pack(">H", parsed_data_list[2]))[0]
+ parsed_data_list[3] = struct.unpack("<H", struct.pack(">H", parsed_data_list[3]))[0]
+ parsed_data = tuple(parsed_data_list)
+
+ ret_val = (dict(list(zip(eeprom_keys, parsed_data))),data)
+ return ret_val \ No newline at end of file