xref: /netbsd-src/usr.sbin/flashctl/flashctl.8 (revision 537c852bdea952876a1f7e64dab6a125a257a431)
1.\"	$NetBSD: flashctl.8,v 1.2 2011/02/27 23:28:12 wiz Exp $
2.\"
3.\" Copyright (c) 2011 Department of Software Engineering,
4.\"		       University of Szeged, Hungary
5.\" Copyright (c) 2011 Adam Hoka <ahoka@NetBSD.org>
6.\" All rights reserved.
7.\"
8.\" This code is derived from software contributed to The NetBSD Foundation
9.\" by the Department of Software Engineering, University of Szeged, Hungary
10.\"
11.\" Redistribution and use in source and binary forms, with or without
12.\" modification, are permitted provided that the following conditions
13.\" are met:
14.\" 1. Redistributions of source code must retain the above copyright
15.\"    notice, this list of conditions and the following disclaimer.
16.\" 2. Redistributions in binary form must reproduce the above copyright
17.\"    notice, this list of conditions and the following disclaimer in the
18.\"    documentation and/or other materials provided with the distribution.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
21.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
22.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
23.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
24.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
25.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
26.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
27.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
28.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.Dd February 27, 2011
33.Dt FLASHCTL 8
34.Os
35.Sh NAME
36.Nm flashctl
37.Nd a program to manipulate flash devices
38.Sh SYNOPSIS
39.Nm
40.Ar device
41.Ar command
42.Oo
43.Ar arg Oo ...
44.Oc
45.Oc
46.Sh DESCRIPTION
47.Nm
48could be used to invoke low level operations specific to flash devices.
49It is used by specifying a device to manipulate,
50the command to perform, and any arguments the command may require.
51.Sh DEVICE COMMANDS
52The following commands may be used on flash devices:
53.Bl -tag -width erase_offset_size
54.It Cm badblocks
55List the bad blocks on the device.
56.It Cm erase Ar offset Ar size
57Erase
58.Ar size
59amount of flash memory from
60.Ar offset .
61Size could be
62.Ar all ,
63which means the rest of the flash after
64.Ar offset
65will be erased.
66.It Cm identify
67Identify the specified device, displaying the device's vendor, product
68strings, and the device's capabilities.
69.It Cm markbad Ar offset
70Mark the block given by its
71.Ar offset
72as bad.
73.El
74.Sh SEE ALSO
75.Xr flash 4
76.Sh HISTORY
77The
78.Nm
79command first appeared in
80.Nx 6.0 .
81.Sh AUTHORS
82The
83.Nm
84command was written by
85.An Adam Hoka .
86