gbdk-2020 | GameBoy Development Kit |
| download: https://git.y1.nz/archives/gbdk.tar.gz | |
| README | Files | Log | Refs | LICENSE |
commit 39e22ef511057c825e046fe31d6e6075a8269802 parent e3a7d26bb1dcf7a89e0bd81f02ce0be170d5af2e Author: bbbbbr <bbbbbr@users.noreply.github.com> Date: Tue, 1 Nov 2022 21:18:40 -0700 Merge pull request #439 from bbbbbr/docs_4_1_0 Docs: Migration guide: 4.1.0 update Diffstat:
| M | docs/api/cgb_8h.html | 8 | ++++---- |
| M | docs/api/cgb_8h_source.html | 4 | ++-- |
| M | docs/api/docs_migrating_versions.html | 3 | ++- |
| M | docs/pages/09_migrating_new_versions.md | 3 | ++- |
4 files changed, 10 insertions(+), 8 deletions(-)
diff --git a/docs/api/cgb_8h.html b/docs/api/cgb_8h.html @@ -101,9 +101,9 @@ $(document).ready(function(){initNavTree('cgb_8h.html',''); initResizable(); }); <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a> Macros</h2></td></tr> -<tr class="memitem:a4a118ad3ee36468a3fa616977a64864e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="cgb_8h.html#a4a118ad3ee36468a3fa616977a64864e">RGB</a>(r, g, <a class="el" href="gb_8h.html#a4c2e4adef74067fdbb49005bc73de937">b</a>)   ((<a class="el" href="stdint_8h.html#adf4d876453337156dde61095e1f20223">uint16_t</a>)((((<a class="el" href="gb_8h.html#a4c2e4adef74067fdbb49005bc73de937">b</a>) & 0x1f) << 10) | (((g) & 0x1f) << 5) | (((r) & 0x1f) << 0)))</td></tr> +<tr class="memitem:a4a118ad3ee36468a3fa616977a64864e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="cgb_8h.html#a4a118ad3ee36468a3fa616977a64864e">RGB</a>(r, g, <a class="el" href="gb_8h.html#a4c2e4adef74067fdbb49005bc73de937">b</a>)   ((<a class="el" href="stdint_8h.html#adf4d876453337156dde61095e1f20223">uint16_t</a>)((((<a class="el" href="gb_8h.html#a4c2e4adef74067fdbb49005bc73de937">b</a>) & 0x1f) << 10) | ((<a class="el" href="stdint_8h.html#adf4d876453337156dde61095e1f20223">uint16_t</a>)(((g) & 0x1f) << 5)) | (((r) & 0x1f) << 0)))</td></tr> <tr class="separator:a4a118ad3ee36468a3fa616977a64864e"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a7d2ed0f10b2b74123a544327bbfd7564"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="cgb_8h.html#a7d2ed0f10b2b74123a544327bbfd7564">RGB8</a>(r, g, <a class="el" href="gb_8h.html#a4c2e4adef74067fdbb49005bc73de937">b</a>)   ((<a class="el" href="stdint_8h.html#adf4d876453337156dde61095e1f20223">uint16_t</a>)((((r) >> 3) & 0x1f) | ((((g) >> 3) & 0x1f) << 5) | ((((<a class="el" href="gb_8h.html#a4c2e4adef74067fdbb49005bc73de937">b</a>) >> 3) & 0x1f) << 10)))</td></tr> +<tr class="memitem:a7d2ed0f10b2b74123a544327bbfd7564"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="cgb_8h.html#a7d2ed0f10b2b74123a544327bbfd7564">RGB8</a>(r, g, <a class="el" href="gb_8h.html#a4c2e4adef74067fdbb49005bc73de937">b</a>)   (((<a class="el" href="stdint_8h.html#adf4d876453337156dde61095e1f20223">uint16_t</a>)((((<a class="el" href="gb_8h.html#a4c2e4adef74067fdbb49005bc73de937">b</a>) >> 3) & 0x1f) << 10)) | ((<a class="el" href="stdint_8h.html#adf4d876453337156dde61095e1f20223">uint16_t</a>)((((g) >> 3) & 0x1f) << 5)) | (((r) >> 3) & 0x1f))</td></tr> <tr class="separator:a7d2ed0f10b2b74123a544327bbfd7564"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ab5a6e450fcf10402278fe585a421dbbd"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="cgb_8h.html#ab5a6e450fcf10402278fe585a421dbbd">RGBHTML</a>(RGB24bit)   (<a class="el" href="nes_8h.html#a7d2ed0f10b2b74123a544327bbfd7564">RGB8</a>((((RGB24bit) >> 16) & 0xff), (((RGB24bit) >> 8) & 0xff), ((RGB24bit) & 0xff)))</td></tr> <tr class="separator:ab5a6e450fcf10402278fe585a421dbbd"><td class="memSeparator" colspan="2"> </td></tr> @@ -210,7 +210,7 @@ Functions</h2></td></tr> <tr> <td></td> <td>)</td> - <td></td><td>   ((<a class="el" href="stdint_8h.html#adf4d876453337156dde61095e1f20223">uint16_t</a>)((((<a class="el" href="gb_8h.html#a4c2e4adef74067fdbb49005bc73de937">b</a>) & 0x1f) << 10) | (((g) & 0x1f) << 5) | (((r) & 0x1f) << 0)))</td> + <td></td><td>   ((<a class="el" href="stdint_8h.html#adf4d876453337156dde61095e1f20223">uint16_t</a>)((((<a class="el" href="gb_8h.html#a4c2e4adef74067fdbb49005bc73de937">b</a>) & 0x1f) << 10) | ((<a class="el" href="stdint_8h.html#adf4d876453337156dde61095e1f20223">uint16_t</a>)(((g) & 0x1f) << 5)) | (((r) & 0x1f) << 0)))</td> </tr> </table> </div><div class="memdoc"> @@ -255,7 +255,7 @@ Functions</h2></td></tr> <tr> <td></td> <td>)</td> - <td></td><td>   ((<a class="el" href="stdint_8h.html#adf4d876453337156dde61095e1f20223">uint16_t</a>)((((r) >> 3) & 0x1f) | ((((g) >> 3) & 0x1f) << 5) | ((((<a class="el" href="gb_8h.html#a4c2e4adef74067fdbb49005bc73de937">b</a>) >> 3) & 0x1f) << 10)))</td> + <td></td><td>   (((<a class="el" href="stdint_8h.html#adf4d876453337156dde61095e1f20223">uint16_t</a>)((((<a class="el" href="gb_8h.html#a4c2e4adef74067fdbb49005bc73de937">b</a>) >> 3) & 0x1f) << 10)) | ((<a class="el" href="stdint_8h.html#adf4d876453337156dde61095e1f20223">uint16_t</a>)((((g) >> 3) & 0x1f) << 5)) | (((r) >> 3) & 0x1f))</td> </tr> </table> </div><div class="memdoc"> diff --git a/docs/api/cgb_8h_source.html b/docs/api/cgb_8h_source.html @@ -97,9 +97,9 @@ $(document).ready(function(){initNavTree('cgb_8h_source.html',''); initResizable <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include <types.h></span></div> <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include <<a class="code" href="stdint_8h.html">stdint.h</a>></span></div> <div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  </div> -<div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="cgb_8h.html#a4a118ad3ee36468a3fa616977a64864e"> 33</a></span> <span class="preprocessor">#define RGB(r, g, b) ((uint16_t)((((b) & 0x1f) << 10) | (((g) & 0x1f) << 5) | (((r) & 0x1f) << 0)))</span></div> +<div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="cgb_8h.html#a4a118ad3ee36468a3fa616977a64864e"> 33</a></span> <span class="preprocessor">#define RGB(r, g, b) ((uint16_t)((((b) & 0x1f) << 10) | ((uint16_t)(((g) & 0x1f) << 5)) | (((r) & 0x1f) << 0)))</span></div> <div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  </div> -<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="cgb_8h.html#a7d2ed0f10b2b74123a544327bbfd7564"> 47</a></span> <span class="preprocessor">#define RGB8(r, g, b) ((uint16_t)((((r) >> 3) & 0x1f) | ((((g) >> 3) & 0x1f) << 5) | ((((b) >> 3) & 0x1f) << 10)))</span></div> +<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="cgb_8h.html#a7d2ed0f10b2b74123a544327bbfd7564"> 47</a></span> <span class="preprocessor">#define RGB8(r, g, b) (((uint16_t)((((b) >> 3) & 0x1f) << 10)) | ((uint16_t)((((g) >> 3) & 0x1f) << 5)) | (((r) >> 3) & 0x1f))</span></div> <div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  </div> <div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="cgb_8h.html#ab5a6e450fcf10402278fe585a421dbbd"> 59</a></span> <span class="preprocessor">#define RGBHTML(RGB24bit) (RGB8((((RGB24bit) >> 16) & 0xff), (((RGB24bit) >> 8) & 0xff), ((RGB24bit) & 0xff)))</span></div> <div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  </div> diff --git a/docs/api/docs_migrating_versions.html b/docs/api/docs_migrating_versions.html @@ -99,7 +99,8 @@ Porting to GBDK-2020 4.1.0</h2> <li>GBDK now requires SDCC 4.2 or higher with GBDK-2020 patches for the the z80 linker</li> <li>The default calling convention changed in SDCC 4.2, see <a class="el" href="docs_coding_guidelines.html#sdcc_calling_convention">Calling Conventions</a> for more details.<ul> <li>If you are linking to libraries compiled with an older version of SDCC / GBDK then you may have to recompile them.</li> -<li>If there are functions written in ASM which receive parameters, they should also be reviewed to make sure they work with the new <code>__sdcccall(1)</code> calling convention, or have their header declaration changed to use <code>OLDCALL</code>.</li> +<li>If there are existing functions written in ASM which <b>receive parameters</b> they should also be reviewed to make sure they work with the new <code>__sdcccall(1)</code> calling convention, or have their header declaration changed to use <code>OLDCALL</code>.</li> +<li>If there are existing functions written in ASM which <b>call other functions written in C</b> the callee C function should be declared OLDCALL.</li> <li>If you are using tools such as <code>rgb2sdas</code> (from hUGETracker/Driver) you may need to edit the resulting .o file and replace <code>-mgbz80</code> with <code>-msm83</code> in addition to using <code>OLDCALL</code></li> </ul> </li> diff --git a/docs/pages/09_migrating_new_versions.md b/docs/pages/09_migrating_new_versions.md @@ -9,7 +9,8 @@ This section contains information that may be useful to know or important when u - GBDK now requires SDCC 4.2 or higher with GBDK-2020 patches for the the z80 linker - The default calling convention changed in SDCC 4.2, see @ref sdcc_calling_convention "Calling Conventions" for more details. - If you are linking to libraries compiled with an older version of SDCC / GBDK then you may have to recompile them. - - If there are functions written in ASM which receive parameters, they should also be reviewed to make sure they work with the new `__sdcccall(1)` calling convention, or have their header declaration changed to use `OLDCALL`. + - If there are existing functions written in ASM which __receive parameters__ they should also be reviewed to make sure they work with the new `__sdcccall(1)` calling convention, or have their header declaration changed to use `OLDCALL`. + - If there are existing functions written in ASM which __call other functions written in C__ the callee C function should be declared OLDCALL. - If you are using tools such as `rgb2sdas` (from hUGETracker/Driver) you may need to edit the resulting .o file and replace `-mgbz80` with `-msm83` in addition to using `OLDCALL` - The SDCC `PORT` name for the Game Boy and related clones changed from `gbz80` to `sm83`. - Additional details in the @ref console_port_plat_settings "Console Port and Platform Settings" section and @ref faq_gbz80_sm83_old_port_name_error "FAQ entry". @ref lcc will error out if the old `PORT` name is passed in.
This webpage is intended to be an accessible preview of this repository. To get a fuller picture, clone it and use the git CLI.