LXR linux/include/drm/drm

   1#ifndef _DRM_AUTH_H_
   2#define _DRM_AUTH_H_
   3
   4/*
   5 * Internal Header for the Direct Rendering Manager
   6 *
   7 * Copyright 2016 Intel Corporation
   8 *
   9 * Author: Daniel Vetter <daniel.vetter@ffwll.ch>
  10 *
  11 * Permission is hereby granted, free of charge, to any person obtaining a
  12 * copy of this software and associated documentation files (the "Software"),
  13 * to deal in the Software without restriction, including without limitation
  14 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  15 * and/or sell copies of the Software, and to permit persons to whom the
  16 * Software is furnished to do so, subject to the following conditions:
  17 *
  18 * The above copyright notice and this permission notice (including the next
  19 * paragraph) shall be included in all copies or substantial portions of the
  20 * Software.
  21 *
  22 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  23 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  24 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  25 * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
  26 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  27 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  28 * OTHER DEALINGS IN THE SOFTWARE.
  29 */
  30
  31#include <linux/idr.h>
  32#include <linux/kref.h>
  33#include <linux/wait.h>
  34
  35struct drm_file;
  36struct drm_hw_lock;
  37
  38/*
  39 * Legacy DRI1 locking data structure. Only here instead of in drm_legacy.h for
  40 * include ordering reasons.
  41 *
  42 * DO NOT USE.
  43 */
  44struct drm_lock_data {
  45        struct drm_hw_lock *hw_lock;
  46        struct drm_file *file_priv;
  47        wait_queue_head_t lock_queue;
  48        unsigned long lock_time;
  49        spinlock_t spinlock;
  50        uint32_t kernel_waiters;
  51        uint32_t user_waiters;
  52        int idle_has_lock;
  53};
  54
  55/**
  56 * struct drm_master - drm master structure
  57 *
  58 * @refcount: Refcount for this master object.
  59 * @dev: Link back to the DRM device
  60 * @driver_priv: Pointer to driver-private information.
  61 * @lessor: Lease holder
  62 * @lessee_id: id for lessees. Owners always have id 0
  63 * @lessee_list: other lessees of the same master
  64 * @lessees: drm_masters leasing from this one
  65 * @leases: Objects leased to this drm_master.
  66 * @lessee_idr: All lessees under this owner (only used where lessor == NULL)
  67 *
  68 * Note that master structures are only relevant for the legacy/primary device
  69 * nodes, hence there can only be one per device, not one per drm_minor.
  70 */
  71struct drm_master {
  72        struct kref refcount;
  73        struct drm_device *dev;
  74        /**
  75         * @unique: Unique identifier: e.g. busid. Protected by
  76         * &drm_device.master_mutex.
  77         */
  78        char *unique;
  79        /**
  80         * @unique_len: Length of unique field. Protected by
  81         * &drm_device.master_mutex.
  82         */
  83        int unique_len;
  84        /**
  85         * @magic_map: Map of used authentication tokens. Protected by
  86         * &drm_device.master_mutex.
  87         */
  88        struct idr magic_map;
  89        void *driver_priv;
  90
  91        /* Tree of display resource leases, each of which is a drm_master struct
  92         * All of these get activated simultaneously, so drm_device master points
  93         * at the top of the tree (for which lessor is NULL). Protected by
  94         * &drm_device.mode_config.idr_mutex.
  95         */
  96
  97        struct drm_master *lessor;
  98        int     lessee_id;
  99        struct list_head lessee_list;
 100        struct list_head lessees;
 101        struct idr leases;
 102        struct idr lessee_idr;
 103        /* private: */
 104#if IS_ENABLED(CONFIG_DRM_LEGACY)
 105        struct drm_lock_data lock;
 106#endif
 107};
 108
 109struct drm_master *drm_master_get(struct drm_master *master);
 110void drm_master_put(struct drm_master **master);
 111bool drm_is_current_master(struct drm_file *fpriv);
 112
 113struct drm_master *drm_master_create(struct drm_device *dev);
 114
 115#endif
 116