From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mx0b-0031df01.pphosted.com (mx0b-0031df01.pphosted.com [205.220.180.131]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 711CF2DF132 for ; Thu, 9 Apr 2026 19:47:12 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=205.220.180.131 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1775764035; cv=none; b=skCImweP5stbCQNqg/41XbLgAd6qR3NbqlzZ3qn02woIkyyUl2JLGdTYDV3TND6u5WqW2tePjEy0WjPqAG/VewaxuEz+dGubaFj+xlt1kbbCHtokZuFP0FI0XVM03qalgMrQ6Li6f+QRACCXiSy7+gdDvkp96hJ0v7OEeCqyfO4= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1775764035; c=relaxed/simple; bh=wE2v5piXmBNTShghMARat1tBKYtFecBTpTLeG/24KeU=; h=Message-ID:Date:MIME-Version:Subject:To:Cc:References:From: In-Reply-To:Content-Type; b=YzsH4GTDVXLIE0m9v+JYz5q5MH7UNkNgd7H9cjp9uI+9edBoNamXEcFWe8pIuZ6xKClcnpy+g0n+HlSXg7b76rOgmQeMY5iQHcQAnTYRWSNtR1BhHVltGPBsUNGn3mDLhT01b7SB6zsTW4yO05icnCDny7YD7WDUrgwk5mutXyg= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=oss.qualcomm.com; spf=pass smtp.mailfrom=oss.qualcomm.com; dkim=pass (2048-bit key) header.d=qualcomm.com header.i=@qualcomm.com header.b=E258ppeT; dkim=pass (2048-bit key) header.d=oss.qualcomm.com header.i=@oss.qualcomm.com header.b=Ov3UNrzq; arc=none smtp.client-ip=205.220.180.131 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=oss.qualcomm.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=oss.qualcomm.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=qualcomm.com header.i=@qualcomm.com header.b="E258ppeT"; dkim=pass (2048-bit key) header.d=oss.qualcomm.com header.i=@oss.qualcomm.com header.b="Ov3UNrzq" Received: from pps.filterd (m0279871.ppops.net [127.0.0.1]) by mx0a-0031df01.pphosted.com (8.18.1.11/8.18.1.11) with ESMTP id 639HkN7L2698277 for ; Thu, 9 Apr 2026 19:47:11 GMT DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=qualcomm.com; h= cc:content-transfer-encoding:content-type:date:from:in-reply-to :message-id:mime-version:references:subject:to; s=qcppdkim1; bh= g/06ClVKS+CLMiIvs4gyofvU9apUnpcFRIbVbc5UPFE=; b=E258ppeTaBTn5jcT fpDf25bOdp8etUBuri9dWIQ4KzrdxasmAACSd68I241xfpF97QvabQdVPyVnQ/qv 21/gdNo0mRTcMj+LtHCjqcEk+N+0gKmm+VZBQ6955Cc/CTLHh+JIWl59J3Z2dqS4 Px89Ewvg93okNdGlc7AdZcTUbtzoJYketddZTlbpqQh79enULdlXCJSeV70wrczL T3AQeQCsCxRS9xC9K4bWylVgmwSC27CsF9ZO7vOWAtbiMjeL+tuxeVlrvlHinebT TXbNN+64GRjB4hgYqyAz7MZ99QKvhR0CiLbt7B94zjY60pcja4oboMG9PLsovvwq Owd4fA== Received: from mail-dl1-f69.google.com (mail-dl1-f69.google.com [74.125.82.69]) by mx0a-0031df01.pphosted.com (PPS) with ESMTPS id 4degt9rcq6-1 (version=TLSv1.3 cipher=TLS_AES_128_GCM_SHA256 bits=128 verify=NOT) for ; Thu, 09 Apr 2026 19:47:10 +0000 (GMT) Received: by mail-dl1-f69.google.com with SMTP id a92af1059eb24-1276e71652fso1792563c88.0 for ; Thu, 09 Apr 2026 12:47:10 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=oss.qualcomm.com; s=google; t=1775764029; x=1776368829; darn=vger.kernel.org; h=content-transfer-encoding:in-reply-to:from:content-language :references:cc:to:subject:user-agent:mime-version:date:message-id :from:to:cc:subject:date:message-id:reply-to; bh=g/06ClVKS+CLMiIvs4gyofvU9apUnpcFRIbVbc5UPFE=; b=Ov3UNrzqw+cHzyIt36kho0v6OtG6bhZP2yqqLXsYYxJb+e6EIkhUWmyvZ/TvyEHRvr zWtcVg4DAN3Nc4rf6uD0/Kr0gJkwqEwCKcMyEdbqt3sLgHRjRWqGdwvfhIYSIw2mHhpT JMeyO4HJloU+dF00Trp9qomeF95tHWQ9DxfabvfsKyA14/pYihCLF0M79PpNWSUxUrDC 0tNKjJ2IkFPOJ+VcJgiesklskKtSDAvn8VS3RN7GdkIilPE27fzMOHE+shj4Gnkg6/lA UrP5GTy7n52oR5Qpxnh2y6IVy07gsGXf6evYsH8BLfILEeO5dEtjIGWEbeoDWvhmfNR7 VuRA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20251104; t=1775764029; x=1776368829; h=content-transfer-encoding:in-reply-to:from:content-language :references:cc:to:subject:user-agent:mime-version:date:message-id :x-gm-gg:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=g/06ClVKS+CLMiIvs4gyofvU9apUnpcFRIbVbc5UPFE=; b=VXidChzmpRahKYMFp1SYIGXDZUJMra276Ggl5gHgMgFY4HodWCkuuvDwVK+j/ckcbd 5bK9lx9i9C+SLmCANvf/6+idwoZBwo7TaQ1Kof5gB5maUrzl8W2Ow3lfn+TRLl/CxOBJ zISB2yakUlnTdoP79EyWhQQ8Cjogb+A1mAy8PKeFMtitRvpU1zEACEcgOX2+86xeRMda mNLz9g8etDaGmhUCI1QbUEd4Zyw0SsoZIKUU/zOp2jAFWg0jsV1U/x1CMfQxmJb86GQA L5yeJL7Db5FrVuSt2aHzVR9Sw84Yco8Y1+HP0lMBM3LTOVFlGCxvEJKdJYbIYEIjaaqi Qu1A== X-Forwarded-Encrypted: i=1; AJvYcCXJSlPYj3/cPu2oxacVznT5VBojzMp2UVFUpNtY3R5KiP6XCKI934isQmuGimxijCHVnXTkGqSHtFf++bQ=@vger.kernel.org X-Gm-Message-State: AOJu0Yz8X5/X8YvloBfryULHZbeGM9Z/u5c5XMgaSSWTuoDm80midcw/ raFAzNTBUnQqu4f+ds9Q98Zv52Bl2SXdroU0RVg9cc/nmN9SCXk0NxVfgMh+DEsEhm2JI/KI6KG Fqmm/ZLko2JdvWV19NcjsFqw4eThIujeRHcsTCrQSABXVI8pTFl5abkWpVnruSGuNpie4EqmLWo A= X-Gm-Gg: AeBDiet9jaY4Ze/EQgHu2joiWn47cTn5IViOs0z1T6o2v795pxG4Mog1nSNFSkTZb9b wbMiguIAWFuHTu6k5gT8MT6AvbRkw7wImialVmiGK8HY2EBzXQi7kxEx2FEq6pNC4CA206CS+Ng gVZEZ0aTz/uM3Ra5ts5/b2styDXrg/o+tFA3UsDyST9FSxO7HVy1n0CZIj1xCHXKnPxSbO3iWRF knkXsBWtMx+Grp1WtmIgwJ/w+GsUCdKucgINTLf/G/gAbw9svk85TFIrfwfWux5WmD7Gg4VJrOx eIdh5UTdDpVWbw9aCpAFQsf/00r2ygaB9m1QTA70t0SlTtlC8lvSHaftq7H5IQrbLh/2xJUzdl1 l6xT2JTtrIgO2Ogpg1OvEhNNDl7PdW78KrqNvP6vZq+ci0RRjAOUqeURNWqaBwcROlLf6kJ0EZB k= X-Received: by 2002:a05:7023:b0f:b0:128:d5bd:357f with SMTP id a92af1059eb24-12c34f09283mr224071c88.30.1775764029053; Thu, 09 Apr 2026 12:47:09 -0700 (PDT) X-Received: by 2002:a05:7023:b0f:b0:128:d5bd:357f with SMTP id a92af1059eb24-12c34f09283mr224039c88.30.1775764028479; Thu, 09 Apr 2026 12:47:08 -0700 (PDT) Received: from [10.226.59.182] (i-global254.qualcomm.com. [199.106.103.254]) by smtp.gmail.com with ESMTPSA id a92af1059eb24-12c345a96f0sm738890c88.5.2026.04.09.12.47.07 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Thu, 09 Apr 2026 12:47:08 -0700 (PDT) Message-ID: Date: Thu, 9 Apr 2026 13:47:06 -0600 Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 User-Agent: Mozilla Thunderbird Subject: Re: [PATCH v4 1/9] Add documentation for Sahara protocol. To: Kishore Batta , Jonathan Corbet , Shuah Khan , Carl Vanderlip , Oded Gabbay , Manivannan Sadhasivam , andersson@kernel.org Cc: linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, linux-arm-msm@vger.kernel.org, dri-devel@lists.freedesktop.org, mhi@lists.linux.dev References: <20260319-sahara_protocol_new_v2-v4-0-47ad79308762@oss.qualcomm.com> <20260319-sahara_protocol_new_v2-v4-1-47ad79308762@oss.qualcomm.com> Content-Language: en-US From: Jeff Hugo In-Reply-To: <20260319-sahara_protocol_new_v2-v4-1-47ad79308762@oss.qualcomm.com> Content-Type: text/plain; charset=UTF-8; format=flowed Content-Transfer-Encoding: 7bit X-Proofpoint-Spam-Details-Enc: AW1haW4tMjYwNDA5MDE4MSBTYWx0ZWRfX1eGb2nML/Bkb TVT/lx3oK2oZGDlJg96bhJG/NiRoO6ICiCyTtaDgtrTcEhZkTwr4kWeb/HnDkBJmeLQXTxwZX8h tU/1F/79ibOowQOCPZlsMKaAUv8I2NhlxUtZl3/xeKODJpxoUgeJua4igywVrjMNcevQcHwfVT2 NL8XjWoRhPK/l4P4AeRPn6FofGrraoIIQHl6Ew70B3bgpYcB0Rgsdj/mtWGVE2S9CznsNQ+kvtU tpzLZB+I9YAeOShNLBfXDdqyM8VgQhg6SVlJYH30LYNB4zBP8oyQNU224727mxhYaR5AU13Axsg 9fKwDnke5sEWiGQwSadu7K9cgItJcO03mt3NkQ3u61bWYfIuWahQ8lgmsVoJj10csjrAXCR1jmb ScJw1LUfcmy/DFibYm28HekCj3u2BTqHdRRgLGq3sBq8iZU+tuVkaQ7Tpuq41B5/YxcVswbuZZy rBAysKSMKVrPIyR9DIQ== X-Proofpoint-ORIG-GUID: skGEjgJM1G-saSRT2KGxht1kUGUJwt-s X-Proofpoint-GUID: skGEjgJM1G-saSRT2KGxht1kUGUJwt-s X-Authority-Analysis: v=2.4 cv=BJyDalQG c=1 sm=1 tr=0 ts=69d8023f cx=c_pps a=kVLUcbK0zfr7ocalXnG1qA==:117 a=JYp8KDb2vCoCEuGobkYCKw==:17 a=IkcTkHD0fZMA:10 a=A5OVakUREuEA:10 a=s4-Qcg_JpJYA:10 a=VkNPw1HP01LnGYTKEx00:22 a=u7WPNUs3qKkmUXheDGA7:22 a=3WHJM1ZQz_JShphwDgj5:22 a=EUspDBNiAAAA:8 a=ddSKszWcQf2y6ZE3pzUA:9 a=QEXdDO2ut3YA:10 a=vr4QvYf-bLy2KjpDp97w:22 X-Proofpoint-Virus-Version: vendor=baseguard engine=ICAP:2.0.293,Aquarius:18.0.1143,Hydra:6.1.51,FMLib:17.12.100.49 definitions=2026-04-09_04,2026-04-09_02,2025-10-01_01 X-Proofpoint-Spam-Details: rule=outbound_notspam policy=outbound score=0 lowpriorityscore=0 suspectscore=0 malwarescore=0 bulkscore=0 adultscore=0 priorityscore=1501 impostorscore=0 clxscore=1015 phishscore=0 spamscore=0 classifier=typeunknown authscore=0 authtc= authcc= route=outbound adjust=0 reason=mlx scancount=1 engine=8.22.0-2604010000 definitions=main-2604090181 $SUBJECT is not a complete sentence. You should drop the full stop ".". On 3/19/2026 12:31 AM, Kishore Batta wrote: > Introduce documentation for the Sahara protocol, describing its > operational modes and their respective functions. The image transfer mode > enables firmware transfer from host to device. The memory debug mode > allows extraction of device memory contents to host. The command mode > facilitates retrieval of DDR training data from the device and also > to restore the training data back to device in subsequent boot of device > to save boot time. Thank you for the documentation. > > Signed-off-by: Kishore Batta > --- > Documentation/sahara/index.rst | 14 + > Documentation/sahara/sahara_protocol.rst | 1241 ++++++++++++++++++++++++++++++ I see from the cover letter that the sahara implementation is moving under MHI. I expect to have more about that move later in the series, but MHI already has a documentation directory. I don't see why Sahara should be at the top level if it is considered to be coupled to MHI. > 2 files changed, 1255 insertions(+) > > diff --git a/Documentation/sahara/index.rst b/Documentation/sahara/index.rst > new file mode 100644 > index 0000000000000000000000000000000000000000..073002c15a203344524e258b2aa0a6ce839e064b > --- /dev/null > +++ b/Documentation/sahara/index.rst > @@ -0,0 +1,14 @@ > +.. SPDX-License-Identifier: GPL-2.0-only > + > +======================== > +Qualcomm Sahara protocol > +======================== > + > +The Sahara protocol transfers data to and from memory and describes packet > +structures, packet flows, and their usage. > + > +.. toctree:: > + :maxdepth: 2 > + :caption: Contents > + > + sahara_protocol > diff --git a/Documentation/sahara/sahara_protocol.rst b/Documentation/sahara/sahara_protocol.rst > new file mode 100644 > index 0000000000000000000000000000000000000000..91204bb7d170be4fc4c85f142b8f0b93d3c421a0 > --- /dev/null > +++ b/Documentation/sahara/sahara_protocol.rst > @@ -0,0 +1,1241 @@ > +.. SPDX-License-Identifier: GPL-2.0-only > + > + > +============================= > +Sahara protocol Specification > +============================= > + > +The Qualcomm Sahara protocol driver is primarily designed for transferring > +software images from a host device to a target device using a simplified data > +transfer mechanism over a link. However, the sahara protocol does not support "Sahara" should be capital "S" everywhere in this patch.