/*-
 * Copyright (c) 2010 Isilon Systems, Inc.
 * Copyright (c) 2010 iX Systems, Inc.
 * Copyright (c) 2010 Panasas, Inc.
 * Copyright (c) 2013-2016 Mellanox Technologies, Ltd.
 * All rights reserved.
 * Copyright (c) 2021-2025 The FreeBSD Foundation
 *
 * Portions of this software were developed by Björn Zeeb
 * under sponsorship from the FreeBSD Foundation.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice unmodified, this list of conditions, and the following
 *    disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
#ifndef _LINUXKPI_LINUX_DEVICE_H_
#define _LINUXKPI_LINUX_DEVICE_H_

#include <linux/err.h>
#include <linux/types.h>
#include <linux/kobject.h>
#include <linux/sysfs.h>
#include <linux/list.h>
#include <linux/compiler.h>
#include <linux/module.h>
#include <linux/workqueue.h>
#include <linux/kdev_t.h>
#include <linux/backlight.h>
#include <linux/pm.h>
#include <linux/idr.h>
#include <linux/overflow.h>
#include <linux/ratelimit.h>    /* via linux/dev_printk.h */
#include <linux/fwnode.h>
#include <asm/atomic.h>

#include <sys/bus.h>
#include <sys/backlight.h>

struct device;

struct class {
        const char      *name;
        struct kobject  kobj;
        devclass_t      bsdclass;
        const struct dev_pm_ops *pm;
        const struct attribute_group **dev_groups;
        void            (*class_release)(struct class *class);
        void            (*dev_release)(struct device *dev);
        char *          (*devnode)(struct device *dev, umode_t *mode);
};

struct dev_pm_ops {
        int (*prepare)(struct device *dev);
        void (*complete)(struct device *dev);
        int (*suspend)(struct device *dev);
        int (*suspend_late)(struct device *dev);
        int (*resume)(struct device *dev);
        int (*resume_early)(struct device *dev);
        int (*freeze)(struct device *dev);
        int (*freeze_late)(struct device *dev);
        int (*thaw)(struct device *dev);
        int (*thaw_early)(struct device *dev);
        int (*poweroff)(struct device *dev);
        int (*poweroff_late)(struct device *dev);
        int (*restore)(struct device *dev);
        int (*restore_early)(struct device *dev);
        int (*suspend_noirq)(struct device *dev);
        int (*runtime_suspend)(struct device *dev);
        int (*runtime_resume)(struct device *dev);
        int (*runtime_idle)(struct device *dev);
};

struct device_driver {
        const char      *name;
        const struct dev_pm_ops *pm;

        void (*shutdown) (struct device *);
        void (*coredump) (struct device *);
};

struct device_type {
        const char      *name;
};

struct device {
        struct device   *parent;
        struct list_head irqents;
        device_t        bsddev;
        /*
         * The following flag is used to determine if the LinuxKPI is
         * responsible for detaching the BSD device or not. If the
         * LinuxKPI got the BSD device using devclass_get_device(), it
         * must not try to detach or delete it, because it's already
         * done somewhere else.
         */
        bool            bsddev_attached_here;
        struct device_driver *driver;
        struct device_type *type;
        dev_t           devt;
        struct class    *class;
        void            (*release)(struct device *dev);
        struct kobject  kobj;
        void            *dma_priv;
        void            *driver_data;
        unsigned int    irq;
#define LINUX_IRQ_INVALID       65535
        unsigned int    irq_start;
        unsigned int    irq_end;
        const struct attribute_group **groups;
        struct fwnode_handle *fwnode;
        struct cdev     *backlight_dev;
        struct backlight_device *bd;

        spinlock_t      devres_lock;
        struct list_head devres_head;

        struct dev_pm_info      power;
};

extern struct device linux_root_device;
extern struct kobject linux_class_root;
extern const struct kobj_type linux_dev_ktype;
extern const struct kobj_type linux_class_ktype;

struct class_attribute {
        struct attribute attr;
        ssize_t (*show)(struct class *, struct class_attribute *, char *);
        ssize_t (*store)(struct class *, struct class_attribute *, const char *, size_t);
        const void *(*namespace)(struct class *, const struct class_attribute *);
};

