OpenNSL API Guide and Reference Manual
driver.h
Go to the documentation of this file.
1 /*********************************************************************
2 *
3 * (C) Copyright Broadcom Corporation 2013-2017
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 *
17 **********************************************************************
18 *
19 * \file driver.h
20 *
21 * \brief This file contains utility functions called externally
22 *
23 **********************************************************************/
24 #ifndef DRIVER_H
25 #define DRIVER_H
26 
27 #define OPENNSL_F_FAST_BOOT 0x00000001 /* Fast boot mode */
28 
29 typedef struct opennsl_config_s
30 {
31  char *cfg_fname; /* Configuration file name along with the path */
32  unsigned int flags; /* OpenNSL boot up flags */
33  char *wb_fname; /* File to store warmboot configuration *
34  * along with the path */
35  char *rmcfg_fname; /* RM config file name along with the path */
36  char *cfg_post_fname; /* Post init configuration file name *
37  * along with the path */
38  unsigned int opennsl_flags; /* OpenNSL flags */
39 } opennsl_init_t;
40 /* __doxy_func_body_end__ */
41 
42 /*****************************************************************/
50 extern int opennsl_driver_init(opennsl_init_t *init);
51 
52 /*****************************************************************/
57 extern int opennsl_driver_exit();
58 
59 /**************************************************************************/
64 extern unsigned int opennsl_driver_boot_flags_get(void);
65 
66 #ifdef INCLUDE_DIAG_SHELL
67 /*****************************************************************/
72 extern int opennsl_driver_shell();
73 
74 /*****************************************************************/
81 extern int opennsl_driver_process_command(char *commandBuf);
82 #endif
83 
84 /*****************************************************************/
93 extern char *readline(const char *prompt);
94 
95 extern void platform_phy_cleanup();
96 
97 #endif /* DRIVER_H */