Add README.AddingFirmware file. Basically telling people not to.
[safe/jmp/linux-2.6] / firmware / Makefile
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
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.
18
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
23 ifdef CONFIG_ACENIC_OMIT_TIGON_I
24 acenic-objs := acenic/tg2.bin
25 fw-shipped- += acenic/tg1.bin
26 else
27 acenic-objs := acenic/tg1.bin acenic/tg2.bin
28 endif
29 fw-shipped-$(CONFIG_3C359) += 3com/3C359.bin
30 fw-shipped-$(CONFIG_ACENIC) += $(acenic-objs)
31 fw-shipped-$(CONFIG_ADAPTEC_STARFIRE) += adaptec/starfire_rx.bin \
32                                          adaptec/starfire_tx.bin
33 fw-shipped-$(CONFIG_ATARI_DSP56K) += dsp56k/bootstrap.bin
34 fw-shipped-$(CONFIG_ATM_AMBASSADOR) += atmsar11.fw
35 fw-shipped-$(CONFIG_CASSINI) += sun/cassini.bin
36 fw-shipped-$(CONFIG_COMPUTONE) += intelliport2.bin
37 fw-shipped-$(CONFIG_CHELSIO_T3) += cxgb3/t3b_psram-1.1.0.bin \
38                                    cxgb3/t3c_psram-1.1.0.bin \
39                                    cxgb3/t3fw-7.1.0.bin
40 fw-shipped-$(CONFIG_DVB_AV7110) += av7110/bootcode.bin
41 fw-shipped-$(CONFIG_DVB_TTUSB_BUDGET) += ttusb-budget/dspbootcode.bin
42 fw-shipped-$(CONFIG_E100) += e100/d101m_ucode.bin e100/d101s_ucode.bin \
43                              e100/d102e_ucode.bin
44 fw-shipped-$(CONFIG_PCMCIA_SMC91C92) += ositech/Xilinx7OD.bin
45 fw-shipped-$(CONFIG_SCSI_ADVANSYS) += advansys/mcode.bin advansys/38C1600.bin \
46                                       advansys/3550.bin advansys/38C0800.bin
47 fw-shipped-$(CONFIG_SCSI_QLOGIC_1280) += qlogic/1040.bin qlogic/1280.bin \
48                                          qlogic/12160.bin
49 fw-shipped-$(CONFIG_SCSI_QLOGICPTI) += qlogic/isp1000.bin
50 fw-shipped-$(CONFIG_SMCTR) += tr_smctr.bin
51 fw-shipped-$(CONFIG_SND_KORG1212) += korg/k1212.dsp
52 fw-shipped-$(CONFIG_SND_MAESTRO3) += ess/maestro3_assp_kernel.fw \
53                                      ess/maestro3_assp_minisrc.fw
54 fw-shipped-$(CONFIG_SND_SB16_CSP) += sb16/mulaw_main.csp sb16/alaw_main.csp \
55                                      sb16/ima_adpcm_init.csp \
56                                      sb16/ima_adpcm_playback.csp \
57                                      sb16/ima_adpcm_capture.csp
58 fw-shipped-$(CONFIG_SND_YMFPCI) += yamaha/ds1_ctrl.fw yamaha/ds1_dsp.fw \
59                                    yamaha/ds1e_ctrl.fw
60 fw-shipped-$(CONFIG_SND_WAVEFRONT) += yamaha/yss225_registers.bin
61 fw-shipped-$(CONFIG_TEHUTI) += tehuti/bdx.bin
62 fw-shipped-$(CONFIG_TIGON3) += tigon/tg3.bin tigon/tg3_tso.bin \
63                                tigon/tg3_tso5.bin
64 fw-shipped-$(CONFIG_TYPHOON) += 3com/typhoon.bin
65 fw-shipped-$(CONFIG_USB_DABUSB) += dabusb/firmware.fw dabusb/bitstream.bin
66 fw-shipped-$(CONFIG_USB_EMI26) += emi26/loader.fw emi26/firmware.fw \
67                                   emi26/bitstream.fw
68 fw-shipped-$(CONFIG_USB_EMI62) += emi62/loader.fw emi62/bitstream.fw \
69                                   emi62/spdif.fw emi62/midi.fw
70 fw-shipped-$(CONFIG_USB_KAWETH) += kaweth/new_code.bin kaweth/trigger_code.bin \
71                                    kaweth/new_code_fix.bin \
72                                    kaweth/trigger_code_fix.bin
73 ifdef CONFIG_FIRMWARE_IN_KERNEL
74 fw-shipped-$(CONFIG_USB_SERIAL_KEYSPAN_MPR) += keyspan/mpr.fw
75 fw-shipped-$(CONFIG_USB_SERIAL_KEYSPAN_USA18X) += keyspan/usa18x.fw
76 fw-shipped-$(CONFIG_USB_SERIAL_KEYSPAN_USA19) += keyspan/usa19.fw
77 fw-shipped-$(CONFIG_USB_SERIAL_KEYSPAN_USA19QI) += keyspan/usa19qi.fw
78 fw-shipped-$(CONFIG_USB_SERIAL_KEYSPAN_USA19QW) += keyspan/usa19qw.fw
79 fw-shipped-$(CONFIG_USB_SERIAL_KEYSPAN_USA19W) += keyspan/usa19w.fw
80 fw-shipped-$(CONFIG_USB_SERIAL_KEYSPAN_USA28) += keyspan/usa28.fw
81 fw-shipped-$(CONFIG_USB_SERIAL_KEYSPAN_USA28XA) += keyspan/usa28xa.fw
82 fw-shipped-$(CONFIG_USB_SERIAL_KEYSPAN_USA28XB) += keyspan/usa28xb.fw
83 fw-shipped-$(CONFIG_USB_SERIAL_KEYSPAN_USA28X) += keyspan/usa28x.fw
84 fw-shipped-$(CONFIG_USB_SERIAL_KEYSPAN_USA49W) += keyspan/usa49w.fw
85 fw-shipped-$(CONFIG_USB_SERIAL_KEYSPAN_USA49WLC) += keyspan/usa49wlc.fw
86 else
87 fw-shipped- += keyspan/mpr.fw keyspan/usa18x.fw keyspan/usa19.fw        \
88         keyspan/usa19qi.fw keyspan/usa19qw.fw keyspan/usa19w.fw         \
89         keyspan/usa28.fw keyspan/usa28xa.fw keyspan/usa28xb.fw          \
90         keyspan/usa28x.fw keyspan/usa49w.fw keyspan/usa49wlc.fw
91 endif
92 fw-shipped-$(CONFIG_USB_SERIAL_TI) += ti_3410.fw ti_5052.fw \
93                                       mts_cdma.fw mts_gsm.fw mts_edge.fw
94 fw-shipped-$(CONFIG_USB_SERIAL_EDGEPORT) += edgeport/boot.fw edgeport/boot2.fw \
95                                             edgeport/down.fw edgeport/down2.fw
96 fw-shipped-$(CONFIG_USB_SERIAL_EDGEPORT_TI) += edgeport/down3.bin
97 fw-shipped-$(CONFIG_USB_SERIAL_WHITEHEAT) += whiteheat_loader.fw whiteheat.fw \
98                                            # whiteheat_loader_debug.fw
99 fw-shipped-$(CONFIG_USB_SERIAL_KEYSPAN_PDA) += keyspan_pda/keyspan_pda.fw
100 fw-shipped-$(CONFIG_USB_SERIAL_XIRCOM) += keyspan_pda/xircom_pgs.fw
101 fw-shipped-$(CONFIG_USB_VICAM) += vicam/firmware.fw
102 fw-shipped-$(CONFIG_VIDEO_CPIA2) += cpia2/stv0672_vp4.bin
103 fw-shipped-$(CONFIG_YAM) += yam/1200.bin yam/9600.bin
104
105 fw-shipped-all := $(fw-shipped-y) $(fw-shipped-m) $(fw-shipped-)
106
107 # Directories which we _might_ need to create, so we have a rule for them.
108 firmware-dirs := $(sort $(patsubst %,$(objtree)/$(obj)/%/,$(dir $(fw-external-y) $(fw-shipped-all))))
109
110 quiet_cmd_mkdir = MKDIR   $(patsubst $(objtree)/%,%,$@)
111       cmd_mkdir = mkdir -p $@
112
113 quiet_cmd_ihex  = IHEX    $@
114       cmd_ihex  = $(OBJCOPY) -Iihex -Obinary $< $@
115
116 quiet_cmd_ihex2fw  = IHEX2FW $@
117       cmd_ihex2fw  = $(objtree)/$(obj)/ihex2fw $< $@
118
119 quiet_cmd_h16tofw  = H16TOFW $@
120       cmd_h16tofw  = $(objtree)/$(obj)/ihex2fw -w $< $@
121
122 quiet_cmd_fwbin = MK_FW   $@
123       cmd_fwbin = FWNAME="$(patsubst firmware/%.gen.S,%,$@)";                \
124                   FWSTR="$(subst /,_,$(subst .,_,$(subst -,_,$(patsubst      \
125                                 firmware/%.gen.S,%,$@))))";                  \
126                   ASM_WORD=$(if $(CONFIG_64BIT),.quad,.long);                \
127                   ASM_ALIGN=$(if $(CONFIG_64BIT),3,2);                       \
128                   PROGBITS=$(if $(CONFIG_ARM),%,@)progbits;                  \
129                   echo "/* Generated by firmware/Makefile */"           > $@;\
130                   echo "    .section .rodata"                           >>$@;\
131                   echo "    .p2align $${ASM_ALIGN}"                     >>$@;\
132                   echo "_fw_$${FWSTR}_bin:"                             >>$@;\
133                   echo "    .incbin \"$(2)\""                           >>$@;\
134                   echo "_fw_end:"                                       >>$@;\
135                   echo "   .section .rodata.str,\"aMS\",$${PROGBITS},1" >>$@;\
136                   echo "    .p2align $${ASM_ALIGN}"                     >>$@;\
137                   echo "_fw_$${FWSTR}_name:"                            >>$@;\
138                   echo "    .string \"$$FWNAME\""                       >>$@;\
139                   echo "    .section .builtin_fw,\"a\",$${PROGBITS}"    >>$@;\
140                   echo "    .p2align $${ASM_ALIGN}"                     >>$@;\
141                   echo "    $${ASM_WORD} _fw_$${FWSTR}_name"            >>$@;\
142                   echo "    $${ASM_WORD} _fw_$${FWSTR}_bin"             >>$@;\
143                   echo "    $${ASM_WORD} _fw_end - _fw_$${FWSTR}_bin"   >>$@;
144
145 # One of these files will change, or come into existence, whenever
146 # the configuration changes between 32-bit and 64-bit. The .S files
147 # need to change when that happens.
148 wordsize_deps := $(wildcard include/config/64bit.h include/config/32bit.h \
149                 include/config/ppc32.h include/config/ppc64.h \
150                 include/config/superh32.h include/config/superh64.h \
151                 include/config/x86_32.h include/config/x86_64.h)
152
153 # Workaround for make < 3.81, where .SECONDEXPANSION doesn't work.
154 # It'll end up depending on these targets, so make them a PHONY rule which
155 # depends on _all_ the directories in $(firmware-dirs), and it'll work out OK.
156 PHONY += $(objtree)/$$(%) $(objtree)/$(obj)/$$(%)
157 $(objtree)/$$(%) $(objtree)/$(obj)/$$(%): $(firmware-dirs)
158         @true
159
160 # For the $$(dir %) trick, where we need % to be expanded first.
161 .SECONDEXPANSION:
162
163 $(patsubst %,$(obj)/%.gen.S, $(fw-shipped-y)): %: $(wordsize_deps) \
164                 | $(objtree)/$$(dir %)
165         $(call cmd,fwbin,$(patsubst %.gen.S,%,$@))
166 $(patsubst %,$(obj)/%.gen.S, $(fw-external-y)): %: $(wordsize_deps) \
167                 include/config/extra/firmware/dir.h | $(objtree)/$$(dir %)
168         $(call cmd,fwbin,$(fwabs)/$(patsubst $(obj)/%.gen.S,%,$@))
169
170 # The .o files depend on the binaries directly; the .S files don't.
171 $(patsubst %,$(obj)/%.gen.o, $(fw-shipped-y)): %.gen.o: %
172 $(patsubst %,$(obj)/%.gen.o, $(fw-external-y)): $(obj)/%.gen.o: $(fwdir)/%
173
174 # .ihex is used just as a simple way to hold binary files in a source tree
175 # where binaries are frowned upon. They are directly converted with objcopy.
176 $(obj)/%: $(obj)/%.ihex | $(objtree)/$(obj)/$$(dir %)
177         $(call cmd,ihex)
178
179 # Don't depend on ihex2fw if we're installing and it already exists.
180 # Putting it after | in the dependencies doesn't seem sufficient when
181 # we're installing after a cross-compile, because ihex2fw has dependencies
182 # on stuff like /usr/lib/gcc/ppc64-redhat-linux/4.3.0/include/stddef.h and 
183 # thus wants to be rebuilt. Which it can't be, if the prebuilt kernel tree
184 # is exported read-only for someone to run 'make install'.
185 ifeq ($(INSTALL):$(wildcard $(obj)/ihex2fw),install:$(obj)/ihex2fw)
186 ihex2fw_dep :=
187 else
188 ihex2fw_dep := $(obj)/ihex2fw
189 endif
190
191 # .HEX is also Intel HEX, but where the offset and length in each record
192 # is actually meaningful, because the firmware has to be loaded in a certain
193 # order rather than as a single binary blob. Thus, we convert them into our
194 # more compact binary representation of ihex records (<linux/ihex.h>)
195 $(obj)/%.fw: $(obj)/%.HEX $(ihex2fw_dep) | $(objtree)/$(obj)/$$(dir %)
196         $(call cmd,ihex2fw)
197
198 # .H16 is our own modified form of Intel HEX, with 16-bit length for records.
199 $(obj)/%.fw: $(obj)/%.H16 $(ihex2fw_dep) | $(objtree)/$(obj)/$$(dir %)
200         $(call cmd,h16tofw)
201
202 $(firmware-dirs):
203         $(call cmd,mkdir)
204
205 obj-y                            += $(patsubst %,%.gen.o, $(fw-external-y))
206 obj-$(CONFIG_FIRMWARE_IN_KERNEL) += $(patsubst %,%.gen.o, $(fw-shipped-y))
207
208 # Remove .S files and binaries created from ihex
209 # (during 'make clean' .config isn't included so they're all in $(fw-shipped-))
210 targets := $(fw-shipped-) $(patsubst $(obj)/%,%, \
211                                 $(shell find $(obj) -name \*.gen.S 2>/dev/null))
212
213 # Without this, built-in.o won't be created when it's empty, and the
214 # final vmlinux link will fail.
215 obj-n := dummy
216
217 hostprogs-y := ihex2fw