Re: [PATCH V2 1/2] gpio: mcp23s08: rename the device tree property

From: Mark Rutland
Date: Tue Aug 27 2013 - 10:16:52 EST

On Mon, Aug 26, 2013 at 10:46:24AM +0100, Lars Poeschel wrote:
> From: Lars Poeschel <poeschel@xxxxxxxxxxx>
>
> The device tree property should be more descriptive.
> microchip seems more reasonable than mcp. The old mcp
> prefix is still supported but marked as deprecated.
> Users of mcp have to switch to the microchip prefix.
>
> Signed-off-by: Lars Poeschel <poeschel@xxxxxxxxxxx>
> ---
> .../devicetree/bindings/gpio/gpio-mcp23s08.txt | 20 ++++++----
> drivers/gpio/gpio-mcp23s08.c | 41 ++++++++++++++++----
> 2 files changed, 46 insertions(+), 15 deletions(-)
>
> diff --git a/Documentation/devicetree/bindings/gpio/gpio-mcp23s08.txt b/Documentation/devicetree/bindings/gpio/gpio-mcp23s08.txt
> index 629d0ef..31d3ad3 100644
> --- a/Documentation/devicetree/bindings/gpio/gpio-mcp23s08.txt
> +++ b/Documentation/devicetree/bindings/gpio/gpio-mcp23s08.txt
> @@ -3,10 +3,12 @@ Microchip MCP2308/MCP23S08/MCP23017/MCP23S17 driver for
>
> Required properties:
> - compatible : Should be
> - - "mcp,mcp23s08" for 8 GPIO SPI version
> - - "mcp,mcp23s17" for 16 GPIO SPI version
> - - "mcp,mcp23008" for 8 GPIO I2C version or
> - - "mcp,mcp23017" for 16 GPIO I2C version of the chip

I would keep these lines, but suffixed "(DEPRECATED)", with the new
strings above so people notice them first.

> + - "microchip,mcp23s08" for 8 GPIO SPI version
> + - "microchip,mcp23s17" for 16 GPIO SPI version
> + - "microchip,mcp23008" for 8 GPIO I2C version or
> + - "microchip,mcp23017" for 16 GPIO I2C version of the chip
> + NOTE: Do not use the old mcp prefix any more. It is deprecated and will be
> + removed.
> - #gpio-cells : Should be two.
> - first cell is the pin number
> - second cell is used to specify flags. Flags are currently unused.
> @@ -15,10 +17,10 @@ Required properties:
> SPI uses this to specify the chipselect line which the chip is
> connected to. The driver and the SPI variant of the chip support
> multiple chips on the same chipselect. Have a look at
> - mcp,spi-present-mask below.
> + microchip,spi-present-mask below.
>
> Required device specific properties (only for SPI chips):
> -- mcp,spi-present-mask : This is a present flag, that makes only sense for SPI

Similarly I would keep this line, suffixed, referring to the new name.

With that:

Acked-by: Mark Rutland <mark.rutland@xxxxxxx>

> +- microchip,spi-present-mask : This is a present flag, that makes only sense for SPI
> chips - as the name suggests. Multiple SPI chips can share the same
> SPI chipselect. Set a bit in bit0-7 in this mask to 1 if there is a
> chip connected with the corresponding spi address set. For example if
> @@ -26,11 +28,13 @@ Required device specific properties (only for SPI chips):
> which is 0x08. mcp23s08 chip variant only supports bits 0-3. It is not
> possible to mix mcp23s08 and mcp23s17 on the same chipselect. Set at
> least one bit to 1 for SPI chips.
> + NOTE: Do not use the old mcp prefix any more. It is deprecated and will be
> + removed.
> - spi-max-frequency = The maximum frequency this chip is able to handle
>
> Example I2C:
> gpiom1: gpio@20 {
> - compatible = "mcp,mcp23017";
> + compatible = "microchip,mcp23017";
> gpio-controller;
> #gpio-cells = <2>;
> reg = <0x20>;
> @@ -38,7 +42,7 @@ gpiom1: gpio@20 {
>
> Example SPI:
> gpiom1: gpio@0 {
> - compatible = "mcp,mcp23s17";
> + compatible = "microchip,mcp23s17";
> gpio-controller;
> #gpio-cells = <2>;
> spi-present-mask = <0x01>;
> diff --git a/drivers/gpio/gpio-mcp23s08.c b/drivers/gpio/gpio-mcp23s08.c
> index 6a4470b..2f94f0f 100644
> --- a/drivers/gpio/gpio-mcp23s08.c
> +++ b/drivers/gpio/gpio-mcp23s08.c
> @@ -483,10 +483,21 @@ fail:
> #ifdef CONFIG_SPI_MASTER
> static struct of_device_id mcp23s08_spi_of_match[] = {
> {
> - .compatible = "mcp,mcp23s08", .data = (void *) MCP_TYPE_S08,
> + .compatible = "microchip,mcp23s08",
> + .data = (void *) MCP_TYPE_S08,
> },
> {
> - .compatible = "mcp,mcp23s17", .data = (void *) MCP_TYPE_S17,
> + .compatible = "microchip,mcp23s17",
> + .data = (void *) MCP_TYPE_S17,
> + },
> +/* NOTE: The use of the mcp prefix is deprecated and will be removed. */
> + {
> + .compatible = "mcp,mcp23s08",
> + .data = (void *) MCP_TYPE_S08,
> + },
> + {
> + .compatible = "mcp,mcp23s17",
> + .data = (void *) MCP_TYPE_S17,
> },
> { },
> };
> @@ -496,10 +507,21 @@ MODULE_DEVICE_TABLE(of, mcp23s08_spi_of_match);
> #if IS_ENABLED(CONFIG_I2C)
> static struct of_device_id mcp23s08_i2c_of_match[] = {
> {
> - .compatible = "mcp,mcp23008", .data = (void *) MCP_TYPE_008,
> + .compatible = "microchip,mcp23008",
> + .data = (void *) MCP_TYPE_008,
> + },
> + {
> + .compatible = "microchip,mcp23017",
> + .data = (void *) MCP_TYPE_017,
> },
> +/* NOTE: The use of the mcp prefix is deprecated and will be removed. */
> {
> - .compatible = "mcp,mcp23017", .data = (void *) MCP_TYPE_017,
> + .compatible = "mcp,mcp23008",
> + .data = (void *) MCP_TYPE_008,
> + },
> + {
> + .compatible = "mcp,mcp23017",
> + .data = (void *) MCP_TYPE_017,
> },
> { },
> };
> @@ -621,10 +643,15 @@ static int mcp23s08_probe(struct spi_device *spi)
> if (match) {
> type = (int)match->data;
> status = of_property_read_u32(spi->dev.of_node,
> - "mcp,spi-present-mask", &spi_present_mask);
> + "microchip,spi-present-mask", &spi_present_mask);
> if (status) {
> - dev_err(&spi->dev, "DT has no spi-present-mask\n");
> - return -ENODEV;
> + status = of_property_read_u32(spi->dev.of_node,
> + "mcp,spi-present-mask", &spi_present_mask);
> + if (status) {
> + dev_err(&spi->dev,
> + "DT has no spi-present-mask\n");
> + return -ENODEV;
> + }
> }
> if ((spi_present_mask <= 0) || (spi_present_mask >= 256)) {
> dev_err(&spi->dev, "invalid spi-present-mask\n");
> --
> 1.7.10.4
>
>
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/