Merge branch 'fw_updater'

1 files changed, 134 insertions, 9 deletions

diff --git a/host/utils/usrp_n2xx_net_burner.py b/host/utils/usrp_n2xx_net_burner.py
index 06af8c860..1df300c76 100755
--- a/host/utils/usrp_n2xx_net_burner.py
+++ b/host/utils/usrp_n2xx_net_burner.py
@@ -17,8 +17,6 @@
 #
 
 # TODO: make it autodetect UHD devices
-# TODO: you should probably watch sequence numbers
-# TODO: validate images in 1) size and 2) header content so you can't write a Justin Bieber MP3 to Flash
 
 import optparse
 import math
@@ -28,6 +26,8 @@ import struct
 import socket
 import sys
 import time
+import platform
+import subprocess
 
 ########################################################################
 # constants
@@ -54,6 +54,14 @@ FLASH_DATA_PACKET_SIZE = 256
 FLASH_ARGS_FMT = '!LLLLL256s'
 FLASH_INFO_FMT = '!LLLLL256x'
 FLASH_IP_FMT =   '!LLLL260x'
+FLASH_HW_REV_FMT = '!LLLL260x'
+
+n2xx_revs = {
+             0x0a00: ["n200_r3", "n200_r2"],
+             0x0a10: ["n200_r4"],
+             0x0a01: ["n210_r3", "n210_r2"],
+             0x0a11: ["n210_r4"]
+            }
 
 class update_id_t:
   USRP2_FW_UPDATE_ID_WAT = ord(' ')
@@ -72,6 +80,8 @@ class update_id_t:
   USRP2_FW_UPDATE_ID_KK_READ_TEH_FLASHES_OMG = ord('R')
   USRP2_FW_UPDATE_ID_RESET_MAH_COMPUTORZ_LOL = ord('s')
   USRP2_FW_UPDATE_ID_RESETTIN_TEH_COMPUTORZ_OMG = ord('S')
+  USRP2_FW_UPDATE_ID_I_CAN_HAS_HW_REV_LOL = ord('v')
+  USRP2_FW_UPDATE_ID_HERES_TEH_HW_REV_OMG = ord('V')
   USRP2_FW_UPDATE_ID_KTHXBAI = ord('~')
 
 _seq = -1
@@ -92,12 +102,18 @@ def unpack_flash_info_fmt(s):
 def unpack_flash_ip_fmt(s):
     return struct.unpack(FLASH_IP_FMT, s) #(proto_ver, pktid, seq, ip_addr)
 
+def unpack_flash_hw_rev_fmt(s):
+    return struct.unpack(FLASH_HW_REV_FMT, s) #proto_ver, pktid, seq, hw_rev
+
 def pack_flash_args_fmt(proto_ver, pktid, seq, flash_addr, length, data=bytes()):
     return struct.pack(FLASH_ARGS_FMT, proto_ver, pktid, seq, flash_addr, length, data)
 
 def pack_flash_info_fmt(proto_ver, pktid, seq, sector_size_bytes, memory_size_bytes):
     return struct.pack(FLASH_INFO_FMT, proto_ver, pktid, seq, sector_size_bytes, memory_size_bytes)
 
+def pack_flash_hw_rev_fmt(proto_ver, pktid, seq, hw_rev):
+    return struct.pack(FLASH_HW_REV_FMT, proto_ver, pktid, seq, hw_rev)
+
 def is_valid_fpga_image(fpga_image):
     for i in range(0,63):
         if fpga_image[i:i+1] == bytes(b'\xFF'): continue
@@ -107,6 +123,96 @@ def is_valid_fpga_image(fpga_image):
 def is_valid_fw_image(fw_image):
     return fw_image[:4] == bytes(b'\x0B\x0B\x0B\x0B')
 
