replace usb protocol with tinfoils protocol, in order to support applications supporting said protocol.
- replace the python script with the one included with tinfoil, minor changes such as changing the supported extension, removing unused imports. - tested with the included script, fluffy and ns-usbloader on linux. a user was unable to get it working on mac however... - added build instructions to the readme, i think they're correct. - added install instructions to the readme.
This commit is contained in:
ITotalJustice
171
tools/usb_install_pc.py
Normal file
171
tools/usb_install_pc.py
Normal file
@@ -0,0 +1,171 @@
|
||||
# This script depends on PyUSB. You can get it with pip install pyusb.
|
||||
# You will also need libusb installed
|
||||
|
||||
# My sincere apologies for this process being overly complicated. Apparently Python and Windows
|
||||
# aren't very friendly :(
|
||||
# Windows Instructions:
|
||||
# 1. Download Zadig from https://zadig.akeo.ie/.
|
||||
# 2. With your switch plugged in and on the Tinfoil USB install menu,
|
||||
# choose "List All Devices" under the options menu in Zadig, and select libnx USB comms.
|
||||
# 3. Choose libusbK from the driver list and click the "Replace Driver" button.
|
||||
# 4. Run this script
|
||||
|
||||
# macOS Instructions:
|
||||
# 1. Install Homebrew https://brew.sh
|
||||
# 2. Install Python 3
|
||||
# sudo mkdir /usr/local/Frameworks
|
||||
# sudo chown $(whoami) /usr/local/Frameworks
|
||||
# brew install python
|
||||
# 3. Install PyUSB
|
||||
# pip3 install pyusb
|
||||
# 4. Install libusb
|
||||
# brew install libusb
|
||||
# 5. Plug in your Switch and go to Tinfoil > Title Management > USB Install NSP
|
||||
# 6. Run this script
|
||||
# python3 usb_install_pc.py <path/to/nsp_folder>
|
||||
|
||||
import usb.core
|
||||
import usb.util
|
||||
import struct
|
||||
import sys
|
||||
from pathlib import Path
|
||||
import time
|
||||
|
||||
CMD_ID_EXIT = 0
|
||||
CMD_ID_FILE_RANGE = 1
|
||||
|
||||
CMD_TYPE_RESPONSE = 1
|
||||
|
||||
# list of supported extensions.
|
||||
EXTS = (".nsp", ".xci", ".nsz", ".xcz")
|
||||
|
||||
def send_response_header(out_ep, cmd_id, data_size):
|
||||
out_ep.write(b'TUC0') # Tinfoil USB Command 0
|
||||
out_ep.write(struct.pack('<B', CMD_TYPE_RESPONSE))
|
||||
out_ep.write(b'\x00' * 3)
|
||||
out_ep.write(struct.pack('<I', cmd_id))
|
||||
out_ep.write(struct.pack('<Q', data_size))
|
||||
out_ep.write(b'\x00' * 0xC)
|
||||
|
||||
def file_range_cmd(nsp_dir, in_ep, out_ep, data_size):
|
||||
file_range_header = in_ep.read(0x20)
|
||||
|
||||
range_size = struct.unpack('<Q', file_range_header[:8])[0]
|
||||
range_offset = struct.unpack('<Q', file_range_header[8:16])[0]
|
||||
nsp_name_len = struct.unpack('<Q', file_range_header[16:24])[0]
|
||||
#in_ep.read(0x8) # Reserved
|
||||
nsp_name = bytes(in_ep.read(nsp_name_len)).decode('utf-8')
|
||||
|
||||
print('Range Size: {}, Range Offset: {}, Name len: {}, Name: {}'.format(range_size, range_offset, nsp_name_len, nsp_name))
|
||||
send_response_header(out_ep, CMD_ID_FILE_RANGE, range_size)
|
||||
|
||||
with open(nsp_name, 'rb') as f:
|
||||
f.seek(range_offset)
|
||||
|
||||
curr_off = 0x0
|
||||
end_off = range_size
|
||||
read_size = 0x800000
|
||||
|
||||
while curr_off < end_off:
|
||||
if curr_off + read_size >= end_off:
|
||||
read_size = end_off - curr_off
|
||||
|
||||
buf = f.read(read_size)
|
||||
out_ep.write(data=buf, timeout=0)
|
||||
curr_off += read_size
|
||||
|
||||
def poll_commands(nsp_dir, in_ep, out_ep):
|
||||
while True:
|
||||
cmd_header = bytes(in_ep.read(0x20, timeout=0))
|
||||
magic = cmd_header[:4]
|
||||
print('Magic: {}'.format(magic), flush=True)
|
||||
|
||||
if magic != b'TUC0': # Tinfoil USB Command 0
|
||||
continue
|
||||
|
||||
cmd_type = struct.unpack('<B', cmd_header[4:5])[0]
|
||||
cmd_id = struct.unpack('<I', cmd_header[8:12])[0]
|
||||
data_size = struct.unpack('<Q', cmd_header[12:20])[0]
|
||||
|
||||
print('Cmd Type: {}, Command id: {}, Data size: {}'.format(cmd_type, cmd_id, data_size), flush=True)
|
||||
|
||||
if cmd_id == CMD_ID_EXIT:
|
||||
print('Exiting...')
|
||||
break
|
||||
elif cmd_id == CMD_ID_FILE_RANGE:
|
||||
file_range_cmd(nsp_dir, in_ep, out_ep, data_size)
|
||||
|
||||
def send_nsp_list(nsp_dir, out_ep):
|
||||
nsp_path_list = list()
|
||||
nsp_path_list_len = 0
|
||||
|
||||
# Add all files with the extension .nsp in the provided dir
|
||||
for nsp_path in [f for f in nsp_dir.iterdir() if f.is_file() and (f.suffix in EXTS)]:
|
||||
nsp_path_list.append(nsp_path.__str__() + '\n')
|
||||
nsp_path_list_len += len(nsp_path.__str__()) + 1
|
||||
|
||||
print('Sending header...')
|
||||
|
||||
out_ep.write(b'TUL0') # Tinfoil USB List 0
|
||||
out_ep.write(struct.pack('<I', nsp_path_list_len))
|
||||
out_ep.write(b'\x00' * 0x8) # Padding
|
||||
|
||||
print('Sending NSP list: {}'.format(nsp_path_list))
|
||||
|
||||
for nsp_path in nsp_path_list:
|
||||
out_ep.write(nsp_path)
|
||||
|
||||
def print_usage():
|
||||
print("""\
|
||||
usb_install_pc.py
|
||||
|
||||
Used for the installation of NSPs over USB.
|
||||
|
||||
Usage: usb_install_pc.py <nsp folder>""")
|
||||
|
||||
if __name__ == '__main__':
|
||||
if len(sys.argv) != 2:
|
||||
print_usage()
|
||||
sys.exit(1)
|
||||
|
||||
nsp_dir = Path(sys.argv[1])
|
||||
|
||||
if not nsp_dir.is_dir():
|
||||
raise ValueError('1st argument must be a directory')
|
||||
|
||||
print("waiting for switch...\n")
|
||||
dev = None
|
||||
|
||||
while (dev is None):
|
||||
dev = usb.core.find(idVendor=0x057E, idProduct=0x3000)
|
||||
time.sleep(0.5)
|
||||
|
||||
print("found the switch!\n")
|
||||
|
||||
cfg = None
|
||||
|
||||
try:
|
||||
cfg = dev.get_active_configuration()
|
||||
print("found active config")
|
||||
except usb.core.USBError:
|
||||
print("no currently active config")
|
||||
cfg = None
|
||||
|
||||
if cfg is None:
|
||||
dev.reset()
|
||||
dev.set_configuration()
|
||||
cfg = dev.get_active_configuration()
|
||||
|
||||
is_out_ep = lambda ep: usb.util.endpoint_direction(ep.bEndpointAddress) == usb.util.ENDPOINT_OUT
|
||||
is_in_ep = lambda ep: usb.util.endpoint_direction(ep.bEndpointAddress) == usb.util.ENDPOINT_IN
|
||||
out_ep = usb.util.find_descriptor(cfg[(0,0)], custom_match=is_out_ep)
|
||||
in_ep = usb.util.find_descriptor(cfg[(0,0)], custom_match=is_in_ep)
|
||||
|
||||
assert out_ep is not None
|
||||
assert in_ep is not None
|
||||
|
||||
print("iManufacturer: {} iProduct: {} iSerialNumber: {}".format(dev.manufacturer, dev.product, dev.serial_number))
|
||||
print("bcdUSB: {} bMaxPacketSize0: {}".format(hex(dev.bcdUSB), dev.bMaxPacketSize0))
|
||||
|
||||
send_nsp_list(nsp_dir, out_ep)
|
||||
poll_commands(nsp_dir, in_ep, out_ep)
|
||||
@@ -1,141 +0,0 @@
|
||||
# based on usb.py from Tinfoil, by Adubbz.
|
||||
import struct
|
||||
import sys
|
||||
import os
|
||||
import usb.core
|
||||
import usb.util
|
||||
import time
|
||||
import glob
|
||||
from pathlib import Path
|
||||
|
||||
# magic number (SPHA) for the script and switch.
|
||||
MAGIC = 0x53504841
|
||||
# version of the usb script.
|
||||
VERSION = 2
|
||||
# list of supported extensions.
|
||||
EXTS = (".nsp", ".xci", ".nsz", ".xcz")
|
||||
|
||||
def verify_switch(bcdUSB, count, in_ep, out_ep):
|
||||
header = in_ep.read(8, timeout=0)
|
||||
switch_magic = struct.unpack('<I', header[0:4])[0]
|
||||
switch_version = struct.unpack('<I', header[4:8])[0]
|
||||
|
||||
if switch_magic != MAGIC:
|
||||
raise Exception("Unexpected magic {}".format(switch_magic))
|
||||
|
||||
if switch_version != VERSION:
|
||||
raise Exception("Unexpected version {}".format(switch_version))
|
||||
|
||||
send_data = struct.pack('<IIII', MAGIC, VERSION, bcdUSB, count)
|
||||
out_ep.write(data=send_data, timeout=0)
|
||||
|
||||
def send_file_info(path, in_ep, out_ep):
|
||||
file_name = Path(path).name
|
||||
file_size = Path(path).stat().st_size
|
||||
file_name_len = len(file_name)
|
||||
|
||||
send_data = struct.pack('<QQ', file_size, file_name_len)
|
||||
out_ep.write(data=send_data, timeout=0)
|
||||
out_ep.write(data=file_name, timeout=0)
|
||||
|
||||
def wait_for_input(path, in_ep, out_ep):
|
||||
buf = None
|
||||
predicted_off = 0
|
||||
print("now waiting for intput\n")
|
||||
|
||||
with open(path, "rb") as file:
|
||||
while True:
|
||||
header = in_ep.read(24, timeout=0)
|
||||
|
||||
range_offset = struct.unpack('<Q', header[8:16])[0]
|
||||
range_size = struct.unpack('<Q', header[16:24])[0]
|
||||
|
||||
if (range_offset == 0 and range_size == 0):
|
||||
break
|
||||
|
||||
if (buf != None and range_offset == predicted_off and range_size == len(buf)):
|
||||
# print("predicted the read off {} size {}".format(predicted_off, len(buf)))
|
||||
pass
|
||||
else:
|
||||
file.seek(range_offset)
|
||||
buf = file.read(range_size)
|
||||
|
||||
if (len(buf) != range_size):
|
||||
# print("off: {} size: {}".format(range_offset, range_size))
|
||||
raise ValueError('bad buf size!!!!!')
|
||||
|
||||
result = out_ep.write(data=buf, timeout=0)
|
||||
if (len(buf) != result):
|
||||
print("off: {} size: {}".format(range_offset, range_size))
|
||||
raise ValueError('bad result!!!!!')
|
||||
|
||||
predicted_off = range_offset + range_size
|
||||
buf = file.read(range_size)
|
||||
|
||||
if __name__ == '__main__':
|
||||
print("hello world")
|
||||
|
||||
# check which mode the user has selected.
|
||||
args = len(sys.argv)
|
||||
if (args != 2):
|
||||
print("either run python usb_total.py game.nsp OR drag and drop the game onto the python file (if python is in your path)")
|
||||
sys.exit(1)
|
||||
|
||||
path = sys.argv[1]
|
||||
files = []
|
||||
|
||||
if os.path.isfile(path) and path.endswith(EXTS):
|
||||
files.append(path)
|
||||
elif os.path.isdir(path):
|
||||
for f in glob.glob(path + "/**/*.*", recursive=True):
|
||||
if os.path.isfile(f) and f.endswith(EXTS):
|
||||
files.append(f)
|
||||
else:
|
||||
raise ValueError('must be a file!')
|
||||
|
||||
# for file in files:
|
||||
# print("found file: {}".format(file))
|
||||
|
||||
# Find the switch
|
||||
print("waiting for switch...\n")
|
||||
dev = None
|
||||
|
||||
while (dev is None):
|
||||
dev = usb.core.find(idVendor=0x057E, idProduct=0x3000)
|
||||
time.sleep(0.5)
|
||||
|
||||
print("found the switch!\n")
|
||||
|
||||
cfg = None
|
||||
|
||||
try:
|
||||
cfg = dev.get_active_configuration()
|
||||
print("found active config")
|
||||
except usb.core.USBError:
|
||||
print("no currently active config")
|
||||
cfg = None
|
||||
|
||||
if cfg is None:
|
||||
dev.set_configuration()
|
||||
cfg = dev.get_active_configuration()
|
||||
|
||||
is_out_ep = lambda ep: usb.util.endpoint_direction(ep.bEndpointAddress) == usb.util.ENDPOINT_OUT
|
||||
is_in_ep = lambda ep: usb.util.endpoint_direction(ep.bEndpointAddress) == usb.util.ENDPOINT_IN
|
||||
out_ep = usb.util.find_descriptor(cfg[(0,0)], custom_match=is_out_ep)
|
||||
in_ep = usb.util.find_descriptor(cfg[(0,0)], custom_match=is_in_ep)
|
||||
assert out_ep is not None
|
||||
assert in_ep is not None
|
||||
|
||||
print("iManufacturer: {} iProduct: {} iSerialNumber: {}".format(dev.manufacturer, dev.product, dev.serial_number))
|
||||
print("bcdUSB: {} bMaxPacketSize0: {}".format(hex(dev.bcdUSB), dev.bMaxPacketSize0))
|
||||
|
||||
try:
|
||||
verify_switch(dev.bcdUSB, len(files), in_ep, out_ep)
|
||||
|
||||
for file in files:
|
||||
print("installing file: {}".format(file))
|
||||
send_file_info(file, in_ep, out_ep)
|
||||
wait_for_input(file, in_ep, out_ep)
|
||||
dev.reset()
|
||||
except Exception as inst:
|
||||
print("An exception occurred " + str(inst))
|
||||
Reference in New Issue
Block a user