Linux 驅動學習筆記 - 互斥體 (十三)

Linux 驅動學習筆記 - 互斥體 (十三)

本系列均爲正點原子 Linux 驅動的學習筆記, 以便加深筆者記憶。如讀者想進一步學習，可以到正點原子官網中下載資料進行學習。

互斥體定義

struct mutex {
    /* 1: unlocked, 0: locked, negative: locked, possible waiters */
    atomic_t count;
    spinlock_t wait_lock;
};

互斥體特點

• mutex 可以導致休眠，因此不能在中斷中使用 mutex，中斷中只能使用自旋鎖。
• 和信號量一樣，mutex 保護的臨界區可以調用引起阻塞的 API 函數。
• 因爲一次只有一個線程可以持有 mutex，因此，必須由 mutex 的持有者釋放 mutex。並且 mutex 不能遞歸上鎖和解鎖。

互斥體 API 函數

函數	描述
DEFINE_MUTEX(name)	定義並初始化一個 mutex 變量
void mutex_init(mutex *lock)	初始化 mutex
void mutex_lock(struct mutex *lock)	獲取 mutex，也就是給 mutex 上鎖。如果獲取不到就進休眠
void mutex_unlock(struct mutex *lock)	釋放 mutex，也就給 mutex 解鎖
int mutex_trylock(struct mutex *lock)	嘗試獲取 mutex，如果成功就返回 1，如果失敗就返回 0
int mutex_is_locked(struct mutex *lock)	判斷 mutex 是否被獲取，如果是的話就返回 1，否則返回 0
int mutex_lock_interruptible(struct mutex *lock)	使用此函數獲取信號量失敗進入休眠以後可以被信號打斷

互斥體使用示例

struct mutex lock; /* 定義一個互斥體 */
mutex_init(&lock); /* 初始化互斥體 */
mutex_lock(&lock); /* 上鎖 */
/* 臨界區 */
mutex_unlock(&lock); /* 解鎖 */

測試程序

#include <linux/types.h>
#include <linux/kernel.h>
#include <linux/delay.h>
#include <linux/ide.h>
#include <linux/init.h>
#include <linux/module.h>
#include <linux/errno.h>
#include <linux/gpio.h>
#include <linux/cdev.h>
#include <linux/device.h>
#include <linux/of.h>
#include <linux/of_address.h>
#include <linux/of_gpio.h>
#include <linux/semaphore.h>
#include <asm/mach/map.h>
#include <asm/uaccess.h>
#include <asm/io.h>

#define GPIOLED_CNT 1          /* 設備號個數 */
#define GPIOLED_NAME "gpioled" /* 名字 */
#define LEDOFF 0               /* 關燈 */
#define LEDON 1                /* 開燈 */

/* gpioled設備結構體 */
struct gpioled_dev
{
    dev_t devid;            /* 設備號 	 */
    struct cdev cdev;       /* cdev 	*/
    struct class *class;    /* 類 		*/
    struct device *device;  /* 設備 	 */
    int major;              /* 主設備號	  */
    int minor;              /* 次設備號   */
    struct device_node *nd; /* 設備節點 */
    int led_gpio;           /* led所使用的GPIO編號		*/
    struct mutex lock;      /* 互斥體 */
};

struct gpioled_dev gpioled; /* led設備 */

/*
 * @description		: 打開設備
 * @param - inode 	: 傳遞給驅動的inode
 * @param - filp 	: 設備文件，file結構體有個叫做private_data的成員變量
 * 					  一般在open的時候將private_data指向設備結構體。
 * @return 			: 0 成功;其他 失敗
 */
static int led_open(struct inode *inode, struct file *filp)
{
    filp->private_data = &gpioled; /* 設置私有數據 */

    /* 獲取互斥體,可以被信號打斷 */
    if (mutex_lock_interruptible(&gpioled.lock))
    {
        return -ERESTARTSYS;
    }
#if 0
	mutex_lock(&gpioled.lock);	/* 不能被信號打斷 */
#endif

    return 0;
}

/*
 * @description		: 從設備讀取數據 
 * @param - filp 	: 要打開的設備文件(文件描述符)
 * @param - buf 	: 返回給用戶空間的數據緩衝區
 * @param - cnt 	: 要讀取的數據長度
 * @param - offt 	: 相對於文件首地址的偏移
 * @return 			: 讀取的字節數，如果爲負值，表示讀取失敗
 */
static ssize_t led_read(struct file *filp, char __user *buf, size_t cnt, loff_t *offt)
{
    return 0;
}

/*
 * @description		: 向設備寫數據 
 * @param - filp 	: 設備文件，表示打開的文件描述符
 * @param - buf 	: 要寫給設備寫入的數據
 * @param - cnt 	: 要寫入的數據長度
 * @param - offt 	: 相對於文件首地址的偏移
 * @return 			: 寫入的字節數，如果爲負值，表示寫入失敗
 */
