/**
 * container_of 通過一個結(jié)構(gòu)體成員的指針，獲取包含該成員的結(jié)構(gòu)體的起始地址
 * @ptr:        變量的指針
 * @type:       指針指向的結(jié)構(gòu)體類型
 * @member:     結(jié)構(gòu)體中的變量類型
 */
#define container_of(ptr, type, member) ({              \
    void *__mptr = (void *)(ptr);                   \
    BUILD_BUG_ON_MSG(!__same_type(*(ptr), ((type *)0)->member) &&   \
                     !__same_type(*(ptr), void),            \
                     "pointer type mismatch in container_of"); \
    ((type *)(__mptr - offsetof(type, member))); })

#define container_of(ptr, type, member) \
    ((type *)((char *)(ptr) - offsetof(type, member)))

/**
 * first：dev_t 類型，指定要注冊的起始設(shè)備號。使用 MKDEV(major, minor) 宏生成
 * count：需要注冊的連續(xù)設(shè)備號數(shù)量（次設(shè)備號的范圍）
 * name：設(shè)備的名稱，該名稱會出現(xiàn)在 /proc/devices 文件中，用于標(biāo)識該組設(shè)備號屬于哪個驅(qū)動。
 * 返回值: 成功返回0
 *        參數(shù)無效返回     -EINVAL
 *        設(shè)備號被占用返回 -EBUSY
*/
int register_chrdev_region(dev_t first, unsigned int count, const char *name);

/*
 * dev：指向要初始化的 struct cdev 結(jié)構(gòu)體的指針。
 *       該結(jié)構(gòu)體可以由驅(qū)動靜態(tài)分配 (kmalloc) ，也可以動態(tài)分配 (cdev_alloc)
 * fops：指向 struct file_operations 結(jié)構(gòu)體的指針
 *       該結(jié)構(gòu)體包含了設(shè)備支持的各種操作函數(shù)（如 open、read、write、ioctl 等）
*/
void cdev_init(struct cdev *cdev, const struct file_operations *fops)
{
    memset(cdev, 0, sizeof *cdev);
    INIT_LIST_HEAD(&cdev->list);
    kobject_init(&cdev->kobj, &ktype_cdev_default);
    cdev->ops = fops;
}

/*
 * p：指向 cdev_init() 已經(jīng)初始化的 struct cdev 對象的指針。
 * dev：分配給該設(shè)備的起始設(shè)備號，應(yīng)該與 register_chrdev_region() 向內(nèi)核申請的設(shè)備號位置一致
 * count：與該設(shè)備關(guān)聯(lián)的次設(shè)備號數(shù)量
 * 返回值：成功 0
          參數(shù)無效    -EINVAL
          設(shè)備號被占用 -EBUSY （理論上在分配設(shè)備號時已經(jīng)檢查過，但這里仍可能發(fā)生，如動態(tài)添加時競爭）
          內(nèi)存不足    -ENOMEM
*/
int cdev_add(struct cdev *p, dev_t dev, unsigned count);

#include <linux/init.h>
#include <linux/errno.h>
#include <linux/mm.h>
#include <linux/sched.h>
#include <linux/module.h>
#include <linux/ioctl.h>
#include <linux/io.h>
#include <linux/fs.h>
#include <linux/cdev.h>
#include <linux/uaccess.h>
#include <linux/slab.h>

#define GLOBALMEM_SIZE    1024
#define GLOBALMEM_MAGIC    'M'
#define MEM_CLEAR        _IO(GLOBALMEM_MAGIC, 0)

struct globalmem_dev 
{
    // 字符設(shè)備
    struct cdev m_cdev;
    // 共享內(nèi)存
    unsigned char mem[GLOBALMEM_SIZE];
};


static int globalmem_major = 266;

// 存放兩個字符設(shè)備私有數(shù)據(jù)
struct globalmem_dev* globalmem_devp;


/* user open fd */
static int globalmem_open(struct inode* inode, struct file* filp) {
    
    struct globalmem_dev* dev;
    /* 下面是一種常用的區(qū)分次設(shè)備號的方法
     * 通過 globalmem_init 初始化時傳入不同的 cdev 指針實現(xiàn)區(qū)分 */
    // inode 中保存的 i_cdev 指針是 globalmem_init 函數(shù)中傳入的，globalmem_dev 結(jié)構(gòu)體變量 m_cdev 的指針
    // 所以通過 inode->i_cdev 指針，即 m_cdev 成員變量的指針，可以找到其對應(yīng)的結(jié)構(gòu)體指針
    dev = container_of(inode->i_cdev, struct globalmem_dev, m_cdev);

    // 將設(shè)備結(jié)構(gòu)體指針傳給文件私有數(shù)據(jù)指針，提供給其他函數(shù)調(diào)用時使用
    filp->private_data = dev;
    return 0;
}


/* user release fd*/
static int globalmem_release(struct inode* inode, struct file* filp) {
    return 0;
}



