xref: /freebsd/share/man/man4/cfi.4 (revision 2e3f49888ec8851bafb22011533217487764fdb0)
1.\"-
2.\" Copyright (c) 2015-2016 SRI International
3.\" All rights reserved.
4.\"
5.\" This software was developed by SRI International and the University of
6.\" Cambridge Computer Laboratory under DARPA/AFRL contract (FA8750-10-C-0237)
7.\" ("CTSRD"), as part of the DARPA CRASH research programme.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28.\" SUCH DAMAGE.
29.\"
30.Dd January 20, 2016
31.Dt CFI 4
32.Os
33.Sh NAME
34.Nm cfi ,
35.Nm cfid
36.Nd driver for Common Flash Interface (CFI) NOR flash
37.Sh SYNOPSIS
38.Cd "device cfi"
39.Cd "device cfid"
40.Cd "options CFI_SUPPORT_STRATAFLASH"
41.Cd "options CFI_ARMEDANDDANGEROUS"
42.Pp
43In
44.Pa /boot/device.hints :
45.Cd hint.cfi.0.at="nexus0"
46.Cd hint.cfi.0.maddr=0x74000000
47.Cd hint.cfi.0.msize=0x4000000
48.Pp
49In DTS file:
50.Cd flash@74000000 {
51.Cd "  compatible =" Qo cfi-flash Qc ;
52.Cd "  reg = <0x74000000 0x4000000>;"
53.Cd };
54.Sh DESCRIPTION
55The
56.Nm
57device driver provides a management interface to NOR flash devices supporting
58the Common Flash Interface (CFI) specification.
59Its companion device
60.Nm cfid
61provides a
62.Xr geom 4
63disk interface to the device.
64.Pp
65Special support for features of the Intel StrataFlash line are available
66with the
67.Cd CFI_SUPPORT_STRATAFLASH
68kernel option.
69Additional support for write-once bits to switch part of Intel StrataFlash
70devices to read-only can be enabled by the
71.Cd CFI_ARMEDANDDANGEROUS
72kernel option.
73.Sh SEE ALSO
74.Xr led 4
75.Sh HISTORY
76The
77.Nm
78device driver first appeared in
79.Fx 8.0 .
80.Sh AUTHORS
81The
82.Nm
83driver was written by
84.An Juniper Networks
85with StrataFlash support by
86.An Sam Leffler .
87This manual page was written by SRI International and the University of
88Cambridge Computer Laboratory under DARPA/AFRL contract
89.Pq FA8750-10-C-0237
90.Pq Do CTSRD Dc ,
91as part of the DARPA CRASH research programme.
92