fw_stub.awk revision 241370
1229159Sadrian#!/usr/bin/awk -f 2229159Sadrian 3229159Sadrian#- 4229159Sadrian# Copyright (c) 2006 Max Laier. 5229159Sadrian# All rights reserved. 6229159Sadrian# 7229159Sadrian# Redistribution and use in source and binary forms, with or without 8229159Sadrian# modification, are permitted provided that the following conditions 9229159Sadrian# are met: 10229159Sadrian# 1. Redistributions of source code must retain the above copyright 11229159Sadrian# notice, this list of conditions and the following disclaimer. 12229159Sadrian# 2. Redistributions in binary form must reproduce the above copyright 13229159Sadrian# notice, this list of conditions and the following disclaimer in the 14229159Sadrian# documentation and/or other materials provided with the distribution. 15229159Sadrian# 16229159Sadrian# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS `AS IS'' AND 17229159Sadrian# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18229159Sadrian# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19229159Sadrian# ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 20229159Sadrian# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21229159Sadrian# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22229159Sadrian# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23229159Sadrian# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24229159Sadrian# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25229159Sadrian# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26229159Sadrian# SUCH DAMAGE. 27229159Sadrian# 28229159Sadrian# $FreeBSD: head/sys/tools/fw_stub.awk 241370 2012-10-09 08:27:40Z kevlo $ 29229159Sadrian 30229159Sadrian# 31229159Sadrian# Script to generate module .c file from a list of firmware images 32229159Sadrian# 33229159Sadrian 34229159Sadrianfunction usage () 35229159Sadrian{ 36229159Sadrian print "usage: fw_stub <firmware:name>* [-l name] [-m modname] [-c outfile]"; 37229159Sadrian exit 1; 38229159Sadrian} 39229159Sadrian 40229159Sadrian# These are just for convenience ... 41229159Sadrianfunction printc(s) 42229159Sadrian{ 43229159Sadrian if (opt_c) 44229159Sadrian print s > ctmpfilename; 45229159Sadrian else 46229159Sadrian print s > "/dev/stdout"; 47229159Sadrian} 48229159Sadrian 49229159SadrianBEGIN { 50229159Sadrian 51229159Sadrian# 52229159Sadrian# Process the command line. 53229159Sadrian# 54229159Sadrian 55229159Sadriannum_files = 0; 56229159Sadrian 57229159Sadrianfor (i = 1; i < ARGC; i++) { 58229159Sadrian if (ARGV[i] ~ /^-/) { 59229159Sadrian # 60229159Sadrian # awk doesn't have getopt(), so we have to do it ourselves. 61229159Sadrian # This is a bit clumsy, but it works. 62229159Sadrian # 63229159Sadrian for (j = 2; j <= length(ARGV[i]); j++) { 64229159Sadrian o = substr(ARGV[i], j, 1); 65229159Sadrian if (o == "c") { 66229159Sadrian if (length(ARGV[i]) > j) { 67229159Sadrian opt_c = substr(ARGV[i], j + 1); 68229159Sadrian break; 69229159Sadrian } 70229159Sadrian else { 71229159Sadrian if (++i < ARGC) 72229159Sadrian opt_c = ARGV[i]; 73229159Sadrian else 74229159Sadrian usage(); 75229159Sadrian } 76229159Sadrian } else if (o == "m") { 77229159Sadrian if (length(ARGV[i]) > j) { 78229159Sadrian opt_m = substr(ARGV[i], j + 1); 79229159Sadrian break; 80229159Sadrian } 81229159Sadrian else { 82229159Sadrian if (++i < ARGC) 83229159Sadrian opt_m = ARGV[i]; 84229159Sadrian else 85229159Sadrian usage(); 86229159Sadrian } 87229159Sadrian } else if (o == "l") { 88229159Sadrian if (length(ARGV[i]) > j) { 89229159Sadrian opt_l = substr(ARGV[i], j + 1); 90229159Sadrian break; 91229159Sadrian } 92229159Sadrian else { 93229159Sadrian if (++i < ARGC) 94229159Sadrian opt_l = ARGV[i]; 95229159Sadrian else 96229159Sadrian usage(); 97229159Sadrian } 98229159Sadrian } else 99229159Sadrian usage(); 100229159Sadrian } 101229159Sadrian } else { 102229159Sadrian split(ARGV[i], curr, ":"); 103229159Sadrian filenames[num_files] = curr[1]; 104229159Sadrian if (length(curr[2]) > 0) 105229159Sadrian shortnames[num_files] = curr[2]; 106229159Sadrian else 107229159Sadrian shortnames[num_files] = curr[1]; 108229159Sadrian if (length(curr[3]) > 0) 109229159Sadrian versions[num_files] = int(curr[3]); 110229159Sadrian else 111229159Sadrian versions[num_files] = 0; 112229159Sadrian num_files++; 113229159Sadrian } 114229159Sadrian} 115229159Sadrian 116229159Sadrianif (!num_files || !opt_m) 117229159Sadrian usage(); 118229159Sadrian 119229159Sadriancfilename = opt_c; 120229159Sadrianctmpfilename = cfilename ".tmp"; 121229159Sadrianmodname = opt_m; 122229159Sadriangsub(/[-\.]/, "_", modname); 123229159Sadrian 124229159Sadrianprintc("/*\ 125229159Sadrian * Automatically generated by:\ 126229159Sadrian * $FreeBSD: head/sys/tools/fw_stub.awk 241370 2012-10-09 08:27:40Z kevlo $\ 127229159Sadrian */"); 128229159Sadrianprintc("#include <sys/param.h>"); 129229159Sadrianprintc("#include <sys/errno.h>"); 130229159Sadrianprintc("#include <sys/kernel.h>"); 131229159Sadrianprintc("#include <sys/module.h>"); 132229159Sadrianprintc("#include <sys/linker.h>"); 133229159Sadrianprintc("#include <sys/firmware.h>"); 134229159Sadrianprintc("#include <sys/systm.h>\n"); 135229159Sadrian 136229159Sadrianif (opt_l) { 137229159Sadrian printc("static long " opt_l "_license_ack = 0;"); 138229159Sadrian} 139229159Sadrian 140229159Sadrianfor (file_i = 0; file_i < num_files; file_i++) { 141229159Sadrian symb = filenames[file_i]; 142229159Sadrian # '-', '.' and '/' are converted to '_' by ld/objcopy 143229159Sadrian gsub(/-|\.|\//, "_", symb); 144229159Sadrian printc("extern char _binary_" symb "_start[], _binary_" symb "_end[];"); 145229159Sadrian} 146229159Sadrian 147229159Sadrianprintc("\nstatic int\n"\ 148229159Sadrianmodname "_fw_modevent(module_t mod, int type, void *unused)\ 149229159Sadrian{\ 150229159Sadrian const struct firmware *fp, *parent;\ 151229159Sadrian int error;\ 152229159Sadrian switch (type) {\ 153229159Sadrian case MOD_LOAD:\n"); 154229159Sadrian 155229159Sadrianif (opt_l) { 156229159Sadrian printc("\ 157229159Sadrian TUNABLE_LONG_FETCH(\"legal." opt_l ".license_ack\", &" opt_l "_license_ack);\ 158229159Sadrian if (!" opt_l "_license_ack) {\ 159229159Sadrian printf(\"" opt_m ": You need to read the LICENSE file in /usr/share/doc/legal/" opt_l "/.\\n\");\ 160229159Sadrian printf(\"" opt_m ": If you agree with the license, set legal." opt_l ".license_ack=1 in /boot/loader.conf.\\n\");\ 161229159Sadrian return(EPERM);\ 162229159Sadrian }\n"); 163229159Sadrian} 164229159Sadrian 165229159Sadrianfor (file_i = 0; file_i < num_files; file_i++) { 166229159Sadrian short = shortnames[file_i]; 167229159Sadrian symb = filenames[file_i]; 168229159Sadrian version = versions[file_i]; 169229159Sadrian # '-', '.' and '/' are converted to '_' by ld/objcopy 170229159Sadrian gsub(/-|\.|\//, "_", symb); 171229159Sadrian 172229159Sadrian reg = "\t\tfp = "; 173229159Sadrian reg = reg "firmware_register(\"" short "\", _binary_" symb "_start , "; 174229159Sadrian reg = reg "(size_t)(_binary_" symb "_end - _binary_" symb "_start), "; 175229159Sadrian reg = reg version ", "; 176229159Sadrian 177229159Sadrian if (file_i == 0) 178229159Sadrian reg = reg "NULL);"; 179229159Sadrian else 180229159Sadrian reg = reg "parent);"; 181229159Sadrian 182229159Sadrian printc(reg); 183229159Sadrian 184229159Sadrian printc("\t\tif (fp == NULL)"); 185229159Sadrian printc("\t\t\tgoto fail_" file_i ";"); 186229159Sadrian if (file_i == 0) 187229159Sadrian printc("\t\tparent = fp;"); 188229159Sadrian} 189229159Sadrian 190229159Sadrianprintc("\t\treturn (0);"); 191229159Sadrian 192229159Sadrianfor (file_i = num_files - 1; file_i > 0; file_i--) { 193229159Sadrian printc("fail_" file_i ":") 194229159Sadrian printc("\t\t(void)firmware_unregister(\"" shortnames[file_i - 1] "\");"); 195229159Sadrian} 196229159Sadrian 197229159Sadrianprintc("\tfail_0:"); 198229159Sadrianprintc("\t\treturn (ENXIO);"); 199229159Sadrian 200229159Sadrianprintc("\tcase MOD_UNLOAD:"); 201229159Sadrian 202229159Sadrianfor (file_i = 1; file_i < num_files; file_i++) { 203229159Sadrian printc("\t\terror = firmware_unregister(\"" shortnames[file_i] "\");"); 204229159Sadrian printc("\t\tif (error)"); 205 printc("\t\t\treturn (error);"); 206} 207 208printc("\t\terror = firmware_unregister(\"" shortnames[0] "\");"); 209 210printc("\t\treturn (error);\ 211 }\ 212 return (EINVAL);\ 213}\ 214\ 215static moduledata_t " modname "_fw_mod = {\ 216 \"" modname "_fw\",\ 217 " modname "_fw_modevent,\ 218 NULL\ 219};\ 220DECLARE_MODULE(" modname "_fw, " modname "_fw_mod, SI_SUB_DRIVERS, SI_ORDER_FIRST);\ 221MODULE_VERSION(" modname "_fw, 1);\ 222MODULE_DEPEND(" modname "_fw, firmware, 1, 1, 1);\ 223"); 224 225if (opt_c) 226 if ((rc = system("mv -f " ctmpfilename " " cfilename))) { 227 print "'mv -f " ctmpfilename " " cfilename "' failed: " rc \ 228 > "/dev/stderr"; 229 exit 1; 230 } 231 232exit 0; 233 234} 235