Message ID | 20240118-ath10k-kerneldoc-v1-2-99c7e8d95aad@quicinc.com |
---|---|
State | New |
Headers |
Return-Path: <linux-kernel+bounces-30340-ouuuleilei=gmail.com@vger.kernel.org> Delivered-To: ouuuleilei@gmail.com Received: by 2002:a05:7301:2bc4:b0:101:a8e8:374 with SMTP id hx4csp449793dyb; Thu, 18 Jan 2024 08:14:53 -0800 (PST) X-Google-Smtp-Source: AGHT+IEa+Mv4372hIaYHRmih6+F1hsb+AtFVm3hymSt2QAw2A3M2zwgrCrqF7Qr16S/rnKCGtwXg X-Received: by 2002:a17:902:f68e:b0:1d4:bd0a:2252 with SMTP id l14-20020a170902f68e00b001d4bd0a2252mr1185689plg.55.1705594493176; Thu, 18 Jan 2024 08:14:53 -0800 (PST) Received: from sv.mirrors.kernel.org (sv.mirrors.kernel.org. [139.178.88.99]) by mx.google.com with ESMTPS id c3-20020a170903234300b001d71667947csi319823plh.337.2024.01.18.08.14.53 for <ouuuleilei@gmail.com> (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 18 Jan 2024 08:14:53 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel+bounces-30340-ouuuleilei=gmail.com@vger.kernel.org designates 139.178.88.99 as permitted sender) client-ip=139.178.88.99; Authentication-Results: mx.google.com; dkim=pass header.i=@quicinc.com header.s=qcppdkim1 header.b=SlDeFIXP; arc=fail (signature failed); spf=pass (google.com: domain of linux-kernel+bounces-30340-ouuuleilei=gmail.com@vger.kernel.org designates 139.178.88.99 as permitted sender) smtp.mailfrom="linux-kernel+bounces-30340-ouuuleilei=gmail.com@vger.kernel.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=quicinc.com Received: from smtp.subspace.kernel.org (wormhole.subspace.kernel.org [52.25.139.140]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by sv.mirrors.kernel.org (Postfix) with ESMTPS id EA861285496 for <ouuuleilei@gmail.com>; Thu, 18 Jan 2024 16:14:52 +0000 (UTC) Received: from localhost.localdomain (localhost.localdomain [127.0.0.1]) by smtp.subspace.kernel.org (Postfix) with ESMTP id 46B402D600; Thu, 18 Jan 2024 16:13:05 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=quicinc.com header.i=@quicinc.com header.b="SlDeFIXP" Received: from mx0a-0031df01.pphosted.com (mx0a-0031df01.pphosted.com [205.220.168.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 0DD5328E1B; Thu, 18 Jan 2024 16:13:00 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=205.220.168.131 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1705594382; cv=none; b=qFqFkd7uWF4BdgZWRJjjJRswBNDlTrCTOAPH4V5psEpuGMKLxedqjzoHftBXbnjX3F4qELUaS4isRa5aDLPgVUW1QJ4MGVNtYcOSq1CKc6zG5q4Z5rhworcL9GqFr3tPuN64HemE80cWWO7fOAm003Zc0lhPKckltUhE22A8QOc= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1705594382; c=relaxed/simple; bh=SMU1jX6PhXnmPDPzo/FpSVauBEGe7pblmdCuBnGURzQ=; h=Received:DKIM-Signature:Received:Received:Received:From:Date: Subject:MIME-Version:Content-Type:Content-Transfer-Encoding: Message-ID:References:In-Reply-To:To:CC:X-Mailer:X-Originating-IP: X-ClientProxiedBy:X-QCInternal:X-Proofpoint-Virus-Version: X-Proofpoint-ORIG-GUID:X-Proofpoint-GUID: X-Proofpoint-Virus-Version:X-Proofpoint-Spam-Details; b=XyQlY4gxXcrjrpxBNf+VBld4qFoEIa3QJCthoHSNT2O9jMvNRfySGVgmKF00n4uUaJF6m0EuVPkOZQAUxoNf2vBN6MFN9qnRJFJ+/NNsMlPx1r8SSoRYDL3LtWfjymkcZsIW52ttwly4096VjBf5zgv6LRM1A6qcFZKuq5e59Qc= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=quicinc.com; spf=pass smtp.mailfrom=quicinc.com; dkim=pass (2048-bit key) header.d=quicinc.com header.i=@quicinc.com header.b=SlDeFIXP; arc=none smtp.client-ip=205.220.168.131 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=quicinc.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=quicinc.com Received: from pps.filterd (m0279864.ppops.net [127.0.0.1]) by mx0a-0031df01.pphosted.com (8.17.1.24/8.17.1.24) with ESMTP id 40I5tT6B029612; Thu, 18 Jan 2024 16:12:56 GMT DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=quicinc.com; h= from:date:subject:mime-version:content-type :content-transfer-encoding:message-id:references:in-reply-to:to :cc; s=qcppdkim1; bh=K3vaS6b06RF0cEsIJCiW4movKSJGZbEk5gzMjPj+5Ss =; b=SlDeFIXPD+ugQxUNwUFuHxPS7oKXY+NXNj8mDNEICtAgTGePcEkZxNSGGIx bXsVPD0V5fQdeOkceBQe+2BxJcymWZFrkoZjCw5SXq33zogtM8wx2jcYccTOZOl0 thZNhLZOYo5EDdu/N6P2agzS0jJxBrnLR64EaczYZkmd1Z2OiCeOG+6NMtVnYy3K WEPUbROpdIV8lFCBZwmCNzEiMxWTjm/xtnBKtvBjrmzGHmJ6TgLd99+ErbQxFSMj B1aN7JrQ7CpxvraT0Aj5n5GUFDKpbfSKDFxH9G1yDgM3MJTNuEF9qP1ol7j0MNEp oaxKmWhlvxd0KaXXHxioQk/4BEQ== Received: from nalasppmta05.qualcomm.com (Global_NAT1.qualcomm.com [129.46.96.20]) by mx0a-0031df01.pphosted.com (PPS) with ESMTPS id 3vpx8shg6j-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT); Thu, 18 Jan 2024 16:12:56 +0000 (GMT) Received: from nalasex01a.na.qualcomm.com (nalasex01a.na.qualcomm.com [10.47.209.196]) by NALASPPMTA05.qualcomm.com (8.17.1.5/8.17.1.5) with ESMTPS id 40IGCtr1007126 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT); Thu, 18 Jan 2024 16:12:55 GMT Received: from [169.254.0.1] (10.49.16.6) by nalasex01a.na.qualcomm.com (10.47.209.196) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.2.1118.40; Thu, 18 Jan 2024 08:12:55 -0800 From: Jeff Johnson <quic_jjohnson@quicinc.com> Date: Thu, 18 Jan 2024 08:12:54 -0800 Subject: [PATCH 2/5] wifi: ath10k: correctly document enum wmi_tlv_tx_pause_id Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: <linux-kernel.vger.kernel.org> List-Subscribe: <mailto:linux-kernel+subscribe@vger.kernel.org> List-Unsubscribe: <mailto:linux-kernel+unsubscribe@vger.kernel.org> MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: 7bit Message-ID: <20240118-ath10k-kerneldoc-v1-2-99c7e8d95aad@quicinc.com> References: <20240118-ath10k-kerneldoc-v1-0-99c7e8d95aad@quicinc.com> In-Reply-To: <20240118-ath10k-kerneldoc-v1-0-99c7e8d95aad@quicinc.com> To: Kalle Valo <kvalo@kernel.org>, Jeff Johnson <quic_jjohnson@quicinc.com> CC: <ath10k@lists.infradead.org>, <linux-wireless@vger.kernel.org>, <linux-kernel@vger.kernel.org> X-Mailer: b4 0.12.3 X-ClientProxiedBy: nalasex01a.na.qualcomm.com (10.47.209.196) To nalasex01a.na.qualcomm.com (10.47.209.196) X-QCInternal: smtphost X-Proofpoint-Virus-Version: vendor=nai engine=6200 definitions=5800 signatures=585085 X-Proofpoint-ORIG-GUID: 5bNRrb3fY-XX-4SLPoWVn6jbR40JS2Wp X-Proofpoint-GUID: 5bNRrb3fY-XX-4SLPoWVn6jbR40JS2Wp X-Proofpoint-Virus-Version: vendor=baseguard engine=ICAP:2.0.272,Aquarius:18.0.997,Hydra:6.0.619,FMLib:17.11.176.26 definitions=2024-01-18_08,2024-01-17_01,2023-05-22_02 X-Proofpoint-Spam-Details: rule=outbound_notspam policy=outbound score=0 adultscore=0 spamscore=0 phishscore=0 priorityscore=1501 mlxlogscore=737 impostorscore=0 mlxscore=0 bulkscore=0 suspectscore=0 malwarescore=0 clxscore=1015 lowpriorityscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.19.0-2311290000 definitions=main-2401180118 X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1788445451354919998 X-GMAIL-MSGID: 1788445451354919998 |
Series |
wifi: ath10k: fix ath10k kerneldoc issues
|
|
Commit Message
Jeff Johnson
Jan. 18, 2024, 4:12 p.m. UTC
Currently kernel-doc reports the issue:
drivers/net/wireless/ath/ath10k/wmi-tlv.h:2363: warning: cannot understand function prototype: 'enum wmi_tlv_tx_pause_id '
Update the enum wmi_tlv_tx_pause_id documentation to fix this issue.
No functional changes, compile tested only.
Signed-off-by: Jeff Johnson <quic_jjohnson@quicinc.com>
---
drivers/net/wireless/ath/ath10k/wmi-tlv.h | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
Comments
On 1/18/24 08:12, Jeff Johnson wrote: > Currently kernel-doc reports the issue: > drivers/net/wireless/ath/ath10k/wmi-tlv.h:2363: warning: cannot understand function prototype: 'enum wmi_tlv_tx_pause_id ' > > Update the enum wmi_tlv_tx_pause_id documentation to fix this issue. > > No functional changes, compile tested only. > > Signed-off-by: Jeff Johnson <quic_jjohnson@quicinc.com> Acked-by: Randy Dunlap <rdunlap@infradead.org> Thanks. > --- > drivers/net/wireless/ath/ath10k/wmi-tlv.h | 4 ++-- > 1 file changed, 2 insertions(+), 2 deletions(-) > > diff --git a/drivers/net/wireless/ath/ath10k/wmi-tlv.h b/drivers/net/wireless/ath/ath10k/wmi-tlv.h > index 83a8f07a687f..8a2f87d0a3a3 100644 > --- a/drivers/net/wireless/ath/ath10k/wmi-tlv.h > +++ b/drivers/net/wireless/ath/ath10k/wmi-tlv.h > @@ -3,7 +3,7 @@ > * Copyright (c) 2005-2011 Atheros Communications Inc. > * Copyright (c) 2011-2017 Qualcomm Atheros, Inc. > * Copyright (c) 2018-2019, The Linux Foundation. All rights reserved. > - * Copyright (c) 2022 Qualcomm Innovation Center, Inc. All rights reserved. > + * Copyright (c) 2022, 2024 Qualcomm Innovation Center, Inc. All rights reserved. > */ > #ifndef _WMI_TLV_H > #define _WMI_TLV_H > @@ -2343,7 +2343,7 @@ struct wmi_tlv_adaptive_qcs { > } __packed; > > /** > - * wmi_tlv_tx_pause_id - firmware tx queue pause reason types > + * enum wmi_tlv_tx_pause_id - firmware tx queue pause reason types > * > * @WMI_TLV_TX_PAUSE_ID_MCC: used for by multi-channel firmware scheduler. > * Only vdev_map is valid. >
diff --git a/drivers/net/wireless/ath/ath10k/wmi-tlv.h b/drivers/net/wireless/ath/ath10k/wmi-tlv.h index 83a8f07a687f..8a2f87d0a3a3 100644 --- a/drivers/net/wireless/ath/ath10k/wmi-tlv.h +++ b/drivers/net/wireless/ath/ath10k/wmi-tlv.h @@ -3,7 +3,7 @@ * Copyright (c) 2005-2011 Atheros Communications Inc. * Copyright (c) 2011-2017 Qualcomm Atheros, Inc. * Copyright (c) 2018-2019, The Linux Foundation. All rights reserved. - * Copyright (c) 2022 Qualcomm Innovation Center, Inc. All rights reserved. + * Copyright (c) 2022, 2024 Qualcomm Innovation Center, Inc. All rights reserved. */ #ifndef _WMI_TLV_H #define _WMI_TLV_H @@ -2343,7 +2343,7 @@ struct wmi_tlv_adaptive_qcs { } __packed; /** - * wmi_tlv_tx_pause_id - firmware tx queue pause reason types + * enum wmi_tlv_tx_pause_id - firmware tx queue pause reason types * * @WMI_TLV_TX_PAUSE_ID_MCC: used for by multi-channel firmware scheduler. * Only vdev_map is valid.