Commit fdfda9a6 authored by Manuel Pégourié-Gonnard's avatar Manuel Pégourié-Gonnard Committed by Greg Kroah-Hartman
Browse files

staging: mt29f: clean up existing kernel-doc 



The existing kerneldoc blocs had a few issues:
- some of them didn't start with /**
- some used -- instead of - to separate the short description
- some descriptions had text looking like section headers
- some descriptions started with "to" while some used the imperative: use the
  imperative everywhere
- some had a "with:" at the end of the shortdesc that didn't make sense once
  formatted by kernel-docs
- two argument names where out of sync with the prototype

Signed-off-by: default avatarManuel Pégourié-Gonnard <mpg@elzevir.fr>
Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent 61cb8d9a

drivers/staging/mt29f_spinand/mt29f_spinand.c

+31 −31
Original line number Diff line number Diff line
@@ -63,8 +63,8 @@ static struct nand_ecclayout spinand_oob_64 = { 
};

#endif



/*

 * spinand_cmd - to process a command to send to the SPI Nand

/**

 * spinand_cmd - process a command to send to the SPI Nand

 * Description:

 *    Set up the command buffer to send to the SPI controller.

 *    The command buffer has to initialized to 0.
@@ -110,10 +110,10 @@ static int spinand_cmd(struct spi_device *spi, struct spinand_cmd *cmd) 
	return spi_sync(spi, &message);

}



/*

/**

 * spinand_read_id - Read SPI Nand ID

 * Description:

 *    Read ID: read two ID bytes from the SPI Nand device

 *    read two ID bytes from the SPI Nand device

 */

static int spinand_read_id(struct spi_device *spi_nand, u8 *id)

{
@@ -135,7 +135,7 @@ static int spinand_read_id(struct spi_device *spi_nand, u8 *id) 
	return retval;

}



/*

/**

 * spinand_read_status - send command 0xf to the SPI Nand status register

 * Description:

 *    After read, write, or erase, the Nand device is expected to set the
@@ -313,7 +313,7 @@ static int spinand_read_page_to_cache(struct spi_device *spi_nand, u16 page_id) 
	return spinand_cmd(spi_nand, &cmd);

}



/*

/**

 * spinand_read_from_cache - send command 0x03 to read out the data from the

 * cache register (2112 bytes max)

 * Description:
@@ -341,15 +341,15 @@ static int spinand_read_from_cache(struct spi_device *spi_nand, u16 page_id, 
	return spinand_cmd(spi_nand, &cmd);

}



/*

 * spinand_read_page-to read a page with:

/**

 * spinand_read_page - read a page

 * @page_id: the physical page number

 * @offset:  the location from 0 to 2111

 * @len:     number of bytes to read

 * @rbuf:    read buffer to hold @len bytes

 *

 * Description:

 *   The read includes two commands to the Nand: 0x13 and 0x03 commands

 *   The read includes two commands to the Nand - 0x13 and 0x03 commands

 *   Poll to read status to wait for tRD time.

 */

static int spinand_read_page(struct spi_device *spi_nand, u16 page_id,
@@ -408,11 +408,11 @@ static int spinand_read_page(struct spi_device *spi_nand, u16 page_id, 
	return ret;

}



/*

 * spinand_program_data_to_cache--to write a page to cache with:

/**

 * spinand_program_data_to_cache - write a page to cache

 * @byte_id: the location to write to the cache

 * @len:     number of bytes to write

 * @rbuf:    read buffer to hold @len bytes

 * @wbuf:    write buffer holding @len bytes

 *

 * Description:

 *   The write command used here is 0x84--indicating that the cache is
@@ -439,7 +439,7 @@ static int spinand_program_data_to_cache(struct spi_device *spi_nand, 
}



/**

 * spinand_program_execute--to write a page from cache to the Nand array with

 * spinand_program_execute - write a page from cache to the Nand array

 * @page_id: the physical page location to write the page.

 *

 * Description:
@@ -462,11 +462,11 @@ static int spinand_program_execute(struct spi_device *spi_nand, u16 page_id) 
}



/**

 * spinand_program_page--to write a page with:

 * spinand_program_page - write a page

 * @page_id: the physical page location to write the page.

 * @offset:  the location from the cache starting from 0 to 2111

 * @len:     the number of bytes to write

 * @wbuf:    the buffer to hold the number of bytes

 * @buf:     the buffer holding @len bytes

 *

 * Description:

 *   The commands used here are 0x06, 0x84, and 0x10--indicating that
@@ -550,7 +550,7 @@ static int spinand_program_page(struct spi_device *spi_nand, 
}



/**

 * spinand_erase_block_erase--to erase a page with:

 * spinand_erase_block_erase - erase a page

 * @block_id: the physical block location to erase.

 *

 * Description:
@@ -573,7 +573,7 @@ static int spinand_erase_block_erase(struct spi_device *spi_nand, u16 block_id) 
}



/**

 * spinand_erase_block--to erase a page with:

 * spinand_erase_block - erase a page

 * @block_id: the physical block location to erase.

 *

 * Description:
@@ -840,12 +840,12 @@ static int spinand_lock_block(struct spi_device *spi_nand, u8 lock) 
	return ret;

}



/*

/**

 * spinand_probe - [spinand Interface]

 * @spi_nand: registered device driver.

 *

 * Description:

 *   To set up the device driver parameters to make the device available.

 *   Set up the device driver parameters to make the device available.

 */

static int spinand_probe(struct spi_device *spi_nand)

{
@@ -919,12 +919,12 @@ static int spinand_probe(struct spi_device *spi_nand) 
	return mtd_device_register(mtd, NULL, 0);

}



/*

 * spinand_remove: Remove the device driver

/**

 * spinand_remove - remove the device driver

 * @spi: the spi device.

 *

 * Description:

 *   To remove the device driver parameters and free up allocated memories.

 *   Remove the device driver parameters and free up allocated memories.

 */

static int spinand_remove(struct spi_device *spi)

{