misc: genwqe: card_ddcb: Fix a variety of kerneldoc issues (7adb55bd) · Commits · github.com / kvm-riscv / linux

drivers/misc/genwqe/card_ddcb.c

+15 −5

Original line number	Diff line number	Diff line
		// SPDX-License-Identifier: GPL-2.0-only
		/**
		/*
		* IBM Accelerator Family 'GenWQE'
		*
		* (C) Copyright IBM Corp. 2013
		@@ -244,10 +244,13 @@ static int ddcb_requ_finished(struct genwqe_dev cd, struct ddcb_requ req)
		(cd->card_state != GENWQE_CARD_USED);
		}

		#define RET_DDCB_APPENDED 1
		#define RET_DDCB_TAPPED 2
		/**
		* enqueue_ddcb() - Enqueue a DDCB
		* @cd: pointer to genwqe device descriptor
		* @queue: queue this operation should be done on
		* @pddcb: pointer to ddcb structure
		* @ddcb_no: pointer to ddcb number being tapped
		*
		* Start execution of DDCB by tapping or append to queue via NEXT
		@@ -259,9 +262,6 @@ static int ddcb_requ_finished(struct genwqe_dev cd, struct ddcb_requ req)
		* Return: 1 if new DDCB is appended to previous
		* 2 if DDCB queue is tapped via register/simulation
		*/
		#define RET_DDCB_APPENDED 1
		#define RET_DDCB_TAPPED 2

		static int enqueue_ddcb(struct genwqe_dev cd, struct ddcb_queue queue,
		struct ddcb *pddcb, int ddcb_no)
		{
		@@ -316,6 +316,8 @@ static int enqueue_ddcb(struct genwqe_dev cd, struct ddcb_queue queue,

		/**
		* copy_ddcb_results() - Copy output state from real DDCB to request
		* @req: pointer to requsted DDCB parameters
		* @ddcb_no: pointer to ddcb number being tapped
		*
		* Copy DDCB ASV to request struct. There is no endian
		* conversion made, since data structure in ASV is still
		@@ -356,6 +358,7 @@ static void copy_ddcb_results(struct ddcb_requ *req, int ddcb_no)
		/**
		* genwqe_check_ddcb_queue() - Checks DDCB queue for completed work equests.
		* @cd: pointer to genwqe device descriptor
		* @queue: queue to be checked
		*
		* Return: Number of DDCBs which were finished
		*/
		@@ -553,6 +556,8 @@ int __genwqe_wait_ddcb(struct genwqe_dev cd, struct ddcb_requ req)
		/**
		* get_next_ddcb() - Get next available DDCB
		* @cd: pointer to genwqe device descriptor
		* @queue: DDCB queue
		* @num: internal DDCB number
		*
		* DDCB's content is completely cleared but presets for PRE and
		* SEQNUM. This function must only be called when ddcb_lock is held.
		@@ -900,7 +905,7 @@ int __genwqe_enqueue_ddcb(struct genwqe_dev cd, struct ddcb_requ req,
		/**
		* __genwqe_execute_raw_ddcb() - Setup and execute DDCB
		* @cd: pointer to genwqe device descriptor
		* @req: user provided DDCB request
		* @cmd: user provided DDCB command
		* @f_flags: file mode: blocking, non-blocking
		*/
		int __genwqe_execute_raw_ddcb(struct genwqe_dev *cd,
		@@ -965,6 +970,7 @@ int __genwqe_execute_raw_ddcb(struct genwqe_dev *cd,

		/**
		* genwqe_next_ddcb_ready() - Figure out if the next DDCB is already finished
		* @cd: pointer to genwqe device descriptor
		*
		* We use this as condition for our wait-queue code.
		*/
		@@ -993,6 +999,7 @@ static int genwqe_next_ddcb_ready(struct genwqe_dev *cd)

		/**
		* genwqe_ddcbs_in_flight() - Check how many DDCBs are in flight
		* @cd: pointer to genwqe device descriptor
		*
		* Keep track on the number of DDCBs which ware currently in the
		* queue. This is needed for statistics as well as conditon if we want
		@@ -1171,6 +1178,7 @@ static irqreturn_t genwqe_vf_isr(int irq, void *dev_id)

		/**
		* genwqe_card_thread() - Work thread for the DDCB queue
		* @data: pointer to genwqe device descriptor
		*
		* The idea is to check if there are DDCBs in processing. If there are
		* some finished DDCBs, we process them and wakeup the
		@@ -1299,6 +1307,7 @@ int genwqe_setup_service_layer(struct genwqe_dev *cd)

		/**
		* queue_wake_up_all() - Handles fatal error case
		* @cd: pointer to genwqe device descriptor
		*
		* The PCI device got unusable and we have to stop all pending
		* requests as fast as we can. The code after this must purge the
		@@ -1323,6 +1332,7 @@ static int queue_wake_up_all(struct genwqe_dev *cd)

		/**
		* genwqe_finish_queue() - Remove any genwqe devices and user-interfaces
		* @cd: pointer to genwqe device descriptor
		*
		* Relies on the pre-condition that there are no users of the card
		* device anymore e.g. with open file-descriptors.