fw_query_definitions.py 5.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119
  1. #!/usr/bin/env python3
  2. import capnp
  3. import copy
  4. from dataclasses import dataclass, field
  5. import struct
  6. from collections.abc import Callable
  7. import panda.python.uds as uds
  8. AddrType = tuple[int, int | None]
  9. EcuAddrBusType = tuple[int, int | None, int]
  10. EcuAddrSubAddr = tuple[int, int, int | None]
  11. LiveFwVersions = dict[AddrType, set[bytes]]
  12. OfflineFwVersions = dict[str, dict[EcuAddrSubAddr, list[bytes]]]
  13. # A global list of addresses we will only ever consider for VIN responses
  14. # engine, hybrid controller, Ford abs, Hyundai CAN FD cluster, 29-bit engine, PGM-FI
  15. # TODO: move these to each brand's FW query config
  16. STANDARD_VIN_ADDRS = [0x7e0, 0x7e2, 0x760, 0x7c6, 0x18da10f1, 0x18da0ef1]
  17. def p16(val):
  18. return struct.pack("!H", val)
  19. class StdQueries:
  20. # FW queries
  21. TESTER_PRESENT_REQUEST = bytes([uds.SERVICE_TYPE.TESTER_PRESENT, 0x0])
  22. TESTER_PRESENT_RESPONSE = bytes([uds.SERVICE_TYPE.TESTER_PRESENT + 0x40, 0x0])
  23. SHORT_TESTER_PRESENT_REQUEST = bytes([uds.SERVICE_TYPE.TESTER_PRESENT])
  24. SHORT_TESTER_PRESENT_RESPONSE = bytes([uds.SERVICE_TYPE.TESTER_PRESENT + 0x40])
  25. DEFAULT_DIAGNOSTIC_REQUEST = bytes([uds.SERVICE_TYPE.DIAGNOSTIC_SESSION_CONTROL,
  26. uds.SESSION_TYPE.DEFAULT])
  27. DEFAULT_DIAGNOSTIC_RESPONSE = bytes([uds.SERVICE_TYPE.DIAGNOSTIC_SESSION_CONTROL + 0x40,
  28. uds.SESSION_TYPE.DEFAULT, 0x0, 0x32, 0x1, 0xf4])
  29. EXTENDED_DIAGNOSTIC_REQUEST = bytes([uds.SERVICE_TYPE.DIAGNOSTIC_SESSION_CONTROL,
  30. uds.SESSION_TYPE.EXTENDED_DIAGNOSTIC])
  31. EXTENDED_DIAGNOSTIC_RESPONSE = bytes([uds.SERVICE_TYPE.DIAGNOSTIC_SESSION_CONTROL + 0x40,
  32. uds.SESSION_TYPE.EXTENDED_DIAGNOSTIC, 0x0, 0x32, 0x1, 0xf4])
  33. MANUFACTURER_SOFTWARE_VERSION_REQUEST = bytes([uds.SERVICE_TYPE.READ_DATA_BY_IDENTIFIER]) + \
  34. p16(uds.DATA_IDENTIFIER_TYPE.VEHICLE_MANUFACTURER_ECU_SOFTWARE_NUMBER)
  35. MANUFACTURER_SOFTWARE_VERSION_RESPONSE = bytes([uds.SERVICE_TYPE.READ_DATA_BY_IDENTIFIER + 0x40]) + \
  36. p16(uds.DATA_IDENTIFIER_TYPE.VEHICLE_MANUFACTURER_ECU_SOFTWARE_NUMBER)
  37. SUPPLIER_SOFTWARE_VERSION_REQUEST = bytes([uds.SERVICE_TYPE.READ_DATA_BY_IDENTIFIER]) + \
  38. p16(uds.DATA_IDENTIFIER_TYPE.SYSTEM_SUPPLIER_ECU_SOFTWARE_VERSION_NUMBER)
  39. SUPPLIER_SOFTWARE_VERSION_RESPONSE = bytes([uds.SERVICE_TYPE.READ_DATA_BY_IDENTIFIER + 0x40]) + \
  40. p16(uds.DATA_IDENTIFIER_TYPE.SYSTEM_SUPPLIER_ECU_SOFTWARE_VERSION_NUMBER)
  41. UDS_VERSION_REQUEST = bytes([uds.SERVICE_TYPE.READ_DATA_BY_IDENTIFIER]) + \
  42. p16(uds.DATA_IDENTIFIER_TYPE.APPLICATION_SOFTWARE_IDENTIFICATION)
  43. UDS_VERSION_RESPONSE = bytes([uds.SERVICE_TYPE.READ_DATA_BY_IDENTIFIER + 0x40]) + \
  44. p16(uds.DATA_IDENTIFIER_TYPE.APPLICATION_SOFTWARE_IDENTIFICATION)
  45. OBD_VERSION_REQUEST = b'\x09\x04'
  46. OBD_VERSION_RESPONSE = b'\x49\x04'
  47. # VIN queries
  48. OBD_VIN_REQUEST = b'\x09\x02'
  49. OBD_VIN_RESPONSE = b'\x49\x02\x01'
  50. UDS_VIN_REQUEST = bytes([uds.SERVICE_TYPE.READ_DATA_BY_IDENTIFIER]) + p16(uds.DATA_IDENTIFIER_TYPE.VIN)
  51. UDS_VIN_RESPONSE = bytes([uds.SERVICE_TYPE.READ_DATA_BY_IDENTIFIER + 0x40]) + p16(uds.DATA_IDENTIFIER_TYPE.VIN)
  52. GM_VIN_REQUEST = b'\x1a\x90'
  53. GM_VIN_RESPONSE = b'\x5a\x90'
  54. KWP_VIN_REQUEST = b'\x21\x81'
  55. KWP_VIN_RESPONSE = b'\x61\x81'
  56. @dataclass
  57. class Request:
  58. request: list[bytes]
  59. response: list[bytes]
  60. whitelist_ecus: list[int] = field(default_factory=list)
  61. rx_offset: int = 0x8
  62. bus: int = 1
  63. # Whether this query should be run on the first auxiliary panda (CAN FD cars for example)
  64. auxiliary: bool = False
  65. # FW responses from these queries will not be used for fingerprinting
  66. logging: bool = False
  67. # boardd toggles OBD multiplexing on/off as needed
  68. obd_multiplexing: bool = True
  69. @dataclass
  70. class FwQueryConfig:
  71. requests: list[Request]
  72. # TODO: make this automatic and remove hardcoded lists, or do fingerprinting with ecus
  73. # Overrides and removes from essential ecus for specific models and ecus (exact matching)
  74. non_essential_ecus: dict[capnp.lib.capnp._EnumModule, list[str]] = field(default_factory=dict)
  75. # Ecus added for data collection, not to be fingerprinted on
  76. extra_ecus: list[tuple[capnp.lib.capnp._EnumModule, int, int | None]] = field(default_factory=list)
  77. # Function a brand can implement to provide better fuzzy matching. Takes in FW versions,
  78. # returns set of candidates. Only will match if one candidate is returned
  79. match_fw_to_car_fuzzy: Callable[[LiveFwVersions, OfflineFwVersions], set[str]] | None = None
  80. def __post_init__(self):
  81. for i in range(len(self.requests)):
  82. if self.requests[i].auxiliary:
  83. new_request = copy.deepcopy(self.requests[i])
  84. new_request.bus += 4
  85. self.requests.append(new_request)
  86. def get_all_ecus(self, offline_fw_versions: OfflineFwVersions,
  87. include_extra_ecus: bool = True) -> set[EcuAddrSubAddr]:
  88. # Add ecus in database + extra ecus
  89. brand_ecus = {ecu for ecus in offline_fw_versions.values() for ecu in ecus}
  90. if include_extra_ecus:
  91. brand_ecus |= set(self.extra_ecus)
  92. return brand_ecus