Commit 3db99f00 authored by Lee Jones's avatar Lee Jones Committed by Greg Kroah-Hartman
Browse files

misc: habanalabs: irq: Repair kerneldoc formatting issues 



W=1 kernel builds report a lack of descriptions for various
function arguments.  In reality they are documented, but the
formatting was not as expected '@.*:'.  Instead, '-'s were
used as separators.

While we're here, the headers for functions various functions
were written in kerneldoc format, but lack the kerneldoc
identifier '/**'.  Let's promote them so they can gain access
to the checker.

This change fixes the following W=1 warnings:

 drivers/misc/habanalabs/irq.c:24: warning: Function parameter or member 'eq_work' not described in 'hl_eqe_work'
 drivers/misc/habanalabs/irq.c:24: warning: Function parameter or member 'hdev' not described in 'hl_eqe_work'
 drivers/misc/habanalabs/irq.c:24: warning: Function parameter or member 'eq_entry' not described in 'hl_eqe_work'

Cc: Oded Gabbay <oded.gabbay@gmail.com>
Cc: Tomer Tayar <ttayar@habana.ai>
Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
Reviewed-by: default avatarOded Gabbay <oded.gabbay@gmail.com>
Link: https://lore.kernel.org/r/20200701085853.164358-6-lee.jones@linaro.org


Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent df123c9d

drivers/misc/habanalabs/irq.c

+11 −11
Original line number Diff line number Diff line
@@ -13,9 +13,9 @@ 
 * struct hl_eqe_work - This structure is used to schedule work of EQ

 *                      entry and armcp_reset event

 *

 * @eq_work          - workqueue object to run when EQ entry is received

 * @hdev             - pointer to device structure

 * @eq_entry         - copy of the EQ entry

 * @eq_work:          workqueue object to run when EQ entry is received

 * @hdev:             pointer to device structure

 * @eq_entry:         copy of the EQ entry

 */

struct hl_eqe_work {

	struct work_struct	eq_work;
@@ -23,7 +23,7 @@ struct hl_eqe_work { 
	struct hl_eq_entry	eq_entry;

};



/*

/**

 * hl_cq_inc_ptr - increment ci or pi of cq

 *

 * @ptr: the current ci or pi value of the completion queue
@@ -39,7 +39,7 @@ inline u32 hl_cq_inc_ptr(u32 ptr) 
	return ptr;

}



/*

/**

 * hl_eq_inc_ptr - increment ci of eq

 *

 * @ptr: the current ci value of the event queue
@@ -66,7 +66,7 @@ static void irq_handle_eqe(struct work_struct *work) 
	kfree(eqe_work);

}



/*

/**

 * hl_irq_handler_cq - irq handler for completion queue

 *

 * @irq: irq number
@@ -142,7 +142,7 @@ irqreturn_t hl_irq_handler_cq(int irq, void *arg) 
	return IRQ_HANDLED;

}



/*

/**

 * hl_irq_handler_eq - irq handler for event queue

 *

 * @irq: irq number
@@ -206,7 +206,7 @@ irqreturn_t hl_irq_handler_eq(int irq, void *arg) 
	return IRQ_HANDLED;

}



/*

/**

 * hl_cq_init - main initialization function for an cq object

 *

 * @hdev: pointer to device structure
@@ -238,7 +238,7 @@ int hl_cq_init(struct hl_device *hdev, struct hl_cq *q, u32 hw_queue_id) 
	return 0;

}



/*

/**

 * hl_cq_fini - destroy completion queue

 *

 * @hdev: pointer to device structure
@@ -269,7 +269,7 @@ void hl_cq_reset(struct hl_device *hdev, struct hl_cq *q) 
	memset((void *) (uintptr_t) q->kernel_address, 0, HL_CQ_SIZE_IN_BYTES);

}



/*

/**

 * hl_eq_init - main initialization function for an event queue object

 *

 * @hdev: pointer to device structure
@@ -297,7 +297,7 @@ int hl_eq_init(struct hl_device *hdev, struct hl_eq *q) 
	return 0;

}



/*

/**

 * hl_eq_fini - destroy event queue

 *

 * @hdev: pointer to device structure