Commit 4b514fa2 authored by Alexey Roslyakov's avatar Alexey Roslyakov Committed by Ulf Hansson
Browse files

mmc: dw_mmc: update kernel-doc comments for dw_mci 



cur_slot and num_slots has been removed from struct dw_mci in 42f989c0.
Unfortunately, inline documentation was not updated so far.

Fix @lock field documentation in Locking section.
Move @mrq field of struct dw_mci_slot mention closer to it
description, so no one could miss this slightest detail.

Couple of code style fixes as a bonus.

Signed-off-by: default avatarAlexey Roslyakov <alexey.roslyakov@gmail.com>
Reviewed-by: default avatarShawn Lin <shawn.lin@rock-chips.com>
Acked-by: default avatarJaehoon Chung <jh80.chung@samsung.com>
Signed-off-by: default avatarUlf Hansson <ulf.hansson@linaro.org>
parent ec10ab57

drivers/mmc/host/dw_mmc.h

+9 −10
Original line number Diff line number Diff line
@@ -65,8 +65,7 @@ struct dw_mci_dma_slave { 
 * @fifo_reg: Pointer to MMIO registers for data FIFO

 * @sg: Scatterlist entry currently being processed by PIO code, if any.

 * @sg_miter: PIO mapping scatterlist iterator.

 * @cur_slot: The slot which is currently using the controller.

 * @mrq: The request currently being processed on @cur_slot,

 * @mrq: The request currently being processed on @slot,

 *	or NULL if the controller is idle.

 * @cmd: The command currently being sent to the card, or NULL.

 * @data: The data currently being transferred, or NULL if no data
@@ -102,7 +101,6 @@ struct dw_mci_dma_slave { 
 * @bus_hz: The rate of @mck in Hz. This forms the basis for MMC bus

 *	rate and timeout calculations.

 * @current_speed: Configured rate of the controller.

 * @num_slots: Number of slots available.

 * @fifoth_val: The value of FIFOTH register.

 * @verid: Denote Version ID.

 * @dev: Device associated with the MMC controller.
@@ -134,17 +132,17 @@ struct dw_mci_dma_slave { 
 * =======

 *

 * @lock is a softirq-safe spinlock protecting @queue as well as

 * @slot, @mrq and @state. These must always be updated

 * at the same time while holding @lock.

 * The @mrq field of struct dw_mci_slot is also protected by @lock,

 * and must always be written at the same time as the slot is added to

 * @queue.

 *

 * @irq_lock is an irq-safe spinlock protecting the INTMASK register

 * to allow the interrupt handler to modify it directly.  Held for only long

 * enough to read-modify-write INTMASK and no other locks are grabbed when

 * holding this one.

 *

 * The @mrq field of struct dw_mci_slot is also protected by @lock,

 * and must always be written at the same time as the slot is added to

 * @queue.

 *

 * @pending_events and @completed_events are accessed using atomic bit

 * operations, so they don't need any locking.

 *
@@ -449,7 +447,8 @@ struct dw_mci_board { 
	(SDMMC_CTRL_RESET | SDMMC_CTRL_FIFO_RESET | SDMMC_CTRL_DMA_RESET)



/* FIFO register access macros. These should not change the data endian-ness

 * as they are written to memory to be dealt with by the upper layers */

 * as they are written to memory to be dealt with by the upper layers

 */

#define mci_fifo_readw(__reg)	__raw_readw(__reg)

#define mci_fifo_readl(__reg)	__raw_readl(__reg)

#define mci_fifo_readq(__reg)	__raw_readq(__reg)