一个实际的Makefile
include $(TOPDIR)/rules.mk
PKG_NAME:=capture-data
PKG_RELEASE:=1
PKG_BUILD_DIR := $(BUILD_DIR)/$(PKG_NAME)
include $(INCLUDE_DIR)/package.mk
define Package/capture-data
SECTION:=utils
CATEGORY:=Utilities
TITLE:=capture-data -- prints a snarky message
DEPENDS:=+libxxx +xxlib +libxxx +libxxx # 需要的库
endef
define Package/capture-data/description
If you can't figure out what this program does, you're probably
brain-dead and need immediate medical attention.
endef
define Build/Prepare
mkdir -p $(PKG_BUILD_DIR)
$(CP) ./src/* $(PKG_BUILD_DIR)/
endef
define Package/capture-data/install
$(INSTALL_DIR) $(1)/bin
$(INSTALL_BIN) $(PKG_BUILD_DIR)/capture-data $(1)/bin/
endef
$(eval $(call BuildPackage,capture-data))
引入文件
OpenWrt 使用三个 makefile 的子文件,分别为:
- include $(TOPDIR)/rules.mk
- $(TOPDIR)/rules.mk 一般在 Makefile 的开头,
- include $(INCLUDE_DIR)/kernel.mk
- $(INCLUDE_DIR)/kernel.mk 文件对于软件包为内核时是不可缺少,
- include $(INCLUDE_DIR)/package.mk
- $(INCLUDE_DIR)/package.mk 一般在软件包的基本信息完成后再引入。
由 这 些 makefile 子 文 件 确 立 软 件 包 加 入 OpenWrt 的 方 式 和 方 法 。
编写软件包的基本信息
软件包的信息均以 PKG_开头,其意思和作用如下:
- PKG_NAME 表示软件包名称,将在 menuconfig 和 ipkg 可以看到。
- PKG_VERSION 表示软件包版本号。
- PKG_RELEASE 表示 Makefile 的版本号。
- PKG_SOURCE 表示源代码的文件名。
- PKG_SOURCE_URL 表示源代码的下载网站位置。
- @SF 表示在 sourceforge 网站,
- @GNU 表示在 GNU 网站,
- @GNOME、 @KERNEL。
- PKG_MD5SUM 表示源代码文件的效验码。用于核对软件包是否正确下载。
- PKG_CAT 表示源代码文件的解压方法。包括 zcat, bzcat, unzip 等。
- PKG_BUILD_DIR 表示软件包编译目录。它的父目录为$(BUILD_DIR)。如果不指定,
默认为$(BUILD_DIR)/$( PKG_NAME)/$( PKG_VERSION)。
- 编译包定义
应用程序和内核驱动模块的定义不一样。- 应用程序软件包使用 Package,
- 內核驱动模块使用 KernelPackage。
应用程序编译包定义
应用程序的编译包以 Package/开头,然后接着软件名,在 Package 定义中的软件名
可以与软件包名不一样,而且可以多个定义。
下面使用$(PKG_NAME)只是做一个标示,并非真正使用$(PKG_NAME),如 Package/$(PKG_NAME)。
1. SECTION 表示包的类型,预留。
2. CATEGORY 表示分类,在 make menuconfig 的菜单下将可以找到。
3. TITLE 用于软件包的简短描述。
4. DESCRIPTION 用于软件包的详细描述,已放弃使用。
如果使用 DESCRIPTION 將會提示“ error DESCRIPTION:= is obsolete, use Package/PKG_NAME/description”。URL 表示软件包的下载位置。
5. MAINTAINER 表示维护者,选项。
6. DEPENDS 表示与其他软件的依赖。即如编译或安装需要其他软件时需要说明。
如果存在多个依赖,则每个依赖需要用空格分开。
依赖前使用+号表示默认为显示,即对象沒有选中时也会显示,使用@则默认为不显示,即当依赖对象选中后才显示。
在用户空间的应用程序软件包中沒有內核驱动模块的 AUTOLOAD 参数。
如果应用软件需要在 boot 时自动运行,则需要在/etc/init.d 中增加相应的脚本文件。
脚本文件需要START 参数,说明在 boot 时的优先级, 如果在 boot 过程启动后再关闭,则需要进一步设置 STOP 参数。
如果 STOP 参数存在, 其值必须大于 START。
脚本文件需要 start()和 stop()两个函数, start()是执行程序, stop()是关闭程序。
关闭程序一般需要執行 killall 命令。
由/etc/rc.d/S10boot 知道,装载內核驱动模块的优先级为 10,
需要使用自己设计的內核驱动模块的程序其 START 的值必须大于 10。
同样由/etc/rc.d/S40network 知道, 使用网络通信的程序其 START 的值必须大于 40。
Package/$(PKG_NAME)/conffiles
本包安裝的配置文件,一行一个。如果文件结尾使用/,则表示为目录。
用于备份配置文件说明,在 sysupgrade 命令执行时将会用到。
Package/$(PKG_NAME)/description
软件包的详细描述,取代前面提到的 DESCRIPTION 详细描述。
Build/Prepare
编译准备方法,对于网上下载的软件包不需要再描述。对于非网上下载或自行开发的软
件包必须说明编译准备方法。一般的准备方法为:
define Build/Prepare
mkdir -p $(PKG_BUILD_DIR)
$(CP) ./src/* $(PKG_BUILD_DIR)/
endef
按 OpenWrt 的习惯,一般把自己设计的程序全部放在 src 目录下。
Build/Configure
在 Automake 中需要进行./configure,所以本配置方法主要针对需要配置的软件包而设计,
一般自行开发的软件包可以不在这里说明。需要使用本定义的情况,可参考dropbear。
Build/Compile 编译方法,没有特别说明的可以不予以定义。
如果不定义将使用默认的编译方法 Build/Compile/Default。
自行开发的软件包可以考虑使用下面的定义。
define Build/Compile
$(MAKE) -C $(PKG_BUILD_DIR) \
$(TARGET_CONFIGURE_OPTS) CFLAGS="$(TARGET_CFLAGS)
-I$(LINUX_DIR)/include"
endef
Package/$(PKG_NAME)/install
软件包的安装方法,包括一系列拷贝编译好的文件到指定位置。
调用时会带一个参数,就是嵌入系統的镜像文件系统目录,因此$(1)表示嵌入系统的镜像目录。
一般可以采用下面的方法:
define Package/$(PKG_NAME)/install
$(INSTALL_DIR) $(1)/usr/bin
$(INSTALL_BIN) $(PKG_BUILD_DIR)/ $(PKG_NAME) $(1)/usr/bin/
endef
INSTALL_DIR、 INSTALL_BIN 在$(TOPDIR)/rules.mk 文件定义,所以本 Makefile
必须引入$(TOPDIR)/rules.mk 文件。
INSTALL_DIR :=install -d -m0755
意思是创建所属用戶可读写和执行,其他用戶可读可执行的目录。
INSTALL_BIN:=install -m0755
意思编译好的文件存放到镜像文件目录。
如果用戶空间的应用软件在 boot 时要自动运行,
则需要在安装方法说明中增加自动运行的脚本文件安装和配置文件安裝方法。 例如:
define Package/mountd/install
$(INSTALL_DIR) $(1)/sbin/ $(1)/etc/config/ $(1)/etc/init.d/
$(INSTALL_BIN) $(PKG_BUILD_DIR)/mountd $(1)/sbin/
$(INSTALL_DATA) ./files/mountd.config $(1)/etc/config/mountd
$(INSTALL_BIN) ./files/mountd.init $(1)/etc/init.d/mountd
endef
安装文件放在 files 子目录下,不要与源代码文件目录 src 混在一起,以提高可读性。
使用清晰的文件扩展名,更方便安装识別文件。
Package/$(PKG_NAME)/preinst
软件包安装前处理方法,使用脚本语言,因此定义的第一行需要下面的格式
#!/bin/sh
调用时带入的参数为嵌入式系統的镜像目录。
Package/$(PKG_NAME)/postinst
软件包安装后处理方法,使用脚本语言。
Package/$(PKG_NAME)/prerm
软件包删除前处理方法,使用脚本语言。
Package/$(PKG_NAME)/postrm
软件包删除后处理方法,使用脚本语言。
内核驱动模块包定义
Linux 分为内核空间和用户空间。
开发者开发的内核部分可以直接加入 Linux 的 Kernel 程序,也可以生成内核模块以便需要时装入内核。
OpenWrt 一般希望开发者生成内核模块,在 Linux 启动后自动装载或手工使用 insmod 命令装载。
内核模块使用KernelPackage 开头,其他与一般应用软件包基本相同。
在内核驱动模块定义中增加了:
SUBMENU 表示子菜单位置 ,在 $(INCLUDE)/kernel.mk对内核模块定义了
CATEGORY 为 kernel modules,所以内核模块在 menuconfig 中的主菜单为 kernel
modules , 然 后 有 下 一 级 子 菜 单 $(SUBMENU) 。 在子菜单下可以看到以
kmod-$(PKG_NAME)项目。
DEFAULT 表示直接编入内核或产生内核模块,y 表示直接编入内核,m 表示产生内核模块。
AUTOLOAD 表示自动装入内核,一般表示方法为:
AUTOLOAD:=$(call AutoLoad, $(PRIORITY),$(AUTOLOAD_MODS))
AutoLoad 的第一个参数$(PRIORITY)为优先级,01 为最优先,99 为最后装载。有
关自动装载可以在/etc/modules.d 目录下看到,第二个参数$(AUTOLOAD_MODS)模块
名,每个模块名以空格符分隔。即可同时装载多个内核模块。
在开发过程最好不要使用自动装载,经过严格调试后再使用,可以减轻调试的工作量。
使用定义
完成前面定义后,必须使用 eval 函数实现各种定义。
其格式为:
- 对于一般应用软件包
$(eval $(call Package,$(PKG_NAME)))
- 内核驱动模块
$(eval $(call KernelPackage,$(PKG_NAME)))
如果一个软件包有多个程序,例如:一个应用程序有自己的內核驱动模块,上面使用的PKG_NAME 需要灵活变通。
eval 函数可以设计多个。也可以当成多个软件包处理。
网友评论