Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 80c57f7a authored by Dong Jia Shi's avatar Dong Jia Shi Committed by Cornelia Huck
Browse files

vfio: ccw: shorten kernel doc description for pfn_array_pin() 



The kernel doc description for usage of the struct pfn_array in
pfn_array_pin() is unnecessary long. Let's shorten it by describing
the contents of the struct pfn_array fields at the struct's definition
instead.

Suggested-by: default avatarCornelia Huck <cohuck@redhat.com>
Signed-off-by: default avatarDong Jia Shi <bjsdjshi@linux.ibm.com>
Message-Id: <20180523025645.8978-2-bjsdjshi@linux.ibm.com>
Signed-off-by: default avatarCornelia Huck <cohuck@redhat.com>
parent fb9e7880

drivers/s390/cio/vfio_ccw_cp.c

+6 −8
Original line number Original line Diff line number Diff line
@@ -23,9 +23,13 @@ 
#define CCWCHAIN_LEN_MAX	256

#define CCWCHAIN_LEN_MAX	256





struct pfn_array {

struct pfn_array {

	/* Starting guest physical I/O address. */

	unsigned long		pa_iova;

	unsigned long		pa_iova;

	/* Array that stores PFNs of the pages need to pin. */

	unsigned long		*pa_iova_pfn;

	unsigned long		*pa_iova_pfn;

	/* Array that receives PFNs of the pages pinned. */

	unsigned long		*pa_pfn;

	unsigned long		*pa_pfn;

	/* Number of pages to pin/pinned from @pa_iova. */

	int			pa_nr;

	int			pa_nr;

};

};
@@ -53,14 +57,8 @@ struct ccwchain { 
 * Attempt to pin user pages in memory.

 * Attempt to pin user pages in memory.

 *

 *

 * Usage of pfn_array:

 * Usage of pfn_array:

 * @pa->pa_iova     starting guest physical I/O address. Assigned by caller.

 * Any field in this structure should be initialized by caller.

 * @pa->pa_iova_pfn array that stores PFNs of the pages need to pin. Allocated

 * We expect @pa->pa_nr > 0, and its value will be assigned by callee.

 *                  by caller.

 * @pa->pa_pfn      array that receives PFNs of the pages pinned. Allocated by

 *                  caller.

 * @pa->pa_nr       number of pages from @pa->pa_iova to pin. Assigned by

 *                  caller.

 *                  number of pages pinned. Assigned by callee.

 *

 *

 * Returns:

 * Returns:

 *   Number of pages pinned on success.

 *   Number of pages pinned on success.