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