This is short howto about adding new l_down into build system

=============================================================

In this howto we are using 'example' as an example name for the new ldown. On

known l_downs example can be changed to 'single', 'tcp' or 'usb' 

So just replace the 'example' on following chapters. There is also actual example

l_down to be used when creating new l_down.

Creating directory

==================

Directory needs to be in form ld_example

e.g.

l_in/ld_example

Adding to build harness

=======================

Makefile.am needs to be added to ld_example folder.

Includings of the l_in/ld_example/Makefile.am:

----------------------------

#  Copyright (c) 2009 Nokia Corporation

#  All rights reserved.

# 

#  Redistribution and use in source and binary forms, with or without

#  modification, are permitted provided that the following conditions are

#  met:

# 

#  * Redistributions of source code must retain the above copyright

#    notice, this list of conditions and the following disclaimer.

#  * Redistributions in binary form must reproduce the above copyright

#    notice, this list of conditions and the following disclaimer in the

#    documentation and/or other materials provided with the distribution.

#  * Neither the name of the Nokia Corporation nor the names of its

#    contributors may be used to endorse or promote products derived from

#    this software without specific prior written permission.

# 

#  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS

#  IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED

#  TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A

#  PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER

#  OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,

#  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,

#  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR

#  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF

#  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING

#  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS

#  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

INCLUDES=\

	-I${top_srcdir}/inc \

	-I${top_srcdir}/l_in_up \

	-I.

noinst_LTLIBRARIES=\

	libld_example.la

libld_example_la_SOURCES=\

	ld_if_example.c \

	ld_example.c \

	ld_example.h

----------------------------

l_in/configure.ac

If l_down is wanted to be added as part of the --with-transports=all command one

needs to add the example to be included when checking if transports is all.

----------------------------

if test "x$transports" = "xall"; then

   transports="tcp,fifo,usb,bt,simple,dummy,single,example"

fi  

----------------------------

in l_in/configure.ac one needs to add ld_example to be part of the AC_OUTPUT

by adding ld_example/Makefile to file. This is required for actual makefile 

to be created.

----------------------------

AC_OUTPUT([

     ...

ld_single/Makefile

ld_example/Makefile

nota-l_in-3.0.pc])

----------------------------

now ld_example is automatically taken into build, when making 

l_in$ ./configure --with-transports=example

If l_down is also wanted to be added in distributions, folder needs to be listed 

in l_in/Makefile.am DIST_SUBDIRS.

----------------------------

DIST_SUBDIRS=     \

   ....           \

   ld_usb         \

   ld_example

----------------------------

l_down files

============

l_in/inc/l_in/ld_types.h

definition for l_down type needs to be added

#define LD_TYPE_MAIN_EXAMPLE        0x00006000

#define LD_TYPE_EXT_EXAMPLE_EXAMPLE 0x00006000

ld_if_example.c

LdActivate function needs to point to ld_types.h values and set the type of

the l_down to reference parameter provided by l_in_up.

Also parameter checking is usually implemented here.

Also has 

ld_example_module_init

ld_example_module_destroy

which are called by l_in_up and ld_tester to initialize and destroy the 

l_down. These function names are automatically generated from the parameters

of the ./configure --with-transports=example and they are generated when 

l_in_up is compiled. funtions are always in the form of ld_??????_module_init.

ld_example.c

implementation of ld_if functions.

Building l_down for the first time

==================================

First update the build instruction scripts

l_in$ autoreconf -i

Update the configuration of l_in

l_in$ ./configure --with-transports=example

now you should see L_IN configure results to similiar to 

L_IN configure results

-----------------------------------

Transport (Ldown) : example 

Transport libs    :  ../ld_example/libld_example.la

Platform          : posix

Build / Target    : i686-pc-linux-gnu / 

Endianness        : little

Plugin support    : no

Multiple ref l_up : no

Prefix            : /usr/local

to build now type

make clean all

to check if all were succesfull, check that l_in/l_in_up/ld_modules.h

was created and it includes:

ld_status_t ld_example_module_init    (ld_callback_t *, void *, struct ld_ops **, ld_t **);

ld_status_t ld_example_module_destroy (ld_t *);

Congratulations!

Now your done it, and new l_down is introduced to build harness, and it is usable by

l_in_up and ld_tester.

Testing l_down

==============

To start testing the l_down, goto ld_tester folder and tun the tester.

More info about the tester in testers README.