| 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 libnet
|
|---|
| 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 |
|
|---|
| 38 | #ifndef LIBNET_NIL_SKEL_H_
|
|---|
| 39 | #define LIBNET_NIL_SKEL_H_
|
|---|
| 40 |
|
|---|
| 41 | #include <async.h>
|
|---|
| 42 | #include <fibril_synch.h>
|
|---|
| 43 | #include <ipc/ipc.h>
|
|---|
| 44 | #include <ipc/services.h>
|
|---|
| 45 |
|
|---|
| 46 | #include <adt/measured_strings.h>
|
|---|
| 47 | #include <net/device.h>
|
|---|
| 48 | #include <net/packet.h>
|
|---|
| 49 |
|
|---|
| 50 | /** Module initialization.
|
|---|
| 51 | *
|
|---|
| 52 | * This has to be implemented in user code.
|
|---|
| 53 | *
|
|---|
| 54 | * @param[in] net_phone Networking module phone.
|
|---|
| 55 | *
|
|---|
| 56 | * @return EOK on success.
|
|---|
| 57 | * @return Other error codes as defined for each specific module
|
|---|
| 58 | * initialize function.
|
|---|
| 59 | *
|
|---|
| 60 | */
|
|---|
| 61 | extern int nil_initialize(int net_phone);
|
|---|
| 62 |
|
|---|
| 63 | /** Notify the network interface layer about the device state change.
|
|---|
| 64 | *
|
|---|
| 65 | * This has to be implemented in user code.
|
|---|
| 66 | *
|
|---|
| 67 | * @param[in] nil_phone Network interface layer phone.
|
|---|
| 68 | * @param[in] device_id Device identifier.
|
|---|
| 69 | * @param[in] state New device state.
|
|---|
| 70 | *
|
|---|
| 71 | * @return EOK on success.
|
|---|
| 72 | * @return Other error codes as defined for each specific module
|
|---|
| 73 | * device state function.
|
|---|
| 74 | *
|
|---|
| 75 | */
|
|---|
| 76 | extern int nil_device_state_msg_local(int, device_id_t, int);
|
|---|
| 77 |
|
|---|
| 78 | /** Pass the packet queue to the network interface layer.
|
|---|
| 79 | *
|
|---|
| 80 | * Process and redistribute the received packet queue to the registered
|
|---|
| 81 | * upper layers.
|
|---|
| 82 | *
|
|---|
| 83 | * This has to be implemented in user code.
|
|---|
| 84 | *
|
|---|
| 85 | * @param[in] nil_phone Network interface layer phone.
|
|---|
| 86 | * @param[in] device_id Source device identifier.
|
|---|
| 87 | * @param[in] packet Received packet or the received packet queue.
|
|---|
| 88 | * @param[in] target Target service. Ignored parameter.
|
|---|
| 89 | *
|
|---|
| 90 | * @return EOK on success.
|
|---|
| 91 | * @return Other error codes as defined for each specific module
|
|---|
| 92 | * received function.
|
|---|
| 93 | *
|
|---|
| 94 | */
|
|---|
| 95 | extern int nil_received_msg_local(int, device_id_t, packet_t *, services_t);
|
|---|
| 96 |
|
|---|
| 97 | /** Message processing function.
|
|---|
| 98 | *
|
|---|
| 99 | * This has to be implemented in user code.
|
|---|
| 100 | *
|
|---|
| 101 | * @param[in] name Module name.
|
|---|
| 102 | * @param[in] callid Message identifier.
|
|---|
| 103 | * @param[in] call Message parameters.
|
|---|
| 104 | * @param[out] answer Message answer parameters.
|
|---|
| 105 | * @param[out] count Message answer arguments.
|
|---|
| 106 | *
|
|---|
| 107 | * @return EOK on success.
|
|---|
| 108 | * @return ENOTSUP if the message is not known.
|
|---|
| 109 | * @return Other error codes as defined for each specific module
|
|---|
| 110 | * message function.
|
|---|
| 111 | *
|
|---|
| 112 | * @see IS_NET_NIL_MESSAGE()
|
|---|
| 113 | *
|
|---|
| 114 | */
|
|---|
| 115 | extern int nil_module_message(ipc_callid_t, ipc_call_t *, ipc_call_t *,
|
|---|
| 116 | size_t *);
|
|---|
| 117 |
|
|---|
| 118 | extern int nil_module_start(int);
|
|---|
| 119 |
|
|---|
| 120 | #endif
|
|---|
| 121 |
|
|---|
| 122 | /** @}
|
|---|
| 123 | */
|
|---|