#define CLASS_ATTR(_name, _mode, _show, _store)                         \
        struct class_attribute class_attr_##_name =                     \
            { { #_name, NULL, _mode }, _show, _store }

struct device_attribute {
        struct attribute        attr;
        ssize_t                 (*show)(struct device *,
                                        struct device_attribute *, char *);
        ssize_t                 (*store)(struct device *,
                                        struct device_attribute *, const char *,
                                        size_t);
};

#define DEVICE_ATTR(_name, _mode, _show, _store)                        \
        struct device_attribute dev_attr_##_name =                      \
            __ATTR(_name, _mode, _show, _store)
#define DEVICE_ATTR_RO(_name)                                           \
        struct device_attribute dev_attr_##_name = __ATTR_RO(_name)
#define DEVICE_ATTR_WO(_name)                                           \
        struct device_attribute dev_attr_##_name = __ATTR_WO(_name)
#define DEVICE_ATTR_RW(_name)                                           \
        struct device_attribute dev_attr_##_name = __ATTR_RW(_name)

/* Simple class attribute that is just a static string */
struct class_attribute_string {
        struct class_attribute attr;
        char *str;
};

static inline ssize_t
show_class_attr_string(struct class *class,
                                struct class_attribute *attr, char *buf)
{
        struct class_attribute_string *cs;
        cs = container_of(attr, struct class_attribute_string, attr);
        return snprintf(buf, PAGE_SIZE, "%s\n", cs->str);
}

/* Currently read-only only */
#define _CLASS_ATTR_STRING(_name, _mode, _str) \
        { __ATTR(_name, _mode, show_class_attr_string, NULL), _str }
#define CLASS_ATTR_STRING(_name, _mode, _str) \
        struct class_attribute_string class_attr_##_name = \
                _CLASS_ATTR_STRING(_name, _mode, _str)

#define dev_printk(lvl, dev, fmt, ...)                                  \
    device_printf((dev)->bsddev, fmt, ##__VA_ARGS__)

#define dev_emerg(dev, fmt, ...)        device_printf((dev)->bsddev, fmt, ##__VA_ARGS__)
#define dev_alert(dev, fmt, ...)        device_printf((dev)->bsddev, fmt, ##__VA_ARGS__)
#define dev_crit(dev, fmt, ...)         device_printf((dev)->bsddev, fmt, ##__VA_ARGS__)
#define dev_err(dev, fmt, ...)          device_printf((dev)->bsddev, fmt, ##__VA_ARGS__)
#define dev_warn(dev, fmt, ...)         device_printf((dev)->bsddev, fmt, ##__VA_ARGS__)
#define dev_notice(dev, fmt, ...)       device_printf((dev)->bsddev, fmt, ##__VA_ARGS__)
#define dev_info(dev, fmt, ...)         device_printf((dev)->bsddev, fmt, ##__VA_ARGS__)
#define dev_dbg(dev, fmt, ...)          do { } while (0)

#define dev_WARN(dev, fmt, ...) \
    device_printf((dev)->bsddev, "%s:%d: " fmt, __func__, __LINE__, ##__VA_ARGS__)

#define dev_WARN_ONCE(dev, condition, fmt, ...) do {            \
        static bool __dev_WARN_ONCE;                            \
        bool __ret_warn_on = (condition);                       \
        if (unlikely(__ret_warn_on)) {                          \
                if (!__dev_WARN_ONCE) {                         \
                        __dev_WARN_ONCE = true;                 \
                        device_printf((dev)->bsddev, "%s:%d: " fmt, __func__, __LINE__, ##__VA_ARGS__); \
                }                                               \
        }                                                       \
} while (0)

#define dev_info_once(dev, ...) do {            \
        static bool __dev_info_once;            \
        if (!__dev_info_once) {                 \
        __dev_info_once = true;                 \
        dev_info(dev, __VA_ARGS__);             \
        }                                       \
} while (0)

#define dev_warn_once(dev, ...) do {            \
        static bool __dev_warn_once;            \
        if (!__dev_warn_once) {                 \
                __dev_warn_once = 1;            \
                dev_warn(dev, __VA_ARGS__);     \
        }                                       \
} while (0)

#define dev_err_once(dev, ...) do {             \
        static bool __dev_err_once;             \
        if (!__dev_err_once) {                  \
                __dev_err_once = 1;             \
                dev_err(dev, __VA_ARGS__);      \
        }                                       \
} while (0)

#define dev_dbg_once(dev, ...) do {             \
        static bool __dev_dbg_once;             \
        if (!__dev_dbg_once) {                  \
                __dev_dbg_once = 1;             \
                dev_dbg(dev, __VA_ARGS__);      \
        }                                       \
} while (0)

