[ICD] Update and Document ICDManager interface #33081
Merged
+581
−72
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
examples
platform
app
tests
icd
pullapprove
bot
requested review from
andy31415,
andyg-apple,
anush-apple,
arkq,
bzbarsky-apple,
carol-apple,
cecille,
chrisdecenzo,
chshu,
chulspro,
cliffamzn,
Damian-Nordic,
dhrishi,
harimau-qirex,
harsha-rajendran,
hawk248,
hicklin,
jepenven-silabs,
jmartinez-silabs,
jmeg-sfy,
joonhaengHeo,
jtung-apple and
kkasperczyk-no
pullapprove
bot
requested review from
sharadb-amazon,
tecimovic,
tehampson,
tima-q,
tobiasgraf,
turon,
vivien-apple,
wiba-nordic,
woody-apple,
younghak-hwang,
yufengwangca and
yunhanw-google
|
PR #33081: Size comparison from 8823bd9 to 78003be Increases (81 builds for bl602, bl702, bl702l, cc13x4_26x4, cc32xx, cyw30739, efr32, esp32, linux, mbed, nrfconnect, nxp, psoc6, qpg, stm32, telink)
Decreases (2 builds for linux)
Full report (82 builds for bl602, bl702, bl702l, cc13x4_26x4, cc32xx, cyw30739, efr32, esp32, linux, mbed, nrfconnect, nxp, psoc6, qpg, stm32, telink)
|
jmartinez-silabs
approved these changes
Apr 19, 2024
Co-authored-by: Boris Zbarsky <bzbarsky@apple.com>
|
PR #33081: Size comparison from 8823bd9 to f1c6f1f Increases (6 builds for cc32xx, mbed, qpg, stm32)
Decreases (2 builds for cc32xx)
Full report (6 builds for cc32xx, mbed, qpg, stm32)
|
yunhanw-google
approved these changes
Apr 19, 2024
|
PR #33081: Size comparison from 8823bd9 to 9fe2cc2 Increases above 0.2%:
Increases (52 builds for bl602, bl702, bl702l, cc13x4_26x4, cc32xx, efr32, esp32, linux, nrfconnect, psoc6, stm32)
Decreases (70 builds for bl602, bl702, bl702l, cc13x4_26x4, cc32xx, cyw30739, efr32, esp32, linux, mbed, nrfconnect, nxp, qpg, stm32, telink)
Full report (82 builds for bl602, bl702, bl702l, cc13x4_26x4, cc32xx, cyw30739, efr32, esp32, linux, mbed, nrfconnect, nxp, psoc6, qpg, stm32, telink)
|
|
@bzbarsky-apple resolving the two remaining comments to unblock follow up PR. If the commit doesn't fully address them, i'll open a follow up PR. |
| // This enum class represents to all ICDStateObserver callbacks available from the | ||
| // mStateObserverPool for the ICDManager. | ||
| /** | ||
| * @brief This enum class represents to all ICDStateObserver callbacks available from the |
| * When this event is called, the ICD is still in ActiveMode. | ||
| * If the ActiveMode timer is increased due to the TransitionToIdle event, the event will not be called a second time in | ||
| * a given cycle. | ||
| * OnEnterIdleMode will always the third when the ICD has transitioned to IdleMode. |
There was a problem hiding this comment.
"OnEnterIdleMode will always the third event and indictats that the ICD has transitioned to IdleMode."
| * OnEnterIdleMode will always the third when the ICD has transitioned to IdleMode. | ||
| * | ||
| * The ICDModeChange event can occur independently from the EnterActiveMode, TransitionToIdle and EnterIdleMode. | ||
| * It will typpically hapen at the ICDManager init when a client is already registered with the ICD before the |
| * | ||
| * The ICDModeChange event can occur independently from the EnterActiveMode, TransitionToIdle and EnterIdleMode. | ||
| * It will typpically hapen at the ICDManager init when a client is already registered with the ICD before the | ||
| * OnEnterIdleMode event or when a client send a register command after the OnEnterActiveMode event. Nothing prevents the |
| * The ICDModeChange event can occur independently from the EnterActiveMode, TransitionToIdle and EnterIdleMode. | ||
| * It will typpically hapen at the ICDManager init when a client is already registered with the ICD before the | ||
| * OnEnterIdleMode event or when a client send a register command after the OnEnterActiveMode event. Nothing prevents the | ||
| * ICDModeChange event to happen multiple times per cycle or while the ICD is in IdleMode. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
The PRs goal is finalize the public interface provided by the ICDManager. During developmment, most of the functions in the ICDManager were made public without good reason and gave access to internal functions and states that should not have been accessible.
PR also has a bug fix to reset the
OnTransitionToIdleflag when we enter ActiveMode and not when the IdleMode timer expires. This is the only real functionnal changes. ICDManager.cpp line #468 & #510privateto prevent consummers from modyfing internal states without going through standard and tested methods.OnTransitionToIdleflag was being set / clearedNote to reviewers :
Tests