[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 ",,$(CONFIG_EXTRA_FIRMWARE_DIR))
fwabs := $(addprefix $(srctree)/,$(filter-out /%,$(fwdir)))$(filter /%,$(fwdir))

fw-external-y := $(subst ",,$(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_SND_KORG1212) += korg/k1212.dsp

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

# Directories which we _might_ need to create, so we have a rule for them.
firmware-dirs := $(sort $(patsubst %,$(objtree)/$(obj)/%/,$(dir $(fw-external-y) $(fw-shipped-all))))

quiet_cmd_mkdir = MKDIR   $(patsubst $(objtree)/%,%,$@)
      cmd_mkdir = mkdir -p $@

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)

# Workaround for make < 3.81, where .SECONDEXPANSION doesn't work.
# It'll end up depending on these targets, so make them a PHONY rule which
# depends on _all_ the directories in $(firmware-dirs), and it'll work out OK.
PHONY += $(objtree)/$$(%) $(objtree)/$(obj)/$$(%)
$(objtree)/$$(%) $(objtree)/$(obj)/$$(%): $(firmware-dirs)
	@true

# For the $$(dir %) trick, where we need % to be expanded first.
.SECONDEXPANSION:

$(patsubst %,$(obj)/%.gen.S, $(fw-shipped-y)): %: $(wordsize_deps) \
		| $(objtree)/$$(dir %)
	$(call cmd,fwbin,$(patsubst %.gen.S,%,$@))
$(patsubst %,$(obj)/%.gen.S, $(fw-external-y)): %: $(wordsize_deps) \
		include/config/builtin/firmware/dir.h | $(objtree)/$$(dir %)
	$(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 | $(objtree)/$(obj)/$$(dir %)
	$(call cmd,ihex)

# .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 $(obj)/ihex2fw | $(objtree)/$(obj)/$$(dir %)
	$(call cmd,ihex2fw)

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

$(firmware-dirs):
	$(call cmd,mkdir)

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

# 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-n := 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).
	7	fwdir := $(subst ",,$(CONFIG_EXTRA_FIRMWARE_DIR))
	8	fwabs := $(addprefix $(srctree)/,$(filter-out /%,$(fwdir)))$(filter /%,$(fwdir))
	9
	10	fw-external-y := $(subst ",,$(CONFIG_EXTRA_FIRMWARE))
	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
76770664	23	fw-shipped-$(CONFIG_SND_KORG1212) += korg/k1212.dsp
88ecf814 DW	24
	25	fw-shipped-all := $(fw-shipped-y) $(fw-shipped-m) $(fw-shipped-)
	26
	27	# Directories which we _might_ need to create, so we have a rule for them.
	28	firmware-dirs := $(sort $(patsubst %,$(objtree)/$(obj)/%/,$(dir $(fw-external-y) $(fw-shipped-all))))
4d2acfbf DW	29
	30	quiet_cmd_mkdir = MKDIR $(patsubst $(objtree)/%,%,$@)
	31	cmd_mkdir = mkdir -p $@
	32
	33	quiet_cmd_ihex = IHEX $@
	34	cmd_ihex = $(OBJCOPY) -Iihex -Obinary $< $@
	35
8bd6b222 DW	36	quiet_cmd_ihex2fw = IHEX2FW $@
	37	cmd_ihex2fw = $(objtree)/$(obj)/ihex2fw $< $@
	38
59890f74 DW	39	quiet_cmd_h16tofw = H16TOFW $@
	40	cmd_h16tofw = $(objtree)/$(obj)/ihex2fw -w $< $@
	41
4d2acfbf DW	42	quiet_cmd_fwbin = MK_FW $@
	43	cmd_fwbin = FWNAME="$(patsubst firmware/%.gen.S,%,$@)"; \
	44	FWSTR="$(subst /,_,$(subst .,_,$(subst -,_,$(patsubst \
	45	firmware/%.gen.S,%,$@))))"; \
	46	ASM_WORD=$(if $(CONFIG_64BIT),.quad,.long); \
	47	ASM_ALIGN=$(if $(CONFIG_64BIT),3,2); \
	48	PROGBITS=$(if $(CONFIG_ARM),%,@)progbits; \
	49	echo "/* Generated by firmware/Makefile */" > $@;\
	50	echo " .section .rodata" >>$@;\
	51	echo " .p2align $${ASM_ALIGN}" >>$@;\
	52	echo "_fw_$${FWSTR}_bin:" >>$@;\
	53	echo " .incbin \"$(2)\"" >>$@;\
	54	echo "_fw_end:" >>$@;\
	55	echo " .section .rodata.str,\"aMS\",$${PROGBITS},1" >>$@;\
	56	echo " .p2align $${ASM_ALIGN}" >>$@;\
	57	echo "_fw_$${FWSTR}_name:" >>$@;\
	58	echo " .string \"$$FWNAME\"" >>$@;\
	59	echo " .section .builtin_fw,\"a\",$${PROGBITS}" >>$@;\
	60	echo " .p2align $${ASM_ALIGN}" >>$@;\
	61	echo " $${ASM_WORD} _fw_$${FWSTR}_name" >>$@;\
	62	echo " $${ASM_WORD} _fw_$${FWSTR}_bin" >>$@;\
	63	echo " $${ASM_WORD} _fw_end - _fw_$${FWSTR}_bin" >>$@;
	64
	65	# One of these files will change, or come into existence, whenever
	66	# the configuration changes between 32-bit and 64-bit. The .S files
	67	# need to change when that happens.
	68	wordsize_deps := $(wildcard include/config/64bit.h include/config/32bit.h \
	69	include/config/ppc32.h include/config/ppc64.h \
	70	include/config/superh32.h include/config/superh64.h \
	71	include/config/x86_32.h include/config/x86_64.h)
	72
	73	# Workaround for make < 3.81, where .SECONDEXPANSION doesn't work.
	74	# It'll end up depending on these targets, so make them a PHONY rule which
	75	# depends on _all_ the directories in $(firmware-dirs), and it'll work out OK.
	76	PHONY += $(objtree)/$$(%) $(objtree)/$(obj)/$$(%)
	77	$(objtree)/$$(%) $(objtree)/$(obj)/$$(%): $(firmware-dirs)
	78	@true
	79
	80	# For the $$(dir %) trick, where we need % to be expanded first.
	81	.SECONDEXPANSION:
	82
	83	$(patsubst %,$(obj)/%.gen.S, $(fw-shipped-y)): %: $(wordsize_deps) \
	84	\| $(objtree)/$$(dir %)
	85	$(call cmd,fwbin,$(patsubst %.gen.S,%,$@))
	86	$(patsubst %,$(obj)/%.gen.S, $(fw-external-y)): %: $(wordsize_deps) \
	87	include/config/builtin/firmware/dir.h \| $(objtree)/$$(dir %)
	88	$(call cmd,fwbin,$(fwabs)/$(patsubst $(obj)/%.gen.S,%,$@))
	89
	90	# The .o files depend on the binaries directly; the .S files don't.
	91	$(patsubst %,$(obj)/%.gen.o, $(fw-shipped-y)): %.gen.o: %
	92	$(patsubst %,$(obj)/%.gen.o, $(fw-external-y)): $(obj)/%.gen.o: $(fwdir)/%
	93
8bd6b222 DW	94	# .ihex is used just as a simple way to hold binary files in a source tree
8bd6b222 DW	95	# where binaries are frowned upon. They are directly converted with objcopy.
4d2acfbf DW	96	$(obj)/%: $(obj)/%.ihex \| $(objtree)/$(obj)/$$(dir %)
	97	$(call cmd,ihex)
	98
8bd6b222 DW	99	# .HEX is also Intel HEX, but where the offset and length in each record
	100	# is actually meaningful, because the firmware has to be loaded in a certain
	101	# order rather than as a single binary blob. Thus, we convert them into our
	102	# more compact binary representation of ihex records (<linux/ihex.h>)
	103	$(obj)/%.fw: $(obj)/%.HEX $(obj)/ihex2fw \| $(objtree)/$(obj)/$$(dir %)
	104	$(call cmd,ihex2fw)
	105
59890f74 DW	106	# .H16 is our own modified form of Intel HEX, with 16-bit length for records.
	107	$(obj)/%.fw: $(obj)/%.H16 $(obj)/ihex2fw \| $(objtree)/$(obj)/$$(dir %)
	108	$(call cmd,h16tofw)
	109
4d2acfbf DW	110	$(firmware-dirs):
	111	$(call cmd,mkdir)
	112
88ecf814 DW	113	obj-y += $(patsubst %,%.gen.o, $(fw-external-y))
88ecf814 DW	114	obj-$(CONFIG_FIRMWARE_IN_KERNEL) += $(patsubst %,%.gen.o, $(fw-shipped-y))
4d2acfbf DW	115
	116	# Remove .S files and binaries created from ihex
	117	# (during 'make clean' .config isn't included so they're all in $(fw-shipped-))
	118	targets := $(fw-shipped-) $(patsubst $(obj)/%,%, \
	119	$(shell find $(obj) -name \*.gen.S 2>/dev/null))
	120
	121	# Without this, built-in.o won't be created when it's empty, and the
	122	# final vmlinux link will fail.
	123	obj-n := dummy
8bd6b222 DW	124
8bd6b222 DW	125	hostprogs-y := ihex2fw