Commit e8ebf411 authored Nov 21, 2020 by Lee Jones Committed by Santosh Shilimkar Nov 21, 2020

soc: ti: knav_qmss_queue: Fix a whole host of function documentation issues

Fixes the following W=1 kernel build warning(s):

drivers/soc/ti/knav_qmss_queue.c:528: warning: Function parameter or member 'flags' not described in 'knav_queue_open'
drivers/soc/ti/knav_qmss_queue.c:528: warning: Function parameter or member 'id' not described in 'knav_queue_open'
drivers/soc/ti/knav_qmss_queue.c:528: warning: Function parameter or member 'name' not described in 'knav_queue_open'
drivers/soc/ti/knav_qmss_queue.c:551: warning: Excess function parameter 'qh' description in 'knav_queue_close'
drivers/soc/ti/knav_qmss_queue.c:551: warning: Function parameter or member 'qhandle' not described in 'knav_queue_close'
drivers/soc/ti/knav_qmss_queue.c:583: warning: Excess function parameter 'qh' description in 'knav_queue_device_control'
drivers/soc/ti/knav_qmss_queue.c:583: warning: Function parameter or member 'arg' not described in 'knav_queue_device_control'
drivers/soc/ti/knav_qmss_queue.c:583: warning: Function parameter or member 'cmd' not described in 'knav_queue_device_control'
drivers/soc/ti/knav_qmss_queue.c:583: warning: Function parameter or member 'qhandle' not described in 'knav_queue_device_control'
drivers/soc/ti/knav_qmss_queue.c:635: warning: Excess function parameter 'data' description in 'knav_queue_push'
drivers/soc/ti/knav_qmss_queue.c:635: warning: Excess function parameter 'qh' description in 'knav_queue_push'
drivers/soc/ti/knav_qmss_queue.c:635: warning: Function parameter or member 'dma' not described in 'knav_queue_push'
drivers/soc/ti/knav_qmss_queue.c:635: warning: Function parameter or member 'flags' not described in 'knav_queue_push'
drivers/soc/ti/knav_qmss_queue.c:635: warning: Function parameter or member 'qhandle' not described in 'knav_queue_push'
drivers/soc/ti/knav_qmss_queue.c:635: warning: Function parameter or member 'size' not described in 'knav_queue_push'
drivers/soc/ti/knav_qmss_queue.c:655: warning: Excess function parameter 'qh' description in 'knav_queue_pop'
drivers/soc/ti/knav_qmss_queue.c:655: warning: Function parameter or member 'qhandle' not described in 'knav_queue_pop'
drivers/soc/ti/knav_qmss_queue.c:655: warning: Function parameter or member 'size' not described in 'knav_queue_pop'
drivers/soc/ti/knav_qmss_queue.c:759: warning: Function parameter or member 'name' not described in 'knav_pool_create'
drivers/soc/ti/knav_qmss_queue.c:759: warning: Function parameter or member 'num_desc' not described in 'knav_pool_create'
drivers/soc/ti/knav_qmss_queue.c:759: warning: Function parameter or member 'region_id' not described in 'knav_pool_create'
drivers/soc/ti/knav_qmss_queue.c:862: warning: Excess function parameter 'pool' description in 'knav_pool_destroy'
drivers/soc/ti/knav_qmss_queue.c:862: warning: Function parameter or member 'ph' not described in 'knav_pool_destroy'
drivers/soc/ti/knav_qmss_queue.c:892: warning: Excess function parameter 'pool' description in 'knav_pool_desc_get'
drivers/soc/ti/knav_qmss_queue.c:892: warning: Function parameter or member 'ph' not described in 'knav_pool_desc_get'
drivers/soc/ti/knav_qmss_queue.c:911: warning: Excess function parameter 'pool' description in 'knav_pool_desc_put'
drivers/soc/ti/knav_qmss_queue.c:911: warning: Function parameter or member 'desc' not described in 'knav_pool_desc_put'
drivers/soc/ti/knav_qmss_queue.c:911: warning: Function parameter or member 'ph' not described in 'knav_pool_desc_put'
drivers/soc/ti/knav_qmss_queue.c:931: warning: Excess function parameter 'pool' description in 'knav_pool_desc_map'
drivers/soc/ti/knav_qmss_queue.c:931: warning: Function parameter or member 'desc' not described in 'knav_pool_desc_map'
drivers/soc/ti/knav_qmss_queue.c:931: warning: Function parameter or member 'dma' not described in 'knav_pool_desc_map'
drivers/soc/ti/knav_qmss_queue.c:931: warning: Function parameter or member 'dma_sz' not described in 'knav_pool_desc_map'
drivers/soc/ti/knav_qmss_queue.c:931: warning: Function parameter or member 'ph' not described in 'knav_pool_desc_map'
drivers/soc/ti/knav_qmss_queue.c:931: warning: Function parameter or member 'size' not described in 'knav_pool_desc_map'
drivers/soc/ti/knav_qmss_queue.c:956: warning: Excess function parameter 'pool' description in 'knav_pool_desc_unmap'
drivers/soc/ti/knav_qmss_queue.c:956: warning: Function parameter or member 'dma' not described in 'knav_pool_desc_unmap'
drivers/soc/ti/knav_qmss_queue.c:956: warning: Function parameter or member 'dma_sz' not described in 'knav_pool_desc_unmap'
drivers/soc/ti/knav_qmss_queue.c:956: warning: Function parameter or member 'ph' not described in 'knav_pool_desc_unmap'
drivers/soc/ti/knav_qmss_queue.c:975: warning: Excess function parameter 'pool' description in 'knav_pool_count'
drivers/soc/ti/knav_qmss_queue.c:975: warning: Function parameter or member 'ph' not described in 'knav_pool_count'