#define dev_err_ratelimited(dev, ...) do {      \
        static linux_ratelimit_t __ratelimited; \
        if (linux_ratelimited(&__ratelimited))  \
                dev_err(dev, __VA_ARGS__);      \
} while (0)

#define dev_warn_ratelimited(dev, ...) do {     \
        static linux_ratelimit_t __ratelimited; \
        if (linux_ratelimited(&__ratelimited))  \
                dev_warn(dev, __VA_ARGS__);     \
} while (0)

#define dev_dbg_ratelimited(dev, ...) do {      \
        static linux_ratelimit_t __ratelimited; \
        if (linux_ratelimited(&__ratelimited))  \
                dev_dbg(dev, __VA_ARGS__);      \
} while (0)

/* Public and LinuxKPI internal devres functions. */
void *lkpi_devres_alloc(void(*release)(struct device *, void *), size_t, gfp_t);
void lkpi_devres_add(struct device *, void *);
void lkpi_devres_free(void *);
void *lkpi_devres_find(struct device *, void(*release)(struct device *, void *),
    int (*match)(struct device *, void *, void *), void *);
int lkpi_devres_destroy(struct device *, void(*release)(struct device *, void *),
    int (*match)(struct device *, void *, void *), void *);
#define devres_alloc(_r, _s, _g)        lkpi_devres_alloc(_r, _s, _g)
#define devres_add(_d, _p)              lkpi_devres_add(_d, _p)
#define devres_free(_p)                 lkpi_devres_free(_p)
#define devres_find(_d, _rfn, _mfn, _mp) \
                                        lkpi_devres_find(_d, _rfn, _mfn, _mp)
#define devres_destroy(_d, _rfn, _mfn, _mp) \
                                        lkpi_devres_destroy(_d, _rfn, _mfn, _mp)
void lkpi_devres_release_free_list(struct device *);
void lkpi_devres_unlink(struct device *, void *);
void lkpi_devm_kmalloc_release(struct device *, void *);
void lkpi_devm_kfree(struct device *, const void *);
#define devm_kfree(_d, _p)              lkpi_devm_kfree(_d, _p)

static inline const char *
dev_driver_string(const struct device *dev)
{
        driver_t *drv;
        const char *str = "";

        if (dev->bsddev != NULL) {
                drv = device_get_driver(dev->bsddev);
                if (drv != NULL)
                        str = drv->name;
        }

        return (str);
}

static inline void *
dev_get_drvdata(const struct device *dev)
{

        return dev->driver_data;
}

static inline void
dev_set_drvdata(struct device *dev, void *data)
{

        dev->driver_data = data;
}

static inline struct device *
get_device(struct device *dev)
{

        if (dev)
                kobject_get(&dev->kobj);

        return (dev);
}

static inline char *
dev_name(const struct device *dev)
{

        return kobject_name(&dev->kobj);
}

static inline bool
dev_is_removable(struct device *dev)
{

        return (false);
}

