svn commit: r289682 - head/sys/ofed/include/linux
Hans Petter Selasky
hselasky at FreeBSD.org
Wed Oct 21 08:51:51 UTC 2015
Author: hselasky
Date: Wed Oct 21 08:51:49 2015
New Revision: 289682
URL: https://svnweb.freebsd.org/changeset/base/289682
Log:
Remove all comments deriving from Linux. Style file for FreeBSD.
Suggested by: emaste @
Sponsored by: Mellanox Technologies
Modified:
head/sys/ofed/include/linux/scatterlist.h
Modified: head/sys/ofed/include/linux/scatterlist.h
==============================================================================
--- head/sys/ofed/include/linux/scatterlist.h Wed Oct 21 08:23:19 2015 (r289681)
+++ head/sys/ofed/include/linux/scatterlist.h Wed Oct 21 08:51:49 2015 (r289682)
@@ -2,7 +2,7 @@
* Copyright (c) 2010 Isilon Systems, Inc.
* Copyright (c) 2010 iX Systems, Inc.
* Copyright (c) 2010 Panasas, Inc.
- * Copyright (c) 2013, 2014 Mellanox Technologies, Ltd.
+ * Copyright (c) 2013-2015 Mellanox Technologies, Ltd.
* Copyright (c) 2015 Matthew Dillon <dillon at backplane.com>
* All rights reserved.
*
@@ -35,48 +35,30 @@
#include <linux/page.h>
#include <linux/slab.h>
-/*
- * SG table design.
- *
- * If flags bit 0 is set, then the sg field contains a pointer to the next sg
- * table list. Otherwise the next entry is at sg + 1, can be determined using
- * the sg_is_chain() function.
- *
- * If flags bit 1 is set, then this sg entry is the last element in a list,
- * can be determined using the sg_is_last() function.
- *
- * See sg_next().
- *
- */
-
struct scatterlist {
union {
- struct page *page;
- struct scatterlist *sg;
- } sl_un;
- dma_addr_t address;
- unsigned long offset;
- uint32_t length;
- uint32_t flags;
+ struct page *page;
+ struct scatterlist *sg;
+ } sl_un;
+ dma_addr_t address;
+ unsigned long offset;
+ uint32_t length;
+ uint32_t flags;
};
struct sg_table {
- struct scatterlist *sgl; /* the list */
- unsigned int nents; /* number of mapped entries */
- unsigned int orig_nents; /* original size of list */
+ struct scatterlist *sgl;
+ unsigned int nents;
+ unsigned int orig_nents;
};
struct sg_page_iter {
- struct scatterlist *sg;
- unsigned int sg_pgoffset; /* page index */
- unsigned int maxents;
+ struct scatterlist *sg;
+ unsigned int sg_pgoffset;
+ unsigned int maxents;
};
-/*
- * Maximum number of entries that will be allocated in one piece, if
- * a list larger than this is required then chaining will be utilized.
- */
-#define SG_MAX_SINGLE_ALLOC (PAGE_SIZE / sizeof(struct scatterlist))
+#define SG_MAX_SINGLE_ALLOC (PAGE_SIZE / sizeof(struct scatterlist))
#define sg_dma_address(sg) (sg)->address
#define sg_dma_len(sg) (sg)->length
@@ -128,60 +110,24 @@ sg_phys(struct scatterlist *sg)
return sg_page(sg)->phys_addr + sg->offset;
}
-/**
- * sg_chain - Chain two sglists together
- * @prv: First scatterlist
- * @prv_nents: Number of entries in prv
- * @sgl: Second 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)
+ struct scatterlist *sgl)
{
-/*
- * offset and length are unused for chain entry. Clear them.
- */
struct scatterlist *sg = &prv[prv_nents - 1];
sg->offset = 0;
sg->length = 0;
-
- /*
- * Indicate a link pointer, and set the link to the second list.
- */
sg->flags = SG_CHAIN;
sg->sl_un.sg = sgl;
}
-/**
- * sg_mark_end - Mark the end of the scatterlist
- * @sg: SG entryScatterlist
- *
- * Description:
- * Marks the passed in sg entry as the termination point for the sg
- * table. A call to sg_next() on this entry will return NULL.
- *
- **/
-static inline void sg_mark_end(struct scatterlist *sg)
+static inline void
+sg_mark_end(struct scatterlist *sg)
{
- sg->flags = SG_END;
+ sg->flags = SG_END;
}
-/**
- * __sg_free_table - Free a previously mapped sg table
- * @table: The sg table header to use
- * @max_ents: The maximum number of entries per single scatterlist
- *
- * Description:
- * Free an sg table previously allocated and setup with
- * __sg_alloc_table(). The @max_ents value must be identical to
- * that previously used with __sg_alloc_table().
- *
- **/
static inline void
__sg_free_table(struct sg_table *table, unsigned int max_ents)
{
@@ -195,12 +141,6 @@ __sg_free_table(struct sg_table *table,
unsigned int alloc_size = table->orig_nents;
unsigned int sg_size;
- /*
- * If we have more than max_ents segments left,
- * then assign 'next' to the sg table after the current one.
- * sg_size is then one less than alloc size, since the last
- * element is the chain pointer.
- */
if (alloc_size > max_ents) {
next = sgl[max_ents - 1].sl_un.sg;
alloc_size = max_ents;
@@ -218,38 +158,15 @@ __sg_free_table(struct sg_table *table,
table->sgl = NULL;
}
-/**
- * sg_free_table - Free a previously allocated sg table
- * @table: The mapped sg table header
- *
- **/
static inline void
sg_free_table(struct sg_table *table)
{
__sg_free_table(table, SG_MAX_SINGLE_ALLOC);
}
-/**
- * __sg_alloc_table - Allocate and initialize an sg table with given allocator
- * @table: The sg table header to use
- * @nents: Number of entries in sg list
- * @max_ents: The maximum number of entries the allocator returns per call
- * @gfp_mask: GFP allocation mask
- *
- * Description:
- * This function returns a @table @nents long. The allocator is
- * defined to return scatterlist chunks of maximum size @max_ents.
- * Thus if @nents is bigger than @max_ents, the scatterlists will be
- * chained in units of @max_ents.
- *
- * Notes:
- * If this function returns non-0 (eg failure), the caller must call
- * __sg_free_table() to cleanup any leftover allocations.
- *
- **/
static inline int
__sg_alloc_table(struct sg_table *table, unsigned int nents,
- unsigned int max_ents, gfp_t gfp_mask)
+ unsigned int max_ents, gfp_t gfp_mask)
{
struct scatterlist *sg, *prv;
unsigned int left;
@@ -261,7 +178,8 @@ __sg_alloc_table(struct sg_table *table,
left = nents;
prv = NULL;
do {
- unsigned int sg_size, alloc_size = left;
+ unsigned int sg_size;
+ unsigned int alloc_size = left;
if (alloc_size > max_ents) {
alloc_size = max_ents;
@@ -273,33 +191,19 @@ __sg_alloc_table(struct sg_table *table,
sg = kmalloc(alloc_size * sizeof(struct scatterlist), gfp_mask);
if (unlikely(!sg)) {
- /*
- * Adjust entry count to reflect that the last
- * entry of the previous table won't be used for
- * linkage. Without this, sg_kfree() may get
- * confused.
- */
if (prv)
table->nents = ++table->orig_nents;
return -ENOMEM;
}
-
sg_init_table(sg, alloc_size);
table->nents = table->orig_nents += sg_size;
- /*
- * If this is the first mapping, assign the sg table header.
- * If this is not the first mapping, chain previous part.
- */
if (prv)
sg_chain(prv, max_ents, sg);
else
table->sgl = sg;
- /*
- * If no more entries after this one, mark the end
- */
if (!left)
sg_mark_end(&sg[sg_size - 1]);
@@ -309,34 +213,19 @@ __sg_alloc_table(struct sg_table *table,
return 0;
}
-/**
- * sg_alloc_table - Allocate and initialize an sg table
- * @table: The sg table header to use
- * @nents: Number of entries in sg list
- * @gfp_mask: GFP allocation mask
- *
- * Description:
- * Allocate and initialize an sg table. If @nents@ is larger than
- * SG_MAX_SINGLE_ALLOC a chained sg table will be setup.
- *
- **/
-
static inline int
sg_alloc_table(struct sg_table *table, unsigned int nents, gfp_t gfp_mask)
{
int ret;
ret = __sg_alloc_table(table, nents, SG_MAX_SINGLE_ALLOC,
- gfp_mask);
+ gfp_mask);
if (unlikely(ret))
__sg_free_table(table, SG_MAX_SINGLE_ALLOC);
return ret;
}
-/*
- * Iterate pages in sg list.
- */
static inline void
_sg_iter_next(struct sg_page_iter *iter)
{
@@ -358,26 +247,16 @@ _sg_iter_next(struct sg_page_iter *iter)
iter->sg = sg;
}
-/*
- * NOTE: pgoffset is really a page index, not a byte offset.
- */
static inline void
_sg_iter_init(struct scatterlist *sgl, struct sg_page_iter *iter,
- unsigned int nents, unsigned long pgoffset)
+ unsigned int nents, unsigned long pgoffset)
{
if (nents) {
- /*
- * Nominal case. Note subtract 1 from starting page index
- * for initial _sg_iter_next() call.
- */
iter->sg = sgl;
iter->sg_pgoffset = pgoffset - 1;
iter->maxents = nents;
_sg_iter_next(iter);
} else {
- /*
- * Degenerate case
- */
iter->sg = NULL;
iter->sg_pgoffset = 0;
iter->maxents = 0;
@@ -397,4 +276,4 @@ sg_page_iter_dma_address(struct sg_page_
#define for_each_sg(sglist, sg, sgmax, _itr) \
for (_itr = 0, sg = (sglist); _itr < (sgmax); _itr++, sg = sg_next(sg))
-#endif /* _LINUX_SCATTERLIST_H_ */
+#endif /* _LINUX_SCATTERLIST_H_ */
More information about the svn-src-all
mailing list