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. The Power Consumption & Efficiency Of Open-Source GPU Drivers
  2. AMD R600g/RadeonSI Performance On Linux 3.16 With Mesa 10.3-devel
  3. Intel Pentium G3258 On Linux
  4. SilverStone Precision PS10
Latest Linux Articles
  1. Nouveau vs. Radeon vs. Intel Tests On Linux 3.16, Mesa 10.3-devel
  2. KVM Benchmarks On Ubuntu 14.10
  3. X.Org Server 1.16 Officially Released With Terrific Features
  4. Ubuntu With Linux 3.16 Smashes OS X 10.9.4 On The MacBook Air
Latest Linux News
  1. Git 2.1 To Further Mainline Windows Support Patches
  2. Debian 8.0 Jessie Is Settling For Linux 3.16
  3. Meson: A Next-Gen Build System Showing Promise
  4. Linux 3.16-rc7 Calms Things Down For The Linux 3.16 Kernel
  5. Open-Source AMD Users Report Hawaii GPU Acceleration Is Working
  6. Linus Torvalds On GCC 4.9: Pure & Utter Crap
  7. Cauldron 2014: GCC & LLVM Will Look To Collaborate More
  8. GCC Receives ACM Programming Languages Software Award
  9. KDE 4.14 Beta 3 Released
  10. A New Video Has Us Real Excited About The New UT For Linux
Latest Forum Discussions
  1. ASRock AM1H-ITX: One Of The Best AM1 Mini-ITX Motherboards
  2. Debian + radeonsi
  3. Open-source drivers on ATI R7 260X
  4. Updated and Optimized Ubuntu Free Graphics Drivers
  5. Table test
  6. How To Setup Radeon DPM On Ubuntu Linux
  7. New build, first Linux PC, what could go wrong? ;)
  8. AMD "Hawaii" Open-Source GPU Acceleration Still Not Working Right