#!/bin/sh

#    Copyright (C) 2008, 2009 Alexandre Oliva <lxoliva@fsfla.org>
#    Copyright (C) 2008 Jeff Moe
#
#    This program is free software; you can redistribute it and/or modify
#    it under the terms of the GNU General Public License as published by
#    the Free Software Foundation; either version 2 of the License, or
#    (at your option) any later version.
#
#    This program is distributed in the hope that it will be useful,
#    but WITHOUT ANY WARRANTY; without even the implied warranty of
#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#    GNU General Public License for more details.
#
#    You should have received a copy of the GNU General Public License
#    along with this program; if not, write to the Free Software
#    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA


# deblob - remove non-free blobs from the vanilla linux kernel

# http://www.fsfla.org/svn/fsfla/software/linux-libre


# This script, suited for the kernel version named below, in kver,
# attempts to remove only non-Free Software bits, without removing
# Free Software that happens to be in the same file.

# Drivers that currently require non-Free firmware are retained, but
# firmware included in GPLed sources is replaced with /*(DEBLOBBED)*/
# if the deblob-check script, that knows how to do this, is present.
# -lxoliva


# See also:
# http://wiki.debian.org/KernelFirmwareLicensing
# svn://svn.debian.org/kernel/dists/trunk/linux-2.6/debian/patches/debian/dfsg/files-1
# http://svn.gnewsense.svnhopper.net/gnewsense/builder/trunk/firmware/firmware-removed
# http://svn.gnewsense.svnhopper.net/gnewsense/builder/trunk/gen-kernel

# Thanks to Brian Brazil @ gnewsense


# For each kver release, start extra with an empty string, then count
# from 1 if changes are needed that require rebuilding the tarball.
kver=2.6.28 extra=++

fatal () {
  echo "$@"
  exit 1
}

case $1 in
--force) die () { echo ERROR: "$@": ignored >&2; }; forced=:; shift;;
*) die () { fatal "$@"; }; forced=false;;
esac

check=`echo $0 | sed 's,/[^/]*$,,'`/deblob-check
if [ ! -f $check ] ; then
  if $forced; then
    die deblob-check script missing, will remove entire files
  else
    die deblob-check script missing
  fi
  have_check=false
else
  have_check=:
fi

announce () {
	echo
	echo "$@"
}

clean_file () {
	#$1 = filename
	if test ! -f $1; then
		die $1 does not exist, something is wrong
	fi
	rm -v $1
}

check_changed () {
	if test ! -f $1; then
		die $1 does not exist, something is wrong
	elif cmp $1.deblob $1 > /dev/null; then
		die $1 did not change, something is wrong
	fi
	mv $1.deblob $1
}

clean_blob () {
	#$1 = filename
	if $have_check; then
	    if test ! -f $1; then
		die $1 does not exist, something is wrong
	    fi
	    name=$1
	    echo Removing blobs from $name
	    set fnord "$@" -d
	    shift 2
	    $check "$@" -i linux-$kver $name > $name.deblob
	    check_changed $name
	else
	    clean_file $1
	fi
}

dummy_blob () {
	#$1 = filename
	if test -f $1; then
	    echo $1 exists, something is wrong
	    exit 1
	elif test ! -f firmware/Makefile; then
	    echo firmware/Makefile does not exist, something is wrong
	    exit 1
	fi

	sed -i "s,`echo $1 | sed s,^firmware/,,`,\$(DEBLOBBED),g" \
	  firmware/Makefile
}

clean_fw () {
	#$1 = firmware text input, $2 = firmware output
	if test ! -f $1; then
		fatal $1 does not exist, something is wrong
		exit 1
	elif test -f $2; then
		fatal $2 exists, something is wrong
		exit 1
	fi
	clean_blob $1 -s 4
	dummy_blob $2
}

drop_fw_file () {
	#$1 = firmware text input, $2 = firmware output
	if test ! -f $1; then
		fatal $1 does not exist, something is wrong
		exit 1
	elif test -f $2; then
		fatal $2 exists, something is wrong
		exit 1
	fi
	clean_file $1
	dummy_blob $2
}

clean_kconfig () {
        #$1 = filename $2 = things to remove
	case $1 in
	-f)
		shift
		;;
	*)
		if $have_check; then
			return
		fi
		;;
	esac
        echo Marking config $2 as depending on NONFREE in $1
	sed "/^config \\($2\\)\$/{p;i\
	depends on NONFREE
d;}" $1 > $1.deblob
	check_changed $1
}

clean_mk () {
	#$1 = config $2 = Makefile name
	# We don't clean up Makefiles any more --lxoliva
	# sed -i "/\\($1\\)/d" $2
	# check_changed $2
	if sed -n "/\\($1\\)/p" $2 | grep . > /dev/null; then
	    :
	else
	    die $2 does not contain matches for $1
	fi
}

clean_sed () {
	#$1 = sed-script $2 = file $3 = comment
	echo "$2": ${3-applying sed script "$1"}
	sed -e "$1" "$2" > "$2".deblob
	check_changed "$2"
}

reject_firmware () {
	#$1 = file
	clean_sed 's,request\(_ihex\|\)_firmware(,reject_firmware(,' "$1" "disablng non-Free firmware-loading machinery"
}

# First, check that files that contain firmwares and their
# corresponding sources are present.

