Re: [PATCH net-next v7 02/15] Documentation: networking: Add timestamp related APIs to OA TC6 framework

[sashiko-bot@kernel.org]

Thank you for your contribution! Sashiko AI review found 2 potential issue(s) to consider:
- [Medium] The commit documents new hardware timestamp and MMS-related APIs, but completely fails to implement them in the codebase.
- [Low] Grammatical error in API documentation.
--

--- Patch [2]: [PATCH net-next v7 02/15] Documentation: networking: Add timestamp related APIs to OA TC6 framework ---
commit e50e16165cde4f4360bc2cdd6d9ceb4359237603
Author: Selvamani Rajagopal <Selvamani.Rajagopal@onsemi.com>

Documentation: networking: Add timestamp related APIs to OA TC6 framework

This commit updates the OA TC6 framework documentation to include new hardware
timestamp and MMS-related APIs. It details functions for PTP clock 
registration, ioctl interfaces, and read/write register operations.

> diff --git a/Documentation/networking/oa-tc6-framework.rst b/Documentation/networking/oa-tc6-framework.rst
> index fe2aabde923a5..325d299d1a7dc 100644
> --- a/Documentation/networking/oa-tc6-framework.rst
> +++ b/Documentation/networking/oa-tc6-framework.rst
[ ... ]
> @@ -495,3 +499,79 @@ the MAC-PHY.
>  Zero align receive frame feature can be enabled to align all receive ethernet
>  frames data to start at the beginning of any receive data chunk payload with a
>  start word offset (SWO) of zero.
> +
> +.. c:function:: int oa_tc6_ptp_register(struct oa_tc6 *tc6, \
> +                                        struct ptp_clock_info *info);

[Severity: Medium]
The commit message mentions adding new APIs and expanding read/write APIs, and
the documentation lists functions like oa_tc6_ptp_register() and
oa_tc6_read_register_mms(). Are these functions actually implemented in the
codebase?

It appears only the documentation was updated, but the corresponding code
implementation is missing from this patch.

> +
> +Registers the PTP hardware clock related functions with the kernel.
> +This API simply registers. Initialization of the fields in the
> +ptp_clock_info structure are left to the vendor as programming hardware
> +timer is expected to be vendor dependent. The fields max_adj, owner,
> +and all the functions for the clock operations, like adjfine, gettimex64,
> +settime64, adjtime are expected to be initialized in the structure before
> +calling the registering the hardware clock.

[Severity: Low]
This isn't a bug, but there's a grammatical error here. Should the phrasing
"calling the registering the hardware clock" be rewritten as "before
registering the hardware clock" or similar?

-- 
Sashiko AI review · https://sashiko.dev/#/patchset/20260708-s2500-mac-phy-support-v7-0-478c877aa1a9@onsemi.com?part=2