Skip to content

Commit 3dce5cf

Browse files
Apply suggestions from code review
Co-authored-by: Divya S Pillai <91891495+divipillai@users.noreply.github.com>
1 parent db43570 commit 3dce5cf

1 file changed

Lines changed: 21 additions & 22 deletions

File tree

nrf_modem/doc/dect_clock_sync.rst

Lines changed: 21 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ When synchronization is enabled, the modem adjusts its internal clock rate to en
6464
Hardware connection
6565
===================
6666

67-
The 1 PPS signal must be connected to the SIM_DET pin of the modem.
67+
The 1 PPS signal must be connected to the **SIM_DET** pin of the modem.
6868

6969
.. important::
7070
The SIM_DET pin is instructed to be left floating in the `nRF9151 DK hardware documentation`_.
@@ -75,18 +75,17 @@ Signal characteristics
7575

7676
The 1 PPS signal must have the following characteristics:
7777

78-
* Frequency: 1 Hz (one pulse per second)
79-
* Signal type: Digital pulse
78+
* Frequency - 1 Hz (one pulse per second)
79+
* Signal type - Digital pulse
8080

8181
.. note::
8282
The synchronization algorithm triggers from the rising edge of the 1 PPS signal.
83-
The quality and stability of the external clock signal directly affects the synchronization precision achieved by the modem.
83+
The quality and stability of the external clock signal directly affect the synchronization precision achieved by the modem.
8484

8585
Synchronization precision
8686
=========================
8787

88-
When synchronized to an external clock source, the modem can track the reference signal with a precision of up to
89-
0.001 ppm (parts per million).
88+
When synchronized to an external clock source, the modem can track the reference signal with a precision of up to 0.001 ppm (parts per million).
9089
The actual tracking precision depends on the quality of the external clock source and environmental conditions.
9190

9291
.. note::
@@ -139,17 +138,17 @@ The application can query the modem for the timing of the next synchronization p
139138

140139
This function takes a parameter specifying the pulse direction to query:
141140

142-
* :c:enumerator:`NRF_MODEM_DECT_CLOCK_SYNC_PULSE_INCOMING` - Query the received/incoming sync pulse time
143-
* :c:enumerator:`NRF_MODEM_DECT_CLOCK_SYNC_PULSE_OUTGOING` - Query the transmitted/outgoing sync pulse time
141+
* :c:enumerator:`NRF_MODEM_DECT_CLOCK_SYNC_PULSE_INCOMING` - Query the received or incoming sync pulse time.
142+
* :c:enumerator:`NRF_MODEM_DECT_CLOCK_SYNC_PULSE_OUTGOING` - Query the transmitted or outgoing sync pulse time.
144143

145144
This operation is asynchronous.
146145
When the operation has completed, its result is signaled to the application in the :c:enumerator:`NRF_MODEM_DECT_CLOCK_SYNC_EVT_PULSE_INFO` event.
147146

148147
The :c:member:`nrf_modem_dect_clock_sync_pulse_info_event.err` field in the event indicates the result of the operation:
149148

150-
* :c:enumerator:`NRF_MODEM_DECT_CLOCK_SYNC_NO_ERROR` - Operation completed successfully
151-
* :c:enumerator:`NRF_MODEM_DECT_CLOCK_SYNC_NOT_ACTIVE` - Clock synchronization is not active
152-
* :c:enumerator:`NRF_MODEM_DECT_CLOCK_SYNC_ERROR` - An error occurred
149+
* :c:enumerator:`NRF_MODEM_DECT_CLOCK_SYNC_NO_ERROR` - Operation completed successfully.
150+
* :c:enumerator:`NRF_MODEM_DECT_CLOCK_SYNC_NOT_ACTIVE` - Clock synchronization is not active.
151+
* :c:enumerator:`NRF_MODEM_DECT_CLOCK_SYNC_ERROR` - An error occurred.
153152

154153
If successful, the event contains:
155154

@@ -183,9 +182,9 @@ The :c:member:`nrf_modem_dect_clock_sync_state_event.clock_std_ppm` field provid
183182

184183
This value is encoded in Q3.12 fixed-point format:
185184

186-
* Bit 15: Sign bit (0 = positive, 1 = negative)
187-
* Bits 14-12: Integer part (3 bits)
188-
* Bits 11-0: Fractional part (12 bits)
185+
* Bit 15 - Sign bit (``0`` = positive, ``1`` = negative)
186+
* Bits 14-12 - Integer part (3 bits)
187+
* Bits 11-0 - Fractional part (12 bits)
189188

190189
To convert the value to floating-point parts per million (ppm)::
191190

@@ -207,16 +206,16 @@ The modem can generate a reference output signal that reflects its internal time
207206
Hardware connection
208207
===================
209208

210-
This signal is output on the COEX1 pin and can be used to synchronize external devices to the modem's clock.
209+
This signal is output on the **COEX1** pin and can be used to synchronize external devices to the modem's clock.
211210

212211
Signal characteristics
213-
=================================
212+
======================
214213

215214
When enabled, the reference output signal has the following characteristics:
216215

217-
* Frequency: 1 Hz (one pulse per second based on modem time)
218-
* Pulse width: 100 ms
219-
* Pin: COEX1
216+
* Frequency - 1 Hz (one pulse per second based on modem time)
217+
* Pulse width - 100 ms
218+
* Pin - **COEX1**
220219

221220
The output signal is generated based on the modem's internal time, occurring once per second as measured by the modem.
222221

@@ -243,10 +242,10 @@ When the operation has completed, its result is signaled to the application in t
243242

244243
The :c:member:`nrf_modem_dect_clock_sync_disable_ref_output_event.err` field in the event indicates the result of the operation:
245244

246-
* :c:enumerator:`NRF_MODEM_DECT_CLOCK_SYNC_NO_ERROR` - Operation completed successfully
247-
* :c:enumerator:`NRF_MODEM_DECT_CLOCK_SYNC_ERROR` - An error occurred
245+
* :c:enumerator:`NRF_MODEM_DECT_CLOCK_SYNC_NO_ERROR` - Operation completed successfully.
246+
* :c:enumerator:`NRF_MODEM_DECT_CLOCK_SYNC_ERROR` - An error occurred.
248247

249-
Once disabled, the COEX1 pin will no longer output the reference signal.
248+
Once disabled, the **COEX1** pin will no longer output the reference signal.
250249

251250
Use cases and application examples
252251
***********************************

0 commit comments

Comments
 (0)