From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-11.5 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_PATCH,MAILING_LIST_MULTI, NICE_REPLY_A,SIGNED_OFF_BY,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED, USER_AGENT_SANE_1 autolearn=unavailable autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id B3004C2D0A3 for ; Fri, 30 Oct 2020 02:16:16 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 40FB020BED for ; Fri, 30 Oct 2020 02:16:16 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (1024-bit key) header.d=mg.codeaurora.org header.i=@mg.codeaurora.org header.b="T1tjjevs" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726200AbgJ3CQO (ORCPT ); Thu, 29 Oct 2020 22:16:14 -0400 Received: from m42-4.mailgun.net ([69.72.42.4]:49068 "EHLO m42-4.mailgun.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1725372AbgJ3CQO (ORCPT ); Thu, 29 Oct 2020 22:16:14 -0400 DKIM-Signature: a=rsa-sha256; v=1; c=relaxed/relaxed; d=mg.codeaurora.org; q=dns/txt; s=smtp; t=1604024173; h=Content-Transfer-Encoding: Content-Type: In-Reply-To: MIME-Version: Date: Message-ID: From: References: Cc: To: Subject: Sender; bh=LRMgOFZbItBqfHE6rw+IhX6ADhrLY1wYvZCBR3GV4N0=; b=T1tjjevsXJ7QN/gV8gKMONYGB0+YeSiZN+9jUSR8dkJsRMpFo7crplifFSrIyQH4pkpOrVsR HzpQOlSikcVStTlwPDc+veVG30W/5zu3s2P0GKEsehOs3UZwUZX2OdHcN1mAZ3ZxoepyrPwb b8GyDbdx4+AiZP8lIm+9AGrplIY= X-Mailgun-Sending-Ip: 69.72.42.4 X-Mailgun-Sid: WyI1MzIzYiIsICJsaW51eC1hcm0tbXNtQHZnZXIua2VybmVsLm9yZyIsICJiZTllNGEiXQ== Received: from smtp.codeaurora.org (ec2-35-166-182-171.us-west-2.compute.amazonaws.com [35.166.182.171]) by smtp-out-n06.prod.us-west-2.postgun.com with SMTP id 5f9b776d1df7f5f83c818582 (version=TLS1.2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256); Fri, 30 Oct 2020 02:16:13 GMT Sender: hemantk=codeaurora.org@mg.codeaurora.org Received: by smtp.codeaurora.org (Postfix, from userid 1001) id 4357DC433FE; Fri, 30 Oct 2020 02:16:13 +0000 (UTC) Received: from [10.46.162.249] (i-global254.qualcomm.com [199.106.103.254]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) (Authenticated sender: hemantk) by smtp.codeaurora.org (Postfix) with ESMTPSA id 1AEACC433C9; Fri, 30 Oct 2020 02:16:12 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 smtp.codeaurora.org 1AEACC433C9 Authentication-Results: aws-us-west-2-caf-mail-1.web.codeaurora.org; dmarc=none (p=none dis=none) header.from=codeaurora.org Authentication-Results: aws-us-west-2-caf-mail-1.web.codeaurora.org; spf=fail smtp.mailfrom=hemantk@codeaurora.org Subject: Re: [PATCH v10 3/4] docs: Add documentation for userspace client interface To: Randy Dunlap , manivannan.sadhasivam@linaro.org, gregkh@linuxfoundation.org Cc: linux-arm-msm@vger.kernel.org, linux-kernel@vger.kernel.org, jhugo@codeaurora.org, bbhatt@codeaurora.org, loic.poulain@linaro.org, netdev@vger.kernel.org References: <1604007647-32163-1-git-send-email-hemantk@codeaurora.org> <1604007647-32163-4-git-send-email-hemantk@codeaurora.org> <6f508e54-a170-8409-886c-a882b6fd5f63@infradead.org> From: Hemant Kumar Message-ID: Date: Thu, 29 Oct 2020 19:16:11 -0700 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:68.0) Gecko/20100101 Thunderbird/68.10.0 MIME-Version: 1.0 In-Reply-To: <6f508e54-a170-8409-886c-a882b6fd5f63@infradead.org> Content-Type: text/plain; charset=utf-8; format=flowed Content-Language: en-US Content-Transfer-Encoding: 7bit Precedence: bulk List-ID: X-Mailing-List: linux-arm-msm@vger.kernel.org Hi Randy, On 10/29/20 2:51 PM, Randy Dunlap wrote: > Hi, > > On 10/29/20 2:40 PM, Hemant Kumar wrote: >> 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 >> --- >> Documentation/mhi/index.rst | 1 + >> Documentation/mhi/uci.rst | 83 +++++++++++++++++++++++++++++++++++++++++++++ >> 2 files changed, 84 insertions(+) >> create mode 100644 Documentation/mhi/uci.rst > > >> 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) >> +================================= >> + > > > Lots of TLAs. > >> + >> +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. > >> + >> +Usage >> +===== >> + >> +Device file node is created with format:- >> + >> +/dev/mhi__ >> + >> +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 Done. > >> +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 Done. > >> +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 -- The Qualcomm Innovation Center, Inc. is a member of the Code Aurora Forum, a Linux Foundation Collaborative Project