├── .bumpversion.cfg
├── .github
    └── FUNDING.yml
├── README.md
├── data
    └── darwin
    │   └── com.dbibackend.usb.agent.plist
├── dbibackend
    ├── __init__.py
    └── dbibackend.py
└── setup.py


/.bumpversion.cfg:
--------------------------------------------------------------------------------
 1 | [bumpversion]
 2 | current_version = 1.1.1.dev0
 3 | commit = True
 4 | message = BUMP_VERSION: {new_version}
 5 | tag = True
 6 | tag_name = {new_version}
 7 | parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(\.(?P<release>[a-z]+)(?P<dev>\d+))?
 8 | serialize = 
 9 | 	{major}.{minor}.{patch}.{release}{dev}
10 | 	{major}.{minor}.{patch}
11 | 
12 | [bumpversion:part:release]
13 | optional_value = gamma
14 | values = 
15 | 	dev
16 | 	gamma
17 | 
18 | [bumpversion:file:dbibackend/__init__.py]
19 | search = __version__ = '{current_version}'
20 | replace = __version__ = '{new_version}'
21 | 


--------------------------------------------------------------------------------
/.github/FUNDING.yml:
--------------------------------------------------------------------------------
1 | custom: https://www.tinkoff.ru/rm/kalashnikov.roman1/ZLI4G51069
2 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | DBI backend
 2 | ===========
 3 | 
 4 | PC-side server for games installation into Nintendo Switch
 5 | 
 6 | Requirements
 7 | ------------
 8 | Host:
 9 | 
10 | - libusb
11 | - pyusb
12 | - python3.7+
13 | 
14 | Nintendo Switch:
15 | - DBI v202+
16 | 
17 | Usage
18 | -----
19 | * Run server `python3 dbibackend.py tites_dir_path`
20 | * Run DBI and then Installation titles from USB
21 | * Install files
22 | 


--------------------------------------------------------------------------------
/data/darwin/com.dbibackend.usb.agent.plist:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <!DOCTYPE plist PUBLIC -//Apple Computer//DTD PLIST 1.0//EN http://www.apple.com/DTDs/PropertyList-1.0.dtd >
 3 | <plist version="1.0">
 4 | <dict>
 5 |     <key>Label</key>
 6 |     <string>com.dbibackend.usb.agent</string>
 7 |     <key>ProgramArguments</key>
 8 |     <array>
 9 |         <string>/usr/local/bin/dbibackend</string>
10 |         <string>/pat_to_titles</string>
11 |     </array>
12 |     <key>LaunchEvents</key>
13 |     <dict>
14 |         <key>com.apple.iokit.matching</key>
15 |         <dict>
16 |             <key>com.apple.device-attach</key>
17 |             <dict>
18 |                 <key>idProduct</key>
19 |                 <integer>12288</integer>
20 |                 <key>idVendor</key>
21 |                 <integer>1406</integer>
22 |                 <key>IOProviderClass</key>
23 |                 <string>IOUSBDevice</string>
24 |                 <key>IOMatchLaunchStream</key>
25 |                 <true/>
26 |             </dict>
27 |         </dict>
28 |     </dict>
29 | </dict>
30 | </plist>
31 | 


--------------------------------------------------------------------------------
/dbibackend/__init__.py:
--------------------------------------------------------------------------------
1 | __version__ = '1.1.1.dev0'
2 | 


