Skip to content

RFC net: iosm: PCIe Driver for Intel M.2 Modem

M Chetan Kumar linux-wireless netdev oe-kbuild-all 1 version New

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 RFC Latest18 patches 0 repliesNew

Patches in v1 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/18net: iosm: entry pointdrivers/net/wwan/iosm/iosm_ipc_pcie.c drivers/net/wwan/iosm/iosm_ipc_pcie.h+699 -00 replies
2/18net: iosm: irq handlingdrivers/net/wwan/iosm/iosm_ipc_irq.c drivers/net/wwan/iosm/iosm_ipc_irq.h+130 -00 replies
3/18net: iosm: mmio scratchpaddrivers/net/wwan/iosm/iosm_ipc_mmio.c drivers/net/wwan/iosm/iosm_ipc_mmio.h+414 -00 replies
4/18net: iosm: shared memory IPC interfacedrivers/net/wwan/iosm/iosm_ipc_imem.c drivers/net/wwan/iosm/iosm_ipc_imem.h+2072 -00 replies
5/18net: iosm: shared memory I/O operationsdrivers/net/wwan/iosm/iosm_ipc_imem_ops.c drivers/net/wwan/iosm/iosm_ipc_imem_ops.h+881 -00 replies
6/18net: iosm: channel configurationdrivers/net/wwan/iosm/iosm_ipc_chnl_cfg.c drivers/net/wwan/iosm/iosm_ipc_chnl_cfg.h+144 -00 replies
7/18net: iosm: char device for FW flash & coredumpdrivers/net/wwan/iosm/iosm_ipc_sio.c drivers/net/wwan/iosm/iosm_ipc_sio.h+260 -00 replies
8/18net: iosm: MBIM control devicedrivers/net/wwan/iosm/iosm_ipc_mbim.c drivers/net/wwan/iosm/iosm_ipc_mbim.h+229 -00 replies
9/18net: iosm: bottom halfdrivers/net/wwan/iosm/iosm_ipc_task_queue.c drivers/net/wwan/iosm/iosm_ipc_task_queue.h+304 -00 replies
10/18net: iosm: multiplex IP sessionsdrivers/net/wwan/iosm/iosm_ipc_mux.c drivers/net/wwan/iosm/iosm_ipc_mux.h+799 -00 replies
11/18net: iosm: encode or decode datagramdrivers/net/wwan/iosm/iosm_ipc_mux_codec.c drivers/net/wwan/iosm/iosm_ipc_mux_codec.h+1096 -00 replies
12/18net: iosm: power managementdrivers/net/wwan/iosm/iosm_ipc_pm.c drivers/net/wwan/iosm/iosm_ipc_pm.h+550 -00 replies
13/18net: iosm: shared memory protocoldrivers/net/wwan/iosm/iosm_ipc_protocol.c drivers/net/wwan/iosm/iosm_ipc_protocol.h+506 -00 replies
14/18net: iosm: protocol operationsdrivers/net/wwan/iosm/iosm_ipc_protocol_ops.c drivers/net/wwan/iosm/iosm_ipc_protocol_ops.h+921 -00 replies
15/18net: iosm: uevent supportdrivers/net/wwan/iosm/iosm_ipc_uevent.c drivers/net/wwan/iosm/iosm_ipc_uevent.h+88 -00 replies
16/18net: iosm: net driverdrivers/net/wwan/iosm/iosm_ipc_wwan.c drivers/net/wwan/iosm/iosm_ipc_wwan.h+746 -00 replies
17/18net: iosm: readme filedrivers/net/wwan/iosm/README+126 -00 replies
18/18net: iosm: infrastructureMAINTAINERS drivers/net/Kconfig drivers/net/Makefile +4 more+64 -00 replies

Reviews trailers per patch

No Reviewed-by, Acked-by or Tested-by trailers for v1 yet.

Read the v1 thread

Cover letter [RFC 00/18] net: iosm: PCIe Driver for Intel M.2 Modem

The IOSM (IPC over Shared Memory) driver is a PCIe host driver implemented for linux or chrome platform for data exchange over PCIe interface between Host platform & Intel M.2 Modem. The driver exposes interface conforming to the MBIM protocol [1]. Any front end application ( eg: Modem Manager) could easily manage the MBIM interface to enable data communication towards WWAN.

This is the driver we are still working on & below are the known things that need to be addressed by driver.
1. Usage of completion() inside deinit()
2. Clean-up wrappers around hr_timer
3. Usage of net stats inside driver struct

Kindly request to review and give your suggestions.

