xref: /freebsd/share/examples/kld/firmware/README (revision 05248206f720394d95c2a7475429311df670a2e9)
16aec1278SMax Laier
26aec1278SMax LaierThis is a simple example of the firmware(9) system.  It consists of two
36aec1278SMax Laierparts:
46aec1278SMax Laier
56aec1278SMax Laier1) fwimage
66aec1278SMax Laier	This is the firmware image (the ascii art of beastie from the boot
76aec1278SMax Laier	menu).  The Makefile lists the firmware file "firmware.img" and the
86aec1278SMax Laier	short handle for this firmware image "beastie".
96aec1278SMax Laier	Note that the module is called "beastie" as well so that it can be
106aec1278SMax Laier	loaded automatically if requested.
116aec1278SMax Laier
126aec1278SMax Laier2) fwconsumer
136aec1278SMax Laier	This module tries to get the a firmware image called "beastie",
146aec1278SMax Laier	checks if the data is '\0'-terminated and prints it to the console.
156aec1278SMax Laier	It keeps a reference to the firmware until it is unloaded.
166aec1278SMax Laier
176aec1278SMax LaierThis is mainly to demonstrate how to construct firmware image modules.
18