Openmoko - User contributions [en]

Offtopic/maemo-migration and backup

2012-12-24T16:48:02Z

JOERG: sorry for offtopic, but it's only fair to help a bit, since SHR got some N900 for free

This page created by Joerg in an effort for a project crossover help during possibly all of maemo.org infra going down and so the community over there needs a place to share URLS, latest info, and so on

For 'chat' please use the talk page of this page

/jOERG

Battery Questions and Answers

2012-09-06T14:52:36Z

JOERG: /* I have several compatible batteries. What are the storage requirements for them? */

NB: Some of the described behaviour depends on the kernel, the
relevant code was pushed on 2009-08-02 to andy-tracking. Some older kernel versions may have quite nasty hacks ('reenabling MBC though battery reports full') that seriously wreck your battery within months.

== Battery care and safety guidelines ==

=== How can I break my battery? ===
To successfully kill your LiIon battery without applying brute force, you simply may disobey any of the following advices:

==== Temperature ====
Never expose or let warm up battery to high temperatures. 70°C might be a limit for safe operation, and >100°C most likely is a killer for the cell. This is especially true during charge/discharge.

==== Drop ====
Never let the battery drop on a hard surface or by any other means expose to hard impact.

==== Wrong storage ====
LiIon cells don't like to be kept at any extreme for a prolonged time. So *never* store away your device with battery inserted, for a period longer than a few days. Charge battery to a reasonable level prior to extended periods of no usage.
Do not store battery in charger, as this may cause a permanent charging level of 100% which is as deteriorating to the LiIon cell chemistry as is storage at 0%. Keeping battery in Neo which is powered by external source is safe though, even for months, as the Neo's PMU charger circuit takes care to treat the battery nicely.