Cc: Santosh Shilimkar <ssantosh@kernel.org>
Cc: Sandeep Nair <sandeep_n@ti.com>
Cc: Cyril Chemparathy <cyril@ti.com>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
Signed-off-by: Santosh Shilimkar <santosh.shilimkar@oracle.com>

parent e7250109

drivers/soc/ti/knav_qmss_queue.c

+30 −29

Original line number	Diff line number	Diff line
		@@ -79,7 +79,7 @@ EXPORT_SYMBOL_GPL(knav_qmss_device_ready);
		/**
		* knav_queue_notify: qmss queue notfier call
		*
		* @inst: qmss queue instance like accumulator
		* @inst: - qmss queue instance like accumulator
		*/
		void knav_queue_notify(struct knav_queue_inst *inst)
		{
		@@ -511,10 +511,10 @@ static int knav_queue_flush(struct knav_queue *qh)

		/**
		* knav_queue_open() - open a hardware queue
		* @name - name to give the queue handle
		* @id - desired queue number if any or specifes the type
		* @name: - name to give the queue handle
		* @id: - desired queue number if any or specifes the type
		* of queue
		* @flags - the following flags are applicable to queues:
		* @flags: - the following flags are applicable to queues:
		* KNAV_QUEUE_SHARED - allow the queue to be shared. Queues are
		* exclusive by default.
		* Subsequent attempts to open a shared queue should
		@@ -545,7 +545,7 @@ EXPORT_SYMBOL_GPL(knav_queue_open);

		/**
		* knav_queue_close() - close a hardware queue handle
		* @qh - handle to close
		* @qhandle: - handle to close
		*/
		void knav_queue_close(void *qhandle)
		{
		@@ -572,9 +572,9 @@ EXPORT_SYMBOL_GPL(knav_queue_close);

		/**
		* knav_queue_device_control() - Perform control operations on a queue
		* @qh - queue handle
		* @cmd - control commands
		* @arg - command argument
		* @qhandle: - queue handle
		* @cmd: - control commands
		* @arg: - command argument
		*
		* Returns 0 on success, errno otherwise.
		*/
		@@ -623,10 +623,10 @@ EXPORT_SYMBOL_GPL(knav_queue_device_control);

		/**
		* knav_queue_push() - push data (or descriptor) to the tail of a queue
		* @qh - hardware queue handle
		* @data - data to push
		* @size - size of data to push
		* @flags - can be used to pass additional information
		* @qhandle: - hardware queue handle
		* @dma: - DMA data to push
		* @size: - size of data to push
		* @flags: - can be used to pass additional information
		*
		* Returns 0 on success, errno otherwise.
		*/
		@@ -646,8 +646,8 @@ EXPORT_SYMBOL_GPL(knav_queue_push);

		/**
		* knav_queue_pop() - pop data (or descriptor) from the head of a queue
		* @qh - hardware queue handle
		* @size - (optional) size of the data pop'ed.
		* @qhandle: - hardware queue handle
		* @size: - (optional) size of the data pop'ed.
		*
		* Returns a DMA address on success, 0 on failure.
		*/
		@@ -746,9 +746,9 @@ EXPORT_SYMBOL_GPL(knav_pool_desc_dma_to_virt);

		/**
		* knav_pool_create() - Create a pool of descriptors
		* @name - name to give the pool handle
		* @num_desc - numbers of descriptors in the pool
		* @region_id - QMSS region id from which the descriptors are to be
		* @name: - name to give the pool handle
		* @num_desc: - numbers of descriptors in the pool
		* @region_id: - QMSS region id from which the descriptors are to be
		* allocated.
		*
		* Returns a pool handle on success.
		@@ -856,7 +856,7 @@ EXPORT_SYMBOL_GPL(knav_pool_create);

		/**
		* knav_pool_destroy() - Free a pool of descriptors
		* @pool - pool handle
		* @ph: - pool handle
		*/
		void knav_pool_destroy(void *ph)
		{
		@@ -884,7 +884,7 @@ EXPORT_SYMBOL_GPL(knav_pool_destroy);

		/**
		* knav_pool_desc_get() - Get a descriptor from the pool
		* @pool - pool handle
		* @ph: - pool handle
		*
		* Returns descriptor from the pool.
		*/
		@@ -905,7 +905,8 @@ EXPORT_SYMBOL_GPL(knav_pool_desc_get);

		/**
		* knav_pool_desc_put() - return a descriptor to the pool
		* @pool - pool handle
		* @ph: - pool handle
		* @desc: - virtual address
		*/
		void knav_pool_desc_put(void ph, void desc)
		{
		@@ -918,11 +919,11 @@ EXPORT_SYMBOL_GPL(knav_pool_desc_put);

		/**
		* knav_pool_desc_map() - Map descriptor for DMA transfer
		* @pool - pool handle
		* @desc - address of descriptor to map
		* @size - size of descriptor to map
		* @dma - DMA address return pointer
		* @dma_sz - adjusted return pointer
		* @ph: - pool handle
		* @desc: - address of descriptor to map
		* @size: - size of descriptor to map
		* @dma: - DMA address return pointer
		* @dma_sz: - adjusted return pointer
		*
		* Returns 0 on success, errno otherwise.
		*/
		@@ -945,9 +946,9 @@ EXPORT_SYMBOL_GPL(knav_pool_desc_map);

		/**
		* knav_pool_desc_unmap() - Unmap descriptor after DMA transfer
		* @pool - pool handle
		* @dma - DMA address of descriptor to unmap
		* @dma_sz - size of descriptor to unmap
		* @ph: - pool handle
		* @dma: - DMA address of descriptor to unmap
		* @dma_sz: - size of descriptor to unmap
		*
		* Returns descriptor address on success, Use IS_ERR_OR_NULL() to identify
		* error values on return.
		@@ -968,7 +969,7 @@ EXPORT_SYMBOL_GPL(knav_pool_desc_unmap);

		/**
		* knav_pool_count() - Get the number of descriptors in pool.
		* @pool - pool handle
		* @ph: - pool handle
		* Returns number of elements in the pool.
		*/
		int knav_pool_count(void *ph)

Admin message