xref: /freebsd/usr.sbin/fdformat/fdformat.c (revision 5521ff5a4d1929056e7ffc982fac3341ca54df7c)
1 /*
2  * Copyright (C) 1992-1994,2001 by Joerg Wunsch, Dresden
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS OR
15  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
16  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
17  * DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT,
18  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
19  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
20  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
22  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
23  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
24  * POSSIBILITY OF SUCH DAMAGE.
25  *
26  * $FreeBSD$
27  */
28 
29 /*
30  * FreeBSD:
31  * format a floppy disk
32  *
33  * Added FD_GTYPE ioctl, verifying, proportional indicators.
34  * Serge Vakulenko, vak@zebub.msk.su
35  * Sat Dec 18 17:45:47 MSK 1993
36  *
37  * Final adaptation, change format/verify logic, add separate
38  * format gap/interleave values
39  * Andrew A. Chernov, ache@astral.msk.su
40  * Thu Jan 27 00:47:24 MSK 1994
41  */
42 
43 #include <ctype.h>
44 #include <err.h>
45 #include <errno.h>
46 #include <fcntl.h>
47 #include <paths.h>
48 #include <stdio.h>
49 #include <stdlib.h>
50 #include <strings.h>
51 #include <unistd.h>
52 
53 #include <sys/fdcio.h>
54 
55 #include "fdutil.h"
56 
57 static void
58 format_track(int fd, int cyl, int secs, int head, int rate,
59 	     int gaplen, int secsize, int fill,int interleave)
60 {
61 	struct fd_formb f;
62 	register int i,j;
63 	int il[FD_MAX_NSEC + 1];
64 
65 	memset(il,0,sizeof il);
66 	for(j = 0, i = 1; i <= secs; i++) {
67 	    while(il[(j%secs)+1]) j++;
68 	    il[(j%secs)+1] = i;
69 	    j += interleave;
70 	}
71 
72 	f.format_version = FD_FORMAT_VERSION;
73 	f.head = head;
74 	f.cyl = cyl;
75 	f.transfer_rate = rate;
76 
77 	f.fd_formb_secshift = secsize;
78 	f.fd_formb_nsecs = secs;
79 	f.fd_formb_gaplen = gaplen;
80 	f.fd_formb_fillbyte = fill;
81 	for(i = 0; i < secs; i++) {
82 		f.fd_formb_cylno(i) = cyl;
83 		f.fd_formb_headno(i) = head;
84 		f.fd_formb_secno(i) = il[i+1];
85 		f.fd_formb_secsize(i) = secsize;
86 	}
87 	if(ioctl(fd, FD_FORM, (caddr_t)&f) < 0)
88 		err(1, "ioctl(FD_FORM)");
89 }
90 
91 static int
92 verify_track(int fd, int track, int tracksize)
93 {
94 	static char *buf = 0;
95 	static int bufsz = 0;
96 	int fdopts = -1, ofdopts, rv = 0;
97 
98 	if (ioctl(fd, FD_GOPTS, &fdopts) < 0)
99 		warn("warning: ioctl(FD_GOPTS)");
100 	else {
101 		ofdopts = fdopts;
102 		fdopts |= FDOPT_NORETRY;
103 		(void)ioctl(fd, FD_SOPTS, &fdopts);
104 	}
105 
106 	if (bufsz < tracksize) {
107 		if (buf)
108 			free (buf);
109 		bufsz = tracksize;
110 		buf = 0;
111 	}
112 	if (! buf)
113 		buf = malloc (bufsz);
114 	if (! buf)
115 		errx(2, "out of memory");
116 	if (lseek (fd, (long) track*tracksize, 0) < 0)
117 		rv = -1;
118 	/* try twice reading it, without using the normal retrier */
119 	else if (read (fd, buf, tracksize) != tracksize
120 		 && read (fd, buf, tracksize) != tracksize)
121 		rv = -1;
122 	if(fdopts != -1)
123 		(void)ioctl(fd, FD_SOPTS, &ofdopts);
124 	return (rv);
125 }
126 
127 static const char *
128 makename(const char *arg, const char *suffix)
129 {
130 	static char namebuff[20];	/* big enough for "/dev/fd0a"... */
131 
132 	memset(namebuff, 0, 20);
133 	if(*arg == '\0') /* ??? */
134 		return arg;
135 	if(*arg == '/')  /* do not convert absolute pathnames */
136 		return arg;
137 	strcpy(namebuff, _PATH_DEV);
138 	strncat(namebuff, arg, 3);
139 	strcat(namebuff, suffix);
140 	return namebuff;
141 }
142 
143 static void
144 usage (void)
145 {
146 	fprintf(stderr, "%s\n%s\n",
147 	"usage: fdformat [-y] [-q] [-n | -v] [-f #] [-c #] [-s #] [-h #]",
148 	"                [-r #] [-g #] [-i #] [-S #] [-F #] [-t #] device_name");
149 	exit(2);
150 }
151 
152 static int
153 yes (void)
154 {
155 	char reply [256], *p;
156 
157 	reply[sizeof(reply)-1] = 0;
158 	for (;;) {
159 		fflush(stdout);
160 		if (! fgets (reply, sizeof(reply)-1, stdin))
161 			return (0);
162 		for (p=reply; *p==' ' || *p=='\t'; ++p)
163 			continue;
164 		if (*p=='y' || *p=='Y')
165 			return (1);
166 		if (*p=='n' || *p=='N' || *p=='\n' || *p=='\r')
167 			return (0);
168 		printf("Answer `yes' or `no': ");
169 	}
170 }
171 
172 int
173 main(int argc, char **argv)
174 {
175 	int format = -1, cyls = -1, secs = -1, heads = -1, intleave = -1;
176 	int rate = -1, gaplen = -1, secsize = -1, steps = -1;
177 	int fill = 0xf6, quiet = 0, verify = 1, verify_only = 0, confirm = 0;
178 	int fd, c, i, track, error, tracks_per_dot, bytes_per_track, errs;
179 	int fdopts;
180 	const char *device, *suffix;
181 	struct fd_type fdt;
182 #define MAXPRINTERRS 10
183 	struct fdc_status fdcs[MAXPRINTERRS];
184 
185 	while((c = getopt(argc, argv, "f:c:s:h:r:g:S:F:t:i:qyvn")) != -1)
186 		switch(c) {
187 		case 'f':	/* format in kilobytes */
188 			format = atoi(optarg);
189 			break;
190 
191 		case 'c':	/* # of cyls */
192 			cyls = atoi(optarg);
193 			break;
194 
195 		case 's':	/* # of secs per track */
196 			secs = atoi(optarg);
197 			break;
198 
199 		case 'h':	/* # of heads */
200 			heads = atoi(optarg);
201 			break;
202 
203 		case 'r':	/* transfer rate, kilobyte/sec */
204 			rate = atoi(optarg);
205 			break;
206 
207 		case 'g':	/* length of GAP3 to format with */
208 			gaplen = atoi(optarg);
209 			break;
210 
211 		case 'S':	/* sector size shift factor (1 << S)*128 */
212 			secsize = atoi(optarg);
213 			break;
214 
215 		case 'F':	/* fill byte, C-like notation allowed */
216 			fill = (int)strtol(optarg, (char **)0, 0);
217 			break;
218 
219 		case 't':	/* steps per track */
220 			steps = atoi(optarg);
221 			break;
222 
223 		case 'i':       /* interleave factor */
224 			intleave = atoi(optarg);
225 			break;
226 
227 		case 'q':
228 			quiet = 1;
229 			break;
230 
231 		case 'y':
232 			confirm = 1;
233 			break;
234 
235 		case 'n':
236 			verify = 0;
237 			break;
238 
239 		case 'v':
240 			verify = 1;
241 			verify_only = 1;
242 			break;
243 
244 		case '?': default:
245 			usage();
246 		}
247 
248 	if(optind != argc - 1)
249 		usage();
250 
251 	switch(format) {
252 	default:
253 		errx(2, "bad floppy size: %dK", format);
254 	case -1:   suffix = "";      break;
255 	case 360:  suffix = ".360";  break;
256 	case 640:  suffix = ".640";  break;
257 	case 720:  suffix = ".720";  break;
258 	case 800:  suffix = ".800";  break;
259 	case 820:  suffix = ".820";  break;
260 	case 1200: suffix = ".1200"; break;
261 	case 1232: suffix = ".1232"; break;
262 	case 1440: suffix = ".1440"; break;
263 	case 1480: suffix = ".1480"; break;
264 	case 1720: suffix = ".1720"; break;
265 	}
266 
267 	device = makename(argv[optind], suffix);
268 
269 	if((fd = open(device, O_RDWR)) < 0)
270 		err(1, "%s", device);
271 
272 	if(ioctl(fd, FD_GTYPE, &fdt) < 0)
273 		errx(1, "not a floppy disk: %s", device);
274 	fdopts = FDOPT_NOERRLOG;
275 	if (ioctl(fd, FD_SOPTS, &fdopts) == -1)
276 		err(1, "ioctl(FD_SOPTS, FDOPT_NOERRLOG)");
277 
278 	switch(rate) {
279 	case -1:  break;
280 	case 250: fdt.trans = FDC_250KBPS; break;
281 	case 300: fdt.trans = FDC_300KBPS; break;
282 	case 500: fdt.trans = FDC_500KBPS; break;
283 	default:
284 		errx(2, "invalid transfer rate: %d", rate);
285 	}
286 
287 	if (cyls >= 0)    fdt.tracks = cyls;
288 	if (secs >= 0)    fdt.sectrac = secs;
289 	if (fdt.sectrac > FD_MAX_NSEC)
290 		errx(2, "too many sectors per track, max value is %d", FD_MAX_NSEC);
291 	if (heads >= 0)   fdt.heads = heads;
292 	if (gaplen >= 0)  fdt.f_gap = gaplen;
293 	if (secsize >= 0) fdt.secsize = secsize;
294 	if (steps >= 0)   fdt.steptrac = steps;
295 	if (intleave >= 0) fdt.f_inter = intleave;
296 
297 	bytes_per_track = fdt.sectrac * (1<<fdt.secsize) * 128;
298 
299 	/* XXX  20/40 = 0.5 */
300 	tracks_per_dot = (fdt.tracks * fdt.heads + 20) / 40;
301 
302 	if (verify_only) {
303 		if(!quiet)
304 			printf("Verify %dK floppy `%s'.\n",
305 				fdt.tracks * fdt.heads * bytes_per_track / 1024,
306 				device);
307 	}
308 	else if(!quiet && !confirm) {
309 		printf("Format %dK floppy `%s'? (y/n): ",
310 			fdt.tracks * fdt.heads * bytes_per_track / 1024,
311 			device);
312 		if(! yes ()) {
313 			printf("Not confirmed.\n");
314 			return 3;
315 		}
316 	}
317 
318 	/*
319 	 * Formatting.
320 	 */
321 	if(!quiet) {
322 		printf("Processing ");
323 		for (i = 0; i < (fdt.tracks * fdt.heads) / tracks_per_dot; i++)
324 			putchar('-');
325 		printf("\rProcessing ");
326 		fflush(stdout);
327 	}
328 
329 	error = errs = 0;
330 
331 	for (track = 0; track < fdt.tracks * fdt.heads; track++) {
332 		if (!verify_only) {
333 			format_track(fd, track / fdt.heads, fdt.sectrac,
334 				track % fdt.heads, fdt.trans, fdt.f_gap,
335 				fdt.secsize, fill, fdt.f_inter);
336 			if(!quiet && !((track + 1) % tracks_per_dot)) {
337 				putchar('F');
338 				fflush(stdout);
339 			}
340 		}
341 		if (verify) {
342 			if (verify_track(fd, track, bytes_per_track) < 0) {
343 				error = 1;
344 				if (errs < MAXPRINTERRS && errno == EIO) {
345 					if (ioctl(fd, FD_GSTAT, fdcs + errs) ==
346 					    -1)
347 						errx(1,
348 					"floppy IO error, but no FDC status");
349 					errs++;
350 				}
351 			}
352 			if(!quiet && !((track + 1) % tracks_per_dot)) {
353 				if (!verify_only)
354 					putchar('\b');
355 				if (error) {
356 					putchar('E');
357 					error = 0;
358 				}
359 				else
360 					putchar('V');
361 				fflush(stdout);
362 			}
363 		}
364 	}
365 	if(!quiet)
366 		printf(" done.\n");
367 
368 	if (!quiet && errs) {
369 		fflush(stdout);
370 		fprintf(stderr, "Errors encountered:\nCyl Head Sect   Error\n");
371 		for (i = 0; i < errs && i < MAXPRINTERRS; i++) {
372 			fprintf(stderr, " %2d   %2d   %2d   ",
373 				fdcs[i].status[3], fdcs[i].status[4],
374 				fdcs[i].status[5]);
375 			printstatus(fdcs + i, 1);
376 			putc('\n', stderr);
377 		}
378 		if (errs >= MAXPRINTERRS)
379 			fprintf(stderr, "(Further errors not printed.)\n");
380 	}
381 
382 	return errs != 0;
383 }
384