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 August 2, 2008
  27 .Dt FIRMWARE 9
  28 .Os
  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
 105 the same name
 106 as the image).
 107 .Sh API DESCRIPTION
 108 The kernel
 109 .Nm
 110 firmware API
 111 is made of the following functions:
 112 .Pp
 113 .Fn firmware_register
 114 registers with the kernel an image of size
 115 .Nm datasize
 116 located at address
 117 .Nm data ,
 118 under the name
 119 .Nm imagename .
 120 .Pp
 121 The function returns NULL on error (e.g. because an
 122 image with the same name already exists, or the image
 123 table is full), or a
 124 .Ft const struct firmware *
 125 pointer to the image requested.
 126 .Pp
 127 .Fn firmware_unregister
 128 tries to unregister the firmware image
 129 .Nm imagename
 130 from the system. The function is successful and returns 0
 131 if there are no pending references to the image, otherwise
 132 it does not unregister the image and returns EBUSY.
 133 .Pp
 134 .Fn firmware_get
 135 returns the requested firmware image.
 136 If the image is not yet registered with the system,
 137 the function tries to load it.
 138 This involves the linker subsystem and disk access, so
 139 .Fn firmware_get
 140 must not be called with any locks (except for
 141 .Va Giant ) .
 142 Note also that if the firmware image is loaded from a filesystem
 143 it must already be mounted.
 144 In particular this means that it may be necessary to defer requests
 145 from a driver attach method unless it is known the root filesystem is
 146 already mounted.
 147 .Pp
 148 On success,
 149 .Fn firmware_get
 150 returns a pointer to the image description and increases the reference count
 151 for this image. On failure, the function returns NULL.
 152 .Pp
 153 .Fn firmware_put
 154 drops a reference to a firmware image.
 155 The
 156 .Fa flags
 157 argument may be set to
 158 .Dv FIRMWARE_UNLOAD
 159 to indicate that
 160 firmware_put is free to reclaim resources associated with
 161 the firmware image if this is the last reference.
 162 By default a firmware image will be deferred to a
 163 .Xr taskqueue 9
 164 thread so the call may be done while holding a lock.
 165 In certain cases, such as on driver detach, this cannot be allowed.
 166 .Sh FIRMWARE LOADING MECHANISMS
 167 As mentioned before, any component of the system can register
 168 firmware images at any time by simply calling
 169 .Fn firmware_register .
 170 .Pp
 171 This is typically done when a module containing
 172 a firmware image is given control,
 173 whether compiled in, or preloaded by
 174 .Nm /boot/loader ,
 175 or manually loaded with
 176 .Xr kldload 8 .
 177 However, a system can implement additional mechanisms to bring
 178 these images in memory before calling
 179 .Fn firmware_register .
 180 .Pp
 181 When
 182 .Fn firmware_get
 183 does not find the requested image, it tries to load it using
 184 one of the available loading mechanisms.
 185 At the moment, there is only one, namely
 186 .Nm Loadable kernel modules :
 187 .Pp
 188 A firmware image named
 189 .Nm foo
 190 is looked up by trying to load the module named
 191 .Nm foo.ko ,
 192 using the facilities described in
 193 .Xr kld 4 .
 194 In particular, images are looked up in the directories specified
 195 by the sysctl variable
 196 .Nm kern.module_path
 197 which on most systems defaults to
 198 .Nm /boot/kernel;/boot/modules .
 199 .Pp
 200 Note that in case a module contains multiple images,
 201 the caller should first request a
 202 .Fn firmware_get
 203 for the first image contained in the module, followed by requests
 204 for the other images.
 205 .Sh BUILDING FIRMWARE LOADABLE MODULES
 206 A firmware module is built by embedding the
 207 .Nm firmware image
 208 into a suitable loadable kernel module that calls
 209 .Fn firmware_register
 210 on loading, and
 211 .Fn firmware_unregister
 212 on unloading.
 213 .Pp
 214 Various system scripts and makefiles let you build a module
 215 by simply writing a Makefile with the following entries:
 216 .Bd -literal
 217
 218         KMOD=   imagename
 219         FIRMWS= image_file:imagename[:version]
 220         .include <bsd.kmod.mk>
 221
 222 .Ed
 223 where KMOD is the basename of the module; FIRMWS is a list of
 224 colon-separated tuples indicating the image_file's to be embedded
 225 in the module, the imagename and version of each firmware image.
 226 .Pp
 227 If you need to embed firmware images into a system, you should write
 228 appropriate entries in the <files.arch> file, e.g. this example is
 229 from
 230 .Nm sys/arm/xscale/ixp425/files.ixp425 :
 231 .Bd -literal
 232 ixp425_npe_fw.c                         optional npe_fw                 \\
 233         compile-with    "${AWK} -f $S/tools/fw_stub.awk                 \\
 234                         IxNpeMicrocode.dat:npe_fw -mnpe -c${.TARGET}"   \\
 235         no-implicit-rule before-depend local                            \\
 236         clean           "ixp425_npe_fw.c"
 237 #
 238 # NB: ld encodes the path in the binary symbols generated for the
 239 #     firmware image so link the file to the object directory to
 240 #     get known values for reference in the _fw.c file.
 241 #
 242 IxNpeMicrocode.fwo  optional npe_fw                                     \\
 243         dependency      "IxNpeMicrocode.dat"                            \\
 244         compile-with    "${LD} -b binary -d -warn-common                \\
 245                             -r -d -o ${.TARGET} IxNpeMicrocode.dat"     \\
 246         no-implicit-rule                                                \\
 247         clean           "IxNpeMicrocode.fwo"
 248 IxNpeMicrocode.dat                      optional npe_fw                 \\
 249         dependency      ".PHONY"                                        \\
 250         compile-with    "uudecode < $S/contrib/dev/npe/IxNpeMicrocode.dat.uu" \\
 251         no-obj no-implicit-rule                                         \\
 252         clean           "IxNpeMicrocode.dat"
 253 .Ed
 254 .Pp
 255 Note that generating the firmware modules in this way requires
 256 the availability of the following tools:
 257 .Xr awk 1 ,
 258 .Xr make 1 ,
 259 the compiler and the linker.
 260 .Sh SEE ALSO
 261 .Xr kld 4 ,
 262 .Xr module 9
 263 .Pp
 264 .Pa /usr/share/examples/kld/firmware
 265 .Sh HISTORY
 266 The
 267 .Nm firmware
 268 system was introduced in
 269 .Fx 6.1 .
 270 .Sh AUTHORS
 271 This manual page was written by
 272 .An Max Laier Aq mlaier@FreeBSD.org .