# Building AdaSockets to target RTEMS.

Prerequisites
=============
Build and install a working GNAT/RTEMS toolset and a BSP. Make sure
networking and POSIX are enabled.  Detailed instructions are available
online in the RTEMS Wiki at:

    http://www.rtems.org/wiki/index.php/RTEMSAda

Run at least one sample from the RTEMS build (e.g. `hello.exe`
or `sample.exe`) to confirm that RTEMS itself was properly built.

Build and run the RTEMS `hello_world_ada` from the `ada-examples`
package using your GNAT/RTEMS development environment.

If everything is working at this point, then you are ready to
build AdaSockets.

Generate `sockets-constants.ads`
================================
Subdirectory: `rtems`

We will use the RTEMS you installed to build and run a program
called `constants.exe`.  The output of this program needs to be
saved as `sockets-constants.ads`.  To compile this program use
the `Makefile.RTEMS`.

```
% RTEMS_MAKEFILE_PATH=install_path_of_BSP make -f Makefile.RTEMS
```

Then run the program `o-optimize/constants.exe` on the target hardware.
Your saved target board output may end up with DOS style
CR/LF's.  Run `dos2unix` on the file to get it back to
Unix style.

There is a version of this file generated using `psim` using
a pre-4.8 CVS snapshot of RTEMS which should work on any target.
You can use this but you would be safer to generate your own.
Consider it an example of how it should look when it works.


Building AdaSockets
===================
Subdirectory: `src`

Now that you have a `sockets-constants.ads`, we can build the
AdaSockets library.  `Makefile.adasockets` is provided for this
step:

```
% RTEMS_MAKEFILE_PATH=install_patch_of_BSP make -f Makefile.RTEMS
```

After the library is compiled, it may be installed using the following:

```
% RTEMS_MAKEFILE_PATH=install_patch_of_BSP make -f Makefile.RTEMS install
```

Building examples
=================
Subdirectory: `examples`

After building the sockets package, build the examples the same way

```
% RTEMS_MAKEFILE_PATH=install_patch_of_BSP make -f Makefile.RTEMS
```

BUGS:

  - stream_listener core dumps if the endian of the `stream_sender` is not
    the same as the listener.
  - multicast does not yet work.  This is probably an RTEMS issue.

README file for adasockets.

AdaSockets is a medium binding (it is not a thin binding because it uses Ada
types and not a thick binding because you have the same subprogram names as
in C) for using BSD-style sockets in Ada.

Since the original release, I have been adding multicast and fixed some
bugs. However, it is likely that others remain.

To use AdaSockets with gnatmake once installed, type:

    $ gnatmake $(adasockets-config) ...

The `adasockets-config` part will add the correct options to gnatmake command
line.

AdaSockets is free software; you can redistribute it and/or modify it
under terms of the GNU General Public License as published by the Free
Software Foundation; either version 2, or (at your option) any later
version.  AdaSockets is distributed in the hope that it will be
useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.  You should have received a
copy of the GNU General Public License distributed with AdaSockets;
see file COPYING.  If not, write to the Free Software Foundation, 59
Temple Place - Suite 330, Boston, MA 02111-1307, USA.

As a special exception, if other files instantiate generics from this
unit, or you link this unit with other files to produce an executable,
this unit does not by itself cause the resulting executable to be
covered by the GNU General Public License.  This exception does not
however invalidate any other reasons why the executable file might be
covered by the GNU Public License.

The main repository for this software is located at:
    http://www.rfc1149.net/devel/adasockets

Please report any issues or address any question to the issues tracker
on GitHub, located at:
    https://github.com/samueltardieu/adasockets/issues

The author, Samuel Tardieu <sam@rfc1149.net>