1. Computers
  2. Display Drivers
  3. Graphics Cards
  4. Memory
  5. Motherboards
  6. Processors
  7. Software
  8. Storage
  9. Operating Systems


Facebook RSS Twitter Twitter Google Plus


Phoronix Test Suite

OpenBenchmarking.org

Better Radeon DRM Code Documentation Comes

AMD

Published on 29 June 2012 08:09 PM EDT
Written by Michael Larabel in AMD
9 Comments

For any independent developers that have been wanting to explore ways to contribute to the open-source Radeon driver but have been intimidated by the lack of documentation within the code, the situation is beginning to improve.

It was just yesterday when I was writing about the AMD Radeon HD 7000 series open-source support still lacking and that besides the code not being in a usable state that documentation is still lacking for recent generations of Radeon GPUs. To some surprise, this morning a set of ten patches arrived from AMD's Alex Deucher for better documenting the Radeon DRM (Direct Rendering Manager) driver code.

As said on the mailing list:
This is something I've been wanting to do for a while and I finally spent a little time getting a start on it. There is still a lot to do and not all of my descriptions are great, but I think we can document the rest in bits and pieces. I also added a note about what asics the function is applicable to. I tried to start with the more common and complex code. I was thinking it would make sense to have an informal documentation policy something like the following:

1. If you edit an undocumented function, add documentation
2. If you edit a documented function and change how it works, update the documentation
3. All new functions added should be documented

Fulfulling all of these for stable fixes could pose problems so obviously there is some leeway.

This adds in around 2,000 lines of documentation to the Radeon kernel driver. Equally important is Deucher's proposal for an informal documentation policy; it's about damn time. This really shouldn't just apply to the Radeon driver but would be great if it applied to all X.Org projects. From fledging developers I still frequently hear that insufficient documentation is one of their biggest hurdles in initially contributing to X.Org/graphics-related projects and many open-source projects in general.

About The Author
Michael Larabel is the principal author of Phoronix.com and founded the web-site in 2004 with a focus on enriching the Linux hardware experience and being the largest web-site devoted to Linux hardware reviews, particularly for products relevant to Linux gamers and enthusiasts but also commonly reviewing servers/workstations and embedded Linux devices. Michael has written more than 10,000 articles covering the state of Linux hardware support, Linux performance, graphics hardware drivers, and other topics. Michael is also the lead developer of the Phoronix Test Suite, Phoromatic, and OpenBenchmarking.org automated testing software. He can be followed via and or contacted via .
Latest Linux Hardware Reviews
  1. Intel Launches The Core i7 5960X, Mighty Powerful Haswell-E CPUs
  2. AMD Radeon R9 290: Gallium3D vs. Catalyst Drivers
  3. AMD Radeon R9 290 Open-Source Driver Works, But Has A Ways To Go
  4. Trying The Configurable 45 Watt TDP With AMD's A10-7800 / A6-7400K
Latest Linux Articles
  1. The Fastest NVIDIA GPUs For Open-Source Nouveau With Steam Linux Gaming
  2. Testing For The Latest Linux Kernel Power Regression
  3. The Most Energy Efficient Radeon GPU For AMD Linux Gaming
  4. 20-Way Radeon Comparison With Open-Source Graphics For Steam On Linux Gaming
Latest Linux News
  1. Intel Beignet Is Working Out Surprisingly Well For OpenCL On Linux
  2. Coreboot Adds Lenovo X220 With Native Sandy Bridge Support
  3. Canonical Has Yet To Land X.Org Server 1.16 For Ubuntu 14.10
  4. Imagination Launches A MIPS Development Board
  5. Getting Involved With The New Raspberry Pi Graphics Driver
  6. A New AMD Catalyst Linux Driver Unofficially Surfaces
  7. LibreOffice Ported To 64-bit ARM (AArch64)
  8. Enlightenment E19 RC3 Shows Off The New Wayland Compositor
  9. Metro Redux Is Going To Require OpenGL 4.x On Linux
  10. Jailhouse v0.1 Released As A Basic Hypervisor For Linux
Latest Forum Discussions
  1. Btrfs Gets Talked Up, Googler Encourages You To Try Btrfs
  2. Catalyst 14.201.1008
  3. It's Now Possible To Play Netflix Natively On Linux Without Wine Plug-Ins
  4. Users defect to Linux as OpenBSD removes Lynx from base system
  5. Updated and Optimized Ubuntu Free Graphics Drivers
  6. Canonical Joined The Khronos Group To Help Mir/Wayland Drivers
  7. Radeon HD5670 and Ubuntu 14.04
  8. AMD Releases UVD Video Decode Support For R600 GPUs