ZAP embedded layer: cleanup, proper layering for codec and PAL integration #698

tecimovic · 2020-05-14T05:12:47Z

Summary

Previous state of the app layer made little sense, as it was mostly a direct dump of two different Silicon Labs application layers. It required a cleanup of directory structure, and creation of API layers that will allow integration with CHIP specific codec, downward integration with platform and network transport layer and upward integration with the end-developer callbacks that process the received commands.
This PR is a step forward in proper organization and allows other developers to start contributing codecs, for example.

make and make test at the src/app level should work.

Changes

Much renaming: The previous renaming of directories was just a direct drop, we can do better. The plugins now have a meaningful prefix that categorizes them.
API extraction: The headers are making some sense now.
Plugins: all the code is in plugins now. Earlier there were few incomprehensible directories lying around, which were created ad-hoc because the code was just created out of the blue.
Better unit tests that actually do something. (Though not enough yet.)

Todos

Solve the problem of using generated layer in a compiled form.
Integrate with the overall build system. Currently there is tons of Makefiles lying around, which should in the long run all be generated as they are boilerplate.
Remove the utest.* files from plugins. There should be a centralized unit testing plugin, no point polluting all the plugins with this.
Add generation tooling for plugins and generated code = integrate zap UI and zap generator with all this.
Properly integrate StructSpec and Struct layers to achieve library-based encoding/decoding of ZCL commands. Currently that is not yet done.
Abstract out attribute database from the data model. They are kind intertwined now, but there is no reason why the attribute DB could not be abstracted and bound to a simple implementaiton.
Many other things. (No kidding!)

src/app/api/chip-zcl-struct.h

src/app/api/chip-zcl.h

src/app/api/chip-zcl-struct.h

src/app/plugin/core-data-model/zcl-struct.c

src/app/api/chip-zcl.h

src/app/plugin/codec-simple/codec-simple.c

src/app/plugin/core-data-model/zcl-struct.c

bhaskar-apple

LGTM
@tecimovic - thanks for this. Would you also please file GitHub issues tracking the remaining work for demo 1.

woody-apple · 2020-05-19T14:34:30Z

@tecimovic Can we rebase this?

tecimovic · 2020-05-19T14:46:21Z

@tecimovic Can we rebase this?

Yeah, I'll rebase it.

rwalker-apple

lgtm

codecov · 2020-05-19T17:14:47Z

Codecov Report

Merging #698 into master will increase coverage by 0.75%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master     #698      +/-   ##
==========================================
+ Coverage   58.72%   59.47%   +0.75%     
==========================================
  Files         130      130              
  Lines       12653    12657       +4     
==========================================
+ Hits         7430     7528      +98     
+ Misses       5223     5129      -94

Impacted Files	Coverage Δ
src/inet/InetFaultInjection.cpp	`0.00% <0.00%> (-100.00%)`	⬇️
src/inet/UDPEndPoint.cpp	`0.00% <0.00%> (-63.81%)`	⬇️
src/lib/core/CHIPEncoding.h	`47.05% <0.00%> (-26.86%)`	⬇️
src/system/SystemFaultInjection.cpp	`31.81% <0.00%> (-18.19%)`	⬇️
src/system/SystemObject.cpp	`87.50% <0.00%> (-6.25%)`	⬇️
src/inet/TCPEndPoint.h	`0.00% <0.00%> (ø)`
src/lib/core/CHIPTLVTags.h	`66.66% <0.00%> (ø)`
src/inet/InetLayer.cpp	`36.64% <0.00%> (+36.64%)`	⬆️
src/system/SystemError.cpp	`69.38% <0.00%> (+61.22%)`	⬆️
src/system/SystemTimer.cpp	`76.74% <0.00%> (+72.09%)`	⬆️
... and 1 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update dc264b1...a98522f. Read the comment docs.

bhaskar-apple

LGTM

woody-apple · 2020-05-19T21:16:36Z

@gerickson @saurabhst @jelderton ?

…platform buffers. We need to explicitely declare this, if we are to interface with an abstraction.

…bstraction layer.

…of a mock buffer layer.

woody-apple · 2020-05-20T15:28:06Z

@tecimovic can you merge in restyle?

@saurabhst - can we get some eyeballs on this?

tecimovic · 2020-05-20T15:31:42Z

@tecimovic can you merge in restyle?

Done.

saurabhst · 2020-05-20T16:03:40Z

@tecimovic can you merge in restyle?

@saurabhst - can we get some eyeballs on this?

requesting @BroderickCarlin and @tpmanley as well to review the PR

woody-apple · 2020-05-20T16:28:09Z

Moving this along so we can start merging in demo progress. Please file issues if things are outstanding!

…py devices Merge in WMN_TOOLS/matter from feature/wifi_NewFeature_doc_update to silabs Squashed commit of the following: commit 1e10c3f53935745dc8ed0a13001ee279ab4c3e64 Author: Mathieu Kardous <[email protected]> Date: Fri May 5 10:26:25 2023 -0400 Add Wi-Fi low power section commit c0d91a5edb75c1f831708a5b21bc78f6d36025f9 Author: senthil kumar E K <[email protected]> Date: Fri May 5 16:33:24 2023 +0530 updated review comments releated to WiFi Station commit f69f22246db17a637f66ea732413b8db7ccb0da6 Merge: 889affc08d c6de514b8f Author: Ezra Hale <[email protected]> Date: Thu May 4 16:08:32 2023 -0400 Merge branch 'silabs' of ssh://stash.silabs.com/wmn_tools/matter into feature/wifi_NewFeature_doc_update Conflicts: docs/silabs/README.md ... and 46 more commits

tecimovic requested review from anush-apple, BroderickCarlin, chrisdecenzo, gerickson, hawk248, jelderton, robszewczyk, saurabhst and woody-apple as code owners May 14, 2020 05:12

restyled-io bot mentioned this pull request May 14, 2020

Restyle ZAP embedded layer: cleanup, proper layering for codec and PAL integration #699

Closed

rwalker-apple reviewed May 14, 2020

View reviewed changes

src/app/api/chip-zcl-struct.h Show resolved Hide resolved

rwalker-apple reviewed May 14, 2020

View reviewed changes

src/app/api/chip-zcl.h Show resolved Hide resolved

rwalker-apple reviewed May 14, 2020

View reviewed changes

src/app/api/chip-zcl-struct.h Show resolved Hide resolved

rwalker-apple reviewed May 14, 2020

View reviewed changes

src/app/plugin/core-data-model/zcl-struct.c Show resolved Hide resolved