Below is the technical detail:-
Intel M.2 modem uses 2 BAR regions. The first region is dedicated to Doorbell register for IRQs and the second region is used as scratchpad area for book keeping modem execution stage details along with host system shared memory region context details. The upper edge of the driver exposes the control and data channels for user space application interaction. At lower edge these data and control channels are associated to pipes. The pipes are lowest level interfaces used over PCIe as a logical channel for message exchange. A single channel maps to UL and DL pipe and are initialized on device open.

On UL path, driver copies application sent data to SKBs associate it with transfer descriptor and puts it on to ring buffer for DMA transfer. Once information has been updated in shared memory region, host gives a Doorbell to modem to perform DMA and modem uses MSI to communicate back to host. For receiving data in DL path, SKBs are pre-allocated during pipe open and transfer descriptors are given to modem for DMA transfer.

The driver exposes two types of ports, namely "wwanctrl", a char device node which is used for MBIM control operation and "INMx",(x = 0,1,2..7) network interfaces for IP data communication.
1) MBIM Control Interface:
This node exposes an interface between modem and application using char device exposed by "IOSM" driver to establish and manage the MBIM data communication with PCIe based Intel M.2 Modems.

It also support an IOCTL command, apart from read and write methods. The IOCTL command, "IOCTL_WDM_MAX_COMMAND" could be used by applications to fetch the Maximum Command buffer length supported by the driver which is restricted to 4096 bytes.

2) MBIM Data Interface:
The IOSM driver represents the MBIM data channel as a single root network device of the "wwan0" type which is mapped as default IP session 0. Several IP sessions(INMx) could be multiplexed over the single data channel using sub devices of master wwanY devices. The driver models such IP sessions as 802.1q VLAN devices which are mapped to a unique VLAN ID.

