sys/compat/linuxkpi/common/include/linux/cdev.h

   1 /*-
   2  * Copyright (c) 2010 Isilon Systems, Inc.
   3  * Copyright (c) 2010 iX Systems, Inc.
   4  * Copyright (c) 2010 Panasas, Inc.
   5  * Copyright (c) 2013-2021 Mellanox Technologies, Ltd.
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice unmodified, this list of conditions, and the following
  13  *    disclaimer.
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in the
  16  *    documentation and/or other materials provided with the distribution.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  19  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  20  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  21  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  22  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  23  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  *
  29  * $FreeBSD$
  30  */
  31 #ifndef _LINUXKPI_LINUX_CDEV_H_
  32 #define _LINUXKPI_LINUX_CDEV_H_
  33
  34 #include <linux/kobject.h>
  35 #include <linux/sysfs.h>
  36 #include <linux/kdev_t.h>
  37 #include <linux/list.h>
  38
  39 #include <asm/atomic-long.h>
  40
  41 struct device;
  42 struct file_operations;
  43 struct inode;
  44 struct module;
  45
  46 extern struct cdevsw linuxcdevsw;
  47 extern const struct kobj_type linux_cdev_ktype;
  48 extern const struct kobj_type linux_cdev_static_ktype;
  49
  50 struct linux_cdev {
  51         struct kobject  kobj;
  52         struct module   *owner;
  53         struct cdev     *cdev;
  54         dev_t           dev;
  55         const struct file_operations *ops;
  56         u_int           refs;
  57         u_int           siref;
  58 };
  59
  60 struct linux_cdev *cdev_alloc(void);
  61
  62 static inline void
  63 cdev_init(struct linux_cdev *cdev, const struct file_operations *ops)
  64 {
  65
  66         kobject_init(&cdev->kobj, &linux_cdev_static_ktype);
  67         cdev->ops = ops;
  68         cdev->refs = 1;
  69 }
  70
  71 static inline void
  72 cdev_put(struct linux_cdev *p)
  73 {
  74         kobject_put(&p->kobj);
  75 }
  76
  77 static inline int
  78 cdev_add(struct linux_cdev *cdev, dev_t dev, unsigned count)
  79 {
  80         struct make_dev_args args;
  81         int error;
  82
  83         if (count != 1)
  84                 return (-EINVAL);
  85
  86         cdev->dev = dev;
  87
  88         /* Setup arguments for make_dev_s() */
  89         make_dev_args_init(&args);
  90         args.mda_devsw = &linuxcdevsw;
  91         args.mda_uid = 0;
  92         args.mda_gid = 0;
  93         args.mda_mode = 0700;
  94         args.mda_si_drv1 = cdev;
  95
  96         error = make_dev_s(&args, &cdev->cdev, "%s",
  97             kobject_name(&cdev->kobj));
  98         if (error)
  99                 return (-error);
 100
 101         kobject_get(cdev->kobj.parent);
 102         return (0);
 103 }
 104
 105 static inline int
 106 cdev_add_ext(struct linux_cdev *cdev, dev_t dev, uid_t uid, gid_t gid, int mode)
 107 {
 108         struct make_dev_args args;
 109         int error;
 110
 111         cdev->dev = dev;
 112
 113         /* Setup arguments for make_dev_s() */
 114         make_dev_args_init(&args);
 115         args.mda_devsw = &linuxcdevsw;
 116         args.mda_uid = uid;
 117         args.mda_gid = gid;
 118         args.mda_mode = mode;
 119         args.mda_si_drv1 = cdev;
 120
 121         error = make_dev_s(&args, &cdev->cdev, "%s/%d",
 122             kobject_name(&cdev->kobj), MINOR(dev));
 123         if (error)
 124                 return (-error);
 125
 126         kobject_get(cdev->kobj.parent);
 127         return (0);
 128 }
 129
 130 static inline void
 131 cdev_del(struct linux_cdev *cdev)
 132 {
 133         kobject_put(&cdev->kobj);
 134 }
 135
 136 struct linux_cdev *linux_find_cdev(const char *name, unsigned major, unsigned minor);
 137
 138 int linux_cdev_device_add(struct linux_cdev *, struct device *);
 139 void linux_cdev_device_del(struct linux_cdev *, struct device *);
 140
 141 #define cdev_device_add(...)            \
 142   linux_cdev_device_add(__VA_ARGS__)
 143 #define cdev_device_del(...)            \
 144   linux_cdev_device_del(__VA_ARGS__)
 145
 146 #define cdev    linux_cdev
 147
 148 #endif  /* _LINUXKPI_LINUX_CDEV_H_ */