Apache NuttX is a mature, real-time embedded operating system (RTOS) https://nuttx.apache.org/
Find a file
dongjiuzhu1 1c643b5cc3 sched/clock: support using CLOCKFD to call clock_gettime/settime
This patch implements POSIX-compliant CLOCKFD support, enabling user
applications to access dynamic PTP clocks through file descriptors
combined with clock_gettime() and clock_settime() system calls.

Key changes include:

1. CLOCKFD macro support:
   - Added CLOCKFD() macro in include/nuttx/clock.h
   - Allows encoding file descriptor into clockid_t: CLOCKFD(fd)
   - Enables accessing PTP clocks via: clock_gettime(CLOCKFD(fd), &ts)

2. clock_gettime() enhancements:
   - Modified sched/clock/clock_gettime.c to detect CLOCKFD clockids
   - Extracts file descriptor from clockid using CLOCKFD_TO_FD()
   - Validates file descriptor and calls file_ioctl() with PTP_CLOCK_GETTIME
   - Falls back to standard clock handling for non-CLOCKFD clockids

3. clock_settime() enhancements:
   - Modified sched/clock/clock_settime.c to support CLOCKFD clockids
   - Extracts file descriptor and validates accessibility
   - Issues PTP_CLOCK_SETTIME ioctl to underlying PTP clock device
   - Maintains backward compatibility with standard POSIX clocks

4. File descriptor validation:
   - Checks file descriptor validity using fs_getfilep()
   - Ensures proper reference counting with fs_putfilep()
   - Returns appropriate error codes (EINVAL, EBADF) on failures

5. Integration with PTP clock framework:
   - Seamlessly integrates with PTP clock driver's ioctl interface
   - Enables standard POSIX clock API usage for dynamic PTP clocks
   - No changes required to existing applications using standard clocks

Usage example:
  int fd = open("/dev/ptp0", O_RDONLY);
  struct timespec ts;
  clock_gettime(CLOCKFD(fd), &ts);  /* Get PTP clock time */
  clock_settime(CLOCKFD(fd), &ts);  /* Set PTP clock time */
  close(fd);

This implementation follows the Linux kernel's PTP clock model, providing
a familiar interface for developers working with PTP hardware.

Signed-off-by: dongjiuzhu1 <dongjiuzhu1@xiaomi.com>
2025-12-30 10:22:09 -03:00
.github mtd/at25ee: Use eeprom/spi_xx25xx internally 2025-12-17 19:03:54 +01:00
arch risc-v/litex: Add 64-bit S-mode vexiiriscv support for litex. 2025-12-30 10:18:57 -03:00
audio fs/file: unify prefix about file_xxx api, like file_open, file_ioctl 2025-06-12 18:12:42 +08:00
binfmt sched:use tcb_s inside of task_tcb_s , remove all cast 2025-12-22 17:55:45 +08:00
boards risc-v/litex: Add 64-bit S-mode vexiiriscv support for litex. 2025-12-30 10:18:57 -03:00
cmake cmake: Improve nuttx_generate_kconfig() 2025-12-02 02:45:36 +08:00
crypto LICENSE: update NuttX-PublicDomain SPDX identifier 2025-12-26 19:46:12 +08:00
Documentation docs: add ICMP ping guide (usage, options, examples) 2025-12-29 22:41:40 +08:00
drivers drivers/timers/ptp: support ptp clock dummy driver 2025-12-30 10:22:09 -03:00
dummy
fs littlefs: fix statfs underflow during active writes 2025-12-29 14:23:04 +08:00
graphics sched/sleep: replace all Signal-based sleep implement to Scheduled sleep 2025-10-17 14:05:02 +08:00
include sched/clock: support using CLOCKFD to call clock_gettime/settime 2025-12-30 10:22:09 -03:00
libs libc/search: add foreach api for hcreate_data 2025-12-25 09:39:03 +08:00
mm net/ethernet: update all iob information in the iob_update_pktlen 2025-12-29 14:40:26 +08:00
net net/arp: support ARP entry learned on gratuitous ARP response 2025-12-30 21:10:50 +08:00
openamp sched/clock: remove return value of clock_systime_timespec() 2025-10-10 23:15:27 +08:00
pass1 Revert "build depend:Revert Make.dep intermediate ddc file" 2024-09-15 19:29:47 +08:00
sched sched/clock: support using CLOCKFD to call clock_gettime/settime 2025-12-30 10:22:09 -03:00
syscall sched/gettid: Move thread ID to TLS 2025-04-08 22:53:10 +08:00
tools espressif: improve esp-hal-3rdparty handling 2025-12-27 11:38:13 +08:00
video Revert "build depend:Revert Make.dep intermediate ddc file" 2024-09-15 19:29:47 +08:00
wireless net/wireless: fix compile warning 2025-12-25 18:05:33 +08:00
.asf.yaml github: master branch protection tune. 2025-05-07 18:37:13 -05:00
.codespell-ignore-lines net/icmpv6: replace net_lock with conn_lock and conn_lock_dev 2025-12-29 09:42:18 +08:00
.codespellrc codespellrc: add ist to ignorelist 2025-10-14 17:42:01 +08:00
.editorconfig .editorconfig: fix character encoding property specification 2025-11-28 19:12:13 +08:00
.gitignore gitignore: add more vim swap files 2025-06-18 15:44:51 -04:00
.gitmessage docs/contributing: Add a commit message template 2025-06-03 17:33:24 +08:00
.pre-commit-config.yaml pre-commit: enable codespell checks 2025-05-05 12:34:39 +08:00
.yamllint
AUTHORS AUTHORS: add Michal Lenc 2025-12-03 08:46:33 -03:00
CMakeLists.txt cmake: Add support for ccache. 2025-12-05 11:46:30 +01:00
CONTRIBUTING.md style: fix spelling in code comments and strings 2025-05-23 10:48:41 +08:00
INVIOLABLES.md
Kconfig drivers/timers/ptp: support ptp clock driver model 2025-12-30 10:22:09 -03:00
LICENSE style: fix spelling in code comments and strings 2025-05-23 10:48:41 +08:00
Makefile tools: migrate to SPDX identifier 2024-09-10 23:11:11 +08:00
NOTICE
README.md Gathering community recommendations 2023-10-28 13:55:56 +08:00
ReleaseNotes Documentation: move ReleaseNotes 2023-09-26 20:41:00 +08:00

POSIX Badge License Issues Tracking Badge Contributors GitHub Build Badge Documentation Badge

Apache NuttX is a real-time operating system (RTOS) with an emphasis on standards compliance and small footprint. Scalable from 8-bit to 64-bit microcontroller environments, the primary governing standards in NuttX are POSIX and ANSI standards. Additional standard APIs from Unix and other common RTOSs (such as VxWorks) are adopted for functionality not available under these standards, or for functionality that is not appropriate for deeply-embedded environments (such as fork()).

For brevity, many parts of the documentation will refer to Apache NuttX as simply NuttX.

Getting Started

First time on NuttX? Read the Getting Started guide! If you don't have a board available, NuttX has its own simulator that you can run on terminal.

Documentation

You can find the current NuttX documentation on the Documentation Page.

Alternatively, you can build the documentation yourself by following the Documentation Build Instructions.

The old NuttX documentation is still available in the Apache wiki.

Supported Boards

NuttX supports a wide variety of platforms. See the full list on the Supported Platforms page.

Contributing

If you wish to contribute to the NuttX project, read the Contributing guidelines for information on Git usage, coding standard, workflow and the NuttX principles.

License

The code in this repository is under either the Apache 2 license, or a license compatible with the Apache 2 license. See the License Page for more information.