readme

This a framework to test new ideas in transmission technology. Actual development is a LDPC-coder in

macro_synch
-----------

 In order to have a simple synchronisation going, this macro has been
written. You can call it and then wait for the synchronisation to be
complete, before going on with the rest of the radio.

Usage
-----

 This macro can be used either in 'polling'- or in 'callback'-mode. For
both modes, after you instantiated the macro with swr_sdb_instantiate_name,
you have to set the 'stfa_id'.
 For the polling-mode, you can directly set the 'synch' parameter to 1,
start the stfa and wait in regular intervals whether the 'status' is 1,
which indicates that a synchronisation has been found.
 In callback-mode, you have to give a pointer to a 'func' (as defined in
stfa.h) in 'call_synched'. After setting the 'synch' parameter to 1, you
can wait for 'func' to be called.
 In either mode, once the synchronisation is achieved, you must set the
'synch' parameter to 0 before trying to add other modules to the stfa.

 For an example, see Radio/Simple/MS/radio_ms.c

Config:
	*call_synched<func>: NULL
		A pointer to a 'func' (defined in stfa.h) that
		is called if a synchronisation has succesfully been detected.

	min_energy<int>: 2^14
		The needed energy to consider synchronisation

	stfa_id<int>: -1
		the id of the stfa where the synch has to attach itself

	synch<int>: 0
		If a change from 0 to 1 is detected, the module attaches
		all necessary chains to the stfa. On a change from 1 to 0,
		all attached chains to the stfa are deleted, except the first one.


Stats:
	offset<int>:
		The offset of the synchronisation-signal

	status<int>:
		0 means not synched, 1 tells it's synched

	synch_rcv<swr_sdb_id>:
		the synchronisation-module where the matched-filter can be
		attached to in order to decode the synch-channel