Open Ethernet Networking (OpEN) API Guide and Reference Manual
3.6.0.3
|
Functions | |
open_error_t | openapiSdkPortRegReadByName (openapiClientHandle_t *client_handle, uint32_t UnitIndex, open_buffdesc *regName, uint32_t portNum, uint64_t *val) |
Read a Port Register given its Name. More... | |
open_error_t | openapiSdkRegReadByName (openapiClientHandle_t *client_handle, uint32_t bcmUnit, open_buffdesc *regName, uint64_t *val) |
Read a register given its Name. More... | |
open_error_t | openapiSdkShellCmdRun (openapiClientHandle_t *client_handle, open_buffdesc *cliCmd, open_buffdesc *fileName, uint32_t appendToFile) |
Execute BCM SDK shell commands. More... | |
open_error_t openapiSdkPortRegReadByName | ( | openapiClientHandle_t * | client_handle, |
uint32_t | UnitIndex, | ||
open_buffdesc * | regName, | ||
uint32_t | portNum, | ||
uint64_t * | val | ||
) |
Read a Port Register given its Name.
[in] | client_handle | client handle from registration API |
[in] | UnitIndex | unit number for the device. |
[in] | regName | Register Name. |
[in] | portNum | Port number. |
[out] | val | output location. |
OPEN_E_NONE | Port register read success. |
OPEN_E_FAIL | Failed to read the port register. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | Not supported for this platform. |
open_error_t openapiSdkRegReadByName | ( | openapiClientHandle_t * | client_handle, |
uint32_t | bcmUnit, | ||
open_buffdesc * | regName, | ||
uint64_t * | val | ||
) |
Read a register given its Name.
[in] | client_handle | client handle from registration API |
[in] | bcmUnit | BCM unit number for the device. |
[in] | regName | Register Name. |
[out] | val | output location. |
OPEN_E_NONE | register read success. |
OPEN_E_FAIL | Failed to read the register. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | Not supported for this platform. |
OpEN API Version: 1.1
open_error_t openapiSdkShellCmdRun | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | cliCmd, | ||
open_buffdesc * | fileName, | ||
uint32_t | appendToFile | ||
) |
Execute BCM SDK shell commands.
[in] | client_handle | client handle from registration API |
[in] | cliCmd | Shell commands to be executed. Multiple shell commands can be specified by separating them by a semicolon. |
[in] | fileName | Name of file to which command output is written. The name must include the complete path for the file. If the complete path is not specified, then the file is created in flash. NULL: Indicates output should be printed to console |
[in] | appendToFile | If the output is to be written to a file, OPEN_ENABLE indicates that the output should be appended to the file and OPEN_DISABLE indicates that the output should override the contents of file. |
OPEN_E_NONE | Executed BCM SDK shell commands. |
OPEN_E_FAIL | Failed to Execute BCM SDK shell commands. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | Not supported for this platform. |
OpEN API Version: 1.1