Skip to content

Commit 40c9bd3

Browse files
[nrf fromtree] bluetooth: host: Add docs for t_XX times in CS Test
These options are in microseconds but not fully configurable, document what options are allowed in 6.0 Signed-off-by: Olivier Lesage <[email protected]> (cherry picked from commit 5d03664)
1 parent c4cc6ef commit 40c9bd3

File tree

1 file changed

+54
-5
lines changed
  • include/zephyr/bluetooth

1 file changed

+54
-5
lines changed

include/zephyr/bluetooth/cs.h

Lines changed: 54 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -338,15 +338,64 @@ struct bt_le_cs_test_param {
338338
* it should use as low a transmit power as possible
339339
*/
340340
uint8_t transmit_power_level;
341-
/** Interlude time in microseconds between the RTT packets. */
341+
/** Interlude time in microseconds between the RTT packets.
342+
*
343+
* Valid options are:
344+
* - 10 us
345+
* - 20 us
346+
* - 30 us
347+
* - 40 us
348+
* - 50 us
349+
* - 60 us
350+
* - 80 us
351+
* - 145 us
352+
*/
342353
uint8_t t_ip1_time;
343-
/** Interlude time in microseconds between the CS tones. */
354+
/** Interlude time in microseconds between the CS tones.
355+
*
356+
* Valid options are:
357+
* - 10 us
358+
* - 20 us
359+
* - 30 us
360+
* - 40 us
361+
* - 50 us
362+
* - 60 us
363+
* - 80 us
364+
* - 145 us
365+
*/
344366
uint8_t t_ip2_time;
345-
/** Time in microseconds for frequency changes. */
367+
/** Time in microseconds for frequency changes.
368+
*
369+
* Valid options are:
370+
* - 15 us
371+
* - 20 us
372+
* - 30 us
373+
* - 40 us
374+
* - 50 us
375+
* - 60 us
376+
* - 80 us
377+
* - 100 us
378+
* - 120 us
379+
* - 150 us
380+
*/
346381
uint8_t t_fcs_time;
347-
/** Time in microseconds for the phase measurement period of the CS tones. */
382+
/** Time in microseconds for the phase measurement period of the CS tones.
383+
*
384+
* Valid options are:
385+
* - 10 us
386+
* - 20 us
387+
* - 40 us
388+
*/
348389
uint8_t t_pm_time;
349-
/** Time in microseconds for the antenna switch period of the CS tones. */
390+
/** Time in microseconds for the antenna switch period of the CS tones.
391+
*
392+
* Valid options are:
393+
* - 0 us
394+
* - 1 us
395+
* - 2 us
396+
* - 4 us
397+
* - 10 us
398+
*/
350399
uint8_t t_sw_time;
351400
/** Antenna Configuration Index used during antenna switching during
352401
* the tone phases of CS steps.

0 commit comments

Comments
 (0)