opnsense-src/share/examples/kld/firmware/README

$FreeBSD$

This is a simple example of the firmware(9) system.  It consists of two
parts:

1) fwimage
	This is the firmware image (the ascii art of beastie from the boot
	menu).  The Makefile lists the firmware file "firmware.img" and the
	short handle for this firmware image "beastie".
	Note that the module is called "beastie" as well so that it can be
	loaded automatically if requested.

2) fwconsumer
	This module tries to get the a firmware image called "beastie",
	checks if the data is '\0'-terminated and prints it to the console.
	It keeps a reference to the firmware until it is unloaded.

This is mainly to demonstrate how to construct firmware image modules.
firmware(9) is a subsystem to load binary data into the kernel via a specially crafted module. There are several handrolled sollutions to this problem in the tree already which will be replaced with this. They include iwi(4), ipw(4), ispfw(4) and digi(4). No objection from: arch MFC after: 2 weeks X-MFC after: some drivers have been converted 2006-01-28 21:52:42 -05:00			$FreeBSD$

			`This is a simple example of the firmware(9) system. It consists of two`
			`parts:`

			`1) fwimage`
			`This is the firmware image (the ascii art of beastie from the boot`
			`menu). The Makefile lists the firmware file "firmware.img" and the`
			`short handle for this firmware image "beastie".`
			`Note that the module is called "beastie" as well so that it can be`
			`loaded automatically if requested.`

			`2) fwconsumer`
			`This module tries to get the a firmware image called "beastie",`
			`checks if the data is '\0'-terminated and prints it to the console.`
			`It keeps a reference to the firmware until it is unloaded.`

			`This is mainly to demonstrate how to construct firmware image modules.`