| # |
| # Copyright 2018 the original author or authors. |
| # |
| # 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. |
| # |
| |
| from voltha.protos.device_pb2 import Port |
| import voltha.protos.device_pb2 as dev_pb2 |
| import voltha.core.flow_decomposer as fd |
| |
| """ |
| Encoding of identifiers |
| ======================= |
| |
| Flow id |
| |
| Identifies a flow within a single OLT |
| Flow Id is unique per OLT |
| Multiple GEM ports can map to same flow id |
| |
| 13 11 4 0 |
| +--------+--------------+------+ |
| | pon id | onu id | Flow | |
| | | | idx | |
| +--------+--------------+------+ |
| |
| 14 bits = 16384 flows (per OLT). |
| |
| pon id = 4 bits = 16 PON ports |
| onu id = 7 bits = 128 ONUss per PON port |
| Flow index = 3 bits = 4 bi-directional flows per ONU |
| = 8 uni-directional flows per ONU |
| |
| |
| Logical (OF) UNI port number |
| |
| OpenFlow port number corresponding to PON UNI |
| |
| 15 11 4 0 |
| +--+--------+--------------+------+ |
| |0 | pon id | onu id | 0 | |
| +--+--------+--------------+------+ |
| |
| pon id = 4 bits = 16 PON ports |
| onu id = 7 bits = 128 ONUs per PON port |
| |
| Logical (OF) NNI port number |
| |
| OpenFlow port number corresponding to PON UNI |
| |
| 16 0 |
| +--+----------------------------+ |
| |1 | intf_id | |
| +--+----------------------------+ |
| |
| No overlap with UNI port number space |
| |
| |
| PON OLT (OF) port number |
| |
| OpenFlow port number corresponding to PON OLT ports |
| |
| 31 28 0 |
| +--------+------------------------~~~------+ |
| | 0x2 | pon intf id | |
| +--------+------------------------~~~------+ |
| |
| """ |
| |
| |
| class OpenOltPlatform(object): |
| MAX_PONS_PER_OLT = 16 |
| MAX_ONUS_PER_PON = 128 |
| MAX_UNIS_PER_ONU = 16 |
| |
| def mk_uni_port_num(self, intf_id, onu_id, uni_id): |
| assert intf_id < OpenOltPlatform.MAX_PONS_PER_OLT |
| assert onu_id < OpenOltPlatform.MAX_ONUS_PER_PON |
| assert uni_id < OpenOltPlatform.MAX_UNIS_PER_ONU |
| # Multiple unis not supported. Physical ONU equates to single UNI. |
| assert uni_id == 0 |
| return intf_id << 11 | onu_id << 4 | uni_id |
| |
| def uni_id_from_port_num(self, port_num): |
| return port_num & 0xF |
| |
| def onu_id_from_port_num(self, port_num): |
| return (port_num >> 4) & 0x7F |
| |
| def intf_id_from_uni_port_num(self, port_num): |
| return (port_num >> 11) & 0xF |
| |
| def onu_id_from_uni_port_num(self, port_num): |
| return (port_num >> 4) & 0x7F |
| |
| def intf_id_from_pon_port_no(self, port_no): |
| return port_no & 0xF |
| |
| def intf_id_to_port_no(self, intf_id, intf_type): |
| if intf_type is Port.ETHERNET_NNI: |
| return (0x1 << 16) | intf_id |
| elif intf_type is Port.PON_OLT: |
| return 0x2 << 28 | intf_id |
| else: |
| raise Exception('Invalid port type') |
| |
| def intf_id_from_nni_port_num(self, port_num): |
| return port_num & 0xFFFF |
| |
| def intf_id_to_port_type_name(self, intf_id): |
| if (2 << 28 ^ intf_id) < 16: |
| return Port.PON_OLT |
| elif intf_id & (0x1 << 16) == (0x1 << 16): |
| return Port.ETHERNET_NNI |
| else: |
| return Port.ETHERNET_UNI |
| |
| def port_type_name_by_port_index(self, port_index): |
| try: |
| return dev_pb2._PORT_PORTTYPE.values_by_number[port_index].name |
| except Exception as err: |
| raise Exception(err) |
| |
| def extract_access_from_flow(self, in_port, out_port): |
| if self.is_upstream(out_port): |
| return (in_port, |
| self.intf_id_from_uni_port_num(in_port), |
| self.onu_id_from_port_num(in_port), |
| self.uni_id_from_port_num(in_port)) |
| else: |
| return (out_port, |
| self.intf_id_from_uni_port_num(out_port), |
| self.onu_id_from_port_num(out_port), |
| self.uni_id_from_port_num(out_port)) |
| |
| def is_upstream(self, out_port): |
| if out_port in [0xfffd, 0xfffffffd]: |
| # To Controller |
| return True |
| if (out_port & (0x1 << 16)) == (0x1 << 16): |
| # NNI interface |
| return True |
| return False |
| |
| def flow_extract_info(self, flow, flow_direction): |
| uni_port_no = None |
| if flow_direction == "upstream": |
| for field in fd.get_ofb_fields(flow): |
| if field.type == fd.IN_PORT: |
| uni_port_no = field.port |
| break |
| elif flow_direction == "downstream": |
| for field in fd.get_ofb_fields(flow): |
| if field.type == fd.METADATA: |
| uni_port_no = field.table_metadata & 0xFFFFFFFF |
| break |
| |
| if uni_port_no is None: |
| for action in fd.get_actions(flow): |
| if action.type == fd.OUTPUT: |
| uni_port_no = action.output.port |
| break |
| |
| if uni_port_no is None: |
| raise ValueError |
| |
| pon_intf = self.platform.intf_id_from_uni_port_num(uni_port_no) |
| onu_id = self.platform.onu_id_from_uni_port_num(uni_port_no) |
| uni_id = self.platform.uni_id_from_port_num(uni_port_no) |
| |
| return pon_intf, onu_id, uni_id |