From patchwork Sat Feb 11 08:37:32 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: =?utf-8?b?WWFuY2hhbyBZYW5nICjmnajlvabotoUp?= X-Patchwork-Id: 55756 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:adf:eb09:0:0:0:0:0 with SMTP id s9csp1401328wrn; Sat, 11 Feb 2023 00:49:58 -0800 (PST) X-Google-Smtp-Source: AK7set+03sm6jkWrugy6Nmn0ZnBab/1784zEMU98ZJ7uJxWBfomV8H7LmYPXTWX3JIOb0tmxD6G9 X-Received: by 2002:a17:903:230c:b0:199:15d6:489b with SMTP id d12-20020a170903230c00b0019915d6489bmr17857274plh.22.1676105398387; Sat, 11 Feb 2023 00:49:58 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1676105398; cv=none; d=google.com; s=arc-20160816; b=zEuTN6PBBZWe88SCCLZv6cn6A+3EDCEoBTr+FIik++P8LTkPPBLN36Li3AT5YcsTCY N0VvnBMzoArPlKr6OD8t8HBVG6I1zq0QMfaMhz/P1aOBDpFFUhxbss6S3p3w5z84Zh8o VED0XhG2vImuUx1CIMs1ab2o3YX0vEvW0SeDBAx4W8DgDh38LFJgWzIxRRjsOfy0/m8X tOLr6SMbsqsokYFduBBX+CAPAfv7wDSkXtVClhl/BkUrbF1qhOUjo1liG1i7E+plHBe7 nOGgrgwMHnwDBsPfcHehvohYL3rkS1QKxonus+TpdUYjtGRG8O1Y+UyiOJCHwCJ5zhJX j0Rw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:mime-version:references:in-reply-to:message-id :date:subject:cc:to:from:dkim-signature; bh=HWdLzUSugUMSgO/oMH5yCErnAFFDCPCQAIwaGw1DuZM=; b=BzpBbr/tHclv3szCXPPmG7QjM6JaoX8vbwomLYNnu8DhUj1FMtjo891Pu9HEvddqXV 4X5CURrvAJ7KH9E7GZqZ7MO46ZmsLgd94kmD7YpELFbSFIEtekOKsx0ivUfWaxg4XuEJ oTj/CwtzUyUjJCC45JSBK+wKoGx5r1Oujdm+Sc2MVAFXgw0KgUkqUZS/SsJIg/Xyh3ju 3pZUl2+qXt/1Z9FPxwVDNVlm0eqIHZz5w7bSPvy0gewiOUdgnhrsmwNju8mo8VzA9wsT hzqqj0/uwgvI036VG7PIdVmw2TKkx54kZmqhhu5x2Z90K18fkXbZIdrCrq0vsv9wuhCf wBDg== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@mediatek.com header.s=dk header.b=FlMcUL7p; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=QUARANTINE sp=QUARANTINE dis=NONE) header.from=mediatek.com Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id p2-20020a170902e74200b0019a6c7e0ef3si5304862plf.485.2023.02.11.00.49.45; Sat, 11 Feb 2023 00:49:58 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; dkim=pass header.i=@mediatek.com header.s=dk header.b=FlMcUL7p; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=QUARANTINE sp=QUARANTINE dis=NONE) header.from=mediatek.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229787AbjBKIqX (ORCPT + 99 others); Sat, 11 Feb 2023 03:46:23 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:42568 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229468AbjBKIqU (ORCPT ); Sat, 11 Feb 2023 03:46:20 -0500 Received: from mailgw01.mediatek.com (unknown [60.244.123.138]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id E40CB6CC56; Sat, 11 Feb 2023 00:45:37 -0800 (PST) X-UUID: 6db64acea9e811eda06fc9ecc4dadd91-20230211 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=mediatek.com; s=dk; h=Content-Type:MIME-Version:References:In-Reply-To:Message-ID:Date:Subject:CC:To:From; bh=HWdLzUSugUMSgO/oMH5yCErnAFFDCPCQAIwaGw1DuZM=; b=FlMcUL7pBUl3zZA6HRsuxdSvOk/Hx22XFxNMJ3HedDjgTla+yBgN7j9PD2THB7Z1zTfAkR7RP62l2lYHEpOUUmvPKkWqN8Wvg3Smn81dllDprvqQGdSicRocrNducd8KKZGq794X7q+CjESg67SeURnBDH8JX9pi7Fn91aFmlKA=; X-CID-P-RULE: Release_Ham X-CID-O-INFO: VERSION:1.1.19,REQID:12f6ae51-5888-42e5-a33e-db263c8ddc4d,IP:0,U RL:0,TC:0,Content:0,EDM:0,RT:0,SF:95,FILE:0,BULK:0,RULE:Release_Ham,ACTION :release,TS:95 X-CID-INFO: VERSION:1.1.19,REQID:12f6ae51-5888-42e5-a33e-db263c8ddc4d,IP:0,URL :0,TC:0,Content:0,EDM:0,RT:0,SF:95,FILE:0,BULK:0,RULE:Spam_GS981B3D,ACTION :quarantine,TS:95 X-CID-META: VersionHash:885ddb2,CLOUDID:ca94f756-dd49-462e-a4be-2143a3ddc739,B ulkID:230211164526Y5ZZ8ZYF,BulkQuantity:0,Recheck:0,SF:38|29|28|17|19|48,T C:nil,Content:0,EDM:-3,IP:nil,URL:11|1,File:nil,Bulk:nil,QS:nil,BEC:nil,CO L:0,OSI:0,OSA:0,AV:0 X-CID-BVR: 0,NGT X-UUID: 6db64acea9e811eda06fc9ecc4dadd91-20230211 Received: from mtkmbs13n1.mediatek.inc [(172.21.101.193)] by mailgw01.mediatek.com (envelope-from ) (Generic MTA with TLSv1.2 ECDHE-RSA-AES256-GCM-SHA384 256/256) with ESMTP id 1595918131; Sat, 11 Feb 2023 16:45:25 +0800 Received: from mtkmbs13n1.mediatek.inc (172.21.101.193) by mtkmbs10n2.mediatek.inc (172.21.101.183) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.2.792.3; Sat, 11 Feb 2023 16:45:24 +0800 Received: from mcddlt001.gcn.mediatek.inc (10.19.240.15) by mtkmbs13n1.mediatek.inc (172.21.101.73) with Microsoft SMTP Server id 15.2.792.15 via Frontend Transport; Sat, 11 Feb 2023 16:45:22 +0800 From: Yanchao Yang To: Loic Poulain , Sergey Ryazanov , Johannes Berg , "David S . Miller" , Eric Dumazet , "Jakub Kicinski" , Paolo Abeni , netdev ML , kernel ML CC: Intel experts , Chetan , MTK ML , Liang Lu , Haijun Liu , Hua Yang , Ting Wang , Felix Chen , Mingliang Xu , Min Dong , Aiden Wang , Guohao Zhang , Chris Feng , "Yanchao Yang" , Lambert Wang , Mingchuang Qiao , Xiayu Zhang , Haozhe Chang Subject: [PATCH net-next v3 10/10] net: wwan: tmi: Add maintainers and documentation Date: Sat, 11 Feb 2023 16:37:32 +0800 Message-ID: <20230211083732.193650-11-yanchao.yang@mediatek.com> X-Mailer: git-send-email 2.18.0 In-Reply-To: <20230211083732.193650-1-yanchao.yang@mediatek.com> References: <20230211083732.193650-1-yanchao.yang@mediatek.com> MIME-Version: 1.0 X-MTK: N X-Spam-Status: No, score=-2.1 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_MSPIKE_H2,SPF_HELO_PASS, SPF_PASS,UNPARSEABLE_RELAY autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1757523894296130932?= X-GMAIL-MSGID: =?utf-8?q?1757523894296130932?= Adds maintainers and documentation for MediaTek TMI 5G WWAN modem device driver. Signed-off-by: Yanchao Yang Signed-off-by: Felix Chen --- .../networking/device_drivers/wwan/index.rst | 1 + .../networking/device_drivers/wwan/tmi.rst | 48 +++++++++++++++++++ MAINTAINERS | 11 +++++ 3 files changed, 60 insertions(+) create mode 100644 Documentation/networking/device_drivers/wwan/tmi.rst diff --git a/Documentation/networking/device_drivers/wwan/index.rst b/Documentation/networking/device_drivers/wwan/index.rst index 370d8264d5dc..8298629b4d55 100644 --- a/Documentation/networking/device_drivers/wwan/index.rst +++ b/Documentation/networking/device_drivers/wwan/index.rst @@ -10,6 +10,7 @@ Contents: iosm t7xx + tmi .. only:: subproject and html diff --git a/Documentation/networking/device_drivers/wwan/tmi.rst b/Documentation/networking/device_drivers/wwan/tmi.rst new file mode 100644 index 000000000000..3655779bf692 --- /dev/null +++ b/Documentation/networking/device_drivers/wwan/tmi.rst @@ -0,0 +1,48 @@ +.. SPDX-License-Identifier: BSD-3-Clause-Clear + +.. Copyright (c) 2022, MediaTek Inc. + +.. _tmi_driver_doc: + +==================================================== +TMI driver for MTK PCIe based T-series 5G Modem +==================================================== +The TMI(T-series Modem Interface) driver is a WWAN PCIe host driver developed +for data exchange over PCIe interface between Host platform and MediaTek's +T-series 5G modem. The driver exposes control plane and data plane interfaces +to applications. The control plane provides device node interfaces for control +data transactions. The data plane provides network link interfaces for IP data +transactions. + +Control channel userspace ABI +============================= +/dev/wwan0at0 character device +------------------------------ +The driver exposes an AT port by implementing AT WWAN Port. +The userspace end of the control channel pipe is a /dev/wwan0at0 character +device. Application shall use this interface to issue AT commands. + +/dev/wwan0mbim0 character device +-------------------------------- +The driver exposes an MBIM interface to the MBIM function by implementing +MBIM WWAN Port. The userspace end of the control channel pipe is a +/dev/wwan0mbim0 character device. Applications shall use this interface +for MBIM protocol communication. + +Data channel userspace ABI +========================== +wwan0-X network device +---------------------- +The TMI driver exposes IP link interfaces "wwan0-X" of type "wwan" for IP +traffic. Iproute network utility is used for creating "wwan0-X" network +interfaces and for associating it with the MBIM IP session. + +The userspace management application is responsible for creating a new IP link +prior to establishing an MBIM IP session where the SessionId is greater than 0. + +For example, creating a new IP link for an MBIM IP session with SessionId 1: + + ip link add dev wwan0-1 parentdev wwan0 type wwan linkid 1 + +The driver will automatically map the "wwan0-1" network device to MBIM IP +session 1. diff --git a/MAINTAINERS b/MAINTAINERS index 7f0b7181e60a..30aa7d7c783e 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -13254,6 +13254,17 @@ L: netdev@vger.kernel.org S: Supported F: drivers/net/wwan/t7xx/ +MEDIATEK TMI 5G WWAN MODEM DRIVER +M: Yanchao Yang +M: Min Dong +M: MediaTek Corporation +R: Liang Lu +R: Haijun Liu +R: Lambert Wang +L: netdev@vger.kernel.org +S: Supported +F: drivers/net/wwan/tmi/ + MEDIATEK USB3 DRD IP DRIVER M: Chunfeng Yun L: linux-usb@vger.kernel.org