[mirror_ubuntu-zesty-kernel.git] / firmware / Makefile

#
# kbuild file for firmware/
#

# Create $(fwabs) from $(CONFIG_EXTRA_FIRMWARE_DIR) -- if it doesn't have a
# leading /, it's relative to $(srctree).
fwdir := $(subst $(quote),,$(CONFIG_EXTRA_FIRMWARE_DIR))
fwabs := $(addprefix $(srctree)/,$(filter-out /%,$(fwdir)))$(filter /%,$(fwdir))

fw-external-y := $(subst $(quote),,$(CONFIG_EXTRA_FIRMWARE))

# There are three cases to care about:
# 1. Building kernel with CONFIG_FIRMWARE_IN_KERNEL=y -- $(fw-shipped-y) should
#    include the firmware files to include, according to .config
# 2. 'make modules_install', which will install firmware for modules, and 
#    _also_ for the in-kernel drivers when CONFIG_FIRMWARE_IN_KERNEL=n
# 3. 'make firmware_install', which installs all firmware, unconditionally.

# For the former two cases we want $(fw-shipped-y) and $(fw-shipped-m) to be
# accurate. In the latter case it doesn't matter -- it'll use $(fw-shipped-all).
# But be aware that the config file might not be included at all.

fw-shipped-$(CONFIG_BNX2X) += bnx2x/bnx2x-e1-7.13.1.0.fw \
			      bnx2x/bnx2x-e1h-7.13.1.0.fw \
			      bnx2x/bnx2x-e2-7.13.1.0.fw
fw-shipped-$(CONFIG_BNX2) += 	bnx2/bnx2-mips-09-6.2.1b.fw \
				bnx2/bnx2-rv2p-06-6.0.15.fw \
				bnx2/bnx2-mips-06-6.2.3.fw \
				bnx2/bnx2-rv2p-09-6.0.17.fw \
				bnx2/bnx2-rv2p-09ax-6.0.17.fw
fw-shipped-$(CONFIG_E100) += e100/d101m_ucode.bin e100/d101s_ucode.bin \
			     e100/d102e_ucode.bin
fw-shipped-$(CONFIG_PCMCIA_PCNET) += 
				     
fw-shipped-$(CONFIG_PCMCIA_3C589) += 
fw-shipped-$(CONFIG_PCMCIA_3C574) += 
fw-shipped-$(CONFIG_SERIAL_8250_CS) +=
				       
fw-shipped-$(CONFIG_SCSI_QLOGIC_1280) += qlogic/1040.bin qlogic/1280.bin \
					 qlogic/12160.bin
fw-shipped-$(CONFIG_SCSI_QLOGICPTI) += qlogic/isp1000.bin
fw-shipped-$(CONFIG_INFINIBAND_QIB) += qlogic/sd7220.fw
fw-shipped-$(CONFIG_SND_KORG1212) += korg/k1212.dsp
fw-shipped-$(CONFIG_SND_SB16_CSP) += sb16/mulaw_main.csp sb16/alaw_main.csp \
				     sb16/ima_adpcm_init.csp \
				     sb16/ima_adpcm_playback.csp \
				     sb16/ima_adpcm_capture.csp
fw-shipped-$(CONFIG_SND_WAVEFRONT) += yamaha/yss225_registers.bin
fw-shipped-$(CONFIG_TIGON3) += tigon/tg3.bin tigon/tg3_tso.bin \
			       tigon/tg3_tso5.bin
fw-shipped-$(CONFIG_TYPHOON) += 3com/typhoon.bin
fw-shipped-$(CONFIG_USB_EMI26) += emi26/loader.fw emi26/firmware.fw \
				  emi26/bitstream.fw
fw-shipped-$(CONFIG_USB_EMI62) += emi62/loader.fw emi62/bitstream.fw \
				  emi62/spdif.fw emi62/midi.fw
fw-shipped-$(CONFIG_USB_SERIAL_WHITEHEAT) += whiteheat_loader.fw whiteheat.fw \
					   # whiteheat_loader_debug.fw

fw-shipped-all := $(fw-shipped-y) $(fw-shipped-m) $(fw-shipped-)

quiet_cmd_ihex  = IHEX    $@
      cmd_ihex  = $(OBJCOPY) -Iihex -Obinary $< $@

quiet_cmd_ihex2fw  = IHEX2FW $@
      cmd_ihex2fw  = $(objtree)/$(obj)/ihex2fw $< $@

