mirror of
https://github.com/gbdk-2020/gbdk-2020.git
synced 2026-03-08 00:07:25 +01:00
184 lines
8.3 KiB
HTML
184 lines
8.3 KiB
HTML
<!-- HTML header for doxygen 1.8.14-->
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="cache-control" content="max-age=86400"/>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.20"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>GBDK 2020 Docs: Migrating to new GBDK Versions</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
<link href="doxygen_extra.css" rel="stylesheet" type="text/css"/>
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">GBDK 2020 Docs
|
|
</div>
|
|
<div id="projectbrief">API Documentation for GBDK 2020</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.20 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(function(){initNavTree('docs_migrating_versions.html',''); initResizable(); });
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div class="PageDoc"><div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">Migrating to new GBDK Versions </div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="textblock"><p>This section contains information that may be useful to know or important when upgrading to a newer GBDK release.</p>
|
|
<h1><a class="anchor" id="autotoc_md115"></a>
|
|
GBDK 2020 versions</h1>
|
|
<h2><a class="anchor" id="autotoc_md116"></a>
|
|
Porting to GBDK 2020 4.0.3</h2>
|
|
<ul>
|
|
<li>No significant changes required</li>
|
|
</ul>
|
|
<h2><a class="anchor" id="autotoc_md117"></a>
|
|
Porting to GBDK 2020 4.0.2</h2>
|
|
<ul>
|
|
<li>The default font has been reduced from 256 to 96 characters.<ul>
|
|
<li>Code using special characters may need to be updated.</li>
|
|
<li>The off-by-1 character index offset was removed for fonts. Old fonts with the offset need to be re-adjusted.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h2><a class="anchor" id="autotoc_md118"></a>
|
|
Porting to GBDK 2020 4.0.1</h2>
|
|
<ul>
|
|
<li><b>Important!</b> : The <code>WRAM</code> memory region is no longer automatically initialized to zeros during startup.<ul>
|
|
<li>Any variables which are declared without being initialized may have <b>indeterminate values instead of 0</b> on startup. This might reveal previously hidden bugs in your code.</li>
|
|
<li>Check your code for variables that are not initialized before use.</li>
|
|
<li>In BGB you can turn on triggering exceptions (options panel) reading from unitialized RAM. This allows for some additional runtime detection of uninitialized vars.</li>
|
|
</ul>
|
|
</li>
|
|
<li>In .ihx files, multiple writes to the same ROM address are now warned about using <a class="el" href="docs_toolchain.html#ihxcheck">ihxcheck</a>.</li>
|
|
<li><code>set_*_tiles()</code> now wrap maps around horizontal and vertical boundaries correctly. Code relying on it not wrapping correctly may be affected.</li>
|
|
</ul>
|
|
<h2><a class="anchor" id="autotoc_md119"></a>
|
|
Porting to GBDK 2020 4.0</h2>
|
|
<ul>
|
|
<li>GBDK now requires SDCC 4.0.3 or higher</li>
|
|
<li>The old linker <code>link-gbz80</code> has been REMOVED, the linker <a class="el" href="docs_toolchain.html#sdldgb">sdldgb</a> from SDCC is used.<ul>
|
|
<li>Due to the linker change, there are no longer warnings about multiple writes to the same ROM address.</li>
|
|
</ul>
|
|
</li>
|
|
<li>GBDK now generates .ihx files, those are converted to a ROM using <a class="el" href="docs_toolchain.html#makebin">makebin</a> (lcc can do this automatically in some use cases)</li>
|
|
<li>Setting ROM bytes directly with <code>-Wl-yp0x<address>=0x<value></code> is no longer supported. Instead use <a class="el" href="docs_toolchain.html#makebin">makebin</a> flags. For example, use <code>-Wm-yC</code> instead of <code>-Wl-yp0x143=0xC0</code>. See <a class="el" href="docs_faq.html#faq_gb_type_header_setting">faq_gb_type_header_setting</a>.</li>
|
|
<li>OAM symbol has been renamed to _shadow_OAM, that allows accessing shadow OAM directly from C code</li>
|
|
</ul>
|
|
<h2><a class="anchor" id="autotoc_md120"></a>
|
|
Porting to GBDK 2020 3.2</h2>
|
|
<ul>
|
|
<li>No significant changes required</li>
|
|
</ul>
|
|
<h2><a class="anchor" id="autotoc_md121"></a>
|
|
Porting to GBDK 2020 3.1.1</h2>
|
|
<ul>
|
|
<li>No significant changes required</li>
|
|
</ul>
|
|
<h2><a class="anchor" id="autotoc_md122"></a>
|
|
Porting to GBDK 2020 3.1</h2>
|
|
<ul>
|
|
<li>No significant changes required</li>
|
|
</ul>
|
|
<h2><a class="anchor" id="autotoc_md123"></a>
|
|
Porting to GBDK 2020 3.0.1</h2>
|
|
<ul>
|
|
<li>LCC was upgraded to use SDCC v4.0. Makefile changes may be required<ul>
|
|
<li>The symbol format changed. To get bgb compatible symbols turn on <code>.noi</code> output (LCC argument: <code>-Wl-j</code> or <code>-debug</code>) and use <code>-Wm-yS</code></li>
|
|
<li>?? Suggested: With LCC argument: <code>-Wa-l</code> (sdasgb:<code>-a All user symbols made global</code>)</li>
|
|
<li>In SDCC 3.6.0, the default for char changed from signed to unsigned.<ul>
|
|
<li>If you want the old behavior use <code>--fsigned-char</code>.</li>
|
|
<li>lcc includes <code>--fsigned-char</code> by default</li>
|
|
<li>Explicit declaration of unsigned vars is encouraged (for example, '15U' instead of '15')</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>.init</code> address has been removed</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<hr />
|
|
<h1><a class="anchor" id="autotoc_md125"></a>
|
|
Historical GBDK versions</h1>
|
|
<h2><a class="anchor" id="autotoc_md126"></a>
|
|
GBDK 1.1 to GBDK 2.0</h2>
|
|
<ul>
|
|
<li>Change your int variables to long if they have to be bigger than 255. If they should only contain values between 0 and 255, use an unsigned int.</li>
|
|
<li>If your application uses the delay function, you'll have to adapt your delay values.</li>
|
|
<li>Several functions have new names. In particular some of them have been changed to macros (e.g. show_bkg() is now SHOW_BKG).</li>
|
|
<li>You will probably have to change the name of the header files that you include. </li>
|
|
</ul>
|
|
</div></div><!-- contents -->
|
|
</div><!-- PageDoc -->
|
|
</div><!-- doc-content -->
|
|
<!-- HTML footer for doxygen 1.8.14-->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
</div>
|
|
</body>
|
|
</html>
|