From patchwork Tue Jul 3 07:04:11 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Andrew Jeffery X-Patchwork-Id: 10503227 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork.web.codeaurora.org (Postfix) with ESMTP id A9CCD60225 for ; Tue, 3 Jul 2018 07:05:08 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 965CF28ADE for ; Tue, 3 Jul 2018 07:05:08 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 8A3B028AE1; Tue, 3 Jul 2018 07:05:08 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-2.9 required=2.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,MAILING_LIST_MULTI autolearn=unavailable version=3.3.1 Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.wl.linuxfoundation.org (Postfix) with ESMTPS id 2B99B28ADE for ; Tue, 3 Jul 2018 07:05:08 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20170209; h=Sender: Content-Transfer-Encoding:Content-Type:MIME-Version:Cc:List-Subscribe: List-Help:List-Post:List-Archive:List-Unsubscribe:List-Id:References: In-Reply-To:Message-Id:Date:Subject:To:From:Reply-To:Content-ID: Content-Description:Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc :Resent-Message-ID:List-Owner; bh=cljsWIDpi+gXQP8xHIdiNjTg2cNoMYj2aU87jXsXUtw=; b=qT5xFEKZ5aZNCgierVvN9KzBGZ b9KSJGZZ69Czw1AKJr471Ohrkd8p4nsEH0uBC3nMl8zAGgkPeGcTbK31E4BPNDhTbNdvq1GTAciJB o7sIOpuBVn/FGPQLR20dCJWzkTeDZtxBFujrmuPwHhJ5SqSDlc6r1kBef8cKJO8ff2PE+GtbP4G3t kQ59eUWGivQKJQUTR4lnRl1tiEcF8qzy1kZw4HtW0ZuQN9BHGXrM2G86i/Dtjsaj/KheIY3BQCOCI sg5I2lkCuPn5XuYlJ3oVtLk/W68vJgnqDb3bR7enNOUBPD375XrTZYzEBiHZR3PtkHz2uskrD5Fsa rjwi4sOQ==; Received: from localhost ([127.0.0.1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.90_1 #2 (Red Hat Linux)) id 1faFMz-0007B0-PK; Tue, 03 Jul 2018 07:05:01 +0000 Received: from out1-smtp.messagingengine.com ([66.111.4.25]) by bombadil.infradead.org with esmtps (Exim 4.90_1 #2 (Red Hat Linux)) id 1faFMo-0006yV-Jo for linux-arm-kernel@lists.infradead.org; Tue, 03 Jul 2018 07:04:56 +0000 Received: from compute4.internal (compute4.nyi.internal [10.202.2.44]) by mailout.nyi.internal (Postfix) with ESMTP id 900D421E76; Tue, 3 Jul 2018 03:04:44 -0400 (EDT) Received: from mailfrontend2 ([10.202.2.163]) by compute4.internal (MEProxy); Tue, 03 Jul 2018 03:04:44 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=aj.id.au; h=cc :date:from:in-reply-to:message-id:references:subject:to :x-me-sender:x-me-sender:x-sasl-enc; s=fm3; bh=2Bi1DQGM6wLVyQtLI Ww/2fzCoBI8DeuVFPU6XvggWws=; b=LzjnyPMNHORPghz+WUjtREHW6qvnAD58T GrvW/aBR68Oml2SIqMxgaOP3ke9UoVz9L9ws8E8R6B7sudvLjsKMPcWG+B4fAKeG Vaf5saCrc6M/vL56z1NLbeMlqEOsXi5vxJgmrbGSI6YHopLUmmMHOL1weYkyOd22 WvBATEzJ229qND1qrzEkoJ04xnuZQItF6Jl/UqXoMFzr0fHyXiT+OeU3mWwNmDfv eu8SBV/rnmwn+KXXabdXO23VyckwMEaCr99fc+gO1SFz9Z14+tDIVpS5AE+cJcDe TB31sUoOawa1FRtpoZF/EaN3RQJdi0CnaEw/fDeKXcyQ0sStQ6J6w== DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:date:from:in-reply-to:message-id :references:subject:to:x-me-sender:x-me-sender:x-sasl-enc; s= fm3; bh=2Bi1DQGM6wLVyQtLIWw/2fzCoBI8DeuVFPU6XvggWws=; b=XPaobINV WLNzQn1AnAQOX92oG0720hc/yJvTlbf3XUk0YMvDjo8v3pNByuNGFGY1K6N7mbmr qqN5+O/VS3AaSg6YhUaxVf7wxN8PXg1AcZerTtUtiVyaLKP5t+xVKfkXcfRYISgD +00KXAY6PwGjihMq6/F84c2o7ZN7iBpKpmUN0Bfk9gghUq35KF6YE2XzZlqpvd9l 71nUvsVURINEapSdRMyZBpjhRJiGmTp5Xau9aEByQsnm6nkqd7+N1/lYYosGJiuc 93/aSiihuYxaSeEy1KyXpdstCeQf9k8VooAmKeNfokBgaGHauBP5bEUuf8LaV1dC phBQSS3rdEKczg== X-ME-Proxy: X-ME-Sender: Received: from dave.bha-au.ibmmobiledemo.com (unknown [202.81.18.28]) by mail.messagingengine.com (Postfix) with ESMTPA id B80E01026E; Tue, 3 Jul 2018 03:04:39 -0400 (EDT) From: Andrew Jeffery To: linux-kernel@vger.kernel.org Subject: [RFC PATCH 2/4] Documentation: ABI: Add sysfs-class-bmc documentation to testing Date: Tue, 3 Jul 2018 17:04:11 +1000 Message-Id: <20180703070413.28756-3-andrew@aj.id.au> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20180703070413.28756-1-andrew@aj.id.au> References: <20180703070413.28756-1-andrew@aj.id.au> X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20180703_000451_507560_D438FA00 X-CRM114-Status: UNSURE ( 9.92 ) X-CRM114-Notice: Please train this message. X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: mark.rutland@arm.com, devicetree@vger.kernel.org, Andrew Jeffery , gregkh@linuxfoundation.org, Eugene.Cho@dell.com, a.amelkin@yadro.com, robh+dt@kernel.org, joel@jms.id.au, stewart@linux.ibm.com, benh@kernel.crashing.org, openbmc@lists.ozlabs.org, linux-arm-kernel@lists.infradead.org MIME-Version: 1.0 Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+patchwork-linux-arm=patchwork.kernel.org@lists.infradead.org X-Virus-Scanned: ClamAV using ClamSMTP Signed-off-by: Andrew Jeffery --- Documentation/ABI/testing/sysfs-class-bmc | 62 +++++++++++++++++++++++ 1 file changed, 62 insertions(+) create mode 100644 Documentation/ABI/testing/sysfs-class-bmc diff --git a/Documentation/ABI/testing/sysfs-class-bmc b/Documentation/ABI/testing/sysfs-class-bmc new file mode 100644 index 000000000000..9d42106b89f9 --- /dev/null +++ b/Documentation/ABI/testing/sysfs-class-bmc @@ -0,0 +1,62 @@ +This document defines the sysfs attributes common to the bmc device class. See +Documentation/devicetree/bindings/misc/bmc-misc-ctrl.txt for exhaustive list of +field definitions. + +What: /sys/class/bmc//label +Date: July, 2018 +KernelVersion: v4.19 +Contact: openbmc@lists.ozlabs.org +Description: + The name of the field of interest. Corresponds to the value of + in the path +Users: openbmc@lists.ozlabs.org + +What: /sys/class/bmc//value +Date: July, 2018 +KernelVersion: v4.19 +Contact: openbmc@lists.ozlabs.org +Description: + The value of the field of interest. + + If the field is exposed from a read-modify-write register this + attribute will be RW, where writes will set the field to the + value written. Writing values that exceed the width of the + field will return an error. + + If the field is exposed from a write-1-set/write-1-clear + register this attribute will be RO, and the attributes 'set' + and 'clear' will be present as write-only. +Users: openbmc@lists.ozlabs.org + +What: /sys/class/bmc//mask +Date: July, 2018 +KernelVersion: v4.19 +Contact: openbmc@lists.ozlabs.org +Description: + The mask applied to the value read/written from the 'value' + attribute. +Users: openbmc@lists.ozlabs.org + +What: /sys/class/bmc//set +Users: openbmc@lists.ozlabs.org +Date: July, 2018 +KernelVersion: v4.19 +Contact: openbmc@lists.ozlabs.org +Description: + For fields backed by write-1-set/write-1-clear registers, + set bits in the value written will be set in hardware. Zero + values are ignored. Writing values that exceed the width of the + mask value will return an error. +Users: openbmc@lists.ozlabs.org + +What: /sys/class/bmc//clear +Users: openbmc@lists.ozlabs.org +Date: July, 2018 +KernelVersion: v4.19 +Contact: openbmc@lists.ozlabs.org +Description: + For fields backed by write-1-set/write-1-clear registers, + set bits in the value written will be cleared in hardware. Zero + values are ignored. Writing values that exceed the width of the + mask value will return an error. +Users: openbmc@lists.ozlabs.org