Unverified Commit 91af6eb0 authored by Amit Kumar Mahapatra's avatar Amit Kumar Mahapatra Committed by Mark Brown
Browse files

spi: spi-zynqmp-gqspi: Fix kernel-doc warnings 



Fix kernel-doc warnings in ZynqMP qspi driver file.

Signed-off-by: default avatarAmit Kumar Mahapatra <amit.kumar-mahapatra@xilinx.com>
Signed-off-by: default avatarMichal Simek <michal.simek@xilinx.com>
Link: https://lore.kernel.org/r/ba5920c57eee06fafa6f9d1df9859e69819ac301.1600931476.git.michal.simek@xilinx.com


Signed-off-by: default avatarMark Brown <broonie@kernel.org>
parent bf253e6b

drivers/spi/spi-zynqmp-gqspi.c

+23 −22
Original line number Diff line number Diff line
@@ -173,9 +173,10 @@ struct zynqmp_qspi { 
};



/**

 * zynqmp_gqspi_read:	For GQSPI controller read operation

 * zynqmp_gqspi_read - For GQSPI controller read operation

 * @xqspi:	Pointer to the zynqmp_qspi structure

 * @offset:	Offset from where to read

 * Return:      Value at the offset

 */

static u32 zynqmp_gqspi_read(struct zynqmp_qspi *xqspi, u32 offset)

{
@@ -183,7 +184,7 @@ static u32 zynqmp_gqspi_read(struct zynqmp_qspi *xqspi, u32 offset) 
}



/**

 * zynqmp_gqspi_write:	For GQSPI controller write operation

 * zynqmp_gqspi_write - For GQSPI controller write operation

 * @xqspi:	Pointer to the zynqmp_qspi structure

 * @offset:	Offset where to write

 * @val:	Value to be written
@@ -195,7 +196,7 @@ static inline void zynqmp_gqspi_write(struct zynqmp_qspi *xqspi, u32 offset, 
}



/**

 * zynqmp_gqspi_selectslave:	For selection of slave device

 * zynqmp_gqspi_selectslave - For selection of slave device

 * @instanceptr:	Pointer to the zynqmp_qspi structure

 * @slavecs:	For chip select

 * @slavebus:	To check which bus is selected- upper or lower
@@ -242,7 +243,7 @@ static void zynqmp_gqspi_selectslave(struct zynqmp_qspi *instanceptr, 
}



/**

 * zynqmp_qspi_init_hw:	Initialize the hardware

 * zynqmp_qspi_init_hw - Initialize the hardware

 * @xqspi:	Pointer to the zynqmp_qspi structure

 *

 * The default settings of the QSPI controller's configurable parameters on
@@ -330,7 +331,7 @@ static void zynqmp_qspi_init_hw(struct zynqmp_qspi *xqspi) 
}



/**

 * zynqmp_qspi_copy_read_data:	Copy data to RX buffer

 * zynqmp_qspi_copy_read_data - Copy data to RX buffer

 * @xqspi:	Pointer to the zynqmp_qspi structure

 * @data:	The variable where data is stored

 * @size:	Number of bytes to be copied from data to RX buffer
@@ -344,7 +345,7 @@ static void zynqmp_qspi_copy_read_data(struct zynqmp_qspi *xqspi, 
}



/**

 * zynqmp_prepare_transfer_hardware:	Prepares hardware for transfer.

 * zynqmp_prepare_transfer_hardware - Prepares hardware for transfer.

 * @master:	Pointer to the spi_master structure which provides

 *		information about the controller.

 *
@@ -361,7 +362,7 @@ static int zynqmp_prepare_transfer_hardware(struct spi_master *master) 
}



/**

 * zynqmp_unprepare_transfer_hardware:	Relaxes hardware after transfer

 * zynqmp_unprepare_transfer_hardware - Relaxes hardware after transfer

 * @master:	Pointer to the spi_master structure which provides

 *		information about the controller.

 *
@@ -378,7 +379,7 @@ static int zynqmp_unprepare_transfer_hardware(struct spi_master *master) 
}



/**

 * zynqmp_qspi_chipselect:	Select or deselect the chip select line

 * zynqmp_qspi_chipselect - Select or deselect the chip select line

 * @qspi:	Pointer to the spi_device structure

 * @is_high:	Select(0) or deselect (1) the chip select line

 */
@@ -423,7 +424,7 @@ static void zynqmp_qspi_chipselect(struct spi_device *qspi, bool is_high) 
}



