HOWTO: Build the Neuros firmware on Linux using Wine

Please send comments and suggestions to nerochiaro at nerochiaro dot net

Changelog and intro

1.3 (2005-09-25):
- ~ updated makefile to work for garbage 2.26.17 branch in CVS (thanks to Erwan Velu)
- ~ updated buildneuros to copy the binary in the right location (thanks to Sergio M. D. Gomes)
- ~ updated the howto with some more details
1.2 (2005-08-27):
- + optional download of "case-sensitive" makefile
1.1 (2005-08-26):
- ~ fixed lots of mistakes
- + imported in wiki
- + changelog
- + updated to use linux buildtools
- + better CCS installation notes
- ~ some overall rewording
1.0 (2005-08-22): created this document.

This document will guide you step-by-step in the process of compiling the open source version of the Neuros firmware under Linux using the nice Wine enviroment.
I personally did this on Gentoo, but I think that for most distributions this will work just fine or with some minor tweaks (I have reports that it works on recent Mandriva too). Just be sure to use the same version of wine I used: 20050725.
Maybe with a newer version it will work even better, but there are often regressions with wine so it's up to you to try your luck with a different version (update: I had report of sucess also with 20050830).

I expect you to read each chapter from start to end. Only when you have done that you should actually begin doing what you have just read. You have been warned.

I should insert the obligatory disclaimer here, but i'm lazy so i won't. Sue me.

Setup a clean wine

Install wine 20050725 as you usually do in your distribution (if possible, get WINEDEBUG support enabled)
rm -r ~/.wine
wine
(if you have a previous wine install that you want to keep, to maximize the chances of success during the next step run winecfg and ensure you have your wine system setup as Windows 98)

Install CCS

Fetch CCS v.2.21.00 (you will need to give TI your email address and some personal data to be able to download this)
Unpack somewhere and cd there
cd ccs
wine setup.exe
Say ok to the popup warning about HTMLHelp. we don't need it.
Click next, say ok to the anti-virus warning, check "i accept the agreement", click next 2 times
Uncheck the manuals option if you want, then click next
Leave all the defaults, included c:\ti as install directory. then click next 2 times
Now the setup will install a lot of stuff, then notify you it's done. Dismiss the message box, then uncheck both checkboxes and click next.
Dismiss another message box, then check "No, I will reboot later" and say ok to finish the install procedure (you might need to CTRL+C to kill wineserver after the last window closes to get back to your shell prompt)
wineboot
This last operation will probably spit a lot of error messages, but you shouldn't need to worry about them.

Setup the CCS environement

Create a file somewhere and put this content inside it

REGEDIT4

[HKEY_CURRENT_USER]

[HKEY_CURRENT_USER\Environment]
"BSL5416_DIR"="c:\\ti\\c5400\\dsk5416\\lib"
"C54X_A_DIR"="c:\\ti\\c5400\\bios\\include;c:\\ti\\c5400\\bios\\lib;c:\\ti\\c5400\\dsk5416\\include;c:\\ti\\c5400\\dsk5416\\lib;c:\\ti\\c5400\\xdais\\include;c:\\ti\\c5500\\xdais\\lib;c:\\ti\\c5400\\cgtools\\include;c:\\ti\\c5400\\cgtools\\lib;c:\\ti\\c5400\\rtdx\\include;c:\\ti\\c5400\\rtdx\\lib"
"C54X_C_DIR"="c:\\ti\\c5400\\bios\\include;c:\\ti\\c5400\\bios\\lib;c:\\ti\\c5400\\xdais\\include;c:\\ti\\c5500\\xdais\\lib;c:\\ti\\c5400\\cgtools\\include;c:\\ti\\c5400\\cgtools\\lib;c:\\ti\\c5400\\rtdx\\include;c:\\ti\\c5400\\rtdx\\lib"
"C55X_A_DIR"="c:\\ti\\c5500\\xdais\\include;c:\\ti\\c5500\\xdais\\lib;c:\\ti\\c5500\\cgtools\\include;c:\\ti\\c5500\\cgtools\\lib;c:\\ti\\c5500\\bios\\include;c:\\ti\\c5500\\bios\\lib;c:\\ti\\c5500\\rtdx\\include;c:\\ti\\c5500\\rtdx\\lib"
"C55X_C_DIR"="c:\\ti\\c5500\\xdais\\include;c:\\ti\\c5500\\xdais\\lib;c:\\ti\\c5500\\cgtools\\include;c:\\ti\\c5500\\cgtools\\lib;c:\\ti\\c5500\\bios\\include;c:\\ti\\c5500\\bios\\lib;c:\\ti\\c5500\\rtdx\\include;c:\\ti\\c5500\\rtdx\\lib"
"C55X_CONFIG_FILE"="c:\\ti\\cc\\bin\\c55xx.cfg"
"PATH"="c:\\\\windows;c:\\\\windows\\\\system;c:\\ti\\bin;c:\\ti\\cc\\bin;c:\\ti\\c5400\\cgtools\\bin;c:\\ti\\c5500\\cgtools\\bin;c:\\ti\\plugins\\bios;c:\\ti\\bin\\utilities\\tconf;c:\\ti\\bin\\utilities\\vislink;"
"TI_DIR"="c:\\ti"

