Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 19e75ea7 authored by Randy Dunlap's avatar Randy Dunlap Committed by David Woodhouse
Browse files

[MTD] [OneNAND] onenand-sim: fix kernel-doc and typos 



Correct kernel-doc notation and descriptions.
Correct other typos.

Signed-off-by: default avatarRandy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: default avatarDavid Woodhouse <dwmw2@infradead.org>
parent cfc8dc6f

drivers/mtd/onenand/onenand_sim.c

+25 −24
Original line number Original line Diff line number Diff line
@@ -88,11 +88,11 @@ do { \ 




/**

/**

 * onenand_lock_handle - Handle Lock scheme

 * onenand_lock_handle - Handle Lock scheme

 * @param this		OneNAND device structure

 * @this:		OneNAND device structure

 * @param cmd		The command to be sent

 * @cmd:		The command to be sent

 *

 *

 * Send lock command to OneNAND device.

 * Send lock command to OneNAND device.

 * The lock scheme is depends on chip type.

 * The lock scheme depends on chip type.

 */

 */

static void onenand_lock_handle(struct onenand_chip *this, int cmd)

static void onenand_lock_handle(struct onenand_chip *this, int cmd)

{

{
@@ -131,8 +131,8 @@ static void onenand_lock_handle(struct onenand_chip *this, int cmd) 




/**

/**

 * onenand_bootram_handle - Handle BootRAM area

 * onenand_bootram_handle - Handle BootRAM area

 * @param this		OneNAND device structure

 * @this:		OneNAND device structure

 * @param cmd		The command to be sent

 * @cmd:		The command to be sent

 *

 *

 * Emulate BootRAM area. It is possible to do basic operation using BootRAM.

 * Emulate BootRAM area. It is possible to do basic operation using BootRAM.

 */

 */
@@ -153,10 +153,10 @@ static void onenand_bootram_handle(struct onenand_chip *this, int cmd) 




/**

/**

 * onenand_update_interrupt - Set interrupt register

 * onenand_update_interrupt - Set interrupt register

 * @param this         OneNAND device structure

 * @this:         OneNAND device structure

 * @param cmd          The command to be sent

 * @cmd:          The command to be sent

 *

 *

 * Update interrupt register. The status is depends on command.

 * Update interrupt register. The status depends on command.

 */

 */

static void onenand_update_interrupt(struct onenand_chip *this, int cmd)

static void onenand_update_interrupt(struct onenand_chip *this, int cmd)

{

{
@@ -189,11 +189,12 @@ static void onenand_update_interrupt(struct onenand_chip *this, int cmd) 
}

}





/**

/**

 * onenand_check_overwrite - Check over-write if happend

 * onenand_check_overwrite - Check if over-write happened

 * @param dest		The destination pointer

 * @dest:		The destination pointer

 * @param src		The source pointer

 * @src:		The source pointer

 * @param count		The length to be check

 * @count:		The length to be check

 * @return		0 on same, otherwise 1

 *

 * Returns:		0 on same, otherwise 1

 *

 *

 * Compare the source with destination

 * Compare the source with destination

 */

 */
@@ -213,10 +214,10 @@ static int onenand_check_overwrite(void *dest, void *src, size_t count) 




/**

/**

 * onenand_data_handle - Handle OneNAND Core and DataRAM

 * onenand_data_handle - Handle OneNAND Core and DataRAM

 * @param this		OneNAND device structure

 * @this:		OneNAND device structure

 * @param cmd		The command to be sent

 * @cmd:		The command to be sent

 * @param dataram	Which dataram used

 * @dataram:		Which dataram used

 * @param offset	The offset to OneNAND Core

 * @offset:		The offset to OneNAND Core

 *

 *

 * Copy data from OneNAND Core to DataRAM (read)

 * Copy data from OneNAND Core to DataRAM (read)

 * Copy data from DataRAM to OneNAND Core (write)

 * Copy data from DataRAM to OneNAND Core (write)
@@ -295,8 +296,8 @@ static void onenand_data_handle(struct onenand_chip *this, int cmd, 




/**

/**

 * onenand_command_handle - Handle command

 * onenand_command_handle - Handle command

 * @param this		OneNAND device structure

 * @this:		OneNAND device structure

 * @param cmd		The command to be sent

 * @cmd:		The command to be sent

 *

 *

 * Emulate OneNAND command.

 * Emulate OneNAND command.

 */

 */
@@ -350,8 +351,8 @@ static void onenand_command_handle(struct onenand_chip *this, int cmd) 




/**

/**

 * onenand_writew - [OneNAND Interface] Emulate write operation

 * onenand_writew - [OneNAND Interface] Emulate write operation

 * @param value		value to write

 * @value:		value to write

 * @param addr		address to write

 * @addr:		address to write

 *

 *

 * Write OneNAND register with value

 * Write OneNAND register with value

 */

 */
@@ -373,7 +374,7 @@ static void onenand_writew(unsigned short value, void __iomem * addr) 




/**

/**

 * flash_init - Initialize OneNAND simulator

 * flash_init - Initialize OneNAND simulator

 * @param flash		OneNAND simulaotr data strucutres

 * @flash:		OneNAND simulator data strucutres

 *

 *

 * Initialize OneNAND simulator.

 * Initialize OneNAND simulator.

 */

 */
@@ -416,7 +417,7 @@ static int __init flash_init(struct onenand_flash *flash) 




/**

/**

 * flash_exit - Clean up OneNAND simulator

 * flash_exit - Clean up OneNAND simulator

 * @param flash		OneNAND simulaotr data strucutres

 * @flash:		OneNAND simulator data structures

 *

 *

 * Clean up OneNAND simulator.

 * Clean up OneNAND simulator.

 */

 */
@@ -449,7 +450,7 @@ static int __init onenand_sim_init(void) 
	info->onenand.write_word = onenand_writew;

	info->onenand.write_word = onenand_writew;





	if (flash_init(&info->flash)) {

	if (flash_init(&info->flash)) {

		printk(KERN_ERR "Unable to allocat flash.\n");

		printk(KERN_ERR "Unable to allocate flash.\n");

		kfree(ffchars);

		kfree(ffchars);

		kfree(info);

		kfree(info);

		return -ENOMEM;

		return -ENOMEM;