root/sys/dev/fb/fbd.c
/*-
 * SPDX-License-Identifier: BSD-2-Clause
 *
 * Copyright (c) 2013 The FreeBSD Foundation
 *
 * This software was developed by Aleksandr Rybalko 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, 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 AND CONTRIBUTORS ``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 OR CONTRIBUTORS 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.
 */

/* Generic framebuffer */
/* TODO unlink from VT(9) */
/* TODO done normal /dev/fb methods */

#include <sys/param.h>
#include <sys/systm.h>
#include <sys/bus.h>
#include <sys/conf.h>
#include <sys/eventhandler.h>
#include <sys/kernel.h>
#include <sys/malloc.h>
#include <sys/module.h>
#include <sys/queue.h>
#include <sys/fbio.h>

#include <machine/bus.h>

#include <dev/vt/vt.h>
#include <dev/vt/hw/fb/vt_fb.h>

#include <vm/vm.h>
#include <vm/pmap.h>

#include "fb_if.h"

LIST_HEAD(fb_list_head_t, fb_list_entry) fb_list_head =
    LIST_HEAD_INITIALIZER(fb_list_head);
struct fb_list_entry {
        struct fb_info  *fb_info;
        struct cdev     *fb_si;
        LIST_ENTRY(fb_list_entry) fb_list;
};

struct fbd_softc {
        device_t        sc_dev;
        struct fb_info  *sc_info;
};

static void fbd_evh_init(void *);
/* SI_ORDER_SECOND, just after EVENTHANDLERs initialized. */
SYSINIT(fbd_evh_init, SI_SUB_CONFIGURE, SI_ORDER_SECOND, fbd_evh_init, NULL);

static d_open_t         fb_open;
static d_close_t        fb_close;
static d_read_t         fb_read;
static d_write_t        fb_write;
static d_ioctl_t        fb_ioctl;
static d_mmap_t         fb_mmap;

static struct cdevsw fb_cdevsw = {
        .d_version =    D_VERSION,
        .d_flags =      D_NEEDGIANT,
        .d_open =       fb_open,
        .d_close =      fb_close,
        .d_read =       fb_read,
        .d_write =      fb_write,
        .d_ioctl =      fb_ioctl,
        .d_mmap =       fb_mmap,
        .d_name =       "fb",
};

static int framebuffer_dev_unit = 0;

static int
fb_open(struct cdev *dev, int oflags, int devtype, struct thread *td)
{

        return (0);
}

static int
fb_close(struct cdev *dev, int fflag, int devtype, struct thread *td)
{

        return (0);
}

static int
fb_ioctl(struct cdev *dev, u_long cmd, caddr_t data, int fflag,
    struct thread *td)
{
        struct fb_info *info;
        int error;

        error = 0;
        info = dev->si_drv1;

        switch (cmd) {
        case FBIOGTYPE:
                bcopy(info, (struct fbtype *)data, sizeof(struct fbtype));
                break;

        case FBIO_GETWINORG:    /* get frame buffer window origin */
                *(u_int *)data = 0;
                break;

        case FBIO_GETDISPSTART: /* get display start address */
                ((video_display_start_t *)data)->x = 0;
                ((video_display_start_t *)data)->y = 0;
                break;

        case FBIO_GETLINEWIDTH: /* get scan line width in bytes */
                *(u_int *)data = info->fb_stride;
                break;

        case FBIO_BLANK:        /* blank display */
                if (info->setblankmode != NULL)
                        error = info->setblankmode(info->fb_priv, *(int *)data);
                break;

        default:
                error = ENOIOCTL;
                break;
        }
        return (error);
}

static int
fb_read(struct cdev *dev, struct uio *uio, int ioflag)
{

        return (0); /* XXX nothing to read, yet */
}

static int
fb_write(struct cdev *dev, struct uio *uio, int ioflag)
{

        return (0); /* XXX nothing written */
}

static int
fb_mmap(struct cdev *dev, vm_ooffset_t offset, vm_paddr_t *paddr, int nprot,
    vm_memattr_t *memattr)
{
        struct fb_info *info;

        info = dev->si_drv1;

        if (info->fb_flags & FB_FLAG_NOMMAP)
                return (ENODEV);

        if (offset < info->fb_size) {
                if (info->fb_pbase == 0)
                        *paddr = vtophys((uint8_t *)info->fb_vbase + offset);
                else
                        *paddr = info->fb_pbase + offset;
                if (info->fb_flags & FB_FLAG_MEMATTR)
                        *memattr = info->fb_memattr;
                return (0);
        }
        return (EINVAL);
}

