share/man/man9/firmware.9

   1 .\"
   2 .\" Copyright (c) 2007
   3 .\"     The DragonFly Project.  All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\"
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in
  13 .\"    the documentation and/or other materials provided with the
  14 .\"    distribution.
  15 .\" 3. Neither the name of The DragonFly Project nor the names of its
  16 .\"    contributors may be used to endorse or promote products derived
  17 .\"    from this software without specific, prior written permission.
  18 .\"
  19 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  22 .\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
  23 .\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  24 .\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
  25 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  26 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  27 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  28 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  29 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\" $DragonFly: src/share/man/man9/firmware.9,v 1.2 2008/01/10 12:45:10 sephe Exp $
  33 .\"
  34 .Dd January 10, 2008
  35 .Dt FIRMWARE 9
  36 .Os
  37 .Sh NAME
  38 .Nm firmware_image_load ,
  39 .Nm firmware_image_unload
  40 .Nd firmware support
  41 .Sh SYNOPSIS
  42 .In sys/firmware.h
  43 .Ft struct fw_image *
  44 .Fn firmware_image_load "const char *image_name" "bus_dma_tag_t parent_tag"
  45 .Ft void
  46 .Fn firmware_image_unload "struct fw_image *img"
  47 .Sh DESCRIPTION
  48 The
  49 .Nm firmware
  50 interface provides functions for loading and unloading of firmware images.
  51 .Pp
  52 The
  53 .Fn firmware_image_load
  54 function loads the firmware
  55 .Fa image_name
  56 into the kernel and returns a pointer to a
  57 .Vt struct fw_image.
  58 If
  59 .Fa parent_tag
  60 is not NULL,
  61 firmware will be loaded into contiguous physical memory
  62 according to it.
  63 The
  64 .Fn firmware_image_unload
  65 function unloads the image associated with
  66 .Fa img
  67 (obtained with a previous call to
  68 .Fn firmware_image_load ) .
  69 .Pp
  70 Images have to reside in
  71 .Pa /etc/firmware
  72 in order for these functions to work.
  73 This requires the root partition being mounted.
  74 .Sh HISTORY
  75 The
  76 .Nm firmware
  77 framework first appeared in
  78 .Dx 1.1 .
  79 .Sh AUTHORS
  80 .An Johannes Hofmann
  81 .An Joerg Sonnenberger