Skip to contentSkip to conversation

remove DMA_nBIT_MASK macro

PATCH In review FUJITA Tomonori 5 participants 17 messages May 7, 2009 – May 11, 2009

Subsystems (6)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 remove DMA_nBIT_MASK macro

We replaced all DMA_nBIT_MASK macros with DMA_BIT_MASK(n) but why do we still keep DMA_nBIT_MASK macros in include/linux/dma-mapping.h?

As long as these macros exist, people use them. The current git has two users and linux-next have other users.

Is it better to remove DMA_nBIT_MASK macros completely now?

=
From: FUJITA Tomonori <[email protected]>
Subject: [PATCH] remove DMA_nBIT_MASK macros

This removes DMA_nBIT_MASK macros in dma-mapping.h so that we will not have any new users.

---
 arch/arm/mach-davinci/board-dm644x-evm.c |    4 ++--
 drivers/net/igbvf/netdev.c               |   13 +++++++------
 include/linux/dma-mapping.h              |   19 -------------------
 3 files changed, 9 insertions(+), 27 deletions(-)
arch/arm/mach-davinci/board-dm644x-evm.c +2 -2
index c039674..b2e7f9c 100644
@@ -211,7 +211,7 @@ static struct resource ide_resources[] = {
 	},
 };
 