+
+########################################################################
+# interface discovery and device enumeration
+########################################################################
+def get_interfaces():
+    if(platform.system() is "Windows"): return win_get_interfaces()
+    else: return unix_get_interfaces()
+
+def unix_get_interfaces():
+    ifconfig = subprocess.check_output("/sbin/ifconfig")
+    ip_addr_re = "cast\D*(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})"
+    bcasts = re.findall(ip_addr_re, ifconfig)
+    return bcasts
+
+def win_get_interfaces():
+    from ctypes import Structure, windll, sizeof
+    from ctypes import POINTER, byref
+    from ctypes import c_ulong, c_uint, c_ubyte, c_char
+    MAX_ADAPTER_DESCRIPTION_LENGTH = 128
+    MAX_ADAPTER_NAME_LENGTH = 256
+    MAX_ADAPTER_ADDRESS_LENGTH = 8
+    class IP_ADDR_STRING(Structure):
+        pass
+    LP_IP_ADDR_STRING = POINTER(IP_ADDR_STRING)
+    IP_ADDR_STRING._fields_ = [
+        ("next", LP_IP_ADDR_STRING),
+        ("ipAddress", c_char * 16),
+        ("ipMask", c_char * 16),
+        ("context", c_ulong)]
+    class IP_ADAPTER_INFO (Structure):
+        pass
+    LP_IP_ADAPTER_INFO = POINTER(IP_ADAPTER_INFO)
+    IP_ADAPTER_INFO._fields_ = [
+        ("next", LP_IP_ADAPTER_INFO),
+        ("comboIndex", c_ulong),
+        ("adapterName", c_char * (MAX_ADAPTER_NAME_LENGTH + 4)),
+        ("description", c_char * (MAX_ADAPTER_DESCRIPTION_LENGTH + 4)),
+        ("addressLength", c_uint),
+        ("address", c_ubyte * MAX_ADAPTER_ADDRESS_LENGTH),
+        ("index", c_ulong),
+        ("type", c_uint),
+        ("dhcpEnabled", c_uint),
+        ("currentIpAddress", LP_IP_ADDR_STRING),
+        ("ipAddressList", IP_ADDR_STRING),
+        ("gatewayList", IP_ADDR_STRING),
+        ("dhcpServer", IP_ADDR_STRING),
+        ("haveWins", c_uint),
+        ("primaryWinsServer", IP_ADDR_STRING),
+        ("secondaryWinsServer", IP_ADDR_STRING),
+        ("leaseObtained", c_ulong),
+        ("leaseExpires", c_ulong)]
+    GetAdaptersInfo = windll.iphlpapi.GetAdaptersInfo
+    GetAdaptersInfo.restype = c_ulong
+    GetAdaptersInfo.argtypes = [LP_IP_ADAPTER_INFO, POINTER(c_ulong)]
+    adapterList = (IP_ADAPTER_INFO * 10)()
+    buflen = c_ulong(sizeof(adapterList))
+    rc = GetAdaptersInfo(byref(adapterList[0]), byref(buflen))
+    if rc == 0:
+        for a in adapterList:
+            adNode = a.ipAddressList
+            while True:
+                #convert ipAddr and ipMask into hex addrs that can be turned into a bcast addr
+                ipAddr = adNode.ipAddress.decode()
+                ipMask = adNode.ipMask.decode()
+                if ipAddr and ipMask:
+                    hexAddr = struct.unpack("<L", socket.inet_aton(ipAddr))[0]
+                    hexMask = struct.unpack("<L", socket.inet_aton(ipMask))[0]
+                    if(hexAddr and hexMask): #don't broadcast on 255.255.255.255, that's just lame
+                        yield socket.inet_ntoa(struct.pack("<L", (hexAddr & hexMask) | (~hexMask) & 0xFFFFFFFF))
+                adNode = adNode.next
+                if not adNode:
+                    break
+
+def enumerate_devices():
+    for bcast_addr in get_interfaces():
+        sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
+        sock.setsockopt(socket.SOL_SOCKET, socket.SO_BROADCAST, 1)
+        sock.settimeout(0.1)
+        out_pkt = pack_flash_args_fmt(USRP2_FW_PROTO_VERSION, update_id_t.USRP2_FW_UPDATE_ID_OHAI_LOL, 0, 0, 0)
+        sock.sendto(out_pkt, (bcast_addr, UDP_FW_UPDATE_PORT))
+        still_goin = True
+        while(still_goin):
+            try:
+                pkt = sock.recv(UDP_MAX_XFER_BYTES)
+                (proto_ver, pktid, rxseq, ip_addr) = unpack_flash_ip_fmt(pkt)
+                if(pktid == update_id_t.USRP2_FW_UPDATE_ID_OHAI_OMG):
+                    yield socket.inet_ntoa(struct.pack("<L", socket.ntohl(ip_addr)))
+            except socket.timeout:
+                still_goin = False
+
 ########################################################################
 # Burner class, holds a socket and send/recv routines
 ########################################################################
@@ -117,6 +223,7 @@ class burner_socket(object):
         self._sock.connect((addr, UDP_FW_UPDATE_PORT))
         self.set_callbacks(lambda *a: None, lambda *a: None)
         self.init_update() #check that the device is there
+        self.get_hw_rev()
 
     def set_callbacks(self, progress_cb, status_cb):
         self._progress_cb = progress_cb
@@ -137,14 +244,19 @@ class burner_socket(object):
         else:
             raise Exception("Invalid reply received from device.")
 
