[PATCH 0/2] iio: adc: mcp320x: Add compatible with vendor prefix and deprecate old ones

[PATCH 0/2] iio: adc: mcp320x: Add compatible with vendor prefix and deprecate old ones

[Javier Martinez Canillas]

Hello,

When the patch "iio: adc: mcp320x: Set struct spi_driver .of_match_table" [0]
was posted, there was a discussion on how to solve the fact that the driver's
compatible strings don't have a vendor prefix and are already documented in
the DT binding doc.

Rob Herring suggested [1] to add new compatible strings with a vendor prefix
and mark the old ones as deprecated. This patch series take care of that.

[0]: https://lkml.org/lkml/2015/8/20/95
[1]: https://lkml.org/lkml/2015/8/23/120

Best regards,
Javier


Javier Martinez Canillas (2):
  iio: adc: mcp320x: Deprecated compatible strings with no vendor prefix
  iio: adc: mcp320x: Add compatible with vendor prefix to OF table

 .../devicetree/bindings/iio/adc/mcp320x.txt        | 30 +++++++++++++++-------
 drivers/iio/adc/mcp320x.c                          | 28 ++++++++++++++++++++
 2 files changed, 49 insertions(+), 9 deletions(-)

-- 
2.4.3

[PATCH 1/2] iio: adc: mcp320x: Deprecated compatible strings with no vendor prefix

[Javier Martinez Canillas]

The Microchip Analog to Digital Converter (ADC) Device Tree binding
documents compatible strings with no vendor prefix. Since it should
compatible strings with also a vendor, add these to the binding doc
and mark the old ones as deprecated.

The driver says that the device is from Microchip Technology which
is listed in Documentation/devicetree/bindings/vendor-prefixes.txt
so use the documented prefix.

Signed-off-by: Javier Martinez Canillas <javier@osg.samsung.com>
---

 .../devicetree/bindings/iio/adc/mcp320x.txt        | 30 +++++++++++++++-------
 1 file changed, 21 insertions(+), 9 deletions(-)

diff --git a/Documentation/devicetree/bindings/iio/adc/mcp320x.txt b/Documentation/devicetree/bindings/iio/adc/mcp320x.txt
index 2a1f3af30155..bcd3ac8e6e0c 100644
--- a/Documentation/devicetree/bindings/iio/adc/mcp320x.txt
+++ b/Documentation/devicetree/bindings/iio/adc/mcp320x.txt
@@ -10,16 +10,28 @@ must be specified.
 Required properties:
 	- compatible:  	Must be one of the following, depending on the
 			model:
-				"mcp3001"
-				"mcp3002"
-				"mcp3004"
-				"mcp3008"
-				"mcp3201"
-				"mcp3202"
-				"mcp3204"
-				"mcp3208"
-				"mcp3301"
+				"mcp3001" (DEPRECATED)
+				"mcp3002" (DEPRECATED)
+				"mcp3004" (DEPRECATED)
+				"mcp3008" (DEPRECATED)
+				"mcp3201" (DEPRECATED)
+				"mcp3202" (DEPRECATED)
+				"mcp3204" (DEPRECATED)
+				"mcp3208" (DEPRECATED)
+				"mcp3301" (DEPRECATED)
 