-static u64 ide_dma_mask = DMA_32BIT_MASK;
+static u64 ide_dma_mask = DMA_BIT_MASK(32);
 
 static struct platform_device ide_dev = {
 	.name           = "palm_bk3710",
@@ -220,7 +220,7 @@ static struct platform_device ide_dev = {
 	.num_resources  = ARRAY_SIZE(ide_resources),
 	.dev = {
 		.dma_mask		= &ide_dma_mask,
-		.coherent_dma_mask      = DMA_32BIT_MASK,
+		.coherent_dma_mask      = DMA_BIT_MASK(32),
 	},
 };
 
drivers/net/igbvf/netdev.c +7 -6
index b774666..c084d3b 100644
@@ -1279,7 +1279,7 @@ static void igbvf_configure_tx(struct igbvf_adapter *adapter)
 	/* Setup the HW Tx Head and Tail descriptor pointers */
 	ew32(TDLEN(0), tx_ring->count * sizeof(union e1000_adv_tx_desc));
 	tdba = tx_ring->dma;
-	ew32(TDBAL(0), (tdba & DMA_32BIT_MASK));
+	ew32(TDBAL(0), (tdba & DMA_BIT_MASK(32)));
 	ew32(TDBAH(0), (tdba >> 32));
 	ew32(TDH(0), 0);
 	ew32(TDT(0), 0);
@@ -1365,7 +1365,7 @@ static void igbvf_configure_rx(struct igbvf_adapter *adapter)
 	 * the Base and Length of the Rx Descriptor Ring
 	 */
 	rdba = rx_ring->dma;
-	ew32(RDBAL(0), (rdba & DMA_32BIT_MASK));
+	ew32(RDBAL(0), (rdba & DMA_BIT_MASK(32)));
 	ew32(RDBAH(0), (rdba >> 32));
 	ew32(RDLEN(0), rx_ring->count * sizeof(union e1000_adv_rx_desc));
 	rx_ring->head = E1000_RDH(0);
@@ -2637,15 +2637,16 @@ static int __devinit igbvf_probe(struct pci_dev *pdev,
 		return err;
 
 	pci_using_dac = 0;
-	err = pci_set_dma_mask(pdev, DMA_64BIT_MASK);
+	err = pci_set_dma_mask(pdev, DMA_BIT_MASK(64));
 	if (!err) {
-		err = pci_set_consistent_dma_mask(pdev, DMA_64BIT_MASK);
+		err = pci_set_consistent_dma_mask(pdev, DMA_BIT_MASK(64));
 		if (!err)
 			pci_using_dac = 1;
 	} else {
-		err = pci_set_dma_mask(pdev, DMA_32BIT_MASK);
+		err = pci_set_dma_mask(pdev, DMA_BIT_MASK(32));
 		if (err) {
-			err = pci_set_consistent_dma_mask(pdev, DMA_32BIT_MASK);
+			err = pci_set_consistent_dma_mask(pdev,
+							  DMA_BIT_MASK(32));
 			if (err) {
 				dev_err(&pdev->dev, "No usable DMA "
 				        "configuration, aborting\n");
include/linux/dma-mapping.h +0 -19
index 8083b6a..f56e607 100644
@@ -63,25 +63,6 @@ struct dma_map_ops {
 
 #define DMA_BIT_MASK(n)	(((n) == 64) ? ~0ULL : ((1ULL<<(n))-1))
 
-/*
- * NOTE: do not use the below macros in new code and do not add new definitions
- * here.
- *
- * Instead, just open-code DMA_BIT_MASK(n) within your driver
- */
-#define DMA_64BIT_MASK	DMA_BIT_MASK(64)
-#define DMA_48BIT_MASK	DMA_BIT_MASK(48)
-#define DMA_47BIT_MASK	DMA_BIT_MASK(47)
-#define DMA_40BIT_MASK	DMA_BIT_MASK(40)
-#define DMA_39BIT_MASK	DMA_BIT_MASK(39)
-#define DMA_35BIT_MASK	DMA_BIT_MASK(35)
-#define DMA_32BIT_MASK	DMA_BIT_MASK(32)
-#define DMA_31BIT_MASK	DMA_BIT_MASK(31)
-#define DMA_30BIT_MASK	DMA_BIT_MASK(30)
-#define DMA_29BIT_MASK	DMA_BIT_MASK(29)
-#define DMA_28BIT_MASK	DMA_BIT_MASK(28)
-#define DMA_24BIT_MASK	DMA_BIT_MASK(24)
-
 #define DMA_MASK_NONE	0x0ULL
 
 static inline int valid_dma_direction(int dma_direction)
Signature · 1 line
1.6.0.6
Reviewed-by on v1 1/1
#1 lore raw
Quoted 8 lines · FUJITA Tomonori

We replaced all DMA_nBIT_MASK macros with DMA_BIT_MASK(n) but why do we still keep DMA_nBIT_MASK macros in include/linux/dma-mapping.h?

As long as these macros exist, people use them. The current git has two users and linux-next have other users.

Is it better to remove DMA_nBIT_MASK macros completely now?

CC ingo

I have no objections,actually I used to remove all these defines in my first commit of these patch series,but got suggestions that keep these defines one more circle.Maybe it's time to remove these defines now or to remove at the end of this circle?

Reviewed-by [email protected]
Quoted 84 lines

=
From: FUJITA Tomonori <[email protected]>
Subject: [PATCH] remove DMA_nBIT_MASK macros

This removes DMA_nBIT_MASK macros in dma-mapping.h so that we will not have any new users.

---
 arch/arm/mach-davinci/board-dm644x-evm.c |    4 ++--
 drivers/net/igbvf/netdev.c               |   13 +++++++------
 include/linux/dma-mapping.h              |   19 -------------------
 3 files changed, 9 insertions(+), 27 deletions(-)
arch/arm/mach-davinci/board-dm644x-evm.c +2 -2
index c039674..b2e7f9c 100644
@@ -211,7 +211,7 @@ static struct resource ide_resources[] = {
 	},
 };
 
-static u64 ide_dma_mask = DMA_32BIT_MASK;
+static u64 ide_dma_mask = DMA_BIT_MASK(32);
 
 static struct platform_device ide_dev = {
 	.name           = "palm_bk3710",
@@ -220,7 +220,7 @@ static struct platform_device ide_dev = {
 	.num_resources  = ARRAY_SIZE(ide_resources),
 	.dev = {
 		.dma_mask		= &ide_dma_mask,
-		.coherent_dma_mask      = DMA_32BIT_MASK,
+		.coherent_dma_mask      = DMA_BIT_MASK(32),
 	},
 };
 
drivers/net/igbvf/netdev.c +7 -6
index b774666..c084d3b 100644
@@ -1279,7 +1279,7 @@ static void igbvf_configure_tx(struct igbvf_adapter *adapter)
 	/* Setup the HW Tx Head and Tail descriptor pointers */
 	ew32(TDLEN(0), tx_ring->count * sizeof(union e1000_adv_tx_desc));
 	tdba = tx_ring->dma;
-	ew32(TDBAL(0), (tdba & DMA_32BIT_MASK));
+	ew32(TDBAL(0), (tdba & DMA_BIT_MASK(32)));
 	ew32(TDBAH(0), (tdba >> 32));
 	ew32(TDH(0), 0);
 	ew32(TDT(0), 0);
@@ -1365,7 +1365,7 @@ static void igbvf_configure_rx(struct igbvf_adapter *adapter)
 	 * the Base and Length of the Rx Descriptor Ring
 	 */
 	rdba = rx_ring->dma;
-	ew32(RDBAL(0), (rdba & DMA_32BIT_MASK));
+	ew32(RDBAL(0), (rdba & DMA_BIT_MASK(32)));
 	ew32(RDBAH(0), (rdba >> 32));
 	ew32(RDLEN(0), rx_ring->count * sizeof(union e1000_adv_rx_desc));
 	rx_ring->head = E1000_RDH(0);
@@ -2637,15 +2637,16 @@ static int __devinit igbvf_probe(struct pci_dev *pdev,
 		return err;
 
 	pci_using_dac = 0;
-	err = pci_set_dma_mask(pdev, DMA_64BIT_MASK);
+	err = pci_set_dma_mask(pdev, DMA_BIT_MASK(64));
 	if (!err) {
-		err = pci_set_consistent_dma_mask(pdev, DMA_64BIT_MASK);
+		err = pci_set_consistent_dma_mask(pdev, DMA_BIT_MASK(64));
 		if (!err)
 			pci_using_dac = 1;
 	} else {
-		err = pci_set_dma_mask(pdev, DMA_32BIT_MASK);
+		err = pci_set_dma_mask(pdev, DMA_BIT_MASK(32));
 		if (err) {
-			err = pci_set_consistent_dma_mask(pdev, DMA_32BIT_MASK);
+			err = pci_set_consistent_dma_mask(pdev,
+							  DMA_BIT_MASK(32));
 			if (err) {
 				dev_err(&pdev->dev, "No usable DMA "
 				        "configuration, aborting\n");
include/linux/dma-mapping.h +0 -0
index 8083b6a..f56e607 100644

include/linux/dma-mapping.h struct dma_map_ops { · line 63

Quoted 1 line
include/linux/dma-mapping.h +0 -0
@@ -63,25 +63,6 @@ struct dma_map_ops {
 

Is it better to add a comment here to tell people that the old macro was deleted?

Quoted 24 lines
include/linux/dma-mapping.h +0 -19
 #define DMA_BIT_MASK(n)	(((n) == 64) ? ~0ULL : ((1ULL<<(n))-1))
 
-/*
- * NOTE: do not use the below macros in new code and do not add new definitions
- * here.
- *
- * Instead, just open-code DMA_BIT_MASK(n) within your driver
- */
-#define DMA_64BIT_MASK	DMA_BIT_MASK(64)
-#define DMA_48BIT_MASK	DMA_BIT_MASK(48)
-#define DMA_47BIT_MASK	DMA_BIT_MASK(47)
-#define DMA_40BIT_MASK	DMA_BIT_MASK(40)
-#define DMA_39BIT_MASK	DMA_BIT_MASK(39)
-#define DMA_35BIT_MASK	DMA_BIT_MASK(35)
-#define DMA_32BIT_MASK	DMA_BIT_MASK(32)
-#define DMA_31BIT_MASK	DMA_BIT_MASK(31)
-#define DMA_30BIT_MASK	DMA_BIT_MASK(30)
-#define DMA_29BIT_MASK	DMA_BIT_MASK(29)
-#define DMA_28BIT_MASK	DMA_BIT_MASK(28)
-#define DMA_24BIT_MASK	DMA_BIT_MASK(24)
-
 #define DMA_MASK_NONE	0x0ULL
 
 static inline int valid_dma_direction(int dma_direction)
Signature · 2 lines
Regards
Yang Hongyang
#2 lore raw
Quoted 8 lines · Yang Hongyang
Quoted 7 lines · FUJITA Tomonori

We replaced all DMA_nBIT_MASK macros with DMA_BIT_MASK(n) but why do we still keep DMA_nBIT_MASK macros in include/linux/dma-mapping.h?

As long as these macros exist, people use them. The current git has two users and linux-next have other users.

Is it better to remove DMA_nBIT_MASK macros completely now?

Can you see a way to emit build warnings? If yes then that might be a better solution instead of breaking in-the-pipeline code. We missed the upstream window of removing the facilities altogether, we could certainly do that in the next merge window though.

Quoted 8 lines
CC ingo

I have no objections,actually I used to remove all these defines in my first commit of these patch series,but got suggestions that keep these defines one more circle.Maybe it's time to remove these defines now or to remove at the end of this circle?

Reviewed-by [email protected]

Thanks!

Ingo

#3 lore raw
Quoted 7 lines · On Thu, 7 May 2009 13:18:46 +0200 Ingo Molnar <[email protected]> wrote:
Quoted 4 lines · Yang Hongyang
Quoted 3 lines · FUJITA Tomonori

We replaced all DMA_nBIT_MASK macros with DMA_BIT_MASK(n) but why do we still keep DMA_nBIT_MASK macros in include/linux/dma-mapping.h?

Quoted 7 lines
Quoted 4 lines
Quoted 4 lines

As long as these macros exist, people use them. The current git has two users and linux-next have other users.

Is it better to remove DMA_nBIT_MASK macros completely now?

Can you see a way to emit build warnings? If yes then that might be a better solution instead of breaking in-the-pipeline code.

Unfortunately, no. Since 2.6.24, include/linux/dma-mapping.h has the warning:

/*
* NOTE: do not use the below macros in new code and do not add new definitions
* here.
*
* Instead, just open-code DMA_BIT_MASK(n) within your driver
*/

IMO, we give people enough time for migration.

Quoted 2 lines

We missed the upstream window of removing the facilities altogether, we could certainly do that in the next merge window though.

Can you apply this patch to the tip? I want to have this patch in linux-next to let new users of DMA-nBIT_MASK in linux-next know that they use wrong macros.

#4 lore raw

PATCH 1/1 DMA: mark DMA_nBITS_MASK as deprecated

In reply to Ingo Molnar
Quoted 2 lines · Ingo Molnar

Can you see a way to emit build warnings? If yes then that might be a better solution instead of breaking in-the-pipeline code.

What about this:
--

Mark them deprecated so that 3rd party vendors get notified about that before their modules break by removing those macros later.

---
 include/linux/dma-mapping.h |   26 ++++++++++++++------------
 1 files changed, 14 insertions(+), 12 deletions(-)
include/linux/dma-mapping.h +14 -12
index 8083b6a..6bf3339 100644
@@ -63,24 +63,26 @@ struct dma_map_ops {
 
 #define DMA_BIT_MASK(n)	(((n) == 64) ? ~0ULL : ((1ULL<<(n))-1))
 
+typedef u64 DMA_DEPRECATED __deprecated;
+
 /*
  * NOTE: do not use the below macros in new code and do not add new definitions
  * here.
  *
  * Instead, just open-code DMA_BIT_MASK(n) within your driver
  */
-#define DMA_64BIT_MASK	DMA_BIT_MASK(64)
-#define DMA_48BIT_MASK	DMA_BIT_MASK(48)
-#define DMA_47BIT_MASK	DMA_BIT_MASK(47)
-#define DMA_40BIT_MASK	DMA_BIT_MASK(40)
-#define DMA_39BIT_MASK	DMA_BIT_MASK(39)
-#define DMA_35BIT_MASK	DMA_BIT_MASK(35)
-#define DMA_32BIT_MASK	DMA_BIT_MASK(32)
-#define DMA_31BIT_MASK	DMA_BIT_MASK(31)
-#define DMA_30BIT_MASK	DMA_BIT_MASK(30)
-#define DMA_29BIT_MASK	DMA_BIT_MASK(29)
-#define DMA_28BIT_MASK	DMA_BIT_MASK(28)
-#define DMA_24BIT_MASK	DMA_BIT_MASK(24)
+#define DMA_64BIT_MASK	(DMA_DEPRECATED)DMA_BIT_MASK(64)
+#define DMA_48BIT_MASK	(DMA_DEPRECATED)DMA_BIT_MASK(48)
+#define DMA_47BIT_MASK	(DMA_DEPRECATED)DMA_BIT_MASK(47)
+#define DMA_40BIT_MASK	(DMA_DEPRECATED)DMA_BIT_MASK(40)
+#define DMA_39BIT_MASK	(DMA_DEPRECATED)DMA_BIT_MASK(39)
+#define DMA_35BIT_MASK	(DMA_DEPRECATED)DMA_BIT_MASK(35)
+#define DMA_32BIT_MASK	(DMA_DEPRECATED)DMA_BIT_MASK(32)
+#define DMA_31BIT_MASK	(DMA_DEPRECATED)DMA_BIT_MASK(31)
+#define DMA_30BIT_MASK	(DMA_DEPRECATED)DMA_BIT_MASK(30)
+#define DMA_29BIT_MASK	(DMA_DEPRECATED)DMA_BIT_MASK(29)
+#define DMA_28BIT_MASK	(DMA_DEPRECATED)DMA_BIT_MASK(28)
+#define DMA_24BIT_MASK	(DMA_DEPRECATED)DMA_BIT_MASK(24)
 
 #define DMA_MASK_NONE	0x0ULL
 
Signature · 1 line
1.6.2.4
author Acked-by on v1 1/1
#5 lore raw

Re: [PATCH 1/1] DMA: mark DMA_nBITS_MASK as deprecated

Quoted 7 lines · On Fri, 8 May 2009 10:00:38 +0200 Jiri Slaby <[email protected]> wrote:
Quoted 2 lines · Ingo Molnar

Can you see a way to emit build warnings? If yes then that might be a better solution instead of breaking in-the-pipeline code.

What about this:
--

Quoted 7 lines

Mark them deprecated so that 3rd party vendors get notified about that before their modules break by removing those macros later.

---
 include/linux/dma-mapping.h |   26 ++++++++++++++------------
 1 files changed, 14 insertions(+), 12 deletions(-)

Ah, nice magic!

Well, "warning: 'DMA_DEPRECATED' is deprecated" warning message is a bit obscure but the developers should notice that they do something wrong.

Thanks a lot,

#6 lore raw

PATCH 1/1 dma-mapping: mark DMA_nBITS_MASK as deprecated fix

Andrew, please fold into
dma-mapping: mark DMA_nBITS_MASK as deprecated --

As Fujita correctly demurs, use more meaningful typedef name, so that we now see:
warning: DMA_nnBIT_MASK is deprecated
instead of
warning: DMA_DEPRECATED is deprecated

Cc Yang Hongyang <[email protected]>
Cc FUJITA Tomonori <[email protected]>
Cc Ingo Molnar <[email protected]>
---
 include/linux/dma-mapping.h |   26 +++++++++++++-------------
 1 files changed, 13 insertions(+), 13 deletions(-)
include/linux/dma-mapping.h +13 -13
index 6bf3339..38f5608 100644
@@ -63,7 +63,7 @@ struct dma_map_ops {
 
 #define DMA_BIT_MASK(n)	(((n) == 64) ? ~0ULL : ((1ULL<<(n))-1))
 
-typedef u64 DMA_DEPRECATED __deprecated;
+typedef u64 DMA_nnBIT_MASK __deprecated;
 
 /*
  * NOTE: do not use the below macros in new code and do not add new definitions
@@ -71,18 +71,18 @@ typedef u64 DMA_DEPRECATED __deprecated;
  *
  * Instead, just open-code DMA_BIT_MASK(n) within your driver
  */
-#define DMA_64BIT_MASK	(DMA_DEPRECATED)DMA_BIT_MASK(64)
-#define DMA_48BIT_MASK	(DMA_DEPRECATED)DMA_BIT_MASK(48)
-#define DMA_47BIT_MASK	(DMA_DEPRECATED)DMA_BIT_MASK(47)
-#define DMA_40BIT_MASK	(DMA_DEPRECATED)DMA_BIT_MASK(40)
-#define DMA_39BIT_MASK	(DMA_DEPRECATED)DMA_BIT_MASK(39)
-#define DMA_35BIT_MASK	(DMA_DEPRECATED)DMA_BIT_MASK(35)
-#define DMA_32BIT_MASK	(DMA_DEPRECATED)DMA_BIT_MASK(32)
-#define DMA_31BIT_MASK	(DMA_DEPRECATED)DMA_BIT_MASK(31)
-#define DMA_30BIT_MASK	(DMA_DEPRECATED)DMA_BIT_MASK(30)
-#define DMA_29BIT_MASK	(DMA_DEPRECATED)DMA_BIT_MASK(29)
-#define DMA_28BIT_MASK	(DMA_DEPRECATED)DMA_BIT_MASK(28)
-#define DMA_24BIT_MASK	(DMA_DEPRECATED)DMA_BIT_MASK(24)
+#define DMA_64BIT_MASK	(DMA_nnBIT_MASK)DMA_BIT_MASK(64)
+#define DMA_48BIT_MASK	(DMA_nnBIT_MASK)DMA_BIT_MASK(48)
+#define DMA_47BIT_MASK	(DMA_nnBIT_MASK)DMA_BIT_MASK(47)
+#define DMA_40BIT_MASK	(DMA_nnBIT_MASK)DMA_BIT_MASK(40)
+#define DMA_39BIT_MASK	(DMA_nnBIT_MASK)DMA_BIT_MASK(39)
+#define DMA_35BIT_MASK	(DMA_nnBIT_MASK)DMA_BIT_MASK(35)
+#define DMA_32BIT_MASK	(DMA_nnBIT_MASK)DMA_BIT_MASK(32)
+#define DMA_31BIT_MASK	(DMA_nnBIT_MASK)DMA_BIT_MASK(31)
+#define DMA_30BIT_MASK	(DMA_nnBIT_MASK)DMA_BIT_MASK(30)
+#define DMA_29BIT_MASK	(DMA_nnBIT_MASK)DMA_BIT_MASK(29)
+#define DMA_28BIT_MASK	(DMA_nnBIT_MASK)DMA_BIT_MASK(28)
+#define DMA_24BIT_MASK	(DMA_nnBIT_MASK)DMA_BIT_MASK(24)
 
 #define DMA_MASK_NONE	0x0ULL
 
Signature · 1 line
1.6.2.4
author Acked-by on v1 1/1
#7 lore raw

Re: [PATCH 1/1] dma-mapping: mark DMA_nBITS_MASK as deprecated fix

Quoted 10 lines · On Sun, 10 May 2009 09:04:26 +0200 Jiri Slaby <[email protected]> wrote:

Andrew, please fold into
dma-mapping: mark DMA_nBITS_MASK as deprecated --

As Fujita correctly demurs, use more meaningful typedef name, so that we now see:
warning: DMA_nnBIT_MASK is deprecated
instead of
warning: DMA_DEPRECATED is deprecated

Quoted 7 lines
Cc Yang Hongyang <[email protected]>
Cc FUJITA Tomonori <[email protected]>
Cc Ingo Molnar <[email protected]>
---
 include/linux/dma-mapping.h |   26 +++++++++++++-------------
 1 files changed, 13 insertions(+), 13 deletions(-)

But I think that you need to resend a version of this patch against tip. We need this patch in linux-next to warn some new users of these deprecated macros.

Thanks,

#8 lore raw

Re: [PATCH 1/1] dma-mapping: mark DMA_nBITS_MASK as deprecated fix

Quoted 3 lines · FUJITA Tomonori

But I think that you need to resend a version of this patch against tip. We need this patch in linux-next to warn some new users of these deprecated macros.

It depends on Ingo if he doesn't mind to pick it up :).

Anyway I though we want to merge this upstream for 1-2 releases and then wave and tell it goodbye to propagate not only to linux-next users. I would resend the patch with an entry in features removal schedule in that case. But it's up to you...

#9 lore raw

Re: [PATCH 1/1] dma-mapping: mark DMA_nBITS_MASK as deprecated fix

Quoted 6 lines · Jiri Slaby
Quoted 3 lines · FUJITA Tomonori

But I think that you need to resend a version of this patch against tip. We need this patch in linux-next to warn some new users of these deprecated macros.

It depends on Ingo if he doesn't mind to pick it up :).

Yes, i picked it up - dma-mapping.h changes generally get reviewed by and go via the IOMMU folks and is maintained in tip:core/iommu.

Ingo

#10 lore raw

[tip:core/iommu] dma-mapping.h: mark DMA_nBITS_MASK as deprecated

In reply to Jiri Slaby
Commit-ID:  0802bbd72dbc0e285799258efbf99e2e822ad8cb
Gitweb:     http://git.kernel.org/tip/0802bbd72dbc0e285799258efbf99e2e822ad8cb
Author:     Jiri Slaby <[email protected]>
AuthorDate: Fri, 8 May 2009 10:00:38 +0200
Committer:  Ingo Molnar <[email protected]>
CommitDate: Mon, 11 May 2009 14:45:43 +0200

dma-mapping.h: mark DMA_nBITS_MASK as deprecated

Mark them deprecated so that 3rd party vendors get notified about that before their modules break by removing those macros later.

[ Impact: trigger cleanups by emitting deprecation messages ]

LKML-Reference: <[email protected]>

---
 include/linux/dma-mapping.h |   26 ++++++++++++++------------
 1 files changed, 14 insertions(+), 12 deletions(-)
include/linux/dma-mapping.h +14 -12
index 8083b6a..6bf3339 100644
@@ -63,24 +63,26 @@ struct dma_map_ops {
 
 #define DMA_BIT_MASK(n)	(((n) == 64) ? ~0ULL : ((1ULL<<(n))-1))
 
+typedef u64 DMA_DEPRECATED __deprecated;
+
 /*
  * NOTE: do not use the below macros in new code and do not add new definitions
  * here.
  *
  * Instead, just open-code DMA_BIT_MASK(n) within your driver
  */
-#define DMA_64BIT_MASK	DMA_BIT_MASK(64)
-#define DMA_48BIT_MASK	DMA_BIT_MASK(48)
-#define DMA_47BIT_MASK	DMA_BIT_MASK(47)
-#define DMA_40BIT_MASK	DMA_BIT_MASK(40)
-#define DMA_39BIT_MASK	DMA_BIT_MASK(39)
-#define DMA_35BIT_MASK	DMA_BIT_MASK(35)
-#define DMA_32BIT_MASK	DMA_BIT_MASK(32)
-#define DMA_31BIT_MASK	DMA_BIT_MASK(31)
-#define DMA_30BIT_MASK	DMA_BIT_MASK(30)
-#define DMA_29BIT_MASK	DMA_BIT_MASK(29)
-#define DMA_28BIT_MASK	DMA_BIT_MASK(28)
-#define DMA_24BIT_MASK	DMA_BIT_MASK(24)
+#define DMA_64BIT_MASK	(DMA_DEPRECATED)DMA_BIT_MASK(64)
+#define DMA_48BIT_MASK	(DMA_DEPRECATED)DMA_BIT_MASK(48)
+#define DMA_47BIT_MASK	(DMA_DEPRECATED)DMA_BIT_MASK(47)
+#define DMA_40BIT_MASK	(DMA_DEPRECATED)DMA_BIT_MASK(40)
+#define DMA_39BIT_MASK	(DMA_DEPRECATED)DMA_BIT_MASK(39)
+#define DMA_35BIT_MASK	(DMA_DEPRECATED)DMA_BIT_MASK(35)
+#define DMA_32BIT_MASK	(DMA_DEPRECATED)DMA_BIT_MASK(32)
+#define DMA_31BIT_MASK	(DMA_DEPRECATED)DMA_BIT_MASK(31)
+#define DMA_30BIT_MASK	(DMA_DEPRECATED)DMA_BIT_MASK(30)
+#define DMA_29BIT_MASK	(DMA_DEPRECATED)DMA_BIT_MASK(29)
+#define DMA_28BIT_MASK	(DMA_DEPRECATED)DMA_BIT_MASK(28)
+#define DMA_24BIT_MASK	(DMA_DEPRECATED)DMA_BIT_MASK(24)
 
 #define DMA_MASK_NONE	0x0ULL
 
#11 lore raw
In reply to FUJITA Tomonori
Quoted 7 lines · On Thu, 7 May 2009 14:14:16 +0900 FUJITA Tomonori…

We replaced all DMA_nBIT_MASK macros with DMA_BIT_MASK(n) but why do we still keep DMA_nBIT_MASK macros in include/linux/dma-mapping.h?

As long as these macros exist, people use them. The current git has two users and linux-next have other users.

Is it better to remove DMA_nBIT_MASK macros completely now?

Yes, the plan is to remove them.

Doing so will break lots and lots of out-of-tree drivers, causing people some grief. Is there any way in which we can cause their use to cause __deprecated warnings for a couple of months, to give people a chance to migrate?

#12 lore raw
Quoted 8 lines · Andrew Morton
Quoted 6 lines · On Thu, 7 May 2009 14:14:16 +0900 FUJITA Tomonori…

We replaced all DMA_nBIT_MASK macros with DMA_BIT_MASK(n) but why do we still keep DMA_nBIT_MASK macros in include/linux/dma-mapping.h?

As long as these macros exist, people use them. The current git has two users and linux-next have other users.

Quoted 10 lines
Quoted 1 line

Is it better to remove DMA_nBIT_MASK macros completely now?

Yes, the plan is to remove them.

Doing so will break lots and lots of out-of-tree drivers, causing people some grief. Is there any way in which we can cause their use to cause __deprecated warnings for a couple of months, to give people a chance to migrate?

Shall we use something like below to warn people?
#define DMA_64BIT_MASK DMA_BIT_MASK(64);(__deprecated warnings:use DMA_BIT_MASK(64) instead) ?

Signature · 2 lines
Regards
Yang Hongyang
#13 lore raw
Quoted 2 lines · Yang Hongyang

Shall we use something like below to warn people?
#define DMA_64BIT_MASK DMA_BIT_MASK(64);(__deprecated warnings:use DMA_BIT_MASK(64) instead) ?

Something like an irq flags deprecation in the past:
http://lwn.net/Articles/229673/
?

I don't know how many in-initializer (struct x x = { DMA_64BIT_MASK } ) users are out there though.

#14 lore raw
Quoted 7 lines · Jiri Slaby
Quoted 2 lines · Yang Hongyang

Shall we use something like below to warn people?
#define DMA_64BIT_MASK DMA_BIT_MASK(64);(__deprecated warnings:use DMA_BIT_MASK(64) instead) ?

Something like an irq flags deprecation in the past:
http://lwn.net/Articles/229673/
?

good catch,but this need to be modified (add one line is enough)to cause their use to cause __deprecated warnings.

Quoted 5 lines

I don't know how many in-initializer (struct x x = { DMA_64BIT_MASK } ) users are out there though.

Signature · 2 lines
Regards
Yang Hongyang
#15 lore raw
Quoted 7 lines · Yang Hongyang
Quoted 3 lines · Jiri Slaby

Something like an irq flags deprecation in the past:
http://lwn.net/Articles/229673/
?

good catch,but this need to be modified (add one line is enough)to cause their use to cause __deprecated warnings.

I'm lost, that inline does it, right?

#16 lore raw
In reply to Jiri Slaby
Quoted 10 lines · On Thu, 07 May 2009 10:46:09 +0200 Jiri Slaby <[email protected]> wrote:
Quoted 2 lines · Yang Hongyang

Shall we use something like below to warn people?
#define DMA_64BIT_MASK DMA_BIT_MASK(64);(__deprecated warnings:use DMA_BIT_MASK(64) instead) ?

Something like an irq flags deprecation in the past:
http://lwn.net/Articles/229673/
?

I don't know how many in-initializer (struct x x = { DMA_64BIT_MASK } ) users are out there though.

Unfortunately, there are lots. Converting these macros to functions would breaks drivers too.