#define dev_set_name(_dev, _fmt, ...)                                   \
        kobject_set_name(&(_dev)->kobj, (_fmt), ##__VA_ARGS__)

static inline void
put_device(struct device *dev)
{

        if (dev)
                kobject_put(&dev->kobj);
}

struct class *lkpi_class_create(const char *name);
#if defined(LINUXKPI_VERSION) && LINUXKPI_VERSION >= 60400
#define class_create(name)              lkpi_class_create(name)
#else
#define class_create(owner, name)       lkpi_class_create(name)
#endif

static inline int
class_register(struct class *class)
{

        class->bsdclass = devclass_create(class->name);
        kobject_init(&class->kobj, &linux_class_ktype);
        kobject_set_name(&class->kobj, class->name);
        kobject_add(&class->kobj, &linux_class_root, class->name);

        return (0);
}

static inline void
class_unregister(struct class *class)
{

        kobject_put(&class->kobj);
}

static inline struct device *kobj_to_dev(struct kobject *kobj)
{
        return container_of(kobj, struct device, kobj);
}

struct device *device_create(struct class *class, struct device *parent,
            dev_t devt, void *drvdata, const char *fmt, ...);
struct device *device_create_groups_vargs(struct class *class, struct device *parent,
    dev_t devt, void *drvdata, const struct attribute_group **groups,
    const char *fmt, va_list args);

/*
 * Devices are registered and created for exporting to sysfs. Create
 * implies register and register assumes the device fields have been
 * setup appropriately before being called.
 */
static inline void
device_initialize(struct device *dev)
{
        device_t bsddev = NULL;
        int unit = -1;

        if (dev->devt) {
                unit = MINOR(dev->devt);
                bsddev = devclass_get_device(dev->class->bsdclass, unit);
                dev->bsddev_attached_here = false;
        } else if (dev->parent == NULL) {
                bsddev = devclass_get_device(dev->class->bsdclass, 0);
                dev->bsddev_attached_here = false;
        } else {
                dev->bsddev_attached_here = true;
        }

        if (bsddev == NULL && dev->parent != NULL) {
                bsddev = device_add_child(dev->parent->bsddev,
                    dev->class->kobj.name, unit);
        }

        if (bsddev != NULL)
                device_set_softc(bsddev, dev);

        dev->bsddev = bsddev;
        MPASS(dev->bsddev != NULL);
        kobject_init(&dev->kobj, &linux_dev_ktype);

        spin_lock_init(&dev->devres_lock);
        INIT_LIST_HEAD(&dev->devres_head);
}

static inline int
device_add(struct device *dev)
{
        if (dev->bsddev != NULL) {
                if (dev->devt == 0)
                        dev->devt = makedev(0, device_get_unit(dev->bsddev));
        }
        kobject_add(&dev->kobj, &dev->class->kobj, dev_name(dev));

        if (dev->groups)
                return (sysfs_create_groups(&dev->kobj, dev->groups));

        return (0);
}

static inline void
device_create_release(struct device *dev)
{
        kfree(dev);
}

static inline struct device *
device_create_with_groups(struct class *class,
    struct device *parent, dev_t devt, void *drvdata,
    const struct attribute_group **groups, const char *fmt, ...)
{
        va_list vargs;
        struct device *dev;

        va_start(vargs, fmt);
        dev = device_create_groups_vargs(class, parent, devt, drvdata,
            groups, fmt, vargs);
        va_end(vargs);
        return dev;
}

static inline bool
device_is_registered(struct device *dev)
{

        return (dev->bsddev != NULL);
}

static inline int
device_register(struct device *dev)
{
        device_t bsddev = NULL;
        int unit = -1;

        if (device_is_registered(dev))
                goto done;

        if (dev->devt) {
                unit = MINOR(dev->devt);
                bsddev = devclass_get_device(dev->class->bsdclass, unit);
                dev->bsddev_attached_here = false;
        } else if (dev->parent == NULL) {
                bsddev = devclass_get_device(dev->class->bsdclass, 0);
                dev->bsddev_attached_here = false;
        } else {
                dev->bsddev_attached_here = true;
        }
        if (bsddev == NULL && dev->parent != NULL) {
                bsddev = device_add_child(dev->parent->bsddev,
                    dev->class->kobj.name, unit);
        }
        if (bsddev != NULL) {
                if (dev->devt == 0)
                        dev->devt = makedev(0, device_get_unit(bsddev));
                device_set_softc(bsddev, dev);
        }
        dev->bsddev = bsddev;
done:
        kobject_init(&dev->kobj, &linux_dev_ktype);
        kobject_add(&dev->kobj, &dev->class->kobj, dev_name(dev));

        sysfs_create_groups(&dev->kobj, dev->class->dev_groups);

        return (0);
}

static inline void
device_unregister(struct device *dev)
{
        device_t bsddev;

        sysfs_remove_groups(&dev->kobj, dev->class->dev_groups);

        bsddev = dev->bsddev;
        dev->bsddev = NULL;

        if (bsddev != NULL && dev->bsddev_attached_here) {
                bus_topo_lock();
                device_delete_child(device_get_parent(bsddev), bsddev);
                bus_topo_unlock();
        }
        put_device(dev);
}

static inline void
device_del(struct device *dev)
{
        device_t bsddev;

        bsddev = dev->bsddev;
        dev->bsddev = NULL;

        if (bsddev != NULL && dev->bsddev_attached_here) {
                bus_topo_lock();
                device_delete_child(device_get_parent(bsddev), bsddev);
                bus_topo_unlock();
        }
}

static inline void
device_destroy(struct class *class, dev_t devt)
{
        device_t bsddev;
        int unit;

        unit = MINOR(devt);
        bsddev = devclass_get_device(class->bsdclass, unit);
        if (bsddev != NULL)
                device_unregister(device_get_softc(bsddev));
}

static inline void
device_release_driver(struct device *dev)
{

        pr_debug("%s: TODO\n", __func__);
#if 0
        /* This leads to panics. Disable temporarily. Keep to rework. */

        /* We also need to cleanup LinuxKPI bits. What else? */
        lkpi_devres_release_free_list(dev);
        dev_set_drvdata(dev, NULL);
        /* Do not call dev->release! */

        bus_topo_lock();
        if (device_is_attached(dev->bsddev))
                device_detach(dev->bsddev);
        bus_topo_unlock();
#endif
}

static inline int
device_reprobe(struct device *dev)
{
        int error;

        device_release_driver(dev);
        bus_topo_lock();
        error = device_probe_and_attach(dev->bsddev);
        bus_topo_unlock();

        return (-error);
}

static inline void
device_set_wakeup_enable(struct device *dev __unused, bool enable __unused)
{

        /*
         * XXX-BZ TODO This is used by wireless drivers supporting WoWLAN which
         * we currently do not support.
         */
}

static inline int
device_wakeup_enable(struct device *dev)
{

        device_set_wakeup_enable(dev, true);
        return (0);
}

static inline bool
device_iommu_mapped(struct device *dev __unused)
{
        return (false);
}

#define dev_pm_set_driver_flags(dev, flags) do { \
} while (0)

