Include/sys_main_api.h

   1 /******************************************************************************
   2 ###############################################################################
   3 #   Copyright (c) [2017-2020] [ICT/CAS]                                        #
   4 #   Licensed under the ORAN Software License v1.0 (License)             #
   5 ###############################################################################
   6 ******************************************************************************/
   7
   8
   9 #ifndef __SYS_MAIN_API_H__
  10 #define __SYS_MAIN_API_H__
  11
  12
  13 #ifdef __cplusplus
  14 extern "C"
  15 {
  16 #endif
  17
  18 /******************************   Begin of File Body  **********************/
  19 #include "vos_common.h"
  20 #ifdef PLAT_MODULE_DEVSM
  21
  22 extern LONG sys_slot_is_master_slot( ULONG slotno );
  23 extern LONG devsm_module_workmode_is_master(ULONG slotno);
  24 extern LONG devsm_module_workmode_is_slave(ULONG slotno);
  25 extern LONG devsm_module_workmode_is_master_active(ULONG slotno);
  26 extern LONG devsm_module_workmode_is_master_standby(ULONG slotno);
  27 extern LONG sys_product_name_get(CHAR *str, ULONG max_len);
  28 extern USHORT sys_chassis_max_slotnum_get();
  29 extern USHORT sys_chassis_master_slotnum_get();
  30 extern ULONG sys_master_active_slotno_get();
  31 extern ULONG sys_local_module_slotno_get();
  32 extern ULONG sys_module_running_state_get(ULONG slotno);
  33 extern ULONG sys_module_is_have_cpu(ULONG slotno);
  34 extern ULONG sys_module_is_running(ULONG slotno);
  35 extern ULONG sys_module_is_ready(ULONG slotno);
  36 extern ULONG sys_module_is_inserted(ULONG slotno);
  37 extern LONG devsm_hot_get_module_type( LONG slotno );
  38 extern ULONG sys_module_type_get(ULONG slotno);
  39 extern LONG sys_module_have_pp(ULONG module_type);
  40 extern LONG sys_module_have_fpgapp(ULONG module_type);
  41 extern LONG sys_module_port_type_num(ULONG slotno, ULONG port_type);
  42
  43 extern ULONG g_ulProductDevIndex;
  44
  45 /** JT_SRAN设备索引 */
  46 #define JT_SRAN_DEV_ID  (g_ulProductDevIndex)
  47
  48 /** TRAP 类型，Dev 必须为1 */
  49 #define TRAP_TYPE_DEV     1
  50
  51 /** TRAP 类型，board 必须为2 */
  52 #define TRAP_TYPE_BOARD   2
  53
  54 /** TRAP 程序启动成功，AlarmID 为1*/
  55 #define ProgramStartSuccessAlarmID 1
  56
  57 /** TRAP 板卡热插入事件，AlarmID 为11*/
  58 #define BoardHotInsertAlarmID 11
  59
  60 /** TRAP 板卡热拔出事件，AlarmID 为12*/
  61 #define BoardHotPullAlarmID 12
  62
  63 /** TRAP 板卡重启事件，AlarmID 为13*/
  64 #define BoardHotRebootAlarmID 13
  65
  66 /** 设备管理模块名*/
  67 #define MOD_DEVSM_NAME  "DEVSM_MODULE"
  68
  69 /** 设备机框最大槽位个数 */
  70 #define PRODUCT_MAX_TOTAL_SLOTNUM 21
  71
  72 /** 设备管理使用通知链发送的信息 */
  73 typedef struct _devsm_notify_info_s
  74 {
  75         ULONG slotno;                   ///< 槽位号
  76         ULONG module_type;              ///< 板卡类型
  77 }devsm_notify_info_t;
  78
  79 /** 设备管理通知链板卡RUNNING事件 */
  80 #define DEVSN_NOTIFY_MOD_RUNNING_EVENT  0X01
  81
  82 #define CPI_HOOK_CALL(hookfunc) (NULL == (hookfunc))?(VOS_ERROR):(*hookfunc)
  83
  84 /**************************        产品相关           ***************************/
  85 #define SYS_PRODUCT_NAME_GET(str, maxlen)       (sys_product_name_get(str, maxlen))             /*产品名称*/
  86
  87 /**************************       全局机框槽位相关           **************************/
  88 #define SYS_MASTER_ACTIVE_SLOTNO_UNKNOW                 (0x00)                                                                                  /*主用主控槽位号未知*/
  89 #define SYS_CHASSIS_SLOTNUM_GET                                 (sys_chassis_max_slotnum_get())                                 /*产品机框的最大槽位个数*/
  90 #define SYS_CHASSIS_MASTER_SLOTNUM_GET                  (sys_chassis_master_slotnum_get())                              /*产品的主控槽位个数*/
  91 #define SYS_MASTER_ACTIVE_SLOTNO_GET                    (sys_master_active_slotno_get())                                /*主用主控槽位号*/
  92 #define SYS_CHASSIS_SLAVE_SLOTNUM                               (SYS_CHASSIS_SLOTNUM_GET-SYS_CHASSIS_MASTER_SLOTNUM_GET)/*产品机框的从板槽位个数*/
  93 #define SYS_CHASSIS_SLOTNO_ISMASTERSLOTNO(slotno) (VOS_YES == sys_slot_is_master_slot(slotno))  /*判断槽位是否为主控*/
  94 #define SYS_CHASSIS_SLOTNO_ISSLAVESLOTNO(slotno) (VOS_NO == sys_slot_is_master_slot(slotno))    /*判断槽位是否为从板*/
  95
  96
  97 /**************************       槽位号判断相关            **************************/
  98 #define SYS_SLOTNO_IS_ILLEGAL(slotno) (((slotno) > (SYS_CHASSIS_SLOTNUM_GET))||((slotno) < 1))          /*槽位不合法*/
  99 #define SYS_SLOT_IS_LEGAL(slot) ((slot>0) && (slot<=SYS_CHASSIS_SLOTNUM_GET))                                           /*槽位合法*/
 100
 101 #define SYS_SLOT_LOOP_BEGIN(slot)      for (slot = 1; slot <= SYS_CHASSIS_SLOTNUM_GET; ++slot) {
 102 #define SYS_SLOT_LOOP_END(slot)        }
 103
 104 #ifdef PLAT_MODULE_IFM
 105 #define SYS_MODULE_PORT_NUM(slotno, port_type)   (sys_module_port_type_num(slotno, port_type))
 106 #define SYS_SLOT_PORT_IS_LEGAL(slot, port_type, port) (SYS_SLOT_IS_LEGAL(slot) && ((port>0) && (port<=SYS_MODULE_PORT_NUM(slot, port_type))))
 107 #endif
 108
 109 /**************************  板卡工作模式、主备状态相关                     *****************/
 110 #define SYS_MODULE_WORKMODE_ISMASTER(slotno)    (devsm_module_workmode_is_master(slotno))                       /*板卡工作模式是否为master*/
 111 #define SYS_MODULE_WORKMODE_ISSLAVE(slotno)     (devsm_module_workmode_is_slave(slotno))                        /*板卡工作模式是否为slave*/
 112 #define SYS_MODULE_ISMASTERACTIVE(slotno)               (devsm_module_workmode_is_master_active(slotno))        /*板卡是否是主用主控*/
 113 #define SYS_MODULE_ISMASTERSTANDBY(slotno)              (devsm_module_workmode_is_master_standby(slotno))       /*板卡是否是备用主控*/
 114
 115
 116 /*********************  local板卡工作模式、主备状态相关 ******             *****************/
 117 #define SYS_LOCAL_MODULE_SLOTNO_GET                             (sys_local_module_slotno_get())                                                         /*本板槽位号*/
 118 #define SYS_LOCAL_MODULE_WORKMODE_ISMASTER              SYS_MODULE_WORKMODE_ISMASTER(SYS_LOCAL_MODULE_SLOTNO_GET)       /*本板是否工作在master*/
 119 #define SYS_LOCAL_MODULE_WORKMODE_ISSLAVE               SYS_MODULE_WORKMODE_ISSLAVE(SYS_LOCAL_MODULE_SLOTNO_GET)        /*本板是否工作在slave*/
 120 #define SYS_LOCAL_MODULE_ISMASTERACTIVE                 SYS_MODULE_ISMASTERACTIVE(SYS_LOCAL_MODULE_SLOTNO_GET)          /*本板是否是主用主控*/
 121 #define SYS_LOCAL_MODULE_ISMASTERSTANDBY                SYS_MODULE_ISMASTERSTANDBY(SYS_LOCAL_MODULE_SLOTNO_GET)         /*本板是否是备用主控*/
 122
 123
 124 /**************************     板卡公共信息相关                ***************************/
 125 #if 0   /*暂不对外开放，要用到再放开*/
 126 #define SYS_MODULE_SW_VERSION(slotno)           _SYS_MODULE_SW_VERSION_(slotno)                         /*软件版本信息*/
 127 #define SYS_MODULE_NAME(slotno)                         _SYS_MODULE_NAME_(slotno)                                       /*板卡名称*/
 128 #define SYS_MODULE_HARDWARE_VERSION(slotno) _SYS_MODULE_HARDWARE_VERSION_(slotno)               /*硬件版本信息*/
 129 #define SYS_MODULE_MANUFACTURE_DATE(slotno) _SYS_MODULE_MANUFACTURE_DATE_(slotno)               /*生产日期*/
 130 #define SYS_MODULE_SERIALNO(slotno)             _SYS_MODULE_SERIALNO_(slotno)                           /*序列号*/
 131 #endif
 132
 133 #define SYS_MODULE_TYPE(slotno)                         (devsm_hot_get_module_type(slotno))     /*include pulled module lastly*/
 134
 135 #define __SYS_MODULE_TYPE__GET(slotno)          (sys_module_type_get(slotno))   /*insert type*/
 136
 137 #define SYS_MODULE_SLOT_ISHAVECPU(slotno) (VOS_YES == sys_module_is_have_cpu(slotno))           /*板卡是否有CPU*/
 138
 139 #define SYS_MODULE_ISHAVEPP(type) (VOS_YES == sys_module_have_pp(type))
 140 #define SYS_MODULE_SLOT_ISHAVEPP(slotno) (SYS_MODULE_ISHAVEPP(__SYS_MODULE_TYPE__GET(slotno)))
 141 #define SYS_LOCAL_MODULE_ISHAVEPP()  SYS_MODULE_SLOT_ISHAVEPP(SYS_LOCAL_MODULE_SLOTNO)
 142
 143 #define SYS_MODULE_ISHAVEFPGAPP(type) (VOS_YES == sys_module_have_fpgapp(type))
 144 #define SYS_MODULE_SLOT_ISHAVEFPGAPP(slotno) (SYS_MODULE_ISHAVEFPGAPP(SYS_MODULE_TYPE(slotno)))
 145
 146
 147 /**************************     槽位运行状态相关                ***************************/
 148 #define SYS_MODULE_RUNNINGSTATE_GET(slotno)             (sys_module_running_state_get(slotno))          /*槽位的运行状态*/
 149 #define SYS_LOCAL_MODULE_RUNNINGSTATE           (SYS_MODULE_RUNNINGSTATE_GET(SYS_LOCAL_MODULE_SLOTNO_GET))      /*本板的运行状态*/
 150 #define SYS_MODULE_IS_RUNNING(slotno)           (VOS_YES == sys_module_is_running(slotno))                      /*槽位是否是RUNNING状态*/
 151 #define SYS_MODULE_IS_READY(slotno)             (VOS_YES == sys_module_is_ready(slotno))                        /*槽位是否是READY状态*/
 152 #define SYS_MODULE_IS_INSERTED(slotno)  (VOS_YES == sys_module_is_inserted(slotno))     /*槽位是否在位*/
 153
 154 extern ULONG g_SysInstallMode;
 155 #define SYS_MODULE_IS_INSTALL_MODE (g_SysInstallMode)                   /*板卡的安装模式，默认自动安装*/
 156 /*******************************  End of File Body ***********************/
 157 #endif
 158
 159 #ifdef __cplusplus
 160 }
 161 #endif
 162
 163 #endif