Delete material in Manually Build X and Beyond
[ikiwiki.git] / docs / developer / GEMdrmKMS / index.mdwn
1 # Port of GEM and KMS
2
3 ## Status
4
5 The latest drm code from FreeBSD 9.x current has been successfully ported to DragonFly BSD, [patch](http://leaf.dragonflybsd.org/~davshao/r600fbsd.diff) and git branch **r600fbsd** git://leaf.dragonflybsd.org/~davshao/dragonfly.git, and tested with a Radeon HD 4550 on an x86_64 machine (Shuttle SG45H7).  However it must be remembered that testing has only been done with this one graphics card and it is completely unknown whether say an Intel machine will lock up solid.  Also nothing was done to port the extensive Via drivers FreeBSD has already ported.
6
7 ## Introduction or what the heck is being talked about
8
9 We are talking about modern graphics card drivers that have already or are in the process of being written for Linux.  Fortunately for the BSDs the source code that is the basis of these drivers, part hosted in git repositories accessible from [freedesktop.org](http://cgit.freedesktop.org/), and even the part that is now residing in the Linux kernel, is mostly licensed under terms compatible with the [MIT X License](http://www.opensource.org/licenses/mit-license.php), and therefore can be directly ported to DragonFly.
10
11 When we refer to DRM, we are referring to the [Direct Render Manager](http://dri.freedesktop.org/wiki/DRM) that is a kernel module arbitrating requests for various graphics related services.  Because of this acronym, the source code for DragonFly's DRM module can be found in directory **sys/dev/drm**, while the source code for Linux'd DRM module has been split into **include/drm** hosting common header files and **drivers/gpu/drm**.  Furthermore the Linux files have had vendor specific code split off into their own separate directories, a change the BSDs should consider since having all files in one directory is becoming rather unwieldy.
12
13 ## Previous work makes the port possible
14
15 Simply take a diff of the FreeBSD and DragonFlyBSD versions of DRM and one can readily see that the hard work of translating the semantics of the locking for the Linux drivers has mostly been done, and better still can be done almost automatically.  The FreeBSD port represents the limits of what can be ported having worked out exclusive access mechanisms, but not having completely worked out equivalents of other Linux APIs such as **idr**, small integer ID management.
16
17 ## What has been done and should be done
18
19 The software used for graphics whether the kernel or Mesa is surprisingly resilient.  As long as it compiles it will try and find a way with dealing with other mismatched components by falling back on default behavior.  Working on a fast x86_64 machine, it is easy to be lulled into a false sense that things are working properly unless one checks the logs.
20
21 ### **dmesg* output
22
23 Here the proper kernel module appears to be loaded.  I wasted quite a bit of time earlier this week not realizing an error that led to the kernel module not being loaded at all that appeared from the messages to be a device non-existence problem.
24
25     drm0: <ATI Radeon HD 4550> on vgapci0
26     vgapci0: child drm0 requested pci_enable_busmaster
27     info: [drm] Initialized radeon 1.31.0 20080613
28     info: [drm] Setting GART location based on new memory map
29     info: [drm] Loading RV710 Microcode
30     info: [drm] Resetting GPU
31     info: [drm] writeback test succeeded in 1 usecs
32
33 ### **var/log/Xorg.0.log** output
34
35 Somewhere on one's system are the logs of the latest startup of the X server and the modules it finds.  There can be an alternate place if one installs a second X.org, say at */opt/xtest*, in which case instead of **/var/log/Xorg.0.log** one will look in **/opt/xtest/var/log/Xorg.0.log**.
36
37 Here's a case of a failure where things are fine: I am composing this wiki from within Firefox 3.6.3 on a system where the proper module fails to load and yet where because of the machine's speed there is no discernible problem.
38
39     drmOpenDevice: node name is /dev/dri/card0
40     drmOpenDevice: open result is 10, (OK)
41     drmOpenByBusid: Searching for BusID pci:0000:01:00.0
42     drmOpenDevice: node name is /dev/dri/card0
43     drmOpenDevice: open result is 10, (OK)
44     drmOpenByBusid: drmOpenMinor returns 10
45     drmOpenByBusid: drmGetBusid reports pci:0000:01:00.0
46     (EE) AIGLX error: dlopen of /usr/pkg/lib/dri/r600_dri.so failed (Cannot open "/usr/pkg/lib/dri/r600_dri.so")
47     (EE) AIGLX: reverting to software rendering
48     (II) AIGLX: Loaded and initialized /usr/pkg/lib/dri/swrast_dri.so
49
50 The Mesa 7.4.x series simply didn't *have* an r600_drv.so driver so of course it can't be found.  Mesa happily falls back to using software rendering and nothing seems greatly wrong.
51
52 Now here is an example using latest Mesa and everything else from git where the driver is found:
53
54     [    95.404] drmOpenDevice: node name is /dev/dri/card0
55     [    95.405] drmOpenDevice: open result is 11, (OK)
56     [    95.405] drmOpenByBusid: Searching for BusID pci:0000:01:00.0
57     [    95.405] drmOpenDevice: node name is /dev/dri/card0
58     [    95.405] drmOpenDevice: open result is 11, (OK)
59     [    95.405] drmOpenByBusid: drmOpenMinor returns 11
60     [    95.405] drmOpenByBusid: drmGetBusid reports pci:0000:01:00.0
61     [    95.507] (II) AIGLX: enabled GLX_MESA_copy_sub_buffer
62     [    95.507] (II) AIGLX: enabled GLX_SGI_make_current_read
63     [    95.507] (II) AIGLX: enabled GLX_texture_from_pixmap with driver support
64     [    95.507] (II) AIGLX: Loaded and initialized /opt/xtest/lib/dri/r600_dri.so
65     [    95.507] (II) GLX: Initialized DRI GL provider for screen 0
66     [    95.508] (II) RADEON(0): Setting screen physical size to 508 x 285
67
68 Ironically I knew I was on the right track porting the latest git versions of the X.org stack when I succeeded in locking up hard my machine.  That meant a real hardware acceleration module was being loaded by that the previous kernel could not handle it, which was why the latest drm from FreeBSD had to be imported for Radeon r600.
69
70 ## Disclaimer
71
72 Code that is uploaded to the experimental git branches has been verified to work for one graphics card only
73 and one x86_64 system only.  It is highly likely that systems exist where using the experimental branches
74 will leave one's system unable to use software based on X.org.  Use at one's own risk.
75
76 I have experienced from an ill-fated experiment forced rebooting with corruption of a ufs2 root filesystem;
77 therefore, the same could well happen to you.  Only use this code on a system with no valuable or
78 irreplaceable data.  I disclaim any warranty or fitness of code.
79
80 ## Current Progress for Google Summer of Code 2010
81
82 Current work on porting the Linux drm to DragonFly BSD can be found in
83 git branch **gsocdrmalpha** git://leaf.dragonflybsd.org/~davshao/dragonfly.git
84
85 As of Wednesday, May 26, 2010, the first goal is to port the API from *drm.h* and *drmP.h*.
86
87 I have ported the easy 90% that does not require changing any working code.  The next harder step
88 will be to fully use the already existing implementation of *list_head* to replace the custom list
89 and locking for agp memory.
90