for f in \
  drivers/char/ser_a2232fw.h \
    drivers/char/ser_a2232fw.ax \
  drivers/net/ixp2000/ixp2400_rx.ucode \
    drivers/net/ixp2000/ixp2400_rx.uc \
  drivers/net/ixp2000/ixp2400_tx.ucode \
    drivers/net/ixp2000/ixp2400_rx.uc \
  drivers/net/wan/wanxlfw.inc_shipped \
    drivers/net/wan/wanxlfw.S \
  drivers/net/wireless/atmel.c \
    drivers/net/wireless/atmel.c \
  drivers/scsi/53c700_d.h_shipped \
    drivers/scsi/53c700.scr \
  drivers/scsi/aic7xxx/aic79xx_seq.h_shipped \
    drivers/scsi/aic7xxx/aic79xx.seq \
  drivers/scsi/aic7xxx/aic7xxx_seq.h_shipped \
    drivers/scsi/aic7xxx/aic7xxx.seq \
  drivers/scsi/aic7xxx_old/aic7xxx_seq.c \
    drivers/scsi/aic7xxx_old/aic7xxx.seq \
  drivers/scsi/53c7xx_d.h_shipped \
    drivers/scsi/53c7xx.scr \
  drivers/scsi/sym53c8xx_2/sym_fw1.h \
    drivers/scsi/sym53c8xx_2/sym_fw1.h \
  drivers/scsi/sym53c8xx_2/sym_fw2.h \
    drivers/scsi/sym53c8xx_2/sym_fw2.h \
  firmware/dsp56k/bootstrap.bin.ihex \
    firmware/dsp56k/bootstrap.asm \
  firmware/keyspan_pda/keyspan_pda.HEX \
    firmware/keyspan_pda/keyspan_pda.S \
  firmware/keyspan_pda/xircom_pgs.HEX \
    firmware/keyspan_pda/xircom_pgs.S \
  sound/pci/cs46xx/imgs/cwcdma.h \
    sound/pci/cs46xx/imgs/cwcdma.asp \
; do
  if test ! $f; then
    die $f is not present, something is amiss
  fi
done

# Identify the tarball.
clean_sed "
s,^EXTRAVERSION.*,&-libre$extra,
" Makefile 'Adding -libre to EXTRAVERSION'

# Add reject_firmware and maybe_reject_firmware
cat >> include/linux/firwmare.h <<\EOF
#ifndef _LINUX_LIBRE_FIRMWARE_H
#define _LINUX_LIBRE_FIRMWARE_H

#define NONFREE_FIRMWARE "/*(DEBLOBBED)*/"

static inline int reject_firmware(const struct firmware **fw,
				  const char *name,
				  struct device *device)
{
	struct firmware *xfw = NULL;
	int retval = request_firmware(&xfw, NONFREE_FIRMWARE, device);
	if (!retval)
		release_firmware(xfw);
	return -EINVAL;
}
static inline int maybe_reject_firmware(const struct firmware **fw,
					const char *name,
					struct device *device)
{
	if (strstr (name, NONFREE_FIRMWARE))
		return reject_firmware(fw, name, device);
	else
		return request_firmware(fw, name, device);
}
static inline void discard_rejected_firmware(const struct firmware *fw,
					      void *context)
{
	release_firmware(fw);
}
static inline int reject_firmware_nowait(
	struct module *module, int uevent,
	const char *name, struct device *device, void *context,
	void (*cont)(const struct firmware *fw, void *context))
{
	int retval = request_firmware_nowait(module, uevent, NONFREE_FIRMWARE,
					     device, NULL,
					     discard_rejected_firmware);
	if (retval)
		return retval;
	return -EINVAL;
}
static inline int maybe_reject_firmware_nowait(
	struct module *module, int uevent,
	const char *name, struct device *device, void *context,
	void (*cont)(const struct firmware *fw, void *context))
{
	if (strstr (name, NONFREE_FIRMWARE))
		return reject_firmware_nowait(module, uevent, name,
					      device, context, cont);
	else
		return request_firmware_nowait(module, uevent, name,
					       device, context, cont);
}

#endif /* _LINUX_LIBRE_FIRMWARE_H */
EOF

#######################
# Removed ATM Drivers #
#######################

announce ATM_AMBASSADOR -  Madge Ambassador, Collage PCI 155 Server
reject_firmware drivers/atm/ambassador.c
clean_blob drivers/atm/ambassador.c
clean_fw firmware/atmsar11.HEX firmware/atmsar11.fw
clean_kconfig drivers/atm/Kconfig 'ATM_AMBASSADOR'
clean_mk CONFIG_ATM_AMBASSADOR drivers/atm/Makefile

announce ATM_FORE200E_PCA, ATM_FORE200E_SBA - SBA-200E
reject_firmware drivers/atm/fore200e.c
clean_blob drivers/atm/fore200e.c
clean_blob Documentation/networking/fore200e.txt
clean_kconfig drivers/atm/Kconfig 'ATM_FORE.*'
clean_mk CONFIG_ATM_FORE200E drivers/atm/Makefile


########################
# Removed char Drivers #
########################

announce COMPUTONE - Computone IntelliPort Plus serial
drop_fw_file firmware/intelliport2.bin.ihex firmware/intelliport2.bin
reject_firmware drivers/char/ip2/ip2main.c
clean_blob drivers/char/ip2/ip2main.c
clean_kconfig drivers/char/Kconfig 'COMPUTONE'
clean_mk CONFIG_COMPUTONE drivers/char/Makefile

# gpu drm

announce DRM_MGA - Matrox g200/g400
clean_blob drivers/gpu/drm/mga/mga_ucode.h
clean_blob drivers/gpu/drm/mga/mga_warp.c
clean_kconfig drivers/gpu/drm/Kconfig 'DRM_MGA'
clean_mk CONFIG_DRM_MGA drivers/gpu/drm/Makefile

announce DRM_R128 - ATI Rage 128
clean_sed '
/^static int r128_do_init_cce(/,/^}$/{
  /^	r128_cce_load_microcode(dev_priv);$/{
    i\
	DRM_ERROR("Missing Free microcode!\\n");\
	dev->dev_private = (void *)dev_priv;\
	r128_do_cleanup_cce(dev);\
	return -EINVAL;
  }
}' drivers/gpu/drm/r128/r128_cce.c 'report missing Free microcode'
clean_blob drivers/gpu/drm/r128/r128_cce.c
clean_kconfig drivers/gpu/drm/Kconfig 'DRM_R128'
clean_mk CONFIG_DRM_R128 drivers/gpu/drm/Makefile

announce DRM_RADEON - ATI Radeon
clean_sed '
/^static int radeon_do_init_cce(/,/^}$/{
  /^	radeon_cp_load_microcode(dev_priv);$/{
    i\
	DRM_ERROR("Missing Free microcode!\\n");\
	radeon_do_cleanup_cp(dev);\
	return -EINVAL;
  }
}
/^static int radeon_do_resume_cp(/,/^}$/{
  /^	radeon_cp_load_microcode(dev_priv);$/{
    i\
	DRM_ERROR("Missing Free microcode!\\n");\
	return -EINVAL;
  }
}' drivers/gpu/drm/radeon/radeon_cp.c 'report missing Free microcode'
clean_blob drivers/gpu/drm/radeon/radeon_microcode.h
clean_kconfig drivers/gpu/drm/Kconfig 'DRM_RADEON'
clean_mk CONFIG_DRM_RADEON drivers/gpu/drm/Makefile


