OsmocomBB

{{>toc}}

h1. Welcome to the [[OsmocomBB]] project

[[OsmocomBB]] is an Free Software / Open Source GSM Baseband software implementation.

It intends to completely replace the need for a proprietary GSM baseband software, such as

* drivers for the GSM analog and digital baseband (integrated and external) peripherals

* the GSM phone-side protocol stack, from layer 1 up to layer 3

In short: By using [[OsmocomBB]] on a compatible phone, you are able

to make and receive phone calls, send and receive SMS, etc. based on Free Software only.

Over the past 12 months, we've been making very good progress. Most of the hardware drivers have been

written, and a relatively complete layer1, layer2 and layer3 exist.

No work has yet been done on any sort of UI on the phone.  The only user interface is a telnet-based

command line.

To get started, checkout the [[PreliminaryRequirements]] and then [[SoftwareGettingStarted]]

h2. Directory

[[BlogList(format=float,recent=5,max_size=350)]]

This is the project page about our experiments (so far) only with phones based on the Ti [[HardwareCalypso]]/[[Iota]]/[[Rita]] 

GSM baseband chipset.  The main target is the [[MotorolaC123]]. For more supported phones, check below.

We originally intended to build an inexpensive GSM experimentation board built with/around that chipset, but right now

are pursuing a slightly alternative course by using cheap off-the-shelf feature phones and write custom software for it.

* The [[ProjectRationale]]

* [[SoftwareAreasOfWork]] -- What needs to be done and who wants to do it

* Information about the [[TypicalCalypsoModemDesign]]

** [[HardwareCalypso]] -- The HERCROM digital baseband chip (DSP+ARM7)

*** [[HardwareCalypsoDSP]] -- The DSP inside the Calypso DBB

** [[Iota]] -- The TWL3025 analog baseband chip (ADC/DAC)

** [[Rita]] -- The TRF6151C GSM transceiver (VCO, up/down-conversion)

* Information about the [[SciphoneDreamG2]], a [[MT6235]] based phone (not supported!!)

* Old/obsolete plan/spec of the [[GsmDevelBoard]] (note: This project is on hold right now!

* Description of our own GSM Stack

** [[L1A_L23_Interface]] -- How the Layer1 interfaces with Layer2 and Layer3 of the stack

* Notes on the [[TSM30Layer1|TSM30 Layer1]] as it can be found in the TSM30 source

* [[Glossary]] -- The weird terms used in the phone baseband world

* [[LegalAspects]] -- Important legal aspects of this project

* [[CommunityPeople]] -- The people behind the project

* [[PressCoverage]] -- What the press is writing about us

h2. Mailing List/IRC Chat

We offer [[CommunityMailing_lists|Mailing Lists] and hang out on [wikiCommunityIRC IRC]].

h2. Software

Documentation about software developed by this project.

[[OsmocomBB]] source code is kept in the git repository at https://gitea.osmocom.org/phone-side/osmocom-bb

* [[SoftwareGettingStarted]] -- Getting Started with the Software for the target and host.

* [[SoftwareOverview]] -- Overview how all the parts below fit together

h3. Host programs (running on the PC)

h4. General Purpose

* [[osmocon]] -- A tool for Compal phones; to load code into RAM and execute it

* [[mobile]] -- An application implementing a regular GSM mobile phone (and more)

* [[WiresharkIntegration]] -- How to use [[OsmocomBB]] with wireshark protocol analyzer

* [[libosmocore]] -- A library with utility functions

h4. Advanced / special purpose tools

* [[osmoload]] -- A tool for flashing and examining phones

* [[calypso_pll]] -- A tool to calculate Calypso DPLL multiplier+divider

* [[rita_pll]] -- A tool to calculate the Rita PLL multiplier/divider

* [[layer23]] -- An implementation of GSM Layer2 and upwards.

h3. Target programs (running on the phone baseband chip)

* The current staging/testing code base for our own software on the Calypso. From it we build a number of apps:

** hello_world.bin -- An actual 'hello world' application for LCD and serial port

** [[layer1bin]] -- The actual Layer1 software as it is to be used with [[layer23]]

** [[loaderbin]] -- Our flash loader, dumper and second stage bootloader

** [[compal_dsp_dumpbin]] -- A program to dump the ROM of the DSP inside the [[HardwareCalypso]]

** [[rssibin]] -- Receive signal strength monitor with spectrum display

h2. Supported Phone hardware

Please see [[HardwarePhones]] for a list of supported phones.

h3. Accessories

You will need a [[HardwareSerialCable]] to connect the phone to a PC

h2. Random bits and pieces

* SIM related

** [[RebelSIM]] How the Rebel SIM card cand be used as SIM proxy

** [[RebelSIM_Scanner]] to scan/trace communication between SIM and phone (rubbish)

** [[SIMtrace]] -- our custom hardware / firmware / software to get SIM-ME traces into wireshark

** [[SIMReader]] How to connect to network using provider SIM

** [[softSIM]] How to do software SIM

* a collection of phone [[TerminalProfile|Terminal Profiles]]

* [[Sniffing|Notes on sniffing]]

* [[dct3-gsmtap]] A tool to obtain GSMTAP messages for SIM and GSM from Nokia DCT3 (eg, 3310) phones

* [[HardwareFilterReplacement]] How to replace filters on Motorola phones

* [[PotentialCalypsoTargets]] Potential phone hardware to use with osmocom-bb

h2. References ==

 Related projects ===

* [[nuttx-bb]] -- Port of nuttx on the osmocom-bb comaptible phones.

* "airprobe":https://svn.berlin.ccc.de/projects/airprobe/ -- Free Software GSM protocol analyzer 

* "Other Osmocom Projects":http://osmocom.org/ -- Osmocom Projects

* "OpenBTS":http://openbts.sourceforge.net/ -- Free Software Um-to-SIP gateway

h3. Recommended reading

* "-- Introduction to contemporary GSM cellphone hardware

* [http://www2.informatik.hu-berlin.de/~goeller/":http://laforge.gnumonks.org/papers/gsm_phone-anatomy-latest.pdf] -- Homepage of Dr.-Ing. Joachim Goeller, lots of GSM tutorials

* "-- Source code of the firmware of the Vitelcom TSM30 phone (dead link)

* [http://svn.gnumonks.org/trunk/presentation/2010/osmocombb-sstic2010/osmocombb-security.pdf [[OsmocomBB]] presentation at SSTIC 2010":http://sourceforge.net/projects/plabs/]

* "Article covering [[OsmocomBB]] at h-online, from July 2012":http://www.h-online.com/open/features/How-free-is-my-phone-1634071.html

For a complete list of local wiki pages, see [[TitleIndex]].