| [21580dd] | 1 | /*
|
|---|
| 2 | * Copyright (c) 2009 Lukas Mejdrech
|
|---|
| 3 | * All rights reserved.
|
|---|
| 4 | *
|
|---|
| 5 | * Redistribution and use in source and binary forms, with or without
|
|---|
| 6 | * modification, are permitted provided that the following conditions
|
|---|
| 7 | * are met:
|
|---|
| 8 | *
|
|---|
| 9 | * - Redistributions of source code must retain the above copyright
|
|---|
| 10 | * notice, this list of conditions and the following disclaimer.
|
|---|
| 11 | * - Redistributions in binary form must reproduce the above copyright
|
|---|
| 12 | * notice, this list of conditions and the following disclaimer in the
|
|---|
| 13 | * documentation and/or other materials provided with the distribution.
|
|---|
| 14 | * - The name of the author may not be used to endorse or promote products
|
|---|
| 15 | * derived from this software without specific prior written permission.
|
|---|
| 16 | *
|
|---|
| 17 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
|
|---|
| 18 | * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
|---|
| 19 | * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
|
|---|
| 20 | * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
|
|---|
| 21 | * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
|
|---|
| 22 | * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|---|
| 23 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|---|
| 24 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|---|
| 25 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
|
|---|
| 26 | * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|---|
| 27 | */
|
|---|
| 28 |
|
|---|
| 29 | /** @addtogroup net_nil
|
|---|
| 30 | * @{
|
|---|
| 31 | */
|
|---|
| 32 |
|
|---|
| 33 | /** @file
|
|---|
| 34 | * Network interface layer modules common skeleton.
|
|---|
| 35 | * All network interface layer modules have to implement this interface.
|
|---|
| 36 | */
|
|---|
| 37 |
|
|---|
| [849ed54] | 38 | #ifndef __NET_NIL_MODULE_H__
|
|---|
| 39 | #define __NET_NIL_MODULE_H__
|
|---|
| [21580dd] | 40 |
|
|---|
| 41 | #include <ipc/ipc.h>
|
|---|
| 42 |
|
|---|
| 43 | /** Module initialization.
|
|---|
| 44 | * Is called by the module_start() function.
|
|---|
| 45 | * @param[in] net_phone The networking moduel phone.
|
|---|
| 46 | * @returns EOK on success.
|
|---|
| 47 | * @returns Other error codes as defined for each specific module initialize function.
|
|---|
| 48 | */
|
|---|
| [849ed54] | 49 | extern int nil_initialize(int net_phone);
|
|---|
| [21580dd] | 50 |
|
|---|
| 51 | /** Message processing function.
|
|---|
| 52 | * @param[in] callid The message identifier.
|
|---|
| 53 | * @param[in] call The message parameters.
|
|---|
| 54 | * @param[out] answer The message answer parameters.
|
|---|
| 55 | * @param[out] answer_count The last parameter for the actual answer in the answer parameter.
|
|---|
| 56 | * @returns EOK on success.
|
|---|
| 57 | * @returns ENOTSUP if the message is not known.
|
|---|
| 58 | * @returns Other error codes as defined for each specific module message function.
|
|---|
| 59 | * @see nil_interface.h
|
|---|
| 60 | * @see IS_NET_NIL_MESSAGE()
|
|---|
| 61 | */
|
|---|
| [849ed54] | 62 | extern int nil_message(ipc_callid_t callid, ipc_call_t * call, ipc_call_t * answer, int * answer_count);
|
|---|
| [21580dd] | 63 |
|
|---|
| 64 | #endif
|
|---|
| 65 |
|
|---|
| 66 | /** @}
|
|---|
| 67 | */
|
|---|
