Re: [PATCH v2 3/5] of-bindings: Add binding documentation for SPI busses and devices

2008-07-04 Thread Segher Boessenkool

+The SPI master node requires the following properties:
+- #address-cells  - number of cells required to define a chip 
select

+   address on the SPI bus.


Hrm.  Should this (and reg in the child node) be required for SPI
masters that have only one chip select?

+- max-speed   - (required) Maximum SPI clocking speed of 
device in Hz


The property name should include something SPI, it's way too generic
otherwise.

+- spi,cpol- (optional) Device requires inverse clock 
polarity

+- spi,cpha- (optional) Device requires shifted clock phase


Don't abbr the property names, there's nothing wrong with longer names.
The names shouldn't start with spi, either, spi isn't a vendor;
how about spi-inverse-clock-polarity or similar?

+- linux,modalias  - (optional, Linux specific) Force binding of 
SPI device

+   to a particular spi_device driver.  Useful for changing
+   driver binding between spidev and a kernel SPI driver.


This is a temporary workaround I hope?


Segher

___
Linuxppc-dev mailing list
Linuxppc-dev@ozlabs.org
https://ozlabs.org/mailman/listinfo/linuxppc-dev


Re: [PATCH v2 3/5] of-bindings: Add binding documentation for SPI busses and devices

2008-07-04 Thread Grant Likely
On Fri, Jul 4, 2008 at 5:36 PM, Segher Boessenkool
[EMAIL PROTECTED] wrote:
 +The SPI master node requires the following properties:
 +- #address-cells  - number of cells required to define a chip select
 +   address on the SPI bus.

 Hrm.  Should this (and reg in the child node) be required for SPI
 masters that have only one chip select?

I suppose it could be skipped, but I'd rather have it there for consistency


 +- max-speed   - (required) Maximum SPI clocking speed of device
 in Hz

 The property name should include something SPI, it's way too generic
 otherwise.

Good point; I'll change this to 'spi-max-speed'

 +- spi,cpol- (optional) Device requires inverse clock polarity
 +- spi,cpha- (optional) Device requires shifted clock phase

 Don't abbr the property names, there's nothing wrong with longer names.
 The names shouldn't start with spi, either, spi isn't a vendor;
 how about spi-inverse-clock-polarity or similar?

Okay, but cpol and cpha are common abbreviations w.r.t. SPI devices.

 +- linux,modalias  - (optional, Linux specific) Force binding of SPI
 device
 +   to a particular spi_device driver.  Useful for
 changing
 +   driver binding between spidev and a kernel SPI
 driver.

 This is a temporary workaround I hope?

Yeah, I'm kind of ashamed of this one.  I'll drop it.

g.

-- 
Grant Likely, B.Sc., P.Eng.
Secret Lab Technologies Ltd.
___
Linuxppc-dev mailing list
Linuxppc-dev@ozlabs.org
https://ozlabs.org/mailman/listinfo/linuxppc-dev


[PATCH v2 3/5] of-bindings: Add binding documentation for SPI busses and devices

2008-07-02 Thread Grant Likely
From: Grant Likely [EMAIL PROTECTED]

Add documentation about how to describe SPI busses in the device tree.

Signed-off-by: Grant Likely [EMAIL PROTECTED]
---

 Documentation/powerpc/booting-without-of.txt |   60 ++
 1 files changed, 60 insertions(+), 0 deletions(-)

diff --git a/Documentation/powerpc/booting-without-of.txt 
b/Documentation/powerpc/booting-without-of.txt
index 1d2a772..7d3564f 100644
--- a/Documentation/powerpc/booting-without-of.txt
+++ b/Documentation/powerpc/booting-without-of.txt
@@ -58,6 +58,7 @@ Table of Contents
   o) Xilinx IP cores
   p) Freescale Synchronous Serial Interface
  q) USB EHCI controllers
+  t) SPI busses
 
   VII - Marvell Discovery mv64[345]6x System Controller chips
 1) The /system-controller node
@@ -2870,6 +2871,65 @@ platforms are moved over to use the 
flattened-device-tree model.
reg = 0xe800 32;
};
 
+t) SPI (Serial Peripheral Interface) busses
+
+SPI busses can be described with a node for the SPI master device
+and a set of child nodes for each SPI slave on the bus.  For this
+discussion, it is assumed that the system's SPI controller is in
+SPI master mode.  This binding does not describe SPI controllers
+in slave mode.
+
+The SPI master node requires the following properties:
+- #address-cells  - number of cells required to define a chip select
+   address on the SPI bus.
+- #size-cells - should be zero.
+- compatible  - name of SPI bus controller following generic names
+   recommended practice.
+No other properties are required in the SPI bus node.  It is assumed
+that a driver for an SPI bus device will understand that it is an SPI bus.
+However, the binding does not attempt to define the specific method for
+assigning chip select numbers.  Since SPI chip select configuration is
+flexible and non-standardized, it is left out of this binding with the
+assumption that board specific platform code will be used to manage
+chip selects.  Individual drivers can define additional properties to
+support describing the chip select layout.
+
+SPI slave nodes must be children of the SPI master node and can
+contain the following properties.
+- reg - (required) chip select address of device.
+- compatible  - (required) name of SPI device following generic names
+   recommended practice
+- max-speed   - (required) Maximum SPI clocking speed of device in Hz
+- spi,cpol- (optional) Device requires inverse clock polarity
+- spi,cpha- (optional) Device requires shifted clock phase
+- linux,modalias  - (optional, Linux specific) Force binding of SPI device
+   to a particular spi_device driver.  Useful for changing
+   driver binding between spidev and a kernel SPI driver.
+
+SPI example for an MPC5200 SPI bus:
+   [EMAIL PROTECTED] {
+   #address-cells = 1;
+   #size-cells = 0;
+   compatible = fsl,mpc5200b-spi,fsl,mpc5200-spi;
+   reg = 0xf00 0x20;
+   interrupts = 2 13 0 2 14 0;
+   interrupt-parent = mpc5200_pic;
+
+   [EMAIL PROTECTED] {
+   compatible = micrel,ks8995m;
+   linux,modalias = ks8995;
+   max-speed = 100;
+   reg = 0;
+   };
+
+   [EMAIL PROTECTED] {
+   compatible = ti,tlv320aic26;
+   max-speed = 10;
+   reg = 1;
+   };
+   };
+
+
 VII - Marvell Discovery mv64[345]6x System Controller chips
 ===
 

___
Linuxppc-dev mailing list
Linuxppc-dev@ozlabs.org
https://ozlabs.org/mailman/listinfo/linuxppc-dev