-        #  print "Incoming:\n\tVer: %i\n\tID: %c\n\tSeq: %i\n\tIP: %i\n" % (proto_ver, chr(pktid), rxseq, ip_addr)
+    def get_hw_rev(self):
+        out_pkt = pack_flash_hw_rev_fmt(USRP2_FW_PROTO_VERSION, update_id_t.USRP2_FW_UPDATE_ID_I_CAN_HAS_HW_REV_LOL, seq(), 0)
+        in_pkt = self.send_and_recv(out_pkt)
+        (proto_ver, pktid, rxseq, hw_rev) = unpack_flash_hw_rev_fmt(in_pkt)
+        if(pktid != update_id_t.USRP2_FW_UPDATE_ID_HERES_TEH_HW_REV_OMG): hw_rev = 0
+        return socket.ntohs(hw_rev)
 
     memory_size_bytes = 0
     sector_size_bytes = 0
     def get_flash_info(self):
         if (self.memory_size_bytes != 0) and (self.sector_size_bytes != 0):
             return (self.memory_size_bytes, self.sector_size_bytes)
-            
+
         out_pkt = pack_flash_args_fmt(USRP2_FW_PROTO_VERSION, update_id_t.USRP2_FW_UPDATE_ID_WATS_TEH_FLASH_INFO_LOL, seq(), 0, 0)
         in_pkt = self.send_and_recv(out_pkt)
 
@@ -157,10 +269,16 @@ class burner_socket(object):
 
     def burn_fw(self, fw, fpga, reset, safe):
         (flash_size, sector_size) = self.get_flash_info()
+        hw_rev = self.get_hw_rev()
 
-        print("Flash size: %i\nSector size: %i\n\n" % (flash_size, sector_size))
+        if(hw_rev != 0): print("Hardware type: %s" % n2xx_revs[hw_rev][0])
+        print("Flash size: %i\nSector size: %i\n" % (flash_size, sector_size))
 
         if fpga:
+            #validate fpga image name against hardware rev
+            if(hw_rev != 0 and not any(name in fpga for name in n2xx_revs[hw_rev])):
+                raise Exception("Error: incorrect FPGA image version. Please use the correct image for device %s" % n2xx_revs[hw_rev][0])
+
             if safe: image_location = SAFE_FPGA_IMAGE_LOCATION_ADDR
             else:    image_location = PROD_FPGA_IMAGE_LOCATION_ADDR
 
@@ -172,7 +290,7 @@ class burner_socket(object):
 
             if not is_valid_fpga_image(fpga_image):
                 raise Exception("Error: Invalid FPGA image file.")
-                
+
             if (len(fpga_image) + image_location) > flash_size:
                 raise Exception("Error: Cannot write past end of device")
 
@@ -196,7 +314,7 @@ class burner_socket(object):
 
             if not is_valid_fw_image(fw_image):
                 raise Exception("Error: Invalid firmware image file.")
-                
+
             if (len(fw_image) + image_location) > flash_size:
                 raise Exception("Error: Cannot write past end of device")
 
@@ -218,7 +336,7 @@ class burner_socket(object):
         (mem_size, sector_size) = self.get_flash_info()
         if (addr + len(writedata)) > mem_size:
             raise Exception("Error: Cannot write past end of device")
-            
+
         while writedata:
             out_pkt = pack_flash_args_fmt(USRP2_FW_PROTO_VERSION, update_id_t.USRP2_FW_UPDATE_ID_WRITE_TEH_FLASHES_LOL, seq(), addr, FLASH_DATA_PACKET_SIZE, writedata[:FLASH_DATA_PACKET_SIZE])
             in_pkt = self.send_and_recv(out_pkt)
@@ -305,7 +423,7 @@ class burner_socket(object):
         (flash_size, sector_size) = self.get_flash_info()
         if (addr + length) > flash_size:
             raise Exception("Cannot erase past end of device")
-            
+
         out_pkt = pack_flash_args_fmt(USRP2_FW_PROTO_VERSION, update_id_t.USRP2_FW_UPDATE_ID_ERASE_TEH_FLASHES_LOL, seq(), addr, length)
         in_pkt = self.send_and_recv(out_pkt)
 
@@ -342,6 +460,7 @@ def get_options():
     parser.add_option("--reset", action="store_true",          help="reset the device after writing", default=False)
     parser.add_option("--read", action="store_true",           help="read to file instead of write from file", default=False)
     parser.add_option("--overwrite-safe", action="store_true", help="never ever use this option", default=False)
+    parser.add_option("--list", action="store_true",           help="list possible network devices", default=False)
     (options, args) = parser.parse_args()
 
     return options
@@ -351,6 +470,12 @@ def get_options():
 ########################################################################
 if __name__=='__main__':
     options = get_options()
+
+    if options.list:
+        print('Possible network devices:')
+        print('  ' + '\n  '.join(enumerate_devices()))
+        exit()
+
     if not options.addr: raise Exception('no address specified')
 
     if not options.fpga and not options.fw and not options.reset: raise Exception('Must specify either a firmware image or FPGA image, and/or reset.')