From 61e2ffd4483bf2da0862e32449caa9f1cecc5b72 Mon Sep 17 00:00:00 2001
From: Tony Wasserka <NeoBrainX@gmail.com>
Date: Tue, 22 Jul 2014 13:21:57 +0200
Subject: GPU: Add documentation.

---
 src/core/hw/gpu.h | 16 ++++++++++++++--
 1 file changed, 14 insertions(+), 2 deletions(-)

(limited to 'src')

diff --git a/src/core/hw/gpu.h b/src/core/hw/gpu.h
index 4ef0a047f..3078e4142 100644
--- a/src/core/hw/gpu.h
+++ b/src/core/hw/gpu.h
@@ -84,11 +84,14 @@ struct Regs::Struct<Regs::FramebufferTop> {
     union {
         u32 active_fb;
 
+        // 0: Use parameters ending with "1"
+        // 1: Use parameters ending with "2"
         BitField<0, 1, u32> second_fb_active;
     };
 
     u32 pad2[5];
 
+    // Distance between two pixel rows, in bytes
     u32 stride;
 
     u32 address_right1;
@@ -132,23 +135,32 @@ struct Regs::Struct<Regs::DisplayTransfer> {
     union {
         u32 flags;
 
-        BitField< 0, 1, u32> flip_data;
+        BitField< 0, 1, u32> flip_data;        // flips input data horizontally (TODO) if true
         BitField< 8, 3, Format> input_format;
         BitField<12, 3, Format> output_format;
-        BitField<16, 1, u32> output_tiled;
+        BitField<16, 1, u32> output_tiled;     // stores output in a tiled format
     };
 
     u32 unknown;
+
+    // it seems that writing to this field triggers the display transfer
     u32 trigger;
 };
 static_assert(sizeof(Regs::Struct<Regs::DisplayTransfer>) == 0x1C, "Structure size and register block length don't match");
 
 template<>
 struct Regs::Struct<Regs::CommandProcessor> {
+    // command list size
     u32 size;
+
     u32 pad0;
+
+    // command list address
     u32 address;
+
     u32 pad1;
+
+    // it seems that writing to this field triggers command list processing
     u32 trigger;
 };
 static_assert(sizeof(Regs::Struct<Regs::CommandProcessor>) == 0x14, "Structure size and register block length don't match");
-- 
cgit v1.2.3