[v7,3/4] docs: Add documentation for userspace client interface

Commit Message

Hemant Kumar Oct. 17, 2020, 4:04 a.m. UTC

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 <[e-mail]>
---
 Documentation/mhi/index.rst |  1 +
 Documentation/mhi/uci.rst   | 83 +++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 84 insertions(+)
 create mode 100644 Documentation/mhi/uci.rst

Comments

Jeffrey Hugo Oct. 21, 2020, 3:28 p.m. UTC | #1

On 10/16/2020 10:04 PM, Hemant Kumar wrote:
> +release

Should this be "close" since close() is the actual function userspace 
would call?

> +-------
> +
> +Decrements UCI device reference count and UCI channel reference count upon last
> +release(). UCI channel clean up is performed. MHI channel moves to disabled
> +state and inbound buffers are freed.
> +

Hemant Kumar Oct. 21, 2020, 5:46 p.m. UTC | #2

Hi Jeff,

On 10/21/20 8:28 AM, Jeffrey Hugo wrote:
> On 10/16/2020 10:04 PM, Hemant Kumar wrote:
>> +release
> 
> Should this be "close" since close() is the actual function userspace 
> would call?
I was keeping kernel driver in mind while writing this, i can change it 
to close() if release() is confusing here.
> 
>> +-------
>> +
>> +Decrements UCI device reference count and UCI channel reference count 
>> upon last
>> +release(). UCI channel clean up is performed. MHI channel moves to 
>> disabled
>> +state and inbound buffers are freed.
>> +
> 
> 
Thanks,
Hemant

Jeffrey Hugo Oct. 22, 2020, 3:04 a.m. UTC | #3

On 10/21/2020 11:46 AM, Hemant Kumar wrote:
> Hi Jeff,
> 
> On 10/21/20 8:28 AM, Jeffrey Hugo wrote:
>> On 10/16/2020 10:04 PM, Hemant Kumar wrote:
>>> +release
>>
>> Should this be "close" since close() is the actual function userspace 
>> would call?
> I was keeping kernel driver in mind while writing this, i can change it 
> to close() if release() is confusing here.

I guess I was considering the client perspective, but this is kernel 
documentation so I can see your perspective.  I don't have a strong 
preference.  I suppose keep it as is.

>>
>>> +-------
>>> +
>>> +Decrements UCI device reference count and UCI channel reference 
>>> count upon last
>>> +release(). UCI channel clean up is performed. MHI channel moves to 
>>> disabled
>>> +state and inbound buffers are freed.
>>> +
>>
>>
> Thanks,
> Hemant

Patch

diff --git a/Documentation/mhi/index.rst b/Documentation/mhi/index.rst
index 1d8dec3..c75a371 100644
--- a/Documentation/mhi/index.rst
+++ b/Documentation/mhi/index.rst
@@ -9,6 +9,7 @@  MHI
 
    mhi
    topology
+   uci
 
 .. only::  subproject and html
 
diff --git a/Documentation/mhi/uci.rst b/Documentation/mhi/uci.rst
new file mode 100644
index 0000000..fe901c4
--- /dev/null
+++ b/Documentation/mhi/uci.rst
@@ -0,0 +1,83 @@ 
+.. SPDX-License-Identifier: GPL-2.0
+
+=================================
+Userspace Client Interface (UCI)
+=================================
+
+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.
+
+Operations
+==========
+
+open
+----
+
+Instantiates UCI channel object and starts MHI channels to move it to running
+state. Inbound buffers are queued to downlink channel transfer ring. Every
+subsequent open() increments UCI device reference count as well as UCI channel
+reference count.
+
+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.
+
+write
+-----
+
+Write buffer is queued to uplink channel transfer ring if ring is not full. Upon
+uplink transfer completion buffer is freed.
+
+poll
+----
+
+Returns EPOLLIN | EPOLLRDNORM mask if pending list has buffers to be read by
+userspace. Returns EPOLLOUT | EPOLLWRNORM mask if MHI uplink channel transfer
+ring is not empty. Returns EPOLLERR when UCI driver is removed. MHI channels
+move to disabled state upon driver remove.
+
+release
+-------
+
+Decrements UCI device reference count and UCI channel reference count upon last
+release(). UCI channel clean up is performed. MHI channel moves to disabled
+state and inbound buffers are freed.
+
+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
+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
+specification. The list of supported channels is in the channel list variable
+of mhi_device_id table in UCI driver.
+
+LOOPBACK Channel
+----------------
+
+Userspace MHI client using LOOPBACK channel opens device file node. As part of
+open operation TREs to transfer ring of LOOPBACK channel 1 gets queued and channel
+doorbell is rung. When userspace MHI client performs write operation on device node,
+data buffer gets queued as a TRE to transfer ring of LOOPBACK channel 0. MHI Core
+driver rings the channel doorbell for MHI device to move data over underlying bus.
+When userspace MHI client driver performs read operation, same data gets looped back
+to MHI host using LOOPBACK channel 1. LOOPBACK channel is used to verify data path
+and data integrity between MHI Host and MHI device.
+
+Other Use Cases
+---------------
+
+Getting MHI device specific diagnostics information to userspace MHI diag client
+using DIAG channel 4 (Host to device) and 5 (Device to Host).