Also see [http://wiki.openmoko.org/wiki/Battery_Questions_and_Answers#I_have_several_compatible_batteries._What_are_the_storage_requirements_for_them.3F Storage]

== Hardware capabilities ==

=== What batteries can be used with gta01 and gta02? ===
Original OM gta01, [[Neo FreeRunner Battery|gta02]], Nokia [http://europe.nokia.com/find-products/accessories/all-accessories/power/batteries/nokia-battery-bl-5c BL-5C], [http://europe.nokia.com/find-products/accessories/all-accessories/power/batteries/nokia-battery-bl-6c BL-6C] and compatibles.

=== Do other BL-5/6C compatible batteries fit? ===
If the battery is thicker than BL-6C, you won't be able to close
the back cover. Nokia's BL-4C is a bit thinner than the BL-5C so it also fits, but has noticeably shorter battery life.

=== What is the difference between all those types? ===

==== Capacity ====
{|border="1" cellspacing="0" cellpadding="5"
| gta01, gta02 || 1200 mAh
|-
| BL-4C old (new) || 720 (860) mAh
|-
| BL-5C old (newer/new) || 850 (970/1020) mAh
|-
| BL-6C || 1150 mAh
|}

==== Temperature control ====
{|border="1" cellspacing="0" cellpadding="5"
| gta01, BL-5C, BL-6C || thermistor
|-
| gta02 || bq27000
|}

==== Special features ====

gta02 - accurate and sophisticated reporting of capacity,
time_to_full, time_to_empty, temperature and battery current during
both charge and discharge thanks to bq27000 (aka [http://de.wikipedia.org/wiki/Coulomb Coulomb] Counter). More details at [[Neo FreeRunner Battery]].

=== What are hardware capabilities of gta01 and gta02 with regard to battery management? ===

gta01: charging all battery types, measuring temperature with
battery-integrated thermistor (currently charging and measuring
temperature for non-gta01 batteries doesn't work due to the kernel
driver issues but it's software limitation), measuring battery output
voltage, very inaccurate and noisy measuring of battery current

gta02: charging all battery types, measuring battery output voltage,
communicating with bq27000

=== Can nokia phones use/charge gta01/gta02 batteries? ===

gta01 and gta02 batteries will fit wherever BL-6C fits but they
can't be charged in nokia phones unless you isolate the middle pin
from the battery and connect a resistor of ~50k (actual measured value
on a cold (25C) battery is 75k, on a slightly warm battery - 82k) from
it to the ground (to fake a thermistor presence).

=== Can third-party chargers charge gta01/gta02 batteries? ===

The "good" ones will most probably require the same trick needed
for nokia phones. More cheaper ones are more likely to ignore
thermistor absence.

=== I have several compatible batteries. What are the storage requirements for them? ===

Keep in a dry cool place charged to no more than 75% and NEVER under 25%. Check every 3 months and recharge when due, cells will self-discharge over time and once they reach 0% level they are dead within weeks!

=== That bq27000 chip seems to be pretty cool, how can i read and understand its raw registers? ===

[[User:jOERG|DocScrutinizer]] to the rescue! Here's his magic script to do that: [http://people.openmoko.org/joerg/battery/bq27k-detail].

== Safety considerations in detail ==

=== Do OM devices control temperature to stop charging if the battery gets too hot? ===

GTA02 Neo FreeRunner:No; GTA01 Neo 1973:Yes (if PMU PCF50606 Main battery charger is configured correctly)

=== Isn't it dangerous? ===

No, since all batteries (not raw cells!) have an integrated
protection circuits.

=== Can i use that fancy 2800 mAh BL-5C-compatible battery i saw on ebay? ===

Unless you want an explosion in your pocket i wouldn't recommend
using any battery that is not produced by a reputable vendor and
widely tested. And even reputable vendors make mistakes, nokia once
had to recall 46 million batteries manufactured by Matsushita ([http://batteryreplacement.nokia.com/batteryreplacement/en/advisory-2007.html]).

=== You say that BL-5C is compatible with my gta02. Does that mean i can use that BL-5C-compatible bat i bought for a buck from a bum? ===

You bet, go ahead.

== Charging ==

=== My battery charges to 100% but then charging stops and the battery keeps discharging, wtf? ===

LiIon batteries don't like to be kept fully charged, so the charger
stops as soon as charging current becomes less than threshold. If you
have GSM on it will discharge the battery.

=== But why doesn't it ever stop charging on my device? ===

The GSM modem is connected directly to the battery terminals so if
it's active, charger will think it's still charging the battery and
won't turn off unless GSM becomes inactive. The default threshold setting of PMU charger is
about 16mA, the latest [[Qi]] increases the threshold to ~32mA.

Depending on various factors (GPRS activated, number of cells to observe, band...) the modem may consume an average standby current of 4mA up to >30mA while registered to a network. For normal (AT%SLEEP=2) situation the standby current is ~15mA. So *usually* the charge end detection should work.

Anyway even if the above mentioned charge end threshold never is reached, the PMU stops charging of bat after expire of some emergency cutoff timer (some hours)

=== Does it mean if i leave my phone plugged it will eventually fully discharge the battery? ===

On gta02 the charger will restart the charge automatically once the
battery voltage reaches ~4V which corresponds to ~76% (If PMU MBC is configured by kernel to enable auto-resume). Not sure about
gta01, requires more investigation. :-/

=== Ok, how to make sure my battery is fully charged before a long trip? ===

Replug the charger at least 90 minutes before you need full battery, it will trigger charging no matter what the
current capacity is.

=== My power/aux LED indicates charging/discharging/whatever, what does that mean (aka why it's still blue even after i unplugged the charger)? ===

Ask FSO guys about it, some of them think that the user shouldn't
really know what's happening and therefore they do some special
mangling of "status" sysfs node before presenting it to the user. If
you want to make a decent bugreport please add clear steps to
reproduce and
<code>
cat /sys/class/power_supply/battery/uevent
cat /sys/class/i2c-adapter/i2c-0/0-0073/gta01_battery/uevent
</code>
contents for all
relevant states.

== Using compatible batteries with gta02 ==

=== So, how do i use "dumb" batteries with my freerunner? ===

First you need to unbind bq27000 driver:
echo bq27000-battery.0 > /sys/bus/platform/drivers/bq27000-battery/unbind

Then you load the dumb battery driver:
modprobe gta01_battery
Since kernel 2.6.34 the module is called platform-battery

If you need to use bq27000 driver again, do:
rmmod gta01_battery
echo bq27000-battery.0 > /sys/bus/platform/drivers/bq27000-battery/bind

If you use Enlightment you might need to restart it after that.

=== Is capacity reported for dumb batteries accurate? ===

During discharge it should be pretty (+-10%) accurate, during
charge the capacity reported is ~20% more than real.

=== Why does /sys/class/power_supply/battery/charge_full says i have a 850 mAh battery no matter what i use? ===

It's a workaround to make popular battery gadgets work with this
driver.

== This Q&A were prepared by ==

[[User:PaulFertser|Paul Fertser]]

[[User:jOERG|Joerg Reisenweber]]

[[Category:Battery]]
[[Category:Neo_FreeRunner_Hardware]]
[[Category:Neo1973_Hardware]]

Battery Questions and Answers

2011-12-26T12:17:39Z

JOERG: /* Special features */ coloumb -> coulomb + wikipedia link

NB: Some of the described behaviour depends on the kernel, the
relevant code was pushed on 2009-08-02 to andy-tracking. Some older kernel versions may have quite nasty hacks ('reenabling MBC though battery reports full') that seriously wreck your battery within months.

== Battery care and safety guidelines ==

=== How can I break my battery? ===
To successfully kill your LiIon battery without applying brute force, you simply may disobey any of the following advices:

==== Temperature ====
Never expose or let warm up battery to high temperatures. 70°C might be a limit for safe operation, and >100°C most likely is a killer for the cell. This is especially true during charge/discharge.

==== Drop ====
Never let the battery drop on a hard surface or by any other means expose to hard impact.

==== Wrong storage ====
LiIon cells don't like to be kept at any extreme for a prolonged time. So *never* store away your device with battery inserted, for a period longer than a few days. Charge battery to a reasonable level prior to extended periods of no usage.
Do not store battery in charger, as this may cause a permanent charging level of 100% which is as deteriorating to the LiIon cell chemistry as is storage at 0%. Keeping battery in Neo which is powered by external source is safe though, even for months, as the Neo's PMU charger circuit takes care to treat the battery nicely.

Also see [http://wiki.openmoko.org/wiki/Battery_Questions_and_Answers#I_have_several_compatible_batteries._What_are_the_storage_requirements_for_them.3F Storage]

== Hardware capabilities ==

=== What batteries can be used with gta01 and gta02? ===
Original OM gta01, [[Neo FreeRunner Battery|gta02]], Nokia [http://europe.nokia.com/find-products/accessories/all-accessories/power/batteries/nokia-battery-bl-5c BL-5C], [http://europe.nokia.com/find-products/accessories/all-accessories/power/batteries/nokia-battery-bl-6c BL-6C] and compatibles.

=== Do other BL-5/6C compatible batteries fit? ===
If the battery is thicker than BL-6C, you won't be able to close
the back cover. Nokia's BL-4C is a bit thinner than the BL-5C so it also fits, but has noticeably shorter battery life.

=== What is the difference between all those types? ===

==== Capacity ====
{|border="1" cellspacing="0" cellpadding="5"
| gta01, gta02 || 1200 mAh
|-
| BL-4C old (new) || 720 (860) mAh
|-
| BL-5C old (newer/new) || 850 (970/1020) mAh
|-
| BL-6C || 1150 mAh
|}

==== Temperature control ====
{|border="1" cellspacing="0" cellpadding="5"
| gta01, BL-5C, BL-6C || thermistor
|-
| gta02 || bq27000
|}

==== Special features ====

gta02 - accurate and sophisticated reporting of capacity,
time_to_full, time_to_empty, temperature and battery current during
both charge and discharge thanks to bq27000 (aka [http://de.wikipedia.org/wiki/Coulomb Coulomb] Counter). More details at [[Neo FreeRunner Battery]].

=== What are hardware capabilities of gta01 and gta02 with regard to battery management? ===

gta01: charging all battery types, measuring temperature with
battery-integrated thermistor (currently charging and measuring
temperature for non-gta01 batteries doesn't work due to the kernel
driver issues but it's software limitation), measuring battery output
voltage, very inaccurate and noisy measuring of battery current

gta02: charging all battery types, measuring battery output voltage,
communicating with bq27000

=== Can nokia phones use/charge gta01/gta02 batteries? ===

gta01 and gta02 batteries will fit wherever BL-6C fits but they
can't be charged in nokia phones unless you isolate the middle pin
from the battery and connect a resistor of ~50k (actual measured value
on a cold (25C) battery is 75k, on a slightly warm battery - 82k) from
it to the ground (to fake a thermistor presence).

=== Can third-party chargers charge gta01/gta02 batteries? ===

The "good" ones will most probably require the same trick needed
for nokia phones. More cheaper ones are more likely to ignore
thermistor absence.

=== I have several compatible batteries. What are the storage requirements for them? ===

Keep in a dry cool place charged to no more than 75%.

=== That bq27000 chip seems to be pretty cool, how can i read and understand its raw registers? ===

[[User:jOERG|DocScrutinizer]] to the rescue! Here's his magic script to do that: [http://people.openmoko.org/joerg/battery/bq27k-detail].

== Safety considerations in detail ==

=== Do OM devices control temperature to stop charging if the battery gets too hot? ===

GTA02 Neo FreeRunner:No; GTA01 Neo 1973:Yes (if PMU PCF50606 Main battery charger is configured correctly)

=== Isn't it dangerous? ===

No, since all batteries (not raw cells!) have an integrated
protection circuits.

=== Can i use that fancy 2800 mAh BL-5C-compatible battery i saw on ebay? ===

Unless you want an explosion in your pocket i wouldn't recommend
using any battery that is not produced by a reputable vendor and
widely tested. And even reputable vendors make mistakes, nokia once
had to recall 46 million batteries manufactured by Matsushita ([http://batteryreplacement.nokia.com/batteryreplacement/en/advisory-2007.html]).

=== You say that BL-5C is compatible with my gta02. Does that mean i can use that BL-5C-compatible bat i bought for a buck from a bum? ===

You bet, go ahead.

== Charging ==

=== My battery charges to 100% but then charging stops and the battery keeps discharging, wtf? ===

LiIon batteries don't like to be kept fully charged, so the charger
stops as soon as charging current becomes less than threshold. If you
have GSM on it will discharge the battery.

=== But why doesn't it ever stop charging on my device? ===

The GSM modem is connected directly to the battery terminals so if
it's active, charger will think it's still charging the battery and
won't turn off unless GSM becomes inactive. The default threshold setting of PMU charger is
about 16mA, the latest [[Qi]] increases the threshold to ~32mA.

Depending on various factors (GPRS activated, number of cells to observe, band...) the modem may consume an average standby current of 4mA up to >30mA while registered to a network. For normal (AT%SLEEP=2) situation the standby current is ~15mA. So *usually* the charge end detection should work.

Anyway even if the above mentioned charge end threshold never is reached, the PMU stops charging of bat after expire of some emergency cutoff timer (some hours)

=== Does it mean if i leave my phone plugged it will eventually fully discharge the battery? ===

On gta02 the charger will restart the charge automatically once the
battery voltage reaches ~4V which corresponds to ~76% (If PMU MBC is configured by kernel to enable auto-resume). Not sure about
gta01, requires more investigation. :-/

=== Ok, how to make sure my battery is fully charged before a long trip? ===

Replug the charger at least 90 minutes before you need full battery, it will trigger charging no matter what the
current capacity is.

=== My power/aux LED indicates charging/discharging/whatever, what does that mean (aka why it's still blue even after i unplugged the charger)? ===

Ask FSO guys about it, some of them think that the user shouldn't
really know what's happening and therefore they do some special
mangling of "status" sysfs node before presenting it to the user. If
you want to make a decent bugreport please add clear steps to
reproduce and
<code>
cat /sys/class/power_supply/battery/uevent
cat /sys/class/i2c-adapter/i2c-0/0-0073/gta01_battery/uevent
</code>
contents for all
relevant states.

== Using compatible batteries with gta02 ==

=== So, how do i use "dumb" batteries with my freerunner? ===

First you need to unbind bq27000 driver:
echo bq27000-battery.0 > /sys/bus/platform/drivers/bq27000-battery/unbind

Then you load the dumb battery driver:
modprobe gta01_battery
Since kernel 2.6.34 the module is called platform-battery

If you need to use bq27000 driver again, do:
rmmod gta01_battery
echo bq27000-battery.0 > /sys/bus/platform/drivers/bq27000-battery/bind

If you use Enlightment you might need to restart it after that.

=== Is capacity reported for dumb batteries accurate? ===

During discharge it should be pretty (+-10%) accurate, during
charge the capacity reported is ~20% more than real.

=== Why does /sys/class/power_supply/battery/charge_full says i have a 850 mAh battery no matter what i use? ===

It's a workaround to make popular battery gadgets work with this
driver.

== This Q&A were prepared by ==

[[User:PaulFertser|Paul Fertser]]

[[User:jOERG|Joerg Reisenweber]]

[[Category:Battery]]
[[Category:Neo_FreeRunner_Hardware]]
[[Category:Neo1973_Hardware]]

FileSystem microSD cards

2011-04-14T17:07:58Z

JOERG: typofix

[[Category:MicroSD]]

{{Languages|FileSystem microSD cards}}

{|align=left
|__TOC__
|}

= Which file system to use =

I got a new SD card. Which file system is the best?

Short answer: ext3. Other options: ext2, vfat. Don't use wear-aware file systems like jffs2 and ubifs.

= Why ext3 =

Long answer:
In principle you can use any file system (fs) that is supported by the kernel in your Openmoko, commonly FAT, ext2, and ext3. reiserfs is currently not available in the standard OM kernel. What sets ext3 apart from FAT and ext2 is the journaling (also in reiserfs).

The journal is an extra data structure used to make sure that the file system is always in a consistent state. Typically, if a crash happens in the system, the file system might get corrupted and even become unusable. In simple terms, the fs first saves all the data needed to perform the operation in the journal and only then starts updating the file system. If something goes wrong, the fs can rely on the journal to safely repeat the operation and repair the file system. Without a journal, the operation will certainly be lost and it might not even be possible to fix the file system.

If you check the community list (see note 1 below), you'll see people vouching both for fat and ext2 but also others experiencing corruption and annoyed with both file systems. Even though ext3 is not error-proof, since it does not do a verification of what is written in the disk, ext3 remains as the choice to minimise corruption.

There are three disadvantages with the journaled file system:
# lower performance at write time, since there is the extra work of the journal
# increased chance of damaging the SD card due to extra use of the journal causing wearing
# increased space usage (for the journal)

Regarding performance, if you are using the SD mostly for static storage like maps or music files, it should not be a big problem. After the initial storage phase, the reads won't be delayed by the journal. Have also a look at [http://www.debian-administration.org/articles/388 this benchmark] between several Linux file systems.

Regarding the extra wearing, the number of write accesses before wearing seem to be sufficiently high not to have to bother with it, and the SD card in itself has automatic wearing leveling which will ensure that the journal will be written in another place after some time. All in all, sd card damage due to the journal should not be a practical issue.

FAT might already be the fs in your card when you got a new one. It has the advantage of being recognised in many other systems. The data structures are simpler which might mean less writes on the sd-card and less code being executed (unverified) and you'll find more tools available to recover information when you get errors.

It is also important to note that ext is faster than FAT (benchmark, anyone?) but, most importantly, it supports owner/group concept and permissions, which FAT doesn't. Of course, since FR is in general a single user device, the permissions might be not so important. Another advantage of ext2/3 is support for hard/soft links, which is typically useful to avoid redundant copies of files. For instance, if you are storing maps and you have blank tiles files, you can keep a single blank file and have all the others be just a link to this one (you would need a script for that to make it practical)

== Create an ext3 partition ==
# put new purchased device in laptop or desktop
# see which device it is via: mount (usually look for /media/disk) or look out for it in sudo fdisk -l
# run: sudo fdisk /dev/xyz
# create new partition table with 'n' (all default will result in Linux, type 83), save and exit with 'w'
# unmount device: sudo umount /dev/xyz
# create new ext3 file system: sudo mkfs.ext3 /dev/xyz
# disable automated file system checks: sudo tune2fs -c 0 -i 0 /dev/xyz
# mount the device: mount/dev/xyz or simply eject and re-insert it
# optionally set some permissions: sudo chown username:username and sudo chmod ug+rw .

= Why not jffs2 or ubifs =

What about file systems like [[jffs2]] and [[ubifs]], which are aware of flash card wearing?

SD cards, according to SanDisk specs, should have wear leveling logic, which controls the number of writes and remaps blocks as needed. Wear-aware file systems might actually play against the logic of the card and are usually not recommendable.

= Notes =

Note 1: this page is mostly based on feedback from the Openmoko community list: see [http://lists.openmoko.org/pipermail/community/2009-January/040521.html here] and [http://lists.openmoko.org/pipermail/community/2009-February/041072.html here].

Note 2: file systems are quite complex components of an operating system, each one with different weak and strong points, which makes it difficult to give a definitive answer to tell which file system is the best. As you can see from the mailing list posts, you'll find people vouching for any of these three options. Furthermore, although the mentioned are well-known, there are actually not yet benchmarks specific to the Openmoko architecture in combination with microSD cards, of which there are many models around.

Flashing the GSM Firmware

2010-08-04T18:36:57Z

JOERG: /* µSD-card Image (GTA02 only) */

{{Languages|GSM/Flashing}}

----
'''This is NOT a community driven page, please be reluctant and careful with edits. Refer to discussion and history tabs.
'''
----

== Introduction ==
To see the version of your GSM firmware, run the following command on a FSO-based distribution like OM2009, SHR, Debian..
mdbus -s org.freesmartphone.ogsmd /org/freesmartphone/GSM/Device org.freesmartphone.GSM.Device.GetInfo
It'll result something like this. Check the end of the revision line to see the version.
{ 'imei': '3546598764672894',
'manufacturer': 'FIC/OpenMoko',
'model': '"Neo1973 GTA01/GTA02 Embedded GSM Modem"',
'revision': '"GSM: gsm_ac_gp_fd_pu_em_cph_ds_vc_cal35_ri_36_amd8_ts0-Moko11"'}

'''All users are recommended to update to a new GSM firmware version. All GTA02 users are recommended to use the easy [[GSM/Flashing#µSD-card_Image_.28GTA02_only.29|µSD method]]

Some distributions like shr don't use mdbus but mdbus2. This command returns the same information, but formated in a different way.

* see http://people.openmoko.org/joerg/calypso_moko_FW for more recent FW-images.
* see http://people.openmoko.org/joerg/calypso_moko_FW/all_version__CHANGELOG.txt
* see http://lists.openmoko.org/pipermail/devel/2008-November/003150.html for more information

== Moko11 ==
Moko11 should fix [http://docs.openmoko.org/trac/ticket/666 #666] (compatibility with some 3G sim cards), and also has a new command AT+CSIM. It also includes fixes related to hardware flow control and wakeup interrupt [http://docs.openmoko.org/trac/ticket//2231 #2231].

This version is not supposed to fix [http://docs.openmoko.org/trac/ticket/1024 #1024] (constant re-registrations leading to lost calls and messages). For a workaround use a distro where deep sleep mode can be deactivated.

GTA02 users are suggested to update using [[GSM/Flashing#µSD-card_Image_.28GTA02_only.29|µSD method]].

The GSM-firmware didn't differ from GTA01 to GTA02, as the GSM-hardware didn't either. This means you can flash MOKO11 (or any other recent GSM-FW) to GTA01 as well but only using the [[GSM/Flashing#Manual_Update_.28GTA01.2C_GTA02.29_.2F_geek_way|manual way]] instructed below.

'''Warning: there are chances to _irrecoverably_ damage your GSM modem calibration data, thus rendering it useless on messing around with FLUID! Use only the commands from this wiki page! Never downgrade to a version earlier than Moko6, or you will render the GSM unusable (certain internal data structures changed between Moko5 and Moko6).'''

Any reports on successful update, as well as problems encountered, or SIMs seen to work after update, all highly appreciated. Please add to the "discussion" tab of this wikipage. Thanks!

== µSD-card Image (GTA02 only) ==
'''We recommend to update all devices by using this µSD-image for flashing MOKO11 to GTA02 Freerunner only (not suitable for GTA01 Neo1973).'''

NOTE: there are reports the uSD has to be <4GB. See talk page of this wiki page.

This works by starting the FreeRunner from a system installed on the µSD, which will automatically apply all needed instructions to flash the GSM firmware to the chip. The µSD image will have to be written on a µSD, 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 µSD-card, *not* any partition (e.g. foo0p1). Also make sure there are *no* mounted partitions left on the µSD 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.''

<ol>
<li>Download and <tt>untar</tt> http://people.openmoko.org/joerg/calypso_moko_FW/moko11/flash-moko11_uSD-image.tar.gz on your desktop computer. Read the <tt>README.txt</tt> file that came with the tarball.</li>

<li>Insert a µSD to your computer's reader, and unmount all µSD-partitions that might have been automounted (use <tt>mount</tt> or <tt>df -h</tt> to check). Do not use "safely remove" for this.</li>

<li>Use <tt>dd</tt> to write the image <tt>flash-moko11-2.image</tt> to the '''physical'''(!) µSD-device (this will erase all data from your µSD, 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 µSD''). Log in as root or use sudo to get root privileges needed to write to the µSD card. For example:</li>

% sudo dd if=flash-moko11-2.image of=/dev/mmcblk0

<li>Execute <tt>sync</tt> or <tt>eject <device></tt> to make sure everything is flushed to the µSD before physically removing it from the reader.</li>

<li>Insert the µSD to your FreeRunner, boot from '''[[Booting_the_Neo_FreeRunner#Log_into_U-Boot_in_the_NOR_Flash|NOR-U-Boot]]''' and select the "Boot from microSD" option.</li>

<li>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 µSD or login via ssh and use <tt>mickeyterm</tt> 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:</li>

# shutdown -h now
</ol>

=== NOTE ===
If you don't have a µSD reader on your PC, you can <tt>dd</tt> from the Neo: install <tt>task-base-smbfs</tt>, u(n)mount <tt>/media/card</tt>, mount the directory in which you have the <tt>flash-moko11-2.image</tt> file and do the <tt>dd</tt> 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 µSD. 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 [[OpenmokoFramework/mickeyterm|mickeyterm]] (cmd: "AT+CGMR"). In SHR-Settings, Phone/Modem Information will supply the same number.

== Manual Update (GTA01, GTA02) / geek way ==
We recommend you don't update by following this procedure, unless you feel very comfortable with commandline. Don't miss-spell any FLUID command!

According to mwester, this worked for him to update from MOKO1 on a GTA01Bv4 to MOKO10b2, by following the steps described herein (if the main firmware can't be started, see troubleshooting section for additional instructions).

=== Phase 1: Preparations ===
* Download and install a distribution to your device that gives you SSH access. We recommend the fso-console image:
<pre>
mickey@amethyst$ cd /tmp
mickey@amethyst$ wget http://people.openmoko.org/mickey/images/openmoko-fso-console-image-glibc-ipk--20081028-om-gta02.rootfs.jffs2.summary
mickey@amethyst$ dfu-util -a rootfs -R -D ./openmoko-fso-console-image-glibc-ipk--20081028-om-gta02.rootfs.jffs2.summary
mickey@amethyst$ wget http://people.openmoko.org/mickey/images/uImage-2.6.24+r10+gitr75999+54524f4531c8b262431b794fea610d81bb351c86-r10-om-gta02.bin
mickey@amethyst$ dfu-util -a kernel -R -D ./uImage-2.6.24+r10+gitr75999+54524f4531c8b262431b794fea610d81bb351c86-r10-om-gta02.bin
</pre>
* Install http://people.openmoko.org/joerg/calypso_moko_FW/fluid_0.0+svn20070817-r2_armv4t_eabi.ipk on your device:
<pre>
root@om-gta02:~# opkg install http://people.openmoko.org/joerg/calypso_moko_FW/fluid_0.0+svn20070817-r2_armv4t_eabi.ipk
</pre>
* Install http://people.openmoko.org/joerg/calypso_moko_FW/s3c24xx-gpio_1.0+svnr4130-r2.1_armv4t.ipk on your device:
<pre>
root@om-gta02:~# opkg install http://people.openmoko.org/joerg/calypso_moko_FW/s3c24xx-gpio_1.0+svnr4130-r2.1_armv4t.ipk
</pre>
* Download
http://people.openmoko.org/joerg/calypso_moko_FW/moko11/calypso-moko11.m0
and place it into the /home/root directory:
<pre>
root@om-gta02:~# cd $HOME
root@om-gta02:~# wget http://people.openmoko.org/joerg/calypso_moko_FW/moko11/calypso-moko11.m0
</pre>

=== Phase 2: The Lobotomy ===
* Make sure '''nothing''' is accessing the GSM modem. If you're using the fso-console image from the link above, this will happen automagically on boot. On other systems, kill processes as you see fit (for FSO it's zhone, frameworkd and gsm0710muxd; for SHR it's ophonekitd, frameworkd and gsm0710muxd -Also note in 2009 that newer version of these distros could have replaced gsm0710muxd by fso-abyss, and then on fso2, ophonekitd is replaced by phonefsod and phoneuid). If you're using a stable (or andy-tracking) kernel from Feb 26 or later on GTA02, see below for simplified instructions on powering the modem on/off (if you use the simplified method to turn it off, you must also use the simplified method to turn it on; no s3c24xx-gpio invocations are needed).

* Power off the modem:
<pre>
root@om-gta02:~# echo 0 >/sys/bus/platform/devices/neo1973-pm-gsm.0/power_on
root@om-gta02:~# echo 1 >/sys/bus/platform/devices/neo1973-pm-gsm.0/power_on
root@om-gta02:~# s3c24xx-gpio b7=0
root@om-gta02:~# stty 0:4:18b2:8a00:0:0:7f:15:4:0:0:0:0:0:0:0:12:f:17:16:0:0:0:0:0:0:0:0:0:0:0:0:0:0:0:0 -F /dev/ttySAC0
root@om-gta02:~# stty 0:4:18b2:8a00:0:0:7f:15:4:0:0:0:0:0:0:0:12:f:17:16:0:0:0:0:0:0:0:0:0:0:0:0:0:0:0:0 -F /dev/ttySAC0
root@om-gta02:~# echo -en "AT@POFF\r" >/dev/ttySAC0; sleep 1; echo -en "AT@POFF\r" >/dev/ttySAC0
</pre>

* Launch the FLUID binary:
<pre>
root@om-gta02:~# cd /usr/sbin
root@om-gta02:/usr/sbin# FLUID_PORT=/dev/ttySAC0 fluid.exe \
-oo -od13,13 -b 115200 \
-f $HOME/calypso-moko11.m0
</pre>
It should say something like this (takes a few seconds to load the file):
<pre>
FLUID Revision 2.27, ...
Bootloader: (reset target)
</pre>
(this fluid command works even if the previous flashing was aborted and you have a broken and non-functional gsm-firmware due to this, as it uses the calypso ROM bootloader instead of the firmware bootloader. But in the case of non-functional gsm-firmware there's no way to power off the modem with AT@POFF command, therefore GTA02 users need to follow "modern kernel" (they might work even with older kernels) instructions and GTA01 users the troubleshooting section. Changing the -b to some lower baudrate might improve stability of flashing-process - the bootloader does autobaud, so you're free to use any rate)

* Start a second SSH session and start the modem:
<pre>
root@om-gta02:~# s3c24xx-gpio b7=1
</pre>

FLUID should now say something like this (it will take a couple of minutes to finish):

<pre>
(fluid, version 3) ok
Checksumming (269 * 8kB = 2152kB): ok
Flash Detect: (0xEC, 0x22A0) Samsung K5A3240CT ok
Program: (34 sectors, 267*8k=2136k) (*******************) ok
</pre>

Congratulations, the update was successful!

'''Note: If you get this instead: MESSAGE: File cmd.m0 not found, then you didn't do the ''cd /usr/sbin''. Please pay attention ;-)'''

If FLUID does nothing, curse your bad luck and repeat the reset sequence, this is the whole 'echo 0/1, b7=0/1 stuff'.

* To verify that everything went well, do this in either of the two sessions (this doesn't always work but you can be sure that if fluid didn't report any errors, everything went well; you can check AT+CGMR output later with mickeyterm):
<pre>
root@om-gta02:~# stty crtscts -F /dev/ttySAC0
root@om-gta02:~# cat /dev/ttySAC0 &
root@om-gta02:~# echo -en 'AT\r' >/dev/ttySAC0; sleep 1; echo -en 'AT+CGMR\r' >/dev/ttySAC0
+CGMR: "GSM: gsm_ac_gp_fd_pu_em_cph_ds_vc_cal35_ri_36_amd8_ts0-Moko11"
...
root@om-gta02:~# kill %1
</pre>

==== Hints ====
In some case you may receive this:

<pre>
(fluid, version 3) ok
Checksumming (269 * 8kB = 2152kB): ok
Flash Detect: (0xEC, 0x22A0) Samsung K5A3240CT ok
Program: (0 sectors, 0*8k=0k) () ok
</pre>

It means the checksums of all sectors in calypso's FW and the new file to flash are identical. Probably you're trying to flash same version of FW that's already installed.

With modern kernels on GTA02 you can use this single command to "Power off the modem":
<pre>
echo 0 >/sys/bus/platform/devices/neo1973-pm-gsm.0/power_on
</pre>

Now you can start fluid as described above.

To "start the modem" you need to issue:
<pre>
echo 1 >/sys/bus/platform/devices/neo1973-pm-gsm.0/power_on
</pre>

----

=== Troubleshooting ===
Some users weren't able to complete the upgrade since they got an error while the firmware was uploading in the GSM chip (like ''Flash operation timeout'').

However a solution [http://n2.nabble.com/problems-with-calypso-firmware-update-tp1565196p1566012.html has been found] and it allows to use again the GSM modem.
(please note this topic resides on [http://lists.openmoko.org/pipermail/devel/2008-November/003150.html devel-ML]. Don't spread over multiple lists please, as it won't help in getting a response to your request just in time, and most people following the main thread likely will miss your postings anyway)

Use the following fluid command:

<pre>
cd /usr/sbin
FLUID_PORT=/dev/ttySAC0 fluid.exe -oo -od13,13 -b 115200 -f $HOME/calypso-moko11.m0
</pre>
(Without FLOWCONTROL and with -oo to choose the ROM bootloader)

Then on a ''second ssh session'' please use this instead of the gpio command:
<pre>
echo 0 > /sys/bus/platform/devices/neo1973-pm-gsm.0/power_on
echo 1 > /sys/bus/platform/devices/neo1973-pm-gsm.0/power_on
</pre>
The firmware download should start now.

=== Half-flashed GTA01bv4 GSM Modem ===

For GTA01 the process of flashing when the main firmware is absent is more complicated as we have no easy way to power-cycle the modem.

I recently had to do a special process to recover my GTA01bv4 after breaking the gsm modem with a failed flash. The process is actually fairly simple.

* Unplug USB and remove the battery for about 10s to ensure that the GSM chipset is powered off, then replace the battery and re-connect the USB
* boot up from a distro that is neutered so that it does not access or turn on the gsm modem at all (this is a really important prerequisitive, as nothing should turn on the modem by touching MODEM_ON line until fluid is ready to connect to it); one can do that simply by disabling start of ophonekitd (and to be on the safe side framworkd too) on SHR
* issue this stty command twice:
stty 0:4:18b2:8a00:0:0:7f:15:4:0:0:0:0:0:0:0:12:f:17:16:0:0:0:0:0:0:0:0:0:0:0:0:0:0:0:0 -F /dev/ttySAC0
* cd /usr/sbin
* issue this fluid command (replace $HOME/filename.m0 with path to firmware you want to flash):
FLUID_PORT=/dev/ttySAC0 fluid.exe -oo -od13,13 -b115200 -f $HOME/filename.m0
* in another ssh session, issue this command:
echo 1 > /sys/bus/platform/devices/neo1973-pm-gsm.0/power_on

After this, the flashing proceeded as expected. You don't need to do any special checks to ensure you have successfully flashed; if fluid reports everything is ok, it is actually ok.

[[Category:GSM]]
[[Category:GSM]]

Talk:Neo Freerunner audio subsystem

2010-03-19T17:03:53Z

JOERG: /* Empirical Data for Mic Settings */

[[User:RuiSeabra]] said:

#* State: GSM <-> Built-in Handset (file gsmhandset.state)
##* Mic volume:
...
##* Control 63: 'Mic Sidetone Mux' MANDATORY VALUE "Mic 2"!!!
###* [[User:RuiSeabra]]'s GTA02v5 with buzz fix has horrible static with this value, but using either "Left PGA" or "Right PGA" works very well.

That's very interesting, but - as elaborated to Rui in IRC - doesn't mean much as buzz isn't related to using PGA. Rather using PGA "detunes" the overall setup of mic path, by introducing several new parameters (PGA controls in digital domain of mixer), which Rui hasn't looked at, taken into account, or even finally listed all the relevant settings' values here. Furthermore there's nothing (except AGC, which is considered contraproductive for calypso's NR&AEC, and very unlikely Rui had a working setup for AGC by mere incident) you could implement by using a routing via PGA, rather than just adjusting #5 (#48, #12. In that precedence) to compensate for pathgain changes done by PGA.

Finally buzz is basically completely unrelated to PGA (if not any mixer volume settings) at all

2009-12-01 [[User:JOERG|jOERG--Openmoko HW development and synergy]]

== it's not buzz fix, is being clearly heard on the other side ==

This is not buzz related (my phone has the buzz fix).

# With Mic2:
## Calling myself from a Nokia phone has loud static, and background noise can easily make it hard for remote end to hear me correctly
# With Left or Right PGA
## Calling myself from a Nokia phone has almos no static at all, and background noise is dampened enough so that even at a noisy restaurant the remote end could hear me about as normally as with any other phone

With no electricity or sound engineering background, I can't explain this other than in these terms:

# Mic2 == awfull sound on remote end
# Left|Right PGA == normal sound on remote end

There may be better solutions, but while they are not found, can we at least provide a working sound setting?

== You're 'fixing' clipping in the mono mixer ==

The loud static is the result of an overloaded amp stage somewhere in the chain. Routing through the PGA will reduce the signal slightly, reducing the distortion or removing it. The problem is probably occurring in the mono mixer as the default setting (7) has +6dB gain. Reducing it to 5 should help as it will then have no gain.

== Empirical Data for Mic Settings ==

Wouldn't it be better to insert previous settings into the table, instead of just saying "it's better now"? --[[User:Fabian Schölzel|Fabian Schölzel]] 16:55, 17 March 2010 (UTC)
: Never mind, thats what "Microphone Settings in Use" is for. --[[User:Fabian Schölzel|Fabian Schölzel]] 16:58, 17 March 2010 (UTC)

I'm so tired to read reports following the scheme "Car's motor didn't start. After fiddling with almost any of the 90 adjustment dials in carburator and ignition and 7 other domains, I finaly found it started when I used a grip to turn the key". Two days later we have to deal with user B, C and D wining "I tried the 'turn key' method. Doesn't work for my car :-(( (even took a hammer to adjust some random dials)". And probably 2 app devels nagging kernel devels about "I implemented proven good turn-key sound improvement method. User said fails for him. FIX THAT!"

Once again: left/right PGA *might* work (as well), but it's introducing 10 unknown variables to the whole process, which are set "correctly" by mere incidence *if* it works for you, and there's absolutely NOTHING that couldn't be done _the right way_ as well, rather than by random switching of dials

*SIGH*
2010-03-19 17:49 jOERG

Talk:Neo Freerunner audio subsystem

2010-03-19T16:58:04Z

JOERG: /* Empirical Data for Mic Settings */

[[User:RuiSeabra]] said:

#* State: GSM <-> Built-in Handset (file gsmhandset.state)
##* Mic volume:
...
##* Control 63: 'Mic Sidetone Mux' MANDATORY VALUE "Mic 2"!!!
###* [[User:RuiSeabra]]'s GTA02v5 with buzz fix has horrible static with this value, but using either "Left PGA" or "Right PGA" works very well.

That's very interesting, but - as elaborated to Rui in IRC - doesn't mean much as buzz isn't related to using PGA. Rather using PGA "detunes" the overall setup of mic path, by introducing several new parameters (PGA controls in digital domain of mixer), which Rui hasn't looked at, taken into account, or even finally listed all the relevant settings' values here. Furthermore there's nothing (except AGC, which is considered contraproductive for calypso's NR&AEC, and very unlikely Rui had a working setup for AGC by mere incident) you could implement by using a routing via PGA, rather than just adjusting #5 (#48, #12. In that precedence) to compensate for pathgain changes done by PGA.

Finally buzz is basically completely unrelated to PGA (if not any mixer volume settings) at all

2009-12-01 [[User:JOERG|jOERG--Openmoko HW development and synergy]]

== it's not buzz fix, is being clearly heard on the other side ==

This is not buzz related (my phone has the buzz fix).

# With Mic2:
## Calling myself from a Nokia phone has loud static, and background noise can easily make it hard for remote end to hear me correctly
# With Left or Right PGA
## Calling myself from a Nokia phone has almos no static at all, and background noise is dampened enough so that even at a noisy restaurant the remote end could hear me about as normally as with any other phone

With no electricity or sound engineering background, I can't explain this other than in these terms:

# Mic2 == awfull sound on remote end
# Left|Right PGA == normal sound on remote end

There may be better solutions, but while they are not found, can we at least provide a working sound setting?

== You're 'fixing' clipping in the mono mixer ==

The loud static is the result of an overloaded amp stage somewhere in the chain. Routing through the PGA will reduce the signal slightly, reducing the distortion or removing it. The problem is probably occurring in the mono mixer as the default setting (7) has +6dB gain. Reducing it to 5 should help as it will then have no gain.

== Empirical Data for Mic Settings ==

Wouldn't it be better to insert previous settings into the table, instead of just saying "it's better now"? --[[User:Fabian Schölzel|Fabian Schölzel]] 16:55, 17 March 2010 (UTC)
: Never mind, thats what "Microphone Settings in Use" is for. --[[User:Fabian Schölzel|Fabian Schölzel]] 16:58, 17 March 2010 (UTC)

I'm so tired to read reports following the scheme "Car's motor didn't start. After fiddling with almost any of the 90 adjustment dials in carburator and ignition and 7 other domains, I finaly found it started when I used a grip to turn the key". Two days later we have to deal with user B, C and D wining "I tried the 'turn key' method. Doesn't work for my car :-(( (even took a hammer to adjust some random dials)". And probably 2 app devels nagging kernel devels about "I implemented proven good turn-key sound improvement method. User said fails for him. FIX THAT!"

Once again: left/right PGA *might* work (as well), but it's introducing 10 unknown variables to the whole process, and there's absolutely NOTHING that couldn't be done _the right way_ as well, rather than by random switching of dials

*SIGH*
2010-03-19 17:49 jOERG

Neo Freerunner audio subsystem

2010-03-19T16:28:16Z

JOERG: /* Empirical Data for Mic Settings */ rant

The Neo Freerunner (GTA02) inherited the audio subsystem from its older brother the Neo 1973 (GTA01). However, there are a few small differences.
This page tries to show and explain the differences and points you to the [[Neo_1973_audio_subsystem | Neo 1973]] page whenever it touches the common points (but there may be overlaps for the sake of usability). As wiki pages are, errors and omissions are likely, and your help is welcomed.

==Differences from Neo 1973==
* There is only 1 (mono) built-in loud speaker (connected to LOUT1) instead of 2 (stereo).
* The Wolfson Codec driver presents 94 separate controls {switches, multiplexers, and volumes} to the alsa system (in both Neos). Unfortunately they are not mapped exactly the same for the GTA01 as for the GTA02.

==Possible sound connections through the Wolfson Codec==
* "Yes" = Confirmed, alsa state file exists.
* "No" = Not possible / not desirable.
* "Should" = Should be possible, not confirmed yet.
* "?" = Have no idea.

{| cellspacing="0" cellpadding="5" border="1"

|- align="center"
! - !! CPU !! GSM !! Bluetooth

|- align="center"
! GSM
| Yes

|- align="center"
! Bluetooth
| via BT-USB || Yes

|- align="center"
! Wired Speaker
| Yes || Yes || via CPU

|- align="center"
! Wired Mic
| Yes || Yes || via CPU

|- align="center"
! Body Earpiece
| Should || Yes || should (via CPU)

|- align="center"
! Body Speaker
| Yes || Yes || should (via CPU)

|- align="center"
! Body Mic
| Yes || Yes || should (via CPU)

|}

==Alsamixer channel controls==
The ALSA state files are installed by default, and belong to package ''"openmoko-alsa-scenarios"''.
To see where the files reside, do ''"opkg files openmoko-alsa-scenarios"''.
Currently ([[SHR]]), they are in ''"/etc/freesmartphone/alsa/default/gsmhandset"''; in other systems, they might be found in ''"/usr/share/openmoko/scenarios/"''.
Recommended statefile for phone usage is http://docs.openmoko.org/trac/attachment/ticket/2121/gsmhandset.state.new

# State: '''''GSM <-> Built-in Handset''''' (file gsmhandset.state)
## Mic volume:
##* Control 48: "Mic2 Capture Volume" (alsamixer name: "Mic2". Suggested value: max [3] - see below)
##* Control 12: "Mono Sidetone Playback Volume" (alsamixer name: "Mono sidetone" Suggested value: 5 [=0dB])
##* Control 5: "Mono Playback Volume" (alsamixer name: "Mono" Value: as needed [80..110]) This is the "user control" for mic
##* Control 63: 'Mic Sidetone Mux' MANDATORY VALUE "Mic 2"!!!
##* General rule is to keep control.12, and ajust control.48 so you have a resonable setting for user control.5 (i.e. NOT <70 or >110)
## Earpiece volume:
##* Control 6: "Bypass Playback Volume"
##* Control 4: "Speaker Playback Volume" This is the user control for earpiece volume

According to the [http://www.mail-archive.com/community@lists.openmoko.org/msg56045.html conclusion] of a [http://www.mail-archive.com/community@lists.openmoko.org/msg56037.html thread] from Dec 09, you might want to set Control 12 to value 5 if people you call complain about background noise, static, etc with the above settings.

For mic settings please refer also to http://wiki.openmoko.org/wiki/Neo_1973_and_Neo_FreeRunner_gsm_modem#AT.25Nxxxx

user should set volume according to own preferences:
for mic the (full, true) procedure is as follows:
reduce #5 by some 15..30 steps
do testcall:
you get very low volume at far end. but tone should be clear, no clipping (sharp agressive noise)
if there is clipping: reduce #48 by one step (i.e. to "2")
then adjust #5 to your preferences and taste
(do `alsactrl store -f gsmhandset.state` to save the changes if you used a mixer to adjust the levels)

for earpiece(-speaker):
level up modem to full volume (AT+CLVL cmd used by framework),
level up #6 to full volume,
adjust by #4
if you get clipping when #4 is at moderate level (same as above): reduce #6 (or even AT+CLVL) until clipping vanishes
(very unlikely to occur for earpiece playback)

# State: '''''GSM <-> Built-in Handsfree''''' (file gsmspeakerout.state)
## Mic volume:
##* Control ?:
## Speaker volume:
##* Control ?:
# State: '''''GSM <-> Wired Headset''''' (file gsmheadset.state)
## Mic volume:
##* Control 49: "Mic1 Capture Volume"
##* Control 12: "Mono Sidetone Playback Volume"
##* Control 5: "Mono Playback Volume"
## Speaker volume:
##* Control 6: "Bypass Playback Volume"
##* Control 3: "Headphone Playback Volume"
# State: '''''GSM <-> Bluetooth Headset''''' (file ???)
## Alternative working state files: [http://handheldshell.com/gsm_headset.txt]
## Mic volume:
##* Control 13: "Mono Voice Playback Volume"
##* Control 5: "Mono Playback Volume"
# State: '''''CPU <-> Built-in Handset''''' (file voip-handset.state)
## Mic volume:
##* Control ?:
## Speaker volume:
##* Control ?:
# State: '''''CPU <-> Wired Headset''''' (file headset.state)
## Stereo sound:
##* Control ?:
## Headset output:
##* Control 94: "Amp Spk Switch" <- false
# State: '''''CPU <-> Buildin Speaker''''' (file stereoout.state)
## Mono sound:
##* Control ?:
## Headset output:
##* Control 94: "Amp Spk Switch" <- true
# State: '''''CPU -> GSM''''' (file gsmhandset.state)
## Mono sound:
##* Control 74: Mono Mixer Left Playback Switch to true
##* Control 75: Mono Mixer Right Playback Switch to true
##* Control 1: PCM Volume suggested value 135

--[[User:Femto|Femto]] 12:39, 24 September 2008 (UTC) I've updated above values. Must be checked.

-- I created another state file (voip-handsfree.state) for CPU Handsfree, mixed and matched voip-handset and stereoout. You can find it [http://wiki.openmoko.org/wiki/User:Savimonty here]. Feel free to make a change to it if there are errors. I don't see any, though.

=== Volume Control ===

Angus Ainslie has written a simple [http://n2.nabble.com/Sound-quality-in-calls.-tp1087522p1096155.html python volume control] (which is getting more and more sophisticated) using some of these settings.

Installing the GUI mixer

<pre>
wget http://handheldshell.com/pymixer.py
wget http://handheldshell.com/volume.desktop
cp pymixer.py /usr/bin
chmod u+x /usr/bin/pymixer.py
cp volume.desktop /usr/share/applications
opkg install python-pygtk
opkg install http://handheldshell.com/python-pyalsaaudio_0.3-ml0_armv4t.ipk
</pre>

If the python script aborts unexpectedly then look [http://lists.openmoko.org/nabble.html#nabble-td1128064 here] for a fix

You could also try [http://www.mazikeen.demon.co.uk/openmoko/fso-simplemixer.py fso-simplemixer.py], a simplified mixer based on the one above.

== Empirical Data for Mic Settings ==

'''"Experiment 1"''' in the table means:
# Set your controls as follows: control.12 (Mono Sidetone Playback Volume): 5 control.48 (Mic2 Capture): 3 control.63 (Mic Sidetone Mux): Mic 2 
# Call another phone from your Neo FreeRunner, mute it's microphone and listen to your voice coming from Neo FreeRunner's microphone. Connect to FreeRunner, run alsamixer and experiment then with control.5 (Mono Playback Volume) by lowering it so that buzzing noise is gone or at an acceptable level. After the noise is reduced, observe the actual volume/clarity of your voice when you speak.
# Write result in the table: "''Positive''" if you don't normally use such settings, but you achieved at least similar level of quality while using these settings, quality meaning lack of noise and clarity/volume of voice. "''Already in use''", if you already normally use settings that have control.12/48/63 like above. Write in notes if you experimented with other settings but found out these were superior, or similar. "''Negative''" if you don't normally use such settings, you experimented, but you failed to achieve similar level of quality with the settings above and experimenting with control.5. Please write in the notes how it failed - most typically did you not hear anymore your voice as well after reducing control.5 enough to get rid of the noise, or how did the experiment turn out negative? "''Not done''", if you didn't complete this experiment.

{| cellspacing="0" cellpadding="5" border="1"
| User || FR Revision + buzzfix? || Microphone Settings in Use (before) || Result of Experiment 1 || Notes
|- align="center"
| [[User:TimoJyrinki]] || A7 || control.5: 97 control.12: 5 control.48: 3 control.63: Mic 2 || Already in use || Able to reach acceptable level of quality with other settings as well, but somewhat less volume can be had with control.63 set to Right PGA before noise starts to be heard (when increasing control.5 and/or control.12 to compensate).
|- align="center"
| [[User:TimoJyrinki]] || A5 + buzzfix || control.5: 105 control.12: 7 control.48: 3 control.63: Mic 2 || Not done || Only checked from a backup, not sure anymore how the audio quality was like. Buzzfix now failing on the device so cannot test. I have used these kind of settings and also earlier control.63 set to Right PGA while increasing control.5.
|- align="center"
| [[User:Pini]] || A5 + buzzfix || control.5: 127 control.12:: 1 control.48: 1 control.63: Mic 2 || In use || Setting successfully tested in a rather noisy environment (train platform)
|- align="center"
| [[User:Neiljerram]] || A6 + buzzfix || control.5: 110 control.12: 7 control.48: 3 control.63: Right PGA || Not done || I've had no complaints at all about audio quality since accidentally discovering the Right PGA setting. It may be voodoo, but it works for me.
Remark jOERG: Great! :-S So *what* exactly should we learn from that? (since I use that new teaspoon to dosage my spices, my meals really are better. Wasn't my explanation clear enough about PGA involving another roundabout 10 controls that have massive impact on your results? Without quoting those, this report is absolutely useless :-/ And it even fails to compare this deprecated PGA routing to the suggested correct one. Really not helpful)
|- align="center"
| [[User:YourName]] || A1 + buzzfix || control.5: NN control.12:: N control.48: N control.63: NNNN || Not done || -
|}

Remark by jOERG: Please try to understand when you are using a different setting than control.63: Mic 2, you are using a whole bunch of function blocks from PGA and digital section and you are not considering how the settings of those function blocks impact on your results. The whole test report is void / useless if using left/right_PGA. Also, as elaborated here and in Talk, there's no benefit from using PGA routing (beyond voodoo).

[[Category:Neo FreeRunner Hardware]]
[[Category:Audio]]

Neo Freerunner audio subsystem

2010-03-17T20:18:09Z

JOERG: /* Alsamixer channel controls */ several minor edits

The Neo Freerunner (GTA02) inherited the audio subsystem from its older brother the Neo 1973 (GTA01). However, there are a few small differences.
This page tries to show and explain the differences and points you to the [[Neo_1973_audio_subsystem | Neo 1973]] page whenever it touches the common points (but there may be overlaps for the sake of usability). As wiki pages are, errors and omissions are likely, and your help is welcomed.

==Differences from Neo 1973==
* There is only 1 (mono) built-in loud speaker (connected to LOUT1) instead of 2 (stereo).
* The Wolfson Codec driver presents 94 separate controls {switches, multiplexers, and volumes} to the alsa system (in both Neos). Unfortunately they are not mapped exactly the same for the GTA01 as for the GTA02.

==Possible sound connections through the Wolfson Codec==
* "Yes" = Confirmed, alsa state file exists.
* "No" = Not possible / not desirable.
* "Should" = Should be possible, not confirmed yet.
* "?" = Have no idea.

{| cellspacing="0" cellpadding="5" border="1"

|- align="center"
! - !! CPU !! GSM !! Bluetooth

|- align="center"
! GSM
| Yes

|- align="center"
! Bluetooth
| via BT-USB || Yes

|- align="center"
! Wired Speaker
| Yes || Yes || via CPU

|- align="center"
! Wired Mic
| Yes || Yes || via CPU

|- align="center"
! Body Earpiece
| Should || Yes || should (via CPU)

|- align="center"
! Body Speaker
| Yes || Yes || should (via CPU)

|- align="center"
! Body Mic
| Yes || Yes || should (via CPU)

|}

==Alsamixer channel controls==
The ALSA state files are installed by default, and belong to package ''"openmoko-alsa-scenarios"''.
To see where the files reside, do ''"opkg files openmoko-alsa-scenarios"''.
Currently ([[SHR]]), they are in ''"/etc/freesmartphone/alsa/default/gsmhandset"''; in other systems, they might be found in ''"/usr/share/openmoko/scenarios/"''.
Recommended statefile for phone usage is http://docs.openmoko.org/trac/attachment/ticket/2121/gsmhandset.state.new

# State: '''''GSM <-> Built-in Handset''''' (file gsmhandset.state)
## Mic volume:
##* Control 48: "Mic2 Capture Volume" (alsamixer name: "Mic2". Suggested value: max [3] - see below)
##* Control 12: "Mono Sidetone Playback Volume" (alsamixer name: "Mono sidetone" Suggested value: 5 [=0dB])
##* Control 5: "Mono Playback Volume" (alsamixer name: "Mono" Value: as needed [80..110]) This is the "user control" for mic
##* Control 63: 'Mic Sidetone Mux' MANDATORY VALUE "Mic 2"!!!
##* General rule is to keep control.12, and ajust control.48 so you have a resonable setting for user control.5 (i.e. NOT <70 or >110)
## Earpiece volume:
##* Control 6: "Bypass Playback Volume"
##* Control 4: "Speaker Playback Volume" This is the user control for earpiece volume

According to the [http://www.mail-archive.com/community@lists.openmoko.org/msg56045.html conclusion] of a [http://www.mail-archive.com/community@lists.openmoko.org/msg56037.html thread] from Dec 09, you might want to set Control 12 to value 5 if people you call complain about background noise, static, etc with the above settings.

For mic settings please refer also to http://wiki.openmoko.org/wiki/Neo_1973_and_Neo_FreeRunner_gsm_modem#AT.25Nxxxx

user should set volume according to own preferences:
for mic the (full, true) procedure is as follows:
reduce #5 by some 15..30 steps
do testcall:
you get very low volume at far end. but tone should be clear, no clipping (sharp agressive noise)
if there is clipping: reduce #48 by one step (i.e. to "2")
then adjust #5 to your preferences and taste
(do `alsactrl store -f gsmhandset.state` to save the changes if you used a mixer to adjust the levels)

for earpiece(-speaker):
level up modem to full volume (AT+CLVL cmd used by framework),
level up #6 to full volume,
adjust by #4
if you get clipping when #4 is at moderate level (same as above): reduce #6 (or even AT+CLVL) until clipping vanishes
(very unlikely to occur for earpiece playback)

# State: '''''GSM <-> Built-in Handsfree''''' (file gsmspeakerout.state)
## Mic volume:
##* Control ?:
## Speaker volume:
##* Control ?:
# State: '''''GSM <-> Wired Headset''''' (file gsmheadset.state)
## Mic volume:
##* Control 49: "Mic1 Capture Volume"
##* Control 12: "Mono Sidetone Playback Volume"
##* Control 5: "Mono Playback Volume"
## Speaker volume:
##* Control 6: "Bypass Playback Volume"
##* Control 3: "Headphone Playback Volume"
# State: '''''GSM <-> Bluetooth Headset''''' (file ???)
## Alternative working state files: [http://handheldshell.com/gsm_headset.txt]
## Mic volume:
##* Control 13: "Mono Voice Playback Volume"
##* Control 5: "Mono Playback Volume"
# State: '''''CPU <-> Built-in Handset''''' (file voip-handset.state)
## Mic volume:
##* Control ?:
## Speaker volume:
##* Control ?:
# State: '''''CPU <-> Wired Headset''''' (file headset.state)
## Stereo sound:
##* Control ?:
## Headset output:
##* Control 94: "Amp Spk Switch" <- false
# State: '''''CPU <-> Buildin Speaker''''' (file stereoout.state)
## Mono sound:
##* Control ?:
## Headset output:
##* Control 94: "Amp Spk Switch" <- true
# State: '''''CPU -> GSM''''' (file gsmhandset.state)
## Mono sound:
##* Control 74: Mono Mixer Left Playback Switch to true
##* Control 75: Mono Mixer Right Playback Switch to true
##* Control 1: PCM Volume suggested value 135

--[[User:Femto|Femto]] 12:39, 24 September 2008 (UTC) I've updated above values. Must be checked.

-- I created another state file (voip-handsfree.state) for CPU Handsfree, mixed and matched voip-handset and stereoout. You can find it [http://wiki.openmoko.org/wiki/User:Savimonty here]. Feel free to make a change to it if there are errors. I don't see any, though.

=== Volume Control ===

Angus Ainslie has written a simple [http://n2.nabble.com/Sound-quality-in-calls.-tp1087522p1096155.html python volume control] (which is getting more and more sophisticated) using some of these settings.

Installing the GUI mixer

<pre>
wget http://handheldshell.com/pymixer.py
wget http://handheldshell.com/volume.desktop
cp pymixer.py /usr/bin
chmod u+x /usr/bin/pymixer.py
cp volume.desktop /usr/share/applications
opkg install python-pygtk
opkg install http://handheldshell.com/python-pyalsaaudio_0.3-ml0_armv4t.ipk
</pre>

If the python script aborts unexpectedly then look [http://lists.openmoko.org/nabble.html#nabble-td1128064 here] for a fix

You could also try [http://www.mazikeen.demon.co.uk/openmoko/fso-simplemixer.py fso-simplemixer.py], a simplified mixer based on the one above.

== Empirical Data for Mic Settings ==

'''"Experiment 1"''' in the table means:
# Set your controls as follows: control.12 (Mono Sidetone Playback Volume): 5 control.48 (Mic2 Capture): 3 control.63 (Mic Sidetone Mux): Mic 2 
# Call another phone from your Neo FreeRunner, mute it's microphone and listen to your voice coming from Neo FreeRunner's microphone. Connect to FreeRunner, run alsamixer and experiment then with control.5 (Mono Playback Volume) by lowering it so that buzzing noise is gone or at an acceptable level. After the noise is reduced, observe the actual volume/clarity of your voice when you speak.
# Write result in the table: "''Positive''" if you don't normally use such settings, but you achieved at least similar level of quality while using these settings, quality meaning lack of noise and clarity/volume of voice. "''Already in use''", if you already normally use settings that have control.12/48/63 like above. Write in notes if you experimented with other settings but found out these were superior, or similar. "''Negative''" if you don't normally use such settings, you experimented, but you failed to achieve similar level of quality with the settings above and experimenting with control.5. Please write in the notes how it failed - most typically did you not hear anymore your voice as well after reducing control.5 enough to get rid of the noise, or how did the experiment turn out negative? "''Not done''", if you didn't complete this experiment.

{| cellspacing="0" cellpadding="5" border="1"
| User || FR Revision + buzzfix? || Microphone Settings in Use (before) || Result of Experiment 1 || Notes
|- align="center"
| [[User:TimoJyrinki]] || A7 || control.5: 97 control.12: 5 control.48: 3 control.63: Mic 2 || Already in use || Able to reach acceptable level of quality with other settings as well, but somewhat less volume can be had with control.63 set to Right PGA before noise starts to be heard (when increasing control.5 and/or control.12 to compensate).
|- align="center"
| [[User:TimoJyrinki]] || A5 + buzzfix || control.5: 105 control.12: 7 control.48: 3 control.63: Mic 2 || Not done || Only checked from a backup, not sure anymore how the audio quality was like. Buzzfix now failing on the device so cannot test. I have used these kind of settings and also earlier control.63 set to Right PGA while increasing control.5.
|- align="center"
| [[User:Pini]] || A5 + buzzfix || control.5: 127 control.12:: 1 control.48: 1 control.63: Mic 2 || In use || Setting successfully tested in a rather noisy environment (train platform)
|- align="center"
| [[User:YourName]] || A1 + buzzfix || control.5: NN control.12:: N control.48: N control.63: NNNN || Not done || -
|}

Remark by jOERG: Please try to understand when you are using a different setting than control.63: Mic 2, you are using a whole bunch of function blocks from PGA and digital section and you are not considering how the settings of those function blocks impact on your results. The whole test report is void / useless if using left/right_PGA. Also, as elaborated here and in Talk, there's no benefit from using PGA routing (beyond voodoo).

[[Category:Neo FreeRunner Hardware]]
[[Category:Audio]]

Neo Freerunner audio subsystem

2010-03-17T19:56:31Z

JOERG: /* Possible sound connections through the Wolfson Codec */ update checked states

The Neo Freerunner (GTA02) inherited the audio subsystem from its older brother the Neo 1973 (GTA01). However, there are a few small differences.
This page tries to show and explain the differences and points you to the [[Neo_1973_audio_subsystem | Neo 1973]] page whenever it touches the common points (but there may be overlaps for the sake of usability). As wiki pages are, errors and omissions are likely, and your help is welcomed.

==Differences from Neo 1973==
* There is only 1 (mono) built-in loud speaker (connected to LOUT1) instead of 2 (stereo).
* The Wolfson Codec driver presents 94 separate controls {switches, multiplexers, and volumes} to the alsa system (in both Neos). Unfortunately they are not mapped exactly the same for the GTA01 as for the GTA02.

==Possible sound connections through the Wolfson Codec==
* "Yes" = Confirmed, alsa state file exists.
* "No" = Not possible / not desirable.
* "Should" = Should be possible, not confirmed yet.
* "?" = Have no idea.

{| cellspacing="0" cellpadding="5" border="1"

|- align="center"
! - !! CPU !! GSM !! Bluetooth

|- align="center"
! GSM
| Yes

|- align="center"
! Bluetooth
| via BT-USB || Yes

|- align="center"
! Wired Speaker
| Yes || Yes || via CPU

|- align="center"
! Wired Mic
| Yes || Yes || via CPU

|- align="center"
! Body Earpiece
| Should || Yes || should (via CPU)

|- align="center"
! Body Speaker
| Yes || Yes || should (via CPU)

|- align="center"
! Body Mic
| Yes || Yes || should (via CPU)

|}

==Alsamixer channel controls==
The ALSA state files are installed by default, and belong to package ''"openmoko-alsa-scenarios"''.
To see where the files reside, do ''"opkg files openmoko-alsa-scenarios"''.
Currently ([[SHR]]), they are in ''"/etc/freesmartphone/alsa/default/gsmhandset"''; in other systems, they might be found in ''"/usr/share/openmoko/scenarios/"''.
Recommended statefile for phone usage is http://docs.openmoko.org/trac/attachment/ticket/2121/gsmhandset.state.new

# State: '''''GSM <-> Built-in Handset''''' (file gsmhandset.state)
## Mic volume:
##* Control 48: "Mic2 Capture Volume" (alsamixer name: "Mic2". Suggested value: max)
##* Control 12: "Mono Sidetone Playback Volume" (alsamixer name: "Mono sidetone" Suggested value: 5..7(max))
##* Control 5: "Mono Playback Volume" (alsamixer name: "Mono" Value: as needed)
##* Control 63: 'Mic Sidetone Mux' MANDATORY VALUE "Mic 2"!!!
## Earpiece volume:
##* Control 6: "Bypass Playback Volume"
##* Control 4: "Speaker Playback Volume"

According to the [http://www.mail-archive.com/community@lists.openmoko.org/msg56045.html conclusion] of a [http://www.mail-archive.com/community@lists.openmoko.org/msg56037.html thread] from Dec 09, you might want to set Control 12 to value 5 if people you call complain about background noise, static, etc with the above settings.

For mic settings please refer also to http://wiki.openmoko.org/wiki/Neo_1973_and_Neo_FreeRunner_gsm_modem#AT.25Nxxxx

user should set volume according to own preferences:
for mic the (full, true) procedure is as follows:
reduce #5 by some 15..30 steps
do testcall:
you get very low volume at far end. but tone should be clear, no clipping (sharp agressive noise)
if there is clipping: reduce #48 by one step (i.e. to "2")
then adjust #5 to your preferences and taste
(do `alsactrl store -f gsmhandset.state` to save the changes if you used a mixer to adjust the levels)

for earpiece(-speaker):
level up modem to full volume (AT+CLVL cmd used by framework),
level up #6 to full volume,
adjust by #4
if you get clipping when #4 is at moderate level (same as above): reduce #6 (or even AT+CLVL) until clipping vanishes
(very unlikely to occur for earpiece playback)

# State: '''''GSM <-> Built-in Handsfree''''' (file gsmspeakerout.state)
## Mic volume:
##* Control ?:
## Speaker volume:
##* Control ?:
# State: '''''GSM <-> Wired Headset''''' (file gsmheadset.state)
## Mic volume:
##* Control 49: "Mic1 Capture Volume"
##* Control 12: "Mono Sidetone Playback Volume"
##* Control 5: "Mono Playback Volume"
## Speaker volume:
##* Control 6: "Bypass Playback Volume"
##* Control 3: "Headphone Playback Volume"
# State: '''''GSM <-> Bluetooth Headset''''' (file ???)
## Alternative working state files: [http://handheldshell.com/gsm_headset.txt]
## Mic volume:
##* Control 13: "Mono Voice Playback Volume"
##* Control 5: "Mono Playback Volume"
# State: '''''CPU <-> Built-in Handset''''' (file voip-handset.state)
## Mic volume:
##* Control ?:
## Speaker volume:
##* Control ?:
# State: '''''CPU <-> Wired Headset''''' (file headset.state)
## Stereo sound:
##* Control ?:
## Headset output:
##* Control 94: "Amp Spk Switch" <- false
# State: '''''CPU <-> Buildin Speaker''''' (file stereoout.state)
## Mono sound:
##* Control ?:
## Headset output:
##* Control 94: "Amp Spk Switch" <- true
# State: '''''CPU -> GSM''''' (file gsmhandset.state)
## Mono sound:
##* Control 74: Mono Mixer Left Playback Switch to true
##* Control 75: Mono Mixer Right Playback Switch to true
##* Control 1: PCM Volume suggested value 135

* These files I still don't know what they are for:

--[[User:Femto|Femto]] 12:39, 24 September 2008 (UTC) I've updated above values. Must be checked.

-- I created another state file (voip-handsfree.state) for CPU Handsfree, mixed and matched voip-handset and stereoout. You can find it [http://wiki.openmoko.org/wiki/User:Savimonty here]. Feel free to make a change to it if there are errors. I don't see any, though.

=== Volume Control ===

Angus Ainslie has written a simple [http://n2.nabble.com/Sound-quality-in-calls.-tp1087522p1096155.html python volume control] (which is getting more and more sophisticated) using some of these settings.

Installing the GUI mixer

<pre>
wget http://handheldshell.com/pymixer.py
wget http://handheldshell.com/volume.desktop
cp pymixer.py /usr/bin
chmod u+x /usr/bin/pymixer.py
cp volume.desktop /usr/share/applications
opkg install python-pygtk
opkg install http://handheldshell.com/python-pyalsaaudio_0.3-ml0_armv4t.ipk
</pre>

If the python script aborts unexpectedly then look [http://lists.openmoko.org/nabble.html#nabble-td1128064 here] for a fix

You could also try [http://www.mazikeen.demon.co.uk/openmoko/fso-simplemixer.py fso-simplemixer.py], a simplified mixer based on the one above.

== Empirical Data for Mic Settings ==

'''"Experiment 1"''' in the table means:
# Set your controls as follows: control.12 (Mono Sidetone Playback Volume): 5 control.48 (Mic2 Capture): 3 control.63 (Mic Sidetone Mux): Mic 2 
# Call another phone from your Neo FreeRunner, mute it's microphone and listen to your voice coming from Neo FreeRunner's microphone. Connect to FreeRunner, run alsamixer and experiment then with control.5 (Mono Playback Volume) by lowering it so that buzzing noise is gone or at an acceptable level. After the noise is reduced, observe the actual volume/clarity of your voice when you speak.
# Write result in the table: "''Positive''" if you don't normally use such settings, but you achieved at least similar level of quality while using these settings, quality meaning lack of noise and clarity/volume of voice. "''Already in use''", if you already normally use settings that have control.12/48/63 like above. Write in notes if you experimented with other settings but found out these were superior, or similar. "''Negative''" if you don't normally use such settings, you experimented, but you failed to achieve similar level of quality with the settings above and experimenting with control.5. Please write in the notes how it failed - most typically did you not hear anymore your voice as well after reducing control.5 enough to get rid of the noise, or how did the experiment turn out negative? "''Not done''", if you didn't complete this experiment.

{| cellspacing="0" cellpadding="5" border="1"
| User || FR Revision + buzzfix? || Microphone Settings in Use (before) || Result of Experiment 1 || Notes
|- align="center"
| [[User:TimoJyrinki]] || A7 || control.5: 97 control.12: 5 control.48: 3 control.63: Mic 2 || Already in use || Able to reach acceptable level of quality with other settings as well, but somewhat less volume can be had with control.63 set to Right PGA before noise starts to be heard (when increasing control.5 and/or control.12 to compensate).
|- align="center"
| [[User:TimoJyrinki]] || A5 + buzzfix || control.5: 105 control.12: 7 control.48: 3 control.63: Mic 2 || Not done || Only checked from a backup, not sure anymore how the audio quality was like. Buzzfix now failing on the device so cannot test. I have used these kind of settings and also earlier control.63 set to Right PGA while increasing control.5.
|- align="center"
| [[User:Pini]] || A5 + buzzfix || control.5: 127 control.12:: 1 control.48: 1 control.63: Mic 2 || In use || Setting successfully tested in a rather noisy environment (train platform)
|- align="center"
| [[User:YourName]] || A1 + buzzfix || control.5: NN control.12:: N control.48: N control.63: NNNN || Not done || -
|}

Remark by jOERG: Please try to understand when you are using a different setting than control.63: Mic 2, you are using a whole bunch of function blocks from PGA and digital section and you are not considering how the settings of those function blocks impact on your results. The whole test report is void / useless if using left/right_PGA. Also, as elaborated here and in Talk, there's no benefit from using PGA routing (beyond voodoo).

[[Category:Neo FreeRunner Hardware]]
[[Category:Audio]]

Neo Freerunner audio subsystem

2010-03-17T19:37:37Z

JOERG: /* Empirical Data for Mic Settings */ Remark on control.63

The Neo Freerunner (GTA02) inherited the audio subsystem from its older brother the Neo 1973 (GTA01). However, there are a few small differences.
This page tries to show and explain the differences and points you to the [[Neo_1973_audio_subsystem | Neo 1973]] page whenever it touches the common points (but there may be overlaps for the sake of usability). As wiki pages are, errors and omissions are likely, and your help is welcomed.

==Differences from Neo 1973==
* There is only 1 (mono) built-in loud speaker (connected to LOUT1) instead of 2 (stereo).
* The Wolfson Codec driver presents 94 separate controls {switches, multiplexers, and volumes} to the alsa system (in both Neos). Unfortunately they are not mapped exactly the same for the GTA01 as for the GTA02.

==Possible sound connections through the Wolfson Codec==
* "Yes" = Confirmed, alsa state file exists.
* "No" = Not possible / not desirable.
* "Should" = Should be possible, not confirmed yet.
* "?" = Have no idea.

{| cellspacing="0" cellpadding="5" border="1"

|- align="center"
! - !! CPU !! GSM !! Bluetooth

|- align="center"
! GSM
| Yes

|- align="center"
! Bluetooth
| ? || Yes

|- align="center"
! Wired Speaker
| Yes || Yes || ?

|- align="center"
! Wired Mic
| Yes || Yes || ?

|- align="center"
! Body Earpiece
| Should || Yes || ?

|- align="center"
! Body Speaker
| Yes || Should || ?

|- align="center"
! Body Mic
| Should || Yes || ?

|}

==Alsamixer channel controls==
The ALSA state files are installed by default, and belong to package ''"openmoko-alsa-scenarios"''.
To see where the files reside, do ''"opkg files openmoko-alsa-scenarios"''.
Currently ([[SHR]]), they are in ''"/etc/freesmartphone/alsa/default/gsmhandset"''; in other systems, they might be found in ''"/usr/share/openmoko/scenarios/"''.
Recommended statefile for phone usage is http://docs.openmoko.org/trac/attachment/ticket/2121/gsmhandset.state.new

# State: '''''GSM <-> Built-in Handset''''' (file gsmhandset.state)
## Mic volume:
##* Control 48: "Mic2 Capture Volume" (alsamixer name: "Mic2". Suggested value: max)
##* Control 12: "Mono Sidetone Playback Volume" (alsamixer name: "Mono sidetone" Suggested value: 5..7(max))
##* Control 5: "Mono Playback Volume" (alsamixer name: "Mono" Value: as needed)
##* Control 63: 'Mic Sidetone Mux' MANDATORY VALUE "Mic 2"!!!
## Earpiece volume:
##* Control 6: "Bypass Playback Volume"
##* Control 4: "Speaker Playback Volume"

According to the [http://www.mail-archive.com/community@lists.openmoko.org/msg56045.html conclusion] of a [http://www.mail-archive.com/community@lists.openmoko.org/msg56037.html thread] from Dec 09, you might want to set Control 12 to value 5 if people you call complain about background noise, static, etc with the above settings.

For mic settings please refer also to http://wiki.openmoko.org/wiki/Neo_1973_and_Neo_FreeRunner_gsm_modem#AT.25Nxxxx

user should set volume according to own preferences:
for mic the (full, true) procedure is as follows:
reduce #5 by some 15..30 steps
do testcall:
you get very low volume at far end. but tone should be clear, no clipping (sharp agressive noise)
if there is clipping: reduce #48 by one step (i.e. to "2")
then adjust #5 to your preferences and taste
(do `alsactrl store -f gsmhandset.state` to save the changes if you used a mixer to adjust the levels)

for earpiece(-speaker):
level up modem to full volume (AT+CLVL cmd used by framework),
level up #6 to full volume,
adjust by #4
if you get clipping when #4 is at moderate level (same as above): reduce #6 (or even AT+CLVL) until clipping vanishes
(very unlikely to occur for earpiece playback)

# State: '''''GSM <-> Built-in Handsfree''''' (file gsmspeakerout.state)
## Mic volume:
##* Control ?:
## Speaker volume:
##* Control ?:
# State: '''''GSM <-> Wired Headset''''' (file gsmheadset.state)
## Mic volume:
##* Control 49: "Mic1 Capture Volume"
##* Control 12: "Mono Sidetone Playback Volume"
##* Control 5: "Mono Playback Volume"
## Speaker volume:
##* Control 6: "Bypass Playback Volume"
##* Control 3: "Headphone Playback Volume"
# State: '''''GSM <-> Bluetooth Headset''''' (file ???)
## Alternative working state files: [http://handheldshell.com/gsm_headset.txt]
## Mic volume:
##* Control 13: "Mono Voice Playback Volume"
##* Control 5: "Mono Playback Volume"
# State: '''''CPU <-> Built-in Handset''''' (file voip-handset.state)
## Mic volume:
##* Control ?:
## Speaker volume:
##* Control ?:
# State: '''''CPU <-> Wired Headset''''' (file headset.state)
## Stereo sound:
##* Control ?:
## Headset output:
##* Control 94: "Amp Spk Switch" <- false
# State: '''''CPU <-> Buildin Speaker''''' (file stereoout.state)
## Mono sound:
##* Control ?:
## Headset output:
##* Control 94: "Amp Spk Switch" <- true
# State: '''''CPU -> GSM''''' (file gsmhandset.state)
## Mono sound:
##* Control 74: Mono Mixer Left Playback Switch to true
##* Control 75: Mono Mixer Right Playback Switch to true
##* Control 1: PCM Volume suggested value 135

* These files I still don't know what they are for:

--[[User:Femto|Femto]] 12:39, 24 September 2008 (UTC) I've updated above values. Must be checked.

-- I created another state file (voip-handsfree.state) for CPU Handsfree, mixed and matched voip-handset and stereoout. You can find it [http://wiki.openmoko.org/wiki/User:Savimonty here]. Feel free to make a change to it if there are errors. I don't see any, though.

=== Volume Control ===

Angus Ainslie has written a simple [http://n2.nabble.com/Sound-quality-in-calls.-tp1087522p1096155.html python volume control] (which is getting more and more sophisticated) using some of these settings.

Installing the GUI mixer

<pre>
wget http://handheldshell.com/pymixer.py
wget http://handheldshell.com/volume.desktop
cp pymixer.py /usr/bin
chmod u+x /usr/bin/pymixer.py
cp volume.desktop /usr/share/applications
opkg install python-pygtk
opkg install http://handheldshell.com/python-pyalsaaudio_0.3-ml0_armv4t.ipk
</pre>

If the python script aborts unexpectedly then look [http://lists.openmoko.org/nabble.html#nabble-td1128064 here] for a fix

You could also try [http://www.mazikeen.demon.co.uk/openmoko/fso-simplemixer.py fso-simplemixer.py], a simplified mixer based on the one above.

== Empirical Data for Mic Settings ==

'''"Experiment 1"''' in the table means:
# Set your controls as follows: control.12 (Mono Sidetone Playback Volume): 5 control.48 (Mic2 Capture): 3 control.63 (Mic Sidetone Mux): Mic 2 
# Call another phone from your Neo FreeRunner, mute it's microphone and listen to your voice coming from Neo FreeRunner's microphone. Connect to FreeRunner, run alsamixer and experiment then with control.5 (Mono Playback Volume) by lowering it so that buzzing noise is gone or at an acceptable level. After the noise is reduced, observe the actual volume/clarity of your voice when you speak.
# Write result in the table: "''Positive''" if you don't normally use such settings, but you achieved at least similar level of quality while using these settings, quality meaning lack of noise and clarity/volume of voice. "''Already in use''", if you already normally use settings that have control.12/48/63 like above. Write in notes if you experimented with other settings but found out these were superior, or similar. "''Negative''" if you don't normally use such settings, you experimented, but you failed to achieve similar level of quality with the settings above and experimenting with control.5. Please write in the notes how it failed - most typically did you not hear anymore your voice as well after reducing control.5 enough to get rid of the noise, or how did the experiment turn out negative? "''Not done''", if you didn't complete this experiment.

{| cellspacing="0" cellpadding="5" border="1"
| User || FR Revision + buzzfix? || Microphone Settings in Use (before) || Result of Experiment 1 || Notes
|- align="center"
| [[User:TimoJyrinki]] || A7 || control.5: 97 control.12: 5 control.48: 3 control.63: Mic 2 || Already in use || Able to reach acceptable level of quality with other settings as well, but somewhat less volume can be had with control.63 set to Right PGA before noise starts to be heard (when increasing control.5 and/or control.12 to compensate).
|- align="center"
| [[User:TimoJyrinki]] || A5 + buzzfix || control.5: 105 control.12: 7 control.48: 3 control.63: Mic 2 || Not done || Only checked from a backup, not sure anymore how the audio quality was like. Buzzfix now failing on the device so cannot test. I have used these kind of settings and also earlier control.63 set to Right PGA while increasing control.5.
|- align="center"
| [[User:Pini]] || A5 + buzzfix || control.5: 127 control.12:: 1 control.48: 1 control.63: Mic 2 || In use || Setting successfully tested in a rather noisy environment (train platform)
|- align="center"
| [[User:YourName]] || A1 + buzzfix || control.5: NN control.12:: N control.48: N control.63: NNNN || Not done || -
|}

Remark by jOERG: Please try to understand when you are using a different setting than control.63: Mic 2, you are using a whole bunch of function blocks from PGA and digital section and you are not considering how the settings of those function blocks impact on your results. The whole test report is void / useless if using left/right_PGA. Also, as elaborated here and in Talk, there's no benefit from using PGA routing (beyond voodoo).

[[Category:Neo FreeRunner Hardware]]
[[Category:Audio]]

Community Resources

2010-03-12T09:45:30Z

JOERG: /* IRC */

{{Languages|Community Resources}}

All resources listed here are available to the general public. Everyone is invited to participate.

See also the [[Community Updates]] board

== Applications Directory ==

We are currently working at a [http://bitbucket.org/spaetz/opkgrepo/ new application repository] where people can browse online for their favourite app, vote, comment, and so on.

If you wish to help please subscribe to the [http://lists.shr-project.org/mailman/listinfo/shr-devel SHR-devel] mailing list or join our irc channel:

Server: irc.freenode.net

Channel: #openmoko-cdevel

We need your help!

== Blogs Aggregator ==

The blogs of openmoko fans and developpers are aggregated at [http://planet.openmoko.org/ planet.openmoko.org]. Only posts tagged ''openmoko'' are syndicated. The planet is multilingual. To get your blog added, please open a ticket on the [http://admin-trac.openmoko.org/trac admin-trac] (you will need to open an account first).

== Forums and Jabber Multi-User Chats ==

See [[Discussion Forums]]. There is very little activity at the [http://forums.makeopensource.com/ The Unofficial OpenMoko Forums], but others forums are more busy.

== Discussion boards ==
See [[Discussion Boards]].

== Git Servers ==

The new official set of repositories for [[OpenEmbedded]] as well as Linux [[kernel]], X.org and other used projects can be found at http://git.openmoko.org/, browsable via gitweb.

'''Currently''' (02/2009) the only active ones are qi, kernel and xf86-video-glamo.git. Everything else has moved to upstream git.openembedded.net, see [[OpenEmbedded]] for more information.

To get access to git.openmoko.org, see instructions on using trac to ask for access in the mailing list post http://lists.openmoko.org/pipermail/devel/2009-February/004563.html.

=== Personal repositories and branches ===

Some members of the community have published their copy of the openmoko repository with private or not-yet-applied changes.

* [[User:Nomeata|Nomeata]]: http://git.nomeata.de/?p=openmoko.git;a=summary

== IRC ==

* '''#openmoko''' of Freenode has always a good group for general discussion.
* '''#openmoko-cdevel''' is for community developer channel
* '''#paroli''' is to discuss the aspects of [Paroli] development
* '''#openmoko-devel''' is for Openmoko Inc. internal developers only, sorry
* '''#openmoko-de''' is active within the time constraints of middle Europe. English spoken, if necessary.
* '''#freerunner-android''' can be used to discuss running [Android] of Freerunner

If you experience any build problems and need help from other developers, it is important that you share your complete output log. To share your output log, just paste it to [http://www.pastebin.ca/ pastebin] after submitting it, paste the resulting URL to the IRC channel.

If you aren't an IRC-er, you might want to review the discussions of #openmoko anyways:

* [http://logs.nslu2-linux.org/livelogs/openmoko.txt Current 24h live log]
* [http://logs.nslu2-linux.org/livelogs/openmoko-prev.txt Previous 24h log]
* [http://logs.nslu2-linux.org/livelogs/openmoko/ Archives back to 29 November 2006]

(Courtesy of the NSLU2-Linux project)
(currently broken as of 2010-02. Use ~logs in IRC)

== Mailing Lists ==

There are several [http://lists.openmoko.org/mailman/listinfo/ Mailing lists]. Archives of these lists can be searched with [http://openmoko.markmail.org/ Markmail]. There is a [http://lists.openmoko.org/nabble.html Nabble web interface] to read and post to the lists.

You should ask for help on the [https://lists.openmoko.org/mailman/listinfo/support support mailing list].

The [http://lists.openmoko.org/pipermail/community/ openmoko community mailing list] is perhaps the most active.
As of July 2008, its volume amounts to dozens of messages per day. Openmoko people are there too. When posting about a specific distribution, please start the subject line with its name between bracket: [FSO], [2008.9]...

Lots of Debian and FSO discussions among the pkg-fso team takes place on the [http://lists.linuxtogo.org/cgi-bin/mailman/listinfo/smartphones-userland Smartphones-userland] list.

If you feel uncomfortable using mailing lists, you can use [http://gmane.org gmane] forum-like interface.

''' announce@lists.openmoko.org '''

A read-only list where the project does official announcements. We strongly recommend subscribing to this list if you want to stay up-to-date with the major project achievements.

http://lists.openmoko.org/mailman/listinfo/announce

Gmane: http://news.gmane.org/gmane.comp.handhelds.openmoko.announce

''' community@lists.openmoko.org '''

This is a public mailinglist for generic discussion of our user + developer community. It acts as a place where people discuss their dreams/wishes/ideas about Openmoko software and supported hardware, applications, and the like. It's an area of general talking and chatting. Please do ''not'' post usage or development questions here.

http://lists.openmoko.org/mailman/listinfo/community

Gmane: http://news.gmane.org/gmane.comp.handhelds.openmoko.community

''' devel@lists.openmoko.org '''

This is a mailinglist on the Openmoko Distribution. Here issues such as ipk packaging related and root fs image related topics should be discussed. Also, questions regarding the OpenEmbedded based build process go here.

http://lists.openmoko.org/mailman/listinfo/devel

Gmane: http://news.gmane.org/gmane.comp.handhelds.openmoko.distro

''' documentation@lists.openmoko.org '''

The meetingplace of the documentation team.

https://lists.openmoko.org/mailman/listinfo/documentation

''' hardware@lists.openmoko.org '''

This is a mailinglist on Openmoko hardware development: digital, RF, schematics.

http://lists.openmoko.org/mailman/listinfo/hardware

Gmane: http://news.gmane.org/gmane.comp.handhelds.openmoko.hardware

''' openmoko-kernel@lists.openmoko.org '''

This is a public mailinglist for discussion of kernel and bootloader development.

http://lists.openmoko.org/mailman/listinfo/openmoko-kernel

Gmane: http://news.gmane.org/gmane.comp.handhelds.openmoko.kernel

''' support@lists.openmoko.org '''

This is a public mailinglist for discussion among actual owners of an Openmoko based device. Here you can ask for assistance, share your experiences, etc. Please keep this list clean of any philosophical debates or general openmoko related discussion. That's what ''community@lists.openmoko.org'' is for! (This list was formerly called device-owners).

http://lists.openmoko.org/mailman/listinfo/support

''' local-openmoko lists '''

Mailing lists in of your region in you own language please ask Michael Siloh (michael at openmoko dot org) to create you own

''''' local-openmoko-spain@projects.openmoko.org '''''

This is the mailing list for spanish community in spanish language, if you need help, orientation or know what's going on please join us.

http://lists.projects.openmoko.org/mailman/listinfo/local-openmoko-spain

nabble: http://n2.nabble.com/Openmoko-spanish-community-list-f1077272.html

Gmane: http://news.gmane.org/gmane.org.user-groups.openmoko.spain

''' log mailing lists '''

''''' buglog@lists.openmoko.org ''''': A read-only list where every status updates to bugs (bugzilla entries) were get posted. Nice to keep updated on the bug squashing progress. http://lists.openmoko.org/mailman/listinfo/buglog. Gmane: http://news.gmane.org/gmane.comp.handhelds.openmoko.buglog

''''' commitlog@lists.openmoko.org ''''': A read-only list where every source code change (commit to the subversion server) gets posted. Nice to keep posted on development progress. http://lists.openmoko.org/mailman/listinfo/commitlog

''''' webdesign-commitlog@lists.openmoko.org ''''': This is a public read-only mailinglist receiving commit log messages of our web designers. Subscribe to this list if you want to get notified if some of the static content or the templates/skins of our websites change. http://lists.openmoko.org/mailman/listinfo/webdesign-commitlog

== Newsletters ==

* [[Community Updates]] try to sum up what has been happening all over. Updates are also mailed to the openmoko-community mailing list, and major updates are also sent to the announce list.

* Wolfgang Spraul tries to give a weekly summary of what's going on in Openmoko. You can follow it at the devel mailing list or follow the [[Weekly Engineering News]] page.

== Openmoko Inc. Internal Resources ==

There are some resources which are internal. This means that they are only available for internal developers of Openmoko Inc. The reason they are internal is either because they deal with information under NDA, or about business strategy. We kindly ask for your understanding that while we really try to be as open as possible, there are some topics which we have to discuss without public participation.

The internal systems have the domain ''*.internal.openmoko.org''.

== Projects Hosting ==

At http://projects.openmoko.org/ we have a GForge installation. Users can use this as hosting service for their contributed applications.

== Trac / Bug Reporting ==

Our bug ticketing and documentation system for software issues is available at http://docs.openmoko.org/trac/. This obsoleted the previously used bugzilla installation which was found at http://bugzilla.openmoko.org/.
Admin team has extra trac system: http://admin-trac.openmoko.org/trac/intertrac/.

== Wiki ==

This Wiki is our public wiki, http://wiki.openmoko.org/. You're already in it, if you're reading this. Due to continued defacements/spam we were forced to limit editing in this wiki to registered users which provide a working email address. Sorry for that.

You can reference the following pages to get more information.
* [[Edit Wiki]]
* [[Openmoko Wiki Editing Guidelines]]

== Local Communities / Non-English Languages ==

See the [[Openmoko_Local_Groups|Openmoko Local Groups]]

=== Czech/Slovak ===
* http://www.openmoko.cz
* [http://forum.openmoko.cz forum]
* [http://www.jabber.cz Jabber] [http://www.jabber.cz/wiki/Konference conference]: ''openmoko@muc.openmoko.cz'' [http://muc.unart.cz/logs/openmoko@muc.openmoko.cz/ logs]

=== Finnish ===

* [http://linux.fi/foorumi/index.php?board=18.0 forum]
* [irc://chat.eu.freenode.net/openmoko-fi IRC channel]
* [[Openmoko Local Groups: Finland|wiki start page]]
* [http://www.vapaasuomi.fi/ possibly some related blog posts]

=== French ===

* [http://openmoko-fr.org/wiki/index.php/Bienvenue wiki]
* [http://openmoko-fr.org/forum/index.php forums]
* [http://openmoko-fr.org/blog/ blog]
* [irc://chat.eu.freenode.net/openmoko-fr IRC channel]

=== German ===

The German Neo1973 community created a Trac-based web site with SVN version control for their community projects: http://neo1973-germany.de/ The most notable project is Zad, which consists of a GUI and daemons for GSM/GPRS muxing, GSM, GPS and more, written using Enlightment for smooth, smooth, fast, alpha-blended graphics and glib and dbus for daemons, but the actual code of the project is all python. And yes, you can even make phone calls with it (even without "echo").

FreeYourPhone - erstes deutsches Openmoko Forum: http://freeyourphone.de

=== Polish ===

* [http://openmoko.opendevice.org wiki]
* irc-room #openmoko.pl@freenode
* [http://openmoko.opendevice.org/planeta planet]
* [http://tytanick.net/openmoko forums]
* Users [http://tinyurl.com/62ja5k map]

=== Spanish ===

There is a spanish mailing list.

=== Italian ===

* [http://wiki.telefoninux.org/ wiki]
* [http://telefoninux.org/ forums]
* [http://planet.telefoninux.org planet]
* IRC channel : #telefoninux@freenode

=== Russian ===

[http://www.linuxphone.ru/ LinuxPhone.ru] is a site dedicated to Openmoko phones, its distributions and other Linux/Open Source mobile initiatives (such as [[Android]], Palm webOS, open Symbian Platform and Linux-powered Motorola phones). Also, it serves as a place for general community meeting point.

These are Openmoko-related resources:
* [http://www.linuxphone.ru/tag/openmoko/ news]
* [http://wiki.linuxphone.ru/Category:Openmoko wiki]
* [http://www.linuxphone.ru/forum/viewforum.php?f=1 forum]
* [http://dl.linuxphone.ru/openmoko/ files] (distribution images, scripts, packages and so on made by Russian community members)

== Appendix: Obsolete resources ==

=== SVN ===

There was a [http://subversion.tigris.org/ Subversion] server available at svn.openmoko.org. '''It is now not used anymore'''. See obsolete information on [http://wiki.openmoko.org/index.php?title=Development_resources&oldid=63119#SVN this history version of this page].

=== Obsolete mailing lists ===
''' framework-devel@lists.openmoko.org '''
''' NOTE: This mailing list has been closed. Discussion should continue on devel. '''

This is a mailinglist on the Openmoko Framework. Please use this list to post questions with regard to the Openmoko Framework, the API's, their usage, API change requests and the like.

http://lists.openmoko.org/mailman/listinfo/framework-devel

Gmane: http://news.gmane.org/gmane.comp.handhelds.openmoko.framework

''' gsmd-devel@lists.openmoko.org '''

This is a mailinglist on the Openmoko gsmd (GSM daemon) and the corresponding libgsmd.

http://lists.openmoko.org/mailman/listinfo/gsmd-devel

Gmane: http://news.gmane.org/gmane.comp.handhelds.openmoko.gsmd

''' openmoko-apps@lists.openmoko.org '''
'''NOTE: This mailing list has been closed. Discussion should continue on devel.'''

This is a public mailinglist about the development of the "official" Openmoko applications, e.g. openmoko-dialer2, openmoko-dates2, openmoko-contacts2, and openmoko-today2. Please do ''not'' use this list for issues related to third party applications.

http://lists.openmoko.org/mailman/listinfo/openmoko-apps/

Gmane: http://news.gmane.org/gmane.comp.handhelds.openmoko.apps

''' openmoko-devel@lists.openmoko.org ''''
'''NOTE: This mailing list has been closed. Discussion should continue on devel.'''

This is a public mailing list for discussion of development related to Openmoko in general. The mailing lists framework-devel and openmoko-apps have been merged into this one. Developers who are writing applications using the Openmoko framework should join this.

http://lists.openmoko.org/mailman/listinfo/openmoko-devel

[[Category:Developer resources]]
[[Category:Community]]

Talk:Manuals/SHR

2010-03-01T11:01:51Z

JOERG: /* Rework for 2010 Unstable/Testing images */

This is the infrastructural page of the SHR User Manual.
Decisions of discussions should go here.

===Sources of info===

http://shr-project.org/trac/wiki/Tweaks

http://shr-project.org/trac/wiki/Customize

http://wiki.openmoko.org/wiki/SHR

http://openmoko.opendevice.org/~dos/manual/

===Base ground===

SHR Unstable will be used for this manual.

===Screenshots===

Screenshots should be based on one, default theme: Illume-SHR.

===Questions for discussion===

name of this guide/manual/introduction/howto...

===Manuals standardisation===

Hi! I'm one of the wiki maintainers here. I have recently started an effort to standardise manuals on this wiki - see http://n2.nabble.com/organizing-manuals-on-the-wiki-tp3302919p3302919.html for my posts to the documentation mailing list. I'm planning to create some standards for writing manuals which would become part of the [[Openmoko Wiki Editing Guidelines]]. For the SHR manual implementing those standards would mean that some parts of the section "Installation" would be moved to individual device-manuals. Furthermore this manual would probably be moved to a page like [[Manuals/SHR]]. What do you think about this? I'd appreciate any comments from you. --[[User:Marko Knöbl|Marko Knöbl]] 21:55, 24 July 2009 (UTC)

I am ok with this but let the draft develop here as part of the cofundus project till August 31st --[[User:Rakshat|Rakshat]] 09:18, 27 July 2009 (UTC)

Hi, i am the writer of this page. I have previously already moved the page to Manuals/SHR but i can see that you moved it back. I don't really care about the location as the wiki is only part of the release. --[[User:Vanous|Vanous]] 09:10, 29 July 2009 (UTC)

===Work in progress===

Started adding screenshots and texts. At this point, i don't care about formatting at all. --[[User:Vanous|Vanous]] 09:41, 29 July 2009 (UTC)

Formatted already. Typo corrections welcomed --[[User:Vanous|Vanous]] 10:57, 31 July 2009 (UTC)

Added SHR Settings screenshots, need to be formatted --[[User:Vanous|Vanous]] 13:09, 31 July 2009 (UTC)

The Car Navigation system (Navit) section may be better lower down the Manual, in the application section. --[[User:Rakshat|Rakshat]] 18:27, 8 August 2009 (UTC)

hihi, didn't read your comment but moved it already :))) will move it even further after things get a bit clearer here :)
--[[User:Vanous|Vanous]] 09:37, 9 August 2009 (UTC)

The Navit section will need to be reviewed as SHR-u provides navit (older version i think). For now it's good though. --?

Add two workaround in the navit section (please correct my bad english;-) ).
Update of navit is not possible: remove and reinstall
GPS didn't work without the libgps17, also not the other programs that use GPS (i.e. that one in the settings). --tomix 00:10, 2. September 2009

==Table of contents==

I think that the toc should be on the left for consistency. right alignment is good for rtl language (not english or other western languages)
[[User:Dareus|Dareus]]

:I'd also prefer having the toc on the left side - but I'd rather have the text below it, not floating around it as it was after your edit. --[[User:Marko Knöbl|Marko Knöbl]] 18:23, 10 August 2009 (UTC)

::I would like to get all the subpoints into sections and this will make the content quite long. I haven't found yet how to make the content smaller (limit levels). this will make the content huge, this is why i would like to keep it besides. i am more inclined towards the right side ans it feels more natural, but of here is a consistency issue, we can go left, but at this point floating, please, thank you --[[User:Vanous|Vanous]] 22:48, 10 August 2009 (UTC)

:::OK, I see what you mean now. I think it's alright to leave floating on the right side. --[[User:Marko Knöbl|Marko Knöbl]] 09:25, 13 August 2009 (UTC)

::::Thank you. The content is ok for now but in the future i would like it to be a bit smarter... will see how to do such a thing.... --[[User:Vanous|Vanous]] 22:24, 14 August 2009 (UTC)

== Rework for 2010 Unstable/Testing images ==

i am going to start updating the manual to reflect the latest Testing/Unstable images.
--[[User:Vanous|Vanous]] 16:38, 20 February 2010 (UTC)

Thanks for doing this --[[User:Rakshat|Rakshat]] 20:12, 20 February 2010 (UTC)

Still working on the updates. Considering swapping sections: Settings and Localizing (so Settings would come first, Localizing second). Any preferences anyone? --[[User:Vanous|Vanous]] 18:21, 26 February 2010 (UTC)

Proceeded :) --[[User:Vanous|Vanous]] 22:21, 28 February 2010 (UTC)

Very good you care about this. One remark: the SHR logo image is overlaying the content on right side (konqueror here)
[[User:JOERG|jOERG]] 2010-03-01 12:00

GSM oscillating between registered and not registered aka 1024

2010-01-27T16:46:04Z

JOERG: /* Hardware bug fixing */

This page describes how to enable Calypso GSM modem deep sleep after performing a hardware fix of bug [http://docs.openmoko.org/trac/ticket/1024 #1024] aka recamping or oscillating of the Calypso GSM modem used in Openmoko [[Neo Freerunner]].

==Description==
Hardware bug #1024 creates a condition when the gsm modem is oscillating between registrated / not-registrated. This causes the phone to be unavailable at times. Distribution maintainers have been able to use a software setting to disable suspend of the gsm modem in order to work around this bug. The downside is that with this workaround the modem never sleeps and consumer more energy then needed.

If you decide to undergo a hardware fix of your phone you have to reconfigure your distribution to allow the gsm modem to go to sleep again in order to actually make use of the modem sleep function and therefore extend your battery life.

Bug trac: http://docs.openmoko.org/trac/ticket/1024

==Bug detection==
Not every Freerunner suffers this issue. To check if your phone has the bug #1024 please use this test script:

(This script will only work on FSO based distro. Also, this script is not 100% perfect, another way is to use frameworkd with ti_calypso_sleep_mode = 'adaptive' and inspect the logs. Frameworkd will tell you, when a real recamping exists)

<pre>
#!/usr/bin/python

import dbus
import dbus.glib
import gobject
import datetime

def onNetworkStatus(status ):
print '[%s] Signal : cid=%s, lac=%s' % (datetime.datetime.now(),status['cid'],status['lac'] )

bus = dbus.SystemBus();

bus.add_signal_receiver( onNetworkStatus,
"Status",
"org.freesmartphone.GSM.Network",
"org.freesmartphone.ogsmd",
"/org/freesmartphone/GSM/Device" )

gobject.threads_init()
dbus.glib.init_threads()
main_loop = gobject.MainLoop()
main_loop.run()
</pre>

Run it like this:

root@om-gta02 ~ $ deep-sleep-check.py > dsc.log

If you have something like this:

[2009-09-09 12:36:09.189663] Signal : cid=3BB3, lac=0D48
[2009-09-09 12:36:15.088936] Signal : cid=3BB3, lac=0D48
[2009-09-09 12:38:10.442808] Signal : cid=3BB3, lac=0D48
[2009-09-09 12:38:13.020126] Signal : cid=3BB3, lac=0D48
[2009-09-09 12:40:25.772918] Signal : cid=3BB3, lac=0D48
[2009-09-09 12:40:28.620096] Signal : cid=3BB3, lac=0D48
[2009-09-09 12:41:17.557676] Signal : cid=3BB3, lac=0D48
[2009-09-09 12:41:20.404582] Signal : cid=3BB3, lac=0D48

Then you have the bug (trying to connect to GSM every second). Please note that cid is always the same.

Correct output might not show any messages or look like this:

[2009-10-18 07:51:27.107655] Signal : cid=4E91, lac=006A
[2009-10-18 07:52:45.145288] Signal : cid=4E7B, lac=006A
[2009-10-18 07:53:18.218122] Signal : cid=4E91, lac=006A

You can see the cid changing.

==Bug detection by fso==
Just use frameworkd with ti_calypso_sleep_mode = 'adaptive' and inspect
the logs. Frameworkd will tell you, when a real recamping exists.

==Hardware bug fixing==
To perform the hardware update, please check description here:
http://lists.openmoko.org/pipermail/hardware/2009-May/001192.html
http://www.neofundas.blogspot.com/

[[Image:1024fix.jpg]]

After the fix, please recheck again with the script as above. Under normal circumstances you would only see these messages with a change of cell, so cid would be different.

If your fix was successful you can change setting to allow Calypso deep sleep:

==Enabling/allowing Calypso GSM modem deep sleep==
===FSO based distros (SHR, Debian, OM2009...)===

Edit /etc/frameworkd.conf , it should contain:

ti_calypso_deep_sleep = always

Then restart framework or reboot the phone.

/etc/init.d/frameworkd restart

===QT based distos (Qtopia, QTExtended, QTMoko...)===

Edit /opt/qtmoko/etc/default/Trolltech/Modem.conf , it should contain:

[DeepSleep]
Active=always

And reboot.

===Hackable:1 (rev.5)===

As said in http://lists.hackable1.org/pipermail/hackable1-user/2010-January/000718.html and other discussions:
hackable:1 does not use frameworkd but gsmd.

To enable deep-sleep mode:

-download and install (or extract)
http://build.hackable1.org/debian/dists/wip/main/binary-armel/gsmd_0.0.2+svn1571-1_armel.deb
-edit /etc/default/gsmd and uncomment the "VENDOR=ti-deepsleep" line: this will add a
"-v ti-deepsleep" to the deamon command line.
-Restart gsmd.

===Android===

Currently Android on Freerunner is hard coded to use AT%SLEEP=2 to avoid deep sleep mode entirely; there is a discussion about providing editable property in Androids init.rc startup file.

==See also==
*[[GSM oscillating between registered and not registered]]

[[Category:Neo FreeRunner reworks and mods]]

Battery Questions and Answers

2010-01-21T18:10:11Z

JOERG: added warning about old kernels' MBC re-enable hack

NB: Some of the described behaviour depends on the kernel, the
relevant code was pushed on 02 Aug to andy-tracking. Some older kernel versions may have quite nasty hacks ('reenabling MBC though battery reports full') that seriously wreck your battery within months.

== Battery care and safety guidelines ==

=== How can I break my battery? ===
To successfully kill your LiIon battery without applying brute force, you simply may disobey any of the following advices:

==== Temperature ====
Never expose or let warm up battery to high temperatures. 70°C might be a limit for safe operation, and >100°C most likely is a killer for the cell. This is especially true during charge/discharge.

==== Drop ====
Never let the battery drop on a hard surface or by any other means expose to hard impact.

==== Wrong storage ====
LiIon cells don't like to be kept at any extreme for a prolonged time. So *never* store away your device with battery inserted, for a period longer than a few days. Charge battery to a reasonable level prior to extended periods of no usage.
Do not store battery in charger, as this may cause a permanent charging level of 100% which is as deteriorating to the LiIon cell chemistry as is storage at 0%. Keeping battery in Neo which is powered by external source is safe though, even for months, as the Neo's PMU charger circuit takes care to treat the battery nicely.

Also see [http://wiki.openmoko.org/wiki/Battery_Questions_and_Answers#I_have_several_compatible_batteries._What_are_the_storage_requirements_for_them.3F Storage]

== Hardware capabilities ==

=== What batteries can be used with gta01 and gta02? ===
Original OM gta01, gta02, Nokia [http://europe.nokia.com/find-products/accessories/all-accessories/power/batteries/nokia-battery-bl-5c BL-5C], [http://europe.nokia.com/find-products/accessories/all-accessories/power/batteries/nokia-battery-bl-6c BL-6C] and compatibles.

=== Do other BL-5/6C compatible batteries fit? ===
If the battery is thicker than BL-6C, you won't be able to close
the back cover. Nokia's BL-4C is a bit thinner than the BL-5C so it also fits, but has noticeably shorter battery life.

=== What is the difference between all those types? ===

==== Capacity ====
{|border="1" cellspacing="0" cellpadding="5"
| gta01, gta02 || 1200 mAh
|-
| BL-4C old (new) || 720 (860) mAh
|-
| BL-5C old (newer/new) || 850 (970/1020) mAh
|-
| BL-6C || 1150 mAh
|}

==== Temperature control ====
{|border="1" cellspacing="0" cellpadding="5"
| gta01, BL-5C, BL-6C || thermistor
|-
| gta02 || bq27000
|}

==== Special features ====

gta02 - accurate and sophisticated reporting of capacity,
time_to_full, time_to_empty, temperature and battery current during
both charge and discharge thanks to bq27000 (aka Coloumb Counter)

=== What are hardware capabilities of gta01 and gta02 with regard to battery management? ===

gta01: charging all battery types, measuring temperature with
battery-integrated thermistor (currently charging and measuring
temperature for non-gta01 batteries doesn't work due to the kernel
driver issues but it's software limitation), measuring battery output
voltage, very inaccurate and noisy measuring of battery current

gta02: charging all battery types, measuring battery output voltage,
communicating with bq27000

=== Can nokia phones use/charge gta01/gta02 batteries? ===

gta01 and gta02 batteries will fit wherever BL-6C fits but they
can't be charged in nokia phones unless you isolate the middle pin
from the battery and connect a resistor of ~50k (actual measured value
on a cold (25C) battery is 75k, on a slightly warm battery - 82k) from
it to the ground (to fake a thermistor presence).

=== Can third-party chargers charge gta01/gta02 batteries? ===

The "good" ones will most probably require the same trick needed
for nokia phones. More cheaper ones are more likely to ignore
thermistor absence.

=== I have several compatible batteries. What are the storage requirements for them? ===

Keep in a dry cool place charged to no more than 75%.

=== That bq27000 chip seems to be pretty cool, how can i read and understand its raw registers? ===

[[User:jOERG|DocScrutinizer]] to the rescue! Here's his magic script to do that: [http://people.openmoko.org/joerg/battery/bq27k-detail].

== Safety considerations in detail ==

=== Do OM devices control temperature to stop charging if the battery gets too hot? ===

GTA02 Neo FreeRunner:No; GTA01 Neo 1973:Yes (if PMU PCF50606 Main battery charger is configured correctly)

=== Isn't it dangerous? ===

No, since all batteries (not raw cells!) have an integrated
protection circuits.

=== Can i use that fancy 2800 mAh BL-5C-compatible battery i saw on ebay? ===

Unless you want an explosion in your pocket i wouldn't recommend
using any battery that is not produced by a reputable vendor and
widely tested. And even reputable vendors make mistakes, nokia once
had to recall 46 million batteries manufactured by Matsushita ([http://batteryreplacement.nokia.com/batteryreplacement/en/advisory-2007.html]).

=== You say that BL-5C is compatible with my gta02. Does that mean i can use that BL-5C-compatible bat i bought for a buck from a bum? ===

You bet, go ahead.

== Charging ==

=== My battery charges to 100% but then charging stops and the battery keeps discharging, wtf? ===

LiIon batteries don't like to be kept fully charged, so the charger
stops as soon as charging current becomes less than threshold. If you
have GSM on it will discharge the battery.

=== But why doesn't it ever stop charging on my device? ===

The GSM modem is connected directly to the battery terminals so if
it's active, charger will think it's still charging the battery and
won't turn off unless GSM becomes inactive. The default threshold setting of PMU charger is
about 16mA, the latest [[Qi]] increases the threshold to ~32mA.

Depending on various factors (GPRS activated, number of cells to observe, band...) the modem may consume an average standby current of 4mA up to >30mA while registered to a network. For normal (AT%SLEEP=2) situation the standby current is ~15mA. So *usually* the charge end detection should work.

Anyway even if the above mentioned charge end threshold never is reached, the PMU stops charging of bat after expire of some emergency cutoff timer (some hours)

=== Does it mean if i leave my phone plugged it will eventually fully discharge the battery? ===

On gta02 the charger will restart the charge automatically once the
battery voltage reaches ~4V which corresponds to ~76% (If PMU MBC is configured by kernel to enable auto-resume). Not sure about
gta01, requires more investigation. :-/

=== Ok, how to make sure my battery is fully charged before a long trip? ===

Replug the charger at least 90 minutes before you need full battery, it will trigger charging no matter what the
current capacity is.

=== My power/aux LED indicates charging/discharging/whatever, what does that mean (aka why it's still blue even after i unplugged the charger)? ===

Ask FSO guys about it, some of them think that the user shouldn't
really know what's happening and therefore they do some special
mangling of "status" sysfs node before presenting it to the user. If
you want to make a decent bugreport please add clear steps to
reproduce and
<code>
cat /sys/class/power_supply/battery/uevent
cat /sys/class/i2c-adapter/i2c-0/0-0073/gta01_battery/uevent
</code>
contents for all
relevant states.

== Using compatible batteries with gta02 ==

=== So, how do i use "dumb" batteries with my freerunner? ===

First you need to unbind bq27000 driver:
echo bq27000-battery.0 > /sys/bus/platform/drivers/bq27000-battery/unbind

Then you load the dumb battery driver:
modprobe gta01_battery

If you need to use bq27000 driver again, do:
rmmod gta01_battery
echo bq27000-battery.0 > /sys/bus/platform/drivers/bq27000-battery/bind

If you use Enlightment you might need to restart it after that.

=== Is capacity reported for dumb batteries accurate? ===

During discharge it should be pretty (+-10%) accurate, during
charge the capacity reported is ~20% more than real.

=== Why does /sys/class/power_supply/battery/charge_full says i have a 850 mAh battery no matter what i use? ===

It's a workaround to make popular battery gadgets work with this
driver.

== This Q&A were prepared by ==

[[User:PaulFertser|Paul Fertser]]

[[User:jOERG|Joerg Reisenweber]]

[[Category:Battery]]
[[Category:Neo_FreeRunner_Hardware]]
[[Category:Neo1973_Hardware]]

Talk:Neo Freerunner audio subsystem

2009-12-01T16:41:12Z

JOERG: 2009-12-01

2009-08-03T11:10:14Z

JOERG: /* Automatic way */ basic (most common) use example

== Resource management conception ==

Here goes some introductory text shamelessly borrowed from [http://git.freesmartphone.org/?p=specs.git;a=blob_plain;f=html/usage-intro.html;hb=HEAD FSO specs].

One of the most important aspects of middleware for mobile devices is saving energy. To do this, the system needs to make sure that peripherals are only powered when they are actually in use by at least one application. In order to support multiple concurrent applications, it is not possible to leave peripheral control up to individual applications — otherwise one application could shut down e.g. a GPS receiver, while another application still wants to access it.

FSO introduces the concept of resources. A resource is a high-level entity with a name and a state. The name is used to identify a resource (e.g. WiFi), the state is describing its condition (e.g. enabled). It is important to understand that a resource not necessarily correlates to a peripheral device. Although enabling a resource such as Bluetooth most likely has the consequence of powering up a device, there may as well be more to it, such as launching a low level device handling services or allocating related resources.

== List of FSO resources ==
=== WiFi ===
Unless this resource is enabled you've no eth0 and wifi module is completely unpowered.

=== Display ===
While this resource is kept the display won't be blanked.

=== TEST ===
A test resource

=== Bluetooth ===
You need to have this resource requested to have bluetooth module powered.

=== GSM ===
The same for GSM modem

=== CPU ===
Default rules.yaml checks for this resource to disable automatic suspend when it's requested.

=== GPS ===
Same idea as WiFi/Bluetooth

== Resource management ==
It would be nice to have a command to list the current state of all
resources. Unfortunately, such an utility is yet to be written. See [http://trac.freesmartphone.org/ticket/461].

=== Manual way ===
With the help of SHR Settings or an appropriate mdbus call (example: <code>mdbus -s org.freesmartphone.ousaged /org/freesmartphone/Usage org.freesmartphone.Usage.SetResourcePolicy Bluetooth enabled</code>) you set resource policy to "enabled". Do not forget that way you'll lose power since it will leave the corresponding device powered all the time.

=== Automatic way ===
Use the <code>fsoraw</code> (created per Joerg's request [http://trac.freesmartphone.org/ticket/393]) utility. With it you can automatically request the necessary resource before starting a command and release it when it's finished.

Typical basic use:
fsoraw -r CPU,Display mokomaze
Start a game (or any other app) and avoid auto-suspend and display-blank

Especially recommended for WiFi since due to the bugs in the firmware and the driver full power-cycle of the module is often advantageous.

Example command (works for open, WEP and WPA/WPA2 networks, automatically determining the network it can connect to, just add all the networks you use to the config):
fsoraw -r WiFi -- wpa_supplicant -ieth0 -Dwext -c/etc/wpa_supplicant/wpa_supplicant.conf

Bluetooth scan for nearby devices example:
fsoraw -r Bluetooth -- bash -c "sleep 1; hcitool scan"

[[Category:FSO]]

Neo 1973 audio subsystem

2009-07-15T19:21:53Z

JOERG: /* using phone-internal microphone and speaker */ control#63 fix explanation

In the center of the [[Neo1973]] '''audio subsystem''' is the [[WM8753]] (the "Wolfson Codec"), which implements record (ADCs), playback (DACs), and signal mixing. On the stereo output is the [[LM4857]] amplifier, which drives the stereo speakers, the mono earpiece and the headphones. Sound from and to [[GSM]] is received from and sent to the GSM modem via analog connections. There's a digital mono interface for sound from and to the [[Bluetooth]] chip.

=== ALSA Channels ===
The channel numbers shown here are for the Freerunner, not the 1973.
[[Image:WM8753 ALSA Mapping.png]]
A way more pretty diagram is [http://people.openmoko.org/joerg/ALSA/doc/WM8753_control_diag.pdf here]

Png version with ALSA control names printed over (these are alsa controls like found in statefiles or amixer commands, alsamixer removes trailing "Playback Volume" and such where it sees fit) [http://wiki.openmoko.org/wiki/Image:WM8753_routing_diagram.svg Inkscape source]:
[[Image:WM8753_routing_diagram_alsa_controls.png|1000px]]

:root@om-gta02:~# amixer controls
:numid=1,iface=MIXER,name='PCM Volume'
:numid=2,iface=MIXER,name='ADC Capture Volume'
:numid=3,iface=MIXER,name='Headphone Playback Volume'
:numid=4,iface=MIXER,name='Speaker Playback Volume'
:numid=5,iface=MIXER,name='Mono Playback Volume'
:numid=6,iface=MIXER,name='Bypass Playback Volume'
:numid=7,iface=MIXER,name='Sidetone Playback Volume'
:numid=8,iface=MIXER,name='Voice Playback Volume'
:numid=9,iface=MIXER,name='Headphone Playback ZC Switch'
:numid=10,iface=MIXER,name='Speaker Playback ZC Switch'
:numid=11,iface=MIXER,name='Mono Bypass Playback Volume'
:numid=12,iface=MIXER,name='Mono Sidetone Playback Volume'
:numid=13,iface=MIXER,name='Mono Voice Playback Volume'
:numid=14,iface=MIXER,name='Mono Playback ZC Switch'
:numid=15,iface=MIXER,name='Bass Boost'
:numid=16,iface=MIXER,name='Bass Filter'
:numid=17,iface=MIXER,name='Bass Volume'
:numid=18,iface=MIXER,name='Treble Volume'
:numid=19,iface=MIXER,name='Treble Cut-off'
:numid=20,iface=MIXER,name='Sidetone Capture Volume'
:numid=21,iface=MIXER,name='Voice Sidetone Capture Volume'
:numid=22,iface=MIXER,name='Capture Volume'
:numid=23,iface=MIXER,name='Capture ZC Switch'
:numid=24,iface=MIXER,name='Capture Switch'
:numid=25,iface=MIXER,name='Capture Filter Select'
:numid=26,iface=MIXER,name='Capture Filter Cut-off'
:numid=27,iface=MIXER,name='Capture Filter Switch'
:numid=28,iface=MIXER,name='ALC Capture Target Volume'
:numid=29,iface=MIXER,name='ALC Capture Max Volume'
:numid=30,iface=MIXER,name='ALC Capture Function'
:numid=31,iface=MIXER,name='ALC Capture ZC Switch'
:numid=32,iface=MIXER,name='ALC Capture Hold Time'
:numid=33,iface=MIXER,name='ALC Capture Decay Time'
:numid=34,iface=MIXER,name='ALC Capture Attack Time'
:numid=35,iface=MIXER,name='ALC Capture NG Threshold'
:numid=36,iface=MIXER,name='ALC Capture NG Type'
:numid=37,iface=MIXER,name='ALC Capture NG Switch'
:numid=38,iface=MIXER,name='3D Function'
:numid=39,iface=MIXER,name='3D Upper Cut-off'
:numid=40,iface=MIXER,name='3D Lower Cut-off'
:numid=41,iface=MIXER,name='3D Volume'
:numid=42,iface=MIXER,name='3D Switch'
:numid=43,iface=MIXER,name='Capture 6dB Attenuate'
:numid=44,iface=MIXER,name='Playback 6dB Attenuate'
:numid=45,iface=MIXER,name='De-emphasis'
:numid=46,iface=MIXER,name='Playback Mono Mix'
:numid=47,iface=MIXER,name='Playback Phase'
:numid=48,iface=MIXER,name='Mic2 Capture Volume'
:numid=49,iface=MIXER,name='Mic1 Capture Volume'
:numid=50,iface=MIXER,name='DAI Mode'
:numid=51,iface=MIXER,name='ADC Data Select'
:numid=52,iface=MIXER,name='ROUT2 Phase'
:numid=53,iface=MIXER,name='Mic Selection Mux'
:numid=54,iface=MIXER,name='Rx Mixer'
:numid=55,iface=MIXER,name='Line Mixer'
:numid=56,iface=MIXER,name='Line Mono Mux'
:numid=57,iface=MIXER,name='Line Right Mux'
:numid=58,iface=MIXER,name='Line Left Mux'
:numid=59,iface=MIXER,name='ALC Mixer Line Capture Switch'
:numid=60,iface=MIXER,name='ALC Mixer Mic2 Capture Switch'
:numid=61,iface=MIXER,name='ALC Mixer Mic1 Capture Switch'
:numid=62,iface=MIXER,name='ALC Mixer Rx Capture Switch'
:numid=63,iface=MIXER,name='Mic Sidetone Mux'
:numid=64,iface=MIXER,name='Capture Right Mux'
:numid=65,iface=MIXER,name='Capture Left Mux'
:numid=66,iface=MIXER,name='Capture Right Mixer'
:numid=67,iface=MIXER,name='Capture Left Mixer'
:numid=68,iface=MIXER,name='Playback Mixer Voice Capture Sw'
:numid=69,iface=MIXER,name='Playback Mixer Left Capture Swi'
:numid=70,iface=MIXER,name='Playback Mixer Right Capture Sw'
:numid=71,iface=MIXER,name='Out4 Mux'
:numid=72,iface=MIXER,name='Out3 Mux'
:numid=73,iface=MIXER,name='Mono 2 Mux'
:numid=74,iface=MIXER,name='Mono Mixer Left Playback Switch'
:numid=75,iface=MIXER,name='Mono Mixer Right Playback Switc'
:numid=76,iface=MIXER,name='Mono Mixer Voice Playback Switc'
:numid=77,iface=MIXER,name='Mono Mixer Sidetone Playback Sw'
:numid=78,iface=MIXER,name='Mono Mixer Bypass Playback Swit'
:numid=79,iface=MIXER,name='Right Mixer Voice Playback Swit'
:numid=80,iface=MIXER,name='Right Mixer Sidetone Playback S'
:numid=81,iface=MIXER,name='Right Mixer Right Playback Swit'
:numid=82,iface=MIXER,name='Right Mixer Bypass Playback Swi'
:numid=83,iface=MIXER,name='Left Mixer Voice Playback Switc'
:numid=84,iface=MIXER,name='Left Mixer Sidetone Playback Sw'
:numid=85,iface=MIXER,name='Left Mixer Left Playback Switch'
:numid=86,iface=MIXER,name='Left Mixer Bypass Playback Swit'
:numid=87,iface=MIXER,name='DAPM Stereo Out Switch'
:numid=88,iface=MIXER,name='DAPM GSM Line Out Switch'
:numid=89,iface=MIXER,name='DAPM GSM Line In Switch'
:numid=90,iface=MIXER,name='DAPM Headset Mic Switch'
:numid=91,iface=MIXER,name='DAPM Handset Mic Switch'
:numid=92,iface=MIXER,name='DAPM Handset Spk Switch'
:numid=93,iface=MIXER,name='Amp State Switch'
:numid=94,iface=MIXER,name='Amp Spk Switch'

Four variants of using available Digital Audio Interfaces and DACs/ADC, these correspond to the "DAI Mode" ALSA control values:

[[Image:wolfson_dai_routing.png|800px]]

Keep in mind: left interface (VXxxx) is connected to BlueTooth, right interface (LRC, BCLK, xxxDAT) is connected to SoC (CPU).
So mode "11" at least seems isn't useful at all for the way Neo HW is built. Mode "10" is suited for (Stereo/mono) output and recording for digital world, whereas Mode "00" is needed for GSM<->BT operation (calls via BT-headset) only.

BT-VoIP-calls and BT-stereo-headphones playback are done via direct USB-connection SoC<->BT in a very usual standard-linux-way, and therefor need no statefile or any other setup of mixer.

We are still wondering what use Mode "01" might have, other than analog mixed mono output (which could as well be done at digital side by feeding L/R with same data)

*--[[User:MMlosh|MMlosh]] 10:15, 5 April 2009 (GMT) Mono signal has separate volume control for stereo (control #8) and mono (control #13) output. This might be useful when mixing PCM (VoIP call / music) output into GSM call and playing it locally (and you can still have different volume levels)

=== Phase0 Quick Start ===

In my experience this works but I have to fiddle with the connection a bit before I get stereo output. The audio also comes out both the speaker and headphones.

alsactl -f /etc/stereoout.state restore
madplay myfavoritesong.mp3

Another simple test (assuming you have [[USB_Networking|USB Networking]] configured) is to listen to a radio stream:

wget -O - http://radioparadise.steadyhost.com:8050 | madplay -

If for some reason you're missing stereoout.state, try getting a similar copy (a couple of volume levels are different is all)

wget http://opensource.wolfsonmicro.com/~gg/neo1973/stereoout.state

=== Voice Calls ===

==== using phone-internal microphone and speaker ====

Actually the diagram below is incorrect (complexity and noise introduced by needless detour for red mic-path, via ACOP ACIN LPGA, should be direct PreAmp MICMUX [control63="Mic 2"] Marked *) below). See http://people.openmoko.org/joerg/ALSA/doc/WM8753_control_diag_gsmhandset_mic_std.png

[[Image:WM8753 BlockDiagram GSM handset.png]]

This is the default case.

* microphone path
** input: built in microphone attached to wolfson MIC2/MIC2N
** routed from wolfson MIC2/MIC2N to MONO1/MONO2
** arrives at GSM Modem input MICIP/MICIN
* speaker path
** input: GSM Modem attached to wolfson RXN/RXP
** routed from wolfson RXN/RXP to ROUT1/LOUT1
** arrives on LM4857 RIN/LIN
** routed on LM4856 to EP+/EP-

===== Internal Codec Route =====

Neo Mode is GSM Handset
Amp Mode is Call Speaker

* audio path Mic -> GSM
** MIC2/MIC2N
** Mic2 Volume
** ALC Micer Mic2 *)
** Left PGA *)
** Mic Sidetone Mux [Left PGA *)"Mic 2"]
** Mono Sidetone Volume
** Mono Mixer Sidetone Playback Switch
** Mono Volume
** Mono 2 Mux [Inverted Mono 1]

* audio path GSM -> Speaker
** RXP/RXN
** Rx Mixer [RXP - RXN]
** Line Left Mux [Rx Mix]/Line Right Mux [Rx Mix]
** Left Mixer Bypass Playback Switch/Right Mixer Bypass Playback Switch
** Headphone Volume

===== Driver Status =====

This should be supported by ASoC 0.13rc3 (-moko7 kernel) on.

ASoC 0.13.3 should have same functionality but has renamed the soundcard to neo1973.

===== asound.state =====

https://people.openmoko.org/laforge/gta01/gta01b_v2/alsa/gsmhandset.state

For ASoC 0.13.3 http://opensource.wolfsonmicro.com/~gg/neo1973/gsmhandset.state

==== using analog (4pin 2.5mm) headset ====

This is also a quite common case, since we ship the headset with the
phone

Headset Detection is done via GPIO on S3C2410

* microphone path
** input: headset mic vial HS_MIC attached to wolfson MIC1
** routed from wolfson MIC1 to MONO1/MONO2
** arrives at GSM Modem input MICIP/MICIN
* speaker path
** input: GSM Modem attached to wolfson RXN/RXP
** routed from wolfson RXN/RXP to ROUT1/LOUT1
** arrives on LM4857 RIN/LIN
** routed on LM4856 to LHP/RHP

===== Internal Codec Route =====

Neo Mode is GSM Headset
Amp Mode is Headphones

* audio path Mic -> GSM
** MIC1
** Mic Selection Mux [Mic 1]
** ALC Mixer Mic1
** Left PGA
** Mic Sidetone Mux [Left PGA]
** Mono Sidetone Volume
** Mono Mixer Sidetone Playback Switch
** Mono Volume
** Mono 2 Mux [Inverted Mono 1]

* Audio path GSM -> Headphones
** RXP/RXN
** Rx Mixer [RXP - RXN]
** Line Left Mux [Rx Mix]/Line Right Mux [Rx Mix]
** Left Mixer Bypass Playback Switch/Right Mixer Bypass Playback Switch
** Headphone Volume

===== Driver Status =====

Supported in ASoC 0.13.3

===== asound.state =====

http://opensource.wolfsonmicro.com/~gg/neo1973/gsmheadset.state

==== using Bluetooth headset with GSM ====

NOTE none of this works with GTA02. Neo mode has disappeared, and none of the state files are GTA02 compatible.

[[Image:WM8753 BlockDiagram GSM Bluetooth.png]]

Headset detection via software

* microphone path
** input: from bluetooth via PCM interface to wolfson
** wolfson: DAC
** wolfson routes analog signal to MONO1/MONO2
** arrives at GSM Modem input MICIP/MICIN
* speaker path
** input: GSM Modem attached to wolfson RXN/RXP
** wolfson: ADC
** wolfson: routes digital signal to PCM
** arrives on bluetooth chip via PCM

===== Internal Codec Route =====

Neo Mode is GSM Bluetooth
Amp Mode is Off

* audio path BT -> GSM
** Vx DAC
** Mono Voice Volume
** Mono Mixer Voice Playback Switch
** Mono Volume
** Mono 2 Mux [Inverted Mono 1]

* audio path GSM -> BT
** RXP/RXN
** Rx Mixer [RXP - RXN]
** ALC Mixer Rx
** Left PGA
** Capture Mixer Mux [PGA]
** Capture Left Mixer [Analogue Mix Left]
** Left ADC

===== Driver Status =====

Should be support by ASoC 0.13.3

Example of how to setup PCM->BT link.

http://opensource.wolfsonmicro.com/~gg/bluetooth-pcm/bluetooth_pcm.c

===== asound.state =====

http://opensource.wolfsonmicro.com/~gg/neo1973/gsmbluetooth.state

NOTE this will not work with GTA02, as the control numbers have changed
Here [http://wiki.openmoko.org/images/6/64/Gsmbluetooth_gta02.state.txt] is a modified version that is GTA02 compatible,
But lacks the Neo Mode settings which disappeared on GTA02, and does not seem to work.

The state file above does not work for me. I created one [http://handheldshell.com/gsm_headset.txt gsm_headset.txt] that is working for audio playback on the freerunner. I will be updating that file as I get the mic routing working.

To use this state file there are a number of steps

Turn on bluetooth

Pair the headset ( this only needs to be done once ).

Start the audio subsystem and connect the headset http://wiki.bluez.org/wiki/HOWTO/AudioDevices or use my script [http://handheldshell.com/BtHeadset.py BtHeadset.py]

If you don't hear static in your headset at this point you may need to reboot.

Start the phone call

alsactl restore 0 -f [http://handheldshell.com/gsm_headset.txt gsm_headset.txt]

[http://handheldshell.com/bluetooth_pcm bluetooth_pcm]

I wrote a script to stop the headset too [http://handheldshell.com/BtAttach.py BtHeadsetDetach.py]

The above did not work for me; for some reason, the hifi DAC interface must be exercised once before playing. I have hacked BtHeadset.py to make [http://www.robsims.com/FR-BTAudio FR-BTAudio]. When paired with [http://www.robsims.com/GSMBLUETOOTH.txt GSMBLUETOOTH.txt] I get 2-way high quality audio.

I did a lot of this debugging using [http://www.robsims.com/w8753_dump w8753_dump] which is a quick and dirty hack, but quite useful on a large text window.

=== Bluetooth headset with system audio ===

For example, using a voip app on the phone with a bt voice headset. This would also be a good way to work on the bluetooth driver without requiring a working GSM and placing a lot of calls.

See ticket 583 for a state file that should route system audio *out* to the headset. The codec does not allow for duplex system audio connected to a headset, so audio in is still using the mic.

NOTE the state file specified does not work for GTA02, and even when modified to be GTA02 compatible still does not route system sound to a BT headset. Modified state file for GTA02 is here
[http://wiki.openmoko.org/images/3/3d/Btcpu_gta02.state.txt]

=== Multimedia ===

==== sound playback to speakers ====

This is an important mode since it is also required for ringtone
playback

* speaker path
** input: from S3C2410 via IIS interface to wolfson
** wolfson: DAC
** wolfson: route to ROUT1/LOUT1
** LM4857: arrives on RIN/LIN
** LM4857: route to LLS+-/RLS+-

===== Driver Status =====

This is working since ASoC 0.13rc2 (-moko6 kernel)

This should also work on ASoC 0.13.3

===== asound.state =====

https://people.openmoko.org/laforge/gta01/gta01b_v2/alsa/stereoout.state

For ASoC 0.13.3 http://opensource.wolfsonmicro.com/~gg/neo1973/stereoout.state

==== sound playback to headphone ====

* speaker path
** input: from S3C2410 via IIS interface to wolfson
** wolfson: DAC
** wolfson: route to ROUT1/LOUT1
** LM4857: arrives on RIN/LIN
** routed on LM4856 to LHP/RHP

===== Driver Status =====

This is working since ASoC 0.13rc2 (-moko6 kernel)

==== sound playback via A2DP ====

One way to do this is to use a pulse plugin for bluetooth audio. Pulse would be routed either to the plugin or the default route to the codec. The plugin would watch for headset connect/disconnect events generated by a bluez audio daemon to keep the list of available output devices current.

===== Driver Status =====

There is early work on the bluez daemon to handle this. It has been combined with an alsa plugin in the bluez tree but the alsa plugin probably will not be sufficient for neo.

==== voice recording ====

This is mainly used to record notes

* microphone path
** can be from built-in mic
** or from headset
** or bluetooth headset

===== Driver Status =====

UNKNOWN

[http://wiki.openmoko.org/wiki/User:Herp http://wiki.openmoko.org/wiki/User:Herp]

[http://wildsau.enemy.org/~moko/voice-recording.state http://wildsau.enemy.org/~moko/voice-recording.state]

=== Call recording ===

This is a nice wishlist item. The user should be able to receive the
full-duplex audio from the wolfson codec, and record it using the
S3C2410 IIS.

==== recording ====

It is possible to do PCM recording of a GSM voice call. In fact, it is even possible to record the local microphone (what you speak) and the remote voice (what is spoken on the other end of the call) to separate channels (L and R of the Stereo ADC).

If you want to record a GSM voice call, please adjust your mixer settings as follows
# Capture Left Mux: ''Line or RXP-RXN''
#* this routes the analog voice from the GSM modem to the left DAC channel
# Capture Right Mux: ''PGA''
#* this routes the microphone input to the right DAC channel

FIXME: test this. There's currently a ASoC kernel driver bug preventing audio capture from working at all.

===== Driver Status =====

UNKNOWN

==== playback ====

If you want to play PCM audio into a GSM call (i.e. make your remote partner of a voice call hear your PCM audio, e.g. your mp3 or ogg files.

If you are inside a voice call (e.g. FSO/zhone), open amixer or load a state file with alsactl and change the following mixer controls:
# Mono Mixer Left
#* this enables audio routing from the Stereo DAC left channel to the Mono Out (GSM Modem)
# Mono Mixer Right Playback Switch
#* this enables audio routing from the Stereo DAC right channel to the Mono Out (GSM Modem)
# PCM Level
#* adjust the PCM Level up to the desired playback volume

===== Driver Status =====

UNKNOWN

==== Recording and Playback .state ====
Here is a state file that allows both recording and playback from and to a gsm call. 
File: [[Image:Callrec.txt]]

To record just issue:

arecord -D hw:0,0 -r 8000 -f S16_LE -c 2 record.wav

and to inject sound just issue:

aplay -D hw:0,0 record.wav

If you have any problems you can contact me on IRC, TAsn.

P.S
There's a bug concerning the Right and Left mux, you have to change the left after you change the right, loading the state file may cause this issue to show, so just in case, I recommend appending:

amixer sset 'Capture Right Mux' 'Line or RXP-RXN'

amixer sset 'Capture Left Mux' 'Line or RXP-RXN'

to the alsactl -f Callrec.txt restore command.

==== Recording and maintaining a call .state ====
For the actual recording:
arecord -D hw:0,0 -r 8000 -f S16_LE -c 2 record.wav

please note that this is the state file I wrote for my [[Call Recorder]], so if you need anything you might miss here, just go and check it's source.

The actual state for gsmhandset (gsmhandset.state):
[[Image:callrec-gsmhandset.txt]]

A patch (diff gsmhandset.txt callrec-gsmhandset.txt) to apply on every state file, including gsmheadset.state and gsmspeakerout.state.
[[Image:callrec-gsmhandset-patch.txt]]

== Userspace Sound Control Daemon ==

The userspace sound control deamon might be a separate process or (more likely) part of some larger general hardware management daemon.

It will provide the following features:

=== audio playback ===

In order to provide the desired functionality, the daemon first needs to be capable of doing audio playback.

* supported formats
** mp3 (libmad)
** ogg/vorbis (libtremor)
** mod (mikmod)
** sid (sidplay)
* supported functionality
** start and stop playback
** interrupt previous sound to play new sound
** enqueue new sound at end of previous sound
** smooth fade-in/fade-out

=== audio event management ===
* manage a set of events (basically just a name for each event)
* manage a set of audio themes
** each theme contains list of event->audio_file_name mappings
** themes stored/managed via gconf
* manage event sources
** built-in event sources, e.g. touchscreen/button press
** external event sources (e.g. gsmd, dbus, ...)

=== audio scenario management ===
* e.g. dialer or even gsmd can request audio subsystem to switch to voicecall mode
* this mainly affects codec/amplifier analog audio routing
* integrated with bluetooth in case of BT headset or A2DP use
* How is this management performed currently?

== Important issues/pitfalls ==

=== Ringtone while headset playback ===

If the user is listening to music on the headset, we want to mix the
ring tones only into the headset audio, as we must not interrupt and play it on the speaker. Reason: headset can't be switched off during playback via speaker, so to avoid extremely loud headset playback there must NOT be any speaker playback while headset is inserted.

In expression: loading speakerout.state is deprecated while JACK_INSERT is asserted.

[[Category:Neo1973 Hardware]]
[[Category:Audio]]

Neo Freerunner audio subsystem

2009-06-24T15:50:47Z

JOERG: /* Alsamixer channel controls */

Neo 1973 hardware

2009-06-21T12:22:25Z

JOERG: /* Main components */ table needs further structuring - TBD

{{Neo1973}}

Openmoko is a software distribution stack that sits on top of a [[hardware]] platform. The [[Neo1973]] phone is the first hardware platform to take advantage of Openmoko. You can find specifics of the [[:Category:Neo1973 Hardware | Neo1973 Hardware]] by reviewing this introduction page and the pages in the category as shown at the bottom of this page.

'''Note that this page is about the first Openmoko phone which is now discontinued. See details on the second Openmoko phone at this page - [[Neo FreeRunner GTA02 Hardware]].'''

[[Image:Gta01b v3 top.jpg|thumb|400px|display (top) side]]
[[Image:Gta01b v3 bottom.jpg|thumb|400px|component (back) side]]

==User experiences of Phase 0 hardware==
[[Wishlist:Neo1973_P0_Review]]

==User reports of robustness==
User experiences - drops onto concrete - ... [[Neo1973 Robustness]]

== Physical Dimensions ==
* 120.7 x 62 x 18.5 mm (4.75 x 2.44 x 0.728 inch)
* 184 +/- 5 g (6.5 ounces)
* For the purposes of acquiring/cutting a properly sized screen protector, the display hole of the case is about 45 x 59 mm, while the top cover internal frame can house up to a 53 x 74 mm protector; sizes much larger than the display hole would obviously necessitate removing the front cover for installation.
* A Useful size comparison between the Neo1973, iPhone, Motorola A1200 and the SEM600i can be seen at [http://www.sizeasy.com/page/size_comparison/5512-Neo1973-vs-Apple-iPhone-vs-M600i-2-vs-A-1200 sizeasy]

== Main components ==

{|
|-
! style="width:250px" | Component
! Chip or Info
|-
| ''' Main Components '''
|
|-
| Processor
| [[Samsung S3C2410]]
|-
| NAND-Flash
| 64MB into [[Samsung K9F1208U0B]]
|-
| SDRAM
| 128MB from the 2 [[Samsung K4M511633C]]
|-
| [[GSM]]/[[GPRS]]
| Texas Instruments Calypso based, probably [[TI Calypso D751992AZHH]]
|-
| [[GPS]]/[[AGPS]]
| [[Hammerhead PMB 2520]].
|-
| microSD-Card
| Supported throught the [[Samsung_S3C2410]]
|-
| LCD
|
|-
|    LCD Module (LCM)
| [[TPO TD028TTEC1]] module
|-
| style='vertical-align:top' |    Touch Screen
| More info, see [[TPO TD028TTEC1]]
|-
| Stylus
| Seemingly identical to [http://cgi.ebay.com/4in1-PDA-Stylus-LED-Light-Torch-Laser-Pointer-Pen-h7_W0QQitemZ280089656134QQihZ018QQcategoryZ48677QQrdZ1QQcmdZViewItem this one on ebay]
|-
| Bluetooth
|
|-
|    Bluetooth module
| [[Delta DFBM-CS320 Class2 Module]]
|-
| Bluetooth Headset
| This one is wired via PCM bus from the CSR Bluetooth chip to the Wolfson codec.
|-
| style='vertical-align:top' | Vibrator
|
* Driver: https://svn.openmoko.org/trunk/src/target/kernel/patches/gta01-vibrator.patch
* Connected to: S3C2410 GPIO
* Controllable via /sys/class/leds/gta01:vibrator
|-
| USB Host
| inside the [[Samsung S3C2410]]
|-
| USB Device
| inside the [[Samsung S3C2410]]
|-
| style='vertical-align:top' | I2C Devices
| The I2C is a simple communication standard intended to move small amounts of data a few inches between chips.
Please see [[I2C | Neo I2C Devices]] for more information & a list of devices & the addresses currently in use & documented for the Neo1973.
|-
| Audio
| See also: [[Neo1973 Audio Subsystem]]
|-
|    Wolfson Codec
| [[WM8753]]
|-
|    Stereo Amplifier
| [[LM4857]]
|-
|    Analog wired Headset
| [[Analog wired Headset]]
|-
| [[Neo_1973_GTA01_Power_Management|Power Management]]
| [[Philips PCF50606]]
|-
| Battery
| [[Neo1973 Battery]]
|-
| style='vertical-align:top' | Buttons
|
* [[Neo1973 Power Button|The Power Button]]
* [[Neo1973 AUX Button|The "Aux" button]]
|-
| Case
| [[Neo1973 case schematics]]
|}



== Alternate cases ==
A number of alternate case designs have been suggested and requested.
[[Alternate Neo1973 case designs]]

== Hardware revisions==
{{Main|GTA01 revisions}}

===Debug Connector===
{{Main|Debug Board v2}}

===Test points===

* GSM RTS - H-TP1531
* GSM CTS - H-TP1530
* GSM Modem on - R10818 - ungrounded end
* GSM_EN - R1501 (not present) - ungrounded end

== Distinguishing hardware revisions ==
=== Inside the [[Bootloader]] ===
Every hardware revision has its own u-boot image type. Thus, the bootloader has the revision hard-coded.
The hardware revision is passed on to the kernel via the ATAG mechanism (ATAG_REVISION)

=== Inside the [[Kernel]] ===
The kernel receives the ATAG_REVISION during bootup, and saves its contents in the "system_rev" global variable.

=== From Userspace ===
The kernel exports the system_rev variable in /proc/cpuinfo as "Revision :" line.

??? So does GTA01Bv4 equal the cat /proc/cpuinfo output of
Hardware : GTA01
Revision : 0240

== Approval ==
*CE compliance is needed before a product can be sold in the EU. The CE mark indicates that a product complies to the relevant legislation, defined in the [http://ec.europa.eu/enterprise/newapproach/standardization/harmstds/reflist.html harmonised standards]. This refers also to the most relevant, for the Neo1973, [http://ec.europa.eu/enterprise/newapproach/standardization/harmstds/reflist/emc.html Directive 89/336/EEC on electromagnetic compatibility] (EMC is the art of assuring [http://en.wikipedia.org/wiki/Electromagnetic_compatibility electromagnetic compatibility] between products). The standards are defined by [http://www.cenelec.org CENELEC] (European Committee for Electrotechnical Standardization), but not verified by any authority. It is the responsibilty of the manufacturer to convince himself that a product is in compliance, and is obligated to be able to prove this (with relevant technical documentation) for a specific product to the authorities on request. Whether the current Phase 1 devices are actually tested against the directives are unknown, no documentation has been disclosed, other than the fact that the devices bear the CE mark.

*[http://www.fcc.gov/ FCC]

===GTA01 FCC test report===

[http://people.openmoko.org/tony_tu/GTA01/certificate/FCC/ FCC test report]

===GTA01 CE test report===

[http://people.openmoko.org/tony_tu/GTA01/certificate/CE/ CE test report]

===GTA01 NCC test report===

For Taiwan Import usage:

[http://people.openmoko.org/tony_tu/GTA01/certificate/NCC/ NCC test report]

[[Category:Neo1973 Hardware]]

Getting Started with your Neo FreeRunner

2009-06-17T00:27:22Z

JOERG: /* Installing the Micro-SD card, the SIM card, and the Battery */ sd-handle

{{Languages|Getting Started with your Neo FreeRunner}}

{| class="wikitable" cellspacing="2" cellpadding="2" style="padding: 0%; margin:0em 0em 1em 0em; background:#eeeeee; width:100%;floating="center"; "
! style="background:#fcfcfc; width:75% " |

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#Getting_Started_with_your_Neo_FreeRunner|FAQ]].


! style="background:#fcfcfc; width:25% " |
[[Image:Freerunner box.png|200px|thumb|Neo FreeRunner Package]]
|}
{{Neo FreeRunner Menu}}

== Package Contents ==

[[Image:Openmokset.jpg|left|400px|thumb|Inside the package]]
 
: [[Image:Circle２.gif|10px]] Neo FreeRunner
: [[Image:Circle２.gif|10px]] Stylus
: [[Image:Circle２.gif|10px]] Battery
: [[Image:Circle２.gif|10px]] Charger
: [[Image:Circle２.gif|10px]] USB Cable (A -> Mini-B 5-pole)
: [[Image:Circle２.gif|10px]] [[Thank You green card]]
<div style="clear: both"> </div>

{{Note|
== Get the source code ==
The software included in this product contains copyrighted software that is licensed under the [http://downloads.openmoko.org/sources/Om2008.9-Lite.iso GPL]. A complete corresponding source code or CD-ROM ISO image with the GPL license is available for download [http://downloads.openmoko.org/sources/Om2008.9-Lite.iso here]. You may also obtain the same corresponding CD-ROM by sending a money order or check for $10 to any one of our [http://downloads.openmoko.org/sources/Om2008.9-Lite.iso 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 ===

[[Image:Circle２.gif|10px]] 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.

<table width="80%" style="clear: both; border: 1px solid #ffffff; border-collapse: collapse; padding: 0.2em; margin: 0; font-size: 100%; margin: 0 1px;">
<tr valign="top" style="background: #ffffff">
<td style="width: 50%; white-space: nowrap; padding: 4px 1em 0 0.5em; border-right: 1px solid #ffffff;">[[Image:menu13.jpg|233px|thumb|Open the case like this.|center]]</td>
<td style="padding: 1px 1em 0; background: #ffffff;">[[Image:menu14.jpg|250px|thumb|Opening !|center]]</td>
</tr>
</table>

[[Image:Circle２.gif|10px]] Now you should be able to locate the combined SIM and Micro-SD card holder at the bottom of the battery compartment.

[[Image:Circle２.gif|10px]] 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.

[[Image:menu11.jpg|260px|thumb|Put the SIM card and SD card here.|center]]

[[Image:Circle２.gif|10px]] Lift up on the SIM card holder.

[[Image:Circle２.gif|10px]] 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 [http://people.openmoko.org/joerg/sdcard-handle/ this photo footage] for a simple yet handy little hack involving some scotchtape, to make your life easier.

[[Image:Circle２.gif|10px]] 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.

[[Image:Circle２.gif|10px]] Close the Micro-SD card holder, making sure that both latches of the holder are securely fastened.

[[Image:Circle２.gif|10px]] 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.

[[Image:Circle２.gif|10px]] Close the SIM card holder and lock it by sliding the metal clip towards the external GPS Antenna Socket on the FreeRunner.
<table width="80%" style="clear: both; border: 1px solid #ffffff; border-collapse: collapse; padding: 0.2em; margin: 0; font-size: 100%; margin: 0 1px;">
<tr valign="top" style="background: #ffffff">
<td style="width: 50%; white-space: nowrap; padding: 4px 1em 0 0.5em; border-right: 1px solid #ffffff;">
[[Image:FR_SIM_SD_open.jpg|457px|thumb|SIM and SD holders open, with cards in place|center]]</td>
<td style="padding: 1px 1em 0; background: #ffffff;">
[[Image:Engchang.jpg|392px|thumb|Some models look like this, the little blob is not a defect|center]]</td>
</tr>
</table>

[[Image:Circle２.gif|10px]] 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.

[[Image:Circle２.gif|10px]] Replace the rear cover on the FreeRunner.

{| class="wikitable" style="background#00CC00;border-left:1px solid white;border-right:1px solid white;border-top:0px solid white; border:1px solid #00CC00; float:right; margin: 0 0 1em 1em;"
! style="background:#00cc00;border-left:1px solid white;border-right:5px solid white;border-top:0px solid white; border:1px solid #00CC00;" |Tips
|-
!style="background:#ffffff;border-left:1px solid white;border-right:1px solid white;border-top:0px solid white; border:1px solid #FFFFff;" |
<div align=left>
[http://video.google.de/videoplay?docid=-8343770443102960945 A short video] is also available. It was shot using the previous version of the Neo, but the installation procedure remains the same.
</div>

|}

===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|Neo FreeRunner Hardware Issues]] about not allowing the battery to discharge completely.}}

===Buttons and connectors===

<table width="80%" style="clear: both; border-collapse: collapse" valign="top">
<tr>
<td style="width: 25px"> </td>
<td style="width: 370px">[[Image:menu9.jpg|370px|thumb|Power Button, USB and external GPS Antenna (left to right)|center]]</td>
<td style="width: 25px"> </td>
<td style="width: 370px">[[Image:menu8.jpg|370px|thumb|AUX Button and headset jack (left to right)|center]]</td>
</tr>
<tr>
<td></td>
<td>'''Power'''
Tapping the power button suspends the GTA02.

Holding the power button shutsdown the device.</td>
<td></td>
<td>'''Aux'''
Tapping or holding the Aux button locks the screen.
</td>
</tr>
</table>

'''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

* remember your date code, the bottom of your shipping box should have a sticker stating it.
* read [[Finding_hardware_revision]]

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]]).

== Image Issue==

Because the software changes so rapidly and the phones were imaged during mass production, we don't ship the newest image with phones.
There are two different kinds of images shipped with the phones:

1. [[Om 2007.2]]

2. [[Om 2008.9]]

But according to the [[FAQ]] and [[Distributions]] pages, all phones ship with [[Om 2007.2]]. This distribution is no longer supported, so before even getting your feet wet, you'll probably want to switch to something else, especially since the FreeRunner is not really usable as a mobile phone with these old distributions.

Switching to another distribution is easy if you have a computer with a USB port and internet connectivity that can run the dfu-util utility. Most current Linux distros have packaged dfu-util, so if you use Linux you can probably just get it from your distro's repository. The next step is to choose which Openmoko distribution to switch to. See [[Distributions]] for information about the alternatives.

That page will point you to the files to download, and to the instructions for installing them using dfu-util.

==For Om 2007.2==

Please notice it is strongly recommended to update to any recent distro (probably the first thing you should do with your FR after some hours of drooling and playing), as the info herein is completely out of date, as is the software this is about.
See [http://wiki.openmoko.org/wiki/Distributions#SHR_-_Stable_Hybrid_Release Distributions]

===Navigating menus and applications===
====Today Page====

[[Image:Todaypage_reduced_true.png|200px|right]] Openmoko starts by displaying the "Today" page, which is your home page. Icons in the top row indicate the status of the phone. The bottom row consists of three tabs. The tab with a house on the left leads to the "Today" page you're viewing now. The central tab leads to the "Launch Task" page, which is the main menu used to start applications. The tab with gears on the right leads to the "Running Tasks" page, which is used to deal with currently open windows and applications.

 

[[Image:Todaypage_reduced_false.png|right|200px|]] The "Today" page is empty, as shown above, when you first start Openmoko. We explain below how to turn on the "full view", displayed to the right. In the full view, a second row of icons give quick links to commonly-used applications such as the dialer, the adressbook, mailbox and calendar. The main body of the screen displays a clock and other useful information.

See [[Today/2007.2]] for more information about the Today page and customization.

 

====Launch Task Page====

{{stub}}

[[Image:LaunchTasks.png|right|200px]] This page displays a menu of available applications. You may choose a category of applications to display to simplify the screen, or choose to display them all.

Current categories are [PIM Suite], [[Om_2007.2_Applications|Applications]], [[Games/Om 2007.2|Games]], Utilities, and All.

 

====Running Tasks Page====

{{stub}}

[[Image:RunningTasks.png|right|200px]] This page displays currently-running tasks. Any individual task may be terminated by selecting it and then clicking on the garbage-can icon to close it. All tasks may be terminated by clicking on any one of them and then clicking on the "folder" icon in the upper right (expect this to change in future releases). Any task may be rejoined by selecting it and then selecting the "return" icon at the middle top.

 

====Exiting from and switching to an Application====

Any time an application is running, you can simply click the device's power button and the application will exit, returning you to the Today page.

Alternatively, you can cycle through active applications using the AUX button

Clicking the top-left of the screen displays the drop down ''task menu''. This menu lists all active applications and allows to switch directly to any one. ''Note:'' If the task menu is not shown, click and hold the [[#Aux|Aux]] button to bring up the Aux menu, and select "Toggle Fullscreen".

=== Using the terminal ===

To start a console from "Today" page, click the middle tab at the bottom of the screen to display the "Launch applications" page, then select Terminal in the "Applications" submenu. The multitaps keyboard slides up (and down) from the bottom of the screen automatically when you touch the screen.

====Setting date and time====

From the terminal, type the following, but replace ''MM'' with the month (01-12); ''DD'' with the day (01-31); ''hhmm'' with the time (0000-2359); ''YYYY'' with the year (optional); and ''.ss'' with the seconds (optional).

date -s ''MMDDhhmmYYYY.ss''

To make the change persist between reboots, sync the hardware clock with the updated system time.

hwclock --systohc

See [[Setting Date and Time]] for more discussion, including synchronizing with an NTP server.

Note: UNIX traditionally sets the system clock to GMT (UTC) or "Zulu" (Z time zone). So I use the stanza:
date -u MMDDhhmmYYYY.ss (well, I usually ignore the seconds)
Then I can set the local time using the techniques described elsewhere. iceworm

==== Accessing the microSD card ====

Mounted at /media/card by default.
<pre>
　mount /media/card
</pre>
If you have multiple partitions on the card, the first (/dev/mmcblk0p1) will be mounted at /media/card, the second at /media/mmcblk0p2, the third at /media/mmcblk0p3 etc. To setup the package management to write on the microSD card when installing new software follow the [[Package_management | package management guide]].

fox example :
<pre>
Filesystem 1k-blocks Used Available Use% Mounted on
rootfs 252544 153560 98984 61% /
/dev/root 252544 153560 98984 61% /
/dev/root 252544 153560 98984 61% /dev/.static/dev
udev 2048 76 1972 4% /dev
/dev/mmcblk0p1 3362 1794 1568 53% /media/card
/dev/mmcblk0p2 476382 157368 294419 35% /media/mmcblk0p2
tmpfs 61928 380 61548 1% /var/volatile
tmpfs 61928 0 61928 0% /dev/shm
</pre>

== For Om 2008.12 ==

=== Entering the SIM PIN ===

Some SIM cards require a PIN code to be entered. If your SIM card is like this, you will see a screen like this after the FreeRunner boots:
[[Image:Enterpin.jpg|center]]
The keypad in the lower part of the screen shows only letters, and your PIN is probably numeric. Switch to other keypads by stroking downwards on the screen with the stylus. Then enter your PIN. If you enter a wrong digit, you can backspace by stroking the screen to the left with the stylus. (Keep trying if it doesn't seem to work.) Finally, having composed the correct PIN, tap on the composed number with the stylus. This will enter it into the dialog box where it needs to be. After a brief pause, you will then see the word "Enter" at the top right of the keypad. Tap it. The PIN will then be checked, and if all is well, the Home Screen (next section) will be displayed.

=== The Home screen ===

With the bare-bones installation, the home screen looks like this.
[[Image:Homescreen.jpg|center]]

=== Terminal ===

In Om 2008.12, no terminal app is installed by default. To get to a command prompt, you need to set up USB-based networking and use SSH; see next section. Before trying to ssh into the FreeRunner, go into the Settings app and set "Suspend" to "off". The default is to go into suspend mode after 30 seconds without activity on the touchscreen, and when in suspend mode, the FreeRunner does not respond to commands sent over the ssh session.

== Set up USB-based networking, SSH and update ==

Openmoko allows TCP/IP-over-USB networking for your phone. The main advantages of this are
* You don't need to set-up GPRS or WLAN network connection for the phone software to reach the Internet
* You can SSH from your computer into the phone shell and comfortably do low-level tasks using your computer's terminal software and real keyboard instead of the tiny screen and touchscreen keyboard

Naturally, the phone must be connected to your computer with USB cable.

===Connect with the Neo FreeRunner===

This is discussed in the [[USB_Networking|USB Networking]] section.

===Update with the package manager===

In order to keep the FreeRunner up-to-date with the latest features and bug-fixes, it is advisable update the software at regular intervals.

There are two main methods of doing this:
* upgrading with the package manager '''[[Opkg]]'''
* or manually flashing the device (see [[Flashing the Neo FreeRunner]]).

There are three layers to the software on the FreeRunner:

* [[uboot|uBoot]]: Think of u-boot as a combination of the BIOS and Grub on a PC.
* Kernel: The Linux kernel
* Root Filesystem: The rest of the system

Note that ''uboot'', the ''kernel'' and the ''root filesystem'' may all be flashed to update them. For uboot, this is the only possibility (see [[Flashing_the_Neo_FreeRunner#Flashing_the_boot_loader]]). The advantage of flashing the kernel manually rather than using opkg seems to be speed. The disadvantage of flashing the root file system is that it wipes out all local modifications, including /home. If /home is moved to the SD disk, this is no longer a problem.

{{Warning| UPGRADING TO DAILY KERNELS FROM THE DEVELOPMENT BRANCH MAY BREAK THINGS. That said, assuming that your FreeRunner can access the internet (see above), the kernel and other packages can be updated with

# opkg update
# opkg -test upgrade
# opkg upgrade

The first updates the repository information, telling opkg what packages are available. The second allows you to see what the package manager wants to do. The third upgrades all packages for which a newer version is available. '''At the moment, some signature files are missing (404 errors), which opkg complains about, but this is cosmetic.''' The repositories will still update with the missing signature files.
}}

'''Important:''' If you have followed the Getting Started Guide this far, but opkg upgrades do not appear to be happening. Try checking the .conf files in the /etc/opkg/ directory. If you see four URLs pointing at
<nowiki>http://buildhost.openmoko.org/</nowiki>, this is your problem. <nowiki>http://buildhost.openmoko.org/</nowiki> is no longer supported. If you're running Om 2007.2 (the stock distribution that comes with the Freerunner according to the [[FAQ]]), you'll need to edit those files to point to an unofficial [[Users Repositories|User Repository]]. Or, you could install another [[Distributions|distribution]] (which is probably the best bet in the long run).

Note that running opkg upgrade on a factory-fresh phone will upgrade dropbear (the ssh software) and various xserver packages, and neither upgrades elegantly while in use. Xserver must be updated over ssh to complete succesfully. Dropbear can be updated over ssh with the proper command:

nohup opkg upgrade dropbear &

Or upgrade it directly in the FreeRunner terminal.

opkg upgrade dropbear

When updating over ssh, the session will be interrupted, but the command should complete successfully(check nohup.out on your device to verify), and you should be able to reconnect within a few seconds.

Another (better) option is to start a screen session before the upgrade with:

screen

After losing the ssh connection and login in again via ssh reconnect to the running screen session with:

screen -x

Then connect to the FreeRunner via ssh and type:

opkg upgrade

And run this command :

depmod

Alternatively you can upgrade the xserver packages via ssh and then upgrade the rest from the FreeRunner's terminal.

If you do your first upgrade in two installments like this, it will go more smoothly.

It will be possible in the future to update uboot with opkg, but this has not yet been implemented.

=== Installing applications ===

There are many applications you can install - check out the [[Repositories]] for a list of packages, an example of how to add a repository using scaredy cat as an example can also be found here. A list of pre-installed and available packages with descriptions can be found here - [[Available Packages]].
Or you can check [[Applications]] page to get applications developed from community.

If you want to install any application on Neo, there three steps:

'''
1. Download the applicatiion you want to install on Neo.

2. scp the opkg/ipk file to the root of Neo.

3. Use Opkg command to intall opkg files.'''

By following example you can install web browser on Neo:

The calendar can be installed with

First download and unpack it on your GNU/Linux host:

<pre>
wget http://www.ginguppin.de/files/minimo.tar.bz2
tar jvxf minimo.tar.bz2
</pre>

Copy it over to the FreeRunner:
<pre>
scp minimo_* root@192.168.0.202:/tmp
</pre>

Then on the FreeRunner:
<pre>
opkg install /tmp/minimo_0.02\+cvs20070626-r0_armv4t.ipk
</pre>

You'll probably also want to [[Switching Keyboards|change the keyboard]] including the [[Switching Keyboards#How_to_add_a_keyboard_toggle_button|keyboard toggle applet]]

=== Importing contacts ===

If you can export your contacts to VCard format, either multiple files or single file containing all of them, you may use the script on [[Import Vcf Contacts]] page to bring them to Neo.

==The next steps==

Congratulations for setting up your Neo FreeRunner. There are many more resources to help free your phone:

===Customize the interface===
home screen clock, keyboard

The stock [[Openmoko2007.2]] image flashed onto the Neo FreeRunner is really just the bare bones. For example, you don't have the clock and the quick-launch icons showing. Here's how you can change that:

# dbus-launch gconftool-2 -t boolean -s /desktop/poky/interface/reduced false
# /etc/init.d/xserver-nodm restart

If you rather have a regular clock instead of the digital one, do this instead:

# dbus-launch gconftool-2 -t boolean -s /desktop/poky/interface/reduced false
# dbus-launch gconftool-2 -t boolean -s /desktop/poky/interface/digital_clock false
# /etc/init.d/xserver-nodm restart

REMOVE CLICK SOUND VIA /etc/pulse/session

More information about today screen customization at [[Today/2007.2]].

Also, if you prefer having a full keyboard, using matchbox's qwerty keybord, see [[Switching_Keyboards#Matchbox_keyboard|these instructions]]. Then you may also see [http://lists.openmoko.org/pipermail/community/2008-July/021296.html these], which describe a way to add an applet allowing the showing/hiding of that keyboard.

===Use the GPS===
You can see [[Manually using GPS]] to get more information about GPS. Or download [[TangoGPS]] from [http://www.tangogps.org/downloads/tangogps_0.9.3-r1_armv4t.ipk tangogps.org].

There were critical [[GPS Problems]] earlier that are largely fixed in newest kernels, see the instructions above to install the updates. More information is on the [[GPS]] page.

===Play with WLAN, GPRS and Bluetooth===

There are plenty of development opportunities to integrate these functions in the Openmoko software.

'''WLAN''': See [[Wireless Networking]]

'''GPRS''': See [[Manually using GPRS]]

'''Bluetooth''': See [[Manually using Bluetooth]]

=== Testing a new distribution ===

For the feature of Openness, you can flash any Linux [[Distributions]] into FreeRunner. You can testing a new distribution by following ways:

* [[Booting from SD]].
* Boot from the built-in NAND flash memory.
** [[NeoTool]] gives you a GUI to flash and backup.
** [http://code.google.com/p/om-manager/ om-manager] is another GUI to flash, backup and [[Community_Updates/December_29th%2C_2008#New_applications|more]].

=== Welcome to the community ===

The release of the FreeRunner in the summer 2008 has led the community into a new period of rapid growth. The resources available are summarized on the [[Community Resources]]. These are always exciting and interesting times to live in when the balance between Chaos and Order tilts towards change.

As an entry point, the [http://lists.openmoko.org/pipermail/community/ openmoko community mailing list] is perhaps the most active. As of July 2008, its volume amounts to dozens of messages per day. Read the [[Community_Updates]] for a digest. Openmoko people are there too. You may ask for help on the [[https://lists.openmoko.org/mailman/listinfo/support support mailing list]].

Or if you use IRC, there is always a good group in the channel #openmoko on FreeNode.

The links on the top-right of this page lead to the sister sites in the Openmoko community:
* Home and Wiki lead to the same Main Page on the wiki. It needs cleaning, we know...
* Doc leads to the bug ''Trac''king system.
* Planet goes to the collection of Openmoko-relatd blogs.
* Projects is the GForge, free hosting for application developers.
* Lists is the listing of all the public mailing lists on lists.openmoko.org.

== Annotated references ==

* [[Neo FreeRunner]]. The top-level view of the specifications.
* [[Neo FreeRunner GTA02 Hardware]]. The detailed specifications.
* [[GTA02 Openness]]. Ultimate chip-level specifications, data sheets and hardware documentation.
* [[Distributions]]. Strengths and weaknesses of the various distributions available for the Neo.
* [[FAQ#Getting_Started_with_your_Neo_FreeRunner]]. Answers.

To search this wiki with Google, use the following search term:

<search term> site:http://wiki.openmoko.org/wiki/

[[Category:Neo FreeRunner Hardware| ]]
[[Category:Basic End User]]

Getting Started with your Neo FreeRunner

2009-06-17T00:16:31Z

JOERG: /* Charging the Neo FreeRunner */ corrected times

{{Languages|Getting Started with your Neo FreeRunner}}

{| class="wikitable" cellspacing="2" cellpadding="2" style="padding: 0%; margin:0em 0em 1em 0em; background:#eeeeee; width:100%;floating="center"; "
! style="background:#fcfcfc; width:75% " |

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#Getting_Started_with_your_Neo_FreeRunner|FAQ]].


! style="background:#fcfcfc; width:25% " |
[[Image:Freerunner box.png|200px|thumb|Neo FreeRunner Package]]
|}
{{Neo FreeRunner Menu}}

== Package Contents ==

[[Image:Openmokset.jpg|left|400px|thumb|Inside the package]]
 
: [[Image:Circle２.gif|10px]] Neo FreeRunner
: [[Image:Circle２.gif|10px]] Stylus
: [[Image:Circle２.gif|10px]] Battery
: [[Image:Circle２.gif|10px]] Charger
: [[Image:Circle２.gif|10px]] USB Cable (A -> Mini-B 5-pole)
: [[Image:Circle２.gif|10px]] [[Thank You green card]]
<div style="clear: both"> </div>

{{Note|
== Get the source code ==
The software included in this product contains copyrighted software that is licensed under the [http://downloads.openmoko.org/sources/Om2008.9-Lite.iso GPL]. A complete corresponding source code or CD-ROM ISO image with the GPL license is available for download [http://downloads.openmoko.org/sources/Om2008.9-Lite.iso here]. You may also obtain the same corresponding CD-ROM by sending a money order or check for $10 to any one of our [http://downloads.openmoko.org/sources/Om2008.9-Lite.iso 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 ===

[[Image:Circle２.gif|10px]] 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.

<table width="80%" style="clear: both; border: 1px solid #ffffff; border-collapse: collapse; padding: 0.2em; margin: 0; font-size: 100%; margin: 0 1px;">
<tr valign="top" style="background: #ffffff">
<td style="width: 50%; white-space: nowrap; padding: 4px 1em 0 0.5em; border-right: 1px solid #ffffff;">[[Image:menu13.jpg|233px|thumb|Open the case like this.|center]]</td>
<td style="padding: 1px 1em 0; background: #ffffff;">[[Image:menu14.jpg|250px|thumb|Opening !|center]]</td>
</tr>
</table>

[[Image:Circle２.gif|10px]] Now you should be able to locate the combined SIM and Micro-SD card holder at the bottom of the battery compartment.

[[Image:Circle２.gif|10px]] 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.

[[Image:menu11.jpg|260px|thumb|Put the SIM card and SD card here.|center]]

[[Image:Circle２.gif|10px]] Lift up on the SIM card holder.

[[Image:Circle２.gif|10px]] 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.

[[Image:Circle２.gif|10px]] 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.

[[Image:Circle２.gif|10px]] Close the Micro-SD card holder, making sure that both latches of the holder are securely fastened.

[[Image:Circle２.gif|10px]] 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.

[[Image:Circle２.gif|10px]] Close the SIM card holder and lock it by sliding the metal clip towards the external GPS Antenna Socket on the FreeRunner.
<table width="80%" style="clear: both; border: 1px solid #ffffff; border-collapse: collapse; padding: 0.2em; margin: 0; font-size: 100%; margin: 0 1px;">
<tr valign="top" style="background: #ffffff">
<td style="width: 50%; white-space: nowrap; padding: 4px 1em 0 0.5em; border-right: 1px solid #ffffff;">
[[Image:FR_SIM_SD_open.jpg|457px|thumb|SIM and SD holders open, with cards in place|center]]</td>
<td style="padding: 1px 1em 0; background: #ffffff;">
[[Image:Engchang.jpg|392px|thumb|Some models look like this, the little blob is not a defect|center]]</td>
</tr>
</table>

[[Image:Circle２.gif|10px]] 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.

[[Image:Circle２.gif|10px]] Replace the rear cover on the FreeRunner.

{| class="wikitable" style="background#00CC00;border-left:1px solid white;border-right:1px solid white;border-top:0px solid white; border:1px solid #00CC00; float:right; margin: 0 0 1em 1em;"
! style="background:#00cc00;border-left:1px solid white;border-right:5px solid white;border-top:0px solid white; border:1px solid #00CC00;" |Tips
|-
!style="background:#ffffff;border-left:1px solid white;border-right:1px solid white;border-top:0px solid white; border:1px solid #FFFFff;" |
<div align=left>
[http://video.google.de/videoplay?docid=-8343770443102960945 A short video] is also available. It was shot using the previous version of the Neo, but the installation procedure remains the same.
</div>

|}

===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|Neo FreeRunner Hardware Issues]] about not allowing the battery to discharge completely.}}

===Buttons and connectors===

<table width="80%" style="clear: both; border-collapse: collapse" valign="top">
<tr>
<td style="width: 25px"> </td>
<td style="width: 370px">[[Image:menu9.jpg|370px|thumb|Power Button, USB and external GPS Antenna (left to right)|center]]</td>
<td style="width: 25px"> </td>
<td style="width: 370px">[[Image:menu8.jpg|370px|thumb|AUX Button and headset jack (left to right)|center]]</td>
</tr>
<tr>
<td></td>
<td>'''Power'''
Tapping the power button suspends the GTA02.

Holding the power button shutsdown the device.</td>
<td></td>
<td>'''Aux'''
Tapping or holding the Aux button locks the screen.
</td>
</tr>
</table>

'''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

* remember your date code, the bottom of your shipping box should have a sticker stating it.
* read [[Finding_hardware_revision]]

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]]).

== Image Issue==

Because the software changes so rapidly and the phones were imaged during mass production, we don't ship the newest image with phones.
There are two different kinds of images shipped with the phones:

1. [[Om 2007.2]]

2. [[Om 2008.9]]

But according to the [[FAQ]] and [[Distributions]] pages, all phones ship with [[Om 2007.2]]. This distribution is no longer supported, so before even getting your feet wet, you'll probably want to switch to something else, especially since the FreeRunner is not really usable as a mobile phone with these old distributions.

Switching to another distribution is easy if you have a computer with a USB port and internet connectivity that can run the dfu-util utility. Most current Linux distros have packaged dfu-util, so if you use Linux you can probably just get it from your distro's repository. The next step is to choose which Openmoko distribution to switch to. See [[Distributions]] for information about the alternatives.

That page will point you to the files to download, and to the instructions for installing them using dfu-util.

==For Om 2007.2==

Please notice it is strongly recommended to update to any recent distro (probably the first thing you should do with your FR after some hours of drooling and playing), as the info herein is completely out of date, as is the software this is about.
See [http://wiki.openmoko.org/wiki/Distributions#SHR_-_Stable_Hybrid_Release Distributions]

===Navigating menus and applications===
====Today Page====

[[Image:Todaypage_reduced_true.png|200px|right]] Openmoko starts by displaying the "Today" page, which is your home page. Icons in the top row indicate the status of the phone. The bottom row consists of three tabs. The tab with a house on the left leads to the "Today" page you're viewing now. The central tab leads to the "Launch Task" page, which is the main menu used to start applications. The tab with gears on the right leads to the "Running Tasks" page, which is used to deal with currently open windows and applications.

 

[[Image:Todaypage_reduced_false.png|right|200px|]] The "Today" page is empty, as shown above, when you first start Openmoko. We explain below how to turn on the "full view", displayed to the right. In the full view, a second row of icons give quick links to commonly-used applications such as the dialer, the adressbook, mailbox and calendar. The main body of the screen displays a clock and other useful information.

See [[Today/2007.2]] for more information about the Today page and customization.

 

====Launch Task Page====

{{stub}}

[[Image:LaunchTasks.png|right|200px]] This page displays a menu of available applications. You may choose a category of applications to display to simplify the screen, or choose to display them all.

Current categories are [PIM Suite], [[Om_2007.2_Applications|Applications]], [[Games/Om 2007.2|Games]], Utilities, and All.

 

====Running Tasks Page====

{{stub}}

[[Image:RunningTasks.png|right|200px]] This page displays currently-running tasks. Any individual task may be terminated by selecting it and then clicking on the garbage-can icon to close it. All tasks may be terminated by clicking on any one of them and then clicking on the "folder" icon in the upper right (expect this to change in future releases). Any task may be rejoined by selecting it and then selecting the "return" icon at the middle top.

 

====Exiting from and switching to an Application====

Any time an application is running, you can simply click the device's power button and the application will exit, returning you to the Today page.

Alternatively, you can cycle through active applications using the AUX button

Clicking the top-left of the screen displays the drop down ''task menu''. This menu lists all active applications and allows to switch directly to any one. ''Note:'' If the task menu is not shown, click and hold the [[#Aux|Aux]] button to bring up the Aux menu, and select "Toggle Fullscreen".

=== Using the terminal ===

To start a console from "Today" page, click the middle tab at the bottom of the screen to display the "Launch applications" page, then select Terminal in the "Applications" submenu. The multitaps keyboard slides up (and down) from the bottom of the screen automatically when you touch the screen.

====Setting date and time====

From the terminal, type the following, but replace ''MM'' with the month (01-12); ''DD'' with the day (01-31); ''hhmm'' with the time (0000-2359); ''YYYY'' with the year (optional); and ''.ss'' with the seconds (optional).

date -s ''MMDDhhmmYYYY.ss''

To make the change persist between reboots, sync the hardware clock with the updated system time.

hwclock --systohc

See [[Setting Date and Time]] for more discussion, including synchronizing with an NTP server.

Note: UNIX traditionally sets the system clock to GMT (UTC) or "Zulu" (Z time zone). So I use the stanza:
date -u MMDDhhmmYYYY.ss (well, I usually ignore the seconds)
Then I can set the local time using the techniques described elsewhere. iceworm

==== Accessing the microSD card ====

Mounted at /media/card by default.
<pre>
　mount /media/card
</pre>
If you have multiple partitions on the card, the first (/dev/mmcblk0p1) will be mounted at /media/card, the second at /media/mmcblk0p2, the third at /media/mmcblk0p3 etc. To setup the package management to write on the microSD card when installing new software follow the [[Package_management | package management guide]].

fox example :
<pre>
Filesystem 1k-blocks Used Available Use% Mounted on
rootfs 252544 153560 98984 61% /
/dev/root 252544 153560 98984 61% /
/dev/root 252544 153560 98984 61% /dev/.static/dev
udev 2048 76 1972 4% /dev
/dev/mmcblk0p1 3362 1794 1568 53% /media/card
/dev/mmcblk0p2 476382 157368 294419 35% /media/mmcblk0p2
tmpfs 61928 380 61548 1% /var/volatile
tmpfs 61928 0 61928 0% /dev/shm
</pre>

== For Om 2008.12 ==

=== Entering the SIM PIN ===

Some SIM cards require a PIN code to be entered. If your SIM card is like this, you will see a screen like this after the FreeRunner boots:
[[Image:Enterpin.jpg|center]]
The keypad in the lower part of the screen shows only letters, and your PIN is probably numeric. Switch to other keypads by stroking downwards on the screen with the stylus. Then enter your PIN. If you enter a wrong digit, you can backspace by stroking the screen to the left with the stylus. (Keep trying if it doesn't seem to work.) Finally, having composed the correct PIN, tap on the composed number with the stylus. This will enter it into the dialog box where it needs to be. After a brief pause, you will then see the word "Enter" at the top right of the keypad. Tap it. The PIN will then be checked, and if all is well, the Home Screen (next section) will be displayed.

=== The Home screen ===

With the bare-bones installation, the home screen looks like this.
[[Image:Homescreen.jpg|center]]

=== Terminal ===

In Om 2008.12, no terminal app is installed by default. To get to a command prompt, you need to set up USB-based networking and use SSH; see next section. Before trying to ssh into the FreeRunner, go into the Settings app and set "Suspend" to "off". The default is to go into suspend mode after 30 seconds without activity on the touchscreen, and when in suspend mode, the FreeRunner does not respond to commands sent over the ssh session.

== Set up USB-based networking, SSH and update ==

Openmoko allows TCP/IP-over-USB networking for your phone. The main advantages of this are
* You don't need to set-up GPRS or WLAN network connection for the phone software to reach the Internet
* You can SSH from your computer into the phone shell and comfortably do low-level tasks using your computer's terminal software and real keyboard instead of the tiny screen and touchscreen keyboard

Naturally, the phone must be connected to your computer with USB cable.

===Connect with the Neo FreeRunner===

This is discussed in the [[USB_Networking|USB Networking]] section.

===Update with the package manager===

In order to keep the FreeRunner up-to-date with the latest features and bug-fixes, it is advisable update the software at regular intervals.

There are two main methods of doing this:
* upgrading with the package manager '''[[Opkg]]'''
* or manually flashing the device (see [[Flashing the Neo FreeRunner]]).

There are three layers to the software on the FreeRunner:

* [[uboot|uBoot]]: Think of u-boot as a combination of the BIOS and Grub on a PC.
* Kernel: The Linux kernel
* Root Filesystem: The rest of the system

Note that ''uboot'', the ''kernel'' and the ''root filesystem'' may all be flashed to update them. For uboot, this is the only possibility (see [[Flashing_the_Neo_FreeRunner#Flashing_the_boot_loader]]). The advantage of flashing the kernel manually rather than using opkg seems to be speed. The disadvantage of flashing the root file system is that it wipes out all local modifications, including /home. If /home is moved to the SD disk, this is no longer a problem.

{{Warning| UPGRADING TO DAILY KERNELS FROM THE DEVELOPMENT BRANCH MAY BREAK THINGS. That said, assuming that your FreeRunner can access the internet (see above), the kernel and other packages can be updated with

# opkg update
# opkg -test upgrade
# opkg upgrade

The first updates the repository information, telling opkg what packages are available. The second allows you to see what the package manager wants to do. The third upgrades all packages for which a newer version is available. '''At the moment, some signature files are missing (404 errors), which opkg complains about, but this is cosmetic.''' The repositories will still update with the missing signature files.
}}

'''Important:''' If you have followed the Getting Started Guide this far, but opkg upgrades do not appear to be happening. Try checking the .conf files in the /etc/opkg/ directory. If you see four URLs pointing at
<nowiki>http://buildhost.openmoko.org/</nowiki>, this is your problem. <nowiki>http://buildhost.openmoko.org/</nowiki> is no longer supported. If you're running Om 2007.2 (the stock distribution that comes with the Freerunner according to the [[FAQ]]), you'll need to edit those files to point to an unofficial [[Users Repositories|User Repository]]. Or, you could install another [[Distributions|distribution]] (which is probably the best bet in the long run).

Note that running opkg upgrade on a factory-fresh phone will upgrade dropbear (the ssh software) and various xserver packages, and neither upgrades elegantly while in use. Xserver must be updated over ssh to complete succesfully. Dropbear can be updated over ssh with the proper command:

nohup opkg upgrade dropbear &

Or upgrade it directly in the FreeRunner terminal.

opkg upgrade dropbear

When updating over ssh, the session will be interrupted, but the command should complete successfully(check nohup.out on your device to verify), and you should be able to reconnect within a few seconds.

Another (better) option is to start a screen session before the upgrade with:

screen

After losing the ssh connection and login in again via ssh reconnect to the running screen session with:

screen -x

Then connect to the FreeRunner via ssh and type:

opkg upgrade

And run this command :

depmod

Alternatively you can upgrade the xserver packages via ssh and then upgrade the rest from the FreeRunner's terminal.

If you do your first upgrade in two installments like this, it will go more smoothly.

It will be possible in the future to update uboot with opkg, but this has not yet been implemented.

=== Installing applications ===

There are many applications you can install - check out the [[Repositories]] for a list of packages, an example of how to add a repository using scaredy cat as an example can also be found here. A list of pre-installed and available packages with descriptions can be found here - [[Available Packages]].
Or you can check [[Applications]] page to get applications developed from community.

If you want to install any application on Neo, there three steps:

'''
1. Download the applicatiion you want to install on Neo.

2. scp the opkg/ipk file to the root of Neo.

3. Use Opkg command to intall opkg files.'''

By following example you can install web browser on Neo:

The calendar can be installed with

First download and unpack it on your GNU/Linux host:

<pre>
wget http://www.ginguppin.de/files/minimo.tar.bz2
tar jvxf minimo.tar.bz2
</pre>

Copy it over to the FreeRunner:
<pre>
scp minimo_* root@192.168.0.202:/tmp
</pre>

Then on the FreeRunner:
<pre>
opkg install /tmp/minimo_0.02\+cvs20070626-r0_armv4t.ipk
</pre>

You'll probably also want to [[Switching Keyboards|change the keyboard]] including the [[Switching Keyboards#How_to_add_a_keyboard_toggle_button|keyboard toggle applet]]

=== Importing contacts ===

If you can export your contacts to VCard format, either multiple files or single file containing all of them, you may use the script on [[Import Vcf Contacts]] page to bring them to Neo.

==The next steps==

Congratulations for setting up your Neo FreeRunner. There are many more resources to help free your phone:

===Customize the interface===
home screen clock, keyboard

The stock [[Openmoko2007.2]] image flashed onto the Neo FreeRunner is really just the bare bones. For example, you don't have the clock and the quick-launch icons showing. Here's how you can change that:

# dbus-launch gconftool-2 -t boolean -s /desktop/poky/interface/reduced false
# /etc/init.d/xserver-nodm restart

If you rather have a regular clock instead of the digital one, do this instead:

# dbus-launch gconftool-2 -t boolean -s /desktop/poky/interface/reduced false
# dbus-launch gconftool-2 -t boolean -s /desktop/poky/interface/digital_clock false
# /etc/init.d/xserver-nodm restart

REMOVE CLICK SOUND VIA /etc/pulse/session

More information about today screen customization at [[Today/2007.2]].

Also, if you prefer having a full keyboard, using matchbox's qwerty keybord, see [[Switching_Keyboards#Matchbox_keyboard|these instructions]]. Then you may also see [http://lists.openmoko.org/pipermail/community/2008-July/021296.html these], which describe a way to add an applet allowing the showing/hiding of that keyboard.

===Use the GPS===
You can see [[Manually using GPS]] to get more information about GPS. Or download [[TangoGPS]] from [http://www.tangogps.org/downloads/tangogps_0.9.3-r1_armv4t.ipk tangogps.org].

There were critical [[GPS Problems]] earlier that are largely fixed in newest kernels, see the instructions above to install the updates. More information is on the [[GPS]] page.

===Play with WLAN, GPRS and Bluetooth===

There are plenty of development opportunities to integrate these functions in the Openmoko software.

'''WLAN''': See [[Wireless Networking]]

'''GPRS''': See [[Manually using GPRS]]

'''Bluetooth''': See [[Manually using Bluetooth]]

=== Testing a new distribution ===

For the feature of Openness, you can flash any Linux [[Distributions]] into FreeRunner. You can testing a new distribution by following ways:

* [[Booting from SD]].
* Boot from the built-in NAND flash memory.
** [[NeoTool]] gives you a GUI to flash and backup.
** [http://code.google.com/p/om-manager/ om-manager] is another GUI to flash, backup and [[Community_Updates/December_29th%2C_2008#New_applications|more]].

=== Welcome to the community ===

The release of the FreeRunner in the summer 2008 has led the community into a new period of rapid growth. The resources available are summarized on the [[Community Resources]]. These are always exciting and interesting times to live in when the balance between Chaos and Order tilts towards change.

As an entry point, the [http://lists.openmoko.org/pipermail/community/ openmoko community mailing list] is perhaps the most active. As of July 2008, its volume amounts to dozens of messages per day. Read the [[Community_Updates]] for a digest. Openmoko people are there too. You may ask for help on the [[https://lists.openmoko.org/mailman/listinfo/support support mailing list]].

Or if you use IRC, there is always a good group in the channel #openmoko on FreeNode.

The links on the top-right of this page lead to the sister sites in the Openmoko community:
* Home and Wiki lead to the same Main Page on the wiki. It needs cleaning, we know...
* Doc leads to the bug ''Trac''king system.
* Planet goes to the collection of Openmoko-relatd blogs.
* Projects is the GForge, free hosting for application developers.
* Lists is the listing of all the public mailing lists on lists.openmoko.org.

== Annotated references ==

* [[Neo FreeRunner]]. The top-level view of the specifications.
* [[Neo FreeRunner GTA02 Hardware]]. The detailed specifications.
* [[GTA02 Openness]]. Ultimate chip-level specifications, data sheets and hardware documentation.
* [[Distributions]]. Strengths and weaknesses of the various distributions available for the Neo.
* [[FAQ#Getting_Started_with_your_Neo_FreeRunner]]. Answers.

To search this wiki with Google, use the following search term:

<search term> site:http://wiki.openmoko.org/wiki/

[[Category:Neo FreeRunner Hardware| ]]
[[Category:Basic End User]]