linux 标准函数注释,Linux 驱动程序中相关函数注释汇总（跟新中）

1、ARRAY_SIZE

宏，是求设备结构体中设备的个数

定义在linux/kernel.h中

#define ARRAY_SIZE(arr)(sizeof(arr)/sizeof((arr)[0]) + __must_be_array(arr))

sizeof(arr)/sizeof((arr)[0])是求出设备的个数，__must_be_array(arr)是防止被吴用，比如用指针而不是数组上。

2、INT_WORK

以前内核里对这个函数是这样定义的 #define INIT_WORK(_work, _func, _data)，可以理解为INIT_WORK会在你定义的_work工作队列里面增加一个工作任务，该任务就是_func。_func这个任务会需要一些数据作为参数，这个参数就是通过_data传递的。

do{ /

(_work)->data = (atomic_long_t) WORK_DATA_INIT(); /

INIT_LIST_HEAD(&(_work)->entry); /

PREPARE_WORK((_work),(_func)); /

} while (0)

#define INIT_DELAYED_WORK(_work,_func) /

do{ /

INIT_WORK(&(_work)->work,(_func)); /

init_timer(&(_work)->timer); /

} while (0)

3、container_of()

#define container_of(ptr, type, member)({

const typeof(((type *)0)->member ) *__mptr = (ptr);

(type *)( (char*)__mptr - offsetof(type,member) );})

(char *)__mptr转换为字节型指针。(char *)__mptr -offsetof(type,member) )用来求出结构体起始地址(为char *型指针)，然后(type*)( (char *)__mptr - offsetof(type,member) )在(type *)作用下进行将字节型的结构体起始指针转换为type *型的结构体起始指针。

它的作用显而易见，那就是根据一个结构体变量中的一个域成员变量的指针来获取指向整个结构体变量的指针。

4、module_param(name, type, perm);

1.定义模块参数的方法:

module_param(name, type, perm);

其中,name:表示参数的名字;

type:表示参数的类型;

perm:表示参数的访问权限;

2. 数组类型模块参数的定义:

用逗号间隔的列表提供的值;

声明一个数组参数:

module_param_array(name, type, num, perm);

其中,name:表示数组的名字;

type:表示参数的类型;

num :表示数组中元素数量;

perm:表示参数的访问权限;

3.type支持的基本类型有:

bool :布尔类型

invbool:颠倒了值的bool类型;

charp :字符指针类型,内存为用户提供的字符串分配;

int :整型

long :长整型

short :短整型

uint :无符号整型

ulong :无符号长整型

ushort :无符号短整型

4. perm参数 设定访问权限

modlue_param和module_param_array中的perm用于设定该参数的访问权限;

perm表示该参数在sysfs文件系统中所对应的文件节点的属性;你用该使用中定义的权限值;这个值控制谁可以存取这些模块参数在sysfs文件系统中的表示;当perm为0时,表示此参数不存在sysfs文件系统下对应的文件节点;否则,模块被加载后,在/sys/module/目录下将会出现以此模块名命名的目录,带有给定的权限;

比如:

#define S_IRWXU 00700

#define S_IRUSR 00400

#define S_IWUSR 00200

#define S_IXUSR 00100

#define S_IRWXG 00070

#define S_IRGRP 00040

#define S_IWGRP 00020

#define S_IXGRP 00010

#define S_IRWXO 00007

#define S_IROTH 00004

#define S_IWOTH 00002

#define S_IXOTH 00001

注意:如果一个参数被sysfs修改了,那么你的模块看到的参数值也被修改了,但是你的模块不会收到任何通知;你应当不要使模块参数可写,除非你准备好检测这个改变并因而作出反应;

5. 也可以在insmod(装载模块)的时候为参数指定值，如果没有指定则使用默认值，如下面的例子。

example:

MODULE_LICENSE("Dual BSD/GPL");

static int num=10;

module_param(num,int,S_IRUGO);

static int hello_init(void)

{

printk("Hello module init./n");

printk("num=%d/n",num);

return 0;

}

static void hello_exit(void)

{

printk("Goodbye module exit./n");

}

module_init(hello_init);

module_exit(hello_exit);

MODULE_DESCRIPTION("a simple module");

MODULE_ALIAS("hello");