/**

 * zynqmp_qspi_setup_transfer:	Configure QSPI controller for specified

 * zynqmp_qspi_setup_transfer - Configure QSPI controller for specified

 *				transfer

 * @qspi:	Pointer to the spi_device structure

 * @transfer:	Pointer to the spi_transfer structure which provides
@@ -482,7 +483,7 @@ static int zynqmp_qspi_setup_transfer(struct spi_device *qspi, 
}



/**

 * zynqmp_qspi_setup:	Configure the QSPI controller

 * zynqmp_qspi_setup - Configure the QSPI controller

 * @qspi:	Pointer to the spi_device structure

 *

 * Sets the operational mode of QSPI controller for the next QSPI transfer,
@@ -498,7 +499,7 @@ static int zynqmp_qspi_setup(struct spi_device *qspi) 
}



/**

 * zynqmp_qspi_filltxfifo:	Fills the TX FIFO as long as there is room in

 * zynqmp_qspi_filltxfifo - Fills the TX FIFO as long as there is room in

 *				the FIFO or the bytes required to be

 *				transmitted.

 * @xqspi:	Pointer to the zynqmp_qspi structure
@@ -524,7 +525,7 @@ static void zynqmp_qspi_filltxfifo(struct zynqmp_qspi *xqspi, int size) 
}



/**

 * zynqmp_qspi_readrxfifo:	Fills the RX FIFO as long as there is room in

 * zynqmp_qspi_readrxfifo - Fills the RX FIFO as long as there is room in

 *				the FIFO.

 * @xqspi:	Pointer to the zynqmp_qspi structure

 * @size:	Number of bytes to be copied from RX buffer to RX FIFO
@@ -552,7 +553,7 @@ static void zynqmp_qspi_readrxfifo(struct zynqmp_qspi *xqspi, u32 size) 
}



/**

 * zynqmp_process_dma_irq:	Handler for DMA done interrupt of QSPI

 * zynqmp_process_dma_irq - Handler for DMA done interrupt of QSPI

 *				controller

 * @xqspi:	zynqmp_qspi instance pointer

 *
@@ -600,7 +601,7 @@ static void zynqmp_process_dma_irq(struct zynqmp_qspi *xqspi) 
}



/**

 * zynqmp_qspi_irq:	Interrupt service routine of the QSPI controller

 * zynqmp_qspi_irq - Interrupt service routine of the QSPI controller

 * @irq:	IRQ number

 * @dev_id:	Pointer to the xqspi structure

 *
@@ -654,7 +655,7 @@ static irqreturn_t zynqmp_qspi_irq(int irq, void *dev_id) 
}



/**

 * zynqmp_qspi_selectspimode:	Selects SPI mode - x1 or x2 or x4.

 * zynqmp_qspi_selectspimode - Selects SPI mode - x1 or x2 or x4.

 * @xqspi:	xqspi is a pointer to the GQSPI instance

 * @spimode:	spimode - SPI or DUAL or QUAD.

 * Return:	Mask to set desired SPI mode in GENFIFO entry.
@@ -682,7 +683,7 @@ static inline u32 zynqmp_qspi_selectspimode(struct zynqmp_qspi *xqspi, 
}



/**

 * zynq_qspi_setuprxdma:	This function sets up the RX DMA operation

 * zynq_qspi_setuprxdma - This function sets up the RX DMA operation

 * @xqspi:	xqspi is a pointer to the GQSPI instance.

 */

static void zynq_qspi_setuprxdma(struct zynqmp_qspi *xqspi)
@@ -732,7 +733,7 @@ static void zynq_qspi_setuprxdma(struct zynqmp_qspi *xqspi) 
}



/**

 * zynqmp_qspi_txrxsetup:	This function checks the TX/RX buffers in

 * zynqmp_qspi_txrxsetup - This function checks the TX/RX buffers in

 *				the transfer and sets up the GENFIFO entries,

 *				TX FIFO as required.

 * @xqspi:	xqspi is a pointer to the GQSPI instance.
@@ -783,7 +784,7 @@ static void zynqmp_qspi_txrxsetup(struct zynqmp_qspi *xqspi, 
}



/**

 * zynqmp_qspi_start_transfer:	Initiates the QSPI transfer

 * zynqmp_qspi_start_transfer - Initiates the QSPI transfer

 * @master:	Pointer to the spi_master structure which provides

 *		information about the controller.

 * @qspi:	Pointer to the spi_device structure
@@ -891,7 +892,7 @@ static int zynqmp_qspi_start_transfer(struct spi_master *master, 
}



/**

 * zynqmp_qspi_suspend:	Suspend method for the QSPI driver

 * zynqmp_qspi_suspend - Suspend method for the QSPI driver

 * @dev:	Address of the platform_device structure

 *

 * This function stops the QSPI driver queue and disables the QSPI controller
@@ -910,7 +911,7 @@ static int __maybe_unused zynqmp_qspi_suspend(struct device *dev) 
}



/**

 * zynqmp_qspi_resume:	Resume method for the QSPI driver

 * zynqmp_qspi_resume - Resume method for the QSPI driver

 * @dev:	Address of the platform_device structure

 *

 * The function starts the QSPI driver queue and initializes the QSPI
@@ -1000,7 +1001,7 @@ static const struct dev_pm_ops zynqmp_qspi_dev_pm_ops = { 
};



/**

 * zynqmp_qspi_probe:	Probe method for the QSPI driver

 * zynqmp_qspi_probe - Probe method for the QSPI driver

 * @pdev:	Pointer to the platform_device structure

 *

 * This function initializes the driver data structures and the hardware.
@@ -1112,7 +1113,7 @@ static int zynqmp_qspi_probe(struct platform_device *pdev) 
}



/**

 * zynqmp_qspi_remove:	Remove method for the QSPI driver

 * zynqmp_qspi_remove - Remove method for the QSPI driver

 * @pdev:	Pointer to the platform_device structure

 *

 * This function is called if a device is physically removed from the system or