nuttx/Documentation/components/drivers
Daniel P. Carvalho 964c68b109 Documentation/ptp: correct the PTP clock driver page.
The page did not match the code in several places.

- Describe struct ptp_ops_s as it is: adjfine takes parts per billion,
  adjphase, getres and control exist, there is no getcaps, and gettime
  has a system timestamp argument. State which operations are optional
  and give the real ptp_clock_register() arguments.
- Replace the CLOCKFD() macro, which does not exist, with the clock
  identifier built from CLOCK_SHIFT and CLOCK_FD, in all examples.
- Fix the frequency values: struct timex freq is in parts per million
  with 16 fractional bits, so +10 ppm is 655360.
- List the modes clock_adjtime() handles for a PTP clock
  (ADJ_SETOFFSET, ADJ_FREQUENCY, ADJ_OFFSET for the phase) and say that
  the others return -ENOTSUP.
- PTP_CLOCK_GETTIME and PTP_CLOCK_SETTIME take a struct timespec. Add
  the ioctls that were missing.
- The dummy driver uses CLOCK_REALTIME, not the monotonic clock.
- Point to ptpd instead of ptp4l and timemaster, which are not part of
  NuttX, and use the real CONFIG_DEBUG_PTP options.

Signed-off-by: Daniel P. Carvalho <danieloak@gmail.com>
Assisted-by: Claude:claude-sonnet-5
2026-09-20 08:22:33 -03:00
..
block drivers/eeprom: Retrieve the geometry 2025-11-13 08:57:52 -03:00
character Documentation,drivers/aie: align machine learning docs with current code 2026-09-19 15:16:18 -03:00
special Documentation/ptp: correct the PTP clock driver page. 2026-09-20 08:22:33 -03:00
thermal sim/thermal: Exercise the devfreq cooling path. 2026-08-18 09:46:47 -03:00
index.rst Documentation,drivers/aie: align machine learning docs with current code 2026-09-19 15:16:18 -03:00