+				"microchip,mcp3001"
+				"microchip,mcp3002"
+				"microchip,mcp3004"
+				"microchip,mcp3008"
+				"microchip,mcp3201"
+				"microchip,mcp3202"
+				"microchip,mcp3204"
+				"microchip,mcp3208"
+				"microchip,mcp3301"
+
+			NOTE: The use of the compatibles with no vendor prefix
+			is deprecated and only listed because old DT use them.
 
 Examples:
 spi_controller {
-- 
2.4.3

Re: [PATCH 1/2] iio: adc: mcp320x: Deprecated compatible strings with no vendor prefix

[Michael Welling]

On Wed, Oct 14, 2015 at 02:54:38PM +0200, Javier Martinez Canillas wrote:
> The Microchip Analog to Digital Converter (ADC) Device Tree binding
> documents compatible strings with no vendor prefix. Since it should
> compatible strings with also a vendor, add these to the binding doc
> and mark the old ones as deprecated.
> 
> The driver says that the device is from Microchip Technology which
> is listed in Documentation/devicetree/bindings/vendor-prefixes.txt
> so use the documented prefix.
> 
> Signed-off-by: Javier Martinez Canillas <javier@osg.samsung.com>
> ---
> 
>  .../devicetree/bindings/iio/adc/mcp320x.txt        | 30 +++++++++++++++-------
>  1 file changed, 21 insertions(+), 9 deletions(-)
> 
> diff --git a/Documentation/devicetree/bindings/iio/adc/mcp320x.txt b/Documentation/devicetree/bindings/iio/adc/mcp320x.txt
> index 2a1f3af30155..bcd3ac8e6e0c 100644
> --- a/Documentation/devicetree/bindings/iio/adc/mcp320x.txt
> +++ b/Documentation/devicetree/bindings/iio/adc/mcp320x.txt
> @@ -10,16 +10,28 @@ must be specified.
>  Required properties:
>  	- compatible:  	Must be one of the following, depending on the
>  			model:
> -				"mcp3001"
> -				"mcp3002"
> -				"mcp3004"
> -				"mcp3008"
> -				"mcp3201"
> -				"mcp3202"
> -				"mcp3204"
> -				"mcp3208"
> -				"mcp3301"
> +				"mcp3001" (DEPRECATED)
> +				"mcp3002" (DEPRECATED)
> +				"mcp3004" (DEPRECATED)
> +				"mcp3008" (DEPRECATED)
> +				"mcp3201" (DEPRECATED)
> +				"mcp3202" (DEPRECATED)
> +				"mcp3204" (DEPRECATED)
> +				"mcp3208" (DEPRECATED)
> +				"mcp3301" (DEPRECATED)
>  
> +				"microchip,mcp3001"
> +				"microchip,mcp3002"
> +				"microchip,mcp3004"
> +				"microchip,mcp3008"
> +				"microchip,mcp3201"
> +				"microchip,mcp3202"
> +				"microchip,mcp3204"
> +				"microchip,mcp3208"
> +				"microchip,mcp3301"
> +
> +			NOTE: The use of the compatibles with no vendor prefix
> +			is deprecated and only listed because old DT use them.
>

Acked-by: Michael Welling <mwelling@ieee.org>
  
>  Examples:
>  spi_controller {
> -- 
> 2.4.3
> 

Re: [PATCH 1/2] iio: adc: mcp320x: Deprecated compatible strings with no vendor prefix

[Jonathan Cameron]

On 14/10/15 16:27, Michael Welling wrote:
> On Wed, Oct 14, 2015 at 02:54:38PM +0200, Javier Martinez Canillas wrote:
>> The Microchip Analog to Digital Converter (ADC) Device Tree binding
>> documents compatible strings with no vendor prefix. Since it should
>> compatible strings with also a vendor, add these to the binding doc
>> and mark the old ones as deprecated.
>>
>> The driver says that the device is from Microchip Technology which
>> is listed in Documentation/devicetree/bindings/vendor-prefixes.txt
>> so use the documented prefix.
>>
>> Signed-off-by: Javier Martinez Canillas <javier@osg.samsung.com>
>> ---
>>
>>  .../devicetree/bindings/iio/adc/mcp320x.txt        | 30 +++++++++++++++-------
>>  1 file changed, 21 insertions(+), 9 deletions(-)
>>
>> diff --git a/Documentation/devicetree/bindings/iio/adc/mcp320x.txt b/Documentation/devicetree/bindings/iio/adc/mcp320x.txt
>> index 2a1f3af30155..bcd3ac8e6e0c 100644
>> --- a/Documentation/devicetree/bindings/iio/adc/mcp320x.txt
>> +++ b/Documentation/devicetree/bindings/iio/adc/mcp320x.txt
>> @@ -10,16 +10,28 @@ must be specified.
>>  Required properties:
>>  	- compatible:  	Must be one of the following, depending on the
>>  			model:
>> -				"mcp3001"
>> -				"mcp3002"
>> -				"mcp3004"
>> -				"mcp3008"
>> -				"mcp3201"
>> -				"mcp3202"
>> -				"mcp3204"
>> -				"mcp3208"
>> -				"mcp3301"
>> +				"mcp3001" (DEPRECATED)
>> +				"mcp3002" (DEPRECATED)
>> +				"mcp3004" (DEPRECATED)
>> +				"mcp3008" (DEPRECATED)
>> +				"mcp3201" (DEPRECATED)
>> +				"mcp3202" (DEPRECATED)
>> +				"mcp3204" (DEPRECATED)
>> +				"mcp3208" (DEPRECATED)
>> +				"mcp3301" (DEPRECATED)
>>  
>> +				"microchip,mcp3001"
>> +				"microchip,mcp3002"
>> +				"microchip,mcp3004"
>> +				"microchip,mcp3008"
>> +				"microchip,mcp3201"
>> +				"microchip,mcp3202"
>> +				"microchip,mcp3204"
>> +				"microchip,mcp3208"
>> +				"microchip,mcp3301"
>> +
>> +			NOTE: The use of the compatibles with no vendor prefix
>> +			is deprecated and only listed because old DT use them.
>>
> 
> Acked-by: Michael Welling <mwelling@ieee.org>
Small point, Michael. Please add such acks below the the Author sign off.
Otherwise sometimes I miss them!  Added it now for this one.
>   
>>  Examples:
>>  spi_controller {
>> -- 
>> 2.4.3
>>

Re: [PATCH 1/2] iio: adc: mcp320x: Deprecated compatible strings with no vendor prefix

[Michael Welling]

On Sun, Oct 25, 2015 at 12:36:37PM +0000, Jonathan Cameron wrote:
> Small point, Michael. Please add such acks below the the Author sign off.
> Otherwise sometimes I miss them!  Added it now for this one.

Okay sorry about the misplacement.

Re: [PATCH 1/2] iio: adc: mcp320x: Deprecated compatible strings with no vendor prefix

[Jonathan Cameron]

On 14/10/15 13:54, Javier Martinez Canillas wrote:
> The Microchip Analog to Digital Converter (ADC) Device Tree binding
> documents compatible strings with no vendor prefix. Since it should
> compatible strings with also a vendor, add these to the binding doc
> and mark the old ones as deprecated.
> 
> The driver says that the device is from Microchip Technology which
> is listed in Documentation/devicetree/bindings/vendor-prefixes.txt
> so use the documented prefix.
> 
> Signed-off-by: Javier Martinez Canillas <javier@osg.samsung.com>
Applied to the togreg branch of iio.git - initially pushed out as testing.
Thanks,
> ---
> 
>  .../devicetree/bindings/iio/adc/mcp320x.txt        | 30 +++++++++++++++-------
>  1 file changed, 21 insertions(+), 9 deletions(-)
> 
> diff --git a/Documentation/devicetree/bindings/iio/adc/mcp320x.txt b/Documentation/devicetree/bindings/iio/adc/mcp320x.txt
> index 2a1f3af30155..bcd3ac8e6e0c 100644
> --- a/Documentation/devicetree/bindings/iio/adc/mcp320x.txt
> +++ b/Documentation/devicetree/bindings/iio/adc/mcp320x.txt
> @@ -10,16 +10,28 @@ must be specified.
>  Required properties:
>  	- compatible:  	Must be one of the following, depending on the
>  			model:
> -				"mcp3001"
> -				"mcp3002"
> -				"mcp3004"
> -				"mcp3008"
> -				"mcp3201"
> -				"mcp3202"
> -				"mcp3204"
> -				"mcp3208"
> -				"mcp3301"
> +				"mcp3001" (DEPRECATED)
> +				"mcp3002" (DEPRECATED)
> +				"mcp3004" (DEPRECATED)
> +				"mcp3008" (DEPRECATED)
> +				"mcp3201" (DEPRECATED)
> +				"mcp3202" (DEPRECATED)
> +				"mcp3204" (DEPRECATED)
> +				"mcp3208" (DEPRECATED)
> +				"mcp3301" (DEPRECATED)
>  
> +				"microchip,mcp3001"
> +				"microchip,mcp3002"
> +				"microchip,mcp3004"
> +				"microchip,mcp3008"
> +				"microchip,mcp3201"
> +				"microchip,mcp3202"
> +				"microchip,mcp3204"
> +				"microchip,mcp3208"
> +				"microchip,mcp3301"
> +
> +			NOTE: The use of the compatibles with no vendor prefix
> +			is deprecated and only listed because old DT use them.
>  
>  Examples:
>  spi_controller {
> 

[PATCH 2/2] iio: adc: mcp320x: Add compatible with vendor prefix to OF table

[Javier Martinez Canillas]

The driver Device Tree binding now documents compatible strings that have
a vendor prefix, so add these to the OF device ID table to match and mark
the old ones as deprecated explaining that should not be used anymore.

Signed-off-by: Javier Martinez Canillas <javier@osg.samsung.com>

---

 drivers/iio/adc/mcp320x.c | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)

diff --git a/drivers/iio/adc/mcp320x.c b/drivers/iio/adc/mcp320x.c
index 41a21e986c1a..9fcb8b61e300 100644
--- a/drivers/iio/adc/mcp320x.c
+++ b/drivers/iio/adc/mcp320x.c
@@ -354,6 +354,7 @@ static int mcp320x_remove(struct spi_device *spi)
 
 #if defined(CONFIG_OF)
 static const struct of_device_id mcp320x_dt_ids[] = {
+	/* NOTE: The use of compatibles with no vendor prefix is deprecated. */
 	{
 		.compatible = "mcp3001",
 		.data = &mcp320x_chip_infos[mcp3001],
@@ -382,6 +383,33 @@ static const struct of_device_id mcp320x_dt_ids[] = {
 		.compatible = "mcp3301",
 		.data = &mcp320x_chip_infos[mcp3301],
 	}, {
+		.compatible = "microchip,mcp3001",
+		.data = &mcp320x_chip_infos[mcp3001],
+	}, {
+		.compatible = "microchip,mcp3002",
+		.data = &mcp320x_chip_infos[mcp3002],
+	}, {
+		.compatible = "microchip,mcp3004",
+		.data = &mcp320x_chip_infos[mcp3004],
+	}, {
+		.compatible = "microchip,mcp3008",
+		.data = &mcp320x_chip_infos[mcp3008],
+	}, {
+		.compatible = "microchip,mcp3201",
+		.data = &mcp320x_chip_infos[mcp3201],
+	}, {
+		.compatible = "microchip,mcp3202",
+		.data = &mcp320x_chip_infos[mcp3202],
+	}, {
+		.compatible = "microchip,mcp3204",
+		.data = &mcp320x_chip_infos[mcp3204],
+	}, {
+		.compatible = "microchip,mcp3208",
+		.data = &mcp320x_chip_infos[mcp3208],
+	}, {
+		.compatible = "microchip,mcp3301",
+		.data = &mcp320x_chip_infos[mcp3301],
+	}, {
 	}
 };
 MODULE_DEVICE_TABLE(of, mcp320x_dt_ids);
-- 
2.4.3

Re: [PATCH 2/2] iio: adc: mcp320x: Add compatible with vendor prefix to OF table

[Michael Welling]

On Wed, Oct 14, 2015 at 02:54:39PM +0200, Javier Martinez Canillas wrote:
> The driver Device Tree binding now documents compatible strings that have
> a vendor prefix, so add these to the OF device ID table to match and mark
> the old ones as deprecated explaining that should not be used anymore.
> 
> Signed-off-by: Javier Martinez Canillas <javier@osg.samsung.com>
> 
> ---
> 
>  drivers/iio/adc/mcp320x.c | 28 ++++++++++++++++++++++++++++
>  1 file changed, 28 insertions(+)
> 
> diff --git a/drivers/iio/adc/mcp320x.c b/drivers/iio/adc/mcp320x.c
> index 41a21e986c1a..9fcb8b61e300 100644
> --- a/drivers/iio/adc/mcp320x.c
> +++ b/drivers/iio/adc/mcp320x.c
> @@ -354,6 +354,7 @@ static int mcp320x_remove(struct spi_device *spi)
>  
>  #if defined(CONFIG_OF)
>  static const struct of_device_id mcp320x_dt_ids[] = {
> +	/* NOTE: The use of compatibles with no vendor prefix is deprecated. */
>  	{
>  		.compatible = "mcp3001",
>  		.data = &mcp320x_chip_infos[mcp3001],
> @@ -382,6 +383,33 @@ static const struct of_device_id mcp320x_dt_ids[] = {
>  		.compatible = "mcp3301",
>  		.data = &mcp320x_chip_infos[mcp3301],
>  	}, {
> +		.compatible = "microchip,mcp3001",
> +		.data = &mcp320x_chip_infos[mcp3001],
> +	}, {
> +		.compatible = "microchip,mcp3002",
> +		.data = &mcp320x_chip_infos[mcp3002],
> +	}, {
> +		.compatible = "microchip,mcp3004",
> +		.data = &mcp320x_chip_infos[mcp3004],
> +	}, {
> +		.compatible = "microchip,mcp3008",
> +		.data = &mcp320x_chip_infos[mcp3008],
> +	}, {
> +		.compatible = "microchip,mcp3201",
> +		.data = &mcp320x_chip_infos[mcp3201],
> +	}, {
> +		.compatible = "microchip,mcp3202",
> +		.data = &mcp320x_chip_infos[mcp3202],
> +	}, {
> +		.compatible = "microchip,mcp3204",
> +		.data = &mcp320x_chip_infos[mcp3204],
> +	}, {
> +		.compatible = "microchip,mcp3208",
> +		.data = &mcp320x_chip_infos[mcp3208],
> +	}, {
> +		.compatible = "microchip,mcp3301",
> +		.data = &mcp320x_chip_infos[mcp3301],
> +	}, {

Acked-by: Michael Welling <mwelling@ieee.org>

>  	}
>  };
>  MODULE_DEVICE_TABLE(of, mcp320x_dt_ids);
> -- 
> 2.4.3
> 

Re: [PATCH 2/2] iio: adc: mcp320x: Add compatible with vendor prefix to OF table

[Jonathan Cameron]

On 14/10/15 16:27, Michael Welling wrote:
> On Wed, Oct 14, 2015 at 02:54:39PM +0200, Javier Martinez Canillas wrote:
>> The driver Device Tree binding now documents compatible strings that have
>> a vendor prefix, so add these to the OF device ID table to match and mark
>> the old ones as deprecated explaining that should not be used anymore.
>>
>> Signed-off-by: Javier Martinez Canillas <javier@osg.samsung.com>
>>
>> ---
>>
>>  drivers/iio/adc/mcp320x.c | 28 ++++++++++++++++++++++++++++
>>  1 file changed, 28 insertions(+)
>>
>> diff --git a/drivers/iio/adc/mcp320x.c b/drivers/iio/adc/mcp320x.c
>> index 41a21e986c1a..9fcb8b61e300 100644
>> --- a/drivers/iio/adc/mcp320x.c
>> +++ b/drivers/iio/adc/mcp320x.c
>> @@ -354,6 +354,7 @@ static int mcp320x_remove(struct spi_device *spi)
>>  
>>  #if defined(CONFIG_OF)
>>  static const struct of_device_id mcp320x_dt_ids[] = {
>> +	/* NOTE: The use of compatibles with no vendor prefix is deprecated. */
>>  	{
>>  		.compatible = "mcp3001",
>>  		.data = &mcp320x_chip_infos[mcp3001],
>> @@ -382,6 +383,33 @@ static const struct of_device_id mcp320x_dt_ids[] = {
>>  		.compatible = "mcp3301",
>>  		.data = &mcp320x_chip_infos[mcp3301],
>>  	}, {
>> +		.compatible = "microchip,mcp3001",
>> +		.data = &mcp320x_chip_infos[mcp3001],
>> +	}, {
>> +		.compatible = "microchip,mcp3002",
>> +		.data = &mcp320x_chip_infos[mcp3002],
>> +	}, {
>> +		.compatible = "microchip,mcp3004",
>> +		.data = &mcp320x_chip_infos[mcp3004],
>> +	}, {
>> +		.compatible = "microchip,mcp3008",
>> +		.data = &mcp320x_chip_infos[mcp3008],
>> +	}, {
>> +		.compatible = "microchip,mcp3201",
>> +		.data = &mcp320x_chip_infos[mcp3201],
>> +	}, {
>> +		.compatible = "microchip,mcp3202",
>> +		.data = &mcp320x_chip_infos[mcp3202],
>> +	}, {
>> +		.compatible = "microchip,mcp3204",
>> +		.data = &mcp320x_chip_infos[mcp3204],
>> +	}, {
>> +		.compatible = "microchip,mcp3208",
>> +		.data = &mcp320x_chip_infos[mcp3208],
>> +	}, {
>> +		.compatible = "microchip,mcp3301",
>> +		.data = &mcp320x_chip_infos[mcp3301],
>> +	}, {
> 
> Acked-by: Michael Welling <mwelling@ieee.org>
Applied to the togreg branch of iio.git - initially pushed out as
testing for the autobuilders to play with it.

Thanks,

Jonathan
> 
>>  	}
>>  };
>>  MODULE_DEVICE_TABLE(of, mcp320x_dt_ids);
>> -- 
>> 2.4.3
>>
> --
> To unsubscribe from this list: send the line "unsubscribe linux-iio" in
> the body of a message to majordomo@vger.kernel.org
> More majordomo info at  http://vger.kernel.org/majordomo-info.html
>