===============================================================================
***************************** OAISIM_MME v0.1 *********************************
===============================================================================

MME + P-GW + S-GW implementation of 3GPP standard.

|-----|       |------|
| MME | ----- | eNBs |
|-----|       |------|

Controle plane:

              eNB                                    MME
 
                                       |----------------------------|
                                       |    MME Application layer   |
                                       |----------------------------|
                                       |------------|
                                       |     NAS    |
                                       |------------|
|------------|   |------------|        |------------|  |------------|
|    RRC     | - | S1AP layer | ------ | S1AP layer |  |  Diameter  |
|------------|   |------------|        |------------|  |------------|
                 |------------|        |----------------------------|
                 | SCTP layer | ------ |         SCTP layer         |
                 |------------|        |----------------------------|

Non-UE associated control plane goes directly from S1AP to MME application layer.

User plane:

      eNB                   MME

|------------|        |------------|
|    PDCP    |        |     MAL    |
|------------|        |------------|
|------------|        |------------|
|    S1-U    | ------ |    S1-U    |
|------------|        |------------|
|------------|        |------------|
|  GTPV1-U   | ------ |   GTPV1-U  |
|------------|        |------------|
|------------|        |------------|
|  UDP layer | ------ |  UDP layer |
|------------|        |------------|

Current development:

- NAS  layer: under development
- S1AP layer: compliant with 3GPP TS36.413-8a0 and TS36.413-980 (under development)
- SCTP layer: SEQ_PACKET socket types

For now the MME is able to register new eNBs on SCTP layer,
and handles S1 Setup request, Initial UE message, UplinkNASTransport on
S1AP layer.

The MME needs some libraries and tools:
- libsctp-dev (SCTP support)
- libpthread-dev
- asn1c utility (patched with Aligned PER support, see README in
S1AP/MESSAGES/ASN1) link: http://lionet.info/soft/asn1c-0.9.21.tar.gz
- freediameter 1.1.5 patched (apply patch in DIAMETER/) with gnutls 3.1.0
link: http://www.freediameter.net/hg/freeDiameter/archive/1.1.5.tar.gz

Compilations steps for use with oaisim 4G emulation environment:
./autogen.sh
mkdir objs && cd objs
../configure [options]
make

Compilations steps for oaisim_mme use alone:
./autogen.sh
./configure [options]
make

Current options supported for configure:
--disable-r9: disable R9 S1AP messages (R9 enabled by default)
code build switch: UPDATE_RELEASE_9

To rum mme:
./OAISIM_MME/oaisim_mme [options]
Avalaible options:
-h: print help
-v: enable verbosity level [1-2]
-V: print current executable version and return

Before any commit:
make maintainer-clean

Bugs:
report any bug to openair_admin@eurecom.fr

MME SCTP port for S1AP messages is 36412

-------- Adding new files to build system --------
1) When adding a new file to compile, edit the Makefile.am of the corresponding
   directory.
2) Execute ./autogen.sh
3) make
WARNING: do not edit directly Makefile and Makefile.in, they are re-generated by
         autoconf/automake.