diff options
| -rw-r--r-- | src/README.building | 14 | ||||
| -rw-r--r-- | src/README.development | 25 |
2 files changed, 32 insertions, 7 deletions
diff --git a/src/README.building b/src/README.building index 32d03c95..a871c7f0 100644 --- a/src/README.building +++ b/src/README.building @@ -3,8 +3,9 @@ === Prerequisites === We assume you are building on a GNU/Linux host system such as Debian -GNU/Linux. Windows builds have been reported successfully using the -Cygwin environment, but we do not officially support this. +GNU/Linux. Builds have been reported successfully using MacOS X +and the Cygwin environment for MS Windows, but we do not officially support +this. # Get a GNU toolchain (gcc/binutils) for ARM (e.g. from http://gnuarm.com/) # Set your path to include the arm-elf-* executables of your toolchain @@ -18,3 +19,12 @@ The master Makefile will build * libosmocore for the target (ARM) * osmocon and layer23 executables for the host (linking libosmocore) * the actual target firmware images (in src/target/firmware/board/*/*.bin) + +== Transmitting == + +For safety reasons, all code that can enable the transmitter on the phone is +disabled in the default builds. Plese check the src/target/firmware/Makefile +for the "#CFLAGS += -DCONFIG_TX_ENABLE" line. + +Please notice that GSM operates in licensed spectrum and in most jurisdictions +you will need a license from a regulatory authority to transmit. diff --git a/src/README.development b/src/README.development index 393b0bd9..2e55f312 100644 --- a/src/README.development +++ b/src/README.development @@ -4,7 +4,22 @@ Feel free to help us by extending the code. Always make sure to send back all your patches to the baseband-devel@lists.osmocom.org mailing list - Free Software is all about sharing. -== src/shared/libosmocore == +== Coding Style == + +Lie all C language Osmocom projects, we use the Linux Kernel coding +style, you can find it in the Documentation/CodingStyle subdirectory +of any Linux Kernel source. + +== More Information == + +Please consult the http://bb.osmocom.org/ web page / wiki. + +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 === is a library of various utility routines, including linked lists, message buffers, bit-vectors, memory allocator, signals, select loop @@ -26,7 +41,7 @@ embedded target without OS. So please refrain from using fancy functions. -== src/target/firmware == +=== src/target/firmware === 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 @@ -45,13 +60,13 @@ written with some idea of modularity in mind, i.e. we have * Applications (each app builds one firmware image) in apps/ -== src/target_dsp/calypso == +=== src/target_dsp/calypso === This is where we keep some (assembly) code that we wrote for the DSP that is part of the Caylypso DBB. -== host/layer23 == +=== src/host/layer23 === -The Layer2 (LAPDm / TS 04.06) and Layer3 (CC/MM/RR / 04.08) +The Layer2 (LAPDm / TS 04.06) and Layer3 (CC/MM/RR / TS 04.08) implementations, as they are growing. |