Browse Source

qcacld-3.0: Fix pktlog_ac_fmt.h documentation

The kernel-doc script detected a single documentation error in the
uapi folder, in uapi/linux/pktlog_ac_fmt.h, so fix it.

Change-Id: Ia1b1f2f7c7d84844cb36b980982d07d76e0d1015
CRs-Fixed: 3403505
Jeff Johnson 2 years ago
parent
commit
2933838e5c
1 changed files with 9 additions and 7 deletions
  1. 9 7
      uapi/linux/pktlog_ac_fmt.h

+ 9 - 7
uapi/linux/pktlog_ac_fmt.h

@@ -1,6 +1,6 @@
 /*
  * Copyright (c) 2012-2019 The Linux Foundation. All rights reserved.
- * Copyright (c) 2022 Qualcomm Innovation Center, Inc. All rights reserved.
+ * Copyright (c) 2022-2023 Qualcomm Innovation Center, Inc. All rights reserved.
  *
  * Permission to use, copy, modify, and/or distribute this software for
  * any purpose with or without fee is hereby granted, provided that the
@@ -94,12 +94,14 @@ struct ath_pktlog_hdr {
 
 /**
  * enum - Pktlog flag field details
- * packet origin [1:0]
- * 00 - Local
- * 01 - Remote
- * 10 - Unknown/Not applicable
- * 11 - Reserved
- * reserved [15:2]
+ * @PKTLOG_FLG_FRM_TYPE_LOCAL_S: local-generated frame (tx)
+ * @PKTLOG_FLG_FRM_TYPE_REMOTE_S: remote-generated frame (rx)
+ * @PKTLOG_FLG_FRM_TYPE_CLONE_S: cloned frame
+ * @PKTLOG_FLG_FRM_TYPE_CBF_S: CBF remote frame
+ * @PKTLOG_FLG_FRM_TYPE_UNKNOWN_S: Unknown
+ *
+ * struct ath_pktlog_hdr flags field bit definitions,
+ * (use 1 << [enum] to assign)
  */
 enum {
 	PKTLOG_FLG_FRM_TYPE_LOCAL_S = 0,