From patchwork Fri Mar 17 08:09:42 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: 71207 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a5d:604a:0:0:0:0:0 with SMTP id j10csp230994wrt; Fri, 17 Mar 2023 02:14:18 -0700 (PDT) X-Google-Smtp-Source: AK7set9nWQSBuDAlp7A6Kc0sasg25T3kV4KFFDmIMk3DTse+OO5OdiXevSDJkJs5C1cLVr7tbGy+ X-Received: by 2002:a05:6a00:844:b0:625:6439:657a with SMTP id q4-20020a056a00084400b006256439657amr7052039pfk.0.1679044458561; Fri, 17 Mar 2023 02:14:18 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1679044458; cv=none; d=google.com; s=arc-20160816; b=R6TFd/HvZ8phZtk0JYPbPdsIlFsM5mcv7/DoUhtrzVVD/Zra2CMwhQ4G6TJbne5JKg V0Cn4kt8PNcRNSAii6gaL2p1HnbfwcjW2MlG0tT8mVyxAuXfdfLKYdwHb6Xqa/kib7fV N2zT5Xa8315Xpyh5meLJ51z63sqFjCqBWtQex6WG8RMqngyGANvmNtvBeNuIwTiQYiq7 kxkvqDqw9DoqFsyC3KbGsVXUaq7o/c4fm2gcb7g6TxUVmMmMCuOjGkDupXURCDggpxAv fUBJeXIwE11vLohz99oNkPsoNJ3TLmaV7YQSrml4tV9Cofhxz25jfhr3C2PBt09oEs+9 Khqw== 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=FGfHOBVymC0DHuKRYmnC5Uxx4OWvdn5zdJ7U9DYtQ5U=; b=qIxzOw4uJ4ldVgT4HOCVuDE+NhCCNckDsaaqC2RywL8n49qqSdonFS2SARp1BtUSol vBznUDkYTGP5JMpVCwBDQu5A+aHucdIztXqer7bEbwbiXbxFP5nCg4PB1M3yPYUJGu4y xA/h2fbBLLMt6klLI+Lw+Dj1tTddWCMlsOaIly5ZcvUi7ggbJ8yb3lZt1qdgG7nL/q8M afk4efSUrAAkyErTeYjMAtWBT16wBNKtSzHORCzQJrO5Nwc7QQtHPbpRl8cQoyxdOH6w 9oKyuD9QwUrLH2MfWsZzIgNJXIBC4vZRVsQfiK8/Efis3nn7LECJin5CMKGvz1CriKyZ wajA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@mediatek.com header.s=dk header.b=ikcEbLkI; 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 x24-20020a63db58000000b005030009496asi1834753pgi.34.2023.03.17.02.14.05; Fri, 17 Mar 2023 02:14:18 -0700 (PDT) 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=ikcEbLkI; 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 S231488AbjCQJHz (ORCPT + 99 others); Fri, 17 Mar 2023 05:07:55 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:33196 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229962AbjCQJHf (ORCPT ); Fri, 17 Mar 2023 05:07:35 -0400 Received: from mailgw02.mediatek.com (unknown [210.61.82.184]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id F120B4ED0; Fri, 17 Mar 2023 02:06:33 -0700 (PDT) X-UUID: d938815ec49b11edbd2e61cc88cc8f98-20230317 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=FGfHOBVymC0DHuKRYmnC5Uxx4OWvdn5zdJ7U9DYtQ5U=; b=ikcEbLkIxAEIvahriLsuh87t+6pHsv62MC2euRW7W9W4qEOlBJ6pq1fuLCxlffXOOWcIw3Nul//yFdEu+x7OqO1j1SkiVGlFbGd9tr17LgJXEBn00x6Yg/FDGWEzfkWUqdjNezUVC38sZdappQlZYPcKaLgfK1dj7yDJyyXGVe8=; X-CID-P-RULE: Release_Ham X-CID-O-INFO: VERSION:1.1.21,REQID:80b96f3b-72fc-4b21-b459-4786f0e423e3,IP:0,U RL:0,TC:0,Content:0,EDM:0,RT:0,SF:0,FILE:0,BULK:0,RULE:Release_Ham,ACTION: release,TS:0 X-CID-META: VersionHash:83295aa,CLOUDID:8859ac28-564d-42d9-9875-7c868ee415ec,B ulkID:nil,BulkQuantity:0,Recheck:0,SF:102,TC:nil,Content:0,EDM:-3,IP:nil,U RL:11|1,File:nil,Bulk:nil,QS:nil,BEC:nil,COL:0,OSI:0,OSA:0,AV:0 X-CID-BVR: 0,NGT X-CID-BAS: 0,NGT,0,_ X-UUID: d938815ec49b11edbd2e61cc88cc8f98-20230317 Received: from mtkmbs11n2.mediatek.inc [(172.21.101.187)] by mailgw02.mediatek.com (envelope-from ) (Generic MTA with TLSv1.2 ECDHE-RSA-AES256-GCM-SHA384 256/256) with ESMTP id 1577523023; Fri, 17 Mar 2023 16:15:16 +0800 Received: from mtkmbs11n2.mediatek.inc (172.21.101.187) by mtkmbs13n2.mediatek.inc (172.21.101.108) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.2.1118.25; Fri, 17 Mar 2023 16:15:14 +0800 Received: from mcddlt001.gcn.mediatek.inc (10.19.240.15) by mtkmbs11n2.mediatek.inc (172.21.101.73) with Microsoft SMTP Server id 15.2.1118.25 via Frontend Transport; Fri, 17 Mar 2023 16:15:13 +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 v4 10/10] net: wwan: tmi: Add maintainers and documentation Date: Fri, 17 Mar 2023 16:09:42 +0800 Message-ID: <20230317080942.183514-11-yanchao.yang@mediatek.com> X-Mailer: git-send-email 2.18.0 In-Reply-To: <20230317080942.183514-1-yanchao.yang@mediatek.com> References: <20230317080942.183514-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,URIBL_BLOCKED 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?1760605722444040038?= X-GMAIL-MSGID: =?utf-8?q?1760605722444040038?= 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 edd3d562beee..5224a42be5ff 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -13187,6 +13187,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