From patchwork Thu Dec 15 06:38:56 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Elliott, Robert (Servers)" X-Patchwork-Id: 33491 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:adf:e747:0:0:0:0:0 with SMTP id c7csp178439wrn; Wed, 14 Dec 2022 22:41:10 -0800 (PST) X-Google-Smtp-Source: AA0mqf7VYGf4rFF08jRcSuy8gd4j6OYEPrfeAjfLDsiexF1HSEwscwhsCzM+iWlyG4spCWMsqKcV X-Received: by 2002:a05:6a20:a6a8:b0:ac:72ab:4490 with SMTP id ba40-20020a056a20a6a800b000ac72ab4490mr6217201pzb.27.1671086470130; Wed, 14 Dec 2022 22:41:10 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1671086470; cv=none; d=google.com; s=arc-20160816; b=wSZndJfAGBP7YoYIMxoA4mg4Vreh3i9oZr7vCy2YHLzWV87sQLFnkBbCioabtmcPhw tgK19nCk0jDS8Q6aC8q6eNra2yAAGrVVyFRHky8ay66a93Gt+SinGXCFJ/EOrNfLXChM Z3dWlXW3TG/L3dK1eA9jzr+PFyTLi0LUOOh2mtxe4FuWRP1rnhIckjLU2qXr2OfbU5e4 SRi8LrSkCDhBmesSysAlE+dWgZbId51yqiXQhTiVIGnAWrKOGj7Z5aHcb0ExldECnLtL hD8ibsnlJnNft1VVUo/S0GffMEGTpZFz5yDkkhPGEBoMEx2cr6i7RKmYuM4S0LMbWyZY p9JQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=EheRUOzM1/FbUVSQp3nOUSZfGhhTVB7Lvia97WJ2X5Q=; b=wuu5Po59BIoq4btG1xQEPfjtg4NV/mAx6UErMtuPyteHSLXdvzoM4c9oekt57Mr7Oi A+iKZUDxADii0GPUXmbOXf1MUAuB0bJla0Bwbxj1brKuaZXwqWYMbR6fyeac4ScKbbZz m7r9vtkB/SP3ii+gQ/faaKOTsozn4c1odnD/C/NfdOWEZekzIOEmPALMJ4aWR/x71Vno Veyx07N+qzI1g0iFVef+Rs7EaWglp8IQWWVcZx5G1tmP9T2AOhhplYCLkuNf7Cc8YFfF tmlNTm/gGy7SNJpaxLLPd7MJMxUh1uUPRQERUzDUQDhwf5UWjD2GrbS7+FSzhX2UuToi jCUg== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@hpe.com header.s=pps0720 header.b=a3zgMpSF; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=hpe.com Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id i24-20020a633c58000000b004794d65bc17si1965412pgn.523.2022.12.14.22.40.56; Wed, 14 Dec 2022 22:41:10 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; dkim=pass header.i=@hpe.com header.s=pps0720 header.b=a3zgMpSF; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=hpe.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229816AbiLOGk2 (ORCPT + 99 others); Thu, 15 Dec 2022 01:40:28 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:42206 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229750AbiLOGju (ORCPT ); Thu, 15 Dec 2022 01:39:50 -0500 Received: from mx0b-002e3701.pphosted.com (mx0b-002e3701.pphosted.com [148.163.143.35]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 2ABB45C0FD; Wed, 14 Dec 2022 22:39:43 -0800 (PST) Received: from pps.filterd (m0148664.ppops.net [127.0.0.1]) by mx0b-002e3701.pphosted.com (8.17.1.19/8.17.1.19) with ESMTP id 2BF4N7V4016184; Thu, 15 Dec 2022 06:39:38 GMT DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=hpe.com; h=from : to : cc : subject : date : message-id : in-reply-to : references : mime-version : content-transfer-encoding; s=pps0720; bh=EheRUOzM1/FbUVSQp3nOUSZfGhhTVB7Lvia97WJ2X5Q=; b=a3zgMpSFCNCZy5e3250FckTcb05LHVvipzEUtlUMbUF3AdNEn3uZJXmK0OEVDMOYLvKP Dg5e6eAky3V+LKepNGJmw+grT7Js1Z1C95eYWVGgZpoEflO9MsYbZDbOLVkuzCJV0zYI EH2+8qzkQJgOP/kVt580/RzVgGo5GBK5E470mNIzrzf9Q6w2fTBxw+DpjhDLbbA/Vtpj EAVAoWDJ/qGSQKb8C210LuzYU5wCV1mXVyPxrfB2GxyrUh7lhChQON6e03HWVoRY/61Q x5qlFpsetRtnwF/Y1MWk5VOJvcqWmeYFmB0J0lCenhRXKnkCRgh6Uk9YUGovf1sjEjiA +w== Received: from p1lg14880.it.hpe.com (p1lg14880.it.hpe.com [16.230.97.201]) by mx0b-002e3701.pphosted.com (PPS) with ESMTPS id 3mfvgj0sp2-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT); Thu, 15 Dec 2022 06:39:38 +0000 Received: from p1lg14886.dc01.its.hpecorp.net (unknown [10.119.18.237]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by p1lg14880.it.hpe.com (Postfix) with ESMTPS id AD32D807131; Thu, 15 Dec 2022 06:39:37 +0000 (UTC) Received: from adevxp033-sys.us.rdlabs.hpecorp.net (unknown [16.231.227.36]) by p1lg14886.dc01.its.hpecorp.net (Postfix) with ESMTP id 5A93080D4AA; Thu, 15 Dec 2022 06:39:37 +0000 (UTC) From: Robert Elliott To: herbert@gondor.apana.org.au, davem@davemloft.net, corbet@lwn.net, linux-crypto@vger.kernel.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org Cc: Robert Elliott Subject: [PATCH 7/8] crypto: x86/blake2s - add kernel-doc comments to assembly Date: Thu, 15 Dec 2022 00:38:56 -0600 Message-Id: <20221215063857.161665-8-elliott@hpe.com> X-Mailer: git-send-email 2.38.1 In-Reply-To: <20221215063857.161665-1-elliott@hpe.com> References: <20221215063857.161665-1-elliott@hpe.com> MIME-Version: 1.0 X-Proofpoint-ORIG-GUID: 9mp5xDFhBwF5ad8EU0__2Sh2NYS4B-R- X-Proofpoint-GUID: 9mp5xDFhBwF5ad8EU0__2Sh2NYS4B-R- X-HPE-SCL: -1 X-Proofpoint-Virus-Version: vendor=baseguard engine=ICAP:2.0.205,Aquarius:18.0.923,Hydra:6.0.545,FMLib:17.11.122.1 definitions=2022-12-15_02,2022-12-14_01,2022-06-22_01 X-Proofpoint-Spam-Details: rule=outbound_notspam policy=outbound score=0 priorityscore=1501 mlxscore=0 spamscore=0 malwarescore=0 impostorscore=0 bulkscore=0 clxscore=1015 mlxlogscore=999 adultscore=0 phishscore=0 suspectscore=0 lowpriorityscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.12.0-2212070000 definitions=main-2212150050 X-Spam-Status: No, score=-2.8 required=5.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_LOW, SPF_HELO_NONE,SPF_NONE autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1752261166388620809?= X-GMAIL-MSGID: =?utf-8?q?1752261166388620809?= Add kernel-doc comments for assembly language functions exported to C glue code. Signed-off-by: Robert Elliott --- arch/x86/crypto/blake2s-core.S | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/arch/x86/crypto/blake2s-core.S b/arch/x86/crypto/blake2s-core.S index b50b35ff1fdb..7605e7d94fd2 100644 --- a/arch/x86/crypto/blake2s-core.S +++ b/arch/x86/crypto/blake2s-core.S @@ -46,6 +46,19 @@ SIGMA2: #endif /* CONFIG_AS_AVX512 */ .text +/** + * blake2s_compress_ssse3 - Calculate BLAKE2s hash using the x86 SSSE3 feature set + * @state: pointer to 48-byte state (%rdi) + * @data: pointer to data (%rsi) + * @nblocks: number of 64-byte blocks of data (%rdx) + * @inc: counter increment value (%rcx) + * + * This function supports 64-bit CPUs. + * + * Return: none (but modifies state) + * Prototype: asmlinkage void blake2s_compress_ssse3(struct blake2s_state *state, const u8 *data, + * unsigned int nblocks, u32 inc); + */ SYM_FUNC_START(blake2s_compress_ssse3) testq %rdx,%rdx je .Lendofloop @@ -175,6 +188,19 @@ SYM_FUNC_START(blake2s_compress_ssse3) SYM_FUNC_END(blake2s_compress_ssse3) #ifdef CONFIG_AS_AVX512 +/** + * blake2s_compress_avx512 - Calculate BLAKE2s hash using the x86 AVX-512VL feature set + * @state: address of 48-byte state (%rdi) + * @data: address of data (%rsi) + * @nblocks: number of 64-byte blocks of data (%rdx) + * @inc: counter increment value (%rcx) + * + * This function supports 64-bit CPUs. + * + * Return: none (but modifies state) + * Prototype: asmlinkage void blake2s_compress_avx512(struct blake2s_state *state, const u8 *data, + * unsigned int nblocks, u32 inc); + */ SYM_FUNC_START(blake2s_compress_avx512) vmovdqu (%rdi),%xmm0 vmovdqu 0x10(%rdi),%xmm1