xref: /freebsd/share/man/man4/cfi.4 (revision 907b59d76938e654f0d040a888e8dfca3de1e222)
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.\" $FreeBSD$
31.\"
32.Dd January 20, 2016
33.Dt CFI 4
34.Os
35.Sh NAME
36.Nm cfi ,
37.Nm cfid
38.Nd driver for Common Flash Interface (CFI) NOR flash
39.Sh SYNOPSIS
40.Cd "device cfi"
41.Cd "device cfid"
42.Cd "options CFI_SUPPORT_STRATAFLASH"
43.Cd "options CFI_ARMEDANDDANGEROUS"
44.Pp
45In
46.Pa /boot/device.hints :
47.Cd hint.cfi.0.at="nexus0"
48.Cd hint.cfi.0.maddr=0x74000000
49.Cd hint.cfi.0.msize=0x4000000
50.Pp
51In DTS file:
52.Cd flash@74000000 {
53.Cd "  compatible =" Qo cfi-flash Qc ;
54.Cd "  reg = <0x74000000 0x4000000>;"
55.Cd };
56.Sh DESCRIPTION
57The
58.Nm
59device driver provides a management interface to NOR flash devices supporting
60the Common Flash Interface (CFI) specification.
61Its companion device
62.Nm cfid
63provides a
64.Xr geom 4
65disk interface to the device.
66.Pp
67Special support for features of the Intel StrataFlash line are available
68with the
69.Cd CFI_SUPPORT_STRATAFLASH
70kernel option.
71Additional support for write-once bits to switch part of Intel StrataFlash
72devices to read-only can be enabled by the
73.Cd CFI_ARMEDANDDANGEROUS
74kernel option.
75.Sh SEE ALSO
76.Xr led 4
77.Sh HISTORY
78The
79.Nm
80device driver first appeared in
81.Fx 8.0 .
82.Sh AUTHORS
83The
84.Nm
85driver was written by
86.An Juniper Networks
87with StrataFlash support by
88.An Sam Leffler .
89This manual page was written by SRI International and the University of
90Cambridge Computer Laboratory under DARPA/AFRL contract
91.Pq FA8750-10-C-0237
92.Pq Do CTSRD Dc ,
93as part of the DARPA CRASH research programme.
94