static inline void
linux_class_kfree(struct class *class)
{

        kfree(class);
}

static inline void
class_destroy(struct class *class)
{

        if (class == NULL)
                return;
        class_unregister(class);
}

static inline int
device_create_file(struct device *dev, const struct device_attribute *attr)
{

        if (dev)
                return sysfs_create_file(&dev->kobj, &attr->attr);
        return -EINVAL;
}

static inline void
device_remove_file(struct device *dev, const struct device_attribute *attr)
{

        if (dev)
                sysfs_remove_file(&dev->kobj, &attr->attr);
}

static inline int
class_create_file(struct class *class, const struct class_attribute *attr)
{

        if (class)
                return sysfs_create_file(&class->kobj, &attr->attr);
        return -EINVAL;
}

static inline void
class_remove_file(struct class *class, const struct class_attribute *attr)
{

        if (class)
                sysfs_remove_file(&class->kobj, &attr->attr);
}

#define dev_to_node(dev) linux_dev_to_node(dev)
#define of_node_to_nid(node) -1
int linux_dev_to_node(struct device *);

char *kvasprintf(gfp_t, const char *, va_list);
char *kasprintf(gfp_t, const char *, ...);
char *lkpi_devm_kasprintf(struct device *, gfp_t, const char *, ...);

#define devm_kasprintf(_dev, _gfp, _fmt, ...)                   \
    lkpi_devm_kasprintf(_dev, _gfp, _fmt, ##__VA_ARGS__)

static __inline void *
devm_kmalloc(struct device *dev, size_t size, gfp_t gfp)
{
        void *p;

        p = lkpi_devres_alloc(lkpi_devm_kmalloc_release, size, gfp);
        if (p != NULL)
                lkpi_devres_add(dev, p);

        return (p);
}

static inline void *
devm_kmemdup(struct device *dev, const void *src, size_t len, gfp_t gfp)
{
        void *dst;

        if (len == 0)
                return (NULL);

        dst = devm_kmalloc(dev, len, gfp);
        if (dst != NULL)
                memcpy(dst, src, len);

        return (dst);
}

#define devm_kzalloc(_dev, _size, _gfp)                         \
    devm_kmalloc((_dev), (_size), (_gfp) | __GFP_ZERO)

#define devm_kcalloc(_dev, _sizen, _size, _gfp)                 \
    devm_kmalloc((_dev), ((_sizen) * (_size)), (_gfp) | __GFP_ZERO)

int lkpi_devm_add_action(struct device *dev, void (*action)(void *), void *data);
#define devm_add_action(dev, action, data)      \
        lkpi_devm_add_action(dev, action, data);
int lkpi_devm_add_action_or_reset(struct device *dev, void (*action)(void *), void *data);
#define devm_add_action_or_reset(dev, action, data)     \
        lkpi_devm_add_action_or_reset(dev, action, data)

int lkpi_devm_device_add_group(struct device *dev, const struct attribute_group *group);
#define devm_device_add_group(dev, group)       \
        lkpi_devm_device_add_group(dev, group)

#endif  /* _LINUXKPI_LINUX_DEVICE_H_ */