From: Yanchao Yang <yanchao.yang@mediatek.com>
To: Loic Poulain <loic.poulain@linaro.org>,
Sergey Ryazanov <ryazanov.s.a@gmail.com>,
Johannes Berg <johannes@sipsolutions.net>,
"David S . Miller" <davem@davemloft.net>,
Eric Dumazet <edumazet@google.com>,
"Jakub Kicinski" <kuba@kernel.org>,
Paolo Abeni <pabeni@redhat.com>,
netdev ML <netdev@vger.kernel.org>,
kernel ML <linux-kernel@vger.kernel.org>
Cc: Intel experts <linuxwwan@intel.com>,
Chetan <m.chetan.kumar@intel.com>,
MTK ML <linux-mediatek@lists.infradead.org>,
Liang Lu <liang.lu@mediatek.com>,
Haijun Liu <haijun.liu@mediatek.com>,
Hua Yang <hua.yang@mediatek.com>,
Ting Wang <ting.wang@mediatek.com>,
Felix Chen <felix.chen@mediatek.com>,
Mingliang Xu <mingliang.xu@mediatek.com>,
Min Dong <min.dong@mediatek.com>,
Aiden Wang <aiden.wang@mediatek.com>,
Guohao Zhang <guohao.zhang@mediatek.com>,
Chris Feng <chris.feng@mediatek.com>,
"Yanchao Yang" <yanchao.yang@mediatek.com>,
Lambert Wang <lambert.wang@mediatek.com>,
Mingchuang Qiao <mingchuang.qiao@mediatek.com>,
Xiayu Zhang <xiayu.zhang@mediatek.com>,
Haozhe Chang <haozhe.chang@mediatek.com>
Subject: [PATCH net-next v3 10/10] net: wwan: tmi: Add maintainers and documentation
Date: Sat, 11 Feb 2023 16:37:32 +0800 [thread overview]
Message-ID: <20230211083732.193650-11-yanchao.yang@mediatek.com> (raw)
In-Reply-To: <20230211083732.193650-1-yanchao.yang@mediatek.com>
Adds maintainers and documentation for MediaTek TMI 5G WWAN modem
device driver.
Signed-off-by: Yanchao Yang <yanchao.yang@mediatek.com>
Signed-off-by: Felix Chen <felix.chen@mediatek.com>
---
.../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 <yanchao.yang@mediatek.com>
+M: Min Dong <min.dong@mediatek.com>
+M: MediaTek Corporation <linuxwwan@mediatek.com>
+R: Liang Lu <liang.lu@mediatek.com>
+R: Haijun Liu <haijun.liu@mediatek.com>
+R: Lambert Wang <lambert.wang@mediatek.com>
+L: netdev@vger.kernel.org
+S: Supported
+F: drivers/net/wwan/tmi/
+
MEDIATEK USB3 DRD IP DRIVER
M: Chunfeng Yun <chunfeng.yun@mediatek.com>
L: linux-usb@vger.kernel.org
--
2.32.0
prev parent reply other threads:[~2023-02-11 8:46 UTC|newest]
Thread overview: 23+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-02-11 8:37 [PATCH net-next v3 00/10] net: wwan: tmi: PCIe driver for MediaTek M.2 modem Yanchao Yang
2023-02-11 8:37 ` [PATCH net-next v3 01/10] net: wwan: tmi: Add PCIe core Yanchao Yang
2023-02-15 4:22 ` Jakub Kicinski
2023-02-16 12:50 ` Yanchao Yang (杨彦超)
2023-02-16 18:10 ` Jakub Kicinski
2023-02-24 7:39 ` Yanchao Yang (杨彦超)
2023-02-24 19:50 ` Jakub Kicinski
2023-02-27 12:11 ` Yanchao Yang (杨彦超)
2023-02-27 19:00 ` Jakub Kicinski
2023-02-28 7:47 ` Yanchao Yang (杨彦超)
[not found] ` <20230228103132.325def4c@kernel.org>
2023-03-01 3:35 ` Yanchao Yang (杨彦超)
2023-03-01 4:05 ` Jakub Kicinski
2023-03-02 9:08 ` Yanchao Yang (杨彦超)
2023-03-17 8:50 ` Yanchao Yang (杨彦超)
2023-02-11 8:37 ` [PATCH net-next v3 02/10] net: wwan: tmi: Add control plane transaction layer Yanchao Yang
2023-02-11 8:37 ` [PATCH net-next v3 03/10] net: wwan: tmi: Add control DMA interface Yanchao Yang
2023-02-11 8:37 ` [PATCH net-next v3 04/10] net: wwan: tmi: Add control port Yanchao Yang
2023-02-11 8:37 ` [PATCH net-next v3 05/10] net: wwan: tmi: Add FSM thread Yanchao Yang
2023-02-11 8:37 ` [PATCH net-next v3 06/10] net: wwan: tmi: Add AT & MBIM WWAN ports Yanchao Yang
2023-02-11 8:37 ` [PATCH net-next v3 07/10] net: wwan: tmi: Introduce data plane hardware interface Yanchao Yang
2023-02-11 8:37 ` [PATCH net-next v3 08/10] net: wwan: tmi: Add data plane transaction layer Yanchao Yang
2023-02-11 8:37 ` [PATCH net-next v3 09/10] net: wwan: tmi: Introduce WWAN interface Yanchao Yang
2023-02-11 8:37 ` Yanchao Yang [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20230211083732.193650-11-yanchao.yang@mediatek.com \
--to=yanchao.yang@mediatek.com \
--cc=aiden.wang@mediatek.com \
--cc=chris.feng@mediatek.com \
--cc=davem@davemloft.net \
--cc=edumazet@google.com \
--cc=felix.chen@mediatek.com \
--cc=guohao.zhang@mediatek.com \
--cc=haijun.liu@mediatek.com \
--cc=haozhe.chang@mediatek.com \
--cc=hua.yang@mediatek.com \
--cc=johannes@sipsolutions.net \
--cc=kuba@kernel.org \
--cc=lambert.wang@mediatek.com \
--cc=liang.lu@mediatek.com \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-mediatek@lists.infradead.org \
--cc=linuxwwan@intel.com \
--cc=loic.poulain@linaro.org \
--cc=m.chetan.kumar@intel.com \
--cc=min.dong@mediatek.com \
--cc=mingchuang.qiao@mediatek.com \
--cc=mingliang.xu@mediatek.com \
--cc=netdev@vger.kernel.org \
--cc=pabeni@redhat.com \
--cc=ryazanov.s.a@gmail.com \
--cc=ting.wang@mediatek.com \
--cc=xiayu.zhang@mediatek.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).