share/man/man9/firmware.9

   1 .\" Copyright (c) 2006 Max Laier <mlaier@FreeBSD.org>
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
  14 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  15 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  16 .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
  17 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  18 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  19 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  20 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  21 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  22 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  23 .\"
  24 .\" $FreeBSD$
  25 .\"
  26 .Dd January 6, 2006
  27 .Os
  28 .Dt FIRMWARE 9
  29 .Sh NAME
  30 .Nm firmware_register ,
  31 .Nm firmware_unregister ,
  32 .Nm firmware_get ,
  33 .Nm firmware_put
  34 .Nd firmware image loading and management
  35 .Sh SYNOPSIS
  36 .In sys/param.h
  37 .In sys/systm.h
  38 .In sys/linker.h
  39 .In sys/firmware.h
  40 .Bd -literal
  41 struct firmware {
  42         const char      *name;          /* system-wide name */
  43         const void      *data;          /* location of image */
  44         size_t          datasize;       /* size of image in bytes */
  45         unsigned int    version;        /* version of the image */
  46 };
  47 .Ed
  48 .Ft "const struct firmware *"
  49 .Fo firmware_register
  50 .Fa "const char *imagename"
  51 .Fa "const void *data"
  52 .Fa "size_t datasize"
  53 .Fa "unsigned int version"
  54 .Fa "const struct firmware *parent"
  55 .Fc
  56 .Ft int
  57 .Fn firmware_unregister "const char *imagename"
  58 .Ft "const struct firmware *"
  59 .Fn firmware_get "const char *imagename"
  60 .Ft void
  61 .Fn firmware_put "const struct firmware *fp" "int flags"
  62 .Sh DESCRIPTION
  63 The
  64 .Nm firmware
  65 abstraction provides a convenient interface for loading
  66 .Nm firmware images
  67 into the kernel, and for accessing such images from kernel components.
  68 .Pp
  69 A
  70 .Nm firmware image
  71 (or
  72 .Nm image
  73 for brevity)
  74 is an opaque block of data residing in kernel memory.
  75 It is associated to a unique
  76 .Nm imagename
  77 which constitutes a search key, and to an integer
  78 .Nm version
  79 number, which is also an opaque piece of information for the
  80 firmware subsystem.
  81 .Pp
  82 An image is registered with the
  83 .Nm firmware
  84 subsystem by calling the function
  85 .Fn firmware_register ,
  86 and unregistered by calling
  87 .Fn firmware_unregister .
  88 These functions are usually (but not exclusively) called by
  89 specially crafted kernel modules that contain the firmware image.
  90 The modules can be statically compiled in the kernel, or loaded by
  91 .Nm /boot/loader ,
  92 manually at runtime, or on demand by the firmware subsystem.
  93 .Pp
  94 .Nm Clients
  95 of the firmware subsystem can request access to a given image
  96 by calling the function
  97 .Fn firmware_get
  98 with the
  99 .Nm imagename
 100 they want as an argument. If a matching image is not already registered,
 101 the firmware subsystem will try to load it using the
 102 mechanisms specified below (typically, a kernel module
 103 with
 104 .Nm the same name
 105 as the image).
 106 .Sh API DESCRIPTION
 107 The kernel
 108 .Nm firmware API
 109 is made of the following functions:
 110 .Pp
 111 .Fn firmware_register
 112 registers with the kernel an image of size
 113 .Nm datasize
 114 located at address
 115 .Nm data ,
 116 under the name
 117 .Nm imagename .
 118 .Pp
 119 The function returns NULL on error (e.g. because an
 120 image with the same name already exists, or the image
 121 table is full), or a
 122 .Ft const struct firmware *
 123 pointer to the image requested.
 124 .Pp
 125 .Fn firmware_unregister
 126 tries to unregister the firmware image
 127 .Nm imagename
 128 from the system. The function is successful and returns 0
 129 if there are no pending references to the image, otherwise
 130 it does not unregister the image and returns EBUSY.
 131 .Pp
 132 .Fn firmware_get
 133 returns the requested firmware image.
 134 If the image is not yet registered with the system,
 135 the function tries to load it.
 136 This involves the linker subsystem and disk access, so
 137 .Fn firmware_get
 138 must not be called with any locks (except for
 139 .Va Giant ) .
 140 The caller must also have a process context so filesystem state such as
 141 the root vnode is defined (e.g. you cannot load from a taskqueue thread).
 142 .Pp
 143 On success,
 144 .Fn firmware_get
 145 returns a pointer to the image description and increases the reference count
 146 for this image. On failure, the function returns NULL.
 147 .Pp
 148 .Fn firmware_put
 149 drops a reference to a firmware image.
 150 The
 151 .Fa flags
 152 argument may be set to
 153 .Dv FIRMWARE_UNLOAD
 154 to indicate that
 155 firmware_put is free to reclaim resources associated with
 156 the firmware image if this is the last reference.
 157 .Sh FIRMWARE LOADING MECHANISMS
 158 As mentioned before, any component of the system can register
 159 firmware images at any time by simply calling
 160 .Fn firmware_register .
 161 .Pp
 162 This is typically done when a module containing
 163 a firmware image is given control,
 164 whether compiled in, or preloaded by
 165 .Nm /boot/loader ,
 166 or manually loaded with
 167 .Xr kldload 8 .
 168 However, a system can implement additional mechanisms to bring
 169 these images in memory before calling
 170 .Fn firmware_register .
 171 .Pp
 172 When
 173 .Fn firmware_get
 174 does not find the requested image, it tries to load it using
 175 one of the available loading mechanisms.
 176 At the moment, there is only one, namely
 177 .Nm Loadable kernel modules :
 178 .Pp
 179 A firmware image named
 180 .Nm foo
 181 is looked up by trying to load the module named
 182 .Nm foo.ko ,
 183 using the facilities described in
 184 .Xr kld 4 .
 185 In particular, images are looked up in the directories specified
 186 by the sysctl variable
 187 .Nm kern.module_path
 188 which on most systems defaults to
 189 .Nm /boot/kernel;/boot/modules .
 190 .Pp
 191 Note that in case a module contains multiple images,
 192 the caller should first request a
 193 .Fn firmware_get
 194 for the first image contained in the module, followed by requests
 195 for the other images.
 196 .Sh BUILDING FIRMWARE LOADABLE MODULES
 197 A firmware module is built by embedding the
 198 .Nm firmware image
 199 into a suitable loadable kernel module that calls
 200 .Fn firmware_register
 201 on loading, and
 202 .Fn firmware_unregister
 203 on unloading.
 204 .Pp
 205 Various system scripts and makefiles let you build a module
 206 by simply writing a Makefile with the following entries:
 207 .Bd -literal
 208
 209         KMOD=   imagename
 210         FIRMWS= image_file:imagename[:version]
 211         .include <bsd.kmod.mk>
 212
 213 .Ed
 214 where KMOD is the basename of the module; FIRMWS is a list of
 215 colon-separated tuples indicating the image_file's to be embedded
 216 in the module, the imagename and version of each firmware image.
 217 .Pp
 218 If you need to embed firmware images into a system, you should write
 219 appropriate entries in the <files.arch> file, e.g. this example is
 220 from
 221 .Nm sys/arm/xscale/ixp425/files.ixp425:
 222 .Bd -literal
 223 ixp425_npe_fw.c                         optional npe_fw                 \\
 224         compile-with    "${AWK} -f $S/tools/fw_stub.awk                 \\
 225                         IxNpeMicrocode.dat:npe_fw -mnpe -c${.TARGET}"   \\
 226         no-implicit-rule before-depend local                            \\
 227         clean           "ixp425_npe_fw.c"
 228 #
 229 # NB: ld encodes the path in the binary symbols generated for the
 230 #     firmware image so link the file to the object directory to
 231 #     get known values for reference in the _fw.c file.
 232 #
 233 IxNpeMicrocode.fwo  optional npe_fw                                     \\
 234         dependency      "IxNpeMicrocode.dat"                            \\
 235         compile-with    "${LD} -b binary -d -warn-common                \\
 236                             -r -d -o ${.TARGET} IxNpeMicrocode.dat"     \\
 237         no-implicit-rule                                                \\
 238         clean           "IxNpeMicrocode.fwo"
 239 IxNpeMicrocode.dat                      optional npe_fw                 \\
 240         dependency      ".PHONY"                                        \\
 241         compile-with    "if [ -e $S/arm/xscale/ixp425/IxNpeMicrocode.dat ]; \\
 242                         then                                            \\
 243                         ln -sf $S/arm/xscale/ixp425/IxNpeMicrocode.dat .; \\
 244                         else echo 'WARNING, no IxNpeMicrocode.dat file; you must obtain this from the Intel web site'; false; \\
 245                         fi" \\
 246         no-obj no-implicit-rule                                         \\
 247         clean           "IxNpeMicrocode.dat"
 248 .Ed
 249 .Pp
 250 Note that generating the firmware modules in this way requires
 251 the availability of the following tools:
 252 .Xr awk ,
 253 .Xr Make ,
 254 the compiler and the linker.
 255 .Sh SEE ALSO
 256 .Xr module 9 ,
 257 .Xr kld 4
 258 .Pp
 259 .Pa /usr/share/examples/kld/firmware
 260 .Sh HISTORY
 261 The
 262 .Nm firmware
 263 system was introduced in
 264 .Fx 6.1 .
 265 .Sh AUTHORS
 266 This manual page was written by
 267 .An Max Laier Aq mlaier@FreeBSD.org .