M Chetan Kumar (18):
net: iosm: entry point
net: iosm: irq handling
net: iosm: mmio scratchpad
net: iosm: shared memory IPC interface
net: iosm: shared memory I/O operations
net: iosm: channel configuration
net: iosm: char device for FW flash & coredump
net: iosm: MBIM control device
net: iosm: bottom half
net: iosm: multiplex IP sessions
net: iosm: encode or decode datagram
net: iosm: power management
net: iosm: shared memory protocol
net: iosm: protocol operations
net: iosm: uevent support
net: iosm: net driver
net: iosm: readme file
net: iosm: infrastructure

 MAINTAINERS                                   |    7 +
 drivers/net/Kconfig                           |    1 +
 drivers/net/Makefile                          |    1 +
 drivers/net/wwan/Kconfig                      |   13 +
 drivers/net/wwan/Makefile                     |    5 +
 drivers/net/wwan/iosm/Kconfig                 |   10 +
 drivers/net/wwan/iosm/Makefile                |   27 +
 drivers/net/wwan/iosm/README                  |  126 +++
 drivers/net/wwan/iosm/iosm_ipc_chnl_cfg.c     |   87 ++
 drivers/net/wwan/iosm/iosm_ipc_chnl_cfg.h     |   57 +
 drivers/net/wwan/iosm/iosm_ipc_imem.c         | 1466 +++++++++++++++++++++++++
 drivers/net/wwan/iosm/iosm_ipc_imem.h         |  606 ++++++++++
 drivers/net/wwan/iosm/iosm_ipc_imem_ops.c     |  779 +++++++++++++
 drivers/net/wwan/iosm/iosm_ipc_imem_ops.h     |  102 ++
 drivers/net/wwan/iosm/iosm_ipc_irq.c          |   95 ++
 drivers/net/wwan/iosm/iosm_ipc_irq.h          |   35 +
 drivers/net/wwan/iosm/iosm_ipc_mbim.c         |  205 ++++
 drivers/net/wwan/iosm/iosm_ipc_mbim.h         |   24 +
 drivers/net/wwan/iosm/iosm_ipc_mmio.c         |  222 ++++
 drivers/net/wwan/iosm/iosm_ipc_mmio.h         |  192 ++++
 drivers/net/wwan/iosm/iosm_ipc_mux.c          |  455 ++++++++
 drivers/net/wwan/iosm/iosm_ipc_mux.h          |  344 ++++++
 drivers/net/wwan/iosm/iosm_ipc_mux_codec.c    |  902 +++++++++++++++
 drivers/net/wwan/iosm/iosm_ipc_mux_codec.h    |  194 ++++
 drivers/net/wwan/iosm/iosm_ipc_pcie.c         |  494 +++++++++
 drivers/net/wwan/iosm/iosm_ipc_pcie.h         |  205 ++++
 drivers/net/wwan/iosm/iosm_ipc_pm.c           |  334 ++++++
 drivers/net/wwan/iosm/iosm_ipc_pm.h           |  216 ++++
 drivers/net/wwan/iosm/iosm_ipc_protocol.c     |  287 +++++
 drivers/net/wwan/iosm/iosm_ipc_protocol.h     |  219 ++++
 drivers/net/wwan/iosm/iosm_ipc_protocol_ops.c |  563 ++++++++++
 drivers/net/wwan/iosm/iosm_ipc_protocol_ops.h |  358 ++++++
 drivers/net/wwan/iosm/iosm_ipc_sio.c          |  188 ++++
 drivers/net/wwan/iosm/iosm_ipc_sio.h          |   72 ++
 drivers/net/wwan/iosm/iosm_ipc_task_queue.c   |  258 +++++
 drivers/net/wwan/iosm/iosm_ipc_task_queue.h   |   46 +
 drivers/net/wwan/iosm/iosm_ipc_uevent.c       |   47 +
 drivers/net/wwan/iosm/iosm_ipc_uevent.h       |   41 +
 drivers/net/wwan/iosm/iosm_ipc_wwan.c         |  674 ++++++++++++
 drivers/net/wwan/iosm/iosm_ipc_wwan.h         |   72 ++
 40 files changed, 10029 insertions(+)
 create mode 100644 drivers/net/wwan/Kconfig
 create mode 100644 drivers/net/wwan/Makefile
 create mode 100644 drivers/net/wwan/iosm/Kconfig
 create mode 100644 drivers/net/wwan/iosm/Makefile
 create mode 100644 drivers/net/wwan/iosm/README
 create mode 100644 drivers/net/wwan/iosm/iosm_ipc_chnl_cfg.c
 create mode 100644 drivers/net/wwan/iosm/iosm_ipc_chnl_cfg.h
 create mode 100644 drivers/net/wwan/iosm/iosm_ipc_imem.c
 create mode 100644 drivers/net/wwan/iosm/iosm_ipc_imem.h
 create mode 100644 drivers/net/wwan/iosm/iosm_ipc_imem_ops.c
 create mode 100644 drivers/net/wwan/iosm/iosm_ipc_imem_ops.h
 create mode 100644 drivers/net/wwan/iosm/iosm_ipc_irq.c
 create mode 100644 drivers/net/wwan/iosm/iosm_ipc_irq.h
 create mode 100644 drivers/net/wwan/iosm/iosm_ipc_mbim.c
 create mode 100644 drivers/net/wwan/iosm/iosm_ipc_mbim.h
 create mode 100644 drivers/net/wwan/iosm/iosm_ipc_mmio.c
 create mode 100644 drivers/net/wwan/iosm/iosm_ipc_mmio.h
 create mode 100644 drivers/net/wwan/iosm/iosm_ipc_mux.c
 create mode 100644 drivers/net/wwan/iosm/iosm_ipc_mux.h
 create mode 100644 drivers/net/wwan/iosm/iosm_ipc_mux_codec.c
 create mode 100644 drivers/net/wwan/iosm/iosm_ipc_mux_codec.h
 create mode 100644 drivers/net/wwan/iosm/iosm_ipc_pcie.c
 create mode 100644 drivers/net/wwan/iosm/iosm_ipc_pcie.h
 create mode 100644 drivers/net/wwan/iosm/iosm_ipc_pm.c
 create mode 100644 drivers/net/wwan/iosm/iosm_ipc_pm.h
 create mode 100644 drivers/net/wwan/iosm/iosm_ipc_protocol.c
 create mode 100644 drivers/net/wwan/iosm/iosm_ipc_protocol.h
 create mode 100644 drivers/net/wwan/iosm/iosm_ipc_protocol_ops.c
 create mode 100644 drivers/net/wwan/iosm/iosm_ipc_protocol_ops.h
 create mode 100644 drivers/net/wwan/iosm/iosm_ipc_sio.c
 create mode 100644 drivers/net/wwan/iosm/iosm_ipc_sio.h
 create mode 100644 drivers/net/wwan/iosm/iosm_ipc_task_queue.c
 create mode 100644 drivers/net/wwan/iosm/iosm_ipc_task_queue.h
 create mode 100644 drivers/net/wwan/iosm/iosm_ipc_uevent.c
 create mode 100644 drivers/net/wwan/iosm/iosm_ipc_uevent.h
 create mode 100644 drivers/net/wwan/iosm/iosm_ipc_wwan.c
 create mode 100644 drivers/net/wwan/iosm/iosm_ipc_wwan.h
Signature · 1 line
2.12.3