m1n1.fw.dcp.ipc: Add support for the macOS 13.2 firmware

Signed-off-by: Janne Grunau <j@jannau.net>

proxyclient/m1n1/fw/dcp/ipc.py

@@ -7,6 +7,7 @@ from enum import IntEnum
 from ..common import *
 from m1n1.utils import *
 from construct import *
+from m1n1.constructutils import Ver
 
 @dataclass
 class ByRef:
@@ -419,7 +420,10 @@ IOMFBParameterName = Int32ul
 BufferDescriptor = uint64_t
 
 SwapCompleteData = Bytes(0x12)
-SwapInfoBlob = Bytes(0x6c4)
+SwapInfoBlob = Struct(
+    "unk" / Bytes(0x6c4),
+    Ver("V >= V13_2", "unk_13_2" / Bytes(0x1)),
+)
 
 SWAP_SURFACES = 4
 
@@ -449,15 +453,15 @@ IOMFBSwapRec = Struct(
     "unk_2c8" / Hex(Default(Int32ul, 0)),
     "unk_2cc" / UnkBytes(0x14),
     "unk_2e0" / Hex(Default(Int32ul, 0)),
-    "unk_2e2" / UnkBytes(0x2),
+    Ver("V < V13_2", "unk_2e2" / UnkBytes(0x2)),
+    Ver("V >= V13_2", "unk_2e2" / UnkBytes(0x3)),
     "bl_unk" / Hex(Int64ul), # seen: 0x0, 0x1, 0x101, 0x1_0000, 0x101_010101
     "bl_val" / Hex(Int32ul), # range 0x10000000 - approximately 0x7fe07fc0 for 4 - 510 nits
     "bl_power" / Hex(Int8ul), # constant 0x40, 0x00: backlight off
     "unk_2f3" / UnkBytes(0x2d),
+    Ver("V >= V13_2", "unk_320" / UnkBytes(0x13f)),
 )
 
