xref: /dflybsd-src/share/examples/kld/firmware/README (revision 137f4259438e31e5d1cb196034dc4fcde775d556)
1d83c779aSSascha Wildner$FreeBSD: src/share/examples/kld/firmware/README,v 1.1 2006/01/29 02:52:39 mlaier Exp $
2d83c779aSSascha Wildner
3d83c779aSSascha WildnerThis is a simple example of the firmware(9) system.  It consists of two
4d83c779aSSascha Wildnerparts:
5d83c779aSSascha Wildner
6d83c779aSSascha Wildner1) fwimage
7d83c779aSSascha Wildner	This is the firmware image (the ascii art of beastie from the boot
8d83c779aSSascha Wildner	menu).  The Makefile lists the firmware file "firmware.img" and the
9d83c779aSSascha Wildner	short handle for this firmware image "beastie".
10d83c779aSSascha Wildner	Note that the module is called "beastie" as well so that it can be
11d83c779aSSascha Wildner	loaded automatically if requested.
12d83c779aSSascha Wildner
13d83c779aSSascha Wildner2) fwconsumer
14d83c779aSSascha Wildner	This module tries to get the a firmware image called "beastie",
15d83c779aSSascha Wildner	checks if the data is '\0'-terminated and prints it to the console.
16d83c779aSSascha Wildner	It keeps a reference to the firmware until it is unloaded.
17d83c779aSSascha Wildner
18d83c779aSSascha WildnerThis is mainly to demonstrate how to construct firmware image modules.
19*137f4259Szrj
20*137f4259Szrj3) wrap-fw_module.sh
21*137f4259Szrj	A simple shell script that demonstrates firmware construction flow
22*137f4259Szrj	in a more detailed way. This example script can potentially be used by
23*137f4259Szrj	external builders or to derive more sophisticated building scripts.
24