From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from smtpcmd01-g.aruba.it (smtpcmd01-g.aruba.it [62.149.158.217]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id EFFBB1922F9 for ; Wed, 9 Oct 2024 08:51:25 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=62.149.158.217 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1728463889; cv=none; b=EG4TUM7PaR6JNDJpT4DVcemJpUrgjbcGJQvbNtwCC68c1xNAlG98lJTPF6vH3deARasyOilyauU+8ftHbitYZCxkzW+KYus1k5woF2OfDnw934aqjOp9SBw9BvkALxxfPZ5DWgZQjYocSXAh+kd5mUxdV9h6gaeNzH7D9XzMQJs= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1728463889; c=relaxed/simple; bh=FV7e7mTgWHw2Z3NtjjRX2MBIrZt/rRVowc+kGDl6BTw=; h=Message-ID:Date:MIME-Version:Subject:To:Cc:References:From: In-Reply-To:Content-Type; b=KpN2diRlLJfexPK/iyIjo3l4qLZdgvLEqmZh+XXKA5gRU5GwzkttQDo/rrbWBjhnuvss+qPJoXNupPBFhSDSSZzCE+PMNzC7Qnlye7+ks+g6Io0pPv+d0kEuxAHfB96Xu+DlYlZNqcezCndS9RcAU1tTVFl44o8jCNX+HIhw3Ac= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=enneenne.com; spf=pass smtp.mailfrom=enneenne.com; dkim=pass (2048-bit key) header.d=aruba.it header.i=@aruba.it header.b=Uvc7Qzp3; arc=none smtp.client-ip=62.149.158.217 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=enneenne.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=enneenne.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=aruba.it header.i=@aruba.it header.b="Uvc7Qzp3" Received: from [192.168.1.58] ([79.0.204.227]) by Aruba Outgoing Smtp with ESMTPSA id ySMgsnKqdwy3rySMpsrqeB; Wed, 09 Oct 2024 10:48:24 +0200 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=aruba.it; s=a1; t=1728463704; bh=FV7e7mTgWHw2Z3NtjjRX2MBIrZt/rRVowc+kGDl6BTw=; h=Date:MIME-Version:Subject:To:From:Content-Type; b=Uvc7Qzp3FEYqEqD/rvjmJO5Xey0Exv95Xx0hpAoe1d8Xc1nrOyYNy3B0Qka4A9xWF VTk/MIl9zPj5Ft2zQMZtL65RVZ8xU2T9RNpLtTP79TtFM+/WvR03LFjwbMEUEn5P6r HKrELBR7gCH6/mieShNQciQOgiUh+s6tI1nGuH6uQaBIrD/G0ktLl1FEWYGoZPa+0V ItmCRAv4idtsjq48Ks8M6gs75NptG97JlB7i2XVvxsBZKsAZhzT5PY1H2zSkDJTowQ pyaro9wn0seAUuwhSvHUIeZ6+v5cEhiigCfFCKR3CCZpHRUV5gYhugdSsmP1IghcI5 VwuygQfR4l9ug== Message-ID: Date: Wed, 9 Oct 2024 10:48:23 +0200 Precedence: bulk X-Mailing-List: linux-doc@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 User-Agent: Mozilla Thunderbird Subject: Re: [RFC 3/3] Documentation ABI: add PPS generators documentaion To: Greg KH Cc: linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, Andrew Morton , corbet@lwn.net, Hall Christopher S , Mohan Subramanian , tglx@linutronix.de, andriy.shevchenko@linux.intel.com, Dong Eddie , N Pandith , T R Thejesh Reddy , Zage David , Chinnadurai Srinivasan References: <20241008135033.3171915-1-giometti@enneenne.com> <20241008135033.3171915-4-giometti@enneenne.com> <2024100819-wildlife-counting-6c63@gregkh> From: Rodolfo Giometti Content-Language: en-US In-Reply-To: <2024100819-wildlife-counting-6c63@gregkh> Content-Type: text/plain; charset=UTF-8; format=flowed Content-Transfer-Encoding: 7bit X-CMAE-Envelope: MS4xfMlxE6mUpguHLy4ZvIxzQPIAvV3oB91YJn+BHky68AOsVpS7bwixEkOVJrpjeOGo9ZFdHSSbs2c9eBLq1tNThaef4RirLZgvb5mqiW8S59WeVTqYM3GX V5VJ8obslYmIOAePh1NzhNfg8CpEmF8Plub2jPSti0jjP5816AnTohPZkhR2HugQ9PcPJ71cK0hAcqKtILQytYh+w06cv8HfrxYr82PEstZR4j9q13mXPakW uEel2a+sCfIVKVH+Hb6VobAA06voeej0RiAaOX1XFWRsMLmgmB/PyIpkSj1sEoyQbOMsWWOCvtDm/UspPeUQoUFYVsQm3W3zfQrGXKQyZJ9h7t4S7w1E8POS l9+7L/vCX4K6wa4qBJJpSVS/3dCSXHs821nsGtsKplB0Lci1C78cAICSQFkfOwZRdl5wCUYLhRyZI9kFg8XC/tN1LGczEuZXeFr2qqm3CiinSFDH5y6qqhCj Tijj+jk29qEyvYj5bxxLe0aNzWdLz0XEt1iOQ89CiZZroj+/hQKuB0NbpggfGas4O365COlCNdddUNaQmuaM/vuL9IML4mEd72UVxxVJwc2gEGcxpON6Fb57 OEobIMtrjztEFfSbR3gov9ZAptzs31WcBAiSpUmmWGuleRc7TlHu8QcZceVSOo0sZQ6BBAxkiGaammCtLXNNIX0k On 08/10/24 17:43, Greg KH wrote: > On Tue, Oct 08, 2024 at 03:50:33PM +0200, Rodolfo Giometti wrote: >> This patch adds the documentation for the ABI between the Linux kernel >> and userspace regarding the PPS generators. >> >> Signed-off-by: Rodolfo Giometti >> --- >> Documentation/ABI/testing/sysfs-pps-gen | 44 +++++++++++++++++++++++++ >> 1 file changed, 44 insertions(+) >> create mode 100644 Documentation/ABI/testing/sysfs-pps-gen >> >> diff --git a/Documentation/ABI/testing/sysfs-pps-gen b/Documentation/ABI/testing/sysfs-pps-gen >> new file mode 100644 >> index 000000000000..9ad066cb3ce5 >> --- /dev/null >> +++ b/Documentation/ABI/testing/sysfs-pps-gen >> @@ -0,0 +1,44 @@ >> +What: /sys/class/pps-gen/ >> +Date: October 2024 >> +Contact: Rodolfo Giometti >> +Description: >> + The /sys/class/pps-gen/ directory will contain files and >> + directories that will provide a unified interface to >> + the PPS generators. >> + >> +What: /sys/class/pps-gen/pps-genX/ >> +Date: October 2024 >> +Contact: Rodolfo Giometti >> +Description: >> + The /sys/class/pps-gen/pps-genX/ directory is related to X-th >> + PPS generator into the system. Each directory will >> + contain files to manage and control its PPS generator. >> + >> +What: /sys/class/pps-gen/pps-genX/enable >> +Date: October 2024 >> +Contact: Rodolfo Giometti >> +Description: >> + This write-only file enables or disables generation of the >> + PPS signal. >> + >> +What: /sys/class/pps-gen/pps-genX/name >> +Date: October 2024 >> +Contact: Rodolfo Giometti >> +Description: >> + This read-only file reports the name of the X-th generator. > > Again, why a name? What is that for? This can be useful in order to distinguish between different PPS generators in the system. For example, the PARPORT generator is not very precise, and userspace applications should be able to know which generator corresponds to the device /dev/pps-gen0 or /dev/pps-gen1, etc. > >> + >> +What: /sys/class/pps-gen/pps-genX/system >> +Date: October 2024 >> +Contact: Rodolfo Giometti >> +Description: >> + This read-only file returns "1" if the generator takes the >> + timing from the system clock, while it returns "0" if not >> + (i.e. from a peripheral device clock). >> + >> +What: /sys/class/pps-gen/pps-genX/time >> +Date: October 2024 >> +Contact: Rodolfo Giometti >> +Description: >> + This read-only file contains the current time stored into the >> + generator clock as two integers representing the current time >> + seconds and nanoseconds. > > Trailing whitespace, please always run checkpatch.pl. Fixed. Ciao, Rodolfo -- GNU/Linux Solutions e-mail: giometti@enneenne.com Linux Device Driver giometti@linux.it Embedded Systems phone: +39 349 2432127 UNIX programming