wine regedit
From the menu select "Registry", then "Import registry file..."
Navigate to the location of the file you just created and open it.
Press F5 to check that HKEY_CURRENT_USER has a bunch of values under it.
cd ~/.wine/drive_c/ti/c5400/cgtools/bin
Create a file called runcc and put this inside it

#! /bin/bash
wine cl500.exe $@

chmod +x runcc
cd ~/.wine/drive_c/ti/plugins/bios/
create a file called gconfgen and put this inside it:

#! /bin/bash
wine gconfgen.exe $@

chmod +x gconfgen

Prepare the source tree

Get the source somehow (be aware that i tested this stuff only with garbage branch and derivatives) and put it somewhere you like, then cd there.
cd ccs_projects/Main_APP/Neuros200
Fetch this build script and save it in the current directory.
chmod +x buildneuros
Now we want also to clean any binaries that were uploaded into CVS. We want to do this so that we know we're really building the firmware and not merely getting an error but not noticing it because the old binaries are there and we think they're new. So please do the following:
rm build/output/*.*
rm ../../../source/DEBUGFLASHER/Debug/*.*

Install the linux buildtools

Fetch the buildtools package and unpack it somewhere, then cd there.
cd buildtools_src
./maketools.sh #sourceroot# of course replacing #sourceroot# with the actual location of the root of your source tree (that is, the folder that contains the "source" dir, not the dir itself).
cd back to the root of your source tree
verify that in ccs_project/buildtools you have three tools called "bootversion", "hexmerge" and "emuflash" (along with other tools with similar name but ending with .exe). If these tools are not there, please check that you provided the correct path in the steps above and repeat them.

Fix the makefile

cd back to the root of your source tree
cd /ccs_projects/Main_APP/Neuros200/
This is optional: you can fetch an already modified makefile and save it in the current directory (backup the one you have, maybe).
WARNING: this makefile is for the 2.26.17 version of the "garbage" branch in CVS. Other branches or versions might differ.
You need to follow the next steps anyway and remember: the makefile you download is probably from a different firmware release from yours. Because of this I suggest you to do this only if you are able to compare the two makefiles and merge any changes if necessary.
Otherwise just follow the next steps with the makefile you have. It will just take a little more and maybe it will be a little more boring, but you will be sure to have the right one.
Now open the Neuros200.mak makefile in your favorite text editor.
First thing you should ensure that the following variables are set in the following way (you should replace <source> with the absolute path to the actual place where you put your neuros source, and <home> is the absolute path to your home directory. beware, shell expansion won't work, so you can't use ~ to denote your home directory)
- OBJ_DIR= <source>/ccs_projects/Main_APP/Neuros200/obj
- COMPILER= runcc
- TI_DIR= <home>/.wine/drive_c/ti

Now, you might already have a linux-aware makefile (sooner or later it will be available in CVS, i hope). If not, you're up to some boring character case conversion work.
Why ? The makefile was made with win32 in mind, so nobody paid attention to the case of characters. But unix does pay attention to that, so we will need to clean up this mess.
First thing, scroll down some lines until you find some variables named DIR_number. You will notice a pattern in the folder names that is like "Source/something", but for most of them should be "source/SOMETHING". Do a first pass and fix these errors on the DIR_number variables and don't worry if you leave out some. We'll fix them later along with the others that lurk deeper into the makefile.
save and leave the file open, you will need to get back to this often in a moment.

make -f Neuros200.mak
Sooner or later the build will stop with an error like (of course the filenames will be different)
```
 make: *** No rule to make target `~/.wine/drive_c/ti/C5400/bios/include/hook.h', 
 needed by `obj/audio.obj'.  Stop.
```
You should check the name of the source file make is working on (not the .obj) and ensure that all instances of it in the makefile are in the correct character case. Have a nice hunting.
Repeat the last 2 steps until you either get sick or you have a working makefile and the build process completes without errors

Actually build the firmware

./buildneuros
If all goes well, you will see the build process merrily roll on its way to manufacturing you a shiny firmware. You will find it in #sourceroot#/source/DEBUGFLASHER/Debug/woid.hex. Otherwise, things will start crashing and burning somewhere along the process. Good luck.

Pain ? Depression ? Rage ?

This is supposed to be a troubleshooting chapter. Later on I will add something here. In the meantime...
If something goes wrong, mail me or join #neuros on irc.freenode.net and poke me if you see me around. If not, you can try asking for help to the other nice fellows you see in there. They won't bite you, at worst they won't answer you at all.