#########################
# Removed Media Drivers #
#########################


announce DVB non-Free firmware scripts and documentation
clean_blob Documentation/dvb/get_dvb_firmware
clean_blob Documentation/dvb/avermedia.txt
clean_blob Documentation/dvb/opera-firmware.txt
clean_blob Documentation/dvb/ttusb-dec.txt

announce DVB_USB_AF9005 - Afatech AF9005 DVB-T USB1.1
clean_file drivers/media/dvb/dvb-usb/af9005-script.h
clean_sed '
s,^	deb_info("load init script\\n");$,	{\n		err("Missing Free init script\\n");\n		return scriptlen = ret = -EINVAL;\n		,;
' drivers/media/dvb/dvb-usb/af9005-fe.c 'report missing Free init script'
clean_blob drivers/media/dvb/dvb-usb/af9005-fe.c
clean_kconfig drivers/media/dvb/dvb-usb/Kconfig 'DVB_USB_AF9005'
clean_mk CONFIG_DVB_USB_AF9005 drivers/media/dvb/dvb-usb/Makefile

# dvb/frontends

announce DVB_SP8870 - Spase sp8870
clean_sed '
s,SP8870_DEFAULT_FIRMWARE,NONFREE_FIRMWARE,g
' drivers/media/dvb/frontends/sp8870.c 'disable non-Free firmware'
clean_blob drivers/media/dvb/frontends/sp8870.c
clean_kconfig drivers/media/dvb/frontends 'DVB_SP8870'
clean_mk CONFIG_DVB_SP8870 drivers/media/dvb/frontends/Makefile

announce DVB_TDA1004X - Philips TDA10045H/TDA10046H
clean_sed '
s,TDA1004[56]_DEFAULT_FIRMWARE,NONFREE_FIRMWARE,g
' drivers/media/dvb/frontends/tda1004x.c 'disable non-Free firmware'
clean_blob drivers/media/dvb/frontends/tda1004x.c
clean_kconfig drivers/media/dvb/frontends 'DVB_TDA1004X'
clean_mk CONFIG_DVB_TDA1004X drivers/media/dvb/frontends/Makefile

# dvb/ttpci

announce DVB_AV7110 - AV7110 cards
# The bootcode is actually Free Software under GPLv2, but since it's
# being distributed without source code, we're taking it out for now.
clean_sed '
s,^	\/\* boot \*\/$,	printk(KERN_ERR "dvb-ttpci: av7110_bootarm(): Missing Free bootcode\\n");\n	return -EINVAL;\n\n&,
' drivers/media/dvb/ttpci/av7110_hw.c 'report missing Free bootcode'
clean_sed '
s,mwdebi(.*bootcode.*$,/* & */,
' drivers/media/dvb/ttpci/av7110_hw.c 'adjust bootcode loader'
clean_blob drivers/media/dvb/ttpci/av7110_hw.c
clean_sed '
/^static int get_firmware(/,/^}$/s, request_firmware(, reject_firmware(,
' drivers/media/dvb/ttpci/av7110.c 'report missing Free firwmare'
clean_sed '
/^static int alps_tdlb7_request_firmware(/,/^}$/s, request_firmware(, maybe_reject_firmware(,
' drivers/media/dvb/ttpci/av7110.c 'accept Free firmware'
clean_blob drivers/media/dvb/ttpci/av7110.c
clean_kconfig drivers/media/dvb/ttpci/Kconfig 'DVB_AV7110'
clean_mk CONFIG_DVB_AV7110 drivers/media/dvb/ttpci/Makefile

announce DVB_BUDGET - Budget cards
clean_sed '
/^static int alps_tdhd1_204_request_firmware(/,/^}$/s, request_firmware(, maybe_reject_firmware(,
' drivers/media/dvb/ttpci/budget.c 'report missing Free firmware'

announce DVB_BUDGET_AV - Budget cards with analog video inputs
clean_sed '
/^static int philips_tu1216_request_firmware(/,/^}$/s, request_firmware(, maybe_reject_firmware(,
' drivers/media/dvb/ttpci/budget-av.c \
  'report missing Free firmware, accept Free firmware'

announce DVB_BUDGET_CI - Budget cards with onboard CI connector
clean_sed '
/^static int philips_tdm1316l_request_firmware(/,/^}$/s, request_firmware(, maybe_reject_firmware(,
' drivers/media/dvb/ttpci/budget-ci.c \
  'report missing Free firmware, accept Free firmware'

# dvb/ttusb-budget

announce DVB_TTUSB_BUDGET - Technotrend/Hauppauge Nova-USB devices
drop_fw_file firmware/ttusb-budget/dspbootcode.bin.ihex firmware/ttusb-budget/dspbootcode.bin
clean_sed '
/^static int philips_tdm1316l_request_firmware(/,/^}$/s, request_firmware(, maybe_reject_firmware(,
' drivers/media/dvb/ttusb-budget/dvb-ttusb-budget.c \
  'report missing Free firmware, accept Free firmware'
reject_firmware drivers/media/dvb/ttusb-budget/dvb-ttusb-budget.c
clean_blob drivers/media/dvb/ttusb-budget/dvb-ttusb-budget.c
clean_kconfig drivers/media/dvb/ttusb-budget/Kconfig 'DVB_TTUSB_BUDGET'
clean_mk CONFIG_DVB_TTUSB_BUDGET drivers/media/dvb/ttusb-budget/Makefile

# video

announce VIDEO_CPIA2 - CPiA2 Video For Linux
clean_fw firmware/cpia2/stv0672_vp4.bin.ihex firmware/cpia2/stv0672_vp4.bin
reject_firmware drivers/media/video/cpia2/cpia2_core.c
clean_blob drivers/media/video/cpia2/cpia2_core.c
clean_kconfig drivers/media/video/cpia2/Kconfig 'VIDEO_CPIA2'
clean_mk CONFIG_VIDEO_CPIA2 drivers/media/video/cpia2/Makefile

announce USB_DABUSB - DABUSB driver
clean_fw firmware/dabusb/bitstream.bin.ihex firmware/dabusb/bitstream.bin
clean_fw firmware/dabusb/firmware.HEX firmware/dabusb/firmware.fw
reject_firmware drivers/media/video/dabusb.c
clean_blob drivers/media/video/dabusb.c
clean_kconfig drivers/media/Kconfig 'USB_DABUSB'
clean_mk CONFIG_USB_DABUSB drivers/media/video/Makefile

# video/usbvideo

announce USB_VICAM - USB 3com HomeConnect, AKA vicam
drop_fw_file firmware/vicam/firmware.H16 firmware/vicam/firmware.fw
reject_firmware drivers/media/video/usbvideo/vicam.c
clean_blob drivers/media/video/usbvideo/vicam.c
clean_kconfig drivers/media/video/usbvideo/Kconfig 'USB_VICAM'
clean_mk CONFIG_USB_VICAM drivers/media/video/usbvideo/Makefile


#######################
# Removed net Drivers #
#######################

announce ACENIC - Alteon AceNIC/3Com 3C985/NetGear GA620 Gigabit
clean_blob drivers/net/acenic_firmware.h
clean_sed '
s,	\(ace_load_firmware[^;]*\),	if ((ecode = \1)) goto init_error,
' drivers/net/acenic.c 'check for error in firmware loading'
clean_sed '
/^static int __devinit ace_load_firmware(/,/^}$/ { /^}$/i\
}\
	printk(KERN_ERR "%s: Missing Free firwmare\\n", ap->name);\
	return -EINVAL;
}' drivers/net/acenic.c 'report missing Free firmware'
clean_blob drivers/net/acenic.c
clean_kconfig drivers/net/Kconfig 'ACENIC'
clean_mk CONFIG_ACENIC drivers/net/Makefile

announce ADAPTEC_STARFIRE - Adaptec Starfire/DuraLAN support
# This file requires prior acceptance of the GPL before you can even
# run the code in it.  It's not clear whether this is a further
# requirement that would make the distribution incompatible with the
# GPL, but since nothing remains after we remove the blob, it's
# irrelevant whether the explicit acceptance would be a problem.
clean_file drivers/net/starfire_firmware.h
clean_file drivers/net/starfire_firmware.pl
clean_sed '
/Load Rx\/Tx firmware/i\
	printk (KERN_ERR "%s: Missing Free firmware\\n", dev->name);\
	return -EINVAL;
' drivers/net/starfire.c 'report missing Free firmware'
clean_blob drivers/net/starfire.c
clean_kconfig drivers/net/Kconfig 'ADAPTEC_STARFIRE'
clean_mk CONFIG_ADAPTEC_STARFIRE drivers/net/Makefile

announce BNX2 - Broadcom NetXtremeII
clean_file drivers/net/bnx2_fw.h
clean_file drivers/net/bnx2_fw2.h
clean_sed '
/ bnx2_init_cpus(/i\
	printk (KERN_ERR "%s: Missing Free firmware\\n", bp->dev->name);\
	return -EINVAL;\
#define bnx2_init_cpus(bp) (-EINVAL)
' drivers/net/bnx2.c 'report missing Free firmware'
clean_blob drivers/net/bnx2.c
clean_kconfig drivers/net/Kconfig 'BNX2'
clean_mk CONFIG_BNX2 drivers/net/Makefile

announce BNX2X - Broadcom NetXtremeII 10Gb support
clean_blob drivers/net/bnx2x_init_values.h
clean_blob drivers/net/bnx2x_init.h
clean_sed '
/^#include "bnx2x_init\.h"/,/^$/ {/^$/i\
#define bnx2x_init_block(bp, start, end) \\\
  return printk(KERN_ERR PFX "%s: Missing Free firmware\\n", bp->dev->name),\
	 -EINVAL;
}' drivers/net/bnx2x_main.c 'report missing Free firmware'
clean_kconfig drivers/net/Kconfig 'BNX2X'
clean_mk CONFIG_BNX2X drivers/net/Makefile

announce CASSINI - Sun Cassini
drop_fw_file firmware/sun/cassini.bin.ihex firmware/sun/cassini.bin
reject_firmware drivers/net/cassini.c
clean_blob drivers/net/cassini.c
clean_kconfig drivers/net/Kconfig 'CASSINI'
clean_mk CONFIG_CASSINI drivers/net/Makefile

announce CHELSIO_T3 - Chelsio AEL 2005 support
clean_sed '
/^static int ael2005_setup_\(sr\|twinax\)_edc(/,/^}$/ {
  /for.*ARRAY_SIZE(\(sr\|twinax\)_edc)/i\
}\
	CH_ERR(phy->adapter, "Missing Free firwmare\\n");\
	err = -EINVAL;
}' drivers/net/cxgb3/ael1002.c 'report missing Free firmware'
clean_blob drivers/net/cxgb3/ael1002.c
clean_kconfig drivers/net/Kconfig 'CHELSIO_T3'
clean_mk CONFIG_CHELSIO_T3 drivers/net/cxgb3/Makefile

announce E100 - Intel PRO/100+
clean_sed '
/^static void e100_setup_ucode(/,/^}$/ {
  /^	} ucode_opts\[\] = {$/,/^	}[,;]/ {
    s,D[^,]*_RCVBUNDLE_UCODE,/*DEBLOBBED*/{0},g;
    s,D[^,]*_CPUSAVER_\(TIMER\|BUNDLE\|MIN_SIZE\)_DWORD,/*DEBLOBBED*/0,g;
  }
  /^	for ([^;]*ucode_opts[^{]*) {$/,/^	}$/ {
    /^	}$/ i\
	}\
		DPRINTK(DRV, ERR, "Missing Free firmware\\n");\
		/* ??? We should error out somehow.  */\
		goto noloaducode;
  }
}
' drivers/net/e100.c 'report missing Free firmware for some variants'
clean_blob drivers/net/e100.c
clean_kconfig drivers/net/Kconfig 'E100'
clean_mk CONFIG_E100 drivers/net/Makefile

announce MYRI_SBUS - MyriCOM Gigabit Ethernet
clean_file drivers/net/myri_code.h
clean_sed '
/myri_load_lanai.*;/i\
	printk(KERN_ERR "Missing Free firmware\\n");\
	goto err_free_irq;
' drivers/net/myri_sbus.c 'report missing Free firmware'
clean_blob drivers/net/myri_sbus.c
clean_kconfig drivers/net/Kconfig 'MYRI_SBUS'
clean_mk CONFIG_MYRI_SBUS drivers/net/Makefile

announce TEHUTI - Tehuti Networks 10G Ethernet
clean_blob drivers/net/tehuti_fw.h
clean_sed '
/bdx_tx_push_desc_safe.*s_firmLoad.*/i\
		ERR("%s: Missing Free firmware\\n", priv->ndev->name);\
		RET(-EINVAL);
' drivers/net/tehuti.c 'report missing Free firmware'
clean_blob drivers/net/tehuti.c
clean_kconfig drivers/net/Kconfig 'TEHUTI'
clean_mk CONFIG_TEHUTI drivers/net/Makefile

announce TIGON3 - Broadcom Tigon3
clean_sed '
s,\&tg3\(Tso5\?\)\?Fw\(Text\|Rodata\|Data\)\[0\],NULL,;
/^static int tg3_load_firmware_cpu(/,/^}/{
  /^	err = 0;/i\
	printk(KERN_ERR PFX "Missing Free firmware for %s, hoping it works anyway\\n",\
	       tp->dev->name);
}' drivers/net/tg3.c 'report missing Free firmware, proceed without it'
clean_blob drivers/net/tg3.c
clean_kconfig drivers/net/Kconfig 'TIGON3'
clean_mk CONFIG_TIGON3 drivers/net/Makefile

announce TYPHOON - 3cr990 series Typhoon
clean_blob drivers/net/typhoon-firmware.h
clean_sed '
/^typhoon_download_firmware(/,/^}/{
  /typhoon_firmware_image/{
    i\
	printk(KERN_ERR "%s: Missing Free firmware\\n", tp->name);\
	err = -EINVAL;\
	goto err_out;
    d;
  }
}' drivers/net/typhoon.c 'report missing Free firmware'
clean_kconfig drivers/net/Kconfig 'TYPHOON'
clean_mk CONFIG_TYPHOON drivers/net/Makefile

# appletalk

announce COPS - COPS LocalTalk PC
clean_sed '
/sizeof(\(ff\|lt\)drv_code)/i\
		printk(KERN_INFO "%s: Missing Free firmware.\\n", dev->name);\
		return;
/\(ff\|lt\)drv_code/d;
' drivers/net/appletalk/cops.c 'report missing Free firmware'
clean_blob drivers/net/appletalk/cops.c
clean_file drivers/net/appletalk/cops_ffdrv.h
clean_file drivers/net/appletalk/cops_ltdrv.h
clean_kconfig drivers/net/appletalk/Kconfig 'COPS'
clean_mk CONFIG_COPS drivers/net/appletalk/Makefile

# hamradio

announce YAM - YAM driver for AX.25
clean_file drivers/net/hamradio/yam1200.h
clean_file drivers/net/hamradio/yam9600.h
clean_sed '
/add_mcs(bits_\(12\|96\)00, bitrate)/{
  i\
		printk(KERN_ERR "yam: Missing Free firmware\\n");
  s:add_mcs(bits_\(12\|96\)00, bitrate):NULL:
}' drivers/net/hamradio/yam.c 'report missing Free firmware'
clean_blob drivers/net/hamradio/yam.c
clean_kconfig drivers/net/hamradio/Kconfig 'YAM'
clean_mk CONFIG_YAM drivers/net/hamradio/Makefile

# pcmcia

announce PCMCIA_SMC91C92 - SMC 91Cxx PCMCIA
clean_blob drivers/net/pcmcia/ositech.h
clean_sed '
/^osi_setup(/,/^}/{
  s/^\(.*\)[/][*] Download.*firmware [*][/]/\1printk(KERN_ERR "%s: Missing Free firmware\\n", dev->name);\n\1rc = -EINVAL;\n\1goto free_cfg_mem;/
}' drivers/net/pcmcia/smc91c92_cs.c 'report missing Free firmware'
clean_sed '/^smc9192_resume(/,/^}/{
  s/^\(.*\)[/][*] Download.*firmware [*][/]/\1printk(KERN_ERR "%s: Missing Free firmware\\n", dev->name);\n\1return -EINVAL;/
}' drivers/net/pcmcia/smc91c92_cs.c 'report another missing Free firmware'
clean_kconfig drivers/net/pcmcia/Kconfig 'PCMCIA_SMC91C92'
clean_mk CONFIG_PCMCIA_SMC91C92 drivers/net/pcmcia/Makefile


# tokenring

announce 3C359 - 3Com 3C359 Token Link Velocity XL adapter
clean_file drivers/net/tokenring/3c359_microcode.h
clean_sed '
/^xl_hw_reset(/,/^}/{
  /printk.*Uploading Microcode/i\
		printk(KERN_ERR "%s: Missing Free firmware\\n", dev->name);\
		return -EINVAL;
}' drivers/net/tokenring/3c359.c 'report missing Free firmware'
clean_blob drivers/net/tokenring/3c359.c
clean_kconfig drivers/net/tokenring/Kconfig '3C359'
clean_mk CONFIG_3C359 drivers/net/tokenring/Makefile

# SMCTR - SMC ISA/MCA adapter
drop_fw_file firmware/tr_smctr.bin.ihex firmware/tr_smctr.bin
reject_firmware drivers/net/tokenring/smctr.c
clean_blob drivers/net/tokenring/smctr.c
clean_kconfig drivers/net/tokenring/Kconfig 'SMCTR'
clean_mk CONFIG_SMCTR drivers/net/tokenring/Makefile

# usb

announce USB_KAWETH - USB KLSI KL5USB101-based ethernet device support
drop_fw_file firmware/kaweth/new_code.bin.ihex firmware/kaweth/new_code.bin
drop_fw_file firmware/kaweth/new_code_fix.bin.ihex firmware/kaweth/new_code_fix.bin
drop_fw_file firmware/kaweth/trigger_code.bin.ihex firmware/kaweth/trigger_code.bin
drop_fw_file firmware/kaweth/trigger_code_fix.bin.ihex firmware/kaweth/trigger_code_fix.bin
reject_firmware drivers/net/usb/kaweth.c
clean_blob drivers/net/usb/kaweth.c
clean_kconfig drivers/net/usb/Kconfig 'USB_KAWETH'
clean_mk CONFIG_USB_KAWETH drivers/net/usb/Makefile

# wireless

announce HERMES - Hermes chipset 802.11b support "(Orinoco/Prism2/Symbol)"
reject_firmware drivers/net/wireless/orinoco.c
clean_blob drivers/net/wireless/orinoco.c
clean_kconfig drivers/net/wireless/Kconfig 'HERMES'
clean_mk CONFIG_HERMES drivers/net/wireless/Makefile


########################
# Removed SCSI Drivers #
########################

announce SCSI_QLOGICPTI - PTI Qlogic, ISP Driver
clean_file drivers/scsi/qlogicpti_asm.c
clean_sed '
/^static int __devinit qlogicpti_load_firmware(/,/^}$/{
  /[&]sbus_risc_code01/i\
	printk(KERN_ERR "qlogicpti%d: Missing Free firmware\\n", qpti->qpti_id);\
	return -EINVAL;
  s,[&]sbus_risc_code01\[0\],NULL,
  s,sbus_risc_code_length01,0,
}' drivers/scsi/qlogicpti.c 'report missing Free firmware'
clean_blob drivers/scsi/qlogicpti.c
clean_kconfig drivers/scsi/Kconfig 'SCSI_QLOGICPTI'
clean_mk CONFIG_SCSI_QLOGICPTI drivers/scsi/Makefile

announce SCSI_ADVANSYS - AdvanSys SCSI
clean_sed '
/ASC_DBG.*_asc_mcode_chksum);/d;
/^\(static ASC_CNT \)\?AscLoadMicroCode(/,/^}$/ {
  /^}$/{p;i\
#define AscLoadMicroCode(x1,x2,x3,x4) ((x1),(x2),(x3),(x4),printk(KERN_ERR "advansys: Missing Free firmware\\n"), -1)
    d;
  }
}
/^\(static int \)\?AdvLoadMicrocode(/,/^}$/ {
  /^}$/{p;i\
#define AdvLoadMicrocode(x1,x2,x3,x4,x5) ((x1),(x2),(x3),(x4),(x5),printk(KERN_ERR "advansys: Missing Free firmware\\n"), ASC_IERR_MCODE_CHKSUM)
    d;
  }
}
s/\([ 	(]\)_\(asc_mcode\|adv_asc3\(550\|8C\(08\|16\)00\)\)_buf,/\1NULL,/;
s/\([ 	]\)_\(asc_mcode\|adv_asc3\(550\|8C\(08\|16\)00\)\)_size\([,)]\)/\1(unsigned short)0\5/;
s/\([ 	]\)_\(asc_mcode\|adv_asc3\(550\|8C\(08\|16\)00\)\)_chksum\([,)]\)/\1(ADV_DCNT)0\5/;
' drivers/scsi/advansys.c 'report missing Free firmware'
clean_blob drivers/scsi/advansys.c
clean_kconfig drivers/scsi/Kconfig 'SCSI_ADVANSYS'
clean_mk CONFIG_SCSI_ADVANSYS drivers/scsi/Makefile

announce SCSI_QLOGIC_1280 - Qlogic QLA 1240/1x80/1x160 SCSI
clean_blob drivers/scsi/ql1280_fw.h
clean_blob drivers/scsi/ql1040_fw.h
clean_blob drivers/scsi/ql12160_fw.h
clean_sed '
s,[&]\(fw12\(160\|80e\)i\|risc\(_code\)\?\)_\(code01\[0\]\|length01\),NULL,g;
/^qla1280_load_firmware\(_pio\)\?(/,/^}$/{
  /risc_code_size = [*]/ {
    i\
	if (!risc_code_address) {\
		printk(KERN_ERR "scsi(%li): Missing Free firmware\\n", ha->host_no);\
		return -EINVAL;\
	}
  }
}
/^qla1280_load_firmware_dma(/,/^}$/{
  /risc_code_size = [*]/ {
    i\
	if (!risc_code_address) {\
		printk(KERN_ERR "scsi(%li): Missing Free firmware\\n", ha->host_no);\
		err = -EINVAL;\
		goto out;\
	}
  }
}' drivers/scsi/qla1280.c 'report missing Free firmware'
clean_kconfig drivers/scsi/Kconfig 'SCSI_QLOGIC_1280'
clean_mk CONFIG_SCSI_QLOGIC_1280 drivers/scsi/Makefile


#######################
# Removed USB Drivers #
#######################

# misc

announce USB_EMI26 - EMI "2|6" USB Audio interface
# These files are not under the GPL, better remove them all.
drop_fw_file firmware/emi26/bitstream.HEX firmware/emi26/bitstream.fw
drop_fw_file firmware/emi26/firmware.HEX firmware/emi26/firmware.fw
drop_fw_file firmware/emi26/loader.HEX firmware/emi26/loader.fw
reject_firmware drivers/usb/misc/emi26.c
clean_blob drivers/usb/misc/emi26.c
clean_kconfig drivers/usb/misc/Kconfig 'USB_EMI26'
clean_mk CONFIG_USB_EMI26 drivers/usb/misc/Makefile

announce USB_EMI62 - EMI "6|2m" USB Audio interface
# These files are probably not under the GPL, better remove them all.
drop_fw_file firmware/emi62/bitstream.HEX firmware/emi62/bitstream.fw
drop_fw_file firmware/emi62/loader.HEX firmware/emi62/loader.fw
drop_fw_file firmware/emi62/midi.HEX firmware/emi62/midi.fw
drop_fw_file firmware/emi62/spdif.HEX firmware/emi62/spdif.fw
reject_firmware drivers/usb/misc/emi62.c
clean_blob drivers/usb/misc/emi62.c
clean_kconfig drivers/usb/misc/Kconfig 'USB_EMI62'
clean_mk CONFIG_USB_EMI62 drivers/usb/misc/Makefile

# serial

announce USB_SERIAL_KEYSPAN - USB Keyspan USA-xxx Serial Driver
drop_fw_file firmware/keyspan/mpr.HEX firmware/keyspan/mpr.fw
clean_kconfig drivers/usb/serial/Kconfig 'USB_SERIAL_KEYSPAN_MPR'
drop_fw_file firmware/keyspan/usa18x.HEX firmware/keyspan/usa18x.fw
clean_kconfig drivers/usb/serial/Kconfig 'USB_SERIAL_KEYSPAN_USA18X'
drop_fw_file firmware/keyspan/usa19.HEX firmware/keyspan/usa19.fw
clean_kconfig drivers/usb/serial/Kconfig 'USB_SERIAL_KEYSPAN_USA19'
drop_fw_file firmware/keyspan/usa19qi.HEX firmware/keyspan/usa19qi.fw
clean_kconfig drivers/usb/serial/Kconfig 'USB_SERIAL_KEYSPAN_USA19QI'
drop_fw_file firmware/keyspan/usa19qw.HEX firmware/keyspan/usa19qw.fw
clean_kconfig drivers/usb/serial/Kconfig 'USB_SERIAL_KEYSPAN_USA19QW'
drop_fw_file firmware/keyspan/usa19w.HEX firmware/keyspan/usa19w.fw
clean_kconfig drivers/usb/serial/Kconfig 'USB_SERIAL_KEYSPAN_USA19W'
drop_fw_file firmware/keyspan/usa28.HEX firmware/keyspan/usa28.fw
clean_kconfig drivers/usb/serial/Kconfig 'USB_SERIAL_KEYSPAN_USA28'
drop_fw_file firmware/keyspan/usa28xa.HEX firmware/keyspan/usa28xa.fw
clean_kconfig drivers/usb/serial/Kconfig 'USB_SERIAL_KEYSPAN_USA28XA'
drop_fw_file firmware/keyspan/usa28xb.HEX firmware/keyspan/usa28xb.fw
clean_kconfig drivers/usb/serial/Kconfig 'USB_SERIAL_KEYSPAN_USA28XB'
drop_fw_file firmware/keyspan/usa28x.HEX firmware/keyspan/usa28x.fw
clean_kconfig drivers/usb/serial/Kconfig 'USB_SERIAL_KEYSPAN_USA28X'
drop_fw_file firmware/keyspan/usa49w.HEX firmware/keyspan/usa49w.fw
clean_kconfig drivers/usb/serial/Kconfig 'USB_SERIAL_KEYSPAN_USA49W'
drop_fw_file firmware/keyspan/usa49wlc.HEX firmware/keyspan/usa49wlc.fw
clean_kconfig drivers/usb/serial/Kconfig 'USB_SERIAL_KEYSPAN_USA49WLC'
reject_firmware drivers/usb/serial/keyspan.c
clean_blob drivers/usb/serial/keyspan.c
clean_kconfig drivers/usb/serial/Kconfig 'USB_SERIAL_KEYSPAN'
clean_mk CONFIG_USB_SERIAL_KEYSPAN drivers/usb/serial/Makefile

announce USB_SERIAL_KEYSPAN_PDA - USB Keyspan PDA Single Port Serial Driver
clean_sed '
s,request_ihex_firmware,/*KEYSPAN_PDA*/&,
' drivers/usb/serial/keyspan_pda.c 'accepting Free firmware'

announce USB_SERIAL_EDGEPORT - USB Inside Out Edgeport Serial Driver
clean_fw firmware/edgeport/boot.H16 firmware/edgeport/boot.fw
clean_fw firmware/edgeport/boot2.H16 firmware/edgeport/boot2.fw
clean_fw firmware/edgeport/down.H16 firmware/edgeport/down.fw
clean_fw firmware/edgeport/down2.H16 firmware/edgeport/down2.fw
reject_firmware drivers/usb/serial/io_edgeport.c
clean_blob drivers/usb/serial/io_edgeport.c
clean_kconfig drivers/usb/serial/Kconfig 'USB_SERIAL_EDGEPORT'
clean_mk CONFIG_USB_SERIAL_EDGEPORT drivers/usb/serial/Makefile

announce USB_SERIAL_EDGEPORT_TI - USB Inside Out Edgeport Serial Driver "(TI devices)"
clean_fw firmware/edgeport/down3.bin.ihex firmware/edgeport/down3.bin
reject_firmware drivers/usb/serial/io_ti.c
clean_blob drivers/usb/serial/io_ti.c
clean_kconfig drivers/usb/serial/Kconfig 'USB_SERIAL_EDGEPORT_TI'
clean_mk CONFIG_USB_SERIAL_EDGEPORT_TI drivers/usb/serial/Makefile

announce USB_SERIAL_TI - USB TI 3410/5052 Serial Driver
drop_fw_file firmware/ti_3410.fw.ihex firmware/ti_3410.fw
drop_fw_file firmware/ti_5052.fw.ihex firmware/ti_5052.fw
reject_firmware drivers/usb/serial/ti_usb_3410_5052.c
clean_blob drivers/usb/serial/ti_usb_3410_5052.c
clean_kconfig drivers/usb/serial/Kconfig 'USB_SERIAL_TI'
clean_mk CONFIG_USB_SERIAL_TI drivers/usb/serial/Makefile

announce USB_SERIAL_WHITEHEAT - USB ConnectTech WhiteHEAT Serial Driver
clean_fw firmware/whiteheat.HEX firmware/whiteheat.fw
clean_fw firmware/whiteheat_loader.HEX firmware/whiteheat_loader.fw
clean_fw firmware/whiteheat_loader_debug.HEX firmware/whiteheat_loader_debug.fw
reject_firmware drivers/usb/serial/whiteheat.c
clean_blob drivers/usb/serial/whiteheat.c
clean_kconfig drivers/usb/serial/Kconfig 'USB_SERIAL_WHITEHEAT'
clean_mk CONFIG_USB_SERIAL_WHITEHEAT drivers/usb/serial/Makefile


#########################
# Removed Sound Drivers #
#########################

announce SND_CS46XX - Cirrus Logic "(Sound Fusion)" CS4280/CS461x/CS462x/CS463x
# This appears to have been extracted from some non-Free driver
clean_file sound/pci/cs46xx/cs46xx_image.h
# The following blobs are definitely extracted from non-Free drivers.
clean_file sound/pci/cs46xx/imgs/cwc4630.h
clean_file sound/pci/cs46xx/imgs/cwcasync.h
clean_file sound/pci/cs46xx/imgs/cwcsnoop.h
clean_sed '
/^\(int \)\?snd_cs46xx_download_image(/,/^}$/{
  /for.*BA1_MEMORY_COUNT/i\
#if 0
  /^}$/{i\
#else\
	snd_printk(KERN_ERR "cs46xx: Missing Free firmware\\n");\
	return -EINVAL;\
#endif
  }
}
s/cs46xx_dsp_load_module(chip, [&]cwc\(4630\|async\|snoop\)_module)/(snd_printk(KERN_ERR "cs46xx: Missing Free firmware\\n"),-EINVAL)/
' sound/pci/cs46xx/cs46xx_lib.c 'report missing Free firmware'
clean_blob sound/pci/cs46xx/cs46xx_lib.c
clean_kconfig sound/pci/Kconfig 'SND_CS46XX'
clean_mk 'CONFIG_SND_CS46XX' sound/pci/cs46xx/Makefile

announce SND_KORG1212 - Korg 1212 IO
drop_fw_file firmware/korg/k1212.dsp.ihex firmware/korg/k1212.dsp
reject_firmware sound/pci/korg1212/korg1212.c
clean_blob sound/pci/korg1212/korg1212.c
clean_kconfig sound/pci/Kconfig 'SND_KORG1212'
clean_mk 'CONFIG_SND_KORG1212' sound/pci/korg1212/Makefile

announce SND_MAESTRO3 - ESS Allegro/Maestro3
drop_fw_file firmware/ess/maestro3_assp_kernel.fw.ihex firmware/ess/maestro3_assp_kernel.fw
drop_fw_file firmware/ess/maestro3_assp_minisrc.fw.ihex firmware/ess/maestro3_assp_minisrc.fw
reject_firmware sound/pci/maestro3.c
clean_blob sound/pci/maestro3.c
clean_kconfig sound/pci/Kconfig 'SND_MAESTRO3'
clean_mk 'CONFIG_SND_MAESTRO3' sound/pci/Makefile

announce SND_YMFPCI - Yamaha YMF724/740/744/754
drop_fw_file firmware/yamaha/ds1_ctrl.fw.ihex firmware/yamaha/ds1_ctrl.fw
drop_fw_file firmware/yamaha/ds1_dsp.fw.ihex firmware/yamaha/ds1_dsp.fw
drop_fw_file firmware/yamaha/ds1e_ctrl.fw.ihex firmware/yamaha/ds1e_ctrl.fw
reject_firmware sound/pci/ymfpci/ymfpci_main.c
clean_blob sound/pci/ymfpci/ymfpci_main.c
clean_kconfig sound/pci/Kconfig 'SND_YMFPCI'
clean_mk 'CONFIG_SND_YMFPCI' sound/pci/ymfpci/Makefile

announce SND_SB16_CSP_FIRMWARE_IN_KERNEL - SB16 Advanced Signal Processor
drop_fw_file firmware/sb16/alaw_main.csp.ihex firmware/sb16/alaw_main.csp
drop_fw_file firmware/sb16/mulaw_main.csp.ihex firmware/sb16/mulaw_main.csp
drop_fw_file firmware/sb16/ima_adpcm_init.csp.ihex firmware/sb16/ima_adpcm_init.csp
drop_fw_file firmware/sb16/ima_adpcm_capture.csp.ihex firmware/sb16/ima_adpcm_capture.csp
drop_fw_file firmware/sb16/ima_adpcm_playback.csp.ihex firmware/sb16/ima_adpcm_playback.csp
reject_firmware sound/isa/sb/sb16_csp.c
clean_blob sound/isa/sb/sb16_csp.c
clean_kconfig sound/isa/Kconfig 'SND_SB16_CSP'
clean_mk 'CONFIG_SND_SB16_CSP' sound/isa/sb/Makefile

announce SND_WAVEFRONT - Turtle Beach Maui,Tropez,Tropez+" (Wavefront)"
clean_blob sound/isa/wavefront/yss225.c
clean_sed '
/firmware = &yss225_registers_firmware/i\
	snd_printk(KERN_ERR "FX: Missing Free firmware\\n");\
	err = -EINVAL;\
	goto out;
' sound/isa/wavefront/wavefront_fx.c 'report missing Free firmware'
reject_firmware sound/isa/wavefront/wavefront_fx.c
clean_blob sound/isa/wavefront/wavefront_fx.c
reject_firmware sound/isa/wavefront/wavefront_synth.c
clean_blob sound/isa/wavefront/wavefront_synth.c
clean_kconfig sound/isa/Kconfig 'SND_WAVEFRONT_FIRMWARE_IN_KERNEL'
clean_kconfig sound/isa/Kconfig 'SND_WAVEFRONT'
clean_mk 'CONFIG_SND_WAVEFRONT' sound/isa/wavefront/Makefile


###########################
# Removed Staging Drivers #
###########################

# ME4000 - Meilhaus ME-4000 I/O board
clean_file drivers/staging/me4000/me4000_firmware.h
clean_file drivers/staging/me4000/me4610_firmware.h
clean_kconfig drivers/staging/me4000/Kconfig 'ME4000'
clean_mk CONFIG_ME4000 drivers/staging/me4000/Makefile

# SLICOSS - Alacritech Gigabit IS-NIC cards
clean_blob drivers/staging/slicoss/gbdownload.h
clean_blob drivers/staging/slicoss/oasisdownload.h
clean_blob drivers/staging/slicoss/oasisdbgdownload.h
clean_blob drivers/staging/slicoss/gbrcvucode.h
clean_blob drivers/staging/slicoss/oasisrcvucode.h
clean_kconfig drivers/staging/slicoss/Kconfig 'SLICOSS'
clean_mk CONFIG_SLICOSS drivers/staging/slicoss/Makefile

# SXG - Alacritech SLIC Technology Non-Accelerated 10Gbe cards
clean_blob drivers/staging/sxg/saharadbgdownload.h
clean_blob drivers/staging/sxg/sxgphycode.h
clean_kconfig drivers/staging/sxg/Kconfig 'SXG'
clean_mk CONFIG_SXG drivers/staging/sxg/Makefile

exit 0