<p>Nico Huber has uploaded this change for <strong>review</strong>.</p><p><a href="https://review.coreboot.org/23466">View Change</a></p><pre style="font-family: monospace,monospace; white-space: pre-wrap;">coreboot_tables: Comment struct lb_framebuffer<br><br>Try to clarify `bytes_per_line`. This was ignored in CorebootPayloadPkg<br>for some reason and led to some confusion.<br><br>Maybe we should document some of the other fields as well. I would have<br>thought, though, it's self-explanatory, but I also thought that about<br>`bytes_per_line`.<br><br>Change-Id: I5e1343b5fe37ac106e61e6907fbcc1737ac56f8b<br>Signed-off-by: Nico Huber <nico.h@gmx.de><br>---<br>M src/commonlib/include/commonlib/coreboot_tables.h<br>1 file changed, 11 insertions(+), 0 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;">git pull ssh://review.coreboot.org:29418/coreboot refs/changes/66/23466/1</pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/src/commonlib/include/commonlib/coreboot_tables.h b/src/commonlib/include/commonlib/coreboot_tables.h</span><br><span>index eaa3c4e..6882213 100644</span><br><span>--- a/src/commonlib/include/commonlib/coreboot_tables.h</span><br><span>+++ b/src/commonlib/include/commonlib/coreboot_tables.h</span><br><span>@@ -219,6 +219,17 @@</span><br><span>       uint64_t physical_address;</span><br><span>   uint32_t x_resolution;</span><br><span>       uint32_t y_resolution;</span><br><span style="color: hsl(120, 100%, 40%);">+        /**</span><br><span style="color: hsl(120, 100%, 40%);">+    * `bytes_per_line` gives the offset in bytes from one line to</span><br><span style="color: hsl(120, 100%, 40%);">+         * another. Thus, the data for a pixel with the coordinates (X, Y)</span><br><span style="color: hsl(120, 100%, 40%);">+     * from the upper left corner starts at</span><br><span style="color: hsl(120, 100%, 40%);">+        *</span><br><span style="color: hsl(120, 100%, 40%);">+     *   physical_address + Y * bytes_per_line + X * bits_per_pixel / 8</span><br><span style="color: hsl(120, 100%, 40%);">+    *</span><br><span style="color: hsl(120, 100%, 40%);">+     * `bytes_per_line` is always big enough to hold `x_resolution`</span><br><span style="color: hsl(120, 100%, 40%);">+        * pixels. It can, however, be chosen arbitrarily higher (e.g.</span><br><span style="color: hsl(120, 100%, 40%);">+         * to fulfill hardware constraints or for optimization purposes).</span><br><span style="color: hsl(120, 100%, 40%);">+      */</span><br><span>  uint32_t bytes_per_line;</span><br><span>     uint8_t bits_per_pixel;</span><br><span>      uint8_t red_mask_pos;</span><br><span></span><br></pre><p>To view, visit <a href="https://review.coreboot.org/23466">change 23466</a>. To unsubscribe, or for help writing mail filters, visit <a href="https://review.coreboot.org/settings">settings</a>.</p><div itemscope itemtype="http://schema.org/EmailMessage"><div itemscope itemprop="action" itemtype="http://schema.org/ViewAction"><link itemprop="url" href="https://review.coreboot.org/23466"/><meta itemprop="name" content="View Change"/></div></div>

<div style="display:none"> Gerrit-Project: coreboot </div>
<div style="display:none"> Gerrit-Branch: master </div>
<div style="display:none"> Gerrit-MessageType: newchange </div>
<div style="display:none"> Gerrit-Change-Id: I5e1343b5fe37ac106e61e6907fbcc1737ac56f8b </div>
<div style="display:none"> Gerrit-Change-Number: 23466 </div>
<div style="display:none"> Gerrit-PatchSet: 1 </div>
<div style="display:none"> Gerrit-Owner: Nico Huber <nico.h@gmx.de> </div>