static int
fb_init(struct fb_list_entry *entry, int unit)
{
        struct fb_info *info;

        info = entry->fb_info;
        entry->fb_si = make_dev(&fb_cdevsw, unit, UID_ROOT, GID_WHEEL,
            0600, "fb%d", unit);
        entry->fb_si->si_drv1 = info;
        info->fb_cdev = entry->fb_si;

        return (0);
}

int
fbd_list(void)
{
        struct fb_list_entry *entry;

        if (LIST_EMPTY(&fb_list_head))
                return (ENOENT);

        LIST_FOREACH(entry, &fb_list_head, fb_list) {
                printf("FB %s @%#jx\n", entry->fb_info->fb_name,
                    (uintmax_t)entry->fb_info->fb_pbase);
        }

        return (0);
}

static struct fb_list_entry *
fbd_find(struct fb_info* info)
{
        struct fb_list_entry *entry, *tmp;

        LIST_FOREACH_SAFE(entry, &fb_list_head, fb_list, tmp) {
                if (entry->fb_info == info) {
                        return (entry);
                }
        }

        return (NULL);
}

int
fbd_register(struct fb_info* info)
{
        struct fb_list_entry *entry;
        int err, first;

        first = 0;
        if (LIST_EMPTY(&fb_list_head))
                first++;

        entry = fbd_find(info);
        if (entry != NULL) {
                /* XXX Update framebuffer params */
                return (0);
        }

        entry = malloc(sizeof(struct fb_list_entry), M_DEVBUF, M_WAITOK|M_ZERO);
        entry->fb_info = info;

        LIST_INSERT_HEAD(&fb_list_head, entry, fb_list);

        err = fb_init(entry, framebuffer_dev_unit++);
        if (err)
                return (err);

        if (first) {
                err = vt_fb_attach(info);
                if (err)
                        return (err);
        }

        return (0);
}

int
fbd_unregister(struct fb_info* info)
{
        struct fb_list_entry *entry, *tmp;

        LIST_FOREACH_SAFE(entry, &fb_list_head, fb_list, tmp) {
                if (entry->fb_info == info) {
                        LIST_REMOVE(entry, fb_list);
                        if (LIST_EMPTY(&fb_list_head))
                                vt_fb_detach(info);
                        free(entry, M_DEVBUF);
                        return (0);
                }
        }

        return (ENOENT);
}

static void
register_fb_wrap(void *arg, void *ptr)
{

        fbd_register((struct fb_info *)ptr);
}

static void
unregister_fb_wrap(void *arg, void *ptr)
{

        fbd_unregister((struct fb_info *)ptr);
}

static void
fbd_evh_init(void *ctx)
{

        EVENTHANDLER_REGISTER(register_framebuffer, register_fb_wrap, NULL,
            EVENTHANDLER_PRI_ANY);
        EVENTHANDLER_REGISTER(unregister_framebuffer, unregister_fb_wrap, NULL,
            EVENTHANDLER_PRI_ANY);
}

/* Newbus methods. */
static int
fbd_probe(device_t dev)
{

        return (BUS_PROBE_NOWILDCARD);
}

static int
fbd_attach(device_t dev)
{
        struct fbd_softc *sc;
        int err;

        sc = device_get_softc(dev);

        sc->sc_dev = dev;
        sc->sc_info = FB_GETINFO(device_get_parent(dev));
        if (sc->sc_info == NULL)
                return (ENXIO);
        err = fbd_register(sc->sc_info);

        return (err);
}

static int
fbd_detach(device_t dev)
{
        struct fbd_softc *sc;
        int err;

        sc = device_get_softc(dev);

        err = fbd_unregister(sc->sc_info);

        return (err);
}

static device_method_t fbd_methods[] = {
        /* Device interface */
        DEVMETHOD(device_probe,         fbd_probe),
        DEVMETHOD(device_attach,        fbd_attach),
        DEVMETHOD(device_detach,        fbd_detach),

        DEVMETHOD(device_shutdown,      bus_generic_shutdown),

        DEVMETHOD_END
};

driver_t fbd_driver = {
        "fbd",
        fbd_methods,
        sizeof(struct fbd_softc)
};

DRIVER_MODULE(fbd, fb, fbd_driver, 0, 0);
DRIVER_MODULE(fbd, drmn, fbd_driver, 0, 0);
DRIVER_MODULE(fbd, udl, fbd_driver, 0, 0);
MODULE_VERSION(fbd, 1);