Commit 8b6e50c9 authored by Brian Norris's avatar Brian Norris Committed by Artem Bityutskiy
Browse files

mtd: nand: multi-line comment style fixups 



Artem: while on it, do other commentaries clean-ups:
1. Start one-line comments with capital letter and no dot at the end
2. Turn sparse multi-line comments into one-line comments
3. Change "phrase ?" to "phrase?" and the same with "!".
4. Remove tabs from the kerneldoc parameters comments - they are mixed
   with tabs often, and inconsistent.
5. Put dot at the end of descriptions in kerneldoc comments.
6. Some other small commentaries clean-ups

Signed-off-by: default avatarBrian Norris <computersforpeace@gmail.com>
Signed-off-by: default avatarArtem Bityutskiy <Artem.Bityutskiy@nokia.com>
parent 18f8eb1b

drivers/mtd/nand/nand_base.c

+346 −357

File changed.

Preview size limit exceeded, changes collapsed.

drivers/mtd/nand/nand_bbt.c

+175 −190
Original line number Diff line number Diff line
@@ -85,11 +85,9 @@ static int check_pattern_no_oob(uint8_t *buf, struct nand_bbt_descr *td) 
 * @paglen: the pagelength

 * @td: search pattern descriptor

 *

 * Check for a pattern at the given place. Used to search bad block

 * tables and good / bad block identifiers.

 * If the SCAN_EMPTY option is set then check, if all bytes except the

 * pattern area contain 0xff

 *

 * Check for a pattern at the given place. Used to search bad block tables and

 * good / bad block identifiers. If the SCAN_EMPTY option is set then check, if

 * all bytes except the pattern area contain 0xff.

 */

static int check_pattern(uint8_t *buf, int len, int paglen, struct nand_bbt_descr *td)

