AmigaOS Documentation Wiki - User contributions [en]

How to create an AmigaOS 4 library

2016-04-21T21:05:31Z

Ölrick Lefebvre: Sample tutor on how to create an OS4 library from scratch

How to create an OS4 library

This simple tutorial is based on the creation of my first library.

Big thanks to Alexandre Balaban, TonyW and Andy Broad Blues for their advices and explanations.

= Create a descriptive xml file =
To generate the skeleton of the library we first need to create an xml file describing it.
You may have a look in SDK:Include/interfaces to get inspiration.

== The header ==
At the beginning you describe the type of document.
For my sample I got inspired by one generated by fdtrans
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE library SYSTEM "library.dtd">

== The library tag ==
The all library description is contained in the library tag.
First you need to enter the name of the library, the name of its base structure and the name of the library file
<library name="sample" basename="SampleBase" openname="sample.library">

=== The include tags ===
You use these tags to specify the include files required for the declaration of your methods signature.
If your methods use custom types, you should add your own new include
<include>exec/types.h</include>
<include>test/sample.h</include>

In that case, don't forget to place your include in SDK:local/common/include

=== The interface tag ===
This tag defines an interface of your library. You should at least declare the "main" interface.
<interface name="main" version="1.0" struct="SampleIFace" prefix="_sample_" asmprefix="ISample" global="ISample">

==== Interface methods ====
In the interface section you add a method tag for each method of your library you want to publish. 
Note: you must provide at least Obtain, Release, Expunge and Clone
<method name="Obtain" result="uint32"/>
<method name="Release" result="uint32"/>
<method name="Expunge" result="void" status="unimplemented"/>
<method name="Clone" result="struct SampleIFace *"/>
===== method properties =====
* name: the name of the method to publish
* result: the data type returne by your method
* status: allows you to specify that a method is not implemented

====== arg tags ======
Each argument of a method must be declared with an arg tag. You specify the name and the type properties
<method name="Addition" result="myInt">
<arg name="value1" type="myInt"/>
<arg name="value2" type="myInt"/>
</method>

Once you're finished with the description your file should look like this:
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE library SYSTEM "library.dtd">
<library name="sample" basename="SampleBase" openname="sample.library">
<include>exec/types.h</include>
<include>test/sample.h</include>

<interface name="main" version="1.0" struct="SampleIFace" prefix="_sample_" asmprefix="ISample" global="ISample">
<method name="Obtain" result="uint32"/>
<method name="Release" result="uint32"/>
<method name="Expunge" result="void" status="unimplemented"/>
<method name="Clone" result="struct SampleIFace *"/>

<method name="Addition" result="myInt">
<arg name="value1" type="myInt"/>
<arg name="value2" type="myInt"/>
</method>
</interface>
</library>

= Generate the skeleton with IDLTool =
Open a shell in the drawer where your XML file resides and launch IDLTool so that it generates all you need
idltool -a sample.xml

== copy the includes at the right place ==
Now you have an include drawer which you'll can put in SDK:local/common/include
Note: you may delay this and use the local includes while debugging your library.
> copy include/#? SDK:local/common/include all
proto (Rép.)
sample.h..copié.
inline4 (Rép.)
sample.h..copié.
interfaces (Rép.)
sample.i..copié.
sample.h..copié.

If you have an include required for the signature of your methods, you can add it too.
#ifndef TEST_SAMPLE_H
#define TEST_SAMPLE_H

typedef int myInt;

#endif // TEST_SAMPLE_H

> makedir SDK:local/common/include/test
> copy test/#? SDK:local/common/include/test
sample.h..copié.

== add the revision info ==
Go into the <library>_files drawer, sample_files in my example.
Now use bumprev to generate revision files.
> bumprev 1.1 sample.library
bumprev: Creating new file "sample.library_rev.rev".
bumprev: Bumped "sample.library" to version 1.1.

bumprev doesn't accept '0' values, but you may modify the *_rev file afterward.

== tune init.c ==
IDLTool has generated source files in the <library>_files drawer.
First you have a init.c file and a drawer for each interface with a source file for each method declared in your xml file, except the methods tagged as 'unimplemented'.
Your first task is to edit init.c and define your library's base structure.
You will find a struct Library definition, rename it and enhanced it with private data if needed

struct Library
{
struct Library libNode;
BPTR segList;
/* If you need more data fields, add them here */
};

struct SampleBase
{
struct Library libNode;
BPTR segList;
/* If you need more data fields, add them here */
};

If you enhanced it, it's interesting to move it in a new header so that you can declare it in other source files.
In that case, don't forget to add the include directive in init.c.

#include <exec/exec.h>
#include <proto/exec.h>
#include <dos/dos.h>
#include <exec/types.h>
#include <test/sample.h>
#include <proto/sample.h>
#include <stdarg.h>
#include "samplebase.h

samplebase.h
#ifndef SAMPLEBASE_H
#define SAMPLEBASE_H

struct SampleBase
{
struct Library libNode;
BPTR segList;
/* If you need more data fields, add them here */
struct Library *UtilityBase;
struct UtilityIFace *IUtility;
};

#endif // SAMPLEBASE_H

Now you must edit init.c to replace the (struct Library *) casts to your library type, (struct SampleBase *) in my case.
To help you find the needed places, just use make:
> make
gcc -Wall -O3 -c -o init.o init.c
init.c: In function 'libOpen':
init.c:66: error: 'struct Library' has no member named 'libNode'
init.c: In function 'libExpunge':
init.c:94: error: 'struct Library' has no member named 'libNode'
init.c:96: error: 'struct Library' has no member named 'segList'
init.c:105: error: 'struct Library' has no member named 'libNode'
init.c: In function 'libInit':
init.c:116: error: 'struct Library' has no member named 'libNode'
init.c:117: error: 'struct Library' has no member named 'libNode'
init.c:118: error: 'struct Library' has no member named 'libNode'
init.c:119: error: 'struct Library' has no member named 'libNode'
init.c:120: error: 'struct Library' has no member named 'libNode'
init.c:121: error: 'struct Library' has no member named 'libNode'
init.c:122: error: 'struct Library' has no member named 'libNode'
init.c:124: error: 'struct Library' has no member named 'segList'
make: *** [init.o] Error 1

