Manuals/Neo FreeRunner

From Openmoko

(Difference between revisions)
Jump to: navigation, search
(Software installation)
(Software installation: adding information on bootloader and GSM firmware)
Line 154: Line 154:
 
===Installing a bootloader===
 
===Installing a bootloader===
  
Qi is the recommended bootloader for the Neo FreeRunner. You can download it from http://downloads.openmoko.org/distro/testing/NeoFreerunner/ and install it using the program NeoTool on your Linux PC. (See http://wiki.openmoko.org/wiki/No_Linux if you do not have Linux on your PC)
+
The bootloader is needed to start up the operating system on the phone. Qi is the recommended bootloader for the Neo FreeRunner. Installing it will result in faster booting. You can download Qi from http://downloads.openmoko.org/distro/testing/NeoFreerunner/ and install it using the program NeoTool on your Linux PC. (See http://wiki.openmoko.org/wiki/No_Linux if you do not have Linux on your PC)
  
 
===Updating the GSM Firmware===
 
===Updating the GSM Firmware===
 +
 +
The current version of the GSM Firmware is called Moko 11. If you do not have this version installed yet you should do an upgrade, which will fix several issues related to the phone functionality of the FreeRunner.
  
 
<!---THIS SECTION SHOULD NOT BE EDITED HERE BUT ONLY REGULARLY COPIED FROM GSM/Flashing !!!!--->
 
<!---THIS SECTION SHOULD NOT BE EDITED HERE BUT ONLY REGULARLY COPIED FROM GSM/Flashing !!!!--->

Revision as of 22:03, 3 August 2009

Thank you for purchasing this Developer release of Neo FreeRunner. The Neo FreeRunner phone is the second hardware platform to take advantage of Openmoko. This guide will help you get to know your Neo FreeRunner and how to start using your Neo FreeRunner.

Some Frequently Asked Questions for new owners are featured in the FAQ.

Neo FreeRunner Package

Contents

Package Contents

Inside the package


Circle2.gif Neo FreeRunner
Circle2.gif Stylus
Circle2.gif Battery
Circle2.gif Charger
Circle2.gif USB Cable (A -> Mini-B 5-pole)
Circle2.gif Thank You green card
 
NOTE:

Get the source code

The software included in this product contains copyrighted software that is licensed under the GPL. A complete corresponding source code or CD-ROM ISO image with the GPL license is available for download here. You may also obtain the same corresponding CD-ROM by sending a money order or check for $10 to any one of our distributors.

Please write “source for Neo FreeRunner ” in the memo line of your payment.


Setting up the hardware, getting to know the Neo FreeRunner physically

Installing the Micro-SD card, the SIM card, and the Battery

Circle2.gif Remove the rear cover of the Neo FreeRunner by first holding the Neo FreeRunner on the side and then use a credit card (or your fingernail, if you have strong fingernails) to prise off the rear cover at the slot on top of the device.

Open the case like this.
Opening !


Circle2.gif Now you should be able to locate the combined SIM and Micro-SD card holder at the bottom of the battery compartment.

Circle2.gif Unlock the SIM card holder by sliding the metal clip down, towards the USB socket, with your fingernail. Use caution, as these parts are delicate and could be damaged by forcing them in the wrong direction.


Put the SIM card and SD card here.

Circle2.gif Lift up on the SIM card holder.

Circle2.gif The Micro-SD card holder is held in place by a latch on either side. It is easiest to open the Micro-SD card holder by releasing these latches one at a time rather than by lifting from the middle, as lifting from the middle tends to increase the latching pressure. A small screwdriver or knife can be used for this, though it's strongly deprecated. Refer to this photo footage for a simple yet handy little hack involving some scotchtape, to make your life easier.

Circle2.gif Insert the Micro-SD card into the Micro-SD card holder. Note that on the inside of metal part of the holder there are little holding tabs for the card. Slide the card in these holders (on the metal part) before closing the card holder. Note that the electrical contacts should face down and towards the edge of the Neo FreeRunner.

