osi: core: fix Doxygen warnings

1) Fix Doxygen warnings
2) include debug.h code only when OSI_DEBUG
is defined

JIRA NET-570

Change-Id: I5d002b959925bec3898cc2faafe3f506b3c9bd22
Signed-off-by: Narayan Reddy<narayanr@nvidia.com>
Reviewed-on: https://git-master.nvidia.com/r/c/kernel/nvethernetrm/+/2847327
Tested-by: mobile promotions <svcmobile_promotions@nvidia.com>
Reviewed-by: mobile promotions <svcmobile_promotions@nvidia.com>
This commit is contained in:
Narayan Reddy
2023-01-23 01:03:54 +05:30
committed by mobile promotions
parent 2a82c10c8f
commit 3fff0cd9ba
17 changed files with 70 additions and 70 deletions

View File

@@ -613,7 +613,7 @@ fail:
* @brief hw_est_read - indirect read the GCL to Software own list
* (SWOL)
*
* @param[in] base: MAC base IOVA address.
* @param[in] osi_core: OSI core private data structure.
* @param[in] addr_val: Address offset for indirect write.
* @param[in] data: Data to be written at offset.
* @param[in] gcla: Gate Control List Address, 0 for ETS register.
@@ -677,6 +677,7 @@ err:
*
* @param[in] osi_core: OSI core private data structure.
* @param[in] est: Configuration input argument.
* @param[in] btr: Base time register value.
* @param[in] mac: MAC index
*
* @note MAC should be init and started. see osi_start_mac()
@@ -858,7 +859,7 @@ done:
* @brief hw_est_write - indirect write the GCL to Software own list
* (SWOL)
*
* @param[in] base: MAC base IOVA address.
* @param[in] osi_core: OSI core private data structure.
* @param[in] addr_val: Address offset for indirect write.
* @param[in] data: Data to be written at offset.
* @param[in] gcla: Gate Control List Address, 0 for ETS register.
@@ -1732,7 +1733,8 @@ static void prepare_l4_port_register(const struct osi_l3_l4_filter *const l3_l4,
*
* @param[in] osi_core: OSI core private data structure.
* @param[in] l3_l4: Pointer to l3 l4 filter structure (#osi_l3_l4_filter)
* @param[out] l4_addr_reg: Pointer to L3 ADDR0 register value
* @param[out] l3_addr1_reg: Pointer to L3 ADDR1 register value
* @param[out] ctr_reg: Pointer to L3L4 CTR register value
*
* @note 1) MAC should be init and started. see osi_start_mac()
* 2) osi_core->osd should be populated