quiet_cmd_h16tofw  = H16TOFW $@
      cmd_h16tofw  = $(objtree)/$(obj)/ihex2fw -w $< $@

quiet_cmd_fwbin = MK_FW   $@
      cmd_fwbin = FWNAME="$(patsubst firmware/%.gen.S,%,$@)";		     \
		  FWSTR="$(subst /,_,$(subst .,_,$(subst -,_,$(patsubst	     \
				firmware/%.gen.S,%,$@))))";		     \
		  ASM_WORD=$(if $(CONFIG_64BIT),.quad,.long);		     \
		  ASM_ALIGN=$(if $(CONFIG_64BIT),3,2);			     \
		  PROGBITS=$(if $(CONFIG_ARM),%,@)progbits;		     \
		  echo "/* Generated by firmware/Makefile */"		> $@;\
		  echo "    .section .rodata"				>>$@;\
		  echo "    .p2align $${ASM_ALIGN}"			>>$@;\
		  echo "_fw_$${FWSTR}_bin:"				>>$@;\
		  echo "    .incbin \"$(2)\""				>>$@;\
		  echo "_fw_end:"					>>$@;\
		  echo "   .section .rodata.str,\"aMS\",$${PROGBITS},1"	>>$@;\
		  echo "    .p2align $${ASM_ALIGN}"			>>$@;\
		  echo "_fw_$${FWSTR}_name:"				>>$@;\
		  echo "    .string \"$$FWNAME\""			>>$@;\
		  echo "    .section .builtin_fw,\"a\",$${PROGBITS}"	>>$@;\
		  echo "    .p2align $${ASM_ALIGN}"			>>$@;\
		  echo "    $${ASM_WORD} _fw_$${FWSTR}_name"		>>$@;\
		  echo "    $${ASM_WORD} _fw_$${FWSTR}_bin"		>>$@;\
		  echo "    $${ASM_WORD} _fw_end - _fw_$${FWSTR}_bin"	>>$@;

# One of these files will change, or come into existence, whenever
# the configuration changes between 32-bit and 64-bit. The .S files
# need to change when that happens.
wordsize_deps := $(wildcard include/config/64bit.h include/config/32bit.h \
		include/config/ppc32.h include/config/ppc64.h \
		include/config/superh32.h include/config/superh64.h \
		include/config/x86_32.h include/config/x86_64.h)

$(patsubst %,$(obj)/%.gen.S, $(fw-shipped-y)): %: $(wordsize_deps)
	$(call cmd,fwbin,$(patsubst %.gen.S,%,$@))
$(patsubst %,$(obj)/%.gen.S, $(fw-external-y)): %: $(wordsize_deps) \
		include/config/extra/firmware/dir.h
	$(call cmd,fwbin,$(fwabs)/$(patsubst $(obj)/%.gen.S,%,$@))

# The .o files depend on the binaries directly; the .S files don't.
$(patsubst %,$(obj)/%.gen.o, $(fw-shipped-y)): %.gen.o: %
$(patsubst %,$(obj)/%.gen.o, $(fw-external-y)): $(obj)/%.gen.o: $(fwdir)/%

# .ihex is used just as a simple way to hold binary files in a source tree
# where binaries are frowned upon. They are directly converted with objcopy.
$(obj)/%: $(obj)/%.ihex
	$(call cmd,ihex)

# Don't depend on ihex2fw if we're installing and it already exists.
# Putting it after | in the dependencies doesn't seem sufficient when
# we're installing after a cross-compile, because ihex2fw has dependencies
# on stuff like /usr/lib/gcc/ppc64-redhat-linux/4.3.0/include/stddef.h and 
# thus wants to be rebuilt. Which it can't be, if the prebuilt kernel tree
# is exported read-only for someone to run 'make install'.
ifeq ($(INSTALL):$(wildcard $(obj)/ihex2fw),install:$(obj)/ihex2fw)
ihex2fw_dep :=
else
ihex2fw_dep := $(obj)/ihex2fw
endif

# .HEX is also Intel HEX, but where the offset and length in each record
# is actually meaningful, because the firmware has to be loaded in a certain
# order rather than as a single binary blob. Thus, we convert them into our
# more compact binary representation of ihex records (<linux/ihex.h>)
$(obj)/%.fw: $(obj)/%.HEX $(ihex2fw_dep)
	$(call cmd,ihex2fw)

