From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mail-oo1-f52.google.com (mail-oo1-f52.google.com [209.85.161.52]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id A7814205E16 for ; Fri, 10 Jan 2025 17:53:25 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.161.52 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1736531607; cv=none; b=k7BrpA1MWw5RPKwBhKAwUcvd5rkvsWuIx8W/GuekvRZ2/Sho9O4mv86GrU8lDFAwf28A+s+bQfDPa85D88M1q6V+eAsAIABTwg5MxBcoOw56v8MGGIZG2Huv20B5E7Mf+WJbap0sAdnYESJjUOGaDsLPGHrWcswFzI7NBySFefo= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1736531607; c=relaxed/simple; bh=5huuw9HXKrRNxSbHfo2OvXsv35m9fsr1qEEkOID/hsc=; h=Date:From:To:Cc:Subject:Message-ID:References:MIME-Version: Content-Type:Content-Disposition:In-Reply-To; b=lAZP8xGHxeVT+6UFFwYNj7RUPxc67Rb8tJzjB2ER2dcuWIafn6TL42ee2e+aaLLDUOICdXZR3r2+8d/0luBNbKctaI44alc6ITlSL7WNANdWlieLc7H9e8sajqGWfPj77CzWqEvxN/dS7qwJTk+o+oohrBn6Z7LcHXms9t2LFzI= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=minyard.net; spf=none smtp.mailfrom=minyard.net; dkim=pass (2048-bit key) header.d=minyard-net.20230601.gappssmtp.com header.i=@minyard-net.20230601.gappssmtp.com header.b=D7JaW4fY; arc=none smtp.client-ip=209.85.161.52 Authentication-Results: smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=minyard.net Authentication-Results: smtp.subspace.kernel.org; spf=none smtp.mailfrom=minyard.net Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=minyard-net.20230601.gappssmtp.com header.i=@minyard-net.20230601.gappssmtp.com header.b="D7JaW4fY" Received: by mail-oo1-f52.google.com with SMTP id 006d021491bc7-5f6ab7e0bd6so1028165eaf.0 for ; Fri, 10 Jan 2025 09:53:25 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=minyard-net.20230601.gappssmtp.com; s=20230601; t=1736531605; x=1737136405; darn=vger.kernel.org; h=in-reply-to:content-disposition:mime-version:references:reply-to :message-id:subject:cc:to:from:date:from:to:cc:subject:date :message-id:reply-to; bh=6JOagae3dW1lR5FIp/nsWts7K+C85jj/Xatk2ej+x4U=; b=D7JaW4fYAwAm7w/aWe0t5u4UKpltxLzfe3C9WHBaufI+N76epPlKT553BtwpmvF/VC P59fCvRWmMiOOMlHvG3uxU2+hrJd7xWWxIDoo26H2IzSG9bTqkDAKi797FQ24SR75oo1 NImaKqePdaQ+MOG9IQuIYLt3o7mMwlE+bxjaMckcnx3/LY1WTdYrvmcPCJkI4dW/cAn0 KrV9XwN8e2B95xRfPga9FKAO9WYcmqBsItTBsKpCHx316qU8oUpF8XenodCW+DuylLUc l4oArQnyZC4mqAY3VIChfG9ukeedpzwqHwMb0Z9MhnoFa31xgtNGbmsLhteLtQA4qHwp VBMA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1736531605; x=1737136405; h=in-reply-to:content-disposition:mime-version:references:reply-to :message-id:subject:cc:to:from:date:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=6JOagae3dW1lR5FIp/nsWts7K+C85jj/Xatk2ej+x4U=; b=dNTlw/L+UL036ITULNcAhSWN1FWEiRpbrJ7V0isBiBUBVxjwzJCOwi6AcJPSlKsQJ9 kgeNIzS2J9y+JHDlDJ1hUqCOyAklTu6sNA0HnA7II9UStI4nuyhKjMTPMdKyZvvCxvi0 xughVIafIyeyRFPIi4NTg9hQAcfRllWKx4q3mi77snUP5vF09o5g3OBYMmLs4vppZFTj oV/oRMperZIQJ9LaMNVJeYwq94e44BaqX+jJDUDfoB+beftlWdeYzf7pw1FcgnpCGWen jI14WFQ2Wwq6PHqHx0TjGvsv4GVTFERrq38laUxfifUU546L50T3Os7AC5TS9GjmBoCd sEnQ== X-Forwarded-Encrypted: i=1; AJvYcCXPUA4wBQM2tzwfzNq/LRngK9lFsuBXfnr/V6r45mcnEbm0eg26Nmli1wa5EZ5Qvv54cL8pYf76c9l84Fc=@vger.kernel.org X-Gm-Message-State: AOJu0YzSjkPs2Z5VyK9HsfK6Aj3fSbb4T8zBR+lo056d4Kt74A4ve2hV JNSNJEFie5BBRtO7QwOkwP/9XfjBio1qAOM0/3TC4lUqfN7q+em+GrsEALjoDL0= X-Gm-Gg: ASbGncsGl/O5wbVt3mM+0G/xfr+7QvuC/crCeh8aGTZzvUnm/e+U26Spqp7RuKEyVyG lUdXP/AF7i8Xa1+Qb1NVzUGjQIuc1mXrWNh5uQDPJ942B/AmcqGTN/BeSyuTYjZN2BZX9USlHrW XWvlHGnh7qT3TucL6KOPBVUxkB53o9c6X2ZpZwWwHQjxyCwh+liEw9fqDy507wAxaFN213Mlxw5 S8+3kEHoWs5cYe6HoUq4IC0y+8Zdr5OEqrGeUDrp87VyasQzNDD9isPhceU X-Google-Smtp-Source: AGHT+IGB0PKOvj7h3ojvbM7pAuyzSK65qG5xXrDh822hP3luACM/ibUleffXIwmcp6JhMd8+ciJOnw== X-Received: by 2002:a05:6870:a691:b0:29d:c999:b90c with SMTP id 586e51a60fabf-2aa065118c4mr2126228fac.1.1736531604651; Fri, 10 Jan 2025 09:53:24 -0800 (PST) Received: from mail.minyard.net ([2001:470:b8f6:1b:1850:cb65:a40d:8a99]) by smtp.gmail.com with ESMTPSA id 586e51a60fabf-2ad804af3b6sm1080167fac.4.2025.01.10.09.53.22 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 10 Jan 2025 09:53:24 -0800 (PST) Date: Fri, 10 Jan 2025 11:53:18 -0600 From: Corey Minyard To: Rob Herring Cc: Ninad Palsule , minyard@acm.org, krzk+dt@kernel.org, conor+dt@kernel.org, andrew+netdev@lunn.ch, davem@davemloft.net, edumazet@google.com, kuba@kernel.org, pabeni@redhat.com, ratbert@faraday-tech.com, openipmi-developer@lists.sourceforge.net, netdev@vger.kernel.org, joel@jms.id.au, andrew@codeconstruct.com.au, devicetree@vger.kernel.org, eajames@linux.ibm.com, linux-arm-kernel@lists.infradead.org, linux-aspeed@lists.ozlabs.org, linux-kernel@vger.kernel.org Subject: Re: [PATCH v3 02/10] bindings: ipmi: Add binding for IPMB device intf Message-ID: Reply-To: corey@minyard.net References: <20250108163640.1374680-1-ninad@linux.ibm.com> <20250108163640.1374680-3-ninad@linux.ibm.com> <20250110160713.GA2952341-robh@kernel.org> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20250110160713.GA2952341-robh@kernel.org> On Fri, Jan 10, 2025 at 10:07:13AM -0600, Rob Herring wrote: > On Wed, Jan 08, 2025 at 10:36:30AM -0600, Ninad Palsule wrote: > > Add device tree binding document for the IPMB device interface. > > This device is already in use in both driver and .dts files. > > > > Signed-off-by: Ninad Palsule > > --- > > .../devicetree/bindings/ipmi/ipmb-dev.yaml | 44 +++++++++++++++++++ > > 1 file changed, 44 insertions(+) > > create mode 100644 Documentation/devicetree/bindings/ipmi/ipmb-dev.yaml > > > > diff --git a/Documentation/devicetree/bindings/ipmi/ipmb-dev.yaml b/Documentation/devicetree/bindings/ipmi/ipmb-dev.yaml > > new file mode 100644 > > index 000000000000..a8f46f1b883e > > --- /dev/null > > +++ b/Documentation/devicetree/bindings/ipmi/ipmb-dev.yaml > > @@ -0,0 +1,44 @@ > > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) > > +%YAML 1.2 > > +--- > > +$id: http://devicetree.org/schemas/ipmi/ipmb-dev.yaml# > > +$schema: http://devicetree.org/meta-schemas/core.yaml# > > + > > +title: IPMB Device > > + > > +description: IPMB Device interface to receive request and send response First, thank you, this does need to be documented. > > IPMB is not defined anywhere. Indeed. At least reference the spec, but better do that and provide a basic description. > > Which side of the interface does this apply to? How do I know if I have > an ipmb-dev? > > This document needs to stand on its own. Bindings exist in a standalone > tree without kernel drivers or docs. At least to someone who knows what IPMB is, it's pretty clear that you are saying "The i2c device this node is in is on an IPMB bus." However, to someone who is not, this is all a foreign language. This definitely needs better documentation. Why do you have a "reg" property? I don't see it referenced in the driver. I assume that's the I2C address, but that's going to be the same as what's in the containing I2C node. I don't think it's necessary. -corey > > > + > > +maintainers: > > + - Ninad Palsule > > + > > +properties: > > + compatible: > > + enum: > > + - ipmb-dev > > + > > + reg: > > + maxItems: 1 > > + > > + i2c-protocol: > > + description: > > + Use I2C block transfer instead of SMBUS block transfer. > > + type: boolean > > + > > +required: > > + - compatible > > + - reg > > + > > +additionalProperties: false > > + > > +examples: > > + - | > > + i2c { > > + #address-cells = <1>; > > + #size-cells = <0>; > > + > > + ipmb-dev@10 { > > + compatible = "ipmb-dev"; > > + reg = <0x10>; > > + i2c-protocol; > > + }; > > + }; > > -- > > 2.43.0 > >