2010-03-08 09:18:57 +00:00
|
|
|
= Contributing to OsmocomBB development =
|
|
|
|
|
|
|
|
Feel free to help us by extending the code. Always make sure to
|
2018-05-20 12:42:34 +00:00
|
|
|
send back all your patches to Gerrit (recommended) or to the
|
|
|
|
baseband-devel@lists.osmocom.org mailing list - Free Software
|
|
|
|
is all about sharing. For details, see:
|
|
|
|
|
|
|
|
https://osmocom.org/projects/cellular-infrastructure/wiki/Gerrit
|
|
|
|
https://gerrit.osmocom.org/
|
2010-03-08 09:18:57 +00:00
|
|
|
|
2010-12-11 03:38:59 +00:00
|
|
|
== Coding Style ==
|
|
|
|
|
2011-01-08 19:58:25 +00:00
|
|
|
Like all C language Osmocom projects, we use the Linux Kernel coding
|
2010-12-11 03:38:59 +00:00
|
|
|
style, you can find it in the Documentation/CodingStyle subdirectory
|
2018-05-20 12:42:34 +00:00
|
|
|
of any Linux Kernel source. For details, see:
|
|
|
|
|
|
|
|
https://osmocom.org/projects/cellular-infrastructure/wiki/Coding_standards
|
2010-12-11 03:38:59 +00:00
|
|
|
|
|
|
|
== More Information ==
|
|
|
|
|
2018-05-20 12:42:34 +00:00
|
|
|
Please consult the https://osmocom.org/projects/baseband/wiki/.
|
2010-12-11 03:38:59 +00:00
|
|
|
|
|
|
|
If you have any technical questions regarding the code, don't hesitate
|
|
|
|
to ask the baseband-devel@lists.osmocom.org mailing list.
|
|
|
|
|
|
|
|
== subdirectories containing libraries and code ==
|
|
|
|
|
|
|
|
=== src/shared/libosmocore ===
|
2010-03-08 09:18:57 +00:00
|
|
|
|
2011-01-08 19:58:25 +00:00
|
|
|
This is a library of various utility routines, including linked lists,
|
2010-03-08 09:18:57 +00:00
|
|
|
message buffers, bit-vectors, memory allocator, signals, select loop
|
|
|
|
handling, timers - as well as some more specifically GSM related things
|
|
|
|
like a TLV parser, a Comp128V1 implementation and utility functions for
|
|
|
|
RSL (TS 08.58) and CC/MM/RR (TS 04.08).
|
|
|
|
|
|
|
|
libosmocore is maintained in git://git.osmocom.org/libosmocore.git, so
|
|
|
|
|
|
|
|
DO NOT DIRECTLY COMMIT TO libosmocore IN THIS REPOSITORY!
|
|
|
|
|
|
|
|
We simply maintain a copy (synchronized by git-subtree) in this
|
|
|
|
repository for the ease of building and to make sure everyone is using
|
|
|
|
the proper/compatible version of libosmocore
|
|
|
|
|
|
|
|
Please note, whatever you add to libosmocore will need to build as a
|
|
|
|
Linux userspace program (using glibc) just as well as on the OsmocomBB
|
|
|
|
embedded target without OS. So please refrain from using fancy
|
|
|
|
functions.
|
|
|
|
|
|
|
|
|
2010-12-11 03:38:59 +00:00
|
|
|
=== src/target/firmware ===
|
2010-03-08 09:18:57 +00:00
|
|
|
|
|
|
|
The firmware is what we build for the actual target (phone). It was
|
|
|
|
written with some idea of modularity in mind, i.e. we have
|
|
|
|
|
|
|
|
* Ti Calypso specific code in calypso/
|
|
|
|
* Analog Baseband code in abb/
|
|
|
|
* RF Mixer code in rf/
|
|
|
|
* Layer1 code in layer1/
|
|
|
|
* NOR flash handling in flash/
|
2011-01-08 19:58:25 +00:00
|
|
|
* LCD display handling in display/
|
2010-03-08 09:18:57 +00:00
|
|
|
* minimal C-Library code in lib/
|
|
|
|
* communications utility routines in comm/
|
|
|
|
* Board (phone model/family) specific code in board/
|
|
|
|
* board/compal_e88 is the Motorola C115-C124 family
|
|
|
|
* board/compal_e99 is the Motorola C155 family
|
|
|
|
* Applications (each app builds one firmware image) in apps/
|
|
|
|
|
|
|
|
|
2010-12-11 03:38:59 +00:00
|
|
|
=== src/target_dsp/calypso ===
|
2010-03-08 09:18:57 +00:00
|
|
|
|
|
|
|
This is where we keep some (assembly) code that we wrote for
|
2011-01-08 19:58:25 +00:00
|
|
|
the DSP that is part of the Calypso DBB.
|
2010-03-08 09:18:57 +00:00
|
|
|
|
2010-12-11 03:38:59 +00:00
|
|
|
=== src/host/layer23 ===
|
2010-03-08 09:18:57 +00:00
|
|
|
|
2010-12-11 03:38:59 +00:00
|
|
|
The Layer2 (LAPDm / TS 04.06) and Layer3 (CC/MM/RR / TS 04.08)
|
2010-03-08 09:18:57 +00:00
|
|
|
implementations, as they are growing.
|
|
|
|
|