[VOL-3380] Functional area specific logging
Change-Id: I67414da013d8fc82827fcdb69d4f8a34040625d3
diff --git a/internal/pkg/common/common.go b/internal/pkg/common/common.go
new file mode 100755
index 0000000..5019a75
--- /dev/null
+++ b/internal/pkg/common/common.go
@@ -0,0 +1,33 @@
+/*
+ * Copyright 2020-present Open Networking Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * 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.
+ */
+
+//Package common provides global definitions
+package common
+
+import (
+ "github.com/opencord/voltha-lib-go/v7/pkg/log"
+)
+
+var logger log.CLogger
+
+func init() {
+ // Setup this package so that it's log level can be modified at run time
+ var err error
+ logger, err = log.RegisterPackage(log.JSON, log.ErrorLevel, log.Fields{"pkg": "common"})
+ if err != nil {
+ panic(err)
+ }
+}
diff --git a/internal/pkg/common/defines.go b/internal/pkg/common/defines.go
new file mode 100755
index 0000000..2c597c1
--- /dev/null
+++ b/internal/pkg/common/defines.go
@@ -0,0 +1,329 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+
+ * http://www.apache.org/licenses/LICENSE-2.0
+
+ * 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.
+ */
+
+//Package common provides global definitions
+package common
+
+import (
+ "context"
+ "time"
+
+ gp "github.com/google/gopacket"
+ "github.com/looplab/fsm"
+ "github.com/opencord/omci-lib-go"
+ vc "github.com/opencord/voltha-protos/v5/go/common"
+ "github.com/opencord/voltha-protos/v5/go/voltha"
+)
+
+// MessageType - Message Protocol Type
+type MessageType uint8
+
+const (
+ // TestMsg - Message type for non OMCI messages
+ TestMsg MessageType = iota
+ //OMCI - OMCI protocol type msg
+ OMCI
+)
+
+// String - Return the text representation of the message type based on integer
+func (m MessageType) String() string {
+ names := [...]string{
+ "TestMsg",
+ "OMCI",
+ }
+ return names[m]
+}
+
+// Message - message type and data(OMCI)
+type Message struct {
+ Type MessageType
+ Data interface{}
+}
+
+//TestMessageType - message data for various events
+type TestMessageType uint8
+
+const (
+ // LoadMibTemplateOk - message data for getting mib template successfully
+ LoadMibTemplateOk TestMessageType = iota + 1
+ // LoadMibTemplateFailed - message data for failure for getting mib template
+ LoadMibTemplateFailed
+ // TimeOutOccurred - message data for timeout
+ TimeOutOccurred
+ // AbortMessageProcessing - message data for aborting running message
+ AbortMessageProcessing
+)
+
+//TestMessage - Struct to hold the message data
+//TODO: place holder to have a second interface variant - to be replaced by real variant later on
+type TestMessage struct {
+ TestMessageVal TestMessageType
+}
+
+//OmciMessage - OMCI protocol messages for managing and monitoring ONUs
+type OmciMessage struct {
+ //OnuSN *openolt.SerialNumber
+ //OnuID uint32
+ OmciMsg *omci.OMCI
+ OmciPacket *gp.Packet
+}
+
+///////////////////////////////////////////////////////////
+
+// device reasons
+const (
+ DrUnset = 0
+ DrActivatingOnu = 1
+ DrStartingOpenomci = 2
+ DrDiscoveryMibsyncComplete = 3
+ DrInitialMibDownloaded = 4
+ DrTechProfileConfigDownloadSuccess = 5
+ DrOmciFlowsPushed = 6
+ DrOmciAdminLock = 7
+ DrOnuReenabled = 8
+ DrStoppingOpenomci = 9
+ DrRebooting = 10
+ DrOmciFlowsDeleted = 11
+ DrTechProfileConfigDeleteSuccess = 12
+ DrReconcileFailed = 13
+ DrReconcileMaxTimeout = 14
+ DrReconcileCanceled = 15
+ DrTechProfileConfigDownloadFailed = 16
+)
+
+// DeviceReasonMap holds device reason strings
+var DeviceReasonMap = map[uint8]string{
+ DrUnset: "unset",
+ DrActivatingOnu: "activating-onu",
+ DrStartingOpenomci: "starting-openomci",
+ DrDiscoveryMibsyncComplete: "discovery-mibsync-complete",
+ DrInitialMibDownloaded: "initial-mib-downloaded",
+ DrTechProfileConfigDownloadSuccess: "tech-profile-config-download-success",
+ DrTechProfileConfigDownloadFailed: "tech-profile-config-download-failed",
+ DrOmciFlowsPushed: "omci-flows-pushed",
+ DrOmciAdminLock: "omci-admin-lock",
+ DrOnuReenabled: "onu-reenabled",
+ DrStoppingOpenomci: "stopping-openomci",
+ DrRebooting: "rebooting",
+ DrOmciFlowsDeleted: "omci-flows-deleted",
+ DrTechProfileConfigDeleteSuccess: "tech-profile-config-delete-success",
+ DrReconcileFailed: "reconcile-failed",
+ DrReconcileMaxTimeout: "reconcile-max-timeout",
+ DrReconcileCanceled: "reconciling-canceled",
+}
+
+// UsedOmciConfigFsms type for FSMs dealing with OMCI messages
+type UsedOmciConfigFsms int
+
+// FSMs dealing with OMCI messages
+const (
+ CUploadFsm UsedOmciConfigFsms = iota
+ CDownloadFsm
+ CUniLockFsm
+ CUniUnLockFsm
+ CAniConfigFsm
+ CUniVlanConfigFsm
+ CL2PmFsm
+ COnuUpgradeFsm
+)
+
+// OnuDeviceEvent - TODO: add comment
+type OnuDeviceEvent int
+
+// Events of interest to Device Adapters and OpenOMCI State Machines
+const (
+ // DeviceStatusInit - default start state
+ DeviceStatusInit OnuDeviceEvent = iota
+ // MibDatabaseSync - MIB database sync (upload done)
+ MibDatabaseSync
+ // OmciCapabilitiesDone - OMCI ME and message type capabilities known
+ OmciCapabilitiesDone
+ // MibDownloadDone - // MIB download done
+ MibDownloadDone
+ // UniLockStateDone - Uni ports admin set to lock
+ UniLockStateDone
+ // UniUnlockStateDone - Uni ports admin set to unlock
+ UniUnlockStateDone
+ // UniDisableStateDone - Uni ports admin set to lock based on device disable
+ UniDisableStateDone
+ // UniEnableStateDone - Uni ports admin set to unlock based on device re-enable
+ UniEnableStateDone
+ // PortLinkUp - Port link state change
+ PortLinkUp
+ // PortLinkDw - Port link state change
+ PortLinkDw
+ // OmciAniConfigDone - AniSide config according to TechProfile done
+ OmciAniConfigDone
+ // OmciAniResourceRemoved - AniSide TechProfile related resource (Gem/TCont) removed
+ OmciAniResourceRemoved // needs to be the successor of OmciAniConfigDone!
+ // OmciVlanFilterAddDone - Omci Vlan config done according to flow-add with request to write kvStore
+ OmciVlanFilterAddDone
+ // OmciVlanFilterAddDoneNoKvStore - Omci Vlan config done according to flow-add without writing kvStore
+ OmciVlanFilterAddDoneNoKvStore // needs to be the successor of OmciVlanFilterAddDone!
+ // OmciVlanFilterRemDone - Omci Vlan config done according to flow-remove with request to write kvStore
+ OmciVlanFilterRemDone // needs to be the successor of OmciVlanFilterAddDoneNoKvStore!
+ // OmciVlanFilterRemDoneNoKvStore - Omci Vlan config done according to flow-remove without writing kvStore
+ OmciVlanFilterRemDoneNoKvStore // needs to be the successor of OmciVlanFilterRemDone!
+ // OmciOnuSwUpgradeDone - SoftwareUpgrade to ONU finished
+ OmciOnuSwUpgradeDone
+ // Add other events here as needed (alarms separate???)
+)
+
+///////////////////////////////////////////////////////////
+
+//definitions as per G.988 softwareImage::valid ME IDs
+const (
+ FirstSwImageMeID = 0
+ SecondSwImageMeID = 1
+)
+
+//definitions as per G.988 softwareImage::IsCommitted
+const (
+ SwIsUncommitted = 0
+ SwIsCommitted = 1
+)
+
+//definitions as per G.988 softwareImage::IsActive
+const (
+ SwIsInactive = 0
+ SwIsActive = 1
+)
+
+//definitions as per G.988 softwareImage::IsValid
+const (
+ SwIsInvalid = 0
+ SwIsValid = 1
+)
+
+// SEntrySwImageIndication - TODO: add comment
+type SEntrySwImageIndication struct {
+ Valid bool
+ EntityID uint16
+ Version string
+ IsCommitted uint8
+}
+
+// SswImageIndications - TODO: add comment
+type SswImageIndications struct {
+ ActiveEntityEntry SEntrySwImageIndication
+ InActiveEntityEntry SEntrySwImageIndication
+}
+
+///////////////////////////////////////////////////////////
+
+type activityDescr struct {
+ DatabaseClass func(context.Context) error
+ //advertiseEvents bool
+ AuditInterval time.Duration
+ //tasks map[string]func() error
+}
+
+// OmciDeviceFsms - FSM event mapping to database class and time to wait between audits
+type OmciDeviceFsms map[string]activityDescr
+
+// AdapterFsm - Adapter FSM details including channel, event and device
+type AdapterFsm struct {
+ fsmName string
+ deviceID string
+ CommChan chan Message
+ PFsm *fsm.FSM
+}
+
+//CErrWaitAborted - AdapterFsm related error string
+//error string could be checked on waitforOmciResponse() e.g. to avoid misleading error log
+// but not used that way so far (permit error log even for wanted cancellation)
+const CErrWaitAborted = "waitResponse aborted"
+
+///////////////////////////////////////////////////////////
+
+// UniPortType holds possible UNI port types
+type UniPortType uint8
+
+// UniPPTP Interface type - re-use values from G.988 (Chapter 9.3.4) TP type definition (directly used in OMCI!)
+const (
+ // UniPPTP relates to PPTP
+ UniPPTP UniPortType = 1 // relates to PPTP
+ // UniVEIP relates to VEIP
+ UniVEIP UniPortType = 11 // relates to VEIP
+ // UniPPTPPots relates to PPTP POTS
+ UniPPTPPots UniPortType = 4 // relates to IP host config data (for Voice Services)
+)
+
+//OnuUniPort structure holds information about the ONU attached Uni Ports
+type OnuUniPort struct {
+ Enabled bool
+ Name string
+ PortNo uint32
+ PortType UniPortType
+ OfpPortNo string
+ UniID uint8
+ MacBpNo uint8
+ EntityID uint16
+ AdminState vc.AdminState_Types
+ OperState vc.OperStatus_Types
+ PPort *voltha.Port
+}
+
+// OnuUniPortMap - TODO: add comment
+type OnuUniPortMap map[uint32]*OnuUniPort
+
+///////////////////////////////////////////////////////////
+
+const (
+ tpIDStart = 64
+ tpIDEnd = 256
+ tpRange = tpIDEnd - tpIDStart
+ maxUni = 256
+)
+
+// TODO
+const (
+ IeeMaperServiceProfileBaseEID = uint16(0x1001)
+ MacBridgePortAniBaseEID = uint16(0x1001)
+ MacBridgePortUniBaseEID = uint16(0x201)
+ MacBridgePortAniMcastBaseEID = uint16(0xA01)
+ GalEthernetEID = uint16(1)
+ MacBridgeServiceProfileEID = uint16(0x201)
+)
+
+// UniVlanRuleParams - TODO: add comment
+type UniVlanRuleParams struct {
+ TpID uint8 `json:"tp_id"`
+ MatchVid uint32 `json:"match_vid"` //use uint32 types for allowing immediate bitshifting
+ MatchPcp uint32 `json:"match_pcp"`
+ TagsToRemove uint32 `json:"tags_to_remove"`
+ SetVid uint32 `json:"set_vid"`
+ SetPcp uint32 `json:"set_pcp"`
+}
+
+// UniVlanFlowParams - TODO: add comment
+type UniVlanFlowParams struct {
+ CookieSlice []uint64 `json:"cookie_slice"`
+ VlanRuleParams UniVlanRuleParams `json:"vlan_rule_params"`
+ Meter *voltha.OfpMeterConfig `json:"flow_meter"`
+}
+
+///////////////////////////////////////////////////////////
+
+//definitions as per G.988
+const (
+ OnuDataMeID = 0
+ Onu2gMeID = 0
+ OnugMeID = 0
+ IPHostConfigDataMeID = 1
+ OnugSerialNumberLen = 8
+ OmciMacAddressLen = 6
+)
diff --git a/internal/pkg/common/interfaces.go b/internal/pkg/common/interfaces.go
new file mode 100755
index 0000000..a15bf35
--- /dev/null
+++ b/internal/pkg/common/interfaces.go
@@ -0,0 +1,178 @@
+/*
+ * Copyright 2020-present Open Networking Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * 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.
+ */
+
+//Package common provides global definitions
+package common
+
+import (
+ "context"
+ "time"
+
+ //"github.com/opencord/voltha-lib-go/v5/pkg/adapters/adapterif"
+ "github.com/opencord/voltha-lib-go/v7/pkg/db"
+ "github.com/opencord/voltha-lib-go/v7/pkg/events/eventif"
+ "github.com/opencord/voltha-openonu-adapter-go/internal/pkg/devdb"
+ ic "github.com/opencord/voltha-protos/v5/go/inter_container"
+ "github.com/opencord/voltha-protos/v5/go/openolt"
+ "github.com/opencord/voltha-protos/v5/go/voltha"
+)
+
+// IopenONUAC interface to openONUAC
+type IopenONUAC interface {
+ GetSupportedFsms() *OmciDeviceFsms
+ LockMutexMibTemplateGenerated()
+ UnlockMutexMibTemplateGenerated()
+ GetMibTemplatesGenerated(string) (bool, bool)
+ SetMibTemplatesGenerated(string, bool)
+ RLockMutexDeviceHandlersMap()
+ RUnlockMutexDeviceHandlersMap()
+ GetDeviceHandler(string) (IdeviceHandler, bool)
+}
+
+// IdeviceHandler interface to deviceHandler
+type IdeviceHandler interface {
+ GetDeviceID() string
+ GetLogicalDeviceID() string
+ GetDevice() *voltha.Device
+ GetDeviceType() string
+ GetProxyAddressID() string
+ GetProxyAddressType() string
+ GetProxyAddress() *voltha.Device_ProxyAddress
+ GetEventProxy() eventif.EventProxy
+ GetOmciTimeout() int
+ GetAlarmAuditInterval() time.Duration
+ GetDlToOnuTimeout4M() time.Duration
+ GetUniEntityMap() *OnuUniPortMap
+ GetUniPortMask() int
+ GetPonPortNumber() *uint32
+ GetOnuIndication() *openolt.OnuIndication
+ GetUniVlanConfigFsm(uint8) IuniVlanConfigFsm
+
+ GetDeviceReasonString() string
+ SetDeviceReason(uint8)
+
+ GetCollectorIsRunning() bool
+ StartCollector(context.Context)
+ InitPmConfigs()
+ GetPmConfigs() *voltha.PmConfigs
+ GetMetricsEnabled() bool
+ GetOnuMetricsManager() IonuMetricsManager
+ GetOnuAlarmManager() IonuAlarmManager
+ GetOnuTP() IonuUniTechProf
+
+ GetAlarmManagerIsRunning(context.Context) bool
+ StartAlarmManager(context.Context)
+
+ CheckAuditStartCondition(context.Context, UsedOmciConfigFsms) bool
+
+ RemoveOnuUpgradeFsm(context.Context, *voltha.ImageState)
+ DeviceProcStatusUpdate(context.Context, OnuDeviceEvent)
+
+ SetReadyForOmciConfig(bool)
+ IsReadyForOmciConfig() bool
+
+ StorePersistentData(context.Context) error
+ StorePersUniFlowConfig(context.Context, uint8, *[]UniVlanFlowParams, bool) error
+
+ StartReconciling(context.Context, bool)
+ StopReconciling(context.Context, bool)
+ IsReconciling() bool
+ IsSkipOnuConfigReconciling() bool
+ PrepareReconcilingWithActiveAdapter(context.Context)
+ ReconcileDeviceTechProf(context.Context)
+ ReconcileDeviceFlowConfig(context.Context)
+
+ VerifyUniVlanConfigRequest(context.Context, *OnuUniPort, uint8)
+ VerifyVlanConfigRequest(context.Context, uint8, uint8)
+ AddAllUniPorts(context.Context)
+ RemoveVlanFilterFsm(context.Context, *OnuUniPort)
+
+ EnableUniPortStateUpdate(context.Context)
+ DisableUniPortStateUpdate(context.Context)
+
+ SetBackend(context.Context, string) *db.Backend
+ GetBackendPathPrefix() string
+
+ RLockMutexDeletionInProgressFlag()
+ RUnlockMutexDeletionInProgressFlag()
+ GetDeletionInProgress() bool
+
+ SendOMCIRequest(context.Context, string, *ic.OmciMessage) error
+ CreatePortInCore(context.Context, *voltha.Port) error
+}
+
+// IonuDeviceEntry interface to onuDeviceEntry
+type IonuDeviceEntry interface {
+ GetDevOmciCC() *OmciCC
+ GetOnuDB() *devdb.OnuDeviceDB
+ GetPersSerialNumber() string
+ GetPersVendorID() string
+ GetPersEquipmentID() string
+
+ GetMibUploadFsmCommChan() chan Message
+ GetMibDownloadFsmCommChan() chan Message
+
+ GetOmciRebootMsgRevChan() chan Message
+ WaitForRebootResponse(context.Context, chan Message) error
+
+ IncrementMibDataSync(context.Context)
+
+ GetActiveImageMeID(context.Context) (uint16, error)
+ LockMutexOnuSwImageIndications()
+ UnlockMutexOnuSwImageIndications()
+ GetOnuSwImageIndications() SswImageIndications
+ SetOnuSwImageIndications(SswImageIndications)
+ GetPersActiveSwVersion() string
+ SetPersActiveSwVersion(string)
+ GetActiveImageVersion(context.Context) string
+ ModifySwImageInactiveVersion(context.Context, string)
+ ModifySwImageActiveCommit(context.Context, uint8)
+
+ AllocateFreeTcont(context.Context, uint16) (uint16, bool, error)
+ FreeTcont(context.Context, uint16)
+
+ LockMutexPersOnuConfig()
+ UnlockMutexPersOnuConfig()
+
+ SetReconcilingFlows(bool)
+ SetChReconcilingFlowsFinished(bool)
+}
+
+// IonuMetricsManager interface to onuMetricsManager
+type IonuMetricsManager interface {
+ AddGemPortForPerfMonitoring(context.Context, uint16)
+ RemoveGemPortForPerfMonitoring(context.Context, uint16)
+}
+
+// IonuAlarmManager interface to onuAlarmManager
+type IonuAlarmManager interface {
+ HandleOmciAlarmNotificationMessage(context.Context, OmciMessage)
+ ResetAlarmUploadCounters()
+ GetAlarmMgrEventChannel() chan Message
+ GetAlarmUploadSeqNo() uint16
+ IncrementAlarmUploadSeqNo()
+}
+
+// IonuUniTechProf interface to onuUniTechProf
+type IonuUniTechProf interface {
+ GetAllBidirectionalGemPortIDsForOnu() []uint16
+ SetProfileToDelete(uint8, uint8, bool)
+}
+
+// IuniVlanConfigFsm interface to uniVlanConfigFsm
+type IuniVlanConfigFsm interface {
+ IsFlowRemovePending(chan<- bool) bool
+}
diff --git a/internal/pkg/common/omci_cc.go b/internal/pkg/common/omci_cc.go
new file mode 100755
index 0000000..363a59f
--- /dev/null
+++ b/internal/pkg/common/omci_cc.go
@@ -0,0 +1,3316 @@
+/*
+ * Copyright 2020-present Open Networking Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * 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.
+ */
+
+//Package common provides global definitions
+package common
+
+import (
+ "container/list"
+ "context"
+ "encoding/binary"
+ "encoding/hex"
+ "fmt"
+ "strconv"
+ "sync"
+ "time" //by now for testing
+
+ "github.com/google/gopacket"
+ // TODO!!! Some references could be resolved auto, but some need specific context ....
+ gp "github.com/google/gopacket"
+
+ "github.com/opencord/omci-lib-go"
+ me "github.com/opencord/omci-lib-go/generated"
+
+ vgrpc "github.com/opencord/voltha-lib-go/v7/pkg/grpc"
+
+ "github.com/opencord/voltha-protos/v5/go/common"
+ //"github.com/opencord/voltha-lib-go/v7/pkg/kafka"
+ "github.com/opencord/voltha-lib-go/v7/pkg/log"
+ ic "github.com/opencord/voltha-protos/v5/go/inter_container"
+ //"github.com/opencord/voltha-protos/v5/go/openflow_13"
+ //"github.com/opencord/voltha-protos/v5/go/voltha"
+)
+
+// ### OMCI related definitions - retrieved from Python adapter code/trace ####
+
+const maxGemPayloadSize = uint16(48)
+const connectivityModeValue = uint8(5)
+
+//const defaultTPID = uint16(0x8100)
+//const broadComDefaultVID = uint16(4091)
+
+// UnusedTcontAllocID - TODO: add comment
+const UnusedTcontAllocID = uint16(0xFFFF) //common unused AllocId for G.984 and G.987 systems
+
+const cOmciBaseMessageTrailerLen = 40
+
+// tOmciReceiveError - enum type for detected problems/errors in the received OMCI message (format)
+type tOmciReceiveError uint8
+
+const (
+ // cOmciMessageReceiveNoError - default start state
+ cOmciMessageReceiveNoError tOmciReceiveError = iota
+ // Error indication wrong trailer length within the message
+ cOmciMessageReceiveErrorTrailerLen
+ // Error indication missing trailer within the message
+ cOmciMessageReceiveErrorMissTrailer
+)
+
+// CDefaultRetries - TODO: add comment
+const CDefaultRetries = 2
+
+// ### OMCI related definitions - end
+
+//CallbackPairEntry to be used for OMCI send/receive correlation
+type CallbackPairEntry struct {
+ CbRespChannel chan Message
+ CbFunction func(context.Context, *omci.OMCI, *gp.Packet, chan Message) error
+ FramePrint bool //true for printing
+}
+
+//CallbackPair to be used for ReceiveCallback init
+type CallbackPair struct {
+ CbKey uint16
+ CbEntry CallbackPairEntry
+}
+
+// OmciTransferStructure - TODO: add comment
+type OmciTransferStructure struct {
+ txFrame []byte
+ timeout int
+ retries int
+ highPrio bool
+ withFramePrint bool
+ cbPair CallbackPair
+ chSuccess chan bool
+}
+
+//OmciCC structure holds information needed for OMCI communication (to/from OLT Adapter)
+type OmciCC struct {
+ enabled bool
+ pBaseDeviceHandler IdeviceHandler
+ pOnuDeviceEntry IonuDeviceEntry
+ pOnuAlarmManager IonuAlarmManager
+ deviceID string
+ coreClient *vgrpc.Client
+ supportExtMsg bool
+ rxOmciFrameError tOmciReceiveError
+
+ txFrames, txOnuFrames uint32
+ rxFrames, rxOnuFrames, rxOnuDiscards uint32
+
+ // OMCI params
+ mutexTid sync.Mutex
+ tid uint16
+ mutexHpTid sync.Mutex
+ hpTid uint16
+ UploadSequNo uint16
+ UploadNoOfCmds uint16
+
+ mutexTxQueue sync.Mutex
+ txQueue *list.List
+ mutexRxSchedMap sync.Mutex
+ rxSchedulerMap map[uint16]CallbackPairEntry
+ mutexMonReq sync.RWMutex
+ monitoredRequests map[uint16]OmciTransferStructure
+}
+
+var responsesWithMibDataSync = []omci.MessageType{
+ omci.CreateResponseType,
+ omci.DeleteResponseType,
+ omci.SetResponseType,
+ omci.StartSoftwareDownloadResponseType,
+ omci.EndSoftwareDownloadResponseType,
+ omci.ActivateSoftwareResponseType,
+ omci.CommitSoftwareResponseType,
+}
+
+//NewOmciCC constructor returns a new instance of a OmciCC
+//mib_db (as well as not inluded alarm_db not really used in this code? VERIFY!!)
+func NewOmciCC(ctx context.Context, deviceID string, deviceHandler IdeviceHandler,
+ onuDeviceEntry IonuDeviceEntry, onuAlarmManager IonuAlarmManager,
+ coreClient *vgrpc.Client) *OmciCC {
+ logger.Debugw(ctx, "init-omciCC", log.Fields{"device-id": deviceID})
+ var omciCC OmciCC
+ omciCC.enabled = false
+ omciCC.pBaseDeviceHandler = deviceHandler
+ omciCC.pOnuAlarmManager = onuAlarmManager
+ omciCC.pOnuDeviceEntry = onuDeviceEntry
+ omciCC.deviceID = deviceID
+ omciCC.coreClient = coreClient
+ omciCC.supportExtMsg = false
+ omciCC.rxOmciFrameError = cOmciMessageReceiveNoError
+ omciCC.txFrames = 0
+ omciCC.txOnuFrames = 0
+ omciCC.rxFrames = 0
+ omciCC.rxOnuFrames = 0
+ omciCC.rxOnuDiscards = 0
+ omciCC.tid = 0x1
+ omciCC.hpTid = 0x8000
+ omciCC.UploadSequNo = 0
+ omciCC.UploadNoOfCmds = 0
+ omciCC.txQueue = list.New()
+ omciCC.rxSchedulerMap = make(map[uint16]CallbackPairEntry)
+ omciCC.monitoredRequests = make(map[uint16]OmciTransferStructure)
+
+ return &omciCC
+}
+
+//Stop stops/resets the omciCC
+func (oo *OmciCC) Stop(ctx context.Context) error {
+ logger.Debugw(ctx, "omciCC-stopping", log.Fields{"device-id": oo.deviceID})
+ //reseting all internal data, which might also be helpful for discarding any lingering tx/rx requests
+ oo.CancelRequestMonitoring(ctx)
+ oo.mutexTxQueue.Lock()
+ oo.txQueue.Init() // clear the tx queue
+ oo.mutexTxQueue.Unlock()
+ oo.mutexRxSchedMap.Lock()
+ for k := range oo.rxSchedulerMap {
+ delete(oo.rxSchedulerMap, k) //clear the scheduler map
+ }
+ oo.mutexRxSchedMap.Unlock()
+ oo.mutexHpTid.Lock()
+ oo.hpTid = 0x8000 //reset the high prio transactionId
+ oo.mutexHpTid.Unlock()
+ oo.mutexTid.Lock()
+ oo.tid = 1 //reset the low prio transactionId
+ oo.mutexTid.Unlock()
+ //reset control values
+ oo.UploadSequNo = 0
+ oo.UploadNoOfCmds = 0
+ oo.rxOmciFrameError = cOmciMessageReceiveNoError
+ //reset the stats counter - which might be topic of discussion ...
+ oo.txFrames = 0
+ oo.txOnuFrames = 0
+ oo.rxFrames = 0
+ oo.rxOnuFrames = 0
+ oo.rxOnuDiscards = 0
+
+ return nil
+}
+
+// Rx handler for omci messages
+func (oo *OmciCC) receiveOnuMessage(ctx context.Context, omciMsg *omci.OMCI, packet *gp.Packet) error {
+ logger.Debugw(ctx, "rx-onu-autonomous-message", log.Fields{"omciMsgType": omciMsg.MessageType,
+ "payload": hex.EncodeToString(omciMsg.Payload)})
+ switch omciMsg.MessageType {
+ case omci.AlarmNotificationType:
+ data := OmciMessage{
+ OmciMsg: omciMsg,
+ OmciPacket: packet,
+ }
+ go oo.pOnuAlarmManager.HandleOmciAlarmNotificationMessage(ctx, data)
+ return nil
+ default:
+ return fmt.Errorf("receiveOnuMessageType %s unimplemented", omciMsg.MessageType.String())
+ }
+ /*
+ msgType = rxFrame.fields["message_type"] //assumed OmciOperationsValue
+ rxOnuFrames++
+
+ switch msgType {
+ case AlarmNotification:
+ {
+ logger.Info("Unhandled: received-onu-alarm-message")
+ // python code was:
+ //if msg_type == EntityOperations.AlarmNotification.value:
+ // topic = OMCI_CC.event_bus_topic(self._device_id, RxEvent.Alarm_Notification)
+ // self.reactor.callLater(0, self.event_bus.publish, topic, msg)
+ //
+ return errors.New("RxAlarmNotification unimplemented")
+ }
+ case AttributeValueChange:
+ {
+ logger.Info("Unhandled: received-attribute-value-change")
+ // python code was:
+ //elif msg_type == EntityOperations.AttributeValueChange.value:
+ // topic = OMCI_CC.event_bus_topic(self._device_id, RxEvent.AVC_Notification)
+ // self.reactor.callLater(0, self.event_bus.publish, topic, msg)
+ //
+ return errors.New("RxAttributeValueChange unimplemented")
+ }
+ case TestResult:
+ {
+ logger.Info("Unhandled: received-test-result")
+ // python code was:
+ //elif msg_type == EntityOperations.TestResult.value:
+ // topic = OMCI_CC.event_bus_topic(self._device_id, RxEvent.Test_Result)
+ // self.reactor.callLater(0, self.event_bus.publish, topic, msg)
+ //
+ return errors.New("RxTestResult unimplemented")
+ }
+ default:
+ {
+ logger.Errorw(ctx,"rx-onu-unsupported-autonomous-message", log.Fields{"msgType": msgType})
+ rxOnuDiscards++
+ return errors.New("RxOnuMsgType unimplemented")
+ }
+ }
+ */
+}
+
+func (oo *OmciCC) printRxMessage(ctx context.Context, rxMsg []byte) {
+ //assuming omci message content is hex coded!
+ // with restricted output of 16bytes would be ...rxMsg[:16]
+ logger.Debugw(ctx, "omci-message-received:", log.Fields{
+ "RxOmciMessage": hex.EncodeToString(rxMsg),
+ "device-id": oo.deviceID})
+}
+
+// ReceiveMessage - Rx handler for onu messages
+// e.g. would call ReceiveOnuMessage() in case of TID=0 or Action=test ...
+func (oo *OmciCC) ReceiveMessage(ctx context.Context, rxMsg []byte) error {
+ //logger.Debugw(ctx,"cc-receive-omci-message", log.Fields{"RxOmciMessage-x2s": hex.EncodeToString(rxMsg)})
+ if len(rxMsg) >= 44 { // then it should normally include the BaseFormat trailer Len
+ // NOTE: autocorrection only valid for OmciBaseFormat, which is not specifically verified here!!!
+ // (an extendedFormat message could be destroyed this way!)
+ trailerLenData := rxMsg[42:44]
+ trailerLen := binary.BigEndian.Uint16(trailerLenData)
+ //logger.Debugw(ctx,"omci-received-trailer-len", log.Fields{"Length": trailerLen})
+ if trailerLen != cOmciBaseMessageTrailerLen { // invalid base Format entry -> autocorrect
+ binary.BigEndian.PutUint16(rxMsg[42:44], cOmciBaseMessageTrailerLen)
+ if oo.rxOmciFrameError != cOmciMessageReceiveErrorTrailerLen {
+ //do just one error log, expectation is: if seen once it should appear regularly - avoid to many log entries
+ logger.Errorw(ctx, "wrong omci-message trailer length: trailer len auto-corrected",
+ log.Fields{"trailer-length": trailerLen, "device-id": oo.deviceID})
+ oo.rxOmciFrameError = cOmciMessageReceiveErrorTrailerLen
+ }
+ }
+ } else if len(rxMsg) >= cOmciBaseMessageTrailerLen { // workaround for Adtran OLT Sim, which currently does not send trailer bytes at all!
+ // NOTE: autocorrection only valid for OmciBaseFormat, which is not specifically verified here!!!
+ // (an extendedFormat message could be destroyed this way!)
+ // extend/overwrite with trailer
+ trailer := make([]byte, 8)
+ binary.BigEndian.PutUint16(trailer[2:], cOmciBaseMessageTrailerLen) //set the defined baseline length
+ rxMsg = append(rxMsg[:cOmciBaseMessageTrailerLen], trailer...)
+ if oo.rxOmciFrameError != cOmciMessageReceiveErrorMissTrailer {
+ //do just one error log, expectation is: if seen once it should appear regularly - avoid to many log entries
+ logger.Errorw(ctx, "omci-message to short to include trailer len: trailer auto-corrected (added)",
+ log.Fields{"message-length": len(rxMsg), "device-id": oo.deviceID})
+ oo.rxOmciFrameError = cOmciMessageReceiveErrorMissTrailer
+ }
+ } else {
+ logger.Errorw(ctx, "received omci-message too small for OmciBaseFormat - abort",
+ log.Fields{"Length": len(rxMsg), "device-id": oo.deviceID})
+ oo.printRxMessage(ctx, rxMsg)
+ return fmt.Errorf("rxOmciMessage too small for BaseFormat %s", oo.deviceID)
+ }
+
+ packet := gopacket.NewPacket(rxMsg, omci.LayerTypeOMCI, gopacket.NoCopy)
+ if packet == nil {
+ logger.Errorw(ctx, "omci-message could not be decoded", log.Fields{"device-id": oo.deviceID})
+ oo.printRxMessage(ctx, rxMsg)
+ return fmt.Errorf("could not decode rxMsg as OMCI %s", oo.deviceID)
+ }
+ omciLayer := packet.Layer(omci.LayerTypeOMCI)
+ if omciLayer == nil {
+ logger.Errorw(ctx, "omci-message could not decode omci layer", log.Fields{"device-id": oo.deviceID})
+ oo.printRxMessage(ctx, rxMsg)
+ return fmt.Errorf("could not decode omci layer %s", oo.deviceID)
+ }
+ omciMsg, ok := omciLayer.(*omci.OMCI)
+ if !ok {
+ logger.Errorw(ctx, "omci-message could not assign omci layer", log.Fields{"device-id": oo.deviceID})
+ oo.printRxMessage(ctx, rxMsg)
+ return fmt.Errorf("could not assign omci layer %s", oo.deviceID)
+ }
+ logger.Debugw(ctx, "omci-message-decoded:", log.Fields{"omciMsgType": omciMsg.MessageType,
+ "transCorrId": strconv.FormatInt(int64(omciMsg.TransactionID), 16), "DeviceIdent": omciMsg.DeviceIdentifier})
+ // TestResult is asynchronous indication that carries the same TID as the TestResponse.
+ // We expect to find the TID in the oo.rxSchedulerMap
+ if byte(omciMsg.MessageType)&me.AK == 0 && omciMsg.MessageType != omci.TestResultType {
+ // Not a response
+ oo.printRxMessage(ctx, rxMsg)
+ logger.Debug(ctx, "RxMsg is no Omci Response Message")
+ if omciMsg.TransactionID == 0 {
+ return oo.receiveOnuMessage(ctx, omciMsg, &packet)
+ }
+ logger.Errorw(ctx, "Unexpected TransCorrId != 0 not accepted for autonomous messages",
+ log.Fields{"msgType": omciMsg.MessageType, "payload": hex.EncodeToString(omciMsg.Payload),
+ "device-id": oo.deviceID})
+ return fmt.Errorf("autonomous Omci Message with TranSCorrId != 0 not acccepted %s", oo.deviceID)
+ }
+ //logger.Debug(ctx,"RxMsg is a Omci Response Message: try to schedule it to the requester")
+ oo.mutexRxSchedMap.Lock()
+ rxCallbackEntry, ok := oo.rxSchedulerMap[omciMsg.TransactionID]
+ if ok && rxCallbackEntry.CbFunction != nil {
+ if rxCallbackEntry.FramePrint {
+ oo.printRxMessage(ctx, rxMsg)
+ }
+ //disadvantage of decoupling: error verification made difficult, but anyway the question is
+ // how to react on erroneous frame reception, maybe can simply be ignored
+ go rxCallbackEntry.CbFunction(ctx, omciMsg, &packet, rxCallbackEntry.CbRespChannel)
+ if isSuccessfulResponseWithMibDataSync(omciMsg, &packet) {
+ oo.pOnuDeviceEntry.IncrementMibDataSync(ctx)
+ }
+
+ // If omciMsg.MessageType is omci.TestResponseType, we still expect the TestResult OMCI message,
+ // so do not clean up the TransactionID in that case.
+ if omciMsg.MessageType != omci.TestResponseType {
+ // having posted the response the request is regarded as 'done'
+ delete(oo.rxSchedulerMap, omciMsg.TransactionID)
+ }
+ oo.mutexRxSchedMap.Unlock()
+ return nil
+ }
+ oo.mutexRxSchedMap.Unlock()
+ logger.Errorw(ctx, "omci-message-response for not registered transCorrId", log.Fields{"device-id": oo.deviceID})
+ oo.printRxMessage(ctx, rxMsg)
+ return fmt.Errorf("could not find registered response handler tor transCorrId %s", oo.deviceID)
+
+ /* py code was:
+ Receive and OMCI message from the proxy channel to the OLT.
+
+ Call this from your ONU Adapter on a new OMCI Rx on the proxy channel
+ :param msg: (str) OMCI binary message (used as input to Scapy packet decoder)
+ """
+ if not self.enabled:
+ return
+
+ try:
+ now = arrow.utcnow()
+ d = None
+
+ # NOTE: Since we may need to do an independent ME map on a per-ONU basis
+ # save the current value of the entity_id_to_class_map, then
+ # replace it with our custom one before decode, and then finally
+ # restore it later. Tried other ways but really made the code messy.
+ saved_me_map = omci_entities.entity_id_to_class_map
+ omci_entities.entity_id_to_class_map = self._me_map
+
+ try:
+ rx_frame = msg if isinstance(msg, OmciFrame) else OmciFrame(msg)
+ self.logger.debug('recv-omci-msg', omci_msg=hexlify(msg))
+ except KeyError as e:
+ # Unknown, Unsupported, or vendor-specific ME. Key is the unknown classID
+ self.logger.debug('frame-decode-key-error', omci_msg=hexlify(msg), e=e)
+ rx_frame = self._decode_unknown_me(msg)
+ self._rx_unknown_me += 1
+
+ except Exception as e:
+ self.logger.exception('frame-decode', omci_msg=hexlify(msg), e=e)
+ return
+
+ finally:
+ omci_entities.entity_id_to_class_map = saved_me_map # Always restore it.
+
+ rx_tid = rx_frame.fields['transaction_id']
+ msg_type = rx_frame.fields['message_type']
+ self.logger.debug('Received message for rx_tid', rx_tid = rx_tid, msg_type = msg_type)
+ # Filter the Test Result frame and route through receive onu
+ # message method.
+ if rx_tid == 0 or msg_type == EntityOperations.TestResult.value:
+ self.logger.debug('Receive ONU message', rx_tid=0)
+ return self._receive_onu_message(rx_frame)
+
+ # Previously unreachable if this is the very first round-trip Rx or we
+ # have been running consecutive errors
+ if self._rx_frames == 0 or self._consecutive_errors != 0:
+ self.logger.debug('Consecutive errors for rx', err = self._consecutive_errors)
+ self.reactor.callLater(0, self._publish_connectivity_event, True)
+
+ self._rx_frames += 1
+ self._consecutive_errors = 0
+
+ try:
+ high_priority = self._tid_is_high_priority(rx_tid)
+ index = self._get_priority_index(high_priority)
+
+ # (timestamp, defer, frame, timeout, retry, delayedCall)
+ last_tx_tuple = self._tx_request[index]
+
+ if last_tx_tuple is None or \
+ last_tx_tuple[OMCI_CC.REQUEST_FRAME].fields.get('transaction_id') != rx_tid:
+ # Possible late Rx on a message that timed-out
+ if last_tx_tuple:
+ self.logger.debug('Unknown message', rx_tid=rx_tid,
+ tx_id=last_tx_tuple[OMCI_CC.REQUEST_FRAME].fields.get('transaction_id'))
+ self._rx_unknown_tid += 1
+ self._rx_late += 1
+ return
+
+ ts, d, tx_frame, timeout, retry, dc = last_tx_tuple
+ if dc is not None and not dc.cancelled and not dc.called:
+ dc.cancel()
+
+ _secs = self._update_rx_tx_stats(now, ts)
+
+ # Late arrival already serviced by a timeout?
+ if d.called:
+ self._rx_late += 1
+ self.logger.debug('Serviced by timeout. Late arrival', rx_late = self._rx_late)
+ return
+
+ except Exception as e:
+ self.logger.exception('frame-match', msg=hexlify(msg), e=e)
+ if d is not None:
+ return d.errback(failure.Failure(e))
+ return
+
+ # Publish Rx event to listeners in a different task
+ self.logger.debug('Publish rx event', rx_tid = rx_tid,
+ tx_tid = tx_frame.fields['transaction_id'])
+ reactor.callLater(0, self._publish_rx_frame, tx_frame, rx_frame)
+
+ # begin success callback chain (will cancel timeout and queue next Tx message)
+ self._rx_response[index] = rx_frame
+ d.callback(rx_frame)
+
+ except Exception as e:
+ self.logger.exception('rx-msg', e=e)
+ */
+}
+
+/*
+func (oo *omciCC) publishRxResponseFrame(ctx context.Context, txFrame []byte, rxFrame []byte) error {
+ return errors.New("publishRxResponseFrame unimplemented")
+ //def _publish_rx_frame(self, tx_frame, rx_frame):
+}
+*/
+
+// ReleaseTid releases OMCI transaction identifier from rxSchedulerMap
+func (oo *OmciCC) ReleaseTid(ctx context.Context, tid uint16) {
+ logger.Debugw(ctx, "releasing tid from rxSchedulerMap", log.Fields{"tid": tid})
+ delete(oo.rxSchedulerMap, tid)
+}
+
+// Send - Queue the OMCI Frame for a transmit to the ONU via the proxy_channel
+func (oo *OmciCC) Send(ctx context.Context, txFrame []byte, timeout int, retry int, highPrio bool,
+ receiveCallbackPair CallbackPair) error {
+
+ if timeout != 0 {
+ logger.Debugw(ctx, "register-response-callback:", log.Fields{"for TansCorrId": receiveCallbackPair.CbKey})
+ oo.mutexRxSchedMap.Lock()
+ // it could be checked, if the callback key is already registered - but simply overwrite may be acceptable ...
+ oo.rxSchedulerMap[receiveCallbackPair.CbKey] = receiveCallbackPair.CbEntry
+ oo.mutexRxSchedMap.Unlock()
+ } //else timeout 0 indicates that no response is expected - fire and forget
+
+ printFrame := receiveCallbackPair.CbEntry.FramePrint //printFrame true means debug print of frame is requested
+ //just use a simple list for starting - might need some more effort, especially for multi source write access
+ omciTxRequest := OmciTransferStructure{
+ txFrame,
+ timeout,
+ retry,
+ highPrio,
+ printFrame,
+ receiveCallbackPair,
+ nil,
+ }
+ oo.mutexMonReq.Lock()
+ defer oo.mutexMonReq.Unlock()
+ if _, exist := oo.monitoredRequests[receiveCallbackPair.CbKey]; !exist {
+ // do not call processRequestMonitoring in background here to ensure correct sequencing
+ // of requested messages into txQueue (especially for non-response-supervised messages)
+ oo.processRequestMonitoring(ctx, omciTxRequest)
+ return nil
+ }
+ logger.Errorw(ctx, "A message with this tid is processed already!",
+ log.Fields{"tid": receiveCallbackPair.CbKey, "device-id": oo.deviceID})
+ return fmt.Errorf("message with tid is processed already %s", oo.deviceID)
+}
+
+//Pull next tx request and send it
+func (oo *OmciCC) sendNextRequest(ctx context.Context) error {
+ // return errors.New("sendNextRequest unimplemented")
+
+ // just try to get something transferred !!
+ // avoid accessing the txQueue from parallel send requests
+ // block parallel omci send requests at least until SendIAP is 'committed'
+ // that should be feasible for an onu instance as on OMCI anyway window size 1 is assumed
+ oo.mutexTxQueue.Lock()
+ defer oo.mutexTxQueue.Unlock()
+ for oo.txQueue.Len() > 0 {
+ queueElement := oo.txQueue.Front() // First element
+ omciTxRequest := queueElement.Value.(OmciTransferStructure)
+ /* compare olt device handler code:
+ func (dh *DeviceHandler) omciIndication(omciInd *oop.OmciIndication) {
+ logger.Debugw(ctx,"omci indication", log.Fields{"intfID": omciInd.IntfId, "onuID": omciInd.OnuId})
+ var deviceType string
+ var deviceID string
+ var proxyDeviceID string
+
+ onuKey := dh.formOnuKey(omciInd.IntfId, omciInd.OnuId)
+
+ if onuInCache, ok := dh.onus.Load(onuKey); !ok {
+
+ logger.Debugw(ctx,"omci indication for a device not in cache.", log.Fields{"intfID": omciInd.IntfId, "onuID": omciInd.OnuId})
+ ponPort := IntfIDToPortNo(omciInd.GetIntfId(), voltha.Port_PON_OLT)
+ kwargs := make(map[string]interface{})
+ kwargs["onu_id"] = omciInd.OnuId
+ kwargs["parent_port_no"] = ponPort
+
+ onuDevice, err := dh.coreProxy.GetChildDevice(log.WithSpanFromContext(context.TODO(), ctx), dh.device.Id, kwargs)
+ if err != nil {
+ logger.Errorw(ctx,"onu not found", log.Fields{"intfID": omciInd.IntfId, "onuID": omciInd.OnuId, "error": err})
+ return
+ }
+ deviceType = onuDevice.Type
+ deviceID = onuDevice.Id
+ proxyDeviceID = onuDevice.ProxyAddress.DeviceId
+ //if not exist in cache, then add to cache.
+ dh.onus.Store(onuKey, NewOnuDevice(deviceID, deviceType, onuDevice.SerialNumber, omciInd.OnuId, omciInd.IntfId, proxyDeviceID))
+ } else {
+ //found in cache
+ logger.Debugw(ctx,"omci indication for a device in cache.", log.Fields{"intfID": omciInd.IntfId, "onuID": omciInd.OnuId})
+ deviceType = onuInCache.(*OnuDevice).deviceType
+ deviceID = onuInCache.(*OnuDevice).deviceID
+ proxyDeviceID = onuInCache.(*OnuDevice).proxyDeviceID
+ }
+ */
+ /* and compare onu_adapter py code:
+ omci_msg = InterAdapterOmciMessage(
+ message=bytes(frame),
+ proxy_address=self._proxy_address,
+ connect_status=self._device.connect_status)
+
+ self.logger.debug('sent-omci-msg', tid=tx_tid, omci_msg=hexlify(bytes(frame)))
+
+ yield self._adapter_proxy.send_inter_adapter_message(
+ msg=omci_msg,
+ type=InterAdapterMessageType.OMCI_REQUEST,
+ from_adapter=self._device.type,
+ to_adapter=self._proxy_address.device_type,
+ to_device_id=self._device_id,
+ proxy_device_id=self._proxy_address.device_id
+ )
+ */
+ if omciTxRequest.withFramePrint {
+ logger.Debugw(ctx, "omci-message-to-send:", log.Fields{
+ "TxOmciMessage": hex.EncodeToString(omciTxRequest.txFrame),
+ "device-id": oo.deviceID,
+ "toDeviceType": oo.pBaseDeviceHandler.GetProxyAddressType(),
+ "proxyDeviceID": oo.pBaseDeviceHandler.GetProxyAddressID(),
+ "proxyAddress": oo.pBaseDeviceHandler.GetProxyAddress()})
+ }
+ omciMsg := &ic.OmciMessage{
+ ParentDeviceId: oo.pBaseDeviceHandler.GetProxyAddressID(),
+ ChildDeviceId: oo.deviceID,
+ Message: omciTxRequest.txFrame,
+ ProxyAddress: oo.pBaseDeviceHandler.GetProxyAddress(),
+ ConnectStatus: common.ConnectStatus_REACHABLE, // If we are sending OMCI messages means we are connected, else we should not be here
+ }
+ sendErr := oo.pBaseDeviceHandler.SendOMCIRequest(ctx, oo.pBaseDeviceHandler.GetProxyAddress().AdapterEndpoint, omciMsg)
+ if sendErr != nil {
+ logger.Errorw(ctx, "send omci request error", log.Fields{"ChildId": oo.deviceID, "error": sendErr})
+ return sendErr
+ }
+ oo.txQueue.Remove(queueElement) // Dequeue
+ }
+ return nil
+}
+
+// GetNextTid - TODO: add comment
+func (oo *OmciCC) GetNextTid(highPriority bool) uint16 {
+ var next uint16
+ if highPriority {
+ oo.mutexHpTid.Lock()
+ next = oo.hpTid
+ oo.hpTid++
+ if oo.hpTid < 0x8000 {
+ oo.hpTid = 0x8000
+ }
+ oo.mutexHpTid.Unlock()
+ } else {
+ oo.mutexTid.Lock()
+ next = oo.tid
+ oo.tid++
+ if oo.tid >= 0x8000 {
+ oo.tid = 1
+ }
+ oo.mutexTid.Unlock()
+ }
+ return next
+}
+
+// ###################################################################################
+// # utility methods provided to work on OMCI messages
+
+// Serialize - TODO: add comment
+func Serialize(ctx context.Context, msgType omci.MessageType, request gopacket.SerializableLayer, tid uint16) ([]byte, error) {
+ omciLayer := &omci.OMCI{
+ TransactionID: tid,
+ MessageType: msgType,
+ }
+ return serializeOmciLayer(ctx, omciLayer, request)
+}
+
+func serializeOmciLayer(ctx context.Context, aOmciLayer *omci.OMCI, aRequest gopacket.SerializableLayer) ([]byte, error) {
+ var options gopacket.SerializeOptions
+ options.FixLengths = true
+
+ buffer := gopacket.NewSerializeBuffer()
+ err := gopacket.SerializeLayers(buffer, options, aOmciLayer, aRequest)
+ if err != nil {
+ logger.Errorw(ctx, "Could not create goPacket Omci serial buffer", log.Fields{"Err": err})
+ return nil, err
+ }
+ return buffer.Bytes(), nil
+}
+
+/*
+func hexEncode(omciPkt []byte) ([]byte, error) {
+ dst := make([]byte, hex.EncodedLen(len(omciPkt)))
+ hex.Encode(dst, omciPkt)
+ return dst, nil
+}
+*/
+
+//supply a response handler for omci response messages to be transferred to the requested FSM
+func (oo *OmciCC) receiveOmciResponse(ctx context.Context, omciMsg *omci.OMCI, packet *gp.Packet, respChan chan Message) error {
+
+ logger.Debugw(ctx, "omci-message-response - transfer on omciRespChannel", log.Fields{"omciMsgType": omciMsg.MessageType,
+ "transCorrId": strconv.FormatInt(int64(omciMsg.TransactionID), 16), "device-id": oo.deviceID})
+
+ if oo.pOnuDeviceEntry == nil {
+ logger.Errorw(ctx, "Abort receiving OMCI response, DeviceEntryPointer is nil", log.Fields{
+ "device-id": oo.deviceID})
+ return fmt.Errorf("deviceEntryPointer is nil %s", oo.deviceID)
+ }
+ oo.mutexMonReq.RLock()
+ if _, exist := oo.monitoredRequests[omciMsg.TransactionID]; exist {
+ //implement non-blocking channel send to avoid blocking on mutexMonReq later
+ select {
+ case oo.monitoredRequests[omciMsg.TransactionID].chSuccess <- true:
+ default:
+ logger.Debugw(ctx, "response not send on omciRespChannel (no receiver)", log.Fields{
+ "transCorrId": strconv.FormatInt(int64(omciMsg.TransactionID), 16), "device-id": oo.deviceID})
+ }
+ } else {
+ logger.Infow(ctx, "reqMon: map entry does not exist!",
+ log.Fields{"tid": omciMsg.TransactionID, "device-id": oo.deviceID})
+ }
+ oo.mutexMonReq.RUnlock()
+
+ // no further test on SeqNo is done here, assignment from rxScheduler is trusted
+ // MibSync responses are simply transferred via deviceEntry to MibSync, no specific analysis here
+ omciRespMsg := Message{
+ Type: OMCI,
+ Data: OmciMessage{
+ OmciMsg: omciMsg,
+ OmciPacket: packet,
+ },
+ }
+ //logger.Debugw(ctx,"Message to be sent into channel:", log.Fields{"mibSyncMsg": mibSyncMsg})
+ respChan <- omciRespMsg
+
+ return nil
+}
+
+// SendMibReset sends MibResetRequest
+func (oo *OmciCC) SendMibReset(ctx context.Context, timeout int, highPrio bool) error {
+
+ logger.Debugw(ctx, "send MibReset-msg to:", log.Fields{"device-id": oo.deviceID})
+ request := &omci.MibResetRequest{
+ MeBasePacket: omci.MeBasePacket{
+ EntityClass: me.OnuDataClassID,
+ },
+ }
+ tid := oo.GetNextTid(highPrio)
+ pkt, err := Serialize(ctx, omci.MibResetRequestType, request, tid)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot serialize MibResetRequest", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return err
+ }
+ omciRxCallbackPair := CallbackPair{
+ CbKey: tid,
+ CbEntry: CallbackPairEntry{oo.pOnuDeviceEntry.GetMibUploadFsmCommChan(), oo.receiveOmciResponse, true},
+ }
+ return oo.Send(ctx, pkt, timeout, CDefaultRetries, highPrio, omciRxCallbackPair)
+}
+
+// SendReboot sends RebootRequest
+func (oo *OmciCC) SendReboot(ctx context.Context, timeout int, highPrio bool, responseChannel chan Message) error {
+ logger.Debugw(ctx, "send reboot-msg to:", log.Fields{"device-id": oo.deviceID})
+ request := &omci.RebootRequest{
+ MeBasePacket: omci.MeBasePacket{
+ EntityClass: me.OnuGClassID,
+ },
+ }
+ tid := oo.GetNextTid(highPrio)
+ pkt, err := Serialize(ctx, omci.RebootRequestType, request, tid)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot serialize RebootRequest", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return err
+ }
+ omciRxCallbackPair := CallbackPair{
+ CbKey: tid,
+ CbEntry: CallbackPairEntry{oo.pOnuDeviceEntry.GetOmciRebootMsgRevChan(), oo.receiveOmciResponse, true},
+ }
+
+ err = oo.Send(ctx, pkt, timeout, CDefaultRetries, highPrio, omciRxCallbackPair)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot send RebootRequest", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return err
+ }
+ err = oo.pOnuDeviceEntry.WaitForRebootResponse(ctx, responseChannel)
+ if err != nil {
+ logger.Errorw(ctx, "aborting ONU reboot!", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return err
+ }
+ return nil
+}
+
+// SendMibUpload sends MibUploadRequest
+func (oo *OmciCC) SendMibUpload(ctx context.Context, timeout int, highPrio bool) error {
+ logger.Debugw(ctx, "send MibUpload-msg to:", log.Fields{"device-id": oo.deviceID})
+ request := &omci.MibUploadRequest{
+ MeBasePacket: omci.MeBasePacket{
+ EntityClass: me.OnuDataClassID,
+ },
+ }
+ tid := oo.GetNextTid(highPrio)
+ pkt, err := Serialize(ctx, omci.MibUploadRequestType, request, tid)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot serialize MibUploadRequest", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return err
+ }
+ oo.UploadSequNo = 0
+ oo.UploadNoOfCmds = 0
+
+ omciRxCallbackPair := CallbackPair{
+ CbKey: tid,
+ CbEntry: CallbackPairEntry{oo.pOnuDeviceEntry.GetMibUploadFsmCommChan(), oo.receiveOmciResponse, true},
+ }
+ return oo.Send(ctx, pkt, timeout, CDefaultRetries, highPrio, omciRxCallbackPair)
+}
+
+// SendMibUploadNext sends MibUploadNextRequest
+func (oo *OmciCC) SendMibUploadNext(ctx context.Context, timeout int, highPrio bool) error {
+ logger.Debugw(ctx, "send MibUploadNext-msg to:", log.Fields{"device-id": oo.deviceID, "UploadSequNo": oo.UploadSequNo})
+ request := &omci.MibUploadNextRequest{
+ MeBasePacket: omci.MeBasePacket{
+ EntityClass: me.OnuDataClassID,
+ },
+ CommandSequenceNumber: oo.UploadSequNo,
+ }
+ tid := oo.GetNextTid(highPrio)
+ pkt, err := Serialize(ctx, omci.MibUploadNextRequestType, request, tid)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot serialize MibUploadNextRequest", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return err
+ }
+ oo.UploadSequNo++
+
+ omciRxCallbackPair := CallbackPair{
+ CbKey: tid,
+ //frame printing for MibUpload frames disabled now per default to avoid log file abort situations (size/speed?)
+ // if wanted, rx frame printing should be specifically done within the MibUpload FSM or controlled via extra parameter
+ // compare also software upgrade download section handling
+ CbEntry: CallbackPairEntry{oo.pOnuDeviceEntry.GetMibUploadFsmCommChan(), oo.receiveOmciResponse, true},
+ }
+ return oo.Send(ctx, pkt, timeout, CDefaultRetries, highPrio, omciRxCallbackPair)
+}
+
+// SendGetAllAlarm gets all alarm ME instances
+func (oo *OmciCC) SendGetAllAlarm(ctx context.Context, alarmRetreivalMode uint8, timeout int, highPrio bool) error {
+ logger.Debugw(ctx, "send GetAllAlarms-msg to:", log.Fields{"device-id": oo.deviceID})
+ request := &omci.GetAllAlarmsRequest{
+ MeBasePacket: omci.MeBasePacket{
+ EntityClass: me.OnuDataClassID,
+ },
+ AlarmRetrievalMode: byte(alarmRetreivalMode),
+ }
+ tid := oo.GetNextTid(highPrio)
+ pkt, err := Serialize(ctx, omci.GetAllAlarmsRequestType, request, tid)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot serialize GetAllAlarmsRequest", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return err
+ }
+ oo.pOnuAlarmManager.ResetAlarmUploadCounters()
+
+ omciRxCallbackPair := CallbackPair{
+ CbKey: tid,
+ CbEntry: CallbackPairEntry{oo.pOnuAlarmManager.GetAlarmMgrEventChannel(), oo.receiveOmciResponse, true},
+ }
+ return oo.Send(ctx, pkt, timeout, CDefaultRetries, highPrio, omciRxCallbackPair)
+}
+
+// SendGetAllAlarmNext gets next alarm ME instance
+func (oo *OmciCC) SendGetAllAlarmNext(ctx context.Context, timeout int, highPrio bool) error {
+ alarmUploadSeqNo := oo.pOnuAlarmManager.GetAlarmUploadSeqNo()
+ logger.Debugw(ctx, "send SendGetAllAlarmNext-msg to:", log.Fields{"device-id": oo.deviceID,
+ "alarmUploadSeqNo": alarmUploadSeqNo})
+ request := &omci.GetAllAlarmsNextRequest{
+ MeBasePacket: omci.MeBasePacket{
+ EntityClass: me.OnuDataClassID,
+ },
+ CommandSequenceNumber: alarmUploadSeqNo,
+ }
+ tid := oo.GetNextTid(highPrio)
+ pkt, err := Serialize(ctx, omci.GetAllAlarmsNextRequestType, request, tid)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot serialize GetAllAlarmsNextRequest", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return err
+ }
+ oo.pOnuAlarmManager.IncrementAlarmUploadSeqNo()
+
+ omciRxCallbackPair := CallbackPair{
+ CbKey: tid,
+ CbEntry: CallbackPairEntry{oo.pOnuAlarmManager.GetAlarmMgrEventChannel(), oo.receiveOmciResponse, true},
+ }
+ return oo.Send(ctx, pkt, timeout, CDefaultRetries, highPrio, omciRxCallbackPair)
+}
+
+// SendCreateGalEthernetProfile creates GalEthernetProfile ME instance
+func (oo *OmciCC) SendCreateGalEthernetProfile(ctx context.Context, timeout int, highPrio bool) (*me.ManagedEntity, error) {
+ tid := oo.GetNextTid(highPrio)
+ logger.Debugw(ctx, "send GalEnetProfile-Create-msg:", log.Fields{"device-id": oo.deviceID,
+ "SequNo": strconv.FormatInt(int64(tid), 16)})
+
+ meParams := me.ParamData{
+ EntityID: GalEthernetEID,
+ Attributes: me.AttributeValueMap{"MaximumGemPayloadSize": maxGemPayloadSize},
+ }
+ meInstance, omciErr := me.NewGalEthernetProfile(meParams)
+ if omciErr.GetError() == nil {
+ //all setByCreate parameters already set, no default option required ...
+ omciLayer, msgLayer, err := omci.EncodeFrame(meInstance, omci.CreateRequestType, omci.TransactionID(tid))
+ if err != nil {
+ logger.Errorw(ctx, "Cannot encode GalEnetProfileInstance for create", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+
+ pkt, err := serializeOmciLayer(ctx, omciLayer, msgLayer)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot serialize GalEnetProfile create", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+
+ omciRxCallbackPair := CallbackPair{
+ CbKey: tid,
+ CbEntry: CallbackPairEntry{oo.pOnuDeviceEntry.GetMibDownloadFsmCommChan(), oo.receiveOmciResponse, true},
+ }
+ err = oo.Send(ctx, pkt, timeout, CDefaultRetries, highPrio, omciRxCallbackPair)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot send GalEnetProfile create", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+ logger.Debug(ctx, "send GalEnetProfile-Create-msg done")
+ return meInstance, nil
+ }
+ logger.Errorw(ctx, "Cannot generate GalEnetProfileInstance", log.Fields{
+ "Err": omciErr.GetError(), "device-id": oo.deviceID})
+ return nil, omciErr.GetError()
+}
+
+// SendSetOnu2g sets Onu2G ME instance
+// might be needed to extend for parameter arguments, here just for setting the ConnectivityMode!!
+func (oo *OmciCC) SendSetOnu2g(ctx context.Context, timeout int, highPrio bool) (*me.ManagedEntity, error) {
+ tid := oo.GetNextTid(highPrio)
+ logger.Debugw(ctx, "send ONU2-G-Set-msg:", log.Fields{"device-id": oo.deviceID,
+ "SequNo": strconv.FormatInt(int64(tid), 16)})
+
+ // ONU-G ME-ID is defined to be 0, but we could verify, if the ONU really supports the desired
+ // connectivity mode 5 (in ConnCap)
+ // By now we just use fix values to fire - this is anyway what the python adapter does
+ // read ONU-2G from DB ???? //TODO!!!
+ meParams := me.ParamData{
+ EntityID: 0,
+ Attributes: me.AttributeValueMap{"CurrentConnectivityMode": connectivityModeValue},
+ }
+ meInstance, omciErr := me.NewOnu2G(meParams)
+ if omciErr.GetError() == nil {
+ omciLayer, msgLayer, err := omci.EncodeFrame(meInstance, omci.SetRequestType, omci.TransactionID(tid))
+ if err != nil {
+ logger.Errorw(ctx, "Cannot encode ONU2-G instance for set", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+
+ pkt, err := serializeOmciLayer(ctx, omciLayer, msgLayer)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot serialize ONU2-G set", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+
+ omciRxCallbackPair := CallbackPair{
+ CbKey: tid,
+ CbEntry: CallbackPairEntry{oo.pOnuDeviceEntry.GetMibDownloadFsmCommChan(), oo.receiveOmciResponse, true},
+ }
+ err = oo.Send(ctx, pkt, timeout, CDefaultRetries, highPrio, omciRxCallbackPair)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot send ONU2-G set", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+ logger.Debug(ctx, "send ONU2-G-Set-msg done")
+ return meInstance, nil
+ }
+ logger.Errorw(ctx, "Cannot generate ONU2-G", log.Fields{
+ "Err": omciErr.GetError(), "device-id": oo.deviceID})
+ return nil, omciErr.GetError()
+}
+
+// SendCreateMBServiceProfile creates MacBridgeServiceProfile ME instance
+func (oo *OmciCC) SendCreateMBServiceProfile(ctx context.Context,
+ aPUniPort *OnuUniPort, timeout int, highPrio bool) (*me.ManagedEntity, error) {
+ tid := oo.GetNextTid(highPrio)
+ instID := MacBridgeServiceProfileEID + uint16(aPUniPort.MacBpNo)
+ logger.Debugw(ctx, "send MBSP-Create-msg:", log.Fields{"device-id": oo.deviceID,
+ "SequNo": strconv.FormatInt(int64(tid), 16), "InstId": strconv.FormatInt(int64(instID), 16)})
+
+ meParams := me.ParamData{
+ EntityID: instID,
+ Attributes: me.AttributeValueMap{
+ "Priority": 0x8000,
+ "MaxAge": 20 * 256, //20s
+ "HelloTime": 2 * 256, //2s
+ "ForwardDelay": 15 * 256, //15s
+ "DynamicFilteringAgeingTime": 0,
+ },
+ }
+
+ meInstance, omciErr := me.NewMacBridgeServiceProfile(meParams)
+ if omciErr.GetError() == nil {
+ //obviously we have to set all 'untouched' parameters to default by some additional option parameter!!
+ omciLayer, msgLayer, err := omci.EncodeFrame(meInstance, omci.CreateRequestType,
+ omci.TransactionID(tid), omci.AddDefaults(true))
+ if err != nil {
+ logger.Errorw(ctx, "Cannot encode MBSP for create", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+
+ pkt, err := serializeOmciLayer(ctx, omciLayer, msgLayer)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot serialize MBSP create", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+
+ omciRxCallbackPair := CallbackPair{
+ CbKey: tid,
+ CbEntry: CallbackPairEntry{oo.pOnuDeviceEntry.GetMibDownloadFsmCommChan(), oo.receiveOmciResponse, true},
+ }
+ err = oo.Send(ctx, pkt, timeout, CDefaultRetries, highPrio, omciRxCallbackPair)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot send MBSP create", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+ logger.Debug(ctx, "send MBSP-Create-msg done")
+ return meInstance, nil
+ }
+ logger.Errorw(ctx, "Cannot generate MBSP Instance", log.Fields{
+ "Err": omciErr.GetError(), "device-id": oo.deviceID})
+ return nil, omciErr.GetError()
+}
+
+// SendCreateMBPConfigDataUniSide creates MacBridgePortConfigurationData ME instance
+func (oo *OmciCC) SendCreateMBPConfigDataUniSide(ctx context.Context,
+ aPUniPort *OnuUniPort, timeout int, highPrio bool) (*me.ManagedEntity, error) {
+ tid := oo.GetNextTid(highPrio)
+ instID, idErr := GenerateUNISideMBPCDEID(uint16(aPUniPort.MacBpNo))
+ if idErr != nil {
+ logger.Errorw(ctx, "Cannot generate MBPCD entity id", log.Fields{
+ "Err": idErr, "device-id": oo.deviceID})
+ return nil, idErr
+ }
+ logger.Debugw(ctx, "send MBPCD-Create-msg for uni side:", log.Fields{"device-id": oo.deviceID,
+ "SequNo": strconv.FormatInt(int64(tid), 16), "InstId": strconv.FormatInt(int64(instID), 16), "macBpNo": aPUniPort.MacBpNo})
+
+ meParams := me.ParamData{
+ EntityID: instID,
+ Attributes: me.AttributeValueMap{
+ "BridgeIdPointer": MacBridgeServiceProfileEID + uint16(aPUniPort.MacBpNo),
+ "PortNum": aPUniPort.MacBpNo,
+ "TpType": uint8(aPUniPort.PortType),
+ "TpPointer": aPUniPort.EntityID,
+ },
+ }
+ meInstance, omciErr := me.NewMacBridgePortConfigurationData(meParams)
+ if omciErr.GetError() == nil {
+ //obviously we have to set all 'untouched' parameters to default by some additional option parameter!!
+ omciLayer, msgLayer, err := omci.EncodeFrame(meInstance, omci.CreateRequestType,
+ omci.TransactionID(tid), omci.AddDefaults(true))
+ if err != nil {
+ logger.Errorw(ctx, "Cannot encode MBPCD for create", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+
+ pkt, err := serializeOmciLayer(ctx, omciLayer, msgLayer)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot serialize MBPCD create", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+
+ omciRxCallbackPair := CallbackPair{
+ CbKey: tid,
+ CbEntry: CallbackPairEntry{oo.pOnuDeviceEntry.GetMibDownloadFsmCommChan(), oo.receiveOmciResponse, true},
+ }
+ err = oo.Send(ctx, pkt, timeout, CDefaultRetries, highPrio, omciRxCallbackPair)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot send MBPCD create", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+ logger.Debug(ctx, "send MBPCD-Create-msg done")
+ return meInstance, nil
+ }
+ logger.Errorw(ctx, "Cannot generate MBPCD Instance", log.Fields{
+ "Err": omciErr.GetError(), "device-id": oo.deviceID})
+ return nil, omciErr.GetError()
+}
+
+// SendCreateEVTOConfigData creates ExtendedVlanTaggingOperationConfigurationData ME instance
+func (oo *OmciCC) SendCreateEVTOConfigData(ctx context.Context,
+ aPUniPort *OnuUniPort, timeout int, highPrio bool) (*me.ManagedEntity, error) {
+ tid := oo.GetNextTid(highPrio)
+ //same entityId is used as for MBSP (see there), but just arbitrary ...
+ instID := MacBridgeServiceProfileEID + uint16(aPUniPort.MacBpNo)
+ logger.Debugw(ctx, "send EVTOCD-Create-msg:", log.Fields{"device-id": oo.deviceID,
+ "SequNo": strconv.FormatInt(int64(tid), 16), "InstId": strconv.FormatInt(int64(instID), 16)})
+
+ // compare python adapter code WA VOL-1311: this is not done here!
+ // (setting TPID values for the create would probably anyway be ignored by the omci lib)
+ // but perhaps we have to be aware of possible problems at get(Next) Request handling for EVTOOCD tables later ...
+ assType := uint8(2) // default AssociationType is PPTPEthUni
+ if aPUniPort.PortType == UniVEIP {
+ assType = uint8(10) // for VEIP
+ }
+ meParams := me.ParamData{
+ EntityID: instID,
+ Attributes: me.AttributeValueMap{
+ "AssociationType": assType,
+ "AssociatedMePointer": aPUniPort.EntityID,
+ },
+ }
+ meInstance, omciErr := me.NewExtendedVlanTaggingOperationConfigurationData(meParams)
+ if omciErr.GetError() == nil {
+ //all setByCreate parameters already set, no default option required ...
+ omciLayer, msgLayer, err := omci.EncodeFrame(meInstance, omci.CreateRequestType, omci.TransactionID(tid))
+ if err != nil {
+ logger.Errorw(ctx, "Cannot encode EVTOCD for create", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+
+ pkt, err := serializeOmciLayer(ctx, omciLayer, msgLayer)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot serialize EVTOCD create", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+
+ omciRxCallbackPair := CallbackPair{
+ CbKey: tid,
+ CbEntry: CallbackPairEntry{oo.pOnuDeviceEntry.GetMibDownloadFsmCommChan(), oo.receiveOmciResponse, true},
+ }
+ err = oo.Send(ctx, pkt, timeout, CDefaultRetries, highPrio, omciRxCallbackPair)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot send EVTOCD create", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+ logger.Debug(ctx, "send EVTOCD-Create-msg done")
+ return meInstance, nil
+ }
+ logger.Errorw(ctx, "Cannot generate EVTOCD Instance", log.Fields{
+ "Err": omciErr.GetError(), "device-id": oo.deviceID})
+ return nil, omciErr.GetError()
+}
+
+// SendSetOnuGLS sets OnuG ME instance
+func (oo *OmciCC) SendSetOnuGLS(ctx context.Context, timeout int,
+ highPrio bool, requestedAttributes me.AttributeValueMap, rxChan chan Message) (*me.ManagedEntity, error) {
+ tid := oo.GetNextTid(highPrio)
+ logger.Debugw(ctx, "send ONU-G-Set-msg:", log.Fields{"device-id": oo.deviceID,
+ "SequNo": strconv.FormatInt(int64(tid), 16)})
+
+ // ONU-G ME-ID is defined to be 0, no need to perform a DB lookup
+ meParams := me.ParamData{
+ EntityID: 0,
+ Attributes: requestedAttributes,
+ }
+ meInstance, omciErr := me.NewOnuG(meParams)
+ if omciErr.GetError() == nil {
+ omciLayer, msgLayer, err := omci.EncodeFrame(meInstance, omci.SetRequestType, omci.TransactionID(tid))
+ if err != nil {
+ logger.Errorw(ctx, "Cannot encode ONU-G instance for set", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+
+ pkt, err := serializeOmciLayer(ctx, omciLayer, msgLayer)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot serialize ONU-G set", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+
+ omciRxCallbackPair := CallbackPair{
+ CbKey: tid,
+ CbEntry: CallbackPairEntry{rxChan, oo.receiveOmciResponse, true},
+ }
+ err = oo.Send(ctx, pkt, timeout, CDefaultRetries, highPrio, omciRxCallbackPair)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot send ONU-G set", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+ logger.Debug(ctx, "send ONU-G-Set-msg done")
+ return meInstance, nil
+ }
+ logger.Errorw(ctx, "Cannot generate ONU-G", log.Fields{
+ "Err": omciErr.GetError(), "device-id": oo.deviceID})
+ return nil, omciErr.GetError()
+}
+
+// SendSetPptpEthUniLS sets PhysicalPathTerminationPointEthernetUni ME instance
+func (oo *OmciCC) SendSetPptpEthUniLS(ctx context.Context, aInstNo uint16, timeout int,
+ highPrio bool, requestedAttributes me.AttributeValueMap, rxChan chan Message) (*me.ManagedEntity, error) {
+ tid := oo.GetNextTid(highPrio)
+ logger.Debugw(ctx, "send PPTPEthUni-Set-msg:", log.Fields{"device-id": oo.deviceID,
+ "SequNo": strconv.FormatInt(int64(tid), 16)})
+
+ // PPTPEthUni ME-ID is taken from Mib Upload stored OnuUniPort instance (argument)
+ meParams := me.ParamData{
+ EntityID: aInstNo,
+ Attributes: requestedAttributes,
+ }
+ meInstance, omciErr := me.NewPhysicalPathTerminationPointEthernetUni(meParams)
+ if omciErr.GetError() == nil {
+ omciLayer, msgLayer, err := omci.EncodeFrame(meInstance, omci.SetRequestType, omci.TransactionID(tid))
+ if err != nil {
+ logger.Errorw(ctx, "Cannot encode PPTPEthUni instance for set", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+
+ pkt, err := serializeOmciLayer(ctx, omciLayer, msgLayer)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot serialize PPTPEthUni-Set", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+
+ omciRxCallbackPair := CallbackPair{
+ CbKey: tid,
+ CbEntry: CallbackPairEntry{rxChan, oo.receiveOmciResponse, true},
+ }
+ err = oo.Send(ctx, pkt, timeout, CDefaultRetries, highPrio, omciRxCallbackPair)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot send PPTPEthUni-Set", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+ logger.Debug(ctx, "send PPTPEthUni-Set-msg done")
+ return meInstance, nil
+ }
+ logger.Errorw(ctx, "Cannot generate PPTPEthUni", log.Fields{
+ "Err": omciErr.GetError(), "device-id": oo.deviceID})
+ return nil, omciErr.GetError()
+}
+
+/* UniG obsolete by now, left here in case it should be needed once again
+ UniG AdminState anyway should be ignored by ONU acc. to G988
+func (oo *omciCC) sendSetUniGLS(ctx context.Context, aInstNo uint16, timeout int,
+ highPrio bool, requestedAttributes me.AttributeValueMap, rxChan chan Message) *me.ManagedEntity {
+ tid := oo.GetNextTid(highPrio)
+ logger.Debugw(ctx,"send UNI-G-Set-msg:", log.Fields{"device-id": oo.deviceID,
+ "SequNo": strconv.FormatInt(int64(tid), 16)})
+
+ // UNI-G ME-ID is taken from Mib Upload stored OnuUniPort instance (argument)
+ meParams := me.ParamData{
+ EntityID: aInstNo,
+ Attributes: requestedAttributes,
+ }
+ meInstance, omciErr := me.NewUniG(meParams)
+ if omciErr.GetError() == nil {
+ omciLayer, msgLayer, err := omci.EncodeFrame(meInstance, omci.SetRequestType, omci.TransactionID(tid))
+ if err != nil {
+ logger.Errorw(ctx,"Cannot encode UNI-G instance for set", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil
+ }
+
+ pkt, err := serializeOmciLayer(omciLayer, msgLayer)
+ if err != nil {
+ logger.Errorw(ctx,"Cannot serialize UNI-G-Set", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil
+ }
+
+ omciRxCallbackPair := CallbackPair{
+ CbKey: tid,
+ CbEntry: CallbackPairEntry{rxChan, oo.receiveOmciResponse, true},
+ }
+ err = oo.Send(ctx, pkt, timeout, CDefaultRetries, highPrio, omciRxCallbackPair)
+ if err != nil {
+ logger.Errorw(ctx,"Cannot send UNIG-G-Set", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil
+ }
+ logger.Debug(ctx,"send UNI-G-Set-msg done")
+ return meInstance
+ }
+ logger.Errorw(ctx,"Cannot generate UNI-G", log.Fields{
+ "Err": omciErr.GetError(), "device-id": oo.deviceID})
+ return nil
+}
+*/
+
+// SendSetVeipLS sets VirtualEthernetInterfacePoint ME instance
+func (oo *OmciCC) SendSetVeipLS(ctx context.Context, aInstNo uint16, timeout int,
+ highPrio bool, requestedAttributes me.AttributeValueMap, rxChan chan Message) (*me.ManagedEntity, error) {
+ tid := oo.GetNextTid(highPrio)
+ logger.Debugw(ctx, "send VEIP-Set-msg:", log.Fields{"device-id": oo.deviceID,
+ "SequNo": strconv.FormatInt(int64(tid), 16)})
+
+ // ONU-G ME-ID is defined to be 0, no need to perform a DB lookup
+ meParams := me.ParamData{
+ EntityID: aInstNo,
+ Attributes: requestedAttributes,
+ }
+ meInstance, omciErr := me.NewVirtualEthernetInterfacePoint(meParams)
+ if omciErr.GetError() == nil {
+ omciLayer, msgLayer, err := omci.EncodeFrame(meInstance, omci.SetRequestType, omci.TransactionID(tid))
+ if err != nil {
+ logger.Errorw(ctx, "Cannot encode VEIP instance for set", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+
+ pkt, err := serializeOmciLayer(ctx, omciLayer, msgLayer)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot serialize VEIP-Set", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+
+ omciRxCallbackPair := CallbackPair{
+ CbKey: tid,
+ CbEntry: CallbackPairEntry{rxChan, oo.receiveOmciResponse, true},
+ }
+ err = oo.Send(ctx, pkt, timeout, CDefaultRetries, highPrio, omciRxCallbackPair)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot send VEIP-Set", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+ logger.Debug(ctx, "send VEIP-Set-msg done")
+ return meInstance, nil
+ }
+ logger.Errorw(ctx, "Cannot generate VEIP", log.Fields{
+ "Err": omciErr.GetError(), "device-id": oo.deviceID})
+ return nil, omciErr.GetError()
+}
+
+// SendGetMe gets ME instance
+func (oo *OmciCC) SendGetMe(ctx context.Context, classID me.ClassID, entityID uint16, requestedAttributes me.AttributeValueMap,
+ timeout int, highPrio bool, rxChan chan Message) (*me.ManagedEntity, error) {
+
+ tid := oo.GetNextTid(highPrio)
+ logger.Debugw(ctx, "send get-request-msg", log.Fields{"classID": classID, "device-id": oo.deviceID,
+ "SequNo": strconv.FormatInt(int64(tid), 16)})
+
+ meParams := me.ParamData{
+ EntityID: entityID,
+ Attributes: requestedAttributes,
+ }
+ meInstance, omciErr := me.LoadManagedEntityDefinition(classID, meParams)
+ if omciErr.GetError() == nil {
+ meClassIDName := meInstance.GetName()
+ omciLayer, msgLayer, err := omci.EncodeFrame(meInstance, omci.GetRequestType, omci.TransactionID(tid))
+ if err != nil {
+ logger.Errorf(ctx, "Cannot encode instance for get-request", log.Fields{"meClassIDName": meClassIDName, "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+ pkt, err := serializeOmciLayer(ctx, omciLayer, msgLayer)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot serialize get-request", log.Fields{"meClassIDName": meClassIDName, "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+ omciRxCallbackPair := CallbackPair{
+ CbKey: tid,
+ CbEntry: CallbackPairEntry{rxChan, oo.receiveOmciResponse, true},
+ }
+ err = oo.Send(ctx, pkt, timeout, CDefaultRetries, highPrio, omciRxCallbackPair)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot send get-request-msg", log.Fields{"meClassIDName": meClassIDName, "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+ logger.Debugw(ctx, "send get-request-msg done", log.Fields{"meClassIDName": meClassIDName, "device-id": oo.deviceID})
+ return meInstance, nil
+ }
+ logger.Errorw(ctx, "Cannot generate meDefinition", log.Fields{"classID": classID, "Err": omciErr.GetError(), "device-id": oo.deviceID})
+ return nil, omciErr.GetError()
+}
+
+// SendGetMeWithAttributeMask gets ME instance with attribute mask
+func (oo *OmciCC) SendGetMeWithAttributeMask(ctx context.Context, classID me.ClassID, entityID uint16, requestedAttributesMask uint16,
+ timeout int, highPrio bool, rxChan chan Message) error {
+
+ tid := oo.GetNextTid(highPrio)
+ logger.Debugw(ctx, "send get-request-msg", log.Fields{"classID": classID, "device-id": oo.deviceID,
+ "SequNo": strconv.FormatInt(int64(tid), 16)})
+
+ request := &omci.GetRequest{
+ MeBasePacket: omci.MeBasePacket{
+ EntityInstance: entityID,
+ EntityClass: classID,
+ },
+ AttributeMask: requestedAttributesMask,
+ }
+
+ pkt, err := Serialize(ctx, omci.GetRequestType, request, tid)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot serialize get-request", log.Fields{"meClassIDName": classID, "Err": err, "device-id": oo.deviceID})
+ return err
+ }
+ omciRxCallbackPair := CallbackPair{
+ CbKey: tid,
+ CbEntry: CallbackPairEntry{rxChan, oo.receiveOmciResponse, true},
+ }
+ err = oo.Send(ctx, pkt, timeout, CDefaultRetries, highPrio, omciRxCallbackPair)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot send get-request-msg", log.Fields{"meClassIDName": classID, "Err": err, "device-id": oo.deviceID})
+ return err
+ }
+ logger.Debugw(ctx, "send get-request-msg done", log.Fields{"meClassIDName": classID, "device-id": oo.deviceID})
+ return nil
+}
+
+// SendCreateDot1PMapper creates Ieee8021PMapperServiceProfile ME instance
+func (oo *OmciCC) SendCreateDot1PMapper(ctx context.Context, timeout int, highPrio bool,
+ aInstID uint16, rxChan chan Message) (*me.ManagedEntity, error) {
+ tid := oo.GetNextTid(highPrio)
+ logger.Debugw(ctx, "send .1pMapper-Create-msg:", log.Fields{"device-id": oo.deviceID,
+ "SequNo": strconv.FormatInt(int64(tid), 16), "InstId": strconv.FormatInt(int64(aInstID), 16)})
+
+ meParams := me.ParamData{
+ EntityID: aInstID,
+ Attributes: me.AttributeValueMap{
+ //workaround for unsuitable omci-lib default values, cmp VOL-3729
+ "TpPointer": 0xFFFF,
+ "InterworkTpPointerForPBitPriority0": 0xFFFF,
+ "InterworkTpPointerForPBitPriority1": 0xFFFF,
+ "InterworkTpPointerForPBitPriority2": 0xFFFF,
+ "InterworkTpPointerForPBitPriority3": 0xFFFF,
+ "InterworkTpPointerForPBitPriority4": 0xFFFF,
+ "InterworkTpPointerForPBitPriority5": 0xFFFF,
+ "InterworkTpPointerForPBitPriority6": 0xFFFF,
+ "InterworkTpPointerForPBitPriority7": 0xFFFF,
+ },
+ }
+ meInstance, omciErr := me.NewIeee8021PMapperServiceProfile(meParams)
+ if omciErr.GetError() == nil {
+ //we have to set all 'untouched' parameters to default by some additional option parameter!!
+ omciLayer, msgLayer, err := omci.EncodeFrame(meInstance, omci.CreateRequestType,
+ omci.TransactionID(tid), omci.AddDefaults(true))
+ if err != nil {
+ logger.Errorw(ctx, "Cannot encode .1pMapper for create", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+
+ pkt, err := serializeOmciLayer(ctx, omciLayer, msgLayer)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot serialize .1pMapper create", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+
+ omciRxCallbackPair := CallbackPair{
+ CbKey: tid,
+ CbEntry: CallbackPairEntry{rxChan, oo.receiveOmciResponse, true},
+ }
+ err = oo.Send(ctx, pkt, timeout, CDefaultRetries, highPrio, omciRxCallbackPair)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot send .1pMapper create", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+ logger.Debug(ctx, "send .1pMapper-create-msg done")
+ return meInstance, nil
+ }
+ logger.Errorw(ctx, "Cannot generate .1pMapper", log.Fields{
+ "Err": omciErr.GetError(), "device-id": oo.deviceID})
+ return nil, omciErr.GetError()
+}
+
+// SendCreateMBPConfigDataVar creates MacBridgePortConfigurationData ME instance
+func (oo *OmciCC) SendCreateMBPConfigDataVar(ctx context.Context, timeout int, highPrio bool,
+ rxChan chan Message, params ...me.ParamData) (*me.ManagedEntity, error) {
+ tid := oo.GetNextTid(highPrio)
+ logger.Debugw(ctx, "send MBPCD-Create-msg:", log.Fields{"device-id": oo.deviceID,
+ "SequNo": strconv.FormatInt(int64(tid), 16),
+ "InstId": strconv.FormatInt(int64(params[0].EntityID), 16)})
+
+ meInstance, omciErr := me.NewMacBridgePortConfigurationData(params[0])
+ if omciErr.GetError() == nil {
+ //obviously we have to set all 'untouched' parameters to default by some additional option parameter!!
+ omciLayer, msgLayer, err := omci.EncodeFrame(meInstance, omci.CreateRequestType,
+ omci.TransactionID(tid), omci.AddDefaults(true))
+ if err != nil {
+ logger.Errorw(ctx, "Cannot encode MBPCD for create", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+
+ pkt, err := serializeOmciLayer(ctx, omciLayer, msgLayer)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot serialize MBPCD create", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+
+ omciRxCallbackPair := CallbackPair{
+ CbKey: tid,
+ CbEntry: CallbackPairEntry{rxChan, oo.receiveOmciResponse, true},
+ }
+ err = oo.Send(ctx, pkt, timeout, CDefaultRetries, highPrio, omciRxCallbackPair)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot send MBPCD create", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+ logger.Debug(ctx, "send MBPCD-Create-msg done")
+ return meInstance, nil
+ }
+ logger.Errorw(ctx, "Cannot generate MBPCD Instance", log.Fields{
+ "Err": omciErr.GetError(), "device-id": oo.deviceID})
+ return nil, omciErr.GetError()
+}
+
+// SendCreateGemNCTPVar creates GemPortNetworkCtp ME instance
+func (oo *OmciCC) SendCreateGemNCTPVar(ctx context.Context, timeout int, highPrio bool,
+ rxChan chan Message, params ...me.ParamData) (*me.ManagedEntity, error) {
+ tid := oo.GetNextTid(highPrio)
+ logger.Debugw(ctx, "send GemNCTP-Create-msg:", log.Fields{"device-id": oo.deviceID,
+ "SequNo": strconv.FormatInt(int64(tid), 16),
+ "InstId": strconv.FormatInt(int64(params[0].EntityID), 16)})
+
+ meInstance, omciErr := me.NewGemPortNetworkCtp(params[0])
+ if omciErr.GetError() == nil {
+ //obviously we have to set all 'untouched' parameters to default by some additional option parameter!!
+ omciLayer, msgLayer, err := omci.EncodeFrame(meInstance, omci.CreateRequestType,
+ omci.TransactionID(tid), omci.AddDefaults(true))
+ if err != nil {
+ logger.Errorw(ctx, "Cannot encode GemNCTP for create", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+
+ pkt, err := serializeOmciLayer(ctx, omciLayer, msgLayer)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot serialize GemNCTP create", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+
+ omciRxCallbackPair := CallbackPair{
+ CbKey: tid,
+ CbEntry: CallbackPairEntry{rxChan, oo.receiveOmciResponse, true},
+ }
+ err = oo.Send(ctx, pkt, timeout, CDefaultRetries, highPrio, omciRxCallbackPair)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot send GemNCTP create", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+ logger.Debug(ctx, "send GemNCTP-Create-msg done")
+ return meInstance, nil
+ }
+ logger.Errorw(ctx, "Cannot generate GemNCTP Instance", log.Fields{
+ "Err": omciErr.GetError(), "device-id": oo.deviceID})
+ return nil, omciErr.GetError()
+}
+
+// SendSetGemNCTPVar sets GemPortNetworkCtp ME instance
+func (oo *OmciCC) SendSetGemNCTPVar(ctx context.Context, timeout int, highPrio bool, rxChan chan Message, params ...me.ParamData) (*me.ManagedEntity, error) {
+ tid := oo.GetNextTid(highPrio)
+ logger.Debugw(ctx, "send GemNCTP-Set-msg:", log.Fields{"device-id": oo.deviceID,
+ "SequNo": strconv.FormatInt(int64(tid), 16),
+ "InstId": strconv.FormatInt(int64(params[0].EntityID), 16)})
+
+ meInstance, omciErr := me.NewGemPortNetworkCtp(params[0])
+ if omciErr.GetError() == nil {
+ //obviously we have to set all 'untouched' parameters to default by some additional option parameter!!
+ omciLayer, msgLayer, err := omci.EncodeFrame(meInstance, omci.SetRequestType,
+ omci.TransactionID(tid), omci.AddDefaults(true))
+ if err != nil {
+ logger.Errorw(ctx, "Cannot encode GemNCTP for set", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+
+ pkt, err := serializeOmciLayer(ctx, omciLayer, msgLayer)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot serialize GemNCTP set", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+
+ omciRxCallbackPair := CallbackPair{
+ CbKey: tid,
+ CbEntry: CallbackPairEntry{rxChan, oo.receiveOmciResponse, true},
+ }
+ err = oo.Send(ctx, pkt, timeout, CDefaultRetries, highPrio, omciRxCallbackPair)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot send GemNCTP set", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+ logger.Debug(ctx, "send GemNCTP-Set-msg done", log.Fields{"device-id": oo.deviceID})
+ return meInstance, nil
+ }
+ logger.Errorw(ctx, "Cannot generate GemNCTP Instance", log.Fields{
+ "Err": omciErr.GetError(), "device-id": oo.deviceID})
+ return nil, omciErr.GetError()
+}
+
+// SendCreateGemIWTPVar creates GemInterworkingTerminationPoint ME instance
+func (oo *OmciCC) SendCreateGemIWTPVar(ctx context.Context, timeout int, highPrio bool,
+ rxChan chan Message, params ...me.ParamData) (*me.ManagedEntity, error) {
+ tid := oo.GetNextTid(highPrio)
+ logger.Debugw(ctx, "send GemIwTp-Create-msg:", log.Fields{"device-id": oo.deviceID,
+ "SequNo": strconv.FormatInt(int64(tid), 16),
+ "InstId": strconv.FormatInt(int64(params[0].EntityID), 16)})
+
+ meInstance, omciErr := me.NewGemInterworkingTerminationPoint(params[0])
+ if omciErr.GetError() == nil {
+ //all SetByCreate Parameters (assumed to be) set here, for optimisation no 'AddDefaults'
+ omciLayer, msgLayer, err := omci.EncodeFrame(meInstance, omci.CreateRequestType,
+ omci.TransactionID(tid))
+ if err != nil {
+ logger.Errorw(ctx, "Cannot encode GemIwTp for create", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+
+ pkt, err := serializeOmciLayer(ctx, omciLayer, msgLayer)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot serialize GemIwTp create", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+
+ omciRxCallbackPair := CallbackPair{
+ CbKey: tid,
+ CbEntry: CallbackPairEntry{rxChan, oo.receiveOmciResponse, true},
+ }
+ err = oo.Send(ctx, pkt, timeout, CDefaultRetries, highPrio, omciRxCallbackPair)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot send GemIwTp create", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+ logger.Debug(ctx, "send GemIwTp-Create-msg done")
+ return meInstance, nil
+ }
+ logger.Errorw(ctx, "Cannot generate GemIwTp Instance", log.Fields{
+ "Err": omciErr.GetError(), "device-id": oo.deviceID})
+ return nil, omciErr.GetError()
+}
+
+// SendSetTcontVar sets TCont ME instance
+func (oo *OmciCC) SendSetTcontVar(ctx context.Context, timeout int, highPrio bool,
+ rxChan chan Message, params ...me.ParamData) (*me.ManagedEntity, error) {
+ tid := oo.GetNextTid(highPrio)
+ logger.Debugw(ctx, "send TCont-Set-msg:", log.Fields{"device-id": oo.deviceID,
+ "SequNo": strconv.FormatInt(int64(tid), 16),
+ "InstId": strconv.FormatInt(int64(params[0].EntityID), 16)})
+
+ meInstance, omciErr := me.NewTCont(params[0])
+ if omciErr.GetError() == nil {
+ omciLayer, msgLayer, err := omci.EncodeFrame(meInstance, omci.SetRequestType, omci.TransactionID(tid))
+ if err != nil {
+ logger.Errorw(ctx, "Cannot encode TCont for set", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+
+ pkt, err := serializeOmciLayer(ctx, omciLayer, msgLayer)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot serialize TCont set", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+
+ omciRxCallbackPair := CallbackPair{
+ CbKey: tid,
+ CbEntry: CallbackPairEntry{rxChan, oo.receiveOmciResponse, true},
+ }
+ err = oo.Send(ctx, pkt, timeout, CDefaultRetries, highPrio, omciRxCallbackPair)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot send TCont set", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+ logger.Debug(ctx, "send TCont-set msg done")
+ return meInstance, nil
+ }
+ logger.Errorw(ctx, "Cannot generate TCont Instance", log.Fields{
+ "Err": omciErr.GetError(), "device-id": oo.deviceID})
+ return nil, omciErr.GetError()
+}
+
+// SendSetPrioQueueVar sets PriorityQueue ME instance
+func (oo *OmciCC) SendSetPrioQueueVar(ctx context.Context, timeout int, highPrio bool,
+ rxChan chan Message, params ...me.ParamData) (*me.ManagedEntity, error) {
+ tid := oo.GetNextTid(highPrio)
+ logger.Debugw(ctx, "send PrioQueue-Set-msg:", log.Fields{"device-id": oo.deviceID,
+ "SequNo": strconv.FormatInt(int64(tid), 16),
+ "InstId": strconv.FormatInt(int64(params[0].EntityID), 16)})
+
+ meInstance, omciErr := me.NewPriorityQueue(params[0])
+ if omciErr.GetError() == nil {
+ omciLayer, msgLayer, err := omci.EncodeFrame(meInstance, omci.SetRequestType, omci.TransactionID(tid))
+ if err != nil {
+ logger.Errorw(ctx, "Cannot encode PrioQueue for set", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+
+ pkt, err := serializeOmciLayer(ctx, omciLayer, msgLayer)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot serialize PrioQueue set", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+
+ omciRxCallbackPair := CallbackPair{
+ CbKey: tid,
+ CbEntry: CallbackPairEntry{rxChan, oo.receiveOmciResponse, true},
+ }
+ err = oo.Send(ctx, pkt, timeout, CDefaultRetries, highPrio, omciRxCallbackPair)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot send PrioQueue set", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+ logger.Debug(ctx, "send PrioQueue-set msg done")
+ return meInstance, nil
+ }
+ logger.Errorw(ctx, "Cannot generate PrioQueue Instance", log.Fields{
+ "Err": omciErr.GetError(), "device-id": oo.deviceID})
+ return nil, omciErr.GetError()
+}
+
+// SendSetDot1PMapperVar sets Ieee8021PMapperServiceProfile ME instance
+func (oo *OmciCC) SendSetDot1PMapperVar(ctx context.Context, timeout int, highPrio bool,
+ rxChan chan Message, params ...me.ParamData) (*me.ManagedEntity, error) {
+ tid := oo.GetNextTid(highPrio)
+ logger.Debugw(ctx, "send 1PMapper-Set-msg:", log.Fields{"device-id": oo.deviceID,
+ "SequNo": strconv.FormatInt(int64(tid), 16),
+ "InstId": strconv.FormatInt(int64(params[0].EntityID), 16)})
+
+ meInstance, omciErr := me.NewIeee8021PMapperServiceProfile(params[0])
+ if omciErr.GetError() == nil {
+ omciLayer, msgLayer, err := omci.EncodeFrame(meInstance, omci.SetRequestType, omci.TransactionID(tid))
+ if err != nil {
+ logger.Errorw(ctx, "Cannot encode 1PMapper for set", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+
+ pkt, err := serializeOmciLayer(ctx, omciLayer, msgLayer)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot serialize 1PMapper set", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+
+ omciRxCallbackPair := CallbackPair{
+ CbKey: tid,
+ CbEntry: CallbackPairEntry{rxChan, oo.receiveOmciResponse, true},
+ }
+ err = oo.Send(ctx, pkt, timeout, CDefaultRetries, highPrio, omciRxCallbackPair)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot send 1PMapper set", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+ logger.Debug(ctx, "send 1PMapper-set msg done")
+ return meInstance, nil
+ }
+ logger.Errorw(ctx, "Cannot generate 1PMapper Instance", log.Fields{
+ "Err": omciErr.GetError(), "device-id": oo.deviceID})
+ return nil, omciErr.GetError()
+}
+
+// SendCreateVtfdVar creates VlanTaggingFilterData ME instance
+func (oo *OmciCC) SendCreateVtfdVar(ctx context.Context, timeout int, highPrio bool,
+ rxChan chan Message, params ...me.ParamData) (*me.ManagedEntity, error) {
+ tid := oo.GetNextTid(highPrio)
+ logger.Debugw(ctx, "send VTFD-Create-msg:", log.Fields{"device-id": oo.deviceID,
+ "SequNo": strconv.FormatInt(int64(tid), 16),
+ "InstId": strconv.FormatInt(int64(params[0].EntityID), 16)})
+
+ meInstance, omciErr := me.NewVlanTaggingFilterData(params[0])
+ if omciErr.GetError() == nil {
+ //all SetByCreate Parameters (assumed to be) set here, for optimisation no 'AddDefaults'
+ omciLayer, msgLayer, err := omci.EncodeFrame(meInstance, omci.CreateRequestType,
+ omci.TransactionID(tid))
+ if err != nil {
+ logger.Errorw(ctx, "Cannot encode VTFD for create", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ //TODO!!: refactoring improvement requested, here as an example for [VOL-3457]:
+ // return (dual format) error code that can be used at caller for immediate error treatment
+ // (relevant to all used sendXX() methods and their error conditions)
+ return nil, err
+ }
+
+ pkt, err := serializeOmciLayer(ctx, omciLayer, msgLayer)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot serialize VTFD create", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+
+ omciRxCallbackPair := CallbackPair{
+ CbKey: tid,
+ CbEntry: CallbackPairEntry{rxChan, oo.receiveOmciResponse, true},
+ }
+ err = oo.Send(ctx, pkt, timeout, CDefaultRetries, highPrio, omciRxCallbackPair)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot send VTFD create", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+ logger.Debug(ctx, "send VTFD-Create-msg done")
+ return meInstance, nil
+ }
+ logger.Errorw(ctx, "Cannot generate VTFD Instance", log.Fields{
+ "Err": omciErr.GetError(), "device-id": oo.deviceID})
+ return nil, omciErr.GetError()
+}
+
+// nolint: unused
+func (oo *OmciCC) sendSetVtfdVar(ctx context.Context, timeout int, highPrio bool,
+ rxChan chan Message, params ...me.ParamData) (*me.ManagedEntity, error) {
+ tid := oo.GetNextTid(highPrio)
+ logger.Debugw(ctx, "send VTFD-Set-msg:", log.Fields{"device-id": oo.deviceID,
+ "SequNo": strconv.FormatInt(int64(tid), 16),
+ "InstId": strconv.FormatInt(int64(params[0].EntityID), 16)})
+
+ meInstance, omciErr := me.NewVlanTaggingFilterData(params[0])
+ if omciErr.GetError() == nil {
+ omciLayer, msgLayer, err := omci.EncodeFrame(meInstance, omci.SetRequestType,
+ omci.TransactionID(tid))
+ if err != nil {
+ logger.Errorw(ctx, "Cannot encode VTFD for set", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ //TODO!!: refactoring improvement requested, here as an example for [VOL-3457]:
+ // return (dual format) error code that can be used at caller for immediate error treatment
+ // (relevant to all used sendXX() methods and their error conditions)
+ return nil, err
+ }
+
+ pkt, err := serializeOmciLayer(ctx, omciLayer, msgLayer)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot serialize VTFD set", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+
+ omciRxCallbackPair := CallbackPair{
+ CbKey: tid,
+ CbEntry: CallbackPairEntry{rxChan, oo.receiveOmciResponse, true},
+ }
+ err = oo.Send(ctx, pkt, timeout, CDefaultRetries, highPrio, omciRxCallbackPair)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot send VTFD set", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+ logger.Debug(ctx, "send VTFD-Set-msg done")
+ return meInstance, nil
+ }
+ logger.Errorw(ctx, "Cannot generate VTFD Instance", log.Fields{
+ "Err": omciErr.GetError(), "device-id": oo.deviceID})
+ return nil, omciErr.GetError()
+}
+
+// SendCreateEvtocdVar creates ExtendedVlanTaggingOperationConfigurationData ME instance
+func (oo *OmciCC) SendCreateEvtocdVar(ctx context.Context, timeout int, highPrio bool,
+ rxChan chan Message, params ...me.ParamData) (*me.ManagedEntity, error) {
+ tid := oo.GetNextTid(highPrio)
+ logger.Debugw(ctx, "send EVTOCD-Create-msg:", log.Fields{"device-id": oo.deviceID,
+ "SequNo": strconv.FormatInt(int64(tid), 16),
+ "InstId": strconv.FormatInt(int64(params[0].EntityID), 16)})
+
+ meInstance, omciErr := me.NewExtendedVlanTaggingOperationConfigurationData(params[0])
+ if omciErr.GetError() == nil {
+ omciLayer, msgLayer, err := omci.EncodeFrame(meInstance, omci.CreateRequestType, omci.TransactionID(tid))
+ if err != nil {
+ logger.Errorw(ctx, "Cannot encode EVTOCD for create", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+
+ pkt, err := serializeOmciLayer(ctx, omciLayer, msgLayer)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot serialize EVTOCD create", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+
+ omciRxCallbackPair := CallbackPair{
+ CbKey: tid,
+ CbEntry: CallbackPairEntry{rxChan, oo.receiveOmciResponse, true},
+ }
+ err = oo.Send(ctx, pkt, timeout, CDefaultRetries, highPrio, omciRxCallbackPair)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot send EVTOCD create", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+ logger.Debug(ctx, "send EVTOCD-set msg done")
+ return meInstance, nil
+ }
+ logger.Errorw(ctx, "Cannot generate EVTOCD Instance", log.Fields{
+ "Err": omciErr.GetError(), "device-id": oo.deviceID})
+ return nil, omciErr.GetError()
+}
+
+// SendSetEvtocdVar sets ExtendedVlanTaggingOperationConfigurationData ME instance
+func (oo *OmciCC) SendSetEvtocdVar(ctx context.Context, timeout int, highPrio bool,
+ rxChan chan Message, params ...me.ParamData) (*me.ManagedEntity, error) {
+ tid := oo.GetNextTid(highPrio)
+ logger.Debugw(ctx, "send EVTOCD-Set-msg:", log.Fields{"device-id": oo.deviceID,
+ "SequNo": strconv.FormatInt(int64(tid), 16),
+ "InstId": strconv.FormatInt(int64(params[0].EntityID), 16)})
+
+ meInstance, omciErr := me.NewExtendedVlanTaggingOperationConfigurationData(params[0])
+ if omciErr.GetError() == nil {
+ omciLayer, msgLayer, err := omci.EncodeFrame(meInstance, omci.SetRequestType, omci.TransactionID(tid))
+ if err != nil {
+ logger.Errorw(ctx, "Cannot encode EVTOCD for set", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+
+ pkt, err := serializeOmciLayer(ctx, omciLayer, msgLayer)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot serialize EVTOCD set", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+
+ omciRxCallbackPair := CallbackPair{
+ CbKey: tid,
+ CbEntry: CallbackPairEntry{rxChan, oo.receiveOmciResponse, true},
+ }
+ err = oo.Send(ctx, pkt, timeout, CDefaultRetries, highPrio, omciRxCallbackPair)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot send EVTOCD set", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+ logger.Debug(ctx, "send EVTOCD-set msg done")
+ return meInstance, nil
+ }
+ logger.Errorw(ctx, "Cannot generate EVTOCD Instance", log.Fields{
+ "Err": omciErr.GetError(), "device-id": oo.deviceID})
+ return nil, omciErr.GetError()
+}
+
+// SendDeleteEvtocd deletes ExtendedVlanTaggingOperationConfigurationData ME instance
+func (oo *OmciCC) SendDeleteEvtocd(ctx context.Context, timeout int, highPrio bool,
+ rxChan chan Message, params ...me.ParamData) (*me.ManagedEntity, error) {
+ tid := oo.GetNextTid(highPrio)
+ logger.Debugw(ctx, "send EVTOCD-Delete-msg:", log.Fields{"device-id": oo.deviceID,
+ "SequNo": strconv.FormatInt(int64(tid), 16),
+ "InstId": strconv.FormatInt(int64(params[0].EntityID), 16)})
+
+ meInstance, omciErr := me.NewExtendedVlanTaggingOperationConfigurationData(params[0])
+ if omciErr.GetError() == nil {
+ omciLayer, msgLayer, err := omci.EncodeFrame(meInstance, omci.DeleteRequestType, omci.TransactionID(tid))
+ if err != nil {
+ logger.Errorw(ctx, "Cannot encode EVTOCD for delete", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+
+ pkt, err := serializeOmciLayer(ctx, omciLayer, msgLayer)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot serialize EVTOCD delete", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+
+ omciRxCallbackPair := CallbackPair{
+ CbKey: tid,
+ CbEntry: CallbackPairEntry{rxChan, oo.receiveOmciResponse, true},
+ }
+ err = oo.Send(ctx, pkt, timeout, CDefaultRetries, highPrio, omciRxCallbackPair)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot send EVTOCD delete", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+ logger.Debug(ctx, "send EVTOCD-delete msg done")
+ return meInstance, nil
+ }
+ logger.Errorw(ctx, "Cannot generate EVTOCD Instance", log.Fields{
+ "Err": omciErr.GetError(), "device-id": oo.deviceID})
+ return nil, omciErr.GetError()
+}
+
+// SendDeleteVtfd deletes VlanTaggingFilterData ME instance
+func (oo *OmciCC) SendDeleteVtfd(ctx context.Context, timeout int, highPrio bool,
+ rxChan chan Message, aInstID uint16) (*me.ManagedEntity, error) {
+ tid := oo.GetNextTid(highPrio)
+ logger.Debugw(ctx, "send VTFD-Delete-msg:", log.Fields{"device-id": oo.deviceID,
+ "SequNo": strconv.FormatInt(int64(tid), 16),
+ "InstId": strconv.FormatInt(int64(aInstID), 16)})
+
+ meParams := me.ParamData{EntityID: aInstID}
+ meInstance, omciErr := me.NewVlanTaggingFilterData(meParams)
+ if omciErr.GetError() == nil {
+ omciLayer, msgLayer, err := omci.EncodeFrame(meInstance, omci.DeleteRequestType,
+ omci.TransactionID(tid))
+ if err != nil {
+ logger.Errorw(ctx, "Cannot encode VTFD for delete", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ //TODO!!: refactoring improvement requested, here as an example for [VOL-3457]:
+ // return (dual format) error code that can be used at caller for immediate error treatment
+ // (relevant to all used sendXX() methods and their error conditions)
+ return nil, err
+ }
+
+ pkt, err := serializeOmciLayer(ctx, omciLayer, msgLayer)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot serialize VTFD delete", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+
+ omciRxCallbackPair := CallbackPair{
+ CbKey: tid,
+ CbEntry: CallbackPairEntry{rxChan, oo.receiveOmciResponse, true},
+ }
+ err = oo.Send(ctx, pkt, timeout, CDefaultRetries, highPrio, omciRxCallbackPair)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot send VTFD delete", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+ logger.Debug(ctx, "send VTFD-Delete-msg done")
+ return meInstance, nil
+ }
+ logger.Errorw(ctx, "Cannot generate VTFD Instance for delete", log.Fields{
+ "Err": omciErr.GetError(), "device-id": oo.deviceID})
+ return nil, omciErr.GetError()
+}
+
+// SendCreateTDVar creates TrafficDescriptor ME instance
+func (oo *OmciCC) SendCreateTDVar(ctx context.Context, timeout int, highPrio bool, rxChan chan Message, params ...me.ParamData) (*me.ManagedEntity, error) {
+ tid := oo.GetNextTid(highPrio)
+ logger.Debugw(ctx, "send TD-Create-msg:", log.Fields{"device-id": oo.deviceID,
+ "SequNo": strconv.FormatInt(int64(tid), 16),
+ "InstId": strconv.FormatInt(int64(params[0].EntityID), 16)})
+ meInstance, omciErr := me.NewTrafficDescriptor(params[0])
+ if omciErr.GetError() == nil {
+ omciLayer, msgLayer, err := omci.EncodeFrame(meInstance, omci.CreateRequestType, omci.TransactionID(tid))
+ if err != nil {
+ logger.Errorw(ctx, "Cannot encode TD for create", log.Fields{"Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+ pkt, err := serializeOmciLayer(ctx, omciLayer, msgLayer)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot serialize TD create", log.Fields{"Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+ omciRxCallbackPair := CallbackPair{
+ CbKey: tid,
+ CbEntry: CallbackPairEntry{rxChan, oo.receiveOmciResponse, true},
+ }
+ err = oo.Send(ctx, pkt, timeout, CDefaultRetries, highPrio, omciRxCallbackPair)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot send TD create", log.Fields{"Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+ logger.Debug(ctx, "send TD-Create-msg done")
+ return meInstance, nil
+ }
+ logger.Errorw(ctx, "Cannot generate TD Instance", log.Fields{"Err": omciErr.GetError(), "device-id": oo.deviceID})
+ return nil, omciErr.GetError()
+}
+
+// nolint: unused
+func (oo *OmciCC) sendSetTDVar(ctx context.Context, timeout int, highPrio bool,
+ rxChan chan Message, params ...me.ParamData) (*me.ManagedEntity, error) {
+ tid := oo.GetNextTid(highPrio)
+ logger.Debugw(ctx, "send TD-Set-msg:", log.Fields{"device-id": oo.deviceID,
+ "SequNo": strconv.FormatInt(int64(tid), 16),
+ "InstId": strconv.FormatInt(int64(params[0].EntityID), 16)})
+
+ meInstance, omciErr := me.NewTrafficDescriptor(params[0])
+ if omciErr.GetError() == nil {
+ omciLayer, msgLayer, err := omci.EncodeFrame(meInstance, omci.SetRequestType, omci.TransactionID(tid))
+ if err != nil {
+ logger.Errorw(ctx, "Cannot encode TD for set", log.Fields{"Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+ pkt, err := serializeOmciLayer(ctx, omciLayer, msgLayer)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot serialize TD set", log.Fields{"Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+ omciRxCallbackPair := CallbackPair{
+ CbKey: tid,
+ CbEntry: CallbackPairEntry{rxChan, oo.receiveOmciResponse, true},
+ }
+ err = oo.Send(ctx, pkt, timeout, CDefaultRetries, highPrio, omciRxCallbackPair)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot send TD set", log.Fields{"Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+ logger.Debug(ctx, "send TD-Set-msg done")
+ return meInstance, nil
+ }
+ logger.Errorw(ctx, "Cannot generate TD Instance", log.Fields{"Err": omciErr.GetError(), "device-id": oo.deviceID})
+ return nil, omciErr.GetError()
+
+}
+
+// SendDeleteTD - TODO: add comment
+func (oo *OmciCC) SendDeleteTD(ctx context.Context, timeout int, highPrio bool,
+ rxChan chan Message, aInstID uint16) (*me.ManagedEntity, error) {
+ tid := oo.GetNextTid(highPrio)
+ logger.Debugw(ctx, "send TD-Delete-msg:", log.Fields{"device-id": oo.deviceID,
+ "SequNo": strconv.FormatInt(int64(tid), 16),
+ "InstId": strconv.FormatInt(int64(aInstID), 16)})
+
+ meParams := me.ParamData{EntityID: aInstID}
+ meInstance, omciErr := me.NewTrafficDescriptor(meParams)
+ if omciErr.GetError() == nil {
+ omciLayer, msgLayer, err := omci.EncodeFrame(meInstance, omci.DeleteRequestType, omci.TransactionID(tid))
+ if err != nil {
+ logger.Errorw(ctx, "Cannot encode TD for delete", log.Fields{"Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+ pkt, err := serializeOmciLayer(ctx, omciLayer, msgLayer)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot serialize TD delete", log.Fields{"Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+ omciRxCallbackPair := CallbackPair{
+ CbKey: tid,
+ CbEntry: CallbackPairEntry{rxChan, oo.receiveOmciResponse, true},
+ }
+ err = oo.Send(ctx, pkt, timeout, CDefaultRetries, highPrio, omciRxCallbackPair)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot send TD delete", log.Fields{"Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+ logger.Debug(ctx, "send TD-Delete-msg done")
+ return meInstance, nil
+ }
+ logger.Errorw(ctx, "Cannot generate TD Instance", log.Fields{"Err": omciErr.GetError(), "device-id": oo.deviceID})
+ return nil, omciErr.GetError()
+
+}
+
+// SendDeleteGemIWTP deletes GemInterworkingTerminationPoint ME instance
+func (oo *OmciCC) SendDeleteGemIWTP(ctx context.Context, timeout int, highPrio bool,
+ rxChan chan Message, aInstID uint16) (*me.ManagedEntity, error) {
+ tid := oo.GetNextTid(highPrio)
+ logger.Debugw(ctx, "send GemIwTp-Delete-msg:", log.Fields{"device-id": oo.deviceID,
+ "SequNo": strconv.FormatInt(int64(tid), 16),
+ "InstId": strconv.FormatInt(int64(aInstID), 16)})
+
+ meParams := me.ParamData{EntityID: aInstID}
+ meInstance, omciErr := me.NewGemInterworkingTerminationPoint(meParams)
+ if omciErr.GetError() == nil {
+ omciLayer, msgLayer, err := omci.EncodeFrame(meInstance, omci.DeleteRequestType,
+ omci.TransactionID(tid))
+ if err != nil {
+ logger.Errorw(ctx, "Cannot encode GemIwTp for delete", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ //TODO!!: refactoring improvement requested, here as an example for [VOL-3457]:
+ // return (dual format) error code that can be used at caller for immediate error treatment
+ // (relevant to all used sendXX() methods and their error conditions)
+ return nil, err
+ }
+
+ pkt, err := serializeOmciLayer(ctx, omciLayer, msgLayer)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot serialize GemIwTp delete", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+
+ omciRxCallbackPair := CallbackPair{
+ CbKey: tid,
+ CbEntry: CallbackPairEntry{rxChan, oo.receiveOmciResponse, true},
+ }
+ err = oo.Send(ctx, pkt, timeout, CDefaultRetries, highPrio, omciRxCallbackPair)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot send GemIwTp delete", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+ logger.Debug(ctx, "send GemIwTp-Delete-msg done")
+ return meInstance, nil
+ }
+ logger.Errorw(ctx, "Cannot generate GemIwTp Instance for delete", log.Fields{
+ "Err": omciErr.GetError(), "device-id": oo.deviceID})
+ return nil, omciErr.GetError()
+}
+
+// SendDeleteGemNCTP deletes GemPortNetworkCtp ME instance
+func (oo *OmciCC) SendDeleteGemNCTP(ctx context.Context, timeout int, highPrio bool,
+ rxChan chan Message, aInstID uint16) (*me.ManagedEntity, error) {
+ tid := oo.GetNextTid(highPrio)
+ logger.Debugw(ctx, "send GemNCtp-Delete-msg:", log.Fields{"device-id": oo.deviceID,
+ "SequNo": strconv.FormatInt(int64(tid), 16),
+ "InstId": strconv.FormatInt(int64(aInstID), 16)})
+
+ meParams := me.ParamData{EntityID: aInstID}
+ meInstance, omciErr := me.NewGemPortNetworkCtp(meParams)
+ if omciErr.GetError() == nil {
+ omciLayer, msgLayer, err := omci.EncodeFrame(meInstance, omci.DeleteRequestType,
+ omci.TransactionID(tid))
+ if err != nil {
+ logger.Errorw(ctx, "Cannot encode GemNCtp for delete", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ //TODO!!: refactoring improvement requested, here as an example for [VOL-3457]:
+ // return (dual format) error code that can be used at caller for immediate error treatment
+ // (relevant to all used sendXX() methods and their error conditions)
+ return nil, err
+ }
+
+ pkt, err := serializeOmciLayer(ctx, omciLayer, msgLayer)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot serialize GemNCtp delete", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+
+ omciRxCallbackPair := CallbackPair{
+ CbKey: tid,
+ CbEntry: CallbackPairEntry{rxChan, oo.receiveOmciResponse, true},
+ }
+ err = oo.Send(ctx, pkt, timeout, CDefaultRetries, highPrio, omciRxCallbackPair)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot send GemNCtp delete", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+ logger.Debug(ctx, "send GemNCtp-Delete-msg done")
+ return meInstance, nil
+ }
+ logger.Errorw(ctx, "Cannot generate GemNCtp Instance for delete", log.Fields{
+ "Err": omciErr.GetError(), "device-id": oo.deviceID})
+ return nil, omciErr.GetError()
+}
+
+// SendDeleteDot1PMapper deletes Ieee8021PMapperServiceProfile ME instance
+func (oo *OmciCC) SendDeleteDot1PMapper(ctx context.Context, timeout int, highPrio bool,
+ rxChan chan Message, aInstID uint16) (*me.ManagedEntity, error) {
+ tid := oo.GetNextTid(highPrio)
+ logger.Debugw(ctx, "send .1pMapper-Delete-msg:", log.Fields{"device-id": oo.deviceID,
+ "SequNo": strconv.FormatInt(int64(tid), 16),
+ "InstId": strconv.FormatInt(int64(aInstID), 16)})
+
+ meParams := me.ParamData{EntityID: aInstID}
+ meInstance, omciErr := me.NewIeee8021PMapperServiceProfile(meParams)
+ if omciErr.GetError() == nil {
+ omciLayer, msgLayer, err := omci.EncodeFrame(meInstance, omci.DeleteRequestType,
+ omci.TransactionID(tid))
+ if err != nil {
+ logger.Errorw(ctx, "Cannot encode .1pMapper for delete", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ //TODO!!: refactoring improvement requested, here as an example for [VOL-3457]:
+ // return (dual format) error code that can be used at caller for immediate error treatment
+ // (relevant to all used sendXX() methods and their error conditions)
+ return nil, err
+ }
+
+ pkt, err := serializeOmciLayer(ctx, omciLayer, msgLayer)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot serialize .1pMapper delete", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+
+ omciRxCallbackPair := CallbackPair{
+ CbKey: tid,
+ CbEntry: CallbackPairEntry{rxChan, oo.receiveOmciResponse, true},
+ }
+ err = oo.Send(ctx, pkt, timeout, CDefaultRetries, highPrio, omciRxCallbackPair)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot send .1pMapper delete", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+ logger.Debug(ctx, "send .1pMapper-Delete-msg done")
+ return meInstance, nil
+ }
+ logger.Errorw(ctx, "Cannot generate .1pMapper Instance for delete", log.Fields{
+ "Err": omciErr.GetError(), "device-id": oo.deviceID})
+ return nil, omciErr.GetError()
+}
+
+// SendDeleteMBPConfigData deletes MacBridgePortConfigurationData ME instance
+func (oo *OmciCC) SendDeleteMBPConfigData(ctx context.Context, timeout int, highPrio bool,
+ rxChan chan Message, aInstID uint16) (*me.ManagedEntity, error) {
+ tid := oo.GetNextTid(highPrio)
+ logger.Debugw(ctx, "send MBPCD-Delete-msg:", log.Fields{"device-id": oo.deviceID,
+ "SequNo": strconv.FormatInt(int64(tid), 16),
+ "InstId": strconv.FormatInt(int64(aInstID), 16)})
+
+ meParams := me.ParamData{EntityID: aInstID}
+ meInstance, omciErr := me.NewMacBridgePortConfigurationData(meParams)
+ if omciErr.GetError() == nil {
+ omciLayer, msgLayer, err := omci.EncodeFrame(meInstance, omci.DeleteRequestType,
+ omci.TransactionID(tid))
+ if err != nil {
+ logger.Errorw(ctx, "Cannot encode MBPCD for delete", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ //TODO!!: refactoring improvement requested, here as an example for [VOL-3457]:
+ // return (dual format) error code that can be used at caller for immediate error treatment
+ // (relevant to all used sendXX() methods and their error conditions)
+ return nil, err
+ }
+
+ pkt, err := serializeOmciLayer(ctx, omciLayer, msgLayer)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot serialize MBPCD delete", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+
+ omciRxCallbackPair := CallbackPair{
+ CbKey: tid,
+ CbEntry: CallbackPairEntry{rxChan, oo.receiveOmciResponse, true},
+ }
+ err = oo.Send(ctx, pkt, timeout, CDefaultRetries, highPrio, omciRxCallbackPair)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot send MBPCD delete", log.Fields{
+ "Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+ logger.Debug(ctx, "send MBPCD-Delete-msg done")
+ return meInstance, nil
+ }
+ logger.Errorw(ctx, "Cannot generate MBPCD Instance for delete", log.Fields{
+ "Err": omciErr.GetError(), "device-id": oo.deviceID})
+ return nil, omciErr.GetError()
+}
+
+// SendCreateMulticastGemIWTPVar creates MulticastGemInterworkingTerminationPoint ME instance
+func (oo *OmciCC) SendCreateMulticastGemIWTPVar(ctx context.Context, timeout int, highPrio bool,
+ rxChan chan Message, params ...me.ParamData) (*me.ManagedEntity, error) {
+ tid := oo.GetNextTid(highPrio)
+ logger.Debugw(ctx, "send MulticastGemIWTP-create-msg:", log.Fields{"device-id": oo.deviceID,
+ "SequNo": strconv.FormatInt(int64(tid), 16),
+ "InstId": strconv.FormatInt(int64(params[0].EntityID), 16)})
+
+ meInstance, omciErr := me.NewMulticastGemInterworkingTerminationPoint(params[0])
+ if omciErr.GetError() == nil {
+ omciLayer, msgLayer, err := omci.EncodeFrame(meInstance, omci.CreateRequestType, omci.TransactionID(tid),
+ omci.AddDefaults(true))
+ if err != nil {
+ logger.Errorw(ctx, "Cannot encode MulticastGEMIWTP for create", log.Fields{"Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+
+ pkt, err := serializeOmciLayer(ctx, omciLayer, msgLayer)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot serialize MulticastGEMIWTP create", log.Fields{"Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+
+ omciRxCallbackPair := CallbackPair{CbKey: tid,
+ CbEntry: CallbackPairEntry{rxChan, oo.receiveOmciResponse, true},
+ }
+ err = oo.Send(ctx, pkt, timeout, CDefaultRetries, highPrio, omciRxCallbackPair)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot send MulticastGEMIWTP create", log.Fields{"Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+ logger.Debug(ctx, "send MulticastGEMIWTP-create-msg done")
+ return meInstance, nil
+ }
+ logger.Errorw(ctx, "Cannot generate MulticastGEMIWTP Instance", log.Fields{"Err": omciErr.GetError(),
+ "device-id": oo.deviceID})
+ return nil, omciErr.GetError()
+}
+
+// SendSetMulticastGemIWTPVar sets MulticastGemInterworkingTerminationPoint ME instance
+func (oo *OmciCC) SendSetMulticastGemIWTPVar(ctx context.Context, timeout int, highPrio bool,
+ rxChan chan Message, params ...me.ParamData) (*me.ManagedEntity, error) {
+ tid := oo.GetNextTid(highPrio)
+ logger.Debugw(ctx, "send MulticastGemIWTP-set-msg:", log.Fields{"device-id": oo.deviceID,
+ "SequNo": strconv.FormatInt(int64(tid), 16),
+ "InstId": strconv.FormatInt(int64(params[0].EntityID), 16)})
+
+ meInstance, omciErr := me.NewMulticastGemInterworkingTerminationPoint(params[0])
+ if omciErr.GetError() == nil {
+ omciLayer, msgLayer, err := omci.EncodeFrame(meInstance, omci.SetRequestType, omci.TransactionID(tid),
+ omci.AddDefaults(true))
+ if err != nil {
+ logger.Errorw(ctx, "Cannot encode MulticastGEMIWTP for set", log.Fields{"Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+
+ pkt, err := serializeOmciLayer(ctx, omciLayer, msgLayer)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot serialize MulticastGEMIWTP create", log.Fields{"Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+
+ omciRxCallbackPair := CallbackPair{CbKey: tid,
+ CbEntry: CallbackPairEntry{rxChan, oo.receiveOmciResponse, true},
+ }
+ err = oo.Send(ctx, pkt, timeout, CDefaultRetries, highPrio, omciRxCallbackPair)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot send MulticastGEMIWTP set", log.Fields{"Err": err, "device-id": oo.deviceID})
+ return nil, err
+ }
+ logger.Debug(ctx, "send MulticastGEMIWTP-set-msg done")
+ return meInstance, nil
+ }
+ logger.Errorw(ctx, "Cannot generate MulticastGEMIWTP Instance", log.Fields{"Err": omciErr.GetError(),
+ "device-id": oo.deviceID})
+ return nil, omciErr.GetError()
+}
+
+// SendCreateMulticastOperationProfileVar creates MulticastOperationsProfile ME instance
+func (oo *OmciCC) SendCreateMulticastOperationProfileVar(ctx context.Context, timeout int, highPrio bool,
+ rxChan chan Message, params ...me.ParamData) (*me.ManagedEntity, error) {
+ tid := oo.GetNextTid(highPrio)
+ logger.Debugw(ctx, "send MulticastOperationProfile-create-msg:", log.Fields{"device-id": oo.deviceID,
+ "SequNo": strconv.FormatInt(int64(tid), 16),
+ "InstId": strconv.FormatInt(int64(params[0].EntityID), 16)})
+
+ meInstance, omciErr := me.NewMulticastOperationsProfile(params[0])
+ if omciErr.GetError() == nil {
+ omciLayer, msgLayer, err := omci.EncodeFrame(meInstance, omci.CreateRequestType, omci.TransactionID(tid),
+ omci.AddDefaults(true))
+ if err != nil {
+ logger.Errorw(ctx, "Cannot encode MulticastOperationProfile for create", log.Fields{"Err": err,
+ "device-id": oo.deviceID})
+ return nil, err
+ }
+
+ pkt, err := serializeOmciLayer(ctx, omciLayer, msgLayer)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot serialize MulticastOperationProfile create", log.Fields{"Err": err,
+ "device-id": oo.deviceID})
+ return nil, err
+ }
+
+ omciRxCallbackPair := CallbackPair{CbKey: tid,
+ CbEntry: CallbackPairEntry{rxChan, oo.receiveOmciResponse, true},
+ }
+ err = oo.Send(ctx, pkt, timeout, CDefaultRetries, highPrio, omciRxCallbackPair)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot send MulticastOperationProfile create", log.Fields{"Err": err,
+ "device-id": oo.deviceID})
+ return nil, err
+ }
+ logger.Debug(ctx, "send MulticastOperationProfile-create-msg done")
+ return meInstance, nil
+ }
+ logger.Errorw(ctx, "Cannot generate MulticastOperationProfile Instance", log.Fields{"Err": omciErr.GetError(),
+ "device-id": oo.deviceID})
+ return nil, omciErr.GetError()
+}
+
+// SendSetMulticastOperationProfileVar sets MulticastOperationsProfile ME instance
+func (oo *OmciCC) SendSetMulticastOperationProfileVar(ctx context.Context, timeout int, highPrio bool,
+ rxChan chan Message, params ...me.ParamData) (*me.ManagedEntity, error) {
+ tid := oo.GetNextTid(highPrio)
+ logger.Debugw(ctx, "send MulticastOperationProfile-create-msg:", log.Fields{"device-id": oo.deviceID,
+ "SequNo": strconv.FormatInt(int64(tid), 16),
+ "InstId": strconv.FormatInt(int64(params[0].EntityID), 16)})
+
+ meInstance, omciErr := me.NewMulticastOperationsProfile(params[0])
+ if omciErr.GetError() == nil {
+ omciLayer, msgLayer, err := omci.EncodeFrame(meInstance, omci.SetRequestType, omci.TransactionID(tid),
+ omci.AddDefaults(true))
+ if err != nil {
+ logger.Errorw(ctx, "Cannot encode MulticastOperationProfile for create", log.Fields{"Err": err,
+ "device-id": oo.deviceID})
+ return nil, err
+ }
+
+ pkt, err := serializeOmciLayer(ctx, omciLayer, msgLayer)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot serialize MulticastOperationProfile create", log.Fields{"Err": err,
+ "device-id": oo.deviceID})
+ return nil, err
+ }
+
+ omciRxCallbackPair := CallbackPair{CbKey: tid,
+ CbEntry: CallbackPairEntry{rxChan, oo.receiveOmciResponse, true},
+ }
+ err = oo.Send(ctx, pkt, timeout, CDefaultRetries, highPrio, omciRxCallbackPair)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot send MulticastOperationProfile create", log.Fields{"Err": err,
+ "device-id": oo.deviceID})
+ return nil, err
+ }
+ logger.Debug(ctx, "send MulticastOperationProfile-create-msg done")
+ return meInstance, nil
+ }
+ logger.Errorw(ctx, "Cannot generate MulticastOperationProfile Instance", log.Fields{"Err": omciErr.GetError(),
+ "device-id": oo.deviceID})
+ return nil, omciErr.GetError()
+}
+
+// SendCreateMulticastSubConfigInfoVar creates MulticastSubscriberConfigInfo ME instance
+func (oo *OmciCC) SendCreateMulticastSubConfigInfoVar(ctx context.Context, timeout int, highPrio bool,
+ rxChan chan Message, params ...me.ParamData) (*me.ManagedEntity, error) {
+ tid := oo.GetNextTid(highPrio)
+ logger.Debugw(ctx, "send MulticastSubConfigInfo-create-msg:", log.Fields{"device-id": oo.deviceID,
+ "SequNo": strconv.FormatInt(int64(tid), 16),
+ "InstId": strconv.FormatInt(int64(params[0].EntityID), 16)})
+
+ meInstance, omciErr := me.NewMulticastSubscriberConfigInfo(params[0])
+ if omciErr.GetError() == nil {
+ omciLayer, msgLayer, err := omci.EncodeFrame(meInstance, omci.CreateRequestType, omci.TransactionID(tid),
+ omci.AddDefaults(true))
+ if err != nil {
+ logger.Errorw(ctx, "Cannot encode MulticastSubConfigInfo for create", log.Fields{"Err": err,
+ "device-id": oo.deviceID})
+ return nil, err
+ }
+
+ pkt, err := serializeOmciLayer(ctx, omciLayer, msgLayer)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot serialize MulticastSubConfigInfo create", log.Fields{"Err": err,
+ "device-id": oo.deviceID})
+ return nil, err
+ }
+
+ omciRxCallbackPair := CallbackPair{CbKey: tid,
+ CbEntry: CallbackPairEntry{rxChan, oo.receiveOmciResponse, true},
+ }
+ err = oo.Send(ctx, pkt, timeout, CDefaultRetries, highPrio, omciRxCallbackPair)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot send MulticastSubConfigInfo create", log.Fields{"Err": err,
+ "device-id": oo.deviceID})
+ return nil, err
+ }
+ logger.Debug(ctx, "send MulticastSubConfigInfo-create-msg done")
+ return meInstance, nil
+ }
+ logger.Errorw(ctx, "Cannot generate MulticastSubConfigInfo Instance", log.Fields{"Err": omciErr.GetError(),
+ "device-id": oo.deviceID})
+ return nil, omciErr.GetError()
+}
+
+// SendSyncTime sends SynchronizeTimeRequest
+func (oo *OmciCC) SendSyncTime(ctx context.Context, timeout int, highPrio bool, rxChan chan Message) error {
+ tid := oo.GetNextTid(highPrio)
+ logger.Debugw(ctx, "send synchronize time request:", log.Fields{"device-id": oo.deviceID,
+ "SequNo": strconv.FormatInt(int64(tid), 16)})
+
+ omciLayer := &omci.OMCI{
+ TransactionID: tid,
+ MessageType: omci.SynchronizeTimeRequestType,
+ // DeviceIdentifier: omci.BaselineIdent, // Optional, defaults to Baseline
+ // Length: 0x28, // Optional, defaults to 40 octets
+ }
+ utcTime := time.Now().UTC()
+ request := &omci.SynchronizeTimeRequest{
+ MeBasePacket: omci.MeBasePacket{
+ EntityClass: me.OnuGClassID,
+ // Default Instance ID is 0
+ },
+ Year: uint16(utcTime.Year()),
+ Month: uint8(utcTime.Month()),
+ Day: uint8(utcTime.Day()),
+ Hour: uint8(utcTime.Hour()),
+ Minute: uint8(utcTime.Minute()),
+ Second: uint8(utcTime.Second()),
+ }
+
+ pkt, err := serializeOmciLayer(ctx, omciLayer, request)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot serialize synchronize time request", log.Fields{"Err": err,
+ "device-id": oo.deviceID})
+ return err
+ }
+
+ omciRxCallbackPair := CallbackPair{CbKey: tid,
+ CbEntry: CallbackPairEntry{rxChan, oo.receiveOmciResponse, true},
+ }
+ err = oo.Send(ctx, pkt, timeout, CDefaultRetries, highPrio, omciRxCallbackPair)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot send synchronize time request", log.Fields{"Err": err,
+ "device-id": oo.deviceID})
+ return err
+ }
+ logger.Debug(ctx, "send synchronize time request done")
+ return nil
+}
+
+// SendCreateOrDeleteEthernetPerformanceMonitoringHistoryME creates or deletes EthernetFramePerformanceMonitoringHistoryData ME instance
+func (oo *OmciCC) SendCreateOrDeleteEthernetPerformanceMonitoringHistoryME(ctx context.Context, timeout int, highPrio bool,
+ upstream bool, create bool, rxChan chan Message, entityID uint16) (*me.ManagedEntity, error) {
+ tid := oo.GetNextTid(highPrio)
+ logger.Debugw(ctx, "send ethernet-performance-monitoring-history-me-msg:", log.Fields{"device-id": oo.deviceID,
+ "SequNo": strconv.FormatInt(int64(tid), 16), "InstId": strconv.FormatInt(int64(entityID), 16), "create": create, "upstream": upstream})
+ meParam := me.ParamData{EntityID: entityID}
+ var meInstance *me.ManagedEntity
+ var omciErr me.OmciErrors
+ if upstream {
+ meInstance, omciErr = me.NewEthernetFramePerformanceMonitoringHistoryDataUpstream(meParam)
+ } else {
+ meInstance, omciErr = me.NewEthernetFramePerformanceMonitoringHistoryDataDownstream(meParam)
+ }
+ if omciErr.GetError() == nil {
+ var omciLayer *omci.OMCI
+ var msgLayer gopacket.SerializableLayer
+ var err error
+ if create {
+ omciLayer, msgLayer, err = omci.EncodeFrame(meInstance, omci.CreateRequestType, omci.TransactionID(tid),
+ omci.AddDefaults(true))
+ } else {
+ omciLayer, msgLayer, err = omci.EncodeFrame(meInstance, omci.DeleteRequestType, omci.TransactionID(tid),
+ omci.AddDefaults(true))
+ }
+ if err != nil {
+ logger.Errorw(ctx, "Cannot encode ethernet frame performance monitoring history data ME",
+ log.Fields{"Err": err, "device-id": oo.deviceID, "upstream": upstream, "create": create, "InstId": strconv.FormatInt(int64(entityID), 16)})
+ return nil, err
+ }
+
+ pkt, err := serializeOmciLayer(ctx, omciLayer, msgLayer)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot serialize ethernet frame performance monitoring history data ME",
+ log.Fields{"Err": err, "device-id": oo.deviceID, "upstream": upstream, "create": create, "InstId": strconv.FormatInt(int64(entityID), 16)})
+ return nil, err
+ }
+
+ omciRxCallbackPair := CallbackPair{CbKey: tid,
+ CbEntry: CallbackPairEntry{rxChan, oo.receiveOmciResponse, true},
+ }
+ err = oo.Send(ctx, pkt, timeout, CDefaultRetries, highPrio, omciRxCallbackPair)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot send ethernet frame performance monitoring history data ME",
+ log.Fields{"Err": err, "device-id": oo.deviceID, "upstream": upstream, "create": create, "InstId": strconv.FormatInt(int64(entityID), 16)})
+ return nil, err
+ }
+ logger.Debugw(ctx, "send ethernet frame performance monitoring history data ME done",
+ log.Fields{"device-id": oo.deviceID, "upstream": upstream, "create": create, "InstId": strconv.FormatInt(int64(entityID), 16)})
+ return meInstance, nil
+ }
+ logger.Errorw(ctx, "Cannot generate ethernet frame performance monitoring history data ME Instance",
+ log.Fields{"Err": omciErr.GetError(), "device-id": oo.deviceID, "upstream": upstream, "create": create, "InstId": strconv.FormatInt(int64(entityID), 16)})
+ return nil, omciErr.GetError()
+}
+
+// SendCreateOrDeleteEthernetUniHistoryME creates or deletes EthernetPerformanceMonitoringHistoryData ME instance
+func (oo *OmciCC) SendCreateOrDeleteEthernetUniHistoryME(ctx context.Context, timeout int, highPrio bool,
+ create bool, rxChan chan Message, entityID uint16) (*me.ManagedEntity, error) {
+ tid := oo.GetNextTid(highPrio)
+ logger.Debugw(ctx, "send ethernet-uni-history-me-msg:", log.Fields{"device-id": oo.deviceID,
+ "SequNo": strconv.FormatInt(int64(tid), 16), "InstId": strconv.FormatInt(int64(entityID), 16), "create": create})
+ meParam := me.ParamData{EntityID: entityID}
+ var meInstance *me.ManagedEntity
+ var omciErr me.OmciErrors
+ meInstance, omciErr = me.NewEthernetPerformanceMonitoringHistoryData(meParam)
+
+ if omciErr.GetError() == nil {
+ var omciLayer *omci.OMCI
+ var msgLayer gopacket.SerializableLayer
+ var err error
+ if create {
+ omciLayer, msgLayer, err = omci.EncodeFrame(meInstance, omci.CreateRequestType, omci.TransactionID(tid),
+ omci.AddDefaults(true))
+ } else {
+ omciLayer, msgLayer, err = omci.EncodeFrame(meInstance, omci.DeleteRequestType, omci.TransactionID(tid),
+ omci.AddDefaults(true))
+ }
+ if err != nil {
+ logger.Errorw(ctx, "Cannot encode ethernet uni history data ME",
+ log.Fields{"Err": err, "device-id": oo.deviceID, "create": create, "InstId": strconv.FormatInt(int64(entityID), 16)})
+ return nil, err
+ }
+
+ pkt, err := serializeOmciLayer(ctx, omciLayer, msgLayer)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot serialize ethernet uni history data ME",
+ log.Fields{"Err": err, "device-id": oo.deviceID, "create": create, "InstId": strconv.FormatInt(int64(entityID), 16)})
+ return nil, err
+ }
+
+ omciRxCallbackPair := CallbackPair{CbKey: tid,
+ CbEntry: CallbackPairEntry{rxChan, oo.receiveOmciResponse, true},
+ }
+ err = oo.Send(ctx, pkt, timeout, CDefaultRetries, highPrio, omciRxCallbackPair)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot send ethernet uni history data ME",
+ log.Fields{"Err": err, "device-id": oo.deviceID, "create": create, "InstId": strconv.FormatInt(int64(entityID), 16)})
+ return nil, err
+ }
+ logger.Debugw(ctx, "send ethernet uni history data ME done",
+ log.Fields{"device-id": oo.deviceID, "create": create, "InstId": strconv.FormatInt(int64(entityID), 16)})
+ return meInstance, nil
+ }
+ logger.Errorw(ctx, "Cannot generate ethernet uni history data ME Instance",
+ log.Fields{"Err": omciErr.GetError(), "device-id": oo.deviceID, "create": create, "InstId": strconv.FormatInt(int64(entityID), 16)})
+ return nil, omciErr.GetError()
+}
+
+// SendCreateOrDeleteFecHistoryME creates or deletes FecPerformanceMonitoringHistoryData ME instance
+func (oo *OmciCC) SendCreateOrDeleteFecHistoryME(ctx context.Context, timeout int, highPrio bool,
+ create bool, rxChan chan Message, entityID uint16) (*me.ManagedEntity, error) {
+ tid := oo.GetNextTid(highPrio)
+ logger.Debugw(ctx, "send fec-history-me-msg:", log.Fields{"device-id": oo.deviceID,
+ "SequNo": strconv.FormatInt(int64(tid), 16), "InstId": strconv.FormatInt(int64(entityID), 16), "create": create})
+ meParam := me.ParamData{EntityID: entityID}
+ var meInstance *me.ManagedEntity
+ var omciErr me.OmciErrors
+ meInstance, omciErr = me.NewFecPerformanceMonitoringHistoryData(meParam)
+
+ if omciErr.GetError() == nil {
+ var omciLayer *omci.OMCI
+ var msgLayer gopacket.SerializableLayer
+ var err error
+ if create {
+ omciLayer, msgLayer, err = omci.EncodeFrame(meInstance, omci.CreateRequestType, omci.TransactionID(tid),
+ omci.AddDefaults(true))
+ } else {
+ omciLayer, msgLayer, err = omci.EncodeFrame(meInstance, omci.DeleteRequestType, omci.TransactionID(tid),
+ omci.AddDefaults(true))
+ }
+ if err != nil {
+ logger.Errorw(ctx, "Cannot encode fec history data ME",
+ log.Fields{"Err": err, "device-id": oo.deviceID, "create": create, "InstId": strconv.FormatInt(int64(entityID), 16)})
+ return nil, err
+ }
+
+ pkt, err := serializeOmciLayer(ctx, omciLayer, msgLayer)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot serialize fec history data ME",
+ log.Fields{"Err": err, "device-id": oo.deviceID, "create": create, "InstId": strconv.FormatInt(int64(entityID), 16)})
+ return nil, err
+ }
+
+ omciRxCallbackPair := CallbackPair{CbKey: tid,
+ CbEntry: CallbackPairEntry{rxChan, oo.receiveOmciResponse, true},
+ }
+ err = oo.Send(ctx, pkt, timeout, CDefaultRetries, highPrio, omciRxCallbackPair)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot send fec history data ME",
+ log.Fields{"Err": err, "device-id": oo.deviceID, "create": create, "InstId": strconv.FormatInt(int64(entityID), 16)})
+ return nil, err
+ }
+ logger.Debugw(ctx, "send fec history data ME done",
+ log.Fields{"device-id": oo.deviceID, "create": create, "InstId": strconv.FormatInt(int64(entityID), 16)})
+ return meInstance, nil
+ }
+ logger.Errorw(ctx, "Cannot generate fec history data ME Instance",
+ log.Fields{"Err": omciErr.GetError(), "device-id": oo.deviceID, "create": create, "InstId": strconv.FormatInt(int64(entityID), 16)})
+ return nil, omciErr.GetError()
+}
+
+// SendCreateOrDeleteGemPortHistoryME deletes GemPortNetworkCtpPerformanceMonitoringHistoryData ME instance
+func (oo *OmciCC) SendCreateOrDeleteGemPortHistoryME(ctx context.Context, timeout int, highPrio bool,
+ create bool, rxChan chan Message, entityID uint16) (*me.ManagedEntity, error) {
+ tid := oo.GetNextTid(highPrio)
+ logger.Debugw(ctx, "send gemport-history-me-msg:", log.Fields{"device-id": oo.deviceID,
+ "SequNo": strconv.FormatInt(int64(tid), 16), "InstId": strconv.FormatInt(int64(entityID), 16), "create": create})
+ meParam := me.ParamData{EntityID: entityID}
+ var meInstance *me.ManagedEntity
+ var omciErr me.OmciErrors
+ meInstance, omciErr = me.NewGemPortNetworkCtpPerformanceMonitoringHistoryData(meParam)
+
+ if omciErr.GetError() == nil {
+ var omciLayer *omci.OMCI
+ var msgLayer gopacket.SerializableLayer
+ var err error
+ if create {
+ omciLayer, msgLayer, err = omci.EncodeFrame(meInstance, omci.CreateRequestType, omci.TransactionID(tid),
+ omci.AddDefaults(true))
+ } else {
+ omciLayer, msgLayer, err = omci.EncodeFrame(meInstance, omci.DeleteRequestType, omci.TransactionID(tid),
+ omci.AddDefaults(true))
+ }
+ if err != nil {
+ logger.Errorw(ctx, "Cannot encode gemport history data ME",
+ log.Fields{"Err": err, "device-id": oo.deviceID, "create": create, "InstId": strconv.FormatInt(int64(entityID), 16)})
+ return nil, err
+ }
+
+ pkt, err := serializeOmciLayer(ctx, omciLayer, msgLayer)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot serialize gemport history data ME",
+ log.Fields{"Err": err, "device-id": oo.deviceID, "create": create, "InstId": strconv.FormatInt(int64(entityID), 16)})
+ return nil, err
+ }
+
+ omciRxCallbackPair := CallbackPair{CbKey: tid,
+ CbEntry: CallbackPairEntry{rxChan, oo.receiveOmciResponse, true},
+ }
+ err = oo.Send(ctx, pkt, timeout, CDefaultRetries, highPrio, omciRxCallbackPair)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot send gemport history data ME",
+ log.Fields{"Err": err, "device-id": oo.deviceID, "create": create, "InstId": strconv.FormatInt(int64(entityID), 16)})
+ return nil, err
+ }
+ logger.Debugw(ctx, "send gemport history data ME done",
+ log.Fields{"device-id": oo.deviceID, "create": create, "InstId": strconv.FormatInt(int64(entityID), 16)})
+ return meInstance, nil
+ }
+ logger.Errorw(ctx, "Cannot generate gemport history data ME Instance",
+ log.Fields{"Err": omciErr.GetError(), "device-id": oo.deviceID, "create": create, "InstId": strconv.FormatInt(int64(entityID), 16)})
+ return nil, omciErr.GetError()
+}
+
+// SendStartSoftwareDownload sends StartSoftwareDownloadRequest
+func (oo *OmciCC) SendStartSoftwareDownload(ctx context.Context, timeout int, highPrio bool,
+ rxChan chan Message, aImageMeID uint16, aDownloadWindowSize uint8, aFileLen uint32) error {
+ tid := oo.GetNextTid(highPrio)
+ logger.Debugw(ctx, "send StartSwDlRequest:", log.Fields{"device-id": oo.deviceID,
+ "SequNo": strconv.FormatInt(int64(tid), 16),
+ "InstId": strconv.FormatInt(int64(aImageMeID), 16)})
+
+ omciLayer := &omci.OMCI{
+ TransactionID: tid,
+ MessageType: omci.StartSoftwareDownloadRequestType,
+ // DeviceIdentifier: omci.BaselineIdent, // Optional, defaults to Baseline
+ // Length: 0x28, // Optional, defaults to 40 octets
+ }
+ request := &omci.StartSoftwareDownloadRequest{
+ MeBasePacket: omci.MeBasePacket{
+ EntityClass: me.SoftwareImageClassID,
+ EntityInstance: aImageMeID, //inactive image
+ },
+ WindowSize: aDownloadWindowSize,
+ ImageSize: aFileLen,
+ NumberOfCircuitPacks: 1, //parallel download to multiple circuit packs not supported
+ CircuitPacks: []uint16{0}, //circuit pack indication don't care for NumberOfCircuitPacks=1, but needed by omci-lib
+ }
+
+ var options gopacket.SerializeOptions
+ options.FixLengths = true
+ buffer := gopacket.NewSerializeBuffer()
+ err := gopacket.SerializeLayers(buffer, options, omciLayer, request)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot serialize StartSwDlRequest", log.Fields{"Err": err,
+ "device-id": oo.deviceID})
+ return err
+ }
+ outgoingPacket := buffer.Bytes()
+
+ omciRxCallbackPair := CallbackPair{CbKey: tid,
+ CbEntry: CallbackPairEntry{rxChan, oo.receiveOmciResponse, true},
+ }
+ err = oo.Send(ctx, outgoingPacket, timeout, CDefaultRetries, highPrio, omciRxCallbackPair)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot send StartSwDlRequest", log.Fields{"Err": err,
+ "device-id": oo.deviceID})
+ return err
+ }
+ logger.Debug(ctx, "send StartSwDlRequest done")
+ return nil
+}
+
+// SendDownloadSection sends DownloadSectionRequestWithResponse
+func (oo *OmciCC) SendDownloadSection(ctx context.Context, aTimeout int, highPrio bool,
+ rxChan chan Message, aImageMeID uint16, aAckRequest uint8, aDownloadSectionNo uint8, aSection []byte, aPrint bool) error {
+ tid := oo.GetNextTid(highPrio)
+ logger.Debugw(ctx, "send DlSectionRequest:", log.Fields{"device-id": oo.deviceID,
+ "SequNo": strconv.FormatInt(int64(tid), 16),
+ "InstId": strconv.FormatInt(int64(aImageMeID), 16), "omci-ack": aAckRequest})
+
+ //TODO!!!: don't know by now on how to generate the possibly needed AR (or enforce it to 0) with current omci-lib
+ // by now just try to send it as defined by omci-lib
+ msgType := omci.DownloadSectionRequestType
+ var timeout int = 0 //default value for no response expected
+ if aAckRequest > 0 {
+ msgType = omci.DownloadSectionRequestWithResponseType
+ timeout = aTimeout
+ }
+ omciLayer := &omci.OMCI{
+ TransactionID: tid,
+ MessageType: msgType,
+ // DeviceIdentifier: omci.BaselineIdent, // Optional, defaults to Baseline
+ // Length: 0x28, // Optional, defaults to 40 octets
+ }
+ localSectionData := make([]byte, len(aSection))
+
+ copy(localSectionData[:], aSection) // as long as DownloadSectionRequest defines array for SectionData we need to copy into the array
+ request := &omci.DownloadSectionRequest{
+ MeBasePacket: omci.MeBasePacket{
+ EntityClass: me.SoftwareImageClassID,
+ EntityInstance: aImageMeID, //inactive image
+ },
+ SectionNumber: aDownloadSectionNo,
+ SectionData: localSectionData,
+ }
+
+ var options gopacket.SerializeOptions
+ options.FixLengths = true
+ buffer := gopacket.NewSerializeBuffer()
+ err := gopacket.SerializeLayers(buffer, options, omciLayer, request)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot serialize DlSectionRequest", log.Fields{"Err": err,
+ "device-id": oo.deviceID})
+ return err
+ }
+ outgoingPacket := buffer.Bytes()
+
+ //for initial debug purpose overrule the requested print state for some frames
+ printFrame := aPrint
+ if aAckRequest > 0 || aDownloadSectionNo == 0 {
+ printFrame = true
+ }
+
+ omciRxCallbackPair := CallbackPair{CbKey: tid,
+ // the callback is set even though no response might be required here, the tid (key) setting is needed here anyway
+ // (used to avoid retransmission of frames with the same TID)
+ CbEntry: CallbackPairEntry{rxChan, oo.receiveOmciResponse, printFrame /*aPrint*/},
+ }
+ err = oo.Send(ctx, outgoingPacket, timeout, CDefaultRetries, highPrio, omciRxCallbackPair)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot send DlSectionRequest", log.Fields{"Err": err,
+ "device-id": oo.deviceID})
+ return err
+ }
+ logger.Debug(ctx, "send DlSectionRequest done")
+ return nil
+}
+
+//SendEndSoftwareDownload sends EndSoftwareDownloadRequest
+func (oo *OmciCC) SendEndSoftwareDownload(ctx context.Context, timeout int, highPrio bool,
+ rxChan chan Message, aImageMeID uint16, aFileLen uint32, aImageCrc uint32) error {
+ tid := oo.GetNextTid(highPrio)
+ logger.Debugw(ctx, "send EndSwDlRequest:", log.Fields{"device-id": oo.deviceID,
+ "SequNo": strconv.FormatInt(int64(tid), 16),
+ "InstId": strconv.FormatInt(int64(aImageMeID), 16)})
+
+ omciLayer := &omci.OMCI{
+ TransactionID: tid,
+ MessageType: omci.EndSoftwareDownloadRequestType,
+ // DeviceIdentifier: omci.BaselineIdent, // Optional, defaults to Baseline
+ // Length: 0x28, // Optional, defaults to 40 octets
+ }
+ request := &omci.EndSoftwareDownloadRequest{
+ MeBasePacket: omci.MeBasePacket{
+ EntityClass: me.SoftwareImageClassID,
+ EntityInstance: aImageMeID, //inactive image
+ },
+ CRC32: aImageCrc,
+ ImageSize: aFileLen,
+ NumberOfInstances: 1, //parallel download to multiple circuit packs not supported
+ ImageInstances: []uint16{0}, //don't care for NumberOfInstances=1, but probably needed by omci-lib as in startSwDlRequest
+ }
+
+ var options gopacket.SerializeOptions
+ options.FixLengths = true
+ buffer := gopacket.NewSerializeBuffer()
+ err := gopacket.SerializeLayers(buffer, options, omciLayer, request)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot serialize EndSwDlRequest", log.Fields{"Err": err,
+ "device-id": oo.deviceID})
+ return err
+ }
+ outgoingPacket := buffer.Bytes()
+
+ omciRxCallbackPair := CallbackPair{CbKey: tid,
+ CbEntry: CallbackPairEntry{rxChan, oo.receiveOmciResponse, true},
+ }
+ err = oo.Send(ctx, outgoingPacket, timeout, CDefaultRetries, highPrio, omciRxCallbackPair)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot send EndSwDlRequest", log.Fields{"Err": err,
+ "device-id": oo.deviceID})
+ return err
+ }
+ logger.Debug(ctx, "send EndSwDlRequest done")
+ return nil
+}
+
+// SendActivateSoftware sends ActivateSoftwareRequest
+func (oo *OmciCC) SendActivateSoftware(ctx context.Context, timeout int, highPrio bool,
+ rxChan chan Message, aImageMeID uint16) error {
+ tid := oo.GetNextTid(highPrio)
+ logger.Debugw(ctx, "send ActivateSwRequest:", log.Fields{"device-id": oo.deviceID,
+ "SequNo": strconv.FormatInt(int64(tid), 16),
+ "InstId": strconv.FormatInt(int64(aImageMeID), 16)})
+
+ omciLayer := &omci.OMCI{
+ TransactionID: tid,
+ MessageType: omci.ActivateSoftwareRequestType,
+ // DeviceIdentifier: omci.BaselineIdent, // Optional, defaults to Baseline
+ // Length: 0x28, // Optional, defaults to 40 octets
+ }
+ request := &omci.ActivateSoftwareRequest{
+ MeBasePacket: omci.MeBasePacket{
+ EntityClass: me.SoftwareImageClassID,
+ EntityInstance: aImageMeID, //inactive image
+ },
+ ActivateFlags: 0, //unconditionally reset as the only relevant option here (regardless of VOIP)
+ }
+
+ var options gopacket.SerializeOptions
+ options.FixLengths = true
+ buffer := gopacket.NewSerializeBuffer()
+ err := gopacket.SerializeLayers(buffer, options, omciLayer, request)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot serialize ActivateSwRequest", log.Fields{"Err": err,
+ "device-id": oo.deviceID})
+ return err
+ }
+ outgoingPacket := buffer.Bytes()
+
+ omciRxCallbackPair := CallbackPair{CbKey: tid,
+ CbEntry: CallbackPairEntry{rxChan, oo.receiveOmciResponse, true},
+ }
+ err = oo.Send(ctx, outgoingPacket, timeout, CDefaultRetries, highPrio, omciRxCallbackPair)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot send ActivateSwRequest", log.Fields{"Err": err,
+ "device-id": oo.deviceID})
+ return err
+ }
+ logger.Debug(ctx, "send ActivateSwRequest done")
+ return nil
+}
+
+// SendCommitSoftware sends CommitSoftwareRequest
+func (oo *OmciCC) SendCommitSoftware(ctx context.Context, timeout int, highPrio bool,
+ rxChan chan Message, aImageMeID uint16) error {
+ tid := oo.GetNextTid(highPrio)
+ logger.Debugw(ctx, "send CommitSwRequest:", log.Fields{"device-id": oo.deviceID,
+ "SequNo": strconv.FormatInt(int64(tid), 16),
+ "InstId": strconv.FormatInt(int64(aImageMeID), 16)})
+
+ omciLayer := &omci.OMCI{
+ TransactionID: tid,
+ MessageType: omci.CommitSoftwareRequestType,
+ // DeviceIdentifier: omci.BaselineIdent, // Optional, defaults to Baseline
+ // Length: 0x28, // Optional, defaults to 40 octets
+ }
+ request := &omci.CommitSoftwareRequest{
+ MeBasePacket: omci.MeBasePacket{
+ EntityClass: me.SoftwareImageClassID,
+ EntityInstance: aImageMeID, //inactive image
+ },
+ }
+
+ var options gopacket.SerializeOptions
+ options.FixLengths = true
+ buffer := gopacket.NewSerializeBuffer()
+ err := gopacket.SerializeLayers(buffer, options, omciLayer, request)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot serialize CommitSwRequest", log.Fields{"Err": err,
+ "device-id": oo.deviceID})
+ return err
+ }
+ outgoingPacket := buffer.Bytes()
+
+ omciRxCallbackPair := CallbackPair{CbKey: tid,
+ CbEntry: CallbackPairEntry{rxChan, oo.receiveOmciResponse, true},
+ }
+ err = oo.Send(ctx, outgoingPacket, timeout, CDefaultRetries, highPrio, omciRxCallbackPair)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot send CommitSwRequest", log.Fields{"Err": err,
+ "device-id": oo.deviceID})
+ return err
+ }
+ logger.Debug(ctx, "send CommitSwRequest done")
+ return nil
+}
+
+//SendSelfTestReq sends TestRequest
+func (oo *OmciCC) SendSelfTestReq(ctx context.Context, classID me.ClassID, instdID uint16, timeout int, highPrio bool, rxChan chan Message) error {
+ tid := oo.GetNextTid(highPrio)
+ logger.Debugw(ctx, "send self test request:", log.Fields{"device-id": oo.deviceID,
+ "SequNo": strconv.FormatInt(int64(tid), 16),
+ "InstId": strconv.FormatInt(int64(instdID), 16)})
+ omciLayer := &omci.OMCI{
+ TransactionID: tid,
+ MessageType: omci.TestRequestType,
+ // DeviceIdentifier: omci.BaselineIdent, // Optional, defaults to Baseline
+ // Length: 0x28, // Optional, defaults to 40 octets
+ }
+
+ var request *omci.OpticalLineSupervisionTestRequest
+ switch classID {
+ case me.AniGClassID:
+ request = &omci.OpticalLineSupervisionTestRequest{
+ MeBasePacket: omci.MeBasePacket{
+ EntityClass: classID,
+ EntityInstance: instdID,
+ },
+ SelectTest: uint8(7), // self test
+ GeneralPurposeBuffer: uint16(0),
+ VendorSpecificParameters: uint16(0),
+ }
+ default:
+ logger.Errorw(ctx, "unsupported class id for self test request", log.Fields{"device-id": oo.deviceID, "classID": classID})
+ return fmt.Errorf("unsupported-class-id-for-self-test-request-%v", classID)
+ }
+ // Test serialization back to former string
+ var options gopacket.SerializeOptions
+ options.FixLengths = true
+
+ buffer := gopacket.NewSerializeBuffer()
+ err := gopacket.SerializeLayers(buffer, options, omciLayer, request)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot serialize self test request", log.Fields{"Err": err,
+ "device-id": oo.deviceID})
+ return err
+ }
+ outgoingPacket := buffer.Bytes()
+
+ omciRxCallbackPair := CallbackPair{CbKey: tid,
+ CbEntry: CallbackPairEntry{rxChan, oo.receiveOmciResponse, true},
+ }
+ err = oo.Send(ctx, outgoingPacket, timeout, 0, highPrio, omciRxCallbackPair)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot send self test request", log.Fields{"Err": err,
+ "device-id": oo.deviceID})
+ return err
+ }
+ logger.Debug(ctx, "send self test request done")
+ return nil
+}
+
+//nolint: gocyclo
+func isSuccessfulResponseWithMibDataSync(omciMsg *omci.OMCI, packet *gp.Packet) bool {
+ for _, v := range responsesWithMibDataSync {
+ if v == omciMsg.MessageType {
+ nextLayer, _ := omci.MsgTypeToNextLayer(v, false)
+ msgLayer := (*packet).Layer(nextLayer)
+ switch nextLayer {
+ case omci.LayerTypeCreateResponse:
+ if resp := msgLayer.(*omci.CreateResponse); resp != nil {
+ if resp.Result == me.Success {
+ return true
+ }
+ }
+ case omci.LayerTypeDeleteResponse:
+ if resp := msgLayer.(*omci.DeleteResponse); resp != nil {
+ if resp.Result == me.Success {
+ return true
+ }
+ }
+ case omci.LayerTypeSetResponse:
+ if resp := msgLayer.(*omci.SetResponse); resp != nil {
+ if resp.Result == me.Success {
+ return true
+ }
+ }
+ case omci.LayerTypeStartSoftwareDownloadResponse:
+ if resp := msgLayer.(*omci.StartSoftwareDownloadResponse); resp != nil {
+ if resp.Result == me.Success {
+ return true
+ }
+ }
+ case omci.LayerTypeEndSoftwareDownloadResponse:
+ if resp := msgLayer.(*omci.EndSoftwareDownloadResponse); resp != nil {
+ if resp.Result == me.Success {
+ return true
+ }
+ }
+ case omci.LayerTypeActivateSoftwareResponse:
+ if resp := msgLayer.(*omci.ActivateSoftwareResponse); resp != nil {
+ if resp.Result == me.Success {
+ return true
+ }
+ }
+ case omci.LayerTypeCommitSoftwareResponse:
+ if resp := msgLayer.(*omci.CommitSoftwareResponse); resp != nil {
+ if resp.Result == me.Success {
+ return true
+ }
+ }
+ }
+ }
+ }
+ return false
+}
+
+func (oo *OmciCC) processRequestMonitoring(ctx context.Context, aOmciTxRequest OmciTransferStructure) {
+ timeout := aOmciTxRequest.timeout
+ if timeout == 0 {
+ //timeout 0 indicates that no response is expected - fire and forget
+ oo.mutexTxQueue.Lock()
+ oo.txQueue.PushBack(aOmciTxRequest) // enqueue
+ oo.mutexTxQueue.Unlock()
+ go oo.sendNextRequest(ctx)
+ } else {
+ //the supervised sending with waiting on the response (based on TID) is called in background
+ // to avoid blocking of the sender for the complete OMCI handshake procedure
+ // to stay consistent with the processing tested so far, sending of next messages of the same control procedure
+ // is ensured by the according control instances (FSM's etc.) (by waiting for the respective responses there)
+ go oo.sendWithRxSupervision(ctx, aOmciTxRequest, timeout)
+ }
+}
+
+func (oo *OmciCC) sendWithRxSupervision(ctx context.Context, aOmciTxRequest OmciTransferStructure, aTimeout int) {
+ chSuccess := make(chan bool)
+ aOmciTxRequest.chSuccess = chSuccess
+ tid := aOmciTxRequest.cbPair.CbKey
+ oo.mutexMonReq.Lock()
+ oo.monitoredRequests[tid] = aOmciTxRequest
+ oo.mutexMonReq.Unlock()
+
+ retries := aOmciTxRequest.retries
+ retryCounter := 0
+loop:
+ for retryCounter <= retries {
+
+ oo.mutexTxQueue.Lock()
+ oo.txQueue.PushBack(aOmciTxRequest) // enqueue
+ oo.mutexTxQueue.Unlock()
+ go oo.sendNextRequest(ctx)
+
+ select {
+ case success := <-chSuccess:
+ if success {
+ logger.Debugw(ctx, "reqMon: response received in time",
+ log.Fields{"tid": tid, "device-id": oo.deviceID})
+ } else {
+ logger.Debugw(ctx, "reqMon: wait for response aborted",
+ log.Fields{"tid": tid, "device-id": oo.deviceID})
+ }
+ break loop
+ case <-time.After(time.Duration(aTimeout) * time.Second):
+ if retryCounter == retries {
+ logger.Errorw(ctx, "reqMon: timeout waiting for response - no of max retries reached!",
+ log.Fields{"tid": tid, "retries": retryCounter, "device-id": oo.deviceID})
+ break loop
+ } else {
+ logger.Infow(ctx, "reqMon: timeout waiting for response - retry",
+ log.Fields{"tid": tid, "retries": retryCounter, "device-id": oo.deviceID})
+ }
+ }
+ retryCounter++
+ }
+ oo.mutexMonReq.Lock()
+ delete(oo.monitoredRequests, tid)
+ oo.mutexMonReq.Unlock()
+}
+
+//CancelRequestMonitoring terminates monitoring of outstanding omci requests
+func (oo *OmciCC) CancelRequestMonitoring(ctx context.Context) {
+ oo.mutexMonReq.RLock()
+ for k := range oo.monitoredRequests {
+ //implement non-blocking channel send to avoid blocking on mutexMonReq later
+ select {
+ case oo.monitoredRequests[k].chSuccess <- false:
+ default:
+ logger.Debugw(ctx, "cancel not send on omciRespChannel (no receiver)", log.Fields{
+ "index": k, "device-id": oo.deviceID})
+ }
+ }
+ oo.mutexMonReq.RUnlock()
+}
+
+//GetMaxOmciTimeoutWithRetries provides a timeout value greater than the maximum
+//time consumed for retry processing of a particular OMCI-request
+func (oo *OmciCC) GetMaxOmciTimeoutWithRetries() time.Duration {
+ return time.Duration((CDefaultRetries+1)*oo.pBaseDeviceHandler.GetOmciTimeout() + 1)
+}
+
+// SendCreateOrDeleteEthernetFrameExtendedPMME deletes EthernetFrameExtendedPm ME instance
+func (oo *OmciCC) SendCreateOrDeleteEthernetFrameExtendedPMME(ctx context.Context, timeout int, highPrio bool,
+ upstream bool, create bool, rxChan chan Message, entityID uint16, classID me.ClassID, controlBlock []uint16) (*me.ManagedEntity, error) {
+ tid := oo.GetNextTid(highPrio)
+ logger.Debugw(ctx, "send-ethernet-frame-extended-pm-me-msg:", log.Fields{"device-id": oo.deviceID,
+ "SequNo": strconv.FormatInt(int64(tid), 16), "InstId": strconv.FormatInt(int64(entityID), 16), "create": create, "upstream": upstream})
+
+ meParam := me.ParamData{EntityID: entityID,
+ Attributes: me.AttributeValueMap{"ControlBlock": controlBlock},
+ }
+ var meInstance *me.ManagedEntity
+ var omciErr me.OmciErrors
+ if classID == me.EthernetFrameExtendedPmClassID {
+ meInstance, omciErr = me.NewEthernetFrameExtendedPm(meParam)
+ } else {
+ meInstance, omciErr = me.NewEthernetFrameExtendedPm64Bit(meParam)
+ }
+
+ if omciErr.GetError() == nil {
+ var omciLayer *omci.OMCI
+ var msgLayer gopacket.SerializableLayer
+ var err error
+ if create {
+ omciLayer, msgLayer, err = omci.EncodeFrame(meInstance, omci.CreateRequestType, omci.TransactionID(tid),
+ omci.AddDefaults(true))
+ } else {
+ omciLayer, msgLayer, err = omci.EncodeFrame(meInstance, omci.DeleteRequestType, omci.TransactionID(tid),
+ omci.AddDefaults(true))
+ }
+ if err != nil {
+ logger.Errorw(ctx, "cannot-encode-ethernet-frame-extended-pm-me",
+ log.Fields{"err": err, "device-id": oo.deviceID, "upstream": upstream, "create": create, "inst-id": strconv.FormatInt(int64(entityID), 16)})
+ return nil, err
+ }
+
+ pkt, err := serializeOmciLayer(ctx, omciLayer, msgLayer)
+ if err != nil {
+ logger.Errorw(ctx, "cannot-serialize-ethernet-frame-extended-pm-me",
+ log.Fields{"err": err, "device-id": oo.deviceID, "upstream": upstream, "create": create, "inst-id": strconv.FormatInt(int64(entityID), 16)})
+ return nil, err
+ }
+
+ omciRxCallbackPair := CallbackPair{CbKey: tid,
+ CbEntry: CallbackPairEntry{rxChan, oo.receiveOmciResponse, true},
+ }
+ err = oo.Send(ctx, pkt, timeout, CDefaultRetries, highPrio, omciRxCallbackPair)
+ if err != nil {
+ logger.Errorw(ctx, "Cannot send ethernet-frame-extended-pm-me",
+ log.Fields{"Err": err, "device-id": oo.deviceID, "upstream": upstream, "create": create, "inst-id": strconv.FormatInt(int64(entityID), 16)})
+ return nil, err
+ }
+ logger.Debugw(ctx, "send-ethernet-frame-extended-pm-me-done",
+ log.Fields{"device-id": oo.deviceID, "upstream": upstream, "create": create, "inst-id": strconv.FormatInt(int64(entityID), 16)})
+ return meInstance, nil
+ }
+ logger.Errorw(ctx, "cannot-generate-ethernet-frame-extended-pm-me-instance",
+ log.Fields{"Err": omciErr.GetError(), "device-id": oo.deviceID, "upstream": upstream, "create": create, "inst-id": strconv.FormatInt(int64(entityID), 16)})
+ return nil, omciErr.GetError()
+}
+
+// RLockMutexMonReq lock read access to monitoredRequests
+func (oo *OmciCC) RLockMutexMonReq() {
+ oo.mutexMonReq.RLock()
+}
+
+// RUnlockMutexMonReq unlock read access to monitoredRequests
+func (oo *OmciCC) RUnlockMutexMonReq() {
+ oo.mutexMonReq.RUnlock()
+}
+
+// GetMonitoredRequest get OmciTransferStructure for an omciTransID
+func (oo *OmciCC) GetMonitoredRequest(omciTransID uint16) (value OmciTransferStructure, exist bool) {
+ value, exist = oo.monitoredRequests[omciTransID]
+ return value, exist
+}
+
+// SetChMonitoredRequest sets chSuccess to indicate whether response was received or not
+func (oo *OmciCC) SetChMonitoredRequest(omciTransID uint16, chVal bool) {
+ oo.monitoredRequests[omciTransID].chSuccess <- chVal
+}
diff --git a/internal/pkg/common/onu_uni_port.go b/internal/pkg/common/onu_uni_port.go
new file mode 100755
index 0000000..77cce60
--- /dev/null
+++ b/internal/pkg/common/onu_uni_port.go
@@ -0,0 +1,158 @@
+/*
+ * Copyright 2020-present Open Networking Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * 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.
+ */
+
+//Package common provides global definitions
+package common
+
+import (
+ "context"
+ "fmt"
+ "strconv"
+ "strings"
+ "time"
+
+ //"sync"
+ //"time"
+
+ //"github.com/opencord/voltha-lib-go/v7/pkg/kafka"
+ "github.com/opencord/voltha-lib-go/v7/pkg/log"
+ vc "github.com/opencord/voltha-protos/v5/go/common"
+ of "github.com/opencord/voltha-protos/v5/go/openflow_13"
+ "github.com/opencord/voltha-protos/v5/go/voltha"
+)
+
+//NewOnuUniPort returns a new instance of a OnuUniPort
+func NewOnuUniPort(ctx context.Context, aUniID uint8, aPortNo uint32, aInstNo uint16,
+ aPortType UniPortType) *OnuUniPort {
+ logger.Infow(ctx, "init-onuUniPort", log.Fields{"uniID": aUniID,
+ "portNo": aPortNo, "InstNo": aInstNo, "type": aPortType})
+ var OnuUniPort OnuUniPort
+ OnuUniPort.Enabled = false
+ OnuUniPort.Name = "uni-" + strconv.FormatUint(uint64(aPortNo), 10)
+ OnuUniPort.PortNo = aPortNo
+ OnuUniPort.PortType = aPortType
+ // so far it seems as here ofpPortNo/Name ist the same as the original port name ...??
+ OnuUniPort.OfpPortNo = OnuUniPort.Name
+ OnuUniPort.UniID = aUniID
+ OnuUniPort.MacBpNo = aUniID + 1 //ensure >0 instanceNo
+ OnuUniPort.EntityID = aInstNo
+ OnuUniPort.AdminState = vc.AdminState_ENABLED //enabled per create
+ OnuUniPort.OperState = vc.OperStatus_UNKNOWN
+ OnuUniPort.PPort = nil // to be set on create
+ return &OnuUniPort
+}
+
+//CreateVolthaPort creates the Voltha port based on ONU UNI Port and informs the core about it
+func (oo *OnuUniPort) CreateVolthaPort(ctx context.Context, apDeviceHandler IdeviceHandler) error {
+ logger.Debugw(ctx, "creating-voltha-uni-port", log.Fields{
+ "device-id": apDeviceHandler.GetDevice().Id, "portNo": oo.PortNo})
+ //200630: per [VOL-3202] OF port info is now to be delivered within UniPort create
+ // not doing so crashes rw_core processing (at least still in 200630 version)
+ name := apDeviceHandler.GetDevice().SerialNumber + "-" + strconv.FormatUint(uint64(oo.MacBpNo), 10)
+ var macOctets [6]uint8
+ macOctets[5] = 0x08
+ macOctets[4] = uint8(*apDeviceHandler.GetPonPortNumber() >> 8)
+ macOctets[3] = uint8(*apDeviceHandler.GetPonPortNumber())
+ macOctets[2] = uint8(oo.PortNo >> 16)
+ macOctets[1] = uint8(oo.PortNo >> 8)
+ macOctets[0] = uint8(oo.PortNo)
+ hwAddr := genMacFromOctets(macOctets)
+ ofHwAddr := macAddressToUint32Array(hwAddr)
+ capacity := uint32(of.OfpPortFeatures_OFPPF_1GB_FD | of.OfpPortFeatures_OFPPF_FIBER)
+ ofUniPortState := of.OfpPortState_OFPPS_LINK_DOWN
+ /* as the VOLTHA port create is only called directly after Uni Port create
+ the OfPortOperState is always Down
+ Note: this way the OfPortOperState won't ever change (directly in adapter)
+ maybe that was already always the case, but looks a bit weird - to be kept in mind ...
+ if pUniPort.operState == vc.OperStatus_ACTIVE {
+ ofUniPortState = of.OfpPortState_OFPPS_LIVE
+ }
+ */
+ logger.Debugw(ctx, "ofPort values", log.Fields{
+ "forUniPortName": oo.Name, "forMacBase": hwAddr,
+ "name": name, "hwAddr": ofHwAddr, "OperState": ofUniPortState})
+
+ pUniPort := &voltha.Port{
+ DeviceId: apDeviceHandler.GetDevice().Id,
+ PortNo: oo.PortNo,
+ Label: oo.Name,
+ Type: voltha.Port_ETHERNET_UNI,
+ AdminState: oo.AdminState,
+ OperStatus: oo.OperState,
+ // obviously empty peer setting
+ OfpPort: &of.OfpPort{
+ Name: name,
+ HwAddr: ofHwAddr,
+ Config: 0,
+ State: uint32(ofUniPortState),
+ Curr: capacity,
+ Advertised: capacity,
+ Peer: capacity,
+ CurrSpeed: 1000,
+ MaxSpeed: 1000,
+ },
+ }
+ maxRetry := 3
+ retryCnt := 0
+ var err error
+ for retryCnt = 0; retryCnt < maxRetry; retryCnt++ {
+ if err = apDeviceHandler.CreatePortInCore(ctx, pUniPort); err != nil {
+ logger.Errorf(ctx, "Device FSM: PortCreated-failed-%s, retrying after a delay", err)
+ // retry after a sleep
+ time.Sleep(2 * time.Second)
+ } else {
+ // success, break from retry loop
+ break
+ }
+ }
+ if retryCnt == maxRetry { // maxed out..
+ logger.Errorf(ctx, "Device FSM: PortCreated-failed-%s", err)
+ return fmt.Errorf("device-fsm-port-create-failed-%s", err)
+ }
+ logger.Infow(ctx, "Voltha OnuUniPort-added", log.Fields{
+ "device-id": apDeviceHandler.GetDevice().Id, "PortNo": oo.PortNo})
+ oo.PPort = pUniPort
+ oo.OperState = vc.OperStatus_DISCOVERED
+
+ return nil
+}
+
+//SetOperState modifies OperState of the the UniPort
+func (oo *OnuUniPort) SetOperState(aNewOperState vc.OperStatus_Types) {
+ oo.OperState = aNewOperState
+}
+
+// uni port related utility functions (so far only used here)
+func genMacFromOctets(aOctets [6]uint8) string {
+ return fmt.Sprintf("%02x:%02x:%02x:%02x:%02x:%02x",
+ aOctets[5], aOctets[4], aOctets[3],
+ aOctets[2], aOctets[1], aOctets[0])
+}
+
+//copied from OLT Adapter: unify centrally ?
+func macAddressToUint32Array(mac string) []uint32 {
+ slist := strings.Split(mac, ":")
+ result := make([]uint32, len(slist))
+ var err error
+ var tmp int64
+ for index, val := range slist {
+ if tmp, err = strconv.ParseInt(val, 16, 32); err != nil {
+ return []uint32{1, 2, 3, 4, 5, 6}
+ }
+ result[index] = uint32(tmp)
+ }
+ return result
+}
diff --git a/internal/pkg/common/utils.go b/internal/pkg/common/utils.go
new file mode 100755
index 0000000..8ea2624
--- /dev/null
+++ b/internal/pkg/common/utils.go
@@ -0,0 +1,155 @@
+/*
+ * Copyright 2020-present Open Networking Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * 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.
+ */
+
+//Package common provides global definitions
+package common
+
+import (
+ "bytes"
+ "context"
+ "encoding/binary"
+ "errors"
+ "fmt"
+ "net"
+ "regexp"
+ "strconv"
+ "strings"
+
+ "github.com/looplab/fsm"
+ me "github.com/opencord/omci-lib-go/generated"
+ "github.com/opencord/voltha-lib-go/v7/pkg/log"
+)
+
+// GetTpIDFromTpPath extracts TpID from the TpPath.
+// On success it returns a valid TpID and nil error.
+// On failure it returns TpID as 0 and the error.
+func GetTpIDFromTpPath(tpPath string) (uint8, error) {
+ // tpPath is of the format <technology>/<table_id>/olt-{}/pon-{}/onu-{}/uni-{}
+ // A sample tpPath is ==> XGS-PON/64/olt-{12345abcd}/pon-{0}/onu-{1}/uni-{1}
+ var tpPathFormat = regexp.MustCompile(`^[a-zA-Z\-_]+/[0-9]+/olt-{[a-z0-9\-]+}/pon-{[0-9]+}/onu-{[0-9]+}/uni-{[0-9]+}$`)
+
+ // Ensure tpPath is of the format <technology>/<table_id>/<uni_port_name>
+ if !tpPathFormat.Match([]byte(tpPath)) {
+ return 0, errors.New("tp-path-not-confirming-to-format")
+ }
+ // Extract the TP table-id field.
+ tpID, err := strconv.Atoi(strings.Split(tpPath, "/")[1])
+ // Atoi returns uint64 and need to be type-casted to uint8 as tpID is uint8 size.
+ return uint8(tpID), err
+}
+
+//IPToInt32 transforms an IP of net.Ip type to int32
+func IPToInt32(ip net.IP) uint32 {
+ if len(ip) == 16 {
+ return binary.BigEndian.Uint32(ip[12:16])
+ }
+ return binary.BigEndian.Uint32(ip)
+}
+
+//AsByteSlice transforms a string of manually set bits to a byt array
+func AsByteSlice(bitString string) []byte {
+ var out []byte
+ var str string
+
+ for i := len(bitString); i > 0; i -= 8 {
+ if i-8 < 0 {
+ str = bitString[0:i]
+ } else {
+ str = bitString[i-8 : i]
+ }
+ v, err := strconv.ParseUint(str, 2, 8)
+ if err != nil {
+ panic(err)
+ }
+ out = append([]byte{byte(v)}, out...)
+ }
+ return out
+}
+
+// TwosComplementToSignedInt16 convert 2s complement to signed int16
+func TwosComplementToSignedInt16(val uint16) int16 {
+ var uint16MsbMask uint16 = 0x8000
+ if val&uint16MsbMask == uint16MsbMask {
+ return int16(^val+1) * -1
+ }
+
+ return int16(val)
+}
+
+// TrimStringFromMeOctet trim string out of Me octet
+func TrimStringFromMeOctet(input interface{}) string {
+ ifBytes, _ := me.InterfaceToOctets(input)
+ return fmt.Sprintf("%s", bytes.Trim(ifBytes, "\x00"))
+}
+
+////////////////////////////////////////////////////////////////////////
+
+//NewAdapterFsm - FSM details including event, device and channel.
+func NewAdapterFsm(aName string, aDeviceID string, aCommChannel chan Message) *AdapterFsm {
+ aFsm := &AdapterFsm{
+ fsmName: aName,
+ deviceID: aDeviceID,
+ CommChan: aCommChannel,
+ }
+ return aFsm
+}
+
+// LogFsmStateChange logs FSM state changes
+func (oo *AdapterFsm) LogFsmStateChange(ctx context.Context, e *fsm.Event) {
+ logger.Debugw(ctx, "FSM state change", log.Fields{"device-id": oo.deviceID, "FSM name": oo.fsmName,
+ "event name": string(e.Event), "src state": string(e.Src), "dst state": string(e.Dst)})
+}
+
+////////////////////////////////////////////////////////////////////////
+
+// GenerateIeeMaperServiceProfileEID returns IeeMaperServiceProfileEntityID
+func GenerateIeeMaperServiceProfileEID(uniPortMacBpNo uint16, tpID uint16) (uint16, error) {
+ if tpID < tpIDStart || tpID >= tpIDEnd {
+ return 0, fmt.Errorf("tech profile id out of range - %d", tpID)
+ }
+ if uniPortMacBpNo > maxUni {
+ return 0, fmt.Errorf("uni macbpno out of range - %d", uniPortMacBpNo)
+ }
+ return (IeeMaperServiceProfileBaseEID + uniPortMacBpNo*tpRange + tpID - tpIDStart), nil
+}
+
+// GenerateANISideMBPCDEID returns ANISideMacBridgePortConfigurationDataEntryID
+func GenerateANISideMBPCDEID(uniPortMacBpNo uint16, tpID uint16) (uint16, error) {
+ if tpID < tpIDStart || tpID >= tpIDEnd {
+ return 0, fmt.Errorf("tech profile id out of range - %d", tpID)
+ }
+ if uniPortMacBpNo > maxUni {
+ return 0, fmt.Errorf("uni macbpno out of range - %d", uniPortMacBpNo)
+ }
+ return (MacBridgePortAniBaseEID + uniPortMacBpNo*tpRange + tpID - tpIDStart), nil
+}
+
+// GenerateUNISideMBPCDEID returns UNISideMacBridgePortConfigurationDataEntityID
+func GenerateUNISideMBPCDEID(uniPortMacBpNo uint16) (uint16, error) {
+ if uniPortMacBpNo > maxUni {
+ return 0, fmt.Errorf("uni macbpno out of range - %d", uniPortMacBpNo)
+ }
+ return (MacBridgePortUniBaseEID + uniPortMacBpNo), nil
+}
+
+// GenerateMcastANISideMBPCDEID returns McastANISideMacBridgePortConfigurationDataEntityID
+func GenerateMcastANISideMBPCDEID(uniPortMacBpNo uint16) (uint16, error) {
+
+ if uniPortMacBpNo > maxUni {
+ return 0, fmt.Errorf("uni macbpno out of range - %d", uniPortMacBpNo)
+ }
+ return (MacBridgePortAniMcastBaseEID + uniPortMacBpNo), nil
+}