Circle2.gif Close the Micro-SD card holder, making sure that both latches of the holder are securely fastened.

Circle2.gif Insert the SIM card into the SIM card holder, taking care to slide inside the two metal tabs in the cover. Note that the electrical contacts should face down and that the cut corner should be closest to the external GPS Antenna Socket.

Circle2.gif Close the SIM card holder and lock it by sliding the metal clip towards the external GPS Antenna Socket on the FreeRunner.

SIM and SD holders open, with cards in place
Some models look like this, the little blob is not a defect

Circle2.gif Insert the battery into the battery compartment, aligning the electrical contacts on the battery with the electrical contacts in the battery compartment. Insert the side with the electrical contacts first.

Circle2.gif Replace the rear cover on the FreeRunner.


Tips

A short video is also available. It was shot using the previous version of the Neo, but the installation procedure remains the same.

Charging the Neo FreeRunner

Before using the Neo FreeRunner for the first time, you should charge the battery completely. The battery can be charged using the provided charger at 1000mA or from a powered USB port capable of providing 500mA worth of current. Most computers will be able to charge the FreeRunner without any problems.

Neo FreeRunner does NOT charge when powered off, so be sure to turn it on and allow it to boot all the way to the GUI (Graphical User Interface). This should happen automatically when you plug in USB power, either from a computer or the provided charger. If it does not, you can turn the power on manually by pressing and holding the power button, which is located just below the USB jack.

Although the provided charger is rated at 2A, the maximum charge rate of the Neo FreeRunner is 1A, and thus the charge rate with the charger is less than the charger capacity.

The provided charger includes three "national" plugs. The default is North America, with alternative U.K (3 square pins) and Euro (two round pins) adapters. To install the alternative power adapters, depress the latch in the cover (on the opposite side of the charger from the product information label) and slide the cover outward. Note that the two North American pins do not come out; the other adapters slide over them, and snap into place. The two-pin Euro adapter is removed in the same way as the cover. The three-pin U.K. adapter is removed by gently pressing the dummy ground pin (black) toward the end of the adapter with the cord and then sliding it off the adapter.

Charging an empty battery at 100mA takes 12~15 hours *), at 500mA (PC) takes 2~3 hours, and at 1000mA (wallcharger) takes 1.5~3hours. (90%~100%)
*) charging with 100mA will occur only if device is suspended, as otherwise system takes more power than the 100mA provided by USB power source, and your battery never reaches full capacity or even drains slowly.

NOTE: See Neo FreeRunner Hardware Issues about not allowing the battery to discharge completely.


Buttons and connectors

 
Power Button, USB and external GPS Antenna (left to right)
 
AUX Button and headset jack (left to right)
Power

Tapping the power button suspends the GTA02.

Holding the power button shutsdown the device.
Aux

Tapping or holding the Aux button locks the screen.


Booting

Booting the Neo FreeRunner takes about 2 minutes overall, so patience is in order. The longest step comes after the Linux boot messages in very small fonts have scrolled by, at the graphical "openmoko" sunrise page.

Phone Jack

The phone jack is a 2.5mm connector with four contacts: stereo + MIC. It is compatible with the headsets used by Motorola smartphones (A780,A1200, ...) and the V-360.

More information on Headset page.

Unlocking the screen

When the screen is locked, you should see a Matrix-style green graphic with the Openmoko symbol in the middle of the bottom of the screen along with lock and unlock symbols. If you drag the Openmoko symbol to the unlock symbol at the top then the screen will become unlocked.

Identifying which revision you have

You will want to determine which revision of the phone you have