static ssize_t led_write(struct file *filp, const char __user *buf, size_t cnt, loff_t *offt)
{
    int retvalue;
    unsigned char databuf[1];
    unsigned char ledstat;
    struct gpioled_dev *dev = filp->private_data;

    retvalue = copy_from_user(databuf, buf, cnt);
    if (retvalue < 0)
    {
        printk("kernel write failed!\r\n");
        return -EFAULT;
    }

    ledstat = databuf[0]; /* 獲取狀態值 */

    if (ledstat == LEDON)
    {
        gpio_set_value(dev->led_gpio, 0); /* 打開LED燈 */
    }
    else if (ledstat == LEDOFF)
    {
        gpio_set_value(dev->led_gpio, 1); /* 關閉LED燈 */
    }
    return 0;
}

/*
 * @description		: 關閉/釋放設備
 * @param - filp 	: 要關閉的設備文件(文件描述符)
 * @return 			: 0 成功;其他 失敗
 */
static int led_release(struct inode *inode, struct file *filp)
{
    struct gpioled_dev *dev = filp->private_data;

    /* 釋放互斥鎖 */
    mutex_unlock(&dev->lock);

    return 0;
}

/* 設備操作函數 */
static struct file_operations gpioled_fops = {
    .owner = THIS_MODULE,
    .open = led_open,
    .read = led_read,
    .write = led_write,
    .release = led_release,
};

/*
 * @description	: 驅動入口函數
 * @param 		: 無
 * @return 		: 無
 */
static int __init led_init(void)
{
    int ret = 0;

    /* 初始化互斥體 */
    mutex_init(&gpioled.lock);

    /* 設置LED所使用的GPIO */
    /* 1、獲取設備節點：gpioled */
    gpioled.nd = of_find_node_by_path("/gpioled");
    if (gpioled.nd == NULL)
    {
        printk("gpioled node not find!\r\n");
        return -EINVAL;
    }
    else
    {
        printk("gpioled node find!\r\n");
    }

    /* 2、 獲取設備樹中的gpio屬性，得到LED所使用的LED編號 */
    gpioled.led_gpio = of_get_named_gpio(gpioled.nd, "led-gpio", 0);
    if (gpioled.led_gpio < 0)
    {
        printk("can't get led-gpio");
        return -EINVAL;
    }
    printk("led-gpio num = %d\r\n", gpioled.led_gpio);

    /* 3、設置GPIO1_IO03爲輸出，並且輸出高電平，默認關閉LED燈 */
    ret = gpio_direction_output(gpioled.led_gpio, 1);
    if (ret < 0)
    {
        printk("can't set gpio!\r\n");
    }

    /* 註冊字符設備驅動 */
    /* 1、創建設備號 */
    if (gpioled.major)
    { /*  定義了設備號 */
        gpioled.devid = MKDEV(gpioled.major, 0);
        register_chrdev_region(gpioled.devid, GPIOLED_CNT, GPIOLED_NAME);
    }
    else
    {                                                                      /* 沒有定義設備號 */
        alloc_chrdev_region(&gpioled.devid, 0, GPIOLED_CNT, GPIOLED_NAME); /* 申請設備號 */
        gpioled.major = MAJOR(gpioled.devid);                              /* 獲取分配號的主設備號 */
        gpioled.minor = MINOR(gpioled.devid);                              /* 獲取分配號的次設備號 */
    }
    printk("gpioled major=%d,minor=%d\r\n", gpioled.major, gpioled.minor);

    /* 2、初始化cdev */
    gpioled.cdev.owner = THIS_MODULE;
    cdev_init(&gpioled.cdev, &gpioled_fops);

    /* 3、添加一個cdev */
    cdev_add(&gpioled.cdev, gpioled.devid, GPIOLED_CNT);

    /* 4、創建類 */
    gpioled.class = class_create(THIS_MODULE, GPIOLED_NAME);
    if (IS_ERR(gpioled.class))
    {
        return PTR_ERR(gpioled.class);
    }

    /* 5、創建設備 */
    gpioled.device = device_create(gpioled.class, NULL, gpioled.devid, NULL, GPIOLED_NAME);
    if (IS_ERR(gpioled.device))
    {
        return PTR_ERR(gpioled.device);
    }

    return 0;
}

/*
 * @description	: 驅動出口函數
 * @param 		: 無
 * @return 		: 無
 */
static void __exit led_exit(void)
{
    /* 註銷字符設備驅動 */
    cdev_del(&gpioled.cdev);                              /*  刪除cdev */
    unregister_chrdev_region(gpioled.devid, GPIOLED_CNT); /* 註銷設備號 */

    device_destroy(gpioled.class, gpioled.devid);
    class_destroy(gpioled.class);
}

module_init(led_init);
module_exit(led_exit);
MODULE_LICENSE("GPL");
MODULE_AUTHOR("tyustli");