0fb08eabb6f5f47f3c411cc1ba5cefa9a772c286
[dragonfly.git] / share / man / man4 / man4.i386 / glxsb.4
1 .\" $OpenBSD: glxsb.4,v 1.5 2007/05/31 19:19:54 jmc Exp $
2 .\"
3 .\"Copyright (c) 2006 Tom Cosgrove <tom@openbsd.org>
4 .\"
5 .\"Permission to use, copy, modify, and distribute this software for any
6 .\"purpose with or without fee is hereby granted, provided that the above
7 .\"copyright notice and this permission notice appear in all copies.
8 .\"
9 .\"THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10 .\"WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11 .\"MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12 .\"ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13 .\"WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14 .\"ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15 .\"OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16 .\"
17 .\" $FreeBSD: src/share/man/man4/man4.i386/glxsb.4,v 1.4 2009/04/23 08:37:56 brueffer Exp $
18 .\"
19 .Dd October 6, 2009
20 .Dt GLXSB 4 i386
21 .Os
22 .Sh NAME
23 .Nm glxsb
24 .Nd Geode LX Security Block crypto accelerator
25 .Sh SYNOPSIS
26 To compile this driver into the kernel,
27 place the following lines in your
28 kernel configuration file:
29 .Bd -ragged -offset indent
30 .Cd "device crypto"
31 .Cd "device glxsb"
32 .Ed
33 .Pp
34 Alternatively, to load the driver as a
35 module at boot time, place the following line in
36 .Xr loader.conf 5 :
37 .Bd -literal -offset indent
38 glxsb_load="YES"
39 .Ed
40 .Sh DESCRIPTION
41 The
42 .Nm
43 driver supports the security block of the Geode LX series processors.
44 The Geode LX is a member of the AMD Geode family
45 of integrated x86 system chips.
46 .Pp
47 Driven by periodic checks for available data from the generator,
48 .Nm
49 supplies entropy to the
50 .Xr random 4
51 driver for common usage.
52 .Pp
53 .Nm
54 also supports acceleration of AES-128-CBC operations for
55 .Xr crypto 4 .
56 It also registers itself to accelerate other HMAC algorithms, although
57 there is no hardware acceleration for those algorithms.
58 This is only needed so
59 .Nm
60 can work with
61 .Xr ipsec 4 .
62 .Sh CAVEAT
63 The
64 .Xr crypto 9
65 framework will fail to open the crypto session on the device if the AES
66 key's length is != 128 bits.
67 This prevents the use of the
68 .Nm
69 device driver with AES keys of length != 128 bits.
70 .Sh SEE ALSO
71 .Xr crypto 4 ,
72 .Xr intro 4 ,
73 .Xr ipsec 4 ,
74 .Xr pci 4 ,
75 .Xr random 4 ,
76 .Xr crypto 9
77 .Sh HISTORY
78 The
79 .Nm
80 device driver first appeared in
81 .Ox 4.1 .
82 The
83 .Nm
84 device driver was imported into
85 .Fx 7.1 .
86 .Sh AUTHORS
87 .An -nosplit
88 The
89 .Nm
90 device driver was written for
91 .Ox
92 by
93 .An Tom Cosgrove .
94 It was ported to
95 .Fx
96 by
97 .An Patrick Lamaiziere Aq patfbsd@davenulle.org