These two are important, as they allow you to know which image is flashed on you phone at the factory (c.f. Distributions and Neo_FreeRunner_Hardware#History).

Software installation

Almost all of the software on the Neo FreeRunner can be updated, including the bootloader which is needed to power up the device and the software on the GSM chip.

Installing a bootloader

The bootloader is needed to start up the operating system on the phone. Qi is the recommended bootloader for the Neo FreeRunner. Installing it will result in faster booting. You can download Qi from http://downloads.openmoko.org/distro/testing/NeoFreerunner/ and install it using the program NeoTool on your Linux PC. (See http://wiki.openmoko.org/wiki/No_Linux if you do not have Linux on your PC)

Updating the GSM Firmware

The current version of the GSM Firmware is called Moko 11. If you do not have this version installed yet you should do an upgrade, which will fix several issues related to the phone functionality of the FreeRunner.


This works by starting the FreeRunner from a system installed on the uSD, which will automatically apply all needed instructions to flash the GSM firmware to the chip. The uSD image will have to be written on a uSD, which will overwrite all its content, so as to make sure it is repartitioned correctly and that it contains the correct bootable system. The procedure has proven to do a reliable job on flashing MOKO11 to GTA02. Chances anything fails are minimal if you _strictly_ follow the instructions. There's no way to do any harm to your device by using this method.

Take special care though about the destination of `dd`, it has to be the *physical* device (e.g. foo0) of your uSD-card, *not* any partition (e.g. foo0p1). Also make sure there are *no* mounted partitions left on the uSD when starting `dd`!
Triple-check you are not accidentally overwriting your system-HD, by e.g using /dev/sda instead of /dev/sdc! Double-check once more! This is the one-typo-kills-system case ;-) You've been warned.

  1. Download and untar http://people.openmoko.org/joerg/calypso_moko_FW/moko11/flash-moko11_uSD-image.tar.gz on your desktop computer. Read the README.tx file that came with the tarball.
  2. Insert a uSD to your computer's reader, and unmount all uSD-partitions that might have been automounted (use mount or df -h to check). Do not use "safely remove" for this.
  3. Use dd to write the image flash-moko11-2.image to the physical(!) uSD-device (this will erase all data from your uSD, including previous partition table and partitions! It will as well erase all data from your computer's HD, in case you accidentally `dd` to this device instead of uSD). Log in as root or use sudo to get root privileges needed to write to the uSD card. For example:
  4. % sudo dd if=flash-moko11-2.image of=/dev/mmcblk0
    
  5. Execute sync or eject <device> to make sure everything is flushed to the uSD before physically removing it from the reader.
  6. Insert the uSD to your FreeRunner, boot from NOR-U-Boot and select the "Boot from microSD" option.
  7. See the boot and flashing process happen, and wait until a green "d_o_n_e" message shows on screen (takes some 6 min). You may can now remove the uSD or login via ssh and use mickeyterm to access the modem and check the firmware version is indeed moko11. Right after flashing, pressing the power button will suspend/resume the Neo, but not shut it down. If you want to do so, you can either remove the battery by hand, or (more gentle way) log in as root into it through the USB cable (root password is blank), and issue:
  8.  # shutdown -h now
    

NOTE

If you don't have a uSD reader on your PC, you can dd from the Neo: install task-base-smbfs, u(n)mount /media/card, mount the directory in which you have the flash-moko11-2.image file and do the dd stuff. This will take about 12 minutes.

You can speed this up by re-gziping just the image file and using the following command to decompress it directly to the flash card:

 % gzip -d < flash-moko11-2.image.gz > /dev/mmcblk0

Using this gzip method, you can actually do the update with an in place image as long as it is shell enabled and has 92M free on the main file system (all but Android and Neovento right now). Just get the 92M gzip file to the phone, use the above line to extract it to the card after unmounting.

Or, maybe in a more simpler manner:

 root@om-gta02 ~ $ umount /media/card
and then from desktop:
 scp flash-moko11-2.image root@192.168.0.202:/dev/mmcblk0

NOTE 2

Whether you have Qi installed or not (see above) as your boot loader, you must power up to the NoR menu (Hold AUX Key, press Power button) and select "Boot from microSD (fat/ext2)" to begin the installation process (per DocScrutinizer in #openmoko). Do not let Qi boot the uSD. Although it still seems to flash OK, the green "d_o_n_e" does not show up, to give you the warm feeling that everything is OK.

You can confirm the firmware version number using the mickeyterm (cmd: "AT+CGMR"). In SHR-Settings, Phone/Modem Information will supply the same number.

Installing a distribution

This section describes how to install a distribution on the internal flash memory of the Neo FreeRunner. If you want to install it on the memory card please refer to the guide provided by the distribution.

For installing a new distribution you will need two files, a root file system (rootfs) image and a kernel image. The root file system image usually ends with ".jffs2", and the kernel image ends with ".uimage.bin". You can get these files from http://wiki.openmoko.org/wiki/Download . Use the program NeoTool to install the distribution on your FreeRunner.

Personal tools

Thank you for purchasing this Developer release of Neo FreeRunner. The Neo FreeRunner phone is the second hardware platform to take advantage of Openmoko. This guide will help you get to know your Neo FreeRunner and how to start using your Neo FreeRunner.

Some Frequently Asked Questions for new owners are featured in the FAQ.

Neo FreeRunner Package

Package Contents

Inside the package


Circle2.gif Neo FreeRunner
Circle2.gif Stylus
Circle2.gif Battery
Circle2.gif Charger
Circle2.gif USB Cable (A -> Mini-B 5-pole)
Circle2.gif Thank You green card
 
NOTE:

Get the source code

The software included in this product contains copyrighted software that is licensed under the GPL. A complete corresponding source code or CD-ROM ISO image with the GPL license is available for download here. You may also obtain the same corresponding CD-ROM by sending a money order or check for $10 to any one of our distributors.

Please write “source for Neo FreeRunner ” in the memo line of your payment.


Setting up the hardware, getting to know the Neo FreeRunner physically

Installing the Micro-SD card, the SIM card, and the Battery

Circle2.gif Remove the rear cover of the Neo FreeRunner by first holding the Neo FreeRunner on the side and then use a credit card (or your fingernail, if you have strong fingernails) to prise off the rear cover at the slot on top of the device.

Open the case like this.
Opening !


Circle2.gif Now you should be able to locate the combined SIM and Micro-SD card holder at the bottom of the battery compartment.

Circle2.gif Unlock the SIM card holder by sliding the metal clip down, towards the USB socket, with your fingernail. Use caution, as these parts are delicate and could be damaged by forcing them in the wrong direction.


Put the SIM card and SD card here.

Circle2.gif Lift up on the SIM card holder.

Circle2.gif The Micro-SD card holder is held in place by a latch on either side. It is easiest to open the Micro-SD card holder by releasing these latches one at a time rather than by lifting from the middle, as lifting from the middle tends to increase the latching pressure. A small screwdriver or knife can be used for this, though it's strongly deprecated. Refer to this photo footage for a simple yet handy little hack involving some scotchtape, to make your life easier.

Circle2.gif Insert the Micro-SD card into the Micro-SD card holder. Note that on the inside of metal part of the holder there are little holding tabs for the card. Slide the card in these holders (on the metal part) before closing the card holder. Note that the electrical contacts should face down and towards the edge of the Neo FreeRunner.

Circle2.gif Close the Micro-SD card holder, making sure that both latches of the holder are securely fastened.

Circle2.gif Insert the SIM card into the SIM card holder, taking care to slide inside the two metal tabs in the cover. Note that the electrical contacts should face down and that the cut corner should be closest to the external GPS Antenna Socket.

Circle2.gif Close the SIM card holder and lock it by sliding the metal clip towards the external GPS Antenna Socket on the FreeRunner.

SIM and SD holders open, with cards in place
Some models look like this, the little blob is not a defect

Circle2.gif Insert the battery into the battery compartment, aligning the electrical contacts on the battery with the electrical contacts in the battery compartment. Insert the side with the electrical contacts first.

Circle2.gif Replace the rear cover on the FreeRunner.


Tips

A short video is also available. It was shot using the previous version of the Neo, but the installation procedure remains the same.

Charging the Neo FreeRunner

Before using the Neo FreeRunner for the first time, you should charge the battery completely. The battery can be charged using the provided charger at 1000mA or from a powered USB port capable of providing 500mA worth of current. Most computers will be able to charge the FreeRunner without any problems.

Neo FreeRunner does NOT charge when powered off, so be sure to turn it on and allow it to boot all the way to the GUI (Graphical User Interface). This should happen automatically when you plug in USB power, either from a computer or the provided charger. If it does not, you can turn the power on manually by pressing and holding the power button, which is located just below the USB jack.

Although the provided charger is rated at 2A, the maximum charge rate of the Neo FreeRunner is 1A, and thus the charge rate with the charger is less than the charger capacity.

The provided charger includes three "national" plugs. The default is North America, with alternative U.K (3 square pins) and Euro (two round pins) adapters. To install the alternative power adapters, depress the latch in the cover (on the opposite side of the charger from the product information label) and slide the cover outward. Note that the two North American pins do not come out; the other adapters slide over them, and snap into place. The two-pin Euro adapter is removed in the same way as the cover. The three-pin U.K. adapter is removed by gently pressing the dummy ground pin (black) toward the end of the adapter with the cord and then sliding it off the adapter.

Charging an empty battery at 100mA takes 12~15 hours *), at 500mA (PC) takes 2~3 hours, and at 1000mA (wallcharger) takes 1.5~3hours. (90%~100%)
*) charging with 100mA will occur only if device is suspended, as otherwise system takes more power than the 100mA provided by USB power source, and your battery never reaches full capacity or even drains slowly.

