Gitiles
Code Review Sign In
gerrit.opencord.org / omci-lib-go / 8fddd110eb455041e690b2d5d1e08daa93e69332
commit8fddd110eb455041e690b2d5d1e08daa93e69332[log] [tgz]
authorChip Boling <chipboling@gmail.com>Wed Aug 11 09:58:20 2021 -0500
committerChip Boling <chipboling@gmail.com>Wed Aug 11 09:58:20 2021 -0500
tree121893b7e8cf2283360bfbe8e03e8a829affca59
parent7a6e8d948d1dcd2bfa99c1368da6fe4f750b1f1d [diff]
VOL-4265: Fix for improperly code generated 802.1ag MEs

Change-Id: Iaf26b743e10d587cf6ec6b6482cd51676b5ae823
5 files changed
tree: 121893b7e8cf2283360bfbe8e03e8a829affca59
  1. .gitignore
  2. .gitreview
  3. LICENSE
  4. Makefile
  5. README.md
  6. VERSION
  7. generated/
  8. go.mod
  9. go.sum
  10. layers.go
  11. layers_test.go
  12. mebase.go
  13. mebase_test.go
  14. meframe.go
  15. meframe_test.go
  16. messagetypes.go
  17. messagetypes_test.go
  18. omci.go
  19. omci_test.go
  20. vendor/
README.md

OMCI

OMCI gopacket library supports the encoding and decoding of ITU G.988 OMCI messages. Support for the Baseline Message Set has been completed and work is underway to support the Extended Message Set format.

Message Types supported and under unit test

The following OMCI message types currently have been coded and are covered satisfactory by unit tests.

  • CreateRequest
  • CreateResponse
  • DeleteRequest
  • DeleteResponse
  • SetRequest
  • GetRequest
  • GetAllAlarmsRequest
  • GetAllAlarmsResponse
  • GetAllAlarmsNextRequest
  • MibUploadRequest
  • MibUploadResponse
  • MibUploadNextRequest
  • MibResetRequest
  • MibResetResponse
  • SynchronizeTimeRequest
  • DownloadSectionRequest
  • DownloadSectionResponse
  • EndSoftwareDownloadRequest
  • EndSoftwareDownloadResponse
  • CommitSoftwareRequest
  • CommitSoftwareResponse
  • AlarmNotification

Message Types supported but lacking full unit test

The following OMCI message types currently have been coded and are partially covered by unit tests, but work still remains for sufficient/better unit test coverage.

  • SetResponse
  • GetResponse
  • GetAllAlarmsNextResponse
  • MibUploadNextResponse
  • SynchronizeTimeResponse
  • AttributeValueChange
  • RebootRequest
  • RebootResponse
  • StartSoftwareDownloadRequest
  • GetNextRequest
  • GetNextResponse
  • TestResult
  • TestRequest
  • TestResponse
  • GetCurrentDataRequest
  • GetCurrentDataResponse

Message Types supported but lacking any unit test

The following OMCI message types currently have been coded but do not have any unit test coverage.

  • StartSoftwareDownloadResponse
  • ActivateSoftwareRequest
  • ActivateSoftwareResponse

Message Types not yet supported

The following OMCI message types currently have not been coded.

  • SetTableRequest
  • SetTableResponse

Extended Message Set Support

As mentioned earlier, support for the Extended Message Set is underway. Currently, the following Message Types have this support and are covered by unit tests:

  • GetRequest
  • GetResponse
  • DownloadSectionRequest/Response
  • AlarmNotification
  • AttributeValueChange
  • TestResult

Upcoming message types that will be supported

The following provides a list of message types that will eventually support the Extended Message Set in the expected order of implementation. The priority was chosen based on speed improvement requests of operations and ease of implementation.

  • GetCurrentDataRequest/Response

  • MibResetRequest/Response

  • RebootRequest/Response

  • SynchronizeTimeRequest/Response

  • CreateRequest/Response

  • DeleteRequest/Response

  • SetRequest/Response

  • GetNextRequest/Response

  • SetTableRequest/Response

  • MibUploadRequest/Response

  • MibUploadNextRequest/Response

  • GetAllAlarmsRequest/Response

  • GetAllAlarmsNextRequest/Response

  • StartSoftwareDownloadRequest/Response

  • EndSoftwareDownloadRequest/Response

  • CommitSoftwareRequest/Response

  • ActivateSoftwareRequest/Response

  • TestRequest/Response

Current user-test coverage

The make test command can be used to create code coverage support for the library. The current coverage for version 1.0.0 (as of 4/21/2021) is:

FileStatement Coverage
layers.go100%
mebase.go91.7%
meframe.go50.8%
messagetypes.go59.1%
omci.go79.0%

Other outstanding items

Besides OMCI Message decode/serialization, and associated unit tests, the following items would be needed or useful in a first official release of this library. Some changes are to be done in the generated OMCI ME code as well.

  • Constraint checking (these are not yet fully parsed/provided by the OMCI code generated structs). This feature will hopefully be available in the near future.
  • Add AVC flag for appropriate attributes
  • Add some type of logging support

Also searching through the code for TODO statements will also yield additional areas of work to be performed.

What is not provided by this library

This library is not a full OMCI stack for either an OLT or an ONU. It is focused primarily on packet decode/serialization and a variety of structs and functions that are useful for handling the creation of OMCI frames and handling decoded frames from the PON.

For an OLT-side OMCI stack, you would still need to write:

  • OMCI CC sender & receiver (stop & wait protocol) with appropriate timeout support
  • OLT State machines to support
    • MIB Uploads/Audits/Resynchronization (and a MIB database implemention),
    • More sophisticated get & get-next support to make handle of MEs with lots of attributes or table attributes easy to handle and code,
    • Alarm Table support,
    • OMCI ME/Msg-Type capabilities inquiry,
    • Performance Monitoring collection (and initial time synchronization),
    • Service implementation

For an ONU-side OMCI stack, you would still need to write:

  • OMCC implementation,
  • MIB Database,
  • Get-Next cache for table attributes,
  • MIB upload next cache for MIB uploads,
  • Generation of any alarms/AVC notifications,
  • Actually acting on the create/delete/get/set/... requests from an OLT