Now you have the functions which use a libBase variable typed as a (struct Library *) instead of your own base, just correct the declarations and check with make.

> make
gcc -Wall -O3 -c -o init.o init.c
gcc -nostartfiles -o sample.library main/Obtain.o main/Release.o main/Clone.o main/Addition.o init.o

Once make succeeds, you get a brand new library
> list sample.library
sample.library 6510 ----rwed Aujourd'hui 18:13:21

= get the interfaces you need =

Now that your library skeleton is validated, you have to implement your methods, but you may need acces to other libraries interfaces for it.
When you compile a regular program, the startup code adds global variables for some libraries (i.e. IExec), but in the case of a library, you don't have these, so it's up to you to do it.

Except for Newlib, it's a good practice to store your opened libraries and interfaces in you libbase by extended it.
On the other hand, using global references allows your code to look like regular code.

== IExec ==
In libInit() you get a (struct Interface *) which you can keep for your library use. No need to call Obtain() on it, as Exec isn't going away.
You may copy it to a global variable or to your libbase.

=== global IExec ===
At the beginning of init.c add a global definition:
struct ExecIFace *IExec = NULL;
In libInit(), comment out the "struct ExecIFace *IExec UNUSED" line and copy the exec argument to your variable
IExec = (struct ExecIFace *)exec;
To access it from your sources, just include proto/exec.h as it contains a declaration for such a global interface.
In your code you can use method calls like
IExec->OpenLibrary()

=== IExec libbase property ===
Extend your libbase structure to add a property to it
#ifndef SAMPLEBASE_H
#define SAMPLEBASE_H

struct SampleBase
{
struct Library libNode;
BPTR segList;
/* If you need more data fields, add them here */
struct ExecIFace *IExec;
};

