Received: by 2002:a05:7412:bbc7:b0:fc:a2b0:25d7 with SMTP id kh7csp519260rdb; Thu, 1 Feb 2024 16:06:42 -0800 (PST) X-Google-Smtp-Source: AGHT+IEkehOLKQGfc48mdj2pBqF8W6qX/I+IGwO2P9QFKnutzrQjxrdAvInbJwtalAdXv6Jhcjuf X-Received: by 2002:a2e:9d8f:0:b0:2d0:5e8d:64d6 with SMTP id c15-20020a2e9d8f000000b002d05e8d64d6mr210273ljj.51.1706832402577; Thu, 01 Feb 2024 16:06:42 -0800 (PST) ARC-Seal: i=2; a=rsa-sha256; t=1706832402; cv=pass; d=google.com; s=arc-20160816; b=08AVq6w+Xf9W/7P+pPwVbNpIhLI6WsIJ/V/Ip9ugMseAg8mCRyZ2sBtnTWOEo0Z6FJ 4qZNcaQ4ObfKnKZvjrQn9wUAMcc/ZruPZ6wvP1f+oQ2dJlaA9KCdDm5c8k5E5ai9T8hY iBskr28nIVr0LHd18FKUjYtdQDgxYYVIg8QkYb8crNjn3DDkTeHnJt4lCcle24xyGgez OtMFOkI9PWK+zghP+KJY2Y8M1qIQlXfNhm4sYics/c4aoGL6z8sJ2v+3bhlTfgxD8Uyg HqOme+5GY/skOfDfKOo3zhcnc8hFQ0Eq78v4vgrZU7wjpJlTVGIbjMzPV36TSkqcrEZ0 0okA== ARC-Message-Signature: i=2; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=cc:to:in-reply-to:references:message-id:content-transfer-encoding :mime-version:list-unsubscribe:list-subscribe:list-id:precedence :subject:date:from; bh=4vcYmNRA1MKCqnb2WVSXZ57mcm+MHGw25qenckmUoko=; fh=v8HjluH0fiTxw1vIJKYuc/vKbblwLunFNKK08eAI0pI=; b=hgG0udJXaaUoPzZ2VszQX0TQo3B2/Y4LRLvaRHNNmSyTd7OoCEIAVj0nioAYCTlEqs Pv5T+ZljiPZ1lJH+I642DEFEXP6lfdX5yxYbNUsViavrqHz8+2W8cxEUfM6l7tWBCBTF coGLFORQCKI+++EnULqHXgB7q56qUc7+jKqZ+rWRErOda0dQOCLmsO11s2NBrjLTEkhq bheCxRKUXI5Mllw3lH7U+f/Nwa8RllPMFek98Hd/Dy07cM+J9tApHzv9BISmvwCruXdH Dg3IZsaa+GU0Z/8KVc4PQ08ukoabDObpir3j0BK9G0Ml8aKsN3zGpV7Pz6jMjPJ1/b64 /Blw==; dara=google.com ARC-Authentication-Results: i=2; mx.google.com; arc=pass (i=1 spf=pass spfdomain=pengutronix.de); spf=pass (google.com: domain of linux-kernel+bounces-49018-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:4601:e00::3 as permitted sender) smtp.mailfrom="linux-kernel+bounces-49018-linux.lists.archive=gmail.com@vger.kernel.org" X-Forwarded-Encrypted: i=1; AJvYcCX9/rrswwn8ngBqBgZf0wLDLOw3ZGtUoLiIfY+K31KSXA20V2TS9OfMhb9mi63iT4Tx+G37iX6VGiDtWTkS84ApVaRq8UNsrtC3XlYuqg== Return-Path: Received: from am.mirrors.kernel.org (am.mirrors.kernel.org. [2604:1380:4601:e00::3]) by mx.google.com with ESMTPS id i41-20020a0564020f2900b0055fe9258761si227124eda.343.2024.02.01.16.06.42 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 01 Feb 2024 16:06:42 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel+bounces-49018-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:4601:e00::3 as permitted sender) client-ip=2604:1380:4601:e00::3; Authentication-Results: mx.google.com; arc=pass (i=1 spf=pass spfdomain=pengutronix.de); spf=pass (google.com: domain of linux-kernel+bounces-49018-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:4601:e00::3 as permitted sender) smtp.mailfrom="linux-kernel+bounces-49018-linux.lists.archive=gmail.com@vger.kernel.org" Received: from smtp.subspace.kernel.org (wormhole.subspace.kernel.org [52.25.139.140]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by am.mirrors.kernel.org (Postfix) with ESMTPS id 2A3201F2507F for ; Fri, 2 Feb 2024 00:06:42 +0000 (UTC) Received: from localhost.localdomain (localhost.localdomain [127.0.0.1]) by smtp.subspace.kernel.org (Postfix) with ESMTP id BFEA35689; Fri, 2 Feb 2024 00:05:39 +0000 (UTC) Received: from metis.whiteo.stw.pengutronix.de (metis.whiteo.stw.pengutronix.de [185.203.201.7]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id E3D6123BF for ; Fri, 2 Feb 2024 00:05:36 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=185.203.201.7 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1706832338; cv=none; b=SQEXKmzzEiAGfmvj2pa4h3TxY1NMMEZPKqrVyMLXORt53x1UVigaT2aIJ63wIMKZlyqfKEx5ZLo9ef7sBgtdQms0IaU+OJGvuGgScMO/ZOoBPNUMQHYI3kwgdUPPBZnzjnN+ioWueLSUPGffSsDS9NV7CvcgJ0rAiknXMDVDJMI= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1706832338; c=relaxed/simple; bh=xahuZ34zPisir7l+Lld5N6MtW7jBLctWjC+/rW1z0ug=; h=From:Date:Subject:MIME-Version:Content-Type:Message-Id:References: In-Reply-To:To:Cc; b=jOXecphuOQMy5ACbiHBONRDC6cq1AHPiP9RyCS2xBSSibOAFT9HK1QdrxMgjWwYBpiArGAvDMYFwv3uYowbB6kT6skHj2lN5A0icInVvNhTKpEvwLsXoRzuXYwGsOhQp0WL3P2+CbrG5Sp+Lt0KpuXHDdK32LnKtq2JO7mrcwvs= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=pengutronix.de; spf=pass smtp.mailfrom=pengutronix.de; arc=none smtp.client-ip=185.203.201.7 Authentication-Results: smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=pengutronix.de Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=pengutronix.de Received: from drehscheibe.grey.stw.pengutronix.de ([2a0a:edc0:0:c01:1d::a2]) by metis.whiteo.stw.pengutronix.de with esmtps (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1rVh3Z-0000d2-Re; Fri, 02 Feb 2024 01:05:21 +0100 Received: from [2a0a:edc0:0:1101:1d::ac] (helo=dude04.red.stw.pengutronix.de) by drehscheibe.grey.stw.pengutronix.de with esmtps (TLS1.3) tls TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (Exim 4.94.2) (envelope-from ) id 1rVh3W-003xQ8-39; Fri, 02 Feb 2024 01:05:18 +0100 Received: from localhost ([::1] helo=dude04.red.stw.pengutronix.de) by dude04.red.stw.pengutronix.de with esmtp (Exim 4.96) (envelope-from ) id 1rVh3V-00AFlM-1l; Fri, 02 Feb 2024 01:05:18 +0100 From: Michael Grzeschik Date: Fri, 02 Feb 2024 01:05:13 +0100 Subject: [PATCH v2 4/4] tools: usb: p9_fwd: add usb gadget packet forwarder script Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: 7bit Message-Id: <20240116-ml-topic-u9p-v2-4-b46cbf592962@pengutronix.de> References: <20240116-ml-topic-u9p-v2-0-b46cbf592962@pengutronix.de> In-Reply-To: <20240116-ml-topic-u9p-v2-0-b46cbf592962@pengutronix.de> To: Eric Van Hensbergen , Latchesar Ionkov , Dominique Martinet , Christian Schoenebeck , Jonathan Corbet , Greg Kroah-Hartman Cc: v9fs@lists.linux.dev, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, linux-usb@vger.kernel.org, kernel@pengutronix.de, Michael Grzeschik X-Mailer: b4 0.12.0 X-Developer-Signature: v=1; a=openpgp-sha256; l=9207; i=m.grzeschik@pengutronix.de; h=from:subject:message-id; bh=xahuZ34zPisir7l+Lld5N6MtW7jBLctWjC+/rW1z0ug=; b=owEBbQKS/ZANAwAKAb9pWET5cfSrAcsmYgBlvDG9NEOGflYQjx9gIoLCgj6t4KvulBz75sp5U HelQskD9GSJAjMEAAEKAB0WIQQV2+2Fpbqd6fvv0Gi/aVhE+XH0qwUCZbwxvQAKCRC/aVhE+XH0 qy0wEACpT2RlxnfBP48RD0POGPqIR/dU95jTJHJV3KACFhKtD4bmMcvmUPMncAWBzSzl7iKxcZw FRXhe8R75nFiLFo7QHdh0O3mZE2pj72wLjy1W3ERHaNzmpBTbWJ4YO1W2P3RZrIkhIiDhC6q7o+ gBx7V+BXQdXRX5xMLzTgY9nhG4vThlJY99mkw4lX3NFSussQhCM/palTLzF/oh4afPddH0DIYnq KZaOB2fTFeP4JMbNeVk6gtIhsCxBO4QVFBIEONRXZnLZ0MjUahdtZGx+mExOY9g2u0TYrf2ktwO vL0yvWRubOVpVABrMLe7sCzlcoJJHNJQQlMK9uir7LDyRP7mfvG3uv514kWH2tuCMxaWjHAi+I9 8vf4cGyTENBsWQ1yHIgRJWIq3klC3bDJ+ZrTGE3hkCYxE2CD2mvzEOEidPKs2ixiFQ77Kim4mJ1 rIMKgk+2FmImAIzH9L8opJ7V/GQhgtf10GZC9Ltl2wXmAf5GNV4xVVvDjTqcbuI6jd2b9a2qXVY hsd1deGIgTtVj7VKV09YXc9pg72U/k3QWGX79HttJNwKtwOpFkhYa9oy2yVdKufYzZPirNWHMD7 nnvZJAST5dwjVTcMS3QDfNXRxRuN+wZkfFJ93X/XTiQ+AN2EfjbgtrwutPTx2UYQ4VBqzLW/0me b7+/1SSA1OasFBg== X-Developer-Key: i=m.grzeschik@pengutronix.de; a=openpgp; fpr=957BC452CE953D7EA60CF4FC0BE9E3157A1E2C64 X-SA-Exim-Connect-IP: 2a0a:edc0:0:c01:1d::a2 X-SA-Exim-Mail-From: m.grzeschik@pengutronix.de X-SA-Exim-Scanned: No (on metis.whiteo.stw.pengutronix.de); SAEximRunCond expanded to false X-PTX-Original-Recipient: linux-kernel@vger.kernel.org This patch is adding an small python tool to forward 9pfs requests from the USB gadget to an existing 9pfs TCP server. Since currently all 9pfs servers lack support for the usb transport this tool is an useful helper to get started. Refer the Documentation section "USBG Example" in Documentation/filesystems/9p.rst on how to use it. Signed-off-by: Michael Grzeschik --- v1 -> v2: - added usbg 9pfs detailed instructions to 9p.rst doc --- Documentation/filesystems/9p.rst | 32 +++++++ tools/usb/p9_fwd.py | 194 +++++++++++++++++++++++++++++++++++++++ 2 files changed, 226 insertions(+) diff --git a/Documentation/filesystems/9p.rst b/Documentation/filesystems/9p.rst index 64439068a8fc5..264265c72ba67 100644 --- a/Documentation/filesystems/9p.rst +++ b/Documentation/filesystems/9p.rst @@ -67,6 +67,38 @@ To mount a 9p FS on a USB Host accessible via the gadget as root filesystem:: where mount_tag is the tag associated by the usb gadget transport. The pattern is usb9pfs0, usb9pfs1, ... +USBG Example +============ + +The USB host exports a filesystem, while the gadget on the USB device +side makes it mountable. + +Diod (9pfs server) and the forwarder are on the development host, where +the root filesystem is actually stored. The gadget is initialized during +boot (or later) on the embedded board. Then the forwarder will find it +on the USB bus and start forwarding requests. + +In this case the 9p requests come from the device and are handled by the +host. The reason is that USB device ports are normally not available on +PCs, so a connection in the other direction would not work. + +When using the usbg transport, for now there is no native usb host +service capable to handle the requests from the gadget driver. For +this we have to use the extra python tool p9_fwd.py from tools/usb. + +Just start the 9pfs capable network server like diod/nfs-ganesha e.g.: + + $ diod -f -n -d 0 -S -l 0.0.0.0:9999 -e $PWD + +Then start the python transport: + + $ python $kernel_dir/tools/usb/p9_fwd.py -p 9999 + +After that the gadget driver can be used as described above. + +One use-case is to use it as an alternative to NFS root booting during +the development of embedded Linux devices. + Options ======= diff --git a/tools/usb/p9_fwd.py b/tools/usb/p9_fwd.py new file mode 100755 index 0000000000000..95208df11abef --- /dev/null +++ b/tools/usb/p9_fwd.py @@ -0,0 +1,194 @@ +#!/usr/bin/env python3 +# SPDX-License-Identifier: GPL-2.0 + +import argparse +import errno +import logging +import socket +import struct +import sys +import time + +import usb.core +import usb.util + + +class Forwarder: + HEXDUMP_FILTER = ( + "".join(chr(x).isprintable() and chr(x) or "." for x in range(128)) + "." * 128 + ) + + @staticmethod + def _log_hexdump(data): + if not logging.root.isEnabledFor(logging.TRACE): + return + L = 16 + for c in range(0, len(data), L): + chars = data[c : c + L] + dump = " ".join(f"{x:02x}" for x in chars) + printable = "".join(HEXDUMP_FILTER[x] for x in chars) + line = f"{c:08x} {dump:{L*3}s} |{printable:{L}s}|" + logging.root.log(logging.TRACE, "%s", line) + + def __init__(self, server): + self.stats = { + "c2s packets": 0, + "c2s bytes": 0, + "s2c packets": 0, + "s2c bytes": 0, + } + self.stats_logged = time.monotonic() + + dev = usb.core.find(idVendor=0x1D6B, idProduct=0x0109) + if dev is None: + raise ValueError("Device not found") + + logging.info(f"found device: {dev.bus}/{dev.address}") + + # dev.set_configuration() is not necessary since g_multi has only one + usb9pfs = None + # g_multi adds 9pfs as last interface + cfg = dev.get_active_configuration() + for intf in cfg: + # we have to detach the usb-storage driver from multi gadget since + # stall option could be set, which will lead to spontaneous port + # resets and our transfers will run dead + if intf.bInterfaceClass == 0x08: + if dev.is_kernel_driver_active(intf.bInterfaceNumber): + dev.detach_kernel_driver(intf.bInterfaceNumber) + + if ( + intf.bInterfaceClass == 0xFF + and intf.bInterfaceSubClass == 0xFF + and intf.bInterfaceProtocol == 0x09 + ): + usb9pfs = intf + if usb9pfs is None: + raise ValueError("Interface not found") + + logging.info(f"claiming interface:\n{usb9pfs}") + usb.util.claim_interface(dev, usb9pfs.bInterfaceNumber) + ep_out = usb.util.find_descriptor( + usb9pfs, + custom_match=lambda e: usb.util.endpoint_direction(e.bEndpointAddress) + == usb.util.ENDPOINT_OUT, + ) + assert ep_out is not None + ep_in = usb.util.find_descriptor( + usb9pfs, + custom_match=lambda e: usb.util.endpoint_direction(e.bEndpointAddress) + == usb.util.ENDPOINT_IN, + ) + assert ep_in is not None + logging.info(f"interface claimed") + + self.ep_out = ep_out + self.ep_in = ep_in + self.dev = dev + + # create and connect socket + self.s = socket.socket(socket.AF_INET, socket.SOCK_STREAM) + self.s.connect(server) + + logging.info(f"connected to server") + + def c2s(self): + """forward a request from the USB client to the TCP server""" + data = None + while data is None: + try: + logging.log(logging.TRACE, "c2s: reading") + data = self.ep_in.read(self.ep_in.wMaxPacketSize) + except usb.core.USBTimeoutError: + logging.log(logging.TRACE, "c2s: reading timed out") + continue + except usb.core.USBError as e: + if e.errno == errno.EIO: + logging.debug("c2s: reading failed with %s, retrying", repr(e)) + time.sleep(0.5) + continue + else: + logging.error("c2s: reading failed with %s, aborting", repr(e)) + raise + size = struct.unpack(" 0 + data = data[written:] + if size % self.ep_out.wMaxPacketSize == 0: + logging.log(logging.TRACE, "sending zero length packet") + self.ep_out.write(b"") + logging.debug("s2c: forwarded %i bytes", size) + self.stats["s2c packets"] += 1 + self.stats["s2c bytes"] += size + + def log_stats(self): + logging.info("statistics:") + for k, v in self.stats.items(): + logging.info(f" {k+':':14s} {v}") + + def log_stats_interval(self, interval=5): + if (time.monotonic() - self.stats_logged) < interval: + return + + self.log_stats() + self.stats_logged = time.monotonic() + + +def main(): + parser = argparse.ArgumentParser( + description="Forward 9PFS requests from USB to TCP", + ) + + parser.add_argument( + "-s", "--server", type=str, default="127.0.0.1", help="server hostname" + ) + parser.add_argument("-p", "--port", type=int, default=564, help="server port") + parser.add_argument("-v", "--verbose", action="count", default=0) + + args = parser.parse_args() + + logging.TRACE = logging.DEBUG - 5 + logging.addLevelName(logging.TRACE, "TRACE") + + if args.verbose >= 2: + level = logging.TRACE + elif args.verbose: + level = logging.DEBUG + else: + level = logging.INFO + logging.basicConfig( + level=level, format="%(asctime)-15s %(levelname)-8s %(message)s" + ) + + f = Forwarder(server=(args.server, args.port)) + + try: + while True: + f.c2s() + f.s2c() + f.log_stats_interval() + finally: + f.log_stats() + + +if __name__ == "__main__": + main() -- 2.39.2