1
2#ifndef _LINUX_SCATTERLIST_H
3#define _LINUX_SCATTERLIST_H
4
5#include <linux/string.h>
6#include <linux/types.h>
7#include <linux/bug.h>
8#include <linux/mm.h>
9#include <asm/io.h>
10
11struct scatterlist {
12#ifdef CONFIG_DEBUG_SG
13 unsigned long sg_magic;
14#endif
15 unsigned long page_link;
16 unsigned int offset;
17 unsigned int length;
18 dma_addr_t dma_address;
19#ifdef CONFIG_NEED_SG_DMA_LENGTH
20 unsigned int dma_length;
21#endif
22};
23
24
25
26
27
28
29
30
31#define sg_dma_address(sg) ((sg)->dma_address)
32
33#ifdef CONFIG_NEED_SG_DMA_LENGTH
34#define sg_dma_len(sg) ((sg)->dma_length)
35#else
36#define sg_dma_len(sg) ((sg)->length)
37#endif
38
39struct sg_table {
40 struct scatterlist *sgl;
41 unsigned int nents;
42 unsigned int orig_nents;
43};
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61#define SG_MAGIC 0x87654321
62
63
64
65
66
67
68#define sg_is_chain(sg) ((sg)->page_link & 0x01)
69#define sg_is_last(sg) ((sg)->page_link & 0x02)
70#define sg_chain_ptr(sg) \
71 ((struct scatterlist *) ((sg)->page_link & ~0x03))
72
73
74
75
76
77
78
79
80
81
82
83static inline void sg_assign_page(struct scatterlist *sg, struct page *page)
84{
85 unsigned long page_link = sg->page_link & 0x3;
86
87
88
89
90
91 BUG_ON((unsigned long) page & 0x03);
92#ifdef CONFIG_DEBUG_SG
93 BUG_ON(sg->sg_magic != SG_MAGIC);
94 BUG_ON(sg_is_chain(sg));
95#endif
96 sg->page_link = page_link | (unsigned long) page;
97}
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113static inline void sg_set_page(struct scatterlist *sg, struct page *page,
114 unsigned int len, unsigned int offset)
115{
116 sg_assign_page(sg, page);
117 sg->offset = offset;
118 sg->length = len;
119}
120
121static inline struct page *sg_page(struct scatterlist *sg)
122{
123#ifdef CONFIG_DEBUG_SG
124 BUG_ON(sg->sg_magic != SG_MAGIC);
125 BUG_ON(sg_is_chain(sg));
126#endif
127 return (struct page *)((sg)->page_link & ~0x3);
128}
129
130
131
132
133
134
135
136
137static inline void sg_set_buf(struct scatterlist *sg, const void *buf,
138 unsigned int buflen)
139{
140#ifdef CONFIG_DEBUG_SG
141 BUG_ON(!virt_addr_valid(buf));
142#endif
143 sg_set_page(sg, virt_to_page(buf), buflen, offset_in_page(buf));
144}
145
146
147
148
149#define for_each_sg(sglist, sg, nr, __i) \
150 for (__i = 0, sg = (sglist); __i < (nr); __i++, sg = sg_next(sg))
151
152
153
154
155
156
157
158
159
160
161
162static inline void sg_chain(struct scatterlist *prv, unsigned int prv_nents,
163 struct scatterlist *sgl)
164{
165
166
167
168 prv[prv_nents - 1].offset = 0;
169 prv[prv_nents - 1].length = 0;
170
171
172
173
174
175 prv[prv_nents - 1].page_link = ((unsigned long) sgl | 0x01) & ~0x02;
176}
177
178
179
180
181
182
183
184
185
186
187static inline void sg_mark_end(struct scatterlist *sg)
188{
189#ifdef CONFIG_DEBUG_SG
190 BUG_ON(sg->sg_magic != SG_MAGIC);
191#endif
192
193
194
195 sg->page_link |= 0x02;
196 sg->page_link &= ~0x01;
197}
198
199
200
201
202
203
204
205
206
207static inline void sg_unmark_end(struct scatterlist *sg)
208{
209#ifdef CONFIG_DEBUG_SG
210 BUG_ON(sg->sg_magic != SG_MAGIC);
211#endif
212 sg->page_link &= ~0x02;
213}
214
215
216
217
218
219
220
221
222
223
224
225static inline dma_addr_t sg_phys(struct scatterlist *sg)
226{
227 return page_to_phys(sg_page(sg)) + sg->offset;
228}
229
230
231
232
233
234
235
236
237
238
239
240static inline void *sg_virt(struct scatterlist *sg)
241{
242 return page_address(sg_page(sg)) + sg->offset;
243}
244
245int sg_nents(struct scatterlist *sg);
246int sg_nents_for_len(struct scatterlist *sg, u64 len);
247struct scatterlist *sg_next(struct scatterlist *);
248struct scatterlist *sg_last(struct scatterlist *s, unsigned int);
249void sg_init_table(struct scatterlist *, unsigned int);
250void sg_init_one(struct scatterlist *, const void *, unsigned int);
251int sg_split(struct scatterlist *in, const int in_mapped_nents,
252 const off_t skip, const int nb_splits,
253 const size_t *split_sizes,
254 struct scatterlist **out, int *out_mapped_nents,
255 gfp_t gfp_mask);
256
257typedef struct scatterlist *(sg_alloc_fn)(unsigned int, gfp_t);
258typedef void (sg_free_fn)(struct scatterlist *, unsigned int);
259
260void __sg_free_table(struct sg_table *, unsigned int, bool, sg_free_fn *);
261void sg_free_table(struct sg_table *);
262int __sg_alloc_table(struct sg_table *, unsigned int, unsigned int,
263 struct scatterlist *, gfp_t, sg_alloc_fn *);
264int sg_alloc_table(struct sg_table *, unsigned int, gfp_t);
265int sg_alloc_table_from_pages(struct sg_table *sgt,
266 struct page **pages, unsigned int n_pages,
267 unsigned long offset, unsigned long size,
268 gfp_t gfp_mask);
269
270size_t sg_copy_buffer(struct scatterlist *sgl, unsigned int nents, void *buf,
271 size_t buflen, off_t skip, bool to_buffer);
272
273size_t sg_copy_from_buffer(struct scatterlist *sgl, unsigned int nents,
274 const void *buf, size_t buflen);
275size_t sg_copy_to_buffer(struct scatterlist *sgl, unsigned int nents,
276 void *buf, size_t buflen);
277
278size_t sg_pcopy_from_buffer(struct scatterlist *sgl, unsigned int nents,
279 const void *buf, size_t buflen, off_t skip);
280size_t sg_pcopy_to_buffer(struct scatterlist *sgl, unsigned int nents,
281 void *buf, size_t buflen, off_t skip);
282size_t sg_zero_buffer(struct scatterlist *sgl, unsigned int nents,
283 size_t buflen, off_t skip);
284
285
286
287
288
289#define SG_MAX_SINGLE_ALLOC (PAGE_SIZE / sizeof(struct scatterlist))
290
291
292
293
294
295
296
297
298#define SG_CHUNK_SIZE 128
299
300
301
302
303
304#ifdef CONFIG_ARCH_HAS_SG_CHAIN
305#define SG_MAX_SEGMENTS 2048
306#else
307#define SG_MAX_SEGMENTS SG_CHUNK_SIZE
308#endif
309
310#ifdef CONFIG_SG_POOL
311void sg_free_table_chained(struct sg_table *table, bool first_chunk);
312int sg_alloc_table_chained(struct sg_table *table, int nents,
313 struct scatterlist *first_chunk);
314#endif
315
316
317
318
319
320
321
322
323
324
325
326struct sg_page_iter {
327 struct scatterlist *sg;
328 unsigned int sg_pgoffset;
329
330
331 unsigned int __nents;
332 int __pg_advance;
333
334};
335
336bool __sg_page_iter_next(struct sg_page_iter *piter);
337void __sg_page_iter_start(struct sg_page_iter *piter,
338 struct scatterlist *sglist, unsigned int nents,
339 unsigned long pgoffset);
340
341
342
343
344static inline struct page *sg_page_iter_page(struct sg_page_iter *piter)
345{
346 return nth_page(sg_page(piter->sg), piter->sg_pgoffset);
347}
348
349
350
351
352
353
354static inline dma_addr_t sg_page_iter_dma_address(struct sg_page_iter *piter)
355{
356 return sg_dma_address(piter->sg) + (piter->sg_pgoffset << PAGE_SHIFT);
357}
358
359
360
361
362
363
364
365
366#define for_each_sg_page(sglist, piter, nents, pgoffset) \
367 for (__sg_page_iter_start((piter), (sglist), (nents), (pgoffset)); \
368 __sg_page_iter_next(piter);)
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386#define SG_MITER_ATOMIC (1 << 0)
387#define SG_MITER_TO_SG (1 << 1)
388#define SG_MITER_FROM_SG (1 << 2)
389
390struct sg_mapping_iter {
391
392 struct page *page;
393 void *addr;
394 size_t length;
395 size_t consumed;
396 struct sg_page_iter piter;
397
398
399 unsigned int __offset;
400 unsigned int __remaining;
401 unsigned int __flags;
402};
403
404void sg_miter_start(struct sg_mapping_iter *miter, struct scatterlist *sgl,
405 unsigned int nents, unsigned int flags);
406bool sg_miter_skip(struct sg_mapping_iter *miter, off_t offset);
407bool sg_miter_next(struct sg_mapping_iter *miter);
408void sg_miter_stop(struct sg_mapping_iter *miter);
409
410#endif
411