Browse Source

qcacld-3.0: Fix DISA documentation

The kernel-doc script identified a few documentation issues in
components/disa, so fix them.

Change-Id: I211fac8d786a64023f9ba2038d5849c418c38159
CRs-Fixed: 3356921
Jeff Johnson 2 years ago
parent
commit
9a425bdb12

+ 3 - 0
components/disa/core/inc/wlan_disa_main.h

@@ -1,5 +1,6 @@
 /*
  * Copyright (c) 2018 The Linux Foundation. All rights reserved.
+ * Copyright (c) 2022 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
@@ -86,6 +87,8 @@ struct wlan_disa_ctx *disa_get_context(void);
  * disa_core_encrypt_decrypt_req() - Form encrypt/decrypt request
  * @psoc: objmgr psoc object
  * @req: DISA encrypt/decrypt request parameters
+ * @cb: Response callback for the encrypt/decrypt request
+ * @cookie: Cookie to pass to the response callback
  *
  * Return: QDF status success or failure
  */

+ 2 - 1
components/disa/core/inc/wlan_disa_objmgr.h

@@ -1,5 +1,6 @@
 /*
  * Copyright (c) 2018 The Linux Foundation. All rights reserved.
+ * Copyright (c) 2022 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
@@ -84,7 +85,7 @@ disa_vdev_get_id(struct wlan_objmgr_vdev *vdev)
 
 /* Tree Navigation */
 
-/**
+/*
  * !PLEASE READ!
  *
  * The following are objmgr navigation helpers for traversing objmgr object

+ 3 - 1
components/disa/core/inc/wlan_disa_priv.h

@@ -1,5 +1,6 @@
 /*
  * Copyright (c) 2018 The Linux Foundation. All rights reserved.
+ * Copyright (c) 2022 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
@@ -34,7 +35,7 @@
  *
  * @disa_rx_ops: rx operations for disa
  * @disa_tx_ops: tx operations for disa
- * @disa_psoc_lock: spin lock for disa psoc priv ctx
+ * @lock: spin lock for disa psoc priv ctx
  */
 struct disa_psoc_priv_obj {
 	struct wlan_disa_rx_ops disa_rx_ops;
@@ -47,6 +48,7 @@ struct disa_psoc_priv_obj {
  *
  * @callback: hdd callback for disa encrypt/decrypt resp
  * @callback_context: context for the callback
+ * @request_active: true if a request is active
  * @lock: spin lock for disa context
  */
 struct wlan_disa_ctx {

+ 8 - 2
components/disa/dispatcher/inc/wlan_disa_public_struct.h

@@ -1,5 +1,6 @@
 /*
  * Copyright (c) 2018 The Linux Foundation. All rights reserved.
+ * Copyright (c) 2022 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
@@ -69,7 +70,7 @@ struct disa_encrypt_decrypt_req_params {
  * struct disa_encrypt_decrypt_resp_params - disa encrypt response
  * @vdev_id: vdev id
  * @status: status
- * @data_length: data length
+ * @data_len: data length
  * @data: data pointer
  */
 struct disa_encrypt_decrypt_resp_params {
@@ -79,7 +80,12 @@ struct disa_encrypt_decrypt_resp_params {
 	uint8_t *data;
 };
 
+/**
+ * typedef encrypt_decrypt_resp_callback() - DISA callback function
+ * @cookie: cookie passed in the DISA request
+ * @resp: the DISA response
+ */
 typedef void (*encrypt_decrypt_resp_callback)(void *cookie,
-	struct disa_encrypt_decrypt_resp_params *resp) ;
+	struct disa_encrypt_decrypt_resp_params *resp);
 #endif /* end  of _WLAN_DISA_PUBLIC_STRUCT_H_ */
 

+ 1 - 8
components/disa/dispatcher/src/wlan_disa_ucfg_api.c

@@ -1,5 +1,6 @@
 /*
  * Copyright (c) 2018 The Linux Foundation. All rights reserved.
+ * Copyright (c) 2022 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
@@ -22,14 +23,6 @@
 #include "wlan_disa_ucfg_api.h"
 #include "wlan_disa_main.h"
 
-/**
- * ucfg_disa_encrypt_decrypt_req() - Send encrypt/decrypt request to the DISA
- * core
- * @psoc: objmgr psoc object
- * @req: DISA encrypt/decrypt request parameters
- *
- * Return: QDF status success or failure
- */
 QDF_STATUS ucfg_disa_encrypt_decrypt_req(struct wlan_objmgr_psoc *psoc,
 		struct disa_encrypt_decrypt_req_params *req,
 		encrypt_decrypt_resp_callback cb,