# .H16 is our own modified form of Intel HEX, with 16-bit length for records.
$(obj)/%.fw: $(obj)/%.H16 $(ihex2fw_dep)
	$(call cmd,h16tofw)

obj-y				 += $(patsubst %,%.gen.o, $(fw-external-y))
obj-$(CONFIG_FIRMWARE_IN_KERNEL) += $(patsubst %,%.gen.o, $(fw-shipped-y))

ifeq ($(KBUILD_SRC),)
# Makefile.build only creates subdirectories for O= builds, but external
# firmware might live outside the kernel source tree
_dummy := $(foreach d,$(addprefix $(obj)/,$(dir $(fw-external-y))), $(shell [ -d $(d) ] || mkdir -p $(d)))
endif

# Remove .S files and binaries created from ihex
# (during 'make clean' .config isn't included so they're all in $(fw-shipped-))
targets := $(fw-shipped-) $(patsubst $(obj)/%,%, \
				$(shell find $(obj) -name \*.gen.S 2>/dev/null))

# Without this, built-in.o won't be created when it's empty, and the
# final vmlinux link will fail.
obj- := dummy

hostprogs-y := ihex2fw
Commit	Line	Data
4d2acfbf DW	1	#
	2	# kbuild file for firmware/
	3	#
	4
	5	# Create $(fwabs) from $(CONFIG_EXTRA_FIRMWARE_DIR) -- if it doesn't have a
	6	# leading /, it's relative to $(srctree).
fb916b42	7	fwdir := $(subst $(quote),,$(CONFIG_EXTRA_FIRMWARE_DIR))
4d2acfbf DW	8	fwabs := $(addprefix $(srctree)/,$(filter-out /%,$(fwdir)))$(filter /%,$(fwdir))
4d2acfbf DW	9
fb916b42	10	fw-external-y := $(subst $(quote),,$(CONFIG_EXTRA_FIRMWARE))
4d2acfbf	11
88ecf814 DW	12	# There are three cases to care about:
	13	# 1. Building kernel with CONFIG_FIRMWARE_IN_KERNEL=y -- $(fw-shipped-y) should
	14	# include the firmware files to include, according to .config
	15	# 2. 'make modules_install', which will install firmware for modules, and
	16	# _also_ for the in-kernel drivers when CONFIG_FIRMWARE_IN_KERNEL=n
	17	# 3. 'make firmware_install', which installs all firmware, unconditionally.
d172e7f5	18
88ecf814 DW	19	# For the former two cases we want $(fw-shipped-y) and $(fw-shipped-m) to be
	20	# accurate. In the latter case it doesn't matter -- it'll use $(fw-shipped-all).
	21	# But be aware that the config file might not be included at all.
	22
8f9e6a26 TG	23	fw-shipped-$(CONFIG_BNX2X) += bnx2x/bnx2x-e1-7.13.1.0.fw \
	24	bnx2x/bnx2x-e1h-7.13.1.0.fw \
	25	bnx2x/bnx2x-e2-7.13.1.0.fw
8f9d6711 TG	26	fw-shipped-$(CONFIG_BNX2) += bnx2/bnx2-mips-09-6.2.1b.fw \
	27	bnx2/bnx2-rv2p-06-6.0.15.fw \
	28	bnx2/bnx2-mips-06-6.2.3.fw \
	29	bnx2/bnx2-rv2p-09-6.0.17.fw \
	30	bnx2/bnx2-rv2p-09ax-6.0.17.fw
9ac32e1b JSR	31	fw-shipped-$(CONFIG_E100) += e100/d101m_ucode.bin e100/d101s_ucode.bin \
9ac32e1b JSR	32	e100/d102e_ucode.bin
f9581011 TG	33	fw-shipped-$(CONFIG_PCMCIA_PCNET) +=
	34
	35	fw-shipped-$(CONFIG_PCMCIA_3C589) +=
	36	fw-shipped-$(CONFIG_PCMCIA_3C574) +=
	37	fw-shipped-$(CONFIG_SERIAL_8250_CS) +=
	38
