diff mbox series

[net-next,v1,13/13] net: wwan: tmi: Add maintainers and documentation

Message ID 20221122112710.161020-1-yanchao.yang@mediatek.com
State New
Headers
Series net: wwan: tmi: PCIe driver for MediaTek M.2 modem |

Commit Message

Yanchao Yang (杨彦超) Nov. 22, 2022, 11:27 a.m. UTC 
  From: MediaTek Corporation <linuxwwan@mediatek.com>

Adds maintainers and documentation for MediaTek TMI 5G WWAN modem
device driver.

Signed-off-by: Felix Chen <felix.chen@mediatek.com>
Signed-off-by: MediaTek Corporation <linuxwwan@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

Comments

Leon Romanovsky Nov. 22, 2022, 2:29 p.m. UTC | #1 
On Tue, Nov 22, 2022 at 07:27:10PM +0800, Yanchao Yang wrote:
> From: MediaTek Corporation <linuxwwan@mediatek.com>
> 
> Adds maintainers and documentation for MediaTek TMI 5G WWAN modem
> device driver.
> 
> Signed-off-by: Felix Chen <felix.chen@mediatek.com>
> Signed-off-by: MediaTek Corporation <linuxwwan@mediatek.com>

Author and SOB should have real names and can't be company.

Thanks
Yanchao Yang (杨彦超) Nov. 23, 2022, 6:18 a.m. UTC | #2 
On Tue, 2022-11-22 at 16:29 +0200, Leon Romanovsky wrote:
> On Tue, Nov 22, 2022 at 07:27:10PM +0800, Yanchao Yang wrote:
> > From: MediaTek Corporation <linuxwwan@mediatek.com>
> > 
> > Adds maintainers and documentation for MediaTek TMI 5G WWAN modem
> > device driver.
> > 
> > Signed-off-by: Felix Chen <felix.chen@mediatek.com>
> > Signed-off-by: MediaTek Corporation <linuxwwan@mediatek.com>
> 
> Author and SOB should have real names and can't be company.
> 
> Thanks

Thank your suggestion. fix it next version(1. remove SOB company's
name; 2. add authour name, ex:  From: MediaTek Corporation <
linuxwwan@mediatek.com> --> From: Yanchao Yang <
yanchao.yang@mediatek.com>)

Many thanks.
diff mbox series

Patch

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 a96c60c787af..eac544b274ac 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -13058,6 +13058,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