#endif // SAMPLEBASE_H
In libInit(), copy the exec argument to your variable
libBase->IExec = (struct ExecIFace *)exec;
To access it from your sources, just include your "samplebase.h".
In your code you can get the interface from the libBase through the interface pointer of your library passed to your methods
struct SampleIFace * _sample_Clone(struct SampleIFace *Self)
{
...
((struct SampleBase *)(Self->Data.LibBase))->IExec->AllocVecTags()

== INewlib ==
If you use functions from libc and compile with newlib (default), the compiler will complain about an undefined INewlib.
That's because your library does not have the startup code which opens newlib.library and gets an interface from it.
The solution is almost the same as for a global IExec.
At the beginning of init.c add global definitions:
struct Library *NewlibBase = NULL;
struct Interface *INewlib = NULL;
In libInit(), open the library and get a "main" interface where the skeleton says it
/* Add additional init code here if you need it. */
NewlibBase = IExec->OpenLibrary("newlib.library", 53);
if(!NewlibBase)
{
CleanLibContext("Can't open V53 newlib.library");
return NULL;
}

INewlib = (struct Interface *)IExec->GetInterface(NewlibBase, "main", 1, NULL);
if(!INewlib)
{
CleanLibContext("Can't get newlib main interface");
return NULL;
}
CleanLibContext() may look like this:
void CleanLibContext(const char *msg)
{
IExec->DebugPrintF("%s\n", msg);
if(NewlibBase)
{
if(INewlib)
{
IExec->DropInterface(INewlib);
INewlib = NULL;
}
IExec->CloseLibrary(NewlibBase);
NewlibBase = NULL;
}
}
Now you can enjoy libc functions. 
'''NB: Do not make a call to a libc function before getting your interface, it's bad !'''

In libExpunge() you must clean up your resources after the dedicated comment:
/* Undo what the init code did */
CleanLibContext("");

== other libraries ==
Now you should have a pretty clear idea of how to do it for whatever library.
* define pointers for the library and the interface,
* open the library and get the interface in libInit()
** if you get an error while opening the library or getting the interface, clean up your resources and return NULL in libInit()
* in libExpunge() close everything opened

= Implement your library's methods =
IDLTool has generated a source file for each of the declared methods.
You just fill them with your code. 
This is a profundly trivial example
myInt _sample_Addition(struct SampleIFace *Self,
myInt value1,
myInt value2)
{
return (value1 + value2);
}

= Test your library =
Once your library is built, it's time to check each method with a simple test program.
#include <proto/exec.h>
#include <proto/sample.h>
#include <stdio.h>

int main(int argc, char *argv[])
{
myInt val1, val2, res;

struct Library *SampleBase = NULL;
struct SampleIFace *ISample = NULL;

SampleBase = (struct Library *)IExec->OpenLibrary("sample.library", 0);
if(!SampleBase)
return -1;

ISample = (struct SampleIFace *)IExec->GetInterface(SampleBase, "main", 1, NULL);
if(!ISample)
{
IExec->CloseLibrary(SampleBase);
return -2;
}

val1 = 123;
val2 = 321;
res = ISample->Addition(val1, val2);
printf("%ld + %ld = %ld\n", val1, val2, res);

IExec->DropInterface((struct Interface *)ISample);
IExec->CloseLibrary(SampleBase);
return 0;
}

Build it, copy your library in the same drawer (except if you already put it in Libs:) and test it
9.test> gcc -g -o tst_sample tst_sample.c
9.test> tst_sample
123 + 321 = 444

Et voila !

Hope this article will help you create much usefull libraries.

Tutorials:Main

2016-04-21T20:42:19Z

Ölrick Lefebvre: /* General */

= Tutorials =

Tutorials have been provided by various authors.

== General ==

[[The Hacking Way: Part 1 - First Steps]]

[[The Right Tool for the Job (Shared Objects)]]

[[How to Build Stubs for 68k Libraries]]

[[How to create an OS4 library]]

== Debugging ==

[[How to install a hardware interrupt]]

[[How to open and use the exec debug interface]]

[[GDB for Beginners]]

[[Using Crash-Logs for Debugging]]

[[Debug Logging on AmigaOS]]

[[Redirecting Debug Output to the Serial Port on Startup]]

[[Advanced Serial Debugging Guide]]

== GUI ==

[[BOOPSI Gadget Help Strings]]

[[BOOPSI Popup Menus - Part 1]]

[[BOOPSI Popup Menus - Part 2]]

[[BOOPSI Popup Menus - Part 3]]

[[Screen Programming]]

== AmiWest 2015 ==

[[AmiWest Setup]]

[[AmiWest 2015 DevCon]]

== AmiWest 2014 ==

[[AmiWest Setup]]

[[AmiWest 2014 Programming Seminar]]

== AmiWest 2013 ==

[[AmiWest 2013 Programming Conference Synopsis]]

[[AmiWest Setup]]

[[AmiWest 2013 Lesson 1|AmiWest Lesson 1: How to Crash]]

[[AmiWest 2013 Lesson 2|AmiWest Lesson 2: Interpreting Crash Reports]]

[[AmiWest 2013 Lesson 3|AmiWest Lesson 3: ProcTree Redux]]

[[AmiWest 2013 Lesson 4|AmiWest Lesson 4: Simple IP Clients & Servers]]

[[AmiWest 2013 Lesson 5|AmiWest Lesson 5: Bars&Pipes Tools]]

== AmiWest 2012 ==

[[AmiWest Setup]] [https://dl.dropboxusercontent.com/u/680455/AmiWest-2012-Programming/Introduction-360.mp4 - Video]

[[AmiWest Lesson 1|AmiWest Lesson 1: Coding Basics]] [https://dl.dropboxusercontent.com/u/680455/AmiWest-2012-Programming/Lesson01-360.mp4 - Video]

[[AmiWest Lesson 2|AmiWest Lesson 2: AmigaOS Fundamentals]][https://dl.dropboxusercontent.com/u/680455/AmiWest-2012-Programming/Lesson02-360.mp4 - Video]

[[AmiWest Lesson 3|AmiWest Lesson 3: Input and Output]][https://dl.dropboxusercontent.com/u/680455/AmiWest-2012-Programming/Lesson03-360.mp4 - Video]

[[AmiWest Lesson 4|AmiWest Lesson 4: ProcTree]][https://dl.dropboxusercontent.com/u/680455/AmiWest-2012-Programming/Lesson04-360.mp4 - Video]

[[AmiWest Lesson 5|AmiWest Lesson 5: MIDI]][https://dl.dropboxusercontent.com/u/680455/AmiWest-2012-Programming/Lesson05-360.mp4 - Video]

[[AmiWest Lesson 6|AmiWest Lesson 6: Application Library - Not Presented]]

[[AmiWest Lesson 7|AmiWest Lesson 7: Screen Blanker]][https://dl.dropboxusercontent.com/u/680455/AmiWest-2012-Programming/Lesson07-360.mp4 - Video]

[[AmiWest Lesson 8|AmiWest Lesson 8: ARexx Ports]][https://dl.dropboxusercontent.com/u/680455/AmiWest-2012-Programming/Lesson08-360.mp4 - Video]

[[AmiWest Support]][https://dl.dropboxusercontent.com/u/680455/AmiWest-2012-Programming/Wrap-Up-360.mp4 - Video]

Updating Nemo firmware

2015-04-09T10:07:34Z

Ölrick Lefebvre: Add link to jumper picture

==Be aware of the risks==
A brutal interruption of the update of the firmware may lead your computer to be as useful as a brick. To avoid this, you have to make sure to minimize the risks:
*keep any animals away (cats, dogs, bugs, children, wife, grandma...),
*make sure nobody's about to blow a fuse in the house (wife not drying her hair while the washing machine is on, while the electric fryer in on, while the oven is on, while the child's discovering electricity is fun by playing with the electric heater...),
*make sure no storm is hereabout, ready to raise a power failure,
*make sure no strike has been announced at your electricity supplier,
*(add here any other good sense measure to ensure 10 minutes of power stability).

==Firmware revisions==
Currently, the way to identify firmware revision is a bit "unusual".
===Original firmware (2011-07-05)===
That's the revision delivered with Nemo to the Betatest team. This is the revision of the rescue BIOS. 
In the serial debug log, it signs like that:
CFE version PAS-2.0.30 for NEMO (64bit,MP,BE,PPC)
Build Date: Tue Jul 5 16:09:15 BST 2011 (andrew@hercules)
Copyright (C) 2000,2001,2002,2003,2004,2005 Broadcom Corporation.
Portions Copyright (C) 2005-2008 PA Semi, Inc.
Portions Copyright (C) 2010 Hyperion Entertainment CVBA

Take note of the date. 
An alternative way to identify it, is that it doesn't support the menu command:
CFE> menu
Invalid command: "menu"
Available commands: ...

===Menu Firmware (2011-08-22)===
This is the second revision, made available to the Betatest team to setup boot menus. 
In the serial debug log, it signs like that:
CFE version PAS-2.0.30 for NEMO (64bit,MP,BE,PPC)
Build Date: Mon Aug 22 14:30:17 CEST 2011 (hfrieden@jumpgate)
Copyright (C) 2000,2001,2002,2003,2004,2005 Broadcom Corporation.
Portions Copyright (C) 2005-2008 PA Semi, Inc.
Portions Copyright (C) 2010 Hyperion Entertainment CVBA
Deja vu ? Take a closer look at the date. 
An alternative way to identify it, is that it does support the menu command:
CFE> menu
Loader:elf Filesys:amigafs Dev:ide0.1 File:amigaboot.of Options:(null)
The size of the corresponding BIN file is 915248 bytes.

===AEon Firmware (2012-06-08)===
This is the third revision. 
In the serial debug log, it signs like that:
CFE version PAS-2.0.30 for NEMO (64bit,MP,BE,PPC)
Build Date: Fri Jun 8 16:04:49 CEST 2012 (hfrieden@jumpgate)
Copyright (C) 2000,2001,2002,2003,2004,2005 Broadcom Corporation.
Portions Copyright (C) 2005-2008 PA Semi, Inc.
Portions Copyright (C) 2010 Hyperion Entertainment CVBA
Once again, you've got to check the date. 
You can visually identify it as there is now the AEon logo on top of "X1000" on the boot screen. 
The size of the corresponding BIN file is 939968 bytes.

==Upgrade procedure==
===Get the firmware BIN file===
Well if you're not a beta tester, you'll have to find a regular way to get it.
===Put it on a media available to CFE===
You can put in on a CD, on a USB stick, on a Compact Flash card or a TFTP server. 
Make it simple, make it safe, just put it on a FAT32 formatted USB stick, no philosophical debate please. 
Make sure your copy is correct, check it with md5sum or any other useful tool.
===Flash===
*Power up Nemo,
*if you have a menu configured, press 'F' to go to CFE prompt,
*plug your USB stick, CFE should detect it
CFE> port 0:1/3 released (full speed)
USB: New device connected to bus 2 hub 1 port 1 (full speed)
USB bus 2 device 2: vendor 0951 product 1625 class 08: Mass-Storage Device
USBMASS: Unit 0 connected
CFE>
*check availability of your file
CFE> dir -fatfs usbdisk0:/
CFE.BIN 915248
X1000_Menu.pdf 122391
X1000_Menu.pdf.info 13168
X1000_Reflash.pdf 670531
X1000_Reflash.pdf.info 13168
*** command status = 0
CFE>
*load the BIN file
CFE> load -raw -fatfs -max=0x8000000 usbdisk0:cfe.bin
Loader:raw Filesys:fat Dev:usbdisk0 File:cfe.bin Options:(null)
Loading: .. 915248 bytes read
Entry at 0x0000000020000000
*** command status = 0
CFE>
*take note of these two values, they may differ:
**bytes read: that's the size of your bin, it may change for each revision, in our example it's 915248
**entry: that's the address where the file is loaded, it may change too, 0x20000000 in our example
*starting from here, you won't be able to go back, so make sure you're ready and take a deep breath
*erase the current content of the flash
CFE> spi erase
*** command status = 0
CFE>
copy your loaded image with the previouly noted entry and size values
CFE> spi copy 0xf00000 0x20000000 915248
< entry > <size>
*** command status = 0
CFE>
 
NOTE: The copy can take several seconds, almost one minute in fact. Be patient, DO NOT SHUTDOWN OR RESET your machine while it is copying: it is NOT DEAD OR CRASHED!! Doing so would put you in an awkward position where you'll have bricked your X-1000. The solution would to follow the rescue procedure below.

*when you get back to the prompt, you can check the ROM signature (55AA55AA)
CFE> spi read 0xf00000 32
00F00000% 55AA55AA 43464531 436F6D6D 6F6E2046
00F00010% 69726D77 61726520 456E7669 726F6E6D
00F00020% 656E742C 20286329 20323030 34204272
00F00030% 6F616463 6F6D2043
*** command status = 0
CFE>
*now you can cold boot Nemo and check the revision.
==In case Murphy was right once again==
Nemo has a dual flash EPROM chips to offer you a safety belt. In case you broke your BIOS, you are able to activate the rescue BIOS which will allow you to try a new update. The choice between normal and rescue BIOS is activated with a jumper located between the DIMM4 slot and the rear USB connector (here in the Normal position):[https://dl.dropboxusercontent.com/u/30631303/Amiga/Setting_Board/bios.jpg BIOS Jumper] 
If you want to join the BIOS club, don't forget the three rules:
*you don't put a jumper on the RESCUE WrEn pins,
*you DON'T put a jumper on the RESCUE WrEn pins,
*YOU DON'T PUT A JUMPER ON THE RESCUE WrEn PINS !
===Rescue guide===
To use the Rescue BIOS and recover your Normal BIOS, here is how to do it:
*power down Nemo,
*put the BIOS jumper in Rescue mode,
*power up Nemo,
*once you get CFE prompt, move carefully your BIOS jumper from Rescue to Normal (carefully means here: avoid any shortcut, I'm obviously talking about electricity),
*follow the standard BIOS update procedure,
*if you get to the end, then you've rescued your BIOS, Champagne !

Updating Nemo firmware

2015-04-08T12:15:27Z

Ölrick Lefebvre: Nemo firmware upgrade and rescue guide

==Be aware of the risks==
A brutal interruption of the update of the firmware may lead your computer to be as useful as a brick. To avoid this, you have to make sure to minimize the risks:
*keep any animals away (cats, dogs, bugs, children, wife, grandma...),
*make sure nobody's about to blow a fuse in the house (wife not drying her hair while the washing machine is on, while the electric fryer in on, while the oven is on, while the child's discovering electricity is fun by playing with the electric heater...),
*make sure no storm is hereabout, ready to raise a power failure,
*make sure no strike has been announced at your electricity supplier,
*(add here any other good sense measure to ensure 10 minutes of power stability).

==Firmware revisions==
Currently, the way to identify firmware revision is a bit "unusual".
===Original firmware (2011-07-05)===
That's the revision delivered with Nemo to the Betatest team. This is the revision of the rescue BIOS. 
In the serial debug log, it signs like that:
CFE version PAS-2.0.30 for NEMO (64bit,MP,BE,PPC)
Build Date: Tue Jul 5 16:09:15 BST 2011 (andrew@hercules)
Copyright (C) 2000,2001,2002,2003,2004,2005 Broadcom Corporation.
Portions Copyright (C) 2005-2008 PA Semi, Inc.
Portions Copyright (C) 2010 Hyperion Entertainment CVBA

Take note of the date. 
An alternative way to identify it, is that it doesn't support the menu command:
CFE> menu
Invalid command: "menu"
Available commands: ...

===Menu Firmware (2011-08-22)===
This is the second revision, made available to the Betatest team to setup boot menus. 
In the serial debug log, it signs like that:
CFE version PAS-2.0.30 for NEMO (64bit,MP,BE,PPC)
Build Date: Mon Aug 22 14:30:17 CEST 2011 (hfrieden@jumpgate)
Copyright (C) 2000,2001,2002,2003,2004,2005 Broadcom Corporation.
Portions Copyright (C) 2005-2008 PA Semi, Inc.
Portions Copyright (C) 2010 Hyperion Entertainment CVBA
Deja vu ? Take a closer look at the date. 
An alternative way to identify it, is that it does support the menu command:
CFE> menu
Loader:elf Filesys:amigafs Dev:ide0.1 File:amigaboot.of Options:(null)
The size of the corresponding BIN file is 915248 bytes.

===AEon Firmware (2012-06-08)===
This is the third revision. 
In the serial debug log, it signs like that:
CFE version PAS-2.0.30 for NEMO (64bit,MP,BE,PPC)
Build Date: Fri Jun 8 16:04:49 CEST 2012 (hfrieden@jumpgate)
Copyright (C) 2000,2001,2002,2003,2004,2005 Broadcom Corporation.
Portions Copyright (C) 2005-2008 PA Semi, Inc.
Portions Copyright (C) 2010 Hyperion Entertainment CVBA
Once again, you've got to check the date. 
You can visually identify it as there is now the AEon logo on top of "X1000" on the boot screen. 
The size of the corresponding BIN file is 939968 bytes.

==Upgrade procedure==
===Get the firmware BIN file===
Well if you're not a beta tester, you'll have to find a regular way to get it.
===Put it on a media available to CFE===
You can put in on a CD, on a USB stick, on a Compact Flash card or a TFTP server. 
Make it simple, make it safe, just put it on a FAT32 formatted USB stick, no philosophical debate please. 
Make sure your copy is correct, check it with md5sum or any other useful tool.
===Flash===
*Power up Nemo,
*if you have a menu configured, press 'F' to go to CFE prompt,
*plug your USB stick, CFE should detect it
CFE> port 0:1/3 released (full speed)
USB: New device connected to bus 2 hub 1 port 1 (full speed)
USB bus 2 device 2: vendor 0951 product 1625 class 08: Mass-Storage Device
USBMASS: Unit 0 connected
CFE>
*check availability of your file
CFE> dir -fatfs usbdisk0:/
CFE.BIN 915248
X1000_Menu.pdf 122391
X1000_Menu.pdf.info 13168
X1000_Reflash.pdf 670531
X1000_Reflash.pdf.info 13168
*** command status = 0
CFE>
*load the BIN file
CFE> load -raw -fatfs -max=0x8000000 usbdisk0:cfe.bin
Loader:raw Filesys:fat Dev:usbdisk0 File:cfe.bin Options:(null)
Loading: .. 915248 bytes read
Entry at 0x0000000020000000
*** command status = 0
CFE>
*take note of these two values, they may differ:
**bytes read: that's the size of your bin, it may change for each revision, in our example it's 915248
**entry: that's the address where the file is loaded, it may change too, 0x20000000 in our example
*starting from here, you won't be able to go back, so make sure you're ready and take a deep breath
*erase the current content of the flash
CFE> spi erase
*** command status = 0
CFE>
copy your loaded image with the previouly noted entry and size values
CFE> spi copy 0xf00000 0x20000000 915248
< entry > <size>
*** command status = 0
CFE>
 
NOTE: The copy can take several seconds, almost one minute in fact. Be patient, DO NOT SHUTDOWN OR RESET your machine while it is copying: it is NOT DEAD OR CRASHED!! Doing so would put you in an awkward position where you'll have bricked your X-1000. The solution would to follow the rescue procedure below.

*when you get back to the prompt, you can check the ROM signature (55AA55AA)
CFE> spi read 0xf00000 32
00F00000% 55AA55AA 43464531 436F6D6D 6F6E2046
00F00010% 69726D77 61726520 456E7669 726F6E6D
00F00020% 656E742C 20286329 20323030 34204272
00F00030% 6F616463 6F6D2043
*** command status = 0
CFE>
*now you can cold boot Nemo and check the revision.
==In case Murphy was right once again==
Nemo has a dual flash EPROM chips to offer you a safety belt. In case you broke your BIOS, you are able to activate the rescue BIOS which will allow you to try a new update. The choice between normal and rescue BIOS is activated with a jumper located between the DIMM4 slot and the rear USB connector (here in the Normal position):BIOS Jumper 
If you want to join the BIOS club, don't forget the three rules:
*you don't put a jumper on the RESCUE WrEn pins,
*you DON'T put a jumper on the RESCUE WrEn pins,
*YOU DON'T PUT A JUMPER ON THE RESCUE WrEn PINS !
===Rescue guide===
To use the Rescue BIOS and recover your Normal BIOS, here is how to do it:
*power down Nemo,
*put the BIOS jumper in Rescue mode,
*power up Nemo,
*once you get CFE prompt, move carefully your BIOS jumper from Rescue to Normal (carefully means here: avoid any shortcut, I'm obviously talking about electricity),
*follow the standard BIOS update procedure,
*if you get to the end, then you've rescued your BIOS, Champagne !

AmigaOne X1000

2015-04-08T11:49:48Z

Ölrick Lefebvre: Added link to the firmware update page

The AmigaOne X1000 is a powerful PowerPC-based high-end computer now available for AmigaOS.

= Key Specifications =

* ATX form factor

* Dual core PWRficient PA6T-1682M 1.8 Ghz PowerISA v2.04+ CPU

* Xena Co-processor running at 500 Mhz with a XCore XS1-L2 124 SDS

* ATI Radeon HD 1GB 4650 Graphics Card

* 7.1 channel HD Audio

* Memory 4xDDR2 SDRAM Slots

* 10 USB 2.0

* 1x Gigabit Ethernet

* A range of PCIe and PCI slots

* A Xorro and Compact Flash slot

* 2x RS-232 serial ports

* 4x SATA2 connectors

* 1x PATA connector

* 1x JTAG connector

= Manufacturer =

[http://www.a-eon.com A-Eon Technology] is the manufacturer of the AmigaOne X1000 motherboard.

[http://www.amigakit.com AmigaKit] is the worldwide distributor of the AmigaOne X1000 System.

= Troubleshooting Tips =

== X1000 CFE Documentation ==

Please remember to refer to CFE's documentation located in SYS:Documentation/X1000_CFE.pdf for information on boot configuration.

== Where does Kickstart load from? ==

As soon as the "amigaboot.of" loader begins, it scans all the available AmigaOS partitions it can find. Specifically, the SATA CD-ROM and SATA drive connected to Port1, SATA2 and IDE devices are scanned for partitions which are set as AmigaOS bootable, using the FFS2 or SFS file systems and containing an AmigaOS system. Kickstart from the partition with the highest priority is then loaded. After Kickstart is loaded, ALL drives will be scanned again and Workbench from the highest priority bootable drive will load. If your highest priority bootable drive is not connected to Port1, SATA2 then a kickstart from another drive will be loaded.

So, if you add another drive with bootable partitions, you may need to swap SATA cables to get the kickstart to load from the right place.

== X1000 Won't Reboot Reliably ==

# Turn off power to PSU.
# Remove plug from PSU.
# Remove power connector from the motherboard.
# Take out one RAM card leaving only one to the right of the PA6T CPU (i.e. 3rd slot from the left).
# While the RAM card is out check the slots 2 & 3 for dust build up (the CPU fan blows dust onto them) and use a small clean brush to remove it.
# Plug power connector back on to the motherboard.
# Connect PSU power & switch on PSU.
# Turn on X1000.

If the X1000 boots up to Workbench, press and hold the power button for 3-5 seconds & it should shut off.

==X1000 locks up randomly and doesn't boot reliably==

I had this problem for a few months and finally tracked it down to loose SATA power connectors.

I had a PSU Modding kit and made a new power lead, MOLEX to 4 SATA, all on the same lead, spaced to fit 4 drives perfectly with no bent wires.

The new connectors are a much tighter fit and since I changed the lead I've not had a single random lockup and reliable booting.

If you get the insufficient memory error in CFE this is a sign the DVD cable is loose.

==X1000 CPU temperatures are rising==

# Clean both fan filters on the front fan openings.
# Clean the fan filter UNDER the power supply unit.

==X1000 fails to boot, "Loading" indicator goes full red and then stops==

# This will happen when booting an older workbench with a newer graphics card.
# You'll need to update your PCIGraphics.card and RadeonHD.chip, or revert to an HD4000 series graphics card.

==X1000 fails to boot==

May also happen if non-bootable media is left in the CD/DVD drive.

==X1000 fails to boot, "Failed to load amigaboot.of: Insufficient memory"==

# Relax your memory isn't fried.
# Check the SATA cable to your DVDRW drive (top left on the motherboard)
# Don't forget to check the power cable too.

For some reason CFE reports insufficient memory errors when it can't find an optical drive.

If checking cables doesn't correct the problem, check that CFE is able to read the amigaboot.of bootloader. Generally it can read it from an installation CD, a hard disk partition, or even from an internal CompactFlash, but there are constraints which you should be aware of:
* CFE can only boot on sata drives connected to [http://dl.dropbox.com/u/30631303/Amiga/Setting_Board/Sata.jpg Sata0 or Sata2 connectors], so check that your DVD drive and your system hardisk are connected to these.
* CFE can only read a few file systems among which
** ISO for CDs
** FFS2, ext2 or FAT for hard disks or CompactFlash
* CFE can't detect filesystems, they must be specified in the boot command
** for a CD: ''-fs=isofs''
** for an AmigaOS FFS partition: ''-fs=amigafs''
* CFE must find an amigaboot.of file on the unit indicated by the boot command, it's up to you to check that it's available
=== Checking the boot command ===
The boot menu is configured through a set of MENU_x_LABEL/MENU_x_COMMAND pairs. If one of the entry doesn't work, you have to check that:
* the unit exists,
* the filesystem is correct,
* the amigaboot.of file is present.

==== checking the units ====
At CFE prompt, display your menu commands with the ''printenv'' command, you may get such menu entries:
MENU_0_COMMAND=setenv amigaboot_quiet Y ;boot -fs=amigafs ide0.0:amigaboot.of
MENU_1_COMMAND=setenv amigaboot_quiet Y ;boot -fs=iso atapi0.1:amigaboot.of
To check what CFE may access, type the ''show device'' command. (NB: hard disks are displayed as ide units and CD/DVD drives as atapi units)
For example:
CFE> show devices
Device Name Description
------------------- ---------------------------------------------------------
uart0 NS16550 UART at 0xFCFF03F8
pcconsole0 PC Console (USB/VESA)
eeprom0 Microchip 24LC128 EEPROM on SMBus channel 0 dev 0x57
eth0 PA Semi Ethernet (ge3) at 0xE00A3000 (02-00-E0-0A-30-00)
flash0.os SPI flash at FFE00000 offset 00000000 size 1024KB
flash0.boot SPI flash at FFE00000 offset 00100000 size 1024KB
therm0 TI TMP423 Thermal Sensor on SMBus channel 0 dev 0x4C
cf0 CompactFlash ATA disk unit 0 at 0xF0000000
atapi0.0 PCI IDE disk unit 0 at I/O 0000 (PCI:E0590000)
ide0.1 PCI IDE disk unit 1 at I/O 0000 (PCI:E0590000)
eth1 RTL8139 Ethernet at 0xA0310000 (00-50-fc-1f-1f-de)
usbdisk0 USB Disk unit 0
usbdisk1 USB Disk unit 1
*** command status = 0
CFE>
In this example you should notice that CFE does not see ide0.0 and atapi0.1 but ide0.1 and atapi0.0. In this case, it means the menu commands are based ont the hard disk being connected on Sata0 and the CD drive on Sata2, but in fact it's connected the other way around.
Either you modify the menu commands, or you swap the cables on the Sata connectors 0 and 2.

==== checking filesystem ====
Once your units are correctly identified, you should check the filesystem is correct with the ''dir'' command.
Note that the error message may be different depending on the type of unit and the filesystem. Just keep in mind that if the command status is 0, the filesystem is correct.
* trying to read an SFS/02 partition:
CFE> dir -fs=amigafs ide0.1,prod:
Could not init file system: Unsupported function
*** command status = -19
* trying to read a wrong unit:
CFE> dir -fs=amigafs ide0.0:
Could not init file system: Insufficient memory
*** command status = -5
* trying to read a FAT partition as FFS:
CFE> dir -fs=amigafs cf0:
Could not init file system: File not found
*** command status = -18
* trying to read an FFS partition as FAT:
CFE> dir -fs=fat ide0.1:
Could not init file system: File system not recognized
*** command status = -29

* and finally finding the Grail:
CFE> dir -fs=amigafs ide0.1:
Directory
amigaboot.of 51420 ------------r---

51420 bytes in 1 files
0 directories
*** command status = 0
==== finding amigaboot.of ====
Once you get the ''dir'' command working, make sure it lists the amigaboot.of file like in the example above, as CFE will load it and pass control to it to continue the boot process, either to present a second boot menu based on kicklayouts or to directly load the kickstart.

==X1000 won't boot (black screen, no boot at all) with only 3 LEDs lighting on motherboard==

Check the CMOS battery.

== X1000 Keyboard does not work while booting==

Plug the keyboard into the USB connector closest to the white audio jack.

This is "upper left" as you look at the back of the case. (ref Sys:documentation/X1000_QuickstartGuide.pdf page 9)

Do not plug a keyboard with a built in hub in that socket, CFE does not approve.

==Creating a new boot CD step by step==

This is taken from a post on Amigaworld.net by Lyle Hazelwood.

If you have upgraded to a newer graphics card, any old boot CDs that don't have the new RadeonHD drivers will not boot. Here is a simple way to create a more useful CD.

You'll need to go back to a compatible graphics card to get running long enough to do this. I hope your original video card is still available to you.

=== Requirements ===

You have a Bootable Recovery CD, like "AmigaOS 4.1 Update 5". Your current Workbench has been upgraded with the new RadeonHD drivers. You have a blank CDROM disk and a drive capable of burning it.

=== Step by step ===

1. Check SYS:Utilities for "AmiDVD". If not there, insert the recovery CD and run the "Extras Installer", then select AmiDVD and allow it to install.

2. With the recovery CD still in the drive, open a Shell and enter the following commands:
MakeDir RAM:BootVol
Copy CD0: RAM:BootVol ALL CLONE
Copy SYS:Kickstart/PCIGraphics.card RAM:BootVol/System/Kickstart
Copy SYS:Kickstart/RadeonHD.chip RAM:BootVol/System/Kickstart

Then make a note of the exact volume name of CD0:. Mine was "AmigaOS 4.1 Update 5" for this example.

3. Now remove the recovery CD and replace it with a blank CD-ROM.

4. Open SYS:Utilities/AmiDVD/AmiDVD

5. From the "CreateImage" Tab, Set source to RAM:BootVol, then set VolumeName to "AmigaOS 4.1 Update 5".

6. Select Bootable AmigaOS4 and finally select "Create Image".

7. Now on to tab2, "Burn Image", and click on "Burn CD-R"

That's it! The resulting disk should be identical to the original but will boot properly with newer graphics cards.

{{Note|title=Remember|text=This new boot image is under the same agreement that the RadeonHD drivers were distributed under. It is NOT OK to share this disk with others.}}

==Intermittent power on/off problems==

Check all PCI(e) cards are securely in their slots.

==Problems updating your Kickstart==

Kickstart will load from the highest priority bootable partition on THE FIRST DRIVE ONLY.
If your highest priority bootable drive is on a second SATA disk, then that will boot over the kickstart found on Disk1.

= Updating Nemo's Firmware =

Warning, this procedure is not harmless and should only be done when you know exactly what you are doing. 
[[Updating Nemo firmware]]

= AmigaOS 4.1 Final Edition FAQ =

Insert documentation here...

AmigaOne X1000

2014-04-12T17:26:13Z

Ölrick Lefebvre: ADD: checking CFE can access amigaboot.of

The AmigaOne X1000 is a powerful PowerPC-based high-end computer now available for AmigaOS.

= Key Specifications =

* ATX form factor

* Dual core PWRficient PA6T-1682M 1.8 Ghz PowerISA v2.04+ CPU

* Xena Co-processor running at 500 Mhz with a XCore XS1-L2 124 SDS

* ATI Radeon HD 1GB 4650 Graphics Card

* 7.1 channel HD Audio

* Memory 4xDDR2 SDRAM Slots

* 10 USB 2.0

* 1x Gigabit Ethernet

* A range of PCIe and PCI slots

* A Xorro and Compact Flash slot

* 2x RS-232 serial ports

* 4x SATA2 connectors

* 1x PATA connector

* 1x JTAG connector

= Manufacturer =

[http://www.a-eon.com A-Eon Technology] is the manufacturer of the AmigaOne X1000 motherboard.

[http://www.amigakit.com AmigaKit] is the worldwide distributor of the AmigaOne X1000 System.

= Frequently Asked Questions =

== When will Mixer be upgraded to support the X1000? ==

The X1000's HDAudio chip does not support monitoring. As such, the Mixer will never work on the X1000 since the hardware does not exist.

A software only solution may be possible to allow for monitoring but that will use up system resources and may or may not work with Mixer.

= Troubleshooting Tips =

== X1000 CFE Documentation ==

Please remember to refer to CFE's documentation located in SYS:Documentation/X1000_CFE.pdf for information on boot configuration.

== X1000 Won't Reboot Reliably ==

# Turn off power to PSU.
# Remove plug from PSU.
# Remove power connector from the motherboard.
# Take out one RAM card leaving only one to the right of the PA6T CPU (i.e. 3rd slot from the left).
# While the RAM card is out check the slots 2 & 3 for dust build up (the CPU fan blows dust onto them) and use a small clean brush to remove it.
# Plug power connector back on to the motherboard.
# Connect PSU power & switch on PSU.
# Turn on X1000.

If the X1000 boots up to Workbench, press and hold the power button for 3-5 seconds & it should shut off.

==X1000 CPU temperatures are rising==

# Clean both fan filters on the front fan openings.
# Clean the fan filter UNDER the power supply unit.

==X1000 fails to boot, "Loading" indicator goes full red and then stops==

# This will happen when booting an older workbench with a newer graphics card.
# You'll need to update your PCIGraphics.card and RadeonHD.chip, or revert to an HD4000 series graphics card.

==X1000 fails to boot==

May also happen if non-bootable media is left in the CD/DVD drive.

==X1000 fails to boot, "Failed to load amigaboot.of: Insufficient memory"==

# Relax your memory isn't fried.
# Check the SATA cable to your DVDRW drive (top left on the motherboard)
# Don't forget to check the power cable too.

For some reason CFE reports insufficient memory errors when it can't find an optical drive.

If checking cables doesn't correct the problem, check that CFE is able to read the amigaboot.of bootloader. Generally it can read it from an installation CD, a hard disk partition, or even from an internal CompactFlash, but there are constraints which you should be aware of:
* CFE can only boot on sata drives connected to [http://dl.dropbox.com/u/30631303/Amiga/Setting_Board/Sata.jpg Sata0 or Sata2 connectors], so check that your DVD drive and your system hardisk are connected to these.
* CFE can only read a few file systems among which
** ISO for CDs
** FFS2, ext2 or FAT for hard disks or CompactFlash
* CFE can't detect filesystems, they must be specified in the boot command
** for a CD: ''-fs=isofs''
** for an AmigaOS FFS partition: ''-fs=amigafs''
* CFE must find an amigaboot.of file on the unit indicated by the boot command, it's up to you to check that it's available
=== Checking the boot command ===
The boot menu is configured through a set of MENU_x_LABEL/MENU_x_COMMAND pairs. If one of the entry doesn't work, you have to check that:
* the unit exists,
* the filesystem is correct,
* the amigaboot.of file is present.

==== checking the units ====
At CFE prompt, display your menu commands with the ''printenv'' command, you may get such menu entries:
MENU_0_COMMAND=setenv amigaboot_quiet Y ;boot -fs=amigafs ide0.0:amigaboot.of
MENU_1_COMMAND=setenv amigaboot_quiet Y ;boot -fs=iso atapi0.1:amigaboot.of
To check what CFE may access, type the ''show device'' command. (NB: hard disks are displayed as ide units and CD/DVD drives as atapi units)
For example:
CFE> show devices
Device Name Description
------------------- ---------------------------------------------------------
uart0 NS16550 UART at 0xFCFF03F8
pcconsole0 PC Console (USB/VESA)
eeprom0 Microchip 24LC128 EEPROM on SMBus channel 0 dev 0x57
eth0 PA Semi Ethernet (ge3) at 0xE00A3000 (02-00-E0-0A-30-00)
flash0.os SPI flash at FFE00000 offset 00000000 size 1024KB
flash0.boot SPI flash at FFE00000 offset 00100000 size 1024KB
therm0 TI TMP423 Thermal Sensor on SMBus channel 0 dev 0x4C
cf0 CompactFlash ATA disk unit 0 at 0xF0000000
atapi0.0 PCI IDE disk unit 0 at I/O 0000 (PCI:E0590000)
ide0.1 PCI IDE disk unit 1 at I/O 0000 (PCI:E0590000)
eth1 RTL8139 Ethernet at 0xA0310000 (00-50-fc-1f-1f-de)
usbdisk0 USB Disk unit 0
usbdisk1 USB Disk unit 1
*** command status = 0
CFE>
In this example you should notice that CFE does not see ide0.0 and atapi0.1 but ide0.1 and atapi0.0. In this case, it means the menu commands are based ont the hard disk being connected on Sata0 and the CD drive on Sata2, but in fact it's connected the other way around.
Either you modify the menu commands, or you swap the cables on the Sata connectors 0 and 2.

==== checking filesystem ====
Once your units are correctly identified, you should check the filesystem is correct with the ''dir'' command.
Note that the error message may be different depending on the type of unit and the filesystem. Just keep in mind that if the command status is 0, the filesystem is correct.
* trying to read an SFS/02 partition:
CFE> dir -fs=amigafs ide0.1,prod:
Could not init file system: Unsupported function
*** command status = -19
* trying to read a wrong unit:
CFE> dir -fs=amigafs ide0.0:
Could not init file system: Insufficient memory
*** command status = -5
* trying to read a FAT partition as FFS:
CFE> dir -fs=amigafs cf0:
Could not init file system: File not found
*** command status = -18
* trying to read an FFS partition as FAT:
CFE> dir -fs=fat ide0.1:
Could not init file system: File system not recognized
*** command status = -29

* and finally finding the Grail:
CFE> dir -fs=amigafs ide0.1:
Directory
amigaboot.of 51420 ------------r---

51420 bytes in 1 files
0 directories
*** command status = 0
==== finding amigaboot.of ====
Once you get the ''dir'' command working, make sure it lists the amigaboot.of file like in the example above, as CFE will load it and pass control to it to continue the boot process, either to present a second boot menu based on kicklayouts or to directly load the kickstart.

==X1000 won't boot (black screen, no boot at all) with only 3 LEDs lighting on motherboard==

Check the CMOS battery.

== X1000 Keyboard does not work while booting==

Plug the keyboard into the USB connector closest to the white audio jack.

This is "upper left" as you look at the back of the case. (ref Sys:documentation/X1000_QuickstartGuide.pdf page 9)

Do not plug a keyboard with a built in hub in that socket, CFE does not approve.

==Creating a new boot CD step by step==

This is taken from a post on Amigaworld.net by Lyle Hazelwood.

If you have upgraded to a newer graphics card, any old boot CDs that don't have the new RadeonHD drivers will not boot. Here is a simple way to create a more useful CD.

You'll need to go back to a compatible graphics card to get running long enough to do this. I hope your original video card is still available to you.

=== Requirements ===

You have a Bootable Recovery CD, like "AmigaOS 4.1 Update 5". Your current Workbench has been upgraded with the new RadeonHD drivers. You have a blank CDROM disk and a drive capable of burning it.

=== Step by step ===

1. Check SYS:Utilities for "AmiDVD". If not there, insert the recovery CD and run the "Extras Installer", then select AmiDVD and allow it to install.

2. With the recovery CD still in the drive, open a Shell and enter the following commands:
MakeDir RAM:BootVol
Copy CD0: RAM:BootVol ALL CLONE
Copy SYS:Kickstart/PCIGraphics.card RAM:BootVol/System/Kickstart
Copy SYS:Kickstart/RadeonHD.chip RAM:BootVol/System/Kickstart

Then make a note of the exact volume name of CD0:. Mine was "AmigaOS 4.1 Update 5" for this example.

3. Now remove the recovery CD and replace it with a blank CD-ROM.

4. Open SYS:Utilities/AmiDVD/AmiDVD

5. From the "CreateImage" Tab, Set source to RAM:BootVol, then set VolumeName to "AmigaOS 4.1 Update 5".

6. Select Bootable AmigaOS4 and finally select "Create Image".

7. Now on to tab2, "Burn Image", and click on "Burn CD-R"

That's it! The resulting disk should be identical to the original but will boot properly with newer graphics cards.

{{Note|title=Remember|text=This new boot image is under the same agreement that the RadeonHD drivers were distributed under. It is NOT OK to share this disk with others.}}

==Intermittent power on/off problems==

Check all PCI(e) cards are securely in their slots.