1bfa11db JSR	39	fw-shipped-$(CONFIG_SCSI_QLOGIC_1280) += qlogic/1040.bin qlogic/1280.bin \
1bfa11db JSR	40	qlogic/12160.bin
f894e74d	41	fw-shipped-$(CONFIG_SCSI_QLOGICPTI) += qlogic/isp1000.bin
ff802e31	42	fw-shipped-$(CONFIG_INFINIBAND_QIB) += qlogic/sd7220.fw
76770664	43	fw-shipped-$(CONFIG_SND_KORG1212) += korg/k1212.dsp
d71792ac JS	44	fw-shipped-$(CONFIG_SND_SB16_CSP) += sb16/mulaw_main.csp sb16/alaw_main.csp \
	45	sb16/ima_adpcm_init.csp \
	46	sb16/ima_adpcm_playback.csp \
	47	sb16/ima_adpcm_capture.csp
7c7cae17	48	fw-shipped-$(CONFIG_SND_WAVEFRONT) += yamaha/yss225_registers.bin
077f849d JSR	49	fw-shipped-$(CONFIG_TIGON3) += tigon/tg3.bin tigon/tg3_tso.bin \
077f849d JSR	50	tigon/tg3_tso5.bin
b775a750	51	fw-shipped-$(CONFIG_TYPHOON) += 3com/typhoon.bin
ae93a55b DW	52	fw-shipped-$(CONFIG_USB_EMI26) += emi26/loader.fw emi26/firmware.fw \
ae93a55b DW	53	emi26/bitstream.fw
b8e24bfa DW	54	fw-shipped-$(CONFIG_USB_EMI62) += emi62/loader.fw emi62/bitstream.fw \
b8e24bfa DW	55	emi62/spdif.fw emi62/midi.fw
ec6752f5 DW	56	fw-shipped-$(CONFIG_USB_SERIAL_WHITEHEAT) += whiteheat_loader.fw whiteheat.fw \
ec6752f5 DW	57	# whiteheat_loader_debug.fw
88ecf814 DW	58
	59	fw-shipped-all := $(fw-shipped-y) $(fw-shipped-m) $(fw-shipped-)
	60
4d2acfbf DW	61	quiet_cmd_ihex = IHEX $@
	62	cmd_ihex = $(OBJCOPY) -Iihex -Obinary $< $@
	63
8bd6b222	64	quiet_cmd_ihex2fw = IHEX2FW $@
556b0f58	65	cmd_ihex2fw = $(objtree)/$(obj)/ihex2fw $< $@
8bd6b222	66
59890f74	67	quiet_cmd_h16tofw = H16TOFW $@
556b0f58	68	cmd_h16tofw = $(objtree)/$(obj)/ihex2fw -w $< $@
59890f74	69
4d2acfbf DW	70	quiet_cmd_fwbin = MK_FW $@
	71	cmd_fwbin = FWNAME="$(patsubst firmware/%.gen.S,%,$@)"; \
	72	FWSTR="$(subst /,_,$(subst .,_,$(subst -,_,$(patsubst \
	73	firmware/%.gen.S,%,$@))))"; \
	74	ASM_WORD=$(if $(CONFIG_64BIT),.quad,.long); \
	75	ASM_ALIGN=$(if $(CONFIG_64BIT),3,2); \
	76	PROGBITS=$(if $(CONFIG_ARM),%,@)progbits; \
	77	echo "/* Generated by firmware/Makefile */" > $@;\
	78	echo " .section .rodata" >>$@;\
	79	echo " .p2align $${ASM_ALIGN}" >>$@;\
	80	echo "_fw_$${FWSTR}_bin:" >>$@;\
	81	echo " .incbin \"$(2)\"" >>$@;\
	82	echo "_fw_end:" >>$@;\
	83	echo " .section .rodata.str,\"aMS\",$${PROGBITS},1" >>$@;\
	84	echo " .p2align $${ASM_ALIGN}" >>$@;\
	85	echo "_fw_$${FWSTR}_name:" >>$@;\
	86	echo " .string \"$$FWNAME\"" >>$@;\
	87	echo " .section .builtin_fw,\"a\",$${PROGBITS}" >>$@;\
	88	echo " .p2align $${ASM_ALIGN}" >>$@;\
	89	echo " $${ASM_WORD} _fw_$${FWSTR}_name" >>$@;\
	90	echo " $${ASM_WORD} _fw_$${FWSTR}_bin" >>$@;\
	91	echo " $${ASM_WORD} _fw_end - _fw_$${FWSTR}_bin" >>$@;
	92
	93	# One of these files will change, or come into existence, whenever
	94	# the configuration changes between 32-bit and 64-bit. The .S files
	95	# need to change when that happens.
	96	wordsize_deps := $(wildcard include/config/64bit.h include/config/32bit.h \
	97	include/config/ppc32.h include/config/ppc64.h \
	98	include/config/superh32.h include/config/superh64.h \
	99	include/config/x86_32.h include/config/x86_64.h)
	100