--------------------------------------------------------------------------------
/dbibackend/dbibackend.py:
--------------------------------------------------------------------------------
  1 | #!/usr/bin/python3
  2 | import usb.core
  3 | import usb.util
  4 | import struct
  5 | import sys
  6 | import time
  7 | import argparse
  8 | import logging
  9 | import os
 10 | from enum import IntEnum
 11 | from collections import OrderedDict
 12 | from pathlib import Path
 13 | 
 14 | 
 15 | log = logging.getLogger(__name__)
 16 | log.addHandler(logging.StreamHandler(sys.stdout))
 17 | log.setLevel(logging.INFO)
 18 | 
 19 | BUFFER_SEGMENT_DATA_SIZE = 0x100000
 20 | 
 21 | 
 22 | class CommandID(IntEnum):
 23 |     EXIT = 0
 24 |     LIST_DEPRECATED = 1
 25 |     FILE_RANGE = 2
 26 |     LIST = 3
 27 | 
 28 | 
 29 | class CommandType(IntEnum):
 30 |     REQUEST = 0
 31 |     RESPONSE = 1
 32 |     ACK = 2
 33 | 
 34 | 
 35 | class UsbContext:
 36 |     def __init__(self, vid: hex, pid: hex):
 37 |         dev = usb.core.find(idVendor=vid, idProduct=pid)
 38 |         if dev is None:
 39 |             raise ConnectionError(f'Device {vid}:{pid} not found')
 40 | 
 41 |         dev.reset()
 42 |         dev.set_configuration()
 43 |         cfg = dev.get_active_configuration()
 44 | 
 45 |         self._out = usb.util.find_descriptor(
 46 |             cfg[(0, 0)],
 47 |             custom_match=lambda ep: usb.util.endpoint_direction(ep.bEndpointAddress) == usb.util.ENDPOINT_OUT
 48 |         )
 49 |         self._in = usb.util.find_descriptor(
 50 |             cfg[(0, 0)],
 51 |             custom_match=lambda ep: usb.util.endpoint_direction(ep.bEndpointAddress) == usb.util.ENDPOINT_IN
 52 |         )
 53 | 
 54 |         if self._out is None:
 55 |             raise LookupError(f'Device {vid}:{pid} output endpoint not found')
 56 |         if self._in is None:
 57 |             raise LookupError(f'Device {vid}:{pid} input endpoint not found')
 58 | 
 59 |     def read(self, data_size, timeout=0):
 60 |         return self._in.read(data_size, timeout=timeout)
 61 | 
 62 |     def write(self, data, timeout=0):
 63 |         self._out.write(data, timeout=timeout)
 64 | 
 65 | 
 66 | def process_file_range_command(data_size, context, cache=None):
 67 |     log.info('File range')
 68 |     context.write(struct.pack('<4sIII', b'DBI0', CommandType.ACK, CommandID.FILE_RANGE, data_size))
 69 |     file_range_header = context.read(data_size)
 70 |     range_size = struct.unpack('<I', file_range_header[:4])[0]
 71 |     range_offset = struct.unpack('<Q', file_range_header[4:12])[0]
 72 |     nsp_name_len = struct.unpack('<I', file_range_header[12:16])[0]
 73 |     nsp_name = bytes(file_range_header[16:]).decode('utf-8')
 74 |     if cache is not None and len(cache) > 0:
 75 |         if nsp_name in cache:
 76 |             nsp_name = cache[nsp_name]
 77 | 
 78 |     log.info(f'Range Size: {range_size}, Range Offset: {range_offset}, Name len: {nsp_name_len}, Name: {nsp_name}')
 79 | 
 80 |     response_bytes = struct.pack('<4sIII', b'DBI0', CommandType.RESPONSE, CommandID.FILE_RANGE, range_size)
 81 |     context.write(response_bytes)
 82 | 
 83 |     ack = bytes(context.read(16, timeout=0))
 84 |     cmd_type = struct.unpack('<I', ack[4:8])[0]
 85 |     cmd_id = struct.unpack('<I', ack[8:12])[0]
 86 |     data_size = struct.unpack('<I', ack[12:16])[0]
 87 |     log.debug(f'Cmd Type: {cmd_type}, Command id: {cmd_id}, Data size: {data_size}')
 88 |     log.debug('Ack')
 89 | 
 90 |     with open(nsp_name, 'rb') as f:
 91 |         f.seek(range_offset)
 92 | 
 93 |         curr_off = 0x0
 94 |         end_off = range_size
 95 |         read_size = BUFFER_SEGMENT_DATA_SIZE
 96 | 
 97 |         while curr_off < end_off:
 98 |             if curr_off + read_size >= end_off:
 99 |                 read_size = end_off - curr_off
