xref: /freebsd/share/examples/kld/firmware/README (revision 3078531de10dcae44b253a35125c949ff4235284)
1$FreeBSD$
2
3This is a simple example of the firmware(9) system.  It consists of two
4parts:
5
61) fwimage
7	This is the firmware image (the ascii art of beastie from the boot
8	menu).  The Makefile lists the firmware file "firmware.img" and the
9	short handle for this firmware image "beastie".
10	Note that the module is called "beastie" as well so that it can be
11	loaded automatically if requested.
12
132) fwconsumer
14	This module tries to get the a firmware image called "beastie",
15	checks if the data is '\0'-terminated and prints it to the console.
16	It keeps a reference to the firmware until it is unloaded.
17
18This is mainly to demonstrate how to construct firmware image modules.
19