userspace MHI client interface driver
Subsystems (5)
v10 cover userspace MHI client interface driver
This patch series adds support for UCI driver. UCI driver enables userspace clients to communicate to external MHI devices like modem and WLAN. UCI driver probe creates standard character device file nodes for userspace clients to perform open, read, write, poll and release file operations. These file operations call MHI core layer APIs to perform data transfer using MHI bus to communicate with MHI device. Patch is tested using arm64 based platform.
V10:
- Replaced mutex_lock with mutex_lock_interruptible in read() and write() file ops call back.
V9:
- Renamed dl_lock to dl_pending _lock and pending list to dl_pending for clarity.
- Used read lock to protect cur_buf.
- Change transfer status check logic and only consider 0 and -EOVERFLOW as only success.
- Added __int to module init function.
- Print channel name instead of minor number upon successful probe.
V8:
- Fixed kernel test robot compilation error by changing %lu to %zu for size_t.
- Replaced uci with UCI in Kconfig, commit text, and comments in driver code.
- Fixed minor style related comments.
V7:
- Decoupled uci device and uci channel objects. uci device is associated with device file node. uci channel is associated with MHI channels. uci device refers to uci channel to perform MHI channel operations for device file operations like read() and write(). uci device increments its reference count for every open(). uci device calls mhi_uci_dev_start_chan() to start the MHI channel. uci channel object is tracking number of times MHI channel is referred. This allows to keep the MHI channel in start state until last release() is called. After that uci channel reference count goes to 0 and uci channel clean up is performed which stops the MHI channel. After the last call to release() if driver is removed uci reference count becomes 0 and uci object is cleaned up.
- Use separate uci channel read and write lock to fine grain locking between reader and writer.
- Use uci device lock to synchronize open, release and driver remove.
- Optimize for downlink only or uplink only UCI device.
V6:
- Moved uci.c to mhi directory.
- Updated Kconfig to add module information.
- Updated Makefile to rename uci object file name as mhi_uci
- Removed kref for open count
V5:
- Removed mhi_uci_drv structure.
- Used idr instead of creating global list of uci devices.
- Used kref instead of local ref counting for uci device and open count.
- Removed unlikely macro.
V4:
- Fix locking to protect proper struct members.
- Updated documentation describing uci client driver use cases.
- Fixed uci ref counting in mhi_uci_open for error case.
- Addressed style related review comments.
V3: Added documentation for MHI UCI driver.
V2:
- Added mutex lock to prevent multiple readers to access same
- mhi buffer which can result into use after free.
Hemant Kumar (4):
bus: mhi: core: Add helper API to return number of free TREs
bus: mhi: core: Move MHI_MAX_MTU to external header file
docs: Add documentation for userspace client interface
bus: mhi: Add userspace client interface driver
Documentation/mhi/index.rst | 1 + Documentation/mhi/uci.rst | 83 +++++ drivers/bus/mhi/Kconfig | 13 + drivers/bus/mhi/Makefile | 4 + drivers/bus/mhi/core/internal.h | 1 - drivers/bus/mhi/core/main.c | 12 + drivers/bus/mhi/uci.c | 662 ++++++++++++++++++++++++++++++++++++++++ include/linux/mhi.h | 12 + 8 files changed, 787 insertions(+), 1 deletion(-) create mode 100644 Documentation/mhi/uci.rst create mode 100644 drivers/bus/mhi/uci.c
Signature · 2 lines
The Qualcomm Innovation Center, Inc. is a member of the Code Aurora Forum, a Linux Foundation Collaborative Project
PATCH v10 1/4 bus: mhi: core: Add helper API to return number of free TREs
Introduce mhi_get_free_desc_count() API to return number of TREs available to queue buffer. MHI clients can use this API to know before hand if ring is full without calling queue API.
--- drivers/bus/mhi/core/main.c | 12 ++++++++++++ include/linux/mhi.h | 9 +++++++++ 2 files changed, 21 insertions(+)
drivers/bus/mhi/core/main.c +12 -0
@@ -258,6 +258,18 @@ int mhi_destroy_device(struct device *dev, void *data)return 0 ; } +int mhi_get_free_desc_count (struct mhi_device *mhi_dev, +enum dma_data_direction dir) +{ +struct mhi_controller *mhi_cntrl = mhi_dev->mhi_cntrl; +struct mhi_chan *mhi_chan = (dir ==DMA_TO_DEVICE ) ? + mhi_dev->ul_chan : mhi_dev->dl_chan; +struct mhi_ring *tre_ring = &mhi_chan->tre_ring; + +return get_nr_avail_ring_elements (mhi_cntrl, tre_ring); +} +EXPORT_SYMBOL_GPL (mhi_get_free_desc_count); +void mhi_notify (struct mhi_device *mhi_dev,enum mhi_callback cb_reason) {struct mhi_driver *mhi_drv;
include/linux/mhi.h +9 -0
@@ -597,6 +597,15 @@ void mhi_set_mhi_state(struct mhi_controller *mhi_cntrl,void mhi_notify (struct mhi_device *mhi_dev,enum mhi_callback cb_reason);/** +* mhi_get_free_desc_count - Get transfer ring length +* Get # of TD available to queue buffers +* @mhi_dev: Device associated with the channels +* @dir: Direction of the channel +*/ +int mhi_get_free_desc_count (struct mhi_device *mhi_dev, +enum dma_data_direction dir); + +/** * mhi_prepare_for_power_up - Do pre-initialization before power up. * This is optional, call this before power up if * the controller does not want bus framework to
Signature · 2 lines
The Qualcomm Innovation Center, Inc. is a member of the Code Aurora Forum, a Linux Foundation Collaborative Project
PATCH v10 2/4 bus: mhi: core: Move MHI_MAX_MTU to external header file
In reply to Hemant KumarCurrently this macro is defined in internal MHI header as a TRE length mask. Moving it to external header allows MHI client drivers to set this upper bound for the transmit buffer size.
--- drivers/bus/mhi/core/internal.h | 1 - include/linux/mhi.h | 3 +++ 2 files changed, 3 insertions(+), 1 deletion(-)
drivers/bus/mhi/core/internal.h +0 -1
@@ -453,7 +453,6 @@ enum mhi_pm_state {#define CMD_EL_PER_RING 128#define PRIMARY_CMD_RING 0#define MHI_DEV_WAKE_DB 127 -#define MHI_MAX_MTU 0xffff#define MHI_RANDOM_U32_NONZERO (bmsk) (prandom_u32_max(bmsk) + 1)enum mhi_er_type {
include/linux/mhi.h +3 -0
@@ -15,6 +15,9 @@#include <linux/wait.h> #include <linux/workqueue.h> +/* MHI client drivers to set this upper bound for tx buffer */ +#define MHI_MAX_MTU 0xffff +#define MHI_MAX_OEM_PK_HASH_SEGMENTS 16struct mhi_chan ;
Signature · 2 lines
The Qualcomm Innovation Center, Inc. is a member of the Code Aurora Forum, a Linux Foundation Collaborative Project
PATCH v10 3/4 docs: Add documentation for userspace client interface
In reply to Hemant KumarMHI userspace client driver is creating device file node for user application to perform file operations. File operations are handled by MHI core driver. Currently Loopback MHI channel is supported by this driver.
--- Documentation/mhi/index.rst | 1 + Documentation/mhi/uci.rst | 83 +++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 84 insertions(+) create mode 100644 Documentation/mhi/uci.rst
Documentation/mhi/index.rst +1 -0
@@ -9,6 +9,7 @@ MHI mhi topology + uci .. only:: subproject and html
Documentation/mhi/uci.rst new file +83 -0
83 lines not on this page · raw message
Signature · 2 lines
The Qualcomm Innovation Center, Inc. is a member of the Code Aurora Forum, a Linux Foundation Collaborative Project
Randy Dunlap
reviewerRe: [PATCH v10 3/4] docs: Add documentation for userspace client interface
Hi,
Quoted 19 lines · Hemant Kumar
MHI userspace client driver is creating device file node for user application to perform file operations. File operations are handled by MHI core driver. Currently Loopback MHI channel is supported by this driver.
Signed-off-by Hemant Kumar <[email protected]>--- Documentation/mhi/index.rst | 1 + Documentation/mhi/uci.rst | 83 +++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 84 insertions(+) create mode 100644 Documentation/mhi/uci.rstDocumentation/mhi/uci.rst new file +0
-0
Documentation/mhi/uci.rst line 6
Quoted 6 lines
Documentation/mhi/uci.rst new file +6
-0@@ -0,0 +1,83 @@ +.. SPDX-License-Identifier: GPL-2.0 + +================================= +Userspace Client Interface (UCI) +================================= +
Lots of TLAs.
Documentation/mhi/uci.rst line 28
Quoted 7 lines
Documentation/mhi/uci.rst new file +7
-0+ +read +---- + +When data transfer is completed on downlink channel, TRE buffer is copied to +pending list. Reader is unblocked and data is copied to userspace buffer. TRE +buffer is queued back to downlink channel transfer ring.
What is TRE?
Quoted 4 lines
Documentation/mhi/uci.rst new file +4
-0+ +Usage +===== +
Documentation/mhi/uci.rst line 63
Quoted 10 lines
Documentation/mhi/uci.rst new file +10
-0+Device file node is created with format:- + +/dev/mhi_<controller_name>_<mhi_device_name> + +controller_name is the name of underlying bus used to transfer data. mhi_device +name is the name of the MHI channel being used by MHI client in userspace to +send or receive data using MHI protocol. + +There is a separate character device file node created for each channel +specified in mhi device id table. MHI channels are statically defined by MHI
MHI
unless it is a variable name, like below: mhi_device_id
Documentation/mhi/uci.rst line 82
Quoted 8 lines
Documentation/mhi/uci.rst new file +7
-0+specification. The list of supported channels is in the channel list variable +of mhi_device_id table in UCI driver. + +Other Use Cases +--------------- + +Getting MHI device specific diagnostics information to userspace MHI diag client
diagnostic client
Quoted 2 lines
+using DIAG channel 4 (Host to device) and 5 (Device to Host).
thanks.
Signature · 1 line
~Randy
Re: [PATCH v10 3/4] docs: Add documentation for userspace client interface
Hi Randy,
Quoted 32 lines · Randy Dunlap
Hi,
Quoted 19 lines · Hemant Kumar
MHI userspace client driver is creating device file node for user application to perform file operations. File operations are handled by MHI core driver. Currently Loopback MHI channel is supported by this driver.
Signed-off-by Hemant Kumar <[email protected]>--- Documentation/mhi/index.rst | 1 + Documentation/mhi/uci.rst | 83 +++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 84 insertions(+)create mode 100644
Documentation/mhi/uci.rstDocumentation/mhi/uci.rst new file +0
-0Documentation/mhi/uci.rst line 6
Quoted 6 lines
Documentation/mhi/uci.rst new file +6
-0@@ -0,0 +1,83 @@ +.. SPDX-License-Identifier: GPL-2.0 + +================================= +Userspace Client Interface (UCI) +================================= +Lots of TLAs.
Quoted 9 lines
Documentation/mhi/uci.rst line 28
Quoted 7 lines
Documentation/mhi/uci.rst new file +7
-0+ +read +---- + +When data transfer is completed on downlink channel, TRE buffer is copied to +pending list. Reader is unblocked and data is copied to userspace buffer. TRE +buffer is queued back to downlink channel transfer ring.What is TRE?
Transfer Ring Element
i will add that in small bracket inline.
Quoted 10 lines
Quoted 10 lines
Documentation/mhi/uci.rst new file +9
-0+ +Usage +===== + +Device file node is created with format:- + +/dev/mhi_<controller_name>_<mhi_device_name> + +controller_name is the name of underlying bus used to transfer data. mhi_device
Quoted 8 lines
Documentation/mhi/uci.rst line 63
Quoted 5 lines
Documentation/mhi/uci.rst new file +5
-0+name is the name of the MHI channel being used by MHI client in userspace to +send or receive data using MHI protocol. + +There is a separate character device file node created for each channel +specified in mhi device id table. MHI channels are statically defined by MHIMHI
unless it is a variable name, like below:mhi_device_id
Done.
Quoted 11 lines
Documentation/mhi/uci.rst line 82
Quoted 9 lines
Documentation/mhi/uci.rst new file +7
-0+specification. The list of supported channels is in the channel list variable +of mhi_device_id table in UCI driver. + +Other Use Cases +--------------- + +Getting MHI device specific diagnostics information to userspace MHI diag clientdiagnostic client
Done.
Quoted 6 lines
Quoted 3 lines
+using DIAG channel 4 (Host to device) and 5 (Device to Host).
thanks.
Thanks for reviewing it. Let me fix it and re-upload.
Thanks,
Hemant
Signature · 2 lines
The Qualcomm Innovation Center, Inc. is a member of the Code Aurora Forum, a Linux Foundation Collaborative Project
PATCH v10 4/4 bus: mhi: Add userspace client interface driver
In reply to Hemant KumarThis MHI client driver allows userspace clients to transfer raw data between MHI device and host using standard file operations. Driver instantiates UCI device object which is associated to device file node. UCI device object instantiates UCI channel object when device file node is opened. UCI channel object is used to manage MHI channels by calling MHI core APIs for read and write operations. MHI channels are started as part of device open(). MHI channels remain in start state until last release() is called on UCI device file node. Device file node is created with format
/dev/mhi_<controller_name>_<mhi_device_name>
Currently it supports LOOPBACK channel.
--- drivers/bus/mhi/Kconfig | 13 + drivers/bus/mhi/Makefile | 4 + drivers/bus/mhi/uci.c | 662 +++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 679 insertions(+) create mode 100644 drivers/bus/mhi/uci.c
drivers/bus/mhi/Kconfig +13 -0
@@ -20,3 +20,16 @@ config MHI_BUS_DEBUG Enable debugfs support for use with the MHI transport. Allows reading and/or modifying some values within the MHI controller for debug and test purposes. + +config MHI_UCI + tristate "MHI UCI" + depends on MHI_BUS + help + MHI based Userspace Client Interface (UCI) driver is used for + transferring raw data between host and device using standard file + operations from userspace. Open, read, write, and close operations + are supported by this driver. Please check mhi_uci_match_table for + all supported channels that are exposed to userspace. + + To compile this driver as a module, choose M here: the module will be + called mhi_uci.
drivers/bus/mhi/Makefile +4 -0
@@ -1,2 +1,6 @@ # core layer obj-y += core/ + +# MHI client +mhi_uci-y := uci.o +obj-$(CONFIG_MHI_UCI) += mhi_uci.o
drivers/bus/mhi/uci.c new file +662 -0
662 lines not on this page · raw message
Signature · 2 lines
The Qualcomm Innovation Center, Inc. is a member of the Code Aurora Forum, a Linux Foundation Collaborative Project