{
@@ -130,10 +128,9 @@ static int check_pattern(uint8_t *buf, int len, int paglen, struct nand_bbt_desc 
 * @buf: the buffer to search

 * @td:	search pattern descriptor

 *

 * Check for a pattern at the given place. Used to search bad block

 * tables and good / bad block identifiers. Same as check_pattern, but

 * no optional empty check

 *

 * Check for a pattern at the given place. Used to search bad block tables and

 * good / bad block identifiers. Same as check_pattern, but no optional empty

 * check.

 */

static int check_short_pattern(uint8_t *buf, struct nand_bbt_descr *td)

{
@@ -177,7 +174,6 @@ static u32 add_marker_len(struct nand_bbt_descr *td) 
 * @offs: offset in the memory table

 *

 * Read the bad block table starting from page.

 *

 */

static int read_bbt(struct mtd_info *mtd, uint8_t *buf, int page, int num,

		struct nand_bbt_descr *td, int offs)
@@ -229,8 +225,10 @@ static int read_bbt(struct mtd_info *mtd, uint8_t *buf, int page, int num, 
					mtd->ecc_stats.bbtblocks++;

					continue;

				}

				/* Leave it for now, if its matured we can move this

				 * message to MTD_DEBUG_LEVEL0 */

				/*

				 * Leave it for now, if it's matured we can

				 * move this message to MTD_DEBUG_LEVEL0.

				 */

				printk(KERN_DEBUG "nand_read_bbt: Bad block at 0x%012llx\n",

				       (loff_t)((offs << 2) + (act >> 1)) << this->bbt_erase_shift);

				/* Factory marked bad or worn out? */
@@ -252,11 +250,11 @@ static int read_bbt(struct mtd_info *mtd, uint8_t *buf, int page, int num, 
 * @mtd: MTD device structure

 * @buf: temporary buffer

 * @td: descriptor for the bad block table

 * @chip:	read the table for a specific chip, -1 read all chips.

 *		Applies only if NAND_BBT_PERCHIP option is set

 * @chip: read the table for a specific chip, -1 read all chips; aplies only if

 *        NAND_BBT_PERCHIP option is set

 *

 * Read the bad block table for all chips starting at a given page

 * We assume that the bbt bits are in consecutive order.

 * Read the bad block table for all chips starting at a given page. We assume

 * that the bbt bits are in consecutive order.

 */

static int read_abs_bbt(struct mtd_info *mtd, uint8_t *buf, struct nand_bbt_descr *td, int chip)

{
@@ -283,9 +281,7 @@ static int read_abs_bbt(struct mtd_info *mtd, uint8_t *buf, struct nand_bbt_desc 
	return 0;

}



/*

 * BBT marker is in the first page, no OOB.

 */

/* BBT marker is in the first page, no OOB */

static int scan_read_raw_data(struct mtd_info *mtd, uint8_t *buf, loff_t offs,

			 struct nand_bbt_descr *td)

{
@@ -299,9 +295,7 @@ static int scan_read_raw_data(struct mtd_info *mtd, uint8_t *buf, loff_t offs, 
	return mtd->read(mtd, offs, len, &retlen, buf);

}



/*

 * Scan read raw data from flash

 */

/* Scan read raw data from flash */

static int scan_read_raw_oob(struct mtd_info *mtd, uint8_t *buf, loff_t offs,

			 size_t len)

{
@@ -344,9 +338,7 @@ static int scan_read_raw(struct mtd_info *mtd, uint8_t *buf, loff_t offs, 
		return scan_read_raw_oob(mtd, buf, offs, len);

}



/*

 * Scan write data with oob to flash

 */

/* Scan write data with oob to flash */

static int scan_write_bbt(struct mtd_info *mtd, loff_t offs, size_t len,

			  uint8_t *buf, uint8_t *oob)

{
@@ -378,9 +370,8 @@ static u32 bbt_get_ver_offs(struct mtd_info *mtd, struct nand_bbt_descr *td) 
 * @td: descriptor for the bad block table

 * @md:	descriptor for the bad block table mirror

 *

 * Read the bad block table(s) for all chips starting at a given page

 * We assume that the bbt bits are in consecutive order.

 *

 * Read the bad block table(s) for all chips starting at a given page. We

 * assume that the bbt bits are in consecutive order.

 */

static int read_abs_bbts(struct mtd_info *mtd, uint8_t *buf,

			 struct nand_bbt_descr *td, struct nand_bbt_descr *md)
@@ -407,9 +398,7 @@ static int read_abs_bbts(struct mtd_info *mtd, uint8_t *buf, 
	return 1;

}



/*

 * Scan a given block full

 */

/* Scan a given block full */

static int scan_block_full(struct mtd_info *mtd, struct nand_bbt_descr *bd,

			   loff_t offs, uint8_t *buf, size_t readlen,

			   int scanlen, int len)
@@ -427,9 +416,7 @@ static int scan_block_full(struct mtd_info *mtd, struct nand_bbt_descr *bd, 
	return 0;

}



/*

 * Scan a given block partially

 */

/* Scan a given block partially */

static int scan_block_fast(struct mtd_info *mtd, struct nand_bbt_descr *bd,

			   loff_t offs, uint8_t *buf, int len)

{
@@ -444,9 +431,8 @@ static int scan_block_fast(struct mtd_info *mtd, struct nand_bbt_descr *bd, 


	for (j = 0; j < len; j++) {

		/*

		 * Read the full oob until read_oob is fixed to

		 * handle single byte reads for 16 bit

		 * buswidth

		 * Read the full oob until read_oob is fixed to handle single

		 * byte reads for 16 bit buswidth.

		 */

		ret = mtd->read_oob(mtd, offs, &ops);

		if (ret)
@@ -465,11 +451,11 @@ static int scan_block_fast(struct mtd_info *mtd, struct nand_bbt_descr *bd, 
 * @mtd: MTD device structure

 * @buf: temporary buffer

 * @bd: descriptor for the good/bad block search pattern

 * @chip:	create the table for a specific chip, -1 read all chips.

 *		Applies only if NAND_BBT_PERCHIP option is set

 * @chip: create the table for a specific chip, -1 read all chips; applies only

 *        if NAND_BBT_PERCHIP option is set

 *

 * Create a bad block table by scanning the device

 * for the given good/bad block identify pattern

 * Create a bad block table by scanning the device for the given good/bad block

 * identify pattern.

 */

static int create_bbt(struct mtd_info *mtd, uint8_t *buf,

	struct nand_bbt_descr *bd, int chip)
@@ -500,8 +486,10 @@ static int create_bbt(struct mtd_info *mtd, uint8_t *buf, 
	}



	if (chip == -1) {

		/* Note that numblocks is 2 * (real numblocks) here, see i+=2

		 * below as it makes shifting and masking less painful */

		/*

		 * Note that numblocks is 2 * (real numblocks) here, see i+=2

		 * below as it makes shifting and masking less painful

		 */

		numblocks = mtd->size >> (this->bbt_erase_shift - 1);

		startblock = 0;

		from = 0;
@@ -553,16 +541,14 @@ static int create_bbt(struct mtd_info *mtd, uint8_t *buf, 
 * @buf: temporary buffer

 * @td: descriptor for the bad block table

 *

 * Read the bad block table by searching for a given ident pattern.

 * Search is preformed either from the beginning up or from the end of

 * the device downwards. The search starts always at the start of a

 * block.

 * If the option NAND_BBT_PERCHIP is given, each chip is searched

 * for a bbt, which contains the bad block information of this chip.

 * This is necessary to provide support for certain DOC devices.

 * Read the bad block table by searching for a given ident pattern. Search is

 * preformed either from the beginning up or from the end of the device

 * downwards. The search starts always at the start of a block. If the option

 * NAND_BBT_PERCHIP is given, each chip is searched for a bbt, which contains

 * the bad block information of this chip. This is necessary to provide support

 * for certain DOC devices.

 *

 * The bbt ident pattern resides in the oob area of the first page

 * in a block.

 * The bbt ident pattern resides in the oob area of the first page in a block.

 */

static int search_bbt(struct mtd_info *mtd, uint8_t *buf, struct nand_bbt_descr *td)

{
@@ -636,7 +622,7 @@ static int search_bbt(struct mtd_info *mtd, uint8_t *buf, struct nand_bbt_descr 
 * @td: descriptor for the bad block table

 * @md: descriptor for the bad block table mirror

 *

 * Search and read the bad block table(s)

 * Search and read the bad block table(s).

 */

static int search_read_bbts(struct mtd_info *mtd, uint8_t * buf, struct nand_bbt_descr *td, struct nand_bbt_descr *md)

{
@@ -653,15 +639,13 @@ static int search_read_bbts(struct mtd_info *mtd, uint8_t * buf, struct nand_bbt 


/**

 * write_bbt - [GENERIC] (Re)write the bad block table

 *

 * @mtd: MTD device structure

 * @buf: temporary buffer

 * @td: descriptor for the bad block table

 * @md: descriptor for the bad block table mirror

 * @chipsel: selector for a specific chip, -1 for all

 *

 * (Re)write the bad block table

 *

 * (Re)write the bad block table.

 */

static int write_bbt(struct mtd_info *mtd, uint8_t *buf,

		     struct nand_bbt_descr *td, struct nand_bbt_descr *md,
@@ -702,8 +686,8 @@ static int write_bbt(struct mtd_info *mtd, uint8_t *buf, 


	/* Loop through the chips */

	for (; chip < nrchips; chip++) {



		/* There was already a version of the table, reuse the page

		/*

		 * There was already a version of the table, reuse the page

		 * This applies for absolute placement too, as we have the

		 * page nr. in td->pages.

		 */
@@ -712,8 +696,10 @@ static int write_bbt(struct mtd_info *mtd, uint8_t *buf, 
			goto write;

		}



		/* Automatic placement of the bad block table */

		/* Search direction top -> down ? */

		/*

		 * Automatic placement of the bad block table. Search direction

		 * top -> down?

		 */

		if (td->options & NAND_BBT_LASTBLOCK) {

			startblock = numblocks * (chip + 1) - 1;

			dir = -1;
@@ -798,7 +784,7 @@ static int write_bbt(struct mtd_info *mtd, uint8_t *buf, 
		} else if (td->options & NAND_BBT_NO_OOB) {

			ooboffs = 0;

			offs = td->len;

			/* the version byte */

			/* The version byte */

			if (td->options & NAND_BBT_VERSION)

				offs++;

			/* Calc length */
@@ -827,7 +813,7 @@ static int write_bbt(struct mtd_info *mtd, uint8_t *buf, 
		if (td->options & NAND_BBT_VERSION)

			buf[ooboffs + td->veroffs] = td->version[chip];



		/* walk through the memory table */

		/* Walk through the memory table */

		for (i = 0; i < numblocks;) {

			uint8_t dat;

			dat = this->bbt[bbtoffs + (i >> 2)];
@@ -873,8 +859,8 @@ static int write_bbt(struct mtd_info *mtd, uint8_t *buf, 
 * @mtd: MTD device structure

 * @bd: descriptor for the good/bad block search pattern

 *

 * The function creates a memory based bbt by scanning the device

 * for manufacturer / software marked good / bad blocks

 * The function creates a memory based bbt by scanning the device for

 * manufacturer / software marked good / bad blocks.

 */

static inline int nand_memory_bbt(struct mtd_info *mtd, struct nand_bbt_descr *bd)

{
@@ -890,11 +876,10 @@ static inline int nand_memory_bbt(struct mtd_info *mtd, struct nand_bbt_descr *b 
 * @buf: temporary buffer

 * @bd: descriptor for the good/bad block search pattern

 *

 * The function checks the results of the previous call to read_bbt

 * and creates / updates the bbt(s) if necessary

 * Creation is necessary if no bbt was found for the chip/device

 * Update is necessary if one of the tables is missing or the

 * version nr. of one table is less than the other

 * The function checks the results of the previous call to read_bbt and creates

 * / updates the bbt(s) if necessary. Creation is necessary if no bbt was found

 * for the chip/device. Update is necessary if one of the tables is missing or

 * the version nr. of one table is less than the other.

 */

static int check_create(struct mtd_info *mtd, uint8_t *buf, struct nand_bbt_descr *bd)

{
@@ -977,10 +962,10 @@ static int check_create(struct mtd_info *mtd, uint8_t *buf, struct nand_bbt_desc 
		if (md)

			md->version[i] = 1;

	writecheck:

		/* read back first ? */

		/* Read back first? */

		if (rd)

			read_abs_bbt(mtd, buf, rd, chipsel);

		/* If they weren't versioned, read both. */

		/* If they weren't versioned, read both */

		if (rd2)

			read_abs_bbt(mtd, buf, rd2, chipsel);
@@ -1006,9 +991,8 @@ static int check_create(struct mtd_info *mtd, uint8_t *buf, struct nand_bbt_desc 
 * @mtd: MTD device structure

 * @td: bad block table descriptor

 *

 * The bad block table regions are marked as "bad" to prevent

 * accidental erasures / writes. The regions are identified by

 * the mark 0x02.

 * The bad block table regions are marked as "bad" to prevent accidental

 * erasures / writes. The regions are identified by the mark 0x02.

 */

static void mark_bbt_region(struct mtd_info *mtd, struct nand_bbt_descr *td)

{
@@ -1053,9 +1037,11 @@ static void mark_bbt_region(struct mtd_info *mtd, struct nand_bbt_descr *td) 
				update = 1;

			block += 2;

		}

		/* If we want reserved blocks to be recorded to flash, and some

		   new ones have been marked, then we need to update the stored

		   bbts.  This should only happen once. */

		/*

		 * If we want reserved blocks to be recorded to flash, and some

		 * new ones have been marked, then we need to update the stored

		 * bbts.  This should only happen once.

		 */

		if (update && td->reserved_block_code)

			nand_update_bbt(mtd, (loff_t)(block - 2) << (this->bbt_erase_shift - 1));

	}
@@ -1114,14 +1100,12 @@ static void verify_bbt_descr(struct mtd_info *mtd, struct nand_bbt_descr *bd) 
 * @mtd: MTD device structure

 * @bd: descriptor for the good/bad block search pattern

 *

 * The function checks, if a bad block table(s) is/are already

 * available. If not it scans the device for manufacturer

 * marked good / bad blocks and writes the bad block table(s) to

 * the selected place.

 *

 * The bad block table memory is allocated here. It must be freed

 * by calling the nand_free_bbt function.

 * The function checks, if a bad block table(s) is/are already available. If

 * not it scans the device for manufacturer marked good / bad blocks and writes

 * the bad block table(s) to the selected place.

 *

 * The bad block table memory is allocated here. It must be freed by calling

 * the nand_free_bbt function.

 */

int nand_scan_bbt(struct mtd_info *mtd, struct nand_bbt_descr *bd)

{
@@ -1132,15 +1116,19 @@ int nand_scan_bbt(struct mtd_info *mtd, struct nand_bbt_descr *bd) 
	struct nand_bbt_descr *md = this->bbt_md;



	len = mtd->size >> (this->bbt_erase_shift + 2);

	/* Allocate memory (2bit per block) and clear the memory bad block table */

	/*

	 * Allocate memory (2bit per block) and clear the memory bad block

	 * table.

	 */

	this->bbt = kzalloc(len, GFP_KERNEL);

	if (!this->bbt) {

		printk(KERN_ERR "nand_scan_bbt: Out of memory\n");

		return -ENOMEM;

	}



	/* If no primary table decriptor is given, scan the device

	 * to build a memory based bad block table

	/*

	 * If no primary table decriptor is given, scan the device to build a

	 * memory based bad block table.

	 */

	if (!td) {

		if ((res = nand_memory_bbt(mtd, bd))) {
@@ -1189,7 +1177,7 @@ int nand_scan_bbt(struct mtd_info *mtd, struct nand_bbt_descr *bd) 
 * @mtd: MTD device structure

 * @offs: the offset of the newly marked block

 *

 * The function updates the bad block table(s)

 * The function updates the bad block table(s).

 */

int nand_update_bbt(struct mtd_info *mtd, loff_t offs)

{
@@ -1243,8 +1231,10 @@ int nand_update_bbt(struct mtd_info *mtd, loff_t offs) 
	return res;

}



/* Define some generic bad / good block scan pattern which are used

 * while scanning a device for factory marked good / bad blocks. */

/*

 * Define some generic bad / good block scan pattern which are used

 * while scanning a device for factory marked good / bad blocks.

 */

static uint8_t scan_ff_pattern[] = { 0xff, 0xff };



static uint8_t scan_agand_pattern[] = { 0x1C, 0x71, 0xC7, 0x1C, 0x71, 0xC7 };
@@ -1256,8 +1246,7 @@ static struct nand_bbt_descr agand_flashbased = { 
	.pattern = scan_agand_pattern

};



/* Generic flash bbt decriptors

*/

/* Generic flash bbt decriptors */

static uint8_t bbt_pattern[] = {'B', 'b', 't', '0' };

static uint8_t mirror_pattern[] = {'1', 't', 'b', 'B' };
@@ -1309,7 +1298,6 @@ static struct nand_bbt_descr bbt_mirror_no_bbt_descr = { 
 * based on the properties of "this". The new descriptor is stored in

 * this->badblock_pattern. Thus, this->badblock_pattern should be NULL when

 * passed to this function.

 *

 */

static int nand_create_default_bbt_descr(struct nand_chip *this)

{
@@ -1336,20 +1324,18 @@ static int nand_create_default_bbt_descr(struct nand_chip *this) 
 * nand_default_bbt - [NAND Interface] Select a default bad block table for the device

 * @mtd: MTD device structure

 *

 * This function selects the default bad block table

 * support for the device and calls the nand_scan_bbt function

 *

 * This function selects the default bad block table support for the device and

 * calls the nand_scan_bbt function.

 */

int nand_default_bbt(struct mtd_info *mtd)

{

	struct nand_chip *this = mtd->priv;



	/* Default for AG-AND. We must use a flash based

	 * bad block table as the devices have factory marked

	 * _good_ blocks. Erasing those blocks leads to loss

	 * of the good / bad information, so we _must_ store

	 * this information in a good / bad table during

	 * startup

	/*

	 * Default for AG-AND. We must use a flash based bad block table as the

	 * devices have factory marked _good_ blocks. Erasing those blocks

	 * leads to loss of the good / bad information, so we _must_ store this

	 * information in a good / bad table during startup.

	 */

	if (this->options & NAND_IS_AND) {

		/* Use the default pattern descriptors */
@@ -1389,7 +1375,6 @@ int nand_default_bbt(struct mtd_info *mtd) 
 * @mtd: MTD device structure

 * @offs: offset in the device

 * @allowbbt: allow access to bad block table region

 *

 */

int nand_isbad_bbt(struct mtd_info *mtd, loff_t offs, int allowbbt)

{