/* $NetBSD: sunxi_drm.h,v 1.4 2026/04/19 10:55:21 jmcneill Exp $ */

/*-
 * Copyright (c) 2019 Jared D. McNeill <jmcneill@invisible.ca>
 * All rights reserved.
 *
 * 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 ``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 _ARM_SUNXI_DRM_H
#define _ARM_SUNXI_DRM_H

#include <sys/queue.h>
#include <sys/workqueue.h>

#include <drm/drm_fb_helper.h>
#include <drm/drm_gem_cma_helper.h>

#define DRIVER_AUTHOR           "Jared McNeill"

#define DRIVER_NAME             "sunxi"
#define DRIVER_DESC             "Allwinner Display Engine"
#define DRIVER_DATE             "20190123"

#define DRIVER_MAJOR            1
#define DRIVER_MINOR            0
#define DRIVER_PATCHLEVEL       0

struct sunxi_framebuffer;

#define SUNXI_DRM_MAX_CRTC      2

struct sunxi_drm_vblank {
        void                    *priv;
        void                    (*enable_vblank)(void *);
        void                    (*disable_vblank)(void *);
        struct drm_pending_vblank_event *event;
        struct drm_crtc         *crtc;
};

struct sunxi_drm_softc {
        device_t                sc_dev;
        struct drm_device       *sc_ddev;

        bus_space_tag_t         sc_bst;
        bus_dma_tag_t           sc_dmat;

        int                     sc_phandle;

        struct lwp                      *sc_task_thread;
        SIMPLEQ_HEAD(, sunxi_drm_task)  sc_tasks;
        struct workqueue                *sc_task_wq;

        bool                    sc_dev_registered;

        struct sunxi_drm_vblank sc_vbl[SUNXI_DRM_MAX_CRTC];
};

struct sunxi_drm_framebuffer {
        struct drm_framebuffer  base;
        struct drm_gem_cma_object *obj;
};

struct sunxi_drm_endpoint {
        int                     phandle;
        struct fdt_endpoint     *ep;
        struct drm_device       *ddev;
        TAILQ_ENTRY(sunxi_drm_endpoint) entries;
};

struct sunxi_drm_fbdev {
        struct drm_fb_helper    helper;
};

struct sunxi_drmfb_attach_args {
        struct drm_device       *sfa_drm_dev;
        struct drm_fb_helper    *sfa_fb_helper;
        struct drm_fb_helper_surface_size sfa_fb_sizes;
        bus_space_tag_t         sfa_fb_bst;
        bus_dma_tag_t           sfa_fb_dmat;
        uint32_t                sfa_fb_linebytes;
};

struct sunxi_drm_task {
        union {
                SIMPLEQ_ENTRY(sunxi_drm_task)   queue;
                struct work                     work;
        }               sdt_u;
        void            (*sdt_fn)(struct sunxi_drm_task *);
};

#define sunxi_drm_private(ddev)         (ddev)->dev_private
#define to_sunxi_drm_framebuffer(x)     container_of(x, struct sunxi_drm_framebuffer, base)

int     sunxi_drm_register_endpoint(int, struct fdt_endpoint *);
struct drm_device *sunxi_drm_endpoint_device(struct fdt_endpoint *);

void    sunxi_task_init(struct sunxi_drm_task *,
            void (*)(struct sunxi_drm_task *));
void    sunxi_task_schedule(device_t, struct sunxi_drm_task *);

#endif /* _ARM_SUNXI_DRM_H */