-assert IOMFBSwapRec.sizeof() == 0x320
-
 MAX_PLANES = 3
 
 ComponentTypes = Struct(
@@ -562,19 +566,26 @@ IOSurface = Struct(
     "unk_1f5" / Int32ul,
     "unk_1f9" / Int32ul,
     "padding" / UnkBytes(7),
+    Ver("V >= V13_2", "padding_13_2" / UnkBytes(40)),
 )
 
-assert IOSurface.sizeof() == 0x204
-
 IOMFBColorFixedMatrix = Array(5, Array(3, ulong))
 
 class PropID(IntEnum):
     BrightnessCorrection = 14
 
 class UPPipeAP_H13P(IPCObject):
-    A000 = Call(bool_, "late_init_signal")
+    # FW version dependent Calls
+    if Ver.check("V < V13_2"):
+        late_init_signal = Call(bool_, "late_init_signal")
+        update_notify_clients_dcp = Call(void, "update_notify_clients_dcp", Array(26, uint))
+    else:
+        late_init_signal = Call(bool_, "late_init_signal", bool_)
+        update_notify_clients_dcp = Call(void, "update_notify_clients_dcp", Array(26, uint))
+
+    A000 = late_init_signal
     A029 = Call(void, "setup_video_limits")
-    A034 = Call(void, "update_notify_clients_dcp", Array(14, uint))
+    A034 = update_notify_clients_dcp
     A035 = Call(bool_, "is_hilo")
     A036 = Call(bool_, "apt_supported")
     A037 = Call(uint, "get_dfb_info", InOutPtr(uint), InOutPtr(Array(4, ulong)), InOutPtr(uint))
@@ -588,10 +599,19 @@ class UPPipeAP_H13P(IPCObject):
 IdleCachingState = uint32_t
 
 class UnifiedPipeline2(IPCObject):
+    # FW version dependent Call tags
+    set_create_DFB = Call(void, "set_create_DFB")
+    vi_set_temperature_hint = Call(IOMFBStatus, "vi_set_temperature_hint")
+
+    if Ver.check("V < V13_2"):
+        A357 = set_create_DFB
+        A358 = vi_set_temperature_hint
+    else:
+        A373 = set_create_DFB
+        A374 = vi_set_temperature_hint
+
     A352 = Call(bool_, "applyProperty", uint, uint)
     A353 = Call(uint, "get_system_type")
-    A357 = Call(void, "set_create_DFB")
-    A358 = Call(IOMFBStatus, "vi_set_temperature_hint")
 
     D100 = Callback(void, "match_pmu_service")
     D101 = Callback(uint32_t, "UNK_get_some_field")
@@ -603,15 +623,37 @@ class UnifiedPipeline2(IPCObject):
     D109 = Callback(bool_, "create_PMU_service")
     D110 = Callback(bool_, "create_iomfb_service")
     D111 = Callback(bool_, "create_backlight_service")
-    D112 = Callback(void, "set_idle_caching_state_ap", IdleCachingState, uint)
-    D116 = Callback(bool_, "start_hardware_boot")
-    D117 = Callback(bool_, "is_dark_boot")
-    D118 = Callback(bool_, "is_waking_from_hibernate")
-    D120 = Callback(bool_, "read_edt_data", key=string(0x40), count=uint, value=InOut(Lazy(SizedArray(8, "count", uint32_t))))
 
-    D122 = Callback(bool_, "setDCPAVPropStart", length=uint)
+    # FW version dependent Callback tags
-    D123 = Callback(bool_, "setDCPAVPropChunk", data=HexDump(SizedBytes(0x1000, "length")), offset=uint, length=uint)
+    create_nvram_service = Callback(bool_, "create_nvram_service") # guessed
-    D124 = Callback(bool_, "setDCPAVPropEnd", key=string(0x40))
+    set_idle_caching_state_ap = Callback(void, "set_idle_caching_state_ap", IdleCachingState, uint)
+    start_hardware_boot = Callback(bool_, "start_hardware_boot")
+    is_dark_boot = Callback(bool_, "is_dark_boot")
+    is_waking_from_hibernate = Callback(bool_, "is_waking_from_hibernate")
+    read_edt_data = Callback(bool_, "read_edt_data", key=string(0x40), count=uint, value=InOut(Lazy(SizedArray(8, "count", uint32_t))))
+    setDCPAVPropStart = Callback(bool_, "setDCPAVPropStart", length=uint)
+    setDCPAVPropChunk = Callback(bool_, "setDCPAVPropChunk", data=HexDump(SizedBytes(0x1000, "length")), offset=uint, length=uint)
+    setDCPAVPropEnd = Callback(bool_, "setDCPAVPropEnd", key=string(0x40))
+
+    if Ver.check("V < V13_2"):
+        D112 = set_idle_caching_state_ap
+        D116 = start_hardware_boot
+        D117 = is_dark_boot
+        D118 = is_waking_from_hibernate
+        D120 = read_edt_data
+        D122 = setDCPAVPropStart
+        D123 = setDCPAVPropChunk
+        D124 = setDCPAVPropEnd
+    else:
+        D112 = create_nvram_service
+        D113 = set_idle_caching_state_ap
+        D119 = start_hardware_boot
+        D120 = is_dark_boot
+        D121 = is_waking_from_hibernate
+        D123 = read_edt_data
+        D125 = setDCPAVPropStart
+        D126 = setDCPAVPropChunk
+        D127 = setDCPAVPropEnd
 
 class UPPipe2(IPCObject):
     A102 = Call(uint64_t, "test_control", cmd=uint64_t, arg=uint)
@@ -634,22 +676,38 @@ class PropRelay(IPCObject):
     D300 = Callback(void, "pr_publish", prop_id=uint32_t, value=int_)
 
 class IOMobileFramebufferAP(IPCObject):
-    A401 = Call(uint32_t, "start_signal")
+    # FW version dependent Calls
-
+    if Ver.check("V < V13_2"):
-    A407 = Call(uint32_t, "swap_start", swap_id=InOutPtr(uint), client=InOutPtr(IOUserClient))
+        swap_submit_dcp = Call(uint32_t, "swap_submit_dcp",
-    A408 = Call(uint32_t, "swap_submit_dcp",
+                 swap_rec=InPtr(IOMFBSwapRec),
+                 surfaces=Array(4, InPtr(IOSurface)),
+                 surfAddr=Array(4, Hex(ulong)),
+                 unkBool=bool_,
+                 unkFloat=Float64l,
+                 unkInt=uint,
+                 unkOutBool=OutPtr(bool_))
+    else:
+        swap_submit_dcp = Call(uint32_t, "swap_submit_dcp",
                 swap_rec=InPtr(IOMFBSwapRec),
-                surfaces=Array(4, InPtr(IOSurface)),
+                surfaces=Array(SWAP_SURFACES, InPtr(IOSurface)),
-                surfAddr=Array(4, Hex(ulong)),
+                surfAddr=Array(SWAP_SURFACES, Hex(ulong)),
+                unkU64Array=Array(SWAP_SURFACES, Hex(ulong)),
+                surfaces2=Array(5, InPtr(IOSurface)),
+                surfAddr2=Array(5, Hex(ulong)),
                 unkBool=bool_,
                 unkFloat=Float64l,
+                unkU64=ulong,
+                unkBool2=bool_,
                 unkInt=uint,
-                unkOutBool=OutPtr(bool_))
+                unkOutBool=OutPtr(bool_),
+                unkCUintArray=InPtr(uint),
+                unkUintPtr=OutPtr(uint))
 
+    A401 = Call(uint32_t, "start_signal")
+    A407 = Call(uint32_t, "swap_start", swap_id=InOutPtr(uint), client=InOutPtr(IOUserClient))
+    A408 = swap_submit_dcp
     A410 = Call(uint32_t, "set_display_device", uint)
     A411 = Call(bool_, "is_main_display")
-    A438 = Call(uint32_t, "swap_set_color_matrix", matrix=InOutPtr(IOMFBColorFixedMatrix), func=uint32_t, unk=uint)
-#"A438": "IOMobileFramebufferAP::swap_set_color_matrix(IOMFBColorFixedMatrix*, IOMFBColorMatrixFunction, unsigned int)",
 
     A412 = Call(uint32_t, "set_digital_out_mode", uint, uint)
     A413 = Call(uint32_t, "get_digital_out_state", InOutPtr(uint))
@@ -660,27 +718,80 @@ class IOMobileFramebufferAP(IPCObject):
     A426 = Call(uint32_t, "get_color_remap_mode", InOutPtr(uint32_t))
     A427 = Call(uint32_t, "setBrightnessCorrection", uint)
 
-    A435 = Call(uint32_t, "set_block_dcp", arg1=uint64_t, arg2=uint, arg3=uint, arg4=Array(8, ulong), arg5=uint, data=SizedBytes(0x1000, "length"), length=ulong)
+    # FW version dependent Call tags
-    A439 = Call(uint32_t, "set_parameter_dcp", param=IOMFBParameterName, value=Lazy(SizedArray(4, "count", ulong)), count=uint)
+    set_block_dcp = Call(uint32_t, "set_block_dcp", arg1=uint64_t, arg2=uint, arg3=uint, arg4=Array(8, ulong), arg5=uint, data=SizedBytes(0x1000, "length"), length=ulong, unknArry=Array(4, uint))
+    get_block_dcp = Call(uint32_t, "get_block_dcp", arg1=uint64_t, arg2=uint, arg3=uint, arg4=Array(8, ulong), arg5=uint, data=OutPtr(SizedBytes(0x1000, "length")), length=uint)
+    swap_set_color_matrix = Call(uint32_t, "swap_set_color_matrix", matrix=InOutPtr(IOMFBColorFixedMatrix), func=uint32_t, unk=uint)
+    set_parameter_dcp = Call(uint32_t, "set_parameter_dcp", param=IOMFBParameterName, value=Lazy(SizedArray(4, "count", ulong)), count=uint)
+    display_width = Call(uint, "display_width")
+    display_height = Call(uint, "display_height")
+    get_display_size = Call(void, "get_display_size", OutPtr(uint), OutPtr(uint))
+    do_create_default_frame_buffer = Call(int_, "do_create_default_frame_buffer")
+    printRegs = Call(void, "printRegs")
+    enable_disable_video_power_savings = Call(int_, "enable_disable_video_power_savings", uint)
+    first_client_open = Call(void, "first_client_open")
+    last_client_close_dcp = Call(void, "last_client_close_dcp", OutPtr(uint))
+    writeDebugInfo = Call(bool_, "writeDebugInfo", ulong)
+    flush_debug_flags = Call(void, "flush_debug_flags", uint)
+    io_fence_notify = Call(bool_, "io_fence_notify", uint, uint, ulong, IOMFBStatus)
+    setDisplayRefreshProperties = Call(bool_, "setDisplayRefreshProperties")
+    flush_supportsPower = Call(void, "flush_supportsPower", bool_)
+    abort_swaps_dcp = Call(uint, "abort_swaps_dcp", InOutPtr(IOMobileFramebufferUserClient))
+    update_dfb = Call(uint, "update_dfb", surf=InPtr(IOSurface))
+    setPowerState = Call(uint32_t, "setPowerState", ulong, bool_, OutPtr(uint))
+    isKeepOnScreen = Call(bool_, "isKeepOnScreen")
 
-    A440 = Call(uint, "display_width")
+    if Ver.check("V < V13_2"):
-    A441 = Call(uint, "display_height")
+        A435 = set_block_dcp
-    A442 = Call(void, "get_display_size", OutPtr(uint), OutPtr(uint))
+        A436 = get_block_dcp
-    A443 = Call(int_, "do_create_default_frame_buffer")
+        A438 = swap_set_color_matrix
-    A444 = Call(void, "printRegs")
+        A439 = set_parameter_dcp
-    A447 = Call(int_, "enable_disable_video_power_savings", uint)
+        A440 = display_width
-    A454 = Call(void, "first_client_open")
+        A441 = display_height
-    A455 = Call(void, "last_client_close_dcp", OutPtr(uint))
+        A442 = get_display_size
-    A456 = Call(bool_, "writeDebugInfo", ulong)
+        A443 = do_create_default_frame_buffer
-    A457 = Call(void, "flush_debug_flags", uint)
+        A444 = printRegs
-    A458 = Call(bool_, "io_fence_notify", uint, uint, ulong, IOMFBStatus)
+        A447 = enable_disable_video_power_savings
-    A460 = Call(bool_, "setDisplayRefreshProperties")
+        A454 = first_client_open
-    A463 = Call(void, "flush_supportsPower", bool_)
+        A455 = last_client_close_dcp
-    A464 = Call(uint, "abort_swaps_dcp", InOutPtr(IOMobileFramebufferUserClient))
+        A456 = writeDebugInfo
+        A457 = flush_debug_flags
+        A458 = io_fence_notify
+        A460 = setDisplayRefreshProperties
+        A463 = flush_supportsPower
+        A464 = abort_swaps_dcp
+        A467 = update_dfb
+        A468 = setPowerState
+        A469 = isKeepOnScreen
+    else:
+        A437 = set_block_dcp
+        A438 = get_block_dcp
+        A440 = swap_set_color_matrix
+        A441 = set_parameter_dcp
+        A442 = display_width
+        A443 = display_height
+        A444 = get_display_size
+        A445 = do_create_default_frame_buffer
+        A446 = printRegs
+        A449 = enable_disable_video_power_savings
+        A456 = first_client_open
+        A457 = last_client_close_dcp
+        A458 = writeDebugInfo
+        A459 = flush_debug_flags
+        A460 = io_fence_notify
+        A462 = setDisplayRefreshProperties
+        A465 = flush_supportsPower
+        A466 = abort_swaps_dcp
+        A469 = update_dfb
+        A470 = setPowerState
+        A471 = isKeepOnScreen
 
-    A467 = Call(uint, "update_dfb", surf=InPtr(IOSurface))
+    # FW version dependent callbacks
-    A468 = Call(uint32_t, "setPowerState", ulong, bool_, OutPtr(uint))
+    if Ver.check("V < V13_2"):
-    A469 = Call(bool_, "isKeepOnScreen")
+        hotPlug_notify_gated = Callback(void, "hotPlug_notify_gated", ulong)
+    else:
+        # TODO: is this sensible?
+        hotPlug_notify_gated = Callback(void, "hotPlug_notify_gated", uint, InOutPtr(Bytes(0x4c)))
 
     D552 = Callback(bool_, "setProperty_dict", key=string(0x40), value=InPtr(Padded(0x1000, OSDictionary())))
     D561 = Callback(bool_, "setProperty_dict", key=string(0x40), value=InPtr(Padded(0x1000, OSDictionary())))
@@ -691,7 +802,7 @@ class IOMobileFramebufferAP(IPCObject):
     D574 = Callback(IOMFBStatus, "powerUpDART", bool_)
 
     D575 = Callback(bool_, "get_dot_pitch", OutPtr(uint))
-    D576 = Callback(void, "hotPlug_notify_gated", ulong)
+    D576 = hotPlug_notify_gated
     D577 = Callback(void, "powerstate_notify", bool_, bool_)
     D578 = Callback(bool_, "idle_fence_create", IdleCachingState)
     D579 = Callback(void, "idle_fence_complete")
@@ -713,12 +824,18 @@ class IOMobileFramebufferAP(IPCObject):
     D598 = Callback(void, "find_swap_function_gated")
 
 class ServiceRelay(IPCObject):
+    # FW version dependent Callbacks
+    if Ver.check("V < V13_2"):
+        sr_mapDeviceMemoryWithIndex = Callback(IOMFBStatus, "sr_mapDeviceMemoryWithIndex", obj=FourCC, index=uint, flags=uint, addr=OutPtr(ulong), length=OutPtr(ulong))
+    else:
+        sr_mapDeviceMemoryWithIndex = Callback(IOMFBStatus, "sr_mapDeviceMemoryWithIndex", obj=FourCC, index=uint, flags=uint, unk_u64=OutPtr(ulong), addr=OutPtr(ulong), length=OutPtr(ulong))
+
     D400 = Callback(void, "get_property", obj=FourCC, key=string(0x40), value=OutPtr(Bytes(0x200)), lenght=InOutPtr(uint))
     D401 = Callback(bool_, "sr_get_uint_prop", obj=FourCC, key=string(0x40), value=InOutPtr(ulong))
     D404 = Callback(void, "sr_set_uint_prop", obj=FourCC, key=string(0x40), value=uint)
     D406 = Callback(void, "set_fx_prop", obj=FourCC, key=string(0x40), value=uint)
     D408 = Callback(uint64_t, "sr_getClockFrequency", obj=FourCC, arg=uint)
-    D411 = Callback(IOMFBStatus, "sr_mapDeviceMemoryWithIndex", obj=FourCC, index=uint, flags=uint, addr=OutPtr(ulong), length=OutPtr(ulong))
+    D411 = sr_mapDeviceMemoryWithIndex
     D413 = Callback(bool_, "sr_setProperty_dict", obj=FourCC, key=string(0x40), value=InPtr(Padded(0x1000, OSDictionary())))
     D414 = Callback(bool_, "sr_setProperty_int", obj=FourCC, key=string(0x40), value=InPtr(uint64_t))
     D415 = Callback(bool_, "sr_setProperty_bool", obj=FourCC, key=string(0x40), value=InPtr(Bool(uint32_t)))