4 # Copyright (c) 2006 Max Laier.
7 # Redistribution and use in source and binary forms, with or without
8 # modification, are permitted provided that the following conditions
10 # 1. Redistributions of source code must retain the above copyright
11 # notice, this list of conditions and the following disclaimer.
12 # 2. Redistributions in binary form must reproduce the above copyright
13 # notice, this list of conditions and the following disclaimer in the
14 # documentation and/or other materials provided with the distribution.
16 # THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS `AS IS'' AND
17 # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 # ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 # FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 # DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 # OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 # HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 # OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 # $FreeBSD: src/sys/tools/fw_stub.awk,v 1.6.10.2 2009/11/02 09:47:15 fjoe Exp $
31 # Script to generate module .c file from a list of firmware images
36 print "usage: fw_stub <firmware:name[:version[:parent]]>* [-l name] [-c outfile] -m modname";
40 # These are just for convenience ...
44 print s > ctmpfilename;
46 print s > "/dev/stdout";
52 # Process the command line.
57 for (i = 1; i < ARGC; i++) {
60 # awk doesn't have getopt(), so we have to do it ourselves.
61 # This is a bit clumsy, but it works.
63 for (j = 2; j <= length(ARGV[i]); j++) {
64 o = substr(ARGV[i], j, 1);
66 if (length(ARGV[i]) > j) {
67 opt_c = substr(ARGV[i], j + 1);
78 } else if (o == "m") {
79 if (length(ARGV[i]) > j) {
80 opt_m = substr(ARGV[i], j + 1);
91 } else if (o == "l") {
92 if (length(ARGV[i]) > j) {
93 opt_l = substr(ARGV[i], j + 1);
108 split(ARGV[i], curr, ":");
109 filenames[num_files] = curr[1];
110 if (length(curr[2]) > 0)
111 shortnames[num_files] = curr[2];
113 shortnames[num_files] = curr[1];
114 if (length(curr[3]) > 0)
115 versions[num_files] = int(curr[3]);
117 versions[num_files] = 0;
122 if (!num_files || !opt_m)
126 ctmpfilename = cfilename ".tmp";
128 gsub(/[-\.]/, "_", modname);
130 printc("#include <sys/param.h>\
131 #include <sys/errno.h>\
132 #include <sys/kernel.h>\
133 #include <sys/module.h>\
134 #include <sys/linker.h>\
135 #include <sys/firmware.h>\
136 #include <sys/systm.h>\n");
139 printc("static long " opt_l "_license_ack = 0;");
142 for (file_i = 0; file_i < num_files; file_i++) {
143 symb = filenames[file_i];
144 # '-', '.' and '/' are converted to '_' by ld/objcopy
145 gsub(/-|\.|\//, "_", symb);
146 printc("extern char _binary_" symb "_start[], _binary_" symb "_end[];");
149 printc("\nstatic int\n"\
150 modname "_fw_modevent(module_t mod, int type, void *unused)\
152 const struct firmware *fp;");
155 printc("\tconst struct firmware *parent;");
157 printc("\tint error;\
163 TUNABLE_LONG_FETCH(\"legal." opt_l ".license_ack\", &" opt_l "_license_ack);\
164 if (!" opt_l "_license_ack) {\
165 kprintf(\"" opt_m ": You need to read the LICENSE file in /usr/share/doc/legal/" opt_l "/.\\n\");\
166 kprintf(\"" opt_m ": If you agree with the license, set legal." opt_l ".license_ack=1 in /boot/loader.conf.\\n\");\
171 for (file_i = 0; file_i < num_files; file_i++) {
172 short = shortnames[file_i];
173 symb = filenames[file_i];
174 version = versions[file_i];
175 # '-', '.' and '/' are converted to '_' by ld/objcopy
176 gsub(/-|\.|\//, "_", symb);
179 reg = reg "firmware_register(\"" short "\", _binary_" symb "_start , ";
180 reg = reg "(size_t)(_binary_" symb "_end - _binary_" symb "_start), ";
181 reg = reg version ", ";
186 reg = reg "parent);";
190 printc("\t\tif (fp == NULL)");
191 printc("\t\t\tgoto fail_" file_i ";");
192 if (file_i == 0 && num_files > 1)
193 printc("\t\tparent = fp;");
196 printc("\t\treturn (0);");
198 for (file_i = num_files - 1; file_i > 0; file_i--) {
199 printc("fail_" file_i ":")
200 printc("\t\t(void)firmware_unregister(\"" shortnames[file_i - 1] "\");");
204 printc("\t\treturn (ENXIO);");
206 printc("\tcase MOD_UNLOAD:");
208 for (file_i = 1; file_i < num_files; file_i++) {
209 printc("\t\terror = firmware_unregister(\"" shortnames[file_i] "\");");
210 printc("\t\tif (error)");
211 printc("\t\t\treturn (error);");
214 printc("\t\terror = firmware_unregister(\"" shortnames[0] "\");");
216 printc("\t\treturn (error);\
221 static moduledata_t " modname "_fw_mod = {\
223 " modname "_fw_modevent,\
226 DECLARE_MODULE(" modname "_fw, " modname "_fw_mod, SI_SUB_DRIVERS, SI_ORDER_FIRST);\
227 MODULE_VERSION(" modname "_fw, 1);\
228 MODULE_DEPEND(" modname "_fw, firmware, 1, 1, 1);\
232 if ((rc = system("mv -f " ctmpfilename " " cfilename))) {
233 print "'mv -f " ctmpfilename " " cfilename "' failed: " rc \