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

osi: core: Update NvEthernetRm ICD

Browse Source 
Update header files to document
all external interfaces of
the NvEthernetRm Unit for
ICD generation.

Jira NET-1013

Change-Id: I776b7e01a0478dbaf7baaa1fdf363df804429892
Signed-off-by: Mohan Thadikamalla <mohant@nvidia.com>
Reviewed-on: https://git-master.nvidia.com/r/c/kernel/nvethernetrm/+/2962418
(cherry picked from commit 09e194e62fe2b2fc85d44aabadf3880cf2a0a993)
Reviewed-on: https://git-master.nvidia.com/r/c/kernel/nvethernetrm/+/2970428
Tested-by: mobile promotions <svcmobile_promotions@nvidia.com>
Reviewed-by: mobile promotions <svcmobile_promotions@nvidia.com>
This commit is contained in:
Mohan Thadikamalla
2023-08-16 14:17:16 +05:30
committed by mobile promotions
parent 232ce3ef80
commit 1ef7aac8cb
2 changed files with 263 additions and 116 deletions
Download Patch File Download Diff File Expand all files Collapse all files

52
include/ivc_core.h
View File

@@ -1,5 +1,5 @@
/*
* Copyright (c) 2020-2022, NVIDIA CORPORATION. All rights reserved.
* 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"),
@@ -171,20 +171,50 @@ typedef struct ivc_msg_common {
} ivc_msg_common_t;
/**
* @brief osd_ivc_send_cmd - OSD ivc send cmd
* @brief
* Description: OSD ivc send cmd
*
* @param[in] priv: OSD private data
* @param[in] ivc_buf: ivc_msg_common structure
* @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
* @note
* API Group:
* - Initialization: Yes
* - Run time: Yes
* - De-initialization: Yes
* * 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 execution 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
*
* @retval ivc status
* @retval -1 on failure
*/
#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 */