nuttx/Documentation/components/drivers/special
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
..
image docs/syslog: add syslog configuration options documentation 2026-02-27 08:09:31 -03:00
mtd Documentation: add pages for supported MTD devices 2025-12-31 11:37:49 +08:00
net net/vlan: add some macro for vlan 2025-12-27 11:36:39 +08:00
pci drivers/net: add IGB network card support 2025-07-08 10:02:15 +02:00
power drivers/power: Describe the regulators through procfs. 2026-08-18 17:28:02 +08:00
rpmsg Documentation/rpmsg: add rpmsg dump documentation 2026-01-30 07:50:11 -03:00
rptun Documents/rptun: add the new rptun framework documents 2026-01-19 14:18:27 +08:00
sensors drivers/sensors: add Microchip TC74 temperature sensor driver 2026-09-18 16:04:32 +08:00
vhost Documentation/vhost: add Vhost framework documentation 2026-02-04 02:32:02 +08:00
virtio Documentation/virtio: add VirtIO framework documentation 2026-01-28 13:09:19 -03:00
wireless Documentation: Add documentation for RN2XX3 driver 2025-03-06 06:10:19 -03:00
audio.rst docs/audio_tone: Add documentation about the audio tone driver 2026-07-13 09:42:26 +08:00
clk.rst
devfreq.rst sim/thermal: Exercise the devfreq cooling path. 2026-08-18 09:46:47 -03:00
devicetree.rst
devmem.rst
dma.rst
framebuffer.rst
i2c.rst Documentation: Add I2C bit-bang IO expander driver documentation 2026-01-01 17:08:47 +08:00
i3c.rst
index.rst Documentation: add devfreq framework documentation 2026-08-08 15:23:54 -03:00
ioexpander.rst ioexpander/ch422g: add a driver for the WCH CH422G I/O 2026-08-24 09:39:58 +02:00
lcd.rst !arch/stm32: move stm32l1 and finalize the directory split 2026-06-24 14:54:44 -03:00
mmcsd.rst drivers/mmcsd: Switch SD cards into high speed. 2026-08-18 09:38:45 +08:00
pinctrl.rst drivers/pinctrl: Add pad read-back and a procfs entry. 2026-08-21 20:04:59 +08:00
pipes.rst
ptp.rst Documentation/ptp: correct the PTP clock driver page. 2026-09-20 08:22:33 -03:00
regmap.rst
reset.rst drivers/reset: Add line read-back and a procfs entry. 2026-08-21 20:07:01 +08:00
rwbuffer.rst
sdio.rst drivers/mmcsd: Switch SD cards into high speed. 2026-08-18 09:38:45 +08:00
segger.rst style: Fix "the the" typo across the codebase. 2026-03-23 11:07:49 +01:00
sensors.rst drivers/sensors: add Microchip TC74 temperature sensor driver 2026-09-18 16:04:32 +08:00
spi.rst
syslog.rst include/debug.h: Move to include/nuttx/debug.h 2026-04-07 07:50:06 -03:00
sysview.png
usbdev.rst !arch/stm32: move stm32l1 and finalize the directory split 2026-06-24 14:54:44 -03:00
usbhost.rst !arch/stm32: move stm32l1 and finalize the directory split 2026-06-24 14:54:44 -03:00
usbmisc.rst
usbmonitor.rst style: fix typos 2025-04-30 13:45:46 +08:00
usbmonitor_wireshark_linux_example_adb.pcapng Documentation: Add usage of Wireshark for USB monitor 2025-01-22 15:17:38 +08:00
usbmonitor_wireshark_linux_example_adb.png Documentation: Add usage of Wireshark for USB monitor 2025-01-22 15:17:38 +08:00
usrsock.rst
uvc.rst drivers/usbdev: add UVC gadget class driver 2026-03-29 12:35:22 -03:00
video.rst
wireless.rst Documentation: Add documentation for RN2XX3 driver 2025-03-06 06:10:19 -03:00