src/README.development

   1 = Contributing to OsmocomBB development =
   2
   3 Feel free to help us by extending the code.  Always make sure to
   4 send back all your patches to the baseband-devel@lists.osmocom.org
   5 mailing list - Free Software is all about sharing.
   6
   7 == src/shared/libosmocore ==
   8
   9 is a library of various utility routines, including linked lists,
  10 message buffers, bit-vectors, memory allocator, signals, select loop
  11 handling, timers - as well as some more specifically GSM related things
  12 like a TLV parser, a Comp128V1 implementation and utility functions for
  13 RSL (TS 08.58) and CC/MM/RR (TS 04.08).
  14
  15 libosmocore is maintained in git://git.osmocom.org/libosmocore.git, so
  16
  17         DO NOT DIRECTLY COMMIT TO libosmocore IN THIS REPOSITORY!
  18
  19 We simply maintain a copy (synchronized by git-subtree) in this
  20 repository for the ease of building and to make sure everyone is using
  21 the proper/compatible version of libosmocore
  22
  23 Please note, whatever you add to libosmocore will need to build as a
  24 Linux userspace program (using glibc) just as well as on the OsmocomBB
  25 embedded target without OS.  So please refrain from using fancy
  26 functions.
  27
  28
  29 == src/target/firmware ==
  30
  31 The firmware is what we build for the actual target (phone).  It was
  32 written with some idea of modularity in mind, i.e. we have
  33
  34  * Ti Calypso specific code in calypso/
  35  * Analog Baseband code in abb/
  36  * RF Mixer code in rf/
  37  * Layer1 code in layer1/
  38  * NOR flash handling in flash/
  39  * LCD display handlin in display/
  40  * minimal C-Library code in lib/
  41  * communications utility routines in comm/
  42  * Board (phone model/family) specific code in board/
  43    * board/compal_e88 is the Motorola C115-C124 family
  44    * board/compal_e99 is the Motorola C155 family
  45  * Applications (each app builds one firmware image) in apps/
  46
  47
  48 == src/target_dsp/calypso ==
  49
  50 This is where we keep some (assembly) code that we wrote for
  51 the DSP that is part of the Caylypso DBB.
  52
  53 == host/layer23 ==
  54
  55 The Layer2 (LAPDm / TS 04.06) and Layer3 (CC/MM/RR / 04.08)
  56 implementations, as they are growing.
  57