5180d5f4	101	$(patsubst %,$(obj)/%.gen.S, $(fw-shipped-y)): %: $(wordsize_deps)
4d2acfbf DW	102	$(call cmd,fwbin,$(patsubst %.gen.S,%,$@))
4d2acfbf DW	103	$(patsubst %,$(obj)/%.gen.S, $(fw-external-y)): %: $(wordsize_deps) \
5180d5f4	104	include/config/extra/firmware/dir.h
4d2acfbf DW	105	$(call cmd,fwbin,$(fwabs)/$(patsubst $(obj)/%.gen.S,%,$@))
	106
	107	# The .o files depend on the binaries directly; the .S files don't.
	108	$(patsubst %,$(obj)/%.gen.o, $(fw-shipped-y)): %.gen.o: %
	109	$(patsubst %,$(obj)/%.gen.o, $(fw-external-y)): $(obj)/%.gen.o: $(fwdir)/%
	110
8bd6b222 DW	111	# .ihex is used just as a simple way to hold binary files in a source tree
8bd6b222 DW	112	# where binaries are frowned upon. They are directly converted with objcopy.
5180d5f4	113	$(obj)/%: $(obj)/%.ihex
4d2acfbf DW	114	$(call cmd,ihex)
4d2acfbf DW	115
4528e429 DW	116	# Don't depend on ihex2fw if we're installing and it already exists.
	117	# Putting it after \| in the dependencies doesn't seem sufficient when
	118	# we're installing after a cross-compile, because ihex2fw has dependencies
	119	# on stuff like /usr/lib/gcc/ppc64-redhat-linux/4.3.0/include/stddef.h and
	120	# thus wants to be rebuilt. Which it can't be, if the prebuilt kernel tree
	121	# is exported read-only for someone to run 'make install'.
	122	ifeq ($(INSTALL):$(wildcard $(obj)/ihex2fw),install:$(obj)/ihex2fw)
	123	ihex2fw_dep :=
	124	else
	125	ihex2fw_dep := $(obj)/ihex2fw
	126	endif
	127
8bd6b222 DW	128	# .HEX is also Intel HEX, but where the offset and length in each record
	129	# is actually meaningful, because the firmware has to be loaded in a certain
	130	# order rather than as a single binary blob. Thus, we convert them into our
	131	# more compact binary representation of ihex records (<linux/ihex.h>)
5180d5f4	132	$(obj)/%.fw: $(obj)/%.HEX $(ihex2fw_dep)
8bd6b222 DW	133	$(call cmd,ihex2fw)
8bd6b222 DW	134
59890f74	135	# .H16 is our own modified form of Intel HEX, with 16-bit length for records.
5180d5f4	136	$(obj)/%.fw: $(obj)/%.H16 $(ihex2fw_dep)
59890f74 DW	137	$(call cmd,h16tofw)
59890f74 DW	138
88ecf814 DW	139	obj-y += $(patsubst %,%.gen.o, $(fw-external-y))
88ecf814 DW	140	obj-$(CONFIG_FIRMWARE_IN_KERNEL) += $(patsubst %,%.gen.o, $(fw-shipped-y))
4d2acfbf	141
dd5a6752 MM	142	ifeq ($(KBUILD_SRC),)
	143	# Makefile.build only creates subdirectories for O= builds, but external
	144	# firmware might live outside the kernel source tree
	145	_dummy := $(foreach d,$(addprefix $(obj)/,$(dir $(fw-external-y))), $(shell [ -d $(d) ] \|\| mkdir -p $(d)))
	146	endif
	147
4d2acfbf DW	148	# Remove .S files and binaries created from ihex
	149	# (during 'make clean' .config isn't included so they're all in $(fw-shipped-))
	150	targets := $(fw-shipped-) $(patsubst $(obj)/%,%, \
	151	$(shell find $(obj) -name \*.gen.S 2>/dev/null))
	152
	153	# Without this, built-in.o won't be created when it's empty, and the
	154	# final vmlinux link will fail.
a4954fd7	155	obj- := dummy
556b0f58 DW	156
556b0f58 DW	157	hostprogs-y := ihex2fw