drm_file.h

Go to the documentation of this file.

/*
 * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
 * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
 * Copyright (c) 2009-2010, Code Aurora Forum.
 * All rights reserved.
 *
 * Author: Rickard E. (Rik) Faith <faith@valinux.com>
 * Author: Gareth Hughes <gareth@valinux.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice (including the next
 * paragraph) shall be included in all copies or substantial portions of the
 * Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
 * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 */
 
#ifndef _DRM_FILE_H_
#define _DRM_FILE_H_
 
#include <linux/types.h>
#include <linux/completion.h>
#include <linux/idr.h>
#include <linux/xarray.h>
 
#include <uapi/drm/drm.h>
 
#include <drm/drm_prime.h>
 
struct dma_fence;
struct drm_file;
struct drm_device;
struct drm_printer;
struct device;
struct file;
 
extern struct xarray drm_minors_xa;
 
/*
 * FIXME: Not sure we want to have drm_minor here in the end, but to avoid
 * header include loops we need it here for now.
 */
 
/* Note that the values of this enum are ABI (it determines
 * /dev/dri/renderD* numbers).
 *
 * Setting DRM_MINOR_ACCEL to 32 gives enough space for more drm minors to
 * be implemented before we hit any future
 */
enum drm_minor_type {
    DRM_MINOR_PRIMARY = 0,
    DRM_MINOR_CONTROL = 1,
    DRM_MINOR_RENDER = 2,
    DRM_MINOR_ACCEL = 32,
};
 
struct drm_minor {
    /* private: */
    int index;          /* Minor device number */
    int type;                       /* Control or render or accel */
    struct device *kdev;        /* Linux device */
    struct drm_device *dev;
 
    struct dentry *debugfs_symlink;
    struct dentry *debugfs_root;
};
 
struct drm_pending_event {
    struct completion *completion;
 
    void (*completion_release)(struct completion *completion);
 
    struct drm_event *event;
 
    struct dma_fence *fence;
 
    struct drm_file *file_priv;
 
    struct list_head link;
 
    struct list_head pending_link;
};
 
struct drm_file {
    bool authenticated;
 
    bool stereo_allowed;
 
    bool universal_planes;
 
    bool atomic;
 
    bool aspect_ratio_allowed;
 
    bool writeback_connectors;
 
    bool plane_color_pipeline;
 
    bool was_master;
 
    bool is_master;
 
    bool supports_virtualized_cursor_plane;
 
    struct drm_master *master;
 
    spinlock_t master_lookup_lock;
 
    struct pid __rcu *pid;
 
    u64 client_id;
 
    drm_magic_t magic;
 
    struct list_head lhead;
 
    struct drm_minor *minor;
 
    struct idr object_idr;
 
    spinlock_t table_lock;
 
    struct xarray syncobj_xa;
 
    struct file *filp;
 
    void *driver_priv;
 
    struct list_head fbs;
 
    struct mutex fbs_lock;
 
    struct list_head blobs;
 
    wait_queue_head_t event_wait;
 
    struct list_head pending_event_list;
 
    struct list_head event_list;
 
    int event_space;
 
    struct mutex event_read_lock;
 
    struct drm_prime_file_private prime;
 
    const char *client_name;
 
    struct mutex client_name_lock;
 
    struct dentry *debugfs_client;
};
 
static inline bool drm_is_primary_client(const struct drm_file *file_priv)
{
    return file_priv->minor->type == DRM_MINOR_PRIMARY;
}
 
static inline bool drm_is_render_client(const struct drm_file *file_priv)
{
    return file_priv->minor->type == DRM_MINOR_RENDER;
}
 
static inline bool drm_is_accel_client(const struct drm_file *file_priv)
{
    return file_priv->minor->type == DRM_MINOR_ACCEL;
}
 
__printf(2, 3)
void drm_file_err(struct drm_file *file_priv, const char *fmt, ...);
 
void drm_file_update_pid(struct drm_file *);
 
struct drm_minor *drm_minor_acquire(struct xarray *minors_xa, unsigned int minor_id);
void drm_minor_release(struct drm_minor *minor);
 
int drm_open(struct inode *inode, struct file *filp);
int drm_open_helper(struct file *filp, struct drm_minor *minor);
ssize_t drm_read(struct file *filp, char __user *buffer,
         size_t count, loff_t *offset);
int drm_release(struct inode *inode, struct file *filp);
int drm_release_noglobal(struct inode *inode, struct file *filp);
__poll_t drm_poll(struct file *filp, struct poll_table_struct *wait);
int drm_event_reserve_init_locked(struct drm_device *dev,
                  struct drm_file *file_priv,
                  struct drm_pending_event *p,
                  struct drm_event *e);
int drm_event_reserve_init(struct drm_device *dev,
               struct drm_file *file_priv,
               struct drm_pending_event *p,
               struct drm_event *e);
void drm_event_cancel_free(struct drm_device *dev,
               struct drm_pending_event *p);
void drm_send_event_locked(struct drm_device *dev, struct drm_pending_event *e);
void drm_send_event(struct drm_device *dev, struct drm_pending_event *e);
void drm_send_event_timestamp_locked(struct drm_device *dev,
                     struct drm_pending_event *e,
                     ktime_t timestamp);
 
struct drm_memory_stats {
    u64 shared;
    u64 private;
    u64 resident;
    u64 purgeable;
    u64 active;
};
 
enum drm_gem_object_status;
 
int drm_memory_stats_is_zero(const struct drm_memory_stats *stats);
void drm_fdinfo_print_size(struct drm_printer *p,
               const char *prefix,
               const char *stat,
               const char *region,
               u64 sz);
void drm_print_memory_stats(struct drm_printer *p,
                const struct drm_memory_stats *stats,
                enum drm_gem_object_status supported_status,
                const char *region);
 
void drm_show_memory_stats(struct drm_printer *p, struct drm_file *file);
void drm_show_fdinfo(struct seq_file *m, struct file *f);
 
struct file *mock_drm_getfile(struct drm_minor *minor, unsigned int flags);
 
#endif /* _DRM_FILE_H_ */