/* user read fd */
static ssize_t globalmem_read(struct file* filp, char __user* buf, size_t count, loff_t* ppos) {
    unsigned long p = *ppos;
    // 獲得設(shè)備結(jié)構(gòu)體的指針（這是通過open函數(shù)傳入的指針，實現(xiàn)不同次設(shè)備使用不同的共享內(nèi)存）
    struct globalmem_dev* dev = filp->private_data;    


    if(p >= GLOBALMEM_SIZE)
        return 0;
    if(count > GLOBALMEM_SIZE - p)
        count = GLOBALMEM_SIZE - p;
    
    copy_to_user(buf, (void*)(dev->mem + p), count);
    *ppos = p + count;

    return count;
}


/* user write fd */ 
static ssize_t globalmem_write(struct file* filp, const char __user* buf, size_t count, loff_t* ppos) {
    unsigned long p = *ppos;

    // 獲得設(shè)備結(jié)構(gòu)體的指針
    struct globalmem_dev* dev = filp->private_data;    

    if(p >= GLOBALMEM_SIZE)
        return 0;
    if(count > GLOBALMEM_SIZE - p)
        count = GLOBALMEM_SIZE - p;

    copy_from_user(dev->mem + p, buf, count);
    *ppos = p + count;
    return count;
}


/* user lseek fd */
static loff_t globalmem_llseek(struct file* filp, loff_t offset, int orig) {
    loff_t ret;
    switch(orig) {
    // 從起始位置開始移動指針
    case 0:
        if(offset < 0) {
            ret = -EINVAL;
            break;
        }
        if((unsigned int)offset > GLOBALMEM_SIZE) {
            ret = -EINVAL;
            break;
        }
        filp->f_pos = (unsigned int)offset;
        ret = filp->f_pos;
        break;
    // 從當(dāng)前位置開始移動指針
    case 1:
        if((filp->f_pos + offset) > GLOBALMEM_SIZE) {
            ret = -EINVAL;
            break;
        }
        if((filp->f_pos + offset) < 0) {
            ret = -EINVAL;
            break;
        }
        filp->f_pos += offset;
        ret = filp->f_pos;
        break;
    default:
        ret = -EINVAL;
    }
    return ret;
}


/* user ioctl fd */
static int globalmem_ioctl(struct inode* inodep, struct file* filp, unsigned int cmd, unsigned long arg) {
    // 獲取設(shè)備結(jié)構(gòu)體指針    
    struct globalmem_dev* dev = filp->private_data;    
    
    switch(cmd) {
    case MEM_CLEAR:
        memset(dev->mem, 0, GLOBALMEM_SIZE);
        break;
    default:
        return -EINVAL;
    }
    return 0;
}



static const struct file_operations globalmem_fops = {
    .owner = THIS_MODULE,
    .open = globalmem_open,
    .release = globalmem_release,
    .llseek = globalmem_llseek,
    .read = globalmem_read,
    .write = globalmem_write,
    .unlocked_ioctl = globalmem_ioctl
};


/* 設(shè)備驅(qū)動模塊insmod加載函數(shù) */
static int globalmem_init(void) {
    // 向 Linux 內(nèi)核中注冊字符設(shè)備編號范圍
    register_chrdev_region(MKDEV(globalmem_major, 0), 2, "globalmem");

    // 為2個次設(shè)備以及共享內(nèi)存分配內(nèi)存
    globalmem_devp = kmalloc(2 * sizeof(struct globalmem_dev), GFP_KERNEL);
    memset(globalmem_devp, 0, 2 * sizeof(struct globalmem_dev));
    
    // 初始化字符設(shè)備0的基本字段
    cdev_init(&(globalmem_devp[0].m_cdev), &globalmem_fops);
    globalmem_devp[0].m_cdev.owner = THIS_MODULE;
    // 將主設(shè)備號globalmem_major次設(shè)備號0，與字符設(shè)備驅(qū)動的關(guān)聯(lián)
    cdev_add(&(globalmem_devp[0].m_cdev), MKDEV(globalmem_major, 0), 1);

    // 初始化字符設(shè)備1的基本字段
    cdev_init(&(globalmem_devp[1].m_cdev), &globalmem_fops);
    globalmem_devp[1].m_cdev.owner = THIS_MODULE;
    // 將主設(shè)備號globalmem_major次設(shè)備號1，與字符設(shè)備驅(qū)動的關(guān)聯(lián)
    cdev_add(&(globalmem_devp[1].m_cdev), MKDEV(globalmem_major, 1), 1);
    return 0;
}


static int globalmem_exit(void) {
    // 注銷cdev
    cdev_del(&(globalmem_devp[0].m_cdev));
    cdev_del(&(globalmem_devp[1].m_cdev));
    // 釋放設(shè)備結(jié)構(gòu)體內(nèi)存
    kfree(globalmem_devp);    
    // 釋放設(shè)備號
    dev_t devno = MKDEV(globalmem_major, 0);
    unregister_chrdev_region(devno, 2);
}


MODULE_AUTHOR("cear");
MODULE_LICENSE("GPL");

module_param(globalmem_major, int, S_IRUGO);
module_init(globalmem_init);
module_exit(globalmem_exit);