* Subsequent attempts to open a shared queue should
* also have this flag.
*
- * Returns a handle to the open hardware queue if successful. Use IS_ERR()
+ * Return: handle to the open hardware queue on success. Use IS_ERR()
* to check the returned value for error codes.
*/
void *knav_queue_open(const char *name, unsigned id,
* @cmd: - control commands
* @arg: - command argument
*
- * Returns 0 on success, errno otherwise.
+ * Return: 0 on success, errno otherwise.
*/
int knav_queue_device_control(void *qhandle, enum knav_queue_ctrl_cmd cmd,
unsigned long arg)
* @size: - size of data to push
* @flags: - can be used to pass additional information
*
- * Returns 0 on success, errno otherwise.
+ * Return: 0 on success, errno otherwise.
*/
int knav_queue_push(void *qhandle, dma_addr_t dma,
unsigned size, unsigned flags)
* @qhandle: - hardware queue handle
* @size: - (optional) size of the data pop'ed.
*
- * Returns a DMA address on success, 0 on failure.
+ * Return: DMA address on success, 0 on failure.
*/
dma_addr_t knav_queue_pop(void *qhandle, unsigned *size)
{
* @region_id: - QMSS region id from which the descriptors are to be
* allocated.
*
- * Returns a pool handle on success.
- * Use IS_ERR_OR_NULL() to identify error values on return.
+ * Return: pool handle on success. Use IS_ERR_OR_NULL() to identify
+ * error values on return.
*/
void *knav_pool_create(const char *name,
int num_desc, int region_id)
* knav_pool_desc_get() - Get a descriptor from the pool
* @ph: - pool handle
*
- * Returns descriptor from the pool.
+ * Return: descriptor from the pool on success, error pointer otherwise.
*/
void *knav_pool_desc_get(void *ph)
{
* @dma: - DMA address return pointer
* @dma_sz: - adjusted return pointer
*
- * Returns 0 on success, errno otherwise.
+ * Return: 0 on success, errno otherwise.
*/
int knav_pool_desc_map(void *ph, void *desc, unsigned size,
dma_addr_t *dma, unsigned *dma_sz)
* @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
+ * Return: descriptor address on success. Use IS_ERR_OR_NULL() to identify
* error values on return.
*/
void *knav_pool_desc_unmap(void *ph, dma_addr_t dma, unsigned dma_sz)
/**
* knav_pool_count() - Get the number of descriptors in pool.
* @ph: - pool handle
- * Returns number of elements in the pool.
+ *
+ * Return: number of elements in the pool.
*/
int knav_pool_count(void *ph)
{