Init commit for standalone enodebd
Change-Id: I88eeef5135dd7ba8551ddd9fb6a0695f5325337b
diff --git a/devices/baicells_old.py b/devices/baicells_old.py
new file mode 100644
index 0000000..f5db4b5
--- /dev/null
+++ b/devices/baicells_old.py
@@ -0,0 +1,329 @@
+"""
+Copyright 2020 The Magma Authors.
+
+This source code is licensed under the BSD-style license found in the
+LICENSE file in the root directory of this source tree.
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+"""
+
+from typing import Any, Callable, Dict, List, Optional, Type
+
+from common.service import MagmaService
+from data_models import transform_for_enb, transform_for_magma
+from data_models.data_model import DataModel, TrParam
+from data_models.data_model_parameters import (
+ ParameterName,
+ TrParameterType,
+)
+from device_config.enodeb_config_postprocessor import (
+ EnodebConfigurationPostProcessor,
+)
+from device_config.enodeb_configuration import EnodebConfiguration
+from devices.device_utils import EnodebDeviceName
+from state_machines.enb_acs_impl import BasicEnodebAcsStateMachine
+from state_machines.enb_acs_states import (
+ AddObjectsState,
+ BaicellsRemWaitState,
+ CheckOptionalParamsState,
+ DeleteObjectsState,
+ EnbSendRebootState,
+ EndSessionState,
+ EnodebAcsState,
+ ErrorState,
+ GetObjectParametersState,
+ GetParametersState,
+ SendGetTransientParametersState,
+ SetParameterValuesState,
+ WaitEmptyMessageState,
+ WaitGetObjectParametersState,
+ WaitGetParametersState,
+ WaitGetTransientParametersState,
+ WaitInformMRebootState,
+ WaitInformState,
+ WaitRebootResponseState,
+ WaitSetParameterValuesState,
+)
+
+
+class BaicellsOldHandler(BasicEnodebAcsStateMachine):
+ def __init__(
+ self,
+ service: MagmaService,
+ ) -> None:
+ self._state_map = {}
+ super().__init__(service=service, use_param_key=False)
+
+ def reboot_asap(self) -> None:
+ self.transition('reboot')
+
+ def is_enodeb_connected(self) -> bool:
+ return not isinstance(self.state, WaitInformState)
+
+ def _init_state_map(self) -> None:
+ self._state_map = {
+ 'wait_inform': WaitInformState(self, when_done='wait_empty', when_boot='wait_rem'),
+ 'wait_rem': BaicellsRemWaitState(self, when_done='wait_inform'),
+ 'wait_empty': WaitEmptyMessageState(self, when_done='get_transient_params', when_missing='check_optional_params'),
+ 'check_optional_params': CheckOptionalParamsState(self, when_done='get_transient_params'),
+ 'get_transient_params': SendGetTransientParametersState(self, when_done='wait_get_transient_params'),
+ 'wait_get_transient_params': WaitGetTransientParametersState(self, when_get='get_params', when_get_obj_params='get_obj_params', when_delete='delete_objs', when_add='add_objs', when_set='set_params', when_skip='end_session'),
+ 'get_params': GetParametersState(self, when_done='wait_get_params'),
+ 'wait_get_params': WaitGetParametersState(self, when_done='get_obj_params'),
+ 'get_obj_params': GetObjectParametersState(self, when_done='wait_get_obj_params'),
+ 'wait_get_obj_params': WaitGetObjectParametersState(self, when_delete='delete_objs', when_add='add_objs', when_set='set_params', when_skip='end_session'),
+ 'delete_objs': DeleteObjectsState(self, when_add='add_objs', when_skip='set_params'),
+ 'add_objs': AddObjectsState(self, when_done='set_params'),
+ 'set_params': SetParameterValuesState(self, when_done='wait_set_params'),
+ 'wait_set_params': WaitSetParameterValuesState(self, when_done='check_get_params', when_apply_invasive='reboot'),
+ 'check_get_params': GetParametersState(self, when_done='check_wait_get_params', request_all_params=True),
+ 'check_wait_get_params': WaitGetParametersState(self, when_done='end_session'),
+ 'end_session': EndSessionState(self),
+ 'reboot': EnbSendRebootState(self, when_done='wait_reboot'),
+ 'wait_reboot': WaitRebootResponseState(self, when_done='wait_post_reboot_inform'),
+ 'wait_post_reboot_inform': WaitInformMRebootState(self, when_done='wait_rem_post_reboot', when_timeout='wait_inform_post_reboot'),
+ # After rebooting, we don't need to query optional params again.
+ 'wait_inform_post_reboot': WaitInformState(self, when_done='wait_empty_post_reboot', when_boot='wait_rem_post_reboot'),
+ 'wait_rem_post_reboot': BaicellsRemWaitState(self, when_done='wait_inform_post_reboot'),
+ 'wait_empty_post_reboot': WaitEmptyMessageState(self, when_done='get_transient_params', when_missing='check_optional_params'),
+ # The states below are entered when an unexpected message type is
+ # received
+ 'unexpected_fault': ErrorState(self, inform_transition_target='wait_inform'),
+ }
+
+ @property
+ def device_name(self) -> str:
+ return EnodebDeviceName.BAICELLS_OLD
+
+ @property
+ def data_model_class(self) -> Type[DataModel]:
+ return BaicellsTrOldDataModel
+
+ @property
+ def config_postprocessor(self) -> EnodebConfigurationPostProcessor:
+ return BaicellsTrOldConfigurationInitializer()
+
+ @property
+ def state_map(self) -> Dict[str, EnodebAcsState]:
+ return self._state_map
+
+ @property
+ def disconnected_state_name(self) -> str:
+ return 'wait_inform'
+
+ @property
+ def unexpected_fault_state_name(self) -> str:
+ return 'unexpected_fault'
+
+
+class BaicellsTrOldDataModel(DataModel):
+ """
+ Class to represent relevant data model parameters from
+ TR-196/TR-098/TR-181.
+
+ This class is effectively read-only
+
+ This is for any version before BaiStation_V100R001C00B110SPC003
+
+ Some eNodeBs have a bug where the meaning of the following parameter is
+ inverted:
+ Device.Services.FAPService.1.CellConfig.LTE.EPC.PLMNList.1.CellReservedForOperatorUse
+ I.e. CellReservedForOperatorUse = True in TR-196 results in the relevant
+ SIB parameter being advertised as 'CellReservedForOperatorUse notReserved',
+ and vice versa.
+
+ This issue was fixed in the above SW version, so the flag should be
+ inverted for the all versions PRECEEDING
+
+ The same problem exists for 'cell barred'. See above description
+ """
+ # Parameters to query when reading eNodeB config
+ LOAD_PARAMETERS = [ParameterName.DEVICE]
+ # Mapping of TR parameter paths to aliases
+ DEVICE_PATH = 'Device.'
+ FAPSERVICE_PATH = DEVICE_PATH + 'Services.FAPService.1.'
+ PARAMETERS = {
+ # Top-level objects
+ ParameterName.DEVICE: TrParam(DEVICE_PATH, True, TrParameterType.OBJECT, False),
+ ParameterName.FAP_SERVICE: TrParam(FAPSERVICE_PATH, True, TrParameterType.OBJECT, False),
+
+ # Device info parameters
+ ParameterName.GPS_STATUS: TrParam(DEVICE_PATH + 'DeviceInfo.X_BAICELLS_COM_GPS_Status', True, TrParameterType.BOOLEAN, False),
+ ParameterName.PTP_STATUS: TrParam(DEVICE_PATH + 'DeviceInfo.X_BAICELLS_COM_1588_Status', True, TrParameterType.BOOLEAN, False),
+ ParameterName.MME_STATUS: TrParam(DEVICE_PATH + 'DeviceInfo.X_BAICELLS_COM_MME_Status', True, TrParameterType.BOOLEAN, False),
+ ParameterName.REM_STATUS: TrParam(FAPSERVICE_PATH + 'REM.X_BAICELLS_COM_REM_Status', True, TrParameterType.BOOLEAN, True),
+ ParameterName.LOCAL_GATEWAY_ENABLE:
+ TrParam(DEVICE_PATH + 'DeviceInfo.X_BAICELLS_COM_LTE_LGW_Switch', False, TrParameterType.BOOLEAN, False),
+ ParameterName.GPS_ENABLE: TrParam(DEVICE_PATH + 'X_BAICELLS_COM_GpsSyncEnable', False, TrParameterType.BOOLEAN, True),
+ ParameterName.GPS_LAT: TrParam(DEVICE_PATH + 'FAP.GPS.LockedLatitude', True, TrParameterType.INT, True),
+ ParameterName.GPS_LONG: TrParam(DEVICE_PATH + 'FAP.GPS.LockedLongitude', True, TrParameterType.INT, True),
+ ParameterName.SW_VERSION: TrParam(DEVICE_PATH + 'DeviceInfo.SoftwareVersion', True, TrParameterType.STRING, False),
+ ParameterName.SERIAL_NUMBER: TrParam(DEVICE_PATH + 'DeviceInfo.SerialNumber', True, TrParameterType.STRING, False),
+
+ # Capabilities
+ ParameterName.DUPLEX_MODE_CAPABILITY: TrParam(
+ FAPSERVICE_PATH + 'Capabilities.LTE.DuplexMode', True, TrParameterType.STRING, False,
+ ),
+ ParameterName.BAND_CAPABILITY: TrParam(FAPSERVICE_PATH + 'Capabilities.LTE.BandsSupported', True, TrParameterType.STRING, False),
+
+ # RF-related parameters
+ ParameterName.EARFCNDL: TrParam(FAPSERVICE_PATH + 'X_BAICELLS_COM_LTE.EARFCNDLInUse', True, TrParameterType.INT, False),
+ ParameterName.EARFCNUL: TrParam(FAPSERVICE_PATH + 'X_BAICELLS_COM_LTE.EARFCNULInUse', True, TrParameterType.INT, False),
+ ParameterName.BAND: TrParam(FAPSERVICE_PATH + 'CellConfig.LTE.RAN.RF.FreqBandIndicator', True, TrParameterType.INT, False),
+ ParameterName.PCI: TrParam(FAPSERVICE_PATH + 'CellConfig.LTE.RAN.RF.PhyCellID', True, TrParameterType.INT, False),
+ ParameterName.DL_BANDWIDTH: TrParam(FAPSERVICE_PATH + 'CellConfig.LTE.RAN.RF.DLBandwidth', True, TrParameterType.STRING, False),
+ ParameterName.UL_BANDWIDTH: TrParam(FAPSERVICE_PATH + 'CellConfig.LTE.RAN.RF.ULBandwidth', True, TrParameterType.STRING, False),
+ ParameterName.SUBFRAME_ASSIGNMENT: TrParam(
+ FAPSERVICE_PATH
+ + 'CellConfig.LTE.RAN.PHY.TDDFrame.SubFrameAssignment', True, TrParameterType.INT, False,
+ ),
+ ParameterName.SPECIAL_SUBFRAME_PATTERN: TrParam(
+ FAPSERVICE_PATH
+ + 'CellConfig.LTE.RAN.PHY.TDDFrame.SpecialSubframePatterns', True, TrParameterType.INT, False,
+ ),
+ ParameterName.CELL_ID: TrParam(FAPSERVICE_PATH + 'CellConfig.LTE.RAN.Common.CellIdentity', True, TrParameterType.UNSIGNED_INT, False),
+
+ # Other LTE parameters
+ ParameterName.ADMIN_STATE: TrParam(FAPSERVICE_PATH + 'FAPControl.LTE.AdminState', False, TrParameterType.BOOLEAN, False),
+ ParameterName.OP_STATE: TrParam(FAPSERVICE_PATH + 'FAPControl.LTE.OpState', True, TrParameterType.BOOLEAN, False),
+ ParameterName.RF_TX_STATUS: TrParam(FAPSERVICE_PATH + 'FAPControl.LTE.RFTxStatus', True, TrParameterType.BOOLEAN, False),
+
+ # RAN parameters
+ ParameterName.CELL_RESERVED: TrParam(
+ FAPSERVICE_PATH
+ + 'CellConfig.LTE.RAN.CellRestriction.CellReservedForOperatorUse', True, TrParameterType.BOOLEAN, False,
+ ),
+ ParameterName.CELL_BARRED: TrParam(
+ FAPSERVICE_PATH
+ + 'CellConfig.LTE.RAN.CellRestriction.CellBarred', True, TrParameterType.BOOLEAN, False,
+ ),
+
+ # Core network parameters
+ ParameterName.MME_IP: TrParam(
+ FAPSERVICE_PATH + 'FAPControl.LTE.Gateway.S1SigLinkServerList', True, TrParameterType.STRING, False,
+ ),
+ ParameterName.MME_PORT: TrParam(FAPSERVICE_PATH + 'FAPControl.LTE.Gateway.S1SigLinkPort', True, TrParameterType.INT, False),
+ ParameterName.NUM_PLMNS: TrParam(
+ FAPSERVICE_PATH + 'CellConfig.LTE.EPC.PLMNListNumberOfEntries', True, TrParameterType.INT, False,
+ ),
+ ParameterName.PLMN: TrParam(FAPSERVICE_PATH + 'CellConfig.LTE.EPC.PLMNList.', True, TrParameterType.STRING, False),
+ # PLMN arrays are added below
+ ParameterName.TAC: TrParam(FAPSERVICE_PATH + 'CellConfig.LTE.EPC.TAC', True, TrParameterType.INT, False),
+ ParameterName.IP_SEC_ENABLE: TrParam(
+ DEVICE_PATH + 'Services.FAPService.Ipsec.IPSEC_ENABLE', False, TrParameterType.BOOLEAN, False,
+ ),
+ ParameterName.MME_POOL_ENABLE: TrParam(
+ FAPSERVICE_PATH +
+ 'FAPControl.LTE.Gateway.X_BAICELLS_COM_MmePool.Enable', True, TrParameterType.BOOLEAN, True,
+ ),
+
+ # Management server parameters
+ ParameterName.PERIODIC_INFORM_ENABLE:
+ TrParam(DEVICE_PATH + 'ManagementServer.PeriodicInformEnable', False, TrParameterType.BOOLEAN, False),
+ ParameterName.PERIODIC_INFORM_INTERVAL:
+ TrParam(DEVICE_PATH + 'ManagementServer.PeriodicInformInterval', False, TrParameterType.INT, False),
+
+ # Performance management parameters
+ ParameterName.PERF_MGMT_ENABLE: TrParam(
+ DEVICE_PATH + 'FAP.PerfMgmt.Config.1.Enable', False, TrParameterType.BOOLEAN, False,
+ ),
+ ParameterName.PERF_MGMT_UPLOAD_INTERVAL: TrParam(
+ DEVICE_PATH + 'FAP.PerfMgmt.Config.1.PeriodicUploadInterval', False, TrParameterType.INT, False,
+ ),
+ ParameterName.PERF_MGMT_UPLOAD_URL: TrParam(
+ DEVICE_PATH + 'FAP.PerfMgmt.Config.1.URL', False, TrParameterType.STRING, False,
+ ),
+
+ }
+
+ NUM_PLMNS_IN_CONFIG = 6
+ for i in range(1, NUM_PLMNS_IN_CONFIG + 1):
+ PARAMETERS[(ParameterName.PLMN_N) % i] = TrParam(
+ FAPSERVICE_PATH + 'CellConfig.LTE.EPC.PLMNList.%d.' % i, True, TrParameterType.STRING, False,
+ )
+ PARAMETERS[ParameterName.PLMN_N_CELL_RESERVED % i] = TrParam(
+ FAPSERVICE_PATH +
+ 'CellConfig.LTE.EPC.PLMNList.%d.CellReservedForOperatorUse' % i, True, TrParameterType.BOOLEAN, False,
+ )
+ PARAMETERS[ParameterName.PLMN_N_ENABLE % i] = TrParam(
+ FAPSERVICE_PATH + 'CellConfig.LTE.EPC.PLMNList.%d.Enable' % i, True, TrParameterType.BOOLEAN, False,
+ )
+ PARAMETERS[ParameterName.PLMN_N_PRIMARY % i] = TrParam(
+ FAPSERVICE_PATH + 'CellConfig.LTE.EPC.PLMNList.%d.IsPrimary' % i, True, TrParameterType.BOOLEAN, False,
+ )
+ PARAMETERS[ParameterName.PLMN_N_PLMNID % i] = TrParam(
+ FAPSERVICE_PATH + 'CellConfig.LTE.EPC.PLMNList.%d.PLMNID' % i, True, TrParameterType.STRING, False,
+ )
+
+ TRANSFORMS_FOR_ENB = {
+ ParameterName.DL_BANDWIDTH: transform_for_enb.bandwidth,
+ ParameterName.UL_BANDWIDTH: transform_for_enb.bandwidth,
+ ParameterName.CELL_BARRED: transform_for_enb.invert_cell_barred,
+ ParameterName.CELL_RESERVED: transform_for_enb.invert_cell_reserved,
+ }
+ TRANSFORMS_FOR_MAGMA = {
+ ParameterName.DL_BANDWIDTH: transform_for_magma.bandwidth,
+ ParameterName.UL_BANDWIDTH: transform_for_magma.bandwidth,
+ # We don't set GPS, so we don't need transform for enb
+ ParameterName.GPS_LAT: transform_for_magma.gps_tr181,
+ ParameterName.GPS_LONG: transform_for_magma.gps_tr181,
+ }
+
+ @classmethod
+ def get_parameter(cls, param_name: ParameterName) -> Optional[TrParam]:
+ return cls.PARAMETERS.get(param_name)
+
+ @classmethod
+ def _get_magma_transforms(
+ cls,
+ ) -> Dict[ParameterName, Callable[[Any], Any]]:
+ return cls.TRANSFORMS_FOR_MAGMA
+
+ @classmethod
+ def _get_enb_transforms(cls) -> Dict[ParameterName, Callable[[Any], Any]]:
+ return cls.TRANSFORMS_FOR_ENB
+
+ @classmethod
+ def get_load_parameters(cls) -> List[ParameterName]:
+ return cls.LOAD_PARAMETERS
+
+ @classmethod
+ def get_num_plmns(cls) -> int:
+ return cls.NUM_PLMNS_IN_CONFIG
+
+ @classmethod
+ def get_parameter_names(cls) -> List[ParameterName]:
+ excluded_params = [
+ str(ParameterName.DEVICE),
+ str(ParameterName.FAP_SERVICE),
+ ]
+ names = list(
+ filter(
+ lambda x: (not str(x).startswith('PLMN'))
+ and (str(x) not in excluded_params),
+ cls.PARAMETERS.keys(),
+ ),
+ )
+ return names
+
+ @classmethod
+ def get_numbered_param_names(cls) -> Dict[ParameterName, List[ParameterName]]:
+ names = {}
+ for i in range(1, cls.NUM_PLMNS_IN_CONFIG + 1):
+ params = []
+ params.append(ParameterName.PLMN_N_CELL_RESERVED % i)
+ params.append(ParameterName.PLMN_N_ENABLE % i)
+ params.append(ParameterName.PLMN_N_PRIMARY % i)
+ params.append(ParameterName.PLMN_N_PLMNID % i)
+ names[ParameterName.PLMN_N % i] = params
+
+ return names
+
+
+class BaicellsTrOldConfigurationInitializer(EnodebConfigurationPostProcessor):
+ def postprocess(self, mconfig: Any, service_cfg: Any, desired_cfg: EnodebConfiguration) -> None:
+ desired_cfg.set_parameter(ParameterName.CELL_BARRED, False)