Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,32 @@ defib burn -c gk7205v200 -f u-boot.bin --output json
- macOS serial workaround (ACK byte correction)
- Cross-platform: Linux, macOS, Windows

## Testing with QEMU

Defib can be tested end-to-end against the
[qemu-hisilicon](https://github.com/OpenIPC/qemu-hisilicon) emulator without
physical hardware. When QEMU starts without `-kernel`, it emulates the HiSilicon
boot ROM serial protocol.

```bash
# Terminal 1: start QEMU in fastboot mode
qemu-system-arm -M hi3516ev300 -m 64M -nographic \
-chardev socket,id=ser0,path=/tmp/qemu-hisi.sock,server=on,wait=off \
-serial chardev:ser0

# Terminal 2: recover via socket (auto-downloads OpenIPC U-Boot)
defib burn -c hi3516ev300 -p socket:///tmp/qemu-hisi.sock
```

The `socket://` transport prefix connects defib directly to QEMU's chardev Unix
socket. All three protocol phases (DDR init, SPL, U-Boot) transfer with full
CRC-16 validation. After the upload, QEMU starts the CPU and U-Boot output
appears on the same connection.

Supported: all Standard protocol chips (hi3516cv300, hi3516ev200, hi3516ev300,
hi3518ev300, gk7205v200, gk7205v300, etc.). V500 and CV6xx protocol emulation
is not yet available in QEMU.

## License

MIT
15 changes: 12 additions & 3 deletions src/defib/transport/serial_platform.py
Original file line number Diff line number Diff line change
Expand Up @@ -114,16 +114,25 @@ async def create_transport(
baudrate: int = 115200,
force_platform: str | None = None,
) -> Transport:
"""Create a platform-appropriate serial transport.
"""Create a platform-appropriate transport.

Args:
device: Serial port device path (e.g., /dev/ttyUSB0, COM3).
baudrate: Baud rate (default 115200).
device: Serial port device path (e.g., /dev/ttyUSB0, COM3) or
Unix socket path with ``socket://`` prefix (e.g.,
``socket:///tmp/qemu.sock``).
baudrate: Baud rate (default 115200, ignored for sockets).
force_platform: Override platform detection ("linux", "darwin", "win32").

Returns:
An appropriate Transport implementation.
"""
# Unix socket transport (for QEMU chardev sockets)
if device.startswith("socket://"):
from defib.transport.socket import SocketTransport
path = device[len("socket://"):]
logger.info("Using SocketTransport: %s", path)
return await SocketTransport.create(path)

platform = force_platform or sys.platform

if platform == "darwin":
Expand Down
92 changes: 92 additions & 0 deletions src/defib/transport/socket.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
"""Async Unix socket transport for connecting to QEMU chardev sockets.

Allows defib to connect to a QEMU instance using:
-chardev socket,id=ser0,path=/tmp/sock,server=on,wait=off -serial chardev:ser0

Usage:
defib burn -c hi3516ev300 -p socket:///tmp/sock
"""

from __future__ import annotations

import asyncio
import logging
import socket as sock_mod

from defib.transport.base import Transport, TransportError, TransportTimeout

logger = logging.getLogger(__name__)


class SocketTransport(Transport):
"""Transport over a Unix domain socket (SOCK_STREAM)."""

def __init__(self, conn: sock_mod.socket) -> None:
self._sock = conn
self._sock.setblocking(False)
self._buf = bytearray()

@classmethod
async def create(cls, path: str) -> SocketTransport:
"""Connect to a Unix domain socket at the given path."""
try:
s = sock_mod.socket(sock_mod.AF_UNIX, sock_mod.SOCK_STREAM)
s.setblocking(False)
loop = asyncio.get_event_loop()
await loop.sock_connect(s, path)
except OSError as e:
raise TransportError(f"Failed to connect to socket {path}: {e}") from e

logger.info("Connected to QEMU socket: %s", path)
return cls(s)

async def read(self, size: int, timeout: float | None = None) -> bytes:
# Return from internal buffer first
if self._buf:
chunk = bytes(self._buf[:size])
del self._buf[:size]
return chunk

loop = asyncio.get_event_loop()
try:
if timeout is not None:
data = await asyncio.wait_for(
loop.sock_recv(self._sock, size), timeout=timeout
)
else:
data = await loop.sock_recv(self._sock, size)
except TimeoutError:
raise TransportTimeout(f"Read timeout ({timeout}s)")
except OSError as e:
raise TransportError(f"Socket read error: {e}") from e

if not data:
raise TransportError("Socket closed by remote end")

return bytes(data)

async def write(self, data: bytes) -> None:
loop = asyncio.get_event_loop()
try:
await loop.sock_sendall(self._sock, data)
except OSError as e:
raise TransportError(f"Socket write error: {e}") from e

async def flush_input(self) -> None:
# No-op for sockets: unlike serial ports, there is no stale data
# to drain. Flushing here would discard legitimate ACK responses
# that QEMU has already sent back (sockets are fast, no serial
# latency to separate the write from the ACK arrival).
pass

async def flush_output(self) -> None:
pass # sendall already ensures data is sent

async def bytes_waiting(self) -> int:
return len(self._buf)

async def close(self) -> None:
try:
self._sock.close()
except OSError:
pass
Loading