osi: Fix Nvethernet and NvEthernetRm ICD comments

Issue:
Need to address the review comments
for NvEthernetRm and Nvethernet ICDs

Fix:
Revise core and DMA header files to address comments
in the ICD change request (CR)

Jira NET-1149
Jira NET-1167

Change-Id: Ibb8831bed471aac88b99b49611ac907f25f0a85f
Signed-off-by: Mohan Thadikamalla <mohant@nvidia.com>
Reviewed-on: https://git-master.nvidia.com/r/c/kernel/nvethernetrm/+/3017371
Reviewed-by: Bhadram Varka <vbhadram@nvidia.com>
Reviewed-by: svcacv <svcacv@nvidia.com>
Reviewed-by: Narayan Reddy <narayanr@nvidia.com>
Reviewed-by: Krishna Thota <kthota@nvidia.com>
GVS: Gerrit_Virtual_Submit <buildbot_gerritrpt@nvidia.com>
This commit is contained in:
Mohan Thadikamalla
2023-11-16 16:26:05 +05:30
committed by Bhadram Varka
parent e66dd0900d
commit 68b8af86a1

View File

@@ -1,5 +1,5 @@
/*
* Copyright (c) 2020-2023, NVIDIA CORPORATION. All rights reserved.
/* SPDX-License-Identifier: LicenseRef-NvidiaProprietary
* SPDX-FileCopyrightText: Copyright (c) 2020-2023, NVIDIA CORPORATION. All rights reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
@@ -170,51 +170,4 @@ typedef struct ivc_msg_common {
}data;
} ivc_msg_common_t;
/**
* @brief
* Description: OSD ivc send cmd
*
* @param[in] priv: Pointer to osi_core_priv_data structure
* * Range: A non-null pointer to NVETHERNETRM_PIF$osi_core_priv_data structure.
* @param[in] ivc_buf: Pointer to ivc_msg_common structure
* * Range: A non-null pointer to NVETHERNETRM_PIF$ivc_msg_common structure.
* @param[in] len: length of data
* * Range: 0 to UINT32_MAX
*
* @return
* - 0 on successful completion of the NVETHERNETRM_PIF#osd_ivc_send_cmd/osi_core
* IVC command.
* - -1 on NVETHERNETRM_PIF#osd_ivc_send_cmd/osi_core IVC command exection fail
* - -1 on NVETHERNETRM_PIF#osi_hw_core_init/osi_core is NULL
*
* @usage
* - Allowed context for the API call
* - Interrupt handler: No
* - Signal handler: No
* - Thread safe: No
* - Async/Sync: Sync
* - Required Privileges: None
* - API Group:
* - Initialization: Yes
* - Run time: Yes
* - De-initialization: Yes
*
*/
#ifndef DOXYGEN_ICD
/**
* @note
* Algorithm:
*
* @note
* Traceability Details:
*/
#else
/**
*
* @dir
* - forward
*/
#endif
nve32_t osd_ivc_send_cmd(void *priv, ivc_msg_common_t *ivc_buf,
nveu32_t len);
#endif /* IVC_CORE_H */