100 | 
101 |             buf = f.read(read_size)
102 |             context.write(data=buf, timeout=0)
103 |             curr_off += read_size
104 | 
105 | 
106 | def process_exit_command(context):
107 |     log.info('Exit')
108 |     context.write(struct.pack('<4sIII', b'DBI0', CommandType.RESPONSE, CommandID.EXIT, 0))
109 |     sys.exit(0)
110 | 
111 | 
112 | def process_list_command(context, work_dir_path):
113 |     log.info('Get list')
114 | 
115 |     cached_titles = OrderedDict()
116 |     for dirName, subdirList, fileList in os.walk(work_dir_path):
117 |         log.debug(f'Found directory: {dirName}')
118 |         for filename in fileList:
119 |             if filename.lower().endswith('.nsp') or filename.lower().endswith('nsz') or filename.lower().endswith('.xci'):
120 |                 log.debug(f'\t{filename}')
121 |                 cached_titles[f'{filename}'] = str(Path(dirName).joinpath(filename))
122 | 
123 |     nsp_path_list = ''
124 |     for title in cached_titles.keys():
125 |         nsp_path_list += f'{title}\n'
126 |     nsp_path_list_bytes = nsp_path_list.encode('utf-8')
127 |     nsp_path_list_len = len(nsp_path_list_bytes)
128 | 
129 |     context.write(struct.pack('<4sIII', b'DBI0', CommandType.RESPONSE, CommandID.LIST, nsp_path_list_len))
130 | 
131 |     ack = bytes(context.read(16, timeout=0))
132 |     cmd_type = struct.unpack('<I', ack[4:8])[0]
133 |     cmd_id = struct.unpack('<I', ack[8:12])[0]
134 |     data_size = struct.unpack('<I', ack[12:16])[0]
135 |     log.debug(f'Cmd Type: {cmd_type}, Command id: {cmd_id}, Data size: {data_size}')
136 |     log.debug('Ack')
137 | 
138 |     context.write(nsp_path_list_bytes)
139 |     return cached_titles
140 | 
141 | 
142 | def poll_commands(context, work_dir_path):
143 |     log.info('Entering command loop')
144 | 
145 |     cmd_cache = None
146 |     while True:
147 |         cmd_header = bytes(context.read(16, timeout=0))
148 |         magic = cmd_header[:4]
149 | 
150 |         if magic != b'DBI0':  # Tinfoil USB Command 0
151 |             continue
152 | 
153 |         cmd_type = struct.unpack('<I', cmd_header[4:8])[0]
154 |         cmd_id = struct.unpack('<I', cmd_header[8:12])[0]
155 |         data_size = struct.unpack('<I', cmd_header[12:16])[0]
156 | 
157 |         log.debug(f'Cmd Type: {cmd_type}, Command id: {cmd_id}, Data size: {data_size}')
158 | 
159 |         if cmd_id == CommandID.EXIT:
160 |             process_exit_command(context)
161 |         elif cmd_id == CommandID.LIST:
162 |             cmd_cache = process_list_command(context, work_dir_path)
163 |         elif cmd_id == CommandID.FILE_RANGE:
164 |             process_file_range_command(data_size, context=context, cache=cmd_cache)
165 |         else:
166 |             log.warning(f'Unknown command id: {cmd_id}')
167 |             process_exit_command(context)
168 | 
169 | 
170 | def connect_to_switch():
171 |     while True:
172 |         try:
173 |             switch_context = UsbContext(vid=0x057E, pid=0x3000)
174 |         except ConnectionError as e:
175 |             log.info('Waiting for switch')
176 |             time.sleep(1)
177 |             continue
178 |         return switch_context
179 | 
180 | 
181 | def get_args(args):
182 |     parser = argparse.ArgumentParser(
183 |         prog='dbibackend',
184 |         description='Install local titles into Nintendo switch via USB',
185 |         add_help=True
186 |     )
187 |     parent_group = parser.add_argument_group(title='Command line params')
188 |     parent_group.add_argument('titles', type=str, help='Path to titles dir')
189 |     parent_group.add_argument('--debug', action='store_true', default=False, required=False,
190 |                               help='Enable debug output')
191 |     return parser.parse_args(args)
192 | 
193 | 
194 | def main():
195 |     args = get_args(sys.argv[1:])
196 | 
197 |     if args.debug:
198 |         log.setLevel(logging.DEBUG)
199 | 
200 |     if not Path(args.titles).is_dir():
201 |         raise NotADirectoryError('Specified path must be a directory')
202 | 
203 |     poll_commands(
204 |         connect_to_switch(),
205 |         work_dir_path=args.titles
206 |     )
207 | 
208 | 
209 | if __name__ == '__main__':
210 |     main()
211 | 


--------------------------------------------------------------------------------
/setup.py:
--------------------------------------------------------------------------------
 1 | #!/usr/bin/python3
 2 | 
 3 | from setuptools import setup, find_packages
 4 | import dbibackend
 5 | 
 6 | 
 7 | setup(
 8 |     name='dbibackend',
 9 |     version=dbibackend.__version__,
10 |     packages=find_packages(),
11 |     author='Kalashnikov Roman',
12 |     author_email='lunix0x@gmail.com',
13 |     license='MIT',
14 |     classifiers=[
15 |         'Programming Language :: Python :: 3.7',
16 |     ],
17 |     entry_points={
18 |         'console_scripts': [
19 |             'dbibackend = dbibackend.dbibackend:main'
20 |             ]
21 |     },
22 |     install_requires=[
23 |         'pyusb==1.1.0',
24 |         'usb==0.0.83.dev0'
25 |     ]
26 | )
27 | 


--------------------------------------------------------------------------------