Patches to nanddump.c

Patches to nanddump.c

[Tim Gardner]

[-- Attachment #1: Type: text/plain, Size: 359 bytes --]

I've added a couple of options to nanddump.c:

-no-oob allowa you to retrieve the contents of a NAND character partiion 
without the OOB info. 

-no-print satisfies the interactive pretty-print request. 

See attached patch file.
-- 
Tim Gardner - timg@tpi.com 406-443-5357
TriplePoint, Inc. - http://www.tpi.com
PGP: http://www.tpi.com/PGP/Tim.txt

[-- Attachment #2: mtd.diff.IceCube --]
[-- Type: text/x-diff, Size: 2858 bytes --]

diff -r -u --new-file mtd/util/nanddump.c mtd.new/util/nanddump.c
--- mtd/util/nanddump.c	2003-02-20 06:34:20.000000000 -0700
+++ mtd.new/util/nanddump.c	2003-10-02 12:11:27.000000000 -0600
@@ -41,17 +41,31 @@
 int main(int argc, char **argv)
 {
 	unsigned long ofs;
-	int i, fd, ofd, bs, start_addr, end_addr, pretty_print;
+	int i, fd, ofd, bs, start_addr, end_addr;
+	int pretty_print=(-1);
+	int no_oob=0;
 	struct mtd_oob_buf oob = {0, 16, oobbuf};
 	mtd_info_t meminfo;
 	unsigned char pretty_buf[80];
 
 	/* Make sure enough arguments were passed */ 
 	if (argc < 3) {
-		printf("usage: %s <mtdname> <dumpname> [start addr] [length]\n", argv[0]);
+		printf("usage: %s <mtdname> <dumpname> [start addr] [length] [-no-oob] [-no-print]\n", argv[0]);
 		exit(1);
 	}
 
+	for (i=1; i<argc; i++)
+	{
+		if (!strcmp(argv[i],"-no-oob"))
+		{
+			no_oob = 1;
+		}
+		if (!strcmp(argv[i],"-no-print"))
+		{
+			pretty_print = 0;
+		}
+	}
+
 	/* Open MTD device */
 	if ((fd = open(argv[1], O_RDONLY)) == -1) {
 		perror("open flash");
@@ -72,6 +86,7 @@
 		close(fd);
 		exit(1);
 	}
+	printf("NAND block size %u Oob block %u\n", meminfo.oobblock,meminfo.oobsize);
 
 	/* Open output file for writing */
 	if ((ofd = open(argv[2], O_WRONLY | O_TRUNC | O_CREAT, 0644)) == -1) {
@@ -86,20 +101,23 @@
 	bs = meminfo.oobblock;
 
 	/* See if start address and length were specified */
-	if (argc == 4) {
+	if (argc >= 4) {
 		start_addr = strtoul(argv[3], NULL, 0) & ~(bs - 1);
 		end_addr = meminfo.size;
-	} else if (argc == 5) {
+	} else if (argc >= 5) {
 		start_addr = strtoul(argv[3], NULL, 0) & ~(bs - 1);
 		end_addr = (strtoul(argv[3], NULL, 0) + strtoul(argv[4], NULL, 0)) & ~(bs - 1);
 	}
 
 	/* Ask user if they would like pretty output */
-	printf("Would you like formatted output? ");
-	if (tolower(getc(stdin)) != 'y')
-		pretty_print = 0;
-	else
-		pretty_print = 1;
+	if (pretty_print < 0)
+	{
+		printf("Would you like formatted output? ");
+		if (tolower(getc(stdin)) != 'y')
+			pretty_print = 0;
+		else
+			pretty_print = 1;
+	}
 
 	/* Print informative message */
 	printf("Dumping data starting at 0x%08x and ending at 0x%08x...\n",
@@ -138,7 +156,7 @@
 
 		/* Read OOB data and exit on failure */
 		oob.start = ofs;
-		printf("Dumping %lx\n", ofs);
+		if (pretty_print > 0) printf("Dumping %lx\n", ofs);
 		if (ioctl(fd, MEMREADOOB, &oob) != 0) {
 			perror("ioctl(MEMREADOOB)");
 			close(fd);
@@ -147,7 +165,7 @@
 		}
 
 		/* Write out OOB data */
-		if (pretty_print) {
+		if ((!no_oob) && pretty_print) {
 			if (meminfo.oobsize == 16) {
 				sprintf(pretty_buf, "  OOB Data: %02x %02x %02x %02x %02x %02x "
 					"%02x %02x %02x %02x %02x %02x %02x %02x %02x %02x\n",
@@ -166,7 +184,7 @@
 					oobbuf[6], oobbuf[7]);
 				write(ofd, pretty_buf, 48);
 			}
-		} else
+		} else if (!no_oob)
 			write(ofd, oobbuf, meminfo.oobsize);
 	}
 

Re: Patches to nanddump.c

[David Woodhouse]

On Thu, 2003-10-02 at 13:44 -0600, Tim Gardner wrote:
> I've added a couple of options to nanddump.c:
> 
> -no-oob allowa you to retrieve the contents of a NAND character partiion 
> without the OOB info. 
> 
> -no-print satisfies the interactive pretty-print request. 

Looks generally sane. Can you use getopt please. Example in mkfs.jffs2.c
-- 
dwmw2

Re: Patches to nanddump.c

[Tim Gardner]

Using getopt will break command line option backward compatibility, which is 
fine with me because it would clean up some parsing code. Any objections?

On Saturday 04 October 2003 11:19, David Woodhouse wrote:
>
> Looks generally sane. Can you use getopt please. Example in mkfs.jffs2.c

-- 
Tim Gardner - timg@tpi.com 406-443-5357
TriplePoint, Inc. - http://www.tpi.com
PGP: http://www.tpi.com/PGP/Tim.txt

Re: Patches to nanddump.c

[David Woodhouse]

On Mon, 2003-10-06 at 07:13 -0600, Tim Gardner wrote:
> Using getopt will break command line option backward compatibility, which is 
> fine with me because it would clean up some parsing code. Any objections?

Nope. It's mostly a debugging tool anyway.

-- 
dwmw2

Re: Patches to nanddump.c

[Tim Gardner]

[-- Attachment #1: Type: text/plain, Size: 1170 bytes --]

Since the patch is nearly as large as the file, I've just attached the file 
itself. The default options are sane in that it prints an ASCII dump of the 
specified partition to stdout. Usage output is:

[root@ppc /]$ nanddump -h
usage: nanddump
-p MTD_PARTITION  - MTD partition to dump from, e,g, /dev/mtd0
[-o DUMP_FILE]    - file to dump to, default is stdout
[-a ADDR]         - starting offset within the MTD partition, default 0
[-l LENGTH]       - Number of bytes to dump, default is size of partition
[-n]              - Omit OOB information in dump.
[-b]              - binary dump of data. Default is ASCII hex
[-v]              - verbose output.
[-h]              - Print this help message.

On Monday 06 October 2003 07:15, David Woodhouse wrote:
> On Mon, 2003-10-06 at 07:13 -0600, Tim Gardner wrote:
> > Using getopt will break command line option backward compatibility, which
> > is fine with me because it would clean up some parsing code. Any
> > objections?
>
> Nope. It's mostly a debugging tool anyway.

-- 
Tim Gardner - timg@tpi.com 406-443-5357
TriplePoint, Inc. - http://www.tpi.com
PGP: http://www.tpi.com/PGP/Tim.txt

[-- Attachment #2: nanddump.c --]
[-- Type: text/x-csrc, Size: 5859 bytes --]

/*
 *  nanddump.c
 *
 *  Copyright (C) 2000 David Woodhouse (dwmw2@infradead.org)
 *                     Steven J. Hill (sjhill@realitydiluted.com)
 *
 * $Id: nanddump.c,v 1.12 2003/02/20 13:34:20 sjhill Exp $
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 *
 *  Overview:
 *   This utility dumps the contents of raw NAND chips or NAND
 *   chips contained in DoC devices. NOTE: If you are using raw
 *   NAND chips, disable NAND ECC in your kernel.
 */

#define _GNU_SOURCE
#include <ctype.h>
#include <fcntl.h>
#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>
#include <sys/ioctl.h>
#include <sys/types.h>
#include <sys/stat.h>

#include <asm/types.h>
#include <linux/mtd/mtd.h>

/*
 * Buffers for reading data from flash
 */
unsigned char readbuf[512];
unsigned char oobbuf[16];

static void
usage(char *p)
{
	fprintf(stderr,"usage: %s \n"
		"-p MTD_PARTITION  - MTD partition to dump from, e,g, /dev/mtd0\n"
		"[-o DUMP_FILE]    - file to dump to, default is stdout\n"
		"[-a ADDR]         - starting offset within the MTD partition, default 0\n"
		"[-l LENGTH]       - Number of bytes to dump, default is size of partition\n"
		"[-n]              - Omit OOB information in dump.\n"
		"[-b]              - binary dump of data. Default is ASCII hex\n"
		"[-v]              - verbose output.\n" 
		"[-h]              - Print this help message.\n",
		p
	);
	exit(1);
}

/*
 * Main program
 */
int main(int argc, char **argv)
{
	unsigned long ofs;
	int c, i, fd, bs, end_addr;
	int ofd=STDOUT_FILENO;
	int start_addr=0;
	int pretty_print=1;
	int no_oob=0;
	struct mtd_oob_buf oob = {0, 16, oobbuf};
	mtd_info_t meminfo;
	unsigned char pretty_buf[80];
	char *mtd_partition=NULL;
	char *ofile=NULL;
	int length;
	int verbose=0;

	while ((c=getopt(argc,argv,"p:o:a:l:nbvh")) >= 0)
	{
		switch (c)
		{
		case 'p':
			mtd_partition = optarg;
			break;
		case 'o':
			ofile = optarg;
			break;
		case 'a':
			if (sscanf(optarg,"%d",&start_addr) != 1)
			{
				fprintf(stderr,"Could not scan starting offset [-a]\n");
				usage(argv[0]);
			}
			break;
		case 'l':
			if (sscanf(optarg,"%d",&length) != 1)
			{
				fprintf(stderr,"Could not scan length [-l] from '%s'\n",optarg);
				usage(argv[0]);
			}
			break;
		case 'n':
			no_oob = 1;
			break;
		case 'b':
			pretty_print = 0;
			break;
		case 'v':
			verbose = 1;
			break;
		case 'h':
			usage(argv[0]);
			break;
		default:
			fprintf(stderr,"Unknown option '%s'\n",argv[optind]);
			usage(argv[0]);
			break;
		}
	}

	if (mtd_partition == NULL)
	{
		fprintf(stderr,"No MTD partition [-p].\n");
		usage(argv[0]);
	}

	/* Open MTD device */
	if ((fd = open(mtd_partition, O_RDONLY)) == -1) {
		perror("open flash");
		exit (1);
	}

	/* Fill in MTD device capability structure */   
	if (ioctl(fd, MEMGETINFO, &meminfo) != 0) {
		perror("MEMGETINFO");
		close(fd);
		exit (1);
	}

	/* Make sure device page sizes are valid */
	if (!(meminfo.oobsize == 16 && meminfo.oobblock == 512) &&
	    !(meminfo.oobsize == 8 && meminfo.oobblock == 256)) {
		fprintf(stderr,"Unknown flash (not normal NAND)\n");
		close(fd);
		exit(1);
	}
	bs = meminfo.oobblock;

	if (verbose) fprintf(stderr,"NAND block size %u Oob block %u\n", meminfo.oobblock,meminfo.oobsize);

	/* Open output file for writing */
	if (ofile && ((ofd = open(ofile, O_WRONLY | O_TRUNC | O_CREAT, 0644)) < 0)) {
		perror ("open outfile");
		close(fd);
		exit(1);
	}

	/* Align start address and length */
	start_addr &= (~(bs - 1));
	length &= (~(bs - 1));

	/* Compute ending address. */
	end_addr = meminfo.size;
	if (length && ((length + start_addr) < end_addr))
	{
		end_addr = start_addr + length;
	}

	/* Print informative message */
	if (verbose)
		fprintf(stderr,"Dumping data starting at 0x%08x and ending at 0x%08x...\n",
			start_addr, end_addr);

	/* Dump the flash contents */
	for (ofs = start_addr; ofs < end_addr ; ofs+=bs) {

		/* Read page data and exit on failure */
		if (pread(fd, readbuf, bs, ofs) != bs) {
			perror("pread");
			close(fd);
			close(ofd);
			exit(1);
		}

		/* Write out page data */
		if (pretty_print) {
			for (i = 0; i < bs; i += 16) {
				sprintf(pretty_buf,
					"0x%08x: %02x %02x %02x %02x %02x %02x %02x "
					"%02x %02x %02x %02x %02x %02x %02x %02x %02x\n",
					(unsigned int) (ofs + i),  readbuf[i],
					readbuf[i+1], readbuf[i+2],
					readbuf[i+3], readbuf[i+4],
					readbuf[i+5], readbuf[i+6],
					readbuf[i+7], readbuf[i+8],
					readbuf[i+9], readbuf[i+10],
					readbuf[i+11], readbuf[i+12],
					readbuf[i+13], readbuf[i+14],
					readbuf[i+15]);
				write(ofd, pretty_buf, 60);
			}
		} else
			write(ofd, readbuf, bs);

		/* Read OOB data and exit on failure */
		oob.start = ofs;
		if (verbose) fprintf(stderr,"Dumping %lx\n", ofs);
		if (ioctl(fd, MEMREADOOB, &oob) != 0) {
			perror("ioctl(MEMREADOOB)");
			close(fd);
			close(ofd);
			exit(1);
		}

		/* Write out OOB data */
		if ((!no_oob) && pretty_print) {
			if (meminfo.oobsize == 16) {
				sprintf(pretty_buf, "  OOB Data: %02x %02x %02x %02x %02x %02x "
					"%02x %02x %02x %02x %02x %02x %02x %02x %02x %02x\n",
					oobbuf[0], oobbuf[1], oobbuf[2],
					oobbuf[3], oobbuf[4], oobbuf[5],
					oobbuf[6], oobbuf[7], oobbuf[8],
					oobbuf[9], oobbuf[10], oobbuf[11],
					oobbuf[12], oobbuf[13], oobbuf[14],
					oobbuf[15]);
				write(ofd, pretty_buf, 60);
			} else {
				sprintf(pretty_buf, "  OOB Data: %02x %02x %02x %02x %02x %02x "
					"%02x %02x\n",
					oobbuf[0], oobbuf[1], oobbuf[2],
					oobbuf[3], oobbuf[4], oobbuf[5],
					oobbuf[6], oobbuf[7]);
				write(ofd, pretty_buf, 48);
			}
		} else if (!no_oob)
			write(ofd, oobbuf, meminfo.oobsize);
	}

	/* Close the output file and MTD device */
	close(fd);
	close(ofd);

	/* Exit happy */
	return 0;
}