Rev 4704 | Go to most recent revision | Only display areas with differences | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed
Rev 4704 | Rev 4723 | ||
---|---|---|---|
1 | /* |
1 | /* |
2 | * Copyright (c) 2009 Lukas Mejdrech |
2 | * Copyright (c) 2009 Lukas Mejdrech |
3 | * All rights reserved. |
3 | * All rights reserved. |
4 | * |
4 | * |
5 | * Redistribution and use in source and binary forms, with or without |
5 | * Redistribution and use in source and binary forms, with or without |
6 | * modification, are permitted provided that the following conditions |
6 | * modification, are permitted provided that the following conditions |
7 | * are met: |
7 | * are met: |
8 | * |
8 | * |
9 | * - Redistributions of source code must retain the above copyright |
9 | * - Redistributions of source code must retain the above copyright |
10 | * notice, this list of conditions and the following disclaimer. |
10 | * notice, this list of conditions and the following disclaimer. |
11 | * - Redistributions in binary form must reproduce the above copyright |
11 | * - Redistributions in binary form must reproduce the above copyright |
12 | * notice, this list of conditions and the following disclaimer in the |
12 | * notice, this list of conditions and the following disclaimer in the |
13 | * documentation and/or other materials provided with the distribution. |
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 |
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. |
15 | * derived from this software without specific prior written permission. |
16 | * |
16 | * |
17 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR |
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 |
18 | * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
19 | * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. |
19 | * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. |
20 | * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, |
20 | * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, |
21 | * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT |
21 | * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT |
22 | * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
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 |
23 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
24 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
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 |
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. |
26 | * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
27 | */ |
27 | */ |
28 | 28 | ||
29 | /** @addtogroup net |
29 | /** @addtogroup net |
30 | * @{ |
30 | * @{ |
31 | */ |
31 | */ |
32 | 32 | ||
33 | /** @file |
33 | /** @file |
34 | * Networking module interface. |
34 | * Networking module interface. |
35 | * The same interface is used for standalone remote modules as well as for bundle modules. |
35 | * The same interface is used for standalone remote modules as well as for bundle modules. |
36 | * The standalone remote modules have to be compiled with the net_remote.c source file. |
36 | * The standalone remote modules have to be compiled with the net_remote.c source file. |
37 | * The bundle networking module is compiled with the net_bundle.c source file and the choosen bundle module implementation source files. |
37 | * The bundle networking module is compiled with the net_bundle.c source file and the choosen bundle module implementation source files. |
38 | */ |
38 | */ |
39 | 39 | ||
40 | #ifndef __NET_NET_INTERFACE_H__ |
40 | #ifndef __NET_NET_INTERFACE_H__ |
41 | #define __NET_NET_INTERFACE_H__ |
41 | #define __NET_NET_INTERFACE_H__ |
42 | 42 | ||
43 | #include <ipc/services.h> |
43 | #include <ipc/services.h> |
44 | 44 | ||
45 | #include "../include/device.h" |
45 | #include "../include/device.h" |
46 | 46 | ||
47 | #include "../structures/measured_strings.h" |
47 | #include "../structures/measured_strings.h" |
48 | 48 | ||
49 | /** @name Networking module interface |
49 | /** @name Networking module interface |
50 | * This interface is used by other modules. |
50 | * This interface is used by other modules. |
51 | */ |
51 | */ |
52 | /*@{*/ |
52 | /*@{*/ |
53 | 53 | ||
54 | /** Returns the device specific configuration. |
54 | /** Returns the device specific configuration. |
55 | * Returns the global configuration if the device specific is not found. |
55 | * Returns the global configuration if the device specific is not found. |
- | 56 | * The configuration names are read and the appropriate settings are set instead. |
|
- | 57 | * Call net_free_settings() function to release the returned configuration. |
|
56 | * @param net_phone The networking module phone. Input parameter. |
58 | * @param net_phone The networking module phone. Input parameter. |
57 | * @param device_id The device identifier. Input parameter. |
59 | * @param device_id The device identifier. Input parameter. |
58 | * @param configuration The configuration and settings. Input/output parameter. |
60 | * @param configuration The requested device configuration. The names are read and the appropriate settings are set instead. Input/output parameter. |
59 | * @param count The configuration entries count. Input parameter. |
61 | * @param count The configuration entries count. Input parameter. |
60 | * @param data The configuration and settings data. Input/output parameter. |
62 | * @param data The configuration and settings data. Input/output parameter. |
61 | * @returns EOK on success. |
63 | * @returns EOK on success. |
62 | * @returns EINVAL if the configuration is NULL. |
64 | * @returns EINVAL if the configuration is NULL. |
63 | * @returns EINVAL if the count is zero (0). |
65 | * @returns EINVAL if the count is zero (0). |
64 | * @returns Other error codes as defined for the generic_translate_req() function. |
66 | * @returns Other error codes as defined for the generic_translate_req() function. |
65 | */ |
67 | */ |
66 | int net_get_device_conf_req( int net_phone, device_id_t device_id, measured_string_ref * configuration, size_t count, char ** data ); |
68 | int net_get_device_conf_req( int net_phone, device_id_t device_id, measured_string_ref * configuration, size_t count, char ** data ); |
67 | 69 | ||
68 | /** Returns the global configuration. |
70 | /** Returns the global configuration. |
- | 71 | * The configuration names are read and the appropriate settings are set instead. |
|
- | 72 | * Call net_free_settings() function to release the returned configuration. |
|
69 | * @param net_phone The networking module phone. Input parameter. |
73 | * @param net_phone The networking module phone. Input parameter. |
70 | * @param configuration The configuration and settings. Input/output parameter. |
74 | * @param configuration The requested configuration. The names are read and the appropriate settings are set instead. Input/output parameter. |
71 | * @param count The configuration entries count. Input parameter. |
75 | * @param count The configuration entries count. Input parameter. |
72 | * @param data The configuration and settings data. Input/output parameter. |
76 | * @param data The configuration and settings data. Input/output parameter. |
73 | * @returns EOK on success. |
77 | * @returns EOK on success. |
74 | * @returns EINVAL if the configuration is NULL. |
78 | * @returns EINVAL if the configuration is NULL. |
75 | * @returns EINVAL if the count is zero (0). |
79 | * @returns EINVAL if the count is zero (0). |
76 | * @returns Other error codes as defined for the generic_translate_req() function. |
80 | * @returns Other error codes as defined for the generic_translate_req() function. |
77 | */ |
81 | */ |
78 | int net_get_conf_req( int net_phone, measured_string_ref * configuration, size_t count, char ** data ); |
82 | int net_get_conf_req( int net_phone, measured_string_ref * configuration, size_t count, char ** data ); |
79 | 83 | ||
80 | /** Frees the received settings. |
84 | /** Frees the received settings. |
81 | * @param settings The received settings. Input parameter. |
85 | * @param settings The received settings. Input parameter. |
82 | * @param data The received settings data. Input parameter. |
86 | * @param data The received settings data. Input parameter. |
83 | * @see net_get_device_conf_req() |
87 | * @see net_get_device_conf_req() |
84 | * @see net_get_conf_req() |
88 | * @see net_get_conf_req() |
85 | */ |
89 | */ |
86 | void net_free_settings( measured_string_ref settings, char * data ); |
90 | void net_free_settings( measured_string_ref settings, char * data ); |
87 | 91 | ||
88 | /** Connects to the networking module. |
92 | /** Connects to the networking module. |
89 | * @param service The networking module service. Ignored parameter. |
93 | * @param service The networking module service. Ignored parameter. |
90 | * @returns The networking module phone on success. |
94 | * @returns The networking module phone on success. |
91 | * @returns 0 if called by the bundle module. |
95 | * @returns 0 if called by the bundle module. |
92 | */ |
96 | */ |
93 | int net_connect_module( services_t service ); |
97 | int net_connect_module( services_t service ); |
94 | 98 | ||
95 | /*@}*/ |
99 | /*@}*/ |
96 | 100 | ||
97 | #endif |
101 | #endif |
98 | 102 | ||
99 | /** @} |
103 | /** @} |
100 | */ |
104 | */ |
101 | 105 |