summaryrefslogtreecommitdiff
path: root/common/lib/mmtcgen/doc.txt
blob: e39223d7246f3a4764e5c1c558a119c4680ccc7d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
MMTypeConstGen
==============

MMTypeConstGen is a MMType Constant Generator, it takes an input file and
generate the constant file for C.
The objective of the tool is centralize all MME definition used in the
project (Cleopatre, Cesar, Maximus).

How to use
----------

The input file format
~~~~~~~~~~~~~~~~~~~~~

CC_WHO_RU 0x1000 REQ IND

This line inform the generator, CC_WHO_RU have for base 0x1000 and is valid
for REQ and IND MMEs.

The output will be (in C)
~~~~~~~~~~~~~~~~~~~~~~~~~

::

	#define CC_WHO_RU 0x1000
	#define MME_CNF 0x01
	#define MME_IND 0x02
	#define MME_REQ 0x00
	#define MME_RSP 0x03

	[...]

	enum cp_mmtype_t
	{
	    CC_WHO_RU_REQ = CC_WHO_RU + MME_REQ,
	    CC_WHO_RU_IND = CC_WHO_RU + MME_IND,

	};
	typedef enum cp_mmtype_t cp_mmtype_t;

Examples
--------

python mmtcgen mmesfile mme.h