drm_drv.c 27 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004
  1. /*
  2. * Created: Fri Jan 19 10:48:35 2001 by faith@acm.org
  3. *
  4. * Copyright 2001 VA Linux Systems, Inc., Sunnyvale, California.
  5. * All Rights Reserved.
  6. *
  7. * Author Rickard E. (Rik) Faith <faith@valinux.com>
  8. *
  9. * Permission is hereby granted, free of charge, to any person obtaining a
  10. * copy of this software and associated documentation files (the "Software"),
  11. * to deal in the Software without restriction, including without limitation
  12. * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  13. * and/or sell copies of the Software, and to permit persons to whom the
  14. * Software is furnished to do so, subject to the following conditions:
  15. *
  16. * The above copyright notice and this permission notice (including the next
  17. * paragraph) shall be included in all copies or substantial portions of the
  18. * Software.
  19. *
  20. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  21. * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  22. * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  23. * PRECISION INSIGHT AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
  24. * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  25. * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  26. * DEALINGS IN THE SOFTWARE.
  27. */
  28. #include <linux/debugfs.h>
  29. #include <linux/fs.h>
  30. #include <linux/module.h>
  31. #include <linux/moduleparam.h>
  32. #include <linux/mount.h>
  33. #include <linux/slab.h>
  34. #include <drm/drm_drv.h>
  35. #include <drm/drmP.h>
  36. #include "drm_crtc_internal.h"
  37. #include "drm_legacy.h"
  38. #include "drm_internal.h"
  39. #include "drm_crtc_internal.h"
  40. /*
  41. * drm_debug: Enable debug output.
  42. * Bitmask of DRM_UT_x. See include/drm/drmP.h for details.
  43. */
  44. unsigned int drm_debug = 0;
  45. EXPORT_SYMBOL(drm_debug);
  46. MODULE_AUTHOR("Gareth Hughes, Leif Delgass, José Fonseca, Jon Smirl");
  47. MODULE_DESCRIPTION("DRM shared core routines");
  48. MODULE_LICENSE("GPL and additional rights");
  49. MODULE_PARM_DESC(debug, "Enable debug output, where each bit enables a debug category.\n"
  50. "\t\tBit 0 (0x01) will enable CORE messages (drm core code)\n"
  51. "\t\tBit 1 (0x02) will enable DRIVER messages (drm controller code)\n"
  52. "\t\tBit 2 (0x04) will enable KMS messages (modesetting code)\n"
  53. "\t\tBit 3 (0x08) will enable PRIME messages (prime code)\n"
  54. "\t\tBit 4 (0x10) will enable ATOMIC messages (atomic code)\n"
  55. "\t\tBit 5 (0x20) will enable VBL messages (vblank code)");
  56. module_param_named(debug, drm_debug, int, 0600);
  57. static DEFINE_SPINLOCK(drm_minor_lock);
  58. static struct idr drm_minors_idr;
  59. /*
  60. * If the drm core fails to init for whatever reason,
  61. * we should prevent any drivers from registering with it.
  62. * It's best to check this at drm_dev_init(), as some drivers
  63. * prefer to embed struct drm_device into their own device
  64. * structure and call drm_dev_init() themselves.
  65. */
  66. static bool drm_core_init_complete = false;
  67. static struct dentry *drm_debugfs_root;
  68. #define DRM_PRINTK_FMT "[" DRM_NAME ":%s]%s %pV"
  69. void drm_dev_printk(const struct device *dev, const char *level,
  70. unsigned int category, const char *function_name,
  71. const char *prefix, const char *format, ...)
  72. {
  73. struct va_format vaf;
  74. va_list args;
  75. if (category != DRM_UT_NONE && !(drm_debug & category))
  76. return;
  77. va_start(args, format);
  78. vaf.fmt = format;
  79. vaf.va = &args;
  80. if (dev)
  81. dev_printk(level, dev, DRM_PRINTK_FMT, function_name, prefix,
  82. &vaf);
  83. else
  84. printk("%s" DRM_PRINTK_FMT, level, function_name, prefix, &vaf);
  85. va_end(args);
  86. }
  87. EXPORT_SYMBOL(drm_dev_printk);
  88. void drm_printk(const char *level, unsigned int category,
  89. const char *format, ...)
  90. {
  91. struct va_format vaf;
  92. va_list args;
  93. if (category != DRM_UT_NONE && !(drm_debug & category))
  94. return;
  95. va_start(args, format);
  96. vaf.fmt = format;
  97. vaf.va = &args;
  98. printk("%s" "[" DRM_NAME ":%ps]%s %pV",
  99. level, __builtin_return_address(0),
  100. strcmp(level, KERN_ERR) == 0 ? " *ERROR*" : "", &vaf);
  101. va_end(args);
  102. }
  103. EXPORT_SYMBOL(drm_printk);
  104. /*
  105. * DRM Minors
  106. * A DRM device can provide several char-dev interfaces on the DRM-Major. Each
  107. * of them is represented by a drm_minor object. Depending on the capabilities
  108. * of the device-driver, different interfaces are registered.
  109. *
  110. * Minors can be accessed via dev->$minor_name. This pointer is either
  111. * NULL or a valid drm_minor pointer and stays valid as long as the device is
  112. * valid. This means, DRM minors have the same life-time as the underlying
  113. * device. However, this doesn't mean that the minor is active. Minors are
  114. * registered and unregistered dynamically according to device-state.
  115. */
  116. static struct drm_minor **drm_minor_get_slot(struct drm_device *dev,
  117. unsigned int type)
  118. {
  119. switch (type) {
  120. case DRM_MINOR_PRIMARY:
  121. return &dev->primary;
  122. case DRM_MINOR_RENDER:
  123. return &dev->render;
  124. case DRM_MINOR_CONTROL:
  125. return &dev->control;
  126. default:
  127. return NULL;
  128. }
  129. }
  130. static int drm_minor_alloc(struct drm_device *dev, unsigned int type)
  131. {
  132. struct drm_minor *minor;
  133. unsigned long flags;
  134. int r;
  135. minor = kzalloc(sizeof(*minor), GFP_KERNEL);
  136. if (!minor)
  137. return -ENOMEM;
  138. minor->type = type;
  139. minor->dev = dev;
  140. idr_preload(GFP_KERNEL);
  141. spin_lock_irqsave(&drm_minor_lock, flags);
  142. r = idr_alloc(&drm_minors_idr,
  143. NULL,
  144. 64 * type,
  145. 64 * (type + 1),
  146. GFP_NOWAIT);
  147. spin_unlock_irqrestore(&drm_minor_lock, flags);
  148. idr_preload_end();
  149. if (r < 0)
  150. goto err_free;
  151. minor->index = r;
  152. minor->kdev = drm_sysfs_minor_alloc(minor);
  153. if (IS_ERR(minor->kdev)) {
  154. r = PTR_ERR(minor->kdev);
  155. goto err_index;
  156. }
  157. *drm_minor_get_slot(dev, type) = minor;
  158. return 0;
  159. err_index:
  160. spin_lock_irqsave(&drm_minor_lock, flags);
  161. idr_remove(&drm_minors_idr, minor->index);
  162. spin_unlock_irqrestore(&drm_minor_lock, flags);
  163. err_free:
  164. kfree(minor);
  165. return r;
  166. }
  167. static void drm_minor_free(struct drm_device *dev, unsigned int type)
  168. {
  169. struct drm_minor **slot, *minor;
  170. unsigned long flags;
  171. slot = drm_minor_get_slot(dev, type);
  172. minor = *slot;
  173. if (!minor)
  174. return;
  175. put_device(minor->kdev);
  176. spin_lock_irqsave(&drm_minor_lock, flags);
  177. idr_remove(&drm_minors_idr, minor->index);
  178. spin_unlock_irqrestore(&drm_minor_lock, flags);
  179. kfree(minor);
  180. *slot = NULL;
  181. }
  182. static int drm_minor_register(struct drm_device *dev, unsigned int type)
  183. {
  184. struct drm_minor *minor;
  185. unsigned long flags;
  186. int ret;
  187. DRM_DEBUG("\n");
  188. minor = *drm_minor_get_slot(dev, type);
  189. if (!minor)
  190. return 0;
  191. ret = drm_debugfs_init(minor, minor->index, drm_debugfs_root);
  192. if (ret) {
  193. DRM_ERROR("DRM: Failed to initialize /sys/kernel/debug/dri.\n");
  194. goto err_debugfs;
  195. }
  196. ret = device_add(minor->kdev);
  197. if (ret)
  198. goto err_debugfs;
  199. /* replace NULL with @minor so lookups will succeed from now on */
  200. spin_lock_irqsave(&drm_minor_lock, flags);
  201. idr_replace(&drm_minors_idr, minor, minor->index);
  202. spin_unlock_irqrestore(&drm_minor_lock, flags);
  203. DRM_DEBUG("new minor registered %d\n", minor->index);
  204. return 0;
  205. err_debugfs:
  206. drm_debugfs_cleanup(minor);
  207. return ret;
  208. }
  209. static void drm_minor_unregister(struct drm_device *dev, unsigned int type)
  210. {
  211. struct drm_minor *minor;
  212. unsigned long flags;
  213. minor = *drm_minor_get_slot(dev, type);
  214. if (!minor || !device_is_registered(minor->kdev))
  215. return;
  216. /* replace @minor with NULL so lookups will fail from now on */
  217. spin_lock_irqsave(&drm_minor_lock, flags);
  218. idr_replace(&drm_minors_idr, NULL, minor->index);
  219. spin_unlock_irqrestore(&drm_minor_lock, flags);
  220. device_del(minor->kdev);
  221. dev_set_drvdata(minor->kdev, NULL); /* safety belt */
  222. drm_debugfs_cleanup(minor);
  223. }
  224. /*
  225. * Looks up the given minor-ID and returns the respective DRM-minor object. The
  226. * refence-count of the underlying device is increased so you must release this
  227. * object with drm_minor_release().
  228. *
  229. * As long as you hold this minor, it is guaranteed that the object and the
  230. * minor->dev pointer will stay valid! However, the device may get unplugged and
  231. * unregistered while you hold the minor.
  232. */
  233. struct drm_minor *drm_minor_acquire(unsigned int minor_id)
  234. {
  235. struct drm_minor *minor;
  236. unsigned long flags;
  237. spin_lock_irqsave(&drm_minor_lock, flags);
  238. minor = idr_find(&drm_minors_idr, minor_id);
  239. if (minor)
  240. drm_dev_ref(minor->dev);
  241. spin_unlock_irqrestore(&drm_minor_lock, flags);
  242. if (!minor) {
  243. return ERR_PTR(-ENODEV);
  244. } else if (drm_dev_is_unplugged(minor->dev)) {
  245. drm_dev_unref(minor->dev);
  246. return ERR_PTR(-ENODEV);
  247. }
  248. return minor;
  249. }
  250. void drm_minor_release(struct drm_minor *minor)
  251. {
  252. drm_dev_unref(minor->dev);
  253. }
  254. /**
  255. * DOC: driver instance overview
  256. *
  257. * A device instance for a drm driver is represented by &struct drm_device. This
  258. * is allocated with drm_dev_alloc(), usually from bus-specific ->probe()
  259. * callbacks implemented by the driver. The driver then needs to initialize all
  260. * the various subsystems for the drm device like memory management, vblank
  261. * handling, modesetting support and intial output configuration plus obviously
  262. * initialize all the corresponding hardware bits. An important part of this is
  263. * also calling drm_dev_set_unique() to set the userspace-visible unique name of
  264. * this device instance. Finally when everything is up and running and ready for
  265. * userspace the device instance can be published using drm_dev_register().
  266. *
  267. * There is also deprecated support for initalizing device instances using
  268. * bus-specific helpers and the &drm_driver.load callback. But due to
  269. * backwards-compatibility needs the device instance have to be published too
  270. * early, which requires unpretty global locking to make safe and is therefore
  271. * only support for existing drivers not yet converted to the new scheme.
  272. *
  273. * When cleaning up a device instance everything needs to be done in reverse:
  274. * First unpublish the device instance with drm_dev_unregister(). Then clean up
  275. * any other resources allocated at device initialization and drop the driver's
  276. * reference to &drm_device using drm_dev_unref().
  277. *
  278. * Note that the lifetime rules for &drm_device instance has still a lot of
  279. * historical baggage. Hence use the reference counting provided by
  280. * drm_dev_ref() and drm_dev_unref() only carefully.
  281. *
  282. * It is recommended that drivers embed &struct drm_device into their own device
  283. * structure, which is supported through drm_dev_init().
  284. */
  285. /**
  286. * drm_put_dev - Unregister and release a DRM device
  287. * @dev: DRM device
  288. *
  289. * Called at module unload time or when a PCI device is unplugged.
  290. *
  291. * Cleans up all DRM device, calling drm_lastclose().
  292. *
  293. * Note: Use of this function is deprecated. It will eventually go away
  294. * completely. Please use drm_dev_unregister() and drm_dev_unref() explicitly
  295. * instead to make sure that the device isn't userspace accessible any more
  296. * while teardown is in progress, ensuring that userspace can't access an
  297. * inconsistent state.
  298. */
  299. void drm_put_dev(struct drm_device *dev)
  300. {
  301. DRM_DEBUG("\n");
  302. if (!dev) {
  303. DRM_ERROR("cleanup called no dev\n");
  304. return;
  305. }
  306. drm_dev_unregister(dev);
  307. drm_dev_unref(dev);
  308. }
  309. EXPORT_SYMBOL(drm_put_dev);
  310. static void drm_device_set_unplugged(struct drm_device *dev)
  311. {
  312. smp_wmb();
  313. atomic_set(&dev->unplugged, 1);
  314. }
  315. /**
  316. * drm_dev_unplug - unplug a DRM device
  317. * @dev: DRM device
  318. *
  319. * This unplugs a hotpluggable DRM device, which makes it inaccessible to
  320. * userspace operations. Entry-points can use drm_dev_is_unplugged(). This
  321. * essentially unregisters the device like drm_dev_unregister(), but can be
  322. * called while there are still open users of @dev.
  323. */
  324. void drm_dev_unplug(struct drm_device *dev)
  325. {
  326. drm_dev_unregister(dev);
  327. mutex_lock(&drm_global_mutex);
  328. drm_device_set_unplugged(dev);
  329. if (dev->open_count == 0)
  330. drm_dev_unref(dev);
  331. mutex_unlock(&drm_global_mutex);
  332. }
  333. EXPORT_SYMBOL(drm_dev_unplug);
  334. /*
  335. * DRM internal mount
  336. * We want to be able to allocate our own "struct address_space" to control
  337. * memory-mappings in VRAM (or stolen RAM, ...). However, core MM does not allow
  338. * stand-alone address_space objects, so we need an underlying inode. As there
  339. * is no way to allocate an independent inode easily, we need a fake internal
  340. * VFS mount-point.
  341. *
  342. * The drm_fs_inode_new() function allocates a new inode, drm_fs_inode_free()
  343. * frees it again. You are allowed to use iget() and iput() to get references to
  344. * the inode. But each drm_fs_inode_new() call must be paired with exactly one
  345. * drm_fs_inode_free() call (which does not have to be the last iput()).
  346. * We use drm_fs_inode_*() to manage our internal VFS mount-point and share it
  347. * between multiple inode-users. You could, technically, call
  348. * iget() + drm_fs_inode_free() directly after alloc and sometime later do an
  349. * iput(), but this way you'd end up with a new vfsmount for each inode.
  350. */
  351. static int drm_fs_cnt;
  352. static struct vfsmount *drm_fs_mnt;
  353. static const struct dentry_operations drm_fs_dops = {
  354. .d_dname = simple_dname,
  355. };
  356. static const struct super_operations drm_fs_sops = {
  357. .statfs = simple_statfs,
  358. };
  359. static struct dentry *drm_fs_mount(struct file_system_type *fs_type, int flags,
  360. const char *dev_name, void *data)
  361. {
  362. return mount_pseudo(fs_type,
  363. "drm:",
  364. &drm_fs_sops,
  365. &drm_fs_dops,
  366. 0x010203ff);
  367. }
  368. static struct file_system_type drm_fs_type = {
  369. .name = "drm",
  370. .owner = THIS_MODULE,
  371. .mount = drm_fs_mount,
  372. .kill_sb = kill_anon_super,
  373. };
  374. static struct inode *drm_fs_inode_new(void)
  375. {
  376. struct inode *inode;
  377. int r;
  378. r = simple_pin_fs(&drm_fs_type, &drm_fs_mnt, &drm_fs_cnt);
  379. if (r < 0) {
  380. DRM_ERROR("Cannot mount pseudo fs: %d\n", r);
  381. return ERR_PTR(r);
  382. }
  383. inode = alloc_anon_inode(drm_fs_mnt->mnt_sb);
  384. if (IS_ERR(inode))
  385. simple_release_fs(&drm_fs_mnt, &drm_fs_cnt);
  386. return inode;
  387. }
  388. static void drm_fs_inode_free(struct inode *inode)
  389. {
  390. if (inode) {
  391. iput(inode);
  392. simple_release_fs(&drm_fs_mnt, &drm_fs_cnt);
  393. }
  394. }
  395. /**
  396. * drm_dev_init - Initialise new DRM device
  397. * @dev: DRM device
  398. * @driver: DRM driver
  399. * @parent: Parent device object
  400. *
  401. * Initialize a new DRM device. No device registration is done.
  402. * Call drm_dev_register() to advertice the device to user space and register it
  403. * with other core subsystems. This should be done last in the device
  404. * initialization sequence to make sure userspace can't access an inconsistent
  405. * state.
  406. *
  407. * The initial ref-count of the object is 1. Use drm_dev_ref() and
  408. * drm_dev_unref() to take and drop further ref-counts.
  409. *
  410. * Note that for purely virtual devices @parent can be NULL.
  411. *
  412. * Drivers that do not want to allocate their own device struct
  413. * embedding &struct drm_device can call drm_dev_alloc() instead. For drivers
  414. * that do embed &struct drm_device it must be placed first in the overall
  415. * structure, and the overall structure must be allocated using kmalloc(): The
  416. * drm core's release function unconditionally calls kfree() on the @dev pointer
  417. * when the final reference is released. To override this behaviour, and so
  418. * allow embedding of the drm_device inside the driver's device struct at an
  419. * arbitrary offset, you must supply a &drm_driver.release callback and control
  420. * the finalization explicitly.
  421. *
  422. * RETURNS:
  423. * 0 on success, or error code on failure.
  424. */
  425. int drm_dev_init(struct drm_device *dev,
  426. struct drm_driver *driver,
  427. struct device *parent)
  428. {
  429. int ret;
  430. if (!drm_core_init_complete) {
  431. DRM_ERROR("DRM core is not initialized\n");
  432. return -ENODEV;
  433. }
  434. kref_init(&dev->ref);
  435. dev->dev = parent;
  436. dev->driver = driver;
  437. INIT_LIST_HEAD(&dev->filelist);
  438. INIT_LIST_HEAD(&dev->ctxlist);
  439. INIT_LIST_HEAD(&dev->vmalist);
  440. INIT_LIST_HEAD(&dev->maplist);
  441. INIT_LIST_HEAD(&dev->vblank_event_list);
  442. spin_lock_init(&dev->buf_lock);
  443. spin_lock_init(&dev->event_lock);
  444. mutex_init(&dev->struct_mutex);
  445. mutex_init(&dev->filelist_mutex);
  446. mutex_init(&dev->ctxlist_mutex);
  447. mutex_init(&dev->master_mutex);
  448. dev->anon_inode = drm_fs_inode_new();
  449. if (IS_ERR(dev->anon_inode)) {
  450. ret = PTR_ERR(dev->anon_inode);
  451. DRM_ERROR("Cannot allocate anonymous inode: %d\n", ret);
  452. goto err_free;
  453. }
  454. if (drm_core_check_feature(dev, DRIVER_RENDER)) {
  455. ret = drm_minor_alloc(dev, DRM_MINOR_RENDER);
  456. if (ret)
  457. goto err_minors;
  458. }
  459. ret = drm_minor_alloc(dev, DRM_MINOR_PRIMARY);
  460. if (ret)
  461. goto err_minors;
  462. ret = drm_ht_create(&dev->map_hash, 12);
  463. if (ret)
  464. goto err_minors;
  465. drm_legacy_ctxbitmap_init(dev);
  466. if (drm_core_check_feature(dev, DRIVER_GEM)) {
  467. ret = drm_gem_init(dev);
  468. if (ret) {
  469. DRM_ERROR("Cannot initialize graphics execution manager (GEM)\n");
  470. goto err_ctxbitmap;
  471. }
  472. }
  473. /* Use the parent device name as DRM device unique identifier, but fall
  474. * back to the driver name for virtual devices like vgem. */
  475. ret = drm_dev_set_unique(dev, parent ? dev_name(parent) : driver->name);
  476. if (ret)
  477. goto err_setunique;
  478. return 0;
  479. err_setunique:
  480. if (drm_core_check_feature(dev, DRIVER_GEM))
  481. drm_gem_destroy(dev);
  482. err_ctxbitmap:
  483. drm_legacy_ctxbitmap_cleanup(dev);
  484. drm_ht_remove(&dev->map_hash);
  485. err_minors:
  486. drm_minor_free(dev, DRM_MINOR_PRIMARY);
  487. drm_minor_free(dev, DRM_MINOR_RENDER);
  488. drm_minor_free(dev, DRM_MINOR_CONTROL);
  489. drm_fs_inode_free(dev->anon_inode);
  490. err_free:
  491. mutex_destroy(&dev->master_mutex);
  492. mutex_destroy(&dev->ctxlist_mutex);
  493. mutex_destroy(&dev->filelist_mutex);
  494. mutex_destroy(&dev->struct_mutex);
  495. return ret;
  496. }
  497. EXPORT_SYMBOL(drm_dev_init);
  498. /**
  499. * drm_dev_fini - Finalize a dead DRM device
  500. * @dev: DRM device
  501. *
  502. * Finalize a dead DRM device. This is the converse to drm_dev_init() and
  503. * frees up all data allocated by it. All driver private data should be
  504. * finalized first. Note that this function does not free the @dev, that is
  505. * left to the caller.
  506. *
  507. * The ref-count of @dev must be zero, and drm_dev_fini() should only be called
  508. * from a &drm_driver.release callback.
  509. */
  510. void drm_dev_fini(struct drm_device *dev)
  511. {
  512. drm_vblank_cleanup(dev);
  513. if (drm_core_check_feature(dev, DRIVER_GEM))
  514. drm_gem_destroy(dev);
  515. drm_legacy_ctxbitmap_cleanup(dev);
  516. drm_ht_remove(&dev->map_hash);
  517. drm_fs_inode_free(dev->anon_inode);
  518. drm_minor_free(dev, DRM_MINOR_PRIMARY);
  519. drm_minor_free(dev, DRM_MINOR_RENDER);
  520. drm_minor_free(dev, DRM_MINOR_CONTROL);
  521. mutex_destroy(&dev->master_mutex);
  522. mutex_destroy(&dev->ctxlist_mutex);
  523. mutex_destroy(&dev->filelist_mutex);
  524. mutex_destroy(&dev->struct_mutex);
  525. kfree(dev->unique);
  526. }
  527. EXPORT_SYMBOL(drm_dev_fini);
  528. /**
  529. * drm_dev_alloc - Allocate new DRM device
  530. * @driver: DRM driver to allocate device for
  531. * @parent: Parent device object
  532. *
  533. * Allocate and initialize a new DRM device. No device registration is done.
  534. * Call drm_dev_register() to advertice the device to user space and register it
  535. * with other core subsystems. This should be done last in the device
  536. * initialization sequence to make sure userspace can't access an inconsistent
  537. * state.
  538. *
  539. * The initial ref-count of the object is 1. Use drm_dev_ref() and
  540. * drm_dev_unref() to take and drop further ref-counts.
  541. *
  542. * Note that for purely virtual devices @parent can be NULL.
  543. *
  544. * Drivers that wish to subclass or embed &struct drm_device into their
  545. * own struct should look at using drm_dev_init() instead.
  546. *
  547. * RETURNS:
  548. * Pointer to new DRM device, or ERR_PTR on failure.
  549. */
  550. struct drm_device *drm_dev_alloc(struct drm_driver *driver,
  551. struct device *parent)
  552. {
  553. struct drm_device *dev;
  554. int ret;
  555. dev = kzalloc(sizeof(*dev), GFP_KERNEL);
  556. if (!dev)
  557. return ERR_PTR(-ENOMEM);
  558. ret = drm_dev_init(dev, driver, parent);
  559. if (ret) {
  560. kfree(dev);
  561. return ERR_PTR(ret);
  562. }
  563. return dev;
  564. }
  565. EXPORT_SYMBOL(drm_dev_alloc);
  566. static void drm_dev_release(struct kref *ref)
  567. {
  568. struct drm_device *dev = container_of(ref, struct drm_device, ref);
  569. if (dev->driver->release) {
  570. dev->driver->release(dev);
  571. } else {
  572. drm_dev_fini(dev);
  573. kfree(dev);
  574. }
  575. }
  576. /**
  577. * drm_dev_ref - Take reference of a DRM device
  578. * @dev: device to take reference of or NULL
  579. *
  580. * This increases the ref-count of @dev by one. You *must* already own a
  581. * reference when calling this. Use drm_dev_unref() to drop this reference
  582. * again.
  583. *
  584. * This function never fails. However, this function does not provide *any*
  585. * guarantee whether the device is alive or running. It only provides a
  586. * reference to the object and the memory associated with it.
  587. */
  588. void drm_dev_ref(struct drm_device *dev)
  589. {
  590. if (dev)
  591. kref_get(&dev->ref);
  592. }
  593. EXPORT_SYMBOL(drm_dev_ref);
  594. /**
  595. * drm_dev_unref - Drop reference of a DRM device
  596. * @dev: device to drop reference of or NULL
  597. *
  598. * This decreases the ref-count of @dev by one. The device is destroyed if the
  599. * ref-count drops to zero.
  600. */
  601. void drm_dev_unref(struct drm_device *dev)
  602. {
  603. if (dev)
  604. kref_put(&dev->ref, drm_dev_release);
  605. }
  606. EXPORT_SYMBOL(drm_dev_unref);
  607. static int create_compat_control_link(struct drm_device *dev)
  608. {
  609. struct drm_minor *minor;
  610. char *name;
  611. int ret;
  612. if (!drm_core_check_feature(dev, DRIVER_MODESET))
  613. return 0;
  614. minor = *drm_minor_get_slot(dev, DRM_MINOR_PRIMARY);
  615. if (!minor)
  616. return 0;
  617. /*
  618. * Some existing userspace out there uses the existing of the controlD*
  619. * sysfs files to figure out whether it's a modeset driver. It only does
  620. * readdir, hence a symlink is sufficient (and the least confusing
  621. * option). Otherwise controlD* is entirely unused.
  622. *
  623. * Old controlD chardev have been allocated in the range
  624. * 64-127.
  625. */
  626. name = kasprintf(GFP_KERNEL, "controlD%d", minor->index + 64);
  627. if (!name)
  628. return -ENOMEM;
  629. ret = sysfs_create_link(minor->kdev->kobj.parent,
  630. &minor->kdev->kobj,
  631. name);
  632. kfree(name);
  633. return ret;
  634. }
  635. static void remove_compat_control_link(struct drm_device *dev)
  636. {
  637. struct drm_minor *minor;
  638. char *name;
  639. if (!drm_core_check_feature(dev, DRIVER_MODESET))
  640. return;
  641. minor = *drm_minor_get_slot(dev, DRM_MINOR_PRIMARY);
  642. if (!minor)
  643. return;
  644. name = kasprintf(GFP_KERNEL, "controlD%d", minor->index);
  645. if (!name)
  646. return;
  647. sysfs_remove_link(minor->kdev->kobj.parent, name);
  648. kfree(name);
  649. }
  650. /**
  651. * drm_dev_register - Register DRM device
  652. * @dev: Device to register
  653. * @flags: Flags passed to the driver's .load() function
  654. *
  655. * Register the DRM device @dev with the system, advertise device to user-space
  656. * and start normal device operation. @dev must be allocated via drm_dev_alloc()
  657. * previously.
  658. *
  659. * Never call this twice on any device!
  660. *
  661. * NOTE: To ensure backward compatibility with existing drivers method this
  662. * function calls the &drm_driver.load method after registering the device
  663. * nodes, creating race conditions. Usage of the &drm_driver.load methods is
  664. * therefore deprecated, drivers must perform all initialization before calling
  665. * drm_dev_register().
  666. *
  667. * RETURNS:
  668. * 0 on success, negative error code on failure.
  669. */
  670. int drm_dev_register(struct drm_device *dev, unsigned long flags)
  671. {
  672. struct drm_driver *driver = dev->driver;
  673. int ret;
  674. mutex_lock(&drm_global_mutex);
  675. ret = drm_minor_register(dev, DRM_MINOR_CONTROL);
  676. if (ret)
  677. goto err_minors;
  678. ret = drm_minor_register(dev, DRM_MINOR_RENDER);
  679. if (ret)
  680. goto err_minors;
  681. ret = drm_minor_register(dev, DRM_MINOR_PRIMARY);
  682. if (ret)
  683. goto err_minors;
  684. ret = create_compat_control_link(dev);
  685. if (ret)
  686. goto err_minors;
  687. dev->registered = true;
  688. if (dev->driver->load) {
  689. ret = dev->driver->load(dev, flags);
  690. if (ret)
  691. goto err_minors;
  692. }
  693. if (drm_core_check_feature(dev, DRIVER_MODESET))
  694. drm_modeset_register_all(dev);
  695. ret = 0;
  696. DRM_INFO("Initialized %s %d.%d.%d %s for %s on minor %d\n",
  697. driver->name, driver->major, driver->minor,
  698. driver->patchlevel, driver->date,
  699. dev->dev ? dev_name(dev->dev) : "virtual device",
  700. dev->primary->index);
  701. goto out_unlock;
  702. err_minors:
  703. remove_compat_control_link(dev);
  704. drm_minor_unregister(dev, DRM_MINOR_PRIMARY);
  705. drm_minor_unregister(dev, DRM_MINOR_RENDER);
  706. drm_minor_unregister(dev, DRM_MINOR_CONTROL);
  707. out_unlock:
  708. mutex_unlock(&drm_global_mutex);
  709. return ret;
  710. }
  711. EXPORT_SYMBOL(drm_dev_register);
  712. /**
  713. * drm_dev_unregister - Unregister DRM device
  714. * @dev: Device to unregister
  715. *
  716. * Unregister the DRM device from the system. This does the reverse of
  717. * drm_dev_register() but does not deallocate the device. The caller must call
  718. * drm_dev_unref() to drop their final reference.
  719. *
  720. * A special form of unregistering for hotpluggable devices is drm_dev_unplug(),
  721. * which can be called while there are still open users of @dev.
  722. *
  723. * This should be called first in the device teardown code to make sure
  724. * userspace can't access the device instance any more.
  725. */
  726. void drm_dev_unregister(struct drm_device *dev)
  727. {
  728. struct drm_map_list *r_list, *list_temp;
  729. if (drm_core_check_feature(dev, DRIVER_LEGACY))
  730. drm_lastclose(dev);
  731. dev->registered = false;
  732. if (drm_core_check_feature(dev, DRIVER_MODESET))
  733. drm_modeset_unregister_all(dev);
  734. if (dev->driver->unload)
  735. dev->driver->unload(dev);
  736. if (dev->agp)
  737. drm_pci_agp_destroy(dev);
  738. list_for_each_entry_safe(r_list, list_temp, &dev->maplist, head)
  739. drm_legacy_rmmap(dev, r_list->map);
  740. remove_compat_control_link(dev);
  741. drm_minor_unregister(dev, DRM_MINOR_PRIMARY);
  742. drm_minor_unregister(dev, DRM_MINOR_RENDER);
  743. drm_minor_unregister(dev, DRM_MINOR_CONTROL);
  744. }
  745. EXPORT_SYMBOL(drm_dev_unregister);
  746. /**
  747. * drm_dev_set_unique - Set the unique name of a DRM device
  748. * @dev: device of which to set the unique name
  749. * @name: unique name
  750. *
  751. * Sets the unique name of a DRM device using the specified string. Drivers
  752. * can use this at driver probe time if the unique name of the devices they
  753. * drive is static.
  754. *
  755. * Return: 0 on success or a negative error code on failure.
  756. */
  757. int drm_dev_set_unique(struct drm_device *dev, const char *name)
  758. {
  759. kfree(dev->unique);
  760. dev->unique = kstrdup(name, GFP_KERNEL);
  761. return dev->unique ? 0 : -ENOMEM;
  762. }
  763. EXPORT_SYMBOL(drm_dev_set_unique);
  764. /*
  765. * DRM Core
  766. * The DRM core module initializes all global DRM objects and makes them
  767. * available to drivers. Once setup, drivers can probe their respective
  768. * devices.
  769. * Currently, core management includes:
  770. * - The "DRM-Global" key/value database
  771. * - Global ID management for connectors
  772. * - DRM major number allocation
  773. * - DRM minor management
  774. * - DRM sysfs class
  775. * - DRM debugfs root
  776. *
  777. * Furthermore, the DRM core provides dynamic char-dev lookups. For each
  778. * interface registered on a DRM device, you can request minor numbers from DRM
  779. * core. DRM core takes care of major-number management and char-dev
  780. * registration. A stub ->open() callback forwards any open() requests to the
  781. * registered minor.
  782. */
  783. static int drm_stub_open(struct inode *inode, struct file *filp)
  784. {
  785. const struct file_operations *new_fops;
  786. struct drm_minor *minor;
  787. int err;
  788. DRM_DEBUG("\n");
  789. mutex_lock(&drm_global_mutex);
  790. minor = drm_minor_acquire(iminor(inode));
  791. if (IS_ERR(minor)) {
  792. err = PTR_ERR(minor);
  793. goto out_unlock;
  794. }
  795. new_fops = fops_get(minor->dev->driver->fops);
  796. if (!new_fops) {
  797. err = -ENODEV;
  798. goto out_release;
  799. }
  800. replace_fops(filp, new_fops);
  801. if (filp->f_op->open)
  802. err = filp->f_op->open(inode, filp);
  803. else
  804. err = 0;
  805. out_release:
  806. drm_minor_release(minor);
  807. out_unlock:
  808. mutex_unlock(&drm_global_mutex);
  809. return err;
  810. }
  811. static const struct file_operations drm_stub_fops = {
  812. .owner = THIS_MODULE,
  813. .open = drm_stub_open,
  814. .llseek = noop_llseek,
  815. };
  816. static void drm_core_exit(void)
  817. {
  818. unregister_chrdev(DRM_MAJOR, "drm");
  819. debugfs_remove(drm_debugfs_root);
  820. drm_sysfs_destroy();
  821. idr_destroy(&drm_minors_idr);
  822. drm_connector_ida_destroy();
  823. drm_global_release();
  824. }
  825. static int __init drm_core_init(void)
  826. {
  827. int ret;
  828. drm_global_init();
  829. drm_connector_ida_init();
  830. idr_init(&drm_minors_idr);
  831. ret = drm_sysfs_init();
  832. if (ret < 0) {
  833. DRM_ERROR("Cannot create DRM class: %d\n", ret);
  834. goto error;
  835. }
  836. drm_debugfs_root = debugfs_create_dir("dri", NULL);
  837. if (!drm_debugfs_root) {
  838. ret = -ENOMEM;
  839. DRM_ERROR("Cannot create debugfs-root: %d\n", ret);
  840. goto error;
  841. }
  842. ret = register_chrdev(DRM_MAJOR, "drm", &drm_stub_fops);
  843. if (ret < 0)
  844. goto error;
  845. drm_core_init_complete = true;
  846. DRM_DEBUG("Initialized\n");
  847. return 0;
  848. error:
  849. drm_core_exit();
  850. return ret;
  851. }
  852. module_init(drm_core_init);
  853. module_exit(drm_core_exit);