Subversion Repositories HelenOS

Rev

Rev 4723 | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
4307 mejdrech 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
30
 *  @{
31
 */
32
 
33
/** @file
4350 mejdrech 34
 *  Networking module interface.
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.
37
 *  The bundle networking module is compiled with the net_bundle.c source file and the choosen bundle module implementation source files.
4307 mejdrech 38
 */
39
 
40
#ifndef __NET_NET_INTERFACE_H__
41
#define __NET_NET_INTERFACE_H__
42
 
43
#include <ipc/services.h>
44
 
45
#include "../include/device.h"
46
 
47
#include "../structures/measured_strings.h"
48
 
4704 mejdrech 49
/** @name Networking module interface
50
 *  This interface is used by other modules.
51
 */
52
/*@{*/
53
 
4350 mejdrech 54
/** Returns the device specific configuration.
55
 *  Returns the global configuration if the device specific is not found.
4723 mejdrech 56
 *  The configuration names are read and the appropriate settings are set instead.
57
 *  Call net_free_settings() function to release the returned configuration.
4756 mejdrech 58
 *  @param[in] net_phone The networking module phone.
59
 *  @param[in] device_id The device identifier.
60
 *  @param[in,out] configuration The requested device configuration. The names are read and the appropriate settings are set instead.
61
 *  @param[in] count The configuration entries count.
62
 *  @param[in,out] data The configuration and settings data.
4350 mejdrech 63
 *  @returns EOK on success.
64
 *  @returns EINVAL if the configuration is NULL.
65
 *  @returns EINVAL if the count is zero (0).
66
 *  @returns Other error codes as defined for the generic_translate_req() function.
67
 */
4505 mejdrech 68
int	net_get_device_conf_req( int net_phone, device_id_t device_id, measured_string_ref * configuration, size_t count, char ** data );
4350 mejdrech 69
 
70
/** Returns the global configuration.
4723 mejdrech 71
 *  The configuration names are read and the appropriate settings are set instead.
72
 *  Call net_free_settings() function to release the returned configuration.
4756 mejdrech 73
 *  @param[in] net_phone The networking module phone.
74
 *  @param[in,out] configuration The requested configuration. The names are read and the appropriate settings are set instead.
75
 *  @param[in] count The configuration entries count.
76
 *  @param[in,out] data The configuration and settings data.
4350 mejdrech 77
 *  @returns EOK on success.
78
 *  @returns EINVAL if the configuration is NULL.
79
 *  @returns EINVAL if the count is zero (0).
80
 *  @returns Other error codes as defined for the generic_translate_req() function.
81
 */
4505 mejdrech 82
int	net_get_conf_req( int net_phone, measured_string_ref * configuration, size_t count, char ** data );
4350 mejdrech 83
 
84
/** Frees the received settings.
4756 mejdrech 85
 *  @param[in] settings The received settings.
86
 *  @param[in] data The received settings data.
4350 mejdrech 87
 *  @see net_get_device_conf_req()
88
 *  @see net_get_conf_req()
89
 */
4307 mejdrech 90
void	net_free_settings( measured_string_ref settings, char * data );
4350 mejdrech 91
 
92
/** Connects to the networking module.
93
 *  @param service The networking module service. Ignored parameter.
94
 *  @returns The networking module phone on success.
95
 *  @returns 0 if called by the bundle module.
96
 */
4307 mejdrech 97
int	net_connect_module( services_t service );
98
 
4704 mejdrech 99
/*@}*/
100
 
4307 mejdrech 101
#endif
102
 
103
/** @}
104
 */