From 82f66fbef58de4ad7519708d0b9e685e20fa4e8a Mon Sep 17 00:00:00 2001 From: Jens Axboe Date: Mon, 22 Oct 2007 17:07:37 +0200 Subject: [SG] Add helpers for manipulating SG entries We can then transition drivers without changing the generated code. Signed-off-by: Jens Axboe --- include/linux/scatterlist.h | 112 ++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 104 insertions(+), 8 deletions(-) (limited to 'include/linux') diff --git a/include/linux/scatterlist.h b/include/linux/scatterlist.h index 2dc7464cce52..1645795cbb13 100644 --- a/include/linux/scatterlist.h +++ b/include/linux/scatterlist.h @@ -2,24 +2,37 @@ #define _LINUX_SCATTERLIST_H #include +#include #include #include +/** + * sg_set_page - Set sg entry to point at given page + * @sg: SG entry + * @page: The page + * + * Description: + * Use this function to set an sg entry pointing at a page, never assign + * the page directly. We encode sg table information in the lower bits + * of the page pointer. See sg_page() for looking up the page belonging + * to an sg entry. + * + **/ +static inline void sg_set_page(struct scatterlist *sg, struct page *page) +{ + sg->page = page; +} + +#define sg_page(sg) ((sg)->page) + static inline void sg_set_buf(struct scatterlist *sg, const void *buf, unsigned int buflen) { - sg->page = virt_to_page(buf); + sg_set_page(sg, virt_to_page(buf)); sg->offset = offset_in_page(buf); sg->length = buflen; } -static inline void sg_init_one(struct scatterlist *sg, const void *buf, - unsigned int buflen) -{ - memset(sg, 0, sizeof(*sg)); - sg_set_buf(sg, buf, buflen); -} - /* * We overload the LSB of the page pointer to indicate whether it's * a valid sg entry, or whether it points to the start of a new scatterlist. @@ -104,4 +117,87 @@ static inline void sg_chain(struct scatterlist *prv, unsigned int prv_nents, prv[prv_nents - 1].page = (struct page *) ((unsigned long) sgl | 0x01); } +/** + * sg_mark_end - Mark the end of the scatterlist + * @sgl: Scatterlist + * @nents: Number of entries in sgl + * + * Description: + * Marks the last entry as the termination point for sg_next() + * + **/ +static inline void sg_mark_end(struct scatterlist *sgl, unsigned int nents) +{ +} + +static inline void __sg_mark_end(struct scatterlist *sg) +{ +} + + +/** + * sg_init_one - Initialize a single entry sg list + * @sg: SG entry + * @buf: Virtual address for IO + * @buflen: IO length + * + * Notes: + * This should not be used on a single entry that is part of a larger + * table. Use sg_init_table() for that. + * + **/ +static inline void sg_init_one(struct scatterlist *sg, const void *buf, + unsigned int buflen) +{ + memset(sg, 0, sizeof(*sg)); + sg_mark_end(sg, 1); + sg_set_buf(sg, buf, buflen); +} + +/** + * sg_init_table - Initialize SG table + * @sgl: The SG table + * @nents: Number of entries in table + * + * Notes: + * If this is part of a chained sg table, sg_mark_end() should be + * used only on the last table part. + * + **/ +static inline void sg_init_table(struct scatterlist *sgl, unsigned int nents) +{ + memset(sgl, 0, sizeof(*sgl) * nents); + sg_mark_end(sgl, nents); +} + +/** + * sg_phys - Return physical address of an sg entry + * @sg: SG entry + * + * Description: + * This calls page_to_phys() on the page in this sg entry, and adds the + * sg offset. The caller must know that it is legal to call page_to_phys() + * on the sg page. + * + **/ +static inline unsigned long sg_phys(struct scatterlist *sg) +{ + return page_to_phys(sg_page(sg)) + sg->offset; +} + +/** + * sg_virt - Return virtual address of an sg entry + * @sg: SG entry + * + * Description: + * This calls page_address() on the page in this sg entry, and adds the + * sg offset. The caller must know that the sg page has a valid virtual + * mapping. + * + **/ +static inline void *sg_virt(struct scatterlist *sg) +{ + return page_address(sg_page(sg)) + sg->offset; +} + #endif /* _LINUX_SCATTERLIST_H */ -- cgit v1.2.3 From 18dabf473e15850c0dbc8ff13ac1e2806d542c15 Mon Sep 17 00:00:00 2001 From: Jens Axboe Date: Mon, 22 Oct 2007 19:57:20 +0200 Subject: Change table chaining layout Change the page member of the scatterlist structure to be an unsigned long, and encode more stuff in the lower bits: - Bits 0 and 1 zero: this is a normal sg entry. Next sg entry is located at sg + 1. - Bit 0 set: this is a chain entry, the next real entry is at ->page_link with the two low bits masked off. - Bit 1 set: this is the final entry in the sg entry. sg_next() will return NULL when passed such an entry. It's thus important that sg table users use the proper accessors to get and set the page member. Signed-off-by: Jens Axboe --- include/asm-alpha/scatterlist.h | 2 +- include/asm-arm/scatterlist.h | 2 +- include/asm-avr32/scatterlist.h | 2 +- include/asm-blackfin/scatterlist.h | 2 +- include/asm-cris/scatterlist.h | 2 +- include/asm-frv/scatterlist.h | 2 +- include/asm-h8300/scatterlist.h | 2 +- include/asm-ia64/scatterlist.h | 2 +- include/asm-m32r/scatterlist.h | 2 +- include/asm-m68k/scatterlist.h | 2 +- include/asm-m68knommu/scatterlist.h | 2 +- include/asm-mips/scatterlist.h | 2 +- include/asm-parisc/scatterlist.h | 2 +- include/asm-powerpc/scatterlist.h | 2 +- include/asm-s390/scatterlist.h | 2 +- include/asm-sh/scatterlist.h | 2 +- include/asm-sh64/scatterlist.h | 2 +- include/asm-sparc/scatterlist.h | 2 +- include/asm-sparc64/scatterlist.h | 2 +- include/asm-v850/scatterlist.h | 2 +- include/asm-x86/dma-mapping_32.h | 4 +- include/asm-x86/scatterlist_32.h | 2 +- include/asm-x86/scatterlist_64.h | 2 +- include/asm-xtensa/scatterlist.h | 2 +- include/linux/scatterlist.h | 78 +++++++++++++++++++++++++------------ 25 files changed, 79 insertions(+), 49 deletions(-) (limited to 'include/linux') diff --git a/include/asm-alpha/scatterlist.h b/include/asm-alpha/scatterlist.h index 917365405e83..b7647063bd55 100644 --- a/include/asm-alpha/scatterlist.h +++ b/include/asm-alpha/scatterlist.h @@ -5,7 +5,7 @@ #include struct scatterlist { - struct page *page; + unsigned long page_link; unsigned int offset; unsigned int length; diff --git a/include/asm-arm/scatterlist.h b/include/asm-arm/scatterlist.h index de2f65eb42ed..ab1d85dd0232 100644 --- a/include/asm-arm/scatterlist.h +++ b/include/asm-arm/scatterlist.h @@ -5,7 +5,7 @@ #include struct scatterlist { - struct page *page; /* buffer page */ + unsigned long page_link; unsigned int offset; /* buffer offset */ dma_addr_t dma_address; /* dma address */ unsigned int length; /* length */ diff --git a/include/asm-avr32/scatterlist.h b/include/asm-avr32/scatterlist.h index c6d5ce3b3a25..1356f29d89f5 100644 --- a/include/asm-avr32/scatterlist.h +++ b/include/asm-avr32/scatterlist.h @@ -4,7 +4,7 @@ #include struct scatterlist { - struct page *page; + unsigned long page_link; unsigned int offset; dma_addr_t dma_address; unsigned int length; diff --git a/include/asm-blackfin/scatterlist.h b/include/asm-blackfin/scatterlist.h index 60e07b92044c..384af549e5b8 100644 --- a/include/asm-blackfin/scatterlist.h +++ b/include/asm-blackfin/scatterlist.h @@ -4,7 +4,7 @@ #include struct scatterlist { - struct page *page; + unsigned long page_link; unsigned int offset; dma_addr_t dma_address; unsigned int length; diff --git a/include/asm-cris/scatterlist.h b/include/asm-cris/scatterlist.h index 4bdc44c4ac3d..5a8a83440d3b 100644 --- a/include/asm-cris/scatterlist.h +++ b/include/asm-cris/scatterlist.h @@ -6,7 +6,7 @@ struct scatterlist { unsigned int length; /* The following is i386 highmem junk - not used by us */ - struct page * page; /* Location for highmem page, if any */ + unsigned long page_link; unsigned int offset;/* for highmem, page offset */ }; diff --git a/include/asm-frv/scatterlist.h b/include/asm-frv/scatterlist.h index 8e827fa853f1..53dade7b2e16 100644 --- a/include/asm-frv/scatterlist.h +++ b/include/asm-frv/scatterlist.h @@ -22,7 +22,7 @@ * and that's it. There's no excuse for not highmem enabling YOUR driver. /jens */ struct scatterlist { - struct page *page; /* Location for highmem page, if any */ + unsigned long page_link; unsigned int offset; /* for highmem, page offset */ dma_addr_t dma_address; diff --git a/include/asm-h8300/scatterlist.h b/include/asm-h8300/scatterlist.h index 985fdf54eaca..7e41983d6b26 100644 --- a/include/asm-h8300/scatterlist.h +++ b/include/asm-h8300/scatterlist.h @@ -4,7 +4,7 @@ #include struct scatterlist { - struct page *page; + unsigned long page_link; unsigned int offset; dma_addr_t dma_address; unsigned int length; diff --git a/include/asm-ia64/scatterlist.h b/include/asm-ia64/scatterlist.h index 7d5234d50312..2f76ce304964 100644 --- a/include/asm-ia64/scatterlist.h +++ b/include/asm-ia64/scatterlist.h @@ -9,7 +9,7 @@ #include struct scatterlist { - struct page *page; + unsigned long page_link; unsigned int offset; unsigned int length; /* buffer length */ diff --git a/include/asm-m32r/scatterlist.h b/include/asm-m32r/scatterlist.h index 352415ff5eb9..33b4b4d2c89e 100644 --- a/include/asm-m32r/scatterlist.h +++ b/include/asm-m32r/scatterlist.h @@ -6,7 +6,7 @@ struct scatterlist { char * address; /* Location data is to be transferred to, NULL for * highmem page */ - struct page * page; /* Location for highmem page, if any */ + unsigned long page_link; unsigned int offset;/* for highmem, page offset */ dma_addr_t dma_address; diff --git a/include/asm-m68k/scatterlist.h b/include/asm-m68k/scatterlist.h index 24887a2d9c7b..e06bb891048e 100644 --- a/include/asm-m68k/scatterlist.h +++ b/include/asm-m68k/scatterlist.h @@ -4,7 +4,7 @@ #include struct scatterlist { - struct page *page; + unsigned long page_link; unsigned int offset; unsigned int length; diff --git a/include/asm-m68knommu/scatterlist.h b/include/asm-m68knommu/scatterlist.h index 4da79d3d3f34..28bed41dc80b 100644 --- a/include/asm-m68knommu/scatterlist.h +++ b/include/asm-m68knommu/scatterlist.h @@ -5,7 +5,7 @@ #include struct scatterlist { - struct page *page; + unsigned long page_link; unsigned int offset; dma_addr_t dma_address; unsigned int length; diff --git a/include/asm-mips/scatterlist.h b/include/asm-mips/scatterlist.h index 7af104c95b20..787797cdb0a9 100644 --- a/include/asm-mips/scatterlist.h +++ b/include/asm-mips/scatterlist.h @@ -4,7 +4,7 @@ #include struct scatterlist { - struct page * page; + unsigned long page_link; unsigned int offset; dma_addr_t dma_address; unsigned int length; diff --git a/include/asm-parisc/scatterlist.h b/include/asm-parisc/scatterlist.h index e7211c748446..26da9146fffb 100644 --- a/include/asm-parisc/scatterlist.h +++ b/include/asm-parisc/scatterlist.h @@ -5,7 +5,7 @@ #include struct scatterlist { - struct page *page; + unsigned long page_link; unsigned int offset; unsigned int length; diff --git a/include/asm-powerpc/scatterlist.h b/include/asm-powerpc/scatterlist.h index b075f619c3b7..b9f1dbc24843 100644 --- a/include/asm-powerpc/scatterlist.h +++ b/include/asm-powerpc/scatterlist.h @@ -14,7 +14,7 @@ #include struct scatterlist { - struct page *page; + unsigned long page_link; unsigned int offset; unsigned int length; diff --git a/include/asm-s390/scatterlist.h b/include/asm-s390/scatterlist.h index a43b3afc5e2d..eb3948690d6e 100644 --- a/include/asm-s390/scatterlist.h +++ b/include/asm-s390/scatterlist.h @@ -2,7 +2,7 @@ #define _ASMS390_SCATTERLIST_H struct scatterlist { - struct page *page; + unsigned long page_link; unsigned int offset; unsigned int length; }; diff --git a/include/asm-sh/scatterlist.h b/include/asm-sh/scatterlist.h index b9ae53c38365..bc7c809e16fb 100644 --- a/include/asm-sh/scatterlist.h +++ b/include/asm-sh/scatterlist.h @@ -4,7 +4,7 @@ #include struct scatterlist { - struct page * page; /* Location for highmem page, if any */ + unsigned long page_link; unsigned int offset;/* for highmem, page offset */ dma_addr_t dma_address; unsigned int length; diff --git a/include/asm-sh64/scatterlist.h b/include/asm-sh64/scatterlist.h index 1c723f2d7a95..0afd856e218a 100644 --- a/include/asm-sh64/scatterlist.h +++ b/include/asm-sh64/scatterlist.h @@ -14,7 +14,7 @@ #include struct scatterlist { - struct page * page; /* Location for highmem page, if any */ + unsigned long page_link; unsigned int offset;/* for highmem, page offset */ dma_addr_t dma_address; unsigned int length; diff --git a/include/asm-sparc/scatterlist.h b/include/asm-sparc/scatterlist.h index 4055af90ad7e..45b16f1072be 100644 --- a/include/asm-sparc/scatterlist.h +++ b/include/asm-sparc/scatterlist.h @@ -5,7 +5,7 @@ #include struct scatterlist { - struct page *page; + unsigned long page_link; unsigned int offset; unsigned int length; diff --git a/include/asm-sparc64/scatterlist.h b/include/asm-sparc64/scatterlist.h index 703c5bbe6c8c..4cbaf7c6b0bb 100644 --- a/include/asm-sparc64/scatterlist.h +++ b/include/asm-sparc64/scatterlist.h @@ -6,7 +6,7 @@ #include struct scatterlist { - struct page *page; + unsigned long page_link; unsigned int offset; unsigned int length; diff --git a/include/asm-v850/scatterlist.h b/include/asm-v850/scatterlist.h index 56f402920db9..db91febc2100 100644 --- a/include/asm-v850/scatterlist.h +++ b/include/asm-v850/scatterlist.h @@ -17,7 +17,7 @@ #include struct scatterlist { - struct page *page; + unsigned long page_link; unsigned offset; dma_addr_t dma_address; unsigned length; diff --git a/include/asm-x86/dma-mapping_32.h b/include/asm-x86/dma-mapping_32.h index 6a2d26cb5da6..55f01bd9e556 100644 --- a/include/asm-x86/dma-mapping_32.h +++ b/include/asm-x86/dma-mapping_32.h @@ -45,9 +45,9 @@ dma_map_sg(struct device *dev, struct scatterlist *sglist, int nents, WARN_ON(nents == 0 || sglist[0].length == 0); for_each_sg(sglist, sg, nents, i) { - BUG_ON(!sg->page); + BUG_ON(!sg_page(sg)); - sg->dma_address = page_to_phys(sg->page) + sg->offset; + sg->dma_address = sg_phys(sg); } flush_write_buffers(); diff --git a/include/asm-x86/scatterlist_32.h b/include/asm-x86/scatterlist_32.h index bd5164aa8f63..140a5b37fa77 100644 --- a/include/asm-x86/scatterlist_32.h +++ b/include/asm-x86/scatterlist_32.h @@ -4,7 +4,7 @@ #include struct scatterlist { - struct page *page; + unsigned long page_link; unsigned int offset; dma_addr_t dma_address; unsigned int length; diff --git a/include/asm-x86/scatterlist_64.h b/include/asm-x86/scatterlist_64.h index ef3986ba4b79..e3447846e03d 100644 --- a/include/asm-x86/scatterlist_64.h +++ b/include/asm-x86/scatterlist_64.h @@ -4,7 +4,7 @@ #include struct scatterlist { - struct page *page; + unsigned long page_link; unsigned int offset; unsigned int length; dma_addr_t dma_address; diff --git a/include/asm-xtensa/scatterlist.h b/include/asm-xtensa/scatterlist.h index ca337a294290..3b8aba5d2c68 100644 --- a/include/asm-xtensa/scatterlist.h +++ b/include/asm-xtensa/scatterlist.h @@ -14,7 +14,7 @@ #include struct scatterlist { - struct page *page; + unsigned long page_link; unsigned int offset; dma_addr_t dma_address; unsigned int length; diff --git a/include/linux/scatterlist.h b/include/linux/scatterlist.h index 1645795cbb13..c6136e8a7f58 100644 --- a/include/linux/scatterlist.h +++ b/include/linux/scatterlist.h @@ -2,9 +2,26 @@ #define _LINUX_SCATTERLIST_H #include -#include #include #include +#include + +/* + * Notes on SG table design. + * + * Architectures must provide an unsigned long page_link field in the + * scatterlist struct. We use that to place the page pointer AND encode + * information about the sg table as well. The two lower bits are reserved + * for this information. + * + * If bit 0 is set, then the page_link contains a pointer to the next sg + * table list. Otherwise the next entry is at sg + 1. + * + * If bit 1 is set, then this sg entry is the last element in a list. + * + * See sg_next(). + * + */ /** * sg_set_page - Set sg entry to point at given page @@ -20,11 +37,20 @@ **/ static inline void sg_set_page(struct scatterlist *sg, struct page *page) { - sg->page = page; + unsigned long page_link = sg->page_link & 0x3; + + sg->page_link = page_link | (unsigned long) page; } -#define sg_page(sg) ((sg)->page) +#define sg_page(sg) ((struct page *) ((sg)->page_link & ~0x3)) +/** + * sg_set_buf - Set sg entry to point at given data + * @sg: SG entry + * @buf: Data + * @buflen: Data length + * + **/ static inline void sg_set_buf(struct scatterlist *sg, const void *buf, unsigned int buflen) { @@ -38,26 +64,27 @@ static inline void sg_set_buf(struct scatterlist *sg, const void *buf, * a valid sg entry, or whether it points to the start of a new scatterlist. * Those low bits are there for everyone! (thanks mason :-) */ -#define sg_is_chain(sg) ((unsigned long) (sg)->page & 0x01) +#define sg_is_chain(sg) ((sg)->page_link & 0x01) +#define sg_is_last(sg) ((sg)->page_link & 0x02) #define sg_chain_ptr(sg) \ - ((struct scatterlist *) ((unsigned long) (sg)->page & ~0x01)) + ((struct scatterlist *) ((sg)->page_link & ~0x03)) /** * sg_next - return the next scatterlist entry in a list * @sg: The current sg entry * - * Usually the next entry will be @sg@ + 1, but if this sg element is part - * of a chained scatterlist, it could jump to the start of a new - * scatterlist array. - * - * Note that the caller must ensure that there are further entries after - * the current entry, this function will NOT return NULL for an end-of-list. + * Description: + * Usually the next entry will be @sg@ + 1, but if this sg element is part + * of a chained scatterlist, it could jump to the start of a new + * scatterlist array. * - */ + **/ static inline struct scatterlist *sg_next(struct scatterlist *sg) { - sg++; + if (sg_is_last(sg)) + return NULL; + sg++; if (unlikely(sg_is_chain(sg))) sg = sg_chain_ptr(sg); @@ -75,14 +102,15 @@ static inline struct scatterlist *sg_next(struct scatterlist *sg) * @sgl: First entry in the scatterlist * @nents: Number of entries in the scatterlist * - * Should only be used casually, it (currently) scan the entire list - * to get the last entry. + * Description: + * Should only be used casually, it (currently) scan the entire list + * to get the last entry. * - * Note that the @sgl@ pointer passed in need not be the first one, - * the important bit is that @nents@ denotes the number of entries that - * exist from @sgl@. + * Note that the @sgl@ pointer passed in need not be the first one, + * the important bit is that @nents@ denotes the number of entries that + * exist from @sgl@. * - */ + **/ static inline struct scatterlist *sg_last(struct scatterlist *sgl, unsigned int nents) { @@ -105,16 +133,17 @@ static inline struct scatterlist *sg_last(struct scatterlist *sgl, * @prv_nents: Number of entries in prv * @sgl: Second scatterlist * - * Links @prv@ and @sgl@ together, to form a longer scatterlist. + * Description: + * Links @prv@ and @sgl@ together, to form a longer scatterlist. * - */ + **/ static inline void sg_chain(struct scatterlist *prv, unsigned int prv_nents, struct scatterlist *sgl) { #ifndef ARCH_HAS_SG_CHAIN BUG(); #endif - prv[prv_nents - 1].page = (struct page *) ((unsigned long) sgl | 0x01); + prv[prv_nents - 1].page_link = (unsigned long) sgl | 0x01; } /** @@ -128,13 +157,14 @@ static inline void sg_chain(struct scatterlist *prv, unsigned int prv_nents, **/ static inline void sg_mark_end(struct scatterlist *sgl, unsigned int nents) { + sgl[nents - 1].page_link = 0x02; } static inline void __sg_mark_end(struct scatterlist *sg) { + sg->page_link |= 0x02; } - /** * sg_init_one - Initialize a single entry sg list * @sg: SG entry @@ -187,7 +217,7 @@ static inline unsigned long sg_phys(struct scatterlist *sg) /** * sg_virt - Return virtual address of an sg entry - * @sg: SG entry + * @sg: SG entry * * Description: * This calls page_address() on the page in this sg entry, and adds the -- cgit v1.2.3 From d6ec084200c37683278c821338f74ddf21ab80f5 Mon Sep 17 00:00:00 2001 From: Jens Axboe Date: Mon, 22 Oct 2007 20:01:06 +0200 Subject: Add CONFIG_DEBUG_SG sg validation Add a Kconfig entry which will toggle some sanity checks on the sg entry and tables. Signed-off-by: Jens Axboe --- include/asm-alpha/scatterlist.h | 3 +++ include/asm-arm/scatterlist.h | 3 +++ include/asm-avr32/scatterlist.h | 3 +++ include/asm-blackfin/scatterlist.h | 3 +++ include/asm-cris/scatterlist.h | 3 +++ include/asm-frv/scatterlist.h | 3 +++ include/asm-h8300/scatterlist.h | 3 +++ include/asm-ia64/scatterlist.h | 3 +++ include/asm-m32r/scatterlist.h | 3 +++ include/asm-m68k/scatterlist.h | 3 +++ include/asm-m68knommu/scatterlist.h | 3 +++ include/asm-mips/scatterlist.h | 3 +++ include/asm-parisc/scatterlist.h | 3 +++ include/asm-powerpc/scatterlist.h | 3 +++ include/asm-s390/scatterlist.h | 3 +++ include/asm-sh/scatterlist.h | 3 +++ include/asm-sh64/scatterlist.h | 3 +++ include/asm-sparc/scatterlist.h | 3 +++ include/asm-sparc64/scatterlist.h | 3 +++ include/asm-v850/scatterlist.h | 3 +++ include/asm-x86/scatterlist_32.h | 3 +++ include/asm-x86/scatterlist_64.h | 3 +++ include/asm-xtensa/scatterlist.h | 3 +++ include/linux/scatterlist.h | 22 ++++++++++++++++++++++ lib/Kconfig.debug | 10 ++++++++++ 25 files changed, 101 insertions(+) (limited to 'include/linux') diff --git a/include/asm-alpha/scatterlist.h b/include/asm-alpha/scatterlist.h index b7647063bd55..440747ca6349 100644 --- a/include/asm-alpha/scatterlist.h +++ b/include/asm-alpha/scatterlist.h @@ -5,6 +5,9 @@ #include struct scatterlist { +#ifdef CONFIG_DEBUG_SG + unsigned long sg_magic; +#endif unsigned long page_link; unsigned int offset; diff --git a/include/asm-arm/scatterlist.h b/include/asm-arm/scatterlist.h index ab1d85dd0232..ca0a37d03400 100644 --- a/include/asm-arm/scatterlist.h +++ b/include/asm-arm/scatterlist.h @@ -5,6 +5,9 @@ #include struct scatterlist { +#ifdef CONFIG_DEBUG_SG + unsigned long sg_magic; +#endif unsigned long page_link; unsigned int offset; /* buffer offset */ dma_addr_t dma_address; /* dma address */ diff --git a/include/asm-avr32/scatterlist.h b/include/asm-avr32/scatterlist.h index 1356f29d89f5..377320e3bd17 100644 --- a/include/asm-avr32/scatterlist.h +++ b/include/asm-avr32/scatterlist.h @@ -4,6 +4,9 @@ #include struct scatterlist { +#ifdef CONFIG_DEBUG_SG + unsigned long sg_magic; +#endif unsigned long page_link; unsigned int offset; dma_addr_t dma_address; diff --git a/include/asm-blackfin/scatterlist.h b/include/asm-blackfin/scatterlist.h index 384af549e5b8..32128d53469b 100644 --- a/include/asm-blackfin/scatterlist.h +++ b/include/asm-blackfin/scatterlist.h @@ -4,6 +4,9 @@ #include struct scatterlist { +#ifdef CONFIG_DEBUG_SG + unsigned long sg_magic; +#endif unsigned long page_link; unsigned int offset; dma_addr_t dma_address; diff --git a/include/asm-cris/scatterlist.h b/include/asm-cris/scatterlist.h index 5a8a83440d3b..faff53ad1f96 100644 --- a/include/asm-cris/scatterlist.h +++ b/include/asm-cris/scatterlist.h @@ -2,6 +2,9 @@ #define __ASM_CRIS_SCATTERLIST_H struct scatterlist { +#ifdef CONFIG_DEBUG_SG + unsigned long sg_magic; +#endif char * address; /* Location data is to be transferred to */ unsigned int length; diff --git a/include/asm-frv/scatterlist.h b/include/asm-frv/scatterlist.h index 53dade7b2e16..f7da007b763c 100644 --- a/include/asm-frv/scatterlist.h +++ b/include/asm-frv/scatterlist.h @@ -22,6 +22,9 @@ * and that's it. There's no excuse for not highmem enabling YOUR driver. /jens */ struct scatterlist { +#ifdef CONFIG_DEBUG_SG + unsigned long sg_magic; +#endif unsigned long page_link; unsigned int offset; /* for highmem, page offset */ diff --git a/include/asm-h8300/scatterlist.h b/include/asm-h8300/scatterlist.h index 7e41983d6b26..d3ecdd87ac90 100644 --- a/include/asm-h8300/scatterlist.h +++ b/include/asm-h8300/scatterlist.h @@ -4,6 +4,9 @@ #include struct scatterlist { +#ifdef CONFIG_DEBUG_SG + unsigned long sg_magic; +#endif unsigned long page_link; unsigned int offset; dma_addr_t dma_address; diff --git a/include/asm-ia64/scatterlist.h b/include/asm-ia64/scatterlist.h index 2f76ce304964..d6f57874041d 100644 --- a/include/asm-ia64/scatterlist.h +++ b/include/asm-ia64/scatterlist.h @@ -9,6 +9,9 @@ #include struct scatterlist { +#ifdef CONFIG_DEBUG_SG + unsigned long sg_magic; +#endif unsigned long page_link; unsigned int offset; unsigned int length; /* buffer length */ diff --git a/include/asm-m32r/scatterlist.h b/include/asm-m32r/scatterlist.h index 33b4b4d2c89e..1ed372c73d0b 100644 --- a/include/asm-m32r/scatterlist.h +++ b/include/asm-m32r/scatterlist.h @@ -4,6 +4,9 @@ #include struct scatterlist { +#ifdef CONFIG_DEBUG_SG + unsigned long sg_magic; +#endif char * address; /* Location data is to be transferred to, NULL for * highmem page */ unsigned long page_link; diff --git a/include/asm-m68k/scatterlist.h b/include/asm-m68k/scatterlist.h index e06bb891048e..d3a7a0edfeca 100644 --- a/include/asm-m68k/scatterlist.h +++ b/include/asm-m68k/scatterlist.h @@ -4,6 +4,9 @@ #include struct scatterlist { +#ifdef CONFIG_DEBUG_SG + unsigned long sg_magic; +#endif unsigned long page_link; unsigned int offset; unsigned int length; diff --git a/include/asm-m68knommu/scatterlist.h b/include/asm-m68knommu/scatterlist.h index 28bed41dc80b..10942840e88f 100644 --- a/include/asm-m68knommu/scatterlist.h +++ b/include/asm-m68knommu/scatterlist.h @@ -5,6 +5,9 @@ #include struct scatterlist { +#ifdef CONFIG_DEBUG_SG + unsigned long sg_magic; +#endif unsigned long page_link; unsigned int offset; dma_addr_t dma_address; diff --git a/include/asm-mips/scatterlist.h b/include/asm-mips/scatterlist.h index 787797cdb0a9..83d69fe17c9f 100644 --- a/include/asm-mips/scatterlist.h +++ b/include/asm-mips/scatterlist.h @@ -4,6 +4,9 @@ #include struct scatterlist { +#ifdef CONFIG_DEBUG_SG + unsigned long sg_magic; +#endif unsigned long page_link; unsigned int offset; dma_addr_t dma_address; diff --git a/include/asm-parisc/scatterlist.h b/include/asm-parisc/scatterlist.h index 26da9146fffb..cd3cfdf82289 100644 --- a/include/asm-parisc/scatterlist.h +++ b/include/asm-parisc/scatterlist.h @@ -5,6 +5,9 @@ #include struct scatterlist { +#ifdef CONFIG_DEBUG_SG + unsigned long sg_magic; +#endif unsigned long page_link; unsigned int offset; diff --git a/include/asm-powerpc/scatterlist.h b/include/asm-powerpc/scatterlist.h index b9f1dbc24843..fcf7d55afe45 100644 --- a/include/asm-powerpc/scatterlist.h +++ b/include/asm-powerpc/scatterlist.h @@ -14,6 +14,9 @@ #include struct scatterlist { +#ifdef CONFIG_DEBUG_SG + unsigned long sg_magic; +#endif unsigned long page_link; unsigned int offset; unsigned int length; diff --git a/include/asm-s390/scatterlist.h b/include/asm-s390/scatterlist.h index eb3948690d6e..29ec8e28c8df 100644 --- a/include/asm-s390/scatterlist.h +++ b/include/asm-s390/scatterlist.h @@ -2,6 +2,9 @@ #define _ASMS390_SCATTERLIST_H struct scatterlist { +#ifdef CONFIG_DEBUG_SG + unsigned long sg_magic; +#endif unsigned long page_link; unsigned int offset; unsigned int length; diff --git a/include/asm-sh/scatterlist.h b/include/asm-sh/scatterlist.h index bc7c809e16fb..a7d0d1856a99 100644 --- a/include/asm-sh/scatterlist.h +++ b/include/asm-sh/scatterlist.h @@ -4,6 +4,9 @@ #include struct scatterlist { +#ifdef CONFIG_DEBUG_SG + unsigned long sg_magic; +#endif unsigned long page_link; unsigned int offset;/* for highmem, page offset */ dma_addr_t dma_address; diff --git a/include/asm-sh64/scatterlist.h b/include/asm-sh64/scatterlist.h index 0afd856e218a..5109251970e7 100644 --- a/include/asm-sh64/scatterlist.h +++ b/include/asm-sh64/scatterlist.h @@ -14,6 +14,9 @@ #include struct scatterlist { +#ifdef CONFIG_DEBUG_SG + unsigned long sg_magic; +#endif unsigned long page_link; unsigned int offset;/* for highmem, page offset */ dma_addr_t dma_address; diff --git a/include/asm-sparc/scatterlist.h b/include/asm-sparc/scatterlist.h index 45b16f1072be..e08d3d775b08 100644 --- a/include/asm-sparc/scatterlist.h +++ b/include/asm-sparc/scatterlist.h @@ -5,6 +5,9 @@ #include struct scatterlist { +#ifdef CONFIG_DEBUG_SG + unsigned long sg_magic; +#endif unsigned long page_link; unsigned int offset; diff --git a/include/asm-sparc64/scatterlist.h b/include/asm-sparc64/scatterlist.h index 4cbaf7c6b0bb..6df23f070b1a 100644 --- a/include/asm-sparc64/scatterlist.h +++ b/include/asm-sparc64/scatterlist.h @@ -6,6 +6,9 @@ #include struct scatterlist { +#ifdef CONFIG_DEBUG_SG + unsigned long sg_magic; +#endif unsigned long page_link; unsigned int offset; diff --git a/include/asm-v850/scatterlist.h b/include/asm-v850/scatterlist.h index db91febc2100..02d27b3fb061 100644 --- a/include/asm-v850/scatterlist.h +++ b/include/asm-v850/scatterlist.h @@ -17,6 +17,9 @@ #include struct scatterlist { +#ifdef CONFIG_DEBUG_SG + unsigned long sg_magic; +#endif unsigned long page_link; unsigned offset; dma_addr_t dma_address; diff --git a/include/asm-x86/scatterlist_32.h b/include/asm-x86/scatterlist_32.h index 140a5b37fa77..0e7d997a34be 100644 --- a/include/asm-x86/scatterlist_32.h +++ b/include/asm-x86/scatterlist_32.h @@ -4,6 +4,9 @@ #include struct scatterlist { +#ifdef CONFIG_DEBUG_SG + unsigned long sg_magic; +#endif unsigned long page_link; unsigned int offset; dma_addr_t dma_address; diff --git a/include/asm-x86/scatterlist_64.h b/include/asm-x86/scatterlist_64.h index e3447846e03d..1847c72befeb 100644 --- a/include/asm-x86/scatterlist_64.h +++ b/include/asm-x86/scatterlist_64.h @@ -4,6 +4,9 @@ #include struct scatterlist { +#ifdef CONFIG_DEBUG_SG + unsigned long sg_magic; +#endif unsigned long page_link; unsigned int offset; unsigned int length; diff --git a/include/asm-xtensa/scatterlist.h b/include/asm-xtensa/scatterlist.h index 3b8aba5d2c68..810080bb0a2b 100644 --- a/include/asm-xtensa/scatterlist.h +++ b/include/asm-xtensa/scatterlist.h @@ -14,6 +14,9 @@ #include struct scatterlist { +#ifdef CONFIG_DEBUG_SG + unsigned long sg_magic; +#endif unsigned long page_link; unsigned int offset; dma_addr_t dma_address; diff --git a/include/linux/scatterlist.h b/include/linux/scatterlist.h index c6136e8a7f58..42daf5e15265 100644 --- a/include/linux/scatterlist.h +++ b/include/linux/scatterlist.h @@ -23,6 +23,8 @@ * */ +#define SG_MAGIC 0x87654321 + /** * sg_set_page - Set sg entry to point at given page * @sg: SG entry @@ -39,6 +41,9 @@ static inline void sg_set_page(struct scatterlist *sg, struct page *page) { unsigned long page_link = sg->page_link & 0x3; +#ifdef CONFIG_DEBUG_SG + BUG_ON(sg->sg_magic != SG_MAGIC); +#endif sg->page_link = page_link | (unsigned long) page; } @@ -81,6 +86,9 @@ static inline void sg_set_buf(struct scatterlist *sg, const void *buf, **/ static inline struct scatterlist *sg_next(struct scatterlist *sg) { +#ifdef CONFIG_DEBUG_SG + BUG_ON(sg->sg_magic != SG_MAGIC); +#endif if (sg_is_last(sg)) return NULL; @@ -123,6 +131,10 @@ static inline struct scatterlist *sg_last(struct scatterlist *sgl, for_each_sg(sgl, sg, nents, i) ret = sg; +#endif +#ifdef CONFIG_DEBUG_SG + BUG_ON(sgl[0].sg_magic != SG_MAGIC); + BUG_ON(!sg_is_last(ret)); #endif return ret; } @@ -180,6 +192,9 @@ static inline void sg_init_one(struct scatterlist *sg, const void *buf, unsigned int buflen) { memset(sg, 0, sizeof(*sg)); +#ifdef CONFIG_DEBUG_SG + sg->sg_magic = SG_MAGIC; +#endif sg_mark_end(sg, 1); sg_set_buf(sg, buf, buflen); } @@ -198,6 +213,13 @@ static inline void sg_init_table(struct scatterlist *sgl, unsigned int nents) { memset(sgl, 0, sizeof(*sgl) * nents); sg_mark_end(sgl, nents); +#ifdef CONFIG_DEBUG_SG + { + int i; + for (i = 0; i < nents; i++) + sgl[i].sg_magic = SG_MAGIC; + } +#endif } /** diff --git a/lib/Kconfig.debug b/lib/Kconfig.debug index c567f219191d..1faa5087dc86 100644 --- a/lib/Kconfig.debug +++ b/lib/Kconfig.debug @@ -389,6 +389,16 @@ config DEBUG_LIST If unsure, say N. +config DEBUG_SG + bool "Debug SG table operations" + depends on DEBUG_KERNEL + help + Enable this to turn on checks on scatter-gather tables. This can + help find problems with drivers that do not properly initialize + their sg tables. + + If unsure, say N. + config FRAME_POINTER bool "Compile the kernel with frame pointers" depends on DEBUG_KERNEL && (X86 || CRIS || M68K || M68KNOMMU || FRV || UML || S390 || AVR32 || SUPERH || BFIN) -- cgit v1.2.3