基礎 Linux Device Driver 驅動程式#11 (procfs-read only)

procfs 指的是位於 /proc 的虛擬檔案系統(實體在 RAM內), 內含 kernel 與各驅動程式的設定選項。
/proc 內的大多數檔案都是唯讀的，像 /proc/cpuinfo , /proc/meminfo 等等...
但也有些是可讓使用者設定的。 像 /proc/sys/kernel/printk 就是了。

如果是要建立唯讀的 procfs，是呼叫 create_proc_read_entry。
定義在 include/linux/proc_fs.h

struct proc_dir_entry *create_proc_read_entry(const char *name,
        mode_t mode, struct proc_dir_entry *base,
        read_proc_t *read_proc, void * data)
       
name:      在 /proc 之內的檔案名稱
mode:      權限(可 NULL)
base:      上層目錄(可 NULL)
read_proc: 讀取處理函式
data:      私有資料(可 NULL)

read_proc 引數要傳入讀取時呼叫的處理函式指標。
這個函式的 prototype 已 typedef 為 read_proc_t， 如下所示：
typedef int (read_proc_t)(char *page, char **start, off_t off,
                          int count, int *eof, void *data);
                         
page:    Kernel 配置的記憶體空間
start:   驅動程式寫入資料的開始位址指標(由驅動程式回傳)
off:     驅動程式傳回資料的偏移量
count:   User space 一次讀回的量
eof:     通知已達資料終點(由驅動程式回傳)
data:    create_proc_read_entry() 設定的私有資料

page 引數是 kernel 分配的記憶體，所以驅動程式可以直接寫入，
但只分配了一個 page 的大小(PAGE_SIZE)，所以寫入資料起過 PAGE_SIZE 就會破壞記憶體內容。

驅動程式在卸載的時候，要呼叫 remove_proc_entry() 清除 procfs 的內容。
void remove_proc_entry(const char *name, struct proc_dir_entry *parent);

好吧， 就來試一下吧。

test_proc.c 原始碼如下：
/*****************************************************************************/
#include <linux/init.h>
#include <linux/module.h>
#include <linux/proc_fs.h>

#define PROC_NAME "test_proc_info"
#define BUF_SIZE 10
static char buf[BUF_SIZE] = {
'a', 'b', 'c', 'd', 'e',
'f', 'g', 'h', 'i', 'j'};

static int test_proc_read(char *page, char **start, off_t off,
int count, int *eof, void *data)
{
int len = BUF_SIZE;

if (len > PAGE_SIZE)
return -ENOBUFS;
len = sprintf(page, "%s\n", buf);

return len;
}

static int test_proc_init(void)
{
struct proc_dir_entry *entry;
int ret = 0;
printk(KERN_ALERT "Procfs init...\n");

entry = create_proc_read_entry(PROC_NAME,
      S_IRUGO | S_IWUGO,
      NULL,
      test_proc_read,
      NULL);
if (entry == NULL) {
ret = -ENOMEM;
goto out;
}

out:
return ret;
}

static void test_proc_exit(void)
{
remove_proc_entry(PROC_NAME, NULL);
printk(KERN_ALERT "Procfs exit.\n");
}

module_init(test_proc_init);
module_exit(test_proc_exit);

MODULE_LICENSE("GPL");
MODULE_AUTHOR("Wang Chen Shu");
MODULE_DESCRIPTION("This is test_proc_read module.");

/*****************************************************************************/

Makefile 如下：
/*****************************************************************************/

KDIR="/opt/linux-source-2.6.38"
PWD=$(shell pwd)

obj-m := test_proc.o

all:
$(MAKE) -C ${KDIR} M=${PWD} modules
clean:
$(MAKE) -C ${KDIR} M=${PWD} clean

/*****************************************************************************/

開始測試， go........

# ls
Makefile  test_proc.c
# make
make -C "/opt/linux-source-2.6.38" M=/opt/test_driver/my_driver/test_proc_read modules
make[1]: Entering directory `/opt/linux-source-2.6.38'
  CC [M]  /opt/test_driver/my_driver/test_proc_read/test_proc.o
  Building modules, stage 2.
  MODPOST 1 modules
  CC      /opt/test_driver/my_driver/test_proc_read/test_proc.mod.o
  LD [M]  /opt/test_driver/my_driver/test_proc_read/test_proc.ko
make[1]: Leaving directory `/opt/linux-source-2.6.38'
# insmod ./test_proc.ko
Procfs init...
# ls -l /proc/test_proc_info
-rw-rw-rw- 1 root root 0 2012-01-06 16:35 /proc/test_proc_info
# cat /proc/test_proc_info
abcdefghij
# rmmod test_proc
Procfs exit.
# ls -l /proc/test_proc_info
ls: 無法存取 /proc/test_proc_info: 沒有此一檔案或目錄

你看看，你看看，是不是這麼一回事呢？
哈^^

procfs - read write 待續......

註記及聲明：
本教學，是參考Linux Device Driver Programming驅動程式設計由平田豐著的這本書。