-
Notifications
You must be signed in to change notification settings - Fork 1
/
driverAR.py
190 lines (154 loc) · 7.38 KB
/
driverAR.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
import itertools
from abstract_classes import AbstractDriverAR
import usb.core
import usb.util
import sys
import time
from struct import *
import logging
class PythonDriver(AbstractDriverAR):
def __init__(self, export_filename: str, import_filename: str, mock: bool = False):
logging.info("Export in PythonDriver " + export_filename)
logging.info("Import in PythonDriver " + import_filename)
self.mock = mock
if mock:
self.DATA_FILE = "mock_data.dat"
# TODO create driver self.dev stub
else:
self.DATA_FILE = import_filename
self.dev, self.cfg_desired = self.__init_driver()
self.gameCheats = [] # TODO: unused?
self.ENDPOINT_ADDRESS_IN = 0x2
self.ENDPOINT_ADDRESS_OUT = 0x81
self.WRITE_CODE = b'\x43\x42\x57\x13\x00\x00\x00\x00'
self.READ_CODE = b'\x43\x42\x57\x1c\x00\x00\x00\x00'
self.END_WRITE_CODE = b'\x43\x42\x57\x1b\x00\x00\x00\x00'
self.ZERO = b'\x00\x00\x00\x00\x00\x00\x00\x00'
self.DONTKNOWYET = b'\x43\x42\x57\x12\x00\x00\x00\x00'
self.SOURCE_FILENAME = export_filename
@staticmethod
def __init_driver():
# find our device
# Bus 002 Device 010: ID 05fd:daae InterAct, Inc. Game Shark
idVendor = 0x5fd
idProduct = 0xdaae
dev = usb.core.find(idVendor=idVendor, idProduct=idProduct)
if dev is None:
raise ValueError(f'Device with vendor ID {idVendor} and product ID {idProduct} not found')
else:
logging.info("GBA Link found")
# check if there is already a driver attached to the device
i = dev[0].interfaces()[0].bInterfaceNumber
if dev.is_kernel_driver_active(i):
dev.detach_kernel_driver(i)
logging.info("Driver active!")
# set appropriate config
cfg_desired = usb.util.find_descriptor(dev, bConfigurationValue=1)
dev.set_configuration(cfg_desired)
try:
cfg = dev.get_active_configuration()
except usb.core.USBError:
cfg = None
if cfg is None or cfg.bConfigurationValue != cfg_desired:
dev.set_configuration(cfg_desired)
return dev, cfg_desired
# From the libusb manual:
#"get_active_configuration() will act as a lightweight device reset:
# it will issue a SET_CONFIGURATION request using the current configuration,
# causing most USB-related device state to be reset (altsetting reset to zero, endpoint halts cleared, toggles reset)."
def __get_and_set_usb_config(self):
usb.util.dispose_resources(self.dev)
i = self.dev[0].interfaces()[0].bInterfaceNumber
if self.dev.is_kernel_driver_active(i):
self.dev.detach_kernel_driver(i)
logging.info("Driver active!")
cfg_desired = usb.util.find_descriptor(self.dev, bConfigurationValue=1)
self.dev.set_configuration(cfg_desired)
try:
cfg = self.dev.get_active_configuration()
except usb.core.USBError:
cfg = None
if cfg is None or cfg.bConfigurationValue != cfg_desired:
self.dev.set_configuration(cfg_desired)
return
def __write_data_to_file(self,data: list[list]):
logging.info(f"In driverAR. This is the filename which the device data is written to: {self.DATA_FILE}")
with open(self.DATA_FILE, "wb") as f:
f.write(bytes(list(itertools.chain(*data))))
def single_read_request(self):
try:
ret = self.dev.read(self.ENDPOINT_ADDRESS_OUT,8,1000)
return ret.tolist()
except Exception as e:
logging.info(f"Exception in single_read_request {e}")
return [-1]
def single_write_request(self, msg: bytes):
ret = self.dev.write(self.ENDPOINT_ADDRESS_IN,msg,100)
return ret
def write_and_read_request(self, msg: bytes):
retW = self.single_write_request(msg)
retR = self.single_read_request()
return retW, retR
def read_data(self):
# initiate upload
self.write_and_read_request(self.READ_CODE)
# send zeros for some reason...
self.write_and_read_request(self.ZERO)
# TODO Find out the semantics of this code DONTKNOWYET...
self.write_and_read_request(self.DONTKNOWYET)
# send zeros for some reason again...
self.write_and_read_request(self.ZERO)
loop_condition = True
data = []
while loop_condition:
msg = b'\x00\x00\x00\x00\x00\x00\x00\x00'
ret = self.dev.write(self.ENDPOINT_ADDRESS_IN,msg,100) # here it is 100 wait time, before only 1 -> TODO new param for write_reat_request() ?
ret = self.single_read_request()
data.append(ret)
# not nice: TODO change (maybe look at original driver/client?)
if ret == [11,11,11,11,20,20,20,20] or ret == [255, 255, 255, 255, 255, 255, 255, 255] or ret == [0,0,0,0,0,0,0,0]:
loop_condition = False
# message to indicate the end of the import of data from device
self.write_and_read_request(self.END_WRITE_CODE)
self.__get_and_set_usb_config()
# save cheat code data to a file
# logging.info("In driver. This is the read data from device: " + str(data))
self.__write_data_to_file(data)
def write_data_to_device(self, num_of_games: int): # TODO: change signature to match signature of AbstractDriverAR
usb.util.dispose_resources(self.dev)
logging.info("In driverAR.write_data_to_device. This file is read and its content written to the device "+ self.SOURCE_FILENAME)
file_handler = open(self.SOURCE_FILENAME,'rb')
data_to_send = file_handler.read()
file_handler.close()
NUM_OF_GAMES = pack("<B",num_of_games) # TODO parse number from SOURCE_FILENAME
logging.info(f"No. of games: {NUM_OF_GAMES}")
if NUM_OF_GAMES[0] == 0:
logging.warning("Driver: Number of games is 0")
return
logging.info("EXPORT CODES")
logging.info("-------------")
# 1
# self.single_write_request(self.WRITE_CODE)
# logging.info(self.single_read_request())
req, res = self.write_and_read_request(self.WRITE_CODE)
logging.info("After WRITE_CODE is send: " + str(res))
# TODO find out why this is needed sometimes...
if res != [0,0,0,0,0,0,0,0]:
req, res = self.write_and_read_request(self.WRITE_CODE)
logging.info("After 2. WRITE_CODE is send: " + str(res))
# 2: send num of games
# self.single_write_request(NUM_OF_GAMES + b'\x00\x00\x00\x00\x00\x00\x00')
# result = self.single_read_request()
req, res = self.write_and_read_request(NUM_OF_GAMES + b'\x00\x00\x00\x00\x00\x00\x00')
logging.info("After num of games is send: " + str(res))
# 3: write games and codes in loop
for i in range(int(len(data_to_send)/8)):
logging.info(data_to_send[i*8:8*(i+1)])
self.single_write_request(data_to_send[i*8:8*(i+1)])
logging.info(self.single_read_request())
self.single_write_request(self.END_WRITE_CODE)
logging.info(self.single_read_request())
def exit_driver(self):
if not self.mock:
logging.info("Unloading Driver")
usb.util.dispose_resources(self.dev)