nv-tegra-mirror/nvethernetrm
1
0
Fork 0
mirror of git://nv-tegra.nvidia.com/kernel/nvethernetrm.git synced 2025-12-24 10:34:24 +03:00
Code Issues Packages Projects Releases Wiki Activity

nveternetrm: fix doxygen comments

Browse Source 
Bug 2804631
Bug 2804169
Bug 200561709

Change-Id: I6d61c8b8a911ae3847049c534e6d19e0aec65209
Signed-off-by: narayanr <narayanr@nvidia.com>
Reviewed-on: https://git-master.nvidia.com/r/c/kernel/nvethernetrm/+/2306568
Tested-by: mobile promotions <svcmobile_promotions@nvidia.com>
Reviewed-by: svc-mobile-coverity <svc-mobile-coverity@nvidia.com>
Reviewed-by: svc-mobile-misra <svc-mobile-misra@nvidia.com>
Reviewed-by: svc-mobile-cert <svc-mobile-cert@nvidia.com>
Reviewed-by: Automatic_Commit_Validation_User
Reviewed-by: Bhadram Varka <vbhadram@nvidia.com>
Reviewed-by: Srinivas Ramachandran <srinivasra@nvidia.com>
Reviewed-by: mobile promotions <svcmobile_promotions@nvidia.com>
GVS: Gerrit_Virtual_Submit
This commit is contained in:
narayanr
2020-03-03 21:00:24 +05:30
committed by Bhadram Varka
parent 8b89217184
commit 173f516672
4 changed files with 76 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
include/osi_common.h
View File

@@ -24,7 +24,9 @@
#define OSI_COMMON_H
/**
* @addtogroup EQOS-Helper Helper MACROS
* @addtogroup Helper Helper MACROS
*
* @brief EQOS generic helper MACROS.
* @{
*/
#define OSI_UNLOCKED 0x0U
@@ -43,6 +45,7 @@
#define OSI_MAX_TX_COALESCE_USEC 1020U
#define OSI_MIN_TX_COALESCE_USEC 32U
#define OSI_MIN_TX_COALESCE_FRAMES 1U
/** @} */
/**
* @addtogroup - LPI-Timers LPI configuration macros
@@ -83,6 +86,12 @@
#define OSI_MIN_TX_LPI_TIMER 0x8U
/** @} */
/**
* @addtogroup Helper Helper MACROS
*
* @brief EQOS generic helper MACROS.
* @{
*/
#define OSI_PAUSE_FRAMES_ENABLE 0U
#define OSI_PAUSE_FRAMES_DISABLE 1U
#define OSI_FLOW_CTRL_TX OSI_BIT(0)
@@ -99,8 +108,14 @@
#ifndef INT_MAX
#define INT_MAX (0x7FFFFFFF)
#endif
/** @} */
/* MAC Time stamp contorl reg bit fields */
/**
* @addtogroup EQOS_PTP PTP Helper MACROS
*
* @brief EQOS PTP MAC Time stamp contorl reg bit fields
* @{
*/
#define OSI_MAC_TCR_TSENA OSI_BIT(0)
#define OSI_MAC_TCR_TSCFUPDT OSI_BIT(1)
#define OSI_MAC_TCR_TSENALL OSI_BIT(8)
@@ -115,7 +130,14 @@
#define OSI_MAC_TCR_SNAPTYPSEL_2 OSI_BIT(17)
#define OSI_MAC_TCR_SNAPTYPSEL_3 (OSI_BIT(16) | OSI_BIT(17))
#define OSI_MAC_TCR_AV8021ASMEN OSI_BIT(28)
/** @} */
/**
* @addtogroup Helper Helper MACROS
*
* @brief EQOS generic helper MACROS.
* @{
*/
#define OSI_ULLONG_MAX (~0ULL)
#define OSI_UCHAR_MAX (0xFFU)
@@ -330,7 +352,7 @@
/** @} */
/**
* @addtogroup MTL queue AVB algorithm mode
* @addtogroup EQOS_MTL MTL queue AVB algorithm mode
*
* @brief MTL AVB queue algorithm type
* @{
@@ -680,14 +702,13 @@ void osi_get_hw_features(void *base, struct osi_hw_features *hw_feat);
*/
void osi_memset(void *s, unsigned int c, unsigned long count);
/*
/**
* @brief Function to store a backup of MAC register space during SOC suspend.
*
* Algorithm: Read registers to be backed up as per struct core_backup and
* store the register values in memory.
*
* @param[in] config: Pointer to core_backup structure.
* @param[in] max_regs: Max num of registers to backup.
*
* @retval none
*/
@@ -700,7 +721,6 @@ void mac_save_registers(struct core_backup *const config);
* osi_save_registers().
*
* @param[in] config: Pointer to core_backup structure.
* @param[in] max_regs: Max num of registers to restore.
*
* @retval none
*/