summaryrefslogtreecommitdiff
path: root/drivers/base/core.cc
blob: f92b2a4e21094df7d975ccadc8d91d7ccd30d888 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
/* SPDX-License-Identifier: GPL-2.0-or-later */
/* Copyright (C) 2026 Richard Qin */

/*
 * drivers/base/core.cc — device core.
 *
 * Mirrors Linux drivers/base/core.c (greatly simplified).  Provides
 * device_initialize, device_register, device_unregister, and the
 * try_bind helper shared with driver registration.
 *
 * Reference: docs/specs/storage_stack.md §4.3
 */

#include <lume/device.h>
#include <lume/container_of.h>
#include <lume/klog.h>
#include <lume/kprintf.h>
#include <lume/errno.h>
#include <lume/list.h>

/* ------------------------------------------------------------------ */
/*  device ktype — generic release (no-op; subclasses override)       */
/* ------------------------------------------------------------------ */

static void device_release(kobject* kobj)
{
    /* Concrete device flavors (platform_device, virtio_device, ...) are
     * expected to allocate via kmalloc and free in their own release
     * paths after device_unregister + final kobject_put.  The generic
     * device kobj_type only fires for stack-allocated devices used in
     * tests — nothing to do. */
    (void)kobj;
}

static const kobj_type device_ktype = {
    .release = device_release,
};

/* ------------------------------------------------------------------ */
/*  device_initialize / device_register                                */
/* ------------------------------------------------------------------ */

void device_initialize(device* dev)
{
    if (dev == nullptr) {
        return;
    }
    kobject_init(&dev->kobj, &device_ktype);
    dev->parent = nullptr;
    dev->driver = nullptr;
    dev->driver_data = nullptr;
    dev->platform_data = nullptr;
    dev->devt = 0;
    dev->bus_list.init();
    dev->driver_list.init();
}

const char* dev_name(const device* dev)
{
    if (dev == nullptr) {
        return "(null)";
    }
    if (dev->kobj.name != nullptr) {
        return dev->kobj.name;
    }
    if (dev->init_name != nullptr) {
        return dev->init_name;
    }
    return "(unnamed)";
}

/* try_bind: attempt to match `dev` against `drv` and probe.
 * Returns 1 on successful bind, 0 otherwise.
 * Caller must hold bus->lock. */
int device_try_bind(device* dev, device_driver* drv);

int device_try_bind(device* dev, device_driver* drv)
{
    bus_type* bus = dev->bus;

    if (bus->match != nullptr && bus->match(dev, drv) == 0) {
        return 0;
    }

    dev->driver = drv;

    int rc = 0;
    if (bus->probe != nullptr) {
        rc = bus->probe(dev);
    } else if (drv->probe != nullptr) {
        rc = drv->probe(dev);
    }

    if (rc == 0) {
        list_add_tail(&dev->driver_list, &drv->devices);
        return 1;
    }
    dev->driver = nullptr;
    return 0;
}

int device_register(device* dev)
{
    if (dev == nullptr || dev->bus == nullptr) {
        return -EINVAL;
    }
    if (!dev->bus->registered) {
        kprintf("[device] register '%s' fail: bus '%s' not registered\n",
                dev_name(dev),
                dev->bus->name != nullptr ? dev->bus->name : "?");
        return -ENODEV;
    }

    /* device_initialize is idempotent — safe to call again, but most
     * paths will already have initialized.  Detect via ktype set. */
    if (dev->kobj.ktype == nullptr) {
        device_initialize(dev);
    }
    if (dev->kobj.name == nullptr) {
        kobject_add(&dev->kobj, nullptr, dev->init_name);
    }
    dev->bus_list.init();
    dev->driver_list.init();

    LockGuard g(dev->bus->lock);
    list_add_tail(&dev->bus_list, &dev->bus->devices);

    list_node* cur = dev->bus->drivers.next;
    while (cur != &dev->bus->drivers) {
        device_driver* drv =
            list_entry<device_driver, &device_driver::bus_node>(cur);
        cur = cur->next;
        if (device_try_bind(dev, drv) != 0) {
            break;
        }
    }
    return 0;
}

void device_unregister(device* dev)
{
    if (dev == nullptr || dev->bus == nullptr) {
        return;
    }

    LockGuard g(dev->bus->lock);

    if (dev->driver != nullptr) {
        if (dev->driver->remove != nullptr) {
            dev->driver->remove(dev);
        }
        list_del_init(&dev->driver_list);
        dev->driver = nullptr;
    }
    list_del_init(&dev->bus_list);
}