/[gentoo-x86]/eclass/linux-mod.eclass
Gentoo

Contents of /eclass/linux-mod.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.35 - (hide annotations) (download)
Fri Apr 22 19:10:32 2005 UTC (9 years, 3 months ago) by johnm
Branch: MAIN
Changes since 1.34: +2 -1 lines
Adding pcmcia flag. Closes #90025, Cheers Georgi

1 johnm 1.1 # Copyright 1999-2004 Gentoo Foundation
2     # Distributed under the terms of the GNU General Public License v2
3 johnm 1.35 # $Header: /var/cvsroot/gentoo-x86/eclass/linux-mod.eclass,v 1.34 2005/04/11 22:26:28 brix Exp $
4 johnm 1.1
5 johnm 1.10 # Description: This eclass is used to interface with linux-info in such a way
6     # to provide the functionality required and initial functions
7     # required to install external modules against a kernel source
8     # tree.
9     #
10     # Maintainer: John Mylchreest <johnm@gentoo.org>
11     # Copyright 2004 Gentoo Linux
12     #
13     # Please direct your bugs to the current eclass maintainer :)
14    
15     # A Couple of env vars are available to effect usage of this eclass
16     # These are as follows:
17     #
18 johnm 1.26 # Env Var Option Default Description
19     # KERNEL_DIR <string> /usr/src/linux The directory containing kernel
20     # the target kernel sources.
21     # ECONF_PARAMS <string> The parameters to pass to econf.
22     # If this is not set, then econf
23     # isn't run.
24     # BUILD_PARAMS <string> The parameters to pass to emake.
25     # BUILD_TARGETS <string> clean modules The build targets to pass to
26     # make.
27     # MODULE_NAMES <string> This is the modules which are
28     # to be built automatically using
29     # the default pkg_compile/install.
30     # They are explained properly
31     # below. It will only make
32     # BUILD_TARGETS once in any
33     # directory.
34 johnm 1.10
35     # MODULE_NAMES - Detailed Overview
36     #
37     # The structure of each MODULE_NAMES entry is as follows:
38 johnm 1.26 # modulename(libdir:srcdir:objdir)
39 johnm 1.10 # for example:
40 johnm 1.26 # MODULE_NAMES="module_pci(pci:${S}/pci:${S}) module_usb(usb:${S}/usb:${S})"
41 johnm 1.10 #
42     # what this would do is
43     # cd ${S}/pci
44     # make ${BUILD_PARAMS} ${BUILD_TARGETS}
45 johnm 1.26 # cd ${S}
46 johnm 1.10 # insinto /lib/modules/${KV_FULL}/pci
47     # doins module_pci.${KV_OBJ}
48     #
49     # cd ${S}/usb
50     # make ${BUILD_PARAMS} ${BUILD_TARGETS}
51 johnm 1.26 # cd ${S}
52 johnm 1.10 # insinto /lib/modules/${KV_FULL}/usb
53     # doins module_usb.${KV_OBJ}
54     #
55 johnm 1.26 # if the srcdir isnt specified, it assumes ${S}
56     # if the libdir isnt specified, it assumes misc.
57     # if the objdir isnt specified, it assumes srcdir
58    
59     # There is also support for automatyed modules.d file generation.
60     # This can be explicitly enabled by setting any of the following variables.
61     #
62     #
63     # MODULESD_${modulename}_ENABLED This enables the modules.d file
64     # generation even if we dont
65     # specify any additional info.
66     # MODULESD_${modulename}_EXAMPLES This is a bash array containing
67     # a list of examples which should
68     # be used. If you want us to try and
69     # take a guess. Set this to "guess"
70     # MODULESD_${modulename}_ALIASES This is a bash array containing
71     # a list of associated aliases.
72     # MODULESD_${modulename}_ADDITIONS This is a bash array containing
73     # A list of additional things to
74     # add to the bottom of the file.
75     # This can be absolutely anything.
76     # Each entry is a new line.
77     # MODULES_${modulename}_DOCS This is a string list which contains
78     # the full path to any associated
79     # documents for $modulename
80    
81 johnm 1.1
82     inherit linux-info
83     ECLASS=linux-mod
84     INHERITED="$INHERITED $ECLASS"
85 johnm 1.33 EXPORT_FUNCTIONS pkg_setup pkg_postinst src_install src_compile
86 johnm 1.1
87 johnm 1.35 IUSE="${IUSE} pcmcia"
88 johnm 1.26 SLOT="0"
89 johnm 1.1 DESCRIPTION="Based on the $ECLASS eclass"
90     DEPEND="virtual/linux-sources
91 johnm 1.11 sys-apps/sed
92 johnm 1.33 virtual/modutils
93 brix 1.34 pcmcia? ( sys-apps/pcmcia-cs )"
94 johnm 1.26
95 johnm 1.1 # eclass utilities
96     # ----------------------------------
97    
98 johnm 1.33 unpack_pcmcia_sources() {
99     # So while the two eclasses exist side-by-side and also the ebuilds inherit
100     # both we need to check for PCMCIA_SOURCE_DIR, and if we find it, then we
101     # bail out and assume pcmcia.eclass is working on it.
102     [[ -n ${PCMCIA_SOURCE_DIR} ]] && return 1
103    
104     if [[ -f "${1}" ]]; then
105     PCMCIA_SOURCE_DIR="${WORKDIR}/pcmcia-cs/"
106    
107     ebegin "Decompressing pcmcia-cs sources"
108     mkdir -p ${PCMCIA_SOURCE_DIR}
109     tar -xjf ${1} -C ${PCMCIA_SOURCE_DIR}
110     eend $?
111    
112     if [[ -f ${PCMCIA_SOURCE_DIR}/pcmcia-cs-version ]]; then
113     PCMCIA_VERSION=$(cat ${PCMCIA_SOURCE_DIR}/pcmcia-cs-version)
114     einfo "Found pcmcia-cs-${PCMCIA_VERSION}"
115     fi
116     fi
117     }
118    
119     # Dummy function for compatibility.
120     pcmcia_configure() { return 0; }
121    
122     pcmcia_src_unpack() {
123     local pcmcia_tbz="${ROOT}/usr/src/pcmcia-cs/pcmcia-cs-build-env.tbz2"
124    
125     # if the kernel has pcmcia support built in, then we just ignore all this.
126     if linux_chkconfig_present PCMCIA; then
127     einfo "Kernel based PCMCIA support has been detected."
128     else
129     if kernel_is 2 4; then
130     unpack_pcmcia_sources ${pcmcia_tbz};
131     else
132     einfo "We have detected that you are running a 2.6 kernel"
133     einfo "but you are not using the built-in PCMCIA support."
134     einfo "We will assume you know what you are doing, but please"
135     einfo "consider using the built in PCMCIA support instead."
136     sleep 10
137    
138     unpack_pcmcia_sources ${pcmcia_tbz};
139     fi
140     fi
141     }
142    
143 johnm 1.1 use_m() {
144     # if we haven't determined the version yet, we need too.
145     get_version;
146    
147     # if the kernel version is greater than 2.6.6 then we should use
148 johnm 1.8 # M= instead of SUBDIRS=
149 johnm 1.1 [ ${KV_MAJOR} -eq 2 -a ${KV_MINOR} -gt 5 -a ${KV_PATCH} -gt 5 ] && \
150     return 0 || return 1
151     }
152    
153     convert_to_m() {
154     if use_m
155     then
156 johnm 1.32 [ ! -f "${1}" ] && \
157     die "convert_to_m() requires a filename as an argument"
158 johnm 1.8 ebegin "Converting ${1/${WORKDIR}\//} to use M= instead of SUBDIRS="
159 johnm 1.1 sed -i 's:SUBDIRS=:M=:g' ${1}
160     eend $?
161     fi
162     }
163    
164     update_depmod() {
165     # if we haven't determined the version yet, we need too.
166     get_version;
167    
168     ebegin "Updating module dependencies for ${KV_FULL}"
169 johnm 1.5 if [ -r ${KV_OUT_DIR}/System.map ]
170 johnm 1.1 then
171 johnm 1.5 depmod -ae -F ${KV_OUT_DIR}/System.map -b ${ROOT} -r ${KV_FULL}
172 johnm 1.18 eend $?
173 johnm 1.1 else
174     ewarn
175 johnm 1.5 ewarn "${KV_OUT_DIR}/System.map not found."
176 johnm 1.1 ewarn "You must manually update the kernel module dependencies using depmod."
177 johnm 1.18 eend 1
178 johnm 1.1 ewarn
179     fi
180     }
181    
182 johnm 1.3 update_modules() {
183 kingtaco 1.31 if [ -x /sbin/modules-update ] && \
184     grep -v -e "^#" -e "^$" ${D}/etc/modules.d/* >/dev/null 2>&1; then
185 johnm 1.3 ebegin "Updating modules.conf"
186     /sbin/modules-update
187     eend $?
188     fi
189     }
190    
191 johnm 1.1 set_kvobj() {
192     if kernel_is 2 6
193     then
194     KV_OBJ="ko"
195     else
196     KV_OBJ="o"
197     fi
198 johnm 1.26 # Do we really need to know this?
199     # Lets silence it.
200     # einfo "Using KV_OBJ=${KV_OBJ}"
201 johnm 1.1 }
202    
203 johnm 1.11 generate_modulesd() {
204     # This function will generate the neccessary modules.d file from the
205     # information contained in the modules exported parms
206 johnm 1.26
207     local currm_path currm t myIFS myVAR
208     local module_docs module_enabled module_aliases \
209     module_additions module_examples module_modinfo module_opts
210    
211     for currm_path in ${@}
212 johnm 1.11 do
213 johnm 1.26 currm=${currm_path//*\/}
214     currm=$(echo ${currm} | tr '[:lower:]' '[:upper:]')
215    
216     module_docs="$(eval echo \${MODULESD_${currm}_DOCS})"
217     module_enabled="$(eval echo \${MODULESD_${currm}_ENABLED})"
218 johnm 1.30 module_aliases="$(eval echo \${#MODULESD_${currm/-/_}_ALIASES[*]})"
219     module_additions="$(eval echo \${#MODULESD_${currm/-/_}_ADDITIONS[*]})"
220     module_examples="$(eval echo \${#MODULESD_${currm/-/_}_EXAMPLES[*]})"
221 johnm 1.26
222 johnm 1.27 [[ ${module_aliases} -eq 0 ]] && unset module_aliases
223     [[ ${module_additions} -eq 0 ]] && unset module_additions
224     [[ ${module_examples} -eq 0 ]] && unset module_examples
225 johnm 1.26
226     # If we specify we dont want it, then lets exit, otherwise we assume
227     # that if its set, we do want it.
228     [[ ${module_enabled} == no ]] && return 0
229    
230     # unset any unwanted variables.
231     for t in ${!module_*}
232 johnm 1.11 do
233 johnm 1.26 [[ -z ${!t} ]] && unset ${t}
234 johnm 1.11 done
235    
236 johnm 1.26 [[ -z ${!module_*} ]] && return 0
237    
238     # OK so now if we have got this far, then we know we want to continue
239     # and generate the modules.d file.
240     module_modinfo="$(modinfo -p ${currm_path}.${KV_OBJ})"
241     module_config="${T}/modulesd-${currm}"
242    
243 johnm 1.11 ebegin "Preparing file for modules.d"
244 johnm 1.26 #-----------------------------------------------------------------------
245     echo "# modules.d configuration file for ${currm}" >> ${module_config}
246     #-----------------------------------------------------------------------
247     [[ -n ${module_docs} ]] && \
248     echo "# For more information please read:" >> ${module_config}
249     for t in ${module_docs}
250 johnm 1.11 do
251 johnm 1.26 echo "# ${t//*\/}" >> ${module_config}
252 johnm 1.11 done
253 johnm 1.26 echo >> ${module_config}
254 johnm 1.11
255 johnm 1.26 #-----------------------------------------------------------------------
256 johnm 1.27 if [[ ${module_aliases} -gt 0 ]]
257 johnm 1.11 then
258     echo "# Internal Aliases - Do not edit" >> ${module_config}
259     echo "# ------------------------------" >> ${module_config}
260 johnm 1.12
261 johnm 1.26 for((t=0; t<${module_aliases}; t++))
262 johnm 1.11 do
263 johnm 1.26 echo "alias $(eval echo \${MODULESD_${currm}_ALIASES[$t]})" \
264     >> ${module_config}
265 johnm 1.12 done
266 johnm 1.26 echo '' >> ${module_config}
267 johnm 1.11 fi
268    
269 johnm 1.26 #-----------------------------------------------------------------------
270     if [[ -n ${module_modinfo} ]]
271 johnm 1.11 then
272     echo >> ${module_config}
273     echo "# Configurable module parameters" >> ${module_config}
274     echo "# ------------------------------" >> ${module_config}
275 johnm 1.26 myIFS="${IFS}"
276 johnm 1.11 IFS="$(echo -en "\n\b")"
277 johnm 1.26
278     for t in ${module_modinfo}
279 johnm 1.11 do
280 johnm 1.26 myVAR="$(echo ${t#*:} | grep -e " [0-9][ =]" | sed "s:.*\([01][= ]\).*:\1:")"
281     if [[ -n ${myVAR} ]]
282 johnm 1.11 then
283 johnm 1.26 module_opts="${module_opts} ${t%%:*}:${myVAR}"
284 johnm 1.11 fi
285 johnm 1.26 echo -e "# ${t%%:*}:\t${t#*:}" >> ${module_config}
286     done
287     IFS="${myIFS}"
288     echo '' >> ${module_config}
289     fi
290    
291     #-----------------------------------------------------------------------
292     if [[ $(eval echo \${MODULESD_${currm}_ALIASES[0]}) == guess ]]
293     then
294     # So lets do some guesswork eh?
295     if [[ -n ${module_opts} ]]
296     then
297     echo "# For Example..." >> ${module_config}
298     echo "# --------------" >> ${module_config}
299     for t in ${module_opts}
300     do
301     echo "# options ${currm} ${t//:*}=${t//*:}" >> ${module_config}
302     done
303     echo '' >> ${module_config}
304     fi
305 johnm 1.27 elif [[ ${module_examples} -gt 0 ]]
306 johnm 1.26 then
307     echo "# For Example..." >> ${module_config}
308     echo "# --------------" >> ${module_config}
309     for((t=0; t<${module_examples}; t++))
310     do
311     echo "options $(eval echo \${MODULESD_${currm}_EXAMPLES[$t]})" \
312     >> ${module_config}
313 johnm 1.11 done
314 johnm 1.26 echo '' >> ${module_config}
315 johnm 1.11 fi
316 johnm 1.26
317     #-----------------------------------------------------------------------
318 johnm 1.27 if [[ ${module_additions} -gt 0 ]]
319 johnm 1.11 then
320 johnm 1.26 for((t=0; t<${module_additions}; t++))
321 johnm 1.11 do
322 johnm 1.26 echo "$(eval echo \${MODULESD_${currm}_ADDITIONS[$t]})" \
323     >> ${module_config}
324 johnm 1.11 done
325 johnm 1.26 echo '' >> ${module_config}
326 johnm 1.11 fi
327    
328 johnm 1.26 #-----------------------------------------------------------------------
329    
330 johnm 1.12 # then we install it
331 johnm 1.11 insinto /etc/modules.d
332 johnm 1.27 newins ${module_config} ${currm_path//*\/}
333    
334 johnm 1.12 # and install any documentation we might have.
335 johnm 1.26 [[ -n ${module_docs} ]] && dodoc ${module_docs}
336 johnm 1.11 done
337     eend 0
338 johnm 1.26 return 0
339 johnm 1.11 }
340    
341 johnm 1.1 display_postinst() {
342     # if we haven't determined the version yet, we need too.
343     get_version;
344    
345 johnm 1.10 local modulename moduledir sourcedir moduletemp file i
346 johnm 1.1
347     file=${ROOT}/etc/modules.autoload.d/kernel-${KV_MAJOR}.${KV_MINOR}
348     file=${file/\/\///}
349    
350 johnm 1.20 for i in ${MODULE_IGNORE}
351     do
352     MODULE_NAMES=${MODULE_NAMES//${i}(*}
353     done
354    
355 johnm 1.22 if [[ -n ${MODULE_NAMES} ]]
356     then
357     einfo "If you would like to load this module automatically upon boot"
358     einfo "please type the following as root:"
359     for i in ${MODULE_NAMES}
360 johnm 1.20 do
361 johnm 1.23 unset libdir srcdir objdir
362 johnm 1.22 for n in $(find_module_params ${i})
363     do
364     eval ${n/:*}=${n/*:/}
365     done
366     einfo " # echo \"${modulename}\" >> ${file}"
367 johnm 1.20 done
368 johnm 1.22 einfo
369     fi
370 johnm 1.1 }
371    
372 johnm 1.18 find_module_params() {
373     local matched_offset=0 matched_opts=0 test="${@}" temp_var result
374     local i=0 y=0 z=0
375    
376     for((i=0; i<=${#test}; i++))
377     do
378     case ${test:${i}:1} in
379     \() matched_offset[0]=${i};;
380     \:) matched_opts=$((${matched_opts} + 1));
381     matched_offset[${matched_opts}]="${i}";;
382     \)) matched_opts=$((${matched_opts} + 1));
383     matched_offset[${matched_opts}]="${i}";;
384     esac
385     done
386    
387     for((i=0; i<=${matched_opts}; i++))
388     do
389     # i = offset were working on
390     # y = last offset
391     # z = current offset - last offset
392     # temp_var = temporary name
393     case ${i} in
394     0) tempvar=${test:0:${matched_offset[0]}};;
395     *) y=$((${matched_offset[$((${i} - 1))]} + 1))
396     z=$((${matched_offset[${i}]} - ${matched_offset[$((${i} - 1))]}));
397     z=$((${z} - 1))
398     tempvar=${test:${y}:${z}};;
399     esac
400    
401     case ${i} in
402     0) result="${result} modulename:${tempvar}";;
403     1) result="${result} libdir:${tempvar}";;
404     2) result="${result} srcdir:${tempvar}";;
405     3) result="${result} objdir:${tempvar}";;
406     esac
407     done
408    
409     echo ${result}
410     }
411    
412 johnm 1.1 # default ebuild functions
413     # --------------------------------
414    
415     linux-mod_pkg_setup() {
416 johnm 1.6 linux-info_pkg_setup;
417     check_kernel_built;
418 johnm 1.1 check_modules_supported;
419     set_kvobj;
420     }
421    
422     linux-mod_src_compile() {
423 johnm 1.26 local modulename libdir srcdir objdir i n myARCH="${ARCH}"
424 johnm 1.21 unset ARCH
425 johnm 1.26
426 johnm 1.16 BUILD_TARGETS=${BUILD_TARGETS:-clean module}
427 johnm 1.20
428     for i in ${MODULE_IGNORE}
429     do
430     MODULE_NAMES=${MODULE_NAMES//${i}(*}
431     done
432 johnm 1.1
433 johnm 1.9 for i in ${MODULE_NAMES}
434 johnm 1.1 do
435 johnm 1.23 unset libdir srcdir objdir
436 johnm 1.18 for n in $(find_module_params ${i})
437     do
438     eval ${n/:*}=${n/*:/}
439     done
440     libdir=${libdir:-misc}
441     srcdir=${srcdir:-${S}}
442     objdir=${objdir:-${srcdir}}
443 johnm 1.10
444 johnm 1.18 if [ ! -f "${srcdir}/.built" ];
445 johnm 1.16 then
446 johnm 1.18 cd ${srcdir}
447 johnm 1.16 einfo "Preparing ${modulename} module"
448 johnm 1.22 if [[ -n ${ECONF_PARAMS} ]]
449     then
450     econf ${ECONF_PARAMS} || \
451     die "Unable to run econf ${ECONF_PARAMS}"
452     fi
453    
454 johnm 1.21 emake ${BUILD_FIXES} ${BUILD_PARAMS} ${BUILD_TARGETS} \
455 johnm 1.18 || die "Unable to make \
456     ${BUILD_FIXES} ${BUILD_PARAMS} ${BUILD_TARGETS}."
457     touch ${srcdir}/.built
458 johnm 1.16 cd ${OLDPWD}
459     fi
460 johnm 1.1 done
461 johnm 1.26
462     ARCH="${myARCH}"
463 johnm 1.1 }
464    
465     linux-mod_src_install() {
466 johnm 1.18 local modulename libdir srcdir objdir i n
467 johnm 1.20
468     for i in ${MODULE_IGNORE}
469     do
470     MODULE_NAMES=${MODULE_NAMES//${i}(*}
471     done
472 johnm 1.1
473 johnm 1.9 for i in ${MODULE_NAMES}
474 johnm 1.1 do
475 johnm 1.23 unset libdir srcdir objdir
476 johnm 1.18 for n in $(find_module_params ${i})
477     do
478     eval ${n/:*}=${n/*:/}
479     done
480     libdir=${libdir:-misc}
481     srcdir=${srcdir:-${S}}
482     objdir=${objdir:-${srcdir}}
483 johnm 1.1
484     einfo "Installing ${modulename} module"
485 johnm 1.18 cd ${objdir}
486 johnm 1.26 insinto ${ROOT}lib/modules/${KV_FULL}/${libdir}
487 johnm 1.1 doins ${modulename}.${KV_OBJ}
488 johnm 1.16 cd ${OLDPWD}
489 johnm 1.11
490 johnm 1.26 generate_modulesd ${objdir}/${modulename}
491 johnm 1.1 done
492     }
493    
494     linux-mod_pkg_postinst() {
495     update_depmod;
496 johnm 1.3 update_modules;
497 johnm 1.1 display_postinst;
498     }

  ViewVC Help
Powered by ViewVC 1.1.20