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