blob: f4b255f409416144cc8931abf4953f01cb2dd23c [file] [log] [blame]
/*
* 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 adaptercoreonu provides the utility for onu devices, flows and statistics
package adaptercoreonu
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"
)
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
}
//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 *deviceHandler) error {
logger.Debugw(ctx, "creating-voltha-uni-port", log.Fields{
"device-id": apDeviceHandler.device.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.device.SerialNumber + "-" + strconv.FormatUint(uint64(oo.macBpNo), 10)
var macOctets [6]uint8
macOctets[5] = 0x08
//ponPortNumber was copied from device.ParentPortNo
macOctets[4] = uint8(apDeviceHandler.ponPortNumber >> 8)
macOctets[3] = uint8(apDeviceHandler.ponPortNumber)
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.deviceID,
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.device.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
}