root/drivers/video/fbdev/omap2/omapfb/omapfb.h
/* SPDX-License-Identifier: GPL-2.0-only */
/*
 * linux/drivers/video/omap2/omapfb.h
 *
 * Copyright (C) 2008 Nokia Corporation
 * Author: Tomi Valkeinen <tomi.valkeinen@nokia.com>
 *
 * Some code and ideas taken from drivers/video/omap/ driver
 * by Imre Deak.
 */

#ifndef __DRIVERS_VIDEO_OMAP2_OMAPFB_H__
#define __DRIVERS_VIDEO_OMAP2_OMAPFB_H__

#ifdef CONFIG_FB_OMAP2_DEBUG_SUPPORT
#define DEBUG
#endif

#include <linux/rwsem.h>
#include <linux/dma-mapping.h>

#include <video/omapfb_dss.h>

#ifdef DEBUG
extern bool omapfb_debug;
#define DBG(format, ...) \
        do { \
                if (omapfb_debug) \
                        printk(KERN_DEBUG "OMAPFB: " format, ## __VA_ARGS__); \
        } while (0)
#else
#define DBG(format, ...) no_printk(format, ## __VA_ARGS__)
#endif

#define FB2OFB(fb_info) ((struct omapfb_info *)(fb_info->par))

/* max number of overlays to which a framebuffer data can be direct */
#define OMAPFB_MAX_OVL_PER_FB 3

struct omapfb2_mem_region {
        int             id;
        unsigned long   attrs;
        void            *token;
        dma_addr_t      dma_handle;
        u32             paddr;
        void __iomem    *vaddr;
        struct vrfb     vrfb;
        unsigned long   size;
        u8              type;           /* OMAPFB_PLANE_MEM_* */
        bool            alloc;          /* allocated by the driver */
        bool            map;            /* kernel mapped by the driver */
        atomic_t        map_count;
        struct rw_semaphore lock;
        atomic_t        lock_count;
};

/* appended to fb_info */
struct omapfb_info {
        int id;
        struct omapfb2_mem_region *region;
        int num_overlays;
        struct omap_overlay *overlays[OMAPFB_MAX_OVL_PER_FB];
        struct omapfb2_device *fbdev;
        enum omap_dss_rotation_type rotation_type;
        u8 rotation[OMAPFB_MAX_OVL_PER_FB];
        bool mirror;
};

struct omapfb_display_data {
        struct omapfb2_device *fbdev;
        struct omap_dss_device *dssdev;
        u8 bpp_override;
        enum omapfb_update_mode update_mode;
        bool auto_update_work_enabled;
        struct delayed_work auto_update_work;
};

struct omapfb2_device {
        struct device *dev;
        struct mutex  mtx;

        u32 pseudo_palette[17];

        int state;

        unsigned num_fbs;
        struct fb_info *fbs[10];
        struct omapfb2_mem_region regions[10];

        unsigned num_displays;
        struct omapfb_display_data displays[10];
        unsigned num_overlays;
        struct omap_overlay *overlays[10];
        unsigned num_managers;
        struct omap_overlay_manager *managers[10];

        struct workqueue_struct *auto_update_wq;
};

struct omapfb_colormode {
        enum omap_color_mode dssmode;
        u32 bits_per_pixel;
        u32 nonstd;
        struct fb_bitfield red;
        struct fb_bitfield green;
        struct fb_bitfield blue;
        struct fb_bitfield transp;
};

void set_fb_fix(struct fb_info *fbi);
int check_fb_var(struct fb_info *fbi, struct fb_var_screeninfo *var);
int omapfb_realloc_fbmem(struct fb_info *fbi, unsigned long size, int type);
int omapfb_apply_changes(struct fb_info *fbi, int init);

int omapfb_create_sysfs(struct omapfb2_device *fbdev);
void omapfb_remove_sysfs(struct omapfb2_device *fbdev);

int omapfb_ioctl(struct fb_info *fbi, unsigned int cmd, unsigned long arg);

int dss_mode_to_fb_mode(enum omap_color_mode dssmode,
                        struct fb_var_screeninfo *var);

int omapfb_setup_overlay(struct fb_info *fbi, struct omap_overlay *ovl,
                u16 posx, u16 posy, u16 outw, u16 outh);

void omapfb_start_auto_update(struct omapfb2_device *fbdev,
                struct omap_dss_device *display);
void omapfb_stop_auto_update(struct omapfb2_device *fbdev,
                struct omap_dss_device *display);
int omapfb_get_update_mode(struct fb_info *fbi, enum omapfb_update_mode *mode);
int omapfb_set_update_mode(struct fb_info *fbi, enum omapfb_update_mode mode);

/* find the display connected to this fb, if any */
static inline struct omap_dss_device *fb2display(struct fb_info *fbi)
{
        struct omapfb_info *ofbi = FB2OFB(fbi);
        struct omap_overlay *ovl;

        /* XXX: returns the display connected to first attached overlay */

        if (ofbi->num_overlays == 0)
                return NULL;

        ovl = ofbi->overlays[0];

        return ovl->get_device(ovl);
}

static inline struct omapfb_display_data *get_display_data(
                struct omapfb2_device *fbdev, struct omap_dss_device *dssdev)
{
        int i;

        for (i = 0; i < fbdev->num_displays; ++i)
                if (fbdev->displays[i].dssdev == dssdev)
                        return &fbdev->displays[i];

        /* This should never happen */
        BUG();
        return NULL;
}

static inline void omapfb_lock(struct omapfb2_device *fbdev)
{
        mutex_lock(&fbdev->mtx);
}

static inline void omapfb_unlock(struct omapfb2_device *fbdev)
{
        mutex_unlock(&fbdev->mtx);
}

static inline int omapfb_overlay_enable(struct omap_overlay *ovl,
                int enable)
{
        if (enable)
                return ovl->enable(ovl);
        else
                return ovl->disable(ovl);
}

static inline struct omapfb2_mem_region *
omapfb_get_mem_region(struct omapfb2_mem_region *rg)
{
        down_read_nested(&rg->lock, rg->id);
        atomic_inc(&rg->lock_count);
        return rg;
}

static inline void omapfb_put_mem_region(struct omapfb2_mem_region *rg)
{
        atomic_dec(&rg->lock_count);
        up_read(&rg->lock);
}

#endif