未完待续……更新至2013.10.17 - 20:50
温馨提示,本文中每个部分设计到的工程包括源文件,都可以在本文的最后发现下载链接哟!
应各路童鞋的围观,“写一个 《手把手教你移植XXX》神马的教程哎~”
实在太忙了,也没有什么好题材的移植,也就是这个InfoNES吧。因为我之前帖子里用的都是我原来学习NES时找到的源码,结构被我改了一通,支持的mapper也少,恰有童鞋提醒,研究InfoNES的信息也不少,我也就凑热闹来搞这个了。
有童鞋问了,神马是InfNES?
这是一款NES游戏模拟器,也就是任天堂的红白机,80后的童年……InfoNES可以很容易地被移植到各个平台,可以说各大开发论坛上都可见它的身影。
说起移植,其实好的移植题材就是一个巴掌拍不响,既要有好的移植手法,同样的移植目标也就是源代码也本就有好的代码结构,具有良好的可移植性。否则源码不好,移植工作可能就变成了重构,任务量变大了不说,一点移植的快乐都没有了,而对源码不甚了解的童鞋,可能移植成功率也非常低了,可以说移植还不如重写。
这次选择的InfoNES就是一个良好的可移植性软件,它将与环境有关的内容都清出了软件内核,并且单独集合于一个InfoNES_System.h中,我们要做的就是实现这里提到的各种函数,再把InfoNES加入到我们的工程中一起联编。
要是像上面这样说的这样容易就好了,事实证明,道路阻且长。所以接下来我们尽量(在有关大道理上)说得细一点,以让更多不同水平段的童鞋在相关情节上多体会一些东西。如果你是有关技术的老鸟,那不好意思你可能什么都学不到了,更可能会发现本文的诸多错误,阅读本文只会让你更多地浪费生命,对此我十分抱歉。
好吧,节目开始。
第一部分是移植的前期工作
首先,
要准备好两个工程,一个是InfoNES的源工程(有码,本文的最后首先分享InfoNES的源码,在网上淘到的,里面还有win32工程和Linux工程,大家可以先编编看。),一个是我们自己的工程,其实移植初期,我们的工程越简单越好,目的就是为了让InfoNES适应我们的环境,这里我就借用青风侠赠送光盘中的《实验十五:液晶屏的显示》。事实上你会知道扯那么多没有用,在这次移植中我们只需要用到一些基本函数,尤其是液晶屏显示相关的内容,剩下的,我们从0开始:
- int main(void)
- {
- //初始化液晶屏幕;此处代码根据你的实际环境从开发板配套实例中复制
- while(1);
- }
复制代码这样应该就足够了。
当然更多通常的东西我还没有指出,比如对于一些开发板,你需要首先关闭看门狗,初始化时钟控制,初始化相关端口,等等之类的,一般都可以在你的开发例程中找到。关于移植所需的最小环境,详情请查阅芯片手册和开发板的学习指南。实在不行可以找卖给你板子的那个人帮你配置一下(哎,店家,你打我干什么),但是这样实在不像我们作为一个开发者的良好选择。
其次,
很重要的,你应该确保前一步准备的东东都是好用的,谁都不希望移植一个软件,搞了一个月都不成功,最后发现是开发板的RAM有问题导致的。如何确认自己的开发板是好用的,没有那么复杂,可是也并不简单,我也没有什么好办法,童鞋们开新帖讨论吧,呵呵。
对于InfoNES是否好用,我已经试过了,可以用VC6.0打开其中的win32工程,编译运行,只可惜是日文版的。
最后,
作为承前启后的一件事,你要搞清楚接下来要做什么。别傻了,我们不可能知道之后每一个细节会怎样,所以这里的搞清楚也不是面面俱到,记得,不要总是急着一口气完成任务,之后我们的道路应该是一步一个脚印。
作为移植这一工作的基础,首先要把目标代码整合到我们的工程里。所以接下来我们就来做整合的工作。整合的工作,不必考虑更多的诸如编译之类的细节。
第二部分是将目标代码整合到我们的工程中,并完成之间的接口。
别担心,这一过程要完成的接口很简单:它提供的接口,我们就调用一下;它需要我们准备的接口,就写一个空函数。
首先,
把InfoNES的源码加入我们的工程。
InfoNES的核心代码很简单的,只有如图选中的这些文件(夹)是我们的工程中所需要的,但是我不建议你删除掉其他的内容。作为示例,我保留了win32的工程,以便我可以用VC对这些我改动的文件进行编译,以确定我们将来对代码进行的手术也都是可移植性强的。
工程中引入相关代码,其实只需要引入上面的cpp文件,只有4个。有童鞋会问,看到mapper文件夹中有大量的cpp文件,不必引入么?放心,InfoNES_Mapper.cpp文件已经Include了那些源文件,而且不存在路径问题,大胆地忽视它们吧!
相关头文件的路径应当正确设置。
其次,
实现InfoNES所需的函数。这些函数统统被定义在了InfoNES_System.h文件中。我们可以把它们复制出来,都扩展为空函数。为了整洁,我们单独创建一个c文件。
- /*-------------------------------------------------------------------*/
- /* InfoNES_system.c */
- /*-------------------------------------------------------------------*/
- #include "InfoNES.h"
-
- /*-------------------------------------------------------------------*/
- /* Palette data */
- /*-------------------------------------------------------------------*/
- WORD NesPalette[64]={
- 0
- };
-
- /*-------------------------------------------------------------------*/
- /* Function prototypes */
- /*-------------------------------------------------------------------*/
-
- /* Menu screen */
- int InfoNES_Menu()
- {
- return 0;
- }
-
- /* Read ROM image file */
- int InfoNES_ReadRom( const char *pszFileName )
- {
- return 0;
- }
-
- /* Release a memory for ROM */
- void InfoNES_ReleaseRom()
- {
- }
-
- /* Transfer the contents of work frame on the screen */
- void InfoNES_LoadFrame()
- {
- }
-
- /* Get a joypad state */
- void InfoNES_PadState( DWORD *pdwPad1, DWORD *pdwPad2, DWORD *pdwSystem )
- {
- }
-
- /* memcpy */
- void *InfoNES_MemoryCopy( void *dest, const void *src, int count )
- {
- return NULL;
- }
-
- /* memset */
- void *InfoNES_MemorySet( void *dest, int c, int count )
- {
- return NULL;
- }
-
- /* Print debug message */
- void InfoNES_DebugPrint( char *pszMsg )
- {
- }
-
- /* Wait */
- void InfoNES_Wait()
- {
- }
-
- /* Sound Initialize */
- void InfoNES_SoundInit( void )
- {
- }
-
- /* Sound Open */
- int InfoNES_SoundOpen( int samples_per_sync, int sample_rate )
- {
- return 0;
- }
-
- /* Sound Close */
- void InfoNES_SoundClose( void )
- {
- }
-
- /* Sound Output 5 Waves - 2 Pulse, 1 Triangle, 1 Noise, 1 DPCM */
- void InfoNES_SoundOutput(int samples, BYTE *wave1, BYTE *wave2, BYTE *wave3, BYTE *wave4, BYTE *wave5)
- {
- }
-
- /* Print system message */
- void InfoNES_MessageBox( char *pszMsg, ... )
- {
- }
复制代码最后,
我们需要调用InfoNES的一些函数。我从win32工程入手,发现启动InfoNES相关的一段代码:
- case IDC_BTN_OPEN:
- /*-------------------------------------------------------------------*/
- /* Open button */
- /*-------------------------------------------------------------------*/
-
- // Do nothing if emulation thread exists
- if (NULL != m_hThread)
- break;
-
- memset( &ofn, 0, sizeof ofn );
- szFileName[ 0 ] = '\0';
- ofn.lStructSize = sizeof ofn;
- ofn.hwndOwner = hWnd;
- ofn.hInstance = wc.hInstance;
-
- ofn.lpstrFilter = NULL;
- ofn.lpstrCustomFilter = NULL;
- ofn.nMaxCustFilter = 0;
- ofn.nFilterIndex = 0;
- ofn.lpstrFile = szFileName;
- ofn.nMaxFile = sizeof szFileName;
- ofn.lpstrFileTitle = NULL;
- ofn.nMaxFileTitle = 0;
- ofn.lpstrInitialDir = NULL;
- ofn.lpstrTitle = NULL;
- ofn.Flags = 0;
- ofn.nFileOffset;
- ofn.nFileExtension = 0;
- ofn.lpstrDefExt = NULL;
- ofn.lCustData = 0;
- ofn.lpfnHook = NULL;
- ofn.lpTemplateName = NULL;
-
- if ( GetOpenFileName( &ofn ) )
- {
- // Load cassette
- if ( InfoNES_Load( szFileName ) == 0 )
- {
- // Set a ROM image name
- strcpy( szRomName, szFileName );
-
- // Load SRAM
- LoadSRAM();
-
- // Create Emulation Thread
- m_hThread=CreateThread((LPSECURITY_ATTRIBUTES)NULL, (DWORD)0,
- (LPTHREAD_START_ROUTINE)InfoNES_Main, (LPVOID)NULL, (DWORD)0, &m_ThreadID);
- }
- }
- break;
复制代码细节都不需要太关注啦,整体的内容大概是弹出打开文件的对话框,然后选择某个文件,再把文件名传递给InfoNES_Load,当它返回0就表示成功,这样就打开一个线程来执行InfoNES_Main。作为一个模拟器,它一旦跑起来就不需要我们控制了(事实可能不是这样,呵呵),所以到这为止就能和模拟器成功对接了。于是我们也在main函数中调用这两个函数。
- #include "InfoNES.h"
-
- int main(void)
- {
- if(InfoNES_Load(NULL) == 0)
- {
- InfoNES_Main();
- }
-
- while(1);
- }
复制代码太棒了,我的工程里有InfoNES模拟器了!
太简单了,这就是移植啊。
点编译……我Sh~it!!!!!!!!
============================
以下,2013.10.17续============================================
第三部分是让工程编译成功
首先我重新整理的工程结构,使得Keil工程也和Win32工程一样并列在那里。
开始编译了,从我的开发经验上说,为了避免不必要的麻烦,即使是warning,也应当看一看要不要修改。所以我们来检查一下都有哪些东西要改的。
各位童鞋编译的结果也不各不相同,暂时以我的为主,依照我的顺序进行修改吧:
1 ..\InfoNES.h(285): warning: #1295-D: Deprecated declaration InfoNES_Init - give arg types
这种问题主要是在我们的编译环境里,即使是没有参数,也最好是指定为(void),所以在InfoNES.h(285行)做修改:
由
/* Initialize InfoNES */
void InfoNES_Init();
复制代码改为
/* Initialize InfoNES */
void InfoNES_Init(void);
复制代码同样的过程,对其他相同的warning进行处理。
2 ..\InfoNES.cpp(634): warning: #175-D: subscript out of range
这里是说对数组的访问,貌似越界了,这种事可是我们程序开发的大忌,必须改。
在相应位置找到代码
- APU_Reg[ 0x4015 ] |= 0x40;
复制代码注意到这是模拟操作APU的寄存器,是处理声音的。这样吧,本篇还是基于HANKER-LM4F232的,暂时没有处理声音的能力,那么和我一起,把所有的APU相关的代码都停用了吧。
停用代码,我建议使用编译预开关,不是#if 0,而是这样:
在infones_types.h中定义一处:
- /*-------------------------------------------------------------------*/
- /* Config */
- /*-------------------------------------------------------------------*/
- #define APU_NONE
复制代码之后要处理好多地方了:根据组个修改变更,行号也会有所变化,如果你是根据我的说明做的,请严格按照顺序,否则请自行搜索相关代码。我会附带上变更后的前后两行代码,以做定位参考。
详细请参考13楼的内容。
停用了APU的代码,接下来处理其他的数组访问越界:我大概看了下,基本都是正经的访问越界了。在不知道具体含义的情况下,我们可以选择扩大定义时的大小。
详细请参考14楼的内容。
3 ..\K6502_rw.h(121): warning: #111-D: statement is unreachable
这处错误,观察一下,好像是编码习惯不好,不过效率会提高一点,暂时可以忽略不改。
经过再次编译确认,就剩下Link错误了。
4 .\output\InfoNES.axf: Error: L6218E: Undefined symbol InfoNES_Load (referred from main.o).
这种错误很可恶。
读一读错误的信息,它说我没有定义InfoNES_Load的实体,可是我明明能够找到这个函数的实现啊……为什么链结不到呢?经过检查工程,可以看到,这个实体实际上定义在cpp文件中,而调用它的main函数我却定义在c文件中,这时候就涉及到一个知识点:
C和C++混合编程。详细信息请各位自行搜索相关内容。
说说处理方案,经过仔细检查,InfoNES的源码均是由纯C语言编写的,所以嘛……哎,可不是把cpp都改成c哟!否则其他的工程就都彪了!处理方案是在所有InfoNES的源码中头尾加上extern "C" {......}。详细参考文末的附件吧。
再编译,就不会出现头疼的L6218E了。
但是出现了更加让人抓狂的Link错误:
.\output\InfoNES.axf: Error: L6406E: No space in execution regions with .ANY selector matching infones_mapper.o(.bss).
.\output\InfoNES.axf: Error: L6406E: No space in execution regions with .ANY selector matching infones.o(.bss).
.\output\InfoNES.axf: Error: L6407E: Sections of aggregate size 0x9535c bytes could not fit into .ANY selector(s).
我无法解释,但是我知道这两个错误意味着RAM不够了!(呵呵,详情请具体学习关于
分散加载中的各种概念,例如这里就出现了.ANY,.bss,这些都是神马?欢迎大家继续深入学习。)
修改方案:
1.打开工程选项对话框,参见下图的标签页,IRAM1就是片上RAM,请调整它的大小,例如我在它后面加了两个0成为0x800000,记得点[OK]
2.还是工程选项对话框,如下图的标签页里,如果发现ScatterFile一项里有内容,那么就点击其后的[Edit...],之后关闭工程选项,在代码编辑区可以发现这个文件已经被打开,找到如“RW_IRAM 0x20000000 0x0008000”一行,修改后面的大小,和修改方案1中的思路一样,它就表示RAM的大小。记得保存。
再编译一次吧……
linking...
Program Size: Code=150964 RO-data=32 RW-data=2360 ZI-data=614976
".\output\InfoNES.axf" - 0 Error(s), 4 Warning(s).
大功告成,我们成功把InfoNES编译在我们的工程里啦!喜大普奔的好消息
什么嘛,这样根本就没法运行啊!
哦,累了,休息,休息一会儿……
小结:移植中不免要修改源码,修改之前千万要尽量搞清楚源码的含义,修改操作也应该是可移植性强的。如果修改破坏了移植性,就会给将来的移植带来麻烦。
第一部分资源:
InfoNES源码包
InfoNES097JRC1_SDL.7z
(110 KB, 下载次数: 333)
第二部分资源 :
我们的InfoNES工程
Prj20131014.rar
(256.77 KB, 下载次数: 212)
第三部分
编译成功的工程
prj20131017.7z
(116.67 KB, 下载次数: 252)
[
本帖最后由 sjtitr 于 2013-10-17 21:35 编辑 ]