Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.6.0.3
openapi_bcmsdk_access.h
Go to the documentation of this file.
1 
9 /*********************************************************************
10 *
11 * Copyright 2016-2018 Broadcom.
12 *
13 * Licensed under the Apache License, Version 2.0 (the "License");
14 * you may not use this file except in compliance with the License.
15 * You may obtain a copy of the License at
16 *
17 * http://www.apache.org/licenses/LICENSE-2.0
18 *
19 * Unless required by applicable law or agreed to in writing, software
20 * distributed under the License is distributed on an "AS IS" BASIS,
21 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
22 * See the License for the specific language governing permissions and
23 * limitations under the License.
24 *
25 **********************************************************************
26 *
27 * @filename openapi_bcmsdk_access.h
28 *
29 * @purpose BCM SDK shell
30 *
31 * @component OPEN
32 *
33 * @create 11/25/2012
34 *
35 * @end
36 *
37 **********************************************************************/
38 #ifndef OPENAPI_BCMSDK_ACCESS_H_INCLUDED
39 #define OPENAPI_BCMSDK_ACCESS_H_INCLUDED
40 
41 #include "openapi_common.h"
42 
43 /******************************************************************************/
73  open_buffdesc * cliCmd,
74  open_buffdesc * fileName,
75  uint32_t appendToFile);
76 
77 /*****************************************************************/
99  uint32_t bcmUnit,
100  open_buffdesc * regName, uint64_t * val);
101 
102 
103 /*****************************************************************/
125  client_handle, uint32_t UnitIndex,
126  open_buffdesc * regName,
127  uint32_t portNum, uint64_t * val);
128 #endif /* OPENAPI_BCMSDK_ACCESS_H_INCLUDED */
129 
open_error_t openapiSdkShellCmdRun(openapiClientHandle_t *client_handle, open_buffdesc *cliCmd, open_buffdesc *fileName, uint32_t appendToFile)
Execute BCM SDK shell commands.
open_error_t
OPEN uses these enumerators to indicate the error codes.
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.
open_error_t openapiSdkRegReadByName(openapiClientHandle_t *client_handle, uint32_t bcmUnit, open_buffdesc *regName, uint64_t *val)
Read a register given its Name.