From patchwork Mon Jan 1 17:30:42 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Aishwarya Pant X-Patchwork-Id: 854335 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Authentication-Results: ozlabs.org; spf=none (mailfrom) smtp.mailfrom=vger.kernel.org (client-ip=209.132.180.67; helo=vger.kernel.org; envelope-from=linux-rtc-owner@vger.kernel.org; receiver=) Authentication-Results: ozlabs.org; dkim=pass (2048-bit key; unprotected) header.d=gmail.com header.i=@gmail.com header.b="dPHFgP1V"; dkim-atps=neutral Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by ozlabs.org (Postfix) with ESMTP id 3z9PP46DxBz9s7s for ; Tue, 2 Jan 2018 04:31:04 +1100 (AEDT) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1751896AbeAARav (ORCPT ); Mon, 1 Jan 2018 12:30:51 -0500 Received: from mail-pg0-f66.google.com ([74.125.83.66]:36860 "EHLO mail-pg0-f66.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751892AbeAARau (ORCPT ); Mon, 1 Jan 2018 12:30:50 -0500 Received: by mail-pg0-f66.google.com with SMTP id 21so921057pgg.3; Mon, 01 Jan 2018 09:30:49 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=date:from:to:cc:subject:message-id:references:mime-version :content-disposition:in-reply-to:user-agent; bh=iEATRWqfpf7HUumyUF82E5JbKIRtkcKFesyUQGIz2eM=; b=dPHFgP1VhrL/Nth7Oe29GTxWlbktQ1vC4J+Y7XU8tGQdEM0NyL18W9W8i2qCcHA8W5 QTMYy8obmNdq/xe0ZCUGdpluXJSNgexk4/ZGT1OQUcToZT2nC9dskg36CEVfFb8ZLvmQ rg3/iM0I7yNhKlE0zc5U8Z6Q6JRXXtf4kV2MYrGWjzGzobC2GjHu8JZUAHbv28KYQ2zZ +ipWbSGCiHQliObezoqi/Auz+H5cRJplzVT+h568GZwwcJmSHIapLTKRy7M/QH0VnvuB 0JT99P4i1wArn/6ZsS2QZjcyNwZZdCKLvonFlwagNgxbT0RIqVn/tYydD4QRRIK7p/7K /Vaw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:date:from:to:cc:subject:message-id:references :mime-version:content-disposition:in-reply-to:user-agent; bh=iEATRWqfpf7HUumyUF82E5JbKIRtkcKFesyUQGIz2eM=; b=WFsWOpi5tBR0r6gkaRIhNzRdNxNuxu8sif/a8/WCTIeZmCn13XjsaZ2Piy7bTDTj0e RarXKS6tdviyz3hNAWvQ712xym0RUuPYW58CAflN/6vbHD5xjHxwPhmEJo3Ui/6eQDd0 xhtlpxsiA3PRRVaBgG867+G0RXYskDCb8XYdNcU1nxgDIod3vegH1AGjRXM3s7Lyk1mQ wrKbUm66IduCfeuIsIveQJRAH8QG4t8V/DvK6xEFfeg9ekag/fjY4bvPXLMbz4+TRC69 ranMsO7YdddgG9/g70EkDn9yk0tm9XwPjS0JDAnKOliUy+OlnnXv9fAu/e+FRUErT1n7 /8IA== X-Gm-Message-State: AKGB3mKhCyJ9JqklMn2UGettsGmnj7TgStYKmp/AqWXN7O7cf3m5xxmH F2KqZdbDZ7h/6zd5uZd+w5A= X-Google-Smtp-Source: ACJfBost2U9ZF6JCwPLqLLHAqJQ7jMtNh34uJ5iGBKewyAnyurt8WkErme2TkEtN1trJNHtQ/BhYJw== X-Received: by 10.98.223.4 with SMTP id u4mr42639719pfg.233.1514827849414; Mon, 01 Jan 2018 09:30:49 -0800 (PST) Received: from mordor.localdomain ([183.82.21.239]) by smtp.gmail.com with ESMTPSA id l8sm14946755pgr.49.2018.01.01.09.30.45 (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Mon, 01 Jan 2018 09:30:48 -0800 (PST) Date: Mon, 1 Jan 2018 23:00:42 +0530 From: Aishwarya Pant To: Alessandro Zummo , Alexandre Belloni , Jonathan Corbet , linux-rtc@vger.kernel.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, linux-api@vger.kernel.org Cc: Julia Lawall , gregkh@linuxfoundation.org Subject: [PATCH 1/2] Documentation: rtc: add sysfs file permissions Message-ID: <1237d9e0d486da6df6bd6260482bab9f930b319c.1514827586.git.aishpant@gmail.com> References: MIME-Version: 1.0 Content-Disposition: inline In-Reply-To: User-Agent: Mutt/1.9.2 (2017-12-15) Sender: linux-rtc-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-rtc@vger.kernel.org Annotate the sysfs interface of rtc with file specific permissions (RO/RW). Signed-off-by: Aishwarya Pant --- Documentation/ABI/testing/sysfs-class-rtc | 44 ++++++++++++++++--------------- 1 file changed, 23 insertions(+), 21 deletions(-) diff --git a/Documentation/ABI/testing/sysfs-class-rtc b/Documentation/ABI/testing/sysfs-class-rtc index df2eca7e2e77..5083841b03d4 100644 --- a/Documentation/ABI/testing/sysfs-class-rtc +++ b/Documentation/ABI/testing/sysfs-class-rtc @@ -18,14 +18,14 @@ Date: March 2006 KernelVersion: 2.6.17 Contact: linux-rtc@vger.kernel.org Description: - RTC-provided date in YYYY-MM-DD format + (RO) RTC-provided date in YYYY-MM-DD format What: /sys/class/rtc/rtcX/hctosys Date: September 2009 KernelVersion: 2.6.32 Contact: linux-rtc@vger.kernel.org Description: - 1 if the RTC provided the system time at boot via the + (RO) 1 if the RTC provided the system time at boot via the CONFIG_RTC_HCTOSYS kernel option, 0 otherwise What: /sys/class/rtc/rtcX/max_user_freq @@ -33,7 +33,7 @@ Date: October 2007 KernelVersion: 2.6.24 Contact: linux-rtc@vger.kernel.org Description: - The maximum interrupt rate an unprivileged user may request + (RW) The maximum interrupt rate an unprivileged user may request from this RTC. What: /sys/class/rtc/rtcX/name @@ -41,58 +41,60 @@ Date: March 2006 KernelVersion: 2.6.17 Contact: linux-rtc@vger.kernel.org Description: - The name of the RTC corresponding to this sysfs directory + (RO) The name of the RTC corresponding to this sysfs directory What: /sys/class/rtc/rtcX/range Date: January 2018 KernelVersion: 4.16 Contact: linux-rtc@vger.kernel.org Description: - Valid time range for the RTC, as seconds from epoch, formatted - as [min, max] + (RO) Valid time range for the RTC, as seconds from epoch, + formatted as [min, max] What: /sys/class/rtc/rtcX/since_epoch Date: March 2006 KernelVersion: 2.6.17 Contact: linux-rtc@vger.kernel.org Description: - RTC-provided time as the number of seconds since the epoch + (RO) RTC-provided time as the number of seconds since the epoch What: /sys/class/rtc/rtcX/time Date: March 2006 KernelVersion: 2.6.17 Contact: linux-rtc@vger.kernel.org Description: - RTC-provided time in 24-hour notation (hh:mm:ss) + (RO) RTC-provided time in 24-hour notation (hh:mm:ss) What: /sys/class/rtc/rtcX/*/nvmem Date: February 2016 KernelVersion: 4.6 Contact: linux-rtc@vger.kernel.org Description: - The non volatile storage exported as a raw file, as described in - Documentation/nvmem/nvmem.txt + (RW) The non volatile storage exported as a raw file, as + described in Documentation/nvmem/nvmem.txt What: /sys/class/rtc/rtcX/offset Date: February 2016 KernelVersion: 4.6 Contact: linux-rtc@vger.kernel.org Description: - The amount which the rtc clock has been adjusted in firmware. - Visible only if the driver supports clock offset adjustment. - The unit is parts per billion, i.e. The number of clock ticks - which are added to or removed from the rtc's base clock per - billion ticks. A positive value makes a day pass more slowly, - longer, and a negative value makes a day pass more quickly. + (RW) The amount which the rtc clock has been adjusted in + firmware. Visible only if the driver supports clock offset + adjustment. The unit is parts per billion, i.e. The number of + clock ticks which are added to or removed from the rtc's base + clock per billion ticks. A positive value makes a day pass more + slowly, longer, and a negative value makes a day pass more + quickly. What: /sys/class/rtc/rtcX/wakealarm Date: February 2007 KernelVersion: 2.6.20 Contact: linux-rtc@vger.kernel.org Description: - The time at which the clock will generate a system wakeup event. - This is a one shot wakeup event, so must be reset after wake if - a daily wakeup is required. Format is seconds since the epoch by - default, or if there's a leading +, seconds in the future, or if - there is a leading +=, seconds ahead of the current alarm. + (RW) The time at which the clock will generate a system wakeup + event. This is a one shot wakeup event, so must be reset after + wake if a daily wakeup is required. Format is seconds since the + epoch by default, or if there's a leading +, seconds in the + future, or if there is a leading +=, seconds ahead of the + current alarm.