[PATCH] of: add bus-number specification to spi_mpc8xxx

[Grant Likely]

[cc'd spi-devel-generial too]

On Tue, Feb 16, 2010 at 8:08 AM, Ernst Schwab <eschwab at online.de> wrote:
> Grant Likely <grant.likely at secretlab.ca> wrote:
>
>> No, unless you can provide a really compelling reason to do so, the
>> goal is to *not* specify Linux implementation detail things like bus
>> numbers in the device tree.
>>
>> Instead, your code should be using spi device child nodes from the
>> bus, or finding the spi bus node and decoding the dynamically assigned
>> bus number from there.  Don't hard code spi bus numbers.
>
> Ok, I understand that no operating system specific stuff should be
> specified in the device tree. But: the bus numbers may be specified
> by the hardware design or the used microcontroller, and I think
> there should be a way to propagate the bus name/number present in
> the hardware design to the operating system. Maybe by adding a
> 'label' property, or by parsing the node name?

Add a property to the /chosen node to assign short labels to devices.

> Documentation/spi/spi-summary tells us to use fixed numbers for SOC
> systems, but unfortunately, we have no method to specify them with
> the device tree:

That document predates SPI device tree bindings, and assumes that
platform data structures will be used to populate SPI busses.
Platform data structures require fixed numbers to line up data with
bus instances.  That problem doesn't exist when using the device tree.

Unless you're trying to line up disparate data structure, the actually
number assigned to a bus really doesn't matter.  It is better to let
Linux dynamically assign than to manually maintain the assigned bus
numbers for each machine.  Assuming dynamic assignment also protects
against breaking userspace applications when, for whatever reason, the
bus numbers get shuffled on a platform.

g.

>
> "
> Bus numbering is important, since that's how Linux identifies a given
> SPI bus (shared SCK, MOSI, MISO).  Valid bus numbers start at zero.  On
> SOC systems, the bus numbers should match the numbers defined by the chip
> manufacturer.  For example, hardware controller SPI2 would be bus number 2,
> and spi_board_info for devices connected to it would use that number.
>
> If you don't have such hardware-assigned bus number, and for some reason
> you can't just assign them, then provide a negative bus number.  That will
> then be replaced by a dynamically assigned number. You'd then need to treat
> this as a non-static configuration (see above).
> "
>
> Ernst
>
> P.S:
> Unfortunately, the proposed patch wasn't sent to the mailing list by mistake,
> so here it is again for reference.
>
> ---
> From: Ernst Schwab <eschwab at online.de>
>
> Added devicetree parsing for SPI bus number. If no bus number is specified,
> a dynamically assigned bus number will be used (typically 32766).
>
> Signed-off-by: Ernst Schwab <eschwab at online.de>
> ---
> diff -upr a/Documentation/powerpc/dts-bindings/fsl/spi.txt b/Documentation/powerpc/dts-bindings/fsl/spi.txt
> --- a/Documentation/powerpc/dts-bindings/fsl/spi.txt
> +++ b/Documentation/powerpc/dts-bindings/fsl/spi.txt
> @@ -4,6 +4,8 @@ Required properties:
>  - cell-index : SPI controller index.
>  - compatible : should be "fsl,spi".
>  - mode : the SPI operation mode, it can be "cpu" or "cpu-qe".
> +- bus-number : number of the SPI bus. If unspecified, a dynamically
> +  assigned bus number will be used.
>  - reg : Offset and length of the register set for the device
>  - interrupts : <a b> where a is the interrupt number and b is a
>   field that represents an encoding of the sense and level
> @@ -21,4 +23,5 @@ Example:
>                interrupts = <82 0>;
>                interrupt-parent = <700>;
>                mode = "cpu";
> +               bus-number = <0>;
>        };
> diff -upr a/drivers/spi/spi_mpc8xxx.c b/drivers/spi/spi_mpc8xxx.c
> --- a/drivers/spi/spi_mpc8xxx.c
> +++ b/drivers/spi/spi_mpc8xxx.c
> @@ -1230,6 +1230,8 @@ static int __devinit of_mpc8xxx_spi_prob
>        struct resource mem;
>        struct resource irq;
>        const void *prop;
> +       const int *bus_num;
> +       int len;
>        int ret = -ENOMEM;
>
>        pinfo = kzalloc(sizeof(*pinfo), GFP_KERNEL);
> @@ -1239,8 +1241,16 @@ static int __devinit of_mpc8xxx_spi_prob
>        pdata = &pinfo->pdata;
>        dev->platform_data = pdata;
>
> -       /* Allocate bus num dynamically. */
> -       pdata->bus_num = -1;
> +
> +       bus_num = of_get_property(np, "bus-number", &len);
> +       if (bus_num && len == sizeof(*bus_num)) {
> +               /* bus number is specified in node */
> +               pdata->bus_num = *bus_num;
> +       } else {
> +               /* Allocate bus num dynamically. */
> +               pdata->bus_num = -1;
> +       }
> +
>
>        /* SPI controller is either clocked from QE or SoC clock. */
>        pdata->sysclk = get_brgfreq();
>
>
>



-- 
Grant Likely, B.Sc., P.Eng.
Secret Lab Technologies Ltd.