Dect clock sync documentation #1973
Conversation
|
|
github-actions
bot
added
the
doc-required
Automatically created by action-manifest-pr GH action from PR: nrfconnect/sdk-nrfxlib#1973 Signed-off-by: Nordic Builder <[email protected]>
Automatically created by action-manifest-pr GH action from PR: nrfconnect/sdk-nrfxlib#1973 Signed-off-by: Nordic Builder <[email protected]>
tokaivola
force-pushed
the
main
branch
2 times, most recently
from
814fe78 to
20b94fa
Compare
Automatically created by action-manifest-pr GH action from PR: nrfconnect/sdk-nrfxlib#1973 Signed-off-by: Nordic Builder <[email protected]>
Automatically created by action-manifest-pr GH action from PR: nrfconnect/sdk-nrfxlib#1973 Signed-off-by: Nordic Builder <[email protected]>
Automatically created by action-manifest-pr GH action from PR: nrfconnect/sdk-nrfxlib#1973 Signed-off-by: Nordic Builder <[email protected]>
Automatically created by action-manifest-pr GH action from PR: nrfconnect/sdk-nrfxlib#1973 Signed-off-by: Nordic Builder <[email protected]>
Automatically created by action-manifest-pr GH action from PR: nrfconnect/sdk-nrfxlib#1973 Signed-off-by: Nordic Builder <[email protected]>
Automatically created by action-manifest-pr GH action from PR: nrfconnect/sdk-nrfxlib#1973 Signed-off-by: Nordic Builder <[email protected]>
|
generally this seemed nice and thorough! |
Automatically created by action-manifest-pr GH action from PR: nrfconnect/sdk-nrfxlib#1973 Signed-off-by: Nordic Builder <[email protected]>
Automatically created by action-manifest-pr GH action from PR: nrfconnect/sdk-nrfxlib#1973 Signed-off-by: Nordic Builder <[email protected]>
|
|
||
| To convert the value to floating-point parts per million (ppm):: | ||
|
|
||
| float ppm = clock_std_ppm / 4096.0f; |
There was a problem hiding this comment.
Should we use (float) 2^12 here as a divisor to make it clear where the 4096 comes from?
nrf_modem/doc/dect_clock_sync.rst
Outdated
| ********************* | ||
|
|
||
| The external clock signal must be a 1 PPS (pulse-per-second) signal connected to the modem's clock synchronization input. | ||
| When synchronization is enabled, the modem adjusts its internal clock rate to ensure that exactly ``NRF_MODEM_DECT_MODEM_TIME_TICK_RATE_KHZ`` clock cycles occur between consecutive external clock pulses. |
There was a problem hiding this comment.
NRF_MODEM_DECT_MODEM_TIME_TICK_RATE_KHZ is 69120 (I hope), but we are monitoring 69120000 clock cycles.
=>
When synchronization is enabled, the modem adjusts its internal clock rate to match correct number of clock cycles between consecutive external clock pulses.
i.e do we need that NRF_MODEM_DECT_MODEM_TIME_TICK_RATE_KHZ at all?
There was a problem hiding this comment.
I can switch this to a plain number, but it might need also to be explained from where the number comes from
There was a problem hiding this comment.
Or just leave out the numbers as suggested. That would actually be better.
There was a problem hiding this comment.
Yes, either remove or NRF_MODEM_DECT_MODEM_TIME_TICK_RATE_KHZ*1000 which looks ugly ;)
|
|
||
| #. Check that all operation parameters are valid | ||
| #. Verify that the Modem library is initialized | ||
| #. Check system logs for additional error information |
There was a problem hiding this comment.
Do we have system logs available in general case? Fidoless trace must be separately enabled, right?
There was a problem hiding this comment.
This refers to whatever app domain traces the user might have available.
Adds documentation for Dect clock synchronization. Signed-off-by: Tommi Kaivola <[email protected]>
Automatically created by action-manifest-pr GH action from PR: nrfconnect/sdk-nrfxlib#1973 Signed-off-by: Nordic Builder <[email protected]>
|
4 participants
Dect clock sync documentation.
The purpose of this PR is first and foremost to serve as means to share this for review, possible merge will happen after dialogue and fixes are complete.