From patchwork Thu Mar 18 12:44:16 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Lee Jones X-Patchwork-Id: 404022 Delivered-To: patch@linaro.org Received: by 2002:a02:8562:0:0:0:0:0 with SMTP id g89csp443798jai; Thu, 18 Mar 2021 05:45:32 -0700 (PDT) X-Google-Smtp-Source: ABdhPJyYPRM0vTC+iptjzrBmulyiijroSv1VzY7LpPNtiQOnHnb3Cyud2Pf7TuP+rxcuMGqqZIPU X-Received: by 2002:a50:82c5:: with SMTP id 63mr3352634edg.97.1616071531920; Thu, 18 Mar 2021 05:45:31 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1616071531; cv=none; d=google.com; s=arc-20160816; b=FhzA51DCxjZnJuoZToqnGBWYDAbNmhO74jhsN58UM0SFvjnI1ygn1QXteYoUxqoIDP WttRc7gmXSmhh0a787CJA5XbOMqCCbESVAmYTp5kNwZ/j3I04i1ssRFxR0qyVgY4t39q jETwfoGxXl5Ghh+vsdVKWEGEoQBb+uzhJCB9Wa8sDd+20bZCrO/ZfJqOJ8jU2Y23MCg6 JAEYoZ1KDh9WhW1Lpua6C5sRPH1/fFJML9vz83LO5SCcZOIbuKpoCp8o5sr5je69IAlS HBv6GKA6HeEFf2MSgWX25vpHfoqTTgce4xXZvgtnEDVcwK4Nmk/XRqoJkaSW8CLsnvDA kogw== 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=GVJx+OIpfKowVFAHFOdCV34ApK3YA2W1l4+0ZHpyDsw=; b=cbcMJJ7ACsu9Al2jvdB4nwMgLsJ10k2tzIU33CwBppVjvc+k7WCiofWcMQEy3Y5l/K EqDFbbSEPRYPhTZErxtd4StJVLxOZUK1nlhYZRhf0GuSrQ75b+Bb3J7X6FaE7Yb0sRxN qvRHYZmJwPt9r8gP8j04Q7xy2X6J58+HsIkdwAqEaCYRPMBvFrnIUieXj7zAwT8FHybo 6Pk0BOkyJ25P78UQPpYP26tnz6eTW51X/fsmaKSz3jpntvmKgxni9eFFc9aom7hBOBMr baU/zFxB5R6BS3iYRQi75KcI6ZfESjJLRdFbnbBNEGyGWSKhtzXIHEJ9oKq6xEl+iwcC G5ig== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=oGDY3f1h; spf=pass (google.com: domain of linux-crypto-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-crypto-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from vger.kernel.org (vger.kernel.org. [23.128.96.18]) by mx.google.com with ESMTP id y21si1526558edo.16.2021.03.18.05.45.31; Thu, 18 Mar 2021 05:45:31 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-crypto-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18; Authentication-Results: mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=oGDY3f1h; spf=pass (google.com: domain of linux-crypto-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-crypto-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231375AbhCRMo7 (ORCPT + 3 others); Thu, 18 Mar 2021 08:44:59 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:60090 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231322AbhCRMof (ORCPT ); Thu, 18 Mar 2021 08:44:35 -0400 Received: from mail-wr1-x42c.google.com (mail-wr1-x42c.google.com [IPv6:2a00:1450:4864:20::42c]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 88D90C06174A for ; Thu, 18 Mar 2021 05:44:35 -0700 (PDT) Received: by mail-wr1-x42c.google.com with SMTP id z2so5377883wrl.5 for ; Thu, 18 Mar 2021 05:44:35 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=GVJx+OIpfKowVFAHFOdCV34ApK3YA2W1l4+0ZHpyDsw=; b=oGDY3f1hsLm/RRceUXYCZGe+2E0KHDebnMjvny/6+Yagr9ieN2j8lO5C8vjZzHMz7X 7nAV7LLYH10IRNIgLxGfNmp1Kum+lgpQl0PqzF9yp4/xMpugGIWehf7PI4LYJVhoBqDQ g41+/wiUN0dAaum5iOgMg9aC1UkR22yz/jdB+/Wiqg3Gt9JHNlis7eWQ6n8MqBb35Qa4 tFxVgMEfeqNv0DFLQPKpzeDRmvCYxGhihqRESBl4DVX2Q4qx/cxD1bBLHXEiM4LXg3lk NFG/aeBC3XVox9ORyb5x08AYb95qHo/w86EUWgrj/7DIaMzVy4aUBZoM6OAy72ml1KTh DLtw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=GVJx+OIpfKowVFAHFOdCV34ApK3YA2W1l4+0ZHpyDsw=; b=N3ZMlew72mx+FV1p+R/2xvJmJt/wyGHVTpjaNF43P4dMBLAvoTEqikcLJGnvqa5mP8 pjQ5MhEekJ3TM/li4vmUiPXP6oKIP3+cP4vceizUvV9Wpngzt8SlM7vx+O9a2z9GLbC3 /imFqbGEoLjWAug6Njur3nNs230B5rlwWIZhlwQZ4u7D7DkC9Bt9OKYKqPUmTEocCYz3 YskQlPhK3gc36xImO336iLdNi0/T6Ibt5pjLy5mckAg7I+wYaoAVHEsV94FVRyX3+PPw mW3wnncLKkiR1RmZbNd3O4rH9FC4IuFi+UCs3AQowLUtwYdMlCYyy1q6I9QrXuinUbMN XZxw== X-Gm-Message-State: AOAM531twgCh/orXuFQvTZe6qhDQTAs7+G2I/dysrMcswbDNj8zAvudH ZR7Sa7AoPyNB+ok9gVuG2otYDA== X-Received: by 2002:adf:e60e:: with SMTP id p14mr9567459wrm.221.1616071474295; Thu, 18 Mar 2021 05:44:34 -0700 (PDT) Received: from dell.default ([91.110.221.194]) by smtp.gmail.com with ESMTPSA id q15sm2813900wrx.56.2021.03.18.05.44.33 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 18 Mar 2021 05:44:33 -0700 (PDT) From: Lee Jones To: lee.jones@linaro.org Cc: linux-kernel@vger.kernel.org, Herbert Xu , "David S. Miller" , Shujuan Chen , Joakim Bech , Berne Hebark , Niklas Hernaeus , Jonas Linde , Andreas Westin , linux-crypto@vger.kernel.org Subject: [PATCH 04/10] crypto: ux500: hash: hash_core: Fix worthy kernel-doc headers and remove others Date: Thu, 18 Mar 2021 12:44:16 +0000 Message-Id: <20210318124422.3200180-5-lee.jones@linaro.org> X-Mailer: git-send-email 2.27.0 In-Reply-To: <20210318124422.3200180-1-lee.jones@linaro.org> References: <20210318124422.3200180-1-lee.jones@linaro.org> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-crypto@vger.kernel.org The ones remove here not only fail to conform to kernel-doc, but also provide no value, so let's remove them completely in this case. Fixes the following W=1 kernel build warning(s): drivers/crypto/ux500/hash/hash_core.c:368: warning: Function parameter or member 'ctx' not described in 'hash_get_device_data' drivers/crypto/ux500/hash/hash_core.c:368: warning: Excess function parameter 'hash_ctx' description in 'hash_get_device_data' drivers/crypto/ux500/hash/hash_core.c:551: warning: expecting prototype for hash_init(). Prototype was for ux500_hash_init() instead drivers/crypto/ux500/hash/hash_core.c:592: warning: Function parameter or member 'length' not described in 'hash_processblock' drivers/crypto/ux500/hash/hash_core.c:1302: warning: expecting prototype for hash_update(). Prototype was for ahash_update() instead drivers/crypto/ux500/hash/hash_core.c:1322: warning: expecting prototype for hash_final(). Prototype was for ahash_final() instead drivers/crypto/ux500/hash/hash_core.c:1622: warning: Function parameter or member 'device_data' not described in 'ahash_algs_register_all' drivers/crypto/ux500/hash/hash_core.c:1622: warning: expecting prototype for hash_algs_register_all(). Prototype was for ahash_algs_register_all() instead drivers/crypto/ux500/hash/hash_core.c:1647: warning: Function parameter or member 'device_data' not described in 'ahash_algs_unregister_all' drivers/crypto/ux500/hash/hash_core.c:1647: warning: expecting prototype for hash_algs_unregister_all(). Prototype was for ahash_algs_unregister_all() instead drivers/crypto/ux500/cryp/cryp.c:19: warning: Incorrect use of kernel-doc format: * cryp_wait_until_done - wait until the device logic is not busy drivers/crypto/ux500/cryp/cryp.c:22: warning: Function parameter or member 'device_data' not described in 'cryp_wait_until_done' drivers/crypto/ux500/cryp/cryp.c:22: warning: expecting prototype for ST(). Prototype was for cryp_wait_until_done() instead drivers/crypto/ux500/cryp/cryp.c:292: warning: Function parameter or member 'cryp_mode' not described in 'cryp_save_device_context' drivers/crypto/ux500/cryp/cryp_irq.c:21: warning: Function parameter or member 'device_data' not described in 'cryp_enable_irq_src' drivers/crypto/ux500/cryp/cryp_irq.c:21: warning: Function parameter or member 'irq_src' not described in 'cryp_enable_irq_src' drivers/crypto/ux500/cryp/cryp_irq.c:21: warning: expecting prototype for ST(). Prototype was for cryp_enable_irq_src() instead drivers/crypto/ux500/cryp/cryp_core.c:42: warning: expecting prototype for ST(). Prototype was for CRYP_MAX_KEY_SIZE() instead drivers/crypto/ux500/cryp/cryp_core.c:91: warning: Function parameter or member 'key' not described in 'cryp_ctx' drivers/crypto/ux500/cryp/cryp_core.c:91: warning: Function parameter or member 'session_id' not described in 'cryp_ctx' Cc: Herbert Xu Cc: "David S. Miller" Cc: Shujuan Chen Cc: Joakim Bech Cc: Berne Hebark Cc: Niklas Hernaeus Cc: Jonas Linde Cc: Andreas Westin Cc: linux-crypto@vger.kernel.org Signed-off-by: Lee Jones --- drivers/crypto/ux500/cryp/cryp.c | 5 +++-- drivers/crypto/ux500/cryp/cryp_core.c | 5 +++-- drivers/crypto/ux500/cryp/cryp_irq.c | 2 +- drivers/crypto/ux500/hash/hash_core.c | 15 +++++---------- 4 files changed, 12 insertions(+), 15 deletions(-) -- 2.27.0 diff --git a/drivers/crypto/ux500/cryp/cryp.c b/drivers/crypto/ux500/cryp/cryp.c index 9866c2a5e9a70..759d0d9786fd1 100644 --- a/drivers/crypto/ux500/cryp/cryp.c +++ b/drivers/crypto/ux500/cryp/cryp.c @@ -1,5 +1,5 @@ // SPDX-License-Identifier: GPL-2.0-only -/** +/* * Copyright (C) ST-Ericsson SA 2010 * Author: Shujuan Chen for ST-Ericsson. * Author: Jonas Linde for ST-Ericsson. @@ -15,7 +15,7 @@ #include "cryp_p.h" #include "cryp.h" -/** +/* * cryp_wait_until_done - wait until the device logic is not busy */ void cryp_wait_until_done(struct cryp_device_data *device_data) @@ -285,6 +285,7 @@ int cryp_configure_init_vector(struct cryp_device_data *device_data, * other device context parameter * @device_data: Pointer to the device data struct for base address. * @ctx: Crypto device context + * @cryp_mode: Mode: Polling, Interrupt or DMA */ void cryp_save_device_context(struct cryp_device_data *device_data, struct cryp_device_context *ctx, diff --git a/drivers/crypto/ux500/cryp/cryp_core.c b/drivers/crypto/ux500/cryp/cryp_core.c index c3adeb2e58232..25ce56d05084e 100644 --- a/drivers/crypto/ux500/cryp/cryp_core.c +++ b/drivers/crypto/ux500/cryp/cryp_core.c @@ -1,5 +1,5 @@ // SPDX-License-Identifier: GPL-2.0-only -/** +/* * Copyright (C) ST-Ericsson SA 2010 * Author: Shujuan Chen for ST-Ericsson. * Author: Joakim Bech for ST-Ericsson. @@ -62,7 +62,7 @@ struct cryp_driver_data { /** * struct cryp_ctx - Crypto context * @config: Crypto mode. - * @key[CRYP_MAX_KEY_SIZE]: Key. + * @key: Key array. * @keylen: Length of key. * @iv: Pointer to initialization vector. * @indata: Pointer to indata. @@ -73,6 +73,7 @@ struct cryp_driver_data { * @updated: Updated flag. * @dev_ctx: Device dependent context. * @device: Pointer to the device. + * @session_id: Atomic session ID. */ struct cryp_ctx { struct cryp_config config; diff --git a/drivers/crypto/ux500/cryp/cryp_irq.c b/drivers/crypto/ux500/cryp/cryp_irq.c index 7ebde69e8c76b..6d2f07bec98a7 100644 --- a/drivers/crypto/ux500/cryp/cryp_irq.c +++ b/drivers/crypto/ux500/cryp/cryp_irq.c @@ -1,5 +1,5 @@ // SPDX-License-Identifier: GPL-2.0-only -/** +/* * Copyright (C) ST-Ericsson SA 2010 * Author: Shujuan Chen for ST-Ericsson. * Author: Jonas Linde for ST-Ericsson. diff --git a/drivers/crypto/ux500/hash/hash_core.c b/drivers/crypto/ux500/hash/hash_core.c index da284b0ea1b26..bcaf6ba3e9235 100644 --- a/drivers/crypto/ux500/hash/hash_core.c +++ b/drivers/crypto/ux500/hash/hash_core.c @@ -356,7 +356,7 @@ static int hash_enable_power(struct hash_device_data *device_data, /** * hash_get_device_data - Checks for an available hash device and return it. - * @hash_ctx: Structure for the hash context. + * @ctx: Structure for the hash context. * @device_data: Structure for the hash device. * * This function check for an available hash device and return it to @@ -542,7 +542,7 @@ static bool hash_dma_valid_data(struct scatterlist *sg, int datasize) } /** - * hash_init - Common hash init function for SHA1/SHA2 (SHA256). + * ux500_hash_init - Common hash init function for SHA1/SHA2 (SHA256). * @req: The hash request for the job. * * Initialize structures. @@ -585,6 +585,7 @@ static int ux500_hash_init(struct ahash_request *req) * @device_data: Structure for the hash device. * @message: Block (512 bits) of message to be written to * the HASH hardware. + * @length: Message length * */ static void hash_processblock(struct hash_device_data *device_data, @@ -1295,7 +1296,7 @@ void hash_get_digest(struct hash_device_data *device_data, } /** - * hash_update - The hash update function for SHA1/SHA2 (SHA256). + * ahash_update - The hash update function for SHA1/SHA2 (SHA256). * @req: The hash request for the job. */ static int ahash_update(struct ahash_request *req) @@ -1315,7 +1316,7 @@ static int ahash_update(struct ahash_request *req) } /** - * hash_final - The hash final function for SHA1/SHA2 (SHA256). + * ahash_final - The hash final function for SHA1/SHA2 (SHA256). * @req: The hash request for the job. */ static int ahash_final(struct ahash_request *req) @@ -1615,9 +1616,6 @@ static struct hash_algo_template hash_algs[] = { } }; -/** - * hash_algs_register_all - - */ static int ahash_algs_register_all(struct hash_device_data *device_data) { int ret; @@ -1640,9 +1638,6 @@ static int ahash_algs_register_all(struct hash_device_data *device_data) return ret; } -/** - * hash_algs_unregister_all - - */ static void ahash_algs_unregister_all(struct hash_device_data *device_data) { int i;