NOTE: See Neo FreeRunner Hardware Issues about not allowing the battery to discharge completely.


Buttons and connectors

 
Power Button, USB and external GPS Antenna (left to right)
 
AUX Button and headset jack (left to right)
Power

Tapping the power button suspends the GTA02.

Holding the power button shutsdown the device.
Aux

Tapping or holding the Aux button locks the screen.


Booting

Booting the Neo FreeRunner takes about 2 minutes overall, so patience is in order. The longest step comes after the Linux boot messages in very small fonts have scrolled by, at the graphical "openmoko" sunrise page.

Phone Jack

The phone jack is a 2.5mm connector with four contacts: stereo + MIC. It is compatible with the headsets used by Motorola smartphones (A780,A1200, ...) and the V-360.

More information on Headset page.

Unlocking the screen

When the screen is locked, you should see a Matrix-style green graphic with the Openmoko symbol in the middle of the bottom of the screen along with lock and unlock symbols. If you drag the Openmoko symbol to the unlock symbol at the top then the screen will become unlocked.

Identifying which revision you have

You will want to determine which revision of the phone you have

These two are important, as they allow you to know which image is flashed on you phone at the factory (c.f. Distributions and Neo_FreeRunner_Hardware#History).

Software installation

Almost all of the software on the Neo FreeRunner can be updated, including the bootloader which is needed to power up the device and the software on the GSM chip.

Installing a bootloader

Qi is the recommended bootloader for the Neo FreeRunner. You can download it from http://downloads.openmoko.org/distro/testing/NeoFreerunner/ and install it using the program NeoTool on your Linux PC. (See http://wiki.openmoko.org/wiki/No_Linux if you do not have Linux on your PC)

Updating the GSM Firmware

This works by starting the FreeRunner from a system installed on the uSD, which will automatically apply all needed instructions to flash the GSM firmware to the chip. The uSD image will have to be written on a uSD, which will overwrite all its content, so as to make sure it is repartitioned correctly and that it contains the correct bootable system. The procedure has proven to do a reliable job on flashing MOKO11 to GTA02. Chances anything fails are minimal if you _strictly_ follow the instructions. There's no way to do any harm to your device by using this method.

Take special care though about the destination of `dd`, it has to be the *physical* device (e.g. foo0) of your uSD-card, *not* any partition (e.g. foo0p1). Also make sure there are *no* mounted partitions left on the uSD when starting `dd`!
Triple-check you are not accidentally overwriting your system-HD, by e.g using /dev/sda instead of /dev/sdc! Double-check once more! This is the one-typo-kills-system case ;-) You've been warned.

  1. Download and untar http://people.openmoko.org/joerg/calypso_moko_FW/moko11/flash-moko11_uSD-image.tar.gz on your desktop computer. Read the README.tx file that came with the tarball.
  2. Insert a uSD to your computer's reader, and unmount all uSD-partitions that might have been automounted (use mount or df -h to check). Do not use "safely remove" for this.
  3. Use dd to write the image flash-moko11-2.image to the physical(!) uSD-device (this will erase all data from your uSD, including previous partition table and partitions! It will as well erase all data from your computer's HD, in case you accidentally `dd` to this device instead of uSD). Log in as root or use sudo to get root privileges needed to write to the uSD card. For example:
  4. % sudo dd if=flash-moko11-2.image of=/dev/mmcblk0
    
  5. Execute sync or eject <device> to make sure everything is flushed to the uSD before physically removing it from the reader.
  6. Insert the uSD to your FreeRunner, boot from NOR-U-Boot and select the "Boot from microSD" option.
  7. See the boot and flashing process happen, and wait until a green "d_o_n_e" message shows on screen (takes some 6 min). You may can now remove the uSD or login via ssh and use mickeyterm to access the modem and check the firmware version is indeed moko11. Right after flashing, pressing the power button will suspend/resume the Neo, but not shut it down. If you want to do so, you can either remove the battery by hand, or (more gentle way) log in as root into it through the USB cable (root password is blank), and issue:
  8.  # shutdown -h now
    

NOTE

If you don't have a uSD reader on your PC, you can dd from the Neo: install task-base-smbfs, u(n)mount /media/card, mount the directory in which you have the flash-moko11-2.image file and do the dd stuff. This will take about 12 minutes.

You can speed this up by re-gziping just the image file and using the following command to decompress it directly to the flash card:

 % gzip -d < flash-moko11-2.image.gz > /dev/mmcblk0

Using this gzip method, you can actually do the update with an in place image as long as it is shell enabled and has 92M free on the main file system (all but Android and Neovento right now). Just get the 92M gzip file to the phone, use the above line to extract it to the card after unmounting.

Or, maybe in a more simpler manner:

 root@om-gta02 ~ $ umount /media/card
and then from desktop:
 scp flash-moko11-2.image root@192.168.0.202:/dev/mmcblk0

NOTE 2

Whether you have Qi installed or not (see above) as your boot loader, you must power up to the NoR menu (Hold AUX Key, press Power button) and select "Boot from microSD (fat/ext2)" to begin the installation process (per DocScrutinizer in #openmoko). Do not let Qi boot the uSD. Although it still seems to flash OK, the green "d_o_n_e" does not show up, to give you the warm feeling that everything is OK.

You can confirm the firmware version number using the mickeyterm (cmd: "AT+CGMR"). In SHR-Settings, Phone/Modem Information will supply the same number.

Installing a distribution

This section describes how to install a distribution on the internal flash memory of the Neo FreeRunner. If you want to install it on the memory card please refer to the guide provided by the distribution.

For installing a new distribution you will need two files, a root file system (rootfs) image and a kernel image. The root file system image usually ends with ".jffs2", and the kernel image ends with ".uimage.bin". You can get these files from http://wiki.openmoko.org/wiki/Download . Use the program NeoTool to install the distribution on your FreeRunner.